Greystar API endpoint
Use Crawlora's Greystar Units API to extract supported public Greystar data as structured JSON. This page includes request parameters, cURL examples, response schema, error behavior, credit cost, and a Playground link for testing before integration.
/greystar/unitsSearches 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. Developers commonly use this endpoint for data enrichment, monitoring, research dashboards, internal automation, and agent-native workflows that need repeatable structured public web data. Authentication uses the documented Crawlora headers, and usage is metered with the credit cost shown on this page.
Request parameters are generated from the active endpoint catalog. Required values must be sent before Crawlora can call the upstream public web data source.
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| location | string | No | Search location slug from /greystar/unit-locations, e.g. austin-tx, texas or greater-austin/round-rock | ||
| bedrooms | array<string> | No | Bedroom count; repeat for several (0 is studio) Allowed values: 0, 1, 2, 3, 4, 5, 6. Repeat this query parameter for multiple values. | ||
| bathrooms | array<string> | No | Bathroom count; repeat for several Allowed values: 0, 1, 2, 3, 4. Repeat this query parameter for multiple values. | ||
| building_type | array<string> | No | Building type; repeat for several Allowed values: Active Adult, Garden, High-Rise, Mid-Rise, Single Family Home, Student, Townhome. Repeat this query parameter for multiple values. | ||
| highlights | array<string> | No | Community highlight; repeat for several (matches any) Allowed values: airCon, dishwasher, eco, fitness, garages, limitedAccess, patioBalcony, pets, playground, pools, smokeFree, walkInClosets, washerDryer. Repeat this query parameter for multiple values. | ||
| min_price | number | No | Minimum monthly unit price | ||
| max_price | number | No | Maximum monthly unit price | ||
| sort | string | No | Result order Allowed values: relevance, price_asc. | ||
| page | integer | No | 1-based page | ||
| per_page | integer | No | Communities per page, 1-100 | ||
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/greystar/units?bedrooms=0&bathrooms=0&building_type=Active+Adult&highlights=airCon&sort=relevance&page=1" \ -H "x-api-key: $CRAWLORA_API_KEY"
Send your scraping API key in the x-api-key header. Use the console API Keys page to rotate or select the active key.
Endpoint usage is metered in credits. The plan prices, included credits, limits, and overage rates below match the active backend billing configuration.
| Plan | Price | Included credits | Daily cap | Rate limit | Overage |
|---|---|---|---|---|---|
| Free | $0/mo | 2,000 | 500 daily credits | 5/min | No overage |
| Starter | $9/mo | 20,000 | 5,000 daily credits | 15/min | $0.75/1,000 overage credits when enabled |
| Growth | $29/mo | 100,000 | 25,000 daily credits | 45/min | $0.45/1,000 overage credits when enabled |
| Pro | $79/mo | 400,000 | No daily cap | 120/min | $0.30/1,000 overage credits |
| Business | $199/mo | 1,200,000 | No daily cap | 300/min | $0.20/1,000 overage credits |
| Enterprise | $499/mo | 5,000,000 | No daily cap | 1,000/min | $0.12/1,000 overage credits |
This endpoint is executed through Crawlora's managed scraping infrastructure.
Lists units currently available to rent, grouped by community. `total_count` counts community groups (a very large community can appear as more than one group). Each entry in `properties` carries `property_id` (usable with `/greystar/properties/{id}`), name, address, coordinates, `matching_units`, and `units`: each with `unit_id`, `unit_number`, `floorplan`, `bedrooms`, `bathrooms`, `price`, `min_price`/`max_price`, `min_base_rent_lease_term`, and required monthly fees. At most about 100 units are listed per community; `units_truncated` is `true` when `matching_units` is larger. `facets` gives the counts for `bedrooms`, `bathrooms`, `building_types`, and `highlights` in the location. A listed location that Greystar has no unit listing for returns `404`.
Crawlora does not silently return bad data when the upstream page cannot be used.
| Status | Common failure case |
|---|---|
| 400 | Invalid input or missing required parameter |
| 429 | Plan or endpoint rate limit exceeded |
| 500 | Internal execution error |
| 502 | Upstream platform failed, returned unusable HTML, or served a challenge page that could not be resolved |
When possible, Crawlora returns structured error context so your integration can retry, back off, or inspect the request.
| Status | Description | Schema |
|---|---|---|
| 400 | Bad Request | #/definitions/app.Response |
| 404 | Not Found | #/definitions/app.Response |
| 429 | Too Many Requests | #/definitions/app.Response |
| 503 | Service Unavailable | #/definitions/app.Response |
{
"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
}
]
}
]
}
}Request schema
No body schema
Response schema
#/definitions/greystar.UnitSearchResult
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| facets | greystar.UnitFacets | No | ||||
| facets.bathrooms | array | No | ||||
| facets.bathrooms[].count | integer | No | ||||
| facets.bathrooms[].value | string | No | ||||
| facets.bedrooms | array | No | ||||
| facets.bedrooms[].count | integer | No | ||||
| facets.bedrooms[].value | string | No | ||||
| facets.building_types | array | No | ||||
| facets.building_types[].count | integer | No | ||||
| facets.building_types[].value | string | No | ||||
| facets.highlights | array | No | ||||
| facets.highlights[].count | integer | No | ||||
| facets.highlights[].value | string | No | ||||
| location | string | No | ||||
| page | integer | No | ||||
| per_page | integer | No | ||||
| properties | array | No | ||||
| properties[].address | string | No | ||||
| properties[].city | string | No | ||||
| properties[].latitude | number | No | ||||
| properties[].longitude | number | No | ||||
| properties[].matching_units | integer | No | ||||
| properties[].name | string | No | ||||
| properties[].postal_code | string | No | ||||
| properties[].property_id | string | No | ||||
| properties[].state | string | No | ||||
| properties[].state_name | string | No | ||||
| properties[].thumbnail_url | string | No | ||||
| properties[].units | array | No | ||||
| properties[].units[].banner | string | No | ||||
| properties[].units[].bathrooms | number | No | ||||
| properties[].units[].bedrooms | number | No | ||||
| properties[].units[].floorplan | string | No | ||||
| properties[].units[].max_price | number | No | ||||
| properties[].units[].min_base_rent_lease_term | integer | No | ||||
| properties[].units[].min_price | number | No | ||||
| properties[].units[].price | number | No | ||||
| properties[].units[].required_monthly_fees_max | number | No | ||||
| properties[].units[].required_monthly_fees_min | number | No | ||||
| properties[].units[].unit_id | string | No | ||||
| properties[].units[].unit_number | string | No | ||||
| properties[].units_truncated | boolean | No | ||||
| total_count | integer | No | ||||
| total_pages | integer | No |
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/greystar/units?bedrooms=0&bathrooms=0&building_type=Active+Adult&highlights=airCon&sort=relevance&page=1" \
-H "x-api-key: $CRAWLORA_API_KEY"Crawlora is designed for responsible structured public web data workflows. Customers are responsible for using Crawlora in compliance with applicable laws, third-party rights, target-platform rules, and Crawlora terms.
Read Crawlora terms