Skip to main content

Provides asynchronous authentication and access to Freebox servers

Project description


Easily manage your freebox in Python using the Freebox OS API. Check your calls, manage your contacts, configure your dhcp, disable your wifi, monitor your LAN activity and many others, on LAN or remotely.

aiofreepybox is a python library implementing the freebox OS API. It handles the authentication process and provides a raw access to the freebox API in an asynchronous manner.

This project is based on fstercq/freepybox, which provides the same features as aiofreepybox in a synchronous manner.


Use the PIP package manager

$ pip install aiofreepybox

Or manually download and install the last version from github

$ git clone
$ python install

Get started

# Import the aiofreepybox package.
from aiofreepybox import Freepybox

async def reboot()
    # Instantiate the Freepybox class using default options.
    fbx = Freepybox()

    # Connect to the freebox with default options. 
    # Be ready to authorize the application on the Freebox.

    # Do something useful, rebooting your freebox for example.
    await fbx.system.reboot()

    # Properly close the session.
	await fbx.close()

Have a look at the for a more complete overview.

Notes on HTTPS

When you access a Freebox with its default-assigned domain (ending in, the library verifies its certificate by automatically trusting the Freebox certificate authority. If you want to avoid this, you can setup a custom domain name which will be associated with a Let's Encrypt certificate.


Freebox OS API documentation :

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

aiofreepybox-0.0.6.tar.gz (33.5 kB view hashes)

Uploaded source

Built Distribution

aiofreepybox-0.0.6-py3-none-any.whl (44.4 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page