{"id":16237153,"url":"https://github.com/klaasnicolaas/python-energyzero","last_synced_at":"2025-07-18T12:32:53.951Z","repository":{"id":64534483,"uuid":"556232424","full_name":"klaasnicolaas/python-energyzero","owner":"klaasnicolaas","description":"💰 Asynchronous Python client for the dynamic prices from EnergyZero","archived":false,"fork":false,"pushed_at":"2025-07-14T02:23:23.000Z","size":2464,"stargazers_count":22,"open_issues_count":4,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-07-14T04:57:07.720Z","etag":null,"topics":["api","async","client","energy","gas","hacktoberfest","prices","python"],"latest_commit_sha":null,"homepage":"https://www.energyzero.nl/energiecontract/stroom-en-gas/flextarieven","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/klaasnicolaas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"klaasnicolaas","ko_fi":"klaasnicolaas"}},"created_at":"2022-10-23T11:29:39.000Z","updated_at":"2025-07-14T02:23:26.000Z","dependencies_parsed_at":"2022-12-13T15:18:15.251Z","dependency_job_id":"7bbfc83c-1040-417e-9f52-8054fef31474","html_url":"https://github.com/klaasnicolaas/python-energyzero","commit_stats":{"total_commits":302,"total_committers":3,"mean_commits":"100.66666666666667","dds":0.3973509933774835,"last_synced_commit":"e758abe41f80a4b27ad7451eafde2ee92e776af6"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/klaasnicolaas/python-energyzero","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaasnicolaas%2Fpython-energyzero","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaasnicolaas%2Fpython-energyzero/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaasnicolaas%2Fpython-energyzero/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaasnicolaas%2Fpython-energyzero/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/klaasnicolaas","download_url":"https://codeload.github.com/klaasnicolaas/python-energyzero/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaasnicolaas%2Fpython-energyzero/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265247905,"owners_count":23734128,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","async","client","energy","gas","hacktoberfest","prices","python"],"created_at":"2024-10-10T13:34:39.607Z","updated_at":"2025-07-18T12:32:53.944Z","avatar_url":"https://github.com/klaasnicolaas.png","language":"Python","funding_links":["https://github.com/sponsors/klaasnicolaas","https://ko-fi.com/klaasnicolaas"],"categories":[],"sub_categories":[],"readme":"\u003c!-- Header --\u003e\n![alt Header of the EnergyZero package](https://raw.githubusercontent.com/klaasnicolaas/python-energyzero/main/assets/header_energyzero-min.png)\n\n\u003c!-- PROJECT SHIELDS --\u003e\n[![GitHub Release][releases-shield]][releases]\n[![Python Versions][python-versions-shield]][pypi]\n![Project Stage][project-stage-shield]\n![Project Maintenance][maintenance-shield]\n[![License][license-shield]](LICENSE)\n\n[![GitHub Activity][commits-shield]][commits-url]\n[![PyPi Downloads][downloads-shield]][downloads-url]\n[![GitHub Last Commit][last-commit-shield]][commits-url]\n[![Open in Dev Containers][devcontainer-shield]][devcontainer]\n\n[![Build Status][build-shield]][build-url]\n[![Typing Status][typing-shield]][typing-url]\n[![Code Coverage][codecov-shield]][codecov-url]\n\nAsynchronous Python client for the EnergyZero API.\n\n## About\n\nA python package with which you can retrieve the dynamic energy/gas prices from [EnergyZero][energyzero] and can therefore also be used for third parties who purchase their energy via EnergyZero, such as:\n\n- [ANWB Energie](https://www.anwb.nl/huis/energie/anwb-energie)\n- [Energie van Ons](https://www.energie.vanons.org)\n- [GroeneStroomLokaal](https://www.groenestroomlokaal.nl)\n- [Mijndomein Energie](https://www.mijndomein.nl/energie)\n- [SamSam](https://www.samsam.nu)\n- [ZonderGas](https://www.zondergas.nu)\n\n## Installation\n\n```bash\npip install energyzero\n```\n\n## Example\n\n```python\nimport asyncio\n\nfrom datetime import date\nfrom energyzero import EnergyZero, VatOption\n\n\nasync def main() -\u003e None:\n    \"\"\"Show example on fetching the energy prices from EnergyZero.\"\"\"\n    async with EnergyZero(vat=VatOption.INCLUDE) as client:\n        start_date = date(2022, 12, 7)\n        end_date = date(2022, 12, 7)\n\n        energy = await client.get_electricity_prices(start_date, end_date)\n        gas = await client.get_gas_prices(start_date, end_date)\n\n\nif __name__ == \"__main__\":\n    asyncio.run(main())\n```\n\nMore examples can be found in the [examples folder](./examples/).\n\n## Data\n\n\u003e **Note:** Currently tested primarily with day-ahead pricing (today/tomorrow).\n\nYou can retrieve both electricity and gas pricing data using this package. Each data type supports a set of common fields, with some additional properties depending on whether you use the **GraphQL** or **legacy REST** endpoint.\n\n## ⚡ Electricity Prices\n\nElectricity prices change **every hour**. Prices for the next day are typically published between **14:00–15:00**.\n\n### Common fields (`Electricity` and `EnergyPrices`)\n\n- `current_price` — Current electricity price for the current hour or time range\n- `average_price` — Average price over the selected period\n- `extreme_prices` — Tuple of `(min_price, max_price)`\n- `pct_of_max_price` — Current price as a percentage of the maximum\n- `price_at_time(moment)` — Get price for a specific `datetime`\n- `timestamp_prices` — List of hourly price entries:\n  - REST: `{\"timestamp\": datetime, \"price\": float}`\n  - GraphQL: `{\"timerange\": TimeRange, \"price\": float}`\n\n### GraphQL-only (`get_electricity_prices()`)\n\n- `highest_price_time_range` — `TimeRange` where the price is highest\n- `lowest_price_time_range` — `TimeRange` where the price is lowest\n- `time_ranges_priced_equal_or_lower` — Count of hours where the price is less than or equal to the current\n\n### REST-only (`get_electricity_prices_legacy()`)\n\n- `highest_price_time` — Timestamp of the highest hourly price\n- `lowest_price_time` — Timestamp of the lowest hourly price\n- `hours_priced_equal_or_lower` — Count of hours with a price ≤ current price\n\n## 🔥 Gas Prices\n\nGas prices are **fixed for 24 hours**, and a new daily rate applies starting at **06:00** each morning.\n\n### Common fields (`Gas` and `EnergyPrices`)\n\n- `current_price` — Current gas price for today\n- `average_price` — Average gas price over the selected period\n- `extreme_prices` — Tuple of `(min_price, max_price)`\n- `price_at_time(moment)` — Get price for a specific `datetime`\n- `timestamp_prices` — List of daily price entries:\n  - REST: `{\"timestamp\": datetime, \"price\": float}`\n  - GraphQL: `{\"timerange\": TimeRange, \"price\": float}`\n\n### GraphQL-only (`get_gas_prices()`)\n\n- `highest_price_time_range` — Time range with the highest daily price\n- `lowest_price_time_range` — Time range with the lowest daily price\n- `pct_of_max_price` — Current price as a percentage of the maximum\n- `time_ranges_priced_equal_or_lower` — Count of days with a price ≤ current price\n\n## Function Parameters\n\n### Class Parameters\n\n| Parameter | Type                             | Description                            | Used by                                                  |\n|-----------|:---------------------------------|:---------------------------------------|:---------------------------------------------------------|\n| `vat`     | `VatOption` (default: `INCLUDE`) | Include or exclude VAT at class level. | `get_electricity_prices_legacy`, `get_gas_prices_legacy` |\n\n### Interval Values\n\n| Value | Meaning  |\n|------:|:---------|\n| `4`   | Day      |\n| `5`   | Month    |\n| `6`   | Year     |\n| `9`   | Week     |\n\n## Modern GraphQL Methods\n\n### `get_electricity_prices()`\n\n| Parameter    | Type        | Description                                    |\n|--------------|-------------|------------------------------------------------|\n| `start_date` | `date`      | Start of the period (local timezone).          |\n| `end_date`   | `date`      | End of the period (local timezone).            |\n| `price_type` | `PriceType` | Type of price to return: `ALL_IN` or `MARKET`. |\n\n\u003e ⚠️ This method **does not use** the class-level `vat` setting.\n\n---\n\n### `get_gas_prices()`\n\n| Parameter    | Type        | Description                                    |\n|--------------|-------------|------------------------------------------------|\n| `start_date` | `date`      | Start of the period (local timezone).          |\n| `end_date`   | `date`      | End of the period (local timezone).            |\n| `price_type` | `PriceType` | Type of price to return: `ALL_IN` or `MARKET`. |\n\n\u003e ⚠️ This method **does not use** the class-level `vat` setting.\n\n---\n\n## Legacy REST Methods\n\n### `get_electricity_prices_legacy()`\n\n| Parameter    | Type                | Description                                          |\n|--------------|---------------------|------------------------------------------------------|\n| `start_date` | `date`              | Start of the period (local timezone).                |\n| `end_date`   | `date`              | End of the period (local timezone).                  |\n| `interval`   | `int`               | Data interval (see interval values table).           |\n| `vat`        | `VatOption \\| None` | VAT inclusion (fallback to class setting if `None`). |\n\n---\n\n### `get_gas_prices_legacy()`\n\n| Parameter    | Type                | Description                                          |\n|--------------|---------------------|------------------------------------------------------|\n| `start_date` | `date`              | Start of the period (local timezone).                |\n| `end_date`   | `date`              | End of the period (local timezone).                  |\n| `interval`   | `int`               | Data interval (see interval values table).           |\n| `vat`        | `VatOption \\| None` | VAT inclusion (fallback to class setting if `None`). |\n\n## Enum Options\n\n### `VatOption`\n\nDefines whether prices returned by legacy methods should include VAT.\n\n| Value          | Description                     |\n|----------------|---------------------------------|\n| `INCLUDE`      | Return prices **including VAT** |\n| `EXCLUDE`      | Return prices **excluding VAT** |\n\nUsed in: `get_electricity_prices_legacy`, `get_gas_prices_legacy`\n\u003e 📝 Ignored in GraphQL methods (`get_electricity_prices`, `get_gas_prices`)\n\n---\n\n### `PriceType`\n\nSpecifies the type of prices returned by GraphQL methods.\n\n| Value       | Description                                                          |\n|-------------|----------------------------------------------------------------------|\n| `MARKET`    | Raw wholesale market price (excludes tax, VAT, and purchasing costs) |\n| `ALL_IN`    | Final consumer price (includes energy tax, VAT, and purchase fees)   |\n\nUsed in: `get_electricity_prices`, `get_gas_prices`\n\n\n## Contributing\n\nThis is an active open-source project. We are always open to people who want to\nuse the code or contribute to it.\n\nWe've set up a separate document for our\n[contribution guidelines](CONTRIBUTING.md).\n\nThank you for being involved! :heart_eyes:\n\n## Setting up development environment\n\nThe simplest way to begin is by utilizing the [Dev Container][devcontainer]\nfeature of Visual Studio Code or by opening a CodeSpace directly on GitHub.\nBy clicking the button below you immediately start a Dev Container in Visual Studio Code.\n\n[![Open in Dev Containers][devcontainer-shield]][devcontainer]\n\nThis Python project relies on [Poetry][poetry] as its dependency manager,\nproviding comprehensive management and control over project dependencies.\n\nYou need at least:\n\n- Python 3.11+\n- [Poetry][poetry-install]\n\n### Installation\n\nInstall all packages, including all development requirements:\n\n```bash\npoetry install\n```\n\n_Poetry creates by default an virtual environment where it installs all\nnecessary pip packages_.\n\n### Pre-commit\n\nThis repository uses the [pre-commit][pre-commit] framework, all changes\nare linted and tested with each commit. To setup the pre-commit check, run:\n\n```bash\npoetry run pre-commit install\n```\n\nAnd to run all checks and tests manually, use the following command:\n\n```bash\npoetry run pre-commit run --all-files\n```\n\n### Testing\n\nIt uses [pytest](https://docs.pytest.org/en/stable/) as the test framework. To run the tests:\n\n```bash\npoetry run pytest\n```\n\nTo update the [syrupy](https://github.com/tophat/syrupy) snapshot tests:\n\n```bash\npoetry run pytest --snapshot-update\n```\n\n## License\n\nMIT License\n\nCopyright (c) 2022-2025 Klaas Schoute\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n[energyzero]: https://www.energyzero.nl\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n[build-shield]: https://github.com/klaasnicolaas/python-energyzero/actions/workflows/tests.yaml/badge.svg\n[build-url]: https://github.com/klaasnicolaas/python-energyzero/actions/workflows/tests.yaml\n[commits-shield]: https://img.shields.io/github/commit-activity/y/klaasnicolaas/python-energyzero.svg\n[commits-url]: https://github.com/klaasnicolaas/python-energyzero/commits/main\n[codecov-shield]: https://codecov.io/gh/klaasnicolaas/python-energyzero/branch/main/graph/badge.svg?token=29Y5JL4356\n[codecov-url]: https://codecov.io/gh/klaasnicolaas/python-energyzero\n[devcontainer-shield]: https://img.shields.io/static/v1?label=Dev%20Containers\u0026message=Open\u0026color=blue\u0026logo=visualstudiocode\n[devcontainer]: https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/klaasnicolaas/python-energyzero\n[downloads-shield]: https://img.shields.io/pypi/dm/energyzero\n[downloads-url]: https://pypistats.org/packages/energyzero\n[license-shield]: https://img.shields.io/github/license/klaasnicolaas/python-energyzero.svg\n[last-commit-shield]: https://img.shields.io/github/last-commit/klaasnicolaas/python-energyzero.svg\n[maintenance-shield]: https://img.shields.io/maintenance/yes/2025.svg\n[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg\n[pypi]: https://pypi.org/project/energyzero/\n[python-versions-shield]: https://img.shields.io/pypi/pyversions/energyzero\n[typing-shield]: https://github.com/klaasnicolaas/python-energyzero/actions/workflows/typing.yaml/badge.svg\n[typing-url]: https://github.com/klaasnicolaas/python-energyzero/actions/workflows/typing.yaml\n[releases-shield]: https://img.shields.io/github/release/klaasnicolaas/python-energyzero.svg\n[releases]: https://github.com/klaasnicolaas/python-energyzero/releases\n\n[poetry-install]: https://python-poetry.org/docs/#installation\n[poetry]: https://python-poetry.org\n[pre-commit]: https://pre-commit.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fklaasnicolaas%2Fpython-energyzero","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fklaasnicolaas%2Fpython-energyzero","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fklaasnicolaas%2Fpython-energyzero/lists"}