Advanced Search

BMRS API and Data Push Guide

v 7.0
Download

BMRS API and Data Push

Guidance Note

1. Introduction

1.1 The BMRS

The Balancing Mechanism Reporting Service (BMRS) is the primary channel for providing operational data relating to the GB Electricity Balancing and Settlement arrangements. It’s used extensively by market participants to help make trading decisions and understanding market dynamics, and acts as a prompt reporting platform as well as a means of accessing historic data. The BMRS has a wider user base both within and outside of the energy industry and includes traders, regulators, industry forecasting teams and academics.

The BMRS initially lacked useable web services and unless participants subscribed to the TIBCO service at additional cost, there were no practical means for machine-to-machine data retrieval. As a result, many market participants resorted to custom scripting to access data from the website, which had a negative impact on its overall performance.

Since September 2016, users are able to retrieve all the BMRS Data programmatically via:

    • 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.

complex image of processApplication programming Interfaces (API), in context of BMRS, is a set of programming instructions for participants to access BMRS data directly from their systems outside of the firewall

TIBCO is a third party software and provides the mechanism for automated publication of BMRS data to market participants via a dedicated line.

Scripting (sometimes referred to as scraping data from the website) is the process by which users run automated programs which simulate interactive access by searching for and downloading data from displayed web pages at a set frequency, sometimes several times a minute. Heavy scripting drastically slows the website which may lead to interactive customers experiencing timeout issues, resulting in the website becoming unusable.

1.2 Purpose and Scope

1.2.1 What is covered in this document?

This document is intended to provide guidance for users into how to use the API and include:

    • 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

1.2.2 Are there any prerequisites?

To use this document, an understanding of software development, web services and the BMRS user interface and its data is required. By using the API, users agree to the BMRS Data Terms of Use Policy.

1.2.3 Can I access the data from the API by putting the URL in the web browser?

Yes – In this version of the API you can retrieve information using a web browser.

1.2.4 What do I need to access the Data Push Service?

Further details on the Data Push Service are available in Section 6 and a general checklist is included in Section 9.

1.2.5 I am having difficulties interpreting some of the field types for the Data Push Service; where are they defined?

Section 8.5 provides definition of the message types and field types. The Data Push Service data content is based on the TIBCO Service and for further guidance on the data items and field types please refer to the NETA Interface Definition and Design (IDD): Part 1.

1.2.6 What support does Elexon provide for the API and Data Push Service?

Elexon ensures that the API guidance document is updated and that the API and Data Push Service are functional.

Elexon has no obligation to provide further support beyond providing the API key, registration and access. Any technical assistance as a result of the API integration within your business processes will be your responsibility. To help users, Elexon has provided sample codes for the API/Data Push in the Appendices of this document (Section 10 & Section 11) and will not provide support or additional codes for the API/Data Push.

1.3 Getting Started

In summary, there are four steps required in using the API:

    1. Register on the ELEXON Portal

    2. Retrieve API Key

    3. Use API Key to gain access to the API URL

    4. Retrieve results from the API

These steps are detailed in the following sections of this document.

complex image of process

Figure 1: Steps to use API

FOR ANY QUERIES PLEASE CONTACT THE BSC SERVICE DESK: BSCSERVICEDESK@CGI.COM

Registration Process

2 Elexon Portal Registration Process

2.1 Accessing Elexon Portal

The web address for the accessing the portal is https://www.elexonportal.co.uk/. You can also access this by clicking on the “Elexon Portal” button at the top of the BMRS or Elexon websites.

Once the page has loaded use your log in credentials to access the page or register as shown below.

Log in

OR

Register

Figure 2: Accessing the Elexon Portal

complex image of process2.2 Registration

Follow the instructions on the screen to register.

Figure 3: Portal registration screen

Once you have entered all the details, you will be asked to activate the account. A link and an activation code will be sent to the email address you used during the registration process.

3 The API Key

The API key has three primary functions:

    • Identify the program calling the API;

    • Serves as authentication code; and

    • Monitor and control usage for overall service protection.

Once you have registered, you will have access to a range of content available on the ELEXON Portal. To get your API Key, click on ‘my profile’ below and you will find the API key under scripting key.

Note: The key shown below is for illustration purposes and is not a valid key.

complex image of process

Figure 4: Retrieving API Key

Note: The API Key will also serve as authentication for the Data Push Service

Accessing the API

4 Data available through APIs

This section of the document details the API design to enable the user to retrieve data from BMRS. In particular highlights the following:

    • API Uniform Resource Identifier (URI)

    • The search parameters which will be passed as input parameters in the API URIs

    • Expected format for returned results

4.1 API Design and Key Features

A sample URI is shown below.

complex image of process

Figure 5: API URL example

    • 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).

For the API, you will use the following:

    • HOST: https://api.bmreports.com

    • 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 Desk Support: bscservicedesk@cgi.com

5 BMRS API Details

5.1 Transparency Data and REMIT

5.1.1 B1720 – Amount of Balancing Reserves Under Contract

API service details for the flow B1720 is as follows

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 and Response format details:

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

5.1.2 B1730 – Prices Of Procured Balancing Reserves

API service details for the flow B1730 is as follows

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 and Response format details:

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

5.1.3 B1740 – Accepted Aggregated Offers

API service details for the flow B1740 is as follows

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 and Response format details:

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

5.1.4 B1750 – Activated Balancing Energy

API service details for the flow B1750 is as follows

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 and Response format details:

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

5.1.5 B1760 – Prices Of Activated Balancing Energy

API service details for the flow B1760 is as follows

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 and Response format details:

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

5.1.6 B1770 – Imbalance Prices

API service details for the flow B1770 is as follows

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 and Response format details:

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

5.1.7 B1780 – Aggregated Imbalance Volumes

API service details for the flow B1780 is as follows

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 and Response format details:

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

5.1.8 B1790 – Financial Expenses and Income For Balancing

API service details for the flow B1790 is as follows

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 and Response format details:

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

5.1.9 B1810 – CrossBorder Balancing Volumes of Exchanged Bids and Offers

API service details for the flow B1810 is as follows

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 and Response format details:

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

5.1.10 B1820 – CrossBorder Balancing Prices

API service details for the flow B01820 is as follows

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 and Response format details:

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

5.1.11 B1830 – Crossborder Balancing Energy Activated

API service details for the flow B01830 is as follows

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 and Response format details:

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

5.1.12 B0610 – Actual Total Load per Bidding Zone

API service details for the flow B0610 is as follows

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 and Response format details:

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

5.1.13 B0620 – Day-Ahead Total Load Forecast per Bidding Zone

API service details for the flow B0620 is as follows

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 and Response format details:

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

5.1.14 B0630 – Week-Ahead Total Load Forecast per Bidding Zone

API service details for the flow B0630 is as follows

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 and Response format details:

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

5.1.15 B0640 – Month-Ahead Total Load Forecast Per Bidding Zone

API service details for the flow B0640 is as follows

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 and Response format details:

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 and Response format details:

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

5.1.16 B0650 – Year Ahead Total Load Forecast per Bidding Zone

API service details for the flow B0650 is as follows

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 and Response format details:

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

5.1.17 B0810 – Year Ahead Forecast Margin

API service details for the flow B0810 is as follows

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 and Response format details:

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

5.1.18 B1410 – Installed Generation Capacity Aggregated

API service details for the flow B1410 is as follows

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 and Response format details:

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

5.1.19 B1420 – Installed Generation Capacity per Unit

API service details for the flow B1420 is as follows

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 and Response format details:

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

5.1.20 B1430 – Day-Ahead Aggregated Generation

API service details for the flow B1430 is as follows

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 and Response format details:

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

5.1.21 B1440 –Generation forecasts for Wind and Solar

API service details for the flow B1440 is as follows

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 and Response format details:

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

5.1.22 B1610 – Actual Generation Output per Generation Unit

API service details for the flow B1610 is as follows

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 and Response format details:

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

5.1.23 B1620 – Actual Aggregated Generation perType

API service details for the flow B1620 is as follows

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 and Response format details:

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

5.1.24 B1630 – Actual Or Estimated Wind and Solar Power Generation

API service details for the flow B1630 is as follows

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 and Response format details:

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

5.1.25 B0910 – Expansion and Dismantling Projects

API service details for the flow B0910 is as follows

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 and Response format details:

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

5.1.26 B1320 – Congestion Management Measures Countertrading

API service details for the flow B1320 is as follows

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 and Response format details:

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

5.1.27 B1330 – Congestion Management Measures Costs of Congestion Management

API service details for the flow B1330 is as follows

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 and Response format details:

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

5.1.28 B0710 – Planned Unavailability of Consumption Units

API service details for the flow B0710 is as follows

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 and Response format details:

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

5.1.29 B0720 – Changes In Actual Availability Of Consumption Units

API service details for the flow B0720 is as follows

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 and Response format details:

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

5.1.30 B1010 – Planned Unavailability In The Transmission Grid

API service details for the flow B1010 is as follows

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 and Response format details:

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

5.1.31 B1020 – Changes In Actual Availability In The Transmission Grid

API service details for the flow B1020 is as follows

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 and Response format details:

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

5.1.32 B1030 – Changes In Actual Availability of Offshore Grid Infrastructure

API service details for the flow B1030 is as follows

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 and Response format details:

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

5.1.33 B1510 – Planned Unavailability of Generation Units

API service details for the flow B1510 is as follows

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 and Response format details:

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

5.1.34 B1520 – Changes In Actual Availability of Generation Units

API service details for the flow B1520 is as follows

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 and Response format details:

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

5.1.35 B1530 – Planned Unavailability of Production Units

API service details for the flow B1530 is as follows

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 and Response format details:

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

5.1.36 B1540 – Changes In Actual Availability of Production Units

API service details for the flow B1540 is as follows

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 and Response format details:

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

5.1.37 REMIT Flow – Message List Retrieval

API service details for REMIT Message List Retrieval is as follows

Service Name

MessageListRetrievalService

Method

GET

Input URL

  1. Event Start & End

https://api.bmreports.com/BMRS/MessageListRetrieval/v1?APIKey=<APIKey>&EventStart=<EventStart>&EventEnd=<EventEnd>&ServiceType=<xml/XML/csv/CSV>

  1. Publication Time

https://api.bmreports.com/BMRS/MessageListRetrieval/v1?APIKey=<APIKey>&PublicationFrom=<PublicationFrom>&PublicationTo=<PublicationTo>&ServiceType=<xml/XML/csv/CSV>

  1. Publication Time with Advanced Filter

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>

  1. Event Start with Active Flag

https://api.bmreports.com/BMRS/MessageListRetrieval/v1?APIKey=<APIKey>&EventStart=<EventStart>&EventEnd=<EventEnd>&ServiceType=<xml/XML/csv/CSV>&ActiveFlag=<ActiveFlag>

  1. Event Start with Advanced Filter

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

  1. All active records are fetched on the basis of mandatory parameters EventStart and EventEnd or PublicationFrom and PublicationTo along with the optional parameters (AffectedUnitID, ParticipantId, MessageID, FuelType, EventType,AssetId) for which AND condition will be applied.

  2. ParticipantId is fetched based on complete or Partial value given in request.(Ex: %name%)

  3. “Events In Progress” will be fetched based on the following conditions:

    • Event Start DateTime is in between “From DateTime” and “To DateTime” OR

    • Event End DateTime is in between “From DateTime” and “To DateTime” OR

    • Event Start DateTime is Before “From DateTime” AND Event End Date time is After “To DateTime”)

API Web service – Request and Response format details:

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

* applicable only for Elexon portal

Note: Either Publication details(PublicationFrom and PublicationTo) or Event details (EvenStart and EventEnd) should be given in request. If both are not present in request proper message with HTTP code will be sent back as response.

5.1.38 REMIT Flow – Message Detail Retrieval

API service details for REMIT Message Detail Retrieval is as follows

Service Name

MessageDetailRetrievalService

Method

GET

Input URL

  1. Message id, Sequence id, Participant id mentioned

https://api.bmreports.com/BMRS/MessageDetailRetrieval/v1?APIKey=<APIKey>&MessageId=<MessageId>&ParticipantId=<ParticipantID>&SequenceId=<SequenceId>&ServiceType=<xml/XML/csv/CSV>

  1. Message id and Participant id mentioned

https://api.bmreports.com/BMRS/MessageDetailRetrieval/v1?APIKey=<APIKey>&MessageId=<MessageId>&ParticipantId=<ParticipantID>&ServiceType=<xml/XML/csv/CSV>

  1. Message id, Participant id mentioned and Active Flag

https://api.bmreports.com/BMRS/MessageDetailRetrieval/v1?APIKey=<APIKey>&MessageId=<MessageId>&ParticipantId=<ParticipantID>&ServiceType=<xml/XML/csv/CSV>&ActiveFlag=<ActiveFlag>

Output Format

XML

API Web service – Request and Response format details:

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

5.2 Legacy BMRS Data

5.2.1 Temperature Data

API service details for the flow is as follows

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 Web service – Request and Response format details:

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

CSV Download service

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

NOTE:

    • 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.

Example File:

HDR,TEMPERATURE DATA

TEMP,20081011,18.3,17.2,12.3,22.4

FTR,1

5.2.2 Bid Offer Level Data

API service details for the flow is as follows

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

  1. Default Sorting: BM Unit Id (Ascending), BM Offer Pair Number (Descending), From Time (Ascending)

  2. Input data flow : BOD

For other common description refer section 3.2

Comments

  1. Default Value (if none specified): Settlement Date = {as per NRT condition}, Settlement Period = {as per NRT condition},BM Unit Id = *, BM Unit Type = *, Lead Party Name = *, NGC BM Unit Name = *, (* implies all values)

  2. NRT condition: Settlement Date and Settlement Period corresponding to current SP + 2

API Web service – Request and Response format details:

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

Example File:

HDR,BID OFFER LEVEL DATA,20001016,*

BOD,T_GENSET176, 20001016,1,-2,20001016173000,-10.000,20001016180000,-10.000,10.00000,15.00000

BOD,T_GENSET176, 20001016,2,-1,20001016173000,-10.000,20001016180000,-10.000,20.00000,25.00000

BOD,T_GENSET176, 20001016,3,1,20001016173000,10.000,20001016180000,10.000,30.00000,35.00000

BOD,T_GENSET176, 20001016,4,2,20001016173000,10.000,20001016180000,10.000,40.00000,45.00000

BOD,T_GENSET176, 20001016,5,3,20001016173000,10.000,20001016180000,10.000,50.00000,55.00000

FTR,5

5.2.3 Credit Default Notice Data

API service details for the flow is as follows

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

  1. Default Sorting: Participant ID (ascending),

  2. Entries with a null Cleared Date and Cleared Period (ie. Parties that are still in default) are displayed above entries with non-null Cleared Date and Cleared Period.

  3. Input data flow : CDN

Comments

  1. Default Value (if none specified): From Cleared Date = Current System Date (i.e. Today) – 30 (configurable) To Cleared Date = NULL

API Web service – Request and Response format details:

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. -

1

Entered Default Settlement Date

Date

-

No

        1. yyyymmdd

20030224

Energy Default Settlement Period

Integer

-

No

        1. -

2

Cleared Default Settlement Date

Date

-

No

        1. yyyymmdd

20030224

Cleared Default Settlement Period

Integer

-

No

-

21

Cleared Default Text

String

-

No

-

Credit Cover Percentage <= 75% of credit limit(level default)

NOTE:

    • 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.

Example File:

HDR,CREDIT DEFAULT NOTICE DATA

CDN,MANW,2,20130714,4,20141212,41,Credit Cover Percentage <= 90% of Credit Limit (Level 2 Default)

CDN,MANW,2,20130714,4,20141123,41,Credit Cover Percentage <= 90% of Credit Limit (Level 2 Default)

CDN,MANW,2,20130714,4,20141124,41,Credit Cover Percentage <= 90% of Credit Limit (Level 2 Default)

FTR,3

5.2.4 System Warnings

API service details for the flow is as follows

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

  1. Default Sorting: Warning Date/Time (Ascending)

  2. Input data flow : System Messages

Comments

Default Value (if none specified): From Date= Current System Date – 1 (configurable)

To Date= Current System Date

API Web service – Request and Response format details:

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

NOTE:

    • 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.

Example File:

HDR,SYSTEM WARNINGS

SYSWARN,20141222130000,From : Power System Manager - National Grid Electricity Control Centre

NOTIFICATION CANCELLATION of GB TRANSMISSION SYSTEM WARNING

The GB Transmission System Warning NOTIFICATION OF INADEQUATE SYSTEM MARGIN issued for the period from 09:00 hrs to 23:30 hrs on Wednesday 20/12/2014 has been cancelled

The following GB Transmission System Warnings remain in force

none

Notification Issued at 13:15 hrs on 20/12/2014

Issued by John Hughes National Grid Electricity Control Centre

25753732 CANC 20/12/14 20/12/14 20/12/14

FTR,1

5.2.5 Balancing Services Adjustment Action Data

API service details for the flow is as follows

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

  1. Default Sorting: Settlement Date (Ascending), Settlement Period (Ascending)

  2. Input data flow : DISBSAD

Comments

  1. Default Value : Settlement Date= Current System Date (i.e. Today), Settlement Period = *.

API Web service – Request and Response format details:

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

Example File:

HDR,BALANCING SERVICES ADJUSTMENT DATA

DISAG,20140906,1,1001,T,0.0,28.0

DISAG,20140906,1,1002,F,0.0,10.0

FTR,2

5.2.6 Balancing Service Adjustment Data

API service details for the flow is as follows

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

  1. Default Sorting: Settlement Date (Ascending), Settlement Period (Ascending)

  2. Input data flow : NETBSAD

For other common description refer section 3.2

Comments

  1. Default Value (if none specified

Settlement Date= Current System Date (i.e. Today), Settlement Period = *, isTwoDayWindow=false

API Web service – Request and Response format details:

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

NOTE:

    • 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.

Example File:

HDR,BALANCING SERVICES ADJUSTMENT DATA

BSAD,20140418,1,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0

BSAD,20140418,2,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0

BSAD,20140418,3,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0

FTR,3

5.2.7 Rolling System Frequency

API service details for the flow is as follows

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

  1. Default Sorting: Date (Ascending), SpotTime (Ascending)

  2. Input data flow : FREQ

Comments

  1. Default Value (if none specified): From DateTime = Current System DateTime – 48 Hr (configurable) To DateTime = Current System DateTime

API Web service – Request and Response format details:

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

NOTE:

    • 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.

Example File:

HDR, SYSTEM FREQUENCY DATA

FREQ,20080428170500,49.101

FREQ,20080428171000,49.393

FREQ,20080428171500,49.573

FREQ,20080428172000,49.032

FREQ,20080428172500,49.432

FTR,5

5.2.8 Market Index Data

API service details for the flow is as follows

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

  1. Default Sorting: Data Provider (Alphabetic Ascending), Settlement Date (Ascending) ,Settlement Period (Ascending)

  2. Input data flow : MID

Comments

  1. Default Value (if none specified): From Settlement Date= Current System Date – 1 (i.e. Yesterday), To Settlement Date= Current System Date (i.e. Today) ,Settlement Period = *

  2. Data available only for Settlement Periods before the Current Settlement Period.

API Web service – Request and Response format details:

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

NOTE:

    • 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.

Example File:

HDR,MARKET INDEX DATA

MID,NNCUK,20001018,33,10.000,40.000

MID,NNCUK,20001018,36,20.000,50.000

MID,NNCUK,20001018,37,10.000,30.000

FTR,3

5.2.9 Daily energy Volume Data

API service details for the flow is as follows

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

  1. Default Sorting: Settlement Day (Ascending)

  2. Input data flow : INDOD

Comments

  1. Default Value (if none specified): From Date= Current System date-90 days To Date= Current System Date

API Web service – Request and Response format details:

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

NOTE:

    • 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.

Example File:

HDR,DAILY ENERGY VOLUME DATA

INDOD,20081016,43323,40121,38124,47634

FTR,1

5.2.10 Non BM STOR Instructed Volume Data

API service details for the flow is as follows

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

  1. Default Sorting: Settlement Date(Ascending), Settlement Period (Ascending)

  2. Input data flow : NONBM

Comments

  1. Default Value (if none specified): From Date = Current System Date – 1, To Date = Current System Date

API Web service – Request and Response format details:

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

API Webservice – Response - Non - BM Stor Instructed Volumes

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

NOTE:

    • 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.

Example File:

HDR,NON-BM STOR INSTRUCTED VOLUME DATA

NONBM,20141109,1,N,20141109003000,12345

NONBM,20141109,2,N,20141109010000,12345

NONBM,20141109,3,N,20141109013000,12345

FTR,3

5.2.11 Applicable Balancing Services Volume Data

API service details for the flow is as follows

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

  1. Default Sorting: Settlement Period (Ascending)

  2. Input data flow : QAS

For other common description refer section 3.2

Comments

  1. Default Value (if none specified): Settlement Date = Current Date-1, Settlement Period = *, One of BM Unit ID / NGC BM Unit ID is mandatory. (* implies all values)

API Web service – Request and Response format details:

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

NOTE: At least one of BM Unit ID or NGC BM Unit Name is mandatory

API Webservice – Response - Applicable Balancing Services Volume

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

-

-

Example File:

HDR,APPLICABLE BALANCING SERVICES VOLUME,20001016,1

QAS,T_GENERATE,1,38889.000

QAS,E_EMBED,1,39066.000

FTR,2

5.2.12 Rolling System Demand

API service details for the flow is as follows

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

  1. Default Sorting: Date (Ascending),Time (Ascending)

  2. Input data flow : FUELINST

Comments

Default Value (if none specified): From Date = Current Date – 2 days, To Date = Current Date

API Web service – Request and Response format details:

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

NOTE:

    • 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

Example File:

HDR,SYSTEM DEMAND DATA

VD,20141102055500,22500

VD,20141102055500,22671

VD,20141102055500,22944

FTR,3

5.2.13 Peak Wind Generation Forecast

API service details for the flow is as follows

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

  1. Default Sorting: Date (Ascending)

  2. Input data flow : WINDFOR

Comments

  1. Default Value (if non specified): From Date = Current System Date (i.e. Today) To Date = Current System Date + 1 (i.e Tomorrow)

API Web service – Request and Response format details:

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

NOTE:

    • 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.

Example File:

HDR, PEAK WIND GENERATION FORECAST

WINDFORPK,20140726,2100,697,1333,201407260430

FTR,1

5.2.14 Wind Generation Forecast and Out-turn Data

API service details for the flow is as follows

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

  1. Default Sorting: Date (Ascending), Settlement Period (Ascending)

  2. Input data flow : WINDFOR, FUELHH

Comments

  1. If data for a column not available for a row, it is displayed as “NULL”

  2. Default Value (if none specified): From Date = Current System Date - 1 , To Date = Current System Date +1

API Web service – Request and Response format details:

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

-

-

NOTE:

    • 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.

Example File:

HDR,WIND GENERATION FORECAST AND OUTTURN DATA

WIND,20080429,1,20080427170000,1001,20080428170000,1011,20080429003500,1221

WIND,20080429,11,20080427170000,1147,20080428170000,1157,20080429053500,1221

WIND,20080429,17,20080427170000,1205,20080428170000,1200,20080429083500,1221

FTR,3

5.2.15 Generation by Fuel Type (Current)

[1831-B]API service details for the flow is as follows:

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

  1. Default Sorting: GB Generating Plant (Ascending)

  2. Input data flow : FUELINST , FUELHH

Comments

  1. If no value is specified for fuel type then it will imply all Fuel Types

  2. Any value from “Fuel Type Set” (Ref: IDD Valid Sets)

  3. All negative values are capped to zero.

  4. INT which implies interconnectors (INTFR, INTIRL, INTNED, INTEW, INTNEM, INTELEC, INTIFA2, INTNSL, INTVKL)

API Web service – Request and Response format details:

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

        1. -

100

Last Half Hour

Date

-

No

        1. yyyy-mm-dd hh:mm:ss

2014-07-29 13:00:00

Last Half Hour MW

Integer

-

No

        1. -

12522

Last Half Hour %age

Double

-

No

        1. -

39.3

Last Half Hour Total MW

Integer

-

No

-

31825

Last Half Hour Total %

Double

-

No

        1. -

100

Last 24 Hours

Date

-

No

        1. yyyy-mm-dd hh:mm:ss

2014-07-29 13:00:00

Last 24 Hours MW

Integer

-

No

        1. -

273320

Last 24 Hours %age

Double

-

No

        1. -

37.3

Last 24 Hours Total MW

Integer

-

No

        1. -

733475

Last 24 Hours Total %

Double

-

No

        1. -

100

Data Last Updated

Date

-

No

        1. yyyy-mm-dd hh:mm:ss

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

        1. yyyymmddhhmmss

20140729130000

Last Half Hour MW

Integer

-

No

        1. -

12522

Last Half Hour %age

Decimal

-

No

        1. -

39.3

Last Half Hour Total MW

Integer

-

No

        1. -

31825

Last Half Hour Total %

Decimal

-

No

        1. -

100

Last 24 Hours

Date

-

No

        1. yyyymmddhhmmss

20140729130000

Last 24 Hours MW

Integer

-

No

        1. -

273320

Last 24 Hours %age

Decimal

-

No

        1. -

37.3

Last 24 Hours Total MW

Integer

-

No

        1. -

733475

Last 24 Hours Total %

Decimal

-

No

        1. -

100

Data Last Updated

Date

-

No

        1. yyyymmddhhmmss

20140729130010

Example File:

HDR,GENERATION BY FUEL TYPE CURRENT

FUELINSTHHCUR,CCGT,1523,96.9,153,100.0,20141202131502,145,93.9,786,100.0,20141212140002,486,17.9,475,100.0,Y,20141214150000

FUELINSTHHCUR,COAL,78954,78.6,954,100.0,20141102131502,354,96.3,516,100.0,20141112140002,954,82.7,127,100.0Y,20141216150000

FTR,2

5.2.16 Generation by Fuel Type (24H Instant Data)

API service details for the flow is as follows

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

  1. Default Sorting: Settlement Date (Ascending), Settlement Period (Ascending)

  2. Input data flow : FUELINST

Comments

  1. Default Value (if non specified): From DateTime = Current System DateTime – 24 Hr (configurable),To DateTime = Current System DateTime

API Web service – Request and Response format details:

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

Note:

    • 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.

Example File:

HDR, INSTANTANEOUS GENERATION BY FUEL TYPE DATA

FUELINST,20080428,37,20080428170503,18137,1850,0,15315,7308,189,15,15,0,55,152,21,22,234,22,22,22,22

FUELINST,20080428,37,20080428171007,18134,1849,0,15312,7307,181,16,14,0,52,150,13,17,238,22,22,22,22

FTR,2

5.2.17 Half Hourly Outturn Generation by Fuel Type

API service details for the flow is as follows

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

  1. Default Sorting: Settlement Date (Ascending), Settlement Period (Ascending)

  2. Input data flow : FUELHH

Comments

Default Value (if none specified): From Date = Current System Date – 1 (i.e. Yesterday), To Date = Current System Date (i.e. Today)

API Web service – Request and Response format details:

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

NOTE:

    • 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.

Example File:

HDR, HALF HOURLY OUTTURN GENERATION BY FUEL TYPE DATA

FUELHH,20080428,1,18137,1850,0,15315,7308,189,15,15,0,55,152,12,16,280,16,16,16,16

FUELHH,20080428,2,18134,1849,0,15312,7307,181,16,14,0,52,150,22,16,300,16,16,16,16

FTR,2

5.2.18 Half Hourly Interconnector Outturn Generation

API service details for the flow is as follows

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

  1. Default Sorting: Date (Ascending), Settlement Period (Ascending)

  2. Input data flow : FUELHH

Comments

  1. Default Value (if none specified): From Date= Current System date - 1 To Date= Current System Date

API Web service – Request and Response format details:

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

Example File:

HDR,HALF HOURLY INTERCONNECTOR OUTTURN GENERATION

INTOUTHH,20080428,1,55,152,23,32,32,32,32,32

INTOUTHH,20080428,2,52,150,22,21,21,21,21,21

FTR,2

NOTE:

    • 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.

5.2.19 National Output Useable (2-14 Days Ahead)

API service details for the flow is as follows

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

  1. Default Sorting: Settlement Date (Ascending)

  2. Input data flow : NOU2T14D

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 Web service – Request and Response format details:

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

API Webservice – Response: National Output Usable Data for 2 to 14 days (NOU2T14D)

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

Example File:

HDR,NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-14 DAYS)DATA

NOU2T14D,20141031151700,N,20141106,63825

NOU2T14D,20141031151700,N,20141107,62977

FTR,

5.2.20 National Output Useable by Fuel Type (2-14 Days Ahead)

API service details for the flow is as follows

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

  1. Default Sorting: Fuel Type (Ascending), Settlement Date (Ascending)

  2. Input data flow : FOU2T14D

Comments

Records are retrieved for date ranges between (Currentdate + 2 days) to (Currentdate + 14 days)

API Web service – Request and Response format details:

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

Example File:

HDR,NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-14 DAYS)DATA – BY FUEL TYPE

FOU2T14D,CCGT,201001021550,N,20100204,1500

FOU2T14D,OIL,201001021550,N,20100204,1500

FOU2T14D,COAL,201001021550,N,20100204,1500

FOU2T14D,NUCLEAR,201001021550,N,20100204,1500

FOU2T14D,BIOMASS,201001021550,N,20171015,788

FTR,5

5.2.21 National Output Useable by Fuel Type and BM Unit (2-14 Days Ahead)

API service details for the flow is as follows

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

  1. Default Sorting: BM Unit Id (Ascending),Fuel Type (Ascending)

  2. Input data flow : UOU2T14D

Comments

Records are retrieved for date ranges between (Currentdate + 2 days) to (Currentdate + 14 days)

API Web service – Request and Response format details:

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

Example File:

HDR,NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-14 DAYS)DATA – BY

BM UNIT/INTERCONNECTOR & FUEL TYPE

UOU2T14D,BMUNIT01,CCGT,201001021550,N,20100204,150

UOU2T14D,BMUNIT02,COAL, 201001021550,N,20100204,150

UOU2T14D,BMUNIT03,OIL, 201001021550,N,20100204,150

UOU2T14D,INTFR, INTFR, 201001021550,N,20100204,150

UOU2T14D,E_BMU-01,BIOMASS,201001021550,N,20100204,150

FTR,4

5.2.22 National Output Useable (2-52 Weeks Ahead)

API service details for the flow is as follows

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

  1. Default Sorting: Calendar Year (Ascending), Calendar Week Number (Ascending)

  2. Input data flow : NOU2T52W

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 Web service – Request and Response format details:

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

Example File:

HDR,NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-52 WEEKS)DATA

NOU2T52W,201004231113,N,18,2010,59588

NOU2T52W,201004231113,N,19,2010,60966

FTR,2

5.2.23 National Output Useable by Fuel type (2-52 Weeks Ahead)

API service details for the flow is as follows

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

  1. Default Sorting: Calendar Year (Ascending), Calendar Week (Ascending), Fuel Type (Ascending)

  2. Input data flow : FOU2T52W

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 Web service – Request and Response format details:

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

        1. -

No

-

1

Calendar Year

Integer

-

No

YYYY

2017

Output Usable

Integer

-

No

-

100

Example File:

HDR,NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-52 WEEKS)DATA –

BY FUEL TYPE

FOU2T52W,CCGT,201001021550,N,3,2010,1500

FOU2T52W,BIOMASS,201001021550,N,3,2010,1500

FTR,2

5.2.24 National Output Useable by Fuel Type and BM Unit (2-52 Weeks Ahead)

API service details for the flow is as follows

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

  1. Default Sorting: BM Unit Id (Ascending),Fuel Type (Ascending), Calendar Year (Ascending), Calendar Week Number (Ascending)

  2. Input data flow : UOU2T52W

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 Web service – Request and Response format details:

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

Example File:

HDR,NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-52 WEEKS)DATA –

BY BM UNIT/INTERCONNECTOR & FUEL TYPE

UOU2T52W,BMUNIT01,CCGT,201001021550,N,12,2010,1000

UOU2T52W,BMUNIT02,COAL,201001021550,N,12,2010,1000

UOU2T52W,BMUNIT03,BIOMASS,201001021550,N,12,2010,1000

UOU2T52W,INTFR,INTFR,201001021550,N,12,2010,2500

FTR,4

5.2.25 National Output Useable Data (2-156 Weeks Ahead)

API service details for the flow is as follows

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'.

API Web service – Request and Response format details:

API Webservice – Request - NationalOutputUsable2T156Weeks

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 - NationalOutputUsable2T156Weeks

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-156 WEEKS)DATA”

Body Record:

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

NOU2T3YW

Publishing Period Commencing Time

Date

-

No

