Imovelweb Autocomplete API turns a place name into location ids. Each result has the location id to use in search and polygon, its level (zone for a neighborhood, city, state), the full name and the parent chain up to Brazil. Cities and neighborhoods are suggested. Street names are not: a street query returns an empty list, which is a valid, billed answer.
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.
1 optional filter available.
string
Required
Place name, 2 to 100 characters. Example: Pinheiros.
coffee shops
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": {
"query": "Pinheiros",
"results": [
{
"name": "Pinheiros",
"type": "zone",
"parents": [
{
"name": "S\u00e3o Paulo",
"type": "city",
"location": "V1-C-109668"
},
{
"name": "S\u00e3o Paulo",
"type": "state",
"location": "V1-B-265"
},
{
"name": "Brasil",
"type": "country",
"location": "V1-A-2"
}
],
"location": "V1-Z-52",
"full_name": "Pinheiros, S\u00e3o Paulo, S\u00e3o Paulo"
},
{
"name": "Alto de Pinheiros",
"type": "zone",
"parents": [
{
"name": "S\u00e3o Paulo",
"type": "city",
"location": "V1-C-109668"
},
{
"name": "S\u00e3o Paulo",
"type": "state",
"location": "V1-B-265"
},
{
"name": "Brasil",
"type": "country",
"location": "V1-A-2"
}
],
"location": "V1-Z-70",
"full_name": "Alto de Pinheiros, S\u00e3o Paulo, S\u00e3o Paulo"
}
]
},
"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
Imovelweb could not be reached, or returned data 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": "Imovelweb 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.