v1

latestOpenAPI 3.0.42026-07-233182951.4 MB

BMRS Datasets

Minimum Zero Time (MZT) stream

This endpoint provides Minimum Zero Time data received from NGESO.

The Minimum Zero Time is the minimum time that a BM Unit which has been exporting must operate at zero or import, before returning to export; whereas if the BM Unit has been importing, the MZT indicates the minimum time that it must operate at zero or export before returning to import, if action by the System Operator (i.e. a Bid-Offer Acceptance) places it at such a level.

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/MZT/stream?from=2022-06-01T00:00Z&to=2022-07-01T00:00Z

Filtering from start time to settlement date and period:

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

Filtering from settlement date and period to start time:

/datasets/MZT/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/MZT/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 MZT data.

get/datasets/MZT/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

periodMininteger

nationalGridBmUnitstring nullable

bmUnitstring nullable

Example response

[
  {
    "dataset": "MZT",
    "settlementDate": "2022-07-25",
    "settlementPeriod": 3,
    "time": "2022-07-25T09:34:00Z",
    "periodMin": 360,
    "nationalGridBmUnit": "ABRBO-1",
    "bmUnit": "T_ABRBO-1"
  }
]