The API key is required for all requests and must be included as a query parameter named `authKey`. You can obtain your API key from the [portal](/portal).


authKey

Deduce a complete or probable address based on incomplete, ambiguous, or partial input.

Provides autocomplete suggestions for Belgian settlements.

### How it works

- Suggestions are generated from **postnames**.
  A postname is the official postal designation used by Bpost, which may differ from the administrative municipality or deelgemeente.
  For example, **Laken** is a postname within the municipality of **Brussels**.

- If the `languageCode` parameter is omitted, results are returned in the **country default language**.
- If the `languageCode` parameter is specified but no matches exist in that language, the API will fall back to the **country default language**.

- Either the `postalCode` or `settlement` is required


The address's settlement (city, town, village, or hamlet).


settlement

ISO 639-1 language code used to determine the language context for input filters.

- **When specified**: input filters are applied only within the given language.
- **When unspecified**: the **default value** is `'nl'` (Dutch).


languageCode

The address's postal code which can be up to four digits long.


postalCode

Belgium postalCode

The amount of results returned, a number between `0` and `999`. Default value is `10`.


maxResults

The page to return, the variables for the next/previous pages can be found in the results Link header.


Suggest België Nederzetting Parameters