v1

latestOpenAPI 3.0.42026-07-233182951.4 MB

BMRS Datasets

Non-BM STOR (NONBM) stream

This endpoint provides data about the Short Term Operating Reserves (STOR) that have been made use of by NGESO. This is activity that is outside of the Balancing Mechanism and takes place to meet the need to increase generation or decrease demand.

To retrieve data from a particular time window, use the optional start and end time parameters. These times should be expressed as defined within <a href="https://datatracker.ietf.org/doc/html/rfc3339#section-5.6" target="_blank">RFC 3339</a>. If no time window is chosen, the default output will be the latest published data.

This endpoint has an optimised JSON payload and is aimed at frequent requests for the Non-BM STOR data.

get/datasets/NONBM/stream

Query parameters

fromstring date-time

Example:2022-06-25T13:15Z

The start of the data publish time window.

tostring date-time

Example:2022-06-27T19:45Z

The end of the data publish time window.

Response

Data retrieved

datasetstring nullable

publishTimestring date-time

startTimestring date-time

settlementDatestring date

settlementPeriodinteger

generationinteger

Example response

[
  {
    "dataset": "NONBM",
    "publishTime": "2022-06-25T13:34:00Z",
    "startTime": "2022-06-25T13:00:00Z",
    "settlementDate": "2022-06-25",
    "settlementPeriod": 29
  }
]