Sign in

v1

latestOpenAPI 3.0.42026-07-233182951.4 MB
Indicative Imbalance Settlement

Indicative volumes by settlement period (DISPTAV)

Returns the settlement indicative volumes for the requested settlement period.

Only messages generated for the latest settlement run are returned.

Settlement date parameter must be provided in the exact format yyyy-MM-dd.

get/balancing/settlement/indicative/volumes/all/{bidOffer}/{settlementDate}/{settlementPeriod}

Path parameters

settlementPeriodinteger required
Example:2

This should be an integer from 1-50 inclusive.

settlementDatestring date required
Example:2024-02-01

This must be in the format yyyy-MM-dd.

bidOffer'bid' | 'offer' required
Example:bid

Query parameters

bmUnitstring[]

Elexon or NGC BMU IDs can be used. If omitted, results for all BM units will be returned.

[
  "2__CMRCY001"
]
format'json' | 'xml'

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

Response

Data retrieved

Example response

{
  "data": [
    {
      "createdDateTime": "2023-02-28T15:31:12Z",
      "settlementDate": "2023-03-01",
      "settlementPeriod": 2,
      "startTime": "2023-03-01T00:30:00Z",
      "bmUnit": "T_ABRBO-1",
      "bmUnitType": "T",
      "leadPartyName": "Aberdeen Offshore Wind Farm",
      "nationalGridBmUnit": "ABRBO-1",
      "dataType": "Original",
      "totalVolumeAccepted": -75.725,
      "pairVolumes": {
        "positive1": 23062.377,
        "positive2": 5017.6255
      }
    }
  ],
  "metadata": {
    "datasets": [
      "DATASET"
    ]
  }
}