Skip to main content

Electricity Trading API client for Python

Project description

Frequenz Electricity Trading API Client

Build Status PyPI Package Docs

Introduction

Electricity Trading API client for Python The Frequenz Electricity Trading API client for Python is an easy-to-use Python interface built to interact with the Frequenz Electricity Trading API. It allows you to create orders, get market data, and manage your orders.

Features

  • Create and manage gridpool orders: Place new orders, update existing ones, and cancel orders when necessary.
  • Stream live data: Get real-time updates on market data, including order books, trades, and market prices.
  • Retrieve historical data: Access historical data on market trades.

Supported Platforms

The following platforms are officially supported (tested):

  • Python: 3.11
  • Operating System: Ubuntu Linux 20.04
  • Architectures: amd64, arm64

Usage

Installation

We assume you are on a system with Python available. If that is not the case, please download and install Python first.

To install the Frequenz Electricity Trading AP, you probably want to create a new virtual environment first. For example, if you use a sh compatible shell, you can do this:

python3 -m venv .venv
. .venv/bin/activate

Then, just install using pip. Replace VERSION with the specific version you wish to install:

# Choose the version you want to install
VERSION=0.2.3
pip install frequenz-client-electricity-trading==$VERSION

Documentation

For more information, please visit the documentation website.

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_client_electricity_trading-0.0.9.tar.gz (36.5 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_client_electricity_trading-0.0.9.tar.gz.

File metadata

File hashes

Hashes for frequenz_client_electricity_trading-0.0.9.tar.gz
Algorithm Hash digest
SHA256 033cfe404734ef05f68d28209915f5743f31660f2fdf1e5268c4b4314272ada1
MD5 7e5683ed3e77b83c81204c42067ea69c
BLAKE2b-256 9a6d79ada135984e15a1abdd50ad48784a6f1a741fea798afb694908c97d438f

See more details on using hashes here.

Provenance

The following attestation bundles were made for frequenz_client_electricity_trading-0.0.9.tar.gz:

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

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_client_electricity_trading-0.0.9-py3-none-any.whl.

File metadata

File hashes

Hashes for frequenz_client_electricity_trading-0.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 abb632559267c1e80f6363f36804876fd6c87379766bd1a74da880100f6cff1a
MD5 03261915f3e770dbb64fef7920d69bdc
BLAKE2b-256 62e1cd09fdec2ae53f13d8527dd892f36bb1be78ce064fd355904a543045aa08

See more details on using hashes here.

Provenance

The following attestation bundles were made for frequenz_client_electricity_trading-0.0.9-py3-none-any.whl:

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

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