eta_utility.connectors.entso_e module

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

class eta_utility.connectors.entso_e.ENTSOEConnection(url: str = 'https://web-api.tp.entsoe.eu/', *, api_token: str, nodes: Nodes[NodeEntsoE] | None = None)[source]

Bases: SeriesConnection[NodeEntsoE]

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)

  • api_token – Token for API authentication

  • nodes – Nodes to select in connection

API_PATH: str = '/api'
read(nodes: Nodes[NodeEntsoE] | None = None) → pd.DataFrame[source]

Warning

Cannot read single values from ENTSO-E transparency platform. Use read_series instead

Parameters:

nodes – List of nodes to read values from

Returns:

Pandas DataFrame containing the data read from the connection

write(values: Mapping[NodeEntsoE, Mapping[datetime, Any]], time_interval: timedelta | None = None) → None[source]

Warning

Cannot write to ENTSO-E transparency platform.

Parameters:

  • values – Dictionary of nodes and data to write. {node: value}

  • time_interval – Interval between datapoints (i.e. between “From” and “To” in EnEffCo Upload), default 1s

subscribe(handler: SubscriptionHandler, nodes: Nodes[NodeEntsoE] | None = None, interval: TimeStep = 1) → None[source]

Subscribe to nodes and call handler when new data is available. This will return only the last available values.

Parameters:

  • handler – SubscriptionHandler object with a push method that accepts node, value pairs

  • interval – interval for receiving new data. It is interpreted as seconds when given as an integer.

  • nodes – identifiers for the nodes to subscribe to

read_series(from_time: datetime, to_time: datetime, nodes: Nodes[NodeEntsoE] | None = None, interval: TimeStep = 1, **kwargs: Any) → pd.DataFrame[source]

Download timeseries data from the ENTSO-E Database

Parameters:

  • nodes – List 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

subscribe_series(handler: SubscriptionHandler, req_interval: TimeStep, offset: TimeStep | None = None, nodes: Nodes[NodeEntsoE] | None = None, interval: TimeStep = 1, data_interval: TimeStep = 1, **kwargs: Any) → None[source]

Warning

Not implemented: Cannot subscribe to data from the ENTSO-E transparency platform.

Parameters:

  • handler – SubscriptionHandler object with a push method that accepts node, value pairs

  • req_interval – Duration covered by requested data (time interval). Interpreted as seconds if given as int

  • offset – Offset from datetime.now from which to start requesting data (time interval). Interpreted as seconds if given as int. Use negative values to go to past timestamps.

  • data_interval – Time interval between values in returned data. Interpreted as seconds if given as int.

  • interval – interval (between requests) for receiving new data. It it interpreted as seconds when given as an integer.

  • nodes – identifiers for the nodes to subscribe to

close_sub() → None[source]

Warning

Not implemented: Cannot subscribe to data from the ENTSO-E transparency platform.