# Immovlan Location Autocomplete API Documentation

<p><strong>Immovlan Location Autocomplete API</strong> Find the places Immovlan knows by name or postal code. Each result has a <code>slug</code> and a <code>search_filter</code> that tells you which search parameter takes it: <code>municipal</code> (a municipality with its suburbs), <code>town</code> (one postal code area), <code>province</code> or <code>region</code>.</p>

- **Documentation:** [https://scrappa.co/docs/immovlan-api/immovlan_autocomplete](https://scrappa.co/docs/immovlan-api/immovlan_autocomplete)
- **API group:** Immovlan API
- **Endpoint:** `GET https://scrappa.co/api/immovlan/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 | Place name or postal code, at least 3 characters. |
| `limit` | integer | No | Maximum places to return, 1 to 20 (default 10). |

## Example response

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

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A required parameter is missing or invalid. This response is not billable. |
| 503 | Service Unavailable | Immovlan could not be reached or returned an unreadable page after retries. Retry shortly. This response is not billable. |

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