energyzero 5.1.0

Asynchronous Python client for the EnergyZero API.

About

A python package with which you can retrieve the dynamic energy/gas prices from EnergyZero and can therefore also be used for third parties who purchase their energy via EnergyZero, such as:

• ANWB Energie
• Energie van Ons
• GroeneStroomLokaal
• Mijndomein Energie
• SamSam
• ZonderGas

Installation

pip install energyzero

Example

import asyncio
from datetime import datetime, timedelta
from zoneinfo import ZoneInfo

from energyzero import EnergyZero, Interval, PriceType


async def main() -> None:
    """Fetch today/tomorrow energy prices using the REST backend (default)."""
    async with EnergyZero() as client:
        local_tz = ZoneInfo("Europe/Amsterdam")
        today = datetime.now(local_tz).date()
        tomorrow = today + timedelta(days=1)

        electricity_today = await client.get_electricity_prices(
            start_date=today,
            interval=Interval.QUARTER,
            price_type=PriceType.ALL_IN,
            local_tz=local_tz,
        )
        gas_today = await client.get_gas_prices(
            start_date=today,
            price_type=PriceType.ALL_IN,
            local_tz=local_tz,
        )

        # Loop over additional days as needed
        electricity_tomorrow = await client.get_electricity_prices(
            start_date=tomorrow,
            interval=Interval.QUARTER,
            price_type=PriceType.MARKET_WITH_VAT,
            local_tz=local_tz,
        )
        gas_tomorrow = await client.get_gas_prices(
            start_date=tomorrow,
            price_type=PriceType.MARKET,
            local_tz=local_tz,
        )

        print(electricity_today.average_price, gas_today.current_price)
        print(electricity_tomorrow.average_price, gas_tomorrow.current_price)


if __name__ == "__main__":
    asyncio.run(main())

More examples can be found in the examples folder.

• examples/graphql/* targets the GraphQL backend (multi-day ranges).
• examples/rest/electricity.py shows quarter-hour electricity data.
• examples/rest/electricity_hourly.py shows hourly electricity data.
• examples/rest/gas.py and examples/rest/prices_list.py show gas and combined list usage.

Data

[!NOTE] Currently tested primarily with day-ahead pricing (today/tomorrow).

You can retrieve both electricity and gas pricing data using this package. With v5.0 we support two official backends:

REST (default)

• APIBackend.REST — Public REST API.
• Electricity: hourly + quarter-hour. Gas: daily.
• Single date per call; end_date must equal start_date if provided.
• The API may return a wider window, but the client now filters it to the requested local day.

GraphQL (optional)

• APIBackend.GRAPHQL — GraphQL endpoint with multi-day ranges and extended metadata (TimeRange, averages).
• end_date is required; electricity is always hourly (interval is ignored).

⚡ Electricity Prices

Electricity prices change every hour. Prices for the next day are typically published between 14:00–15:00. Returned electricity prices are expressed in EUR/kWh.

Common fields (EnergyPrices)

• current_price — Current electricity price for the active hour/time range
• average_price — Average price over the selected period
• extreme_prices — Tuple (min_price, max_price)
• pct_of_max_price — Current price expressed as % of the maximum
• price_at_time(moment) — Look up the price for a specific UTC timestamp
• timestamp_prices — List of {"timerange": TimeRange, "price": float} entries
• highest_price_time_range / lowest_price_time_range — TimeRange with highest/lowest price
• time_ranges_priced_equal_or_lower — Number of ranges priced ≤ current price

🔥 Gas Prices

Gas prices are fixed for 24 hours, and a new daily rate applies starting at 06:00 each morning. Returned gas prices are expressed in EUR/m³.

Common fields (EnergyPrices)

• current_price — Current gas price for today
• average_price — Average price over the requested period
• extreme_prices — Tuple (min_price, max_price)
• price_at_time(moment) — Price lookup for a UTC timestamp
• timestamp_prices — {"timerange": TimeRange, "price": float} entries
• highest_price_time_range / lowest_price_time_range — TimeRange with highest/lowest price
• pct_of_max_price, time_ranges_priced_equal_or_lower — Not applicable for gas prices

Client Methods (REST + GraphQL)

get_electricity_prices()

Returns electricity prices in EUR/kWh.

get_gas_prices()

Returns gas prices in EUR/m³.

Retrieving multiple price types

Retrieve multiple price types with one HTTP request per method call, on either backend. Pass an iterable of PriceType values to the existing price_type parameter of get_electricity_prices() or get_gas_prices(). This returns dict[PriceType, EnergyPrices], even when the iterable contains only one type. Passing a single PriceType still returns one EnergyPrices object. Type overloads infer the return type from the input.

prices = await client.get_electricity_prices(
    start_date=today,
    interval=Interval.QUARTER,
    price_type=(PriceType.MARKET_WITH_VAT, PriceType.ALL_IN),
    local_tz=local_tz,
)
market_prices = prices[PriceType.MARKET_WITH_VAT]
all_in_prices = prices[PriceType.ALL_IN]

gas_prices = await client.get_gas_prices(
    start_date=today,
    price_type=(PriceType.MARKET_WITH_VAT, PriceType.ALL_IN),
    local_tz=local_tz,
)

Duplicate types appear once, in first-requested order. An empty iterable raises ValueError without making a request. Values must be PriceType members; raw strings and other invalid values raise TypeError before making a request. REST filters each requested stream to the local date and raises EnergyZeroNoDataError if a requested stream has no prices for that date; no partial mapping is returned. GraphQL requires end_date and retains its existing date-range behavior. Omitting price_type still returns one EnergyPrices object using PriceType.ALL_IN.

PriceType

Specifies the type of prices returned by both backends.

Used in: get_electricity_prices, get_gas_prices

Interval

Specifies the interval for REST API requests:

Note: Interval is used by get_electricity_prices(). Gas prices are retrieved through get_gas_prices() and use daily intervals internally on the REST API.

Contributing

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We've set up a separate document for our contribution guidelines.

Thank you for being involved! :heart_eyes:

Setting up development environment

The simplest way to begin is by utilizing the Dev Container feature of Visual Studio Code or by opening a CodeSpace directly on GitHub. By clicking the button below you immediately start a Dev Container in Visual Studio Code.

This Python project relies on Poetry as its dependency manager, providing comprehensive management and control over project dependencies.

You need at least:

• Python 3.12+
• Poetry

Installation

Install all packages, including all development requirements:

poetry install

Poetry creates by default an virtual environment where it installs all necessary pip packages.

Prek

This repository uses the prek framework, all changes are linted and tested with each commit. To setup the prek check, run:

poetry run prek install

And to run all checks and tests manually, use the following command:

poetry run prek run --all-files

Testing

It uses pytest as the test framework. To run the tests:

poetry run pytest

To update the syrupy snapshot tests:

poetry run pytest --snapshot-update

License

MIT License

Copyright (c) 2022-2026 Klaas Schoute

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.