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.

Resolves a single query string into complete or probable addresses and returns a list of ranked suggestions.
Each suggestion includes a `stage` indicating the current resolution step or completion status.

Stage meanings:
  * `empty`: returned on empty queries.
  * `mixed`: Both cities and streets suggested.
  * `postcode`: Postal code suggestions.
  * `street_number`: Street number selection.
  * `addition`: Street number addition selection.
  * `direct`: Suggest full addresses (with/without additions).
  * `final`: Fully validated and structured address.

Street and city name matching:
  * One or two characters match names from the start (prefix).
  * Three or more characters match anywhere in the name: `gebouw` also finds `Klokgebouw`.
  * Matches are ranked by quality: the exact name first, then names the query starts, then
    matches beginning at a word boundary, then mid-word matches. Ties within a rank go to
    the name covering the most addresses.
  * When the names containing the query leave suggestion slots free, close matches fill
    them below the exact matches, absorbing typos.


query

Maximum number of suggestions to return.
Must be between 1 and 1000 when provided; omitting the parameter uses the default page size.


limit

Sort mixed city and street suggestions by relevance (default) or distance.
Distance sorting requires the Infer Extended (`infer::location`) capability.
Distance sorting uses `lat` and `lng` when provided. Otherwise, it uses the
approximate location derived from the request IP. If that location is
unavailable, suggestions are sorted by relevance.


sort

Latitude of the origin used for distance sorting. When providing coordinates,
include both `lat` and `lng`.


Longitude of the origin used for distance sorting. When providing coordinates,
include both `lat` and `lng`.


Suggest possible Dutch addresses from a string.

Afleiden Nederland Parameters