---
title: "Historical weekly surplus forecast (OCNMFW, OCNMF3Y)"
method: GET
path: "/forecast/surplus/weekly/history"
tags: ["Surplus Forecast"]
---

# Historical weekly surplus forecast (OCNMFW, OCNMF3Y)

`GET /forecast/surplus/weekly/history`

## Request

- Base URL: `https://data.elexon.co.uk/bmrs/api/v1`
- URL: `https://data.elexon.co.uk/bmrs/api/v1/forecast/surplus/weekly/history`
- Auth: none declared

This endpoint provides the historic Generating Plant Operating Surplus covering 2 weeks ahead to 156 weeks ahead in MW values.
The weekly API outputs the latest published data for weekly surplus forecast for W+2 to W+156.
Historical published data of weekly surplus forecasts for a given publish date in the 2-156 week dataset.

## Query parameters

- `publishTime` string, date-time, required
- `range` '52W' | '156W'
- `format` 'json' | 'xml' | 'csv'

## Response `200`

OK

- InsightsApiModelsResponsesResponseWithMetadata1InsightsApiModelsResponsesForecastSurplusForecastSurplusWeekly
  - `data` InsightsApiModelsResponsesForecastSurplusForecastSurplusWeekly[], nullable
    - `publishTime` string, date-time
    - `surplus` integer, nullable
    - `week` integer
    - `year` integer
    - `weekStartDate` string, date
  - `metadata` InsightsApiModelsMetadataApiResponseSourceMetadata
    - `datasets` string[], nullable

---

[API](https://skmtc.dev/elexon/apis/bmrs-insights.md) - [All operations](https://skmtc.dev/elexon/apis/bmrs-insights/llms.txt) - [OpenAPI document](https://skmtc.dev/elexon/apis/bmrs-insights/revisions/d992cbaa9351?raw)