# Frequenz Electricity Trading API
[](https://github.com/frequenz-floss/frequenz-api-electricity-trading/actions/workflows/ci.yaml)
[](https://pypi.org/project/frequenz-api-electricity-trading/)
[](https://frequenz-floss.github.io/frequenz-api-electricity-trading/)
## Introduction
Specification for Electricity Trading API.
## Overview
The Frequenz API offers a robust set of operations for managing electricity trading orders within Gridpools.
A Gridpool is an aggregation of multiple microgrids into a virtual power pool, designed to ensure the balancing
of electricity supply and demand in real time.
## Objective
The primary aim of this API is to streamline the process of electricity trading within balancing groups.
A balancing group is a network configuration that includes multiple electricity producers and consumers.
Grid stability relies on maintaining a balance between supply and demand within these groups. Participants
causing imbalances can face financial penalties. Using this API, individual participants can trade electricity
efficiently, ensuring they meet both their operational needs and financial objectives, while also contributing to
the overall grid stability.
## Key Features
- Order Placement: Facilitates the creation, modification, and deletion of trading orders.
- Real-Time Matching: Enables real-time order matching within the Gridpool.
- Order Tracking: Allows users to track the status of their orders, providing transparency and control.
- Public Order Book: Provides access to a list of public orders for market visibility and analysis.
## Target Audience
This API is primarily designed for application developers in the energy sector who focus on electricity
trading, grid management, and related services. While the API covers complex energy market operations,
its design aims to be as developer-friendly as possible, requiring no specialized knowledge in energy systems.
## 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-api-electricity-trading",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.11",
"maintainer_email": null,
"keywords": "frequenz, python, api, grpc, protobuf, rpc, electricity-trading",
"author": null,
"author_email": "Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>",
"download_url": "https://files.pythonhosted.org/packages/f2/20/85a269b2051382cf8fd5b0fea44604cd39f8e27d9669957ca012efebb1ac/frequenz-api-electricity-trading-0.2.4.tar.gz",
"platform": null,
"description": "# Frequenz Electricity Trading API\n\n[](https://github.com/frequenz-floss/frequenz-api-electricity-trading/actions/workflows/ci.yaml)\n[](https://pypi.org/project/frequenz-api-electricity-trading/)\n[](https://frequenz-floss.github.io/frequenz-api-electricity-trading/)\n\n## Introduction\n\nSpecification for Electricity Trading API.\n\n## Overview\n\nThe Frequenz API offers a robust set of operations for managing electricity trading orders within Gridpools.\nA Gridpool is an aggregation of multiple microgrids into a virtual power pool, designed to ensure the balancing\nof electricity supply and demand in real time.\n\n## Objective\n\nThe primary aim of this API is to streamline the process of electricity trading within balancing groups.\nA balancing group is a network configuration that includes multiple electricity producers and consumers.\nGrid stability relies on maintaining a balance between supply and demand within these groups. Participants\ncausing imbalances can face financial penalties. Using this API, individual participants can trade electricity\nefficiently, ensuring they meet both their operational needs and financial objectives, while also contributing to\nthe overall grid stability.\n\n## Key Features\n\n- Order Placement: Facilitates the creation, modification, and deletion of trading orders.\n- Real-Time Matching: Enables real-time order matching within the Gridpool.\n- Order Tracking: Allows users to track the status of their orders, providing transparency and control.\n- Public Order Book: Provides access to a list of public orders for market visibility and analysis.\n\n## Target Audience\n\nThis API is primarily designed for application developers in the energy sector who focus on electricity\ntrading, grid management, and related services. While the API covers complex energy market operations,\nits design aims to be as developer-friendly as possible, requiring no specialized knowledge in energy systems.\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": "Specification for Electricity Trading API.",
"version": "0.2.4",
"project_urls": {
"Changelog": "https://github.com/frequenz-floss/frequenz-api-electricity-trading/releases",
"Documentation": "https://frequenz-floss.github.io/frequenz-api-electricity-trading/",
"Issues": "https://github.com/frequenz-floss/frequenz-api-electricity-trading/issues",
"Repository": "https://github.com/frequenz-floss/frequenz-api-electricity-trading",
"Support": "https://github.com/frequenz-floss/frequenz-api-electricity-trading/discussions/categories/support"
},
"split_keywords": [
"frequenz",
" python",
" api",
" grpc",
" protobuf",
" rpc",
" electricity-trading"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c3f7bf2b7820e2f33deaeb1a8145efe70eed41b2a20e03280882060b610f154e",
"md5": "f274af6039704f12e78f02a809caebcb",
"sha256": "163eee277fbaadf18b82c4afb635aa2f2d9c95ecbf4d9db05b01cd6ee062402f"
},
"downloads": -1,
"filename": "frequenz_api_electricity_trading-0.2.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f274af6039704f12e78f02a809caebcb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.11",
"size": 24902,
"upload_time": "2024-10-09T11:22:43",
"upload_time_iso_8601": "2024-10-09T11:22:43.151696Z",
"url": "https://files.pythonhosted.org/packages/c3/f7/bf2b7820e2f33deaeb1a8145efe70eed41b2a20e03280882060b610f154e/frequenz_api_electricity_trading-0.2.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f22085a269b2051382cf8fd5b0fea44604cd39f8e27d9669957ca012efebb1ac",
"md5": "724bc4c32650ebc4a8b1caa4774bb3af",
"sha256": "b3392cebf1425c12f4e87b22d1c0c1f031caf38340febd6ec4e3c52962ea7490"
},
"downloads": -1,
"filename": "frequenz-api-electricity-trading-0.2.4.tar.gz",
"has_sig": false,
"md5_digest": "724bc4c32650ebc4a8b1caa4774bb3af",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.11",
"size": 34323,
"upload_time": "2024-10-09T11:22:44",
"upload_time_iso_8601": "2024-10-09T11:22:44.711366Z",
"url": "https://files.pythonhosted.org/packages/f2/20/85a269b2051382cf8fd5b0fea44604cd39f8e27d9669957ca012efebb1ac/frequenz-api-electricity-trading-0.2.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-09 11:22:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "frequenz-floss",
"github_project": "frequenz-api-electricity-trading",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "frequenz-api-electricity-trading"
}
JSON
