Get filtered HA snapshot
snapshot_get_snapshotFetch Home Assistant states, registries, and config in one filtered call to avoid multiple round-trips. Apply domain, area, and pagination filters to assemble context quickly.
Instructions
Return a single filtered snapshot combining HA states, registries and config.
Reads live states via ha.get_states() and, depending on include, the
area/floor/device/entity registries and config entries over HTTP in one
call, applies domains/area_id filtering and limit/offset
pagination to the states list, and returns one dict keyed by section
name. Every call in this path is a read; nothing here writes to HA.
Use when: a client needs several registries and/or states together and
should not spend several round-trips assembling that context.
Not for: a single registry without filtering — use entities_list_entities
or ws_get_states for a plain state list, or areas_list_devices/
devices_list_devices for a plain device list.
Returns: dict keyed by requested section (states, areas, floors,
devices, entities, integrations, config), plus _meta (echoed
filters and per-section counts) and _states_total (pre-pagination
count) when states is included.
Errors: {"error": "unknown_include", "unknown": [...], "valid": [...]}
when include names a section outside the valid set.
Limits: limit/offset paginate only the states section; every other
section is always returned in full.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of states to return after filtering, for pagination on large setups. Omit for no limit. | |
| offset | No | Number of filtered states to skip before applying limit, for pagination. 0 starts from the first matching state. | |
| area_id | No | Area registry ID; keeps only states/devices/entities assigned to this area, directly or via their device. Omit for no area filter. | |
| domains | No | Entity domain filter applied to the states/entities sections, e.g. ['light', 'climate']. Omit to include every domain. | |
| include | No | Sections to return. Omit for the default states/areas/devices/entities/integrations set. Valid values: states, areas, floors, devices, entities, integrations, config. | |
| summary | No | If true, each state is reduced to entity_id/state/friendly_name. Set false for full attributes; ignored when state_fields is given. | |
| state_fields | No | Explicit per-state keys to return, overriding summary. Valid: entity_id, state, friendly_name, attributes, last_changed, last_updated. Omit to use summary instead. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||