Documentation API de consultation BAN - BaseAdresseNationale/ban-plateforme GitHub Wiki

Description des routes disponibles

L'Api de consultation BAN est pour l'instant utilisée en interne.

Les routes sont accessibles avec la même url de base https://plateforme.adresse.data.gouv.fr

• /tiles/ban/{z}/{x}/{y}.pbf
• /ban/stats
• /lookup/{id}
• /api/communes-summary
• /api/communes-summary.csv
• /ban/communes/{codeCommune}/download/csv-legacy/adresses
• /ban/communes/{codeCommune}/download/csv-legacy/lieux-dits

/tiles/ban/{z}/{x}/{y}.pbf

retourne la tuile au format PBF permettant l'affichage des données

/ban/stats

Retourne des statistiques sur la BAN

Exemple de réponse avec code 200 :

{
  "france": {
    "population": 66184087,
    "nbCommunes": 35106
  },
  "ban": {
    "nbAdresses": 25630703,
    "nbAdressesCertifiees": 2705399,
    "nbCommunesCouvertes": 34545,
    "populationCouverte": 66065585
  },
  "bal": {
    "nbAdresses": 6095851,
    "nbAdressesCertifiees": 2064264,
    "nbCommunesCouvertes": 5192,
    "populationCouverte": 21492132
  }
}

/lookup/{id}

Permet d'obtenir des informations sur un objet de la BAN

type d'objet	format id	exemple
Commune	5 caractères	59450
Voie	10 ou 12 caractères	54084_0200
Numéro	>= 16 caractères	54084_0200_00001

/api/communes-summary

Présente l'état de la Base Adresse Nationale pour chaque commune. Il est produit en temps réel à partir de la plateforme BAN.

Liste des champs présents

Champ	Signification
region (string)	code INSEE de la région
departement (string)	code INSEE du département
code_commune (string)	code INSEE de la commune
nom_commune (string)	nom de la commune
population (integer)	population légale de la commune (population municipale, si connue)
type_composition (string)	mode de construction des adresses de la commune (bal pour Base Adresse Locale, assemblage pour assemblage multi-sources)
nb_lieux_dits (integer)	nombre de lieux-dits répertoriés pour la commune
nb_voies (integer)	nombre de voies répertoriées pour la commune
nb_numeros (integer)	nombre de numéros répertoriés pour la commune
nb_numeros_certifies (integer)	nombre de numéros répertoriés pour la commune pour lesquels l’adresse est certifiée par la commune
analyse_adressage_nb_adresses_attendues (integer)	estimation du nombre d'adresses que devrait comporter la commune
analyse_adressage_ratio (integer)	ratio du nombre d'adresses répertoriées sur estimation du nombre d'adresses attendues, multiplié par 100
analyse_adressage_deficit_adresses (boolean)	indique si la commune est en déficit d'adresses (population < 2000 et ratio < 50

Analyse de l'adressage

L'analyse de l'adressage est là pour aider les chefs de file territoriaux et les acteurs nationaux à identifier les communes les plus "en retard" en terme d'adressage. Il s'agit d'estimations basées sur le jeu de données du Nombre de locaux adressables par commune. Cette approximation n'est pertinente que pour les petites communes essentiellement résidentielles et pavillonnaires.

Note : ces fichiers sont mis à disposition sur data.gouv https://www.data.gouv.fr/datasets/etat-de-la-base-adresse-nationale-par-commune

/ban/communes/{codeCommune}/download/csv-legacy/adresses

Renvoie les adresses de la commune en CSV au format BAN historique

/ban/communes/{codeCommune}/download/csv-legacy/lieux-dits

Renvoie les lieux-dits de la commune en CSV au format BAN historique