documentation

Le service d’autocomplétion a pour but de suggérer des localisants probables au fur et à mesure de la saisie d’adresses ou de noms de lieux.

Les données de référence utilisées au sein du service d’autocomplétion proviennent de la base de données IGN BD ADRESSE® pour les suggestions d’adresses, du thème toponymes de la base de données IGN BD TOPO® pour les suggestions de noms de lieux.

Le service d’autocomplétion est accessible à l’adresse suivante :

https://wxs.ign.fr/CLEF/ols/apis/completion?

Le paramètre CLEF doit être remplacé par l'une des clés partagées du type "essentiels" ou "calcul" disponible dans notre onglet service web.

Les requêtes sont des requêtes HTTP / GET. Elles peuvent comprendre les paramètres suivants :

• text : une chaine de caractères à compléter
• terr : une limitation de la zone de recherche de localisants correspondant à :
  • "METROPOLE" pour une recherche sur la métropole et la corse
  • "DOMTOM" pour une recherche sur les DROM-COM uniquement
  • une liste de codes de départements pour une recherche limitée à ces départements spécifiés
• type : le type de localisants recherchés :
  • "PositionOfInterest" pour une recherche parmi les noms de lieux
  • "StreetAddress" pour une recherche parmi des adresses ou les deux valeurs séparées par une virgule pour une recherche parmi les deux types de localisants
• maximumResponses : le nombre maximum de réponses que l’on souhaite voir retournées.

Exemple de requête:

Autocomplétion par adresse :

https://wxs.ign.fr/essentiels/ols/apis/completion?text=2%2C%20avenue%20pasteur%20saint%20m&type=StreetAddress&maximumResponses=5

La réponse du service est, en cas de succès, au format JSON :

{"status":"OK",
 "results":[{"country":"StreetAddress",
             "city":"Saint-Malo",
             "x":-2.004141,
             "y":48.655722,
             "zipcode":"35400",
             "street":"2 av pasteur",
             "classification":7,
             "kind":"",
             "fulltext":"2 av pasteur,35400 Saint-Malo"},
             ...
           ]
}

où :

• status : indique le statut de la réponse : "OK" s’il y a des résultats ; "ERROR" s’il n’y en a pas
• results : est un tableau contenant les résultats retournés, avec pour chacun, les champs suivants :
  • country : le type du localisant proposé ("PositionOfInterest" ou "StreetAddress")
  • city : forme décomposée de la proposition, ville
  • x,y : coordonnées du localisant (en longitude, latitude)
  • zipcode : forme décomposée de la proposition : code postal
  • street : forme décomposée de la proposition, rue ou toponyme
  • classification : classification
  • kind : type
  • fulltext : la proposition complète de localisant pour l’autocomplétion

En cas d’erreur du service (code HTTP différent de 200), la réponse est au format JSON. Par exemple :

{"status":"ERROR","results":[]}

NB : les suggestions retournées sont associées à des coordonnées géographiques. Le service d’autocomplétion peut aussi être utilisé pour faire du Géocodage. Cependant, il est moins performant en terme de pertinence des résultats que le service de Géocodage du Géoportail.