Zolo Autocomplete API finds places and listing addresses by name. Pass the search_area of a city or neighbourhood as location to the search route. A listing address has a listing_url for the listing route. A query with no match returns an empty list. Failed requests are not 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.
string
Required
Required. Search text, 1 to 100 characters. Example: toronto.
coffee shops
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"data": {
"count": 3,
"items": [
{
"name": "Toronto, ON",
"type": "city",
"group": "locations",
"listing_url": null,
"search_area": "Toronto",
"listing_path": null
},
{
"name": "Toronto Gore Rural Estate, Brampton, ON",
"type": "neighbourhood",
"group": "locations",
"listing_url": null,
"search_area": "Toronto Gore Rural Estate, Brampton",
"listing_path": null
},
{
"name": "17-Toronto Toronto Lake Road, Georgian Bay, ON",
"type": "address",
"group": "listings",
"listing_url": "https://www.zolo.ca/georgian-bay-real-estate/toronto-toronto-lake-road/17",
"search_area": null,
"listing_path": "/georgian-bay-real-estate/toronto-toronto-lake-road/17"
}
]
},
"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 invalid. This response is not billable.
{
"errors": {
"q": [
"The q field is required."
]
},
"message": "The request validation failed"
}Upstream Unavailable
Zolo 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": "Zolo 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.