YYYY-MM-DD HH:MM:SS

2020-07-21 10:59:00

System Zone

String

-

No

-

N

Calendar Week Number

Integer

-

No

-

1

Year

Integer

-

No

YYYY

2020

Output Usable

Integer

-

No

-

69163

Active Flag

String

Only active records are returned, as for NOU2T52W

No

-

Y

CSV Download Service:

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

NOU2T3YW

Publishing Period Commencing Time

Date

-

No

YYYYMMDDHHMMSS

20200721105900

System Zone

String

-

No

-

N

Calendar Week Number

Integer

-

No

-

1

Year

Integer

-

No

YYYY

2020

Output Usable

Integer

-

No

-

69163

Example file:

HDR,NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-156 WEEKS) DATA

NOU2T3YW,20200721105900,N,18,2020,59588

NOU2T3YW,20200721105900,N,19,2020,60966

FTR,2

5.2.26 National Output Usable by Fuel Type (2-156 Weeks Ahead)

API service details for the flow is as follows

Service Name

nationalOutputUsableByFuelType2T156WeeksService

Method

GET

Input URL

https://api.bmreports.com/BMRS/FOU2T3YW/<VersionNo>?APIKey=<APIKey>&ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Description

1. Default Sorting: Calendar Year (Ascending), Calendar Week Number (Ascending), Fuel Type (Ascending)

2. Input data flow : FOU2T3YW

Comments

Records are retrieved for date ranges between (Currentdate + 2 weeks) to (Currentdate + 156 weeks)

Note: The First day of week is considered as 'Monday'.

API Web service – Request and Response format details:

API Webservice – Request - NationalOutputUsableByFuelType2T156Weeks

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 - NationalOutputUsableByFuelType2T156Weeks

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-156 WEEKS)DATA –FUEL TYPE”

Body Record:

Group Name: Response List

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

FOU2T3YW

Fuel Type

String

-

No

-

COAL

Publishing Period Commencing Time

Date

-

No

YYYY-MM-DD HH:MM:SS

2020-07-21 10:59:00

System Zone

String

-

No

-

N

Calendar Week Number

Integer

-

No

-

1

Year

Integer

-

No

YYYY

2020

Output Usable

Integer

-

No

-

69163

Active Flag

String

Only active records are returned, as for FOU2T52W

No

-

Y

Bidding Zone

String

Only returned for Interconnector fuel types

No

-

FRANCE

Group Name: Bidding Zone Total Generation

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Bidding Zone

String

-

No

-

Record Type

String

-

No

-

FOU2T3YW

Publishing Period Commencing Time

Date

-

No

-

Calendar Week Number

Integer

-

No

-

1

Year

Integer

-

No

YYYY

2020

Output Usable

Integer

Sum of Output Usable in Response List for Bidding Zone, Calendar Week Number, and Year

No

-

69163

Active Flag

String

Only active records are returned, as for FOU2T52W

No

-

Y

CSV Download Service:

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

FOU2T3YW

Fuel Type

String

-

No

-

COAL

Publishing Period Commencing Time

Date

-

No

YYYYMMDDHHMMSS

20200721105900

System Zone

String

-

No

-

N

Calendar Week Number

Integer

-

No

-

1

Year

Integer

-

No

YYYY

2020

Output Usable

Integer

-

No

-

69163

Example file:

HDR,NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-156 WEEKS) DATA – BY FUEL TYPE

FOU2T3YW,CCGT,20200721105900,N,3,2020,1500

FOU2T3YW,BIOMASS,20200721105900,N,3,2020,1500

FTR,2

5.2.27 National Output Useable by Fuel Type and BM Unit (2-156 Weeks Ahead)

API service details for the flow is as follows

Service Name

nationalOutputUsableByFuelType&BMUnit2T156WeeksService

Method

GET

Input URL

https://api.bmreports.com/BMRS/UOU2T3YW/<VersionNo>?APIKey=<APIKey>&ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Description

1. Default Sorting: BM Unit Id (Ascending), Fuel Type (Ascending), Calendar Year (Ascending), Calendar Week Number (Ascending)

2. Input data flow : UOU2T3YW

Comments

Records are retrieved for date ranges between (Currentdate + 2 weeks) to (Currentdate + 156 weeks)

Note: The First day of week is considered as 'Monday'.

API Web service – Request and Response format details:

API Webservice – Request – NationalOutputUsableByFuelType&BMUnit2T156Weeks

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&BMUnit2T156Weeks

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-156 WEEKS)DATA – BY BM UNIT & FUEL TYPE”

Body Record:

Group Name: Response List

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

UOU2T3YW

BM Unit Name

String

-

No

-

BMUNIT01

Fuel Type

String

-

No

-

COAL

Publishing Period Commencing Time

Date

-

No

YYYY-MM-DD HH:MM:SS

2020-07-21 10:59:00

System Zone

String

-

No

-

N

Calendar Week Number

Integer

-

No

-

1

Year

Integer

-

No

YYYY

2020

Output Usable

Integer

-

No

-

69163

Active Flag

String

Only active records are returned, as for UOU2T52W

No

-

Y

Bidding Zone

String

Only returned for Interconnector fuel types, derived by joining to DB_NETABMRS_REP.T_BMRS_BIDDING_ZONE_DATA

No

-

FRANCE

Group Name: Bidding Zone Total Generation

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Bidding Zone

String

-

No

-

Record Type

String

-

No

-

UOU2T3YW

Publishing Period Commencing Time

Date

-

No

-

Calendar Week Number

Integer

-

No

-

1

Year

Integer

-

No

YYYY

2020

Output Usable

Integer

Sum of Output Usable in Response List for Bidding Zone, Calendar Week Number, and Year

No

-

69163

Active Flag

String

Only active records are returned, as for UOU2T52W

No

-

Y

CSV Download Service:

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

UOU2T3YW

BM Unit ID

String

-

No

-

BMUNIT01

Fuel Type

String

-

No

-

COAL

Publishing Period Commencing Time

Date

-

No

YYYYMMDDHHMMSS

20200721105900

System Zone

String

-

No

-

N

Calendar Week Number

Integer

-

No

-

1

Year

Integer

-

No

YYYY

2020

Output Usable

Integer

-

No

-

69163

Example file:

HDR,NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-156 WEEKS)DATA – BY BM UNIT & FUEL TYPE

UOU2T3Y,BMUNIT01,CCGT,20200721105900,N,12,2020,1000

UOU2T3Y,BMUNIT02,COAL, 20200721105900,N,12,2020,1000

UOU2T3Y,BMUNIT03,BIOMASS,20200721105900,N,12,2020,1000

FTR,3

5.2.28 Initial Demand Outturn

API service details for the flow is as follows

Service Name

initialDemandOutturnService

Method

GET

Input URL

https://api.bmreports.com/BMRS/INDOITSDO/<VersionNo>?APIKey=<APIKey>&FromDate=<FromDate>&ToDate=<ToDate>&ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Description

  1. Default Sorting: Settlement Date (Ascending), Settlement Period (Ascending)

  2. Input data flow: INDO, ITSDO.

Comments

  • Default Value (if none specified): From Date= Current System date - 1 To Date= Current System Date

API Web service – Request and Response format details:

API Webservice – Request – InitialDemandOutturn

Logical Field Name

Field Type

Remarks

Mandatory

Format

Sample data

ApiKey

String

-

Yes

-

AP8DA23

From Date

String

-

No

YYYY-MM-DD

2014-12-31

To Date

String

-

No

YYYY-MM-DD

2014-12-31

Service Type

String

-

No

-

csv/CSV/xml/XML

API Webservice – Response-InitialDemandOutturn

Header Record:

Report Output Field Mapping

Condition

Record Type

HDR

File Type

INITIAL DEMAND OUTTURN

Body Record:

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Settlement Date

Date

-

No

yyyy-mm-dd

2014-10-26

Settlement Period

Integer

-

No

-

1

SystemZone

String

-

No

-

N

Record Type

String

-

No

-

INDO

Publish Time

Date

-

No

yyyy-mm-dd hh:mm:ss

2014-10-25 23:30:00

Demand

Integer

-

No

-

23039

Active Flag

String

-

No

-

Y

CSV Download Service:

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

INDO/ITSDO

Settlement Date

Date

-

No

yyyymmdd

20141026

Settlement Period

Integer

-

No

-

1

SystemZone

String

-

No

-

N

Publish Time

Date

-

No

yyyymmddhhmmsS

20141025233000

Demand

Integer

-

No

-

23039

NOTE:

    • 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.

Example File:

HDR,INITIAL DEMAND OUTTURN

INDO,20141109,1,N,20141109003000,27901

INDO,20141109,2,N,20141109010000,27745

INDO,20141109,3,N,20141109013000,27168

FTR,3

5.2.29 Forecast Day and Day Ahead Margin and Imbalance Data

API service details for the flow is as follows

Service Name

forecastDayAndDayAheadMarginAndImbalanceService

Method

GET

Input URL

https://api.bmreports.com/BMRS/MELIMBALNGC/<VersionNo>?APIKey=<APIKey>&ZoneIdentifier=<ZoneIdentifier>&FromDate=<FromDate>&ToDate=<ToDate>&ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Description

  • Default Sorting: Settlement Date (Ascending), Settlement Period (Ascending)

  • Input data flow : IMBALNGC, MELNGC

Comments

  1. Default Values (if none specified): Zone Identifier = N, From Date = Current System Date, To Date = Current System Date + 2

API Web service – Request and Response format details:

API Webservice – Request – ForecastDayAndDayAheadMarginAndImbalance

Logical Field Name

Field Type

Remarks

Mandatory

Format

Sample data

Zone Identifier

String

-

No

-

Default data N

From Date

String

-

No

YYYY-MM-DD

2014-08-11

To Date

String

-

No

YYYY-MM-DD

2014-08-12

ApiKey

String

-

Yes

-

AP8DA23

Service Type

String

-

No

-

xml/XML/csv/CSV

API Webservice – Response - ForecastDayAndDayAheadMarginAndImbalance

Header Record:

Report Output Field Mapping

Condition

Record Type

Fixed string value “HDR”

File Type

Fixed string value “FORECAST DAY AND DAY AHEAD MARGIN AND IMBALANCE DATA”

Body Record :

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Zone ID

String

-

No

-

B1 to B14

Settlement Date

Date

-

No

-

2014-08-11

Settlement Period

Integer

-

No

-

1 to 50

Record Type

String

-

No

-

Fixed string value -“DAM” or “DAI”

Publish Time

Date

-

No

Yyyy-mm-dd hh:MM:ss

2014-08-10 14:22:00

Margin/ImbalanceValue

Integer

Margin value or Imbalance Value will be present for corresponding record type.

No

-

26223

Active Flag

String

-

No

-

Y

CSV Download Service:

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Zone ID

String

-

No

-

B1 to B14

Settlement Date

Date

-

No

-

20140811

Settlement Period

Integer

-

No

-

1 to 50

Record Type

String

-

No

-

Fixed string value -“DAM” or “DAI”

Publish Time

Date

-

No

Yyyymmdd hhMMss

20140810142200

Margin/ ImbalanceValue

Integer

Margin value or Imbalance Value will be present for corresponding record type.

No

-

26223

NOTE:

    • 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.

Example File:

HDR,FORECAST DAY AND DAY AHEAD MARGIN AND IMBALANCE DATA

DAM,20001017,1,B1,20001016220000,2623

DAM,20001017,2,B1,20001016220000,2574

DAI,20001017,1,B1,20001016220000,2602

DAI,20001017,2,B1,20001016220000,2556

FTR,4

5.2.30 Forecast Day and Day Ahead Demand Data

API service details for the flow is as follows

Service Name

forecastDayAndDayAheadDemandDataService

Method

GET

Input URL

https://api.bmreports.com/BMRS/FORDAYDEM/<VersionNo>?APIKey=<APIKey>&ZoneIdentifier=<ZoneIdentifier>&FromDate=<FromDate>&ToDate=<ToDate>&ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Description

  1. Default Sorting: Settlement Date (Ascending),Settlement Period (Ascending)

  2. Input data flow : NDF, TSDF, INDDEM, INDGEN

Comments

  1. Default Value (if none specified): Zone Identifier = N, From Date = Current system Date ,To Date = Current System Date + 2

API Web service – Request and Response format details:

API Webservice – Request - Forecast day and day ahead demand data

Logical Field Name

Field Type

Remarks

Mandatory

Format

Sample data

Zone Identifier

String

-

No

-

Default Zone Identifier = N

From Date

String

-

No

YYYY-MM-DD

2014-08-11

To Date

String

-

No

YYYY-MM-DD

2014-08-12

ApiKey

String

-

Yes

-

AP8DA23

Service Type

String

-

No

-

csv/CSV/XML/xml

API Webservice – Response - Forecast day and day ahead demand data

Header Record:

Report Output Field Mapping

Condition

Record Type

Fixed string value “HDR”

File Type

Fixed string value “FORECAST DAY AND DAY AHEAD DEMAND

DATA”

Body Record:

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Zone (Boundary ID)

String

-

No

Always N

N

Settlement Date

Date

-

No

yyyy-mm-dd

2000-10-10

Settlement Period (S/P)

Integer

-

No

-

10

Record Type

String

-

No

-

DANF

Publish Time

Date

-

No

yyyy-mm-dd hh:mm:ss

2000-10-16 22:00:00

Demand/SPNDemand/SPNGeneration

Integer

-

No

-

9861

Active Flag

String

-

No

-

Y

CSV Download Service:

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

DANF

Settlement Date

Date

-

No

yyyymmdd

20141010

Settlement Period (S/P)

Integer

-

No

-

10

Zone (Boundary ID)

String

-

No

Always N

N

Publish Time

Date

-

No

yyyymmddhhmmss

20001016220000

Demand/SPNDemand/SPNGeneration

Integer

-

No

-

9861

Example File:

HDR,FORECAST DAY AND DAY AHEAD DEMAND DATA

DANF,20001017,1,N,20001016220000,9861

DANF,20001017,2,N,20001016220000,8783

DATF,20001017,1,N,20001016220000,9661

DATF,20001017,2,N,20001016220000,8583

DAID,20001017,1,N,20001016220000,9560

DAID,20001017,2,N,20001016220000,8484

DAIG,20001017,1,N,20001016220000,9699

DAIG,20001017,2,N,20001016220000,8612

FTR,8

5.2.31 Demand & Surplus Forecast Data (2-14 Days Ahead)

API service details for the flow is as follows

Service Name

demandAndSurplusForecastData2T14DaysService

Method

GET

Input URL

https://api.bmreports.com/BMRS/DEMMF2T14D/<VersionNo>?APIKey=<APIKey>&ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Description

  1. Default Sorting: Settlement Date (Ascending), Settlement Period (Ascending)

  2. Input data flow : NDFD, TSDFD, OCNMFD, OCNMFD2.

Comments

Records are retrieved for date ranges between (Currentdate + 2 days) to (Currentdate + 14 days)

API Web service – Request and Response format details:

API Webservice – Request -DemandAndSurplusForecastData2T14Days

Logical Field Name

Field Type

Remarks

Mandatory

Format

Sample data

ApiKey

String

-

Yes

-

AP8DA23

Service Type

String

-

No

-

csv/CSV/xml/XML

API Webservice – Response- DemandAndSurplusForecastData2T14Days

Header Record:

Report Output Field Mapping

Condition

Record Type

HDR

File Type

FORECAST 2 TO 14 DAYS AHEAD DEMAND AND MARGIN DATA

Body Record:

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Settlement Date

Date

-

No

yyyy-mm-dd

2014-10-29

Settlement Period

Integer

-

No

-

1

Boundary ID

String

-

No

-

Always is “N”

Record Type

String

-

No

-

DSN (for NDFD)or DST (for TSDFD)or DSM (for OCNMFD)or OCNMFD2 (for OCNMFD2)

Publication Time

Date

-

No

yyyy-mm-dd hh:mm:ss

2014-10-26 14:45:00

demand/margin

Integer

If Record Type is DSN,DST we will have demand value, or DSM,OCNMFD2 we will have margin value

No

-

45300

Active Flag

String

-

No

-

Y

CSV Download Service:

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Settlement Date

Date

-

No

yyyymmdd

20141029

Settlement Period

Integer

-

No

-

1

Boundary ID

String

-

No

-

Always is “N”

Record Type

String

No

-

DSN (for NDFD)or DST (for TSDFD)or DSM (for OCNMFD)or OCNMFD2 (for OCNMFD2)

Publication Time

Date

-

No

yyyymmddhhmmss

20141026144500

demand/margin

Integer

If Record Type is DSN,DST we will have demand value, or DSM,OCNMFD2 we will have margin value

No

45300

Example File:

HDR,FORECAST 2 TO 14 DAYS AHEAD DEMAND AND MARGIN DATA

DSN,20001019,9,N,20001016150000,41000

DSN,20001020,11,N,20001016150000,42000

OCNMFD2,20001010,9,N,20001016150000,17330

OCNMFD2,20001010,11,N,20001016150000,14288

FTR,4

5.2.32 Demand & Surplus Forecast Data (2-52 Weeks Ahead)

API service details for the flow is as follows

Service Name

demandAndSurplusForecastData2T52WeeksService

Method

GET

Input URL

https://api.bmreports.com/BMRS/DEMMF2T52W/<VersionNo>?APIKey=<APIKey>&ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Description

  1. Default Sorting: Record Type,

  2. Week Number - Records ordered incrementing by this field (wraps from 53 to 1when new year starts) Input data flow: NDFW, TSDFW, OCNMFW, and OCNMFW2.

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 Web service – Request and Response format details:

API Webservice – Request DemandAndSurplusForecastData2T52Weeks

Logical Field Name

Field Type

Remarks

Mandatory

Format

Sample data

ApiKey

String

-

Yes

-

AP8DA23

Service Type

String

-

No

-

csv/CSV/xml/XML

API Webservice – Response -DemandAndSurplusForecastData2T52Weeks

Header Record

Report Output Field Mapping

Condition

Record Type

Fixed string value “HDR”

File Type

Fixed string value “FORECAST 2 TO 52 WEEKS AHEAD DEMAND AND MARGIN DATA”

Body Record:

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample values

Week Number

Integer

-

No

-

46

Boundary ID

String

-

No

-

Always is “N”

Record Type

String

-

No

-

“WN”(for NDFW) or “WT” (for TSDFW) or “WM” (for OCNMFW) or “OCNMFW2” (for OCNMFW2)

Publication Time

Date

-

No

Yyyy-mm-dd hh:mm:ss

2014-10-16 13:45:00

demand/margin

Integer

Depending upon Record type If it is WN,WT we will get Demand value else if it is WM,OCNMFW2 we will get Margin value.

No

-

49500

Active Flag

String

-

No

-

Y

CSV Download Service:

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample values

Week Number

Integer

-

No

-

46

Boundary ID

String

-

-

Always is “N”

Record Type

String

-

No

-

“WN”(for NDFW) or “WT” (for TSDFW) or “WM” (for OCNMFW) or “OCNMFW2” (for OCNMFW2)

Publication Time

Date

-

No

yyyymmddhhmmss

20141016134500

demand/margin

Integer

Depending upon Record type If it is WN,WT we will get Demand value else if it is WM,OCNMFW2 we will get Margin value.

No

-

49500

Example File:

HDR,FORECAST 2 TO 52 WEEKS AHEAD DEMAND AND MARGIN DATA

WN,44,N,20001013170000,36000

WN,45,N,20001013170000,37000

OCNMFW2,44,N,20001013170000,17830

OCNMFW2,45,N,20001013170000,18610

FTR,4

5.2.33 Demand & Surplus Forecast Data (2-156 Weeks Ahead)

API service details for the flow is as follows

Service Name

marginAndSurplusForecastData2T156WeeksService

Method

GET

Input URL

https://api.bmreports.com/BMRS/MARSF2T3YW/<VersionNo>?APIKey=<APIKey>&RecordType=<RecordType>&ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Description

1. Default Sorting: Record Type

2. Week Number - Records ordered incrementing by this field (wraps from 156 to 1 when new year starts)

3. Input data flow: OCNMF3Y and OCNMF3Y2

Comments

Records are retrieved for date ranges between (Currentdate + 2 weeks) to (Currentdate + 156 weeks)

Note: The First day of week is considered as 'Monday'.

API Web service – Request and Response format details:

API Webservice – Request - MarginAndSurplusForecastData2T156Weeks

Logical Field Name

Field Type

Remarks

Mandatory

Format

Sample data

ApiKey

String

-

Yes

-

AP8DA23

Service Type

String

-

No

-

xml/XML/csv/CSV

Record Type

String

-

No

-

OCNMF3Y/OCNMF3Y2

API Webservice – Response - MarginAndSurplusForecastData2T156Weeks

Header Record:

Report Output Field Mapping

Condition

Record Type

Fixed string value “HDR”

File Type

If requested Record Type = OCNMF3Y, fixed string value “FORECAST 2 TO 156 WEEKS AHEAD SURPLUS DATA”

Else if requested Record Type = OCNMF3Y2, fixed string value “FORECAST 2 TO 156 WEEKS AHEAD MARGIN DATA”

Else

Fixed string value “FORECAST 2 TO 156 WEEKS AHEAD SURPLUS AND MARGIN DATA”

Body Record:

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

OCNMF3Y or OCNMF3Y2

Calendar Week Number

Integer

-

No

-

46

Year

Integer

-

No

YYYY

2020

Boundary ID

String

-

No

-

N

Publishing Period Commencing Time

Date

-

No

YYYY-MM-DD HH:MM:SS

2020-07-21 10:59:00

Surplus / Margin

Integer

If OCNMF3Y, tag = Surplus

If OCNMF3Y2, tag = Margin

No

-

49500

Active Flag

String

Only active records are returned, as for DEMMF2T52W

No

-

Y

CSV Download Service:

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

OCNMF3Y or OCNMF3Y2

Week Number

Integer

-

No

-

46

Year

Integer

-

No

YYYY

2020

Boundary Id

String

-

No

-

N

Publishing Period Commencing Time

Date

-

No

YYYYMMDDHHMMSS

20200721105900

Surplus / Margin

Integer

No

-

49500

Example file:

HDR,FORECAST 2 TO 156 WEEKS AHEAD SURPLUS AND MARGIN DATA

OCNMF3Y,44,2020,N,20200721105900,17830

OCNMF3Y2,45,2020,N,20200721105900,18610

FTR,2

5.2.34 SO-SO Prices (SO-SO)

API service details for the flow is as follows

Service Name

sosoPricesService

Operation Name

sosoPricesImpl

Method

GET

Input URL

https://api.bmreports.com/BMRS/SOSOP/<VersionNo>?APIKey=<APIKey>&SettlementDate=<SettlementDate>&StartTime=<StartTime>&TradeType=<TradeType>&IsTwoDayWindow=<IsTwoDayWindow>&ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Description

  1. Default Sorting: Start Time (Ascending)

  2. Input data flow : SOSO

For other common description refer section 3.2

Comments

Default Value (if none specified): Settlement Date = Current System Date , Start Time = *, Trade Type = ALL, isTwoDayWindow=false

API Web service – Request and Response format details:

API Webservice – Request - SO-SO Prices (SO-SO)

Logical Field Name

Field Type

Remarks

Mandatory

Format

Sample data

ApiKey

String

-

Yes

-

AP8DA23

Service Type

String

-

No

-

csv/CSV/xml/XML

Settlement Date

String

-

No

YYYY-MM-DD

2014-12-31

Start time

String

-

No

HH:MM

-

Trade Type

String

-

No

-

ALL, BALIT_NG, BALIT_RTE, BritNed_NG, BritNed_TN, EWIC_EG, EWIC_NG, MOYLE_NG, MOYLE_SN

isTwoDayWindow

String

-

No

-

false

API Webservice – Response – SO-SO Prices (SO-SO)

Header Record:

Report Output Field Mapping

Condition

Record Type

Fixed string value “HDR”

File Type

Fixed String value “SO-SO PRICES”

Body Record:

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample values

Record Type

String

-

No

-

SOSO

Trade Type

String

-

No

-

BALIT_NG

Start Time

Date

-

No

hh:mm:ss

23:00:00

Date

Date

-

No

yyyy-mm-dd

2014-09-08

Trade Direction

String

-

No

A01, A02

A01

Contract Identification

String

-

No

-

NG_20140908_2300_20

Trade Quantity

Integer

-

No

MW

55

Trade Price

Double

-

No

Currency/MWh

57.07

Active Flag

String

-

No

-

Y

CSV Download service

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample values

Record Type

String

-

No

-

SOSO

Trade Type

String

-

No

-

BALIT_NG

Start Time

Date

-

No

yyyymmddhhmmss

20100422170000

Trade Direction

String

-

No

A01, A02

A01

Contract Identification

String

-

No

-

NG_20140908_2300_20

Trade Quantity

Integer

-

No

MW

55

Trade Price

Double

-

No

Currency/MWh

57.07

Example File:

HDR,SO-SO PRICES

SOSO,BALIT_NG,20100422170000,A01,RTE_20101225_1000_3,12584,24.25

SOSO,BALIT_NG,20100422180000,A02,RTE_20101225_1000_27,10524,30.16

FTR,2

Note: If “isTwoDayWindow” input parameter values is “true” then fetching yesterday and today’s data if it is “false” then fetching only today’s data.

5.2.35 SO SO Trades

API service details for the flow is as follows

Service Name

sosoTradesService

Method

GET

Input URL

https://api.bmreports.com/BMRS/SOSOT/<VersionNo>?APIKey=<APIKey>&ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Description

  1. Default Sorting: Warning Date/Time (Ascending)

  2. Input data flow : SYS_WARN

Comments

-

API Web service – Request and Response format details:

API Webservice – Request - SO-SO Trades

Logical Field Name

Field Type

Remarks

Mandatory

Format

Sample data

ApiKey

String

-

Yes

-

AP8DA23

Service Type

String

-

No

-

csv/CSV/xml/XML

API Webservice – Response – SO-SO Trades

Header Record:

Report Output Field Mapping

Condition

Record Type

Fixed string value “HDR”

File Type

Fixed String value “SO-SO TRADES”

Body Record:

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample values

RecordType

String

-

No

-

SOSOT

Warning Date/Time

Date

-

No

yyyy-mm-dd hh:mm

2014-12-31 13:31

Message Text

String

-

No

-

National Grid Notification

Active Flag

String

-

No

-

Y

CSV Download service

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample values

RecordType

String

-

No

-

SOSOT

Warning Date/Time

Date

-

No

yyyymmddhhmm

201412311331

Message Text

String

-

No

-

National Grid Notification

5.2.36 Peak Demand – Yesterday/Today/Tomorrow

API service details for the flow is as follows

Service Name

peakDemandService

Operation Name

peakDemandImpl

Method

GET

Input URL

https://api.bmreports.com/BMRS/PKDEMYESTTDYTOM/<VersionNo>?APIKey=<APIKey>&ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Description

Default Sorting: Date (Ascending)

Input data flow : TSDF , ITSDO

For other common description refer section 2.3

Comments

-

API Web service – Request and Response format details:

API Webservice – Request - Peak Demand

Logical Field Name

Field Type

Mandatory

Format

Sample data

ApiKey

String

Yes

-

AP8DA23

Service Type

String

No

-

csv/CSV/xml/XML

API Webservice – Response - Peak Demand

Header Record:

Report Output Field Mapping

Condition

Record Type

Fixed string value “HDR”

File Type

Fixed string value “PEAK DEMAND DATA – YESTERDAY, TODAY, TOMORROW”

Body Record:

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample values

Record Type

String

-

No

PKDEM

Fixed string value “PKDEM”

Date

Date

-

No

YYYY-MM-DD

2014-10-13

Forecast Demand Peak (MW)

Integer

-

No

-

154236

Forecast Peak Demand Time (local time)

Date

-

No

HH:mm

10:10

Actual Demand Peak (MW)

Integer

-

No

-

154236

Actual Peak Demand Time (local time)

Date

-

No

HH:mm

10:10

Last Updated (GMT time of Forecast, or Actual if Actual showing)

Date

-

No

YYYY-MM-DD HH:mm

2014-10-10 11:10

Active Flag

String

-

No

-

Y

CSV Download service

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample values

Record Type

String

-

No

PKDEM

Fixed string value “PKDEM”

Date

Date

-

No

YYYYMMDD

20141013

Forecast Demand Peak (MW)

Integer

-

No

-

154236

Forecast Peak Demand Time (local time)

Date

-

No

HHmm

10:10

Actual Demand Peak (MW)

Integer

-

No

-

154236

Actual Peak Demand Time (local time)

Date

-

No

HHmm

10:10

Last Updated (GMT time of Forecast, or Actual if Actual showing)

Date

-

No

YYYYMMDDHHmm

201410101110

Active Flag

String

-

No

-

Y

5.2.37 Indicative Peak Demand Information (Using Operational Metering Data)

API service details for the flow is as follows

Service Name

indicativePeakDemandInformationService

Operation Name

indicativePeakDemandInformationImpl

Method

GET

Input URL

https://api.bmreports.com/BMRS/INDPKDEMINFO/<VersionNo>?APIKey=<APIKey> &ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Description

Default Sorting: Data Set 1 : Date (Ascending) Data Set 2: Week Number (Ascending)

Input data flow : ITSDO,TSDFW

Source

MySQL

Comments

-

API Web service – Request and Response format details:

API Webservice – Request – Indicative Peak Demand Information (Using Operational Metering Data)

Logical Field Name

Field Type

Remarks

Mandatory

Format

Sample data

ApiKey

String

-

Yes

-

AP8DA23

Service Type

String

-

No

-

xml/XML/csv/CSV

API Webservice – Response - Indicative Peak Demand Information (Using Operational Metering Data)

Header Record

Report Output Field Mapping

Condition

Record Type

Fixed string value “HDR”

File Type

Fixed string value “INDICATIVE PEAK DEMAND INFORMATION (USING OPERATIONAL METERING DATA)”

Body Record : Data Set 1

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “3HIGHDEMSOFAR”

Date

Date

-

No

YYYY-MM-DD

2014-10-10

GB Demand (MW)

Integer

-

No

-

12888

Time of peak

Date

-

No

HH:MM

14:00

Active Flag

String

-

No

-

Y

Body Record: Data Set 2

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “3HIGHFORDEM”

Week Number

Integer

-

No

-

5

GB Demand (MW)

Integer

-

No

-

12866

Active Flag

String

-

No

-

Y

CSV Download service

Data Set 1

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

Fixed string value “3HIGHDEMSOFAR”

Date

Date

-

No

YYYYMMDD

20141010

GB Demand (MW)

Integer

-

No

-

12888

Time of peak

Date

-

No

HHMM

1400

Active Flag

String

-

No

-

Y

Data Set 2

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

Fixed string value “3HIGHFORDEM”

Week Number

Integer

-

No

-

5

GB Demand (MW)

Integer

-

No

-

12866

Active Flag

String

-

No

-

Y

5.2.38 System Demand

API service details for the flow is as follows

Service Name

systemDemandService

Operation Name

systemDemandImpl

Method

GET

Input URL

https://api.bmreports.com/BMRS/SYSDEM/<VersionNo>?APIKey=<APIKey>&FromDate=<FromDate>&ToDate=<ToDate>&ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Description

Default Sorting: Settlement Date (Ascending),Settlement Period (Ascending)

Input data flow : ITSDO,TSDF

For other common description refer section 2.3

Source

MySQL

Comments

Default Value (if none specified): From Date = Current System Date - 1 To Date = Current System Date +1

API Web service – Request and Response format details:

API Webservice – Request –System Demand

Logical Field Name

Field Type

Remarks

Mandatory

Format

Sample data

ApiKey

String

-

Yes

-

AP8DA23

From Date

String

-

No

YYYY-MM-DD

2014-12-31

To Date

String

-

No

YYYY-MM-DD

2014-12-31

Service Type

String

-

No

-

xml/XML/csv/CSV

API Webservice – Response – System Demand

Header Record:

Report Output Field Mapping

Condition

Record Type

Fixed string value “HDR”

File Type

Fixed string value “SYSTEM DEMAND”

Body Record:

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Settlement Date

Date

-

No

Yyyy-mm-dd

2014-07-29

Settlement Period

Integer

-

No

-

25

Record Type

String

-

No

-

Fixed string value “ITSDO

GB Demand (MW)

Integer

-

No

-

14565

Record Type

String

-

No

-

Fixed string value “TSDF”

GB Demand (MW)

Integer

-

No

-

35469

Active Flag

String

-

No

-

Y

CSV Download service

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Settlement Date

Date

-

No

Yyyymmdd

20140729

Settlement Period

Integer

-

No

-

25

Record Type

String

-

No

-

Fixed string value “ITSDO

GB Demand (MW)

Integer

-

No

-

14565

Record Type

String

-

No

-

Fixed string value “TSDF”

