LogoLogo
✉️ Contact💬 Forum
Guides de data.gouv.fr
Guides de data.gouv.fr
  • Bienvenue
  • ❓Foire aux questions
  • Documentation de data.gouv.fr
    • Créer un compte utilisateur et rejoindre une organisation
    • Organisation
      • Créer une organisation
      • Suivre l'activité et modifier son organisation
      • Gérer les membres de son organisation
      • Certifier une organisation
      • Supprimer une organisation
    • Jeux de données
      • Publier un jeu de données
        • Publier une Base Adresse Locale
      • Gérer un jeu de données
      • Explorer un jeu de donnée
      • Télécharger le catalogue de données de data.gouv.fr
      • Accéder au catalogue via SPARQL
    • API
      • Publier une API
      • Gérer une API
      • Outils pour les administrations
        • Doctrine des API
        • Accompagnement humain
        • Datapass : Outil d'habilitations
        • Bouquets API Entreprise et API Particulier
    • Réutilisations
      • Publier une réutilisation
      • Gérer une réutilisation
    • Statistiques
    • Ressource communautaire
    • Moissonnage
      • Comprendre les limites du moissonnage
      • Les différents types de moissonneurs
      • Mettre en place un moissonneur
      • Analyser le rapport de moissonnage
      • Moissonnage des plateformes géographiques
    • API de data.gouv.fr
      • Prise en main de l'API
      • Tutoriel d'utilisation
      • Gérer un jeu de données par l'API
      • Référence
        • site
        • datasets
        • reuses
        • discussions
        • organizations
        • spatial
        • users
        • me
        • contacts
        • workers
        • tags
        • topics
        • posts
        • transfer
        • notifications
        • avatars
        • harvest
  • Guides open data
    • Guide juridique
      • Producteurs de données
        • Comprendre la notion d'open data
        • Qui est concerné ?
        • Quelles sont les obligations ?
      • Réutilisateurs de données
        • Respecter les conditions de réutilisation
      • Chronologie de l'open data
    • Guide qualité
      • Evaluer le niveau de qualité d'un jeu de données
      • Préparer un jeu de données de qualité
        • Extraire un jeu de données d'un système d'information
        • Structurer un jeu de données
          • Structurer une Base Adresse Locale
        • Lier des données à un référentiel
      • Documenter des données
        • Bien documenter un jeu de données
        • Diffuser la documentation d'un jeu de données
      • Améliorer la qualité d'un jeu de données en continu
        • Améliorer le score de qualité des métadonnées
        • Connaître et suivre les usages d'un jeu de données
        • Mettre en place une stratégie organisationnelle
      • Maîtriser les schémas de données
        • Comprendre les bénéfices d'utiliser un schéma de données
        • Créer un schéma de données
          • Etape 1 : Phase d'investigation
          • Etape 2 : Phase de concertation
          • Etape 3 : Phase de construction
          • Etape 4 : Phase de promotion et de maintien
          • Focus : Construire un schéma TableSchema
        • Intégrer un schéma de données à schema.data.gouv.fr
        • Produire des données en conformité avec un schéma
        • Indiquer et vérifier qu'une ressource respecte un schéma de données
  • Guides sur l'utilisation des données
    • Introduction à l'open data
      • Comprendre la notion d'open data
      • Comprendre l'écosystème de l'open data
      • Comprendre les conditions d'utilisation des données en open data
      • Découvrir et utiliser data.gouv.fr
    • Guide traitement et analyse de données
      • Trouver des données
      • Prendre connaissance et évaluer la qualité de données
      • Explorer des données
      • Récupérer des données
      • Manipuler des données
        • Ouvrir des données
        • Filtrer des données
        • Nettoyer des données
        • Croiser des données
        • Géocoder des adresses
      • Analyser des données
        • Analyser des données avec le tableur LibreOffice Calc
        • Analyser des données avec Python
        • Analyser des données avec R
      • Visualiser des données
      • Cartographier des données
      • Réaliser des projets utiles et s'inspirer
      • Poser des questions aux producteurs de données
      • Valoriser ses travaux
      • Autres ressources pédagogiques
    • Guide API géographiques
      • Utiliser l'API Adresse
        • Rappel sur les données adresses
        • Géocoder des adresses - théorie
        • Géocoder des adresses - cas pratiques
        • FAQ Adresse
      • Utiliser l'API Découpage administratif
      • Utiliser les tuiles vectorielles
    • Guide données du cadastre
      • Comprendre les données du cadastre et leurs usages
      • Manipuler les données du cadastre
      • Foire aux questions sur le cadastre
    • Guide données météorologiques
    • Guide API "Adresse" de l'IGN
  • Autres ressources utiles
    • Lexique de l'open data
    • Données de la commande publique
      • Publier les données essentielles d’attribution des marchés
      • Déclaration d’un profil d’acheteur
    • Données de forte valeur : métadonnées obligatoires et modalités de rapportage
    • Ressources OpenDataFrance
    • Documentation de transport.data.gouv.fr
    • Les algorithmes publics : pourquoi et comment les expliquer ?
      • Les algorithmes publics : enjeux et obligations
      • Fiche pratique : l'obligation de mention explicite
      • Fiche pratique : l'inventaire des principaux traitements algorithmiques
      • Liste de ressources
    • Codes sources du secteur public : lesquels ouvrir, pourquoi et comment ?
      • Ce document n'est pas...
      • Cadre juridique
    • Catalogage de données - GRIST
    • 📒Guide du participant au Hackathon Météo
      • Ressources du hackathon
        • Données
        • Prise en main des données
        • Outils
        • Programme
        • Informations pratiques
        • Contacts
      • Avant le hackathon
      • Pendant le hackathon : règles et bonnes pratiques
        • Choix du défi
        • Constitution des équipes
        • Sollicitation des mentors
        • Documentation des réalisations
        • Rendu intermédiaire
        • Soumission du projet
        • Evaluation des projets
      • Après le hackathon
        • Evaluation du hackathon
        • Valorisation de votre projet
