v1

latestOpenAPI 3.0.42026-07-233182951.4 MB

Non-BM STOR

Non-BM STOR events (NONBM)

This endpoint provides data about the start of NGESO Short Term Operating Reserves (STOR) events. This is activity that is outside of the Balancing Mechanism and takes place to meet the need to increase generation or decrease demand. Each result has a non-zero generation value which was preceded by a zero generation value.

By default, the before parameter filters the data by start time. If the settlementPeriodBefore parameter is provided, the before parameter instead filters on settlement date, allowing for searching by start time or settlement date & settlement period. Note: When filtering via settlement date, before is treated as a Date only, with the time being ignored. For example, 2022-06-01T00:00Z and 2022-06-01T11:11Z are both treated as the settlement date 2022-06-01.

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

Filtering latest 3 events:

/balancing/nonbm/stor/events?count=3

Filtering latest 3 events before start time:

/balancing/nonbm/stor/events?before=2022-08-01T00:00Z&count=3

Filtering latest 3 events before settlement date and settlement period:

/balancing/nonbm/stor/events?before=2022-08-01T00:00Z&settlementPeriodBefore=48&count=3

get/balancing/nonbm/stor/events

Query parameters

countinteger required

Example:3

The number of events to return.

beforestring date-time

If specified, filters events to those with a start time before or at the date, or a settlement date before the date if settlementPeriodBefore is also specified. If omitted, latest events are returned.

settlementPeriodBeforeinteger

Filters events to those with a settlement period before or at the value. Before parameter must be specified if this is specified.

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

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

Response

Data retrieved

Example response

{
  "data": [
    {
      "publishTime": "2022-06-25T13:34:00Z",
      "startTime": "2022-06-25T13:00:00Z",
      "settlementDate": "2022-06-25",
      "settlementPeriod": 29
    }
  ],
  "metadata": {
    "datasets": [
      "DATASET"
    ]
  }
}