Every request needs an API key, which you can get in the [portal](/portal).

When you call the API from a browser, visitors can see your API key. Limit it to your own domains in the [portal](/portal), or send the requests through your own server so the key stays hidden.


authKey

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

Returns the postal codes within a range of a postal code or settlement.

* `postalCode` or `settlement` is required. When both are supplied, `postalCode` is used.
* An ambiguous settlement returns HTTP 400.


postalCode

German postalCode

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


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 when nothing matches


A value has the wrong type, such as a non-integer `searchRange`.

A value is malformed or out of bounds, or the `postalCode` or `settlement` origin cannot be found.

Neither `postalCode` nor `settlement` is supplied.

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


The API key is missing, unknown, revoked or expired, its subscription is not active, the request does not match the key's allowlist, or the subscription does not include this call.

The request is not authorized; `error_id` names the reason.


Return German postal codes within range of a postal code or settlement.

Range Germany Step by step