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.

Given a postcode or lat/lng combination and your own list of postcodes, returns the postcodes ordered from near to far.


An array of 4PPs (e.g: `["1000", "1011", "1012"]`).


targetPostalCodes

The 4PP(e.g: 1000), if both `postalCode` and lat/lng combination is given, the lat/lng from the `postalCode` will be used.


postalCode

Dutch fourppOrSixpp

latitude

longitude

The order in which to return the results: `distance` (default) or `input` (keeps the input ordering).


orderBy

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


maxResults

Specifies the algorithm for calculating distance and time.

Available Algorithms:
* `straight`: Calculates the distance in a straight line.
* `road`: Calculates the actual traveling distance and time using the drive time matrix (shortest route) over the actual road network.
    * Availability of `road` depends on your subscription level.
    * For trial purposes, this algorithm can be used with any subscription level for the following postcode ranges:
        * `1000-1098`, `1100-1108` (Amsterdam)
        * `3000-3089` (Rotterdam)
        * `5600-5658` (Eindhoven)


algorithm

A required field is missing or a value is invalid


Return near postcodes from a postcode or latitude/longitude combination.

Locator Netherlands Example code