A simple wrapper for the Elexon BMRS API.
$ pip install elexon
$ git clone https://github.com/MichaelKavanagh/elexon.git
$ python setup.py install
API_KEY
in the example below with your API Key.For the full list of namespaces, methods, parameters and data types see methods.py.
from elexon import ElexonRawClient
api = ElexonRawClient('API_KEY') # available for free from the Elexon Portal
# Actual Aggregated Generation per Type
generation = api.Transparency.B1620(SettlementDate = '2020-01-01', Period = '5')
# Alternatively, use the general request() function by passing the endpoint in with the arguments:
generation = api.request('B1620', SettlementDate = '2020-01-01', Period = '5')
There have been cases where the wrapper/API doesn't behave due to inconsistencies or errors in Elexon's documentation.
If you believe you have come across a bug, please open a GitHub issue.
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
https://www.elexon.co.uk/guidance-note/bmrs-api-data-push-user-guide/