Sign in

v1

latestOpenAPI 3.0.42026-07-233182951.4 MB
Balancing Mechanism Dynamic

Rate data per BMU (RDRE, RURE, RDRI, RURI)

This endpoint provides the physical rate data for a requested BMU. 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: RDRE, RURE, RDRI, RURI.

get/balancing/dynamic/rates

Query parameters

bmUnitstring required
Example:DRAXX-1

The BM Unit to query.

snapshotAtstring date-time required
Example:2022-09-01T00: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-09-30T00: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 empty, all datasets will be returned.

[
  "RURE",
  "RDRE",
  "RDRI"
]
format'json' | 'xml' | 'csv'

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

Response

Data retrieved

Example response

{
  "data": [
    {
      "dataset": "RURE",
      "settlementDate": "2022-07-01",
      "settlementPeriod": 3,
      "time": "2022-07-01T13:34:00Z",
      "rate1": 0.4,
      "elbow2": 5,
      "rate2": 300.2,
      "nationalGridBmUnit": "ABRBO-1",
      "bmUnit": "T_ABRBO-1"
    }
  ],
  "metadata": {
    "datasets": [
      "DATASET"
    ]
  }
}