Frequenz Electricity Trading API
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.
1 maintainer
Metadata
1 maintainer
Release files for frequenz-api-electricity-trading 0.9.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| frequenz_api_electricity_trading-0.9.0.tar.gz | 76.8 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| frequenz_api_electricity_trading-0.9.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 105.1 kB
Release files / frequenz_api_electricity_trading-0.9.0.tar.gz
| Download URL | frequenz_api_electricity_trading-0.9.0.tar.gz |
|---|---|
| Size | 76.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
24fb8f8278e654f94148c0bfee107c32bd816e3b5d45070c76b92d29469bbac2
|
|
BLAKE2b-256 checksum How to use checksums |
c298396afde4f471a1faf12edb49b5716fe8256a9766086ada5aab7edcbfa9dc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 28, 2025.
Transparency logRelease files / frequenz_api_electricity_trading-0.9.0-py3-none-any.whl
| Download URL | frequenz_api_electricity_trading-0.9.0-py3-none-any.whl |
|---|---|
| Size | 28.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
670138fb0533ad161d73dbfd5d927017bf80789f8e179160cd0dda52d87aee69
|
|
BLAKE2b-256 checksum How to use checksums |
de194fb67825bbbb28cb0cd21836a76688287ad19414c371f938301cacc3f54e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 28, 2025.
Transparency logSecurity for frequenz-api-electricity-trading 0.9.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for frequenz_api_electricity_trading-0.9.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 28, 2025.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
