Elexon BMRS API
A simple wrapper for the Elexon BMRS API.
Installing
- 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
Getting Started
- Register on the ELEXON Portal.
- Retrieve API Key.
- Replace
API_KEYin the example below with your API Key. - 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/
1 maintainer
Metadata
1 maintainer
Release files for elexon 0.2.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| elexon-0.2.3.tar.gz | 8.9 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| elexon-0.2.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 18.8 kB
Release files / elexon-0.2.3.tar.gz
| Download URL | elexon-0.2.3.tar.gz |
|---|---|
| Size | 8.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7740844a31cc191d057d629d35f9b72e5efa5841c834bad8460be74b1700685c
|
|
BLAKE2b-256 checksum How to use checksums |
f007d1e565a899744fa38c92c81ef8231757fedd4aeeb2df35268fb7515bdc3f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.7
|
Release files / elexon-0.2.3-py3-none-any.whl
| Download URL | elexon-0.2.3-py3-none-any.whl |
|---|---|
| Size | 9.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fb931090fd725b1a547ac383d98e1e5925ec549ab2a86c097a6ebe2167899f20
|
|
BLAKE2b-256 checksum How to use checksums |
a69f8fcaf49e9227561ac38c67c4355929bf63966dcc37c188353677d32846a9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.7
|
Security for elexon 0.2.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
