Search areas
search_search_areasFuzzy-rank Home Assistant areas by name fragment to find an area's id when the exact name is unknown. Returns top scored matches, dropping zero-score results.
Instructions
Fuzzy-rank areas by name.
Scores every area from the area registry against query, keeps only
scores above 0, and returns the top limit matches sorted descending.
Use when: you don't know an area's exact id and want a ranked guess
from a name fragment.
Not for: an exact, unranked area list — use areas_list_areas.
Returns: list of dicts (area_id, name, floor_id, icon, score) up to
limit entries.
Limits: areas that score exactly 0 are dropped entirely; a WS failure
yields an empty list rather than an error.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of ranked results to return; defaults to 20. | |
| query | Yes | Search text to fuzzy-match against area names. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |