1. Startpagina
  2. Ontwikkelaar API informatie
  3. Bereik FR

Bereik FR

Return French postal codes within range of a given postal code

Opmerking: Dit is de documentatie voor de v2 API die nog in beta is.

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

  • Either the postalCode or settlement is required

Verplichte parameters

    Optionele parameters

    • postalCode (string): The address's postal code which consists of five digits
    • settlement (string): The address's settlement (city, town, village, or hamlet)
    • searchRange (integer): The range to search, in meters. Maximum 100000.
    • maxResults (integer): The amount of results returned, a number between 0 and 999.
    • includeInitialPostalCode (boolean): 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.


    authKey: This is the Authorization key. You have to add it as a GET parameter. Your auth key can be found on the CMS.