{"info":{"name":"Service d'autocomplétion public de la Géoplateforme","title":"API Géoplateforme - Autocomplétion","description":"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.","language":"Français","contact":{"email":"geoplateforme@ign.fr"}},"api":{"name":"rest","version":"1.0.0"},"operations":[{"id":"completion","description":"fournit des suggestions d'objets géolocalisés pouvant correspondre à la chaine de caractères entrée par l'utilisateur.","url":"/completion?","methods":["GET"],"parameters":[{"name":"text","in":"query","description":"le texte devant être completé","required":true,"schema":{"type":"string","example":"10 ru"}},{"name":"terr","in":"query","description":"une limitation de la zone de recherche de localisants. Les valeurs acceptés sont METROPOLE, DOMTOM, code(s) INSEE de département, code(s) postaux de commune","required":false,"schema":{"type":"string","example":"75013"}},{"name":"poiType","in":"query","description":"filtre sur le localisant pour le type de POI","required":false,"schema":{"type":"string","example":"administratif"}},{"name":"lonlat","in":"query","description":"coordonnées (longitude, latitude) d'un localisant pour favoriser les candidats les plus proches","required":false,"schema":{"type":"custom","example":"2.347640,48.835187"}},{"name":"type","in":"query","description":"le type de localisant recherché, il est possible de spécifier plusieurs types séparés par une virgule","required":false,"default":["PositionOfInterest","StreetAddress"],"schema":{"type":"string","example":"PositionOfInterest"}},{"name":"maximumResponses","in":"query","description":"le nombre maximum de réponses que l'on souhaite voir retournées","required":false,"default":10,"schema":{"type":"integer","example":"6"}},{"name":"bbox","in":"query","description":"filtre avec une bbox suivant l'ordre xmin, ymin, xmax, ymax","required":false,"schema":{"type":"custom","example":"48.573569106948469,27.837770518544438,48.417446881093412,27.381161181879751"}},{"name":"depcode","in":"query","description":"filtre pour les index address et poi. Il permet de filtrer les résultats par code de département","required":false,"schema":{"type":"string","example":"94"}},{"name":"citycode","in":"query","description":"filtre pour les index address et poi. Il permet de filtrer les résultats par code INSEE","required":false,"schema":{"type":"string","example":"94067"}},{"name":"zipcode","in":"query","description":"filtre pour les index address et poi. Il permet de filtrer les résultats par code postal","required":false,"schema":{"type":"string","example":"94160"}}]}],"indexes":[{"id":"StreetAddress","description":"adresses postales","fields":[{"name":"country","description":"Le type du localisant proposé","type":"string","queryable":false,"filter":false,"values":["StreetAddress"]},{"name":"city","description":"Le nom de la commune","type":"string","queryable":false,"filter":false},{"name":"oldcity","description":"Nom de la commune ancienne absorbée (le cas échéant)","type":"string","queryable":false,"filter":false},{"name":"zipcode","description":"Code postal de l’adresse, de la voie ou de la commune","type":"string","queryable":false,"filter":true},{"name":"street","description":"Nom de la voie de l’adresse","type":"string","queryable":false,"filter":false},{"name":"classification","description":"Code classification de l’adresse. Vaudra toujours 7.","type":"integer","queryable":false,"filter":false},{"name":"kind","description":"Le Type","type":"string","queryable":false,"filter":false},{"name":"metropole","description":"L'adresse est-elle située en France métropolitaine ?","type":"boolean","queryable":false,"filter":true},{"name":"fulltext","description":"La proposition complète de localisant pour l’autocomplétion","type":"string","queryable":true,"filter":false},{"name":"importance","description":"Indicateur d’importance du localisant servant au calcul du score. Issu de la Base Adresse Nationale.","type":"float","queryable":false,"filter":false}]},{"id":"PositionOfInterest","description":"points d'intérêt","fields":[{"name":"poiType","description":"Le type du lieu","type":"string","queryable":false,"filter":true,"values":{"cimetière":[],"réservoir":["réservoir industriel","réservoir d'eau ou château d'eau au sol","château d'eau"],"administratif":["commune","epci","département","région","arrondissement municipal"],"construction":["pont isolé","construction linéaire","pont","barrage","passerelle","tremplin de ski","piste de luge","croix","construction ponctuelle","autre construction élevée","clocher","calvaire","construction surfacique","ecluse","zone d'activité ou d'intérêt","pont mobile","aqueduc","dalle","sport de montagne","viaduc","pont submersible","phare","cale","pont transbordeur","pont tournant","piste de bobsleigh"],"hydrographie":["cours d'eau","source","détail hydrographique","point d'eau","fontaine","marais","perte","source captée","baie","résurgence","lavoir","embouchure","retenue","plan d'eau","lac","ecoulement naturel","retenue-barrage","plan d'eau de gravière","mare","réservoir-bassin","réservoir-bassin piscicole","canal","réservoir-bassin d'orage","prise d'eau","glacier, névé","retenue-digue","inconnue","espace maritime","banc","feu","balise","lagune","ecoulement canalisé","estuaire","retenue-bassin portuaire","plan d'eau de mine","ravine"],"élément topographique ou forestier":["plaine","détail orographique","sommet","escarpement","rochers","gorge","ile","vallée","dépression","grotte","crête","col","montagne","cirque","gouffre","pic","plage","lieu-dit non habité","bois","arbre","cap","récif","volcan","dune","terril","pare-feu","isthme"],"transport":["télécabine, téléphérique","transport par câble","héliport","aérodrome","aire de repos ou de service","équipement de transport","parking","arrêt voyageurs","aire de triage","gare voyageurs uniquement","gare routière","gare voyageurs et fret","gare fret uniquement","port","station de métro","station de tramway","gare téléphérique","service dédié aux véhicules","aérogare","tapis roulant de stations de montagne","tyrolienne géante","câble transporteur","altiport","gare maritime","service dédié aux vélos"],"poste de transformation":[],"zone d'activité ou d'intérêt":["piscine","culte chrétien","usine","zone industrielle","déchèterie","enseignement primaire","collège","lycée","camping","parc de loisirs","musée","monument","poste","caserne de pompiers","gendarmerie","mairie","divers public ou administratif","maison de retraite","hébergement de loisirs","refuge","maison du parc","golf","stade","centre équestre","complexe sportif couvert","hôpital","etablissement hospitalier","culte musulman","tombeau","divers industriel","divers commercial","haras","enseignement supérieur","autre établissement d'enseignement","structure d'accueil pour personnes handicapées","ecomusée","mégalithe","sous-préfecture","police","préfecture","autre service déconcentré de l'etat","ouvrage militaire","hippodrome","culte israélite","marché","université","etablissement pénitentiaire","palais de justice","capitainerie","hôtel de département","etablissement thermal","parc zoologique","siège d'epci","maison forestière","equipement de cyclisme","parc des expositions","baignade surveillée","site d'escalade","site de vol libre","site skiable","divers agricole","caserne","culte divers","office de tourisme","administration centrale de l'etat","résidence autonomie","stand de tir","mine","sentier de découverte","patinoire","habitation troglodytique","etablissement extraterritorial","camp militaire non clos","hôtel de région","marais salant","préfecture de région","hôtel de collectivité"],"zone d'habitation":["lieu-dit habité","château","quartier","ruines","moulin","grange","habitat temporaire"]}},{"name":"classification","description":"La classification","type":"integer","queryable":false,"filter":false},{"name":"fulltext","description":"La dénomination complète (nom+code postal+nom commune)","type":"string","queryable":false,"filter":false},{"name":"city","description":"Le nom de la commune","type":"string","queryable":false,"filter":false},{"name":"zipcode","description":"Le code postal de la commune","type":"string","queryable":false,"filter":false},{"name":"zipcodes","description":"Les codes postaux des communes","type":"string","queryable":false,"filter":true},{"name":"street","description":"Le nom du POI","type":"string","queryable":false,"filter":false},{"name":"kind","description":"Le type du POI","type":"string","queryable":false,"filter":false},{"name":"country","description":"Le type du localisant proposé","type":"string","queryable":false,"filter":false,"values":["PositionOfInterest"]},{"name":"metropole","description":"Le POI se trouve-t-il en France métropolitaine ?","type":"boolean","queryable":false,"filter":true},{"name":"importance","description":"Le poids","type":"float","queryable":false,"filter":false},{"name":"names","description":"Les noms du POI","type":"string","queryable":false,"filter":false}]}]}