Homes.co.nz Autocomplete API finds cities, suburbs, streets and addresses by name. Each location has a type (city, suburb, street or address), title, ids, coordinates and, for addresses, the property_id for the property route. search_params holds the parameter that searches the place: q for a suburb, bbox for the others. The box is an approximate area around the point. A text that matches no place returns an empty list. Failed requests are not billable.
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. Place or address text, 2 to 100 characters.
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": {
"locations": [
{
"city": "Auckland",
"type": "suburb",
"unit": null,
"title": "Ponsonby, Auckland",
"street": null,
"suburb": "Ponsonby",
"city_id": 100004,
"latitude": -36.85071676573275,
"longitude": 174.7405510648527,
"suburb_id": 1279,
"property_id": null,
"search_params": {
"q": "Ponsonby, Auckland"
},
"street_number": null
},
{
"city": "Auckland",
"type": "street",
"unit": null,
"title": "Ponsonby Road, Ponsonby, Auckland",
"street": "Ponsonby Road",
"suburb": "Ponsonby",
"city_id": 100004,
"latitude": -36.8521886789864,
"longitude": 174.74511952436453,
"suburb_id": 1279,
"property_id": null,
"search_params": {
"bbox": "-36.8486,174.74063,-36.85578,174.74961"
},
"street_number": null
},
{
"city": "Auckland",
"type": "street",
"unit": null,
"title": "Ponsonby Road, Grey Lynn, Auckland",
"street": "Ponsonby Road",
"suburb": "Grey Lynn",
"city_id": 100004,
"latitude": -36.85764329170246,
"longitude": 174.7488146529926,
"suburb_id": 475,
"property_id": null,
"search_params": {
"bbox": "-36.85405,174.74432,-36.86124,174.75331"
},
"street_number": null
}
]
},
"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
Homes.co.nz could not be reached. This response is not billable and is retryable.
{
"meta": {
"billable": false,
"retryable": true,
"endpoint_family": "autocomplete"
},
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "Homes.co.nz 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.