GB Demand (MW)

Integer

-

No

-

35469

Active Flag

String

-

No

-

Y

NOTE:

    • 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.

5.2.39 Indicative Triad Demand Information (Using Settlement Metering Data)

API service details for the flow is as follows

Service Name

indicativeTriadDemandInfoService

Operation Name

indicativeTriadDemandInfoImpl

Method

GET

Input URL

https://api.bmreports.com/BMRS/INDTRIADDEMINFO/<VersionNo>?APIKey=<APIKey>&ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Description

Default Sorting: Date (Ascending)

Input data flow : NA

For other common description refer section 2.3

Comments

Note that there may not always be sufficient temporal separation to provide 3 peaks in which case it is shown as NULL

API Web service – Request and Response format details:

API Webservice – Request - Peak Demand

Logical Field Name

Field Type

Mandatory

Format

Sample data

ApiKey

String

Yes

-

AP8DA23

Service Type

String

No

-

csv/CSV/xml/XML

API Webservice – Response - Peak Demand

Header Record:

Report Output Field Mapping

Condition

Record Type

Fixed string value “HDR”

File Type

Fixed string value “INDICATIVE TRIAD DEMAND INFORMATION (USING SETTLEMENT METERING DATA)”

Body Record:

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “TRIADSETTDATA”

Date

Date

-

No

Yyyy-mm-dd

2014-07-29

GB Demand (MW)

Integer

-

No

-

14565

Time Of Peak

String

-

No

-

Fixed string value “TSDF”

Data Last Updated

Date

-

No

YYYY-MM-DD HH:mm

2014-07-29 14:10

Active Flag

String

-

No

-

Y

CSV Download service

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

Fixed string value “TRIADSETTDATA”

Date

Date

-

No

Yyyymmdd

20140729

GB Demand (MW)

Integer

-

No

-

14565

Time Of Peak

String

-

No

-

Fixed string value “TSDF”

Data Last Updated

Date

-

No

YYYYMMDDHHmm

201407291410

Active Flag

String

-

No

-

Y

5.2.40 Physical Data

API service details for the flow is as follows

Service Name

physicalBMDataService

Operation Name

physicalBMDataImpl

Method

GET

Input URL

https://api.bmreports.com/BMRS/PHYBMDATA/<VersionNo>?APIKey=<APIKey>&SettlementDate=<SettlementDate>&SettlementPeriod=<SettlementPeriod>&BMUnitId=<BMUnitId>&BMUnitType=<BMUnitType>&LeadPartyName=<LeadPartyName>&NGCBMUnitName=<NGCBMUnitName>&ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Description

  1. Default Sorting: BM Unit Id (Ascending), Settlement Period (Ascending ) (From Body) , Bid Offer Acceptance ID (Ascending) (applicable only for BOALF body), From Time (Ascending)

  2. Input data flow: FPN, QPN, MELS, MILS, BOALF.

Comments

Default Value (if none specified): Settlement Date = {as per NRT criteria}, Settlement Period = {as per NRT criteria},BM Unit Id = *, BM Unit Type = *, Lead Party Name = *, NGC BM Unit Name = * (* implies all values)

API Web service – Request and Response format details:

API Webservice – Request – Physical BM 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 – Physical BM Data

Header Record:

Report Output Field Mapping

Condition

Record Type

Fixed string value “HDR”

File Type

Fixed string value “PHYSICAL BM DATA”

Settlement Date

From input parameter

Settlement Period

From input parameter

Body Records:

FPN Data :

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

“PN”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

From Time

Date

-

No

yyyy-mm-dd hh:mm:ss

2000-10-16 17:30:00

From Level

Double

-

No

-

0.000

To Time

Date

-

No

yyyy-mm-dd hh:mm:ss

2000-10-16 17:30:00

To Level

Double

-

No

-

0.000

Active Flag

String

-

No

-

Y

QPN Data :

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

“QPN”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

From Time

Date

-

No

yyyy-mm-dd hh:mm:ss

2000-10-16 17:30:00

From Level

Double

-

No

-

0.000

To Time

Date

-

No

yyyy-mm-dd hh:mm:ss

2000-10-16 17:30:00

To Level

Double

-

No

-

0.000

Active Flag

String

-

No

-

Y

MEL Data :

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

“MEL”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

From Time

Date

-

No

yyyy-mm-dd hh:mm:ss

2000-10-16 17:30:00

From Level

Double

-

No

-

0.000

To Time

Date

-

No

yyyy-mm-dd hh:mm:ss

2000-10-16 17:30:00

To Level

Double

-

No

-

0.000

Active Flag

String

-

No

-

Y

MIL Data :

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

“MIL”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

From Time

Date

-

No

yyyy-mm-dd hh:mm:ss

2000-10-16 17:30:00

From Level

Double

-

No

-

0.000

To Time

Date

-

No

yyyy-mm-dd hh:mm:ss

2000-10-16 17:30:00

To Level

Double

-

No

-

0.000

Active Flag

String

-

No

-

Y

BOALF Data :

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

“BOALF”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Bid Offer Acceptance ID

Integer

-

No

-

2564812568

Acceptance Time

Date

-

No

-

2000-10-16 17:30:00

Deemed Flag

String

-

No

-

N

SO-Flag

String

-

No

-

F

STOR Provider Flag

String

-

No

-

RR Instruction Flag

String

-

No

-

F

RR Schedule Flag

String

-

No

-

F

From Time

Date

-

No

yyyy-mm-dd hh:mm:ss

2000-10-16 17:30:00

From Level

Double

-

No

-

0.000

To Time

Date

-

No

yyyy-mm-dd hh:mm:ss

2000-10-16 17:30:00

To Level

Double

-

No

-

0.000

Active Flag

String

-

No

-

Y

CSV Download service

FPN Data :

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

“PN”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

From Time

Date

-

No

yyyymmddhhmmss

20001016173000

From Level

Double

-

No

-

0.000

To Time

Date

-

No

yyyymmddhhmmss

20001016173000

To Level

Double

-

No

-

0.000

QPN data :

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

“QPN”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

From Time

Date

-

No

yyyymmddhhmmss

20001016173000

From Level

Double

-

No

-

0.000

To Time

Date

-

No

yyyymmddhhmmss

20001016173000

To Level

Double

-

No

-

0.000

MEL Data :

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

“MEL”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

From Time

Date

-

No

yyyymmddhhmmss

20001016173000

From Level

Double

-

No

-

0.000

To Time

Date

-

No

yyyymmddhhmmss

20001016173000

To Level

Double

-

No

-

0.000

MIL Data :

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

“MIL”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

From Time

Date

-

No

yyyymmddhhmmss

20001016173000

From Level

Double

-

No

-

0.000

To Time

Date

-

No

yyyymmddhhmmss

20001016173000

To Level

Double

-

No

-

0.000

BOALF Data :

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

“BOALF”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Bid Offer Acceptance ID

Integer

-

No

-

2564812568

Acceptance Time

Date

-

No

YYYYMMDDHHMMSS

20001016173000

Deemed Flag

String

-

No

-

N

SO-Flag

String

-

No

-

F

STOR Provider Flag

String

-

No

-

RR Instruction Flag

String

-

No

-

F

RR Schedule Flag

String

-

No

-

F

From Time

Date

-

No

yyyymmddhhmmss

20001016173000

From Level

Double

-

No

-

0.000

To Time

Date

-

No

yyyymmddhhmmss

20001016173000

To Level

Double

-

No

-

0.000

5.2.41 Dynamic Data

API service details for the flow is as follows

Service Name

dynamicDataService

Operation Name

dynamicDataImpl

Method

GET

Input URL

https://api.bmreports.com/BMRS/DYNBMDATA/<VersionNo>?APIKey=<APIKey>&SettlementDate=<SettlementDate>&SettlementPeriod=<SettlementPeriod>&BMUnitId=<BMUnitId>&BMUnitType=<BMUnitType>&LeadPartyName=<LeadPartyName>&NGCBMUnitName=<NGCBMUnitName>&ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Description

Default Sorting:

BM Unit ID

Settlement Period (ascending) (from body)

Time (ascending)

Input data flow : RURE,RDRE,RURI,NDZ,NTB,NTO,MZT,MNZT,SEL,SIL

Comments

Default Value (if none specified):

Settlement Date = {as per NRT criteria}

Settlement Period = {as per NRT criteria}

BM Unit Id = *

BM Unit Type = *

Lead Party Name = *

NGC BM Unit Name = *

(* implies all values)

API Web service – Request and Response format details:

API Webservice – Request –Dynamic Data

Logical Field Name

Field Type

Remarks

Mandatory

Format

Sample data

ApiKey

String

-

Yes

-

AP8DA23

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

String

-

No

1 to 50 or *

12

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Service Type

String

-

No

-

xml/XML/csv/CSV

API Webservice – Response - Dynamic Data

Header Record

Report Output Field Mapping

Condition

Record Type

Fixed string value “HDR”

File Type

Fixed string value “Dynamic Data”

Settlement Date

From input parameter

Settlement Period

From input parameter

Body Record:

RURE Data

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “RURE”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Time

Date

-

No

YYYY-MM-DD HH:MM

2014-02-03 14:00

Rate 1

Double

-

No

-

254.2

Elbow 2

Integer

-

No

-

2541

Rate 2

Double

-

No

-

245.0

Elbow 3

Integer

-

No

-

2456

Rate 3

Double

-

No

-

256.6

Active Flag

String

-

No

-

Y

RDRE Data

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “RDRE”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Time

Date

-

No

YYYY-MM-DD HH:MM

2014-02-03 14:00

Rate 1

Double

-

No

-

254.2

Elbow 2

Integer

-

No

-

2541

Rate 2

Double

-

No

-

245.0

Elbow 3

Integer

-

No

-

2456

Rate 3

Double

-

No

-

256.6

Active Flag

String

-

No

-

Y

RURI Data

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “RURI”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Time

Date

-

No

YYYY-MM-DD HH:MM

2014-02-03 14:00

Rate 1

Double

-

No

-

254.2

Elbow 2

Integer

-

No

-

2541

Rate 2

Double

-

No

-

245.0

Elbow 3

Integer

-

No

-

2456

Rate 3

Double

-

No

-

256.6

Active Flag

String

-

No

-

Y

RURE Data

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “RURE”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Time

Date

-

No

YYYY-MM-DD HH:MM

2014-02-03 14:00

Rate 1

Double

-

No

-

254.2

Elbow 2

Integer

-

No

-

2541

Rate 2

Double

-

No

-

245.0

Elbow 3

Integer

-

No

-

2456

Rate 3

Double

-

No

-

256.6

Active Flag

String

-

No

-

Y

NDZ Data

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “NDZ”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Time

Date

-

No

YYYY-MM-DD HH:MM

2014-03-03 13:00

Notice

Double

-

No

-

2.000

Active Flag

String

-

No

-

Y

NDB Data

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “NDB”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Time

Date

-

No

YYYY-MM-DD HH:MM

2014-03-03 13:00

Notice

Double

-

No

-

2.000

Active Flag

String

-

No

-

Y

NDO Data

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “NDO”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Time

Date

-

No

YYYY-MM-DD HH:MM

2014-03-03 13:00

Notice

Double

-

No

-

2.000

Active Flag

String

-

No

-

Y

MZT Data

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “MZT”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Time

Date

-

No

YYYY-MM-DD HH:MM

2014-03-03 13:00

Period

Double

-

No

-

240.000

Active Flag

String

-

No

-

Y

MNZT Data

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “MNZT”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Time

Date

-

No

YYYY-MM-DD HH:MM

2014-03-03 13:00

Period

Double

-

No

-

240.000

Active Flag

String

-

No

-

Y

SEL Data

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “SEL”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Time

Date

-

No

YYYY-MM-DD HH:MM

2014-03-03 13:00

Level

Double

-

No

-

240.000

Active Flag

String

-

No

-

Y

SIL Data

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “SIL”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Time

Date

-

No

YYYY-MM-DD HH:MM

2014-03-03 13:00

Level

Double

-

No

-

240.000

Active Flag

String

-

No

-

Y

MDV Data

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “MDV”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Time

Date

-

No

YYYY-MM-DD HH:MM

2014-03-03 13:00

Level

Double

-

No

-

240.000

Active Flag

String

-

No

-

Y

MDP Data

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “MDP”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Time

Date

-

No

YYYY-MM-DD HH:MM

2014-03-03 13:00

Period

Double

-

No

-

240.000

Active Flag

String

-

No

-

Y

CSV Download service

RURE Data

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

Fixed string value “RURE”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Time

Date

-

No

YYYYMMDDHHMMSS

20140303130025

Rate 1

Double

-

No

-

254.2

Elbow 2

Integer

-

No

-

2541

Rate 2

Double

-

No

-

245.0

Elbow 3

Integer

-

No

-

2456

Rate 3

Double

-

No

-

256.6

RDRE Data

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

Fixed string value “RDRE”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Time

Date

-

No

YYYYMMDDHHMMSS

20140303130025

Rate 1

Double

-

No

-

254.2

Elbow 2

Integer

-

No

-

2541

Rate 2

Double

-

No

-

245.0

Elbow 3

Integer

-

No

-

2456

Rate 3

Double

-

No

-

256.6

RURI Data

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

Fixed string value “RURI”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Time

Date

-

No

YYYYMMDDHHMMSS

20140303130025

Rate 1

Double

-

No

-

254.2

Elbow 2

Integer

-

No

-

2541

Rate 2

Double

-

No

-

245.0

Elbow 3

Integer

-

No

-

2456

Rate 3

Double

-

No

-

256.6

RURE Data

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

Fixed string value “RURE”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Time

Date

-

No

YYYYMMDDHHMMSS

20140303130025

Rate 1

Double

-

No

-

254.2

Elbow 2

Integer

-

No

-

2541

Rate 2

Double

-

No

-

245.0

Elbow 3

Integer

-

No

-

2456

Rate 3

Double

-

No

-

256.6

NDZ Data

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

Fixed string value “NDZ”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Time

Date

-

No

YYYYMMDDHHMMSS

20140303130025

Notice

Double

-

No

-

2.000

NDB Data

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

Fixed string value “NDB”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Time

Date

-

No

YYYYMMDDHHMMSS

20140303130025

Notice

Double

-

No

-

2.000

NDO Data

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

Fixed string value “NDO”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Time

Date

-

No

YYYYMMDDHHMMSS

20140303130025

Notice

Double

-

No

-

2.000

MZT Data

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

Fixed string value “MZT”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Time

Date

-

No

YYYYMMDDHHMMSS

20140303130025

Period

Double

-

No

-

240.000

MNZT Data

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

Fixed string value “MNZT”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Time

Date

-

No

YYYYMMDDHHMMSS

20140303130025

Period

Double

-

No

-

240.000

SEL Data

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

Fixed string value “SEL”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Time

Date

-

No

YYYYMMDDHHMMSS

20140303130025

Level

Double

-

No

-

240.000

SIL Data

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

Fixed string value “SIL”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Time

Date

-

No

YYYYMMDDHHMMSS

20140303130025

Level

Double

-

No

-

240.000

MDV Data

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

Fixed string value “MDV”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Time

Date

-

No

YYYYMMDDHHMMSS

20140303130025

Level

Double

-

No

-

240.000

MDP Data

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

Fixed string value “MDP”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Time

Date

-

No

YYYYMMDD HHMMSS

20140303130025

Period

Double

-

No

-

240.000

5.2.42 Derived BM Unit Data

API service details for the flow is as follows

Service Name

derivedBMUnitDataService

Operation Name

derivedBMUnitDataImpl

Method

GET

Input URL

https://api.bmreports.com/BMRS/DERBMDATA/<VersionNo>?APIKey=<APIKey>&SettlementDate=<SettlementDate>&SettlementPeriod=<SettlementPeriod>&BMUnitId=<BMUnitId>&BMUnitType=<BMUnitType>&LeadPartyName=<LeadPartyName>&NGCBMUnitName=<NGCBMUnitName>&ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Description

Default Sorting:

BM Unit ID

Settlement Period (ascending) (from body)

Acceptance ID (applicable only to Body Record Bid Acceptance Volumes and Body Record Offer Acceptance Volumes)

Input data flow : BOALF

Comments

Default Value (if none specified):

Settlement Date = {as per NRT criteria}

Settlement Period = {as per NRT criteria}

BM Unit Id = *

BM Unit Type = *

Lead Party Name = *

NGC BM Unit Name = *

(* implies all values)

API Web service – Request and Response format details:

API Webservice – Request –Derived BM Unit Data

Logical Field Name

Field Type

Remarks

Mandatory

Format

Sample data

ApiKey

String

-

Yes

-

AP8DA23

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

String

-

No

1 to 50 or *

12

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Service Type

String

-

No

-

xml/XML/csv/CSV

API Webservice – Response - Derived BM Unit Data

Header Record

Report Output Field Mapping

Condition

Record Type

Fixed string value “HDR”

File Type

Fixed string value “DERIVED DATA”

Settlement Date

From input parameter

Settlement Period

From input parameter

Body Records:

Bid Acceptance Volume

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “BAV”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Acceptance ID

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

Short Acceptance Flag

String

-

No

-

G, S, E, I, T, etc

RR Instruction Flag

String

-

No

-

F

Volume Accepted for Bid-Offer Pair -6

String

-

No

-

Volume Accepted for Bid-Offer Pair -5

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Volume Accepted for Bid-Offer Pair -4

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -3

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -2

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -1

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 1

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 2

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 3

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 4

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 5

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 6

String

-

No

-

-

Total

String

-

No

-

-

Active Flag

String

-

No

-

Y

Offer Acceptance Volume

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “OAV”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Acceptance ID

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

Short Acceptance Flag (a.k.a. Acceptance Duration)

String

-

No

-

G, S, E, I, T, etc

RR Instruction Flag

String

-

No

-

F

Volume Accepted for Bid-Offer Pair -6

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -5

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Volume Accepted for Bid-Offer Pair -4

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -3

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -2

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -1

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 1

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 2

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 3

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 4

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 5

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 6

String

-

No

-

-

Total

String

-

No

-

-

Active Flag

String

-

No

-

Y

Indicative Period Bid Acceptance Volumes

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “IPBAV”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Data Type

String

-

No

-

RR Instruction Flag

String

-

No

-

F

Volume Accepted for Bid-Offer Pair -6

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -5

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -4

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Volume Accepted for Bid-Offer Pair -3

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -2

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -1

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 1

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 2

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 3

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 4

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 5

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 6

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -6

String

-

No

-

-

Total

String

-

No

-

-

Active Flag

String

-

No

-

Y

Indicative Period Offer Acceptance Volumes

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “IPOAV”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Data Type

String

-

No

-

-

RR Instruction Flag

String

-

No

-

F

Volume Accepted for Bid-Offer Pair -6

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -5

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -4

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Volume Accepted for Bid-Offer Pair -3

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -2

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -1

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 1

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 2

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 3

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 4

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 5

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 6

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -6

String

-

No

-

-

Total

String

-

No

-

-

Active Flag

String

-

No

-

Y

Indicative Period Bid Cashflow

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “IPBC”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Data Type

String

-

No

-

-

Cashflow for Bid-Offer Pair -6

String

-

No

-

-

Cashflow for Bid-Offer Pair -5

String

-

No

-

-

Cashflow for Bid-Offer Pair -4

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Cashflow for Bid-Offer Pair -3

String

-

No

-

-

Cashflow for Bid-Offer Pair -2

String

-

No

-

-

Cashflow for Bid-Offer Pair -1

String

-

No

-

-

Cashflow for Bid-Offer Pair 1

String

-

No

-

-

Cashflow for Bid-Offer Pair 2

String

-

No

-

-

Cashflow for Bid-Offer Pair 3

String

-

No

-

-

Cashflow for Bid-Offer Pair 4

String

-

No

-

-

Cashflow for Bid-Offer Pair 5

String

-

No

-

-

Cashflow for Bid-Offer Pair 6

String

-

No

-

-

Cashflow for Bid-Offer Pair -6

String

-

No

-

-

Total

String

-

No

-

-

Active Flag

String

-

No

-

Y

Indicative Period Offer Cashflow

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “IPOC”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

9

Data Type

String

-

No

-

-

Cashflow for Bid-Offer Pair -6

String

-

No

-

-

Cashflow for Bid-Offer Pair -5

String

-

No

-

-

Cashflow for Bid-Offer Pair -4

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Cashflow for Bid-Offer Pair -3

String

-

No

-

-

Cashflow for Bid-Offer Pair -2

String

-

No

-

-

Cashflow for Bid-Offer Pair -1

String

-

No

-

-

Cashflow for Bid-Offer Pair 1

String

-

No

-

-

Cashflow for Bid-Offer Pair 2

String

-

No

-

-

Cashflow for Bid-Offer Pair 3

String

-

No

-

-

Cashflow for Bid-Offer Pair 4

String

-

No

-

-

Cashflow for Bid-Offer Pair 5

String

-

No

-

-

Cashflow for Bid-Offer Pair 6

String

-

No

-

-

Cashflow for Bid-Offer Pair -6

String

-

No

-

-

Total

String

-

No

-

-

Active Flag

String

-

No

-

Y

CSV Download service

Bid Acceptance Volume

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “BAV”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYYMMDD

20140201

Settlement Period

Integer

-

No

-

9

Acceptance ID

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

Short Acceptance Flag

String

-

No

-

G, S, E, I, T, etc

RR Instruction Flag

String

-

No

-

F

Volume Accepted for Bid-Offer Pair -6

String

-

No

-

Volume Accepted for Bid-Offer Pair -5

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Volume Accepted for Bid-Offer Pair -4

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -3

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -2

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -1

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 1

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 2

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 3

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 4

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 5

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 6

String

-

No

-

-

Total

String

-

No

-

-

Offer Acceptance Volume

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “OAV”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYYMMDD

20140201

Settlement Period

Integer

-

No

-

9

Acceptance ID

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

Short Acceptance Flag (a.k.a. Acceptance Duration)

String

-

No

-

G, S, E, I, T, etc

RR Instruction Flag

String

-

No

-

F

Volume Accepted for Bid-Offer Pair -6

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -5

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Volume Accepted for Bid-Offer Pair -4

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -3

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -2

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -1

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 1

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 2

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 3

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 4

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 5

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 6

String

-

No

-

-

Total

String

-

No

-

-

Indicative Period Bid Acceptance Volumes

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “IPBAV”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYYMMDD

20140201

Settlement Period

Integer

-

No

-

9

Data Type

String

-

No

-

RR Instruction Flag

String

-

No

-

F

Volume Accepted for Bid-Offer Pair -6

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -5

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -4

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Volume Accepted for Bid-Offer Pair -3

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -2

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -1

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 1

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 2

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 3

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 4

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 5

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 6

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -6

String

-

No

-

-

Total

String

-

No

-

-

Active Flag

String

-

No

-

Y

Indicative Period Offer Acceptance Volumes

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “IPOAV”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYYMMDD

20140201

Settlement Period

Integer

-

No

-

9

Data Type

String

-

No

-

-

RR Instruction Flag

String

-

No

-

F

Volume Accepted for Bid-Offer Pair -6

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -5

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -4

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Volume Accepted for Bid-Offer Pair -3

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -2

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -1

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 1

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 2

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 3

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 4

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 5

String

-

No

-

-

Volume Accepted for Bid-Offer Pair 6

String

-

No

-

-

Volume Accepted for Bid-Offer Pair -6

String

-

No

-

-

Total

String

-

No

-

-

Indicative Period Bid Cashflow

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “IPBC”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYYMMDD

20140201

Settlement Period

Integer

-

No

-

9

Data Type

String

-

No

-

-

Cashflow for Bid-Offer Pair -6

String

-

No

-

-

Cashflow for Bid-Offer Pair -5

String

-

No

-

-

Cashflow for Bid-Offer Pair -4

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Cashflow for Bid-Offer Pair -3

String

-

No

-

-

Cashflow for Bid-Offer Pair -2

String

-

No

-

-

Cashflow for Bid-Offer Pair -1

String

-

No

-

-

Cashflow for Bid-Offer Pair 1

String

-

No

-

-

Cashflow for Bid-Offer Pair 2

String

-

No

-

-

Cashflow for Bid-Offer Pair 3

String

-

No

-

-

Cashflow for Bid-Offer Pair 4

String

-

No

-

-

Cashflow for Bid-Offer Pair 5

String

-

No

-

-

Cashflow for Bid-Offer Pair 6

String

-

No

-

-

Cashflow for Bid-Offer Pair -6

String

-

No

-

-

Total

String

-

No

-

-

Indicative Period Offer Cashflow

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “IPOC”

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Settlement Date

String

-

No

YYYYMMDD

20140201

Settlement Period

Integer

-

No

-

9

Data Type

String

-

No

-

-

Cashflow for Bid-Offer Pair -6

String

-

No

-

-

Cashflow for Bid-Offer Pair -5

String

-

No

-

-

Cashflow for Bid-Offer Pair -4

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Cashflow for Bid-Offer Pair -3

String

-

No

-

-

Cashflow for Bid-Offer Pair -2

String

-

No

-

-

Cashflow for Bid-Offer Pair -1

String

-

No

-

-

Cashflow for Bid-Offer Pair 1

String

-

No

-

-

Cashflow for Bid-Offer Pair 2

String

-

No

-

-

Cashflow for Bid-Offer Pair 3

String

-

No

-

-

Cashflow for Bid-Offer Pair 4

String

-

No

-

-

Cashflow for Bid-Offer Pair 5

String

-

No

-

-

Cashflow for Bid-Offer Pair 6

String

-

No

-

-

Cashflow for Bid-Offer Pair -6

String

-

No

-

-

Total

String

-

No

-

-

5.2.43 Derived System Wide Data

API service details for the flow is as follows

Service Name

derivedSystemWideDataService

Operation Name

derivedSystemWideDataImpl

Method

GET

Input URL

https://api.bmreports.com/BMRS/DERSYSDATA/<VersionNo>?APIKey=<APIKey>&FromSettlementDate=<FromSettlementDate>&ToSettlementDate=<ToSettlementDate>&SettlementPeriod=<SettlementPeriod>&ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Description

Default Sorting:

Settlement Date (Ascending)

Settlement Period (Ascending)

Input data flow : Derived

Comments

Default Value (if none specified):

From Settlement Date = Current System Date -1(i.e. Yesterday)

To Date = Current System Date (i.e Today)

Settlement Period = *

(* implies all values)

API Web service – Request and Response format details:

API Webservice – Request – Derived System-wide Data

Logical Field Name

Field Type

Remarks

Mandatory

Format

Sample data

ApiKey

String

-

Yes

-

AP8DA23

From Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

To Settlement Date

String

-

No

YYYY-MM-DD

2014-03-01

Settlement Period

String

-

No

1 to 50 or *

12

Service Type

String

-

No

-

xml/XML/csv/CSV

API Webservice – Response - Derived System-wide Data

Header Record:

Report Output Field Mapping

Condition

Record Type

Fixed string value “HDR”

File Type

Fixed string value “SYSTEM BUY SELL DATA”

Body Record:

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “SSB”

Settlement Date

Date

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

1 to 50 or *

1

System Sell Price

(SSP in £/MWh)

Double

-

No

-

31.60000

System Buy Price

(SBP in £/MWh)

Double

-

No

-

38.66000

BSAD Default

String

-

No

-

F

Price Derivation Code (PDC)

String

-

No

-

F

Reserve Scarcity Price

Double

No

-

15.03210

Indicative Net Imbalance Volume (NIV)

Double

-

No

-

294.983

Sell-Price Price Adjustment (SPA)

Double

-

No

-

0.00

Buy-Price Price Adjustment (BPA)

Double

-

No

-

5.50

Replacement Price (RP in £/MWh )

Double

-

No

-

294.983

Replacement Price Calculation Volume (RPRV in MWh)

Double

-

No

-

294.983

Total System Accepted Offer Volume

Double

-

No

-

294.983

Total System Accepted Bid Volume

Double

-

No

-

294.983

Total System Tagged Accepted Offer Volume

Double

-

No

-

294.983

Total System Tagged Accepted Bid Volume

Double

-

No

-

294.983

System Total Priced Accepted Offer Volume

Double

-

No

-

294.983

System Total Priced Accepted Bid Volume

Double

-

No

-

294.983

Total System Adjustment Sell Volume

Double

-

No

-

294.983

Total System Adjustment Buy Volume

Double

-

No

-

294.983

Total System Tagged Adjustment Sell Volume

Double

-

No

-

294.983

Total System Tagged Adjustment Buy Volume

Double

-

No

-

294.983

CSV Download Service

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

Fixed string value “SSB”

Settlement Date

Date

-

No

YYYYMMDD

20140201

Settlement Period

Integer

-

No

1 to 50 or *

1

System Sell Price

(SSP in £/MWh)

Double

-

No

-

31.60000

System Buy Price

(SBP in £/MWh)

Double

-

No

-

38.66000

BSAD Default

String

-

No

-

F

Price Derivation Code (PDC)

String

-

No

-

F

Reserve Scarcity Price

Double

No

-

15.03210

Indicative Net Imbalance Volume (NIV)

Double

-

No

-

294.983

Replacement Price (RP in £/MWh )

Double

-

No

-

294.983

Replacement Price Calculation Volume (RPRV in MWh)

Double

-

No

-

294.983

Total System Accepted Offer Volume

Double

-

No

-

294.983

Total System Accepted Bid Volume

Double

-

No

-

294.983

Total System Tagged Accepted Offer Volume

Double

-

No

-

294.983

Total System Tagged Accepted Bid Volume

Double

-

No

-

294.983

System Total Priced Accepted Offer Volume

Double

-

No

-

294.983

System Total Priced Accepted Bid Volume

Double

-

No

-

294.983

Total System Adjustment Sell Volume

Double

-

No

-

294.983

Total System Adjustment Buy Volume

Double

-

No

-

294.983

Total System Tagged Adjustment Sell Volume

Double

-

No

-

294.983

Total System Tagged Adjustment Buy Volume

Double

-

No

-

294.983

5.2.44 Detailed System Prices

API service details for the flow is as follows

Service Name

detailedSystemPricesService

Operation Name

detailedSystemPricesImpl

Method

GET

Input URL

https://api.bmreports.com/BMRS/DETSYSPRICES/<VersionNo>?APIKey=<APIKey>&SettlementDate=<SettlementDate>&SettlementPeriod=<SettlementPeriod>&ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Description

Default Sorting: Settlement Date (Ascending), Settlement Period (Ascending), Index (Ascending), and Component Identifier (Alphabetically sorted).

Input data flow : Derived

Comments

Default Value (if none specified):

From Settlement Date = Current System Date

Settlement Period = Current Settlement Period

Note that NO wildcard (*) allowed for Settlement Period.

API Web service – Request and Response format details:

API Webservice – Request –Detailed System Prices

Logical Field Name

Field Type

Remarks

Mandatory

Format

Sample data

ApiKey

String

-

Yes

-

AP8DA23

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

String

-

No

-

2

Service Type

String

-

No

-

xml/XML/csv/CSV

API Webservice – Response – Detailed System Prices

Header Record:

Report Output Field Mapping

Condition

Record Type

Fixed string value “HDR”

File Type

Fixed string value “INDICATIVE SYSTEM PRICE STACK DATA”

Body Record:

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

System Price Calculation Summary

Record Type

String

-

No

-

Fixed as “MAIN PRICE SUMMARY”

Settlement Date

Date

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

2

Cost

Double

-

No

-

1555.66

Volume

Double

-

No

-

39.097

Adjuster

Double

-

No

-

0.00

Value

Double

-

No

-

39.78979

Type

String

-

No

-

SBP

Record Type

String

-

No

-

Fixed as “MARKET PRICE SUMMARY”

Settlement Date

Date

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

2

Cost

Double

-

No

-

1555.66

Volume

Double

-

No

-

39.097

Value

Double

-

No

-

39.78979

Type

String

-

No

-

SBP

Price Derivation Code

String

-

No

-

B

Indicative System Price Offer Stack Data

Record Type

String

-

No

-

Fixed String “OFFER”

Settlement Date

Date

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

2

Index (Sequence number)

Integer

-

No

-

12

ID (Component Identifier)

String

-

No

-

T_DINO-5

Acceptance ID

String

-

No

-

58932

Bid Offer Pair ID

String

-

No

-

11

CADL Flag

String

-

No

-

T

SO Flag

String

-

No

-

F

STOR Provider Flag

String

-

No

-

F

Repriced Indicator

String

-

No

-

F

Bid Offer Original Price

Double

-

No

-

160.00000

Reserve Scarcity Price

Double

-

No

-

120.25

OfferVolume (Stack Item Original Volume)

Double

-

No

-

30.000

DMAT Adjusted Volume

Double

-

No

-

30.000

Arbitrage Adjusted Volume

Double

-

No

-

30.000

