Suggest FR

Suggest a French address.

Note: This is the documentation for the v2 API which is still in beta.

This will give autocomplete suggestions for French premises.

Only street is required but a call must contain at least one of the following parameters:

  • postalCode
  • settlement

Required parameters

  • street (string): The address's street name

Optional parameters

  • postalCode (string): The address's postal code which consists of five digits
  • settlement (string): The address's settlement (city, town, village, or hamlet)
  • streetNumber (string): The address's streetnumber
  • premise (string): The address's premise
  • maxResults (integer): The amount of results returned, a number between 0 and 999.
  • cursor (string): The page to return, the variables for the next/previous pages can be found in the results Link header.

Authorization

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