Skip to content
github-actions[bot] edited this page Oct 12, 2026 · 9 revisions

🌐 Eero API Wiki

Welcome! Everything you need to master the Eero API Python client.


πŸ“š Guides

Getting Started

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

Core Concepts

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

Reference

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
⚠️ Deprecations No-op and removed surface, and what replaces it
πŸ’‘ Examples End-to-end runnable scripts

Project

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

πŸš€ Quick Start

Requirements

  • 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)

Install

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]"

Hello World

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.name attribute access β€” get_networks() can nest the network list more than one way. Note: For a reusable shape-tolerant helper, see Raw Response Format.


πŸ”— Links

Resource URL
πŸ“¦ PyPI eero-api
πŸ“¦ GitHub fulviofreitas/eero-api
πŸ› Issues Report a bug
πŸ“‹ Changelog CHANGELOG.md
πŸ–₯️ CLI eeroctl
🏠 Home Assistant home-assistant-eero

πŸ™ Acknowledgments

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 resources links the API publishes instead of hardcoding paths (see Network Targeting)
  • Secure credential storage β€” OS keyring, with an owner-only (0600) file fallback

⚠️ Important Notes

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.


πŸ’‘ Tips

  • Use the sidebar to navigate between pages
  • Code blocks have a copy button

Clone this wiki locally