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.9.0.tar.gz (76.8 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.9.0.tar.gz.

File metadata

File hashes

Hashes for frequenz_api_electricity_trading-0.9.0.tar.gz
Algorithm Hash digest
SHA256 24fb8f8278e654f94148c0bfee107c32bd816e3b5d45070c76b92d29469bbac2
MD5 c1f464dac7e5233792575930bd55eaf5
BLAKE2b-256 c298396afde4f471a1faf12edb49b5716fe8256a9766086ada5aab7edcbfa9dc

See more details on using hashes here.

Provenance

The following attestation bundles were made for frequenz_api_electricity_trading-0.9.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.9.0-py3-none-any.whl.

File metadata

File hashes

Hashes for frequenz_api_electricity_trading-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 670138fb0533ad161d73dbfd5d927017bf80789f8e179160cd0dda52d87aee69
MD5 29e8aeb763ccffea21cb7c01f0eba899
BLAKE2b-256 de194fb67825bbbb28cb0cd21836a76688287ad19414c371f938301cacc3f54e

See more details on using hashes here.

Provenance

The following attestation bundles were made for frequenz_api_electricity_trading-0.9.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