v1

latestOpenAPI 3.0.42026-07-233182951.4 MB

System forecast

Loss of load probability and de-rated margin forecast (LOLPDRM)

This endpoint provides the 1h, 2h, 4h, 8h and 12h+ Loss of Load Probability and De-rated Margin forecasts for each settlement period over a requested time range.

For each forecast horizon at 1, 2, 4 or 8 hours, the returned value is the forecast received that number of hours before the start of the settlement period.

For the forecast horizon of 12h, the returned value is the most recent forecast received 12 or more hours before the start of the settlement period. That is, if the most recent forecast was published today at 00:00,

for 11:30 today, the 12h forecast is the one published yesterday at 23:30 (12h before)
for 12:00 today, the 12h forecast is the one published today at 00:00 (12h before)
for 12:30 today, the 12h forecast is the one published today at 00:00 (the latest published)

get/forecast/system/loss-of-load

Query parameters

fromstring date-time required

Example:2023-03-06T07:00Z

tostring date-time required

Example:2023-03-06T12:00Z

settlementPeriodFrominteger

Example:15

The "from" settlement period for the filter. This should be an integer from 1-50 inclusive.

settlementPeriodTointeger

Example:25

The "to" settlement period for the filter. This should be an integer from 1-50 inclusive.

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

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

Response

Data retrieved

Example response

{
  "data": [
    {
      "publishTime": "2023-01-31 17:36",
      "publishingPeriodCommencingTime": "2023-01-31 17:30",
      "startTime": "2023-01-31 18:30",
      "settlementDate": "2023-01-31",
      "settlementPeriod": 38,
      "forecastHorizon": 1,
      "deratedMargin": 12570.207
    }
  ],
  "metadata": {
    "datasets": [
      "DATASET"
    ]
  }
}