search_listings searches apartment listings through BrightPlace’s search
stack using strict-match mode.
When to use it
Usesearch_listings when a renter asks for apartments matching objective
criteria such as price, location, bedrooms, bathrooms, amenities, or move-in
timing.
Do not use it for protected-class or demographic steering requests. Those
requests return FAIR_HOUSING_VIOLATION.
Input
| Field | Type | Required | Notes |
|---|---|---|---|
query | string | No | Semantic search text. Empty strings are treated as omitted. |
filters.locations | array | No | City/state filters. Use lowercase city and two-letter state. |
filters.beds | number | No | Exact bedroom count. |
filters.baths | number | No | Minimum bathroom count. |
filters.minPrice | number | No | Minimum monthly rent. |
filters.maxPrice | number | No | Maximum monthly rent. |
limit | integer | No | Defaults to 20. Maximum 50. |
query is
omitted.
Output
The tool returnsListingSummary[].
listing_id is the listing snapshot id to pass into get_listing,
get_tour_availability, and book_tour.