Homes.com Autocomplete API turns text into Homes.com places. Each result has a category (place, neighborhood, school, building, community or address), the page URL, the city, state and ZIP, coordinates and a bounding box. Places, neighborhoods and communities carry a location_id that you pass to the search route. A street address carries a property_id that you pass to the listing route. School and neighborhood results also carry an id for the school and neighborhood routes. An empty list is a valid answer and is billed.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
1 required parameter needed before sending a request.
3 optional filters available.
string
Required
Search text, 2 to 100 characters. Example: Austin, TX.
coffee shops
integer
Optional
Number of results, 1 to 25. Default 10.
10
string
Optional
Keep one result type: place, neighborhood, school, building, community or address.
example
string
Optional
sale (default) or rent.
example
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"data": {
"query": "Austin",
"results": [
{
"id": "f5xx96v6x6171",
"url": "https://www.homes.com/austin-tx/",
"city": "Austin",
"name": "Austin, TX",
"state": "TX",
"county": "Travis",
"street": null,
"category": "place",
"coordinates": {
"latitude": 30.29861,
"longitude": -97.75405
},
"description": "City",
"location_id": "2.f5xx96v6x6171",
"postal_code": null,
"property_id": null,
"bounding_box": {
"east": -97.52759,
"west": -97.93836,
"north": 30.51666,
"south": 30.07558
},
"display_name": "Austin, TX"
},
{
"id": "0dqk6nmm631zg",
"url": "https://www.homes.com/austin-tx/northeast-austin-neighborhood/",
"city": "Austin",
"name": "Northeast Austin, Austin, TX",
"state": "TX",
"county": "Travis",
"street": null,
"category": "neighborhood",
"coordinates": {
"latitude": 30.3244,
"longitude": -97.55753
},
"description": "Neighborhood",
"location_id": "4.0dqk6nmm631zg",
"postal_code": null,
"property_id": null,
"bounding_box": {
"east": -97.41946,
"west": -97.70677,
"north": 30.48521,
"south": 30.198
},
"display_name": "Northeast Austin, Austin, TX"
}
]
},
"meta": {
"billable": true,
"endpoint_family": "autocomplete"
},
"success": true
}Errors
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
A required parameter or a range is invalid, or the page is beyond the first 700 results. This response is not billable.
{
"errors": {
"query": [
"The query field is required."
]
},
"message": "The request validation failed"
}Upstream Unavailable
Homes.com could not be reached or returned data that does not match the request. This response is not billable and is retryable.
{
"meta": {
"billable": false,
"retryable": true,
"endpoint_family": "autocomplete"
},
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "Homes.com could not be reached. Please retry shortly."
},
"success": false
}Generate Code with AI
Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.
Try It Live
Test this endpoint in our interactive playground with real data.