France Address Geocoding (BAN)
Geocode a French address against the Base Adresse Nationale: matched label, score, house number, street, postcode, city, INSEE commune code, BAN id and coordinates.
GET
/api/v1/geo/france/geocodeData source
- Géoplateforme geocoding (Base Adresse Nationale)IGN and DINUM (Base Adresse Nationale)
Query parameters
| Parameter | Description | Try value |
|---|---|---|
qstring required | Address text | |
postcodestring | 5-digit postcode to narrow the search | |
typestring | housenumber, street, locality or municipality | |
limitnumber | Rows (default 5, max 20) | |
apikeystring required | Your API key. Can also be sent as the X-API-Key header. | demo key used here |
Response envelope
Success: { data, meta: { sources, fetchedAt, cached } }. Errors: { error: { code, message } } with HTTP 400, 401, 404, 502, 503 or 504.