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
  • Intelligent retry mechanism with exponential backoff for connection errors and service unavailability
  • 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.

from pandas import DataFrame

from entsoe.Market import EnergyPrices  # from the Market Group
from entsoe.utils import extract_records

EIC = "10Y1001A1001A82H"  # "DE-LU" bidding zone

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()

records = extract_records(result)

df = DataFrame(records)
period_time_interval.start time_series.period.point.position time_series.period.point.price_amount time_series.business_type time_series.currency_unit_name time_series.price_measure_unit_name time_series.period.resolution
2018-09-30T22:00Z 1 49.3 A62 EUR MWH PT15M
2018-09-30T22:00Z 2 44.38 A62 EUR MWH PT15M
2018-09-30T22:00Z 3 36.99 A62 EUR MWH PT15M
2018-09-30T22:00Z 4 35.54 A62 EUR MWH PT15M
2018-09-30T22:00Z 5 46.5 A62 EUR MWH PT15M

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.3.2.tar.gz (247.9 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.3.2-py3-none-any.whl (536.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: entsoe_apy-0.3.2.tar.gz
  • Upload date:
  • Size: 247.9 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.3.2.tar.gz
Algorithm Hash digest
SHA256 df212e1966333a87e96654515807c7db7625a05e18f2adf37764ff9acb2c803a
MD5 68a43801826428c426fd2218133bbf07
BLAKE2b-256 fd4910d8322cae252dcbf334a7dd3fdec659a21d6f7c1dd448f320040ce38d88

See more details on using hashes here.

File details

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

File metadata

  • Download URL: entsoe_apy-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 536.4 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.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c99dd2a84238e27075f5999c68295f14cf87fc6923a7d0aebd9345a89e20edcb
MD5 4c8a058c93193e589590b5bd7ea3ece9
BLAKE2b-256 26dac752fb2f9a2920828736f98a12dcc7b62f744ea17121b2f8b7a69d091395

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