v1

latestOpenAPI 3.0.42026-07-233182951.4 MB

Bid-Offer Acceptances

Bid-offer acceptances per BMU (BOALF)

This endpoint provides the bid-offer acceptance data (BOALF) for a requested BMU.

By default, the from and to parameters filter the data by start time inclusively. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, the corresponding from or to parameter instead filters on settlement date, allowing for searching by a combination of start 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 from start time to start time:

/balancing/acceptances?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z

Filtering from start time to settlement date and period:

/balancing/acceptances?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodTo=1

Filtering from settlement date and period to start time:

/balancing/acceptances?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1

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

/balancing/acceptances?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z&settlementPeriodFrom=1&settlementPeriodTo=1

get/balancing/acceptances

Query parameters

bmUnitstring required

Example:T_MILWW-1

The BM Unit to query.

fromstring date-time required

Example:2022-10-03T00:00Z

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

tostring date-time required

Example:2022-10-06T00: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-06-25",
      "settlementPeriodFrom": 29,
      "settlementPeriodTo": 32,
      "timeFrom": "2022-06-25T13:34:00Z",
      "timeTo": "2022-06-25T13:37:00Z",
      "levelFrom": 5,
      "levelTo": 46,
      "nationalGridBmUnit": "ABRBO-1",
      "bmUnit": "T_ABRBO-1",
      "acceptanceNumber": 1234567,
      "acceptanceTime": "2022-06-25T13:30:00Z",
      "deemedBoFlag": true,
      "storFlag": true
    }
  ],
  "metadata": {
    "datasets": [
      "DATASET"
    ]
  }
}