Propulsé par GitBook
Sur cette page
  • Transfert de l’API “Adresse” de la Base Adresse Nationale, de la DINUM à l’IGN
  • Modalités d’évaluation de l’API “Adresse” portée par l’IGN
  • Documentation
  • Gouvernance
  • Migration
  • Performance de l’API
  • Utilisation de l’API “Adresse” portée par l’IGN et les différences avec l’API “Adresse” portée par la DINUM
  • Spécifique à la recherche de POIs
  • Spécifique à la recherche de parcelles
  • Autres remarques

Cet article vous a-t-il été utile ?

Modifier sur GitHub
Exporter en PDF
  1. Guides sur l'utilisation des données

Guide API "Adresse" de l'IGN

PrécédentGuide données météorologiquesSuivantAutres ressources utiles

Dernière mise à jour il y a 9 mois

Cet article vous a-t-il été utile ?

Ce guide a vocation à accompagner les utilisateurs de l'API "Adresse", dans le cadre de son transfert de la DINUM à l'IGN.

Il présente :

  • ;

  • ;

  • .

Transfert de l’API “Adresse” de la Base Adresse Nationale, de la DINUM à l’IGN

La Base Adresse Nationale (BAN) est la base de données ouverte d’adresses officiellement reconnues par l’administration. Elle figure parmi les 9 données de référence du .

Elle est disponible en téléchargement et via une API () sur :

L’API “Adresse” adossée à la BAN était initialement opérée par la Direction interministérielle du numérique (DINUM).

Elle a entamé en décembre 2023 sa transition pour être dorénavant gérée par l’Institut de l’information géographique et forestière (IGN) au sein de la Géoplateforme. Elle rejoint ainsi les API géographiques de l’IGN. Ce transfert garantit l’intégration de nouvelles fonctionnalités telles que la recherche par points d’intérêt (POI) et selon les parcelles cadastrales.

Ce nouveau portage s’inscrit dans le cadre du transfert de la BAN initié en mars 2022, de la DINUM à l’IGN.

Geoplateforme : Espace public de l’information géographique visant à optimiser la production et la diffusion des géodatas au service de la décision publique.

Une période minimum de transition est mise en place pendant les 6 premiers mois de l’année 2024, au cours de laquelle “l’API DINUM” et “l’API IGN” coexisteront. A partir du début 2024, l’IGN sera le point de contact principal pour les questions relatives à l’API “Adresse”.

Modalités d’évaluation de l’API “Adresse” portée par l’IGN

Dans le cadre du transfert, les performances de l’API « Adresse » gérée par l’IGN seront évaluées par la DINUM 3 mois après la mise en production : le service doit être iso-fonctionnel avec l’API “Adresse” de la DINUM.

Si cet audit s’avère satisfaisant, l’API BAN de la DINUM sera décommissionnée mi-2024.

L’évaluation sera réalisée selon le protocole suivant :

Documentation

  • Documentation claire sur les réglages effectués sur Addok (joue sur le ranking et le scoring)

Actuellement on a addok.conf qui contient

ATTRIBUTION = "BAN"
LICENCE = "ETALAB-2.0"
EXTRA_FIELDS = [
    {"key": "citycode"},
    {"key": "oldcitycode"},
    {"key": "oldcity"},
    {"key": "district"},
]
FILTERS = ["type", "citycode", "postcode"]
QUERY_PROCESSORS_PYPATHS = [
    "addok.helpers.text.check_query_length",
    "addok_france.extract_address",
    "addok_france.clean_query",
    "addok_france.remove_leading_zeros",
]
SEARCH_RESULT_PROCESSORS_PYPATHS = [
    "addok.helpers.results.match_housenumber",
    "addok_france.make_labels",
    "addok.helpers.results.score_by_importance",
    "addok.helpers.results.score_by_autocomplete_distance",
    "addok.helpers.results.score_by_ngram_distance",
    "addok.helpers.results.score_by_geo_distance",
]
PROCESSORS_PYPATHS = [
    "addok.helpers.text.tokenize",
    "addok.helpers.text.normalize",
    "addok_france.glue_ordinal",
    "addok_france.fold_ordinal",
    "addok_france.flag_housenumber",
    "addok.helpers.text.synonymize",
    "addok_fr.phonemicize",
]
SQLITE_DB_PATH = '/home/debian/addok-data/addok.db'

