Géoplateforme API - AutocompletionAPI Géoplateforme - Autocomplétion
API Géoplateforme - AutocomplétionGéoplateforme API - Autocompletion
This API from the Institut national de l'information géographique et forestière (IGN) provides address and place-name autocompletion, suggesting likely locations as a user types. It relies on the BAN (Base Adresse Nationale), BD TOPO, and Parcellaire Express datasets to generate suggestions covering France. Access is free without authentication, but usage is limited to 10 requests per second per IP address. It is intended for integration into search fields and geolocation tools requiring quick, incremental place or address matching.L'API d'autocomplétion de la Géoplateforme a pour but de suggérer des localisants probables, au fur et à mesure de la saisie d’adresses ou de noms de lieux. Son usage est limité à 10 requêtes par seconde depuis une même adresse IP. Elle s'appuie sur des données BAN, BD TOPO® et Parcellaire Expres…
Trust score
How is this computed?Weighted across five axes. Tap a ring for what it measures.
Data schema (26 fields)
| Field | Type | Description |
|---|---|---|
| text | string | Text string to autocomplete.Le texte devant être completé |
| terr | string | Restricts search to a territory: METROPOLE, DOMTOM, or department/postal codes.Une limitation de la zone de recherche de localisants. Une liste peut être fournie en séparant les valeurs par des virgules. Les valeurs acceptées sont METROPOLE, DOMTOM, code(s) INSEE de département, code(s) postaux de commune. |
| poiTypePoi type | string | Filters results by POI type, as listed in getCapabilities.Filtre sur le type de localisant pour le type POI. Les valeurs possibles sont listées dans le getCapabilities du service d'autocompletion. |
| depcode | string | Filters address/POI results by department code(s), comma-separated, max 10.Filtre pour les index address et poi. Il permet de filtrer les résultats par code départmeent. Accepte plusieurs valeurs séparées par des virgules (maximum 10). |
| zipcode | string | Filters address/POI results by postal code(s), comma-separated, max 50.Filtre pour les index address et poi. Il permet de filtrer les résultats par code postal. Accepte plusieurs valeurs séparées par des virgules (maximum 50). |
| citycode | string | Filters address/POI results by INSEE code(s), comma-separated, max 200.Filtre pour les index address et poi. Il permet de filtrer les résultats par code INSEE. Accepte plusieurs valeurs séparées par des virgules (maximum 200). |
| lonlat | string | Reference coordinates (longitude,latitude) to prioritize nearby results.coordonnées (longitude,latitude) d'un localisant pour favoriser les candidats les plus proches. |
| type | string | Type(s) of locations sought, comma-separated if multiple.Le type de localisants recherchés. Il est possible de spécifier plusieurs types séparés par une virgule. |
| maximumResponsesMaximum responses | integer | Maximum number of results to return, between 1 and 15.Le nombre maximum de réponses que l’on souhaite voir retournées (entre 1 et 15) |
| bbox | string | Bounding box filter in order xmin,ymin,xmax,ymax.Filtre avec une bbox suivant l'ordre xmin,ymin,xmax,ymax |
| infoGetcapabilities | object | General information section of the service capabilities.General information section of the service capabilities. |
| apiGetcapabilities | object | API metadata section of the service capabilities.API metadata section of the service capabilities. |
| operationsGetcapabilities | array<object> | List of operations supported by the autocompletion service.List of operations supported by the autocompletion service. |
| indexesGetcapabilities | array<object> | List of data indexes available for autocompletion queries.List of data indexes available for autocompletion queries. |
| countryAddress | string | Country of the matched address.Country of the matched address. |
| cityAddress | string | City name of the matched address.City name of the matched address. |
| xAddress | number (float) | X coordinate (longitude) of the matched location.X coordinate (longitude) of the matched location. |
| yAddress | number (float) | Y coordinate (latitude) of the matched location.Y coordinate (latitude) of the matched location. |
| streetAddress | string | Street name of the matched address.Street name of the matched address. |
| classificationAddress | integer (int32) | Numeric classification code assigned to the address result.Numeric classification code assigned to the address result. |
| kindAddress | string | Kind or category of the matched address.Kind or category of the matched address. |
| fulltextAddress | string | Full text representation of the matched address.Full text representation of the matched address. |
| metropoleAddress | boolean | Indicates whether the address is in metropolitan France.Indicates whether the address is in metropolitan France. |
| zipcodesPoi | array<string> | List of postal codes associated with the point of interest.List of postal codes associated with the point of interest. |
| statusResponse | string | Status of the API response.Status of the API response. |
| resultsResponse | array<unknown> | List of matching results returned by the query.List of matching results returned by the query. |
Schema captured from openapi 1 month ago.
Verification Status
Using the API
Configuration
- Format
- openapi
License
- ✓ Redistributable
- ✓ Attribution required
Query examples
curl -s 'https://data.geopf.fr/geocodage/completion/openapi.yaml' -H 'Accept: application/json'Machine-readable API description (use it to generate clients).
Machine-readable & source
Embed this badge in a README or wiki — it always shows the latest verification state and quality tier.