To use this API, you must utilize the service actions that best suit your use case.

Currently, the following actions are available:

• Search Address
• Reverse Search By Coordinates
• Search By Type
• Search Ordered By Coordinates

Almost every input is mandatory, with the exception of the limit input (default is 5) and postal code (default is empty).

Please note that if you need to make more than 50 requests per second per IP, some configurations may be required. Detailed information can be found here.

The GeoJSON coordinates are expressed in WGS-84 (EPSG 4326).

The attributes returned are:

• id  : address identifier (interoperability key)
• type  : type of result found
  • housenumber  : number “on the plate”
  • street  : “on the lane” position, placed approximately in the center of it
  • locality : lieu-dit
  • municipality  : number “to the municipality”
• score  : value from 0 to 1 indicating the relevance of the result
• housenumber  : number with possible repetition index (bis, ter, A, B)
• street  : name of the road
• name  : possible number and name of road or place called
• postcode : code postal
• citycode  : INSEE code of the municipality
• city  : name of the municipality
• district  : name of the district (Paris/Lyon/Marseille)
• oldcitycode  : INSEE code of the old municipality (if applicable)
• oldcity  : name of the old municipality (if applicable)
• context  : department number, department and region name
• label  : full wording of the address
• x : geographic coordinates in legal projection
• y : geographic coordinates in legal projection
• importance : importance indicator (technical field)