Endpoint Playground
Searches apartment units currently available to rent on greystar.com within one location (nationwide by default), filtered by bedrooms, bathrooms, building type, community highlights, and monthly price, sorted by relevance or price. Results are grouped by community: each carries its address, coordinates, the number of matching units, and up to about 100 units with unit number, floor plan, bedrooms, bathrooms, price range, and lease term. The response also returns filter counts for the location. Several values of one filter match any of them. Get location values from /greystar/unit-locations.
14 Oct 2026: 20 properties; 13 fields had a value in every checked item.
Sample value profiles: matching_units: 6 to 85, median 22; name: “Tree Apartments” and 19 other values; thumbnail_url: s7d9.scene7.com.
curl 'https://api.crawlora.net/api/v1/greystar/units?sort=relevance' \
-H "x-api-key: $CRAWLORA_API_KEY"| Parameter | Type | Required | Prefilled value | Description |
|---|---|---|---|---|
| location | string | No | Search location slug from /greystar/unit-locations, e.g. austin-tx, texas or greater-austin/round-rock | |
| bedrooms | array | No | Bedroom count; repeat for several (0 is studio) | |
| bathrooms | array | No | Bathroom count; repeat for several | |
| building_type | array | No | Building type; repeat for several | |
| highlights | array | No | Community highlight; repeat for several (matches any) | |
| min_price | number | No | Minimum monthly unit price | |
| max_price | number | No | Maximum monthly unit price | |
| sort | string | No | relevance | Result order |
| page | integer | No | 1-based page | |
| per_page | integer | No | Communities per page, 1-100 |
{
"code": 200,
"msg": "OK",
"data": {
"location": "austin-tx",
"total_count": 82,
"page": 1,
"per_page": 1,
"total_pages": 82,
"facets": {
"bedrooms": [
{
"value": "2",
"count": 60
}
],
"bathrooms": [
{
"value": "2",
"count": 44
}
],
"building_types": [
{
"value": "Garden",
"count": 431
}
],
"highlights": [
{
"value": "pools",
"count": 474
}
]
},
"properties": [
{
"property_id": "12913",
"name": "Residences at The Triangle",
"address": "4600 W. Guadalupe St.",
"city": "Austin",
"state": "TX",
"postal_code": "78751",
"latitude": 30.31,
"longitude": -97.73,
"matching_units": 42,
"units_truncated": false,
"units": [
{
"unit_id": "3638674",
"unit_number": "B325",
"floorplan": "B-C1",
"bedrooms": 2,
"bathrooms": 2,
"price": 2125,
"min_price": 2012,
"max_price": 2180,
"min_base_rent_lease_term": 12,
"required_monthly_fees_min": 113,
"required_monthly_fees_max": 113
}
]
}
]
}
}The sample response, schema and code snippets below work without an account. Sending a live request needs an API key.