Sign in

v1

latestOpenAPI 3.0.42026-07-233182951.4 MB
Bid-Offer

Bid-offer data per BMU (BOD)

This endpoint provides the bid-offer data for a requested BMU. It returns the data valid over a given time range, excluding any results where LevelFrom and LevelTo are both zero.

By default, the from and to parameters filter the data inclusively and this endpoint will return any data that overlaps even at a single instant. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, it will instead filter to return any data that overlaps with the specified range of settlement periods. It is possible to search using a combination of time and/or settlement date & settlement period. Note: When filtering via settlement date, from/to are treated as Dates only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.

All Dates and DateTimes should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6" target="_blank">RFC 3339</a>.

Some examples of date parameter combinations are shown below.

Filtering by timeFrom and timeTo:

/balancing/bid-offer?bmUnit=T_DRAXX-1&from=2022-06-01T00:00Z&to=2022-07-01T00:00Z

Filtering from timeFrom to settlement date and period:

/balancing/bid-offer?bmUnit=T_DRAXX-1&from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1

Filtering from settlement date and period to TimeTo:

/balancing/bid-offer?bmUnit=T_DRAXX-1&from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1

Filtering from settlement date and period to settlement date and period:

/balancing/bid-offer?bmUnit=T_DRAXX-1&from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1
get/balancing/bid-offer

Query parameters

bmUnitstring required
Example:2__HFLEX001

The BM Unit to query.

fromstring date-time required
Example:2022-09-22T00:00Z

The "from" start time or settlement date for the filter.

tostring date-time required
Example:2022-09-23T00:00Z

The "to" start time or settlement date for the filter.

settlementPeriodFrominteger

The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.

settlementPeriodTointeger

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

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"
    ]
  }
}