Sign in

v1

latestOpenAPI 3.0.42026-07-233182951.4 MB
Indicative Imbalance Settlement

Indicative period BMU cashflows by settlement period (EBOCF)

Returns derived indicative cashflow data generated by the latest calculation run for a given 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/cashflows/all/{bidOffer}/{settlementDate}/{settlementPeriod}

Path parameters

settlementPeriodinteger required
Example:9

The settlement period for the filter.

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

Filter if bid or offer data is to be returned.

settlementDatestring date required
Example:2024-02-01

The settlement date for the filter. This must be in the format yyyy-MM-dd.

Query parameters

bmUnitstring[]

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

[
  "T_DINO-2"
]
format'json' | 'xml'

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

Response

Data retrieved

Example response

{
  "data": [
    {
      "settlementDate": "2023-03-01",
      "settlementPeriod": 1,
      "startTime": "2023-03-01T00:00:00Z",
      "createdDateTime": "2023-09-17T09:03:18.74Z",
      "bmUnit": "2__AFLEX003",
      "bmUnitType": "S",
      "leadPartyName": "Flexitricity Limited",
      "nationalGridBmUnit": "AG-AFLX03",
      "bidOfferPairCashflows": {
        "positive1": 23062.377,
        "positive2": 5017.6255
      },
      "totalCashflow": 28080.002
    }
  ],
  "metadata": {
    "datasets": [
      "DATASET"
    ]
  }
}