ELelexon
Generation Forecast

History of the three-year generation capacity forecast (FOU2T3YW)

Changed on

This endpoint provides the latest three-year forecast from a given DateTime

get/forecast/availability/weekly/history

Request

Query parameters

publishTimestring date-time required
Example:2024-06-07T15:00:00Z

The UTC publish time to query. This should be in the format yyyy-MM-ddT:HH:mm:ssZ.

level'total' | 'fuelType' | 'bmUnit'
Example:fuelType

The filter level for the forecast. This can be one of the following:

  • total: the total forecast for the given time period.
  • bmUnit: the forecast for each specified BM unit.
  • fuelType: the forecast aggregated, and optionally filtered by fuel type.
bmUnitstring[]

The BM units to query. Add each unit separately. Either the Elexon ID (Eg: T_CARR-1) or National Grid ID (Eg: CARR-1) can be used. Between 1 and 10 units should be queried when using the bmUnit level.

fuelTypestring[]

The fuel type to query when using the fuelType level. Add each fuel type separately. If no fuel types are supplied, all fuel types will be returned.

[
  "CCGT"
]
format'json' | 'xml' | 'csv'

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

Response

OK

Example response

{
  "data": [
    {
      "publishTime": "2024-06-07T15:00:00Z",
      "fuelType": "CCGT",
      "ngcBmUnit": "CARR-1",
      "bmUnit": "T_CARR-1",
      "outputUsable": 418,
      "year": 2024,
      "calendarWeekNumber": 23
    }
  ],
  "metadata": {
    "datasets": [
      "DATASET"
    ]
  }
}

Changes

  • d967a175e71cRevision changes
    • info

      added the optional property // to the response with the status (media type: text/plain)

    • info

      added the optional property // to the response with the status (media type: application/json)

    • info

      added the optional property // to the response with the status (media type: text/json)

    • info

      added the optional property // to the response with the status (media type: application/xml)

    • info

      added the optional property // to the response with the status (media type: text/xml)

    • info

      added the optional property // to the response with the status (media type: text/csv)