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 (as a dict) or the raw csv data is returned as a string.

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

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.

Files for elexon, version 0.0.4
Filename, size File type Python version Upload date Hashes
Filename, size elexon-0.0.4-py3-none-any.whl (7.5 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size elexon-0.0.4.tar.gz (5.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page