Sign in

v1

latestOpenAPI 3.0.42026-07-233182951.4 MB
Bid-Offer

Market-wide bid-offer data (BOD)

This endpoint provides market-wide bid-offer data, for all BMUs or a requested set of multiple BMUs. It returns the data valid for a given settlement period, excluding any results where LevelFrom and LevelTo are both zero.

The settlement period to query must be specified as a date and settlement period. The date should be provided in the format yyyy-MM-dd.

get/balancing/bid-offer/all

Query parameters

settlementDatestring date required
Example:2022-09-22

The settlement date to filter.

settlementPeriodinteger required
Example:1

The settlement period to filter. This should be an integer from 1-50 inclusive.

bmUnitstring[]

The BM Units to query. Elexon or NGC BMU IDs can be used. If omitted, results for all BM units will be returned.

[
  "2__HFLEX001",
  "HUMR-1"
]
format'json' | 'xml' | 'csv'

Response data format. Use json/xml to include metadata.

Response

Data retrieved

Example response

{
  "data": [
    {
      "settlementDate": "2022-07-25",
      "settlementPeriod": 3,
      "nationalGridBmUnit": "ABRBO-1",
      "bmUnit": "T_ABRBO-1",
      "timeFrom": "2022-07-01T13:34:00Z",
      "timeTo": "2022-07-01T13:34:00Z",
      "levelFrom": 5,
      "levelTo": 46,
      "bid": 668.67,
      "offer": -71.5,
      "pairId": 1
    }
  ],
  "metadata": {
    "datasets": [
      "DATASET"
    ]
  }
}