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 |