Skip to main content

A python API wrapper for JAO.eu

Project description

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:

  • JaoAPIClient: api client for the webservice API defined here
  • JaoPublicationToolClient: client for the CORE Day Ahead publication tool defined here
  • JaoPublicationToolPandasIntraDay: client for CORE Intradaypublication tool for Intraday 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(b): business day 2024-05-29 onwards
  • CORE Intraday(a): business day 2024-06-14 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)

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 details


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.4.7.tar.gz (15.4 kB view details)

Uploaded Source

Built Distribution

jao_py-0.4.7-py3-none-any.whl (17.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: jao_py-0.4.7.tar.gz
  • Upload date:
  • Size: 15.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for jao_py-0.4.7.tar.gz
Algorithm Hash digest
SHA256 3dd1a302c418d2acc9290e5017f1f16d2795e94bf9f8b555dd4ba68913b6e7fa
MD5 116c25ef7af773fbaa35c549a1167d89
BLAKE2b-256 216514a3adc4f76ae1c8e2eede202f1a19a3fbd0449843e5892debab187cbba5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: jao_py-0.4.7-py3-none-any.whl
  • Upload date:
  • Size: 17.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for jao_py-0.4.7-py3-none-any.whl
Algorithm Hash digest
SHA256 40d1519d5bc2bf9513338955889c072df34681f0f96442d865eaaf33fd6c572d
MD5 25431d30901e89f85f749849b90ef0dc
BLAKE2b-256 125652e471b2ea8a940011fedb9dae98466dd7ef2c25705b5dfcb8a9c2174c7b

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