Zimmo Places API Look up a Belgian place by its official name (Dutch, French or English) or by a 4 digit postal code. Each result has a place_id for the search endpoint, the name in every language, aliases such as Gand for Gent, the type (locality, municipality, province or region), the postal code and the centre point.
The result also lists the parent places, such as the province and the region. Their ids work as search filters too.
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
Official place name in Dutch, French or English, or a 4 digit postal code, e.g. Gent or 9000. Aliases such as Gand are returned in the result but are not matched as a query.
coffee shops
string
Optional
Language of the flat text fields (title, description, url, city): nl, fr, en or de. Default nl. The full text maps keep all languages.
en-US
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": "Gent",
"results": [
{
"lat": 51.04506,
"lon": 3.71517,
"name": "Gent",
"type": "locality",
"names": {
"en": "Ghent",
"nl": "Gent"
},
"slugs": {
"en": "ghent",
"nl": "gent"
},
"aliases": [
{
"name": "Gand",
"locale": "fr"
}
],
"place_id": 1506,
"postal_code": "9000"
},
{
"lat": 51.11067,
"lon": 4.6712,
"name": "Vlaanderen",
"type": "region",
"names": {
"en": "Flanders",
"fr": "Flandre",
"nl": "Vlaanderen"
},
"slugs": {
"fr": "flandre",
"nl": "vlaanderen"
},
"aliases": [],
"place_id": 3,
"postal_code": null
},
{
"lat": 51.01091,
"lon": 3.68307,
"name": "Oost-Vlaanderen",
"type": "province",
"names": {
"en": "East Flanders",
"fr": "Flandre orientale (la)",
"nl": "Oost-Vlaanderen"
},
"slugs": {
"en": "east-flanders",
"fr": "flandre-orientale",
"nl": "oost-vlaanderen"
},
"aliases": [],
"place_id": 4,
"postal_code": null
}
]
},
"meta": {
"billable": true,
"endpoint_family": "locations"
},
"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": [
"A place name or a 4 digit postal code is required, e.g. Gent or 9000."
]
},
"message": "The request validation failed"
}Temporarily Unavailable
Zimmo did not answer or refused the request after several attempts. This response is not billable. Retry after a short pause.
{
"meta": {
"attempts": 3,
"billable": false,
"retryable": true
},
"error": {
"message": "Zimmo 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.