NIV Adjusted Volume

Double

-

No

-

0.000

PAR Adjusted Volume

Double

-

No

-

0.000

(Stack Item) Final Price

Double

-

No

-

0.00000

Transmission Loss Multiplier (TLM)

Double

-

No

-

0.0000000

TLM Adjusted Volume (QAPO * TLM)

Double

-

No

-

0.000

TLM Adjusted Cost (QAPO * PO * TLM)

Double

-

No

-

0.00

Totals

TOTAL of TLM Adjusted Volume

Double

-

No

-

39.097

TOTAL of TLM Adjusted Cost

Double

-

No

-

1555.66

Indicative System Price Bid Stack Data

Record Type

String

-

No

-

Fixed String “BID”

Settlement Date

Date

-

No

YYYY-MM-DD

2014-02-01

Settlement Period

Integer

-

No

-

2

Index (Sequence number)

Integer

-

No

-

8

ID (Component Identifier)

String

-

No

-

T_RUGPS-6

Acceptance ID

String

-

No

-

109766

Bid Offer Pair ID

String

-

No

-

-1

CADL Flag

String

-

No

-

F

SO Flag

String

-

No

-

F

STOR Provider Flag

String

-

No

-

F

Repriced Indicator

String

-

No

-

F

Bid Price (Stack Item Original Price)

Double

-

No

-

30.01000

Reserve Scarcity Price

Double

-

No

-

120.25

Bid Volume (Stack Item Original Volume)

Double

-

No

-

-4.083

DMAT Adjusted Volume

Double

-

No

-

-4.083

Arbitrage Adjusted Volume

Double

-

No

-

-4.083

NIV Adjusted Volume

Double

-

No

-

0.000

PAR Adjusted Volume

Double

-

No

-

0.000

(Stack Item) Final Price

Double

-

No

-

0.00000

Transmission Loss Multiplier (TLM)

Double

-

No

-

0.0000000

TLM Adjusted Volume (QAPB * TLM)

Double

-

No

-

0.000

TLM Adjusted Cost (QAPB * PB * TLM)

Double

-

No

-

0.00

Totals

TOTAL of TLM Adjusted Volume

Double

-

No

-

39.097

TOTAL of TLM Adjusted Cost

Double

-

No

-

1555.66

CSV Download service

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

System Price Calculation Summary

Record Type

String

-

No

-

Fixed as “MAIN PRICE SUMMARY”

Settlement Date

Date

-

No

YYYYMMDD

20150210

Settlement Period

Integer

-

No

-

2

Cost

Double

-

No

-

1555.66

Volume

Double

-

No

-

39.097

Adjuster

Double

-

No

-

0.00

Value

Double

-

No

-

39.78979

Type

String

-

No

-

SBP

Record Type

String

-

No

-

Fixed as “MARKET PRICE SUMMARY”

Settlement Date

Date

-

No

YYYYMMDD

20150210

Settlement Period

Integer

-

No

-

2

Cost

Double

-

No

-

1555.66

Volume

Double

-

No

-

39.097

Adjuster

Double

-

No

-

0.00

Value

Double

-

No

-

39.78979

Type

String

-

No

-

SBP

Price Derivation Code

String

-

No

-

B

Indicative System Price Offer Stack Data

Record Type

String

-

No

-

Fixed String “OFFER”

Settlement Date

Date

-

No

YYYYMMDD

20150210

Settlement Period

Integer

-

No

-

2

Index (Sequence number)

Integer

-

No

-

12

ID (Component Identifier)

String

-

No

-

T_DINO-5

Acceptance ID

String

-

No

-

58932

Bid Offer Pair ID

String

-

No

-

11

CADL Flag

String

-

No

-

T

SO Flag

String

-

No

-

F

STOR Provider Flag

String

-

No

-

F

Repriced Indicator

String

-

No

-

F

Bid Offer Original Price

Double

-

No

-

160.00000

Reserve Scarcity Price

Double

-

No

-

120.25

OfferVolume (Stack Item Original Volume)

Double

-

No

-

30.000

DMAT Adjusted Volume

Double

-

No

-

30.000

Arbitrage Adjusted Volume

Double

-

No

-

30.000

NIV Adjusted Volume

Double

-

No

-

0.000

PAR Adjusted Volume

Double

-

No

-

0.000

(Stack Item) Final Price

Double

-

No

-

0.00000

Transmission Loss Multiplier (TLM)

Double

-

No

-

0.0000000

TLM Adjusted Volume (QAPO * TLM)

Double

-

No

-

0.000

TLM Adjusted Cost (QAPO * PO * TLM)

Double

-

No

-

0.00

Totals

TOTAL of TLM Adjusted Volume

Double

-

No

-

39.097

TOTAL of TLM Adjusted Cost

Double

-

No

-

1555.66

Indicative System Price Bid Stack Data

Record Type

String

-

No

-

Fixed String “BID”

Settlement Date

Date

-

No

YYYYMMDD

20150210

Settlement Period

Integer

-

No

-

2

Index (Sequence number)

Integer

-

No

-

8

ID (Component Identifier)

String

-

No

-

T_RUGPS-6

Acceptance ID

String

-

No

-

109766

Bid Offer Pair ID

String

-

No

-

-1

CADL Flag

String

-

No

-

F

SO Flag

String

-

No

-

F

STOR Provider Flag

String

-

No

-

F

Repriced Indicator

String

-

No

-

F

Bid Price (Stack Item Original Price)

Double

-

No

-

30.01000

Reserve Scarcity Price

Double

-

No

-

120.25

Bid Volume (Stack Item Original Volume)

Double

-

No

-

-4.083

DMAT Adjusted Volume

Double

-

No

-

-4.083

Arbitrage Adjusted Volume

Double

-

No

-

-4.083

NIV Adjusted Volume

Double

-

No

-

0.000

PAR Adjusted Volume

Double

-

No

-

0.000

(Stack Item) Final Price

Double

-

No

-

0.00000

Transmission Loss Multiplier (TLM)

Double

-

No

-

0.0000000

TLM Adjusted Volume (QAPB * TLM)

Double

-

No

-

0.000

TLM Adjusted Cost (QAPB * PB * TLM)

Double

-

No

-

0.00

Totals

TOTAL of TLM Adjusted Volume

Double

-

No

-

39.097

TOTAL of TLM Adjusted Cost

Double

-

No

-

1555.66

5.2.45 Market Depth Data

API service details for the flow is as follows

Service Name

marketDepthDataService

Operation Name

marketDepthDataImpl

Method

GET

Input URL

https://api.bmreports.com/BMRS/MKTDEPTHDATA/<VersionNo>?APIKey=<APIKey>&SettlementDate=<SettlementDate>&ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Description

Default Sorting: Settlement Date (ascending)

Settlement Period (ascending)

Input data flow : IMBALNGC

Comments

Default Value (if none specified): Return all rows From Settlement Date = Current System Date -1(i.e. Yesterday)

API Web service – Request and Response format details:

API Webservice – Request –Market Depth Data

Logical Field Name

Field Type

Remarks

Mandatory

Format

Sample data

ApiKey

String

-

Yes

-

AP8DA23

Settlement Date

String

-

No

YYYY-MM-DD

2014-02-01

Service Type

String

-

No

-

xml/XML/csv/CSV

API Webservice – Response – Market Depth Data

Header Record:

Report Output Field Mapping

Condition

Record Type

Fixed string value “HDR”

File Type

Fixed string value “MARKET DEPTH DATA”

Body Record:

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “MDD”

Settlement Date

Date

-

No

YYYY-MM-DD

2015-01-26

Settlement Period

Integer

-

No

-

2

IMBALNGC

Double

-

No

-

80.000

Total Offer Volume

Double

-

No

-

48515.000

Total Bid Volume

Double

-

No

-

-57826.000

Total Accepted Offer Volume

Double

-

No

-

1079.542

Total Accepted Bid Volume

Double

-

No

-

-1028.994

Total Unpriced Accepted Offer Volume

Double

-

No

-

0.000

Total Unpriced Accepted Bid Volume

Double

-

No

-

0.000

Total Priced Accepted Offer Volume

Double

-

No

-

815.462

Total Priced Accepted Bid Volume

Double

-

No

-

-1062.853

Active Flag

String

-

No

-

Y

CSV Download service

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

Fixed string value “MDD”

Settlement Date

Date

-

No

YYYYMMDD

20150126

Settlement Period

Integer

-

No

-

2

IMBALNGC

Double

-

No

-

80.000

Total Offer Volume

Double

-

No

-

48515.000

Total Bid Volume

Double

-

No

-

-57826.000

Total Accepted Offer Volume

Double

-

No

-

1079.542

Total Accepted Bid Volume

Double

-

No

-

-1028.994

Total Unpriced Accepted Offer Volume

Double

-

No

-

0.000

Total Unpriced Accepted Bid Volume

Double

-

No

-

0.000

Total Priced Accepted Offer Volume

Double

-

No

-

815.462

Total Priced Accepted Bid Volume

Double

-

No

-

-1062.853

5.2.46 Latest Acceptances

API service details for the flow is as follows

Service Name

latestAcceptancesService

Operation Name

latestAcceptancesImpl

Method

GET

Input URL

https://api.bmreports.com/BMRS/LATESTACCEPTS/<VersionNo>?APIKey=<APIKey>&ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Description

Default Sorting: Acceptance Time (descending)

From Time (ascending)

Input data flow : BOALF

Comments

-

API Web service – Request and Response format details:

API Webservice – Request –Latest Acceptances

Logical Field Name

Field Type

Remarks

Mandatory

Format

Sample data

ApiKey

String

-

Yes

-

AP8DA23

Service Type

String

-

No

-

xml/XML/csv/CSV

API Webservice – Response – Latest Acceptances

Header Record:

Report Output Field Mapping

Condition

Record Type

Fixed string value “HDR”

File Type

Fixed string value “LATEST ACCEPTANCE DATA”

Body Record:

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “LAD”

BM Unit Id

String

-

No

-

T_FFES-4

Acceptance Number

Integer

-

No

-

2558965231

Acceptance Time

Date

-

No

YYYY-MM-DD HH:MM

2015-01-26 00:47

From Time

Date

-

No

YYYY-MM-DD HH:MM

2015-01-26 23:47

Active Flag

String

-

No

-

Y

CSV Download service

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

Fixed string value “LAD”

BM Unit Id

String

-

No

-

T_STAY-2

Acceptance Number

Integer

-

No

-

2558965231

Acceptance Time

Date

-

No

yyyymmddhhmmss

20150126004700

From Time

Date

-

No

YYYYMMDDHHMMSS

20150126004700

5.2.47 Historic Acceptances

API service details for the flow is as follows

Service Name

historicAcceptancesService

Operation Name

historicAcceptancesImpl

Method

GET

Input URL

https://api.bmreports.com/BMRS/HISTACCEPTS/<VersionNo>?APIKey=<APIKey>&SettlementDate=<SettlementDate>&SettlementPeriod=<SettlementPeriod>&ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Description

Default Sorting: Acceptance Time (ascending)

Input data flow : BOALF

Comments

Default Value (if none specified):

From Settlement Date = Current System Date

Settlement Period = Current Settlement Period

API Web service – Request and Response format details:

API Webservice – Request –Historic Acceptances

Logical Field Name

Field Type

Remarks

Mandatory

Format

Sample data

ApiKey

String

-

Yes

-

AP8DA23

Settlement Date

String

-

No

YYYY-MM-DD

2014-12-31

Settlement Period

String

-

No

1 to 50

2

Service Type

String

-

No

-

xml/XML/csv/CSV

API Webservice – Response – Historic Acceptances

Header Record:

Report Output Field Mapping

Condition

Record Type

Fixed string value “HDR”

File Type

Fixed string value “ACCEPTANCE DATA”

Settlement Date

From input parameter

Settlement Period

number between 1 and 50 or * if selecting a full day’s data (from input parameter)

Body Record:

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “HAD”

BM Unit Id

String

-

No

-

T_STAY-2

Acceptance Number

Integer

-

No

-

2558965231

Acceptance Time

Date

-

No

YYYY-MM-DD HH:MM

2015-01-26 00:47

Offer Price

Double

-

No

-

58.00000

Bid Price

Double

-

No

-

35.00000

Active Flag

String

-

No

-

Y

CSV Download service

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

Fixed string value “HAD”

BM Unit Id

String

-

No

-

T_STAY-2

Acceptance Number

Integer

-

No

-

2558965231

Acceptance Time

Date

-

No

yyyymmddhhmmss

20150126004700

Offer Price

Double

-

No

-

58.00000

Bid Price

Double

-

No

-

35.00000

NOTE:

    • Note that NO wildcard (*) allowed for Settlement Period.

5.2.48 System Messages

API service details for the flow is as follows

Service Name

systemMessagesService

Operation Name

systemMessagesImpl

Method

GET

Input URL

https://api.bmreports.com/BMRS/SYSMSG/<VersionNo>?APIKey=<APIKey>& ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Description

Default Sorting: Acceptance Time (descending)

Input data flow : NA

Source

MySQL

Destination

Third party software

Data Source

Reporting Database

Database Table Name

T_BMRS_SYS_MSGS

Comments

-

API Web service – Request and Response format details:

API Webservice – Request –System Messages

Logical Field Name

Field Type

Remarks

Mandatory

Format

Sample data

ApiKey

String

-

Yes

-

AP8DA23

Service Type

String

-

No

-

xml/XML/csv/CSV

API Webservice – Response – System Messages

Header Record:

Report Output Field Mapping

Condition

Record Type

Fixed string value “HDR”

File Type

Fixed string value “SYSTEM MESSAGES”

Body Record:

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “SYSMSG””

Message Date Time

Date

-

No

YYYY-MM-DD HH:MM

2015-02-25 07:21

Message Type

String

-

No

-

MIDNP

Message Text

String

-

No

-

Market Index Data for Settlement Day 20150225 period 14 from Automated Power Exchange (UK) (APXMIDP) was not received. Price and volume defaulted to 0.

Active Flag

String

-

No

-

Y

CSV Download Service

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

Fixed string value “SYSMSG””

Message Date Time

Date

-

No

YYYYMMDDHHMMSS

20150126004700

Message Type

String

-

No

-

MIDNP

Message Text

String

-

No

-

Market Index Data for Settlement Day 20150225 period 14 from Automated Power Exchange (UK) (APXMIDP) was not received. Price and volume defaulted to 0.

5.2.49 BM Unit Search

API service details for the flow is as follows

Service Name

bmUnitSearchService

Operation Name

bmUnitSearchImpl

Method

GET

Input URL

https://api.bmreports.com/BMRS/BMUNITSEARCH/<VersionNo>?APIKey=<APIKey>&BmUnitId=<BmUnitId>&BmUnitType=<BmUnitType>&LeadPartyName=<LeadPartyName>&NgcBmUnitName=<NgcBmUnitName>&ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Description

Default Sorting: BM Unit ID

Source

MySQL

Destination

Third party software

Data Source

Reporting Database

Database Table Name

T_BMRS_BM_UNT_SRCH

Comments

Default Value (if none specified):

BM Unit Id = *

BM Unit Type = *

Lead Party Name = *

NGC BM Unit Name = *

(* implies all values)

API Web service – Request and Response format details:

API Webservice – Request –BM Unit Search

Logical Field Name

Field Type

Remarks

Mandatory

Format

Sample data

ApiKey

String

-

Yes

-

AP8DA23

BM Unit Id

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Service Type

String

-

No

-

xml/XML/csv/CSV

API Webservice – Response –BM Unit Search

Header Record:

Report Output Field Mapping

Condition

Record Type

Fixed string value “HDR”

File Type

Fixed string value “BM UNIT DATA”

Body Record:

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “BMUD”

BM Unit ID

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

Active Flag

String

-

No

-

Y

CSV Download Service

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

Fixed string value “BMUD”

BM Unit ID

String

-

No

-

2__AEENG000, G, E.ON Energy Solutions Limited, EAS-EST01

BM Unit Type

String

-

No

-

G, S, E, I, T, etc

Lead Party Name

String

-

No

-

AES New Energy Limited

NGC BM Unit Name

String

-

No

-

EAS-ASP01, AES New Energy Limited, G, 2__AAEPD000

5.2.50 System Warning (Today/Tomorrow)

API service details for the flow is as follows

Service Name

systemWarningTodayTomorrowService

Operation Name

systemWarningTodayTomorrowImpl

Method

GET

Input URL

https://api.bmreports.com/BMRS/SYSWARNTDYTOM<VersionNo>?APIKey=<APIKey&ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Description

Default Sorting: Times applicable (descending); separately for TODAY and TOMORROW

Input data flow : System Warning flow from NGC

Source

MySQL

Comments

-

API Web service – Request and Response format details:

API Webservice – Request –System Warning (Today/Tomorrow)

Logical Field Name

Field Type

Remarks

Mandatory

Format

Sample data

ApiKey

String

-

Yes

-

AP8DA23

Service Type

String

-

No

-

xml/XML/csv/CSV

API Webservice – Response – System Warning (Today/Tomorrow)

Header Record:

Report Output Field Mapping

Condition

Record Type

Fixed string value “HDR”

File Type

Fixed string value “SYSTEM WARNINGS IN FORCE”

Body Record:

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

System warnings in force TODAY

Record Type

String

-

No

-

Fixed string value “SYSWARNTDY ”

Today

Date

-

No

YYYY-MM-DD

2008-07-02

Warning in Force

String

-

No

-

TDY

Times applicable

String

-

No

-

NONE

Active Flag

String

-

No

-

Y

System warnings in force TOMORROW

Record Type

String

-

No

-

Fixed string value “SYSWARNTOM”

Today

Date

-

No

YYYY-MM-DD

2008-07-02

Warning in Force

String

-

No

-

TDY

Times applicable

String

-

No

-

NONE

Active Flag

String

-

No

-

Y

CSV Download Service

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

System warnings in force TODAY

Record Type

String

-

No

-

Fixed string value “SYSWARNTDY ”

Today

Date

-

No

YYYYMMDD

20080702

Warning in Force

String

-

No

-

TDY

Times applicable

String

-

No

-

NONE

System warnings in force TOMORROW

Record Type

String

-

No

-

Fixed string value “SYSWARNTOM”

Today

Date

-

No

YYYYMMDD

20080702

Warning in Force

String

-

No

-

TOM

Times applicable

String

-

No

-

NONE

5.2.51 System Warning (Historic)

API service details for the flow is as follows

Service Name

systemWarningHistoricService

Operation Name

systemWarningHistoricImpl

Method

GET

Input URL

https://api.bmreports.com/BMRS/HISTSYSWARN/<VersionNo>?APIKey=<APIKey&ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Description

Default Sorting : Times applicable (descending) Warning Date Time;

Input data flow : System Warning flow from NGC

Source

MySQL

Comments

-

API Web service – Request and Response format details:

API Webservice – Request –System Warning (Historic)

Logical Field Name

Field Type

Remarks

Mandatory

Format

Sample data

ApiKey

String

-

Yes

-

AP8DA23

Service Type

String

-

No

-

xml/XML/csv/CSV

API Webservice – Response – System Warning (Historic)

Header Record:

Report Output Field Mapping

Condition

Record Type

Fixed string value “HDR”

File Type

Fixed string value “SYSTEM WARNING - HISTORIC”

Body Record:

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “SYSWARNHIST”

Warning Type

String

-

No

-

-

Effective From

Date

-

No

-

-

Time Effective From

Date

-

No

-

-

Shortfall (MW)

Double

-

No

-

-

Date Warning Cancelled

Date

-

No

-

-

Time Warning Cancelled

Date

-

No

-

-

Active Flag

String

-

No

-

Y

CSV Download Service

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

Fixed string value “SYSWARNHIST”

Warning Type

String

-

No

-

-

Effective From

Date

-

No

-

-

Time Effective From

Date

-

No

-

-

Time Effective To

Date

-

No

-

-

Shortfall (MW)

Double

-

No

-

-

Date Warning Cancelled

Date

-

No

-

-

Time Warning Cancelled

Date

-

No

-

-

Active Flag

String

-

No

-

Y

5.2.52 Loss of Load Probability

API service details for the flow is as follows

Service Name

lossOfLoadProbabilityService

Operation Name

lossOfLoadProbabilityImpl

Method

GET

Input URL

https://api.bmreports.com/BMRS/LOLPDRM/<VersionNo>?APIKey=<APIKey>&FromSettlementDate=<FromSettlementDate>&ToSettlementDate=<ToSettlementDate>&ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Description

Default Sorting :

1. Settlement Date (ascending)

2. Settlement Period (ascending)

Source

MySQL

Comments

Default Value (if none specified; this is the today/tomorrow web page case):

From Settlement Date = Current System Date

To Settlement Date = Current System Date + 2

API Web service – Request and Response format details:

API Webservice – Request – Loss of Load Probability

Logical Field Name

Field Type

Remarks

Mandatory

Format

Sample data

ApiKey

String

-

Yes

-

AP8DA23

From Settlement Date

String

-

No

YYYY-MM-DD

2014-12-30

To Settlement Date

String

-

No

YYYY-MM-DD

2014-12-31

Service Type

String

-

No

-

Xml/XML/csv/CSV

API Webservice – Response – Loss of Load Probability

Header Record:

Report Output Field Mapping

Condition

Record Type

Fixed string value “HDR”

File Type

Fixed string value “LOLP”

Body Record:

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “LOLPDRM”

Settlement Date

Date

-

No

YYYY-MM-DD

2014-12-31

Settlement Period

Integer

-

No

-

2

LOLP_1200

Double

-

No

-

0.977100

DRM_1200

Double

-

No

-

0.10000

LOLP_8h

Double

-

No

-

0.978500

DRM_8h

Double

-

No

-

0.24000

LOLP_4h

Double

-

No

-

0.981600

DRM_4h

Double

-

No

-

0.18000

LOLP_2h

Double

-

No

-

0.981200

DRM_2h

Double

-

No

-

0.14000

LOLP_1h

Double

-

No

-

0.981000

DRM_1h

Double

-

No

-

0.12000

Active Flag

String

-

No

-

Y

CSV Download service

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

Fixed string value “LOLPDRM”

Settlement Date

Date

-

No

YYYYMMDD

20141231

Settlement Period

Integer

-

No

-

2

LOLP_1200

Double

-

No

-

0.977100

DRM_1200

Double

-

No

-

0.10000

LOLP_8h

Double

-

No

-

0.978500

DRM_8h

Double

-

No

-

0.24000

LOLP_4h

Double

-

No

-

0.981600

DRM_4h

Double

-

No

-

0.18000

LOLP_2h

Double

-

No

-

0.981200

DRM_2h

Double

-

No

-

0.14000

LOLP_1h

Double

-

No

-

0.981000

DRM_1h

Double

-

No

-

0.12000

5.2.53 Demand Control Instructions

API service details for the flow is as follows

Service Name

demandControlInstructionService

Operation Name

demandControlInstructionImpl

Method

GET

Input URL

https://api.bmreports.com/BMRS/DEMCI/<VersionNo>?APIKey=<APIKey>&FromSettlementDate=<FromSettlementDate>&ToSettlementDate=<ToSettlementDate>&ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Description

Default Sorting :

1. Demand Control ID (ascending)

2. Instruction Sequence (ascending)

Source

MySQL

Comments

Default Value (if none specified; this is the today/tomorrow web page case):

From Settlement Date = Current System Date

To Settlement Date = Current System Date + 1

API Web service – Request and Response format details:

API Webservice – Request – Demand Control Instruction

Logical Field Name

Field Type

Remarks

Mandatory

Format

Sample data

ApiKey

String

-

Yes

-

AP8DA23

From Settlement Date

String

-

No

YYYY-MM-DD

2014-12-30

To Settlement Date

String

-

No

YYYY-MM-DD

2014-12-31

Service Type

String

-

No

-

Xml/XML/csv/CSV

API Webservice – Response – Demand Control Instruction

Header Record:

Report Output Field Mapping

Condition

Record Type

Fixed string value “HDR”

File Type

Fixed string value “DCONTROL”

Body Record:

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “DEMCI”

Demand Control ID

String

-

No

-

DCID1

Affected DSO

Integer

-

No

-

1

Instruction Sequence

String

-

No

-

SPOW

Demand Control Event Flag

String

-

No

-

L

Time From

Date

-

No

YYYY-MM-DD HH:MM

2014-12-31 10:00

Time To

Date

-

No

YYYY-MM-DD HH:MM

2014-12-31 10:00

Demand Control Level

Double

-

No

-

10.00000

SO-Flag

String

-

No

-

F

Active Flag

String

-

No

-

Y

CSV Download Service

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

Fixed string value “DEMCI”

Demand Control ID

String

-

No

-

DCID1

Affected DSO

Integer

-

No

-

1

Instruction Sequence

String

-

No

-

SPOW

Demand Control Event Flag

String

-

No

-

L

Time From

Date

-

No

YYYYMMDDHHMM

201412311000

Time To

Date

-

No

YYYYMMDDHHMM

201412311000

Demand Control Level

Double

-

No

-

10.00000

SO-Flag

String

-

No

-

F

5.2.54 STOR Availability Window

API service details for the flow is as follows

Service Name

storAvailabilityWindowService

Operation Name

storAvailabilityWindowImpl

Method

GET

Input URL

https://api.bmreports.com/BMRS/STORAW/<VersionNo>?APIKey=<APIKey>&FromSettlementDate=<SettlementDate>&ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Description

Default Sorting :

1. STOR Availability From Date (ascending)

Source

MySQL

Comments

Default Value (if none specified; this is the current web page case):

From Settlement Date = Current System Date

API Web service – Request and Response format details:

API Webservice – Request – STOR Availability Window

Logical Field Name

Field Type

Remarks

Mandatory

Format

Sample data

ApiKey

String

-

Yes

-

AP8DA23

FromSettlementDate

String

-

No

YYYY-MM-DD

2014-12-31

Service Type

String

-

No

-

Xml/XML/csv/CSV

API Webservice – Response – STOR Availability Window

Header Record:

Report Output Field Mapping

Condition

Record Type

Fixed string value “HDR”

File Type

Fixed string value “STORAW DATA”

Body Record:

Logical Field Name

Field Type

Remarks

Mandatory

XML Format

Sample data

Record Type

String

-

No

-

Fixed string value “STORAW”

Document ID

Integer

-

No

-

67

Season Year

Date

-

No

YYYY-MM-DD

2014-12-31

Season Number

Integer

-

No

-

2

STOR Availability From Date

Date

-

No

YYYY-MM-DD HH:MM

2014-12-31 10:00

STOR Availability To Date

Date

-

No

YYYY-MM-DD HH:MM

2014-12-31 10:00

Weekday Start Time

Date

-

No

HH:MM

10:00

Weekday End Time

Date

-

No

HH:MM

10:00

Non-weekday Start Time

Date

-

No

HH:MM

10:00

Non-weekday End Time

Date

-

No

HH:MM

10:00

Active Flag

String

-

No

-

Y

CSV Download Service

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

Fixed string value “STORAW”

Document ID

Integer

-

No

-

67

Season Year

Date

-

No

YYYYMMDD

20141231

Season Number

Integer

-

No

-

2

STOR Availability From Date

Date

-

No

YYYYMMDDHHMM

201412311000

STOR Availability To Date

Date

-

No

YYYYMMDDHHMM

201412311000

Weekday Start Time

Date

-

No

HHMM

10:00

Weekday End Time

Date

-

No

HHMM

10:00

Non-weekday Start Time

Date

-

No

HHMM

10:00

Non-weekday End Time

Date

-

No

HHMM

10:00

5.2.55 Trading Unit Delivery Mode

Service Name

TRADINGUNITService

Operation Name

TRADINGUNITImpl

Method

GET

Input URL

  1. Settlement Date & Settlement Period mentioned:

https://api.bmreports.com/BMRS/TRADINGUNIT/V1?APIKey=<APIKey>&SettlementDate=<SettlementDate>&SettlementPeriod=<SettlementPeriod>&ServiceType=<xml/XML/csv/CSV>

2) Settlement date, Settlement Period, trading unit type and trading unit name mentioned:

https://api.bmreports.com/BMRS/TRADINGUNIT/v1?APIKey=<APIKey>&SettlementDate=<SettlementDate>&SettlementPeriod=<SettlementPeriod>&TradeType=<TradeType>&TradeName=<TradeName>&ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

API Web service – Request and Response format details:

API Webservice – Request – Trading Unit

Logical Field Name

Field Type

Remarks

Mandatory

Sample data

APIKey

String

Yes

AP8DA23

ServiceType

String

No

xml/csv/XML/CSV

SettlementDate

String

Yes

2017-04-04

SettlementPeriod

Int

Yes

2

TradeType

String

No

Sole

TradeName

String

No

E_EMBEDD18

API Webservice – Response– Trading Unit

Logical Field Name

Field Type

Remarks

Mandatory

Sample data

Trading Unit Type

String

No

Sole

Settlement Date

String

No

2017-01-29

Settlement Period

Int

No

2

Settlement Runtype

String

No

R2

Trading Unit Name

String

No

BALGAN TRADING UNIT

Delivery Mode

String

No

Offtaking

Import Volume

String

No

1111.111

Export Volume

String

No

2222.111

Net Volume

String

No

1111.000

Active Flag

String

No

Y

5.2.56 Settlement Exchange Rate

API service details for the flow is as follows

Service Name

SettlementExchangeRateService

Operation Name

Settlement ExchangeRateImpl

Method

GET

Input URL

https://api.bmreports.com/EURGBFXDATA/V1?APIKey=<APIKey>&SettlementDayFrom=<SettlementDate>&SettlementDayTo=<SettlementDate>&ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Comments

Default value (if none specified):

SettlementDayTo = SettlementDayFrom

API Web service – Request and Response format details:

API Webservice – Request

Logical Field Name

Field Type

Remarks

Mandatory

Sample data

APIKey

String

-

Yes

AP8DA23

Service Type

String

-

No

xml/csv/XML/CSV

Settlement Day From

String

-

Yes

2019-02-01

Settlement Day To

String

-

No

2019-02-04

API Webservice – Response

Logical Field Name

Field Type

Remarks

Mandatory

Sample data

Record Type

String

-

No

GBP_EURO_Settlement_Exchange_Rate_Data

Settlement Day

String

No

2019-02-01

Settlement Exchange Rate

Decimal

-

No

1.13987

Date Time Received

DateTime

-

No

2019-02-01 16:00:00

CSV Download service

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

Fixed string value “GBP EUR SETTLEMENT EXCHANGE RATE”

Settlement Day

String

-

No

YYYY-MM-DD

2019-02-01

Settlement Exchange Rate

Decimal

-

No

-

1.13987

Date Time Received

DateTime

-

No

YYYY-MM-DD HH:MM:SS

2019-02-01 16:00:00

5.3 Replacement Reserve Data

5.3.1 RR Bid Data

API service details for the flow is as follows

Service Name

RRBidDataService

Operation Name

RRBidDataImpl

Method

GET

Input URL

https://api.bmreports.com/RRBidData/V1?APIKey=<APIKey>&SettlementDate=<SettlementDate>&SettlementPeriod=<SettlementPeriod>&BMUnitId=<BMUnitId>&BMUnitType=<BMUnit Type>&NGCBMUnitNAme=<NGCBMUnitName>&ParticipantId=<ParticipantId>& ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Comments

Default value (if none specified):

SettlementPeriod = *

BMUnitId = *

BMUnitType = *

NGCBMUnitType = *

ParticipantId = *

API Web service – Request and Response format details:

API Webservice – Request

Logical Field Name

Field Type

Remarks

Mandatory

Sample data

APIKey

String

-

Yes

AP8DA23

Service Type

String

-

No

xml/csv/XML/CSV

Settlement Date

String

-

Yes

2019-02-19

Settlement Period

Integer

-

No

1

BM Unit Id

String

-

No

BMU1

BM Unit Type

String

-

No

TYPE1

NGC BM Unit Name

String

-

No

NGCBMU1

Participant Id

String

-

No

PARTY1

API Webservice -- Response

Logical Field Name

Field Type

Remarks

Mandatory

Sample data

Record Type

String

-

No

RRBD

BM Unit Id

String

-

No

BMU1

BM Unit Type

String

-

No

TYPE1

NGC BM Unit Name

String

-

No

NGCBMU1

NGC Participant Id

String

-

No

PARTY1

Time Series Id

String

-

No

NGET-RR1

Settlement Date

String

-

No

2019-02-19

Settlement Period

Integer

-

No

1

Quarter Hour Period

Integer

-

No

1

RR Associated TSO

String

-

No

TSO1

RR Market Balance Area

String

-

No

Area1

RR Divisible

String

-

No

A01

RR Linking Bid Id

String

-

No

LINKING1

RR Multipart Bid Id

String

-

No

MULTIPART1

RR Exclusive Bid Id

String

-

No

EXCLUSIVE1

