jao-py

tests

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:

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 pakcage
  • JaoUtilityToolCSVClient: client to download csv data inm the same way as the utility tool excel file, returns pandas dataframes
  • JaoUtilityToolXmlClient: 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

Project links

Data verified by PyPI on Aug 26, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.7.8)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for fboerman from gravatar.com fboerman

Credits

Author: Frank Boerman-Lima

GitHub Statistics

Data verified by PyPI on Aug 26, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

MIT
View SPDX License List

Requires

Python >=3.9

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jao_py-0.7.7.tar.gz (95.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jao_py-0.7.7-py3-none-any.whl (23.3 kB view details)

Uploaded Python 3

File details

Details for the file jao_py-0.7.7.tar.gz.

File metadata

  • Download URL: jao_py-0.7.7.tar.gz
  • Upload date:
  • Size: 95.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for jao_py-0.7.7.tar.gz
Algorithm Hash digest
SHA256 24f396b953bdec109d5de4b5733b5b53276ca60b425820a274b8da9cc2713282
MD5 5261b1442f232cb6a1290f42ccad5c6e
BLAKE2b-256 7b677eff689d476ba0ed379b755f3a79e63c2c72d9d0f4404762f768aeaf6168

See more details on using hashes here.

Provenance

The following attestation bundles were made for jao_py-0.7.7.tar.gz:

Publisher: publish-to-pypi.yml on fboerman/jao-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file jao_py-0.7.7-py3-none-any.whl.

File metadata

  • Download URL: jao_py-0.7.7-py3-none-any.whl
  • Upload date:
  • Size: 23.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for jao_py-0.7.7-py3-none-any.whl
Algorithm Hash digest
SHA256 603efdc61da5fc200b05818b8c941e21b70e2cc271b25418d54d00a0c51e2673
MD5 412a04fb03b1ba947402d37e900b4d7b
BLAKE2b-256 8bb1df1099bd01cc082e06676baf4a56d27e407db91406a6b4e1f552e014bd00

See more details on using hashes here.

Provenance

The following attestation bundles were made for jao_py-0.7.7-py3-none-any.whl:

Publisher: publish-to-pypi.yml on fboerman/jao-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.7.8

2 files

This release

0.7.7 This release

2 files

0.7.6

2 files

0.7.5

2 files

0.7.4

2 files

0.7.3

2 files

0.7.2

2 files

0.7.1

2 files

0.7.0

2 files

0.6.9

2 files

0.6.8

2 files

0.6.7

2 files

0.6.6

2 files

0.6.5

2 files

0.6.4

2 files

0.6.3

2 files

0.6.2

2 files

0.6.1

2 files

0.6.0

2 files

0.5.14

2 files

0.5.13

2 files

0.5.12

2 files

0.5.11

2 files

0.5.10

2 files

0.5.9

2 files

0.5.8

2 files

0.5.7

2 files

0.5.6

2 files

0.5.5

2 files

0.5.4

2 files

0.5.3

2 files

0.5.2

2 files

0.5.1

2 files

0.5.0

2 files

0.4.10

2 files

0.4.9

2 files

0.4.8

2 files

0.4.7

2 files

0.4.6

2 files

0.4.5

2 files

0.4.4

2 files

0.4.3

2 files

0.4.2

2 files

0.4.1

2 files

0.4.0

2 files

0.3.13

2 files

0.3.12

2 files

0.3.11

2 files

0.3.10

2 files

0.3.9

2 files

0.3.8

2 files

0.3.7

2 files

0.3.6

2 files

0.3.5

2 files

0.3.4

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.4

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.9

2 files

0.1.8

2 files

0.1.7

2 files

0.1.6

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page