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.

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


postalCode

French 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 `0` 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

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

Range France Parameters