RR Flow Direction

String

-

No

A01

RR Minimum Quantity

String

-

No

1.234

RR Quantity

String

-

No

99.567

RR Bid Resolution

String

-

No

PT15M

RR Position

String

-

No

1

RR Price (£/MWh)

String

-

No

9.99999

RR Status

String

-

No

A06

CSV Download service

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

Fixed string value “Reserve Bid Data”

BM Unit Id

String

-

No

-

BMU1

BM Unit Type

String

-

No

-

TYPE1

NGC BM Unit Name

String

-

No

-

NGCBMU1

NGC Participant Id

String

-

No

-

PARTY1

Time Series Id

String

-

No

-

NGET-RR1

Settlement Date

String

-

No

YYYYMMDD

20190219

Settlement Period

Integer

-

No

-

1

Quarter Hour Period

Integer

-

No

-

1

RR Associated TSO

String

-

No

-

TSO1

RR Market Balance Area

String

-

No

-

Area1

RR Divisible

String

-

No

-

A01

RR Linking Bid Id

String

-

No

-

LINKING1

RR Multipart Bid Id

String

-

No

-

MULTIPART1

RR Exclusive Bid Id

String

-

No

-

EXCLUSIVE1

RR Flow Direction

String

-

No

-

A01

RR Minimum Quantity

String

-

No

-

1.234

RR Quantity

String

-

No

-

99.567

RR Bid Resolution

String

-

No

-

PT15M

RR Position

String

-

No

-

1

RR Price (£/MWh)

String

-

No

-

9.99999

RR Status

String

-

No

-

A06

5.3.2 RR Aggregated Information Data

API service details for the flow is as follows

Service Name

RRAggregatedInformationDataService

Operation Name

RRAggregatedInformationDataImpl

Method

GET

Input URL

https://api.bmreports.com/RRAggregatedInfo/V1?APIKey=<APIKey>&DateTimeFrom=<DateTime>&DateTimeTo=<DateTime>&ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Comments

Default value (if none specified):

DateTimeTo = DateTimeFrom + 1 hour

API Web service – Request and Response format details:

API Webservice – Request

Logical Field Name

Field Type

Remarks

Mandatory

Sample data

APIKey

String

-

Yes

AP8DA23

Service Type

String

-

No

xml/csv/XML/CSV

Date Time From

DateTime

-

Yes

2019-02-28 11:00:00

Date Time To

DateTime

-

No

2019-02-28 12:00:00

API Webservice – Response

Logical Field Name

Field Type

Remarks

Mandatory

Sample data

Record Type

String

-

No

RRAGGINGO

Auction Period Start

DateTime

No

2019-02-01 11:00:00

Auction Period End

DateTime

-

No

2019-02-01 12:00:00

Total Volume of Offered Bids

String

-

No

1234.567

Total volume of Activated Bids

String

-

No

2345.678

Total Volume of Unavailable Bids

String

-

No

3456.789

CSV Download service

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

Fixed string value “RRAGGINFO”

Auction Period Start

DateTime

No

YYYYMMDDHHMMSS

20190228110000

Auction Period End

DateTime

-

No

YYYYMMDDHHMMSS

20190228120000

Total Volume of Offered Bids

String

-

No

-

1234.567

Total Volume of Activated Bids

String

-

No

-

2345.678

Total Volume of Unavailable Bids

String

-

No

-

3456.789

5.3.3 RR Activation Data

API service details for the flow is as follows

Service Name

RRActivationDataService

Operation Name

RRActivationDataImpl

Method

GET

Input URL

https://api.bmreports.com/RRActivation/V1?APIKey=<APIKey>&SettlementDate=<SettlementDate>&SettlementPeriod=<SettlementPeriod>&BMUnitId=<BMUnitId>& ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Comments

Default value (if none specified):

SettlementPeriod = *

BM Unit Id = *

API Web service – Request and Response format details:

API Webservice – Request

Logical Field Name

Field Type

Remarks

Mandatory

Sample data

APIKey

String

-

Yes

AP8DA23

Service Type

String

-

No

xml/csv/XML/CSV

Settlement Date

String

-

Yes

2019-02-19

Settlement Period

Integer

-

No

1

BM Unit Id

String

-

No

BMU1

API Webservice – Response

Report Output Field Mapping

Condition

Record Type

Fixed string value “HDR”

File Type

Fixed string value “RRRESULTS Data”

Settlement Date

Settlement Period

Body Record:

Logical Field Name

Field Type

Remarks

Mandatory

Sample data

Record Type

String

-

No

Fixed string value “ACTIVATION”

NGC Participant Id

String

-

No

PARTY1

BM Unit Id

String

-

No

BMU1

Settlement Date

Date

-

No

2019-02-25

Settlement Period

Integer

-

No

25

Quarter Hour Period

Integer

-

No

1

Type

String

-

No

B74

Flow Direction

String

-

No

UP

Activated Quantity (MW)

Double

-

No

100

Activation Price (£/MWh)

Double

-

No

9.99

Time Series Id

String

-

No

BMRA_RRBS_2019052909000001

CSV Download Service

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

Fixed String Value “RR RESULTS DATA ACTIVATION”

NGC Participant Id

String

-

No

-

PARTY1

BM Unit Id

String

-

No

-

BMU1

Settlement Date

Date

-

No

YYYYMMDD

20190225

Settlement Period

Integer

-

No

-

25

Quarter Hour Period

Integer

-

No

-

1

Type

String

-

No

-

B74

Flow Direction

String

-

No

-

UP

Activated Quantity (MW)

Double

-

No

-

100

Activation Price (£/MWh)

Double

-

No

-

9.99

Time Series Id

String

-

No

-

BMRA_RRBS_2019052909000001

5.3.4 RR Interconnector Schedule

API service details for the flow is as follows

Service Name

RRInterconnectorScheduleDataService

Operation Name

RRInterconnectorScheduleDataImpl

Method

GET

Input URL

https://api.bmreports.com/RRINTCON/V1?APIKey=<APIKey>&SettlementDate=<SettlementDate>&SettlementPeriod=<SettlementPeriod>&InterconnectorId=<InterconnectorId>& ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Comments

Default value (if none specified):

SettlementPeriod = *

Interconnector Id = *

API Web service – Request and Response format details:

API Webservice – Request

Logical Field Name

Field Type

Remarks

Mandatory

Sample data

APIKey

String

-

Yes

AP8DA23

Service Type

String

-

No

xml/csv/XML/CSV

Settlement Date

String

-

Yes

2019-02-19

Settlement Period

Integer

-

No

1

Interconnector Id

String

-

No

INTFR

API Webservice – Response

Header Record:

Report Output Field Mapping

Condition

Record Type

Fixed string value “HDR”

File Type

Fixed string value “RRRESULTS Data”

Settlement Date

Settlement Period

Body Record:

Logical Field Name

Field Type

Remarks

Mandatory

Sample data

Record Type

String

-

No

Fixed string value “INTERCONN”

Interconnector Id

String

-

No

INTFR

Settlement Date

Date

-

No

2019-02-25

Settlement Period

Integer

-

No

25

Quarter Hour Period

Integer

-

No

1

Type

String

-

No

A05

Flow Direction

String

-

No

UP

Activated Quantity (MW)

Double

-

No

100

CSV Download Service

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

Fixed String Value “RRRESULTSDATA INTERCONN”

Interconnector Id

String

-

No

-

INTFR

Settlement Date

Date

-

No

YYYYMMDD

20190225

Settlement Period

Integer

-

No

-

25

Quarter Hour Period

Integer

-

No

-

1

Type

String

-

No

-

A05

Flow Direction

String

-

No

-

UP

Activated Quantity (MW)

Double

-

No

-

100

5.3.5 RR Activation Data

API service details for the flow is as follows

Service Name

RRActivationDataService

Operation Name

RRActivationDataImpl

Method

GET

Input URL

https://api.bmreports.com/RRAD/V1?APIKey=<APIKey>&SettlementDate=<SettlementDate>&SettlementPeriod=<SettlementPeriod>& ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Comments

Default value (if none specified):

SettlementPeriod = *

API Web service – Request and Response format details:

API Webservice – Request

Logical Field Name

Field Type

Remarks

Mandatory

Sample data

APIKey

String

-

Yes

AP8DA23

Service Type

String

-

No

xml/csv/XML/CSV

Settlement Date

String

-

Yes

2019-02-19

Settlement Period

Integer

-

No

1

API Webservice – Response

Header Record:

Report Output Field Mapping

Condition

Record Type

Fixed string value “HDR”

File Type

Fixed string value “RRRESULTS Data”

Settlement Date

Settlement Period

Body Record:

Logical Field Name

Field Type

Remarks

Mandatory

Sample data

Record Type

String

-

No

Fixed string value “AD”

Settlement Date

Date

-

No

2019-02-25

Settlement Period

Integer

-

No

25

Quarter Hour Period

Integer

-

No

1

Type

String

-

No

B75

Flow Direction

String

-

No

UP

Activated Quantity (MW)

Double

-

No

100

Activation Price (£/MWh)

Double

-

No

9.99

Market Object Status

String

No

Fixed string value “Ordered”

CSV Download Service

Logical Field Name

Field Type

Remarks

Mandatory

Sample data

Record Type

String

-

No

Fixed string value “RRRESULTS DATA AD”

Settlement Date

Date

-

No

2019-02-25

Settlement Period

Integer

-

No

25

Quarter Hour Period

Integer

-

No

1

Type

String

-

No

B74

Flow Direction

String

-

No

UP

Activated Quantity (MW)

Double

-

No

100

Activation Price (£/MWh)

Double

-

No

9.99

Market Object Status

String

No

Fixed string value “Ordered”

5.3.6 RR GB Need Met

API service details for the flow is as follows

Service Name

RRGBNeedMetDataService

Operation Name

RRGBNeedMetDataImpl

Method

GET

Input URL

https://api.bmreports.com/RRGBNM/V1?APIKey=<APIKey>&SettlementDate=<SettlementDate>&SettlementPeriod=<SettlementPeriod>& ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Comments

Default value (if none specified):

SettlementPeriod = *

API Web service – Request and Response format details:

API Webservice – Request

Logical Field Name

Field Type

Remarks

Mandatory

Sample data

APIKey

String

-

Yes

AP8DA23

Service Type

String

-

No

xml/csv/XML/CSV

Settlement Date

String

-

Yes

2019-02-19

Settlement Period

Integer

-

No

1

API Webservice – Response

Header Record:

Report Output Field Mapping

Condition

Record Type

Fixed string value “HDR”

File Type

Fixed string value “RRRESULTS Data”

Settlement Date

Settlement Period

Body Record:

Logical Field Name

Field Type

Remarks

Mandatory

Sample data

Record Type

String

-

No

Fixed string value “GBNM”

Settlement Date

Date

-

No

2019-02-25

Settlement Period

Integer

-

No

25

Quarter Hour Period

Integer

-

No

1

Type

String

-

No

B75

Flow Direction

String

-

No

UP

Activated Quantity (MW)

Double

-

No

100

Activation Price (£/MWh)

Double

-

No

9.99

CSV Download Service

Logical Field Name

Field Type

Remarks

Mandatory

Sample data

Record Type

String

-

No

Fixed string value “RRRESULTS DATA GBNM”

Settlement Date

Date

-

No

2019-02-25

Settlement Period

Integer

-

No

25

Quarter Hour Period

Integer

-

No

1

Type

String

-

No

B75

Flow Direction

String

-

No

UP

Activated Quantity (MW)

Double

-

No

100

Activation Price (£/MWh)

Double

-

No

9.99

5.3.7 RR Indicative Cashflow

API service details for the flow is as follows

Service Name

RRIndicativeCashflowService

Operation Name

RRIndicativeCashflowImpl

Method

GET

Input URL

https://api.bmreports.com/ICCR/V1?APIKey=<APIKey>&SettlementDate=<SettlementDate>&SettlementPeriod=<SettlementPeriod>&LeadParty Name=<LeadPartyName>&BMUnitType=<BMUnitType>&NGCBMUnitId=<NGCBMUnitId>&BMUnitId=<BMUnitId>&ServiceType=<xml/XML/csv/CSV>

Output Format

XML/CSV

Comments

Default value (if none specified):

SettlementPeriod = *

LeadPartyName = *

BMUnitType =*

NGCBMUnitId =*

BMUnitId = *

API Web service – Request and Response format details:

API Webservice – Request

Logical Field Name

Field Type

Remarks

Mandatory

Sample data

APIKey

String

-

Yes

AP8DA23

Service Type

String

-

No

xml/csv/XML/CSV

Settlement Date

Date

-

Yes

2019-02-28

Settlement Period

Integer

-

No

1

BM Unit Id

String

-

No

BMU1

API Webservice – Response

Logical Field Name

Field Type

Remarks

Mandatory

Sample data

Record Type

String

-

No

ICCR

BM Unit Id

String

-

No

BMU1

Settlement Date

String

-

No

2019-02-28

Settlement Period

Integer

-

No

1

Quarter Hour Period

Integer

-

No

1

Quarter Hour RR Activated Quantity

String

-

No

100

Quarter Hour RR Activated Volume

String

-

No

25

RR Activation Price

Double

-

No

9.99

Quarter Hour RR Cashflow

String

-

No

249.75

Period RR BM Unit Cashflow

String

-

No

474.53

CSV Download Service

Logical Field Name

Field Type

Remarks

Mandatory

CSV Format

Sample data

Record Type

String

-

No

-

Fixed string value “ICCR”

BM Unit Id

String

-

No

-

BM Unit Id

Settlement Date

String

-

No

YYYYMMDD

20190228

Settlement Period

Integer

-

No

-

1

Quarter Hour Period

Integer

-

No

-

1

Quarter Hour RR Activated Quantity

String

-

No

-

100

Quarter Hour RR Activated Volume

String

-

No

-

25

RR Activation Price

Double

-

No

-

9.99

Quarter Hour RR Cashflow

String

-

No

-

249.75

Period RR BM Unit Cashflow

String

-

No

-

474.53

Data Push Service

6 Data Push Service

BMRS contains a new capability that allows the near real-time publishing of information from the BMRS system to industry participants. This section explains how participants can connect to this service and describes the information available.

6.1 Connectivity

The BMRS Data Push Service supports a variety of Cross Language Clients and Protocols from Java, C, C++, C#, Ruby, Perl, Python, PHP to name a few. We also support several protocols for communication to the BMRS Data Push Service. These are as follows:

OpenWire

OpenWire is the default cross language wire protocol that is supported by the BMRS Data Push Service.

Stomp

The BMRS Data Push Service implements version 1.1 of the STOMP wire protocol. STOMP is the Simple (or Streaming) Text Orientated Messaging Protocol. STOMP provides an interoperable wire format so that STOMP clients can communicate with any STOMP message broker to provide easy and widespread messaging interoperability among many languages, platforms and brokers.

AMQP

The BMRS Data Push Service implements version 1.0 of the OASIS AMQP TC protocol. The OASIS AMQP TC advances a vendor-neutral and platform-agnostic protocol that offers organizations an easier; more secure approach to passing real-time data streams and business transactions. The goal of AMQP is to ensure information is safely and efficiently transported between applications, among organizations, across distributed cloud computing environments, and within mobile infrastructures. AMQP avoids proprietary technologies, offering the potential to lower the cost of enterprise middleware software integrations through open interoperability. By enabling a commoditized, multi-vendor ecosystem, AMQP seeks to create opportunities for transforming the way business is done in the Cloud and over the Internet.

6.2 Topology

The BMRS Data Push Service allows two different approaches for the receipt of the messages. Depending upon the number of client’s that require the receipt of these messages within a participant’s organisation would determine the approach to use.

6.2.1 Client direct connection

complex image of process

In this mode, each client will connect to the BMRS Data Push service and receive messages as they are published. This approach is advised if the participant wishes to connect only one or two clients to the BMRS Data Push Service due to the amount of traffic replicated over the Internet to each client. Due to the nature of the messages being delivered there may be a slight delay between each client receiving the message.

6.2.2 Participant hosted broker

complex image of process

If a participant wishes to connect several clients to the BMRS Data Push Service it is the recommendation for that participant to host their own broker. This would mean that only one instance of the message is transmitted over the Internet to the participant’s network thus reducing traffic or latency.

The participant’s clients would then connect over the participant’s local LAN to the participant’s broker to receive the messages. This approach provides the participant with the quickest approach for messages to be delivered to multiple clients.

6.3 Protocol Connection Strings

Here are some examples of protocol connection strings for connectivity to the data push service

OpenWire over TCP

ssl://<host>:61616

OpenWire over HTTPS

https://<host>:61617

Stomp

stomp+ssl://<host>:61613

AMQP

amqp+ssl://<host>:5672

6.4 Push Data XSDs

The XSDs for the push data service can be found on the ELEXON Portal in the “BMRS API & Data Push” Folder as shown below.

complex image of process

6.5 Data Push Service – Summary Data Set

The list of data available via the data push service is listed in the table below.

6.5.1 Message Types

Interface ID

Data flow type

Data Items

Date set IDD ref

BMRA-I004

Balancing Mechanism Data

Bid-Offer Acceptance Level Flagged Data

BOALF

BMRA-I004

Balancing Mechanism Data

Bid-Offer Data

BOD

BMRA-I004

Balancing Mechanism Data

Maximum Delivery Period

MDP

BMRA-I004

Balancing Mechanism Data

Maximum Delivery Volume

MDV

BMRA-I004

Balancing Mechanism Data

Maximum Export Limit

MEL, MELS

BMRA-I004

Balancing Mechanism Data

Maximum Import Limit

MIL, MILS

BMRA-I004

Balancing Mechanism Data

Minimum Non-Zero Time

MNZT

BMRA-I004

Balancing Mechanism Data

Minimum Zero Time

MZT

BMRA-I004

Balancing Mechanism Data

Notice to Deviate from Zero

NDZ

BMRA-I004

Balancing Mechanism Data

Notice to Deliver Bids

NTB

BMRA-I004

Balancing Mechanism Data

Notice to Deliver Offers

NTO

BMRA-I004

Balancing Mechanism Data

Point FPN Data

PN, FPN

BMRA-I004

Balancing Mechanism Data

Applicable Balancing Services Volume Data

QAS

BMRA-I004

Balancing Mechanism Data

Point Quiescent FPN Data

QPN

BMRA-I004

Balancing Mechanism Data

Run Down Rates Export

RDRE

BMRA-I004

Balancing Mechanism Data

Run Down Rates Import

RDRI

BMRA-I004

Balancing Mechanism Data

Run Up Rates Export

RURE

BMRA-I004

Balancing Mechanism Data

Run Up Rates Import

RURI

BMRA-I004

Balancing Mechanism Data

Stable Export Limit

SEL

BMRA-I004

Balancing Mechanism Data

Stable Import Limit

SIL

BMRA-I005

System Related Data

Balancing Services Adjustment Action ID (unique for Settlement Period),

Balancing Services Adjustment Action Cost (£),

Balancing Services Adjustment Action Volume (MWh), Balancing Services Adjustment Action SO-Flag (T/F)

DISBSAD

BMRA-I005

System Related Data

National Output Usable by Fuel Type, 2-14 Day

FOU2T14D

BMRA-I005

System Related Data

National Output Usable by Fuel Type, 2-52 Week

FOU2T52W

BMRA-I005

System Related Data

Realtime Transmission System Frequency Data

FREQ

BMRA-I005

System Related Data

Half Hourly Generation By Fuel Type

FUELHH

BMRA-I005

System Related Data

Instantaneous Generation By Fuel Type

FUELINST

BMRA-I005

System Related Data

Indicated Imbalance

IMBALNGC

BMRA-I005

System Related Data

Sum of PN Demand (MW), (Indicated Demand)

INDDEM

BMRA-I005

System Related Data

Sum of PN Generation (MW), (Indicated Generation)

INDGEN

BMRA-I005

System Related Data

Initial National Demand Out-Turn

INDO

BMRA-I005

System Related Data

Outturn Volume (MWh), Normal Volume (MWh), High Volume (MWh), Low Volume (MWh)

INDOD

BMRA-I005

System Related Data

Initial Transmission System Demand Out-Turn

ITSDO

BMRA-I005

System Related Data

Indicated Margin

MELNGC

BMRA-I005

System Related Data

Market Index Price, Market Index Volume

MID

BMRA-I005

System Related Data

Missing Market Index Data Messages

Missing MID

BMRA-I005

System Related Data

National Demand Forecast

NDF

BMRA-I005

System Related Data

National Demand Forecast Day, 2-14 Day

NDFD

BMRA-I005

System Related Data

National Demand Forecast Week, 2-52 Week

NDFW

BMRA-I005

System Related Data

Net Energy Buy Price Cost Adjustment (EBCA) (£),

Net Energy Buy Price Volume Adjustment (EBVA) (MWh), Net System Buy Price Volume Adjustment (SBVA) (MWh), Buy Price Price Adjustment (BPA) (£/MWh), Net Energy Sell Price Cost Adjustment (ESCA) (£),Net Energy Sell Price Volume Adjustment (ESVA) (MWh), Net System Sell Price Volume Adjustment (SSVA) (MWh), Sell Price Price Adjustment (SPA) (£/MWh)

NETBSAD

BMRA-I005

System Related Data

Non-BM STOR Out-Turn

NONBM

BMRA-I005

System Related Data

National Surplus Forecast, 2-14 Day

OCNMFD

BMRA-I005

System Related Data

National Surplus Forecast, 2-156 Weeks

OCNMF3Y

BMRA-I005

System Related Data

Generating Plant Demand Margin, 2-14 Days

OCNMFD2

BMRA-I005

System Related Data

Generating Plant Demand Margin, 2-156 Weeks

OCNMF3Y2

BMRA-I005

System Related Data

National Surplus Forecast, 2-52 Week

OCNMFW

BMRA-I005

System Related Data

Generating Plant Demand Margin, 2-52 Weeks

OCNMFW2

BMRA-I005

System Related Data

SO-SO Prices

SO-SO

BMRA-I005

System Related Data

System Message

SYSMSG

BMRA-I005

System Related Data

System Zone Map

System Zone Map

BMRA-I005

System Related Data

System Warnings

SYSWARN

BMRA-I005

System Related Data

Outturn Temperature, Low Reference Temperature, Normal Reference Temperature, High Reference Temperature (all degrees Celsius)

TEMP, REFTEMP

BMRA-I005

System Related Data

Transmission System Demand Forecast

TSDF

BMRA-I005

System Related Data

Transmission System Demand Forecast Day, 2-14 Day

TSDFD

BMRA-I005

System Related Data

Transmission System Demand Forecast Week, 2-52 Week

TSDFW

BMRA-I005

System Related Data

National Output Usable by Fuel Type and BM Unit, 2-14 Day

UOU2T14D

BMRA-I005

System Related Data

National Output Usable by Fuel Type and BM Unit, 2-52 Week

UOU2T52W

BMRA-I005

System Related Data

National Output Usable, 2-156 Weeks

NOU2T3YW

BMRA-I005

System Related Data

National Output Usable by Fuel Type, 2-156 Weeks

FOU2T3YW

BMRA-I005

System Related Data

National Output Usable by Fuel Type and BM Unit, 2-156 Weeks

UOU2T3YW

BMRA-I005

System Related Data

Generation Forecast (MW), Total Registered Capacity (MW)

WINDFOR

BMRA-I006

Derived Data

Period Bid and Offer Acceptance Volumes (QAB, QAO and CADL Flag)

BOAV

BMRA-I006

Derived Data

Estimated Period BM Unit Total Accepted Bid and Offer Volume (QAB and QAO), Estimated Period BM Unit Tagged Accepted Bid and Offer Volume (QTAB and QTAO), Estimated Period BM Unit Repriced Accepted Bid and Offer Volume (QRAB and QRAO), Estimated Period BM Unit Originally-Priced Accepted Bid and Offer Volume (QOAB and QOAO)

DISPTAV

BMRA-I006

Derived Data

Estimated Bid Offer Cash flows

EBOCF

BMRA-I006

Derived Data

Index, Component Identifier, Acceptance Number, Bid-Offer Pair Number, CADL Flag (T/F), SO-Flag (T/F), Repriced Indicator (T/F), Volume (MWh), DMAT Adjusted Volume (MWh), Arbitrage Adjusted Volume (MWh), NIV Adjusted Volume (MWh), PAR Adjusted Volume (MWh), Final Price (£/MWh), Transmission Loss Multiplier, TLM Adjusted Volume (MWh), TLM Adjusted Cost (£)

ISPSTACK

BMRA-I006

Derived Data

Estimated Period Balancing Mechanism Bid and Offer Cashflows (CB and CO)

PTAV

BMRA-I006

Derived Data

Disaggregated Estimated Buy and Sell Price

DISEBSP

BMRA-I006

Derived Data

Total Bid Volume and Total Offer Volume

TBOD

BMRA-I019

Credit Default Notices

Credit Default Notices

CDN

BMRA-I037

Replacement Reserve Data

Replacement Reserve Bid Data

RRBD

BMRA-I037

Replacement Reserve Data

Indicative RR Bid and Offer Volumes

RRBOAV

BMRA-I037

Replacement Reserve Data

Indicative RR Bid and Offer Acceptance Volumes

RRPTAV

BMRA-I037

Replacement Reserve Data

Indicative RR Quarter Hour Cashflows

QRRC

BMRA-I037

Replacement Reserve Data

Indicative RR Period Cashflows

PRRC

BMRA-I037

Replacement Reserve Data

RR Activation Data

AD

BMRA-I037

Replacement Reserve Data

GB Need Met

GBNM

BMRA-I037

Replacement Reserve Data

Interconnector Schedule

IS

BMRA-I037

Replacement Reserve Data

RR Aggregated Information

AGGINFO

Please note: The Data Push Dataset also includes Transparency and REMIT data (B1610, B1720, etc)

6.5.2 Field Type Index by Data Type

Data Type

Field Type

Acceptance Level Value

VA

Acceptance Number

NK

Acceptance Time

TA

Adjustment Cost

JC

Adjustment Identifier

AI

Adjustment Volume

JV

Affected LDSO

DS

Amendment Flag

AM

Applicable Balancing Services Volume

SV

Arbitrage Adjusted Volume

AV

Bid Cashflow

BC

Bid Price

BP

Bid Volume

BV

Bid/Offer Indicator

BO

Bid-Offer Level Value

VB

Bid-Offer Original Price

UP

Bid-Offer Pair Number

NN

BMRS Informational Text

IN

BSAD Defaulted

BD

Buy Price

PB

Buy Price Cost Adjustment

A4

Buy Price Price Adjustment

A6

Buy Price Volume Adjustment

A5

CADL Flag

CF

Calendar Week Number

WN

Calendar Year

CY

Cleared Default Settlement Date

CD

Cleared Default Settlement Period

CP

Component Identifier

CI

Contract Identification

IC

Credit Default Level

DL

Deemed Bid-Offer Flag

AD

Demand Control Event Flag

EV

Demand Control ID

ID

Demand Control Level

VO

Demand Margin

DM

Demand Value

VD

DMAT Adjusted Volume

DA

Effective From Time

TE

Energy Volume Daily High Reference

EH

Energy Volume Daily Low Reference

EL

Energy Volume Daily Normal Reference

EN

Energy Volume Outturn

EO

Entered Default Settlement Date

ED

Entered Default Settlement Period

EP

Export Level Value

VE

Fuel Type

FT

Fuel Type Generation

FG

GB Noon Temperature Outturn

TO

GB Reference High Noon Temperature

TH

GB Reference Low Noon Temperature

TL

GB Reference Normal Noon Temperature

TN

Generation Value

VG

Imbalance Value

VI

Import Level Value

VF

Indicative Net Imbalance Volume

NI

Instruction Sequence No

SQ

Margin/Surplus Value

VM

Market Index Data Provider ID

MI

Market Index Price

M1

Market Index Volume

M2

Market Object Status

MOS

Maximum Delivery Period

DP

Maximum Delivery Volume

DV

Message Type

MT

Minimum non-Zero Time

MN

Minimum Zero Time

MZ

Net Energy Buy Price Cost Adjustment

A9

Net Energy Buy Price Volume Adjustment

A10

Net Energy Sell Price Cost Adjustment

A7

Net Energy Sell Price Volume Adjustment

A8

Net System Buy Price Volume Adjustment

A12

Net System Sell Price Volume Adjustment

A11

NIV Adjusted Volume

NV

Non-BM STOR Volume

NB

Notice to Deliver Bids

DB

Notice to Deliver Offers

DO

Notice to Deviate from Zero

DZ

Number of Records

NR

Number Of Spot Points

NP

Offer Cashflow

OC

Offer Price

OP

Offer Volume

OV

Output Usable

OU

PAR Adjusted Volume

PV

Party Id

PI

Period Originally-Priced BM Unit Bid Volume

P6

Period Originally-Priced BM Unit Offer Volume

P3

Period Repriced BM Unit Bid Volume

P5

Period Repriced BM Unit Offer Volume

P2

Period Tagged BM Unit Bid Volume

P4

Period Tagged BM Unit Offer Volume

P1

PN Level Value

VP

Price Derivation Code

PD

Publishing Time

TP

Replacement Price

RP

Replacement Price Calculation Volume

RV

Repriced Indicator

RI

Reserve Scarcity Price

RSP

RR Accepted Bid Volume

BV

RR Accepted Offer Volume

OV

RR Associated TSO

AT

RR Auction Period End

AE

RR Auction Period Start

AS

RR Bid Resolution

BR

RR Business Type

TY

RR Cashflow

CR

RR Divisible

DI

RR Exclusive Bid Id

EB

RR Flow Direction

FD

RR Instruction Flag

RN

RR Interconnector Identifier

IN

RR Linking Bid Id

LB

RR Market Balance Area

BA

RR Maximum Quantity

QX

RR Multipart Bid Id

MB

RR Position

PO

RR Price

PR

RR Quantity

QI

RR Quarter Hour Period

QP

RR Schedule Flag

SC

RR Status

RS

Run Down Elbow 2

RB

Run Down Elbow 3

RC

Run Down Rate 1

R1

Run Down Rate 2

R2

Run Down Rate 3

R3

Run Up Elbow 2

UB

Run Up Elbow 3

UC

Run Up Rate 1

U1

Run Up Rate 2

U2

Run Up Rate 3

U3

Sell Price

PS

Sell Price Cost Adjustment

A1

Sell Price Price Adjustment

A3

Sell Price Volume Adjustment

A2

Sequence Number

SN

Settlement Date

SD

Settlement Period

SP

Short Acceptance Flag

SA

SO-Flag

SO

SO-SO Start Time

ST

SO-SO Trade Type

TT

Spot Time

TS

Stable Export Limit

SE

Stable Import Limit

SI

Stack Item Final Price

FP

Stack Item Original Price

IP

Stack Item Volume

IV

STOR Provider Flag

PF

System Frequency

SF

System Message Text

SM

System Total Priced Accepted Bid Volume

PC

System Total Priced Accepted Offer Volume

PP

System Total Unpriced Accepted Bid Volume

AC

System Total Unpriced Accepted Offer Volume

AP

System Warning Text

SW

Tagged Accepted Bid Volume

T2

Tagged Accepted Offer Volume

T1

Tagged Adjustment Buy Volume

J4

Tagged Adjustment Sell Volume

J3

Time From

TF

Time To

TI

TLM Adjusted Cost

TC

TLM Adjusted Volume

TV

Total Accepted Bid Volume

AB

Total Accepted Offer Volume

AO

Total Adjustment Buy Volume

J2

Total Adjustment Sell Volume

J1

Total Bid Volume

BT

Total Offer Volume

OT

Total Registered Capacity

TR

Total Volume of Activated Bids

TA

Total Volume of Offered Bids

TO

Total Volume of Unavailable Bids

TU

Trade Direction

TD

Trade Price

PT

Trade Quantity

TQ

Transmission Loss Multiplier

TM

Week Start Date

WD

Zone Indicator

ZI

Please note: The Data Push Service data content is based on the TIBCO Service and for further guidance on the data items and field types please refer to the NETA Interface Definition and Design (IDD): Part 1.

6.6 Filter by Message types

The Data Push Service allows you to filter by message type. JMS selectors can be used to filter the received messages based on a given data item. The different flows have been assigned a unique JMSType (see the table below) and hence to filter on specific flows please use this field. The implementation of the filter depends on the participant side message consumer technology, however the syntax will be standards based as follows https://docs.oracle.com/cd/E19798-01/821-1841/bncer/index.html

Examples of the implementing a filter using the apache JMeter client are as follows:

complex image of process

7 Data Push and API checklist

Below are the major points of information you will need to be able to use either the RESTful or the Push Data service.

7.1 RESTful

URL: This is the address of the RESTful service you are accessing. The default for the Elexon live service is https://api.bmreports.co.uk/BMRS.

