Python client for OverKiz API

A fully asynchronous and user-friendly API client for the OverKiz platform. This client enables interaction with smart devices connected to OverKiz, supporting multiple vendors such as Somfy TaHoma and Atlantic Cozytouch.

This package is primarily used by Home Assistant Core to provide the Overkiz integration. If you wish to use this package in your own project, refer to the full documentation, the example below, or explore the Home Assistant source code for additional usage examples.

Documentation

Full documentation is available at imicknl.github.io/python-overkiz-api:

Supported hubs

Vendor Cloud Local
Atlantic Cozytouch ✓
Bouygues Flexom ✓
Brandt Smart Control ✓
Hexaom HexaConnect ✓
Hitachi Hi Kumo ✓
Nexity Eugénie ✓
Rexel Energeasy Connect † ✓ ✓
Sauter Cozytouch ✓
Simu LiveIn2 ✓
Somfy ✓ ✓
Thermor Cozytouch ✓
Ubiwizz ✓

Local API availability depends on your specific gateway. See the Getting started guide for the supported gateways and setup.

† The cloud API requires OAuth credentials provided by Rexel; the local API uses a token from the EConnect app instead.

Somfy

Gateway Cloud Local
Connexoon IO ✓ ✓
Connexoon RTS ✓ ✓
TaHoma v2 ✓ ✓
TaHoma Beecon ✓ ✓
TaHoma Switch ✓ ✓
Connectivity Kit ✓

Rexel Energeasy Connect

Gateway Cloud Local
Energeasy Connect ✓
Energeasy Connect Rail Din ✓ ✓
Energeasy Connect V2 ✓ ✓
Energeasy Connect V3 ✓ ✓
Energeasy Connect V3 Rail Din ✓ ✓

Installation

pip install pyoverkiz

Getting started

Connect to the cloud API, authenticate, and list your devices:

import asyncio

from pyoverkiz.auth.credentials import UsernamePasswordCredentials
from pyoverkiz.client import OverkizClient
from pyoverkiz.enums import Server


async def main() -> None:
    async with OverkizClient(
        server=Server.SOMFY_EUROPE,
        credentials=UsernamePasswordCredentials("username", "password"),
    ) as client:
        await client.login()

        devices = await client.get_devices()
        for device in devices:
            print(f"{device.label} ({device.device_url}) - {device.controllable_name}")


asyncio.run(main())

For executing commands, listening to events, and connecting to the local API, see the Getting started guide in the documentation.

Projects using pyOverkiz

This package powers the Overkiz integration in Home Assistant Core. Other open-source projects and custom automations also leverage pyOverkiz to interact with Overkiz-compatible hubs and devices, including:

  • overkiz2mqtt: Bridges Overkiz devices to MQTT for integration with various platforms.
  • mcp-overkiz: Implements an MCP server to enable communication between Overkiz devices and language models.
  • tahoma: Command Line Interface (CLI) to control Overkiz devices.

Contribute

We welcome contributions! To get started with setting up this project for development, follow the steps below.

Project setup

Dev Container (recommended)

If you use Visual Studio Code with Docker or GitHub Codespaces, you can take advantage of the included Dev Container. This environment comes pre-configured with all necessary dependencies and tools, including the correct Python version, making setup simple and straightforward.

Manual setup

  • Install uv.
  • Clone this repository and navigate to it: cd python-overkiz-api
  • Initialize the project with uv sync, then run uv run prek install

Tests

uv run pytest

Project links

Data verified by PyPI on Aug 12, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for imick from gravatar.com imick

Credits

Author: Vincent Le Bourlot, Thibaut Etienne

GitHub Statistics

Data verified by PyPI on Aug 12, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

MIT

Requires

Python <4.0, >=3.12

Provides Extra

docs nexity

Report project as malware

Download files

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

Source Distribution

pyoverkiz-2.1.1.tar.gz (120.1 kB view details)

Uploaded Source

Built Distribution

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

