freebox-api

What it is and what it does

freebox-api is an asynchronous Python client for the Freebox OS API, the control interface for Freebox routers (and compatible iliadbox devices). It handles the authentication handshake with the Freebox and exposes its API surface—calls, contacts, DHCP configuration, WiFi control, LAN monitoring, and system operations like reboot—through async/await methods, usable both on the local network and remotely.

The library wraps aiohttp for HTTP communication and relies on importlib-metadata for version introspection. It is built on the same API surface as the earlier synchronous freepybox project but designed for non-blocking I/O. The package supports Python 3.10 through 3.14 and is actively maintained.

Use it for:

• Automate Freebox router administration tasks (WiFi toggle, DHCP reconfiguration, system reboot) from Python scripts or services.
• Monitor Freebox call logs and contact lists programmatically for integration with home automation or notification systems.
• Build remote management dashboards or CLI tools that query Freebox LAN activity and device status over the network.
• Integrate Freebox control into Home Assistant or other async-first home automation frameworks.
• Develop multi-device network monitoring that polls Freebox metrics alongside other router or IoT APIs.

Worth the install?

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

Asynchronous Python library for authenticating with and controlling Freebox routers via the Freebox OS API, supporting remote and LAN access.

Yes. The package is actively maintained, has low install friction, covers a specific and useful niche (Freebox control), and carries no known vulnerabilities. The copyleft GPL v3 license is a consideration if you plan to redistribute modified versions, but poses no barrier to private use. Install if you own or manage a Freebox and need programmatic control or monitoring.

Install

freebox-api on PyPI

pip install freebox-api

uv add freebox-api

poetry add freebox-api

Installing freebox-api

Before you install

Low friction install with only two runtime dependencies (aiohttp and importlib-metadata). Active maintenance with last commit on 2026-08-13; repository is not archived and has 53 stars.

License in practice

Licensed under GNU GPL v3 (copyleft). You must distribute any modifications under the same license and make source code available to users.

Quickstart

pip install freebox-api

from freebox_api import Freepybox

async def example():
    fbx = Freepybox()
    await fbx.open('192.168.0.254')
    await fbx.system.reboot()
    await fbx.close()

Requires Python 3.10 or later. Async/await syntax required; synchronous code must wrap calls with asyncio.run() or equivalent event loop.

Verify before relying

• Exact scope of Freebox OS API coverage (which endpoints/features are wrapped)
• Whether certificate pinning for fbxos.fr domains is automatic or requires configuration
• Performance characteristics under high-frequency monitoring or large contact/call datasets

Package facts

Evidence: freebox_api-1.3.1-py3-none-any.whl

Keywords: freebox, iliadbox

Tags

More Home Automation packages