# Zimmo Places API Documentation

<p><strong>Zimmo Places API</strong> Look up a Belgian place by its official name (Dutch, French or English) or by a 4 digit postal code. Each result has a <code>place_id</code> 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.</p><p>The result also lists the parent places, such as the province and the region. Their ids work as search filters too.</p>

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

## 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 | 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. |
| `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": "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

| 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)