greystar_units
Search apartment units currently available on greystar.com in one location (nationwide by default) by bedrooms, bathrooms, building type, community highlights, and monthly price, sorted by relevance or price; returns communities with matching unit counts, units (number, floor plan, beds, baths, price range, lease term) and filter counts. Get locations from greystar_unit_locations.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 1-based page. Default 1. | |
| sort | No | relevance (default, the site's order) or price_asc. | |
| bedrooms | No | Bedroom counts 0-6 (0 is studio); several values match any of them. | |
| location | No | Search location slug from greystar_unit_locations, e.g. austin-tx, texas or greater-austin/round-rock. Default us (nationwide). | |
| per_page | No | Communities per page, 1-100. Default 20. | |
| bathrooms | No | Bathroom counts 0-4; several values match any of them. | |
| max_price | No | Maximum monthly unit price. | |
| min_price | No | Minimum monthly unit price. | |
| highlights | No | Community highlights: airCon, dishwasher, eco, fitness, garages, limitedAccess, patioBalcony, pets, playground, pools, smokeFree, walkInClosets, washerDryer; several values match ANY of them. | |
| building_type | No | Active Adult, Garden, High-Rise, Mid-Rise, Single Family Home, Student or Townhome; several values match any of them. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | The tool result payload (shape varies per tool; see each tool's docs resource). |