# 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`](#JaoAPIClient): api client for the webservice API defined [here](https://www.jao.eu/page-api/market-data)
- [`JaoPublicationToolClient`](#JaoPublicationToolClient): client for the CORE Day Ahead publication tool defined [here](https://publicationtool.jao.eu/core/)
- [`JaoPublicationToolPandasIntraDay`](#JaoPublicationToolPandasIntraDay): client for CORE Intradaypublication tool for Intraday defined [here](https://publicationtool.jao.eu/coreID/)
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:
```python
from jao import JaoPublicationToolPandasIntraDay
client = JaoPublicationToolPandasIntraDay(version='a') # IDCC(a)
client = JaoPublicationToolPandasIntraDay(version='b') # IDCC(b)
```
There is also a client available for parallel run, which works in the exact same way as the intraday client above:
```python
from jao import JaoPublicationToolPandasIntraDayParRun
client = JaoPublicationToolPandasIntraDayParRun('c') #IDCC(c)
```
### 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`](#JaoUtilityToolASMXClient): a very light wrapper around the ASMX Web Service API implemented as a passthrough to the suds-community pakcage
- [`JaoUtilityToolCSVClient`](#JaoUtilityToolCSVClient): client to download csv data inm the same way as the utility tool excel file, returns pandas dataframes
- [`JaoUtilityToolXmlClient`](#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
Raw data
{
"_id": null,
"home_page": "https://github.com/fboerman/jao-py",
"name": "jao-py",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "JAO data api energy",
"author": "Frank Boerman",
"author_email": "frank@fboerman.nl",
"download_url": "https://files.pythonhosted.org/packages/82/5a/35dc0f1dbcd8ea94f978c8a7a5f8cef6981c9829cedf024493586d4d3907/jao_py-0.5.3.tar.gz",
"platform": null,
"description": "# jao-py\n\n\nPython client for the various endpoints offered by jao.eu, the Joint Allocation Office.\n\"Europe's single leading trading platform( e-CAT) for cross-border transmission capacity\"\n\nMore information about JAO can be found on their website https://jao.eu/\n\njao.eu has various ways of retrieving data. This package tries to offer useful functions to handle them.\nThis package is not exhaustive, more methods are added when the authors needs them.\nIf you want to see other methods added please either open a feature request issue to give others ideas or \nsupply a pull request yourself.\n\n\n## Installation\n`python3 -m pip install jao-py`\n\n## Usage\n### Current clients\nThe package comes with the current pandas clients:\n- [`JaoAPIClient`](#JaoAPIClient): api client for the webservice API defined [here](https://www.jao.eu/page-api/market-data)\n- [`JaoPublicationToolClient`](#JaoPublicationToolClient): client for the CORE Day Ahead publication tool defined [here](https://publicationtool.jao.eu/core/)\n- [`JaoPublicationToolPandasIntraDay`](#JaoPublicationToolPandasIntraDay): client for CORE Intradaypublication tool for Intraday defined [here](https://publicationtool.jao.eu/coreID/)\nThe publication tool clients have valid data from their respective go lives:\n- CORE Day Ahead: business day 2022-06-09 onwards\n- CORE Intraday(b): business day 2024-05-29 onwards\n- CORE Intraday(a): business day 2024-06-14 onwards\n\nCORE 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:\n```python\nfrom jao import JaoPublicationToolPandasIntraDay\n\nclient = JaoPublicationToolPandasIntraDay(version='a') # IDCC(a)\nclient = JaoPublicationToolPandasIntraDay(version='b') # IDCC(b)\n```\n\nThere is also a client available for parallel run, which works in the exact same way as the intraday client above:\n```python\nfrom jao import JaoPublicationToolPandasIntraDayParRun\n\nclient = JaoPublicationToolPandasIntraDayParRun('c') #IDCC(c)\n```\n\n### Deprecated clients\nThe package also includes legacy clients for flowbased CWE data in the CWE subpackage. These return data up until business day 2022-06-08\n- [`JaoUtilityToolASMXClient`](#JaoUtilityToolASMXClient): a very light wrapper around the ASMX Web Service API implemented as a passthrough to the suds-community pakcage\n- [`JaoUtilityToolCSVClient`](#JaoUtilityToolCSVClient): client to download csv data inm the same way as the utility tool excel file, returns pandas dataframes\n- [`JaoUtilityToolXmlClient`](#JaoUtilityToolXmlClient): downloads xml data of the utilitytool, this requires solving a captcha by the user, returns pandas dataframes\n\nTo use these deprecated clients be sure to install the following additional dependencies:\n```\nsuds-community\nlxml\npillow\n```\nthis is only required for the CWE deprecated subpackage\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A python API wrapper for JAO.eu",
"version": "0.5.3",
"project_urls": {
"Homepage": "https://github.com/fboerman/jao-py"
},
"split_keywords": [
"jao",
"data",
"api",
"energy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e36535770bc0761d3512b83c911b37483cd9e1f73ad260438f9164187564e92a",
"md5": "922580510f8b700ae0785b0c6861cf20",
"sha256": "53a31baf5d9f30b13c08ced0ee25c700c566a7ca6afff46503334211435b6c25"
},
"downloads": -1,
"filename": "jao_py-0.5.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "922580510f8b700ae0785b0c6861cf20",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 18951,
"upload_time": "2025-01-06T22:40:41",
"upload_time_iso_8601": "2025-01-06T22:40:41.397327Z",
"url": "https://files.pythonhosted.org/packages/e3/65/35770bc0761d3512b83c911b37483cd9e1f73ad260438f9164187564e92a/jao_py-0.5.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "825a35dc0f1dbcd8ea94f978c8a7a5f8cef6981c9829cedf024493586d4d3907",
"md5": "8f4170172a897305bcdc803258ca8724",
"sha256": "1091fbb1bd82e07812a2559c9388b39937573a073b08d16fd73e68c99a4ae5d9"
},
"downloads": -1,
"filename": "jao_py-0.5.3.tar.gz",
"has_sig": false,
"md5_digest": "8f4170172a897305bcdc803258ca8724",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 16126,
"upload_time": "2025-01-06T22:40:44",
"upload_time_iso_8601": "2025-01-06T22:40:44.277858Z",
"url": "https://files.pythonhosted.org/packages/82/5a/35dc0f1dbcd8ea94f978c8a7a5f8cef6981c9829cedf024493586d4d3907/jao_py-0.5.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-06 22:40:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fboerman",
"github_project": "jao-py",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "requests",
"specs": []
},
{
"name": "pandas",
"specs": []
},
{
"name": "suds-community",
"specs": []
},
{
"name": "python-dateutil",
"specs": []
},
{
"name": "pillow",
"specs": []
},
{
"name": "beautifulsoup4",
"specs": []
},
{
"name": "lxml",
"specs": []
},
{
"name": "pytest",
"specs": []
}
],
"lcname": "jao-py"
}
JSON
