v1

latestOpenAPI 3.0.42026-07-233182951.4 MB

BMRS Datasets

Year Ahead Forecast Margin (YAFM / B0810)

This endpoint provides year-ahead forecast margin data.

A year-ahead forecast margin is defined as the difference between yearly forecast of available generation capacity and yearly forecast of total load, taking into account the forecast of total generation capacity, forecast of availability of generation and forecast of reserves contracted for system services.

This API endpoint has a maximum range of 20 years (7305 days).

get/datasets/YAFM

Query parameters

publishDateTimeFromstring date-time required

Example:2021-06-01T00:00Z

publishDateTimeTostring date-time required

Example:2022-07-25T00:00Z

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

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

Response

Data retrieved

Example response

{
  "data": [
    {
      "dataset": "YAFM",
      "documentId": "NGET-EMFIP-YAFM-00687705",
      "documentRevisionNumber": 1,
      "publishTime": "2023-07-12 05:00:00Z",
      "businessType": "Positive forecast margin",
      "year": 2023,
      "quantity": 1.08
    }
  ]
}