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

Uploaded Source

Built Distribution

elexon-0.0.1-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

Details for the file elexon-0.0.1.tar.gz.

File metadata

  • Download URL: elexon-0.0.1.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.4

File hashes

Hashes for elexon-0.0.1.tar.gz
Algorithm Hash digest
SHA256 f806a0461ae56074597dbb501bd54465a35d8bc020977ec54047b9e9a9d36a5e
MD5 a15005a6460c01b37efed27ab9be7164
BLAKE2b-256 5150027d952de676f86ae4e05ffbe907b82a27911bf76a70c04e88740df39d1c

See more details on using hashes here.

File details

Details for the file elexon-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: elexon-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 10.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.4

File hashes

Hashes for elexon-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b879e54c902e018343029b498c66fc7863274e1447030ab57500270ed46d79df
MD5 4e2ec43d7f141fc0c95dcf4ee819a314
BLAKE2b-256 77b9bf3e419743392cd23a19290b9e57a21e2c62eb44a12668bda34218df24b6

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page