aiohasupervisor

What it is and what it does

aiohasupervisor is an async Python client for the Home Assistant Supervisor REST API. It wraps HTTP communication with Supervisor into a Python interface, currently used in Home Assistant's official Supervisor integration. The library relies on aiohttp for async HTTP, mashumaro and orjson for serialization, and expects authentication via the SUPERVISOR_TOKEN environment variable—a design that limits its use to Home Assistant add-ons and environments where Supervisor automatically sets that token.

The library is purpose-built for Home Assistant's internal ecosystem rather than general-purpose Supervisor access. Add-ons and integrations that need to query Supervisor state or trigger actions can use it instead of making raw HTTP calls, but there is currently no way to obtain a long-lived access token for Supervisor outside the add-on context, so external applications cannot easily adopt it.

Use it for:

• Query Supervisor state and system information from within a Home Assistant add-on or integration.
• Trigger Supervisor actions from Home Assistant automation or custom integrations.
• Build add-ons that need to communicate bidirectionally with the Supervisor daemon.
• Replace raw HTTP calls to Supervisor endpoints with a typed, async Python interface in Home Assistant components.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Asynchronous Python client library for communicating with Home Assistant Supervisor via its REST API, designed for use within Home Assistant integrations and add-ons.

Yes, if you are developing a Home Assistant add-on or integration that needs to interact with Supervisor. The library is actively maintained, has no known vulnerabilities, and low install friction. No, if you need to access Supervisor from outside the Home Assistant ecosystem—the token-based authentication model and lack of external token generation make it unsuitable for that use case.

Install

aiohasupervisor on PyPI

pip install aiohasupervisor

uv add aiohasupervisor

poetry add aiohasupervisor

Installing aiohasupervisor

Before you install

Low install friction with a pure-Python wheel distribution. Actively maintained with a recent release; the repository is not archived and receives regular commits.

License in practice

Licensed under Apache-2.0 (permissive), allowing use in commercial and proprietary projects with minimal restrictions.

Quickstart

pip install aiohasupervisor

import aiohasupervisor
import asyncio

await aiohasupervisor.info()

Requires Python 3.13.0 or later. The library expects the SUPERVISOR_TOKEN environment variable to be set, which is automatically provided by Supervisor for add-ons but must be manually configured for remote development.

Verify before relying

• What specific methods and endpoints the library exposes beyond the info() call shown in documentation.
• Whether error handling and retry logic are built in or left to the caller.
• Performance characteristics and rate-limiting behavior when making repeated calls to Supervisor.

Package facts

Evidence: aiohasupervisor-0.6.0-py3-none-any.whl

Keywords: docker, home-assistant, api, client-library

Tags

More WWW/HTTP packages