APIKey: This is provided through the ELEXON portal. You need to register with the portal prior to the use of the API services.

Client: This can be a web browser or a custom piece of code.

7.2 Push Data Service

URL: This is the address of the RESTful service you are accessing. The default for the ELEXON live service is https://api.bmreports.co.uk:<PROTOCOL_PORT>.

APIKey: This is provided through the Elexon portal. You need to register with the portal prior to the use of the API services.

Protocol and API: A protocol is the language that is spoken between the push data service and your client. The Elexon Push Data Service supports several protocols documented earlier in this guide. You will need to select a protocol and the supporting library (Elexon do not provide these) for your environment.

Client: You will need a client that receives the information through your chosen protocol and library. This client will most likely be a custom piece of code for your environment that will receive the message from the Elexon push data service and then process it for your organisation.

7.3 Other Considerations

The broker is ActiveMQ 5.10.0

    • The broker address is api.bmreports.com (for production), testapi.bmreports.com (for testing)

    • The port varies depending on the chosen protocol – see section 8.3.

    • The method of establishing a durable connection varies depending on the protocol – see the ActiveMQ website for details

    • Regardless of chosen protocol, your scripting key should be passed as both username and password – see your profile page of the ELEXON Portal

    • The topic is /topic/bmrsTopic

    • No particular approach is recommended, but Java examples are provided in the Appendix of this document

8 BMRA Data Download Service

8.1 Data Formats

This section gives the interface definition (file formats) for the files which can be downloaded from both the High and Low Grade Service web pages.

The formats are very simple comma separated variable records consisting of one header record, zero or more body records and one footer record. The contents of the header record differ between the types of the data downloaded. The Common Footer record only contains a count of the body section records.

The contents of the files will match the criteria specified in the User Interface.

8.1.1 Common Footer Record

Field

Type

Format

Comments

Record Type

string

Fixed String “FTR”

Body Record Count

number

8.1.2 Forecast Day and Day Ahead Demand Data

8.1.2.1 Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed string “FORECAST DAY AND DAY AHEAD DEMAND DATA”

8.1.2.2 Body Record National Day and Day Ahead National Demand Forecast

Field

Type

Format

Comments

Record Type

string

Fixed String “DANF”

Settlement Date

date

yyyymmdd

Records ordered incrementing by this field first

Settlement Period

number

Records ordered incrementing by this field second

Boundary ID

string

Always N

Publication Time

datetime

yyyymmddhh24miss

Demand Forecast (DF)

number

8.1.2.3 Body Record Day and Day Ahead Indicated Demand

Field

Type

Format

Comments

Record Type

string

Fixed String “DAID”

Settlement Date

date

yyyymmdd

Records ordered incrementing by this field first

Settlement Period

number

Records ordered incrementing by this field second

Boundary ID

string

One of B1-B17 or N

Publication Time

datetime

yyyymmddhh24miss

Indicated Demand (INDDEM)

number

8.1.2.4 Body Record Day and Day Ahead Indicated Generation

Field

Type

Format

Comments

Record Type

string

Fixed String “DAIG”

Settlement Date

date

yyyymmdd

Records ordered incrementing by this field first

Settlement Period

number

Records ordered incrementing by this field second

Boundary ID

string

One of B1-B17 or N

Publication Time

datetime

yyyymmddhh24miss

Indicated Generation (INDGEN)

number

8.1.2.5 Body Record Day and Day Ahead Transmission System Demand Forecast

Field

Type

Format

Comments

Record Type

string

Fixed String “DATF”

Settlement Date

date

yyyymmdd

Records ordered incrementing by this field first

Settlement Period

number

Records ordered incrementing by this field second

Boundary ID

string

One of B1-B17 or N

Publication Time

datetime

yyyymmddhh24miss

Demand Forecast (DF)

number

8.1.2.6 Example File

HDR,FORECAST DAY AND DAY AHEAD DEMAND DATA

DANF,20001017,1,N,20001016220000,9861.000

DANF,20001017,2,N,20001016220000,8783.000

DATF,20001017,1,N,20001016220000,9661.000

DATF,20001017,2,N,20001016220000,8583.000

DAID,20001017,1,N,20001016220000,9560.000

DAID,20001017,2,N,20001016220000,8484.000

DAIG,20001017,1,N,20001016220000,9699.000

DAIG,20001017,2,N,20001016220000,8612.000

FTR,8

8.1.3 Forecast Day and Day Ahead Margin and Imbalance Data

8.1.3.1 Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed string “FORECAST DAY AND DAY AHEAD MARGIN AND IMBALANCE DATA”

8.1.3.2 Body Record Day and Day-Ahead Margin

Field

Type

Format

Comments

Record Type

string

Fixed String “DAM”

Settlement Date

date

yyyymmdd

Records ordered incrementing by this field first

Settlement Period

number

Records ordered incrementing by this field second

Boundary ID

string

One of B1-B17 or N

Publication Time

datetime

yyyymmddhh24miss

Indicated Margin (MELNGC)

number

8.1.3.3 Body Record Day and Day-Ahead Imbalance

Field

Type

Format

Comments

Record Type

string

Fixed String “DAI”

Settlement Date

date

yyyymmdd

Records ordered incrementing by this field first

Settlement Period

number

Records ordered incrementing by this field second

Boundary ID

string

One of B1-B17 or N

Publication Time

datetime

yyyymmddhh24miss

Indicated Imbalance (IMBALNGC)

number

8.1.3.4 Example File

HDR,FORECAST DAY AND DAY AHEAD MARGIN AND IMBALANCE DATA

DAM,20001017,1,B1,20001016220000,2623.000

DAM,20001017,2,B1,20001016220000,2574.000

DAI,20001017,1,B1,20001016220000,2602.000

DAI,20001017,2,B1,20001016220000,2556.000

FTR,4

8.1.4 Demand & Surplus Forecast Data (2-14 days ahead)

8.1.4.1 Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed string “FORECAST 2 TO 14 DAYS AHEAD DEMAND AND MARGIN DATA”

Demand & Surplus Forecast Data (2-14 days ahead) National Demand

8.1.4.2 Demand & Surplus Forecast Data (2-14 days ahead) National Demand

Field

Type

Format

Comments

Record Type

string

Fixed String “DSN”

Settlement Date

date

yyyymmdd

Records ordered incrementing by this field first

Settlement Period

number

Records ordered incrementing by this field second

Boundary ID

string

Always N

Publication Time

datetime

yyyymmddhh24miss

Average half-hour MW Demand value for peak of Day (NDFD)

number

8.1.4.3 Demand & Surplus Forecast Data (2-14 days ahead) Surplus

Field

Type

Format

Comments

Record Type

string

Fixed String “DSM”

Settlement Date

date

yyyymmdd

Records ordered incrementing by this field first

Settlement Period

number

Records ordered incrementing by this field second

Boundary ID

string

Always N

Publication Time

datetime

yyyymmddhh24miss

Average half-hour MW Surplus value for peak of Day (OCNMFD)

number

8.1.4.4 Demand & Surplus Forecast Data (2-14 days ahead) Transmission System Demand

Field

Type

Format

Comments

Record Type

string

Fixed String “DST”

Settlement Date

date

yyyymmdd

Records ordered incrementing by this field first

Settlement Period

number

Records ordered incrementing by this field second

Boundary ID

string

Always N

Publication Time

datetime

yyyymmddhh24miss

Average half-hour MW Demand value for peak of Day (TSDFD)

number

8.1.4.5 Demand & Surplus Forecast Data (2-14 days ahead) Generating Plant Demand Margin

Field

Type

Format

Comments

Record Type

string

Fixed String “OCNMFD2”

Settlement Date

date

yyyymmdd

Records ordered incrementing by this field first

Settlement Period

number

Records ordered incrementing by this field second

Boundary ID

string

Always N

Publication Time

datetime

yyyymmddhh24miss

Average half-hour MW demand margin value for peak of Day (OCNMFD2)

number

8.1.4.6 Example File

HDR,FORECAST 2 TO 14 DAYS AHEAD DEMAND AND MARGIN DATA

DSN,20001019,9,N,20001016150000,41000.000

DSN,20001020,11,N,20001016150000,42000.000

DSM,20001019,9,N,20001016160000,41000.000

DSM,20001020,11,N,20001016160000,42000.000

DST,20001019,9,N,20001016150000,40000.000

DST,20001020,11,N,20001016150000,41000.000O

CNMFD2, 20001010,9,N, 20001016150000,17330.000

OCNMFD2, 20001010,11,N, 20001016150000,14288.000

FTR,8

8.1.5 Demand & Surplus Forecast Data (2-52 weeks ahead)

8.1.5.1 Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed string “FORECAST 2 TO 52 WEEKS AHEAD DEMAND AND MARGIN DATA”

Demand & Surplus Forecast Data (2-52 weeks ahead) National Demand

Field

Type

Format

Comments

Record Type

string

Fixed String “WN”

Week Number

number

Records ordered incrementing by this field (wraps from 53 to 1 when new year starts)

Boundary ID

string

Always N

Publication Time

datetime

yyyymmddhh24miss

Average half-hour MW Demand value for peak of Week (NDFW)

number

Demand & Surplus Forecast Data (2-52 weeks ahead) Transmission System Demand

Field

Type

Format

Comments

Record Type

string

Fixed String “WT”

Week Number

number

Records ordered incrementing by this field (wraps from 53 to 1 when new year starts)

Boundary ID

string

Always N

Publication Time

datetime

yyyymmddhh24miss

Average half-hour MW Demand value for peak of Week (TSDFW)

number

Demand & Surplus Forecast Data (2-52 weeks ahead) Surplus

Field

Type

Format

Comments

Record Type

string

Fixed String “WM”

Week Number

number

Records ordered incrementing by this field (wraps from 53 to 1 when new year starts)

Boundary ID

string

Always N

Publication Time

datetime

yyyymmddhh24miss

Average half-hour MW Surplus value for peak of Week (OCNMFW)

number

Demand & Surplus Forecast Data (2-52 weeks ahead) Generating Plant Demand Margin

Field

Type

Format

Comments

Record Type

string

Fixed String “OCNMFW2”

Week Number

number

Records ordered incrementing by this field (wraps from 53 to 1 when new year starts)

Boundary ID

string

Always N

Publication Time

datetime

yyyymmddhh24miss

Average half-hour MW demand margin value for peak of Week (OCNMFW2)

number

Example File

HDR,FORECAST 2 TO 52 WEEKS AHEAD DEMAND AND MARGIN DATA

WN,44,N,20001013170000,36000.000

WN,45,N,20001013170000,37000.000

WM,44,N,20001011160000,37000.000

WM,45,N,20001011160000,38000.000

WT,44,N,20001013170000,35000.000

WT,45,N,20001013170000,36000.000

OCNMFW2,44,N,20001013170000,17830.000

OCNMFW2,45,N,20001013170000,18610.000

FTR,8

8.1.6 Demand & Surplus Forecast Data (2-156 weeks ahead)

8.1.6.1 Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed string “FORECAST 2 TO 156 WEEKS AHEAD MARGIN DATA”

8.1.6.2 Demand & Surplus Forecast Data (2-156 weeks ahead) Surplus

Field

Type

Format

Comments

Record Type

string

Fixed String “OCNMF3Y”

Week Number

number

Records ordered incrementing by this field (wraps from 53 to 1 when new year starts)

Calendar Year

number

Boundary ID

string

Always N

Publication Time

datetime

yyyymmddhh24miss

Average half-hour MW Surplus value for peak of Week (OCNMF3Y)

number

8.1.6.3 Demand & Surplus Forecast Data (2-156 weeks ahead) Generating Plant Demand Margin

Field

Type

Format

Comments

Record Type

string

Fixed String “OCNMF3Y2”

Week Number

number

Records ordered incrementing by this field (wraps from 53 to 1 when new year starts)

Calendar Year

number

Boundary ID

string

Always N

Publication Time

datetime

yyyymmddhh24miss

Average half-hour MW demand margin value for peak of Week (OCNMFW2)

number

8.1.6.4 Example File

HDR,FORECAST 2 TO 156 WEEKS AHEAD MARGIN DATA

OCNMF3Y,44,2021,N,20201013170000,3500.000

OCNMF3Y,45,2021,N,20201013170000,3600.000

OCNMF3Y2,44,2021,N,20201013170000,17830.000

OCNMF3Y2,45,2021,N,20201013170000,18610.000

FTR,4

8.1.7 Output Usable

National Output Usable (2-14 days ahead)

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed String “NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-14 DAYS) DATA”

            1. Body Record

Field

Type

Format

Comments

Record Type

string

Fixed String “NOU2T14D”

Publication Time

datetime

yyyymmddhh24miss

System Zone

string

Always N

Settlement Date

date

Output Usable

number

            1. Example File

HDR,NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-14 DAYS)DATA

NOU2T14D,201004231113,N,20100425,54267

NOU2T14D,201004231113,N,20100425,57666

FTR,2

National Output Usable (2-52 weeks ahead)

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed String “NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-52 WEEKS) DATA”

            1. Body Record

Field

Type

Format

Comments

Record Type

string

Fixed String “NOU2T52W”

Publication Time

datetime

yyyymmddhh24miss

System Zone

string

Always N

Calendar Week Number

number

Calendar Year

number

Output Usable

number

            1. Example Record

HDR,NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-52 WEEKS)DATA

NOU2T52W,201004231113,N,18,2010,59588

NOU2T52W,201004231113,N,19,2010,60966

FTR,2

National Output Usable (2-156 weeks ahead)

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed String “NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-156 WEEKS) DATA”

            1. Body Record

Field

Type

Format

Comments

Record Type

string

Fixed String “NOU2T3YW”

Publication Time

datetime

yyyymmddhh24miss

System Zone

string

Always N

Calendar Week Number

number

Calendar Year

number

Output Usable

number

            1. Example Record

HDR,NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-156 WEEKS)DATA

NOU2T3YW,201004231113,N,18,2010,59588

NOU2T3YW,201004231113,N,19,2010,60966

FTR,2

National Output Usable by Fuel Type (2-14 days ahead)

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed String “NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-14 DAYS) DATA – BY FUEL TYPE”

            1. Body Record

Field

Type

Format

Comments

Record Type

string

Fixed String “FOU2T14D”

Fuel Type

Publication Time

datetime

yyyymmddhh24miss

System Zone

string

Always N

Settlement Date

date

Output Usable

number

            1. Example File

HDR,NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-14 DAYS)DATA – BY FUEL TYPE

FOU2T14D,CCGT,201001021550,N,20100204,1500

FOU2T14D,OIL,201001021550,N,20100204,1500

FOU2T14D,COAL,201001021550,N,20100204,1500

FOU2T14D,NUCLEAR,201001021550,N,20100204,1500

FTR,4

National Output Usable by Fuel Type and BM Unit (2-14 days ahead)

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed String “NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-14 DAYS) DATA – BY BM UNIT/INTERCONNECTOR & FUEL TYPE”

            1. Body Record

Field

Type

Format

Comments

Record Type

string

Fixed String “UOU2T14D”

BM Unit ID

Fuel Type

Publication Time

datetime

yyyymmddhh24miss

System Zone

string

Always N

System Zone

Settlement Date

date

Output Usable

number

            1. Example File

HDR,NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-14 DAYS)DATA – BY BM UNIT/INTERCONNECTOR & FUEL TYPE

UOU2T14D,BMUNIT01,CCGT,201001021550,N,20100204,150

UOU2T14D,BMUNIT02,COAL, 201001021550,N,20100204,150

UOU2T14D,BMUNIT03,OIL, 201001021550,N,20100204,150

UOU2T14D,INTFR, INTFR, 201001021550,N,20100204,150

FTR,4

National Output Usable by Fuel Type (2-52 weeks ahead)

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed String “NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-52 WEEKS) DATA –FUEL TYPE”

            1. Body Record

Field

Type

Format

Comments

Record Type

string

Fixed String “FOU2T52W”

Fuel Type

Publication Time

datetime

yyyymmddhh24miss

System Zone

string

Always N

Calendar Week Number

number

Calendar Year

number

Output Usable

number

            1. Example File

HDR,NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-52 WEEKS)DATA – BY FUEL TYPE

FOU2T52W,CCGT,201001021550,N,3,2010,1500

FOU2T52W,COAL,201001021550,N,3,2010,1500

FTR,2

National Output Usable by Fuel Type and BM Unit (2-52 weeks ahead)

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed String “NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-52 WEEKS) DATA – BY BM UNIT/INTERCONNECTOR & FUEL TYPE”

            1. Body Record

Field

Type

Format

Comments

Record Type

string

Fixed String “UOU2T52W”

BM Unit ID

Fuel Type

Publication Time

datetime

yyyymmddhh24miss

System Zone

string

Always N

Calendar Week Number

number

Calendar Year

number

Output Usable

number

            1. Example File

HDR,NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-52 WEEKS)DATA – BY BM UNIT/INTERCONNECTOR & FUEL TYPE

UOU2T52W,BMUNIT01,CCGT,201001021550,N,12,2010,1000

UOU2T52W,BMUNIT02,COAL,201001021550,N,12,2010,1000

UOU2T52W,BMUNIT03,OIL,201001021550,N,12,2010,1000

UOU2T52W,INTFR,INTFR,201001021550,N,12,2010,2500

FTR,4

National Output Usable by Fuel Type (2-156 weeks ahead)

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed String “NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-156 WEEKS) DATA –FUEL TYPE”

            1. Body Record

Field

Type

Format

Comments

Record Type

string

Fixed String “FOU2T3YW”

Fuel Type

Publication Time

datetime

yyyymmddhh24miss

System Zone

string

Always N

Calendar Week Number

number

Calendar Year

number

Output Usable

number

            1. Example File

HDR,NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-156 WEEKS)DATA – BY FUEL TYPE

FOU2T3YW,CCGT,201001021550,N,3,2010,1500

FOU2T3YW,COAL,201001021550,N,3,2010,1500

FTR,2

[P408]National Output Usable by Fuel Type and BM Unit (2-156 weeks ahead)

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed String “NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-156 WEEKS) DATA – BY BM UNIT/INTERCONNECTOR & FUEL TYPE”

            1. Body Record

Field

Type

Format

Comments

Record Type

string

Fixed String “UOU2T3YW”

BM Unit ID

Fuel Type

Publication Time

datetime

yyyymmddhh24miss

System Zone

string

Always N

Calendar Week Number

number

Calendar Year

number

Output Usable

number

            1. Example File

HDR,NATIONAL OUTPUT USABLE MW BASED ON OC2 (2-156 WEEKS)DATA – BY BM UNIT/INTERCONNECTOR & FUEL TYPE

UOU2T3YW,BMUNIT01,CCGT,201001021550,N,12,2010,1000

UOU2T3YW,BMUNIT02,COAL,201001021550,N,12,2010,1000

UOU2T3YW,BMUNIT03,OIL,201001021550,N,12,2010,1000

UOU2T3YW,INTFR,INTFR,201001021550,N,12,2010,2500

FTR,4

8.1.8 Initial Demand Outturn

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed string “INITIAL DEMAND OUTTURN”

Body Record Initial Demand Outturn

Field

Type

Format

Comments

Record Type

string

Fixed String “INDO

Settlement Date

date

yyyymmdd

Group ordered by this field first, incrementing.

Settlement Period

number

Group ordered by this field second, incrementing.

National Demand Out-Turn

number

Body Record Initial Transmission System Demand Outturn

N.B. ITSDO is a data stream introduced through Modification P219. P219 has an effectiveness date of 6th November 2008 and therefore ITSDO data is only available on calendar dates from that date onwards. This body record will therefore only appear in the CSV for dates on or after 6th November 2008.

Field

Type

Format

Comments

Record Type

string

Fixed String “ITSDO

Settlement Date

date

yyyymmdd

Group ordered by this field first, incrementing.

Settlement Period

number

Group ordered by this field second, incrementing.

Initial Transmission System Demand Out-Turn (ITSDO)

number

Example File

HDR,INITIAL DEMAND OUTTURN

INDO,20001016,32,38889.000

INDO,20001016,33,39066.000

ITSDO,20001016,32,48889.000

ITSDO,20001016,33,49066.000

FTR,4

8.1.9 Gate Closure Data

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed string “PHYSICAL BM DATA”

Settlement Date

date

yyyymmdd

Settlement Period

string

number between 1 and 50 or * if selecting a full day’s data

Body Record FPN Data

Field

Type

Format

Comments

Record Type (PN)

string

Fixed String “PN”

BM Unit ID

string

ordered by this field first, incrementing

Settlement Period

number

number between 1 and 50; ordered by this field second, incrementing

From Time

datetime

yyyymmddhh24miss

Group ordered by this field third, incrementing.

From Level

number

To Time

datetime

yyyymmddhh24miss

To Level

number

Body Record QPN Data

Field

Type

Format

Comments

Record Type (QPN)

string

Fixed String “QPN”

BM Unit ID

string

ordered by this field first, incrementing

Settlement Period

number

number between 1 and 50; ordered by this field second, incrementing

From Time

datetime

yyyymmddhh24miss

Group ordered by this field third, incrementing.

From Level

number

To Time

datetime

yyyymmddhh24miss

To Level

number

Body Record Maximum Export Level Data

Field

Type

Format

Comments

Record Type (MEL)

string

Fixed String “MEL”

BM Unit ID

string

ordered by this field first, incrementing

Settlement Period

number

number between 1 and 50; ordered by this field second, incrementing

From Time

datetime

yyyymmddhh24miss

Group ordered by this field third, incrementing.

From Level

number

To Time

datetime

yyyymmddhh24miss

To Level

number

Body Record Maximum Import Level Data

Field

Type

Format

Comments

Record Type (MIL)

string

Fixed String “MIL”

BM Unit ID

string

ordered by this field first, incrementing

Settlement Period

number

number between 1 and 50; ordered by this field second, incrementing

From Time

datetime

yyyymmddhh24miss

Group ordered by this field third, incrementing.

From Level

number

To Time

datetime

yyyymmddhh24miss

To Level

number

Body Record Bid-Offer Acceptance Level Data

For Settlement Dates prior to the P217 effective date the following data item will be reported:

Field

Type

Format

Comments

Record Type(BOAL)

string

Fixed String “BOAL”

BM Unit ID

string

ordered by this field first, incrementing

Bid Offer Acceptance ID

number

Group ordered secondly by this field, incrementing.

Acceptance Time

datetime

yyyymmddhh24miss

Deemed Flag

boolean

Y or N

From Time

datetime

yyyymmddhh24miss

Group ordered thirdly by this field, incrementing.

From Level

number

To Time

datetime

yyyymmddhh24miss

To Level

number

Body Record Bid-Offer Acceptance Level Flagged Data

For Settlement Dates on or after the P217 effective date the following data will be reported:

Field

Type

Format

Comments

Record Type(BOALF)

string

Fixed String “BOALF”

BM Unit ID

string

ordered by this field first, incrementing

Bid Offer Acceptance ID

number

Group ordered secondly by this field, incrementing.

Acceptance Time

datetime

yyyymmddhh24miss

Deemed Flag

boolean

Y or N

SO-Flag

boolean

T or F

'T' if potentially impacted by transmission constraints.

STOR Provider Flag

boolean

T or F

‘T’ if related to a STOR Provider

This field will be null if pre-P305 Settlement Date

RR Instruction Flag

boolean

T or F

RR Schedule Flag

boolean

T or F

From Time

datetime

yyyymmddhh24miss

Group ordered thirdly by this field, incrementing.

From Level

number

To Time

datetime

yyyymmddhh24miss

To Level

number

Example File

For Settlement Dates prior to the P217 effective date the following data will be reported:

HDR,PHYSICAL BM DATA,20001016,43

PN,T_GENSET176,43,20001016200000,170.000,20001016200600,180.000

PN,T_GENSET176,43,20001016200600,180.000,20001016201200,180.000

PN,T_GENSET176,43,20001016201200,180.000,20001016201800,160.000

PN,T_GENSET176,43,20001016201800,160.000,20001016202400,160.000

PN,T_GENSET176,43,20001016202400,160.000,20001016203000,170.000

QPN,T_GENSET176,43,20001016200000,10.000,20001016201000,15.000

QPN,T_GENSET176,43,20001016201000,15.000,20001016202000,5.000

QPN,T_GENSET176,43,20001016202000,5.000,20001016203000,10.000

MEL,T_GENSET176,43,20001016200000,200.000,20001016201500,210.000

MEL,T_GENSET176,43,20001016201500,210.000,20001016203000,200.000

MIL,T_GENSET176,43,20001016200000,-200.000,20001016201500,-210.000

MIL,T_GENSET176,43,20001016201500,-210.000,20001016203000,-200.000

BOAL,T_GENSET176,3000,20001016160000,N,20001016200000,175.000,20001016200600,185.000

BOAL,T_GENSET176,3000,20001016160000,N,20001016200600,185.000,20001016201200,185.000

BOAL,T_GENSET176,3000,20001016160000,N,20001016201200,185.000,20001016201800,165.000

BOAL,T_GENSET176,3000,20001016160000,N,20001016201800,165.000,20001016202400,165.000

BOAL,T_GENSET176,3000,20001016160000,N,20001016202400,165.000,20001016203000,175.000

BOAL,T_GENSET176,3100,20001016161100,N,20001016200000,180.000,20001016200600,190.000

BOAL,T_GENSET176,3100,20001016161100,N,20001016200600,190.000,20001016201200,190.000

BOAL,T_GENSET176,3100,20001016161100,N,20001016201200,190.000,20001016201800,170.000

BOAL,T_GENSET176,3100,20001016161100,N,20001016201800,170.000,20001016202400,170.000

BOAL,T_GENSET176,3100,20001016161100,N,20001016202400,170.000,20001016203000,180.000

FTR,22

For Settlement Dates on or after the P217 effective date the following data will be reported:

HDR,PHYSICAL BM DATA,20001016,43

PN,T_GENSET176,43,20001016200000,170.000,20001016200600,180.000

PN,T_GENSET176,43,20001016200600,180.000,20001016201200,180.000

PN,T_GENSET176,43,20001016201200,180.000,20001016201800,160.000

PN,T_GENSET176,43,20001016201800,160.000,20001016202400,160.000

PN,T_GENSET176,43,20001016202400,160.000,20001016203000,170.000

QPN,T_GENSET176,43,20001016200000,10.000,20001016201000,15.000

QPN,T_GENSET176,43,20001016201000,15.000,20001016202000,5.000

QPN,T_GENSET176,43,20001016202000,5.000,20001016203000,10.000

MEL,T_GENSET176,43,20001016200000,200.000,20001016201500,210.000

MEL,T_GENSET176,43,20001016201500,210.000,20001016203000,200.000

MIL,T_GENSET176,43,20001016200000,-200.000,20001016201500,-210.000

MIL,T_GENSET176,43,20001016201500,-210.000,20001016203000,-200.000

BOALF,T_GENSET176,3000,20001016160000,N,F,,20001016200000,175.000,20001016200600,185.000

BOALF,T_GENSET176,3000,20001016160000,N,F,,20001016200600,185.000,20001016201200,185.000

BOALF,T_GENSET176,3000,20001016160000,N,F,,20001016201200,185.000,20001016201800,165.000

BOALF,T_GENSET176,3000,20001016160000,N,F,,20001016201800,165.000,20001016202400,165.000

BOALF,T_GENSET176,3000,20001016160000,N,F,,20001016202400,165.000,20001016203000,175.000

BOALF,T_GENSET176,3100,20001016161100,N,F,,20001016200000,180.000,20001016200600,190.000

BOALF,T_GENSET176,3100,20001016161100,N,F,,20001016200600,190.000,20001016201200,190.000

BOALF,T_GENSET176,3100,20001016161100,N,F,,20001016201200,190.000,20001016201800,170.000

BOALF,T_GENSET176,3100,20001016161100,N,F,,20001016201800,170.000,20001016202400,170.000

BOALF,T_GENSET176,3100,20001016161100,N,F,,20001016202400,170.000,20001016203000,180.000

FTR,22

For Settlement Dates on or after the P305 effective date the following data will be reported:

HDR,PHYSICAL BM DATA,20001016,43

PN,T_GENSET176,43,20001016200000,170.000,20001016200600,180.000

PN,T_GENSET176,43,20001016200600,180.000,20001016201200,180.000

PN,T_GENSET176,43,20001016201200,180.000,20001016201800,160.000

PN,T_GENSET176,43,20001016201800,160.000,20001016202400,160.000

PN,T_GENSET176,43,20001016202400,160.000,20001016203000,170.000

QPN,T_GENSET176,43,20001016200000,10.000,20001016201000,15.000

QPN,T_GENSET176,43,20001016201000,15.000,20001016202000,5.000

QPN,T_GENSET176,43,20001016202000,5.000,20001016203000,10.000

MEL,T_GENSET176,43,20001016200000,200.000,20001016201500,210.000

MEL,T_GENSET176,43,20001016201500,210.000,20001016203000,200.000

MIL,T_GENSET176,43,20001016200000,-200.000,20001016201500,-210.000

MIL,T_GENSET176,43,20001016201500,-210.000,20001016203000,-200.000

BOALF,T_GENSET176,3000,20001016160000,N,F,F,F,F,20001016200000,175.000,20001016200600,185.000

BOALF,T_GENSET176,3000,20001016160000,N,F,F,F,F,20001016200600,185.000,20001016201200,185.000

BOALF,T_GENSET176,3000,20001016160000,N,F,F,F,F,20001016201200,185.000,20001016201800,165.000

BOALF,T_GENSET176,3000,20001016160000,N,F,F,F,F,20001016201800,165.000,20001016202400,165.000

BOALF,T_GENSET176,3000,20001016160000,N,F,F,F,F,20001016202400,165.000,20001016203000,175.000

BOALF,T_GENSET176,3100,20001016161100,N,F,F,F,F,20001016200000,180.000,20001016200600,190.000

BOALF,T_GENSET176,3100,20001016161100,N,F,F,F,F,20001016200600,190.000,20001016201200,190.000

BOALF,T_GENSET176,3100,20001016161100,N,F,F,F,F,20001016201200,190.000,20001016201800,170.000

BOALF,T_GENSET176,3100,20001016161100,N,F,F,F,F,20001016201800,170.000,20001016202400,170.000

BOALF,T_GENSET176,3100,20001016161100,N,F,F,F,F,20001016202400,170.000,20001016203000,180.000

FTR,22

8.1.10 Dynamic Data

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed string “DYNAMIC DATA”

Settlement Date

date

yyyymmdd

Settlement Period

string

number between 1 and 50 or * if selecting a full day’s data

Body Record Run Up Rate Export

Field

Type

Format

Comments

Record Type (RURE)

string

Fixed String “RURE”

BM Unit ID

string

Ordered by this field first, incrementing

Time

datetime

yyyymmddhh24miss

Ordered by this field second, incrementing

Rate 1

number

Elbow 2

number

Rate 2

number

Elbow 3

number

Rate 3

number

Body Record Run Down Rate Export

Field

Type

Format

Comments

Record Type (RDRE)

string

Fixed String “RDRE”

BM Unit ID

string

Ordered by this field first, incrementing

Time

datetime

yyyymmddhh24miss

Ordered by this field second, incrementing

Rate 1

number

Elbow 2

number

Rate 2

number

Elbow 3

number

Rate 3

number

Body Record Run Up Rate Import

Field

Type

Format

Comments

Record Type (RURI)

string

Fixed String “RURI”

BM Unit ID

string

Ordered by this field first, incrementing

Time

datetime

yyyymmddhh24miss

Ordered by this field second, incrementing

Rate 1

number

Elbow 2

number

Rate 2

number

Elbow 3

number

Rate 3

number

Body Record Run Down Rate Import

Field

Type

Format

Comments

Record Type (RDRI)

string

Fixed String “RDRI”

BM Unit ID

string

Ordered by this field first, incrementing

Time

datetime

yyyymmddhh24miss

Ordered by this field second, incrementing

Rate 1

number

Elbow 2

number

Rate 2

number

Elbow 3

number

Rate 3

number

Body Record Notice to Deviate from Zero

Field

Type

Format

Comments

Record Type (NDZ)

string

Fixed String “NDZ”

BM Unit ID

string

Ordered by this field first, incrementing

Time

datetime

yyyymmddhh24miss

Ordered by this field second, incrementing

Notice

number

Body Record Notice to Deliver Bids

Field

Type

Format

Comments

Record Type

string

Fixed String “NDB”

BM Unit ID

string

Ordered by this field first, incrementing

Time

datetime

yyyymmddhh24miss

Ordered by this field second, incrementing

Notice

number

Body Record Notice to Deliver Offers

Field

Type

Format

Comments

Record Type

string

Fixed String “NDO”

BM Unit ID

string

Ordered by this field first, incrementing

Time

datetime

yyyymmddhh24miss

