Skip to content

dayahead

frequenz.lib.notebooks.dayahead ¤

Functions for CLI tool to interact with the day-ahead pricing API.

Functions:¤

frequenz.lib.notebooks.dayahead.fetch_day_ahead_prices ¤

fetch_day_ahead_prices(
    entsoe_key: str | None,
    start: datetime,
    end: datetime,
    country_code: str,
) -> Series

Fetch day-ahead prices for a given country code as a normalized series.

PARAMETER DESCRIPTION
entsoe_key

The API key for the Entsoe API. If not provided, the value is read from the ENTSOE_API_KEY environment variable.

TYPE: str | None

start

The start date of the query.

TYPE: datetime

end

The end date of the query.

TYPE: datetime

country_code

The country code for which to query the prices.

TYPE: str

RETURNS DESCRIPTION
Series

A pandas series named price indexed by timestamp.
RAISES DESCRIPTION
ModuleNotFoundError

If the optional entsoe dependency is not installed.
ValueError

If the time window is invalid or no API key is available.
Source code in src/frequenz/lib/notebooks/dayahead.py 
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
def fetch_day_ahead_prices(
    entsoe_key: str | None,
    start: datetime,
    end: datetime,
    country_code: str,
) -> pd.Series:
    """Fetch day-ahead prices for a given country code as a normalized series.

    Args:
        entsoe_key: The API key for the Entsoe API. If not provided, the value
            is read from the ``ENTSOE_API_KEY`` environment variable.
        start: The start date of the query.
        end: The end date of the query.
        country_code: The country code for which to query the prices.

    Returns:
        A pandas series named ``price`` indexed by timestamp.

    Raises:
        ModuleNotFoundError: If the optional entsoe dependency is not installed.
        ValueError: If the time window is invalid or no API key is available.
    """
    if EntsoePandasClient is None:
        raise ModuleNotFoundError(
            "The optional dependency 'entsoe-py' is required to fetch day-ahead "
            "prices. Install it before calling fetch_day_ahead_prices()."
        )

    api_key = entsoe_key or os.getenv("ENTSOE_API_KEY")
    if not api_key:
        raise ValueError(
            "Missing ENTSO-E API key. Pass entsoe_key explicitly or set the "
            "ENTSOE_API_KEY environment variable."
        )

    if start >= end:
        raise ValueError(
            f"Expected start to be earlier than end, got start={start!r}, end={end!r}."
        )

    start_ts = pd.Timestamp(start)
    end_ts = pd.Timestamp(end)

    if start_ts.tzinfo is None or end_ts.tzinfo is None:
        raise ValueError("Please use timezone-aware datetimes for start and end.")

    client = EntsoePandasClient(api_key=api_key)
    return _normalize_prices(
        client.query_day_ahead_prices(country_code, start=start_ts, end=end_ts)
    )