Skip to content
Scrappa Get API key
Zimmo API 1 credit/request

Zimmo Address Autocomplete API Documentation

GET https://scrappa.co/api/zimmo/autocomplete

Zimmo Address Autocomplete API Type part of an address and get matching Belgian street addresses. Each result has the full text, street, house number, postal code, city, coordinates and the place_id of the municipality for the search endpoint.

Zimmo Address Autocomplete API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/zimmo/autocomplete
Auth header
x-api-key
Cost
1 credit/request
query = coffee shops
Response preview
200 OK
{
    "data": {
        "query": "Korenmarkt Gent",
        "results": [
            {
                "lat": 51.055334,
                "lon": 3.722253,
                "city": "Gent",
                "text": "Korenmarkt 1, 9000 Gent",
                "street": "Korenmarkt",
                "place_id": 1506,
                "postal_code": "9000",
                "house_number": "1"
            },
...

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.

2 optional filters available.

query string Required

Address text, 3 to 100 characters, e.g. Korenmarkt Gent.

Example value coffee shops
limit integer Optional

Rows to return, 1 to 20. Default 10.

Example value 10
locale 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.

Example value 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
JSON Response
200 OK
{
    "data": {
        "query": "Korenmarkt Gent",
        "results": [
            {
                "lat": 51.055334,
                "lon": 3.722253,
                "city": "Gent",
                "text": "Korenmarkt 1, 9000 Gent",
                "street": "Korenmarkt",
                "place_id": 1506,
                "postal_code": "9000",
                "house_number": "1"
            },
            {
                "lat": 51.0544,
                "lon": 3.722257,
                "city": "Gent",
                "text": "Korenmarkt 14A, 9000 Gent",
                "street": "Korenmarkt",
                "place_id": 1506,
                "postal_code": "9000",
                "house_number": "14A"
            }
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "autocomplete"
    },
    "success": true
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

422

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"
}
503

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.