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.

WIP: currently there is zero data validation and raw unparsed XML is returned.

Installing

$ pip install elexon

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.

Example

from elexon import Elexon

api = Elexon('API_KEY') # available for free from the Elexon Portal

# Actual Generation Output per Generation Unit
generation = api.transparency.B1620(SettlementDate = '2020-01-01', Period = '5')

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.0.1.tar.gz (4.6 kB view hashes)

Uploaded source

Built Distribution

elexon-0.0.1-py3-none-any.whl (10.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