jao-py
Python client for the various endpoints offered by jao.eu, the Joint Allocation Office. "Europe's single leading trading platform( e-CAT) for cross-border transmission capacity"
More information about JAO can be found on their website https://jao.eu/
jao.eu has various ways of retrieving data. This package tries to offer useful functions to handle them. This package is not exhaustive, more methods are added when the authors needs them. If you want to see other methods added please either open a feature request issue to give others ideas or supply a pull request yourself.
Installation
python3 -m pip install jao-py
Usage
Current clients
The package comes with the current pandas clients:
JaoAPIClient: api client for the webservice API defined hereJaoPublicationToolClient: client for the Core Day-Ahead publication tool defined hereJaoPublicationToolPandasClient: Pandas client for the Core Day-Ahead publication tool defined hereJaoPublicationToolPandasIntraDay: client for Core Intradaypublication tool for Intraday defined hereJaoPublicationToolPandasNordics: client for Nordic Day-Ahead publication tool defined hereJaoPublicationToolPandasItalyNorth: client for Italy North publication tool defined here The publication tool clients have valid data from their respective go lives:- Core Day-Ahead: business day 2022-06-09 onwards
- Core Intraday(a): business day 2024-06-14 onwards
- Core Intraday(b): business day 2024-05-29 onwards
- Core Intraday(c): business day 2025-06-25 onwards
- Nordic Day-Ahead: business day 2024-10-30 onwards
Core Intraday a and b are combined in the same intraday client. In the initialization of the client you can choose which one you want like so:
from jao import JaoPublicationToolPandasIntraDay
client = JaoPublicationToolPandasIntraDay(version='a') # IDCC(a)
client = JaoPublicationToolPandasIntraDay(version='b') # IDCC(b)
client = JaoPublicationToolPandasIntraDay(version='c') # IDCC(c)
Rate Limiter
JAO currently has a fixed rate limiting of 100 requests per minute, if you surpass this a HTTP 429 is returned.
The library has a naive way of handling this by sleeping for RATE_LIMIT_HANDLER seconds, which is by default 60 seconds.
If you want to disable this set RATE_LIMIT_HANDLER to 0 through environment variables and the library will throw a HTTP exception that you can handle yourself.
Experimental Features
Mirror
This package provides support for the experimental data mirror mirror.flowbased.eu.
This allows to download final and prefinal domain from the fast mirror. If the requested day is not available the package will fallback to the JAO publication tool.
To enable it either use use_mirror=True in the function call or set the environment variable JAO_USE_MIRROR=1, by default this feature is off.
Disable Pagination for domain data
Sometimes disabling pagination on domain data helps with API stability. In order to use this set environment variable JAO_EXPERIMENTAL_NO_PAGINATION=1
Deprecated clients
The package also includes legacy clients for flowbased CWE data in the CWE subpackage. These return data up until business day 2022-06-08
JaoUtilityToolASMXClient: a very light wrapper around the ASMX Web Service API implemented as a passthrough to the suds-community pakcageJaoUtilityToolCSVClient: client to download csv data inm the same way as the utility tool excel file, returns pandas dataframesJaoUtilityToolXmlClient: downloads xml data of the utilitytool, this requires solving a captcha by the user, returns pandas dataframes
To use these deprecated clients be sure to install the following additional dependencies:
suds-community
lxml
pillow
this is only required for the CWE deprecated subpackage
1 maintainer
Metadata
1 maintainer
Release files for jao-py 0.7.9
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 | |
|---|---|---|---|---|
| jao_py-0.7.9.tar.gz | 95.4 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| jao_py-0.7.9-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 118.7 kB
Release files / jao_py-0.7.9.tar.gz
| Download URL | jao_py-0.7.9.tar.gz |
|---|---|
| Size | 95.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ac72df4a0d7d52315a173e535f5603cf4cae75ba8a8cc2eed08b23de0b877bb1
|
|
BLAKE2b-256 checksum How to use checksums |
b9ac7cc4c9736cf20620928dd6ab6491ebb799c4563b25f1a7f13606291c17cb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 9, 2026.
Transparency logRelease files / jao_py-0.7.9-py3-none-any.whl
| Download URL | jao_py-0.7.9-py3-none-any.whl |
|---|---|
| Size | 23.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ff26397de720350a81b9c1940cd9ef32371e4f8b0e9e106f4ace2c6e31a7ffe6
|
|
BLAKE2b-256 checksum How to use checksums |
851a5ec0c0206d79b9ba549e4ae5f39e943c63b58d4412663d2e739a6b190950
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 9, 2026.
Transparency logSecurity for jao-py 0.7.9
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.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for jao_py-0.7.9.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 9, 2026.
Transparency logA 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.
