# gie-py
Python client for the API endpoints of gie.eu. Both ASGI for gas storage and ALSI for LNG terminals and lso's are supported
Using it requires an api key which you can get by registering an account [at the alsi website](https://alsi.gie.eu/#/api).
API keys are valid for both ASGI and ALSI if you set "access to" to "Both ALSI and AGSI+" when registering or later in account settings.
## Installation
`python3 -m pip install gie-py`
## Usage
The package comes with 2 clients:
- [`GieRawClient`](#GieRawClient): Returns data in its raw format direct from api, a list of dictionaries
- [`GiePandasClient`](#GiePandasClient): Returns data parsed as a Pandas DataFrame
### Supported methods:
The same for both clients. Each method has same setup for arguments, a string to denominate the target
and a start and end parameter which is either a pandas timestamp or a string
* ```query_gas_storage```
* ```query_gas_company```
* ```query_gas_country```
* ```query_lng_terminal```
* ```query_lng_lso```
* ```query_lng_country```
### Example
```python
from gie import GiePandasClient
client = GiePandasClient(api_key=<YOUR API KEY>)
df_terminal=client.query_lng_terminal('zeebrugge', start='2020-01-01', end='2022-07-10')
df_lso=client.query_lng_lso('fluxys_lng', start='2020-01-01', end='2022-07-10')
```
## meaning of dataframe columns
For the meaning of the columns in the resulting dataframes please consult the official [documentation](https://alsi.gie.eu/GIE_API_documentation_v007.pdf) chapter 2 page 5 and 6
Raw data
{
"_id": null,
"home_page": "https://github.com/fboerman/gie-py",
"name": "gie-py",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "GIE data api energy gas",
"author": "Frank Boerman",
"author_email": "frank@fboerman.nl",
"download_url": "https://files.pythonhosted.org/packages/e7/54/e4d5f5b7f4b795ad8b50b512e2c74078cc86f08c674e8696fe0620f3078f/gie-py-0.4.3.tar.gz",
"platform": null,
"description": "# gie-py\nPython client for the API endpoints of gie.eu. Both ASGI for gas storage and ALSI for LNG terminals and lso's are supported\n\nUsing it requires an api key which you can get by registering an account [at the alsi website](https://alsi.gie.eu/#/api).\nAPI keys are valid for both ASGI and ALSI if you set \"access to\" to \"Both ALSI and AGSI+\" when registering or later in account settings.\n\n## Installation\n`python3 -m pip install gie-py`\n\n## Usage\nThe package comes with 2 clients:\n- [`GieRawClient`](#GieRawClient): Returns data in its raw format direct from api, a list of dictionaries \n- [`GiePandasClient`](#GiePandasClient): Returns data parsed as a Pandas DataFrame\n\n### Supported methods:\nThe same for both clients. Each method has same setup for arguments, a string to denominate the target \nand a start and end parameter which is either a pandas timestamp or a string\n* ```query_gas_storage```\n* ```query_gas_company```\n* ```query_gas_country```\n* ```query_lng_terminal```\n* ```query_lng_lso```\n* ```query_lng_country```\n\n### Example\n```python\nfrom gie import GiePandasClient\n\nclient = GiePandasClient(api_key=<YOUR API KEY>)\ndf_terminal=client.query_lng_terminal('zeebrugge', start='2020-01-01', end='2022-07-10')\ndf_lso=client.query_lng_lso('fluxys_lng', start='2020-01-01', end='2022-07-10')\n```\n\n## meaning of dataframe columns\nFor the meaning of the columns in the resulting dataframes please consult the official [documentation](https://alsi.gie.eu/GIE_API_documentation_v007.pdf) chapter 2 page 5 and 6\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A python API wrapper for alsi.gie.eu and agsi.gie.eu",
"version": "0.4.3",
"project_urls": {
"Homepage": "https://github.com/fboerman/gie-py"
},
"split_keywords": [
"gie",
"data",
"api",
"energy",
"gas"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "df47dc71fe310f8b92531b14c8639f0b89899c235921955b6f5e6bce44d4efc4",
"md5": "89d061513d92a2704ab2c30374eedff3",
"sha256": "8b158e12a140b2c1c34a04b92e1e09b0737d82ddc69ba5ce14b06375b17abfbf"
},
"downloads": -1,
"filename": "gie_py-0.4.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "89d061513d92a2704ab2c30374eedff3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 10911,
"upload_time": "2024-02-05T10:52:09",
"upload_time_iso_8601": "2024-02-05T10:52:09.148824Z",
"url": "https://files.pythonhosted.org/packages/df/47/dc71fe310f8b92531b14c8639f0b89899c235921955b6f5e6bce44d4efc4/gie_py-0.4.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e754e4d5f5b7f4b795ad8b50b512e2c74078cc86f08c674e8696fe0620f3078f",
"md5": "ca728c5253d7e6ff91b1e1b8705b2ed1",
"sha256": "22360c3b53b83cc2279128b3d10927e8b2ee84784b0f5373c1e44d3dd11eae16"
},
"downloads": -1,
"filename": "gie-py-0.4.3.tar.gz",
"has_sig": false,
"md5_digest": "ca728c5253d7e6ff91b1e1b8705b2ed1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11177,
"upload_time": "2024-02-05T10:52:10",
"upload_time_iso_8601": "2024-02-05T10:52:10.796856Z",
"url": "https://files.pythonhosted.org/packages/e7/54/e4d5f5b7f4b795ad8b50b512e2c74078cc86f08c674e8696fe0620f3078f/gie-py-0.4.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-05 10:52:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fboerman",
"github_project": "gie-py",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "pandas",
"specs": []
},
{
"name": "requests",
"specs": []
}
],
"lcname": "gie-py"
}
JSON
