Skip to main content

A Python library for accessing ENTSO-E Transparency Platform API endpoints

Project description

ENTSO-E API Python Package

A Python library for accessing ENTSO-E Transparency Platform API endpoints.

-> Documentation

Highlights

  • Easy access to ENTSO-E Transparency Platform API endpoints
  • Supports all major API functionalities
  • Well-documented, easy to use and highly consistent with the API
  • Automatically splits up large requests into multiple smaller calls to the API
  • Retries on connection errors
  • Returns meaningful error messages if something goes wrong

Install

Install the package from pypi using pip:

pip install entsoe-apy

Quick Start

API Key

You need an ENTSOE API Key (also called token) refer to the official documentation on how to obtain it. The package expects an environment variable called ENTSOE_API to be set with your API key. See Configuration for more details and options.

Query Day-Ahead Prices

The package structure mirrors the official ENTSO-E API docs. So for querying "12.1.D Energy Prices" we need the entsoe.Market module and use the EnergyPrices class.

After initializing the class, we can query the data using the query_data method.

# Import item from the Market Group
from entsoe.Market import EnergyPrices

EIC = "10Y1001A1001A82H" # DE-AT Biddingzone

period_start = 201512312300
period_end = 202107022300

ep = EnergyPrices(
    in_domain=EIC,
    out_domain=EIC,
    period_start=period_start,
    period_end=period_end,
    contract_market_agreement_type="A01",
)
result = ep.query_api()

The structure of the result object depends on the queried data. See the examples for more details.

Next Steps

  • ENTSOE - Class documentation
  • Examples - Practical examples and use cases

Contributions

Contributions are welcome! Please open an issue or submit a pull request.

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

entsoe_apy-0.2.0.tar.gz (228.5 kB view details)

Uploaded Source

Built Distribution

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

entsoe_apy-0.2.0-py3-none-any.whl (517.8 kB view details)

Uploaded Python 3

File details

Details for the file entsoe_apy-0.2.0.tar.gz.

File metadata

  • Download URL: entsoe_apy-0.2.0.tar.gz
  • Upload date:
  • Size: 228.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for entsoe_apy-0.2.0.tar.gz
Algorithm Hash digest
SHA256 5bbf9f9c0ca964d47badc4f315d2375cfccd14e33e712b866f70b0807176e066
MD5 106527f7e16115fe095a442cc70c75ec
BLAKE2b-256 c4b561f638aa667502e556a7ab86e997e84a2732f3f9edb215bc9be7c90f9470

See more details on using hashes here.

File details

Details for the file entsoe_apy-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: entsoe_apy-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 517.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for entsoe_apy-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 509e915aaa35ff85b6a5edbe8766144fa73db4b6fdcd3c59f9234d145c14652e
MD5 1bc6ede983baa185c859dc477b2cd748
BLAKE2b-256 3fe465498b632539fe33efb2fc6b3830dc14c4ea679d031336ae8b0755d5eb2d

See more details on using hashes here.

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