eta_nexus.connections.entsoe_connection module

Utility functions for connecting to the ENTSO-E Transparency database and for reading data. This connection does not have the ability to write data.

class eta_nexus.connections.entsoe_connection.EntsoeConnection(url: str = 'https://web-api.tp.entsoe.eu', *, nodes: Nodes[EntsoeNode] | None = None, retry_total: int = 3, retry_backoff_factor: float = 1.0)[source]

Bases: RESTConnection[EntsoeNode], SeriesReadable[EntsoeNode]

ENTSOEConnection is a class to download and upload multiple features from and to the ENTSO-E transparency platform database as timeseries. The platform contains data about the european electricity markets.

Parameters:

  • url – Url of the server with scheme (https://web-api.tp.entsoe.eu/)

  • usr – Username for login to the platform (usually not required - default: None)

  • pwd – Password for login to the platform (usually not required - default: None)

  • nodes – Nodes to select in connection

  • retry_total – Total number of retries for failed HTTP requests (default: 3).

  • retry_backoff_factor – Backoff factor for retries (default: 1s-> e.g. 1s, 2s, 4s for 3 retries).

API_PATH: str = 'api'
logger: Logger = <Logger eta_nexus.connections.entsoe_connection (WARNING)>
read_series(from_time: datetime, to_time: datetime, nodes: EntsoeNode | Nodes[EntsoeNode] | None = None, interval: TimeStep = 1, **kwargs: Any) → pd.DataFrame[source]

Download timeseries data from the ENTSO-E Database.

Parameters:

  • nodes – Single node or list/set of nodes to read values from

  • from_time – Starting time to begin reading (included in output)

  • to_time – Time to stop reading at (not included in output)

  • interval – interval between time steps. It is interpreted as seconds if given as integer.

Returns:

Pandas DataFrame containing the data read from the connection

read_node(node: N, from_time: datetime, to_time: datetime, interval: timedelta, **kwargs: Any) → pd.DataFrame[source]

Read data from a REST API endpoint.

Parameters:

  • node – Node to read data from.

  • from_time – Start of the time series (timezone-aware).

  • to_time – End of the time series (timezone-aware).

  • interval – Time interval between data points.

  • kwargs – Additional arguments.

Returns:

DataFrame containing the data read from the API.