XML-REST Services

Introduction

The XML-REST interfaces into the system are broken into discrete services. These services are defined below. Some package documentation is restricted to users with the correct user privileges.

XML-REST Common Features

There are many common features to the XML-REST services. The XML-REST common features page discusses these.

aggregate

The 'aggregate' service is used to download information on entities that aggregate BM Units. What does this mean? A power station is an aggregate of BM Units, a fuel technology type is assigned to a BM unit by aggregating the BM Units by fuel type etc. For the 'aggregate' service click here.

apxdamdata

The 'apxdamdata' service returns APX Day Ahead Market price data. For the 'apxdamdata' service click here.

bmunit

The 'bmunit' service is used to download a list of BM Units. For the 'bmunit' service click here.

bmuforbscp

The 'bmuforbscp' service is used to download BM Unit for BSC Party relationships. For the 'bmuforbscp' service click here.

bmusumddl

The 'bmusumddl' service returns BM Unit summary data. For the 'bmusumddl' service click here.

bsuos

The 'bsuos' service is used to download BSUoS charges and price data. For the 'bsuos' service click here.

cdca

The 'cdca' service returns Grid Supply Point data. For the 'cdca' service click here.

data

The 'data' service is used to download data using a generic interface. For the 'data' service click here.

leba

The 'leba' service returns LEBA price data. For the 'leba' service click here.

lhwind

The 'lhwind' service returns livehub wind forecast data. For the 'lhwind' service click here.

mdd

The 'mdd' service returns a subset of Market Domain data. For the 'mdd' service click here.

midp

The 'midp' service returns Market Index Data Price data. For the 'midp' service click here.

nationalgridgas

The 'nationalgridgas' service returns UK gas data. For the 'nationalgridgas' service click here.

realtime

The 'realtime' service returns BMRS and derived data. For the 'realtime' service click here.

remit

The 'remit' service returns REMIT data. For the 'remit' service click here.

saa_apb

The 'saa_apb' service returns SAA incoming MVR data. For the 'saa_apb' service click here.

saa_apc

The 'saa_apc' service returns SAA BSC party daily charge data. For the 'saa_apc' service click here.

saa_apd

The 'saa_apd' service returns SAA energy account period data. For the 'saa_apd' service click here.

saa_bpx

The 'saa_bpx' service returns SAA BM unit period data. For the 'saa_bpx' service click here.

saa_mvr

The 'saa_mvr' service returns SAA outgoing MVR data. For the 'saa_mvr' service click here.

saa_ppc

The 'saa_ppc' service returns SAA BSC party period charge data. For the 'saa_ppc' service click here.

saa_spi

The 'saa_ppc' service returns SAA system level (SPI) data. For the 'saa_spi' service click here.

saa_ssd

The 'saa_ppc' service returns SAA system level (SSD) data. For the 'saa_ssd' service click here.

settlementrundata

The 'settlementrundata' service returns settlement run information. For the 'settlementrundata' service click here.

spectron

The 'spectron' service returns spectron price data. For the 'spectron' service click here.

systemprices

The 'systemprices' service returns system prices. For the 'systemprices' service click here.

user

The 'user' service validates a user's credentials. For the 'user' service click here.

windforecast

The 'windforecast' service returns wind forecast data. For the 'windforecast' service click here.