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.

This will return all postal codes within a range of a given postal code or city.

* Exactly one of `postalCode` or `settlement` is required


postalCode

Luxembourg postalCode

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


settlement

The range to search, in meters. Maximum `100000`.


searchRange

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


maxResults

Option whether to include the initial postal code in `/v2/range` calls. If the value is `True`, then the initial postal code is included in the search.


includeInitialPostalCode

Postcodes within range, or an empty array if no postcode is in range


The request is rejected; `error_id` names the reason:

* `MISSING_PARAMETER`: neither `postalCode` nor `settlement` is supplied.
* `INVALID_PARAMETER_TYPE`: a value has the wrong type, such as a non-integer `searchRange`.
* `INVALID_VALUE`: a value is malformed or out of bounds, or the `postalCode` or `settlement` origin cannot be found.
* `MULTIPLE_RESULTS_FOUND`: the `settlement` is ambiguous.
* `MULTIPLE_KEY_ERROR`: both `postalCode` and `settlement` are supplied.


Return Luxembourg postal codes within range of a given postal code.

Range Luxembourg Parameters