A simple wrapper for the Elexon BMRS API
Elexon BMRS API
A simple wrapper for the Elexon BMRS API.
- Install with pip (recommended):
$ pip install elexon
- Alternatively, you can grab the latest source code from GitHub:
$ git clone https://github.com/MichaelKavanagh/elexon.git $ python setup.py install
- Register on the ELEXON Portal.
- Retrieve API Key.
API_KEYin the example below with your API Key.
Supported Elexon BMRS Reports
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.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.