Point2 Homes Autocomplete API turns the start of a city name into the country, state and city values the rental search needs. Each result has an id, the city name, a label such as "Vancouver, BC", and a ready search object you can pass to the search endpoint.
Type at least 3 characters. Results only include cities in the requested country.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
2 required parameters needed before sending a request.
1 optional filter available.
string
Required
Start of a city name, 3 to 100 characters. Example: vancou.
coffee shops
string
Required
CA for Canada or US for the United States.
US
integer
Optional
Number of results, 1 to 25, default 10.
10
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"data": {
"results": [
{
"id": "960103",
"city": "Vancouver",
"name": "Vancouver",
"label": "Vancouver, BC",
"state": "BC",
"search": {
"city": "Vancouver",
"state": "BC",
"country": "CA"
},
"country": "CA",
"search_path": "/api/point2homes/search?country=CA&state=BC&city=Vancouver"
},
{
"id": "960134",
"city": "North Vancouver",
"name": "North Vancouver",
"label": "North Vancouver, BC",
"state": "BC",
"search": {
"city": "North Vancouver",
"state": "BC",
"country": "CA"
},
"country": "CA",
"search_path": "/api/point2homes/search?country=CA&state=BC&city=North+Vancouver"
},
{
"id": "960104",
"city": "West Vancouver",
"name": "West Vancouver",
"label": "West Vancouver, BC",
"state": "BC",
"search": {
"city": "West Vancouver",
"state": "BC",
"country": "CA"
},
"country": "CA",
"search_path": "/api/point2homes/search?country=CA&state=BC&city=West+Vancouver"
}
]
},
"meta": {
"billable": true,
"endpoint_family": "autocomplete"
},
"success": true
}Errors
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
A parameter is missing or outside its allowed values. This response is not billable.
{
"errors": {
"query": [
"The query field is required."
]
},
"message": "The request validation failed"
}Upstream Unavailable
Point2 Homes could not be reached, or returned a page that does not match the expected shape. Retry shortly. This response is not billable.
{
"meta": {
"billable": false,
"retryable": true,
"endpoint_family": "autocomplete"
},
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "Point2 Homes 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.