Aller au contenu
Documentation de la Plateforme

Normaliser une adresse en texte libre

GET
/v1/adresses
curl --request GET \
  --url 'https://donnees-publiques.api.example.internal/v1/adresses?q=example&limite=20' \
  --header 'Authorization: Bearer <token>'

DES CANDIDATS ORDONNÉS PAR SCORE, jamais une décision : le score dit la qualité de l’appariement, il ne choisit pas. Retenir un candidat, et ce qu’on en retient, appartient au consommateur.

Autorisations

Section intitulée « Autorisations »

Paramètres

Section intitulée « Paramètres »

Paramètres (query)

Section intitulée « Paramètres (query) »
q
required
string
>= 3 characters <= 300 characters

L’adresse recherchée, en texte libre.

codePostal
string
/^[0-9]{5}$/

Restreint la recherche à un code postal.

codeCommune
string
/^[0-9AB]{5}$/

Restreint la recherche à un code commune Insee.

limite
integer
default: 20 >= 1 <= 100

Réponses

Section intitulée « Réponses »

200

Section intitulée « 200 »

Les candidats, du meilleur score au moins bon, avec leur provenance.

Media typeapplication/json
object
provenance
required

Les contreparties de la Licence Ouverte 2.0, portées par chaque réponse : la source est nommée, l’adresse du concédant est donnée, la date de dernière mise à jour est dite, et la réutilisation n’est ni officielle ni cautionnée par le producteur.

object
jeu
required
string
Allowed values: SIRENE BAN
producteur
required

Le producteur du jeu, tel qu’il se nomme — « Insee » pour Sirene ; pour la BAN, le partenariat qui la produit (Ministère de la Transition écologique, IGN, ANCT). Une mention de source inexacte est un manquement à la licence.

string
urlDuConcedant
required

L’adresse du concédant, que l’attribution due par la Licence Ouverte réclame au même titre que la source et la date de dernière mise à jour.

string format: uri
licence
required
string
Allowed value: Licence Ouverte 2.0
dateDeFraicheur
required

La date du dernier chargement réussi du jeu servi.

string format: date-time
candidats
required
Array<object>

Un candidat de la Base Adresse Nationale, avec son score d’appariement.

object
libelle
required

L’adresse complète normalisée, en une ligne.

string
score
required

Qualité de l’appariement — un score, pas une décision.

number
<= 1
numeroDeVoie

ISO 20022 BuildingNumber (BldgNb) — numéro et indice de répétition réunis.

string
nomDeVoie

ISO 20022 StreetName (StrtNm) — nom de la voie, ou du lieu-dit. ABSENT pour les adresses que le producteur publie sans voie.

string
codePostal

ISO 20022 PostCode (PstCd). ABSENT pour les adresses que le producteur publie sans code postal.

string
/^[0-9]{5}$/
nomDeVille
required

ISO 20022 TownName (TwnNm) — la commune.

string
pays
required

ISO 20022 Country (Ctry) — toujours FR : la BAN ne couvre que la France.

string
/^[A-Z]{2}$/
codeCommune
required

Code commune Insee — hors ISO 20022, servi pour identifier la commune.

string
/^[0-9AB]{5}$/
position

Position géographique, WGS 84.

object
longitude
required
number
latitude
required
number
Example
{
  "provenance": {
    "jeu": "SIRENE",
    "licence": "Licence Ouverte 2.0"
  }
}

401

Section intitulée « 401 »

Jeton absent, invalide ou expiré.

Media typeapplication/problem+json

Erreur au format « problème » (RFC 9457).

object
type
string format: uri-reference
title
required
string
status
required
integer
detail
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}

403

Section intitulée « 403 »

Jeton valide, permission refusée par le PEP.

Media typeapplication/problem+json

Erreur au format « problème » (RFC 9457).

object
type
string format: uri-reference
title
required
string
status
required
integer
detail
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}

default

Section intitulée « default »

Toute autre erreur, au format problème.

Media typeapplication/problem+json

Erreur au format « problème » (RFC 9457).

object
type
string format: uri-reference
title
required
string
status
required
integer
detail
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}