Aller au contenu
Edifiable

L'API

Les mêmes faits que les pages, en JSON. Sans clé, sans quota, sans compte : la matière est publiée sous Licence Ouverte, et la faire payer reviendrait à revendre ce que l'État donne. Les chemins et les noms de champs sont en anglais ; les valeurs du document restent telles quelles, en français.

Les quatre adresses

Le contrat OpenAPI 3.1, généré depuis le code qui sert ces adresses : https://edifiable.fr/api/openapi.json. Chaque réponse porte un en-tête Link vers ce contrat et vers cette page.

Ce qu'une réponse porte

La promesse

Les refus

Tout refus est un application/problem+json (RFC 9457), sans enveloppe et no-store. Son champ type est l'une des ancres ci-dessous ; instance porte le chemin demandé, et received ce qui a été lu quand cela aide à corriger.

invalid-insee-code 400
le code INSEE ne fait pas cinq caractères (2A et 2B en Corse). Un code postal n'est pas un code INSEE.
municipality-not-found 404
aucune commune ne porte ce code. Les codes changent au 1er janvier quand des communes fusionnent.
zone-not-found 404
aucun article n'est lu pour cette zone. Le refus énumère les zones lues de la commune.
invalid-street 400
le nom de voie fait moins de deux caractères.
street-not-found 404
aucune voie de ce nom dans la commune à la Base Adresse Nationale.
method-not-allowed 405
la méthode n'est ni GET, ni HEAD, ni OPTIONS. La réponse porte `Allow`.
not-found 404
rien n'est servi à cette adresse sous /api/.

Les autres formes des mêmes faits

Citer

Les données viennent du Géoportail de l'urbanisme, du Code officiel géographique, de Géorisques et de la Base Adresse Nationale, sous Licence Ouverte 2.0 (Etalab) : la réutilisation est libre, en citant la source. Le champ source de chaque réponse porte la phrase à recopier.