Data related to the settlement process.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/elexon-indicative-imbalance-settlement-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Insights.Api Balancing Mechanism Dynamic Indicative Imbalance Settlement API
version: '1.0'
description: Dynamic data.
servers:
- url: https://data.elexon.co.uk/bmrs/api/v1
tags:
- name: Indicative Imbalance Settlement
description: Data related to the settlement process.
paths:
/balancing/settlement/messages/{settlementDate}:
get:
tags:
- Indicative Imbalance Settlement
summary: Settlement messages by settlement date (SMSG)
description: "Returns settlement messages generated by the SAA for a given settlement day, relating to the data\nfor a settlement run.\n \nFor each settlement period within the range, only messages generated for the latest settlement run are returned.\n \nSettlement date parameter must be provided in the exact format yyyy-MM-dd."
parameters:
- name: settlementDate
in: path
description: The settlement date to filter. This must be in the format yyyy-MM-dd.
required: true
schema:
type: string
format: date
example: '2024-02-01'
example: '2024-02-01'
- name: format
in: query
description: Response data format. Use json/xml to include metadata.
schema:
enum:
- json
- xml
- csv
type: string
responses:
'200':
description: Data retrieved
content:
text/plain:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementMessageResponse'
application/json:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementMessageResponse'
text/json:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementMessageResponse'
application/xml:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementMessageResponse'
text/xml:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementMessageResponse'
text/csv:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementMessageResponse'
'429':
description: Too many requests
'400':
description: Error with query parameters - see response for details
'500':
description: Server error - please try again later
/balancing/settlement/messages/{settlementDate}/{settlementPeriod}:
get:
tags:
- Indicative Imbalance Settlement
summary: Settlement messages by settlement date and period (SMSG)
description: "Returns settlement messages generated by the SAA for a given settlement period, relating to the data\nfor a settlement run.\n \nOnly messages generated for the latest settlement run are returned.\n \nSettlement date parameter must be provided in the exact format yyyy-MM-dd."
parameters:
- name: settlementPeriod
in: path
description: The settlement period to filter. This should be an integer from 1-50 inclusive.
required: true
schema:
type: integer
format: int32
example: 3
example: 3
- name: settlementDate
in: path
description: The settlement date to filter. This must be in the format yyyy-MM-dd.
required: true
schema:
type: string
format: date
example: '2024-02-01'
example: '2024-02-01'
- name: format
in: query
description: Response data format. Use json/xml to include metadata.
schema:
enum:
- json
- xml
- csv
type: string
responses:
'200':
description: Data retrieved
content:
text/plain:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementMessageResponse'
application/json:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementMessageResponse'
text/json:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementMessageResponse'
application/xml:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementMessageResponse'
text/xml:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementMessageResponse'
text/csv:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementMessageResponse'
'429':
description: Too many requests
'400':
description: Error with query parameters - see response for details
'500':
description: Server error - please try again later
/balancing/settlement/stack/all/{bidOffer}/{settlementDate}/{settlementPeriod}:
get:
tags:
- Indicative Imbalance Settlement
summary: Settlement bid-offer stacks by settlement period (ISPSTACK)
description: "Returns detailed system prices generated by the latest calculation run for a given settlement period.\n \nSettlement date parameter must be provided in the exact format yyyy-MM-dd."
parameters:
- name: bidOffer
in: path
description: Filter if bid or offer data is to be returned.
required: true
schema:
enum:
- bid
- offer
type: string
example: bid
example: bid
- name: settlementDate
in: path
description: The settlement date for the filter. This must be in the format yyyy-MM-dd.
required: true
schema:
type: string
format: date
example: '2024-02-01'
example: '2024-02-01'
- name: settlementPeriod
in: path
description: The settlement period for the filter.
required: true
schema:
type: integer
format: int32
example: 1
example: 1
- name: format
in: query
description: Response data format. Use json/xml to include metadata.
schema:
enum:
- json
- xml
- csv
type: string
responses:
'200':
description: Data retrieved
content:
text/plain:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementStackResponse'
application/json:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementStackResponse'
text/json:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementStackResponse'
application/xml:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementStackResponse'
text/xml:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementStackResponse'
text/csv:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SettlementStackResponse'
'429':
description: Too many requests
'400':
description: Error with query parameters - see response for details
'500':
description: Server error - please try again later
/balancing/settlement/summary/{settlementDate}/{settlementPeriod}:
get:
tags:
- Indicative Imbalance Settlement
summary: Settlement calculation summary (ISPSTACK, DISEBSP, MID, NETBSAD)
description: "Returns the settlement calculation summary for the requested settlement period.\nData is derived from the following datasets: ISPSTACK, DISEBSP, MID, NETBSAD\n \nIn JSON format, decimal values are returned as strings to avoid loss of precision."
parameters:
- name: settlementDate
in: path
description: This must be in the format yyyy-MM-dd.
required: true
schema:
type: string
format: date
example: '2024-02-01'
example: '2024-02-01'
- name: settlementPeriod
in: path
description: This should be an integer from 1-50 inclusive.
required: true
schema:
type: integer
format: int32
example: 1
example: 1
- name: format
in: query
description: Response data format. Use json/xml to include metadata.
schema:
enum:
- json
- xml
type: string
responses:
'200':
description: Data retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Settlement.SettlementSummaryResponse'
application/xml:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.Balancing.Settlement.SettlementSummaryResponse'
'429':
description: Too many requests
'400':
description: Error with query parameters - see response for details
'404':
description: No data found for the requested parameters
'500':
description: Server error - please try again later
/balancing/settlement/default-notices:
get:
tags:
- Indicative Imbalance Settlement
summary: Default notices (CDN)
description: This endpoint provides a subset of CDN (Credit Default Notice) data received from ECVAA (Energy Contract Volume Aggregation Agent). It returns the defaults that are in force and defaults that have closed within the last 7 days.
parameters:
- name: format
in: query
description: Response data format. Use json/xml to include metadata.
schema:
enum:
- json
- xml
- csv
type: string
responses:
'200':
description: Data retrieved
content:
text/plain:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.CreditDefaultNoticeResponse'
application/json:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.CreditDefaultNoticeResponse'
text/json:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.CreditDefaultNoticeResponse'
application/xml:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.CreditDefaultNoticeResponse'
text/xml:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.CreditDefaultNoticeResponse'
text/csv:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.DatasetResponse-1_Insights.Api.Models.Responses.Balancing.CreditDefaultNoticeResponse'
'429':
description: Too many requests
'400':
description: Error with query parameters - see response for details
'500':
description: Server error - please try again later
/balancing/settlement/system-prices/{settlementDate}:
get:
tags:
- Indicative Imbalance Settlement
summary: Settlement system prices by settlement date (DISEBSP)
description: "Returns settlement system buy and sell prices generated by the SAA for a given settlement day, relating to\nthe data for a settlement run.\n \nFor each settlement period within the range, only messages generated for the latest settlement run are returned.\n \nSettlement date parameter must be provided in the exact format yyyy-MM-dd."
parameters:
- name: settlementDate
in: path
description: The settlement date to filter. This must be in the format yyyy-MM-dd.
required: true
schema:
type: string
format: date
example: '2024-02-01'
example: '2024-02-01'
- name: format
in: query
description: Response data format. Use json/xml to include metadata.
schema:
enum:
- json
- xml
- csv
type: string
responses:
'200':
description: Data retrieved
content:
text/plain:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SystemPriceResponse'
application/json:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SystemPriceResponse'
text/json:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SystemPriceResponse'
application/xml:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SystemPriceResponse'
text/xml:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SystemPriceResponse'
text/csv:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SystemPriceResponse'
'429':
description: Too many requests
'400':
description: Error with query parameters - see response for details
'500':
description: Server error - please try again later
/balancing/settlement/system-prices/{settlementDate}/{settlementPeriod}:
get:
tags:
- Indicative Imbalance Settlement
summary: Settlement system prices by settlement date and period (DISEBSP)
description: "Returns settlement system buy and sell prices generated by the SAA for a given settlement period, relating to\nthe data for a settlement run.\n \nOnly messages generated for the latest settlement run are returned.\n \nSettlement date parameter must be provided in the exact format yyyy-MM-dd."
parameters:
- name: settlementPeriod
in: path
description: The settlement period to filter. This should be an integer from 1-50 inclusive.
required: true
schema:
type: integer
format: int32
example: 1
example: 1
- name: settlementDate
in: path
description: The settlement date to filter. This must be in the format yyyy-MM-dd.
required: true
schema:
type: string
format: date
example: '2024-02-01'
example: '2024-02-01'
- name: format
in: query
description: Response data format. Use json/xml to include metadata.
schema:
enum:
- json
- xml
- csv
type: string
responses:
'200':
description: Data retrieved
content:
text/plain:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SystemPriceResponse'
application/json:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SystemPriceResponse'
text/json:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SystemPriceResponse'
application/xml:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SystemPriceResponse'
text/xml:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SystemPriceResponse'
text/csv:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.SystemPriceResponse'
'429':
description: Too many requests
'400':
description: Error with query parameters - see response for details
'500':
description: Server error - please try again later
/balancing/settlement/acceptance/volumes/all/{bidOffer}/{settlementDate}:
get:
tags:
- Indicative Imbalance Settlement
summary: Acceptance volumes by settlement date (BOAV)
description: "Returns the settlement acceptance volumes for the requested settlement date.\n\nFor each settlement period within the range, only messages generated for the latest settlement run are returned.\n \nSettlement date parameter must be provided in the exact format yyyy-MM-dd."
parameters:
- name: settlementDate
in: path
description: This must be in the format yyyy-MM-dd.
required: true
schema:
type: string
format: date
example: '2024-02-01'
example: '2024-02-01'
- name: bidOffer
in: path
required: true
schema:
enum:
- bid
- offer
type: string
example: bid
example: bid
- name: bmUnit
in: query
description: Elexon or NGC BMU IDs can be used. If omitted, results for all BM units will be returned.
schema:
type: array
items:
type: string
example:
- DALSW-1
example:
- DALSW-1
- name: format
in: query
description: Response data format. Use json/xml to include metadata.
schema:
enum:
- json
- xml
type: string
responses:
'200':
description: Data retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.AcceptanceVolumeResponse'
application/xml:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.AcceptanceVolumeResponse'
'429':
description: Too many requests
'400':
description: Error with query parameters - see response for details
'500':
description: Server error - please try again later
/balancing/settlement/acceptance/volumes/all/{bidOffer}/{settlementDate}/{settlementPeriod}:
get:
tags:
- Indicative Imbalance Settlement
summary: Acceptance volumes by settlement period (BOAV)
description: "Returns the settlement acceptance volumes for the requested settlement period.\n\nOnly messages generated for the latest settlement run are returned.\n \nSettlement date parameter must be provided in the exact format yyyy-MM-dd."
parameters:
- name: settlementPeriod
in: path
description: This should be an integer from 1-50 inclusive.
required: true
schema:
type: integer
format: int32
example: 48
example: 48
- name: settlementDate
in: path
description: This must be in the format yyyy-MM-dd.
required: true
schema:
type: string
format: date
example: '2024-02-01'
example: '2024-02-01'
- name: bidOffer
in: path
required: true
schema:
enum:
- bid
- offer
type: string
example: bid
example: bid
- name: bmUnit
in: query
description: Elexon or NGC BMU IDs can be used. If omitted, results for all BM units will be returned.
schema:
type: array
items:
type: string
example:
- DALSW-1
example:
- DALSW-1
- name: format
in: query
description: Response data format. Use json/xml to include metadata.
schema:
enum:
- json
- xml
type: string
responses:
'200':
description: Data retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.AcceptanceVolumeResponse'
application/xml:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.AcceptanceVolumeResponse'
'429':
description: Too many requests
'400':
description: Error with query parameters - see response for details
'500':
description: Server error - please try again later
/balancing/settlement/indicative/volumes/all/{bidOffer}/{settlementDate}:
get:
tags:
- Indicative Imbalance Settlement
summary: Indicative volumes by settlement date (DISPTAV)
description: "Returns the settlement indicative volumes for the requested settlement date.\n\nFor each settlement period within the range, only messages generated for the latest settlement run are returned.\n \nSettlement date parameter must be provided in the exact format yyyy-MM-dd."
parameters:
- name: settlementDate
in: path
description: This must be in the format yyyy-MM-dd.
required: true
schema:
type: string
format: date
example: '2024-02-01'
example: '2024-02-01'
- name: bidOffer
in: path
required: true
schema:
enum:
- bid
- offer
type: string
example: bid
example: bid
- name: bmUnit
in: query
description: Elexon or NGC BMU IDs can be used. If omitted, results for all BM units will be returned.
schema:
type: array
items:
type: string
example:
- 2__CMRCY001
example:
- 2__CMRCY001
- name: format
in: query
description: Response data format. Use json/xml to include metadata.
schema:
enum:
- json
- xml
type: string
responses:
'200':
description: Data retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.IndicativeVolumeResponse'
application/xml:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.IndicativeVolumeResponse'
'429':
description: Too many requests
'400':
description: Error with query parameters - see response for details
'500':
description: Server error - please try again later
/balancing/settlement/indicative/volumes/all/{bidOffer}/{settlementDate}/{settlementPeriod}:
get:
tags:
- Indicative Imbalance Settlement
summary: Indicative volumes by settlement period (DISPTAV)
description: "Returns the settlement indicative volumes for the requested settlement period.\n\nOnly messages generated for the latest settlement run are returned.\n \nSettlement date parameter must be provided in the exact format yyyy-MM-dd."
parameters:
- name: settlementPeriod
in: path
description: This should be an integer from 1-50 inclusive.
required: true
schema:
type: integer
format: int32
example: 2
example: 2
- name: settlementDate
in: path
description: This must be in the format yyyy-MM-dd.
required: true
schema:
type: string
format: date
example: '2024-02-01'
example: '2024-02-01'
- name: bidOffer
in: path
required: true
schema:
enum:
- bid
- offer
type: string
example: bid
example: bid
- name: bmUnit
in: query
description: Elexon or NGC BMU IDs can be used. If omitted, results for all BM units will be returned.
schema:
type: array
items:
type: string
example:
- 2__CMRCY001
example:
- 2__CMRCY001
- name: format
in: query
description: Response data format. Use json/xml to include metadata.
schema:
enum:
- json
- xml
type: string
responses:
'200':
description: Data retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.IndicativeVolumeResponse'
application/xml:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.IndicativeVolumeResponse'
'429':
description: Too many requests
'400':
description: Error with query parameters - see response for details
'500':
description: Server error - please try again later
/balancing/settlement/indicative/cashflows/all/{bidOffer}/{settlementDate}:
get:
tags:
- Indicative Imbalance Settlement
summary: Indicative period BMU cashflows by settlement date (EBOCF)
description: "Returns derived indicative cashflow data generated by the latest calculation run for a given settlement date.\n \nFor each settlement period within the range, only messages generated for the latest settlement run are returned.\n \nSettlement date parameter must be provided in the exact format yyyy-MM-dd."
parameters:
- name: bidOffer
in: path
description: Filter if bid or offer data is to be returned.
required: true
schema:
enum:
- bid
- offer
type: string
example: bid
example: bid
- name: settlementDate
in: path
description: The settlement date for the filter. This must be in the format yyyy-MM-dd.
required: true
schema:
type: string
format: date
example: '2024-02-01'
example: '2024-02-01'
- name: bmUnit
in: query
description: The BM Units to query. Elexon or NGC BMU IDs can be used. If omitted, results for all BM units will be returned.
schema:
type: array
items:
type: string
example:
- T_DINO-2
example:
- T_DINO-2
- name: format
in: query
description: Response data format. Use json/xml to include metadata.
schema:
enum:
- json
- xml
type: string
responses:
'200':
description: Data retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.IndicativeCashflowResponse'
application/xml:
schema:
$ref: '#/components/schemas/Insights.Api.Models.Responses.ResponseWithMetadata-1_Insights.Api.Models.Responses.Balancing.Settlement.IndicativeCashflowResponse'
'429':
description: Too many requests
'400':
description: Error with query parameters - see response for details
'500':
description: Server error - please try again later
/balancing/settlement/indicative/cashflows/all/{bidOffer}/{settlementDate}/{settlementPeriod}:
get:
tags:
- Indicative Imbalance Settlement
summary: Indicative period BMU cashflows by settlement period (EBOCF)
description: "Returns derived indicative cashflow data generated by the latest calculation run for a given settlement period.\n \nOnly messages generated for the latest settlement run are returned.\n \nSettlement date parameter must be provided in the exact format yyyy-MM-dd."
parameters:
- name: settlementPeriod
in: path
description: The settlement period for the filter.
required: true
schema:
type: integer
format: int32
example: 9
example: 9
- name: bidOffer
in: path
description: Filter if bid or offer data is to be returned.
required: true
schema:
enum:
- bid
- offer
type: string
example: bid
example: bid
- name: settlementDate
in: path
description: The settlement date for the filter. This must be in the format yyyy-MM-dd.
required: true
schema:
type: string
format: date
example: '2024-02-01'
example: '2024-02-01'
- name: bmUnit
in: query
description: The BM Units to query. Elexon or NGC BMU IDs can be used. If omitted, results for all BM units will be returned.
schema:
type: array
items:
type: string
example:
- T_DINO-2
example:
- T_DINO-2
- name: format
in: query
description: Response data format. Use json/xml to include metadata.
schema:
enum:
- json
- xml
type: string
responses:
'200':
description: Data retrieved
content:
application/json:
schema:
$ref: '#
# --- truncated at 32 KB (63 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/elexon/refs/heads/main/openapi/elexon-indicative-imbalance-settlement-api-openapi.yml