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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: jao_py-0.4.8.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.8.tar.gz
Algorithm Hash digest
SHA256 99ef40939444827a0784d228aee13964881716dd3359ead8263157be3b921e8f
MD5 66507e5fbc87ce57fec6546366166f30
BLAKE2b-256 efc365467ac3d2d2a073ca4a3c7b69ab215917b1669c6a25ec806c680839ef94

See more details on using hashes here.

File details

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

File metadata

  • Download URL: jao_py-0.4.8-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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 605a1ab650706f1182540776abcc438b94b428fb00fc2889c46c770a7f857c8e
MD5 fb13931b77d1a05a3fd1facc037b0016
BLAKE2b-256 6dcc746ca8de77dace2f15b558b234b7ca235d90ee9caf1615f59eaae1e0a015

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