# Zimmo Address Autocomplete API Documentation

<p><strong>Zimmo Address Autocomplete API</strong> 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 <code>place_id</code> of the municipality for the search endpoint.</p>

- **Documentation:** [https://scrappa.co/docs/zimmo-api/zimmo_autocomplete](https://scrappa.co/docs/zimmo-api/zimmo_autocomplete)
- **API group:** Zimmo API
- **Endpoint:** `GET https://scrappa.co/api/zimmo/autocomplete`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `query` | string | Yes | Address text, 3 to 100 characters, e.g. Korenmarkt Gent. |
| `limit` | integer | No | Rows to return, 1 to 20. Default 10. |
| `locale` | string | No | 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 response

```json
{
    "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

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A required parameter is missing or invalid. This response is not billable. |
| 503 | Temporarily Unavailable | Zimmo did not answer or refused the request after several attempts. This response is not billable. Retry after a short pause. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)