Immovlan Location Autocomplete API Find the places Immovlan knows by name or postal code. Each result has a slug and a search_filter that tells you which search parameter takes it: municipal (a municipality with its suburbs), town (one postal code area), province or region.
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 or postal code, at least 3 characters.
coffee shops
integer
Optional
Maximum places to return, 1 to 20 (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": {
"count": 3,
"query": "Antwerp",
"results": [
{
"id": 8422,
"zip": "2000",
"name": "Antwerp",
"slug": "antwerp",
"type": "municipality",
"label": "Antwerp (2000) + Suburbs",
"names": {
"en": "Antwerp",
"fr": "Anvers",
"nl": "Antwerpen"
},
"has_suburbs": true,
"search_filter": {
"param": "municipal",
"value": "antwerp"
}
},
{
"id": 8422,
"zip": "2000",
"name": "Antwerp",
"slug": "2000-antwerp",
"type": "town",
"label": "Antwerp (2000)",
"names": {
"en": "Antwerp",
"fr": "Anvers",
"nl": "Antwerpen"
},
"has_suburbs": true,
"search_filter": {
"param": "town",
"value": "2000-antwerp"
}
},
{
"id": 24387,
"zip": "2018",
"name": "Antwerp",
"slug": "2018-antwerp",
"type": "town",
"label": "Antwerp (2018)",
"names": {
"en": "Antwerp",
"fr": "Anvers",
"nl": "Antwerpen"
},
"has_suburbs": false,
"search_filter": {
"param": "town",
"value": "2018-antwerp"
}
}
]
},
"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 is missing or invalid. This response is not billable.
{
"errors": {
"query": [
"The query needs at least 3 characters."
]
},
"message": "The request validation failed"
}Service Unavailable
Immovlan could not be reached or returned an unreadable page after retries. Retry shortly. This response is not billable.
{
"meta": {
"attempts": 3,
"billable": false,
"retryable": true
},
"error": {
"message": "Immovlan data is temporarily unavailable. Please retry.",
"failure_type": "upstream_unavailable"
},
"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.