aiosynologysrm

PyPI	Python	Release Date	Downloads

CI	License	Typed	Issues	Discussions

A Python library that reads what your Synology router knows: its own state, the devices on your network, and over time DHCP, Wi-Fi, firewall and more. It talks to the router's Web API (Synology Router Manager, SRM) and never changes a setting.

It is built as a foundation for integrations such as Home Assistant, but works in any asyncio program.

Unofficial. Not affiliated with, endorsed by or supported by Synology Inc. "Synology" and "SRM" are trademarks of Synology Inc.

Table of contents

• Why this library?
• Which devices work?
• Quick start
• What it can read
• Errors
• Documentation
• Contributing
• License

Why this library?

synology-srm by aerialls pioneered Python access to SRM and is what Home Assistant's built-in integration uses. It is synchronous and has not changed since 2023. This library starts fresh for today's needs:

Which devices work?

Router, mesh point and standalone access point are all supported modes. If the router lacks a feature, the library says so instead of guessing. Details and how to report your model: docs/compatibility.md.

Quick start

You need Python 3.12 or newer and an SRM administrator account (SRM's Web API only answers administrators; a dedicated account for your integration is a good idea).

pip install aiosynologysrm

import asyncio

import aiohttp

from aiosynologysrm import SrmClient


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with SrmClient(
            "192.0.2.1",
            "admin-user",
            "secret",
            session=session,
            verify_ssl=False,  # SRM ships a self-signed certificate
        ) as client:
            info = await client.get_system_info()
            print(info.model, info.firmware_version)

            devices = await client.get_network_devices()
            for device in devices.devices:
                if device.online:
                    print(device.mac, device.hostname, device.connection)


asyncio.run(main())

What it can read

More (DHCP leases and reservations, IPv6 prefixes, external IP, firewall rules, Wi-Fi radios, ports, USB storage) is on the way. See the changelog for what each release adds.

Errors

Every error derives from SrmError. The ones you will meet most:

Error messages never contain passwords or session data, so they are safe to log.

Documentation

• Compatibility: devices, firmware, modes, how support is decided
• Design: how the library stays read-only, sessions, versions, privacy

Contributing

Reports with your router model and SRM version help most. See CONTRIBUTING.md; for security issues SECURITY.md.

License

MIT. Provided "as is", without warranty of any kind. The icon and header images are CC BY 4.0; their source is in eizedev/brand.