Documentation
ENDPOINT
https://api.addrs.fr/v1
DESCRIPTION
API endpoint for version 1
GET
/address/get?id={id}
QUERY
- {id} : address id
DESCRIPTION
returns address details
RESPONSE
JSON object
- id : address id
- name : address fullname
- lon : longitude
- lat : latitude
- parts :
- number : address number
- rep : repetition index (bis, ter, ...)
- street : street name
- postcode : postal code
- city : city name
GET
/address/search?q={query}
QUERY
- {query} : text to search for
DESCRIPTION
returns a list of addresses that best match {query}
RESPONSE
JSON array of addresses, sorted by score first and then by distance
- score : score for this address, the closest the address is to the query the highest the score
- dist : levenshtein distance for this address, the closest the address is to the query the lowest the distance
- name : address fullname
- id : address id
- lon : longitude
- lat : latitude
- parts :
- number : address number
- rep : repetition index (bis, ter, ...)
- street : street name
- postcode : postal code
- city : city name