Repository navigation
Home
Welcome! Everything you need to master the Eero API Python client.
| Page | What you'll learn |
|---|---|
| π Python API | Full API reference & examples |
| βοΈ Configuration | Client setup & options |
| π Authentication | Login, OTP verification, session lifecycle |
| π Credential Storage | Keyring, file, and memory storage backends |
| Page | What you'll learn |
|---|---|
| π Raw Response Format | The {"meta": ..., "data": ...} envelope |
| π― Network Targeting | Passing network_id correctly; IDs, paths, URLs and parent= links |
| π¨ Error Handling | The EeroException hierarchy |
| β‘ Caching and Rate Limits | TTL cache, the ~100 req/min ceiling, and which writes may reboot the mesh |
| Page | What you'll learn |
|---|---|
| π API Reference | Every domain API and method signature |
| π Migration | Upgrade guide for every breaking release, v1.x β v8.0.0 |
| No-op and removed surface, and what replaces it | |
| π‘ Examples | End-to-end runnable scripts |
| Page | What you'll learn |
|---|---|
| π‘οΈ Logging and Security |
SecureLoggerAdapter, redaction, safe debug logging |
| π Ecosystem | CLI, dashboard, exporter and Home Assistant projects built on this SDK |
| π€ Contributing | Dev setup, tests, style |
| π§ Troubleshooting | Common issues & fixes |
- Python 3.12+
- An Eero account that signs in with an email address or phone number, verified by a one-time code (see Troubleshooting if you use Amazon login)
pip install eero-api
# or
uv add eero-apiπ¦ Latest release: see the PyPI project page for the current version.
π¦ Install from source
git clone https://github.com/fulviofreitas/eero-api.git
cd eero-api
pip install .
# For development (includes pytest, black, mypy, ruff)
pip install -e ".[dev]"import asyncio
from eero import EeroClient
async def main():
async with EeroClient() as client:
if not client.is_authenticated:
await client.login("you@example.com")
await client.verify(input("Code: "))
# All methods return a raw {"meta": ..., "data": ...} envelope
response = await client.get_networks()
data = response.get("data") or {}
networks = data if isinstance(data, list) else (data.get("networks") or data.get("data") or [])
for network in networks:
print(f"πΆ {network.get('name')}: {network.get('status')}")
asyncio.run(main())Note: See Raw Response Format for why there's no
network.nameattribute access βget_networks()can nest the network list more than one way. Note: For a reusable shape-tolerant helper, see Raw Response Format.
| Resource | URL |
|---|---|
| π¦ PyPI | eero-api |
| π¦ GitHub | fulviofreitas/eero-api |
| π Issues | Report a bug |
| π Changelog | CHANGELOG.md |
| π₯οΈ CLI | eeroctl |
| π Home Assistant | home-assistant-eero |
This project is a modern revamp of the original eero-client by @343max. Previously known as eero-client.
What's new:
- Full async/await with
aiohttp - Raw JSON passthrough β no Pydantic models, no data transformation
- 37 domain-specific APIs + AuthAPI (38 API classes total) covering the Eero Cloud API surface the API still serves β including, since v8.0.0, entitlements, events, permissions, notifications, DNS policies, members and invites, account profile, DHCP and connection mode, per-band WPA3, power saving, dynamic DNS, backup access points, subnets, and multi-static IP / secondary WAN
- Link-driven requests β every resource argument accepts a bare ID, an API path, or an absolute API-host URL, and the SDK follows the
resourceslinks the API publishes instead of hardcoding paths (see Network Targeting) - Secure credential storage β OS keyring, with an owner-only (
0600) file fallback
Unofficial Project: This library uses reverse-engineered APIs and is not affiliated with or endorsed by Eero.
Amazon Login Limitation: If your Eero account uses Amazon for login, this library may not work directly due to API limitations. See Troubleshooting for the workaround.
- Use the sidebar to navigate between pages
- Code blocks have a copy button
eero-api β unofficial async Python client for the Eero cloud API. Not affiliated with or endorsed by Eero.
This wiki is generated from wiki/ in the main repository β edit there, not here. Β· MIT License