Autocomplete a French address.
Note: This is the documentation for the v2 API which is still in beta.
In case you don't know all of the required parameters, you can use the suggest call to gather them first.
If the input identifies a unique address, all available information about said address is returned.
- To validate if an address has either a streetNumber or a Premise, query through the
- To validate if an address exists with a certain streetnumber, use the
- To validate if an address exists with a certain premise, use both the
streetNumberis required. If both are given, only
postalCode(string): The address's postal code which consists of five digits
settlement(string): The address's settlement (city, town, village, or hamlet)
street(string): The address's street name
streetNumberAndPremise(string): The address's streetnumber and premise (extension/addition)
streetNumber(string): The address's streetnumber
premise(string): The address's premise
authKey: This is the Authorization key. You have to add it as a GET parameter.
Your auth key can be found on the CMS.
Available API calls