# TenneT-py
Python client for ingesting the TenneT System & transmission data API which can be found [here](https://www.tennet.org/english/operational_management/export_data_explanation.aspx).
It is a public API for which no API key is needed.
The library currently supports four data items:
* Measurement data
* Imbalance price
* Balance delta with prices
* Available capacity
Data can be retrieved as raw text or a Pandas DataFrame.
The client currently has two methods:
* ```base_request```: retrieves specified data in csv or xml text format
* ```query_df```: retrieves specified data and returnes a Pandas DataFrame
## Installation
```pip install tennet-py```
## Example Usages
```python
from tennet import TenneTClient, DataType, OutputType
import pandas as pd
start = pd.Timestamp("2021-01-01")
end = pd.Timestamp("2021-01-31")
# initiate the client, you can specify a default output to not always specify it per call
client = TenneTClient(default_output=OutputType.CSV)
# retrieve data as text in default output (in this case csv)
data = client.base_request(DataType.settlementprices, d_from=start, d_to=end)
# retrieve data as xml
data = client.base_request(DataType.settlementprices, d_from=start, d_to=end, output_type=OutputType.XML)
# retrieve same data as a dataframe
df = client.query_df(DataType.settlementprices, d_from=start, d_to=end)
```
## Netztransparenz
Also supported is a limited number of endpoints of the german TenneT from the Netztransparenz platform. First register and get oauth credentials as explained on the documentation page [here](https://www.netztransparenz.de/en/Web-API)
Then can be used as follows:
```python
from tennet import NetztransparenzClient
import pandas as pd
client = NetztransparenzClient(oauth_client_id, oauth_client_secret)
df = client.query_imbalance(start=pd.Timestamp('2023-12-22', tz='europe/amsterdam'), end=pd.Timestamp('2023-12-22 23:59', tz='europe/amsterdam'))
```
## Disclaimer
This is an unoffical package which is not supported or endorsed in any way by TenneT TSO.
Raw data
{
"_id": null,
"home_page": "https://github.com/fboerman/tennet-py",
"name": "tennet-py",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "TenneT data api energy",
"author": "Frank Boerman",
"author_email": "frank@fboerman.nl",
"download_url": "https://files.pythonhosted.org/packages/95/b0/8c22f23812847000d413c1a9b616df4719066293d45e669d98724c857f2d/tennet-py-0.2.1.tar.gz",
"platform": null,
"description": "# TenneT-py\nPython client for ingesting the TenneT System & transmission data API which can be found [here](https://www.tennet.org/english/operational_management/export_data_explanation.aspx).\nIt is a public API for which no API key is needed.\n\nThe library currently supports four data items:\n\n* Measurement data\n* Imbalance price\n* Balance delta with prices\n* Available capacity\n\nData can be retrieved as raw text or a Pandas DataFrame.\n\nThe client currently has two methods:\n* ```base_request```: retrieves specified data in csv or xml text format\n* ```query_df```: retrieves specified data and returnes a Pandas DataFrame\n\n## Installation\n```pip install tennet-py```\n\n## Example Usages\n```python\nfrom tennet import TenneTClient, DataType, OutputType\nimport pandas as pd\n\nstart = pd.Timestamp(\"2021-01-01\")\nend = pd.Timestamp(\"2021-01-31\")\n\n# initiate the client, you can specify a default output to not always specify it per call\nclient = TenneTClient(default_output=OutputType.CSV)\n# retrieve data as text in default output (in this case csv)\ndata = client.base_request(DataType.settlementprices, d_from=start, d_to=end)\n# retrieve data as xml\ndata = client.base_request(DataType.settlementprices, d_from=start, d_to=end, output_type=OutputType.XML)\n\n# retrieve same data as a dataframe\ndf = client.query_df(DataType.settlementprices, d_from=start, d_to=end)\n```\n\n## Netztransparenz\nAlso supported is a limited number of endpoints of the german TenneT from the Netztransparenz platform. First register and get oauth credentials as explained on the documentation page [here](https://www.netztransparenz.de/en/Web-API)\nThen can be used as follows:\n```python\nfrom tennet import NetztransparenzClient\nimport pandas as pd\n\nclient = NetztransparenzClient(oauth_client_id, oauth_client_secret)\ndf = client.query_imbalance(start=pd.Timestamp('2023-12-22', tz='europe/amsterdam'), end=pd.Timestamp('2023-12-22 23:59', tz='europe/amsterdam'))\n```\n\n## Disclaimer\nThis is an unoffical package which is not supported or endorsed in any way by TenneT TSO.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A python API wrapper for TenneT System & transmission data",
"version": "0.2.1",
"project_urls": {
"Homepage": "https://github.com/fboerman/tennet-py"
},
"split_keywords": [
"tennet",
"data",
"api",
"energy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2311589fcff38e7e1053234971536e523c0702ea4879b596de345ccc39d92e51",
"md5": "5fd41b034d375ab5d4abf8b8fbb10e8e",
"sha256": "f7d4f48bdc99f30748103a946194637509610a8b0bdb9178a688568e0420c510"
},
"downloads": -1,
"filename": "tennet_py-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5fd41b034d375ab5d4abf8b8fbb10e8e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7230,
"upload_time": "2024-02-08T09:13:46",
"upload_time_iso_8601": "2024-02-08T09:13:46.772532Z",
"url": "https://files.pythonhosted.org/packages/23/11/589fcff38e7e1053234971536e523c0702ea4879b596de345ccc39d92e51/tennet_py-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "95b08c22f23812847000d413c1a9b616df4719066293d45e669d98724c857f2d",
"md5": "ea99692b495ec470c6f545acf192efec",
"sha256": "e17e5edaf1fd06651345f7b342d2d2008de0be2a6e9c56d38d3f71436b654b7b"
},
"downloads": -1,
"filename": "tennet-py-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "ea99692b495ec470c6f545acf192efec",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6469,
"upload_time": "2024-02-08T09:13:48",
"upload_time_iso_8601": "2024-02-08T09:13:48.279187Z",
"url": "https://files.pythonhosted.org/packages/95/b0/8c22f23812847000d413c1a9b616df4719066293d45e669d98724c857f2d/tennet-py-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-08 09:13:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fboerman",
"github_project": "tennet-py",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "requests",
"specs": []
},
{
"name": "pandas",
"specs": []
},
{
"name": "lxml",
"specs": []
}
],
"lcname": "tennet-py"
}
JSON