Ordered by this field second, incrementing

Notice

number

Body Record Minimum Zero Time

Field

Type

Format

Comments

Record Type

string

Fixed String “MZT”

BM Unit ID

string

Ordered by this field first, incrementing

Time

datetime

yyyymmddhh24miss

Ordered by this field second, incrementing

Period

number

Body Record Minimum Non-Zero Time

Field

Type

Format

Comments

Record Type

string

Fixed String “MNZT”

BM Unit ID

string

Ordered by this field first, incrementing

Time

datetime

yyyymmddhh24miss

Ordered by this field second, incrementing

Period

number

Body Record Stable Export Limit

Field

Type

Format

Comments

Record Type

string

Fixed String “SEL”

BM Unit ID

string

Ordered by this field first, incrementing

Time

datetime

yyyymmddhh24miss

Ordered by this field second, incrementing

Level

number

Body Record Stable Import Limit

Field

Type

Format

Comments

Record Type

string

Fixed String “SIL”

BM Unit ID

string

Ordered by this field first, incrementing

Time

datetime

yyyymmddhh24miss

Ordered by this field second, incrementing

Level

number

Body Record Maximum Delivery Volume

Field

Type

Format

Comments

Record Type

string

Fixed String “MDV”

BM Unit ID

string

Ordered by this field first, incrementing

Time

datetime

yyyymmddhh24miss

Ordered by this field second, incrementing

Level

number

Body Record Maximum Delivery Period

Field

Type

Format

Comments

Record Type

string

Fixed String “MDP”

BM Unit ID

string

Ordered by this field first, incrementing

Time

datetime

yyyymmddhh24miss

Ordered by this field second, incrementing

Period

number

Example File

HDR,DYNAMIC DATA,20001018,*

RURE,E_EMBEDD139,20001018150400,10.0,30,5.0,40,2.0

RDRE,E_EMBEDD139,20001018150400,10.0,30,5.0,40,2.0

RURI,E_EMBEDD139,20001018150400,10.0,-30,5.0,-40,2.0

RDRI,E_EMBEDD139,20001018150400,10.0,-30,5.0,-40,2.0

NDZ,E_EMBEDD139,20001018145200,20.000

NDB,E_EMBEDD139,20001018145200,20.000

NDO,E_EMBEDD139,20001018145200,20.000

MZT,E_EMBEDD139,20001018145200,20.000

MNZT,E_EMBEDD139,20001018145200,20.000

SEL,E_EMBEDD139,20001018145200,110.000

SIL,E_EMBEDD139,20001018145200,-110.000

MDV,E_EMBEDD139,20001018145200,90.000

MDP,E_EMBEDD139,20001018145200,30.000

FTR,13

8.1.11 Bid-Offer Level Data

Header Record Bid-Offer Level Data

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed string “BID OFFER LEVEL DATA”

Settlement Date

date

yyyymmdd

Settlement Period

string

number between 1 and 50 or * if selecting a full day’s data

Body Record Bid-Offer Level Data

Field

Type

Format

Comments

Record Type (BOD)

string

Fixed String “BOD”

BM Unit ID

string

Group ordered firstly by this field, incrementing.

Bid Offer Pair Number

number

Group ordered thirdly by this field, decrementing.

From Time

datetime

yyyymmddhh24miss

Group ordered secondly by this field, incrementing.

From Level

number

To Time

datetime

yyyymmddhh24miss

To Level

number

Bid Price

number

Offer Price

number

Example File

HDR,BID OFFER LEVEL DATA,20001016,*

BOD,T_GENSET176,-2,20001016173000,-10.000,20001016180000,-10.000,10.00000,15.00000

BOD,T_GENSET176,-1,20001016173000,-10.000,20001016180000,-10.000,20.00000,25.00000

BOD,T_GENSET176,1,20001016173000,10.000,20001016180000,10.000,30.00000,35.00000

BOD,T_GENSET176,2,20001016173000,10.000,20001016180000,10.000,40.00000,45.00000

BOD,T_GENSET176,3,20001016173000,10.000,20001016180000,10.000,50.00000,55.00000

FTR,5

8.1.12 Derived BM Unit Data

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed string “DERIVED DATA”

Settlement Date

date

yyyymmdd

Settlement Period

string

number between 1 and 50 or * if selecting a full day’s data

Body Record Bid Acceptance Volumes

Field

Type

Format

Comments

Record Type

string

Fixed String “BAV”

BM Unit ID

string

Ordered by this field first, incrementing

Settlement Period

number

number between 1 and 50

Acceptance ID

number

Ordered by this field second, incrementing

Short Acceptance Flag

SA

Flag indicating whether this acceptance was a “short” acceptance.

RR Instruction Flag

Boolean

Volume Accepted for Bid-Offer Pair -6

number

Volume Accepted for Bid-Offer Pair -5

number

Volume Accepted for Bid-Offer Pair -4

number

Volume Accepted for Bid-Offer Pair -3

number

Volume Accepted for Bid-Offer Pair -2

number

Volume Accepted for Bid-Offer Pair -1

number

Volume Accepted for Bid-Offer Pair 1

number

Volume Accepted for Bid-Offer Pair 2

number

Volume Accepted for Bid-Offer Pair 3

number

Volume Accepted for Bid-Offer Pair 4

number

Volume Accepted for Bid-Offer Pair 5

number

Volume Accepted for Bid-Offer Pair 6

number

Total

number

Body Record Offer Acceptance Volumes

Field

Type

Format

Comments

Record Type

string

Fixed String “OAV”

BM Unit ID

string

Ordered by this field first, incrementing

Settlement Period

number

number between 1 and 50

Acceptance ID

number

Ordered by this field second, incrementing

Short Acceptance Flag

SA

Flag indicating whether this acceptance was a “short” acceptance.

RR Instruction Flag

Boolean

Volume Accepted for Bid-Offer Pair -6

number

Volume Accepted for Bid-Offer Pair -5

number

Volume Accepted for Bid-Offer Pair -4

number

Volume Accepted for Bid-Offer Pair -3

number

Volume Accepted for Bid-Offer Pair -2

number

Volume Accepted for Bid-Offer Pair -1

number

Volume Accepted for Bid-Offer Pair 1

number

Volume Accepted for Bid-Offer Pair 2

number

Volume Accepted for Bid-Offer Pair 3

number

Volume Accepted for Bid-Offer Pair 4

number

Volume Accepted for Bid-Offer Pair 5

number

Volume Accepted for Bid-Offer Pair 6

number

Total

number

Body Record Indicative Period Bid Acceptance Volumes

For Settlement Dates prior to the P217 effective date the body record will have the following format:

Field

Type

Format

Comments

Record Type

string

Fixed String “IPBAV”

BM Unit ID

string

Ordered by this field first, incrementing

Settlement Period

number

number between 1 and 50; ordered by this field second, incrementing

Volume Accepted for Bid-Offer Pair -6

number

Volume Accepted for Bid-Offer Pair -5

number

Volume Accepted for Bid-Offer Pair -4

number

Volume Accepted for Bid-Offer Pair -3

number

Volume Accepted for Bid-Offer Pair -2

number

Volume Accepted for Bid-Offer Pair -1

number

Volume Accepted for Bid-Offer Pair 1

number

Volume Accepted for Bid-Offer Pair 2

number

Volume Accepted for Bid-Offer Pair 3

number

Volume Accepted for Bid-Offer Pair 4

number

Volume Accepted for Bid-Offer Pair 5

number

Volume Accepted for Bid-Offer Pair 6

number

Total

number

For Settlement Dates on or after the P217 effective date the body record will have the following format:

Field

Type

Format

Comments

Record Type

string

Fixed String “IPBAV”

BM Unit ID

string

Ordered by this field first, incrementing

Settlement Period

number

number between 1 and 50; ordered by this field second, incrementing

Data Type

string

‘O’ for Original

‘T’ for Tagged

‘R’ for Repriced

‘N’ for Originally-Priced (Not Repriced)

RR Instruction Flag

Boolean

Volume Accepted for Bid-Offer Pair -6

number

Volume Accepted for Bid-Offer Pair -5

number

Volume Accepted for Bid-Offer Pair -4

number

Volume Accepted for Bid-Offer Pair -3

number

Volume Accepted for Bid-Offer Pair -2

number

Volume Accepted for Bid-Offer Pair -1

number

Volume Accepted for Bid-Offer Pair 1

number

Volume Accepted for Bid-Offer Pair 2

number

Volume Accepted for Bid-Offer Pair 3

number

Volume Accepted for Bid-Offer Pair 4

number

Volume Accepted for Bid-Offer Pair 5

number

Volume Accepted for Bid-Offer Pair 6

number

Total

number

Body Record Indicative Period Offer Acceptance Volumes

For Settlement Dates prior to the P217 effective date the body record will have the following format:

Field

Type

Format

Comments

Record Type

string

Fixed String “IPOAV”

BM Unit ID

string

Ordered by this field first, incrementing

Settlement Period

number

number between 1 and 50; ordered by this field second, incrementing

Volume Accepted for Bid-Offer Pair -6

number

Volume Accepted for Bid-Offer Pair -5

number

Volume Accepted for Bid-Offer Pair -4

number

Volume Accepted for Bid-Offer Pair -3

number

Volume Accepted for Bid-Offer Pair -2

number

Volume Accepted for Bid-Offer Pair -1

number

Volume Accepted for Bid-Offer Pair 1

number

Volume Accepted for Bid-Offer Pair 2

number

Volume Accepted for Bid-Offer Pair 3

number

Volume Accepted for Bid-Offer Pair 4

number

Volume Accepted for Bid-Offer Pair 5

number

Volume Accepted for Bid-Offer Pair 6

number

Total

number

For Settlement Dates on or after to the P217 effective date the body record will have the following format:

Field

Type

Format

Comments

Record Type

string

Fixed String “IPOAV”

BM Unit ID

string

Ordered by this field first, incrementing

Settlement Period

number

number between 1 and 50; ordered by this field second, incrementing

Data Type

string

‘O’ for Original

‘T’ for Tagged

‘R’ for Repriced

‘N’ for Originally-Priced (Not Repriced)

RR Instruction Flag

Boolean

Volume Accepted for Bid-Offer Pair -6

number

Volume Accepted for Bid-Offer Pair -5

number

Volume Accepted for Bid-Offer Pair -4

number

Volume Accepted for Bid-Offer Pair -3

number

Volume Accepted for Bid-Offer Pair -2

number

Volume Accepted for Bid-Offer Pair -1

number

Volume Accepted for Bid-Offer Pair 1

number

Volume Accepted for Bid-Offer Pair 2

number

Volume Accepted for Bid-Offer Pair 3

number

Volume Accepted for Bid-Offer Pair 4

number

Volume Accepted for Bid-Offer Pair 5

number

Volume Accepted for Bid-Offer Pair 6

number

Total

number

Body Record Indicative Period Bid Cashflow

Field

Type

Format

Comments

Record Type

string

Fixed String “IPBC”

BM Unit ID

string

Ordered by this field first, incrementing

Settlement Period

number

number between 1 and 50; ordered by this field second, incrementing

Cashflow for Bid-Offer Pair -6

number

Cashflow for Bid-Offer Pair -5

number

Cashflow for Bid-Offer Pair -4

number

Cashflow for Bid-Offer Pair -3

number

Cashflow for Bid-Offer Pair -2

number

Cashflow for Bid-Offer Pair -1

number

Cashflow for Bid-Offer Pair 1

number

Cashflow for Bid-Offer Pair 2

number

Cashflow for Bid-Offer Pair 3

number

Cashflow for Bid-Offer Pair 4

number

Cashflow for Bid-Offer Pair 5

number

Cashflow for Bid-Offer Pair 6

number

Total

number

Body Record Indicative Period Offer Cashflow

Field

Type

Format

Comments

Record Type

string

Fixed String “IPOC”

BM Unit ID

string

Ordered by this field first, incrementing

Settlement Period

number

number between 1 and 50; ordered by this field second, incrementing

Cashflow for Bid-Offer Pair -6

number

Cashflow for Bid-Offer Pair -5

number

Cashflow for Bid-Offer Pair -4

number

Cashflow for Bid-Offer Pair -3

number

Cashflow for Bid-Offer Pair -2

number

Cashflow for Bid-Offer Pair -1

number

Cashflow for Bid-Offer Pair 1

number

Cashflow for Bid-Offer Pair 2

number

Cashflow for Bid-Offer Pair 3

number

Cashflow for Bid-Offer Pair 4

number

Cashflow for Bid-Offer Pair 5

number

Cashflow for Bid-Offer Pair 6

number

Total

number

Example File

For Settlement Dates prior to the P217 effective date the body record will have the following format:

HDR,DERIVED DATA,20001018,33

BAV,T_GENSET176,33,3000,L,,,,,,,-5.0000,,,,,,-5.0000

BAV,T_GENSET176,33,3100,L,,,,,,,-5.0000,,,,,,-5.0000

OAV,T_GENSET176,33,3000,L,,,,,,,2.5000,,,,,,2.5000

OAV,T_GENSET176,33,3100,L,,,,,,,2.5000,,,,,,2.5000

IPBAV,T_GENSET176,33,,,,,,,-10.000,,,,,,-10.000

IPOAV,T_GENSET176,33,,,,,,,5.000,,,,,,5.000

IPBC,T_GENSET176,33,,,,,,,-50.00,,,,,,-50.00

IPOC,T_GENSET176,33,,,,,,,175.00,,,,,,175.00

FTR,8

For Settlement Dates on or after the P217 effective date the body record will have the following format:

HDR,DERIVED DATA,20001018,33

BAV,T_GENSET176,33,3000,L,T,,,,,,,-5.0000,,,,,,-5.0000

BAV,T_GENSET176,33,3100,L,T,,,,,,,-5.0000,,,,,,-5.0000

OAV,T_GENSET176,33,3000,L,T,,,,,,,2.5000,,,,,,2.5000

OAV,T_GENSET176,33,3100,L,T,,,,,,,2.5000,,,,,,2.5000

IPBAV,T_GENSET176,33,O,T,,,,,,,-10.000,,,,,,-10.000

IPBAV,T_GENSET176,33,T,T,,,,,,,0.000,,,,,,-10.000

IPBAV,T_GENSET176,33,R,T,,,,,,,0.000,,,,,,-10.000

IPBAV,T_GENSET176,33,N,T,,,,,,,-10.000,,,,,,-10.000

IPOAV,T_GENSET176,33,O,T,,,,,,,5.000,,,,,,5.000

IPOAV,T_GENSET176,33,T,T,,,,,,,0.000,,,,,,5.000

IPOAV,T_GENSET176,33,R,T,,,,,,,0.000,,,,,,5.000

IPOAV,T_GENSET176,33,N,T,,,,,,,5.000,,,,,,5.000

IPBC,T_GENSET176,33,,,,,,,-50.00,,,,,,-50.00

IPOC,T_GENSET176,33,,,,,,,175.00,,,,,,175.00

FTR,8

8.1.13 Derived System-wide Data

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed string “SYSTEM BUY SELL DATA”

Body Record System Buy/Sell Prices

For Settlement Dates prior to the P217 effective date the body record will have the following format:

Field

Type

Format

Comments

Record Type

string

Fixed String “SSB”

Settlement Date

date

yyyymmdd

Group ordered by this field first, incrementing.

Settlement Period

number

Group ordered by this field second, incrementing.

System Sell Price

number

System Buy Price

number

BSAD Default

boolean

True if following BSAD data represents default values

Price Derivation Code

string

Indicative Net Imbalance Volume

number

The Indicative NIV

Net Energy Sell Price Cost Adjustment

number

ESCA used in derivation of the main price

Net Energy Sell Price Volume Adjustment

number

ESVA used in derivation of the main price

Net System Sell Price Volume Adjustment

number

SSVA used in derivation of the main price

Sell Price Price Adjustment

number

SPA used in derivation of the main price

Net Energy Buy Price Cost Adjustment

number

EBCA used in derivation of the main price

Net Energy Buy Price Volume Adjustment

number

EBVA used in derivation of the main price

Net System Buy Price Volume Adjustment

number

SBVA used in derivation of the main price

Buy Price Price Adjustment

number

BPA used in derivation of the main price

For Settlement Dates on or after the P217 effective date the body record will have the following format:

Field

Type

Format

Comments

Record Type

string

Fixed String “SSB”

Settlement Date

date

yyyymmdd

Group ordered by this field first, incrementing.

Settlement Period

number

Group ordered by this field second, incrementing.

System Sell Price

number

System Buy Price

number

BSAD Default

boolean

True if following BSAD data represents default values

Price Derivation Code

string

Reserve Scarcity Price

number

£/MWh

Replacement Price

number

£/ MWh

Replacement Price Calculation Volume

number

MWh

Indicative Net Imbalance Volume

number

The Indicative NIV

Total System Accepted Offer Volume

number

MWh

Total System Accepted Bid Volume

number

MWh

Total System Tagged Accepted Offer Volume

number

MWh

Total System Tagged Accepted Bid Volume

number

MWh

System Total Priced Accepted Offer Volume

number

MWh

System Total Priced Accepted Bid Volume

number

MWh

Total System Adjustment Sell Volume

number

MWh

Total System Adjustment Buy Volume

number

MWh

Total System Tagged Adjustment Sell Volume

number

MWh

Total System Tagged Adjustment Buy Volume

number

MWh

Example File

For Settlement Dates prior to the P217 effective date an example file would look like this:

HDR,SYSTEM BUY SELL DATA

SSB,20001018,33,32.66245,34.96198,F,A,0.000,0.00,0.000,0.000,0.00,0.00,0.000,0.000,0.00

SSB,20001018,36,31.74655,34.96312,F,L,0.000,0.00,0.000,0.000,0.00,0.00,0.000,0.000,0.00

SSB,20001018,37,1.00000,1.00000,T,E,0.000,0.00,0.000,0.000,0.00,0.00,0.000,0.000,0.00

FTR,3

For Settlement Dates on and after the P217 effective date an example file would look like this:

HDR,SYSTEM BUY SELL DATA

SSB,20001018,33,32.66245,34.96198,F,N,0.000,0.000,0.00,0.000,0.000,0.00,0.00,0.000,0.000,0.00,0.00,0.00,0.00,0.00

SSB,20001018,36,31.74655,34.96312,F,L,,0.000,0.00,0.000,0.000,0.00,0.00,0.000,0.000,0.00,0.00,0.00,0.00,0.00

SSB,20001018,37,1.00000,1.00000,T,E,,0.000,0.00,0.000,0.000,0.00,0.00,0.000,0.000,0.00,0.00,0.00,0.00,0.00

FTR,3

Please note that RSP will be null for dates on or after the P217 effective date until the P305 effective date.

8.1.14 Market Depth Data

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed string “MARKET DEPTH DATA”

Body Record Market Depth Data

Field

Type

Format

Comments

Record Type

string

Fixed String “MDD”

Settlement Date

date

yyyymmdd

Group ordered by this field first, incrementing.

Settlement Period

number

Group ordered by this field second, incrementing.

IMBALNGC

number

Total Offer Volume

number

Total Bid Volume

number

Total Accepted Offer Volume

number

Total Accepted Bid Volume

number

Total Unpriced Accepted Offer Volume

number

Total Unpriced Accepted Bid Volume

number

Total Priced Accepted Offer Volume

number

Total Priced Accepted Bid Volume

number

Example File

HDR,MARKET DEPTH DATA

MDD,20001206,1,1936.000,,,,,,,,

MDD,20001206,2,1755.000,,,,,,,,

MDD,20001206,3,1676.000,,,,,,,,

MDD,20001206,4,1665.000,,,,,,,,

FTR,4

8.1.15 Latest Acceptances

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed string “LATEST ACCEPTANCE DATA”

Body Record Latest Acceptance Data

Field

Type

Format

Comments

Record Type

string

Fixed String “LAD”

BM Unit Id

string

Acceptance Number

number

Acceptance Time

datetime

yyyymmddhh24miss

Group ordered by this field first, decrementing.

From Time

datetime

yyyymmddhh24miss

Group ordered by this field second, incrementing.

Example File

HDR,LATEST ACCEPTANCE DATA

LAD,GEN1,12771,20001201232800,20001202030000

LAD,SUPBMU21,12770,20001201232600,20001202030000

LAD,EMBEDG111,12769,20001201232400,20001202030000

LAD,T_GENSET199,12768,20001201231400,20001202030000

LAD,GENSET209,12767,20001201231400,20001202030000

FTR,5

8.1.16 Historic Acceptances

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed string “ACCEPTANCE DATA”

Settlement Date

date

yyyymmdd

Settlement Period

string

number between 1 and 50 or * if selecting a full day’s data

Body Record Historic Acceptance Data

Field

Type

Format

Comments

Record Type

string

Fixed String “HAD”

BM Unit Id

string

Acceptance Number

number

Acceptance Time

datetime

yyyymmddhh24miss

Group ordered by this field first, incrementing.

Offer Price

number

Bid Price

number

Note that this includes all acceptances which overlap the specified settlement Date and Period.

Note that where the acceptance overlaps more than one bid-offer pair, a separate record will be shown for each giving the appropriate prices.

Example File

HDR,ACCEPTANCE DATA,20001201,6

HAD,T_GENSET199,12768,20001201231400,75.00000,70.00000

HAD,GENSET209,12767,20001201231400,55.00000,40.00000

HAD,EMBEDG111,12769,20001201232400,65.00000,65.00000

HAD,SUPBMU21,12770,20001201232600,60.00000,20.00000

HAD,GEN1,12771,20001201232800,75.00000,60.00000

FTR,5

8.1.17 Balancing Services Adjustment Data

Header Record

Field

Type

Format

Comments

Record Type

String

Fixed String “HDR”

File Type

String

Fixed string “BALANCING SERVICES ADJUSTMENT DATA”

Body Record Balancing Services Adjustment Data

Note that for Settlement Dates on or after the P217 effective date the following data items will always be zero:

    • Net Energy Buy Price Cost Adjustment (EBCA)

    • Net Energy Buy Price Volume Adjustment (EBVA)

    • Net System Buy Price Volume Adjustment (SBVA)

    • Net Energy Sell Price Cost Adjustment (ESCA)

    • Net Energy Sell Price Volume Adjustment (ESVA)

    • Net System Sell Price Volume Adjustment (SSVA)

Field

Type

Format

Comments

Record Type

string

Fixed String “BSAD

Settlement Date

date

yyyymmdd

Group ordered by this field first, incrementing.

Settlement Period

number

Group ordered by this field second, incrementing.

Net Energy Sell Price Cost Adjustment

number

ESCA £

Net Energy Sell Price Volume Adjustment

number

ESVA MWh

Net System Sell Price Volume Adjustment

number

SSVA MWh

Sell Price Price Adjustment

number

SPA £/MWh

Net Energy Buy Price Cost Adjustment

number

EBCA £

Net Energy Buy Price Volume Adjustment

number

EBVA MWh

Net System Buy Price Volume Adjustment

number

SBVA MWh

Buy Price Price Adjustment

number

BPA £/MWh

Body Record Balancing Services Adjustment Action Data

For Settlement Dates on and after the P217 effective date the following data will be reported:

Field

Type

Format

Comments

Record Type

string

Fixed String “DISAG”

Settlement Date

date

yyyymmdd

Group ordered by this field first, incrementing.

Settlement Period

number

Group ordered by this field second, incrementing.

Action Identifier

number

SO-Flag

boolean

T or F

‘T’ if potentially impacted by transmission constraints.

Balancing Services Adjustment Action STOR Provider Flag

boolean

T or F

‘T’ if related to a STOR Provider

This field will be null if pre-P305 Settlement Date

Action Cost

number

£ (can be NULL)

Action Volume

number

MWh

Example File

For Settlement Dates on, and after prior to the P217 effective date an example file would look like this:

HDR,BALANCING SERVICES ADJUSTMENT DATA

BSAD,20001018,33,0.00,0.000,0.000,0.00,0.00,0.000,0.000,0.00

BSAD,20001018,36,0.00,0.000,0.000,0.00,0.00,0.000,0.000,0.00

BSAD,20001018,37,0.00,0.000,0.000,0.00,0.00,0.000,0.000,0.00

FTR,3

For Settlement Dates on and after the P217 effective date an example file would look like this:

HDR,BALANCING SERVICES ADJUSTMENT DATA

BSAD,20001018,33,0.00,0.000,0.000,13.1,0.00,0.000,0.000,0.00

DISAG,20001018,33,1,F,,5.00,1.23

DISAG,20001018,33,2,T,,0.000

DISAG,20001018,33,3,F,,10.00,4.5

BSAD,20001018,36,0.00,0.000,0.000,0.00,0.00,0.000,0.000,4.57

DISAG,20001018,36,1,T,,6.00,2.2

DISAG,20001018,36,2,T,,3.00,6.000

BSAD,20001018,37,0.00,0.000,0.000,0.00,0.00,0.000,0.000,11.00

DISAG,20001018,37,1,F,,5.00,7.113

DISAG,20001018,37,2,T,,10.00,5.051

DISAG,20001018,37,3,T,,3.00,0.309

DISAG,20001018,37,4,F,,7.00,0.099

FTR,3

For Settlement Dates on and after the P305 effective date an example file would look like this:

HDR,BALANCING SERVICES ADJUSTMENT DATA

BSAD,20001018,33,0.00,0.000,0.000,13.1,0.00,0.000,0.000,0.00

DISAG,20001018,33,1,F,F,5.00,1.23

DISAG,20001018,33,2,T,F,0.000

DISAG,20001018,33,3,F,F,10.00,4.5

BSAD,20001018,36,0.00,0.000,0.000,0.00,0.00,0.000,0.000,4.57

DISAG,20001018,36,1,T,F, 6.00,2.2

DISAG,20001018,36,2,T,F, 3.00,6.000

BSAD,20001018,37,0.00,0.000,0.000,0.00,0.00,0.000,0.000,11.00

DISAG,20001018,37,1,F,F, 5.00,7.113

DISAG,20001018,37,2,T,F, 10.00,5.051

DISAG,20001018,37,3,T,F, 3.00,0.309

DISAG,20001018,37,4,F,F, 7.00,0.099

FTR,3

8.1.18 Market Index Data

Header Record

Field

Type

Format

Comments

Record Type

String

Fixed String “HDR”

File Type

String

Fixed string “MARKET INDEX DATA”

Body Record Market Index Data

Field

Type

Format

Comments

Record Type

string

Fixed String “MID”

Market Index Data Provider ID

string

Group ordered by this field first, incrementing.

Settlement Date

date

yyyymmdd

Group ordered by this field second, incrementing.

Settlement Period

number

Group ordered by this field third, incrementing.

Market Index Price

number

£/MWh

Market Index Volume

number

MWh

4.5.15.3 Example File

HDR,MARKET INDEX DATA

MID,NNCUK,20001018,33,10.000,40.000

MID,NNCUK,20001018,36,20.000,50.000

MID,NNCUK,20001018,37,10.000,30.000

FTR,3

8.1.19 Applicable Balancing Services Volume Data

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed string “APPLICABLE BALANCING SERVICES VOLUME”

Body Record Applicable Balancing Services Volume Data

Field

Type

Format

Comments

Record Type

string

Fixed String “QAS”

BM Unit ID

string

Settlement Period

number

Group ordered by this field second, incrementing.

BM Unit Applicable Balancing Services Volume

number

Example File

HDR,APPLICABLE BALANCING SERVICES VOLUME,20001016,1

QAS,T_GENERATE,1,38889.000

QAS,E_EMBED,1,39066.000

FTR,2

8.1.20 Credit Default Notice Data

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed string “CREDIT DEFAULT NOTICE DATA”

Body Record

Field

Type

Format

Comments

Record Type

string

Fixed String “CDN”

Participant ID

string

Records ordered incrementing by this field

Credit Default Level

number

1 or 2

Entered Default Settlement Date

date

yyyymmdd

Entered Default Settlement Period

number

Cleared Default Settlement Date

date

yyyymmdd

May be NULL

Cleared Default Settlement Period

number

May be NULL

Cleared Default Text

string

May be NULL

Example File

HDR, CREDIT DEFAULT NOTICE DATA

CDN,PARTY01,1,20021127,12,20021128,2,Credit Cover Percentage <= 75 percent

CDN,PARTY02,2,20021126,11,,,

FTR,2

8.1.21 Temperature Data

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed string “TEMPERATURE DATA”

Body Record Temperature Data

Field

Type

Format

Comments

Record Type

string

Fixed String “TEMP”

Spot Time

datetime

yyyymmddhh24miss

Group ordered by this field first, incrementing.

Temperature Out-Turn

number

Normal Reference Temperature

number

Low Reference Temperature

number

High Reference Temperature

number

Example File

HDR,TEMPERATURE DATA

TEMP,20081016091503,18.3,17.2,12.3,22.4

FTR,1

8.1.22 Wind Generation Forecast and Outturn Data

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed string “WIND GENERATION FORECAST AND OUTTURN DATA”

Body Record Wind Generation Forecast and Outturn Data

Field

Type

Format

Comments

Record Type

string

Fixed String “WIND”

Settlement Date

date

yyyymmdd

Group ordered by this field first, incrementing.

Settlement Period

number

Group ordered by this field second, incrementing.

Publication Time (Initial Forecast)

datetime

yyyymmddhh24miss

Optional field

Initial Forecast Generation (MW)

number

Optional field

Publication Time (Latest Forecast)

datetime

yyyymmddhh24miss

Optional field

Latest Forecast Generation (MW)

number

Optional field

Publication Time (Outturn)

datetime

yyyymmddhh24miss

Outturn Generation (MW)

number

Example File

HDR,WIND GENERATION FORECAST AND OUTTURN DATA

WIND,20080429,1,20080427170000,1001, 20080428170000,1011,20080429003500,1221

WIND,20080429,2,,,,,20080429010500,1221

WIND,20080429,3,,,,,20080429013500,1221

WIND,20080429,4,,,,,20080429020500,1221

WIND,20080429,5,,,,,20080429023500,1221

WIND,20080429,6,,,,,20080429030500,1221

WIND,20080429,7,,,,,20080429033500,1221

WIND,20080429,8,,,,,20080429040500,1221

WIND,20080429,9,,,,,20080429043500,1221

WIND,20080429,10,,,,,20080429050500,1221

WIND,20080429,11, 20080427170000,1147,20080428170000,1157,20080429053500,1221

WIND,20080429,12,,,,,20080429060500,1221

WIND,20080429,13,,,,,20080429063500,1221

WIND,20080429,14,,,,,20080429070500,1221

WIND,20080429,15,,,,,20080429073500,1221

WIND,20080429,16,,,,,20080429080500,1221

WIND,20080429,17, 20080427170000,1205,20080428170000,1200,20080429083500,1221

WIND,20080429,18,,,,,20080429090500,1221

WIND,20080429,19,,,,,20080429093500,1221

WIND,20080429,20,,,,,20080429100500,1221

FTR,20

8.1.23 Instantaneous Generation By Fuel Type

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed string “INSTANTANEOUS GENERATION BY FUEL TYPE DATA”

[1831-B]Body Record Instantaneous Generation By Fuel Type Data

Field

Type

Format

Comments

Record Type

string

Fixed String “FUELINST”

Settlement Date

date

yyyymmdd

Group ordered by this field first, incrementing.

Settlement Period

number

Group ordered by this field second, incrementing.

Spot Time

datetime

yyyymmddhh24miss

CCGT (MW)

number

OIL (MW)

number

COAL (MW)

number

NUCLEAR (MW)

number

WIND (MW)

number

PS (MW)

number

NPSHYD (MW)

number

OCGT (MW)

number

OTHER (MW)

number

INTFR (MW)

number

INTIRL (MW)

number

INTNED (MW)

number

INTEW (MW)

number

BIOMASS (MW)

number

INTNEM (MW)

number

INTELEC (MW)

number

INTIFA2 (MW)

number

INTNSL (MW)

number

INTVKL (MW)

number

Example File

HDR, INSTANTANEOUS GENERATION BY FUEL TYPE DATA

FUELINST,20080428,37,20080428170503,18137,1850,0,15315,7308,189,15,15,0,55,152,21,22,27,28,30,31,50

FUELINST,20080428,37,20080428171007,18134,1849,0,15312,7307,181,16,14,0,52,150,13,17,27,31,30,31,50

FTR,2

8.1.24 Half Hourly Outturn Generation By Fuel Type

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed string “HALF HOURLY OUTTURN GENERATION BY FUEL TYPE DATA”

[1831-B]Body Record Half Hourly Outturn Generation By Fuel Type Data

Field

Type

Format

Comments

Record Type

string

Fixed String “FUELHH”

Settlement Date

date

yyyymmdd

Group ordered by this field first, incrementing.

Settlement Period

number

Group ordered by this field second, incrementing.

CCGT (MW)

