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.

Highlights

  • Easy access to all ENTSO-E Transparency Platform API endpoints
  • 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 entsoe.utils import extract_records, add_timestamps

# Query energy prices
result = EnergyPrices(
    in_domain="10YNL----------L", # Netherlands
    out_domain="10YNL----------L",
    period_start=202012312300,
    period_end=202101022300,
).query_api()

# Convert to DataFrame-ready records
records = extract_records(result)
records = add_timestamps(records)
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
  • Mappings - EIC codes and area mappings
  • Examples - Practical examples and use cases
  • Utilities - Utility functions for data processing

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-1.0.0.tar.gz (276.0 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-1.0.0-py3-none-any.whl (578.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: entsoe_apy-1.0.0.tar.gz
  • Upload date:
  • Size: 276.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.11

File hashes

Hashes for entsoe_apy-1.0.0.tar.gz
Algorithm Hash digest
SHA256 9d335ff9f646af7a378a4b1077bdbcaf3bfb7bec8f9f293bba1f340002d8ae29
MD5 79a123e34f1bbd024c4483a165704df5
BLAKE2b-256 33b4bb82999278e600100a8a5539539e90509f4880a60810751344ecde1e7135

See more details on using hashes here.

File details

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

File metadata

  • Download URL: entsoe_apy-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 578.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.11

File hashes

Hashes for entsoe_apy-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 68fd90566d10ebe2c4d9a12828bd4801659ba48d10dcfb567f61c2fc287d3ceb
MD5 1d2f5b472e1d4bc0d30374546556622e
BLAKE2b-256 1862c0323f9e96120fb799cf506cfde75fd4f61bd718fd48163eaa85b29c2299

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