# Frequenz Electricity Trading API Client
[](https://github.com/frequenz-floss/frequenz-client-electricity-trading-python/actions/workflows/ci.yaml)
[](https://pypi.org/project/frequenz-client-electricity-trading/)
[](https://frequenz-floss.github.io/frequenz-client-electricity-trading-python/)
## Introduction
Electricity Trading API client for Python
The Frequenz Electricity Trading API client for Python is an easy-to-use Python interface built to interact with the Frequenz Electricity Trading API. It allows you to create orders, get market data, and manage your orders.
## Features
* **Create and manage gridpool orders**: Place new orders, update existing ones, and cancel orders when necessary.
* **Stream live data**: Get real-time updates on market data, including order books, trades, and market prices.
* **Retrieve historical data**: Access historical data on market trades.
## Supported Platforms
The following platforms are officially supported (tested):
* **Python:** 3.11
* **Operating System:** Ubuntu Linux 20.04
* **Architectures:** amd64, arm64
## Usage
### Installation
We assume you are on a system with Python available. If that is not the case,
please [download and install Python](https://www.python.org/downloads/) first.
To install the Frequenz Electricity Trading AP, you probably want to create a new virtual
environment first. For example, if you use a `sh` compatible shell, you can do this:
```sh
python3 -m venv .venv
. .venv/bin/activate
```
Then, just install using `pip`. Replace `VERSION` with the specific version you wish to install:
```sh
# Choose the version you want to install
VERSION=0.2.3
pip install frequenz-client-electricity-trading==$VERSION
```
## Documentation
For more information, please visit the [documentation
website](https://frequenz-floss.github.io/frequenz-client-electricity-trading-python/).
## Contributing
If you want to know how to build this project and contribute to it, please
check out the [Contributing Guide](CONTRIBUTING.md).
Raw data
{
"_id": null,
"home_page": null,
"name": "frequenz-client-electricity-trading",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.11",
"maintainer_email": null,
"keywords": "frequenz, python, lib, library, client-electricity-trading, client, api, python, trading, electricity-trading",
"author": null,
"author_email": "Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>",
"download_url": "https://files.pythonhosted.org/packages/6f/d1/9a08f42cecb30bbd6875734bff0f091783a8e82856d3d22c894634cfaa24/frequenz_client_electricity_trading-0.3.1.tar.gz",
"platform": null,
"description": "# Frequenz Electricity Trading API Client\n\n[](https://github.com/frequenz-floss/frequenz-client-electricity-trading-python/actions/workflows/ci.yaml)\n[](https://pypi.org/project/frequenz-client-electricity-trading/)\n[](https://frequenz-floss.github.io/frequenz-client-electricity-trading-python/)\n\n## Introduction\n\nElectricity Trading API client for Python\nThe Frequenz Electricity Trading API client for Python is an easy-to-use Python interface built to interact with the Frequenz Electricity Trading API. It allows you to create orders, get market data, and manage your orders.\n\n## Features\n\n* **Create and manage gridpool orders**: Place new orders, update existing ones, and cancel orders when necessary.\n* **Stream live data**: Get real-time updates on market data, including order books, trades, and market prices.\n* **Retrieve historical data**: Access historical data on market trades.\n\n## Supported Platforms\n\nThe following platforms are officially supported (tested):\n\n* **Python:** 3.11\n* **Operating System:** Ubuntu Linux 20.04\n* **Architectures:** amd64, arm64\n\n## Usage\n\n### Installation\n\nWe assume you are on a system with Python available. If that is not the case,\nplease [download and install Python](https://www.python.org/downloads/) first.\n\n\nTo install the Frequenz Electricity Trading AP, you probably want to create a new virtual\nenvironment first. For example, if you use a `sh` compatible shell, you can do this:\n\n```sh\npython3 -m venv .venv\n. .venv/bin/activate\n```\n\nThen, just install using `pip`. Replace `VERSION` with the specific version you wish to install:\n\n```sh\n# Choose the version you want to install\nVERSION=0.2.3\npip install frequenz-client-electricity-trading==$VERSION\n```\n\n\n## Documentation\n\nFor more information, please visit the [documentation\nwebsite](https://frequenz-floss.github.io/frequenz-client-electricity-trading-python/).\n\n\n## Contributing\n\nIf you want to know how to build this project and contribute to it, please\ncheck out the [Contributing Guide](CONTRIBUTING.md).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Electricity Trading API client for Python",
"version": "0.3.1",
"project_urls": {
"Changelog": "https://github.com/frequenz-floss/frequenz-client-electricity-trading-python/releases",
"Documentation": "https://frequenz-floss.github.io/frequenz-client-electricity-trading-python/",
"Issues": "https://github.com/frequenz-floss/frequenz-client-electricity-trading-python/issues",
"Repository": "https://github.com/frequenz-floss/frequenz-client-electricity-trading-python",
"Support": "https://github.com/frequenz-floss/frequenz-client-electricity-trading-python/discussions/categories/support"
},
"split_keywords": [
"frequenz",
" python",
" lib",
" library",
" client-electricity-trading",
" client",
" api",
" python",
" trading",
" electricity-trading"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a5bb051780b3fd0405ceb481140d2807a1b2cb75a7392d6e59bd1fede13b569e",
"md5": "eb8a873a368b72cb7945df9876295263",
"sha256": "d65cb80e6b2519fbbcf0702f5caa936fcc5e0a9ce5bad99f8d191a9c3fcc202a"
},
"downloads": -1,
"filename": "frequenz_client_electricity_trading-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "eb8a873a368b72cb7945df9876295263",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.11",
"size": 23618,
"upload_time": "2024-12-12T16:12:32",
"upload_time_iso_8601": "2024-12-12T16:12:32.754501Z",
"url": "https://files.pythonhosted.org/packages/a5/bb/051780b3fd0405ceb481140d2807a1b2cb75a7392d6e59bd1fede13b569e/frequenz_client_electricity_trading-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6fd19a08f42cecb30bbd6875734bff0f091783a8e82856d3d22c894634cfaa24",
"md5": "ac87c823b0d806a9da3f24f059753b55",
"sha256": "657e7d37dc6290d02ca4d40b58a94f07bc9d30a04a4291882b13de6068f7e26b"
},
"downloads": -1,
"filename": "frequenz_client_electricity_trading-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "ac87c823b0d806a9da3f24f059753b55",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.11",
"size": 30578,
"upload_time": "2024-12-12T16:12:35",
"upload_time_iso_8601": "2024-12-12T16:12:35.583634Z",
"url": "https://files.pythonhosted.org/packages/6f/d1/9a08f42cecb30bbd6875734bff0f091783a8e82856d3d22c894634cfaa24/frequenz_client_electricity_trading-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-12 16:12:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "frequenz-floss",
"github_project": "frequenz-client-electricity-trading-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "frequenz-client-electricity-trading"
}
JSON
