Sign in

v1

latestOpenAPI 3.0.42026-07-233182951.4 MB
Demand

Restoration Zone Demand Restored Submissions (RZDR)

This endpoint provides data about the end of system restoration events. It returns the restored demand value for each restoration zone at the last submission time of each event. The number of events to return is determined by the count parameter.

The data can be filtered by submission date/time, region, and GSP Group ID (when received by NESO).

All 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 parameter combinations are shown below.

Filtering latest 3 events:

/demand/by-restoration-zone/restored/submissions?count=3

Filtering latest 3 events before a given submission time:

/demand/by-restoration-zone/restored/submissions?before=2025-10-01T00:00Z&count=3

Filtering latest 10 events for a given region:

/demand/by-restoration-zone/restored/submissions?region=North West&count=10
get/demand/by-restoration-zone/restored/submissions

Query parameters

countinteger required
Example:3

The number of system restoration events to return.

beforestring date-time

If specified, filters events to those with a submission time before or at the specified date and time. If omitted, latest events are returned.

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.

format'json' | 'xml' | 'csv'

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

Response

Data retrieved

Example response

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