BMRS API and Data Push |
Guidance Note |
A Representational State Transfer (REST) Application Programming Interface (API); and
The Data Push Service – A near real-time information publication capability from the BMRS system to industry participants.
Registration process and access
Accessing data API and Uniform Resource Locator (URL)
API functions such as search parameters
Structure for API request
Using and connecting to the Data Push Service
Interface definition (file formats) for the files which can be downloaded from both the High and Low Grade Service web pages
Register on the ELEXON Portal
Retrieve API Key
Use API Key to gain access to the API URL
Retrieve results from the API
Identify the program calling the API;
Serves as authentication code; and
Monitor and control usage for overall service protection.
API Uniform Resource Identifier (URI)
The search parameters which will be passed as input parameters in the API URIs
Expected format for returned results
Host address: This is the first portion of the URI, and identifies the internet address of the BMRS;
Port Number: The communications endpoint for the API;
Report name: The unique identifier for the report generated by the API;
Version number: The version of the API being called;
API Key: The unique authentication code granted to the users via the ELEXON Portal, giving them rights and permissions to use the API;
Search Parameters: Parameters available to filter the reports, such as Settlement Date and Settlement Period; and
Response format: The file format by which the API will return data, either CSV or XML (with XML being the default).
PORT: 443. (Do not need to specify, as this is the default port for HTTPS)
REPORT NAME: Already included in the API flow details
VERSION NUMBER: v1 or V1 (case insensitive)
API Key: Your API Key from ELEXON Portal
Service Name | AmountOfBalancingReservesUnderContractService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B1720/<VersionNo>?APIKey=<APIKey>&SettlementDate=<SettlementDate>&Period=<Period>&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Time Series ID (Descending) |
API Web service – Request | ||||||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data | |||
APIKey | String |
| Yes | NA | AP8DA23 | |||
Settlement Date | String |
| Yes | YYYY-MM-DD | 2014-12-31 | |||
Period | String |
| Yes | */1-50 | 1 | |||
Service Type | String |
| No | NA | csv/xml | |||
API Web service – Response | ||||||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data | |||
Control Area | String |
| No | NA | London | |||
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 | |||
Business Type | String |
| No | NA | Frequency Containment Reserve | |||
Market Agreement Type | String |
| No | NA | Monthly | |||
Power System Resource Type | String |
| No | NA | Generation | |||
Imbalance Quantity Direction | String |
| No | NA | SURPLUS | |||
Settlement Date | Date |
| No | YYYY-MM-DD | 2014-12-31 | |||
Settlement Period | int |
| No | */1-50 | 1 | |||
Quantity | String |
| No |
| 200 | |||
Document Type | String |
| No |
| System total load | |||
Doc Status | String |
| No |
| Intermediate | |||
Process Type | String |
| No |
| Realised | |||
Resolution | String |
| No |
| PT30M | |||
Curve Type | String |
| No |
| Point | |||
Active Flag | String |
| No |
| Y | |||
Document Id | String |
| No |
| NGET-EMFIP-ATL-401 | |||
Document RevNum | String |
| No |
| 1 |
Service Name | PricesOfProcuredBalancingReservesService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B1730/<VersionNo>?APIKey=<APIKey>&SettlementDate=<SettlementDate>&Period=<Period>&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Time Series ID (Descending) |
API Web service – Request | |||||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data | ||
APIKey | String |
| Yes | NA | AP8DA23 | ||
Settlement Date | String |
| Yes | YYYY-MM-DD | 2014-12-31 | ||
Period | String |
| Yes | */1-50 | 1 | ||
Service Type | String |
| No | NA | csv/xml | ||
API Web service – Response | |||||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data | ||
Control Area | String |
| No | NA | London | ||
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 | ||
Business Type | String |
| No | NA | Frequency Containment Reserve | ||
Market Agreement Type | String |
| No | NA | Monthly | ||
Power System Resource Type | String |
| No | NA | Generation | ||
Flow Direction | String |
| No | NA | Stable | ||
Settlement Date | Date |
| No | YYYY-MM-DD | 2014-12-31 | ||
Settlement Period | int |
| No | */1-50 | 1 | ||
Procurement Price Amount | String |
| No |
| 661237.297 | ||
Price Category | String |
| No | NA | Excess Balance | ||
Document Type | String |
| No |
| System total load | ||
Doc Status | String |
| No |
| Intermediate | ||
Process Type | String |
| No |
| Realised | ||
Resolution | String |
| No |
| PT30M | ||
Curve Type | String |
| No |
| Point | ||
Active Flag | String |
| No |
| Y | ||
Document Id | String |
| No |
| NGET-EMFIP-ATL-401 | ||
Unit Of Currency | String |
| No |
| GBP | ||
Document RevNum | String |
| No |
| 1 |
Service Name | AcceptedAggregatedOffersService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B1740/<VersionNo>?APIKey=<APIKey>&SettlementDate=<SettlementDate>&Period=<Period>&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Time Series ID (Descending) |
API Web service – Request | |||||
Field Name | Field Type | emarks | Mandatory | Format | Sample data |
APIKey | String |
| Yes |
| AP8DA23 |
Settlement Date | String |
| Yes | YYYY-MM-DD | 2014-12-31 |
Period | String |
| Yes | */1-50 | 1 |
Service Type | String |
| No |
| csv/xml |
API Web service – Response | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
Control Area | String |
| No | NA | London |
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 |
Business Type | String |
| No | NA | Frequency Containment Reserve |
Power System Resource Type | String |
| No | NA | Load |
Flow Direction | String |
| No | NA | Up |
Settlement Date | Date |
| No | YYYY-MM-DD | 2014-12-31 |
Settlement Period | int |
| No | */1-50 | 1 |
Quantity | String |
| No |
| 50 |
Secondary Quantity (MAW) | String |
| No |
| 50 |
Document Type | String |
| No |
| System total load |
Doc Status | String |
| No |
| Intermediate |
Process Type | String |
| No |
| Realised |
Resolution | String |
| No |
| PT30M |
Curve Type | String |
| No |
| Point |
Active Flag | String |
| No |
| Y |
Document Id | String |
| No |
| NGET-EMFIP-ATL-401 |
Document RevNum | String |
| No |
| 1 |
Service Name | ActivatedBalancingEnergyService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B1750/<VersionNo>?APIKey=<APIKey>&SettlementDate=<SettlementDate>&Period=<Period>&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Time Series ID (Descending) |
API Web service – Request | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
APIKey | String |
| Yes | NA | AP8DA23 |
Settlement Date | String |
| Yes | YYYY-MM-DD | 2014-12-31 |
Period | String |
| Yes | */1-50 | 1 |
Service Type | String |
| No | NA | csv/xml |
API Web service – Response | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
Control Area | String |
| No | NA | London |
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 |
Business Type | String |
| No | NA | Frequency Containment Reserve |
Power System Resource Type | String |
| No | NA | Load |
Flow Direction | String |
| No | NA | Stable |
Settlement Date | Date |
| No | YYYY-MM-DD | 2014-12-31 |
Settlement Period | int |
| No | */1-50 | 1 |
Activation Quantity | String |
| No |
| 50 |
Document Type | String |
| No | NA | System total load |
Doc Status | String |
| No | NA | Intermediate |
Process Type | String |
| No | NA | Realised |
Resolution | String |
| No | NA | PT30M |
Curve Type | String |
| No | NA | Point |
Active Flag | String |
| No | NA | Y |
Document Id | String |
| No | NA | NGET-EMFIP-ATL-401 |
Document RevNum | String |
| No | NA | 1 |
Service Name | PricesOfActivatedBalancingEnergyService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B1760/<VersionNo>?APIKey=<APIKey>&SettlementDate=<SettlementDate>&Period=<Period>&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Time Series ID (Descending) |
API Web service – Request | |||||||||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data | ||||||
APIKey | String |
| Yes | NA | AP8DA23 | ||||||
Settlement Date | String |
| Yes | YYYY-MM-DD | 2014-12-31 | ||||||
Period | String |
| Yes | */1-50 | 1 | ||||||
Service Type | String |
| No | NA | csv/xml | ||||||
API Web service – Response | |||||||||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data | ||||||
Control Area | String |
| No | NA | London | ||||||
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 | ||||||
Business Type | String |
| No | NA | Frequency Containment Reserve | ||||||
Power System Resource Type | String |
| No | NA | Load | ||||||
Flow Direction | String |
| No | NA | Stable | ||||||
Settlement Date | Date |
| No | YYYY-MM-DD | 2014-12-31 | ||||||
Settlement Period | int |
| No | */1-50 | 1 | ||||||
Activation Price Amount | String |
| No |
| 661237.297 | ||||||
Price Category | String |
| No | NA | Excess Balance | ||||||
Document Type | String |
| No | NA | System total load | ||||||
Doc Status | String |
| No | NA | Intermediate | ||||||
Process Type | String |
| No | NA | Realised | ||||||
Resolution | String |
| No | NA | PT30M | ||||||
Curve Type | String |
| No | NA | Point | ||||||
Active Flag | String |
| No | NA | Y | ||||||
Document Id | String |
| No | NA | NGET-EMFIP-ATL-401 | ||||||
Document RevNum | String |
| No | NA | 1 |
Service Name | ImbalancePricesService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B1770/<VersionNo>?APIKey=< APIKey>&SettlementDate=<SettlementDate>&Period=<Period>&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Time Series ID (Descending) |
API Web service – Request | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
APIKey | String |
| Yes | NA | AP8DA23 |
Settlement Date | String |
| Yes | YYYY-MM-DD | 2014-12-31 |
Period | String |
| Yes | */1-50 | 1 |
Service Type | String |
| No | NA | csv/xml |
API Web service – Response | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
Control Area | String |
| No | NA | London |
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 |
Business Type | String |
| No | NA | Frequency Containment Reserve |
Settlement Date | Date |
| No | YYYY-MM-DD | 2014-12-31 |
Settlement Period | Int |
| No | */1-50 | 1 |
Imbalance Price Amount | String |
| No |
| 661237.297 |
Price Category | String |
| No | NA | Excess Balance |
Document Type | String |
| No | NA | System total load |
Doc Status | String |
| No | NA | Intermediate |
Process Type | String |
| No | NA | Realised |
Resolution | String |
| No | NA | PT30M |
Curve Type | String |
| No | NA | Point |
Active Flag | String |
| No | NA | Y |
Document Id | String |
| No | NA | NGET-EMFIP-ATL-401 |
Document RevNum | String |
| No | NA | 1 |
Service Name | AggregatedImbalanceVolumesService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B1780/<VersionNo>?APIKey=<APIKey>&SettlementDate=<SettlementDate>&Period=<Period>&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Time Series ID (Descending) |
API Web service – Request | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
APIKey | String |
| Yes | NA | AP8DA23 |
Settlement Date | String |
| Yes | YYYY-MM-DD | 2014-12-31 |
Period | String |
| Yes | */1-50 | 1 |
Service Type | String |
| No | NA | csv/xml |
API Web service – Response | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
Control Area | String |
| No | NA | London |
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 |
Business Type | String |
| No | NA | Balance Energy Deviation |
Imbalance Quantity Direction | String |
| No | NA | SURPLUS |
Settlement Date | Date |
| No | YYYY-MM-DD | 2014-12-31 |
Settlement Period | int |
| No | */1-50 | 1 |
Imbalance Quantity | String |
| No |
| 661237.297 |
Document Type | String |
| No | NA | System total load |
Doc Status | String |
| No | NA | Intermediate |
Process Type | String |
| No | NA | Realised |
Resolution | String |
| No | NA | PT30M |
Curve Type | String |
| No | NA | Point |
Active Flag | String |
| No | NA | Y |
Document Id | String |
| No | NA | NGET-EMFIP-ATL-401 |
Document RevNum | String |
| No | NA | 1 |
Service Name | financialExpensesAndIncomeForBalService |
Method | GET |
Input URL | http://<host>:<port>/BMRS/B1790/<VersionNo>?APIKey=< APIKey>&Year=<Year>&Month=<Month>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Comments | 1. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Month (Descending) |
API Web service – Request | |||||||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data | ||||
APIKey | String |
| Yes | NA | AP8DA23 | ||||
Year | String |
| Yes | YYYY | 2014 | ||||
Month | String |
| Yes | MMM | MAR | ||||
ServiceType | String |
| No | NA | csv/xml/CSV/XML | ||||
API Web service – Response | |||||||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data | ||||
Control Area | String |
| No | NA | London | ||||
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 | ||||
Business Type | String |
| No | NA | Financial situation | ||||
Year | int |
| No | YYYY | 2014 | ||||
Month | String |
| No | MMM | MAR | ||||
Financial Price Amount | String |
| No |
| 661237.297 | ||||
Price Direction | String |
| No | NA | Expenditure | ||||
Document Type | String |
| No | NA | System total load | ||||
Doc Status | String |
| No | NA | Intermediate | ||||
Process Type | String |
| No | NA | Realised | ||||
Resolution | String |
| No | NA | PT30M | ||||
Curve Type | String |
| No | NA | Point | ||||
Active Flag | String |
| No | NA | Y | ||||
Document Id | String |
| No | NA | NGET-EMFIP-ATL-401 | ||||
Unit Of Currency | String |
| No | NA | GBP | ||||
Document RevNum | String |
| No | NA | 1 |
Service Name | CrossBorderBalancingVolumesOfExchangedBidsandOffersService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B1810/<VersionNo>?APIKey=<APIKey>&SettlementDate=<SettlementDate>&Period=<Period>&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Time Series ID (Descending) |
API Web service – Request | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
APIKey | String |
| Yes | NA | AP8DA23 |
Settlement Date | String |
| Yes | YYYY-MM-DD | 2014-12-31 |
Period | String |
| Yes | */1-50 | 1 |
Service Type | String |
| No | NA | csv/xml |
API Web service – Response | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
Control Area | String |
| No | NA | London |
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 |
Business Type | String |
| No | NA | Frequency Containment Reserve |
Acquiring Domain | String |
| No | NA | A01=EIC Code |
Connecting Domain | String |
| No | NA | A01=EIC Code |
Flow Direction | String |
| No | NA | Stable |
Settlement Date | Date |
| No | YYYY-MM-DD | 2014-12-31 |
Settlement Period | int |
| No | */1-50 | 1 |
Quantity | String |
| No |
| 121212.5 |
Document Type | String |
| No | NA | System total load |
Doc Status | String |
| No | NA | Intermediate |
Process Type | String |
| No | NA | Realised |
Resolution | String |
| No | NA | PT30M |
Curve Type | String |
| No | NA | Point |
Active Flag | String |
| No | NA | Y |
Document Id | String |
| No | NA | NGET-EMFIP-ATL-401 |
Document RevNum | String |
| No | NA | 1 |
Service Name | CrossBorderBalancingPricesService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B1820/<VersionNo>?APIKey=<APIKey>&SettlementDate=<SettlementDate>&Period=<Period>&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Time Series ID (Descending) |
API Web service – Request | ||||||||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data | |||||
APIKey | String |
| Yes | NA | AP8DA23 | |||||
Settlement Date | String |
| Yes | YYYY-MM-DD | 2014-12-31 | |||||
Period | String |
| Yes | */1-50 | 1 | |||||
Service Type | String |
| No | NA | csv/xml | |||||
API Web service – Response | ||||||||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data | |||||
Control Area | String |
| No | NA | London | |||||
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 | |||||
Business Type | String |
| No | NA | Frequency Containment Reserve | |||||
Acquiring Domain | String |
| No | NA | A01=EIC Code | |||||
Connecting Domain | String |
| No | NA | A01=EIC Code | |||||
Flow Direction | String |
| No | NA | Stable | |||||
Settlement Date | Date |
| No | YYYY-MM-DD | 2014-12-31 | |||||
Settlement Period | int |
| No | */1-50 | 1 | |||||
Min Price Amount | String |
| No |
| 1000 | |||||
Max Price Amount | String |
| No |
| 999999 | |||||
Document Type | String |
| No | NA | System total load | |||||
Doc Status | String |
| No | NA | Intermediate | |||||
Process Type | String |
| No | NA | Realised | |||||
Resolution | String |
| No | NA | PT30M | |||||
Curve Type | String |
| No | NA | Point | |||||
Active Flag | String |
| No | NA | Y | |||||
Document Id | String |
| No | NA | NGET-EMFIP-ATL-401 | |||||
Document RevNum | String |
| No | NA | 1 |
Service Name | CrossBorderBalancingEnergyActivatedService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B1830/<VersionNo>?APIKey=<APIKey>&SettlementDate=<SettlementDate>&Period=<Period>&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Time Series ID (Descending) |
API Web service – Request | ||||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data | |
APIKey | String |
| Yes | NA | AP8DA23 | |
Settlement Date | String |
| Yes | YYYY-MM-DD | 2014-12-31 | |
Period | String |
| Yes | */1-50 | 1 | |
Service Type | String |
| No | NA | csv/xml | |
API Web service – Response | ||||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data | |
Control Area | String |
| No | NA | London | |
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 | |
Business Type | String |
| No | NA | Frequency Containment Reserve | |
Acquiring Domain | String |
| No | NA | A01=EIC Code | |
Connecting Domain | String |
| No | NA | A01=EIC Code | |
Flow Direction | String |
| No | NA | Stable | |
Settlement Date | Date |
| No | YYYY-MM-DD | 2014-12-31 | |
Settlement Period | int |
| No | */1-50 | 1 | |
Secondary Quantity | String |
| No |
| 1012112 | |
Document Type | String |
| No | NA | System total load | |
Doc Status | String |
| No | NA | Intermediate | |
Process Type | String |
| No | NA | Realised | |
Resolution | String |
| No | NA | PT30M | |
Curve Type | String |
| No | NA | Point | |
Active Flag | String |
| No | NA | Y | |
Document Id | String |
| No | NA | NGET-EMFIP-ATL-401 | |
Document RevNum | String |
| No | NA | 1 |
Service Name | ActualTotalLoadPerBiddingZoneService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B0610/<VersionNo>?APIKey=< APIKey>&SettlementDate=<SettlementDate>&Period=<Period>&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Time Series ID (Descending) |
API Web service – Request | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
APIKey | String |
| Yes | NA | AP8DA23 |
Settlement Date | String |
| Yes | YYYY-MM-DD | 2014-12-31 |
Period | String |
| Yes | */1-50 | 1 |
Service Type | String |
| No | NA | csv/xml |
API Web service – Response | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
Time Series ID | String |
| No | NA | 101 |
Settlement Date | Date |
| No | YYYY-MM-DD | 2014-12-31 |
Settlement Period | int |
| No | */1-50 | 1 |
Quantity | String |
| No |
| 200 |
Document Type | String |
| No | NA | System total load |
Business Type | String |
| No | NA | Consumption |
Process Type | String |
| No | NA | Realised |
Object Aggregation | String |
| No | NA | Area |
Resolution | String |
| No | NA | PT30M |
Curve Type | String |
| No | NA | Point |
Unit of Measure | String |
| No | NA | Mega watt |
Active Flag | String |
| No | NA | Y |
Document Id | String |
| No | NA | NGET-EMFIP-ATL-401 |
Document RevNum | String |
| No | NA | 1 |
Secondary Quantity (MAW) | String |
| No |
| 50 |
Service Name | DayAheadTotalLoadForecastPerBiddingZoneService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B0620/<VersionNo>?APIKey=< APIKey>&SettlementDate=<SettlementDate>&Period=<Period>&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Time Series ID (Descending) |
API Web service – Request | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
APIKey | String |
| Yes | NA | AP8DA23 |
Settlement Date | String |
| Yes | YYYY-MM-DD | 2014-12-31 |
Period | String |
| Yes | */1-50 | 1 |
Service Type | String |
| No | NA | csv/xml |
API Web service – Response | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 |
Settlement Date | Date |
| No | YYYY-MM-DD | 2014-12-31 |
Settlement Period | int |
| No | */1-50 | 1 |
Quantity | String |
| No |
| 200 |
Document Type | String |
| No | NA | System total load |
Business Type | String |
| No | NA | Consumption |
Process Type | String |
| No | NA | Realised |
Object Aggregation | String |
| No | NA | Area |
Resolution | String |
| No | NA | PT30M |
Curve Type | String |
| No | NA | Point |
Unit of Measure | String |
| No | NA | Mega watt |
Active Flag | String |
| No | NA | Y |
Document Id | String |
| No | NA | NGET-EMFIP-ATL-401 |
Document RevNum | String |
| No | NA | 1 |
Secondary Quantity (MAW) | String |
| No |
| 50 |
Service Name | WeekAheadTotalLoadForecastPerBiddingZoneService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B0630/<VersionNo>? APIKey=< APIKey>&Year=<Year>&Week=<Week>&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Time Series ID (Descending), Date (Descending) |
API Web service – Request | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
APIKey | String |
| Yes | NA | AP8DA23 |
Year | String |
| Yes | YYYY | 2014 |
Week | String |
| Yes | ww(01-52) | 22 |
Service Type | String |
| No | NA | csv/xml |
API Web service – Response | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
Business Type | String |
| No | NA | Consumption |
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 |
Date | Date |
| No | YYYY-MM-DD | 07/05/2014 |
Quantity (MAW) | String |
| No |
| 200 |
Week | int |
| No | NA | 13 |
Secondary Quantity (MAW) | String |
| No |
| 50 |
Document Type | String |
| No | NA | System total load |
Year | int |
| No | NA | 2014 |
Process Type | String |
| No | NA | Realised |
Object Aggregation | String |
| No | NA | Area |
Resolution | String |
| No | NA | PT30M |
Curve Type | String |
| No | NA | Point |
Unit of Measure | String |
| No | NA | Mega watt |
Active Flag | String |
| No | NA | Y |
Document RevNum | String |
| No | NA | 2 |
Document Id | String |
| No | NA | NGET-EMFIP-ATL-401 |
Service Name | monthAheadTotLoadForecastPerBiddingZoneService |
Method | GET |
Input URL | http://<host>:<port>/BMRS/B0640/<VersionNo>? APIKey=< APIKey>&Year=<Year>&Month=<Month>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Comments | 1. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Week Commencing (Descending) |
API Web service – Request | ||||||||||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data | |||||||
APIKey | String |
| Yes | NA | AP8DA23 | |||||||
Year | String |
| Yes | YYYY | 2014 | |||||||
Month | String |
| Yes | MMM | MAR | |||||||
Service Type | String |
| No | NA | csv/xml/CSV/XML | |||||||
API Web service – Response | ||||||||||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data | |||||||
Business Type | String |
| No | NA | Consumption | |||||||
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 | |||||||
Quantity | String |
| No |
| 200 | |||||||
Secondary Quantity (MAW) | String |
| No |
| 50 | |||||||
Year | int |
| No | YYYY | 2014 | |||||||
Month | String |
| No | MMM | MAR | |||||||
Week Commencing (YYYY-MM-DD) | Date |
| No | YYYY-MM-DD | 2014-01-25 | |||||||
Document Type | String |
| No | NA | System total load | |||||||
Document RevNum | String |
| No | NA | 2 | |||||||
Process Type | String |
| No | NA | Realised | |||||||
Object Aggregation | String |
| No | NA | Area | |||||||
Resolution | String |
| No | NA | PT30M | |||||||
Curve Type | String |
| No | NA | Point | |||||||
Unit of Measure | String |
| No | NA | Mega watt | |||||||
Active Flag | String |
| No | NA | Y | |||||||
Document Id | String |
| No | NA | NGET-EMFIP-ATL-401 |
Service Name | MonthAheadTotalLoadForecastPerBiddingZoneService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B0640/<VersionNo>? APIKey=< APIKey>&Year=<Year>&Month=<Month>&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Time Series ID (Descending), Week Commencing (Descending) |
API Web service – Request | |||||||||||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data | ||||||||
APIKey | String |
| Yes | NA | AP8DA23 | ||||||||
Year | String |
| Yes | YYYY | 2014 | ||||||||
Month | String |
| Yes | MM(01-12) | 4 | ||||||||
Service Type | String |
| No | NA | csv/xml | ||||||||
API Web service – Response | |||||||||||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data | ||||||||
Business Type | String |
| No | NA | Consumption | ||||||||
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 | ||||||||
Quantity | String |
| No |
| 200 | ||||||||
Secondary Quantity (MAW) | String |
| No |
| 50 | ||||||||
Year | int |
| No | YYYY | 2014 | ||||||||
Month | String |
| No | MM(01-12) | 4 | ||||||||
Week Commencing (YYYY-MM-DD) | Date |
| No | YYYY-MM-DD | 2014-01-25 | ||||||||
Document Type | String |
| No | NA | System total load | ||||||||
Document RevNum | String |
| No | NA | 2 | ||||||||
Process Type | String |
| No | NA | Realised | ||||||||
Object Aggregation | String |
| No | NA | Area | ||||||||
Resolution | String |
| No | NA | PT30M | ||||||||
Curve Type | String |
| No | NA | Point | ||||||||
Unit of Measure | String |
| No | NA | Mega watt | ||||||||
Active Flag | String |
| No | NA | Y | ||||||||
Document Id | String |
| No | NA | NGET-EMFIP-ATL-401 |
Service Name | YearAheadTotalLoadForecastPerBiddingZoneService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B0650/<VersionNo>? APIKey =< APIKey >&Year=<Year>&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Week (Descending) |
API Web service – Request | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
APIKey | String |
| Yes | NA | AP8DA23 |
Year | String |
| Yes | YYYY | 2013 |
Service Type | String |
| No | NA | csv/xml |
API Web service – Response | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
Business Type | String |
| No | NA | Consumption |
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 |
Quantity | String |
| No | NA | 200 |
Secondary Quantity (MAW) | String |
| No |
| 50 |
Year | int |
| No | YYYY | 2013 |
Week | int |
| No |
| 52 |
Document Type | String |
| No | NA | System total load |
Month Name | String |
| No | NA |
|
Process Type | String |
| No | NA | Realised |
Object Aggregation | String |
| No | NA | Area |
Resolution | String |
| No | NA | PT30M |
Curve Type | String |
| No | NA | Point |
Unit of Measure | String |
| No | NA | Mega watt |
Active Flag | String |
| No | NA | Y |
Document Id | String |
| No | NA | NGET-EMFIP-ATL-401 |
Document RevNum | String |
| No | NA | 1 |
Service Name | YearAheadForecastMarginService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B0810/<VersionNo>? APIKey =< APIKey >&Year=<Year>&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Time Series ID (Descending) |
API Web service – Request | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
APIKey | String |
| Yes | NA | AP8DA23 |
Year | String |
| Yes | YYYY | 2014 |
Service Type | String |
| No | NA | csv/xml |
API Web service – Response | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
Business Type | String |
| No | NA | Consumption |
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 |
Quantity | String |
| No |
| 200 |
Secondary Quantity (MAW) | String |
| No |
| 50 |
Year | int |
| No | YYYY | 2014 |
Document Type | String |
| No | NA | System total load |
Process Type | String |
| No | NA | Realised |
Resolution | String |
| No | NA | PT30M |
Curve Type | String |
| No | NA | Point |
Unit of Measure | String |
| No | NA | Mega watt |
Active Flag | String |
| No | NA | Y |
Document Id | String |
| No | NA | NGET-EMFIP-ATL-401 |
Document RevNum | String |
| No | NA | 1 |
Service Name | InstalledGenerationCapacityAggregatedService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B1410/<VersionNo>? APIKey =< APIKey >&Year=<Year>&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Time Series ID (Descending) |
API Web service – Request | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
APIKey | String |
| Yes | NA | AP8DA23 |
Year | String |
| Yes | YYYY | 2014 |
Service Type | String |
| No | NA | csv/xml |
API Web service – Response | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 |
Quantity | double |
| No |
| 200 |
Year | int |
| No | YYYY | 2014 |
Power System Resource Type | String |
| No | NA | Generation |
Document Type | String |
| No | NA | System total load |
Process Type | String |
| No | NA | Realised |
Resolution | String |
| No | NA | PT30M |
BusinessType | String |
| No | NA | Consumption |
Active Flag | String |
| No | NA | Y |
Document Id | String |
| No | NA | NGET-EMFIP-ATL-401 |
Document RevNum | String |
| No | NA | 1 |
Service Name | InstalledGenerationCapacityPerUnitService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B1420/<VersionNo>? APIKey =< APIKey >&Year=<Year>&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Time Series ID (Descending) |
API Web service – Request | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
APIKey | String |
| Yes | NA | AP8DA23 |
Year | String |
| Yes | YYYY | 2014 |
Service Type | String |
| No | NA | csv/xml |
API Web service – Response | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 |
Power System Resource Type | String |
| No | NA | Generation |
Year | int |
| No | YYYY | 2014 |
BM UNIT ID | String |
| No | NA | 100 |
Registered Resource EIC Code | String |
| No | NA | 10T-AL-GN-000112 |
Voltage limit | String |
| No |
| 100 |
NGC BM UNIT ID | String |
| No | NA | 200 |
Registered Resource Name | String |
| No | NA | BAGE-2 |
Document Type | String |
| No | NA | System total load |
Business Type | String |
| No | NA | Consumption |
Process Type | String |
| No | NA | Realised |
Active Flag | String |
| No | NA | Y |
Document Id | String |
| No | NA | NGET-EMFIP-ATL-401 |
Nominal | String |
| No | NA | 153.2 |
Implementation Date | String |
| No | NA | 2014-12-20 |
Decommissioning Date | String |
| No | NA | 2020-01-01 |
Service Name | DayAheadAggregatedGenerationService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B1430/<VersionNo>? APIKey=< APIKey>&SettlementDate=<SettlementDate>&Period=<Period>&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Time Series ID (Descending) |
API Web service – Request | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
APIKey | String |
| Yes | NA | AP8DA23 |
Settlement Date | String |
| Yes | YYYY-MM-DD | 2014-12-31 |
Period | String |
| Yes | */1-50 | 1 |
Service Type | String |
| No | NA | csv/xml |
API Web service – Response | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 |
Quantity | String |
| No |
| 200 |
Settlement Date | Date |
| No | YYYY-MM-DD | 2014-12-31 |
Settlement Period | int |
| No | */1-50 | 1 |
Document Type | String |
| No | NA | System total load |
Business Type | String |
| No | NA | Consumption |
Process Type | String |
| No | NA | Realised |
Resolution | String |
| No | NA | PT30M |
Curve Type | String |
| No | NA | Point |
Active Flag | String |
| No | NA | Y |
Document Id | String |
| No | NA | NGET-EMFIP-ATL-401 |
Document RevNum | String |
| No | NA | 1 |
Service Name | GenerationforecastsForWindAndSolarService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B1440/<VersionNo>? APIKey =< APIKey >&SettlementDate=<SettlementDate>&Period=<Period>&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Process Type (Ascending) |
API Web service – Request | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
APIKey | String |
| Yes | NA | AP8DA23 |
Settlement Date | String |
| Yes | YYYY-MM-DD | 2014-12-31 |
Period | String |
| Yes | */1-50 | 1 |
Process Type | String |
| No | NA | Day Ahead |
Service Type | String |
| No | NA | csv/xml |
API Web service – Response | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
Business Type | String |
| No | NA | Solar Generation |
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 |
Quantity | double |
| No |
| 200 |
Settlement Date | Date |
| No | YYYY-MM-DD | 2014-12-31 |
Settlement Period | int |
| No |
| 1 |
PSR Type | String |
| No | NA | Generation |
Document Type | String |
| No | NA | System total load |
Process Type | String |
| No | NA | Realised |
Resolution | String |
| No | NA | PT30M |
Curve Type | String |
| No | NA | Point |
Active Flag | String |
| No | NA | Y |
Document Id | String |
| No | NA | NGET-EMFIP-ATL-401 |
Document RevNum | String |
| No | NA | 1 |
Service Name | ActualGenerationOutputPerGenerationUnitService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B1610/<VersionNo>? APIKey =< APIKey >&SettlementDate=<SettlementDate>&Period=<Period>&NGCBMUnitID=<NGCBMUnitID>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Time Series ID (Descending) 3. This API was updated on 21 February 2019 to provide an enhanced hierarchical structure in the XML response that improves size, performance and readability. The updated API is called by specifying ‘V2’ as the version parameter in the input URL. 4. Version 1 of this API will no longer be available from 5 July 2019 |
API Web service – Request | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
APIKey | String |
| Yes | NA | AP8DA23 |
Settlement Date | String |
| Yes | YYYY-MM-DD | 2014-12-31 |
Period | String |
| Yes | */1-50 | 1 |
NGC BM Unit ID | String |
| No | NA | DRAXX-2 |
Service Type | String |
| No | NA | csv/xml |
API Web service – Response | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 |
Quantity | String |
| No | NA | 200 |
Settlement Date | Date |
| No | YYYY-MM-DD | 2014-12-31 |
Settlement Period | int |
| No | */1-50 | 1 |
PSR Type | String |
| No | NA | Generation |
Registered Resource EIC Code | String |
| No | NA | EIC2_A0001 |
Market Generation Unit EIC Code | String |
| No | NA | NG_Wales-Generation-121 |
Market Generation BM Unit | String |
| No | NA | NA |
Market Generation NGC BM Unit | String |
| No | NA | NA |
BM Unit ID | String |
| No | NA | NA |
NGC BM Unit ID | String |
| No | NA | NA |
Document Type | String |
| No | NA | System total load |
Business Type | String |
| No | NA | Consumption |
Process Type | String |
| No | NA | Realised |
Resolution | String |
| No | NA | PT30M |
Curve Type | String |
| No | NA | Point |
Active Flag | String |
| No | NA | Y |
Document Id | String |
| No | NA | NGET-EMFIP-ATL-401 |
Document RevNum | String |
| No | NA | 1 |
Service Name | ActualAggregatedGenerationPerTypeService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B1620/<VersionNo>? APIKey =< APIKey >&SettlementDate=<SettlementDate>&Period=<Period>&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Time Series ID (Descending) |
API Web service – Request | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
APIKey | String |
| Yes | NA | AP8DA23 |
Settlement Date | String |
| Yes | YYYY-MM-DD | 2014-12-31 |
Period | String |
| Yes | */1-50 | 1 |
Service Type | String |
| No | NA | csv/xml |
API Web service – Response | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
Business Type | String |
| No | NA | Solar Generation |
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 |
Quantity | String |
| No |
| 200 |
Settlement Date | Date |
| No | YYYY-MM-DD | 2014-12-31 |
Settlement Period | int |
| No | */1-50 | 1 |
PSR Type | String |
| No | NA | Generation |
Document Type | String |
| No | NA | System total load |
Process Type | String |
| No | NA | Realised |
Resolution | String |
| No | NA | PT30M |
Curve Type | String |
| No | NA | Point |
Active Flag | String |
| No | NA | Y |
Document Id | String |
| No | NA | NGET-EMFIP-ATL-401 |
Document RevNum | String |
| No | NA | 1 |
Service Name | ActualOrEstimatedWindAndSolarPowerGenerationService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B1630/<VersionNo>? APIKey =< APIKey >&SettlementDate=<SettlementDate>&Period=<Period>&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Time Series ID (Descending) |
API Web service – Request | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
APIKey | String |
| Yes | NA | AP8DA23 |
Settlement Date | String |
| Yes | YYYY-MM-DD | 2014-12-31 |
Period | String |
| Yes | */1-50 | 1 |
Service Type | String |
| No | NA | csv/xml |
API Web service – Response | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
Business Type | String |
| No | NA | Solar Generation |
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 |
Quantity | double |
| No |
| 200 |
Settlement Date | Date |
| No | YYYY-MM-DD | 2014-12-31 |
Settlement Period | int |
| No | */1-50 | 1 |
PSR Type | String |
| No | NA | Generation |
Document Type | String |
| No | NA | System total load |
Process Type | String |
| No | NA | Realised |
Resolution | String |
| No | NA | PT30M |
Curve Type | String |
| No | NA | Point |
Active Flag | String |
| No | NA | Y |
Document Id | String |
| No | NA | NGET-EMFIP-ATL-401 |
Document RevNum | String |
| No | NA | 1 |
Service Name | ExpansionandDismantlingProjectsService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B0910/<VersionNo>? APIKey =< APIKey >&Year=<Year>&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Time Series ID (Descending) |
API Web service – Request | ||||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data | |
APIKey | String |
| Yes | NA | AP8DA23 | |
Year | Int | - | Yes | YYYY | 2014 | |
Service Type | String |
| No | NA | csv/xml | |
API Web service – Response | ||||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data | |
Business Type | String |
| No | NA | Solar Generation | |
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 | |
Quantity | String |
| No |
| 200 | |
Asset Type | String |
| No | NA | Line | |
Reason Code | String |
| No | NA | Complementary Information | |
Reason Description | String |
| No | NA | Infrastructure End of Life | |
Location | String |
| No | NA | London | |
End Date | Date |
| No | NA | 2014-12-31 | |
BM UNIT Id | String |
| No | NA | NA | |
NGC BM Unit id | String |
| No | NA | NA | |
MRID(ASSET_EIC_CDE) | String |
| No | NA | mRID.12345678 | |
Doc Status | String |
| No | NA | Intermediate | |
Document Type | String |
| No | NA | Interconnection network expansion | |
Process Type | String |
| No | NA | Network information | |
Unit of Measure | String |
| No | NA | Meega Watt | |
resolution | String |
| No | NA | P1Y | |
Curve type | String |
| No | NA | Point | |
Active Flag | String |
| No | NA | Y | |
Document Id | String |
| No | NA | DEVUT-NGET-EMFIP-RST | |
Document Rev Num | String |
| No | NA | 12 | |
Year | int |
| No | NA | 2014 |
Service Name | CongestionManagementMeasuresCountertradingService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B1320/<VersionNo>? APIKey=< APIKey>&SettlementDate=<SettlementDate>&Period=<Period>&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Time Series ID (Descending) |
API Web service – Request | ||||||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data | |||
APIKey | String |
| Yes | NA | AP8DA23 | |||
Settlement Date | String |
| Yes | YYYY-MM-DD | 2014-12-31 | |||
Period | String |
| Yes | */1-50 | 1 | |||
Service Type | String |
| No | NA | csv/xml | |||
API Web service – Response | ||||||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data | |||
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 | |||
Quantity(MAW) | String |
| No |
| 200 | |||
Settlement Date | Date |
| No | YYYY-MM-DD | 2014-12-31 | |||
Settlement Period | int |
| No | */1-50 | 1 | |||
Reason Code | String |
| No | NA | Complementary Information | |||
Reason Description | String |
| No | NA | Infrastructure End of Life | |||
Flow Direction | String |
| No | NA | up | |||
Document Type | String |
| No | NA | Counter trade notice | |||
Process Type | String |
| No | NA | Realised | |||
Doc Status | String |
| No | NA | Intermediate | |||
resolution | String |
| No | NA | PT30M | |||
Curve type | String |
| No | NA | Sequential fixed size block | |||
Active Flag | String |
| No | NA | N | |||
Document Id | String |
| No | NA | DEVUT-NGET-EMFIP-RST | |||
Document Rev Num | String |
| No | NA | 2 |
Service Name | CongestionManagementMeasuresCostsOfCongestionManagementService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B1330/<VersionNo>? APIKey=< APIKey>&Year=<Year>&Month=<Month>&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Time Series ID (Descending) |
API Web service – Request | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
APIKey | String |
| Yes | NA | AP8DA23 |
Year | String |
| Yes | YYYY | 1905-07-06 |
Month | String |
| Yes | MM | 11 |
Service Type | String |
| No | NA | csv/xml |
API Web service – Response | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 |
Congestion Price(GBP) | String |
| No |
| 20012 |
Year | String |
| No | YYYY | 2014 |
Month | String |
| No | MM | Mar |
Reason Code | String |
| No | NA | Complementary Information |
Reason Description | String |
| No | NA | Infrastructure End of Life |
Document Type | String |
| No | NA | Congestion costs |
Process Type | String |
| No | NA | Realised |
Doc Status | String |
| No | NA | Intermediate |
resolution | String |
| No | NA | P1M |
business type | String |
| No | NA | Congestion costs |
Active Flag | String |
| No | NA | N |
Document Id | String |
| No | NA | DEVUT-NGET-EMFIP-Testingxx |
Document Rev Num | String |
| No | NA | 8 |
Service Name | PlannedUnavailabilityOfConsumptionUnitsService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B0710/<VersionNo>? StartDate =< StartDate >& EndTime =< EndTime >& StartTime =< StartTime >& APIKey=< APIKey > & EndDate =< EndDate >&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Time Series ID (Descending) |
API Web service – Request | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
APIKey | String |
| Yes | NA | AP8DA23 |
EndTime | String |
| Yes | mm:hh:ss ZZ | 15:00:00 ZZ |
StartTime | String |
| Yes | mm:hh:ss ZZ | 14:00:00 ZZ |
Start date | String |
| Yes | YYYY-MM-DD | 2014-12-31 |
End date | String |
| Yes | YYYY-MM-DD | 2014-12-31 |
Service Type | String |
| No | NA | csv/xml |
API Web service – Response | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
Business Type | String |
| No | NA | Solar Generation |
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 |
Start Date | Date |
| No | YYYY-MM-DD | 2014-12-31 |
End Date | Date |
| No | YYYY-MM-DD | 2014-12-31 |
Start Time | Date |
| No | mm:hh:ss ZZ | 14:00:00 ZZ |
End Time | Date |
| No | mm:hh:ss ZZ | 15:00:00 ZZ |
Quantity | String |
| No |
| 200 |
Reason Code | String |
| No | NA | shutdown |
Reason Description | String |
| No | NA | shut down for Maintenance |
Document Type | String |
| No | NA | Load unavailability |
Process Type | String |
| No | NA | Outage information |
Doc Status | String |
| No | NA |
|
Active Flag | String |
| No | NA | N |
Document Id | String |
| No | NA | NGET-PUCU-00001 |
Document Rev Num | String |
| No | NA | 2 |
BM UNIT Id | String |
| No | NA | NA |
AssestEICCode | String |
| No | NA | registered.12345 |
NGC BM Unit id | String |
| No | NA | NA |
Service Name | ChangesInActualAvailabilityOfConsumptionUnitsService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B0720/<VersionNo>?StartDate=<StartDate>&EndTime=<EndTime>&StartTime=<StartTime>&APIKey=<APIKey>&EndDate=<EndDate>&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Time Series ID (Descending) |
API Web service – Request | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
APIKey | String |
| Yes | NA | AP8DA23 |
Start date | String |
| Yes | YYYY-MM-DD | 2014-12-31 |
StartTime | String |
| Yes | mm:hh:ss ZZ | 14:00:00 ZZ |
End date | String |
| Yes | YYYY-MM-DD | 2014-12-31 |
EndTime | String |
| Yes | mm:hh:ss ZZ | 15:00:00 ZZ |
Service Type | String |
| No | NA | csv/xml |
API Web service – Response | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
Business Type | String |
| No | NA | Solar Generation |
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 |
Start Date | Date |
| No | YYYY-MM-DD | 2014-12-31 |
End Date | Date |
| No | YYYY-MM-DD | 2014-12-31 |
Start Time | Date |
| No | mm:hh:ss ZZ | 14:00:00 ZZ |
End Time | Date |
| No | mm:hh:ss ZZ | 15:00:00 ZZ |
Reason Code | String |
| No | NA | shutdown |
Reason Description | String |
| No | NA | shut down for Maintenance |
Quantity | String |
| No |
| 200 |
Document Type | String |
| No | NA | Load unavailability |
Process Type | String |
| No | NA | Outage information |
Doc Status | String |
| No | NA | NA |
Active Flag | String |
| No | NA | N |
Document Id | String |
| No | NA | NGET-PUCU-00001 |
Document Rev Num | String |
| No | NA | 2 |
Assest BM UNIT Id | String |
| No | NA | NA |
AssestEICCode | String |
| No | NA | registered.12345 |
NGC BM Unit id | String |
| No | NA | NA |
Service Name | PlannedUnavailabilityInTheTransmissionGridService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B1010/<VersionNo>?APIKey=<APIKey>&StartDate=<StartDate>&EndTime=<EndTime>&StartTime=<StartTime>&EndDate=<EndDate>&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Time Series ID (Descending) |
API Web service – Request | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
APIKey | String |
| Yes | NA | AP8DA23 |
Start date | String |
| Yes | YYYY-MM-DD | 2014-12-31 |
End date | String |
| Yes | YYYY-MM-DD | 2014-12-31 |
StartTime | String |
| Yes | mm:hh:ss ZZ | 14:00:00 ZZ |
EndTime | String |
| Yes | mm:hh:ss ZZ | 15:00:00 ZZ |
Service Type | String |
| No | NA | csv/xml |
API Web service – Response | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
Business Type | String |
| No | NA | Solar Generation |
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 |
Start Date | Date |
| No | YYYY-MM-DD | 2014-12-31 |
End Date | Date |
| No | YYYY-MM-DD | 2014-12-31 |
Start Time | Date |
| No | mm:hh:ss ZZ | 14:00:00 ZZ |
End Time | Date |
| No | mm:hh:ss ZZ | 15:00:00 ZZ |
Reason Code | String |
| No | NA | shutdown |
Reason Description | String |
| No | NA | shut down for Maintenance |
Asset EIC Code | String |
| No | NA | EIC_A001 |
BM Unit Id | String |
| No | NA | NA |
NGC BU Unit ID | String |
| No | NA | NA |
Asset Type | String |
| No | NA | Line |
Name | String |
| No | NA | NG -Wales_Line-L121 |
location | String |
| No | NA | London |
Quantity | String |
| No |
| 200 |
Document Type | String |
| No | NA | Transmission unavailability |
Process Type | String |
| No | NA | Outage information |
Doc Status | String |
| No | NA | NA |
Active Flag | String |
| No | NA | N |
Document Id | String |
| No | NA | NGET-PUCU-00001 |
Document Rev Num | String |
| No | NA | 1 |
Service Name | ChangesInActualAvailabilityInTheTransmissionGridService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B1020/<VersionNo>?APIKey=<APIKey>&StartDate=<StartDate>&EndDate=<EndDate>&StartTime=<StartTime>&EndTime=<EndTime>&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Time Series ID (Descending) |
API Web service – Request | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
APIKey | String |
| Yes | NA | AP8DA23 |
Start date | String |
| Yes | YYYY-MM-DD | 2014-12-31 |
End date | String |
| Yes | YYYY-MM-DD | 2014-12-31 |
StartTime | String |
| Yes | mm:hh:ss ZZ | 14:00:00 ZZ |
EndTime | String |
| Yes | mm:hh:ss ZZ | 15:00:00 ZZ |
Service Type | String |
| No | NA | csv/xml |
API Web service – Response | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
Business Type | String |
| No | NA | Solar Generation |
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 |
Start Date | Date |
| No | YYYY-MM-DD | 2014-12-31 |
End Date | Date |
| No | YYYY-MM-DD | 2014-12-31 |
Start Time | Date |
| No | mm:hh:ss ZZ | 14:00:00 ZZ |
End Time | Date |
| No | mm:hh:ss ZZ | 15:00:00 ZZ |
Reason Code | String |
| No | NA | shutdown |
Reason Description | String |
| No | NA | shut down for Maintenance |
Quantity | String |
| No |
| 200 |
Asset EIC Code | String |
| No | NA | EIC_A001 |
BM Unit Id | String |
| No | NA | NA |
NGC BU Unit ID | String |
| No | NA | NA |
Asset Type | String |
| No | NA | Line |
Name | String |
| No | NA | NG -Wales_Line-L121 |
location | String |
| No | NA | London |
Document Type | String |
| No | NA | Transmission unavailability |
Process Type | String |
| No | NA | Outage information |
Doc Status | String |
| No | NA | NA |
Active Flag | String |
| No | NA | N |
Document Id | String |
| No | NA | NGET-PUCU-00001 |
Document Rev Num | String |
| No | NA | 1 |
Service Name | ChangesInActualAvailabilityOfOffShoreGridInfrastructureService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B1030/<VersionNo>?APIKey=<APIKey>&StartDate=<StartDate>&EndDate=<EndDate>&StartTime=<StartTime>&EndTime=<EndTime>&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Time Series ID (Descending) |
API Web service – Request | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
APIKey | String |
| Yes | NA | AP8DA23 |
Start date | String |
| Yes | YYYY-MM-DD | 2014-12-31 |
End date | String |
| Yes | YYYY-MM-DD | 2014-12-31 |
StartTime | String |
| Yes | mm:hh:ss ZZ | 14:00:00 ZZ |
EndTime | String |
| Yes | mm:hh:ss ZZ | 15:00:00 ZZ |
Service Type | String |
| No | NA | csv/xml |
API Web service – Response | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
Business Type | String |
| No | NA | Solar Generation |
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 |
Start Date | Date |
| No | YYYY-MM-DD | 2014-12-31 |
End Date | Date |
| No | YYYY-MM-DD | 2014-12-31 |
Start Time | Date |
| No | mm:hh:ss ZZ | 14:00:00 ZZ |
End Time | Date |
| No | mm:hh:ss ZZ | 15:00:00 ZZ |
Reason Code | String |
| No | NA | shutdown |
Reason Description | String |
| No | NA | shut down for Maintenance |
Quantity | String |
| No |
| 200 |
Active Power | String |
| No |
| 50 |
Asset EIC Code | String |
| No | NA | EIC_A001 |
BM Unit Id | String |
| No | NA | NA |
NGC BU Unit ID | String |
| No | NA | NA |
Name | String |
| No | NA | NG -Wales_Line-L121 |
location | String |
| No | NA | London |
Document Type | String |
| No | NA | Generation unavailability |
Process Type | String |
| No | NA | Outage information |
Doc Status | String |
| No | NA | NA |
Active Flag | String |
| No | NA | N |
Document Id | String |
| No | NA | NGET-PUCU-00001 |
Document Rev Num | String |
| No | NA | 1 |
Service Name | PlannedUnavailabilityOfGenerationUnitsService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B1510/<VersionNo>?APIKey=<APIKey>&StartDate=<StartDate>&EndDate=<EndDate>&StartTime=<StartTime>&EndTime=<EndTime>&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Time Series ID (Descending) |
API Web service – Request | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
APIKey | String |
| Yes | NA | AP8DA23 |
Start date | String |
| Yes | YYYY-MM-DD | 2014-12-31 |
End date | String |
| Yes | YYYY-MM-DD | 2014-12-31 |
StartTime | String |
| Yes | mm:hh:ss ZZ | 14:00:00 ZZ |
EndTime | String |
| Yes | mm:hh:ss ZZ | 15:00:00 ZZ |
Service Type | String |
| No | NA | csv/xml |
API Web service – Response | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
Business Type | String |
| No | NA | Solar Generation |
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 |
Start Date | Date |
| No | YYYY-MM-DD | 2014-12-31 |
End Date | Date |
| No | YYYY-MM-DD | 2014-12-31 |
Start Time | Date |
| No | mm:hh:ss ZZ | 14:00:00 ZZ |
End Time | Date |
| No | mm:hh:ss ZZ | 15:00:00 ZZ |
Reason Code | String |
| No | NA | shutdown |
Reason Description | String |
| No | NA | shutdown for Maintenance |
Prod Registered Resource Active power | String |
| No | NA | 500 |
BM Unit Id | String |
| No | NA | NA |
NGC BU Unit ID | String |
| No | NA | NA |
Quantity | String |
| No |
| 200 |
Prod Registered Resource EIC CODE | String |
| No | NA | 10T-AL-WS-00015 |
Prod Registered Resource PSR name | String |
| No | NA | NG-Wales-Gen-G121 |
Prod Registered Resource type | String |
| No | NA | Generation |
Prod Registered Resource location | String |
| No | NA | London |
Document Type | String |
| No | NA | Production unavailability |
Process Type | String |
| No | NA | Outage information |
Doc Status | String |
| No | NA | Intermediate |
Active Flag | String |
| No | NA | N |
Document Id | String |
| No | NA | NGET-AAPU-00001t1 |
Document Rev Num | String |
| No | NA | 2 |
PSR EIC Code | String |
| No | NA | BMUnitEIC |
PSR NGC BM Unit ID | String |
| No | NA | T_COTPS-1 |
PSR BM Uni tID | String |
| No | NA | COTPS-1 |
PSR Name | String |
| No | NA | BMUnitEIC.name |
Service Name | ChangesInActualAvailabilityOfGenerationUnitsService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B1520/<VersionNo>?APIKey=<APIKey>&StartDate=<StartDate>&EndDate=<EndDate>&StartTime=<StartTime>&EndTime=<EndTime>&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Time Series ID (Descending) |
API Web service – Request | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
APIKey | String |
| Yes | NA | AP8DA23 |
Start date | String |
| Yes | YYYY-MM-DD | 2014-12-31 |
End date | String |
| Yes | YYYY-MM-DD | 2014-12-31 |
StartTime | String |
| Yes | mm:hh:ss ZZ | 14:00:00 ZZ |
EndTime | String |
| Yes | mm:hh:ss ZZ | 15:00:00 ZZ |
Service Type | String |
| No | NA | csv/xml |
API Web service – Response | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
Business Type | String |
| No | NA | Solar Generation |
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 |
Start Date | Date |
| No | YYYY-MM-DD | 2014-12-31 |
End Date | Date |
| No | YYYY-MM-DD | 2014-12-31 |
Start Time | Date |
| No | mm:hh:ss ZZ | 14:00:00 ZZ |
End Time | Date |
| No | mm:hh:ss ZZ | 15:00:00 ZZ |
Quantity(MAW) | String |
| No | dddd | 200 |
Prod Registered Resource EIC Code | String |
| No | NA | 10T-AL-WS-00015 |
Prod Registered Resource name | String |
| No | NA | NG-Wales-Gen-G121 |
Prod Registered Resource location | String |
| No | NA | London |
Reason Code | String |
| No | NA | Complementary Information |
Reason Description | String |
| No | NA | Infrastructure End of Life |
Prod Registered Resource Active | String |
| No | NA | 50 |
Prod Registered Resource type | String |
| No | NA | Generation |
Prod Registered PSR EIC Code | String |
| No | NA | BMUnitEIC1234 |
Document Type | String |
| No | NA | Generation unavailability |
Process Type | String |
| No | NA | Outage information |
Doc Status | String |
| No | NA | Intermediate |
Active Flag | String |
| No | NA | N |
Document Id | String |
| No | NA | NGET-AAGTYU |
Document Rev Num | String |
| No | NA | 2 |
Service Name | postPlannedUnavailabilityOfProductionUnitsService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B1530/<VersionNo>?APIKey=<APIKey>&StartDate=<StartDate>&EndDate=<EndDate>&StartTime=<StartTime>&EndTime=<EndTime>&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Time Series ID (Descending) |
API Web service – Request | ||||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data | |
APIKey | String |
| Yes | NA | AP8DA23 | |
Start date | String |
| Yes | YYYY-MM-DD | 2014-12-31 | |
End date | String |
| Yes | YYYY-MM-DD | 2014-12-31 | |
StartTime | String |
| Yes | mm:hh:ss ZZ | 14:00:00 ZZ | |
EndTime | String |
| Yes | mm:hh:ss ZZ | 15:00:00 ZZ | |
Service Type | String |
| No | NA | csv/xml | |
API Web service – Response | ||||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data | |
Business Type | String |
| No | NA | Solar Generation | |
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 | |
Start Date | Date |
| No | YYYY-MM-DD | 2014-12-31 | |
End Date | Date |
| No | YYYY-MM-DD | 2014-12-31 | |
Start Time | Date |
| No | mm:hh:ss ZZ | 14:00:00 ZZ | |
End Time | Date |
| No | mm:hh:ss ZZ | 15:00:00 ZZ | |
Reason Code | String |
| No | NA | Complementary Information | |
Reason Description | String |
| No | NA | Infrastructure End of Life | |
Quantity(MAW) | String |
| No |
| 200 | |
Prod Registered Resource EIC Code | String |
| No | NA | 10T-AL-WS-00015 | |
Prod Registered Resource name | String |
| No | NA | NG-Wales-Gen-G121 | |
Prod Registered Resource location | String |
| No | NA | London | |
Active power | String |
| No |
| 500 | |
Document Type | String |
| No | NA | Generation unavailability | |
Process Type | String |
| No | NA | Outage information | |
Doc Status | String |
| No | NA | Intermediate | |
Active Flag | String |
| No | NA | N | |
Document Id | String |
| No | NA | NGET-AAGTYU | |
Document Rev Num | String |
| No | NA | 2 |
Service Name | ChangesInActualAvailabilityOfProductionUnitsService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/B1540/<VersionNo>?APIKey=<APIKey>&StartDate=<StartDate>&EndDate=<EndDate>&StartTime=<StartTime>&EndTime=<EndTime>&ServiceType=<xml/csv> |
Output Format | XML/CSV |
Comments | 1. All the fields are Varchar data type at Database; hence we have assumed the field type has String. 2. Default sorting will be used by the application to sort the retrieve data. Default Sorting: Time Series ID (Descending) |
API Web service – Request | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
APIKey | String |
| Yes | NA | AP8DA23 |
Start date | String |
| Yes | YYYY-MM-DD | 2014-12-31 |
End date | String |
| Yes | YYYY-MM-DD | 2014-12-31 |
StartTime | String |
| Yes | mm:hh:ss ZZ | 14:00:00 ZZ |
EndTime | String |
| Yes | mm:hh:ss ZZ | 15:00:00 ZZ |
Service Type | String |
| No | NA | csv/xml |
API Web service – Response | |||||
Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
Business Type | String |
| No | NA | Solar Generation |
Time Series ID | String |
| No | NA | NGET-EMFIP-ATL-0002 |
Start Date | Date |
| No | YYYY-MM-DD | 2014-12-31 |
End Date | Date |
| No | YYYY-MM-DD | 2014-12-31 |
Start Time | Date |
| No | mm:hh:ss ZZ | 14:00:00 ZZ |
End Time | Date |
| No | mm:hh:ss ZZ | 15:00:00 ZZ |
Reason Code | String |
| No | NA | Complementary Information |
Reason Description | String |
| No | NA | Infrastructure End of Life |
Quantity(MAW) | String |
| No |
| 200 |
Prod Registered Resource EIC Code | String |
| No | NA | 10T-AL-WS-00015 |
Prod Registered Resource name | String |
| No | NA | NG-Wales-Gen-G121 |
Prod Registered Resource location | String |
| No | NA | London |
Active power | String |
| No |
| 500 |
Document Type | String |
| No | NA | Production unavailability |
Process Type | String |
| No | NA | Outage information |
Doc Status | String |
| No | NA | Intermediate |
Active Flag | String |
| No | NA | N |
Document Id | String |
| No | NA | NGET-AAPU-00001t1 |
Document Rev Num | String |
| No | NA | 2 |
Service Name | MessageListRetrievalService |
Method | GET |
Input URL |
https://api.bmreports.com/BMRS/MessageListRetrieval/v1?APIKey=<APIKey>&EventStart=<EventStart>&EventEnd=<EventEnd>&ServiceType=<xml/XML/csv/CSV>
https://api.bmreports.com/BMRS/MessageListRetrieval/v1?APIKey=<APIKey>&PublicationFrom=<PublicationFrom>&PublicationTo=<PublicationTo>&ServiceType=<xml/XML/csv/CSV>
https://api.bmreports.com/BMRS/MessageListRetrieval/v1?APIKey=<APIKey>&PublicationFrom=<PublicationFrom>&PublicationTo=<PublicationTo>&ServiceType=<xml/XML/csv/CSV>&AffectedUnitID=<AffectedID>&ParticipantId=<ParticipantID>&MessageID=<MessageID>&EventType=<EventType>&FuelType=<FuelType>
https://api.bmreports.com/BMRS/MessageListRetrieval/v1?APIKey=<APIKey>&EventStart=<EventStart>&EventEnd=<EventEnd>&ServiceType=<xml/XML/csv/CSV>&ActiveFlag=<ActiveFlag>
https://api.bmreports.com/BMRS/MessageListRetrieval/v1?APIKey=<APIKey>&EventStart=<EventStart>&EventEnd=<EventEnd>&ServiceType=<xml/XML/csv/CSV>&AffectedUnitID=<AffectedID>&ParticipantID=<ParticipantID>&MessageID=<MessageID>&EventType=<EventType>&FuelType=<FuelType> Note: Active Flag is used to retrieve only the latest revisions. Different urls are possible for this service by including optional parameters. |
Output Format | XML |
Comments |
|
Field Name | Field Type | Remarks | Mandatory | Sample data |
ApiKey | String | The key used to identify and authorize the request. | Yes |
|
EventStart | String | The start date of the event. This a fixed format string, like YYYY-MM-DD | No |
|
EventEnd | String | The end date of the event. This a fixed format string, like YYYY-MM-DD | No |
|
PublicationFrom | String | The start date of the publication. This a fixed format string, like YYYY-MM-DD | No |
|
PublicationTo | String | The end date of the publication. This a fixed format string, like YYYY-MM-DD | No |
|
ParticipantId | String | The ID of the participant. | No |
|
MessageID | String | The ID of the message. | No |
|
AssetID | String | The ID of the asset. | No |
|
EventType | String | The type of the event. | No |
|
FuelType | String | The type of the fuel. | No |
|
MessageType | String | The type of the message. | No |
|
UnavailabilityType | String | The type of the unavailability. | No |
|
ServiceType | String | The ServiceType must be xml/XML/csv/CSV. If not set, defaults to XML. | No |
|
API Web service – Response | ||||
Field Name | Field Type | Remarks | Mandatory | Sample data |
Message Id | String |
|
| 99X0000000000001-ELXP-RMT-00020072 |
Sequence Id | String |
|
| 1 |
Message Heading | String |
|
| EXAMGEN |
Event Type | String |
|
| Transmission unavailability |
Published Date Time | String |
|
| 2017-04-04 13:57:10 |
Participant ID | String |
|
| N_TEST |
Asset ID | String |
|
| N_TESTASSET9999999 |
Asset EIC Code | String |
|
| 51WX123123456789 |
Affected Unit | String |
|
| N_TESTXXXXXXXX |
Asset Normal Capacity | String |
|
| 10000000000.0 |
Available Capacity | String |
|
| 10000000000.0 |
Event Start | String |
|
| 2017-03-01 00:00:00 |
Event End | String |
|
| 2017-09-17 00:00:00 |
Duration Uncertainty | String |
|
| Lorem ipsum dolor |
Cause | String |
|
| Active |
Event Status | String |
|
| Dismissed |
Related Information | String |
|
| Aliquam erat volutpat. Etiam eget varius neque. |
Active Flag | String |
|
| Y |
Revision Number | String |
|
| 9 |
Message Type | String |
|
| Unavailabilities of Electricity Facilities |
Unavailability Type | String |
|
| Unplanned |
Service Name | MessageDetailRetrievalService |
Method | GET |
Input URL |
https://api.bmreports.com/BMRS/MessageDetailRetrieval/v1?APIKey=<APIKey>&MessageId=<MessageId>&ParticipantId=<ParticipantID>&SequenceId=<SequenceId>&ServiceType=<xml/XML/csv/CSV>
https://api.bmreports.com/BMRS/MessageDetailRetrieval/v1?APIKey=<APIKey>&MessageId=<MessageId>&ParticipantId=<ParticipantID>&ServiceType=<xml/XML/csv/CSV>
https://api.bmreports.com/BMRS/MessageDetailRetrieval/v1?APIKey=<APIKey>&MessageId=<MessageId>&ParticipantId=<ParticipantID>&ServiceType=<xml/XML/csv/CSV>&ActiveFlag=<ActiveFlag>
|
Output Format | XML |
Field Name | Field Type | Remarks | Mandatory | Sample data |
APIKey | String | The key used to identify and authorize the request. | Yes |
|
MessageId | String | Message ID | Yes |
|
ParticipantId | String | Participant ID for the remit message | Yes |
|
SequenceId | Integer | Sequence Id for the Message | No |
|
ActiveFlag | String | Active Flag to be given as Y/N | No |
|
ServiceType | String | The ServiceType must be xml/XML/csv/CSV. If not set, defaults to XML. | No |
|
API Web service – Response | ||||
Field Name | Field Type | Remarks | Mandatory | Sample data |
Message Id | String |
|
| 99X0000000000001-ELXP-RMT-00020072 |
Sequence Id | String |
|
| 1 |
Message Heading | String |
|
| EXAMGEN |
Event Type | String |
|
| Transmission unavailability |
Published Date Time | String |
|
| 2017-04-04 13:57:10 |
Participant ID | String |
|
| N_TEST |
Asset ID | String |
|
| N_TESTASSET9999999 |
Asset EIC Code | String |
|
| 51WX123123456789 |
Asset Type | String |
|
| Production |
Affected Unit | String |
|
| T_COTPS-1 |
Affected Area | String |
|
| N |
Fuel Type | String |
|
| Fossil Gas |
Asset Normal Capacity | String |
|
| 497.0 |
Available Capacity | String |
|
| 466.0 |
Unavailable Capacity | String |
|
| 31.0 |
Event Start | String |
|
| 2017-03-01 00:00:00 |
Event End | String |
|
| 2017-09-17 00:00:00 |
Duration Uncertainty | String |
|
| Lorem ipsum dolor |
Cause | String |
|
| Active |
Event Status | String |
|
| Dismissed |
Related Information | String |
|
| 4604: De-load for operational reasons. |
Active Flag | String |
|
| Y |
Message Type | String |
|
| Unavailabilities of Electricity Facilities |
Unavailability Type | String |
|
| Unplanned |
Acer Code | String |
|
| A00000000.AA |
Bidding Zone | String |
|
| 10YGB----------A |
Outage Profile Segment Start | String |
|
| 2017-04-04 13:30:00 |
Outage Profile Segment End | String |
|
| 2017-04-04 13:40:00 |
Outage Profile Segment Capacity | String |
|
| 9999999998 |
Revision Number | Integer |
|
| 3 |
Service Name | temperatureDataService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/TEMP/<VersionNo>?APIKey=<APIKey>&FromDate=<FromDate>&ToDate =<ToDate>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description | Default Sorting: Spot Time (Ascending) Input data flow : TEMP, REFTEMP
|
Comments | Default Value (if non specified): From Date = Current System Date – 3 months (configurable) ,To Date = Current System Date (i.e. Today) |
API Webservice – Request - Temperature Data | ||||
Logical Field Name | Field Type | Mandatory | Format | Sample data |
ApiKey | String | Yes | - | AP8DA23 |
From Date | String | No | YYYY-MM-DD | 2014-12-31 |
To Date | String | No | YYYY-MM-DD | 2014-12-31 |
Service Type | String | No | - | csv/CSV/xml/XML |
API Webservice – Response - Temperature Data |
| |||||
Header Record: |
| |||||
Report Output Field Mapping | Condition |
| ||||
Record Type | Fixed string value “HDR” |
| ||||
File Type | Fixed string value “TEMPERATURE DATA” |
| ||||
Body Record: |
| |||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample values | |
Record Type | String | - | No | TEMP | Fixed string value “TEMP” | |
Spot (Date)Time | Date | - | No | YYYY-MM-DD | 2014-10-13 | |
Temperature Out-Turn | Double | - | No | - | 9.5 | |
Normal Reference Temperature | Double | - | No | - | 9.6 | |
Low Reference Temperature | Double | - | No | - | 12.5 | |
High Reference Temperature | Double | - | No | - | 12.5 | |
Active Flag | String | - | No | - | Y |
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample values |
Record Type | String | - | No | TEMP | Fixed string value “TEMP” |
Spot (Date)Time | Date | - | No | YYYYMMDD | 20141013 |
Temperature Out-Turn | Double | - | No | - | 9.5 |
Normal Reference Temperature | Double | - | No | - | 9.6 |
Low Reference Temperature | Double | - | No | - | 12.5 |
High Reference Temperature | Double | - | No | - | 12.5 |
Also note that, even in cases where ‘From Date’ and ‘To Date’ are defined as optional with default values, either both should be absent or both have to be present.
FromDate should not be greater than ToDate. If so exception is thrown with appropriate Message.
Service Name | bidOfferLevelDataService |
Operation Name | bidOfferLevelDataImpl |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/BOD/<VersionNo>?APIKey=<APIKey>&SettlementDate=<SettlementDate>&SettlementPeriod=<SettlementPeriod>&BMUnitId=<BMUnitId>&BMUnitType=<BMUnitType>&LeadPartyName=<LeadPartyName>&NGCBMUnitName=<NGCBMUnitName>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description |
For other common description refer section 3.2 |
Comments |
|
API Webservice – Request – Bid Offer Level Data | |||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | String | - | No | 1 to 50 or * | 12 |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Service Type | String | - | No | - | csv/xml/CSV/XML |
API Webservice – Response - Bid Offer Level Data | |
Header Record: |
|
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “BID OFFER LEVEL DATA” |
Settlement Date | From input parameter |
Settlement Period | From input parameter |
Body Records: | |||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | “BOD” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | Date | - | No | yyyy-mm-dd | 2000-10-16 |
Settlement Period | Integer | - | No | - | 1 |
BM Offer Pair Number | Integer | - | No | - | 1, -1, etc. |
From Time | Date | - | No | yyyy-mm-dd hh:mm:ss | 2000-10-16 17:30:00 |
From Level | Integer | - | No | - | 0 |
To Time | Date | - | No | yyyy-mm-dd hh:mm:ss | 2000-10-16 17:30:00 |
To Level | Integer | - | No | - | 0 |
Bid Price | Double | - | No | - | 0 |
Offer Price | Double | - | No | - | 0 |
Active Flag | String | - | No | - | Y |
CSV Download Service: | |||||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | “BOD” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | Date | - | No | yyyymmdd | 20001016 |
Settlement Period | Integer | - | No | - | 1 |
BM Offer Pair Number | Integer | - | No | - | 1, -1, etc. |
From Time | Date | - | No | yyyymmddhhmmss | 20001016173000 |
From Level | Integer | - | No | - | 0 |
To Time | Date | - | No | yyyymmddhhmmss | 20001016173000 |
To Level | Integer | - | No | - | 0 |
Bid Price | Double | - | No | - | 0 |
Offer Price | Double | - | No | - | 0 |
Service Name | creditDefaultNoticeDataService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/CDN/<VersionNo>?APIKey=<APIKey>&FromClearedDate=<FromClearedDate>&ToClearedDate=<ToClearedDate>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description |
|
Comments |
|
API Webservice – Request - Credit Default Notices
| |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
From Cleared Date | String | DateTime | No | YYYY-DD-MM | 2014-12-12 |
To Cleared Date | String | DateTime | No | YYYY-DD-MM | 2014-12-12 |
Service Type | String | - | No | - | xml/XML/csv/CSV |
API Webservice – Response - Credit Default Notices | |
Header Record: | |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “CREDIT DEFAULT NOTICE DATA” |
Body Record: | |||||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed string value “CDN” |
Participant ID | String | - | No | - | NEEB |
Credit Default Level | Integer | - | No | - | 1 |
Entered Default Settlement Date | Date | - | No | yyyy-mm-dd | 2003-02-24 |
Energy Default Settlement Period | Integer | - | No | - | 2 |
Cleared Default Settlement Date | Date | - | No | yyyy-mm-dd | 2003-02-24 |
Cleared Default Settlement Period | Integer | - | No | - | 21 |
Cleared Default Text | String | - | No | - | Credit Cover Percentage <= 75% of credit limit(level default) |
Active Flag | String | - | No | - | Y |
CSV download service: | |||||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed string value “CDN” |
Participant ID | String | - | No | - | NEEB |
Credit Default Level | Integer | - | No |
| 1 |
Entered Default Settlement Date | Date | - | No |
| 20030224 |
Energy Default Settlement Period | Integer | - | No |
| 2 |
Cleared Default Settlement Date | Date | - | No |
| 20030224 |
Cleared Default Settlement Period | Integer | - | No | - | 21 |
Cleared Default Text | String | - | No | - | Credit Cover Percentage <= 75% of credit limit(level default) |
Also note that, even in cases where ‘From Date’ and ‘To Date’ are defined as optional with default values, either both should be absent or both have to be present.
FromDate should not be greater than ToDate. If so exception is thrown with appropriate Message.
Service Name | systemWarningsService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/SYSWARN/<VersionNo>?APIKey=<APIKey>&FromDate=<FromDate>&ToDate=<ToDate>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description |
|
Comments | Default Value (if none specified): From Date= Current System Date – 1 (configurable) To Date= Current System Date |
API Webservice – Request- SystemWarning
| |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
From Date | String | - | No | YYYY-MM-DD | 2014-12-31 |
To Date | String | - | No | YYYY-MM-DD | 2014-12-31 |
Service Type | String | - | No | - | csv/CSV/xml/XML |
API Webservice – Response- SystemWarning | |
Header Record: | |
Report Output Field Mapping | Condition |
Record Type | HDR |
File Type | SYSTEM WARNING |
Body Record: | |||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
RecordType | String | - | No | - | SYSWARN |
Warning Date/Time | Date | - | No | yyyy-mm-dd hh:mm | 2014-10-26 22:23 |
Warning Text | String | - | No | - | Text Data |
Active Flag | String | - | No | - | Y |
CSV Download Service | |||||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
RecordType | String | - | No | - | SYSWARN |
Warning Date/Time | Date | - | No | yyyymmddhhmm | 201410262223 |
Warning Text | String | - | No | - | Text Data |
Also note that, even in cases where ‘From Date’ and ‘To Date’ are defined as optional with default values, either both should be absent or both have to be present.
FromDate should not be greater than ToDate. If so exception is thrown with appropriate Message.
Service Name | balancingServicesAdjustmentActionDataService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/DISBSAD/<VersionNo>?APIKey=<APIKey>&SettlementDate=<SettlementDate>&SettlementPeriod=<SettlementPeriod>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description |
|
Comments |
|
API Webservice – Request - BalancingServicesAdjustmentActionData
| |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
Settlement Date | String | - | No | YYYY-MM-DD | 2041-08-15 |
Settlement Period | String | - | No | - | 1 to 50 |
Service Type | String | - | No | - | xml/XML/csv/CSV |
API Webservice – Response - BalancingServicesAdjustmentActionData | |
Header Record: | |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string “BALANCING SERVICES ADJUSTMENT DATA” |
Body Record: | |||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | DISAG |
Settlement Date | Date | - | No | yyyy-mm-dd | 2014-10-18 |
Settlement Period | Integer | - | No | - | 1 |
Action Identifier | Integer | - | No | - | 6 |
SO-Flag | String | - | No | - | T |
Balancing Services Adjustment Action STOR Provider Flag | String | - | No | - |
|
Action Cost | Double | - | No | - | 1031.53 |
Action Volume | Double | - | No | - | 150.25 |
Active Flag | String | - | No | - | Y |
CSV Download Service | |||||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | DISAG |
Settlement Date | Date | - | No | yyyymmdd | 20141018 |
Settlement Period | Integer | - | No | - | 1 |
Action Identifier | Integer | - | No | - | 6 |
SO-Flag | String | - | No | - | T |
Balancing Services Adjustment Action STOR Provider Flag | String | - | No | - |
|
Action Cost | Double | - | No | - | 1031.53 |
Action Volume | Double | - | No | - | 150.25 |
Service Name | balancingServiceAdjustmentDataService |
Method | GET |
Input URL | http://<host>:<port>/BMRS/ NETBSAD /<VersionNo>?APIKey=<APIKey>&SettlementDate=<SettlementDate>& SettlementPeriod =< SettlementPeriod >&IsTwoDayWindow=<IsTwoDayWindow>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description |
For other common description refer section 3.2 |
Comments |
Settlement Date= Current System Date (i.e. Today), Settlement Period = *, isTwoDayWindow=false |
API Webservice – Request - BalancingServiceAdjustmentData | |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
Settlement Date | String | - | No | YYYY-MM-DD | 2016-02-04 |
Settlement Period | String | - | No | - | 1 |
isTwoDayWindow | String | - | No | - | false |
Service Type | String | - | No | - | xml/XML/csv/CSV |
API Webservice – Response - BalancingServiceAdjustmentData | |
Header Record: | |
Report Output Field Mapping | Condition |
Record Type | HDR |
File Type | BALANCING SERVICE ADJUSTMENT DATA |
Body Record: | |||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | BSAD |
Settlement Date | Date | - | No | Yyyy-mm-dd | 2014-10-18 |
Settlement Period | Integer | - | No | - | 1 |
Net Energy Sell-Price Cost Adjustment – (ESCA) £ | Double | - | No | - | 60.23 |
Net Energy Sell-Price Volume Adjustment – (ESVA) MWh | Double | - | No | - | 1031.53 |
Net System Sell-Price Volume Adjustment – (SSVA) MWh | Double | - | No | - | 150.25 |
Sell-Price Price Adjust – (SPA) £/MWh | Double | - | No | - | 12.00 |
Net Energy Buy-Price Cost Adjustment – (EBCA) £ | Double | - | No | - | 0.0 |
Net Energy Buy-Price Volume Adjustment – (EBVA) MWh | Double | - | No | - | 0.000 |
Net System Buy-Price Volume Adjustment – (SBVA) MWh | Double | - | No | - | 0.000 |
Buy-Price Price Adjust (BPA) £/MWh | Double | - | No | - | 0.00 |
Active Flag | String | - | No | - | Y |
CSV Download service : | |||||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | BSAD |
Settlement Date | Date | - | No | yyyymmdd | 20141018 |
Settlement Period | Integer | - | No | - | 1 |
Net Energy Sell-Price Cost Adjustment – (ESCA) £ | Double | - | No | - | 60.23 |
Net Energy Sell-Price Volume Adjustment – (ESVA) MWh | Double | - | No | - | 1031.53 |
Net System Sell-Price Volume Adjustment – (SSVA) MWh | Double | - | No | - | 150.25 |
Sell-Price Price Adjust – (SPA) £/MWh | Double | - | No | - | 12.00 |
Net Energy Buy-Price Cost Adjustment – (EBCA) £ | Double | - | No | - | 0.0 |
Net Energy Buy-Price Volume Adjustment – (EBVA) MWh | Double | - | No | - | 0.000 |
Net System Buy-Price Volume Adjustment – (SBVA) MWh | Double | - | No | - | 0.000 |
Buy-Price Price Adjust (BPA) £/MWh | Double | - | No | - | 0.00 |
Also note that, even in cases where ‘From Date’ and ‘To Date’ are defined as optional with default values, either both should be absent or both have to be present.
FromDate should not be greater than ToDate. If so exception is thrown with appropriate Message.
Service Name | rollingSystemFrequencyService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/FREQ/<VersionNo>?APIKey=<APIKey>&FromDateTime=<FromDateTime>&ToDateTime=<ToDateTime>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description |
|
Comments |
|
API Webservice – Request - Rolling System Frequency
| |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
From DateTime | String | - | No | YYYY-MM-DD HH:MM:SS | 2014-10-10 10:10:10 |
To DateTime | String | - | No | YYYY-MM-DD HH:MM:SS | 2014-10-10 10:10:10 |
Service Type | String | - | No | - | xml/XML/csv/CSV |
API Webservice – Response - Rolling System Frequency | |
Header Record: | |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “SYSTEM FREQUENCY DATA” |
Body Record: | ||||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data | |
Record Type | String | - | No | VD | VD | |
Date | Date | - | No | YYYY-MM-DD | 2014-10-10 | |
Spot Time | Date | - | No | HH:mm:ss | 10:42:55 | |
Frequency(Hz) | Double | - | No | Derived data = Sum of demand across all the Fuel type (N0509) | 50000.09 | |
Active Flag | String | - | No | - | Y | |
CSV Download Service: | ||||||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data | |
Record Type | String | - | No | VD | VD | |
DateTime | Date | - | No | yyyyMMddHHmmss | 20141010101010 | |
Frequency(Hz) | Double | - | No | Derived data = Sum of demand across all the Fuel type (N0509) | 50000.00 |
Also note that, even in cases where ‘From Date Time’ and ‘To Date Time’ are defined as optional with default values, either both should be absent or both have to be present.
FromDateTimeshould not be greater than ToDateTime. If so exception is thrown with appropriate Message.
Service Name | marketIndexDataService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/MID/<VersionNo>?APIKey=<APIKey>&FromSettlementDate=<FromSettlementDate>&ToSettlementDate=<ToSettlementDate>&Period=<Period>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description |
|
Comments |
|
API Webservice Request - Market Index Data | ||||||||||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data | |||||||
From Settlement Date | String | - | No | YYYY-MM-DD | 2014-08-10 | |||||||
To Settlement Date | String | - | No | YYYY-MM-DD | 2014-08-11 | |||||||
Period | String | - | No | - | 1 to 50 or * | |||||||
ApiKey | String | - | Yes | - | AP8DA23 | |||||||
Service Type | String | - | No | - | csv/CSV/XML/xml | |||||||
API Webservice Response - Market Index Data |
| |||||||||||
Header Record: |
| |||||||||||
Report Output Field Mapping | Condition |
| ||||||||||
Record Type | Fixed string value “HDR” |
| ||||||||||
File Type | Fixed string value “MARKET INDEX DATA” |
| ||||||||||
Body Record: | ||||||||||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data | |||||||
Record Type | String | - | No | - | MID | |||||||
Data Provider | String | - | No | - | APXMIDP | |||||||
Settlement Date | Date | - | No | YYYY-MM-DD | 2014-08-11 | |||||||
Settlement Period | Integer | - | No | - | 1 to 50 | |||||||
Price | Double | - | No | - | 24.09 | |||||||
Volume | Double | - | No | - | 434.4 | |||||||
Active Flag | String | - | No | - | Y |
CSV Download service: | |||||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | MID |
Data Provider | String | - | No | - | APXMIDP |
Settlement Date | Date | - | No | YYYYMMDD | 20140811 |
Settlement Period | Integer | - | No | - | 50 |
Price | Double | - | No | - | 24.09 |
Volume | Double | - | No | - | 434.400 |
Also note that, even in cases where ‘FromSettlementDate and ‘ToSettlementDate are defined as optional with default values, either both should be absent or both have to be present.
FromSettlementDate should not be greater than ToSettlementDate. If so exception is thrown with appropriate Message.
Service Name | dailyEnergyVolumeDataService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/DEVINDOD/<VersionNo>?APIKey=<APIKey>&FromDate=<FromDate>&ToDate=<ToDate>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description |
|
Comments |
|
API Webservice – Request – DailyEnergyVolumeData
| |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
From Date | String | - | No | YYYY-MM-DD | 2013-10-24 |
To Date | String | - | No | YYYY-MM-DD | 2013-10-24 |
Service Type | String | - | No | - | xml/XML/csv/CSV |
API Webservice – Response – DailyEnergyVolumeData | |
Header Record: |
|
Report Output Field Mapping | Condition |
Record Type | HDR |
File Type | DAILY ENERGY VOLUME DATA |
Body Record: |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | INDOD |
Settlement Day | Date | - | No | yyyy-mm-dd | 2014-07-27 |
Daily Energy Volume Outturn | Integer | - | No | - | 628909 |
Daily Energy Volume Normal Reference | Integer | - | No | - | 594930 |
Daily Energy Volume Low Reference | Integer | - | No | - | 542739 |
Daily Energy Volume High Reference | Integer | - | No | - | 631710 |
Active Flag | String | - | No | - | Y |
CSV Download Service: |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | INDOD |
Settlement Day | Date | - | No | yyyymmdd | 20140727 |
Daily Energy Volume Outturn | Integer | - | No | - | 628909 |
Daily Energy Volume Normal Reference | Integer | - | No | - | 594930 |
Daily Energy Volume Low Reference | Integer | - | No | - | 542739 |
Daily Energy Volume High Reference | Integer | - | No | - | 631710 |
Also note that, even in cases where ‘From Date’ and ‘To Date’ are defined as optional with default values, either both should be absent or both have to be present.
FromDate should not be greater than ToDate. If so exception is thrown with appropriate Message.
Service Name | nonBMStorInstructedVolumeDataService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/NONBM/<VersionNo>?APIKey=<APIKey>&FromDate=<FromDate>&ToDate=<ToDate>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description |
|
Comments |
|
API Webservice – Request - Non - BM Stor Instructed Volumes | |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
From Date | String | - | No | YYYY-MM-DD | 2014-08-11 |
To Date | String | - | No | YYYY-MM-DD | 2014-08-12 |
ApiKey | String | - | Yes | - | AP8DA23 |
Service Type | String | - | No | - | csv/CSV/XML/xml |
Header Record: | |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “NON-BM STOR INSTRUCTED VOLUME DATA” |
Body Record: | |||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | NONBM |
Settlement Date | Date | - | No | Yyyy-mm-dd | 2014-08-11 |
Settlement Period | Integer | - | No | - | 1 to 50 |
SystemZone | String | - | No | - | Always N |
NONBM Publish Time | Date | - | No | Yyyy-mm-dd hh:mm:ss | 2014-08-10 15:22:00 |
Instructed Volume (MWh) | Integer | - | No | - | 12345 |
Active Flag | String | - | No | - | Y |
CSV Download Service : | |||||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | NONBM |
Settlement Date | Date | - | No | yyyymmdd | 20140811 |
Settlement Period | Integer | - | No | - | 1 to 50 |
SystemZone | String | - | No | - | Always N |
NONBM Publish Time | Date | - | No | yyyymmddhhmmss | 20140810152200 |
Instructed Volume (MWh) | Integer | - | No | - | 12345 |
Also note that, even in cases where ‘From Date’ and ‘To Date’ are defined as optional with default values, either both should be absent or both have to be present.
FromDate should not be greater than ToDate. If so exception is thrown with appropriate Message.
Service Name | applicableBalancingServiceVoulmeDataService |
Operation Name | applicableBalancingServiceVoulmeDataImpl |
Method | GET |
Input URL |
http://<host>:<port>/BMRS/QAS/<VersionNo>?APIKey=<APIKey>&SettlementDate=<SettlementDate>&SettlementPeriod=<SettlementPeriod>&BmUnitId=<BmUnitId>&BMUnitType=<BMUnitType>&LeadPartyName=<LeadPartyName>&NgcBmUnitName=<NgcBmUnitName>&ServiceType=<xml/XML/csv/CSV>
|
Output Format | XML/CSV |
Description |
For other common description refer section 3.2 |
Comments |
|
API Webservice – Request - Applicable Balancing Services Volume | |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
Settlement Date | String | - | No | YYYY-MM-DD HH:MM:SS | 2013-10-24 05:52:45 |
Settlement Period | String | - | No | 1 to 50 or * | 12 |
BM Unit ID | String | - | No | - | - |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | - |
Service Type | String | - | No | - | csv/CSV/xml/XML |
Header Record: | ||||||
Report Output Field Mapping | Condition | |||||
Record Type | Fixed string value “HDR” | |||||
File Type | Fixed string value “APPLICABLE BALANCING SERVICES VOLUME” | |||||
Body Record :Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data | |
Record Type | String | - | No | - | QAS | |
BM Unit Id | String | - | No | - | - | |
BM Unit Type | String | - | No | - | - | |
Lead Party Name | String | - | No | - | - | |
NGC BM Unit Name | String | - | No | - | BAGE-1 | |
Settlement Date | Date | - | No | Yyyy-mm-dd | 2014-07-27 | |
Settlement Period | Integer | - | No | - | 12 | |
Balancing Service Volume | Double | - | No | - | - | |
Active Flag | String | - | No | - | Y |
CSV Download Service: |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | QAS |
BM Unit Id | String | - | No | - | - |
BM Unit Type | String | - | No | - | - |
Lead Party Name | String | - | No | - | - |
NGC BM Unit Name | String | - | No | - | BAGE-1 |
Settlement Date | Date | - | No | yyyymmdd | 20140727 |
Settlement Period | Integer | - | No | - | 12 |
Balancing Service Volume | Double | - | No | - | - |
Service Name | rollingSystemDemandService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/ROLSYSDEM/<VersionNo>?APIKey=<APIKey>&FromDateTime=<FromDateTime>&ToDateTime=<ToDateTime>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description |
|
Comments | Default Value (if none specified): From Date = Current Date – 2 days, To Date = Current Date |
API Webservice – Request - Rolling System Demand | |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
From DateTime | String | - | No | YYYY-MM-DD HH:MM:SS | 2014-10-10 10:10:10 |
To DateTime | String | - | No | YYYY-MM-DD HH:MM:SS | 2014-10-10 10:10:10 |
Service Type | String | - | No | - | xml/XML/csv/CSV |
API Webservice – Response - Rolling System Demand | |
Header Record: | |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “ROLLING SYSTEM DEMAND” |
Body records : | |||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | VD | VD |
Date | Date | - | No | YYYY-MM-DD | 2013-10-24 |
Time | Date | - | No | HH:mm:ss | 10:42:55 |
Demand(MW) | Integer | - | No | Derived data = Sum of demand across all the Fuel type (N0509) | 50000 |
Active Flag | String | - | No | - | Y |
CSV Download Service: | |||||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | VD | VD |
Date | String | - | No | yyyyMMddHHmmss | 20131024101010 |
Demand(MW) | Integer | - | No | Derived data = Sum of demand across all the Fuel type (N0509) | 50000 |
Also note that, even in cases where ‘From Date’ and ‘To Date’ are defined as optional with default values, either both should be absent or both have to be present.
FromDate should not be greater than ToDate. If so exception is thrown with appropriate Message.
For CSV output Date and Time fields are concatenated and displayed
Service Name | peakWindGenerationForecastService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/WINDFORPK/<VersionNo>?APIKey=<APIKey>&FromDate=<FromDate>&ToDate=<ToDate>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description |
|
Comments |
|
API Webservice – Request - Peak Wind Generation Forecast
| |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
From Date | String | - | No | YYYY-MM-DD | 2014-10-10 |
To Date | String | - | No | YYYY-MM-DD | 2014-10-10 |
Service Type | String | - | No | - | xml/XML/csv/CSV |
API Webservice – Response - Peak Wind Generation Forecast | |
Header Record: | |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “PEAK WIND GENERATION FORECAST” |
Body Record: |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
RecordType | String | - | No | - | WINDFORPK |
Day & Date | Date | - | No | YYYY-MM-DD | 2014-10-10 |
Time of Maximum Wind Generation | Date | - | No | HH:mm | 14:00 |
Peak (Max) MW | Integer | - | No | - | 123 |
Total Metered Capacity (MW) | Integer | - | No | - | 456 |
Data Last updated | Date | - | No | Yyyy-mm-dd hh:mm | 2014-10-1010:10 |
Active Flag | String | - | No | - | Y |
CSV Download service |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
RecordType | String | - | No | - | WINDFORPK |
Day & Date | Date | - | No | yyyymmdd | 20141212 |
Time of Maximum Wind Generation | Date | - | No | HHmm | 1400 |
Peak (Max) MW | Integer | - | No | - | 123 |
Total Metered Capacity (MW) | Integer | - | No | - | 456 |
Data Last updated | Date | - | No | yyyymmddhhmm | 201410101010 |
Also note that, even in cases where ‘From Date’ and ‘To Date’ are defined as optional with default values, either both should be absent or both have to be present.
FromDate should not be greater than ToDate. If so exception is thrown with appropriate Message.
Service Name | windForecastOutTurnService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/WINDFORFUELHH/<VersionNo>?APIKey=<APIKey>&FromDate=<FromDate>&ToDate=<ToDate>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description |
|
Comments |
|
API Webservice – Request -Wind Forecast Out-turn | |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
From Date | String | - | No | YYYY-MM-DD | 2014-12-31 |
To Date | String | - | No | YYYY-MM-DD | 2014-12-31 |
Service Type | String | - | No | - | xml/XML/csv/CSV |
API Webservice – Response - Wind Forecast Out-turn | |
Header Record: | |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “WIND GENERATION FORECAST AND OUTTURN DATA” |
Body Record: |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | Fixed String “WIND” |
Settlement Date | Date | - | No | Yyyy-mm-dd | 2014-07-29 |
Settlement Period | Integer | - | No | - | 1 |
Publication Time (Initial Forecast) | String | - | No | Yyyy-mm-dd hh:mm:ss | 2008-04-27 17:00:00 |
Initial forecast Generation (MW) | String | - | No | - | - |
Publication Time (Latest Forecast) | String | - | No | Yyyy-mm-dd hh:mm:ss | 2008-04-27 17:00:00 |
Latest forecast Generation (MW) | String | - | No | - | - |
Publication Time (Out-turn) | String | - | No | Yyyy-mm-dd hh:mm:ss | 2008-04-27 17:00:00 |
Outturn Generation (MW) | String | - | No | - | - |
Active Flag | String | - | No | - | Y |
CSV Download Service | |||||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed String “WIND” |
Settlement Date | Date | - | No | yyyymmdd | 20140729 |
Settlement Period | Integer | - | No | - | 1 |
Publication Time (Initial Forecast) | String | - | No | yyyymmddhhmmss | 20080427170000 |
Initial forecast Generation (MW) | String | - | No | - | - |
Publication Time (Latest Forecast) | String | - | No | yyyymmddhhmmss | 20080427170000 |
Final forecast Generation (MW) | String | - | No | - | - |
Publication Time (Out-turn) | String | - | No | yyyymmddhhmmss | 20080427170000 |
Outturn Generation (MW) | String | - | No | - | - |
Also note that, even in cases where ‘From Date’ and ‘To Date’ are defined as optional with default values, either both should be absent or both have to be present.
FromDate should not be greater than ToDate. If so exception is thrown with appropriate Message.
Service Name | generationByFuelTypeCurrentService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/FUELINSTHHCUR/<VersionNo>?APIKey=<APIKey>&FuelType=<FuelType>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description |
|
Comments |
|
API Webservice – Request - Generation By Fuel Type (Current)
| |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
FuelType | String | - | No | - | COAL |
Service Type | String | - | No | - | xml/XML/csv/CSV |
API Webservice – Request - Generation By Fuel Type (Current) | |||||||
Report Output Field Mapping | Condition | ||||||
Record Type | Fixed string value “HDR” | ||||||
File Type | Fixed string value “GENERATION BY FUEL TYPE (CURRENT)” | ||||||
API Webservice – Request - Generation By Fuel Type (Current) | |||||||
|
| ||||||
Body Records: |
|
|
|
|
| ||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data | ||
RecordType | String | - | No | - | FUELINSTHHCUR | ||
GB Generating Plant | String | - | No | - | CCGT | ||
Bidding Zone | String | - | No |
| FRANCE | ||
Current MW | Integer | - | No | - | 12472 | ||
Current %age | Double | - | No | - | 39.2 | ||
Current Total MW | Integer | - | No | - | 31854 | ||
Current Total % | Double | - | No |
| 100 | ||
Last Half Hour | Date | - | No |
| 2014-07-29 13:00:00 | ||
Last Half Hour MW | Integer | - | No |
| 12522 | ||
Last Half Hour %age | Double | - | No |
| 39.3 | ||
Last Half Hour Total MW | Integer | - | No | - | 31825 | ||
Last Half Hour Total % | Double | - | No |
| 100 | ||
Last 24 Hours | Date | - | No |
| 2014-07-29 13:00:00 | ||
Last 24 Hours MW | Integer | - | No |
| 273320 | ||
Last 24 Hours %age | Double | - | No |
| 37.3 | ||
Last 24 Hours Total MW | Integer | - | No |
| 733475 | ||
Last 24 Hours Total % | Double | - | No |
| 100 | ||
Data Last Updated | Date | - | No |
| 2014-07-29 13:00:00 | ||
Active Flag | String | - | No | - | Y |
CSV Download Records : |
|
|
|
| |
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
RecordType | String | - | No | - | FUELINSTHHCUR |
GB Generating Plant | String | - | No | - | CCGT |
Current MW | Integer | - | No | - | 12472 |
Current %age | Decimal | - | No | - | 39.2 |
Current Total MW | Integer | - | No | - | 31854 |
Current Total % | Decimal | - | No | - | 100 |
Last Half Hour | Date | - | No |
| 20140729130000 |
Last Half Hour MW | Integer | - | No |
| 12522 |
Last Half Hour %age | Decimal | - | No |
| 39.3 |
Last Half Hour Total MW | Integer | - | No |
| 31825 |
Last Half Hour Total % | Decimal | - | No |
| 100 |
Last 24 Hours | Date | - | No |
| 20140729130000 |
Last 24 Hours MW | Integer | - | No |
| 273320 |
Last 24 Hours %age | Decimal | - | No |
| 37.3 |
Last 24 Hours Total MW | Integer | - | No |
| 733475 |
Last 24 Hours Total % | Decimal | - | No |
| 100 |
Data Last Updated | Date | - | No |
| 20140729130010 |
Service Name | generationByFuelType24HInstantDataService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/FUELINST/<VersionNo>?APIKey=<APIKey>&FromDateTime=<FromDateTime>&ToDateTime=<ToDateTime>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description |
|
Comments |
|
API Webservice – Request - Generation By Fuel Type (24H Instant Data) | |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
From DateTime | String | - | No | YYYY-MM-DD HH:MM:SS | 2014-07-29 13:00:00 |
To DateTime | String | - | No | YYYY-MM-DD HH:MM:SS | 2014-07-29 13:00:00 |
Service Type | String | - | No | - | xml/XML/csv/CSV |
API Webservice – Response - Generation By Fuel Type (24H Instant Data) | |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “INSTANTANEOUS GENERATION BY FUEL TYPE DATA” |
[1831-B]Body Record: |
|
|
|
| |
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | Fixed string value “FUELINST” |
Settlement Date | Date | - | No | yyyy-mm-dd | 2014-12-12 |
Settlement Period | Integer | - | No | - | 43 |
Spot Time | Date | - | No | yyyy-mm-dd hh:mm:ss | 2008-04-28 17:05:03 |
Bidding Zone | String | - | No |
| FRANCE |
Bidding Zone Total Generation | Integer | - | No |
| 12032 |
CCGT | Integer | - | No |
| 12032 |
OIL | Integer | - | No | - | 12032 |
COAL | Integer | - | No | - | 12032 |
NUCLEAR | Integer | - | No | - | 12032 |
WIND | Integer | - | No | - | 12032 |
PS | Integer | - | No | - | 12032 |
NPSHYD | Integer | - | No | - | 12032 |
OCGT | Integer | - | No | - | 12032 |
OTHER | Integer | - | No | - | 12032 |
INTFR | Integer | - | No | - | 12032 |
INTIRL | Integer | - | No | - | 12032 |
INTNED | Integer | - | No | - | 12032 |
INTEW | Integer | - | No | - | 12032 |
INTNEM | Integer |
| No |
| 13032 |
INTELEC | Integer |
| No |
| 13032 |
INTIFA2 | Integer |
| No |
| 13032 |
INTNSL | Integer |
| No |
| 13032 |
INTVKL | Integer |
| No |
| 13032 |
BIOMASS | Integer | - | No | - | 12032 |
Active Flag | String | - | No | - | Y |
[1831-B]CSV Download Service: | |||||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed string value “FUELINST” |
Settlement Date | Date | - | No | yyyymmdd | 20080428 |
Settlement Period | Integer | - | No | - | 43 |
Spot Time | Date | - | No | yyyymmddhhmmss | 20080428170503 |
CCGT | Integer | - | No | - | 12032 |
OIL | Integer | - | No | - | 12032 |
COAL | Integer | - | No | - | 12032 |
NUCLEAR | Integer | - | No | - | 12032 |
WIND | Integer | - | No | - | 12032 |
PS | Integer | - | No | - | 12032 |
NPSHYD | Integer | - | No | - | 12032 |
OCGT | Integer | - | No | - | 12032 |
OTHER | Integer | - | No | - | 12032 |
INTFR | Integer | - | No | - | 12032 |
INTIRL | Integer | - | No | - | 12032 |
INTNED | Integer | - | No | - | 12032 |
INTEW | Integer | - | No | - | 12032 |
BIOMASS | Integer | - | No | - | 12032 |
INTNEM | Integer |
| No |
| 12032 |
INTELEC | Integer |
| No |
| 12032 |
INTIFA2 | Integer |
| No |
| 12032 |
INTNSL | Integer |
| No |
| 12032 |
INTVKL | Integer |
| No |
| 12032 |
Also note that, even in cases where ‘FromDateTime’ and ‘ToDateTime’ are defined as optional with default values, either both should be absent or both have to be present.
FromDateTime should not be greater than ToDateTime. If so exception is thrown with appropriate Message.
Service Name | halfHourlyOutTurnGenerationByFuelTypeService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/FUELHH/<VersionNo>?APIKey=<APIKey>&FromDate=<FromDate>&ToDate=<ToDate>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description |
|
Comments | Default Value (if none specified): From Date = Current System Date – 1 (i.e. Yesterday), To Date = Current System Date (i.e. Today) |
API Webservice – Request - Half Hourly Outturn Generation By Fuel Type Data
| |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
From Date | String | - | No | YYYY-MM-DD | 2014-12-31 |
To Date | String | - | No | YYYY-MM-DD | 2014-12-31 |
Service Type | String | - | No | - | xml/XML/csv/CSV |
API Webservice – Response - Half Hourly Outturn Generation By Fuel Type Data | |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “HALF HOURLY OUTTURN GENERATION BY FUEL TYPE DATA” |
[1831-B]Body Record: |
|
|
| ||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | Fixed string value “FUELHH” |
Settlement Date | Date | - | No | yyyy-mm-dd | 2014-12-12 |
Settlement Period | Integer | - | No | - | 43 |
Bidding Zone | String | - | No |
| FRANCE |
Bidding Zone Total Generation | Integer | - | No |
| 12032 |
CCGT | Integer | - | No | - | 12032 |
OIL | Integer | - | No | - | 12032 |
COAL | Integer | - | No | - | 12032 |
NUCLEAR | Integer | - | No | - | 12032 |
WIND | Integer | - | No | - | 12032 |
PS | Integer | - | No | - | 12032 |
NPSHYD | Integer | - | No | - | 12032 |
OCGT | Integer | - | No | - | 12032 |
OTHER | Integer | - | No | - | 12032 |
INTFR | Integer | - | No | - | 12032 |
INTIRL | Integer | - | No | - | 12032 |
INTNED | Integer | - | No | - | 12032 |
INTEW | Integer | - | No | - | 12032 |
INTNEM | Integer | - | No | - | 12032 |
INTELEC | Integer | - | No | - | 12032 |
INTIFA2 | Integer | - | No | - | 12032 |
INTNSL | Integer | - | No | - | 12032 |
INTVKL | Integer |
| No | - | 12032 |
BIOMASS | Integer | - | No | - | 12032 |
Active Flag | String | - | No | - | Y |
[1831-B]CSV Download Service: | |||||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | NO | - | Fixed string value “FUELHH” |
Settlement Date | Date | - | NO | yyyymmdd | 20080428 |
Settlement Period | Integer | - | NO | - | 43 |
CCGT | Integer | - | NO | - | 12032 |
OIL | Integer | - | NO | - | 12032 |
COAL | Integer | - | NO | - | 12032 |
NUCLEAR | Integer | - | NO | - | 12032 |
WIND | Integer | - | NO | - | 12032 |
PS | Integer | - | NO | - | 12032 |
NPSHYD | Integer | - | NO | - | 12032 |
OCGT | Integer | - | NO | - | 12032 |
OTHER | Integer | - | NO | - | 12032 |
INTFR | Integer | - | NO | - | 12032 |
INTIRL | Integer | - | NO | - | 12032 |
INTNED | Integer | - | NO | - | 12032 |
INTEW | Integer | - | NO | - | 12032 |
BIOMASS | Integer | - | NO | - | 12032 |
INTNEM | Integer | - | NO | - | 12032 |
INTELEC | Integer | - | NO | - | 12032 |
INTIFA2 | Integer | - | NO | - | 12032 |
INTNSL | Integer | - | NO | - | 12032 |
INTVKL | Integer | - | NO | - | 12032 |
Also note that, even in cases where ‘From Date’ and ‘To Date’ are defined as optional with default values, either both should be absent or both have to be present.
FromDate should not be greater than ToDate. If so exception is thrown with appropriate Message.
Service Name | halfHourlyInterConnectorOutturnGenerationService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/INTERFUELHH/<VersionNo>?APIKey=<APIKey>&FromDate=<FromDate>&ToDate=<ToDate>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description |
|
Comments |
|
API Webservice – Request – HalfHourlyInterConnectorOutturnGeneration
| |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
Service Type | String | - | No | - | csv/CSV/xml/XML |
From Date | String | - | No | YYYY-MM-DD | 2014-12-31 |
To Date | String | - | No | YYYY-MM-DD | 2014-12-31 |
API Webservice – Response-HalfHourlyInterConnectorOutturnGeneration | |
Header Record: | |
Report Output Field Mapping | Condition |
Record Type | HDR |
File Type | HALF HOURLY INTERCONNECTOR OUTTURN GENERATION |
[1831-B]Body Record: | |||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | INTOUTHH |
Settlement Date | Date | - | No | yyyy-mm-dd | 2014-10-26 |
Settlement Period | Integer | - | No | - | 1 |
Bidding Zone | String | - | No |
| FRANCE |
Bidding Zone Total Generation | Integer | - | No |
| 12032 |
INTFR - External Interconnector flows with France | Integer | - | No | - | 1704 |
INTIRL - External Interconnector flows with Ireland | Integer | - | No | - | 202 |
INTNED - External Interconnector flows with the Netherlands | Integer | - | No | - | 852 |
INTEW - External Interconnector flows with Ireland (East-West) | Integer | - | No | - | 278 |
INTNEM – External Interconnector flows with Belgium (Nemo Link) | Integer | - | No | - | 278 |
INTELEC – External Interconnector flows with France (ElecLink) | Integer | - | No | - | 278 |
INTIFA2 – External Interconnector flows with France (IFA2) | Integer | - | No | - | 278 |
INTNSL – External Interconnector flows with Norway 2 (North Sea Link) | Integer | - | No | - | 278 |
INTVKL – External Interconnector flows with Denmark 1 (Viking Link) | Integer | - | No | - | 278 |
Active Flag | String | - | No | - | Y |
[1831-B]CSV Download Service | |||||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | INTOUTHH |
Settlement Date | Date | - | No | yyyymmdd | 20141026 |
Settlement Period | Integer | - | No | - | 1 |
INTFR - External Interconnector flows with France | Integer | - | No | - | 1704 |
INTIRL - External Interconnector flows with Ireland | Integer | - | No | - | 202 |
INTNED - External Interconnector flows with the Netherlands | Integer | - | No | - | 852 |
INTEW - External Interconnector flows with Ireland (East-West) | Integer | - | No | - | 278 |
INTNEM – External Interconnector flows with Belgium (Nemo Link) | Integer | - | No | - | 278 |
INTELEC – External Interconnector flows with France (ElecLink) | Integer | - | No | - | 278 |
INTIFA2 – External Interconnector flows with France (IFA2) | Integer | - | No | - | 278 |
INTNSL – External Interconnector flows with Norway 2 (North Sea Link) | Integer | - | No | - | 278 |
INTVKL – External Interconnector flows with Denmark 1 (Viking Link) | Integer | - | No | - | 278 |
Also note that, even in cases where ‘From Date’ and ‘To Date’ are defined as optional with default values, either both should be absent or both have to be present.
FromDate should not be greater than ToDate. If so exception is thrown with appropriate Message.
Service Name | nationalOutputUsable2T14DaysAheadService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/NOU2T14D/<VersionNo>?APIKey=<APIKey>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description |
|
Comments | Records are retrieved for date ranges between (Currentdate + 2 days) to (Currentdate + 14 days). Note that in legacy (existing) BMRS this data is available in CSV or XML. The header and footer labels in the snapshot are for that. These are not explicitly listed for Restful API. |
API Webservice – Request : National Output Usable Data for 2 to 14 days (NOU2T14D) | |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
Service Type | String | - | No | - | csv/CSV/xml/XML |
Header Record: | |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-14 DAYS) DATA |
Body Record: | |||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | Fixed string value “NOU2T14D” |
Publication Time | Date | - | No | Yyyy-mm-dd hh:mm:ss | 2014-11-03 14:45:00 |
System Zone | String | - | No | - | N |
Settlement Date | Date | - | No | Yyyy-mm-dd | 2014-07-27 |
Output Usable | Integer | - | No | - | 10045 |
Active Flag | String | - | No | - | Y |
CSV Download service | |||||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed string value “NOU2T14D” |
Publication Time | Date | - | No | YyyymmddHHmmss | 20141103144500 |
System Zone | String | - | No | - | N |
Settlement Date | Date | - | No | yyyymmdd | 20140727 |
Output Usable | Integer | - | No | - | 10045 |
Service Name | nationalOutputUsableByFuelType2T14DaysService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/FOU2T14D/<VersionNo>?APIKey=<APIKey>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description |
|
Comments | Records are retrieved for date ranges between (Currentdate + 2 days) to (Currentdate + 14 days) |
API Webservice – Request - NationalOutputUsableByFuelType2T14DaysService | |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
Service Type | String | - | No | - | xml/XML/csv/CSV |
API Webservice – Response - NationalOutputUsableByFuelType2T14DaysService | |
Header Record: | |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-14 DAYS) DATA – BY FUEL TYPE” |
Body Record : | |||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | FOU2T14D |
FuelType | String | - | No | - | COAL |
Publication (Date)Time | Date | - | No | Yyyy-mm-dd hh:mm:ss | 2010-01-02 15:50:00 |
System Zone | String | - | No | - | Must be 'N' |
Bidding Zone | String | - | No | - | FRANCE |
Settlement Date | Date | - | No | Yyyy-mm-dd | 2014-07-29 |
Output Usable | Integer | - | No | - | 100 |
Active Flag | String | - | No | - | Y |
CSV Download Service : | |||||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | FOU2T14D |
FuelType | String | - | No | - | COAL |
Publication (Date)Time | Date | - | No | yyyymmddhhmmss | 20100102155000 |
System Zone | String | - | No | - | Must be 'N' |
Settlement Date | Date | - | No | yyyymmdd | 20140729 |
Output Usable | Integer | - | No | - | 100 |
Service Name | nationalOutputUsableByBMUnitAndFuelType2T14DaysService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/UOU2T14D/<VersionNo>?APIKey=<APIKey>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description |
|
Comments | Records are retrieved for date ranges between (Currentdate + 2 days) to (Currentdate + 14 days) |
API Webservice - Request - NationalOutputUsableByBMUnitAndFuelType
| |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
Service Type | String | - | No | - | xml/XML/csv/CSV |
API Webservice - Response - NationalOutputUsableByBMUnitAndFuelType | |
Header Record: | |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-14 DAYS) DATA – BY BM UNIT/INTERCONNECTOR & FUELTYPE” |
Body Record : |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | UOU2T14D |
BM Unit ID | String | - | No | - | BMUNIT01 |
FuelType | String | - | No | - | CCGT |
Publication(Date) Time | Date | - | No | Yyyy-mm-dd hh:mm:ss | 2010-01-02 15:50:00 |
System Zone | String | - | No | - | Must be 'N' |
Bidding Zone | String | - | No | - | FRANCE |
Settlement Date | Date | - | No | Yyyy-mm-dd | 2014-07-29 |
Output Usable | Integer | - | No | - | 10000 |
Active Flag | String | - | No | - | Y |
CSV Download Service : |
|
|
| ||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | UOU2T14D |
BM Unit ID | String | - | No | - | BMUNIT01 |
FuelType | String | - | No | - | CCGT |
Publication(Date) Time | Date | - | No | Yyyymmdd hhmmss | 20100102155000 |
System Zone | String | - | No | - | Must be 'N' |
Settlement Date | Date | - | No | Yyyymmdd | 20140729 |
Output Usable | Integer | - | No | - | 10000 |
Service Name | nationalOutputUsable2T52WeeksService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/NOU2T52W/<VersionNo>?APIKey=<APIKey>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description |
|
Comments | Records are retrieved for date ranges between (Currentdate + 2 weeks) to (Currentdate + 52 weeks)
Note: The First day of week is considered as 'Monday'.
|
API Webservice – Request - NationalOutputUsable2T52Weeks | |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
Service Type | String | - | No | - | xml/XML/csv/CSV |
API Webservice – Response - NationalOutputUsable2T52Weeks | |||||||||||
Header Record: | |||||||||||
Report Output Field Mapping | Condition | ||||||||||
Record Type | Fixed string value “HDR” | ||||||||||
File Type | Fixed string value “NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-52 WEEKS)DATA” | ||||||||||
Body Record: | |||||||||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data | ||||||
Record Type | String | - | No | - | NOU2T52W | ||||||
Publication Time | Date | - | No | Yyyy-mm-dd hh: mm:ss | 2014-07-08 10:59:00 | ||||||
System Zone | String | - | No | - | N | ||||||
Calendar Week Number | Integer | - | No | - | 1 | ||||||
Calendar Year | Integer | - | No | YYYY | 2017 | ||||||
Output Usable | Integer | - | No | - | 69163 | ||||||
Active Flag | String | - | No | - | Y | ||||||
CSV Download Service : | |||||||||||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data | ||||||
Record Type | String | - | No | - | NOU2T52W | ||||||
Publication Time | Date | - | No | yyyymmddhhmmss | 20140708105900 | ||||||
System Zone | String | - | No | - | N | ||||||
Calendar Week Number | Integer | - | No | - | 1 | ||||||
Calendar Year | Integer | - | No | YYYY | 2017 | ||||||
Output Usable | Integer | - | No | - | 69163 |
Service Name | nationalOutputUsableByFuelType2T52WeeksService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/FOU2T52W/<VersionNo>?APIKey=<APIKey>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description |
|
Comments | Records are retrieved for date ranges between (Currentdate + 2 weeks) to (Currentdate + 52 weeks). The First day of week is considered as 'Monday'. |
API Webservice – Request - National Output Usable Data for 2- 52 Weeks | ||||||||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data | |||||
ApiKey | String | - | Yes | - | AP8DA23 | |||||
Service Type | String | - | No | - | csv/CSV/xml/XML | |||||
API Webservice – Response - National Output Usable Data for 2- 52 Weeks | ||||||||||
Header Record: | ||||||||||
Report Output Field Mapping | Condition | |||||||||
Record Type | HDR | |||||||||
File Type | NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-52 WEEKS) DATA –FUEL TYPE | |||||||||
Body Records: | ||||||||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data | |||||
Record Type | String | - | No | - | FOU2T52W | |||||
Fuel Type | String | - | No | - | COAL | |||||
Publishing Time | Date | - | No | Yyyy-mm-dd hh:mm:ss | 2014-10-16 13:45:00 | |||||
System Zone | String | - | No | NA | Always ‘N’ | |||||
Bidding Zone | String | - | No | - | FRANCE | |||||
Calendar Week Number | Integer | - | No | - | 1 | |||||
Calendar Year | Integer | - | No | YYYY | 2017 | |||||
Output Usable | Integer | - | No | - | 100 | |||||
Active Flag | String | - | No | - | Y |
CSV Download Service: | |||||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | FOU2T52W |
Fuel Type | String | - | No | - | COAL |
Publishing Time | Date | - | No | Yyyymmddhhmmss | 20141016134500 |
System Zone | String | - | No | NA | N |
Calendar Week Number | Integer |
| No | - | 1 |
Calendar Year | Integer | - | No | YYYY | 2017 |
Output Usable | Integer | - | No | - | 100 |
Service Name | nationalOutputUsableByFuelType&BMUnit2T52WeeksService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/UOU2T52W/<VersionNo>?APIKey=<APIKey>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description |
|
Comments | Records are retrieved for date ranges between (Currentdate + 2 weeks) to (Currentdate + 52 weeks). The First day of week is considered as 'Monday'. |
API Webservice - Request - NationalOutputUsableByFuelType&BMUnit2T52Weeks | |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
Service Type | String | - | No | - | xml/XML/csv/CSV |
API Webservice - Response - NationalOutputUsableByFuelType&BMUnit2T52Weeks | |
Header Record: | |
Report Output Field Mapping | Condition |
Record Type | HDR |
File Type | NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-52 WEEKS) DATA – BY BM UNIT/INTERCONNECTOR & FUEL TYPE |
Body Record: | |||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | UOU2T52W |
BM Unit ID | String | - | No | - | BMUNIT01 |
FuelType | String | - | No | - | COAL |
Publishing Time | Date | - | No | Yyyy-mm-dd hh:mm:ss | 2010-01-02 15:50:00 |
System Zone | String | - | No | - | Always ‘N’ |
Bidding Zone | String | - | No | - | FRANCE |
Calendar Week Number | Integer | - | No | - | 1 |
Calendar Year | Integer | - | No | YYYY | 2017 |
Output Usable | Integer | - | No | - | 100 |
Active Flag | String | - | No | - | Y |
CSV Download Service: | |||||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | UOU2T52W |
BM Unit ID | String | - | No | - | BMUNIT01 |
FuelType | String | - | No | - | COAL |
Publishing Time | Date | - | No | yyyymmddhhmmss | 20100102155012 |
System Zone | String | - | No | - | Always ‘N’ |
Calendar Week Number | Integer | - | No | - | 1 |
Calendar Year | Integer | - | No | YYYY | 2017 |
Output Usable | Integer | - | No | - | 100 |
Service Name | nationalOutputUsable2T156WeeksService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/NOU2T3YW/<VersionNo>?APIKey=<APIKey>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description | 1. Default Sorting: Calendar Year (Ascending), Calendar Week Number (Ascending) 2. Input data flow : NOU2T3YW |
Comments | Records are retrieved for date ranges between (Currentdate + 2 weeks) to (Currentdate + 156 weeks) Note: The First day of week is considered as 'Monday'. |
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
Service Type | String | - | No | - | xml/XML/csv/CSV |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-156 WEEKS)DATA” |
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | NOU2T3YW |
Publishing Period Commencing Time | Date | - | No | YYYY-MM-DD HH:MM:SS | 2020-07-21 10:59:00 |
System Zone | String | - | No | - | N |
Calendar Week Number | Integer | - | No | - | 1 |
Year | Integer | - | No | YYYY | 2020 |
Output Usable | Integer | - | No | - | 69163 |
Active Flag | String | Only active records are returned, as for NOU2T52W | No | - | Y |
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | NOU2T3YW |
Publishing Period Commencing Time | Date | - | No | YYYYMMDDHHMMSS | 20200721105900 |
System Zone | String | - | No | - | N |
Calendar Week Number | Integer | - | No | - | 1 |
Year | Integer | - | No | YYYY | 2020 |
Output Usable | Integer | - | No | - | 69163 |
Service Name | nationalOutputUsableByFuelType2T156WeeksService |
---|---|
Method | GET |
Input URL | https://api.bmreports.com/BMRS/FOU2T3YW/<VersionNo>?APIKey=<APIKey>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description | 1. Default Sorting: Calendar Year (Ascending), Calendar Week Number (Ascending), Fuel Type (Ascending) 2. Input data flow : FOU2T3YW |
Comments | Records are retrieved for date ranges between (Currentdate + 2 weeks) to (Currentdate + 156 weeks) Note: The First day of week is considered as 'Monday'. |
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
---|---|---|---|---|---|
ApiKey | String | - | Yes | - | AP8DA23 |
Service Type | String | - | No | - | xml/XML/csv/CSV |
Report Output Field Mapping | Condition |
---|---|
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-156 WEEKS)DATA –FUEL TYPE” |
Group Name: Response List | |||||
---|---|---|---|---|---|
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | FOU2T3YW |
Fuel Type | String | - | No | - | COAL |
Publishing Period Commencing Time | Date | - | No | YYYY-MM-DD HH:MM:SS | 2020-07-21 10:59:00 |
System Zone | String | - | No | - | N |
Calendar Week Number | Integer | - | No | - | 1 |
Year | Integer | - | No | YYYY | 2020 |
Output Usable | Integer | - | No | - | 69163 |
Active Flag | String | Only active records are returned, as for FOU2T52W | No | - | Y |
Bidding Zone | String | Only returned for Interconnector fuel types | No | - | FRANCE |
Group Name: Bidding Zone Total Generation | |||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Bidding Zone | String | - | No | - |
|
Record Type | String | - | No | - | FOU2T3YW |
Publishing Period Commencing Time | Date | - | No | - |
|
Calendar Week Number | Integer | - | No | - | 1 |
Year | Integer | - | No | YYYY | 2020 |
Output Usable | Integer | Sum of Output Usable in Response List for Bidding Zone, Calendar Week Number, and Year | No | - | 69163 |
Active Flag | String | Only active records are returned, as for FOU2T52W | No | - | Y |
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
---|---|---|---|---|---|
Record Type | String | - | No | - | FOU2T3YW |
Fuel Type | String | - | No | - | COAL |
Publishing Period Commencing Time | Date | - | No | YYYYMMDDHHMMSS | 20200721105900 |
System Zone | String | - | No | - | N |
Calendar Week Number | Integer | - | No | - | 1 |
Year | Integer | - | No | YYYY | 2020 |
Output Usable | Integer | - | No | - | 69163 |
Service Name | nationalOutputUsableByFuelType&BMUnit2T156WeeksService |
---|---|
Method | GET |
Input URL | https://api.bmreports.com/BMRS/UOU2T3YW/<VersionNo>?APIKey=<APIKey>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description | 1. Default Sorting: BM Unit Id (Ascending), Fuel Type (Ascending), Calendar Year (Ascending), Calendar Week Number (Ascending) 2. Input data flow : UOU2T3YW |
Comments | Records are retrieved for date ranges between (Currentdate + 2 weeks) to (Currentdate + 156 weeks) Note: The First day of week is considered as 'Monday'. |
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
---|---|---|---|---|---|
ApiKey | String | - | Yes | - | AP8DA23 |
Service Type | String | - | No | - | xml/XML/csv/CSV |
Report Output Field Mapping | Condition |
---|---|
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-156 WEEKS)DATA – BY BM UNIT & FUEL TYPE” |
Group Name: Response List | |||||
---|---|---|---|---|---|
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | UOU2T3YW |
BM Unit Name | String | - | No | - | BMUNIT01 |
Fuel Type | String | - | No | - | COAL |
Publishing Period Commencing Time | Date | - | No | YYYY-MM-DD HH:MM:SS | 2020-07-21 10:59:00 |
System Zone | String | - | No | - | N |
Calendar Week Number | Integer | - | No | - | 1 |
Year | Integer | - | No | YYYY | 2020 |
Output Usable | Integer | - | No | - | 69163 |
Active Flag | String | Only active records are returned, as for UOU2T52W | No | - | Y |
Bidding Zone | String | Only returned for Interconnector fuel types, derived by joining to DB_NETABMRS_REP.T_BMRS_BIDDING_ZONE_DATA | No | - | FRANCE |
Group Name: Bidding Zone Total Generation | |||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Bidding Zone | String | - | No | - |
|
Record Type | String | - | No | - | UOU2T3YW |
Publishing Period Commencing Time | Date | - | No | - |
|
Calendar Week Number | Integer | - | No | - | 1 |
Year | Integer | - | No | YYYY | 2020 |
Output Usable | Integer | Sum of Output Usable in Response List for Bidding Zone, Calendar Week Number, and Year | No | - | 69163 |
Active Flag | String | Only active records are returned, as for UOU2T52W | No | - | Y |
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
---|---|---|---|---|---|
Record Type | String | - | No | - | UOU2T3YW |
BM Unit ID | String | - | No | - | BMUNIT01 |
Fuel Type | String | - | No | - | COAL |
Publishing Period Commencing Time | Date | - | No | YYYYMMDDHHMMSS | 20200721105900 |
System Zone | String | - | No | - | N |
Calendar Week Number | Integer | - | No | - | 1 |
Year | Integer | - | No | YYYY | 2020 |
Output Usable | Integer | - | No | - | 69163 |
Service Name | initialDemandOutturnService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/INDOITSDO/<VersionNo>?APIKey=<APIKey>&FromDate=<FromDate>&ToDate=<ToDate>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description |
|
Comments |
|
API Webservice – Request – InitialDemandOutturn
| ||||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data | |
ApiKey | String | - | Yes | - | AP8DA23 | |
From Date | String | - | No | YYYY-MM-DD | 2014-12-31 | |
To Date | String | - | No | YYYY-MM-DD | 2014-12-31 | |
Service Type | String | - | No | - | csv/CSV/xml/XML | |
API Webservice – Response-InitialDemandOutturn | ||||||
Header Record: | ||||||
Report Output Field Mapping | Condition | |||||
Record Type | HDR | |||||
File Type | INITIAL DEMAND OUTTURN |
Body Record: | |||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Settlement Date | Date | - | No | yyyy-mm-dd |
2014-10-26 |
Settlement Period | Integer | - | No | - | 1 |
SystemZone | String | - | No | - | N |
Record Type | String | - | No | - | INDO |
Publish Time | Date | - | No | yyyy-mm-dd hh:mm:ss | 2014-10-25 23:30:00 |
Demand | Integer | - | No | - | 23039 |
Active Flag | String | - | No | - | Y |
CSV Download Service: | |||||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | INDO/ITSDO |
Settlement Date | Date | - | No | yyyymmdd |
20141026 |
Settlement Period | Integer | - | No | - | 1 |
SystemZone | String | - | No | - | N |
Publish Time | Date | - | No | yyyymmddhhmmsS | 20141025233000 |
Demand | Integer | - | No | - | 23039 |
Also note that, even in cases where ‘From Date’ and ‘To Date’ are defined as optional with default values, either both should be absent or both have to be present.
FromDate should not be greater than ToDate. If so exception is thrown with appropriate Message.
Service Name | forecastDayAndDayAheadMarginAndImbalanceService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/MELIMBALNGC/<VersionNo>?APIKey=<APIKey>&ZoneIdentifier=<ZoneIdentifier>&FromDate=<FromDate>&ToDate=<ToDate>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description |
|
Comments |
|
API Webservice – Request – ForecastDayAndDayAheadMarginAndImbalance
| |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
Zone Identifier | String | - | No | - | Default data N |
From Date | String | - | No | YYYY-MM-DD | 2014-08-11 |
To Date | String | - | No | YYYY-MM-DD | 2014-08-12 |
ApiKey | String | - | Yes | - | AP8DA23 |
Service Type | String | - | No | - | xml/XML/csv/CSV |
API Webservice – Response - ForecastDayAndDayAheadMarginAndImbalance | |
Header Record: | |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “FORECAST DAY AND DAY AHEAD MARGIN AND IMBALANCE DATA” |
Body Record :
| |||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Zone ID | String | - | No | - | B1 to B14 |
Settlement Date | Date | - | No | - | 2014-08-11 |
Settlement Period | Integer | - | No | - | 1 to 50 |
Record Type | String | - | No | - | Fixed string value -“DAM” or “DAI” |
Publish Time | Date | - | No | Yyyy-mm-dd hh:MM:ss | 2014-08-10 14:22:00 |
Margin/ImbalanceValue | Integer | Margin value or Imbalance Value will be present for corresponding record type. | No | - | 26223 |
Active Flag | String | - | No | - | Y |
CSV Download Service:
| |||||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Zone ID | String | - | No | - | B1 to B14 |
Settlement Date | Date | - | No | - | 20140811 |
Settlement Period | Integer | - | No | - | 1 to 50 |
Record Type | String | - | No | - | Fixed string value -“DAM” or “DAI” |
Publish Time | Date | - | No | Yyyymmdd hhMMss | 20140810142200 |
Margin/ ImbalanceValue | Integer | Margin value or Imbalance Value will be present for corresponding record type. | No | - | 26223 |
Also note that, even in cases where ‘From Date’ and ‘To Date’ are defined as optional with default values, either both should be absent or both have to be present.
FromDate should not be greater than ToDate. If so exception is thrown with appropriate Message.
Service Name | forecastDayAndDayAheadDemandDataService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/FORDAYDEM/<VersionNo>?APIKey=<APIKey>&ZoneIdentifier=<ZoneIdentifier>&FromDate=<FromDate>&ToDate=<ToDate>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description |
|
Comments |
|
API Webservice – Request - Forecast day and day ahead demand data | |||||||||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data | ||||||
Zone Identifier | String | - | No | - | Default Zone Identifier = N | ||||||
From Date | String | - | No | YYYY-MM-DD | 2014-08-11 | ||||||
To Date | String | - | No | YYYY-MM-DD | 2014-08-12 | ||||||
ApiKey | String | - | Yes | - | AP8DA23 | ||||||
Service Type | String | - | No | - | csv/CSV/XML/xml | ||||||
API Webservice – Response - Forecast day and day ahead demand data | |||||||||||
Header Record: | |||||||||||
Report Output Field Mapping | Condition | ||||||||||
Record Type | Fixed string value “HDR” | ||||||||||
File Type | Fixed string value “FORECAST DAY AND DAY AHEAD DEMAND DATA” | ||||||||||
Body Record: | |||||||||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data | ||||||
Zone (Boundary ID) | String | - | No | Always N | N | ||||||
Settlement Date | Date | - | No | yyyy-mm-dd | 2000-10-10 | ||||||
Settlement Period (S/P) | Integer | - | No | - | 10 | ||||||
Record Type | String | - | No | - | DANF | ||||||
Publish Time | Date | - | No | yyyy-mm-dd hh:mm:ss | 2000-10-16 22:00:00 | ||||||
Demand/SPNDemand/SPNGeneration | Integer | - | No | - | 9861 | ||||||
Active Flag | String | - | No | - | Y |
CSV Download Service: | |||||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | DANF |
Settlement Date | Date | - | No | yyyymmdd | 20141010 |
Settlement Period (S/P) | Integer | - | No | - | 10 |
Zone (Boundary ID) | String | - | No | Always N | N |
Publish Time | Date | - | No | yyyymmddhhmmss | 20001016220000 |
Demand/SPNDemand/SPNGeneration | Integer | - | No | - | 9861 |
Service Name | demandAndSurplusForecastData2T14DaysService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/DEMMF2T14D/<VersionNo>?APIKey=<APIKey>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description |
|
Comments | Records are retrieved for date ranges between (Currentdate + 2 days) to (Currentdate + 14 days) |
API Webservice – Request -DemandAndSurplusForecastData2T14Days
| |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
Service Type | String | - | No | - | csv/CSV/xml/XML |
API Webservice – Response- DemandAndSurplusForecastData2T14Days | |
Header Record: | |
Report Output Field Mapping | Condition |
Record Type | HDR |
File Type | FORECAST 2 TO 14 DAYS AHEAD DEMAND AND MARGIN DATA |
Body Record: | |||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Settlement Date | Date | - | No | yyyy-mm-dd | 2014-10-29 |
Settlement Period | Integer | - | No | - | 1 |
Boundary ID | String | - | No | - | Always is “N” |
Record Type | String | - | No | - | DSN (for NDFD)or DST (for TSDFD)or DSM (for OCNMFD)or OCNMFD2 (for OCNMFD2) |
Publication Time | Date | - | No | yyyy-mm-dd hh:mm:ss | 2014-10-26 14:45:00 |
demand/margin | Integer | If Record Type is DSN,DST we will have demand value, or DSM,OCNMFD2 we will have margin value | No | - | 45300 |
Active Flag | String | - | No | - | Y |
CSV Download Service: | |||||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Settlement Date | Date | - | No | yyyymmdd | 20141029 |
Settlement Period | Integer | - | No | - | 1 |
Boundary ID | String | - | No | - | Always is “N” |
Record Type | String |
| No | - | DSN (for NDFD)or DST (for TSDFD)or DSM (for OCNMFD)or OCNMFD2 (for OCNMFD2) |
Publication Time | Date | - | No | yyyymmddhhmmss | 20141026144500 |
demand/margin | Integer | If Record Type is DSN,DST we will have demand value, or DSM,OCNMFD2 we will have margin value | No |
| 45300 |
Service Name | demandAndSurplusForecastData2T52WeeksService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/DEMMF2T52W/<VersionNo>?APIKey=<APIKey>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description |
|
Comments | Records are retrieved for date ranges between (Currentdate + 2 weeks) to (Currentdate + 52 weeks). The First day of week is considered as 'Monday'. |
API Webservice – Request DemandAndSurplusForecastData2T52Weeks
| |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
Service Type | String | - | No | - | csv/CSV/xml/XML |
API Webservice – Response -DemandAndSurplusForecastData2T52Weeks
|
| |
Header Record |
| |
Report Output Field Mapping | Condition | |
Record Type | Fixed string value “HDR” | |
File Type | Fixed string value “FORECAST 2 TO 52 WEEKS AHEAD DEMAND AND MARGIN DATA” |
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample values |
Week Number | Integer | - | No | - | 46 |
Boundary ID | String | - | No | - | Always is “N” |
Record Type | String | - | No | - | “WN”(for NDFW) or “WT” (for TSDFW) or “WM” (for OCNMFW) or “OCNMFW2” (for OCNMFW2) |
Publication Time | Date | - | No | Yyyy-mm-dd hh:mm:ss | 2014-10-16 13:45:00 |
demand/margin | Integer | Depending upon Record type If it is WN,WT we will get Demand value else if it is WM,OCNMFW2 we will get Margin value. | No | - | 49500 |
Active Flag | String | - | No | - | Y |
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample values |
Week Number | Integer | - | No | - | 46 |
Boundary ID | String | - |
| - | Always is “N” |
Record Type | String | - | No | - | “WN”(for NDFW) or “WT” (for TSDFW) or “WM” (for OCNMFW) or “OCNMFW2” (for OCNMFW2) |
Publication Time | Date | - | No | yyyymmddhhmmss | 20141016134500 |
demand/margin | Integer | Depending upon Record type If it is WN,WT we will get Demand value else if it is WM,OCNMFW2 we will get Margin value. | No | - | 49500 |
Service Name | marginAndSurplusForecastData2T156WeeksService |
---|---|
Method | GET |
Input URL | https://api.bmreports.com/BMRS/MARSF2T3YW/<VersionNo>?APIKey=<APIKey>&RecordType=<RecordType>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description | 1. Default Sorting: Record Type 2. Week Number - Records ordered incrementing by this field (wraps from 156 to 1 when new year starts) 3. Input data flow: OCNMF3Y and OCNMF3Y2 |
Comments | Records are retrieved for date ranges between (Currentdate + 2 weeks) to (Currentdate + 156 weeks) Note: The First day of week is considered as 'Monday'. |
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
---|---|---|---|---|---|
ApiKey | String | - | Yes | - | AP8DA23 |
Service Type | String | - | No | - | xml/XML/csv/CSV |
Record Type | String | - | No | - | OCNMF3Y/OCNMF3Y2 |
Report Output Field Mapping | Condition |
---|---|
Record Type | Fixed string value “HDR” |
File Type | If requested Record Type = OCNMF3Y, fixed string value “FORECAST 2 TO 156 WEEKS AHEAD SURPLUS DATA” Else if requested Record Type = OCNMF3Y2, fixed string value “FORECAST 2 TO 156 WEEKS AHEAD MARGIN DATA” Else Fixed string value “FORECAST 2 TO 156 WEEKS AHEAD SURPLUS AND MARGIN DATA” |
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
---|---|---|---|---|---|
Record Type | String | - | No | - | OCNMF3Y or OCNMF3Y2 |
Calendar Week Number | Integer | - | No | - | 46 |
Year | Integer | - | No | YYYY | 2020 |
Boundary ID | String | - | No | - | N |
Publishing Period Commencing Time | Date | - | No | YYYY-MM-DD HH:MM:SS | 2020-07-21 10:59:00 |
Surplus / Margin | Integer | If OCNMF3Y, tag = Surplus If OCNMF3Y2, tag = Margin | No | - | 49500 |
Active Flag | String | Only active records are returned, as for DEMMF2T52W | No | - | Y |
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
---|---|---|---|---|---|
Record Type | String | - | No | - | OCNMF3Y or OCNMF3Y2 |
Week Number | Integer | - | No | - | 46 |
Year | Integer | - | No | YYYY | 2020 |
Boundary Id | String | - | No | - | N |
Publishing Period Commencing Time | Date | - | No | YYYYMMDDHHMMSS | 20200721105900 |
Surplus / Margin | Integer |
| No | - | 49500 |
Service Name | sosoPricesService |
Operation Name | sosoPricesImpl |
Method | GET |
Input URL |
https://api.bmreports.com/BMRS/SOSOP/<VersionNo>?APIKey=<APIKey>&SettlementDate=<SettlementDate>&StartTime=<StartTime>&TradeType=<TradeType>&IsTwoDayWindow=<IsTwoDayWindow>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description |
For other common description refer section 3.2 |
Comments | Default Value (if none specified): Settlement Date = Current System Date , Start Time = *, Trade Type = ALL, isTwoDayWindow=false |
API Webservice – Request - SO-SO Prices (SO-SO)
|
| |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data | |
ApiKey | String | - | Yes | - | AP8DA23 | |
Service Type | String | - | No | - | csv/CSV/xml/XML | |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-12-31 | |
Start time | String | - | No | HH:MM | - | |
Trade Type | String | - | No | - | ALL, BALIT_NG, BALIT_RTE, BritNed_NG, BritNed_TN, EWIC_EG, EWIC_NG, MOYLE_NG, MOYLE_SN | |
isTwoDayWindow | String | - | No | - | false |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed String value “SO-SO PRICES” |
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample values |
Record Type | String | - | No | - | SOSO |
Trade Type | String | - | No | - | BALIT_NG |
Start Time | Date | - | No | hh:mm:ss | 23:00:00 |
Date | Date | - | No | yyyy-mm-dd | 2014-09-08 |
Trade Direction | String | - | No | A01, A02 | A01 |
Contract Identification | String | - | No | - | NG_20140908_2300_20 |
Trade Quantity | Integer | - | No | MW | 55 |
Trade Price | Double | - | No | Currency/MWh | 57.07 |
Active Flag | String | - | No | - | Y |
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample values |
Record Type | String | - | No | - | SOSO |
Trade Type | String | - | No | - | BALIT_NG |
Start Time | Date | - | No | yyyymmddhhmmss | 20100422170000 |
Trade Direction | String | - | No | A01, A02 | A01 |
Contract Identification | String | - | No | - | NG_20140908_2300_20 |
Trade Quantity | Integer | - | No | MW | 55 |
Trade Price | Double | - | No | Currency/MWh | 57.07 |
Service Name | sosoTradesService |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/SOSOT/<VersionNo>?APIKey=<APIKey>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description |
|
Comments | - |
API Webservice – Request - SO-SO Trades | |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
Service Type | String | - | No | - | csv/CSV/xml/XML |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed String value “SO-SO TRADES” |
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample values |
RecordType | String | - | No | - | SOSOT |
Warning Date/Time | Date | - | No | yyyy-mm-dd hh:mm | 2014-12-31 13:31 |
Message Text | String | - | No | - | National Grid Notification |
Active Flag | String | - | No | - | Y |
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample values |
RecordType | String | - | No | - | SOSOT |
Warning Date/Time | Date | - | No | yyyymmddhhmm | 201412311331 |
Message Text | String | - | No | - | National Grid Notification |
Service Name | peakDemandService |
Operation Name | peakDemandImpl |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/PKDEMYESTTDYTOM/<VersionNo>?APIKey=<APIKey>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description | Default Sorting: Date (Ascending) Input data flow : TSDF , ITSDO For other common description refer section 2.3 |
Comments | - |
API Webservice – Request - Peak Demand
| ||||
Logical Field Name | Field Type | Mandatory | Format | Sample data |
ApiKey | String | Yes | - | AP8DA23 |
Service Type | String | No | - | csv/CSV/xml/XML |
API Webservice – Response - Peak Demand |
| |||||
Header Record: |
| |||||
Report Output Field Mapping | Condition |
| ||||
Record Type | Fixed string value “HDR” |
| ||||
File Type | Fixed string value “PEAK DEMAND DATA – YESTERDAY, TODAY, TOMORROW” |
| ||||
Body Record: |
| |||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample values | |
Record Type | String | - | No | PKDEM | Fixed string value “PKDEM” | |
Date | Date | - | No | YYYY-MM-DD | 2014-10-13 | |
Forecast Demand Peak (MW) | Integer | - | No | - | 154236 | |
Forecast Peak Demand Time (local time) | Date | - | No | HH:mm | 10:10 | |
Actual Demand Peak (MW) | Integer | - | No | - | 154236 | |
Actual Peak Demand Time (local time) | Date | - | No | HH:mm | 10:10 | |
Last Updated (GMT time of Forecast, or Actual if Actual showing) | Date | - | No | YYYY-MM-DD HH:mm | 2014-10-10 11:10 | |
Active Flag | String | - | No | - | Y |
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample values |
Record Type | String | - | No | PKDEM | Fixed string value “PKDEM” |
Date | Date | - | No | YYYYMMDD | 20141013 |
Forecast Demand Peak (MW) | Integer | - | No | - | 154236 |
Forecast Peak Demand Time (local time) | Date | - | No | HHmm | 10:10 |
Actual Demand Peak (MW) | Integer | - | No | - | 154236 |
Actual Peak Demand Time (local time) | Date | - | No | HHmm | 10:10 |
Last Updated (GMT time of Forecast, or Actual if Actual showing) | Date | - | No | YYYYMMDDHHmm | 201410101110 |
Active Flag | String | - | No | - | Y |
Service Name | indicativePeakDemandInformationService |
Operation Name | indicativePeakDemandInformationImpl |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/INDPKDEMINFO/<VersionNo>?APIKey=<APIKey> &ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description | Default Sorting: Data Set 1 : Date (Ascending) Data Set 2: Week Number (Ascending) Input data flow : ITSDO,TSDFW |
Source | MySQL |
Comments | - |
API Webservice – Request – Indicative Peak Demand Information (Using Operational Metering Data)
| |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
Service Type | String | - | No | - | xml/XML/csv/CSV |
API Webservice – Response - Indicative Peak Demand Information (Using Operational Metering Data)
| |
Header Record | |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “INDICATIVE PEAK DEMAND INFORMATION (USING OPERATIONAL METERING DATA)” |
Body Record : Data Set 1 |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | Fixed string value “3HIGHDEMSOFAR” |
Date | Date | - | No | YYYY-MM-DD | 2014-10-10 |
GB Demand (MW) | Integer | - | No | - | 12888 |
Time of peak | Date | - | No | HH:MM | 14:00 |
Active Flag | String | - | No | - | Y |
Body Record: Data Set 2 |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | Fixed string value “3HIGHFORDEM” |
Week Number | Integer | - | No | - | 5 |
GB Demand (MW) | Integer | - | No | - | 12866 |
Active Flag | String | - | No | - | Y |
Data Set 1 |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed string value “3HIGHDEMSOFAR” |
Date | Date | - | No | YYYYMMDD | 20141010 |
GB Demand (MW) | Integer | - | No | - | 12888 |
Time of peak | Date | - | No | HHMM | 1400 |
Active Flag | String | - | No | - | Y |
Data Set 2 |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed string value “3HIGHFORDEM” |
Week Number | Integer | - | No | - | 5 |
GB Demand (MW) | Integer | - | No | - | 12866 |
Active Flag | String | - | No | - | Y |
Service Name | systemDemandService |
Operation Name | systemDemandImpl |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/SYSDEM/<VersionNo>?APIKey=<APIKey>&FromDate=<FromDate>&ToDate=<ToDate>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description | Default Sorting: Settlement Date (Ascending),Settlement Period (Ascending) Input data flow : ITSDO,TSDF For other common description refer section 2.3 |
Source | MySQL |
Comments | Default Value (if none specified): From Date = Current System Date - 1 To Date = Current System Date +1 |
API Webservice – Request –System Demand | |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
From Date | String | - | No | YYYY-MM-DD | 2014-12-31 |
To Date | String | - | No | YYYY-MM-DD | 2014-12-31 |
Service Type | String | - | No | - | xml/XML/csv/CSV |
API Webservice – Response – System Demand | |
Header Record: | |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “SYSTEM DEMAND” |
Body Record: |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Settlement Date | Date | - | No | Yyyy-mm-dd | 2014-07-29 |
Settlement Period | Integer | - | No | - | 25 |
Record Type | String | - | No | - | Fixed string value “ITSDO” |
GB Demand (MW) | Integer | - | No | - | 14565 |
Record Type | String | - | No | - | Fixed string value “TSDF” |
GB Demand (MW) | Integer | - | No | - | 35469 |
Active Flag | String | - | No | - | Y |
|
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Settlement Date | Date | - | No | Yyyymmdd | 20140729 |
Settlement Period | Integer | - | No | - | 25 |
Record Type | String | - | No | - | Fixed string value “ITSDO” |
GB Demand (MW) | Integer | - | No | - | 14565 |
Record Type | String | - | No | - | Fixed string value “TSDF” |
GB Demand (MW) | Integer | - | No | - | 35469 |
Active Flag | String | - | No | - | Y |
Also note that, even in cases where ‘From Date’ and ‘To Date’ are defined as optional with default values, either both should be absent or both have to be present.
FromDate should not be greater than ToDate. If so exception is thrown with appropriate Message.
Service Name | indicativeTriadDemandInfoService |
Operation Name | indicativeTriadDemandInfoImpl |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/INDTRIADDEMINFO/<VersionNo>?APIKey=<APIKey>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description | Default Sorting: Date (Ascending) Input data flow : NA For other common description refer section 2.3 |
Comments | Note that there may not always be sufficient temporal separation to provide 3 peaks in which case it is shown as NULL |
API Webservice – Request - Peak Demand | ||||
Logical Field Name | Field Type | Mandatory | Format | Sample data |
ApiKey | String | Yes | - | AP8DA23 |
Service Type | String | No | - | csv/CSV/xml/XML |
API Webservice – Response - Peak Demand | |
Header Record: | |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “INDICATIVE TRIAD DEMAND INFORMATION (USING SETTLEMENT METERING DATA)” |
Body Record: |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | Fixed string value “TRIADSETTDATA” |
Date | Date | - | No | Yyyy-mm-dd | 2014-07-29 |
GB Demand (MW) | Integer | - | No | - | 14565 |
Time Of Peak | String | - | No | - | Fixed string value “TSDF” |
Data Last Updated | Date | - | No | YYYY-MM-DD HH:mm | 2014-07-29 14:10 |
Active Flag | String | - | No | - | Y |
|
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed string value “TRIADSETTDATA” |
Date | Date | - | No | Yyyymmdd | 20140729 |
GB Demand (MW) | Integer | - | No | - | 14565 |
Time Of Peak | String | - | No | - | Fixed string value “TSDF” |
Data Last Updated | Date | - | No | YYYYMMDDHHmm | 201407291410 |
Active Flag | String | - | No | - | Y |
Service Name | physicalBMDataService |
Operation Name | physicalBMDataImpl |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/PHYBMDATA/<VersionNo>?APIKey=<APIKey>&SettlementDate=<SettlementDate>&SettlementPeriod=<SettlementPeriod>&BMUnitId=<BMUnitId>&BMUnitType=<BMUnitType>&LeadPartyName=<LeadPartyName>&NGCBMUnitName=<NGCBMUnitName>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description |
|
Comments | Default Value (if none specified): Settlement Date = {as per NRT criteria}, Settlement Period = {as per NRT criteria},BM Unit Id = *, BM Unit Type = *, Lead Party Name = *, NGC BM Unit Name = * (* implies all values) |
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data | |
ApiKey | String | - | Yes | - | AP8DA23 | |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 | |
Settlement Period | String | - | No | 1 to 50 or * | 12 | |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 | |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc | |
Lead Party Name | String | - | No | - | AES New Energy Limited | |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 | |
Service Type | String | - | No | - | csv/xml/CSV/XML | |
API Webservice – Response – Physical BM Data | ||||||
Header Record: |
| |||||
Report Output Field Mapping | Condition | |||||
Record Type | Fixed string value “HDR” | |||||
File Type | Fixed string value “PHYSICAL BM DATA” | |||||
Settlement Date | From input parameter | |||||
Settlement Period | From input parameter |
FPN Data : | |||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | “PN” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
From Time | Date | - | No | yyyy-mm-dd hh:mm:ss | 2000-10-16 17:30:00 |
From Level | Double | - | No | - | 0.000 |
To Time | Date | - | No | yyyy-mm-dd hh:mm:ss | 2000-10-16 17:30:00 |
To Level | Double | - | No | - | 0.000 |
Active Flag | String | - | No | - | Y |
QPN Data : | |||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | “QPN” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
From Time | Date | - | No | yyyy-mm-dd hh:mm:ss | 2000-10-16 17:30:00 |
From Level | Double | - | No | - | 0.000 |
To Time | Date | - | No | yyyy-mm-dd hh:mm:ss | 2000-10-16 17:30:00 |
To Level | Double | - | No | - | 0.000 |
Active Flag | String | - | No | - | Y |
MEL Data : | |||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | “MEL” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
From Time | Date | - | No | yyyy-mm-dd hh:mm:ss | 2000-10-16 17:30:00 |
From Level | Double | - | No | - | 0.000 |
To Time | Date | - | No | yyyy-mm-dd hh:mm:ss | 2000-10-16 17:30:00 |
To Level | Double | - | No | - | 0.000 |
Active Flag | String | - | No | - | Y |
MIL Data : | |||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | “MIL” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
From Time | Date | - | No | yyyy-mm-dd hh:mm:ss | 2000-10-16 17:30:00 |
From Level | Double | - | No | - | 0.000 |
To Time | Date | - | No | yyyy-mm-dd hh:mm:ss | 2000-10-16 17:30:00 |
To Level | Double | - | No | - | 0.000 |
Active Flag | String | - | No | - | Y |
BOALF Data : | |||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | “BOALF” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
Bid Offer Acceptance ID | Integer | - | No | - | 2564812568 |
Acceptance Time | Date | - | No | - | 2000-10-16 17:30:00 |
Deemed Flag | String | - | No | - | N |
SO-Flag | String | - | No | - | F |
STOR Provider Flag | String | - | No | - |
|
RR Instruction Flag | String | - | No | - | F |
RR Schedule Flag | String | - | No | - | F |
From Time | Date | - | No | yyyy-mm-dd hh:mm:ss | 2000-10-16 17:30:00 |
From Level | Double | - | No | - | 0.000 |
To Time | Date | - | No | yyyy-mm-dd hh:mm:ss | 2000-10-16 17:30:00 |
To Level | Double | - | No | - | 0.000 |
Active Flag | String | - | No | - | Y |
FPN Data : | |||||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | “PN” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
From Time | Date | - | No | yyyymmddhhmmss | 20001016173000 |
From Level | Double | - | No | - | 0.000 |
To Time | Date | - | No | yyyymmddhhmmss | 20001016173000 |
To Level | Double | - | No | - | 0.000 |
QPN data : | |||||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | “QPN” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
From Time | Date | - | No | yyyymmddhhmmss | 20001016173000 |
From Level | Double | - | No | - | 0.000 |
To Time | Date | - | No | yyyymmddhhmmss | 20001016173000 |
To Level | Double | - | No | - | 0.000 |
MEL Data : | |||||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | “MEL” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
From Time | Date | - | No | yyyymmddhhmmss | 20001016173000 |
From Level | Double | - | No | - | 0.000 |
To Time | Date | - | No | yyyymmddhhmmss | 20001016173000 |
To Level | Double | - | No | - | 0.000 |
MIL Data : | |||||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | “MIL” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
From Time | Date | - | No | yyyymmddhhmmss | 20001016173000 |
From Level | Double | - | No | - | 0.000 |
To Time | Date | - | No | yyyymmddhhmmss | 20001016173000 |
To Level | Double | - | No | - | 0.000 |
BOALF Data : | |||||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | “BOALF” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
Bid Offer Acceptance ID | Integer | - | No | - | 2564812568 |
Acceptance Time | Date | - | No | YYYYMMDDHHMMSS | 20001016173000 |
Deemed Flag | String | - | No | - | N |
SO-Flag | String | - | No | - | F |
STOR Provider Flag | String | - | No | - |
|
RR Instruction Flag | String | - | No | - | F |
RR Schedule Flag | String | - | No | - | F |
From Time | Date | - | No | yyyymmddhhmmss | 20001016173000 |
From Level | Double | - | No | - | 0.000 |
To Time | Date | - | No | yyyymmddhhmmss | 20001016173000 |
To Level | Double | - | No | - | 0.000 |
Service Name | dynamicDataService |
Operation Name | dynamicDataImpl |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/DYNBMDATA/<VersionNo>?APIKey=<APIKey>&SettlementDate=<SettlementDate>&SettlementPeriod=<SettlementPeriod>&BMUnitId=<BMUnitId>&BMUnitType=<BMUnitType>&LeadPartyName=<LeadPartyName>&NGCBMUnitName=<NGCBMUnitName>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description | Default Sorting: BM Unit ID Settlement Period (ascending) (from body) Time (ascending) Input data flow : RURE,RDRE,RURI,NDZ,NTB,NTO,MZT,MNZT,SEL,SIL |
Comments | Default Value (if none specified): Settlement Date = {as per NRT criteria} Settlement Period = {as per NRT criteria} BM Unit Id = * BM Unit Type = * Lead Party Name = * NGC BM Unit Name = * (* implies all values) |
API Webservice – Request –Dynamic Data | |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | String | - | No | 1 to 50 or * | 12 |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Service Type | String | - | No | - | xml/XML/csv/CSV |
API Webservice – Response - Dynamic Data | |
Header Record | |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “Dynamic Data” |
Settlement Date | From input parameter |
Settlement Period | From input parameter |
RURE Data |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | Fixed string value “RURE” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
Time | Date | - | No | YYYY-MM-DD HH:MM | 2014-02-03 14:00 |
Rate 1 | Double | - | No | - | 254.2 |
Elbow 2 | Integer | - | No | - | 2541 |
Rate 2 | Double | - | No | - | 245.0 |
Elbow 3 | Integer | - | No | - | 2456 |
Rate 3 | Double | - | No | - | 256.6 |
Active Flag | String | - | No | - | Y |
RDRE Data |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | Fixed string value “RDRE” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
Time | Date | - | No | YYYY-MM-DD HH:MM | 2014-02-03 14:00 |
Rate 1 | Double | - | No | - | 254.2 |
Elbow 2 | Integer | - | No | - | 2541 |
Rate 2 | Double | - | No | - | 245.0 |
Elbow 3 | Integer | - | No | - | 2456 |
Rate 3 | Double | - | No | - | 256.6 |
Active Flag | String | - | No | - | Y |
RURI Data |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | Fixed string value “RURI” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
Time | Date | - | No | YYYY-MM-DD HH:MM | 2014-02-03 14:00 |
Rate 1 | Double | - | No | - | 254.2 |
Elbow 2 | Integer | - | No | - | 2541 |
Rate 2 | Double | - | No | - | 245.0 |
Elbow 3 | Integer | - | No | - | 2456 |
Rate 3 | Double | - | No | - | 256.6 |
Active Flag | String | - | No | - | Y |
RURE Data |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | Fixed string value “RURE” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
Time | Date | - | No | YYYY-MM-DD HH:MM | 2014-02-03 14:00 |
Rate 1 | Double | - | No | - | 254.2 |
Elbow 2 | Integer | - | No | - | 2541 |
Rate 2 | Double | - | No | - | 245.0 |
Elbow 3 | Integer | - | No | - | 2456 |
Rate 3 | Double | - | No | - | 256.6 |
Active Flag | String | - | No | - | Y |
NDZ Data |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | Fixed string value “NDZ” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
Time | Date | - | No | YYYY-MM-DD HH:MM | 2014-03-03 13:00 |
Notice | Double | - | No | - | 2.000 |
Active Flag | String | - | No | - | Y |
NDB Data |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | Fixed string value “NDB” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
Time | Date | - | No | YYYY-MM-DD HH:MM | 2014-03-03 13:00 |
Notice | Double | - | No | - | 2.000 |
Active Flag | String | - | No | - | Y |
NDO Data |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | Fixed string value “NDO” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
Time | Date | - | No | YYYY-MM-DD HH:MM | 2014-03-03 13:00 |
Notice | Double | - | No | - | 2.000 |
Active Flag | String | - | No | - | Y |
MZT Data |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | Fixed string value “MZT” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
Time | Date | - | No | YYYY-MM-DD HH:MM | 2014-03-03 13:00 |
Period | Double | - | No | - | 240.000 |
Active Flag | String | - | No | - | Y |
MNZT Data | |||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | Fixed string value “MNZT” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
Time | Date | - | No | YYYY-MM-DD HH:MM | 2014-03-03 13:00 |
Period | Double | - | No | - | 240.000 |
Active Flag | String | - | No | - | Y |
SEL Data |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | Fixed string value “SEL” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
Time | Date | - | No | YYYY-MM-DD HH:MM | 2014-03-03 13:00 |
Level | Double | - | No | - | 240.000 |
Active Flag | String | - | No | - | Y |
SIL Data |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | Fixed string value “SIL” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
Time | Date | - | No | YYYY-MM-DD HH:MM | 2014-03-03 13:00 |
Level | Double | - | No | - | 240.000 |
Active Flag | String | - | No | - | Y |
MDV Data |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | Fixed string value “MDV” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
Time | Date | - | No | YYYY-MM-DD HH:MM | 2014-03-03 13:00 |
Level | Double | - | No | - | 240.000 |
Active Flag | String | - | No | - | Y |
MDP Data |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | Fixed string value “MDP” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
Time | Date | - | No | YYYY-MM-DD HH:MM | 2014-03-03 13:00 |
Period | Double | - | No | - | 240.000 |
Active Flag | String | - | No | - | Y |
RURE Data |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed string value “RURE” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
Time | Date | - | No | YYYYMMDDHHMMSS | 20140303130025 |
Rate 1 | Double | - | No | - | 254.2 |
Elbow 2 | Integer | - | No | - | 2541 |
Rate 2 | Double | - | No | - | 245.0 |
Elbow 3 | Integer | - | No | - | 2456 |
Rate 3 | Double | - | No | - | 256.6 |
RDRE Data |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed string value “RDRE” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
Time | Date | - | No | YYYYMMDDHHMMSS | 20140303130025 |
Rate 1 | Double | - | No | - | 254.2 |
Elbow 2 | Integer | - | No | - | 2541 |
Rate 2 | Double | - | No | - | 245.0 |
Elbow 3 | Integer | - | No | - | 2456 |
Rate 3 | Double | - | No | - | 256.6 |
RURI Data |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed string value “RURI” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
Time | Date | - | No | YYYYMMDDHHMMSS | 20140303130025 |
Rate 1 | Double | - | No | - | 254.2 |
Elbow 2 | Integer | - | No | - | 2541 |
Rate 2 | Double | - | No | - | 245.0 |
Elbow 3 | Integer | - | No | - | 2456 |
Rate 3 | Double | - | No | - | 256.6 |
RURE Data |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed string value “RURE” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
Time | Date | - | No | YYYYMMDDHHMMSS | 20140303130025 |
Rate 1 | Double | - | No | - | 254.2 |
Elbow 2 | Integer | - | No | - | 2541 |
Rate 2 | Double | - | No | - | 245.0 |
Elbow 3 | Integer | - | No | - | 2456 |
Rate 3 | Double | - | No | - | 256.6 |
NDZ Data |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed string value “NDZ” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
Time | Date | - | No | YYYYMMDDHHMMSS | 20140303130025 |
Notice | Double | - | No | - | 2.000 |
NDB Data |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed string value “NDB” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
Time | Date | - | No | YYYYMMDDHHMMSS | 20140303130025 |
Notice | Double | - | No | - | 2.000 |
NDO Data |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed string value “NDO” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
Time | Date | - | No | YYYYMMDDHHMMSS | 20140303130025 |
Notice | Double | - | No | - | 2.000 |
MZT Data |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed string value “MZT” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
Time | Date | - | No | YYYYMMDDHHMMSS | 20140303130025 |
Period | Double | - | No | - | 240.000 |
MNZT Data |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed string value “MNZT” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
Time | Date | - | No | YYYYMMDDHHMMSS | 20140303130025 |
Period | Double | - | No | - | 240.000 |
SEL Data |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed string value “SEL” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
Time | Date | - | No | YYYYMMDDHHMMSS | 20140303130025 |
Level | Double | - | No | - | 240.000 |
SIL Data |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed string value “SIL” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
Time | Date | - | No | YYYYMMDDHHMMSS | 20140303130025 |
Level | Double | - | No | - | 240.000 |
MDV Data |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed string value “MDV” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
Time | Date | - | No | YYYYMMDDHHMMSS | 20140303130025 |
Level | Double | - | No | - | 240.000 |
MDP Data |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed string value “MDP” |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 9 |
Time | Date | - | No | YYYYMMDD HHMMSS | 20140303130025 |
Period | Double | - | No | - | 240.000 |
Service Name | derivedBMUnitDataService |
Operation Name | derivedBMUnitDataImpl |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/DERBMDATA/<VersionNo>?APIKey=<APIKey>&SettlementDate=<SettlementDate>&SettlementPeriod=<SettlementPeriod>&BMUnitId=<BMUnitId>&BMUnitType=<BMUnitType>&LeadPartyName=<LeadPartyName>&NGCBMUnitName=<NGCBMUnitName>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description | Default Sorting: BM Unit ID Settlement Period (ascending) (from body) Acceptance ID (applicable only to Body Record Bid Acceptance Volumes and Body Record Offer Acceptance Volumes) Input data flow : BOALF |
Comments | Default Value (if none specified): Settlement Date = {as per NRT criteria} Settlement Period = {as per NRT criteria} BM Unit Id = * BM Unit Type = * Lead Party Name = * NGC BM Unit Name = * (* implies all values) |
API Webservice – Request –Derived BM Unit Data
| |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | String | - | No | 1 to 50 or * | 12 |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Service Type | String | - | No | - | xml/XML/csv/CSV |
API Webservice – Response - Derived BM Unit Data | |
Header Record | |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “DERIVED DATA” |
Settlement Date | From input parameter |
Settlement Period | From input parameter |
Bid Acceptance Volume |
|
|
|
| ||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data | |||
Record Type | String | - | No | - | Fixed string value “BAV” | |||
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 | |||
BM Unit Type | String | - | No | - | G, S, E, I, T, etc | |||
Lead Party Name | String | - | No | - | AES New Energy Limited | |||
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 | |||
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 | |||
Settlement Period | Integer | - | No | - | 9 | |||
Acceptance ID | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 | |||
Short Acceptance Flag | String | - | No | - | G, S, E, I, T, etc | |||
RR Instruction Flag | String | - | No | - | F | |||
Volume Accepted for Bid-Offer Pair -6 | String | - | No | - |
| |||
Volume Accepted for Bid-Offer Pair -5 | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 | |||
Volume Accepted for Bid-Offer Pair -4 | String | - | No | - | - | |||
Volume Accepted for Bid-Offer Pair -3 | String | - | No | - | - | |||
Volume Accepted for Bid-Offer Pair -2 | String | - | No | - | - | |||
Volume Accepted for Bid-Offer Pair -1 | String | - | No | - | - | |||
Volume Accepted for Bid-Offer Pair 1 | String | - | No | - | - | |||
Volume Accepted for Bid-Offer Pair 2 | String | - | No | - | - | |||
Volume Accepted for Bid-Offer Pair 3 | String | - | No | - | - | |||
Volume Accepted for Bid-Offer Pair 4 | String | - | No | - | - | |||
Volume Accepted for Bid-Offer Pair 5 | String | - | No | - | - | |||
Volume Accepted for Bid-Offer Pair 6 | String | - | No | - | - | |||
Total | String | - | No | - | - | |||
Active Flag | String | - | No | - | Y |
Offer Acceptance Volume |
|
|
|
|
| ||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data | ||||
Record Type | String | - | No | - | Fixed string value “OAV” | ||||
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 | ||||
BM Unit Type | String | - | No | - | G, S, E, I, T, etc | ||||
Lead Party Name | String | - | No | - | AES New Energy Limited | ||||
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 | ||||
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 | ||||
Settlement Period | Integer | - | No | - | 9 | ||||
Acceptance ID | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 | ||||
Short Acceptance Flag (a.k.a. Acceptance Duration) | String | - | No | - | G, S, E, I, T, etc | ||||
RR Instruction Flag | String | - | No | - | F | ||||
Volume Accepted for Bid-Offer Pair -6 | String | - | No | - | - | ||||
Volume Accepted for Bid-Offer Pair -5 | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 | ||||
Volume Accepted for Bid-Offer Pair -4 | String | - | No | - | - | ||||
Volume Accepted for Bid-Offer Pair -3 | String | - | No | - | - | ||||
Volume Accepted for Bid-Offer Pair -2 | String | - | No | - | - | ||||
Volume Accepted for Bid-Offer Pair -1 | String | - | No | - | - | ||||
Volume Accepted for Bid-Offer Pair 1 | String | - | No | - | - | ||||
Volume Accepted for Bid-Offer Pair 2 | String | - | No | - | - | ||||
Volume Accepted for Bid-Offer Pair 3 | String | - | No | - | - | ||||
Volume Accepted for Bid-Offer Pair 4 | String | - | No | - | - | ||||
Volume Accepted for Bid-Offer Pair 5 | String | - | No | - | - | ||||
Volume Accepted for Bid-Offer Pair 6 | String | - | No | - | - | ||||
Total | String | - | No | - | - | ||||
Active Flag | String | - | No | - | Y |
Indicative Period Bid Acceptance Volumes | ||||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data | |
Record Type | String | - | No | - | Fixed string value “IPBAV” | |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
|
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
|
Lead Party Name | String | - | No | - | AES New Energy Limited |
|
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
|
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
|
Settlement Period | Integer | - | No | - | 9 |
|
Data Type | String | - | No | - |
| |
RR Instruction Flag | String | - | No | - | F | |
Volume Accepted for Bid-Offer Pair -6 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair -5 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair -4 | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 | |
Volume Accepted for Bid-Offer Pair -3 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair -2 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair -1 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair 1 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair 2 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair 3 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair 4 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair 5 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair 6 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair -6 | String | - | No | - | - | |
Total | String | - | No | - | - | |
Active Flag | String | - | No | - | Y | |
Indicative Period Offer Acceptance Volumes | ||||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data | |
Record Type | String | - | No | - | Fixed string value “IPOAV” | |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
|
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
|
Lead Party Name | String | - | No | - | AES New Energy Limited |
|
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
|
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
|
Settlement Period | Integer | - | No | - | 9 |
|
Data Type | String | - | No | - | - | |
RR Instruction Flag | String | - | No | - | F | |
Volume Accepted for Bid-Offer Pair -6 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair -5 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair -4 | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 | |
Volume Accepted for Bid-Offer Pair -3 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair -2 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair -1 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair 1 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair 2 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair 3 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair 4 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair 5 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair 6 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair -6 | String | - | No | - | - | |
Total | String | - | No | - | - | |
Active Flag | String | - | No | - | Y |
Indicative Period Bid Cashflow | ||||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data | |
Record Type | String | - | No | - | Fixed string value “IPBC” | |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
|
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
|
Lead Party Name | String | - | No | - | AES New Energy Limited |
|
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
|
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
|
Settlement Period | Integer | - | No | - | 9 |
|
Data Type | String | - | No | - | - | |
Cashflow for Bid-Offer Pair -6 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair -5 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair -4 | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 | |
Cashflow for Bid-Offer Pair -3 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair -2 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair -1 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair 1 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair 2 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair 3 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair 4 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair 5 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair 6 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair -6 | String | - | No | - | - | |
Total | String | - | No | - | - | |
Active Flag | String | - | No | - | Y |
Indicative Period Offer Cashflow | ||||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data | |
Record Type | String | - | No | - | Fixed string value “IPOC” | |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
|
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
|
Lead Party Name | String | - | No | - | AES New Energy Limited |
|
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
|
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
|
Settlement Period | Integer | - | No | - | 9 |
|
Data Type | String | - | No | - | - | |
Cashflow for Bid-Offer Pair -6 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair -5 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair -4 | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 | |
Cashflow for Bid-Offer Pair -3 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair -2 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair -1 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair 1 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair 2 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair 3 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair 4 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair 5 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair 6 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair -6 | String | - | No | - | - | |
Total | String | - | No | - | - | |
Active Flag | String | - | No | - | Y |
Bid Acceptance Volume |
|
|
|
| ||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data | |||
Record Type | String | - | No | - | Fixed string value “BAV” | |||
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 | |||
BM Unit Type | String | - | No | - | G, S, E, I, T, etc | |||
Lead Party Name | String | - | No | - | AES New Energy Limited | |||
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 | |||
Settlement Date | String | - | No | YYYYMMDD | 20140201 | |||
Settlement Period | Integer | - | No | - | 9 | |||
Acceptance ID | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 | |||
Short Acceptance Flag | String | - | No | - | G, S, E, I, T, etc | |||
RR Instruction Flag | String | - | No | - | F | |||
Volume Accepted for Bid-Offer Pair -6 | String | - | No | - |
| |||
Volume Accepted for Bid-Offer Pair -5 | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 | |||
Volume Accepted for Bid-Offer Pair -4 | String | - | No | - | - | |||
Volume Accepted for Bid-Offer Pair -3 | String | - | No | - | - | |||
Volume Accepted for Bid-Offer Pair -2 | String | - | No | - | - | |||
Volume Accepted for Bid-Offer Pair -1 | String | - | No | - | - | |||
Volume Accepted for Bid-Offer Pair 1 | String | - | No | - | - | |||
Volume Accepted for Bid-Offer Pair 2 | String | - | No | - | - | |||
Volume Accepted for Bid-Offer Pair 3 | String | - | No | - | - | |||
Volume Accepted for Bid-Offer Pair 4 | String | - | No | - | - | |||
Volume Accepted for Bid-Offer Pair 5 | String | - | No | - | - | |||
Volume Accepted for Bid-Offer Pair 6 | String | - | No | - | - | |||
Total | String | - | No | - | - |
Offer Acceptance Volume |
|
|
|
|
| ||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data | ||||
Record Type | String | - | No | - | Fixed string value “OAV” | ||||
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 | ||||
BM Unit Type | String | - | No | - | G, S, E, I, T, etc | ||||
Lead Party Name | String | - | No | - | AES New Energy Limited | ||||
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 | ||||
Settlement Date | String | - | No | YYYYMMDD | 20140201 | ||||
Settlement Period | Integer | - | No | - | 9 | ||||
Acceptance ID | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 | ||||
Short Acceptance Flag (a.k.a. Acceptance Duration) | String | - | No | - | G, S, E, I, T, etc | ||||
RR Instruction Flag | String | - | No | - | F | ||||
Volume Accepted for Bid-Offer Pair -6 | String | - | No | - | - | ||||
Volume Accepted for Bid-Offer Pair -5 | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 | ||||
Volume Accepted for Bid-Offer Pair -4 | String | - | No | - | - | ||||
Volume Accepted for Bid-Offer Pair -3 | String | - | No | - | - | ||||
Volume Accepted for Bid-Offer Pair -2 | String | - | No | - | - | ||||
Volume Accepted for Bid-Offer Pair -1 | String | - | No | - | - | ||||
Volume Accepted for Bid-Offer Pair 1 | String | - | No | - | - | ||||
Volume Accepted for Bid-Offer Pair 2 | String | - | No | - | - | ||||
Volume Accepted for Bid-Offer Pair 3 | String | - | No | - | - | ||||
Volume Accepted for Bid-Offer Pair 4 | String | - | No | - | - | ||||
Volume Accepted for Bid-Offer Pair 5 | String | - | No | - | - | ||||
Volume Accepted for Bid-Offer Pair 6 | String | - | No | - | - | ||||
Total | String | - | No | - | - |
Indicative Period Bid Acceptance Volumes | ||||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data | |
Record Type | String | - | No | - | Fixed string value “IPBAV” | |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
|
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
|
Lead Party Name | String | - | No | - | AES New Energy Limited |
|
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
|
Settlement Date | String | - | No | YYYYMMDD | 20140201 |
|
Settlement Period | Integer | - | No | - | 9 |
|
Data Type | String | - | No | - |
| |
RR Instruction Flag | String | - | No | - | F | |
Volume Accepted for Bid-Offer Pair -6 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair -5 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair -4 | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 | |
Volume Accepted for Bid-Offer Pair -3 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair -2 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair -1 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair 1 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair 2 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair 3 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair 4 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair 5 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair 6 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair -6 | String | - | No | - | - | |
Total | String | - | No | - | - | |
Active Flag | String | - | No | - | Y |
Indicative Period Offer Acceptance Volumes | ||||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data | |
Record Type | String | - | No | - | Fixed string value “IPOAV” | |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
|
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
|
Lead Party Name | String | - | No | - | AES New Energy Limited |
|
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
|
Settlement Date | String | - | No | YYYYMMDD | 20140201 |
|
Settlement Period | Integer | - | No | - | 9 |
|
Data Type | String | - | No | - | - | |
RR Instruction Flag | String | - | No | - | F | |
Volume Accepted for Bid-Offer Pair -6 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair -5 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair -4 | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 | |
Volume Accepted for Bid-Offer Pair -3 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair -2 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair -1 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair 1 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair 2 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair 3 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair 4 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair 5 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair 6 | String | - | No | - | - | |
Volume Accepted for Bid-Offer Pair -6 | String | - | No | - | - | |
Total | String | - | No | - | - |
Indicative Period Bid Cashflow | ||||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data | |
Record Type | String | - | No | - | Fixed string value “IPBC” | |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
|
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
|
Lead Party Name | String | - | No | - | AES New Energy Limited |
|
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
|
Settlement Date | String | - | No | YYYYMMDD | 20140201 |
|
Settlement Period | Integer | - | No | - | 9 |
|
Data Type | String | - | No | - | - | |
Cashflow for Bid-Offer Pair -6 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair -5 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair -4 | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 | |
Cashflow for Bid-Offer Pair -3 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair -2 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair -1 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair 1 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair 2 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair 3 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair 4 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair 5 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair 6 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair -6 | String | - | No | - | - | |
Total | String | - | No | - | - |
Indicative Period Offer Cashflow | ||||||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data | |
Record Type | String | - | No | - | Fixed string value “IPOC” | |
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
|
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
|
Lead Party Name | String | - | No | - | AES New Energy Limited |
|
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
|
Settlement Date | String | - | No | YYYYMMDD | 20140201 |
|
Settlement Period | Integer | - | No | - | 9 |
|
Data Type | String | - | No | - | - | |
Cashflow for Bid-Offer Pair -6 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair -5 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair -4 | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 | |
Cashflow for Bid-Offer Pair -3 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair -2 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair -1 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair 1 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair 2 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair 3 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair 4 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair 5 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair 6 | String | - | No | - | - | |
Cashflow for Bid-Offer Pair -6 | String | - | No | - | - | |
Total | String | - | No | - | - |
Service Name | derivedSystemWideDataService |
Operation Name | derivedSystemWideDataImpl |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/DERSYSDATA/<VersionNo>?APIKey=<APIKey>&FromSettlementDate=<FromSettlementDate>&ToSettlementDate=<ToSettlementDate>&SettlementPeriod=<SettlementPeriod>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description | Default Sorting: Settlement Date (Ascending) Settlement Period (Ascending) Input data flow : Derived |
Comments | Default Value (if none specified): From Settlement Date = Current System Date -1(i.e. Yesterday) To Date = Current System Date (i.e Today) Settlement Period = * (* implies all values)
|
API Webservice – Request – Derived System-wide Data | |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
From Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
To Settlement Date | String | - | No | YYYY-MM-DD | 2014-03-01 |
Settlement Period | String | - | No | 1 to 50 or * | 12 |
Service Type | String | - | No | - | xml/XML/csv/CSV |
API Webservice – Response - Derived System-wide Data | |
| |
Header Record: | |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “SYSTEM BUY SELL DATA” |
Body Record: |
|
|
|
|
|
| |||
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data | ||||
Record Type | String | - | No | - | Fixed string value “SSB” | ||||
Settlement Date | Date | - | No | YYYY-MM-DD | 2014-02-01 | ||||
Settlement Period | Integer | - | No | 1 to 50 or * | 1 | ||||
System Sell Price (SSP in £/MWh) | Double | - | No | - | 31.60000 | ||||
System Buy Price (SBP in £/MWh) | Double | - | No | - | 38.66000 | ||||
BSAD Default | String | - | No | - | F | ||||
Price Derivation Code (PDC) | String | - | No | - | F | ||||
Reserve Scarcity Price | Double |
| No | - | 15.03210 | ||||
Indicative Net Imbalance Volume (NIV) | Double | - | No | - | 294.983 | ||||
Sell-Price Price Adjustment (SPA) | Double | - | No | - | 0.00 | ||||
Buy-Price Price Adjustment (BPA) | Double | - | No | - | 5.50 | ||||
Replacement Price (RP in £/MWh ) | Double | - | No | - | 294.983 | ||||
Replacement Price Calculation Volume (RPRV in MWh) | Double | - | No | - | 294.983 | ||||
Total System Accepted Offer Volume | Double | - | No | - | 294.983 | ||||
Total System Accepted Bid Volume | Double | - | No | - | 294.983 | ||||
Total System Tagged Accepted Offer Volume | Double | - | No | - | 294.983 | ||||
Total System Tagged Accepted Bid Volume | Double | - | No | - | 294.983 | ||||
System Total Priced Accepted Offer Volume | Double | - | No | - | 294.983 | ||||
System Total Priced Accepted Bid Volume | Double | - | No | - | 294.983 | ||||
Total System Adjustment Sell Volume | Double | - | No | - | 294.983 | ||||
Total System Adjustment Buy Volume | Double | - | No | - | 294.983 | ||||
Total System Tagged Adjustment Sell Volume | Double | - | No | - | 294.983 | ||||
Total System Tagged Adjustment Buy Volume | Double | - | No | - | 294.983 |
|
|
|
|
|
|
| |||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data | ||||
Record Type | String | - | No | - | Fixed string value “SSB” | ||||
Settlement Date | Date | - | No | YYYYMMDD | 20140201 | ||||
Settlement Period | Integer | - | No | 1 to 50 or * | 1 | ||||
System Sell Price (SSP in £/MWh) | Double | - | No | - | 31.60000 | ||||
System Buy Price (SBP in £/MWh) | Double | - | No | - | 38.66000 | ||||
BSAD Default | String | - | No | - | F | ||||
Price Derivation Code (PDC) | String | - | No | - | F | ||||
Reserve Scarcity Price | Double |
| No | - | 15.03210 | ||||
Indicative Net Imbalance Volume (NIV) | Double | - | No | - | 294.983 | ||||
Replacement Price (RP in £/MWh ) | Double | - | No | - | 294.983 | ||||
Replacement Price Calculation Volume (RPRV in MWh) | Double | - | No | - | 294.983 | ||||
Total System Accepted Offer Volume | Double | - | No | - | 294.983 | ||||
Total System Accepted Bid Volume | Double | - | No | - | 294.983 | ||||
Total System Tagged Accepted Offer Volume | Double | - | No | - | 294.983 | ||||
Total System Tagged Accepted Bid Volume | Double | - | No | - | 294.983 | ||||
System Total Priced Accepted Offer Volume | Double | - | No | - | 294.983 | ||||
System Total Priced Accepted Bid Volume | Double | - | No | - | 294.983 | ||||
Total System Adjustment Sell Volume | Double | - | No | - | 294.983 | ||||
Total System Adjustment Buy Volume | Double | - | No | - | 294.983 | ||||
Total System Tagged Adjustment Sell Volume | Double | - | No | - | 294.983 | ||||
Total System Tagged Adjustment Buy Volume | Double | - | No | - | 294.983 |
Service Name | detailedSystemPricesService |
Operation Name | detailedSystemPricesImpl |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/DETSYSPRICES/<VersionNo>?APIKey=<APIKey>&SettlementDate=<SettlementDate>&SettlementPeriod=<SettlementPeriod>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description | Default Sorting: Settlement Date (Ascending), Settlement Period (Ascending), Index (Ascending), and Component Identifier (Alphabetically sorted). Input data flow : Derived |
Comments | Default Value (if none specified): From Settlement Date = Current System Date Settlement Period = Current Settlement Period Note that NO wildcard (*) allowed for Settlement Period. |
API Webservice – Request –Detailed System Prices | |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | String | - | No | - | 2 |
Service Type | String | - | No | - | xml/XML/csv/CSV |
API Webservice – Response – Detailed System Prices | |
Header Record: | |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “INDICATIVE SYSTEM PRICE STACK DATA” |
Body Record: |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
System Price Calculation Summary | |||||
Record Type | String | - | No | - | Fixed as “MAIN PRICE SUMMARY” |
Settlement Date | Date | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 2 |
Cost | Double | - | No | - | 1555.66 |
Volume | Double | - | No | - | 39.097 |
Adjuster | Double | - | No | - | 0.00 |
Value | Double | - | No | - | 39.78979 |
Type | String | - | No | - | SBP |
Record Type | String | - | No | - | Fixed as “MARKET PRICE SUMMARY” |
Settlement Date | Date | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 2 |
Cost | Double | - | No | - | 1555.66 |
Volume | Double | - | No | - | 39.097 |
Value | Double | - | No | - | 39.78979 |
Type | String | - | No | - | SBP |
Price Derivation Code | String | - | No | - | B |
Indicative System Price Offer Stack Data | |||||
Record Type | String | - | No | - | Fixed String “OFFER” |
Settlement Date | Date | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 2 |
Index (Sequence number) | Integer | - | No | - | 12 |
ID (Component Identifier) | String | - | No | - | T_DINO-5 |
Acceptance ID | String | - | No | - | 58932 |
Bid Offer Pair ID | String | - | No | - | 11 |
CADL Flag | String | - | No | - | T |
SO Flag | String | - | No | - | F |
STOR Provider Flag | String | - | No | - | F |
Repriced Indicator | String | - | No | - | F |
Bid Offer Original Price | Double | - | No | - | 160.00000 |
Reserve Scarcity Price | Double | - | No | - | 120.25 |
OfferVolume (Stack Item Original Volume) | Double | - | No | - | 30.000 |
DMAT Adjusted Volume | Double | - | No | - | 30.000 |
Arbitrage Adjusted Volume | Double | - | No | - | 30.000 |
NIV Adjusted Volume | Double | - | No | - | 0.000 |
PAR Adjusted Volume | Double | - | No | - | 0.000 |
(Stack Item) Final Price | Double | - | No | - | 0.00000 |
Transmission Loss Multiplier (TLM) | Double | - | No | - | 0.0000000 |
TLM Adjusted Volume (QAPO * TLM) | Double | - | No | - | 0.000 |
TLM Adjusted Cost (QAPO * PO * TLM) | Double | - | No | - | 0.00 |
Totals | |||||
TOTAL of TLM Adjusted Volume | Double | - | No | - | 39.097 |
TOTAL of TLM Adjusted Cost | Double | - | No | - | 1555.66 |
|
|
|
|
|
|
Indicative System Price Bid Stack Data | |||||
Record Type | String | - | No | - | Fixed String “BID” |
Settlement Date | Date | - | No | YYYY-MM-DD | 2014-02-01 |
Settlement Period | Integer | - | No | - | 2 |
Index (Sequence number) | Integer | - | No | - | 8 |
ID (Component Identifier) | String | - | No | - | T_RUGPS-6 |
Acceptance ID | String | - | No | - | 109766 |
Bid Offer Pair ID | String | - | No | - | -1 |
CADL Flag | String | - | No | - | F |
SO Flag | String | - | No | - | F |
STOR Provider Flag | String | - | No | - | F |
Repriced Indicator | String | - | No | - | F |
Bid Price (Stack Item Original Price) | Double | - | No | - | 30.01000 |
Reserve Scarcity Price | Double | - | No | - | 120.25 |
Bid Volume (Stack Item Original Volume) | Double | - | No | - | -4.083 |
DMAT Adjusted Volume | Double | - | No | - | -4.083 |
Arbitrage Adjusted Volume | Double | - | No | - | -4.083 |
NIV Adjusted Volume | Double | - | No | - | 0.000 |
PAR Adjusted Volume | Double | - | No | - | 0.000 |
(Stack Item) Final Price | Double | - | No | - | 0.00000 |
Transmission Loss Multiplier (TLM) | Double | - | No | - | 0.0000000 |
TLM Adjusted Volume (QAPB * TLM) | Double | - | No | - | 0.000 |
TLM Adjusted Cost (QAPB * PB * TLM) | Double | - | No | - | 0.00 |
Totals | |||||
TOTAL of TLM Adjusted Volume | Double | - | No | - | 39.097 |
TOTAL of TLM Adjusted Cost | Double | - | No | - | 1555.66 |
CSV Download service | |||||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
System Price Calculation Summary | |||||
Record Type | String | - | No | - | Fixed as “MAIN PRICE SUMMARY” |
Settlement Date | Date | - | No | YYYYMMDD | 20150210 |
Settlement Period | Integer | - | No | - | 2 |
Cost | Double | - | No | - | 1555.66 |
Volume | Double | - | No | - | 39.097 |
Adjuster | Double | - | No | - | 0.00 |
Value | Double | - | No | - | 39.78979 |
Type | String | - | No | - | SBP |
Record Type | String | - | No | - | Fixed as “MARKET PRICE SUMMARY” |
Settlement Date | Date | - | No | YYYYMMDD | 20150210 |
Settlement Period | Integer | - | No | - | 2 |
Cost | Double | - | No | - | 1555.66 |
Volume | Double | - | No | - | 39.097 |
Adjuster | Double | - | No | - | 0.00 |
Value | Double | - | No | - | 39.78979 |
Type | String | - | No | - | SBP |
Price Derivation Code | String | - | No | - | B |
Indicative System Price Offer Stack Data | |||||
Record Type | String | - | No | - | Fixed String “OFFER” |
Settlement Date | Date | - | No | YYYYMMDD | 20150210 |
Settlement Period | Integer | - | No | - | 2 |
Index (Sequence number) | Integer | - | No | - | 12 |
ID (Component Identifier) | String | - | No | - | T_DINO-5 |
Acceptance ID | String | - | No | - | 58932 |
Bid Offer Pair ID | String | - | No | - | 11 |
CADL Flag | String | - | No | - | T |
SO Flag | String | - | No | - | F |
STOR Provider Flag | String | - | No | - | F |
Repriced Indicator | String | - | No | - | F |
Bid Offer Original Price | Double | - | No | - | 160.00000 |
Reserve Scarcity Price | Double | - | No | - | 120.25 |
OfferVolume (Stack Item Original Volume) | Double | - | No | - | 30.000 |
DMAT Adjusted Volume | Double | - | No | - | 30.000 |
Arbitrage Adjusted Volume | Double | - | No | - | 30.000 |
NIV Adjusted Volume | Double | - | No | - | 0.000 |
PAR Adjusted Volume | Double | - | No | - | 0.000 |
(Stack Item) Final Price | Double | - | No | - | 0.00000 |
Transmission Loss Multiplier (TLM) | Double | - | No | - | 0.0000000 |
TLM Adjusted Volume (QAPO * TLM) | Double | - | No | - | 0.000 |
TLM Adjusted Cost (QAPO * PO * TLM) | Double | - | No | - | 0.00 |
Totals | |||||
TOTAL of TLM Adjusted Volume | Double | - | No | - | 39.097 |
TOTAL of TLM Adjusted Cost | Double | - | No | - | 1555.66 |
Indicative System Price Bid Stack Data | |||||
Record Type | String | - | No | - | Fixed String “BID” |
Settlement Date | Date | - | No | YYYYMMDD | 20150210 |
Settlement Period | Integer | - | No | - | 2 |
Index (Sequence number) | Integer | - | No | - | 8 |
ID (Component Identifier) | String | - | No | - | T_RUGPS-6 |
Acceptance ID | String | - | No | - | 109766 |
Bid Offer Pair ID | String | - | No | - | -1 |
CADL Flag | String | - | No | - | F |
SO Flag | String | - | No | - | F |
STOR Provider Flag | String | - | No | - | F |
Repriced Indicator | String | - | No | - | F |
Bid Price (Stack Item Original Price) | Double | - | No | - | 30.01000 |
Reserve Scarcity Price | Double | - | No | - | 120.25 |
Bid Volume (Stack Item Original Volume) | Double | - | No | - | -4.083 |
DMAT Adjusted Volume | Double | - | No | - | -4.083 |
Arbitrage Adjusted Volume | Double | - | No | - | -4.083 |
NIV Adjusted Volume | Double | - | No | - | 0.000 |
PAR Adjusted Volume | Double | - | No | - | 0.000 |
(Stack Item) Final Price | Double | - | No | - | 0.00000 |
Transmission Loss Multiplier (TLM) | Double | - | No | - | 0.0000000 |
TLM Adjusted Volume (QAPB * TLM) | Double | - | No | - | 0.000 |
TLM Adjusted Cost (QAPB * PB * TLM) | Double | - | No | - | 0.00 |
Totals | |||||
TOTAL of TLM Adjusted Volume | Double | - | No | - | 39.097 |
TOTAL of TLM Adjusted Cost | Double | - | No | - | 1555.66 |
Service Name | marketDepthDataService |
Operation Name | marketDepthDataImpl |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/MKTDEPTHDATA/<VersionNo>?APIKey=<APIKey>&SettlementDate=<SettlementDate>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description | Default Sorting: Settlement Date (ascending) Settlement Period (ascending) Input data flow : IMBALNGC
|
Comments | Default Value (if none specified): Return all rows From Settlement Date = Current System Date -1(i.e. Yesterday)
|
API Webservice – Request –Market Depth Data | |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-02-01 |
Service Type | String | - | No | - | xml/XML/csv/CSV |
API Webservice – Response – Market Depth Data | |
Header Record: | |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “MARKET DEPTH DATA” |
Body Record: |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | Fixed string value “MDD” |
Settlement Date | Date | - | No | YYYY-MM-DD | 2015-01-26 |
Settlement Period | Integer | - | No | - | 2 |
IMBALNGC | Double | - | No | - | 80.000 |
Total Offer Volume | Double | - | No | - | 48515.000 |
Total Bid Volume | Double | - | No | - | -57826.000 |
Total Accepted Offer Volume | Double | - | No | - | 1079.542 |
Total Accepted Bid Volume | Double | - | No | - | -1028.994 |
Total Unpriced Accepted Offer Volume | Double | - | No | - | 0.000 |
Total Unpriced Accepted Bid Volume | Double | - | No | - | 0.000 |
Total Priced Accepted Offer Volume | Double | - | No | - | 815.462 |
Total Priced Accepted Bid Volume | Double | - | No | - | -1062.853 |
Active Flag | String | - | No | - | Y |
|
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed string value “MDD” |
Settlement Date | Date | - | No | YYYYMMDD | 20150126 |
Settlement Period | Integer | - | No | - | 2 |
IMBALNGC | Double | - | No | - | 80.000 |
Total Offer Volume | Double | - | No | - | 48515.000 |
Total Bid Volume | Double | - | No | - | -57826.000 |
Total Accepted Offer Volume | Double | - | No | - | 1079.542 |
Total Accepted Bid Volume | Double | - | No | - | -1028.994 |
Total Unpriced Accepted Offer Volume | Double | - | No | - | 0.000 |
Total Unpriced Accepted Bid Volume | Double | - | No | - | 0.000 |
Total Priced Accepted Offer Volume | Double | - | No | - | 815.462 |
Total Priced Accepted Bid Volume | Double | - | No | - | -1062.853 |
Service Name | latestAcceptancesService |
Operation Name | latestAcceptancesImpl |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/LATESTACCEPTS/<VersionNo>?APIKey=<APIKey>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description | Default Sorting: Acceptance Time (descending) From Time (ascending) Input data flow : BOALF
|
Comments | - |
API Webservice – Request –Latest Acceptances | |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
Service Type | String | - | No | - | xml/XML/csv/CSV |
API Webservice – Response – Latest Acceptances | |
Header Record: | |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “LATEST ACCEPTANCE DATA” |
Body Record: |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | Fixed string value “LAD” |
BM Unit Id | String | - | No | - | T_FFES-4 |
Acceptance Number | Integer | - | No | - | 2558965231 |
Acceptance Time | Date | - | No | YYYY-MM-DD HH:MM | 2015-01-26 00:47 |
From Time | Date | - | No | YYYY-MM-DD HH:MM | 2015-01-26 23:47 |
Active Flag | String | - | No | - | Y |
|
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed string value “LAD” |
BM Unit Id | String | - | No | - | T_STAY-2 |
Acceptance Number | Integer | - | No | - | 2558965231 |
Acceptance Time | Date | - | No | yyyymmddhhmmss | 20150126004700 |
From Time | Date | - | No | YYYYMMDDHHMMSS | 20150126004700 |
Service Name | historicAcceptancesService |
Operation Name | historicAcceptancesImpl |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/HISTACCEPTS/<VersionNo>?APIKey=<APIKey>&SettlementDate=<SettlementDate>&SettlementPeriod=<SettlementPeriod>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description | Default Sorting: Acceptance Time (ascending) Input data flow : BOALF |
Comments | Default Value (if none specified): From Settlement Date = Current System Date Settlement Period = Current Settlement Period |
API Webservice – Request –Historic Acceptances | |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
Settlement Date | String | - | No | YYYY-MM-DD | 2014-12-31 |
Settlement Period | String | - | No | 1 to 50 | 2 |
Service Type | String | - | No | - | xml/XML/csv/CSV |
API Webservice – Response – Historic Acceptances | |
Header Record: | |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “ACCEPTANCE DATA” |
Settlement Date | From input parameter |
Settlement Period | number between 1 and 50 or * if selecting a full day’s data (from input parameter) |
Body Record: |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | Fixed string value “HAD” |
BM Unit Id | String | - | No | - | T_STAY-2 |
Acceptance Number | Integer | - | No | - | 2558965231 |
Acceptance Time | Date | - | No | YYYY-MM-DD HH:MM | 2015-01-26 00:47 |
Offer Price | Double | - | No | - | 58.00000 |
Bid Price | Double | - | No | - | 35.00000 |
Active Flag | String | - | No | - | Y |
CSV Download service | |||||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed string value “HAD” |
BM Unit Id | String | - | No | - | T_STAY-2 |
Acceptance Number | Integer | - | No | - | 2558965231 |
Acceptance Time | Date | - | No | yyyymmddhhmmss | 20150126004700 |
Offer Price | Double | - | No | - | 58.00000 |
Bid Price | Double | - | No | - | 35.00000 |
Note that NO wildcard (*) allowed for Settlement Period.
Service Name | systemMessagesService |
Operation Name | systemMessagesImpl |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/SYSMSG/<VersionNo>?APIKey=<APIKey>& ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description | Default Sorting: Acceptance Time (descending) Input data flow : NA
|
Source | MySQL |
Destination | Third party software |
Data Source | Reporting Database |
Database Table Name | T_BMRS_SYS_MSGS |
Comments | - |
API Webservice – Request –System Messages | |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
Service Type | String | - | No | - | xml/XML/csv/CSV |
API Webservice – Response – System Messages | |
Header Record: | |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “SYSTEM MESSAGES” |
Body Record: |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | Fixed string value “SYSMSG”” |
Message Date Time | Date | - | No | YYYY-MM-DD HH:MM | 2015-02-25 07:21 |
Message Type | String | - | No | - | MIDNP |
Message Text | String | - | No | - | Market Index Data for Settlement Day 20150225 period 14 from Automated Power Exchange (UK) (APXMIDP) was not received. Price and volume defaulted to 0. |
Active Flag | String | - | No | - | Y |
CSV Download Service | |||||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed string value “SYSMSG”” |
Message Date Time | Date | - | No | YYYYMMDDHHMMSS | 20150126004700 |
Message Type | String | - | No | - | MIDNP |
Message Text | String | - | No | - | Market Index Data for Settlement Day 20150225 period 14 from Automated Power Exchange (UK) (APXMIDP) was not received. Price and volume defaulted to 0. |
Service Name | bmUnitSearchService |
Operation Name | bmUnitSearchImpl |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/BMUNITSEARCH/<VersionNo>?APIKey=<APIKey>&BmUnitId=<BmUnitId>&BmUnitType=<BmUnitType>&LeadPartyName=<LeadPartyName>&NgcBmUnitName=<NgcBmUnitName>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description | Default Sorting: BM Unit ID |
Source | MySQL |
Destination | Third party software |
Data Source | Reporting Database |
Database Table Name | T_BMRS_BM_UNT_SRCH |
Comments | Default Value (if none specified): BM Unit Id = * BM Unit Type = * Lead Party Name = * NGC BM Unit Name = * (* implies all values) |
API Webservice – Request –BM Unit Search | |||||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data | ||
ApiKey | String | - | Yes | - | AP8DA23 | ||
BM Unit Id | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 | ||
BM Unit Type | String | - | No | - | G, S, E, I, T, etc | ||
Lead Party Name | String | - | No | - | AES New Energy Limited | ||
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 | ||
Service Type | String | - | No | - | xml/XML/csv/CSV | ||
API Webservice – Response –BM Unit Search |
| ||||||
Header Record: |
| ||||||
Report Output Field Mapping | Condition |
| |||||
Record Type | Fixed string value “HDR” |
| |||||
File Type | Fixed string value “BM UNIT DATA” |
|
Body Record: |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | Fixed string value “BMUD” |
BM Unit ID | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Active Flag | String | - | No | - | Y |
CSV Download Service | |||||
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed string value “BMUD” |
BM Unit ID | String | - | No | - | 2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01 |
BM Unit Type | String | - | No | - | G, S, E, I, T, etc |
Lead Party Name | String | - | No | - | AES New Energy Limited |
NGC BM Unit Name | String | - | No | - | EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000 |
Service Name | systemWarningTodayTomorrowService |
Operation Name | systemWarningTodayTomorrowImpl |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/SYSWARNTDYTOM<VersionNo>?APIKey=<APIKey&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description | Default Sorting: Times applicable (descending); separately for TODAY and TOMORROW Input data flow : System Warning flow from NGC
|
Source | MySQL |
Comments | - |
API Webservice – Request –System Warning (Today/Tomorrow) | |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
Service Type | String | - | No | - | xml/XML/csv/CSV |
API Webservice – Response – System Warning (Today/Tomorrow) | |
Header Record: | |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “SYSTEM WARNINGS IN FORCE” |
Body Record: |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
System warnings in force TODAY | |||||
Record Type | String | - | No | - | Fixed string value “SYSWARNTDY ” |
Today | Date | - | No | YYYY-MM-DD | 2008-07-02 |
Warning in Force | String | - | No | - | TDY |
Times applicable | String | - | No | - | NONE |
Active Flag | String | - | No | - | Y |
System warnings in force TOMORROW | |||||
Record Type | String | - | No | - | Fixed string value “SYSWARNTOM” |
Today | Date | - | No | YYYY-MM-DD | 2008-07-02 |
Warning in Force | String | - | No | - | TDY |
Times applicable | String | - | No | - | NONE |
Active Flag | String | - | No | - | Y |
|
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
System warnings in force TODAY | |||||
Record Type | String | - | No | - | Fixed string value “SYSWARNTDY ” |
Today | Date | - | No | YYYYMMDD | 20080702 |
Warning in Force | String | - | No | - | TDY |
Times applicable | String | - | No | - | NONE |
System warnings in force TOMORROW | |||||
Record Type | String | - | No | - | Fixed string value “SYSWARNTOM” |
Today | Date | - | No | YYYYMMDD | 20080702 |
Warning in Force | String | - | No | - | TOM |
Times applicable | String | - | No | - | NONE |
Service Name | systemWarningHistoricService |
Operation Name | systemWarningHistoricImpl |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/HISTSYSWARN/<VersionNo>?APIKey=<APIKey&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description | Default Sorting : Times applicable (descending) Warning Date Time; Input data flow : System Warning flow from NGC
|
Source | MySQL |
Comments | - |
API Webservice – Request –System Warning (Historic) | |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
Service Type | String | - | No | - | xml/XML/csv/CSV |
API Webservice – Response – System Warning (Historic) | |
Header Record: | |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “SYSTEM WARNING - HISTORIC” |
Body Record: |
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data |
Record Type | String | - | No | - | Fixed string value “SYSWARNHIST” |
Warning Type | String | - | No | - | - |
Effective From | Date | - | No | - | - |
Time Effective From | Date | - | No | - | - |
Shortfall (MW) | Double | - | No | - | - |
Date Warning Cancelled | Date | - | No | - | - |
Time Warning Cancelled | Date | - | No | - | - |
Active Flag | String | - | No | - | Y |
|
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed string value “SYSWARNHIST” |
Warning Type | String | - | No | - | - |
Effective From | Date | - | No | - | - |
Time Effective From | Date | - | No | - | - |
Time Effective To | Date | - | No | - | - |
Shortfall (MW) | Double | - | No | - | - |
Date Warning Cancelled | Date | - | No | - | - |
Time Warning Cancelled | Date | - | No | - | - |
Active Flag | String | - | No | - | Y |
Service Name | lossOfLoadProbabilityService |
Operation Name | lossOfLoadProbabilityImpl |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/LOLPDRM/<VersionNo>?APIKey=<APIKey>&FromSettlementDate=<FromSettlementDate>&ToSettlementDate=<ToSettlementDate>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description | Default Sorting : 1. Settlement Date (ascending) 2. Settlement Period (ascending)
|
Source | MySQL |
Comments | Default Value (if none specified; this is the today/tomorrow web page case): From Settlement Date = Current System Date To Settlement Date = Current System Date + 2 |
API Webservice – Request – Loss of Load Probability | |||||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data | ||
ApiKey | String | - | Yes | - | AP8DA23 | ||
From Settlement Date | String | - | No | YYYY-MM-DD | 2014-12-30 | ||
To Settlement Date | String | - | No | YYYY-MM-DD | 2014-12-31 | ||
Service Type | String | - | No | - | Xml/XML/csv/CSV | ||
API Webservice – Response – Loss of Load Probability |
| ||||||
Header Record: |
| ||||||
Report Output Field Mapping | Condition |
| |||||
Record Type | Fixed string value “HDR” |
| |||||
File Type | Fixed string value “LOLP” |
|
Body Record: |
|
|
|
|
| |
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data | |
Record Type | String | - | No | - | Fixed string value “LOLPDRM” | |
Settlement Date | Date | - | No | YYYY-MM-DD | 2014-12-31 | |
Settlement Period | Integer | - | No | - | 2 | |
LOLP_1200 | Double | - | No | - | 0.977100 | |
DRM_1200 | Double | - | No | - | 0.10000 | |
LOLP_8h | Double | - | No | - | 0.978500 | |
DRM_8h | Double | - | No | - | 0.24000 | |
LOLP_4h | Double | - | No | - | 0.981600 | |
DRM_4h | Double | - | No | - | 0.18000 | |
LOLP_2h | Double | - | No | - | 0.981200 | |
DRM_2h | Double | - | No | - | 0.14000 | |
LOLP_1h | Double | - | No | - | 0.981000 | |
DRM_1h | Double | - | No | - | 0.12000 | |
Active Flag | String | - | No | - | Y |
|
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed string value “LOLPDRM” |
Settlement Date | Date | - | No | YYYYMMDD | 20141231 |
Settlement Period | Integer | - | No | - | 2 |
LOLP_1200 | Double | - | No | - | 0.977100 |
DRM_1200 | Double | - | No | - | 0.10000 |
LOLP_8h | Double | - | No | - | 0.978500 |
DRM_8h | Double | - | No | - | 0.24000 |
LOLP_4h | Double | - | No | - | 0.981600 |
DRM_4h | Double | - | No | - | 0.18000 |
LOLP_2h | Double | - | No | - | 0.981200 |
DRM_2h | Double | - | No | - | 0.14000 |
LOLP_1h | Double | - | No | - | 0.981000 |
DRM_1h | Double | - | No | - | 0.12000 |
Service Name | demandControlInstructionService |
Operation Name | demandControlInstructionImpl |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/DEMCI/<VersionNo>?APIKey=<APIKey>&FromSettlementDate=<FromSettlementDate>&ToSettlementDate=<ToSettlementDate>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description | Default Sorting : 1. Demand Control ID (ascending) 2. Instruction Sequence (ascending) |
Source | MySQL |
Comments | Default Value (if none specified; this is the today/tomorrow web page case): From Settlement Date = Current System Date To Settlement Date = Current System Date + 1 |
API Webservice – Request – Demand Control Instruction | |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
From Settlement Date | String | - | No | YYYY-MM-DD | 2014-12-30 |
To Settlement Date | String | - | No | YYYY-MM-DD | 2014-12-31 |
Service Type | String | - | No | - | Xml/XML/csv/CSV |
API Webservice – Response – Demand Control Instruction | |
Header Record: | |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “DCONTROL” |
Body Record: |
|
|
|
|
| |
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data | |
Record Type | String | - | No | - | Fixed string value “DEMCI” | |
Demand Control ID | String | - | No | - | DCID1 | |
Affected DSO | Integer | - | No | - | 1 | |
Instruction Sequence | String | - | No | - | SPOW | |
Demand Control Event Flag | String | - | No | - | L | |
Time From | Date | - | No | YYYY-MM-DD HH:MM | 2014-12-31 10:00 | |
Time To | Date | - | No | YYYY-MM-DD HH:MM | 2014-12-31 10:00 | |
Demand Control Level | Double | - | No | - | 10.00000 | |
SO-Flag | String | - | No | - | F | |
Active Flag | String | - | No | - | Y |
|
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed string value “DEMCI” |
Demand Control ID | String | - | No | - | DCID1 |
Affected DSO | Integer | - | No | - | 1 |
Instruction Sequence | String | - | No | - | SPOW |
Demand Control Event Flag | String | - | No | - | L |
Time From | Date | - | No | YYYYMMDDHHMM | 201412311000 |
Time To | Date | - | No | YYYYMMDDHHMM | 201412311000 |
Demand Control Level | Double | - | No | - | 10.00000 |
SO-Flag | String | - | No | - | F |
Service Name | storAvailabilityWindowService |
Operation Name | storAvailabilityWindowImpl |
Method | GET |
Input URL | https://api.bmreports.com/BMRS/STORAW/<VersionNo>?APIKey=<APIKey>&FromSettlementDate=<SettlementDate>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Description | Default Sorting : 1. STOR Availability From Date (ascending)
|
Source | MySQL |
Comments | Default Value (if none specified; this is the current web page case): From Settlement Date = Current System Date |
API Webservice – Request – STOR Availability Window | |||||
Logical Field Name | Field Type | Remarks | Mandatory | Format | Sample data |
ApiKey | String | - | Yes | - | AP8DA23 |
FromSettlementDate | String | - | No | YYYY-MM-DD | 2014-12-31 |
Service Type | String | - | No | - | Xml/XML/csv/CSV |
API Webservice – Response – STOR Availability Window | |
Header Record: | |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “STORAW DATA” |
Body Record: |
|
|
|
|
| |
Logical Field Name | Field Type | Remarks | Mandatory | XML Format | Sample data | |
Record Type | String | - | No | - | Fixed string value “STORAW” | |
Document ID | Integer | - | No | - | 67 | |
Season Year | Date | - | No | YYYY-MM-DD | 2014-12-31 | |
Season Number | Integer | - | No | - | 2 | |
STOR Availability From Date | Date | - | No | YYYY-MM-DD HH:MM | 2014-12-31 10:00 | |
STOR Availability To Date | Date | - | No | YYYY-MM-DD HH:MM | 2014-12-31 10:00 | |
Weekday Start Time | Date | - | No | HH:MM | 10:00 | |
Weekday End Time | Date | - | No | HH:MM | 10:00 | |
Non-weekday Start Time | Date | - | No | HH:MM | 10:00 | |
Non-weekday End Time | Date | - | No | HH:MM | 10:00 | |
Active Flag | String | - | No | - | Y |
|
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed string value “STORAW” |
Document ID | Integer | - | No | - | 67 |
Season Year | Date | - | No | YYYYMMDD | 20141231 |
Season Number | Integer | - | No | - | 2 |
STOR Availability From Date | Date | - | No | YYYYMMDDHHMM | 201412311000 |
STOR Availability To Date | Date | - | No | YYYYMMDDHHMM | 201412311000 |
Weekday Start Time | Date | - | No | HHMM | 10:00 |
Weekday End Time | Date | - | No | HHMM | 10:00 |
Non-weekday Start Time | Date | - | No | HHMM | 10:00 |
Non-weekday End Time | Date | - | No | HHMM | 10:00 |
Service Name | TRADINGUNITService |
Operation Name | TRADINGUNITImpl |
Method | GET |
Input URL |
https://api.bmreports.com/BMRS/TRADINGUNIT/V1?APIKey=<APIKey>&SettlementDate=<SettlementDate>&SettlementPeriod=<SettlementPeriod>&ServiceType=<xml/XML/csv/CSV>
2) Settlement date, Settlement Period, trading unit type and trading unit name mentioned: https://api.bmreports.com/BMRS/TRADINGUNIT/v1?APIKey=<APIKey>&SettlementDate=<SettlementDate>&SettlementPeriod=<SettlementPeriod>&TradeType=<TradeType>&TradeName=<TradeName>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
API Webservice – Request – Trading Unit | ||||
Logical Field Name | Field Type | Remarks | Mandatory | Sample data |
APIKey | String |
| Yes | AP8DA23 |
ServiceType | String |
| No | xml/csv/XML/CSV |
SettlementDate | String |
| Yes | 2017-04-04 |
SettlementPeriod | Int |
| Yes | 2 |
TradeType | String |
| No | Sole |
TradeName | String |
| No | E_EMBEDD18 |
API Webservice – Response– Trading Unit | ||||
Logical Field Name | Field Type | Remarks | Mandatory | Sample data |
Trading Unit Type | String |
| No | Sole |
Settlement Date | String |
| No | 2017-01-29 |
Settlement Period | Int |
| No | 2 |
Settlement Runtype | String |
| No | R2 |
Trading Unit Name | String |
| No | BALGAN TRADING UNIT |
Delivery Mode | String |
| No | Offtaking |
Import Volume | String |
| No | 1111.111 |
Export Volume | String |
| No | 2222.111 |
Net Volume | String |
| No | 1111.000 |
Active Flag | String |
| No | Y |
Service Name | SettlementExchangeRateService |
Operation Name | Settlement ExchangeRateImpl |
Method | GET |
Input URL | https://api.bmreports.com/EURGBFXDATA/V1?APIKey=<APIKey>&SettlementDayFrom=<SettlementDate>&SettlementDayTo=<SettlementDate>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Comments | Default value (if none specified): SettlementDayTo = SettlementDayFrom |
API Webservice – Request | ||||
Logical Field Name | Field Type | Remarks | Mandatory | Sample data |
APIKey | String | - | Yes | AP8DA23 |
Service Type | String | - | No | xml/csv/XML/CSV |
Settlement Day From | String | - | Yes | 2019-02-01 |
Settlement Day To | String | - | No | 2019-02-04 |
| ||||
API Webservice – Response | ||||
Logical Field Name | Field Type | Remarks | Mandatory | Sample data |
Record Type | String | - | No | GBP_EURO_Settlement_Exchange_Rate_Data |
Settlement Day | String |
| No | 2019-02-01 |
Settlement Exchange Rate | Decimal | - | No | 1.13987 |
Date Time Received | DateTime | - | No | 2019-02-01 16:00:00 |
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed string value “GBP EUR SETTLEMENT EXCHANGE RATE” |
Settlement Day | String | - | No | YYYY-MM-DD | 2019-02-01 |
Settlement Exchange Rate | Decimal | - | No | - | 1.13987 |
Date Time Received | DateTime | - | No | YYYY-MM-DD HH:MM:SS | 2019-02-01 16:00:00 |
Service Name | RRBidDataService |
Operation Name | RRBidDataImpl |
Method | GET |
Input URL | https://api.bmreports.com/RRBidData/V1?APIKey=<APIKey>&SettlementDate=<SettlementDate>&SettlementPeriod=<SettlementPeriod>&BMUnitId=<BMUnitId>&BMUnitType=<BMUnit Type>&NGCBMUnitNAme=<NGCBMUnitName>&ParticipantId=<ParticipantId>& ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Comments | Default value (if none specified): SettlementPeriod = * BMUnitId = * BMUnitType = * NGCBMUnitType = * ParticipantId = * |
API Webservice – Request | ||||
Logical Field Name | Field Type | Remarks | Mandatory | Sample data |
APIKey | String | - | Yes | AP8DA23 |
Service Type | String | - | No | xml/csv/XML/CSV |
Settlement Date | String | - | Yes | 2019-02-19 |
Settlement Period | Integer | - | No | 1 |
BM Unit Id | String | - | No | BMU1 |
BM Unit Type | String | - | No | TYPE1 |
NGC BM Unit Name | String | - | No | NGCBMU1 |
Participant Id | String | - | No | PARTY1 |
| ||||
API Webservice -- Response | ||||
Logical Field Name | Field Type | Remarks | Mandatory | Sample data |
Record Type | String | - | No | RRBD |
BM Unit Id | String | - | No | BMU1 |
BM Unit Type | String | - | No | TYPE1 |
NGC BM Unit Name | String | - | No | NGCBMU1 |
NGC Participant Id | String | - | No | PARTY1 |
Time Series Id | String | - | No | NGET-RR1 |
Settlement Date | String | - | No | 2019-02-19 |
Settlement Period | Integer | - | No | 1 |
Quarter Hour Period | Integer | - | No | 1 |
RR Associated TSO | String | - | No | TSO1 |
RR Market Balance Area | String | - | No | Area1 |
RR Divisible | String | - | No | A01 |
RR Linking Bid Id | String | - | No | LINKING1 |
RR Multipart Bid Id | String | - | No | MULTIPART1 |
RR Exclusive Bid Id | String | - | No | EXCLUSIVE1 |
RR Flow Direction | String | - | No | A01 |
RR Minimum Quantity | String | - | No | 1.234 |
RR Quantity | String | - | No | 99.567 |
RR Bid Resolution | String | - | No | PT15M |
RR Position | String | - | No | 1 |
RR Price (£/MWh) | String | - | No | 9.99999 |
RR Status | String | - | No | A06 |
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed string value “Reserve Bid Data” |
BM Unit Id | String | - | No | - | BMU1 |
BM Unit Type | String | - | No | - | TYPE1 |
NGC BM Unit Name | String | - | No | - | NGCBMU1 |
NGC Participant Id | String | - | No | - | PARTY1 |
Time Series Id | String | - | No | - | NGET-RR1 |
Settlement Date | String | - | No | YYYYMMDD | 20190219 |
Settlement Period | Integer | - | No | - | 1 |
Quarter Hour Period | Integer | - | No | - | 1 |
RR Associated TSO | String | - | No | - | TSO1 |
RR Market Balance Area | String | - | No | - | Area1 |
RR Divisible | String | - | No | - | A01 |
RR Linking Bid Id | String | - | No | - | LINKING1 |
RR Multipart Bid Id | String | - | No | - | MULTIPART1 |
RR Exclusive Bid Id | String | - | No | - | EXCLUSIVE1 |
RR Flow Direction | String | - | No | - | A01 |
RR Minimum Quantity | String | - | No | - | 1.234 |
RR Quantity | String | - | No | - | 99.567 |
RR Bid Resolution | String | - | No | - | PT15M |
RR Position | String | - | No | - | 1 |
RR Price (£/MWh) | String | - | No | - | 9.99999 |
RR Status | String | - | No | - | A06 |
Service Name | RRAggregatedInformationDataService |
Operation Name | RRAggregatedInformationDataImpl |
Method | GET |
Input URL | https://api.bmreports.com/RRAggregatedInfo/V1?APIKey=<APIKey>&DateTimeFrom=<DateTime>&DateTimeTo=<DateTime>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Comments | Default value (if none specified): DateTimeTo = DateTimeFrom + 1 hour |
API Webservice – Request | ||||
Logical Field Name | Field Type | Remarks | Mandatory | Sample data |
APIKey | String | - | Yes | AP8DA23 |
Service Type | String | - | No | xml/csv/XML/CSV |
Date Time From | DateTime | - | Yes | 2019-02-28 11:00:00 |
Date Time To | DateTime | - | No | 2019-02-28 12:00:00 |
| ||||
API Webservice – Response | ||||
Logical Field Name | Field Type | Remarks | Mandatory | Sample data |
Record Type | String | - | No | RRAGGINGO |
Auction Period Start | DateTime |
| No | 2019-02-01 11:00:00 |
Auction Period End | DateTime | - | No | 2019-02-01 12:00:00 |
Total Volume of Offered Bids | String | - | No | 1234.567 |
Total volume of Activated Bids | String | - | No | 2345.678 |
Total Volume of Unavailable Bids | String | - | No | 3456.789 |
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed string value “RRAGGINFO” |
Auction Period Start | DateTime |
| No | YYYYMMDDHHMMSS | 20190228110000 |
Auction Period End | DateTime | - | No | YYYYMMDDHHMMSS | 20190228120000 |
Total Volume of Offered Bids | String | - | No | - | 1234.567 |
Total Volume of Activated Bids | String | - | No | - | 2345.678 |
Total Volume of Unavailable Bids | String | - | No | - | 3456.789 |
Service Name | RRActivationDataService |
Operation Name | RRActivationDataImpl |
Method | GET |
Input URL | https://api.bmreports.com/RRActivation/V1?APIKey=<APIKey>&SettlementDate=<SettlementDate>&SettlementPeriod=<SettlementPeriod>&BMUnitId=<BMUnitId>& ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Comments | Default value (if none specified): SettlementPeriod = * BM Unit Id = * |
API Webservice – Request | ||||
Logical Field Name | Field Type | Remarks | Mandatory | Sample data |
APIKey | String | - | Yes | AP8DA23 |
Service Type | String | - | No | xml/csv/XML/CSV |
Settlement Date | String | - | Yes | 2019-02-19 |
Settlement Period | Integer | - | No | 1 |
BM Unit Id | String | - | No | BMU1 |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “RRRESULTS Data” |
Settlement Date |
|
Settlement Period |
|
Logical Field Name | Field Type | Remarks | Mandatory | Sample data |
Record Type | String | - | No | Fixed string value “ACTIVATION” |
NGC Participant Id | String | - | No | PARTY1 |
BM Unit Id | String | - | No | BMU1 |
Settlement Date | Date | - | No | 2019-02-25 |
Settlement Period | Integer | - | No | 25 |
Quarter Hour Period | Integer | - | No | 1 |
Type | String | - | No | B74 |
Flow Direction | String | - | No | UP |
Activated Quantity (MW) | Double | - | No | 100 |
Activation Price (£/MWh) | Double | - | No | 9.99 |
Time Series Id | String | - | No | BMRA_RRBS_2019052909000001 |
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed String Value “RR RESULTS DATA ACTIVATION” |
NGC Participant Id | String | - | No | - | PARTY1 |
BM Unit Id | String | - | No | - | BMU1 |
Settlement Date | Date | - | No | YYYYMMDD | 20190225 |
Settlement Period | Integer | - | No | - | 25 |
Quarter Hour Period | Integer | - | No | - | 1 |
Type | String | - | No | - | B74 |
Flow Direction | String | - | No | - | UP |
Activated Quantity (MW) | Double | - | No | - | 100 |
Activation Price (£/MWh) | Double | - | No | - | 9.99 |
Time Series Id | String | - | No | - | BMRA_RRBS_2019052909000001 |
Service Name | RRInterconnectorScheduleDataService |
Operation Name | RRInterconnectorScheduleDataImpl |
Method | GET |
Input URL | https://api.bmreports.com/RRINTCON/V1?APIKey=<APIKey>&SettlementDate=<SettlementDate>&SettlementPeriod=<SettlementPeriod>&InterconnectorId=<InterconnectorId>& ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Comments | Default value (if none specified): SettlementPeriod = * Interconnector Id = * |
API Webservice – Request | ||||
Logical Field Name | Field Type | Remarks | Mandatory | Sample data |
APIKey | String | - | Yes | AP8DA23 |
Service Type | String | - | No | xml/csv/XML/CSV |
Settlement Date | String | - | Yes | 2019-02-19 |
Settlement Period | Integer | - | No | 1 |
Interconnector Id | String | - | No | INTFR |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “RRRESULTS Data” |
Settlement Date |
|
Settlement Period |
|
Logical Field Name | Field Type | Remarks | Mandatory | Sample data |
Record Type | String | - | No | Fixed string value “INTERCONN” |
Interconnector Id | String | - | No | INTFR |
Settlement Date | Date | - | No | 2019-02-25 |
Settlement Period | Integer | - | No | 25 |
Quarter Hour Period | Integer | - | No | 1 |
Type | String | - | No | A05 |
Flow Direction | String | - | No | UP |
Activated Quantity (MW) | Double | - | No | 100 |
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed String Value “RRRESULTSDATA INTERCONN” |
Interconnector Id | String | - | No | - | INTFR |
Settlement Date | Date | - | No | YYYYMMDD | 20190225 |
Settlement Period | Integer | - | No | - | 25 |
Quarter Hour Period | Integer | - | No | - | 1 |
Type | String | - | No | - | A05 |
Flow Direction | String | - | No | - | UP |
Activated Quantity (MW) | Double | - | No | - | 100 |
Service Name | RRActivationDataService |
Operation Name | RRActivationDataImpl |
Method | GET |
Input URL | https://api.bmreports.com/RRAD/V1?APIKey=<APIKey>&SettlementDate=<SettlementDate>&SettlementPeriod=<SettlementPeriod>& ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Comments | Default value (if none specified): SettlementPeriod = * |
API Webservice – Request | ||||
Logical Field Name | Field Type | Remarks | Mandatory | Sample data |
APIKey | String | - | Yes | AP8DA23 |
Service Type | String | - | No | xml/csv/XML/CSV |
Settlement Date | String | - | Yes | 2019-02-19 |
Settlement Period | Integer | - | No | 1 |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “RRRESULTS Data” |
Settlement Date |
|
Settlement Period |
|
Logical Field Name | Field Type | Remarks | Mandatory | Sample data |
Record Type | String | - | No | Fixed string value “AD” |
Settlement Date | Date | - | No | 2019-02-25 |
Settlement Period | Integer | - | No | 25 |
Quarter Hour Period | Integer | - | No | 1 |
Type | String | - | No | B75 |
Flow Direction | String | - | No | UP |
Activated Quantity (MW) | Double | - | No | 100 |
Activation Price (£/MWh) | Double | - | No | 9.99 |
Market Object Status | String |
| No | Fixed string value “Ordered” |
Logical Field Name | Field Type | Remarks | Mandatory | Sample data |
Record Type | String | - | No | Fixed string value “RRRESULTS DATA AD” |
Settlement Date | Date | - | No | 2019-02-25 |
Settlement Period | Integer | - | No | 25 |
Quarter Hour Period | Integer | - | No | 1 |
Type | String | - | No | B74 |
Flow Direction | String | - | No | UP |
Activated Quantity (MW) | Double | - | No | 100 |
Activation Price (£/MWh) | Double | - | No | 9.99 |
Market Object Status | String |
| No | Fixed string value “Ordered” |
Service Name | RRGBNeedMetDataService |
Operation Name | RRGBNeedMetDataImpl |
Method | GET |
Input URL | https://api.bmreports.com/RRGBNM/V1?APIKey=<APIKey>&SettlementDate=<SettlementDate>&SettlementPeriod=<SettlementPeriod>& ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Comments | Default value (if none specified): SettlementPeriod = * |
API Webservice – Request | ||||
Logical Field Name | Field Type | Remarks | Mandatory | Sample data |
APIKey | String | - | Yes | AP8DA23 |
Service Type | String | - | No | xml/csv/XML/CSV |
Settlement Date | String | - | Yes | 2019-02-19 |
Settlement Period | Integer | - | No | 1 |
Report Output Field Mapping | Condition |
Record Type | Fixed string value “HDR” |
File Type | Fixed string value “RRRESULTS Data” |
Settlement Date |
|
Settlement Period |
|
Logical Field Name | Field Type | Remarks | Mandatory | Sample data |
Record Type | String | - | No | Fixed string value “GBNM” |
Settlement Date | Date | - | No | 2019-02-25 |
Settlement Period | Integer | - | No | 25 |
Quarter Hour Period | Integer | - | No | 1 |
Type | String | - | No | B75 |
Flow Direction | String | - | No | UP |
Activated Quantity (MW) | Double | - | No | 100 |
Activation Price (£/MWh) | Double | - | No | 9.99 |
Logical Field Name | Field Type | Remarks | Mandatory | Sample data |
Record Type | String | - | No | Fixed string value “RRRESULTS DATA GBNM” |
Settlement Date | Date | - | No | 2019-02-25 |
Settlement Period | Integer | - | No | 25 |
Quarter Hour Period | Integer | - | No | 1 |
Type | String | - | No | B75 |
Flow Direction | String | - | No | UP |
Activated Quantity (MW) | Double | - | No | 100 |
Activation Price (£/MWh) | Double | - | No | 9.99 |
Service Name | RRIndicativeCashflowService |
Operation Name | RRIndicativeCashflowImpl |
Method | GET |
Input URL | https://api.bmreports.com/ICCR/V1?APIKey=<APIKey>&SettlementDate=<SettlementDate>&SettlementPeriod=<SettlementPeriod>&LeadParty Name=<LeadPartyName>&BMUnitType=<BMUnitType>&NGCBMUnitId=<NGCBMUnitId>&BMUnitId=<BMUnitId>&ServiceType=<xml/XML/csv/CSV> |
Output Format | XML/CSV |
Comments | Default value (if none specified): SettlementPeriod = * LeadPartyName = * BMUnitType =* NGCBMUnitId =* BMUnitId = * |
API Webservice – Request | ||||
Logical Field Name | Field Type | Remarks | Mandatory | Sample data |
APIKey | String | - | Yes | AP8DA23 |
Service Type | String | - | No | xml/csv/XML/CSV |
Settlement Date | Date | - | Yes | 2019-02-28 |
Settlement Period | Integer | - | No | 1 |
BM Unit Id | String | - | No | BMU1 |
| ||||
API Webservice – Response | ||||
Logical Field Name | Field Type | Remarks | Mandatory | Sample data |
Record Type | String | - | No | ICCR |
BM Unit Id | String | - | No | BMU1 |
Settlement Date | String | - | No | 2019-02-28 |
Settlement Period | Integer | - | No | 1 |
Quarter Hour Period | Integer | - | No | 1 |
Quarter Hour RR Activated Quantity | String | - | No | 100 |
Quarter Hour RR Activated Volume | String | - | No | 25 |
RR Activation Price | Double | - | No | 9.99 |
Quarter Hour RR Cashflow | String | - | No | 249.75 |
Period RR BM Unit Cashflow | String | - | No | 474.53 |
|
|
|
|
|
|
Logical Field Name | Field Type | Remarks | Mandatory | CSV Format | Sample data |
Record Type | String | - | No | - | Fixed string value “ICCR” |
BM Unit Id | String | - | No | - | BM Unit Id |
Settlement Date | String | - | No | YYYYMMDD | 20190228 |
Settlement Period | Integer | - | No | - | 1 |
Quarter Hour Period | Integer | - | No | - | 1 |
Quarter Hour RR Activated Quantity | String | - | No | - | 100 |
Quarter Hour RR Activated Volume | String | - | No | - | 25 |
RR Activation Price | Double | - | No | - | 9.99 |
Quarter Hour RR Cashflow | String | - | No | - | 249.75 |
Period RR BM Unit Cashflow | String | - | No | - | 474.53 |
OpenWire | OpenWire is the default cross language wire protocol that is supported by the BMRS Data Push Service. |
Stomp | The BMRS Data Push Service implements version 1.1 of the STOMP wire protocol. STOMP is the Simple (or Streaming) Text Orientated Messaging Protocol. STOMP provides an interoperable wire format so that STOMP clients can communicate with any STOMP message broker to provide easy and widespread messaging interoperability among many languages, platforms and brokers. |
AMQP | The BMRS Data Push Service implements version 1.0 of the OASIS AMQP TC protocol. The OASIS AMQP TC advances a vendor-neutral and platform-agnostic protocol that offers organizations an easier; more secure approach to passing real-time data streams and business transactions. The goal of AMQP is to ensure information is safely and efficiently transported between applications, among organizations, across distributed cloud computing environments, and within mobile infrastructures. AMQP avoids proprietary technologies, offering the potential to lower the cost of enterprise middleware software integrations through open interoperability. By enabling a commoditized, multi-vendor ecosystem, AMQP seeks to create opportunities for transforming the way business is done in the Cloud and over the Internet. |
OpenWire over TCP | ssl://<host>:61616 |
OpenWire over HTTPS | https://<host>:61617 |
Stomp | stomp+ssl://<host>:61613 |
AMQP | amqp+ssl://<host>:5672 |
Interface ID | Data flow type | Data Items | Date set IDD ref
|
BMRA-I004 | Balancing Mechanism Data | Bid-Offer Acceptance Level Flagged Data | BOALF |
BMRA-I004 | Balancing Mechanism Data | Bid-Offer Data | BOD |
BMRA-I004 | Balancing Mechanism Data | Maximum Delivery Period | MDP |
BMRA-I004 | Balancing Mechanism Data | Maximum Delivery Volume | MDV |
BMRA-I004 | Balancing Mechanism Data | Maximum Export Limit | MEL, MELS |
BMRA-I004 | Balancing Mechanism Data | Maximum Import Limit | MIL, MILS |
BMRA-I004 | Balancing Mechanism Data | Minimum Non-Zero Time | MNZT |
BMRA-I004 | Balancing Mechanism Data | Minimum Zero Time | MZT |
BMRA-I004 | Balancing Mechanism Data | Notice to Deviate from Zero | NDZ |
BMRA-I004 | Balancing Mechanism Data | Notice to Deliver Bids | NTB |
BMRA-I004 | Balancing Mechanism Data | Notice to Deliver Offers | NTO |
BMRA-I004 | Balancing Mechanism Data | Point FPN Data | PN, FPN |
BMRA-I004 | Balancing Mechanism Data | Applicable Balancing Services Volume Data | QAS |
BMRA-I004 | Balancing Mechanism Data | Point Quiescent FPN Data | QPN |
BMRA-I004 | Balancing Mechanism Data | Run Down Rates Export | RDRE |
BMRA-I004 | Balancing Mechanism Data | Run Down Rates Import | RDRI |
BMRA-I004 | Balancing Mechanism Data | Run Up Rates Export | RURE |
BMRA-I004 | Balancing Mechanism Data | Run Up Rates Import | RURI |
BMRA-I004 | Balancing Mechanism Data | Stable Export Limit | SEL |
BMRA-I004 | Balancing Mechanism Data | Stable Import Limit | SIL |
BMRA-I005 | System Related Data | Balancing Services Adjustment Action ID (unique for Settlement Period), Balancing Services Adjustment Action Cost (£), Balancing Services Adjustment Action Volume (MWh), Balancing Services Adjustment Action SO-Flag (T/F) | DISBSAD |
BMRA-I005 | System Related Data | National Output Usable by Fuel Type, 2-14 Day | FOU2T14D |
BMRA-I005 | System Related Data | National Output Usable by Fuel Type, 2-52 Week | FOU2T52W |
BMRA-I005 | System Related Data | Realtime Transmission System Frequency Data | FREQ |
BMRA-I005 | System Related Data | Half Hourly Generation By Fuel Type | FUELHH |
BMRA-I005 | System Related Data | Instantaneous Generation By Fuel Type | FUELINST |
BMRA-I005 | System Related Data | Indicated Imbalance | IMBALNGC |
BMRA-I005 | System Related Data | Sum of PN Demand (MW), (Indicated Demand) | INDDEM |
BMRA-I005 | System Related Data | Sum of PN Generation (MW), (Indicated Generation) | INDGEN |
BMRA-I005 | System Related Data | Initial National Demand Out-Turn | INDO |
BMRA-I005 | System Related Data | Outturn Volume (MWh), Normal Volume (MWh), High Volume (MWh), Low Volume (MWh) | INDOD |
BMRA-I005 | System Related Data | Initial Transmission System Demand Out-Turn | ITSDO |
BMRA-I005 | System Related Data | Indicated Margin | MELNGC |
BMRA-I005 | System Related Data | Market Index Price, Market Index Volume | MID |
BMRA-I005 | System Related Data | Missing Market Index Data Messages | Missing MID |
BMRA-I005 | System Related Data | National Demand Forecast | NDF |
BMRA-I005 | System Related Data | National Demand Forecast Day, 2-14 Day | NDFD |
BMRA-I005 | System Related Data | National Demand Forecast Week, 2-52 Week | NDFW |
BMRA-I005 | System Related Data | Net Energy Buy Price Cost Adjustment (EBCA) (£), Net Energy Buy Price Volume Adjustment (EBVA) (MWh), Net System Buy Price Volume Adjustment (SBVA) (MWh), Buy Price Price Adjustment (BPA) (£/MWh), Net Energy Sell Price Cost Adjustment (ESCA) (£),Net Energy Sell Price Volume Adjustment (ESVA) (MWh), Net System Sell Price Volume Adjustment (SSVA) (MWh), Sell Price Price Adjustment (SPA) (£/MWh) | NETBSAD |
BMRA-I005 | System Related Data | Non-BM STOR Out-Turn | NONBM |
BMRA-I005 | System Related Data | National Surplus Forecast, 2-14 Day | OCNMFD |
BMRA-I005 | System Related Data | National Surplus Forecast, 2-156 Weeks | OCNMF3Y |
BMRA-I005 | System Related Data | Generating Plant Demand Margin, 2-14 Days | OCNMFD2 |
BMRA-I005 | System Related Data | Generating Plant Demand Margin, 2-156 Weeks | OCNMF3Y2 |
BMRA-I005 | System Related Data | National Surplus Forecast, 2-52 Week | OCNMFW |
BMRA-I005 | System Related Data | Generating Plant Demand Margin, 2-52 Weeks | OCNMFW2 |
BMRA-I005 | System Related Data | SO-SO Prices | SO-SO |
BMRA-I005 | System Related Data | System Message | SYSMSG |
BMRA-I005 | System Related Data | System Zone Map | System Zone Map |
BMRA-I005 | System Related Data | System Warnings | SYSWARN |
BMRA-I005 | System Related Data | Outturn Temperature, Low Reference Temperature, Normal Reference Temperature, High Reference Temperature (all degrees Celsius) | TEMP, REFTEMP |
BMRA-I005 | System Related Data | Transmission System Demand Forecast | TSDF |
BMRA-I005 | System Related Data | Transmission System Demand Forecast Day, 2-14 Day | TSDFD |
BMRA-I005 | System Related Data | Transmission System Demand Forecast Week, 2-52 Week | TSDFW |
BMRA-I005 | System Related Data | National Output Usable by Fuel Type and BM Unit, 2-14 Day | UOU2T14D |
BMRA-I005 | System Related Data | National Output Usable by Fuel Type and BM Unit, 2-52 Week | UOU2T52W |
BMRA-I005 | System Related Data | National Output Usable, 2-156 Weeks | NOU2T3YW |
BMRA-I005 | System Related Data | National Output Usable by Fuel Type, 2-156 Weeks | FOU2T3YW |
BMRA-I005 | System Related Data | National Output Usable by Fuel Type and BM Unit, 2-156 Weeks | UOU2T3YW |
BMRA-I005 | System Related Data | Generation Forecast (MW), Total Registered Capacity (MW) | WINDFOR |
BMRA-I006 | Derived Data | Period Bid and Offer Acceptance Volumes (QAB, QAO and CADL Flag) | BOAV |
BMRA-I006 | Derived Data | Estimated Period BM Unit Total Accepted Bid and Offer Volume (QAB and QAO), Estimated Period BM Unit Tagged Accepted Bid and Offer Volume (QTAB and QTAO), Estimated Period BM Unit Repriced Accepted Bid and Offer Volume (QRAB and QRAO), Estimated Period BM Unit Originally-Priced Accepted Bid and Offer Volume (QOAB and QOAO) | DISPTAV |
BMRA-I006 | Derived Data | Estimated Bid Offer Cash flows | EBOCF |
BMRA-I006 | Derived Data | Index, Component Identifier, Acceptance Number, Bid-Offer Pair Number, CADL Flag (T/F), SO-Flag (T/F), Repriced Indicator (T/F), Volume (MWh), DMAT Adjusted Volume (MWh), Arbitrage Adjusted Volume (MWh), NIV Adjusted Volume (MWh), PAR Adjusted Volume (MWh), Final Price (£/MWh), Transmission Loss Multiplier, TLM Adjusted Volume (MWh), TLM Adjusted Cost (£) | ISPSTACK |
BMRA-I006 | Derived Data | Estimated Period Balancing Mechanism Bid and Offer Cashflows (CB and CO) | PTAV |
BMRA-I006 | Derived Data | Disaggregated Estimated Buy and Sell Price | DISEBSP |
BMRA-I006 | Derived Data | Total Bid Volume and Total Offer Volume | TBOD |
BMRA-I019 | Credit Default Notices | Credit Default Notices | CDN |
BMRA-I037 | Replacement Reserve Data | Replacement Reserve Bid Data | RRBD |
BMRA-I037 | Replacement Reserve Data | Indicative RR Bid and Offer Volumes | RRBOAV |
BMRA-I037 | Replacement Reserve Data | Indicative RR Bid and Offer Acceptance Volumes | RRPTAV |
BMRA-I037 | Replacement Reserve Data | Indicative RR Quarter Hour Cashflows | QRRC |
BMRA-I037 | Replacement Reserve Data | Indicative RR Period Cashflows | PRRC |
BMRA-I037 | Replacement Reserve Data | RR Activation Data | AD |
BMRA-I037 | Replacement Reserve Data | GB Need Met | GBNM |
BMRA-I037 | Replacement Reserve Data | Interconnector Schedule | IS |
BMRA-I037 | Replacement Reserve Data | RR Aggregated Information | AGGINFO |
Data Type | Field Type |
Acceptance Level Value | VA |
Acceptance Number | NK |
Acceptance Time | TA |
Adjustment Cost | JC |
Adjustment Identifier | AI |
Adjustment Volume | JV |
Affected LDSO | DS |
Amendment Flag | AM |
Applicable Balancing Services Volume | SV |
Arbitrage Adjusted Volume | AV |
Bid Cashflow | BC |
Bid Price | BP |
Bid Volume | BV |
Bid/Offer Indicator | BO |
Bid-Offer Level Value | VB |
Bid-Offer Original Price | UP |
Bid-Offer Pair Number | NN |
BMRS Informational Text | IN |
BSAD Defaulted | BD |
Buy Price | PB |
Buy Price Cost Adjustment | A4 |
Buy Price Price Adjustment | A6 |
Buy Price Volume Adjustment | A5 |
CADL Flag | CF |
Calendar Week Number | WN |
Calendar Year | CY |
Cleared Default Settlement Date | CD |
Cleared Default Settlement Period | CP |
Component Identifier | CI |
Contract Identification | IC |
Credit Default Level | DL |
Deemed Bid-Offer Flag | AD |
Demand Control Event Flag | EV |
Demand Control ID | ID |
Demand Control Level | VO |
Demand Margin | DM |
Demand Value | VD |
DMAT Adjusted Volume | DA |
Effective From Time | TE |
Energy Volume Daily High Reference | EH |
Energy Volume Daily Low Reference | EL |
Energy Volume Daily Normal Reference | EN |
Energy Volume Outturn | EO |
Entered Default Settlement Date | ED |
Entered Default Settlement Period | EP |
Export Level Value | VE |
Fuel Type | FT |
Fuel Type Generation | FG |
GB Noon Temperature Outturn | TO |
GB Reference High Noon Temperature | TH |
GB Reference Low Noon Temperature | TL |
GB Reference Normal Noon Temperature | TN |
Generation Value | VG |
Imbalance Value | VI |
Import Level Value | VF |
Indicative Net Imbalance Volume | NI |
Instruction Sequence No | SQ |
Margin/Surplus Value | VM |
Market Index Data Provider ID | MI |
Market Index Price | M1 |
Market Index Volume | M2 |
Market Object Status | MOS |
Maximum Delivery Period | DP |
Maximum Delivery Volume | DV |
Message Type | MT |
Minimum non-Zero Time | MN |
Minimum Zero Time | MZ |
Net Energy Buy Price Cost Adjustment | A9 |
Net Energy Buy Price Volume Adjustment | A10 |
Net Energy Sell Price Cost Adjustment | A7 |
Net Energy Sell Price Volume Adjustment | A8 |
Net System Buy Price Volume Adjustment | A12 |
Net System Sell Price Volume Adjustment | A11 |
NIV Adjusted Volume | NV |
Non-BM STOR Volume | NB |
Notice to Deliver Bids | DB |
Notice to Deliver Offers | DO |
Notice to Deviate from Zero | DZ |
Number of Records | NR |
Number Of Spot Points | NP |
Offer Cashflow | OC |
Offer Price | OP |
Offer Volume | OV |
Output Usable | OU |
PAR Adjusted Volume | PV |
Party Id | PI |
Period Originally-Priced BM Unit Bid Volume | P6 |
Period Originally-Priced BM Unit Offer Volume | P3 |
Period Repriced BM Unit Bid Volume | P5 |
Period Repriced BM Unit Offer Volume | P2 |
Period Tagged BM Unit Bid Volume | P4 |
Period Tagged BM Unit Offer Volume | P1 |
PN Level Value | VP |
Price Derivation Code | PD |
Publishing Time | TP |
Replacement Price | RP |
Replacement Price Calculation Volume | RV |
Repriced Indicator | RI |
Reserve Scarcity Price | RSP |
RR Accepted Bid Volume | BV |
RR Accepted Offer Volume | OV |
RR Associated TSO | AT |
RR Auction Period End | AE |
RR Auction Period Start | AS |
RR Bid Resolution | BR |
RR Business Type | TY |
RR Cashflow | CR |
RR Divisible | DI |
RR Exclusive Bid Id | EB |
RR Flow Direction | FD |
RR Instruction Flag | RN |
RR Interconnector Identifier | IN |
RR Linking Bid Id | LB |
RR Market Balance Area | BA |
RR Maximum Quantity | QX |
RR Multipart Bid Id | MB |
RR Position | PO |
RR Price | PR |
RR Quantity | QI |
RR Quarter Hour Period | QP |
RR Schedule Flag | SC |
RR Status | RS |
Run Down Elbow 2 | RB |
Run Down Elbow 3 | RC |
Run Down Rate 1 | R1 |
Run Down Rate 2 | R2 |
Run Down Rate 3 | R3 |
Run Up Elbow 2 | UB |
Run Up Elbow 3 | UC |
Run Up Rate 1 | U1 |
Run Up Rate 2 | U2 |
Run Up Rate 3 | U3 |
Sell Price | PS |
Sell Price Cost Adjustment | A1 |
Sell Price Price Adjustment | A3 |
Sell Price Volume Adjustment | A2 |
Sequence Number | SN |
Settlement Date | SD |
Settlement Period | SP |
Short Acceptance Flag | SA |
SO-Flag | SO |
SO-SO Start Time | ST |
SO-SO Trade Type | TT |
Spot Time | TS |
Stable Export Limit | SE |
Stable Import Limit | SI |
Stack Item Final Price | FP |
Stack Item Original Price | IP |
Stack Item Volume | IV |
STOR Provider Flag | PF |
System Frequency | SF |
System Message Text | SM |
System Total Priced Accepted Bid Volume | PC |
System Total Priced Accepted Offer Volume | PP |
System Total Unpriced Accepted Bid Volume | AC |
System Total Unpriced Accepted Offer Volume | AP |
System Warning Text | SW |
Tagged Accepted Bid Volume | T2 |
Tagged Accepted Offer Volume | T1 |
Tagged Adjustment Buy Volume | J4 |
Tagged Adjustment Sell Volume | J3 |
Time From | TF |
Time To | TI |
TLM Adjusted Cost | TC |
TLM Adjusted Volume | TV |
Total Accepted Bid Volume | AB |
Total Accepted Offer Volume | AO |
Total Adjustment Buy Volume | J2 |
Total Adjustment Sell Volume | J1 |
Total Bid Volume | BT |
Total Offer Volume | OT |
Total Registered Capacity | TR |
Total Volume of Activated Bids | TA |
Total Volume of Offered Bids | TO |
Total Volume of Unavailable Bids | TU |
Trade Direction | TD |
Trade Price | PT |
Trade Quantity | TQ |
Transmission Loss Multiplier | TM |
Week Start Date | WD |
Zone Indicator | ZI |
The broker address is api.bmreports.com (for production), testapi.bmreports.com (for testing)
The port varies depending on the chosen protocol – see section 8.3.
The method of establishing a durable connection varies depending on the protocol – see the ActiveMQ website for details
Regardless of chosen protocol, your scripting key should be passed as both username and password – see your profile page of the ELEXON Portal
The topic is /topic/bmrsTopic
No particular approach is recommended, but Java examples are provided in the Appendix of this document
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “FTR” |
Body Record Count | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed string “FORECAST DAY AND DAY AHEAD DEMAND DATA” |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “DANF” |
Settlement Date | date | yyyymmdd | Records ordered incrementing by this field first |
Settlement Period | number |
| Records ordered incrementing by this field second |
Boundary ID | string | Always N |
|
Publication Time | datetime | yyyymmddhh24miss |
|
Demand Forecast (DF) | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “DAID” |
Settlement Date | date | yyyymmdd | Records ordered incrementing by this field first |
Settlement Period | number |
| Records ordered incrementing by this field second |
Boundary ID | string | One of B1-B17 or N |
|
Publication Time | datetime | yyyymmddhh24miss |
|
Indicated Demand (INDDEM) | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “DAIG” |
Settlement Date | date | yyyymmdd | Records ordered incrementing by this field first |
Settlement Period | number |
| Records ordered incrementing by this field second |
Boundary ID | string | One of B1-B17 or N |
|
Publication Time | datetime | yyyymmddhh24miss |
|
Indicated Generation (INDGEN) | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “DATF” |
Settlement Date | date | yyyymmdd | Records ordered incrementing by this field first |
Settlement Period | number |
| Records ordered incrementing by this field second |
Boundary ID | string | One of B1-B17 or N |
|
Publication Time | datetime | yyyymmddhh24miss |
|
Demand Forecast (DF) | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed string “FORECAST DAY AND DAY AHEAD MARGIN AND IMBALANCE DATA” |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “DAM” |
Settlement Date | date | yyyymmdd | Records ordered incrementing by this field first |
Settlement Period | number |
| Records ordered incrementing by this field second |
Boundary ID | string | One of B1-B17 or N |
|
Publication Time | datetime | yyyymmddhh24miss |
|
Indicated Margin (MELNGC) | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “DAI” |
Settlement Date | date | yyyymmdd | Records ordered incrementing by this field first |
Settlement Period | number |
| Records ordered incrementing by this field second |
Boundary ID | string | One of B1-B17 or N |
|
Publication Time | datetime | yyyymmddhh24miss |
|
Indicated Imbalance (IMBALNGC) | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed string “FORECAST 2 TO 14 DAYS AHEAD DEMAND AND MARGIN DATA” |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “DSN” |
Settlement Date | date | yyyymmdd | Records ordered incrementing by this field first |
Settlement Period | number |
| Records ordered incrementing by this field second |
Boundary ID | string | Always N |
|
Publication Time | datetime | yyyymmddhh24miss |
|
Average half-hour MW Demand value for peak of Day (NDFD) | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “DSM” |
Settlement Date | date | yyyymmdd | Records ordered incrementing by this field first |
Settlement Period | number |
| Records ordered incrementing by this field second |
Boundary ID | string | Always N |
|
Publication Time | datetime | yyyymmddhh24miss |
|
Average half-hour MW Surplus value for peak of Day (OCNMFD) | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “DST” |
Settlement Date | date | yyyymmdd | Records ordered incrementing by this field first |
Settlement Period | number |
| Records ordered incrementing by this field second |
Boundary ID | string | Always N |
|
Publication Time | datetime | yyyymmddhh24miss |
|
Average half-hour MW Demand value for peak of Day (TSDFD) | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “OCNMFD2” |
Settlement Date | date | yyyymmdd | Records ordered incrementing by this field first |
Settlement Period | number |
| Records ordered incrementing by this field second |
Boundary ID | string | Always N |
|
Publication Time | datetime | yyyymmddhh24miss |
|
Average half-hour MW demand margin value for peak of Day (OCNMFD2) | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed string “FORECAST 2 TO 52 WEEKS AHEAD DEMAND AND MARGIN DATA” |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “WN” |
Week Number | number |
| Records ordered incrementing by this field (wraps from 53 to 1 when new year starts) |
Boundary ID | string | Always N |
|
Publication Time | datetime | yyyymmddhh24miss |
|
Average half-hour MW Demand value for peak of Week (NDFW) | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “WM” |
Week Number | number |
| Records ordered incrementing by this field (wraps from 53 to 1 when new year starts) |
Boundary ID | string | Always N |
|
Publication Time | datetime | yyyymmddhh24miss |
|
Average half-hour MW Surplus value for peak of Week (OCNMFW) | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “OCNMFW2” |
Week Number | number |
| Records ordered incrementing by this field (wraps from 53 to 1 when new year starts) |
Boundary ID | string | Always N |
|
Publication Time | datetime | yyyymmddhh24miss |
|
Average half-hour MW demand margin value for peak of Week (OCNMFW2) | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed string “FORECAST 2 TO 156 WEEKS AHEAD MARGIN DATA” |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “OCNMF3Y” |
Week Number | number |
| Records ordered incrementing by this field (wraps from 53 to 1 when new year starts) |
Calendar Year | number |
|
|
Boundary ID | string | Always N |
|
Publication Time | datetime | yyyymmddhh24miss |
|
Average half-hour MW Surplus value for peak of Week (OCNMF3Y) | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “OCNMF3Y2” |
Week Number | number |
| Records ordered incrementing by this field (wraps from 53 to 1 when new year starts) |
Calendar Year | number |
|
|
Boundary ID | string | Always N |
|
Publication Time | datetime | yyyymmddhh24miss |
|
Average half-hour MW demand margin value for peak of Week (OCNMFW2) | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed String “NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-14 DAYS) DATA” |
Body Record
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “NOU2T14D” |
Publication Time | datetime | yyyymmddhh24miss |
|
System Zone | string | Always N |
|
Settlement Date | date |
|
|
Output Usable | number |
|
|
Example File
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed String “NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-52 WEEKS) DATA” |
Body Record
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “NOU2T52W” |
Publication Time | datetime | yyyymmddhh24miss |
|
System Zone | string | Always N |
|
Calendar Week Number | number |
|
|
Calendar Year | number |
|
|
Output Usable | number |
|
|
Example Record
Field | Type | Format | Comments |
Record Type | string |
| Fixed String “HDR” |
|
|
|
|
File Type | string |
| Fixed String “NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-156 WEEKS) DATA” |
Body Record
Field | Type | Format | Comments |
Record Type | string |
| Fixed String “NOU2T3YW” |
Publication Time | datetime | yyyymmddhh24miss |
|
System Zone | string | Always N |
|
Calendar Week Number | number |
|
|
Calendar Year | number |
|
|
Output Usable | number |
|
|
Example Record
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed String “NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-14 DAYS) DATA – BY FUEL TYPE” |
Body Record
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “FOU2T14D” |
Fuel Type |
|
|
|
Publication Time | datetime | yyyymmddhh24miss |
|
System Zone | string | Always N |
|
Settlement Date | date |
|
|
Output Usable | number |
|
|
Example File
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed String “NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-14 DAYS) DATA – BY BM UNIT/INTERCONNECTOR & FUEL TYPE” |
Body Record
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “UOU2T14D” |
BM Unit ID |
|
|
|
Fuel Type |
|
|
|
Publication Time | datetime | yyyymmddhh24miss |
|
System Zone | string | Always N | System Zone |
Settlement Date | date |
|
|
Output Usable | number |
|
|
Example File
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed String “NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-52 WEEKS) DATA –FUEL TYPE” |
Body Record
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “FOU2T52W” |
Fuel Type |
|
|
|
Publication Time | datetime | yyyymmddhh24miss |
|
System Zone | string | Always N |
|
Calendar Week Number | number |
|
|
Calendar Year | number |
|
|
Output Usable | number |
|
|
Example File
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed String “NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-52 WEEKS) DATA – BY BM UNIT/INTERCONNECTOR & FUEL TYPE” |
Body Record
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “UOU2T52W” |
BM Unit ID |
|
|
|
Fuel Type |
|
|
|
Publication Time | datetime | yyyymmddhh24miss |
|
System Zone | string | Always N |
|
Calendar Week Number | number |
|
|
Calendar Year | number |
|
|
Output Usable | number |
|
|
Example File
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed String “NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-156 WEEKS) DATA –FUEL TYPE” |
Body Record
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “FOU2T3YW” |
Fuel Type |
|
|
|
Publication Time | datetime | yyyymmddhh24miss |
|
System Zone | string | Always N |
|
Calendar Week Number | number |
|
|
Calendar Year | number |
|
|
Output Usable | number |
|
|
Example File
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed String “NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-156 WEEKS) DATA – BY BM UNIT/INTERCONNECTOR & FUEL TYPE” |
Body Record
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “UOU2T3YW” |
BM Unit ID |
|
|
|
Fuel Type |
|
|
|
Publication Time | datetime | yyyymmddhh24miss |
|
System Zone | string | Always N |
|
Calendar Week Number | number |
|
|
Calendar Year | number |
|
|
Output Usable | number |
|
|
Example File
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed string “INITIAL DEMAND OUTTURN” |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “INDO” |
Settlement Date | date | yyyymmdd | Group ordered by this field first, incrementing. |
Settlement Period | number |
| Group ordered by this field second, incrementing. |
National Demand Out-Turn | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “ITSDO” |
Settlement Date | date | yyyymmdd | Group ordered by this field first, incrementing. |
Settlement Period | number |
| Group ordered by this field second, incrementing. |
Initial Transmission System Demand Out-Turn (ITSDO) | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed string “PHYSICAL BM DATA” |
|
|
|
|
Settlement Date | date | yyyymmdd |
|
Settlement Period | string |
| number between 1 and 50 or * if selecting a full day’s data |
Field | Type | Format | Comments |
---|---|---|---|
Record Type (PN) | string |
| Fixed String “PN” |
BM Unit ID | string |
| ordered by this field first, incrementing |
Settlement Period | number |
| number between 1 and 50; ordered by this field second, incrementing |
From Time | datetime | yyyymmddhh24miss | Group ordered by this field third, incrementing. |
From Level | number |
|
|
To Time | datetime | yyyymmddhh24miss |
|
To Level | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type (QPN) | string |
| Fixed String “QPN” |
BM Unit ID | string |
| ordered by this field first, incrementing |
Settlement Period | number |
| number between 1 and 50; ordered by this field second, incrementing |
From Time | datetime | yyyymmddhh24miss | Group ordered by this field third, incrementing. |
From Level | number |
|
|
To Time | datetime | yyyymmddhh24miss |
|
To Level | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type (MEL) | string |
| Fixed String “MEL” |
BM Unit ID | string |
| ordered by this field first, incrementing |
Settlement Period | number |
| number between 1 and 50; ordered by this field second, incrementing |
From Time | datetime | yyyymmddhh24miss | Group ordered by this field third, incrementing. |
From Level | number |
|
|
To Time | datetime | yyyymmddhh24miss |
|
To Level | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type (MIL) | string |
| Fixed String “MIL” |
BM Unit ID | string |
| ordered by this field first, incrementing |
Settlement Period | number |
| number between 1 and 50; ordered by this field second, incrementing |
From Time | datetime | yyyymmddhh24miss | Group ordered by this field third, incrementing. |
From Level | number |
|
|
To Time | datetime | yyyymmddhh24miss |
|
To Level | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type(BOAL) | string |
| Fixed String “BOAL” |
BM Unit ID | string |
| ordered by this field first, incrementing |
Bid Offer Acceptance ID | number |
| Group ordered secondly by this field, incrementing. |
Acceptance Time | datetime | yyyymmddhh24miss |
|
Deemed Flag | boolean | Y or N |
|
From Time | datetime | yyyymmddhh24miss | Group ordered thirdly by this field, incrementing. |
From Level | number |
|
|
To Time | datetime | yyyymmddhh24miss |
|
To Level | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type(BOALF) | string |
| Fixed String “BOALF” |
BM Unit ID | string |
| ordered by this field first, incrementing |
Bid Offer Acceptance ID | number |
| Group ordered secondly by this field, incrementing. |
Acceptance Time | datetime | yyyymmddhh24miss |
|
Deemed Flag | boolean | Y or N |
|
SO-Flag | boolean | T or F | 'T' if potentially impacted by transmission constraints. |
STOR Provider Flag | boolean | T or F | ‘T’ if related to a STOR Provider This field will be null if pre-P305 Settlement Date |
RR Instruction Flag | boolean | T or F |
|
RR Schedule Flag | boolean | T or F |
|
From Time | datetime | yyyymmddhh24miss | Group ordered thirdly by this field, incrementing. |
From Level | number |
|
|
To Time | datetime | yyyymmddhh24miss |
|
To Level | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed string “DYNAMIC DATA” |
|
|
|
|
Settlement Date | date | yyyymmdd |
|
Settlement Period | string |
| number between 1 and 50 or * if selecting a full day’s data |
Field | Type | Format | Comments |
---|---|---|---|
Record Type (RURE) | string |
| Fixed String “RURE” |
BM Unit ID | string |
| Ordered by this field first, incrementing |
Time | datetime | yyyymmddhh24miss | Ordered by this field second, incrementing |
Rate 1 | number |
|
|
Elbow 2 | number |
|
|
Rate 2 | number |
|
|
Elbow 3 | number |
|
|
Rate 3 | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type (RDRE) | string |
| Fixed String “RDRE” |
BM Unit ID | string |
| Ordered by this field first, incrementing |
Time | datetime | yyyymmddhh24miss | Ordered by this field second, incrementing |
Rate 1 | number |
|
|
Elbow 2 | number |
|
|
Rate 2 | number |
|
|
Elbow 3 | number |
|
|
Rate 3 | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type (RURI) | string |
| Fixed String “RURI” |
BM Unit ID | string |
| Ordered by this field first, incrementing |
Time | datetime | yyyymmddhh24miss | Ordered by this field second, incrementing |
Rate 1 | number |
|
|
Elbow 2 | number |
|
|
Rate 2 | number |
|
|
Elbow 3 | number |
|
|
Rate 3 | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type (RDRI) | string |
| Fixed String “RDRI” |
BM Unit ID | string |
| Ordered by this field first, incrementing |
Time | datetime | yyyymmddhh24miss | Ordered by this field second, incrementing |
Rate 1 | number |
|
|
Elbow 2 | number |
|
|
Rate 2 | number |
|
|
Elbow 3 | number |
|
|
Rate 3 | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type (NDZ) | string |
| Fixed String “NDZ” |
BM Unit ID | string |
| Ordered by this field first, incrementing |
Time | datetime | yyyymmddhh24miss | Ordered by this field second, incrementing |
Notice | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “NDB” |
BM Unit ID | string |
| Ordered by this field first, incrementing |
Time | datetime | yyyymmddhh24miss | Ordered by this field second, incrementing |
Notice | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “NDO” |
BM Unit ID | string |
| Ordered by this field first, incrementing |
Time | datetime | yyyymmddhh24miss | Ordered by this field second, incrementing |
Notice | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “MZT” |
BM Unit ID | string |
| Ordered by this field first, incrementing |
Time | datetime | yyyymmddhh24miss | Ordered by this field second, incrementing |
Period | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “MNZT” |
BM Unit ID | string |
| Ordered by this field first, incrementing |
Time | datetime | yyyymmddhh24miss | Ordered by this field second, incrementing |
Period | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “SEL” |
BM Unit ID | string |
| Ordered by this field first, incrementing |
Time | datetime | yyyymmddhh24miss | Ordered by this field second, incrementing |
Level | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “SIL” |
BM Unit ID | string |
| Ordered by this field first, incrementing |
Time | datetime | yyyymmddhh24miss | Ordered by this field second, incrementing |
Level | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “MDV” |
BM Unit ID | string |
| Ordered by this field first, incrementing |
Time | datetime | yyyymmddhh24miss | Ordered by this field second, incrementing |
Level | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “MDP” |
BM Unit ID | string |
| Ordered by this field first, incrementing |
Time | datetime | yyyymmddhh24miss | Ordered by this field second, incrementing |
Period | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed string “BID OFFER LEVEL DATA” |
|
|
|
|
Settlement Date | date | yyyymmdd |
|
Settlement Period | string |
| number between 1 and 50 or * if selecting a full day’s data |
Field | Type | Format | Comments |
---|---|---|---|
Record Type (BOD) | string |
| Fixed String “BOD” |
BM Unit ID | string |
| Group ordered firstly by this field, incrementing. |
Bid Offer Pair Number | number |
| Group ordered thirdly by this field, decrementing. |
From Time | datetime | yyyymmddhh24miss | Group ordered secondly by this field, incrementing. |
From Level | number |
|
|
To Time | datetime | yyyymmddhh24miss |
|
To Level | number |
|
|
Bid Price | number |
|
|
Offer Price | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed string “DERIVED DATA” |
|
|
|
|
Settlement Date | date | yyyymmdd |
|
Settlement Period | string |
| number between 1 and 50 or * if selecting a full day’s data |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “BAV” |
BM Unit ID | string |
| Ordered by this field first, incrementing |
Settlement Period | number |
| number between 1 and 50 |
Acceptance ID | number |
| Ordered by this field second, incrementing |
Short Acceptance Flag | SA |
| Flag indicating whether this acceptance was a “short” acceptance. |
RR Instruction Flag | Boolean |
|
|
Volume Accepted for Bid-Offer Pair -6 | number |
|
|
Volume Accepted for Bid-Offer Pair -5 | number |
|
|
Volume Accepted for Bid-Offer Pair -4 | number |
|
|
Volume Accepted for Bid-Offer Pair -3 | number |
|
|
Volume Accepted for Bid-Offer Pair -2 | number |
|
|
Volume Accepted for Bid-Offer Pair -1 | number |
|
|
Volume Accepted for Bid-Offer Pair 1 | number |
|
|
Volume Accepted for Bid-Offer Pair 2 | number |
|
|
Volume Accepted for Bid-Offer Pair 3 | number |
|
|
Volume Accepted for Bid-Offer Pair 4 | number |
|
|
Volume Accepted for Bid-Offer Pair 5 | number |
|
|
Volume Accepted for Bid-Offer Pair 6 | number |
|
|
Total | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “OAV” |
BM Unit ID | string |
| Ordered by this field first, incrementing |
Settlement Period | number |
| number between 1 and 50 |
Acceptance ID | number |
| Ordered by this field second, incrementing |
Short Acceptance Flag | SA |
| Flag indicating whether this acceptance was a “short” acceptance. |
RR Instruction Flag | Boolean |
|
|
Volume Accepted for Bid-Offer Pair -6 | number |
|
|
Volume Accepted for Bid-Offer Pair -5 | number |
|
|
Volume Accepted for Bid-Offer Pair -4 | number |
|
|
Volume Accepted for Bid-Offer Pair -3 | number |
|
|
Volume Accepted for Bid-Offer Pair -2 | number |
|
|
Volume Accepted for Bid-Offer Pair -1 | number |
|
|
Volume Accepted for Bid-Offer Pair 1 | number |
|
|
Volume Accepted for Bid-Offer Pair 2 | number |
|
|
Volume Accepted for Bid-Offer Pair 3 | number |
|
|
Volume Accepted for Bid-Offer Pair 4 | number |
|
|
Volume Accepted for Bid-Offer Pair 5 | number |
|
|
Volume Accepted for Bid-Offer Pair 6 | number |
|
|
Total | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “IPBAV” |
BM Unit ID | string |
| Ordered by this field first, incrementing |
Settlement Period | number |
| number between 1 and 50; ordered by this field second, incrementing |
Volume Accepted for Bid-Offer Pair -6 | number |
|
|
Volume Accepted for Bid-Offer Pair -5 | number |
|
|
Volume Accepted for Bid-Offer Pair -4 | number |
|
|
Volume Accepted for Bid-Offer Pair -3 | number |
|
|
Volume Accepted for Bid-Offer Pair -2 | number |
|
|
Volume Accepted for Bid-Offer Pair -1 | number |
|
|
Volume Accepted for Bid-Offer Pair 1 | number |
|
|
Volume Accepted for Bid-Offer Pair 2 | number |
|
|
Volume Accepted for Bid-Offer Pair 3 | number |
|
|
Volume Accepted for Bid-Offer Pair 4 | number |
|
|
Volume Accepted for Bid-Offer Pair 5 | number |
|
|
Volume Accepted for Bid-Offer Pair 6 | number |
|
|
Total | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “IPBAV” |
BM Unit ID | string |
| Ordered by this field first, incrementing |
Settlement Period | number |
| number between 1 and 50; ordered by this field second, incrementing |
Data Type | string |
| ‘O’ for Original ‘T’ for Tagged ‘R’ for Repriced ‘N’ for Originally-Priced (Not Repriced) |
RR Instruction Flag | Boolean |
|
|
Volume Accepted for Bid-Offer Pair -6 | number |
|
|
Volume Accepted for Bid-Offer Pair -5 | number |
|
|
Volume Accepted for Bid-Offer Pair -4 | number |
|
|
Volume Accepted for Bid-Offer Pair -3 | number |
|
|
Volume Accepted for Bid-Offer Pair -2 | number |
|
|
Volume Accepted for Bid-Offer Pair -1 | number |
|
|
Volume Accepted for Bid-Offer Pair 1 | number |
|
|
Volume Accepted for Bid-Offer Pair 2 | number |
|
|
Volume Accepted for Bid-Offer Pair 3 | number |
|
|
Volume Accepted for Bid-Offer Pair 4 | number |
|
|
Volume Accepted for Bid-Offer Pair 5 | number |
|
|
Volume Accepted for Bid-Offer Pair 6 | number |
|
|
Total | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “IPOAV” |
BM Unit ID | string |
| Ordered by this field first, incrementing |
Settlement Period | number |
| number between 1 and 50; ordered by this field second, incrementing |
Volume Accepted for Bid-Offer Pair -6 | number |
|
|
Volume Accepted for Bid-Offer Pair -5 | number |
|
|
Volume Accepted for Bid-Offer Pair -4 | number |
|
|
Volume Accepted for Bid-Offer Pair -3 | number |
|
|
Volume Accepted for Bid-Offer Pair -2 | number |
|
|
Volume Accepted for Bid-Offer Pair -1 | number |
|
|
Volume Accepted for Bid-Offer Pair 1 | number |
|
|
Volume Accepted for Bid-Offer Pair 2 | number |
|
|
Volume Accepted for Bid-Offer Pair 3 | number |
|
|
Volume Accepted for Bid-Offer Pair 4 | number |
|
|
Volume Accepted for Bid-Offer Pair 5 | number |
|
|
Volume Accepted for Bid-Offer Pair 6 | number |
|
|
Total | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “IPOAV” |
BM Unit ID | string |
| Ordered by this field first, incrementing |
Settlement Period | number |
| number between 1 and 50; ordered by this field second, incrementing |
Data Type | string |
| ‘O’ for Original ‘T’ for Tagged ‘R’ for Repriced ‘N’ for Originally-Priced (Not Repriced) |
RR Instruction Flag | Boolean |
|
|
Volume Accepted for Bid-Offer Pair -6 | number |
|
|
Volume Accepted for Bid-Offer Pair -5 | number |
|
|
Volume Accepted for Bid-Offer Pair -4 | number |
|
|
Volume Accepted for Bid-Offer Pair -3 | number |
|
|
Volume Accepted for Bid-Offer Pair -2 | number |
|
|
Volume Accepted for Bid-Offer Pair -1 | number |
|
|
Volume Accepted for Bid-Offer Pair 1 | number |
|
|
Volume Accepted for Bid-Offer Pair 2 | number |
|
|
Volume Accepted for Bid-Offer Pair 3 | number |
|
|
Volume Accepted for Bid-Offer Pair 4 | number |
|
|
Volume Accepted for Bid-Offer Pair 5 | number |
|
|
Volume Accepted for Bid-Offer Pair 6 | number |
|
|
Total | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “IPBC” |
BM Unit ID | string |
| Ordered by this field first, incrementing |
Settlement Period | number |
| number between 1 and 50; ordered by this field second, incrementing |
Cashflow for Bid-Offer Pair -6 | number |
|
|
Cashflow for Bid-Offer Pair -5 | number |
|
|
Cashflow for Bid-Offer Pair -4 | number |
|
|
Cashflow for Bid-Offer Pair -3 | number |
|
|
Cashflow for Bid-Offer Pair -2 | number |
|
|
Cashflow for Bid-Offer Pair -1 | number |
|
|
Cashflow for Bid-Offer Pair 1 | number |
|
|
Cashflow for Bid-Offer Pair 2 | number |
|
|
Cashflow for Bid-Offer Pair 3 | number |
|
|
Cashflow for Bid-Offer Pair 4 | number |
|
|
Cashflow for Bid-Offer Pair 5 | number |
|
|
Cashflow for Bid-Offer Pair 6 | number |
|
|
Total | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “IPOC” |
BM Unit ID | string |
| Ordered by this field first, incrementing |
Settlement Period | number |
| number between 1 and 50; ordered by this field second, incrementing |
Cashflow for Bid-Offer Pair -6 | number |
|
|
Cashflow for Bid-Offer Pair -5 | number |
|
|
Cashflow for Bid-Offer Pair -4 | number |
|
|
Cashflow for Bid-Offer Pair -3 | number |
|
|
Cashflow for Bid-Offer Pair -2 | number |
|
|
Cashflow for Bid-Offer Pair -1 | number |
|
|
Cashflow for Bid-Offer Pair 1 | number |
|
|
Cashflow for Bid-Offer Pair 2 | number |
|
|
Cashflow for Bid-Offer Pair 3 | number |
|
|
Cashflow for Bid-Offer Pair 4 | number |
|
|
Cashflow for Bid-Offer Pair 5 | number |
|
|
Cashflow for Bid-Offer Pair 6 | number |
|
|
Total | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed string “SYSTEM BUY SELL DATA” |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “SSB” |
Settlement Date | date | yyyymmdd | Group ordered by this field first, incrementing. |
Settlement Period | number |
| Group ordered by this field second, incrementing. |
System Sell Price | number |
|
|
System Buy Price | number |
|
|
BSAD Default | boolean |
| True if following BSAD data represents default values |
Price Derivation Code | string |
|
|
Indicative Net Imbalance Volume | number |
| The Indicative NIV |
Net Energy Sell Price Cost Adjustment | number |
| ESCA used in derivation of the main price |
Net Energy Sell Price Volume Adjustment | number |
| ESVA used in derivation of the main price |
Net System Sell Price Volume Adjustment | number |
| SSVA used in derivation of the main price |
Sell Price Price Adjustment | number |
| SPA used in derivation of the main price |
Net Energy Buy Price Cost Adjustment | number |
| EBCA used in derivation of the main price |
Net Energy Buy Price Volume Adjustment | number |
| EBVA used in derivation of the main price |
Net System Buy Price Volume Adjustment | number |
| SBVA used in derivation of the main price |
Buy Price Price Adjustment | number |
| BPA used in derivation of the main price |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “SSB” |
Settlement Date | date | yyyymmdd | Group ordered by this field first, incrementing. |
Settlement Period | number |
| Group ordered by this field second, incrementing. |
System Sell Price | number |
|
|
System Buy Price | number |
|
|
BSAD Default | boolean |
| True if following BSAD data represents default values |
Price Derivation Code | string |
|
|
Reserve Scarcity Price | number |
| £/MWh |
Replacement Price | number |
| £/ MWh |
Replacement Price Calculation Volume | number |
| MWh |
Indicative Net Imbalance Volume | number |
| The Indicative NIV |
Total System Accepted Offer Volume | number |
| MWh |
Total System Accepted Bid Volume | number |
| MWh |
Total System Tagged Accepted Offer Volume | number |
| MWh |
Total System Tagged Accepted Bid Volume | number |
| MWh |
System Total Priced Accepted Offer Volume | number |
| MWh |
System Total Priced Accepted Bid Volume | number |
| MWh |
Total System Adjustment Sell Volume | number |
| MWh |
Total System Adjustment Buy Volume | number |
| MWh |
Total System Tagged Adjustment Sell Volume | number |
| MWh |
Total System Tagged Adjustment Buy Volume | number |
| MWh |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed string “MARKET DEPTH DATA” |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “MDD” |
Settlement Date | date | yyyymmdd | Group ordered by this field first, incrementing. |
Settlement Period | number |
| Group ordered by this field second, incrementing. |
IMBALNGC | number |
|
|
Total Offer Volume | number |
|
|
Total Bid Volume | number |
|
|
Total Accepted Offer Volume | number |
|
|
Total Accepted Bid Volume | number |
|
|
Total Unpriced Accepted Offer Volume | number |
|
|
Total Unpriced Accepted Bid Volume | number |
|
|
Total Priced Accepted Offer Volume | number |
|
|
Total Priced Accepted Bid Volume | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed string “LATEST ACCEPTANCE DATA” |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “LAD” |
BM Unit Id | string |
|
|
Acceptance Number | number |
|
|
Acceptance Time | datetime | yyyymmddhh24miss | Group ordered by this field first, decrementing. |
From Time | datetime | yyyymmddhh24miss | Group ordered by this field second, incrementing. |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed string “ACCEPTANCE DATA” |
Settlement Date | date | yyyymmdd |
|
Settlement Period | string |
| number between 1 and 50 or * if selecting a full day’s data |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HAD” |
BM Unit Id | string |
|
|
Acceptance Number | number |
|
|
Acceptance Time | datetime | yyyymmddhh24miss | Group ordered by this field first, incrementing. |
Offer Price | number |
|
|
Bid Price | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | String |
| Fixed String “HDR” |
File Type | String |
| Fixed string “BALANCING SERVICES ADJUSTMENT DATA” |
Net Energy Buy Price Cost Adjustment (EBCA)
Net Energy Buy Price Volume Adjustment (EBVA)
Net System Buy Price Volume Adjustment (SBVA)
Net Energy Sell Price Cost Adjustment (ESCA)
Net Energy Sell Price Volume Adjustment (ESVA)
Net System Sell Price Volume Adjustment (SSVA)
Field | Type | Format | Comments |
Record Type | string |
| Fixed String “BSAD” |
Settlement Date | date | yyyymmdd | Group ordered by this field first, incrementing. |
Settlement Period | number |
| Group ordered by this field second, incrementing. |
Net Energy Sell Price Cost Adjustment | number |
| ESCA £ |
Net Energy Sell Price Volume Adjustment | number |
| ESVA MWh |
Net System Sell Price Volume Adjustment | number |
| SSVA MWh |
Sell Price Price Adjustment | number |
| SPA £/MWh |
Net Energy Buy Price Cost Adjustment | number |
| EBCA £ |
Net Energy Buy Price Volume Adjustment | number |
| EBVA MWh |
Net System Buy Price Volume Adjustment | number |
| SBVA MWh |
Buy Price Price Adjustment | number |
| BPA £/MWh |
Field | Type | Format | Comments |
Record Type | string |
| Fixed String “DISAG” |
Settlement Date | date | yyyymmdd | Group ordered by this field first, incrementing. |
Settlement Period | number |
| Group ordered by this field second, incrementing. |
Action Identifier | number |
|
|
SO-Flag | boolean | T or F | ‘T’ if potentially impacted by transmission constraints. |
Balancing Services Adjustment Action STOR Provider Flag | boolean | T or F | ‘T’ if related to a STOR Provider This field will be null if pre-P305 Settlement Date |
Action Cost | number |
| £ (can be NULL) |
Action Volume | number |
| MWh |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | String |
| Fixed String “HDR” |
File Type | String |
| Fixed string “MARKET INDEX DATA” |
Field | Type | Format | Comments |
Record Type | string |
| Fixed String “MID” |
Market Index Data Provider ID | string |
| Group ordered by this field first, incrementing. |
Settlement Date | date | yyyymmdd | Group ordered by this field second, incrementing. |
Settlement Period | number |
| Group ordered by this field third, incrementing. |
Market Index Price | number |
| £/MWh |
Market Index Volume | number |
| MWh |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed string “APPLICABLE BALANCING SERVICES VOLUME” |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “QAS” |
BM Unit ID | string |
|
|
Settlement Period | number |
| Group ordered by this field second, incrementing. |
BM Unit Applicable Balancing Services Volume | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed string “CREDIT DEFAULT NOTICE DATA” |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “CDN” |
Participant ID | string |
| Records ordered incrementing by this field |
Credit Default Level | number | 1 or 2 |
|
Entered Default Settlement Date | date | yyyymmdd |
|
Entered Default Settlement Period | number |
|
|
Cleared Default Settlement Date | date | yyyymmdd | May be NULL |
Cleared Default Settlement Period | number |
| May be NULL |
Cleared Default Text | string |
| May be NULL |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed string “TEMPERATURE DATA” |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “TEMP” |
Spot Time | datetime | yyyymmddhh24miss | Group ordered by this field first, incrementing. |
Temperature Out-Turn | number |
|
|
Normal Reference Temperature | number |
|
|
Low Reference Temperature | number |
|
|
High Reference Temperature | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed string “WIND GENERATION FORECAST AND OUTTURN DATA” |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “WIND” |
Settlement Date | date | yyyymmdd | Group ordered by this field first, incrementing. |
Settlement Period | number |
| Group ordered by this field second, incrementing. |
Publication Time (Initial Forecast) | datetime | yyyymmddhh24miss | Optional field |
Initial Forecast Generation (MW) | number |
| Optional field |
Publication Time (Latest Forecast) | datetime | yyyymmddhh24miss | Optional field |
Latest Forecast Generation (MW) | number |
| Optional field |
Publication Time (Outturn) | datetime | yyyymmddhh24miss |
|
Outturn Generation (MW) | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed string “INSTANTANEOUS GENERATION BY FUEL TYPE DATA” |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “FUELINST” |
Settlement Date | date | yyyymmdd | Group ordered by this field first, incrementing. |
Settlement Period | number |
| Group ordered by this field second, incrementing. |
Spot Time | datetime | yyyymmddhh24miss |
|
CCGT (MW) | number |
|
|
OIL (MW) | number |
|
|
COAL (MW) | number |
|
|
NUCLEAR (MW) | number |
|
|
WIND (MW) | number |
|
|
PS (MW) | number |
|
|
NPSHYD (MW) | number |
|
|
OCGT (MW) | number |
|
|
OTHER (MW) | number |
|
|
INTFR (MW) | number |
|
|
INTIRL (MW) | number |
|
|
INTNED (MW) | number |
|
|
INTEW (MW) | number |
|
|
BIOMASS (MW) | number |
|
|
INTNEM (MW) | number |
|
|
INTELEC (MW) | number |
|
|
INTIFA2 (MW) | number |
|
|
INTNSL (MW) | number |
|
|
INTVKL (MW) | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed string “HALF HOURLY OUTTURN GENERATION BY FUEL TYPE DATA” |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “FUELHH” |
Settlement Date | date | yyyymmdd | Group ordered by this field first, incrementing. |
Settlement Period | number |
| Group ordered by this field second, incrementing. |
CCGT (MW) | number |
|
|
OIL (MW) | number |
|
|
COAL (MW) | number |
|
|
NUCLEAR (MW) | number |
|
|
WIND (MW) | number |
|
|
PS (MW) | number |
|
|
NPSHYD (MW) | number |
|
|
OCGT (MW) | number |
|
|
OTHER (MW) | number |
|
|
INTFR (MW) | number |
|
|
INTIRL (MW) | number |
|
|
INTNED (MW) | number |
|
|
INTEW (MW) | number |
|
|
BIOMASS (MW) | number |
|
|
INTNEM (MW) | number |
|
|
INTELEC (MW) | number |
|
|
INTIFA2 (MW) | number |
|
|
INTNSL (MW) | number |
|
|
INTVKL (MW) | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed string “TRANSMISSION SYSTEM DEMAND DATA” |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “TSD” |
Spot Time | datetime | yyyymmddhh24miss |
|
Demand (MW) | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed string “HALF HOURLY INTERCONNECTOR OUTTURN GENERATION” |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “INTOUTHH” |
Settlement Date | date | yyyymmdd | Group ordered by this field first, incrementing. |
Settlement Period | number |
| Group ordered by this field second, incrementing. |
INTFR (MW) | number |
|
|
INTIRL (MW) | number |
|
|
INTNED (MW) | number |
|
|
INTEW (MW) | number |
|
|
INTNEM (MW) | number |
|
|
INTELEC (MW) | number |
|
|
INTIFA2 (MW) | number |
|
|
INTNSL (MW) | number |
|
|
INTVKL (MW) | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed string “DAILY ENERGY VOLUME DATA” |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “INDOD” |
Settlement Day | Date | yyyymmdd | Group ordered by this field first, incrementing. |
Daily Energy Volume Outturn | number |
|
|
Daily Energy Volume Normal Reference | number |
|
|
Daily Energy Volume Low Reference | number |
|
|
Daily Energy Volume High Reference | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed string “NON-BM STOR INSTRUCTED VOLUME DATA” |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “NONBM” |
Settlement Date | date | yyyymmdd | Group ordered by this field first, incrementing. |
Settlement Period | number |
| Group ordered by this field second, incrementing. |
Instructed Volume (MWh) | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed string “SYSTEM FREQUENCY DATA” |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “FREQ” |
Spot Time | datetime | yyyymmddhh24miss |
|
Frequency (Hz) | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | String |
| Fixed String “HDR” |
File Type | String |
| Fixed string “Indicative System Price Stack Data” |
Field | Type | Format | Comments |
Record Type | string |
| Fixed String “BID” |
Settlement Date | date | yyyymmdd | Group ordered by this field first, incrementing. |
Settlement Period | number |
| Group ordered by this field second, incrementing. |
Sequence Number | number |
| Group ordered by this field third, incrementing. |
Component Identifier | string |
| Acceptance BM Unit ID, RR identifier or BSAD NETSO allocated ID |
Acceptance Number | number |
|
|
Bid-Offer Pair Number | number |
|
|
CADL Flag | boolean | T or F | ‘T’ if Short Duration Acceptance |
SO-Flag | boolean | T or F | ‘T’ if potentially impacted by transmission constraints. |
STOR Provider Flag | Boolean | T or F | ‘T’ if System Action relates to a BOA accepted for a STOR Provider. This field will be null for pre-P305 dates |
Repriced Indicator | Boolean | T or F | ‘T’ if repriced item |
Bid-Offer Original Price | Number |
| £/MWh |
Reserve Scarcity Price | Number |
| £/MWh This will be null because STOR not accepted as a Bid This field will be null for pre-P305 dates |
Stack Item Original Price | number |
| £/MWh |
Stack Item Volume | number |
| MWh |
DMAT Adjusted Volume | number |
| MWh |
Arbitrage Adjusted Volume | number |
| MWh |
NIV Adjusted Volume | number |
| MWh |
PAR Adjusted Volume | number |
| MWh |
Stack Item Final Price | number |
| £/MWh |
Transmission Loss Multiplier | number |
|
|
TLM Adjusted Volume | number |
| MWh |
TLM Adjusted Cost | number |
| £ |
| Field | Type | Format | Comments | |
| Record Type | string |
| Fixed String “OFFER” | |
| Settlement Date | date | yyyymmdd | Group ordered by this field first, incrementing. | |
| Settlement Period | number |
| Group ordered by this field second, incrementing. | |
| Sequence Number | number |
| Group ordered by this field third, incrementing. | |
| Component Identifier | string |
| Acceptance BM Unit ID, RR identifier or BSAD NETSO allocated ID | |
| Acceptance Number | number |
|
| |
| Bid-Offer Pair Number | number |
|
| |
| CADL Flag | boolean | T or F | ‘T’ if Short Duration Acceptance | |
| SO-Flag | boolean | T or F | ‘T’ if potentially impacted by transmission constraints. | |
| STOR Provider Flag | boolean | T or F | ‘T’ if System Action relates to a BOA accepted for a STOR Provider This field will be null for pre-P305 dates | |
| Repriced Indicator | boolean | T or F | ‘T’ if repriced item | |
| Bid-Offer Original Price | number |
| £/MWh | |
| Reserve Scarcity Price | number |
| £/MWh This field will be null for pre-P305 dates | |
| Stack Item Original Price | number |
| £/MWh | |
| Stack Item Volume | number |
| MWh | |
| DMAT Adjusted Volume | number |
| MWh | |
| Arbitrage Adjusted Volume | number |
| MWh | |
| NIV Adjusted Volume | number |
| MWh | |
| PAR Adjusted Volume | number |
| MWh | |
Stack Item Final Price | number |
| £/MWh |
| |
| Transmission Loss Multiplier | number |
|
| |
| TLM Adjusted Volume | number |
| MWh | |
| TLM Adjusted Cost | number |
| £ |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed String “SO-SO PRICES” |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “SOSO” |
Trade Type | string |
| A code identifying the type of trade being made |
Start Time | datetime | yyyymmddhhmmss | The start date and time for which a Trade Price applies |
Trade Direction | string | A01, A02 | The direction of the trade |
Contract Identification | string |
| A unique identifier for an offered trade |
Trade Quantity | number | MW | The quantity of an offered trade in MW |
Trade Price | number | Currency/MWh | The price of the trade in units of currency per MWh |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | String |
| Fixed String “HDR” |
File Type | String |
| Fixed String “DCONTROL” |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | String |
| Fixed String “DEMCI” |
Demand Control ID | String |
| The unique identifier for a demand control instruction |
Affected DSO | String |
|
|
Instruction Sequence | Number |
|
|
Demand Control Event Flag | Boolean | ‘I’ or ‘L’ | A value of ‘I’ indicates an instruction initiated by the NETSO or an Emergency Manual Disconnection. A Value of ‘L’ indicates an Automatic Low Frequency Demand Disconnection |
Time From | datetime | yyyymmddhh24miss |
|
Time To | datetime | yyyymmddhh24miss |
|
Demand Control Level | Number |
|
|
SO-Flag | Boolean | ‘T’ or ‘F’ |
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed String “LOLP” |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | String |
| Fixed String “HDR” |
File Type | String |
| Fixed String “STORAW DATA” |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | String |
| Fixed String “STORAW” |
Season Year | Date | yyyy |
|
Season Number | Number |
|
|
STOR Availability From Date | Datetime | yyyymmddhh24mm |
|
STOR Availability To Date | Date | yyyymmddhh24miss |
|
Weekday Start Time | time | hhmm |
|
Weekday End Time | time | hhmm |
|
Non-weekday Start Time | time | hhmm |
|
Non-weekday End Time | time | hhmm |
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed String “GBP EUR Settlement Exchange Rate” |
Field | Type | Format | Comments |
---|---|---|---|
Settlement Day | date |
|
|
Exchange Rate | number |
|
|
Datetime Received | datetime |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed String “Reserve Bid Data” |
Field | Type | Format | Comments |
---|---|---|---|
BM Unit Id | string |
|
|
BM Unit Type | string |
|
|
NGC BM Unit Name | string |
|
|
Participant Id | string |
|
|
Time Series Id | string |
|
|
Settlement Date | Date |
|
|
Settlement Period | number |
|
|
RR Quarter Hour Period | number |
|
|
RR Associated TSO | string |
|
|
RR Market Balance Area | string |
|
|
RR Divisible | string |
|
|
RR Linking Bid Id | string |
|
|
RR Multipart Bid Id | string |
|
|
RR Exclusive Bid Id | string |
|
|
RR Flow Direction | string |
|
|
RR Minimum Quantity | number |
|
|
RR Maximum Quantity | number |
|
|
RR Bid Resolution | string |
|
|
RR Position | number |
|
|
RR Price (£/MWh) | number |
|
|
RR Status | string |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed String “RRAGGINFO” |
Auction Period Start | Datetime |
|
|
Auction Period End | Datetime |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “RRAGGINFO” |
Total volume of offered bids | number |
|
|
Total of activated TERRE bids | number |
|
|
Total of unavailable bids | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed String “RRRESULTS DATA” |
Settlement Date | Date |
|
|
Settlement Period | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “ACTIVATION” |
Participant Id | string |
|
|
BM Unit Id | string |
|
|
Settlement Date | Date |
|
|
Settlement Period | number |
|
|
RR Quarter Hour Period | number |
|
|
Type | string | B74 |
|
RR Flow Direction | string |
|
|
Activated Quantity (MW) | number |
|
|
Activation Price (£/MWh) | number |
|
|
Marketobjectstatus | String |
| Available, Ordered or Cancelled |
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “GBNM” |
Settlement Date | Date |
|
|
Settlement Period | number |
|
|
RR Quarter Hour Period | number |
|
|
Type | string | B75 |
|
RR Flow Direction | string |
|
|
Activated Quantity (MW) | number |
|
|
Activation Price (£/MWh) | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “INTERCONN” |
Interconnector Id | string |
|
|
Settlement Date | Date |
|
|
Settlement Period | number |
|
|
RR Quarter Hour Period | number |
|
|
Type | string | A05 or B09 |
|
RR Flow Direction | string |
|
|
Activated Quantity (MW) | number |
|
|
Activation Price (£/MWh) | number |
|
|
Field | Type | Format | Comments |
---|---|---|---|
Record Type | string |
| Fixed String “HDR” |
File Type | string |
| Fixed String “ICCR” |
Version | Date | Author | Reason |
Version 0.1 | 12 November 2014 | Zaahir Ghanty | First Draft for peer review |
Version 0.2 | 12 December 2014 | Stephen J. Thompson | Brought into alignment with 0.6 of the API specification |
Version 0.3 | 12 December 2014 | Zaahir Ghanty | Update following review |
Version 0.4 | 28 April 2015 | Zaahir Ghanty/Stephen J. Thompson | Update to include REST API for Phase 2 & Data Push Service |
Version 0.5 | 18 May 2015 | Zaahir Ghanty | Update following user feedback |
Version 0.6 | 14 July 2015 | Stephen J. Thompson | Update of API request method from POST to GET |
Version 0.7 | 24 July 2015 | Zaahir Ghanty/Stephen J. Thompson | Update of API URLs and Java examples for Data Push |
Version 0.8 | 31 August 2015 | Stephen J. Thompson | Updated the RESTful examples to use the GET verb. Added a checklist for users |
Version 0.9 | 22 January 2016 | Zaahir Ghanty | Updated to include REST API for Phase 3 and P305 Data |
Version 0.10 | 22 April 2016 | Zaahir Ghanty | Updated following user feedback Added message types for Data Push Service |
Version 0.11 | 14 July 2016 | Zaahir Ghanty | Housekeeping updates |
Version 0.12 | 17 October 2016 | Zaahir Ghanty | Housekeeping updates & Python working example for Data Push |
Version 1.0 | 23 June 2017 | Zaahir Ghanty | Updates for June 2017 BSC System release (BSC Modifications P3211 and P3292) |
Version 1.1 | 30 October 2017 | Zaahir Ghanty | Updates for November 2017 BSC System Release (BSC Modification P3363) Inclusion of BIOMASS in API responses for FUELINSTHHCUR, FUELINST, FUELHH, FOU2T14D, UOU2T14D, FOU2T52W, UOU2T52W. No changes to API URIs |
Version 2.0 | 11 November 2018 | Stephen Francis | Updates for November 2018 BSC Systems Release (CP15034 and CP15065) |
Version 2.1 | 5 July 2019 | Stephen Francis | Updated B1610 API to Version 2 for improved reporting |
Version 2.2 | 31 July 2019 | Stephen Francis | Housekeeping updates |
Version 3.0 | 18 December 2019 | Stephen Francis | Updates for November 2019 BSC Systems Release (P344 TERRE and CP1517) |
Version 3.1 | 1 July 2020 | Stephen Francis | Updated B1610 API request details table to reference the optional NGC BM Unit ID; no functional change to the API |
Version 4.0 | 3 December 2020 | Stephen Francis | Updates for December 2020 BSC Systems Release for CP1535 |
Version 5.0 | 18 March 2021 | Stephen Francis | Updates for February 2021 Standalone BSC Systems Release for P408 Self-Governance |
Version 6.0 | 24 February 2022 | Ivar Macsween | Updates for February 2022 Standard BSC Release for CP1548 |
Version 6.1 | 2 November 2023 | Mark De Souza-Wilson | Updates for November 2023 Standard BSC Release for Cxxxx |
1 Publication of Trading Unit Delivery Mode
2 Changes to REMIT inside information reporting
3 Fuel types on the BMRS
4 Changes to European Transparency Regulation Data
5 New Interconnector fuel type