pyoverkiz-2.1.1-py3-none-any.whl (130.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyoverkiz-2.1.1.tar.gz
  • Upload date:
  • Size: 120.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pyoverkiz-2.1.1.tar.gz
Algorithm Hash digest
SHA256 685ef147d5a8b743ab8dc610e9c6298975731dd0090e299b28fc6e589e02c5ff
MD5 8ee3d29f065f4380557a1b2759e06c66
BLAKE2b-256 0a2f31dff4c7c746733d0052d493b25757b206663f149fc14c9c06febf2cc396

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyoverkiz-2.1.1.tar.gz:

Publisher: release.yml on iMicknl/python-overkiz-api

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: pyoverkiz-2.1.1-py3-none-any.whl
  • Upload date:
  • Size: 130.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pyoverkiz-2.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5f269972b518123f1e6a873f24e3df643954434157073b289924a5756f018d6b
MD5 f34313f2920f9b4b77c5d1508feadcd2
BLAKE2b-256 935c5a677bbaf14813c6b9b5fc845e3f1f1083a082e24b6de2e3f2737e3214a8

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyoverkiz-2.1.1-py3-none-any.whl:

Publisher: release.yml on iMicknl/python-overkiz-api

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

2.1.1 This release

2 files

2.1.0

2 files

2.0.5

2 files

2.0.4

2 files

2.0.3

2 files

2.0.2

2 files

2.0.1

2 files

2.0.0

2 files

Pre-release

2.0.0rc9

2 files

Pre-release

2.0.0rc8

2 files

Pre-release

2.0.0rc7

2 files

Pre-release

2.0.0rc6

2 files

Pre-release

2.0.0rc5

2 files

Pre-release

2.0.0rc4

2 files

Pre-release

2.0.0rc3

2 files

Pre-release

2.0.0rc2

2 files

Pre-release

2.0.0rc1

2 files

1.20.6

2 files

1.20.5

2 files

1.20.4

2 files

1.20.3

2 files

1.20.2

2 files

1.20.1

2 files

1.20.0

2 files

1.19.4

2 files

1.19.3

2 files

1.19.2

2 files

1.19.1

2 files

1.19.0

2 files

1.18.2

2 files

1.18.1

2 files

1.18.0

2 files

1.17.2

2 files

1.17.1

2 files

1.17.0

2 files

1.16.5

2 files

1.16.4

2 files

1.16.3

2 files

1.16.2

2 files

1.16.1

2 files

1.16.0

2 files

1.15.5

2 files

1.15.4

2 files

1.15.3

2 files

1.15.2

2 files

1.15.1

2 files

1.15.0

2 files

1.14.2

2 files

1.14.1

2 files

1.14.0

2 files

1.13.14

2 files

1.13.13

2 files

1.13.12

2 files

1.13.11

2 files

1.13.10

2 files

1.13.9

2 files

1.13.8

2 files

1.13.7

2 files

1.13.6

2 files

1.13.5

2 files

1.13.4

2 files

1.13.3

2 files

1.13.2

2 files

1.13.1

2 files

1.13.0

2 files

1.12.2

2 files

1.12.1

2 files

1.12.0

2 files

1.11.0

2 files

1.10.1

2 files

1.10.0

2 files

1.9.1

2 files

1.9.0

2 files

1.8.0

2 files

1.7.9

2 files

1.7.8

2 files

1.7.7

2 files

1.7.6

2 files

1.7.5

2 files

1.7.4

2 files

1.7.3

2 files

1.7.2

2 files

1.7.1

2 files

1.7.0

2 files

1.6.0

2 files

1.5.6

2 files

1.5.5

2 files

1.5.4

2 files

1.5.3

2 files

1.5.2

2 files

1.5.1

2 files

1.5.0

2 files

1.4.2

2 files

1.4.1

2 files

1.4.0

2 files

1.3.14

2 files

1.3.13

2 files

1.3.12

2 files

1.3.10

2 files

1.3.9

2 files

1.3.8

2 files

1.3.7

2 files

1.3.6

2 files

1.3.5

2 files

1.3.4

2 files

1.3.3

2 files

1.3.2

2 files

1.3.1

2 files

1.3.0

2 files

1.2.0

2 files

1.1.1

2 files

1.1.0

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page