Home Assistant WebSocket API

Create custom WebSocket API commands for frontend integration, custom panels, or third-party tools.

When to Use WebSocket API

Use WebSocket API for:

• Custom frontend panels needing real-time data
• Complex queries not covered by standard APIs
• Integration-specific configuration UIs
• Streaming data to clients
• Third-party tool integration

Basic WebSocket Command

# api.py
"""WebSocket API for {Name}."""
from __future__ import annotations