Gouvernance

  • Maintenance du code et des dépendances de l’API (pérennité) : quelle réactivité suite aux sollicitations de la communauté ?

  • Organisation mise en place

  • Gestion des droits spéciaux : comment sont gérés les droits des tiers de confiance dont on lève la limitation de consommation

  • Evaluation du coût d’hébergement de l’API

  • Vérification que la fréquence de mise à jour des données et sources soit a minima hebdomadaire

Migration

  • Evaluation des modifications des payloads de l’API actuelle pour assurer la continuité de service

  • Routes disponibles :

    • Adresse unitaire

    • Geocoding CSV

  • Evaluation du parsing CSV (actuellement, l’API BAN effectue un pré-traitement de données avant appel à Addok)

  • Suivi de la migration des gros acteurs publics (ANTS, Ameli, Pôle Emploi, etc.)

Performance de l’API

  • Evaluation de la tenue de la charge de l’API : doit pouvoir atteindre plusieurs centaines de millions d’appels par mois

  • Temps de réponse moyen d’un appel unitaire inférieur à 100ms

  • Nombre, durée des incidents, temps de rétablissement et/ou redéploiement du fait de la criticité de l’API

Utilisation de l’API “Adresse” portée par l’IGN et les différences avec l’API “Adresse” portée par la DINUM

L’API “Adresse” portée par l’IGN est rétrocompatible/iso-fonctionnelle avec celle jusqu’alors portée par la DINUM pour la recherche via les points d’entrée /search/ et /reverse/ qui se font en GET.

La fonction géocodage CSV fortement utilisée n’est pas implémentée et reste un point majeur pour la rétrocompatibilité avec les fonctionnalités existantes.

Des fonctionnalités ont été rajoutées mais elles ne concernent pas la recherche d’adresse à l’exception très limitée de rechercher par nom de commune avec l’option city qui fonctionne sur les address et les poi.

Elle supporte les options historiques :

  • limit

  • autocomplete

  • lat et lon

  • type

  • postcode

  • citycode

Il est possible de rechercher des POIs ou des parcelles en passant par l’option index. On peut combiner les options que sont parcel, poi et address.

Les options postcode et citycode fonctionnent aussi avec l’index des poi et pas seulement avec les address.

Spécifique à la recherche de POIs

Spécifique à la recherche de parcelles

  • departmentcode

  • municipalitycode

  • oldmunicipalitycode

  • districtcode

  • section

  • number

  • sheet

Autres remarques

Il existe une option returntruegeometry assez intéressante mais encore plutôt inconsistante (elle est sérialisée ou pas selon le type d’index)

  • Pour les parcelles : elle présente l’avantage de retourner la géométrie polygonale. Attention, cette géométrie est une propriété dans le GeoJSON retourné. La géométrie reste un point par ailleurs.

  • Pour les POIs : on retourne la chaine échappée de la géométrie polygonale et comme pour les parcelles, le GeoJSON reste de type point.

  • Pour les adresses : l’intérêt est limité, on retourne la chaine échappée de la géométrie ponctuelle qui est déjà dans le GeoJSON retourné.

Code publié en open source

Documentation détaillée de l’architecture pour la possibilité d’un déploiement iso par un tiers

Nom de domaine de l’API simple à utiliser « »:

Nous vous invitons donc à consulter la documentation “” des guides de .

category: Il faut passer par les options relatives à category dans le getCapabilities disponible sur pour connaître les possibilités de filtre.

Exemple :

Exemple :

Le transfert de l'API "Adresse" de la Base Adresse Nationale, de la DINUM à l'IGN
Les modalités d’évaluation de l’API “Adresse” portée par l’IGN
Comment utiliser l'API "Adresse" portée par l'IGN et les différences avec l'API "Adresse" portée par la DINUM
service public de la donnée
licence ouverte Etalab 2.0
adresse.data.gouv.fr
www.data.gouv.fr/fr/datasets/base-adresse-nationale
https://gitlab.gpf-tech.ign.fr/geoplateforme/geocodage/geocodeur/
https://gitlab.gpf-tech.ign.fr/geoplateforme/geocodage/geocodeur/-/blob/main/docs/user/installation.md
sous-domaine.domaine.ign.fr
Utiliser l’API Adresse
data.gouv.fr
https://data.geopf.fr/geocodage/getCapabilities
https://data.geopf.fr/geocodage/search?index=poi&q=nantes&category=administratif&returntruegeometry=true
https://data.geopf.fr/geocodage/search?index=parcel&departmentcode=44&municipalitycode=109&section=EX&number=8&returntruegeometry=true