Skip to main content

Specification for Electricity Trading API.

Project description

Frequenz Electricity Trading API

Build Status PyPI Package Docs

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

frequenz_api_electricity_trading-0.8.0.tar.gz (36.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file frequenz_api_electricity_trading-0.8.0.tar.gz.

File metadata

File hashes

Hashes for frequenz_api_electricity_trading-0.8.0.tar.gz
Algorithm Hash digest
SHA256 efe0d7c836469e90aca754658fb3420cebc25e94d9cfc5f602925011db425542
MD5 060290eb161e8c1691b01eafbe0d2243
BLAKE2b-256 a0bb9703557cbd3856f4915157522e9fad905c51e47083c1092141b6258c8a91

See more details on using hashes here.

Provenance

The following attestation bundles were made for frequenz_api_electricity_trading-0.8.0.tar.gz:

Publisher: ci.yaml on frequenz-floss/frequenz-api-electricity-trading

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file frequenz_api_electricity_trading-0.8.0-py3-none-any.whl.

File metadata

File hashes

Hashes for frequenz_api_electricity_trading-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9da51b85532af9d953af6d3e57e0b4ab945c260e847415a94170b8bb20487123
MD5 e35446bf39be84a6d85f2c155b0c7c56
BLAKE2b-256 108f13ca724080bc185b539a2e0c3f3bd63e3307e37588eab17720db483d64c2

See more details on using hashes here.

Provenance

The following attestation bundles were made for frequenz_api_electricity_trading-0.8.0-py3-none-any.whl:

Publisher: ci.yaml on frequenz-floss/frequenz-api-electricity-trading

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page