Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Elexon Surplus Forecast API

Generating Plant Operating Surplus forecast data, including historical views of data by publish time or forecast date.

Elexon Surplus Forecast API is one of 32 APIs that Elexon publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Surplus Forecast. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 6 paths, and defines 5 schemas. It is described by OpenAPI 3.0.4, at version 1.0.

Requests are made against a single base URL, https://data.elexon.co.uk/bmrs/api/v1.

6 operations 6 paths 5 schemas 6 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.4
API Version
1.0
Base URL
https://data.elexon.co.uk/bmrs/api/v1
Resource Areas
1

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 6 GET. Each is listed below with its method, path, parameters, and response codes.

Surplus Forecast 6

Generating Plant Operating Surplus forecast data, including historical views of data by publish time or forecast date.

GET
/forecast/surplus/daily
Daily surplus forecast (OCNMFD)
1 param → 200
GET
/forecast/surplus/daily/history
Historical daily surplus forecast (OCNMFD)
2 params → 200
GET
/forecast/surplus/daily/evolution
Evolution daily surplus forecast (OCNMFD)
2 params → 200
GET
/forecast/surplus/weekly
Weekly surplus forecast (OCNMFW, OCNMF3Y)
2 params → 200
GET
/forecast/surplus/weekly/history
Historical weekly surplus forecast (OCNMFW, OCNMF3Y)
3 params → 200
GET
/forecast/surplus/weekly/evolution
Evolution weekly surplus forecast (OCNMFW, OCNMF3Y)
4 params → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusWeekly (5 properties), Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusDaily (3 properties), Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusWeekly (2 properties), Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusDaily (2 properties). Each schema is shown below with its type and property counts.

Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusDaily
object
2 properties
Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusWeekly
object
2 properties
Insights.Api.Models.Metadata.ApiResponseSourceMetadata
object
1 property
Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusDaily
object
3 properties
Insights.Api.Models.Responses.ForecastSurplus.ForecastSurplusWeekly
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elexon-surplus-forecast-api-openapi.yml Raw ↑

Other APIs Elexon publishes across the network.

Elexon Balancing Mechanism Dynamic API
Elexon Balancing Mechanism Physical API
Elexon Balancing Services Adjustment - Disaggregated API
Elexon Balancing Services Adjustment - Net API
Elexon Bid-Offer Acceptances API
Elexon Bid-Offer API
Elexon BMRS Datasets API
Elexon Credit Default Notice API
Elexon Data Status API
Elexon Demand API
Elexon Demand Forecast API
Elexon Generation API