Sites

Get site flex events

Get info on flex events the site has participated in, including estimated and final gross revenues.

These estimates can be used for a variety of purposes, including paying out end-users before the final settlement data is available.However, to avoid overpayments it is recommended to only pay out a percentage of the estimated revenue initially, and top-up once final revenues are available.

Note: it is possible for gross revenues to be negative in some scenarios, e.g. if the site flexed in the wrong direction by consuming more energy while it was instructed to consume less.

GET

entities

site

{site_id}

flex-events

Get Site Flex Events

curl --request GET \
  --url https://api-sandbox.axle.energy/entities/site/{site_id}/flex-events \
  --header 'Authorization: Bearer <token>'

{
  "site_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "events": [
    {
      "start_at": "2023-11-07T05:31:56Z",
      "end_at": "2023-11-07T05:31:56Z",
      "estimated_gross_revenue_gbp": 123,
      "final_gross_revenue_gbp": 123
    }
  ]
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

site_id

string<uuid>

required

Response

Successful Response

site_id

string<uuid>

required

ID of the site

events

FlexEventResponse · object[]

required

List of flex events the site participated in

Show child attributes

events.start_at

string<date-time>

required

UTC start time of the flex event

events.end_at

string<date-time>

required

UTC end time of the flex event

events.estimated_gross_revenue_gbp

number

required

Estimated gross revenue earned in GBP for the event, before data has been submitted and reviewed by the relevant market bodies. Gross earnings are total flex earnings before any Axle and end-user revenue sharing deductions.

events.final_gross_revenue_gbp

number

Final gross revenue earned in GBP for the event. This will be completed before the final settlement run of the event month (in UK Time), which runs at the end of the following month. Gross earnings are total flex earnings before any Axle and end-user revenue sharing deductions.

Add site auth tokenProvide an auth token to Axle, for dispatching the site's assets. This token should provide access to all of the assets registered against the specified site. This is only required where Axle is not able to access this site via an aggregated API in your systems.

⌘I

Get Site Flex Events

curl --request GET \
  --url https://api-sandbox.axle.energy/entities/site/{site_id}/flex-events \
  --header 'Authorization: Bearer <token>'

{
  "site_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "events": [
    {
      "start_at": "2023-11-07T05:31:56Z",
      "end_at": "2023-11-07T05:31:56Z",
      "estimated_gross_revenue_gbp": 123,
      "final_gross_revenue_gbp": 123
    }
  ]
}

API Documentation

Authorizations

Path Parameters

Response