v1

latestOpenAPI 3.0.42026-07-233182951.4 MB

BMRS Datasets

Quiescent Physical Notifications (QPN) stream

This endpoint provides Quiescent Physical Notification data received from NGESO. Quiescent Physical Notifications describe the MW levels to be deducted from the Physical Notification of a BM Unit to determine a resultant operating level.

The settlement period to query can be specified as a date and settlement period, or as a datetime which will resolve to the settlement period that time falls within. If a settlement period is provided, it will take precedence over the time portion of the datetime.

Some examples of date parameter combinations are shown below.

Filtering from settlement datetime to settlement datetime:

 /datasets/QPN/stream?from=2022-07-01T00:00Z&to=2022-07-03T06:00Z

Filtering from settlement datetime to settlement date and period:

 /datasets/QPN/stream?from=2022-07-01T00:00Z&to=2022-07-03&settlementPeriodTo=15

Filtering from settlement date and period to settlement datetime:

 /datasets/QPN/stream?from=2022-07-01&settlementPeriodFrom=3&to=2022-07-03T06:00Z

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

/datasets/QPN/stream?from=2022-07-01&settlementPeriodFrom=3&to=2022-07-03&settlementPeriodTo=15

This endpoint has an optimised JSON payload and is aimed at frequent requests for QPN data.

get/datasets/QPN/stream

Query parameters

fromstring date-time required

Example:2022-07-01

The settlement date to query from.

tostring date-time required

Example:2022-07-03

The settlement date to query up to.

settlementPeriodFrominteger

Example:3

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

settlementPeriodTointeger

Example:15

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_ABRBO-1"
]

Response

Data retrieved

datasetstring nullable

settlementDatestring date

settlementPeriodinteger

timeFromstring date-time

timeTostring date-time

levelFrominteger

levelTointeger

nationalGridBmUnitstring nullable

bmUnitstring nullable

Example response

[
  {
    "dataset": "PN",
    "settlementDate": "2022-07-01",
    "settlementPeriod": 3,
    "timeFrom": "2022-07-01T13:34:00Z",
    "timeTo": "2022-07-01T13:34:00Z",
    "levelFrom": 5,
    "levelTo": 46,
    "nationalGridBmUnit": "ABRBO-1",
    "bmUnit": "T_ABRBO-1"
  }
]