Sign in

v1

latestOpenAPI 3.0.42026-07-233182951.4 MB
BMRS Datasets

Actual Generation Output Per Generation Unit (B1610) stream

This endpoint provides the actual metered volume output (MWh) per Settlement Period for all BM units (Positive, Negative or zero MWh values).

The information is published five days after the end of the operational period based on the Interim Information (II) Settlement Run and the data is refreshed by subsequent Settlement Runs.

The generation output returned by this endpoint is the metered volume and not the instantaneous power output as often appears in other specifications.

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

get/datasets/B1610/stream

Query parameters

fromstring date-time required
Example:2022-08-12T00:00Z

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

tostring date-time required
Example:2022-08-14T00: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[] 
[
  "T_CNQPS-1"
]

Response

Data retrieved

datasetstring nullable
psrTypestring nullable
bmUnitstring nullable
nationalGridBmUnitIdstring nullable
settlementDatestring date
settlementPeriodinteger
halfHourEndTimestring date-time
quantitynumber double

Example response

[
  {
    "dataset": "B1610",
    "psrType": "Generation",
    "bmUnit": "T_CNQPS-1",
    "nationalGridBmUnitId": "CNQPS-1",
    "settlementDate": "2022-08-12",
    "settlementPeriod": 10,
    "halfHourEndTime": "2022-08-12T04:00:00Z",
    "quantity": 116.109
  }
]