{ "opencollection": "1.0.0", "info": { "name": "Insights.Api Balancing Mechanism Dynamic Indicative Imbalance Settlement API", "version": "1.0" }, "items": [ { "info": { "name": "Indicative Imbalance Settlement", "type": "folder" }, "items": [ { "info": { "name": "Settlement messages by settlement date (SMSG)", "type": "http" }, "http": { "method": "GET", "url": "https://data.elexon.co.uk/bmrs/api/v1/balancing/settlement/messages/:settlementDate", "params": [ { "name": "settlementDate", "value": "2024-02-01", "type": "path", "description": "The settlement date to filter. This must be in the format yyyy-MM-dd." }, { "name": "format", "value": "", "type": "query", "description": "Response data format. Use json/xml to include metadata." } ] }, "docs": "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." }, { "info": { "name": "Settlement messages by settlement date and period (SMSG)", "type": "http" }, "http": { "method": "GET", "url": "https://data.elexon.co.uk/bmrs/api/v1/balancing/settlement/messages/:settlementDate/:settlementPeriod", "params": [ { "name": "settlementPeriod", "value": "3", "type": "path", "description": "The settlement period to filter. This should be an integer from 1-50 inclusive." }, { "name": "settlementDate", "value": "2024-02-01", "type": "path", "description": "The settlement date to filter. This must be in the format yyyy-MM-dd." }, { "name": "format", "value": "", "type": "query", "description": "Response data format. Use json/xml to include metadata." } ] }, "docs": "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." }, { "info": { "name": "Settlement bid-offer stacks by settlement period (ISPSTACK)", "type": "http" }, "http": { "method": "GET", "url": "https://data.elexon.co.uk/bmrs/api/v1/balancing/settlement/stack/all/:bidOffer/:settlementDate/:settlementPeriod", "params": [ { "name": "bidOffer", "value": "bid", "type": "path", "description": "Filter if bid or offer data is to be returned." }, { "name": "settlementDate", "value": "2024-02-01", "type": "path", "description": "The settlement date for the filter. This must be in the format yyyy-MM-dd." }, { "name": "settlementPeriod", "value": "1", "type": "path", "description": "The settlement period for the filter." }, { "name": "format", "value": "", "type": "query", "description": "Response data format. Use json/xml to include metadata." } ] }, "docs": "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." }, { "info": { "name": "Settlement calculation summary (ISPSTACK, DISEBSP, MID, NETBSAD)", "type": "http" }, "http": { "method": "GET", "url": "https://data.elexon.co.uk/bmrs/api/v1/balancing/settlement/summary/:settlementDate/:settlementPeriod", "params": [ { "name": "settlementDate", "value": "2024-02-01", "type": "path", "description": "This must be in the format yyyy-MM-dd." }, { "name": "settlementPeriod", "value": "1", "type": "path", "description": "This should be an integer from 1-50 inclusive." }, { "name": "format", "value": "", "type": "query", "description": "Response data format. Use json/xml to include metadata." } ] }, "docs": "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." }, { "info": { "name": "Default notices (CDN)", "type": "http" }, "http": { "method": "GET", "url": "https://data.elexon.co.uk/bmrs/api/v1/balancing/settlement/default-notices", "params": [ { "name": "format", "value": "", "type": "query", "description": "Response data format. Use json/xml to include metadata." } ] }, "docs": "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." }, { "info": { "name": "Settlement system prices by settlement date (DISEBSP)", "type": "http" }, "http": { "method": "GET", "url": "https://data.elexon.co.uk/bmrs/api/v1/balancing/settlement/system-prices/:settlementDate", "params": [ { "name": "settlementDate", "value": "2024-02-01", "type": "path", "description": "The settlement date to filter. This must be in the format yyyy-MM-dd." }, { "name": "format", "value": "", "type": "query", "description": "Response data format. Use json/xml to include metadata." } ] }, "docs": "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." }, { "info": { "name": "Settlement system prices by settlement date and period (DISEBSP)", "type": "http" }, "http": { "method": "GET", "url": "https://data.elexon.co.uk/bmrs/api/v1/balancing/settlement/system-prices/:settlementDate/:settlementPeriod", "params": [ { "name": "settlementPeriod", "value": "1", "type": "path", "description": "The settlement period to filter. This should be an integer from 1-50 inclusive." }, { "name": "settlementDate", "value": "2024-02-01", "type": "path", "description": "The settlement date to filter. This must be in the format yyyy-MM-dd." }, { "name": "format", "value": "", "type": "query", "description": "Response data format. Use json/xml to include metadata." } ] }, "docs": "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." }, { "info": { "name": "Acceptance volumes by settlement date (BOAV)", "type": "http" }, "http": { "method": "GET", "url": "https://data.elexon.co.uk/bmrs/api/v1/balancing/settlement/acceptance/volumes/all/:bidOffer/:settlementDate", "params": [ { "name": "settlementDate", "value": "2024-02-01", "type": "path", "description": "This must be in the format yyyy-MM-dd." }, { "name": "bidOffer", "value": "bid", "type": "path" }, { "name": "bmUnit", "value": "DALSW-1", "type": "query", "description": "Elexon or NGC BMU IDs can be used. If omitted, results for all BM units will be returned." }, { "name": "format", "value": "", "type": "query", "description": "Response data format. Use json/xml to include metadata." } ] }, "docs": "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." }, { "info": { "name": "Acceptance volumes by settlement period (BOAV)", "type": "http" }, "http": { "method": "GET", "url": "https://data.elexon.co.uk/bmrs/api/v1/balancing/settlement/acceptance/volumes/all/:bidOffer/:settlementDate/:settlementPeriod", "params": [ { "name": "settlementPeriod", "value": "48", "type": "path", "description": "This should be an integer from 1-50 inclusive." }, { "name": "settlementDate", "value": "2024-02-01", "type": "path", "description": "This must be in the format yyyy-MM-dd." }, { "name": "bidOffer", "value": "bid", "type": "path" }, { "name": "bmUnit", "value": "DALSW-1", "type": "query", "description": "Elexon or NGC BMU IDs can be used. If omitted, results for all BM units will be returned." }, { "name": "format", "value": "", "type": "query", "description": "Response data format. Use json/xml to include metadata." } ] }, "docs": "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." }, { "info": { "name": "Indicative volumes by settlement date (DISPTAV)", "type": "http" }, "http": { "method": "GET", "url": "https://data.elexon.co.uk/bmrs/api/v1/balancing/settlement/indicative/volumes/all/:bidOffer/:settlementDate", "params": [ { "name": "settlementDate", "value": "2024-02-01", "type": "path", "description": "This must be in the format yyyy-MM-dd." }, { "name": "bidOffer", "value": "bid", "type": "path" }, { "name": "bmUnit", "value": "2__CMRCY001", "type": "query", "description": "Elexon or NGC BMU IDs can be used. If omitted, results for all BM units will be returned." }, { "name": "format", "value": "", "type": "query", "description": "Response data format. Use json/xml to include metadata." } ] }, "docs": "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." }, { "info": { "name": "Indicative volumes by settlement period (DISPTAV)", "type": "http" }, "http": { "method": "GET", "url": "https://data.elexon.co.uk/bmrs/api/v1/balancing/settlement/indicative/volumes/all/:bidOffer/:settlementDate/:settlementPeriod", "params": [ { "name": "settlementPeriod", "value": "2", "type": "path", "description": "This should be an integer from 1-50 inclusive." }, { "name": "settlementDate", "value": "2024-02-01", "type": "path", "description": "This must be in the format yyyy-MM-dd." }, { "name": "bidOffer", "value": "bid", "type": "path" }, { "name": "bmUnit", "value": "2__CMRCY001", "type": "query", "description": "Elexon or NGC BMU IDs can be used. If omitted, results for all BM units will be returned." }, { "name": "format", "value": "", "type": "query", "description": "Response data format. Use json/xml to include metadata." } ] }, "docs": "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." }, { "info": { "name": "Indicative period BMU cashflows by settlement date (EBOCF)", "type": "http" }, "http": { "method": "GET", "url": "https://data.elexon.co.uk/bmrs/api/v1/balancing/settlement/indicative/cashflows/all/:bidOffer/:settlementDate", "params": [ { "name": "bidOffer", "value": "bid", "type": "path", "description": "Filter if bid or offer data is to be returned." }, { "name": "settlementDate", "value": "2024-02-01", "type": "path", "description": "The settlement date for the filter. This must be in the format yyyy-MM-dd." }, { "name": "bmUnit", "value": "T_DINO-2", "type": "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." }, { "name": "format", "value": "", "type": "query", "description": "Response data format. Use json/xml to include metadata." } ] }, "docs": "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." }, { "info": { "name": "Indicative period BMU cashflows by settlement period (EBOCF)", "type": "http" }, "http": { "method": "GET", "url": "https://data.elexon.co.uk/bmrs/api/v1/balancing/settlement/indicative/cashflows/all/:bidOffer/:settlementDate/:settlementPeriod", "params": [ { "name": "settlementPeriod", "value": "9", "type": "path", "description": "The settlement period for the filter." }, { "name": "bidOffer", "value": "bid", "type": "path", "description": "Filter if bid or offer data is to be returned." }, { "name": "settlementDate", "value": "2024-02-01", "type": "path", "description": "The settlement date for the filter. This must be in the format yyyy-MM-dd." }, { "name": "bmUnit", "value": "T_DINO-2", "type": "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." }, { "name": "format", "value": "", "type": "query", "description": "Response data format. Use json/xml to include metadata." } ] }, "docs": "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." }, { "info": { "name": "Historic acceptances by settlement period (ISPSTACK, BOALF, BOD)", "type": "http" }, "http": { "method": "GET", "url": "https://data.elexon.co.uk/bmrs/api/v1/balancing/settlement/acceptances/all/:settlementDate/:settlementPeriod", "params": [ { "name": "settlementDate", "value": "2024-02-01", "type": "path", "description": "The settlement date for the filter. This must be in the format yyyy-MM-dd." }, { "name": "settlementPeriod", "value": "1", "type": "path", "description": "The settlement period to filter. This should be an integer from 1-50 inclusive." }, { "name": "format", "value": "", "type": "query", "description": "Response data format. Use json/xml to include metadata." } ] }, "docs": "Returns the bid and offer prices for acceptances, with the acceptance number and acceptance time. Results are sorted by descending acceptance time.\n \nSettlement date parameter must be provided in the exact format yyyy-MM-dd." }, { "info": { "name": "Market depth by settlement date (IMBALNGC, BOD, DISEBSP, DISPTAV)", "type": "http" }, "http": { "method": "GET", "url": "https://data.elexon.co.uk/bmrs/api/v1/balancing/settlement/market-depth/:settlementDate", "params": [ { "name": "settlementDate", "value": "2024-02-01", "type": "path", "description": "The settlement date for the filter. This must be in the format yyyy-MM-dd." }, { "name": "format", "value": "", "type": "query", "description": "Response data format. Use json/xml to include metadata." } ] }, "docs": "Returns market depth data for a given day.\nImbalance (MW) is retrieved from IMBALNGC.\nBid/offer volumes (MWh) are calculated by summing bid/offer volumes from BOD.\nTotal acceptance volumes (MWh) are retrieved from DISEBSP.\nPriced acceptance volumes (MWh) are calculated by summing bid/offer accepted volumes with data type Original from DISPTAV.\n \nSettlement date parameter must be provided in the exact format yyyy-MM-dd." }, { "info": { "name": "Market depth by settlement period (IMBALNGC, BOD, DISEBSP, DISPTAV)", "type": "http" }, "http": { "method": "GET", "url": "https://data.elexon.co.uk/bmrs/api/v1/balancing/settlement/market-depth/:settlementDate/:settlementPeriod", "params": [ { "name": "settlementPeriod", "value": "1", "type": "path", "description": "The settlement period to filter. This should be an integer from 1-50 inclusive." }, { "name": "settlementDate", "value": "2024-02-01", "type": "path", "description": "The settlement date for the filter. This must be in the format yyyy-MM-dd." }, { "name": "format", "value": "", "type": "query", "description": "Response data format. Use json/xml to include metadata." } ] }, "docs": "Returns market depth data for a given settlement period.\nImbalance (MW) is retrieved from IMBALNGC.\nBid/offer volumes (MWh) are calculated by summing bid/offer volumes from BOD.\nTotal acceptance volumes (MWh) are retrieved from DISEBSP.\nPriced acceptance volumes (MWh) are calculated by summing bid/offer accepted volumes with data type Original from DISPTAV.\n \nSettlement date parameter must be provided in the exact format yyyy-MM-dd." } ] } ], "bundled": true }