v1

latestOpenAPI 3.0.42026-07-233182951.4 MB

BMRS Datasets

Bid Offer Acceptance Level Flagged (BOALF)

This endpoint provides bid offer acceptance data.

By default, the from and to parameters filter the data inclusively and this endpoint will return any data where TimeFrom is within the requested time range. If the settlementPeriodFrom or settlementPeriodTo parameters are provided, it will instead filter to return any data where TimeFrom is within 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 from datetime to datetime

/datasets/boalf?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z

Filtering from datetime to settlement date and period:

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

Filtering from settlement date and period to datetime:

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

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

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

get/datasets/BOALF

Query parameters

fromstring date-time required

Example:2022-10-22T00:00Z

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

tostring date-time required

Example:2022-10-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.

bmUnitstring[]

The BM units to query. Add each unit separately. If no BM unit is selected all BM units will be displayed.

[
  "T_WBURB-3"
]

format'json' | 'xml' | 'csv'

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

Response

Data retrieved

Example response

{
  "data": [
    {
      "dataset": "BOALF",
      "settlementDate": "2022-07-25",
      "settlementPeriodFrom": 29,
      "settlementPeriodTo": 32,
      "timeFrom": "2022-06-25T13:34:00Z",
      "timeTo": "2022-06-25T13:37:00Z",
      "levelFrom": 5,
      "levelTo": 46,
      "acceptanceNumber": 1234567,
      "acceptanceTime": "2022-06-25T13:37:00Z",
      "amendmentFlag": "ORI",
      "nationalGridBmUnit": "ABRBO-1",
      "bmUnit": "T_ABRBO-1"
    }
  ]
}