number

OIL (MW)

number

COAL (MW)

number

NUCLEAR (MW)

number

WIND (MW)

number

PS (MW)

number

NPSHYD (MW)

number

OCGT (MW)

number

OTHER (MW)

number

INTFR (MW)

number

INTIRL (MW)

number

INTNED (MW)

number

INTEW (MW)

number

BIOMASS (MW)

number

INTNEM (MW)

number

INTELEC (MW)

number

INTIFA2 (MW)

number

INTNSL (MW)

number

INTVKL (MW)

number

Example File

HDR, HALF HOURLY OUTTURN GENERATION BY FUEL TYPE DATA

FUELHH,20080428,1,18137,1850,0,15315,7308,189,15,15,0,55,152,12,16,27,19,20,21,40

FUELHH,20080428,2,18134,1849,0,15312,7307,181,16,14,0,52,150,22,16,27,5,20,21,40

FTR,2

8.1.25 Transmission System Demand

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed string “TRANSMISSION SYSTEM DEMAND DATA”

Body Record Transmission System Demand Data

Field

Type

Format

Comments

Record Type

string

Fixed String “TSD”

Spot Time

datetime

yyyymmddhh24miss

Demand (MW)

number

Example File

HDR, TRANSMISSION SYSTEM DEMAND DATA

TSD,20080428170500,43036

TSD,20080428171000,43006

TSD,20080428171500,41160

TSD,20080428172000,42705

TSD,20080428172500,42565

FTR,5

8.1.26 Half Hourly Interconnector Outturn Generation

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed string “HALF HOURLY INTERCONNECTOR OUTTURN GENERATION”

[1831-B]Body Record Half Hourly Interconnector Outturn Generation

Field

Type

Format

Comments

Record Type

string

Fixed String “INTOUTHH”

Settlement Date

date

yyyymmdd

Group ordered by this field first, incrementing.

Settlement Period

number

Group ordered by this field second, incrementing.

INTFR (MW)

number

INTIRL (MW)

number

INTNED (MW)

number

INTEW (MW)

number

INTNEM (MW)

number

INTELEC (MW)

number

INTIFA2 (MW)

number

INTNSL (MW)

number

INTVKL (MW)

number

Example File

HDR, HALF HOURLY OUTTURN GENERATION BY FUEL TYPE DATA

INTOUTHH,20080428,1,55,152,23,32,27,28,29,32

INTOUTHH,20080428,2,52,150,22,21,17,28,29,32

FTR,2

8.1.27 Daily Energy Volume Data

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed string “DAILY ENERGY VOLUME DATA”

Body Record Temperature Data

Field

Type

Format

Comments

Record Type

string

Fixed String “INDOD”

Settlement Day

Date

yyyymmdd

Group ordered by this field first, incrementing.

Daily Energy Volume Outturn

number

Daily Energy Volume Normal Reference

number

Daily Energy Volume Low Reference

number

Daily Energy Volume High Reference

number

Example File

HDR,DAILY ENERGY VOLUME DATA

INDOD,20081016,43323,40121,38124,47634

FTR,1

8.1.28 Non-BM STOR Instructed Volume Data

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed string “NON-BM STOR INSTRUCTED VOLUME DATA”

Non-BM STOR Instructed Volume Data

Field

Type

Format

Comments

Record Type

string

Fixed String “NONBM”

Settlement Date

date

yyyymmdd

Group ordered by this field first, incrementing.

Settlement Period

number

Group ordered by this field second, incrementing.

Instructed Volume (MWh)

number

Example File

HDR, NON-BM STOR INSTRUCTED VOLUME DATA

NONBM,20080428,1,551

NONBM,20080428,2,524

FTR,2

8.1.29 System Frequency

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed string “SYSTEM FREQUENCY DATA”

Body Record System Frequency Data

Field

Type

Format

Comments

Record Type

string

Fixed String “FREQ”

Spot Time

datetime

yyyymmddhh24miss

Frequency (Hz)

number

Example File

HDR, SYSTEM FREQUENCY DATA

FREQ,20080428170500,49.101

FREQ,20080428171000,49.393

FREQ,20080428171500,49.573

FREQ,20080428172000,49.032

FREQ,20080428172500,49.432

FTR,5

8.1.30 Indicative System Price Stack Data

Header

Field

Type

Format

Comments

Record Type

String

Fixed String “HDR”

File Type

String

Fixed string “Indicative System Price Stack Data

Body Record Indicative System Price Bid Stack Data

Field

Type

Format

Comments

Record Type

string

Fixed String “BID”

Settlement Date

date

yyyymmdd

Group ordered by this field first, incrementing.

Settlement Period

number

Group ordered by this field second, incrementing.

Sequence Number

number

Group ordered by this field third, incrementing.

Component Identifier

string

Acceptance BM Unit ID, RR identifier or BSAD NETSO allocated ID

Acceptance Number

number

Bid-Offer Pair Number

number

CADL Flag

boolean

T or F

‘T’ if Short Duration Acceptance

SO-Flag

boolean

T or F

‘T’ if potentially impacted by transmission constraints.

STOR Provider Flag

Boolean

T or F

‘T’ if System Action relates to a BOA accepted for a STOR Provider.

This field will be null for pre-P305 dates

Repriced Indicator

Boolean

T or F

‘T’ if repriced item

Bid-Offer Original Price

Number

£/MWh

Reserve Scarcity Price

Number

£/MWh

This will be null because STOR not accepted as a Bid

This field will be null for pre-P305 dates

Stack Item Original Price

number

£/MWh

Stack Item Volume

number

MWh

DMAT Adjusted Volume

number

MWh

Arbitrage Adjusted Volume

number

MWh

NIV Adjusted Volume

number

MWh

PAR Adjusted Volume

number

MWh

Stack Item Final Price

number

£/MWh

Transmission Loss Multiplier

number

TLM Adjusted Volume

number

MWh

TLM Adjusted Cost

number

£

Body Record Indicative System Price Offer Stack Data

Field

Type

Format

Comments

Record Type

string

Fixed String “OFFER”

Settlement Date

date

yyyymmdd

Group ordered by this field first, incrementing.

Settlement Period

number

Group ordered by this field second, incrementing.

Sequence Number

number

Group ordered by this field third, incrementing.

Component Identifier

string

Acceptance BM Unit ID, RR identifier or BSAD NETSO allocated ID

Acceptance Number

number

Bid-Offer Pair Number

number

CADL Flag

boolean

T or F

‘T’ if Short Duration Acceptance

SO-Flag

boolean

T or F

‘T’ if potentially impacted by transmission constraints.

STOR Provider Flag

boolean

T or F

‘T’ if System Action relates to a BOA accepted for a STOR Provider

This field will be null for pre-P305 dates

Repriced Indicator

boolean

T or F

‘T’ if repriced item

Bid-Offer Original Price

number

£/MWh

Reserve Scarcity Price

number

£/MWh

This field will be null for pre-P305 dates

Stack Item Original Price

number

£/MWh

Stack Item Volume

number

MWh

DMAT Adjusted Volume

number

MWh

Arbitrage Adjusted Volume

number

MWh

NIV Adjusted Volume

number

MWh

PAR Adjusted Volume

number

MWh

Stack Item Final Price

number

£/MWh

Transmission Loss Multiplier

number

TLM Adjusted Volume

number

MWh

TLM Adjusted Cost

number

£

Example File

HDR, INDICATIVE SYSTEM PRICE STACK DATA

BID,20001018,33,1,T_BASS-1,2345,-1,F,F,F,F,2.0,,2.0,30.0,30.0,30.0,30.0,30.0,2.0,0.9,27.0,54.0

BID,20001018,33,2,1,,,T,F,F,F,2.0,,2.0,30.0,30.0,30.0,30.0,30.0,2.0,0.9,27.0,54.0

OFFER,20001018,33,1,T_EROL-1,1357,-1,F,F,F,F,2.0,,2.0,30.0,30.0,30.0,30.0,30.0,2.0,0.9,27.0,54.0

OFFER,20001018,33,2,1,,,T,F,F,T,2.0,2.5,2.5,30.0,30.0,30.0,30.0,30.0,2.0,0.9,27.0,54.0

OFFER,20001018,33,3,T_HEST-1,6789,-1,F,F,F,F,2.0,,2.0,30.0,30.0,30.0,30.0,30.0,2.0,0.9,27.0,54.0

FTR,5

8.1.31 SO-SO Prices

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed String “SO-SO PRICES”

Body Record

Field

Type

Format

Comments

Record Type

string

Fixed String “SOSO”

Trade Type

string

A code identifying the type of trade being made

Start Time

datetime

yyyymmddhhmmss

The start date and time for which a Trade Price applies

Trade Direction

string

A01, A02

The direction of the trade

Contract Identification

string

A unique identifier for an offered trade

Trade Quantity

number

MW

The quantity of an offered trade in MW

Trade Price

number

Currency/MWh

The price of the trade in units of currency per MWh

Example File

HDR,SO-SO PRICES

SOSO,BALIT_NG,20100422170000,A01,RTE_20101225_1000_3,12584,24.25

SOSO,BALIT_NG,20100422180000,A02,RTE_20101225_1000_27,10524,30.16

FTR,2

8.1.32 Demand Control Instruction

Header Record

Field

Type

Format

Comments

Record Type

String

Fixed String “HDR”

File Type

String

Fixed String “DCONTROL”

Body Record

Field

Type

Format

Comments

Record Type

String

Fixed String “DEMCI”

Demand Control ID

String

The unique identifier for a demand control instruction

Affected DSO

String

Instruction Sequence

Number

Demand Control Event Flag

Boolean

‘I’ or ‘L’

A value of ‘I’ indicates an instruction initiated by the NETSO or an Emergency Manual Disconnection. A Value of ‘L’ indicates an Automatic Low Frequency Demand Disconnection

Time From

datetime

yyyymmddhh24miss

Time To

datetime

yyyymmddhh24miss

Demand Control Level

Number

SO-Flag

Boolean

‘T’ or ‘F’

Example File

HDR,DCONTROL

DEMCI,DCID,,1,L,2015-08-10 01:00,2015-08-10 01:25,30.00000,T

DEMCI,DCID,NORW,1,I,2015-08-10 01:00,2015-08-10 01:25,30.00000,F

DEMCI,DCID,,2,L,2015-08-10 02:00,2015-08-10 02:40,40.00000,T

FTR,3

8.1.33 Loss of Load Probability

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed String “LOLP”

Body Record

Field

Type

Format

Comments

Record Type

String

Fixed String “LOLPDRM”

Settlement Date

Date

yyyymmdd

Settlement Period

Number

1-50

LOLP_1200

number

Midday Indicative LoLP value

DRM_1200

number

Midday forecast of De-rated Margin

LOLP_8h

number

8 hour ahead Indicative LoLP value

DRM_8h

number

8 hour ahead forecast of De-rated Margin

LOLP_4h

number

4 hour ahead Indicative LoLP value

DRM_4h

number

4 hour ahead forecast of De-rated Margin

LOLP_2h

number

2 hour ahead Indicative LoLP value

DRM_2h

number

2 hour ahead forecast of De-rated Margin

LOLP_1h

number

1 hour ahead Final LoLP value

DRM_1h

number

1 hour ahead forecast of De-rated Margin

Example File

HDR,LOLP

LOLPDRM,20150810,25,0.345,10.56,0.234,112.34,0.123,1.456,0.56,345.789,0.8,0.80000

FTR,1

8.1.34 STOR Availability Window

Header Record

Field

Type

Format

Comments

Record Type

String

Fixed String “HDR”

File Type

String

Fixed String “STORAW DATA”

Body Record

Field

Type

Format

Comments

Record Type

String

Fixed String “STORAW”

Season Year

Date

yyyy

Season Number

Number

STOR Availability From Date

Datetime

yyyymmddhh24mm

STOR Availability To Date

Date

yyyymmddhh24miss

Weekday Start Time

time

hhmm

Weekday End Time

time

hhmm

Non-weekday Start Time

time

hhmm

Non-weekday End Time

time

hhmm

Example File

HDR,STORAW DATA

STORAW,2015-2015,1,201504010500,201504270500,0700,1330,1000,1400

STORAW,2015-2015,1,201504010500,201504270500,1900,2200,1930,2200

STORAW,2015-2015,2,201504270500,201508240500,0730,1400,0930,1330

STORAW,2015-2015,2,201504270500,201508240500,1600,1800,1630,2030

STORAW,2015-2015,2,201504270500,201508240500,1930,2230,2030,2200

STORAW,2015-2015,3,201508240500,201509210500,0730,1400,1030,1330

STORAW,2015-2015,3,201508240500,201509210500,1600,2130,1900,2200

STORAW,2015-2015,4,201509210500,201510260500,0700,1330,,

STORAW,2015-2015,4,201509210500,201510260500,1630,2100,1730,2100

STORAW,2015-2016,5,201510260500,201602010500,0700,1330,1030,1330

STORAW,2015-2016,5,201510260500,201602010500,1600,2100,1600,2230

STORAW,2016-2016,6,201602010500,201604010500,0700,1330,1030,1330

STORAW,2016-2016,6,201602010500,201604010500,,,1630,2100

FTR,13

8.1.35 GBP EUR Settlement Exchange Rate

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed String “GBP EUR Settlement Exchange Rate

Body Record

Field

Type

Format

Comments

Settlement Day

date

Exchange Rate

number

Datetime Received

datetime

Example File

HDR,GBP EUR SETTLEMENT EXCHANGE RATE

2019-02-26,1.13000,2019-02-25 16:00:00

2019-02-27,1.14123,2019-02-26 16:00:00

2019-02-28,1.15246,2019-02-27 16:00:00

FTR,3

8.1.36 TERRE Bid Data

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed String “Reserve Bid Data”

Body Record

Field

Type

Format

Comments

BM Unit Id

string

BM Unit Type

string

NGC BM Unit Name

string

Participant Id

string

Time Series Id

string

Settlement Date

Date

Settlement Period

number

RR Quarter Hour Period

number

RR Associated TSO

string

RR Market Balance Area

string

RR Divisible

string

RR Linking Bid Id

string

RR Multipart Bid Id

string

RR Exclusive Bid Id

string

RR Flow Direction

string

RR Minimum Quantity

number

RR Maximum Quantity

number

RR Bid Resolution

string

RR Position

number

RR Price (£/MWh)

number

RR Status

string

Example File

HDR,RESERVE BID DATA

BMU1,T,NGCBMU1,PARTY1,NGET-RR1,2019-02-19,1,1,TSO1,Area1,A01,LINKING1,MULTIPART1,EXCLUSIVE1,A01, 1.234,99.567,PT15M,1,9.99999,A06

BMU1,T,NGCBMU1,PARTY1,NGET-RR1,2019-02,19,1,2,TSO1,Area1,A01,LINKING1,MULTIPART1,EXCLUSIVE1,A01,1.234,99.567,PT15M,1,9.99999,A06

BMU1,T,NGCBMU1,PARTY1,NGET-RR1,2019-02-19,1,3,TSO1,Area1,A01,LINKING1,MULTIPART1,EXCLUSIVE1,A01,1.234,99.567,PT15M,1,9.99999,A06

BMU1,T,NGCBMU1,PARTY1,NGET-RR1,2019-02-19,1,4,TSO1,Area1,A01,LINKING1,MULTIPART1,EXCLUSIVE1,A01,1.234,99.567,PT15M,1,9.99999,A06

FTR,4

8.1.37 TERRE Aggregated Information

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed String “RRAGGINFO”

Auction Period Start

Datetime

Auction Period End

Datetime

Body Record

Field

Type

Format

Comments

Record Type

string

Fixed String “RRAGGINFO”

Total volume of offered bids

number

Total of activated TERRE bids

number

Total of unavailable bids

number

Example File

HDR,RRAGGINFO,20190228110000,20190228120000

RRAGGINFO,1234.567,2345.678,3456.789

FTR,1

8.1.38 TERRE Auction Results

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed String “RRRESULTS DATA”

Settlement Date

Date

Settlement Period

number

Body Record Activation Data

Field

Type

Format

Comments

Record Type

string

Fixed String “ACTIVATION”

Participant Id

string

BM Unit Id

string

Settlement Date

Date

Settlement Period

number

RR Quarter Hour Period

number

Type

string

B74

RR Flow Direction

string

Activated Quantity (MW)

number

Activation Price (£/MWh)

number

Marketobjectstatus

String

Available, Ordered or Cancelled

Body Record GB Need Met Data

Field

Type

Format

Comments

Record Type

string

Fixed String “GBNM”

Settlement Date

Date

Settlement Period

number

RR Quarter Hour Period

number

Type

string

B75

RR Flow Direction

string

Activated Quantity (MW)

number

Activation Price (£/MWh)

number

Body Record Interconnector Schedule

Field

Type

Format

Comments

Record Type

string

Fixed String “INTERCONN”

Interconnector Id

string

Settlement Date

Date

Settlement Period

number

RR Quarter Hour Period

number

Type

string

A05 or B09

RR Flow Direction

string

Activated Quantity (MW)

number

Activation Price (£/MWh)

number

Example File

HDR,RRRESULTS DATA,20190225,25

ACTIVATION,PARTY1,T_BMUX-1,20190225,25,1,B74,UP,100,9.99

ACTIVATION,PARTY1,T_BMUX-1,20190225,25,2,B74,UP,110,10.99

GBNM,20190225,25,1,B75,UP,100,9.99

GBNM,20190225,25,2,B75,UP,100,9.99

INTERCONN,FRANCE,20190225,25,1,A05,UP,100

INTERCONN,FRANCE,20190225,25,2,A05,UP,100

[…]

FTR,99

8.1.39 TERRE Indicative Cashflows

Header Record

Field

Type

Format

Comments

Record Type

string

Fixed String “HDR”

File Type

string

Fixed String “ICCR”

Body Record

Field

Type

Format

Comments

Record Type

string

Fixed String “ICCR”

BM Unit Id

string

Settlement Date

Date

Settlement Period

number

RR Quarter Hour Period

number

Quarter Hour RR Activated Quantity

number

Quarter Hour RR Activated Volume

number

RR Activation Price

number

Quarter Hour RR Cashflow

number

Period RR BM Unit Cashflow

number

Example File

HDR,BMUnitId,settlementDate,settlementPeriod,quarterHourPeriod,quarterHourRRActivatedQuantity,

quarterHourRRActivatedVolume,rrActivationPrice,quarterHourRRCashflow,periodRRBMUnitCashflow

BMU1,2019-02-19,1,1,100,25,9.99,249.75,474.53

BMU1,2019-02-19,1,2,90,22.5,9.99,224.78,474.53

BMU1,2019-02-19,2,1,75,18.75,9.99,187.31,412.09

BMU1,2019-02-19,2,2,90,22.5,9.99,224.78,412.09

[…]

FTR,99

Appendices

9 Appendix A – Example Source Code RESTFul Service

9.1 Java

The following code demonstrates calling the RESTFul service using standard Java API.

import java.io.BufferedReader;

import java.io.IOException;

import java.io.InputStreamReader;

import java.net.HttpURLConnection;

import java.net.MalformedURLException;

import java.net.URL;

/**

*

* @author stephen

*/

public class BMRSGet {

private static final String ELEXON_PORTAL_KEY = "YOUR API KEY HERE";

public static void main(String[] args) {

try {

URL url = new URL("https://testapi.bmreports.com/BMRS/MessageListRetrieval/V1?ServiceType=XML&APIKey=" + ELEXON_PORTAL_KEY + "&EventStart=2014-01-01&EventEnd=2014-01-02");

HttpURLConnection conn = (HttpURLConnection) url.openConnection();

conn.setRequestMethod("GET");

conn.setRequestProperty("Accept", "application/xml");

if (conn.getResponseCode() != 200) {

throw new RuntimeException("Failed : HTTP error code : "

+ conn.getResponseCode());

}

BufferedReader br = new BufferedReader(new InputStreamReader(

(conn.getInputStream())));

String output;

System.out.println("Output from Server .... \n");

while ((output = br.readLine()) != null) {

System.out.println(output);

}

conn.disconnect();

} catch (MalformedURLException e) {

e.printStackTrace();

} catch (IOException e) {

e.printStackTrace();

}

}

}

9.2 Python

The following code is written in python and demonstrates calling the Elexon RESTFul API. Please note that you need to replace the YOUR_API_KEY_HERE with the key from the Elexon portal.

#! /usr/bin/env python

import httplib2

# These aren't needed, just for this example

from pprint import pformat

def post_elexon(url):

http_obj = httplib2.Http()

resp, content = http_obj.request(

uri=url,

method='GET',

headers={'Content-Type': 'application/xml; charset=UTF-8'},

)

print '===Response==='

print pformat(resp)

print '===Content==='

print pformat(content)

print '===Finished==='

def main():

post_elexon(

url='https://api.bmreports.com/BMRS/B1770/v1?APIKey=YOUR_API_KEY_HERE&SettlementDate=2015-03-01&Period=1&ServiceType=xml',

)

if __name__ == "__main__":

main()

10 Appendix B – Example Push Data Service Source Code

10.1 Java – onMessage example

import java.io.FileWriter;

import java.io.PrintWriter;

import javax.jms.Connection;

import javax.jms.ConnectionFactory;

import javax.jms.JMSException;

import javax.jms.MessageConsumer;

import javax.jms.MessageListener;

import javax.jms.Session;

import javax.jms.Topic;

import org.apache.activemq.ActiveMQConnectionFactory;

import org.apache.activemq.command.ActiveMQTextMessage;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

/**

*

* @author stephen

*/

public class Subscriber {

// --- Start of connection details

private static final String URL = "ssl://api.bmreports.com:61616"; // This is the connection string to the ELEXON servers

private static final String APIKEY = "<YOUR API KEY GOES HERE>"; // This is your API key from the portal

private static final String CLIENTID = "<YOUR CLIENT ID GOES HERE>"; // This is a client name that needs to be unique (this you create)

private static final String TOPICNAME = "bmrsTopic"; // This is the topic name

private static final String SUBSCRIPTIONID = "<YOUR SUBSCRIPTION ID GOES HERE>"; // Each durable subscription needs an ID that is unique (this you create)

// --- End of connection details

private static final Logger LOGGER = LoggerFactory

.getLogger(Subscriber.class);

private Connection connection;

private Session session;

private MessageConsumer messageConsumer;

private static Subscriber subscriberPublishSubscribe;

/**

* Generic start point.

*

* @param args the command line arguments

* @throws java.lang.Exception

*/

public static void main(String[] args) throws Exception {

try {

// Setup and connect to the queue

subscriberPublishSubscribe = new Subscriber();

subscriberPublishSubscribe.create(URL, APIKEY, CLIENTID, TOPICNAME, SUBSCRIPTIONID);

} catch (Exception ex) {

LOGGER.error(ex.getLocalizedMessage());

if (subscriberPublishSubscribe != null) {

subscriberPublishSubscribe.closeConnection();

}

}

}

/**

* This is the method that initiates the connection and sets up the

* JMSListener

*

* @param url - The server and connection protocol

* @param apikey - the api key to connect with

* @param clientId - Unique id for this client

* @param topicName - The topic to listen to

* @throws JMSException

*/

public void create(String url, String apikey, String clientId, String topicName, String subId) throws JMSException {

// create a Connection Factory

ConnectionFactory factory = new ActiveMQConnectionFactory(apikey, apikey, url);

try {

// create a Connection

LOGGER.debug("Creating a connection");

connection = factory.createConnection();

connection.setClientID(clientId);

// create a Session

LOGGER.debug("Creating a session");

session = connection.createSession(false, Session.AUTO_ACKNOWLEDGE);

// create the Topic from which messages will be received

LOGGER.debug("Creating the topic connection: " + topicName);

Topic topic = session.createTopic(topicName);

// Set up the message consumer

LOGGER.debug("Creating the consumer for: " + topicName);

//messageConsumer = session.createConsumer(topic);

messageConsumer = session.createDurableSubscriber(topic, subId);

// Create the listener.

LOGGER.debug("Setting up the listener");

JMSMessageListener listener = new JMSMessageListener();

messageConsumer.setMessageListener(listener);

// start the connection in order to receive messages

LOGGER.debug("Starting the connection");

connection.start();

} catch (JMSException exp) {

throw exp;

}

}

public void closeConnection() throws JMSException {

LOGGER.debug("Closing the connection");

connection.close();

}

/**

* This class implements a message listener for the ActiveMQ

*/

class JMSMessageListener implements MessageListener {

@Override

public void onMessage(javax.jms.Message msg) {

try {

LOGGER.info(msg.toString());

ActiveMQTextMessage txtMessage = (ActiveMQTextMessage) msg;

LOGGER.info(txtMessage.getText());

try (PrintWriter out = new PrintWriter(new FileWriter(txtMessage.getJMSMessageID()))) {

out.print(txtMessage.getText());

}

} catch (Exception ex) {

LOGGER.error(ex.getLocalizedMessage());

}

}

}

}

10.2 Java – Looping example

import javax.jms.Connection;

import javax.jms.ConnectionFactory;

import javax.jms.JMSException;

import javax.jms.Message;

import javax.jms.MessageConsumer;

import javax.jms.Session;

import javax.jms.TextMessage;

import javax.jms.Topic;

import javax.naming.NamingException;

import org.apache.activemq.ActiveMQConnectionFactory;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

/**

*

* @author stephen

*/

public class SubscriberRetry {

// --- Start of connection details

private static final String URL = "ssl://api.bmreports.com:61616"; // This is the connection string to the ELEXON servers

private static final String APIKEY = "<YOUR API KEY GOES HERE>"; // This is your API key from the portal

private static final String CLIENTID = "<YOUR CLIENT ID GOES HERE>"; // This is a client name that needs to be unique (this you create)

private static final String TOPICNAME = "bmrsTopic"; // This is the topic name

private static final String SUBSCRIPTIONID = "<YOUR SUBSCRIPTION ID GOES HERE>"; // Each durable subscription needs an ID that is unique (this you create)

// --- End of connection details

private static final Logger LOGGER = LoggerFactory

.getLogger(SubscriberRetry.class);

private static SubscriberRetry consumer;

private Connection connection;

private Session session;

private MessageConsumer messageConsumer;

private boolean transacted;

private boolean isRunning = false;

/**

* @param args the command line arguments

* @throws java.lang.InterruptedException

*/

public static void main(String[] args) throws InterruptedException {

int retryCount = 20000;

int count = 0;

consumer = new SubscriberRetry();

// This runs forever

while (count < retryCount) {

LOGGER.debug("Attempting connection. Count = " + count);

try {

consumer.run();

} catch (NamingException | JMSException ex) {

LOGGER.error(ex.getLocalizedMessage());

count++;

} finally {

LOGGER.debug("Shutting down");

}

Thread.sleep(1000);

}

}

public void run() throws NamingException, JMSException {

isRunning = true;

// create a Connection Factory

ConnectionFactory factory = new ActiveMQConnectionFactory(APIKEY, APIKEY, URL);

// create a Connection

LOGGER.debug("Creating a connection");

connection = factory.createConnection();

connection.setClientID(CLIENTID);

// create a Session

LOGGER.debug("Creating a session");

session = connection.createSession(transacted, Session.AUTO_ACKNOWLEDGE);

// create the Topic from which messages will be received

LOGGER.debug("Creating the topic connection: " + TOPICNAME);

Topic topic = session.createTopic(TOPICNAME);

// Set up the message consumer

LOGGER.debug("Creating the consumer for: " + TOPICNAME);

messageConsumer = session.createDurableSubscriber(topic, SUBSCRIPTIONID);

// start the connection in order to receive messages

LOGGER.debug("Starting the connection");

connection.start();

while (isRunning) {

LOGGER.debug("Waiting for message...");

Message message = messageConsumer.receive(1000);

if (message != null && message instanceof TextMessage) {

TextMessage txtMsg = (TextMessage) message;

LOGGER.debug("Received: " + txtMsg.getText());

}

}

LOGGER.debug("Closing connection");

messageConsumer.close();

session.close();

connection.close();

10.3 Python Example (Stomp)

The following example uses the stomp.py library – see https://github.com/jasonrbriggs/stomp.py

import stomp

import time

class MyListener(stomp.ConnectionListener):

def on_error(self, headers, message):

print('received an error "%s"' % message)

def on_message(self, headers, message):

for k,v in headers.iteritems():

print('header: key %s , value %s' %(k,v))

print('received a message "%s"' % message)

with open("messages.log", "a") as logfile:

logfile.write(message)

conn = stomp.Connection12(host_and_ports=[('api.bmreports.com', 61613)],use_ssl=True)

conn.set_listener('', MyListener())

conn.start()

conn.connect('YOUR API KEY HERE', 'YOUR API KEY HERE', True)

conn.subscribe(destination='/topic/bmrsTopic', ack='auto', id='CLIENT ID OF YOUR CHOICE HERE')

while conn.is_connected():

time.sleep(1)

11 Amendment History

Version

Date

Author

Reason

Version 0.1

12 November 2014

Zaahir Ghanty

First Draft for peer review

Version 0.2

12 December 2014

Stephen J. Thompson

Brought into alignment with 0.6 of the API specification

Version 0.3

12 December 2014

Zaahir Ghanty

Update following review

Version 0.4

28 April 2015

Zaahir Ghanty/Stephen J. Thompson

Update to include REST API for Phase 2 & Data Push Service

Version 0.5

18 May 2015

Zaahir Ghanty

Update following user feedback

Version 0.6

14 July 2015

Stephen J. Thompson

Update of API request method from POST to GET

Version 0.7

24 July 2015

Zaahir Ghanty/Stephen J. Thompson

Update of API URLs and Java examples for Data Push

Version 0.8

31 August 2015

Stephen J. Thompson

Updated the RESTful examples to use the GET verb. Added a checklist for users

Version 0.9

22 January 2016

Zaahir Ghanty

Updated to include REST API for Phase 3 and P305 Data

Version 0.10

22 April 2016

Zaahir Ghanty

Updated following user feedback

Added message types for Data Push Service

Version 0.11

14 July 2016

Zaahir Ghanty

Housekeeping updates

Version 0.12

17 October 2016

Zaahir Ghanty

Housekeeping updates & Python working example for Data Push

Version 1.0

23 June 2017

Zaahir Ghanty

Updates for June 2017 BSC System release (BSC Modifications P3211 and P3292)

Version 1.1

30 October 2017

Zaahir Ghanty

Updates for November 2017 BSC System Release (BSC Modification P3363)

Inclusion of BIOMASS in API responses for FUELINSTHHCUR, FUELINST, FUELHH, FOU2T14D, UOU2T14D, FOU2T52W, UOU2T52W. No changes to API URIs

Version 2.0

11 November 2018

Stephen Francis

Updates for November 2018 BSC Systems Release (CP15034 and CP15065)

Version 2.1

5 July 2019

Stephen Francis

Updated B1610 API to Version 2 for improved reporting

Version 2.2

31 July 2019

Stephen Francis

Housekeeping updates

Version 3.0

18 December 2019

Stephen Francis

Updates for November 2019 BSC Systems Release (P344 TERRE and CP1517)

Version 3.1

1 July 2020

Stephen Francis

Updated B1610 API request details table to reference the optional NGC BM Unit ID; no functional change to the API

Version 4.0

3 December 2020

Stephen Francis

Updates for December 2020 BSC Systems Release for CP1535

Version 5.0

18 March 2021

Stephen Francis

Updates for February 2021 Standalone BSC Systems Release for P408 Self-Governance

Version 6.0

24 February 2022

Ivar Macsween

Updates for February 2022 Standard BSC Release for CP1548

Version 6.1

2 November 2023

Mark De Souza-Wilson

Updates for November 2023 Standard BSC Release for Cxxxx

Intellectual Property Rights, Copyright and Disclaimer

The copyright and other intellectual property rights in this document are vested in Elexon or appear with the consent of the copyright owner. These materials are made available for you for the purposes of your participation in the electricity industry. If you have an interest in the electricity industry, you may view, download, copy, distribute, modify, transmit, publish, sell or create derivative works (in whatever format) from this document or in other cases use for personal academic or other non-commercial purposes. All copyright and other proprietary notices contained in the document must be retained on any copy you make.

All other rights of the copyright owner not expressly dealt with above are reserved.

No representation, warranty or guarantee is made that the information in this document is accurate or complete. While care is taken in the collection and provision of this information, Elexon Limited shall not be liable for any errors, omissions, misstatements or mistakes in any information or damages resulting from the use of this information or action taken in reliance on it.

The use of the API is governed by the BMRS Data Terms of Use Policy

Service Desk Support: bscservicedesk@cgi.com

1 Publication of Trading Unit Delivery Mode

2 Changes to REMIT inside information reporting

3 Fuel types on the BMRS

4 Changes to European Transparency Regulation Data

5 New Interconnector fuel type