Skip to main content

pyEzvizApi

CI PyPI Buy Me A Coffee

A Python client and CLI for the reverse-engineered EZVIZ cloud API, device controls, channel-99 push and optional local/cloud media processing.

These docs track main, including unreleased changes. A PyPI installation may not contain every API described here. Match documentation to your installed release tag, or use a source checkout for current development. See the changelog, especially the removed import paths and push migration.

Release 2.5.0

Version 2.5.0 adds non-camera monitors, capability-qualified intercom controls and normalized ring/unlock events with optional bounded history. Channel-99 decoding now preserves alarm metadata and separates call/control layouts. Existing method signatures remain compatible; ring/unlock motion classification, raw notification fields and monitor inventory have compatibility notes. See intercom support for qualification and hardware limits.

Upgrading to 2.0

Version 2.0 removes obsolete flat imports and legacy push registration. Review the release and migration notes before upgrading. Push consumers need explicit channel-99 migration and durable complete-token storage; polling remains independent of push. Updating this library does not migrate Home Assistant integrations or change their dependency pins.

Install

Python 3.12 or newer is required for the library.

python -m pip install pyezvizapi
# Optional PyAV-backed streaming APIs:
python -m pip install 'pyezvizapi[streaming]'

FFmpeg/FFprobe are separate system programs used by specific media paths, not installed by pip. Home Assistant and development-player dependencies are not required for ordinary library use.

Quick start

pyezvizapi --help
# First login; replace placeholders. Passwords passed as arguments may be
# visible in shell history/process listings. Prefer saved tokens for reuse.
pyezvizapi -u YOUR_USERNAME -p YOUR_PASSWORD --save-token devices status
# Global flags precede the command:
pyezvizapi --token-file ezviz_token.json --json devices status

The CLI prompts for MFA when required. Protect the complete token file; do not commit it. See getting started for region selection, token precedence, source installation and authentication troubleshooting.

What is available?

Area Start here
Python account/device client Python API guide
Read-only T2C/T10C/T9C detector status Detector guide
CLI inventory, status and controls Command-line guide
Push notifications Channel-99 migration and lifecycle
Images, finite clips and stream paths Media guide
Home Assistant consumers and known gaps HA integration status
Canonical imports and breaking alias removals Compatibility guide
All guides, technical references and research Documentation index

Device controls and stream support depend on model, firmware, region and account permissions. A command's API success is not proof of physical device action. Decoded samples and offline tests are not proof of live HA/browser playback.

Home Assistant

The cloud client is consumed by HA's EZVIZ integration and the ha-ezviz custom integration; they have separate dependency pins and release cycles. The current ha-ezviz consumer needs channel-99 migration and durable token persistence before push can work with this branch. Polling is independent of push.

The native HA example is an isolated validation integration, not a released replacement for either cloud integration. See HA status for tested boundaries and remaining live acceptance work.

Development and support

Apache-2.0; see LICENSE.

Support the maintainer.

Shared device inventory

For one bounded refresh shared across HA platforms, immutable typed states and per-device freshness, see Device inventory. Existing family loaders remain compatible.

Stable identities for container applications (2.1.0+)

Applications can opt into a persisted per-client feature_code instead of the legacy MAC-derived identity. Persist it before first login and provide the same value when restoring saved credentials; the SDK never silently adopts a token's identity or changes process-wide defaults. See persisted installation identities for ownership, migration, validation and consumer-release requirements.

Video intercoms

See non-streaming intercom support for monitor inventory, capability-qualified relay/settings helpers and normalized ringing/access events. Streaming and call/talk control are separate from this API.

Metadata

Release files for pyezvizapi 2.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyezvizapi 2.5.0
File Size Uploaded Provenance Actions
pyezvizapi-2.5.0.tar.gz 969.1 kB With provenance Details for pyezvizapi-2.5.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pyezvizapi 2.5.0
File Interpreter ABI Platform Actions
pyezvizapi-2.5.0-py3-none-any.whl Python 3 none any Details for pyezvizapi-2.5.0-py3-none-any.whl

Total release size: 1.6 MB

Release files / pyezvizapi-2.5.0.tar.gz

Download URL pyezvizapi-2.5.0.tar.gz
Size 969.1 kB
Tags Source
SHA-256 checksum
How to use checksums
bf41a7473705eba2887198100a3999bc536bd8a8359cbf85464b8d84e9adc442
BLAKE2b-256 checksum
How to use checksums
f0004edf881558a03e2820b036dfa2881a3d637f3d3899bf278af6c3b8b1cf87
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 15, 2026.

Transparency log

Release files / pyezvizapi-2.5.0-py3-none-any.whl

Download URL pyezvizapi-2.5.0-py3-none-any.whl
Size 623.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0c5e2baf16b1e7966291a654ace17a77474d7c22fa0b5d49c1fb3acb12a2f5f8
BLAKE2b-256 checksum
How to use checksums
2292941c2f43e6da9f12d302738daeeba8a00813ebd6a9eb2cf161991d19f19f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 15, 2026.

Transparency log

Security for pyezvizapi 2.5.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for pyezvizapi-2.5.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 15, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

2.5.0 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page