Making a request

A request at its most basic level is a URL made up of 3 parts: a base URL, an end-point, and parameters. For request where you are updating or creating data, you will also need to include a request body. To read more about what request bodies each end-point accepts, please see the REST API reference documentation.

Base URL

All API requests should use a base URL of https://api.oeg-kraken.energy/v1/. Note, all API requests must be made over HTTPS.

Authentication

For endpoints that require authentication, refer to the GraphQL guide on retrieving a token which can be passed via the Authorization header. The same token can be used to authenticate with the REST APIs.

Parameters

Datetimes: Some API end-points accept datetime strings as parameters. These should be passed in ISO 8601 format. Eg:

We strongly recommend that timezone information is included on all datetime parameters. If no timezone information is included, the “Europe/London” timezone will be assumed and results may vary between GMT and British Summer Time.