Greystar API endpoint
Use Crawlora's Greystar Search 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/searchLists Greystar communities published on greystar.com, optionally filtered by market area, neighborhood, city, state, country, starting rent, or free text. Filter values must come from /greystar/markets; an unknown value returns 400. Starting prices reflect each community's published minimum and are null when none is published. Results come from a snapshot refreshed every few minutes. 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 |
|---|---|---|---|---|---|
| query | string | No | Free-text match on name, address, city, neighborhood, market area, or postal code (max 160 characters) | ||
| market_area | string | No | Exact market area from /greystar/markets, e.g. Greater Austin | ||
| neighborhood | string | No | Exact neighborhood from /greystar/markets | ||
| city | string | No | Exact city from /greystar/markets | ||
| state | string | No | State or region abbreviation from /greystar/markets, e.g. TX | ||
| country_code | string | No | ISO country code from /greystar/markets, e.g. US | ||
| min_price | number | No | Minimum starting monthly rent; excludes communities with no published price | ||
| max_price | number | No | Maximum starting monthly rent; excludes communities with no published price | ||
| sort | string | No | Result order Allowed values: relevance, name, price_asc, price_desc. | ||
| page | integer | No | 1-based page | ||
| per_page | integer | No | Results per page, 1-100 | ||
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/greystar/search?query=coffee&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.
Filter values match case-insensitively but must exist in `/greystar/markets`; an unknown value returns `400` instead of an empty list. Filters combine with AND. Results come from a snapshot of every published community refreshed every few minutes, so `total_count` is exact for the snapshot. `min_price` is the community's published starting rent and is `null` when none is published. A page past the end returns an empty `properties` array. Use a result's `id` with `/greystar/properties/{id}` for floor plans, fees, and available units.
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 |
| 429 | Too Many Requests | #/definitions/app.Response |
| 503 | Service Unavailable | #/definitions/app.Response |
{
"code": 200,
"msg": "OK",
"data": {
"total_count": 16,
"page": 1,
"per_page": 20,
"total_pages": 1,
"properties": [
{
"id": "23303",
"name": "Lantower Edgewater",
"address": "14201 N Interstate 35",
"city": "Pflugerville",
"state": "TX",
"state_name": "Texas",
"postal_code": "78660",
"country_code": "US",
"market_area": "Greater Austin",
"min_price": null,
"display_price": null,
"min_base_rent_lease_term": null,
"required_monthly_fees_min": 97,
"required_monthly_fees_max": 97,
"thumbnail_url": "https://s7d9.scene7.com/is/image/greystarprod/23303CLB1"
}
]
}
}Request schema
No body schema
Response schema
#/definitions/greystar.SearchResult
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| page | integer | No | ||||
| per_page | integer | No | ||||
| properties | array | No | ||||
| properties[].address | string | No | ||||
| properties[].city | string | No | ||||
| properties[].country_code | string | No | ||||
| properties[].display_price | number | No | ||||
| properties[].id | string | No | ||||
| properties[].market_area | string | No | ||||
| properties[].min_base_rent_lease_term | integer | No | ||||
| properties[].min_price | number | No | ||||
| properties[].name | string | No | ||||
| properties[].neighborhood | string | No | ||||
| properties[].postal_code | string | No | ||||
| properties[].required_monthly_fees_max | number | No | ||||
| properties[].required_monthly_fees_min | number | No | ||||
| properties[].state | string | No | ||||
| properties[].state_name | string | No | ||||
| properties[].thumbnail_url | string | 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/search?query=coffee&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