Skip to main content

Client API for eau.veolia.fr

Project description

Async Python client for the Veolia water portal API (eau.veolia.fr and compatible portals).

Table of contents

Installation

pip install veolia-api

For a development environment, install devbox then run:

devbox shell

Usage

import asyncio
from datetime import date

import aiohttp

from veolia_api import VeoliaAPI


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        client_api = VeoliaAPI("your@email.com", "password", session)

        # Optional: specify a portal other than the default
        # client_api = VeoliaAPI("your@email.com", "password", session, portal_url="eaudetm.monespace.eau.veolia.fr")

        await client_api.fetch_all_data(date(2025, 1, 1), date(2025, 9, 1))

        print(client_api.account_data.daily_consumption)
        print(client_api.account_data.monthly_consumption)
        print(client_api.account_data.alert_settings.daily_enabled)


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

A runnable example with logging is available in usage_example.py.

Supported portals

Portal Region
eau.veolia.fr France (national)
eaudetm.monespace.eau.veolia.fr Eau de Toulouse Metropole

Your portal is missing? See Adding a portal — it only requires editing one file.

Contributing

Contributions are welcome. Please read CONTRIBUTING.md for guidelines on reporting bugs, suggesting features, and submitting pull requests.

Credits

Inspired by the original work of @CorentinGrard.

License

MIT — see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

veolia_api-2.1.1.tar.gz (10.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

veolia_api-2.1.1-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

Details for the file veolia_api-2.1.1.tar.gz.

File metadata

  • Download URL: veolia_api-2.1.1.tar.gz
  • Upload date:
  • Size: 10.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.4 CPython/3.13.13 Linux/6.17.0-1010-azure

File hashes

Hashes for veolia_api-2.1.1.tar.gz
Algorithm Hash digest
SHA256 ddcbf8eb76f437df29eb6d9eb16b9e38122eb082428cf8ba40e1ab451ef97a60
MD5 4636ff239cc8d84d5516ba81dab4050d
BLAKE2b-256 c857792b5c4e9df10f496d01271ba0370264353ae9a18b06441d1eb87f8b17c3

See more details on using hashes here.

File details

Details for the file veolia_api-2.1.1-py3-none-any.whl.

File metadata

  • Download URL: veolia_api-2.1.1-py3-none-any.whl
  • Upload date:
  • Size: 10.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.4 CPython/3.13.13 Linux/6.17.0-1010-azure

File hashes

Hashes for veolia_api-2.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ac6ce593f28d97b92b3c762817f400e5ea35db5ab6b4183f4eb6987059657a29
MD5 db92a97452ad274ac9c1b665851d8ad7
BLAKE2b-256 2a1ba5d2a8c879d8e1e001718d5359058317d4ef274842918e7fcf5b456d11e2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page