Skip to main content

A simple wrapper for the Elexon BMRS API

Project description

Elexon BMRS API

A simple wrapper for the Elexon BMRS API.

Installing

  1. Install with pip (recommended):
$ pip install elexon
  1. Alternatively, you can grab the latest source code from GitHub:
$ git clone https://github.com/MichaelKavanagh/elexon.git
$ python setup.py install

Getting Started

  1. Register on the ELEXON Portal.
  2. Retrieve API Key.
  3. Replace API_KEY in the example below with your API Key.
  4. Profit.

Usage

Supported Elexon BMRS Reports

For the full list of namespaces, methods, parameters and data types see methods.py.

Example

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

Support

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.

Contributing

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.

Further Reading

https://www.elexon.co.uk/guidance-note/bmrs-api-data-push-user-guide/

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

elexon-0.2.2.tar.gz (2.8 kB view hashes)

Uploaded source

Built Distribution

elexon-0.2.2-py3-none-any.whl (3.0 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page