entsoe-apy 0.3.1

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

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.