v1

latestOpenAPI 3.0.42026-07-233182951.4 MB
Balancing Mechanism Dynamic

Dynamic data per BMU (SEL, SIL, MZT, MNZT, MDV, MDP, NTB, NTO, NDZ)

This endpoint provides the dynamic data for a requested BMU, excluding physical rate data. It returns a "snapshot" of data valid at a given time, and optionally a time series of changes over a requested interval.

By default, all of the relevant datasets are returned: SIL, SEL, NDZ, NTB, NTO, MZT, MNZT, MDV, MDP. The results from each dataset are transformed to a common response model, with the common integer field Value mapped from the fields Level, Period, Volume or Notice in the original dataset, as relevant.

get/balancing/dynamic

Query parameters

bmUnitstring required
Example:2__HFLEX001

The BM Unit to query.

snapshotAtstring date-time required
Example:2022-08-23T00:00Z

When to retrieve a snapshot of data at. That is, the latest datapoint before this time will be returned for each dataset.

untilstring date-time
Example:2022-08-24T00:00Z

When to retrieve data until. Data from the snapshot until this time will be returned.

snapshotAtSettlementPeriodinteger
Example:2

The settlement period to retrieve a snapshot of data at. If provided, the time part of SnapshotAt will be ignored.

untilSettlementPeriodinteger
Example:2

The settlement period to retrieve data until. If provided, the time part of Until will be ignored.

datasetstring[]

Datasets to filter. If omitted, all datasets will be returned.

[
  "SEL",
  "MNZT",
  "MDP"
]
format'json' | 'xml' | 'csv'

Response data format. Use json/xml to include metadata.

Response

Data retrieved

Example response

{
  "data": [
    {
      "dataset": "SEL",
      "bmUnit": "T_ABRBO-1",
      "nationalGridBmUnit": "ABRBO-1",
      "time": "2022-07-01T13:34:00Z",
      "value": 5,
      "settlementDate": "2022-07-01",
      "settlementPeriod": 3
    }
  ],
  "metadata": {
    "datasets": [
      "DATASET"
    ]
  }
}
All 318 operations