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.1.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.1.tar.gz.

File metadata

File hashes

Hashes for frequenz_api_electricity_trading-0.8.1.tar.gz
Algorithm Hash digest
SHA256 23719201df4703deb6a1467ceb8e8662da37eca377844d0b63da74134db18e4e
MD5 aa065668ad260337a5edd8d784037f32
BLAKE2b-256 7d91fba8d23e82c5fca73fbd4b364c0c2976dd906ea2e85c9ba0e18ff362eeb1

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for frequenz_api_electricity_trading-0.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b8bf076f4e583a55fc2e6e694dc8b3e559dd4ed86ed0d73df1de2faf928c5b20
MD5 1b9264bd5f8537d0920545517f81710f
BLAKE2b-256 f408234b63e6b1194b62fc40984c81b03423833f9265ea2ae164886edbbab461

See more details on using hashes here.

Provenance

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