Sign in

v1

latestOpenAPI 3.0.42026-07-233182951.4 MB
BMRS Datasets

Restoration Region Demand Restored (RZDR) Stream

This endpoint provides the restored demand value for each restoration region with filtering by submission time, region, and GSP Group ID (when received by NESO). This endpoint has an optimised JSON payload and is aimed at frequent requests for the data.

get/datasets/RZDR/stream

Query parameters

submissionDateTimeFromstring date-time required
Example:2025-06-25 00:00:00Z

The submission date and time to filter from. This should be in the format yyyy-MM-dd HH:mm:ssZ.

submissionDateTimeTostring date-time required
Example:2025-07-05 00:00:00Z

The submission date and time to filter to. This should be in the format yyyy-MM-dd HH:mm:ssZ.

region'North Scotland' | 'South Scotland' | 'North West' | 'North East' | 'Midlands' | 'South West' | 'South East'

The region to filter by.

gspGroupIdstring

The GSP Group ID to filter by.

Response

Data retrieved

datasetstring nullable
submissionDateTimestring date-time
publishTimestring date-time
regionstring nullable
gspGroupIdstring nullable
restoredDemandinteger

Example response

[
  {
    "dataset": "RZDR",
    "submissionDateTime": "2025-01-01T07:01:07",
    "publishTime": "2025-01-01T00:00:10",
    "region": "North Scotland",
    "gspGroupId": "_A",
    "restoredDemand": 1234
  }
]