v1

latestOpenAPI 3.0.42026-07-233182951.4 MB

BMRS Datasets

Notice to Deviate from Zero (NDZ) stream

This endpoint provides Notice to Deviate from Zero data received from NGESO.

Notice to Deviate from Zero (NDZ) indicates the length of time required for a BM Unit to start importing or exporting energy, from a zero Physical Notification level as a result of a Bid-Offer Acceptance, expressed in minutes.

By default, the from and to parameters filter the data by 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 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:

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

Filtering from start time to settlement date and period:

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

Filtering from settlement date and period to start time:

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

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

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

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

get/datasets/NDZ/stream

Query parameters

fromstring date-time required

Example:2022-08-01T00:00Z

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

tostring date-time required

Example:2022-08-02T00: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_FOYE-1"
]

Response

Data retrieved

datasetstring nullable

settlementDatestring date

settlementPeriodinteger

timestring date-time

noticeinteger

nationalGridBmUnitstring nullable

bmUnitstring nullable

Example response

[
  {
    "dataset": "NTB",
    "settlementDate": "2022-07-01",
    "settlementPeriod": 3,
    "time": "2022-07-01T13:34:00Z",
    "notice": 13,
    "nationalGridBmUnit": "ABRBO-1",
    "bmUnit": "T_ABRBO-1"
  }
]