Adresse et DPE

17 opérations servies.

/

Résoudre une adresse ou un point

GET/api/v1/adresses/recherche

GET/api/v1/adresses/inverse

Géocodage par la Base Adresse Nationale d'une adresse en texte (avec son code postal pour départager) ou d'un point (géocodage inverse, du plus proche au plus lointain). Chaque candidat porte sa clé BAN, son numéro, sa voie, sa commune et son ancienne commune, sa position, son score ou sa distance, et pour un numéro le type de position, les parcelles cadastrales et la certification lus dans la copie de la BAN de Pillr. La clé BAN d'un numéro sert aux autres opérations du domaine.

Coût: 0 crédit par appel réussi
Accès: À l'usage ou avec l'abonnement Data
Portée: adresse
Outil MCP: resoudre_adresse
Bac à sable: Oui, sans débit, sur un jeu figé
Mémoire: 24 h
Délai: 8 s

Essayer en direct

Paramètres de /api/v1/adresses/recherche

qtexte
Adresse en texte (recherche).
de 3 à 200 caractères
code_postaltexte
Code postal, pour départager une adresse homonyme (avec q).
limiteentier
Nombre de candidats rendus.
de 1 à 10 ; par défaut 5

Paramètres de /api/v1/adresses/inverse

latnombreobligatoire
Latitude en degrés décimaux (WGS 84).
de -90 à 90
lonnombreobligatoire
Longitude en degrés décimaux (WGS 84).
de -180 à 180

Exemple d'appel

curl https://pillr.fr/api/v1/adresses/recherche \
  -H "Authorization: Bearer $PILLR_CLE"

Réponse

modetexte
Valeurs : recherche, inverse
candidatsliste d'objets
Afficher les 17 champsMasquer
- cle_bantexte ou null
  Clé BAN du candidat : celle d'un numéro (adresse servie par les autres opérations), d'une voie ou d'un lieu-dit.
- libelletexte
- typetexte
  Ce que désigne le candidat : un numéro, une voie, un lieu-dit ou une commune.
  Valeurs : numero, voie, lieu_dit, commune
- numerotexte ou null
- suffixetexte ou null
  Indice de répétition (bis, ter, A...), en minuscules.
- voietexte ou null
- code_postaltexte ou null
- inseetexte ou null
- communetexte ou null
- ancienne_communeobjet ou null
  Commune déléguée ou fusionnée, quand l'adresse en porte une.
  Afficher les 2 champsMasquer
  - inseetexte ou null
  - nomtexte ou null
- latnombre
- lonnombre
- type_positiontexte ou null
  Type de position de la BAN (entrée, bâtiment, délivrance postale, parcelle, segment...) ; null si non lu.
- parcellesliste de textes ou null
  Parcelles cadastrales (14 caractères) rattachées au numéro par la BAN ; vide quand la BAN n'en donne pas (environ une adresse sur deux) ; null quand la base n'a pas été lue.
- scorenombre ou null
  Score de la recherche, de 0 à 1 (recherche en texte).
- distance_mnombre ou null
  Distance au point demandé, en mètres (géocodage inverse).
- certificationbooléen ou null
  Vrai si la commune a certifié l'adresse dans la BAN.
creditsobjet
Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).
Afficher les 2 champsMasquer
- debitesentier
  0 au moins
- restantsentier ou null

Erreurs possibles

400parametres_invalidesUn paramètre manque ou ne passe pas son contrôle ; le détail est donné champ par champ
401cle_absenteL'en-tête Authorization manque
401cle_invalideLa clé est inconnue, révoquée ou expirée
403organisation_suspendueL'organisation de la clé n'est pas active
403portee_insuffisanteLa clé ou l'accès de l'organisation n'ouvre pas cette opération
403hors_bac_a_sableUne clé pk_test_ demande une entrée hors du jeu figé de l'opération
402credits_insuffisantsLes crédits ne suffisent plus pour cet appel
429plafond_cleLe plafond mensuel de crédits de la clé est atteint
429quota_minuteLe débit par minute de l'organisation est atteint
503charge_globaleL'API est momentanément surchargée, tous clients confondus ; rien n'est débité
504delai_depasseLe calcul dépasse le délai de l'opération ; rien n'est débité
503service_indisponibleL'API est momentanément indisponible
500erreur_interneUne erreur de notre côté ; rien n'est servi ni débité

Une ressource absente répond par un code de la famille des ressources absentes, propre à l'opération, sans débit.

Faits complets d'une adresse

GET/api/v1/adresses/{cle_ban}/faits

La ligne complète d'une adresse BAN dans la table d'adresses de Pillr, en groupes : identité (parcelles, îlot, position), bâtiment, DPE détaillé (chauffage, isolation, ventilation, méthode, numéro, historique daté), audit, ventes DVF au numéro avec leur historique, îlot (ventes sur 5 ans, médiane au m² et son nombre de ventes, annonces actives, copropriétés), copropriété, autorisations d'urbanisme avec leur historique, sociétés civiles nommées avec leur SIREN, mise en vente (annonce rattachée, confiance et méthode), contexte de la commune et variables du pré-marché. Le paramètre champs choisit des groupes ou des colonnes. Un seul DPE par adresse : le plus récent.

Coût: 5 crédits par appel réussi
Accès: À l'usage ou avec l'abonnement Data
Portée: adresse
Outil MCP: faits_adresse
Bac à sable: Non
Mémoire: 24 h
Délai: 6 s

Essayer en direct

Paramètres

cle_bantexteobligatoire
Clé d'interopérabilité de la Base Adresse Nationale, ex. 69383_1234_00012.
champsvaleur
Champs rendus, séparés par des virgules (« prix,surface,analyse.score ») ; tous si absent.

Exemple d'appel

curl https://pillr.fr/api/v1/adresses/{cle_ban}/faits \
  -H "Authorization: Bearer $PILLR_CLE"

Réponse

identiteobjetfacultatif
Afficher les 17 champsMasquer
- cle_bantexte
- originetexte ou null
  ban : adresse de la BAN ; dpe : adresse connue par un DPE, absente de la BAN.
- adresse_numeroteebooléen ou null
  Faux pour une pseudo-adresse (voie ou commune seule) : à ne pas lire comme un bâtiment.
- adressetexte ou null
- numerotexte ou null
- reptexte ou null
- voietexte ou null
- code_postaltexte ou null
- inseetexte ou null
- communetexte ou null
- lieu_dittexte ou null
- parcellesliste de textes
  Parcelles cadastrales de l'adresse (14 caractères).
- type_positiontexte ou null
- latnombre ou null
- lonnombre ou null
- ilottexte ou null
  Îlot d'environ 100 m (position arrondie au millième de degré).
- cell4texte ou null
  Cellule d'environ 10 m (position arrondie au dix-millième de degré).
batimentobjetfacultatif
Afficher les 6 champsMasquer
- typetexte ou null
- surface_immeuble_m2nombre ou null
- periodetexte ou null
- anneeentier ou null
- niveauxentier ou null
- appartementsentier ou null
dpeobjet ou nullfacultatif
Un DPE par adresse ici (le plus récent) : le détail logement par logement est servi par les opérations du domaine DPE.
Afficher les 24 champsMasquer
- etiquettetexte ou null
  Valeurs : A, B, C, D, E, F, G
- gestexte ou null
  Valeurs : A, B, C, D, E, F, G
- conso_kwh_m2_annombre ou null
- ges_kg_m2_annombre ou null
- surface_m2nombre ou null
- chauffage_energietexte ou null
- chauffage_installationtexte ou null
- isolation_enveloppetexte ou null
- isolation_murstexte ou null
- isolation_menuiseriestexte ou null
- ventilationtexte ou null
- methodetexte ou null
  Méthode d'application du DPE (logement, immeuble, à partir du DPE de l'immeuble).
- numerotexte ou null
  Numéro ADEME du DPE le plus récent.
- etabli_letexte ou null
- fin_validitetexte ou null
- premier_letexte ou null
- jours_depuisentier ou null
- nb_totalentier ou null
- nb_12_moisentier ou null
- nb_6_moisentier ou null
- refait_pendant_validitebooléen ou null
- historiqueliste d'objets
  Tous les DPE datés de l'adresse, du plus ancien au plus récent.
  Afficher les 2 champsMasquer
  - datetexte
  - etiquettetexte ou null
    Valeurs : A, B, C, D, E, F, G
- interdiction_locationtexte ou null
  Premier jour où la location d'un logement de cette classe est interdite (AAAA-MM-JJ), selon le calendrier de la loi Climat et résilience en métropole (G 2025, F 2028, E 2034). null : classe sans échéance, DPE absent, ou adresse hors de la métropole (le calendrier des outre-mer n'est pas servi).
- qualiteobjet
  Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
  Afficher les 7 champsMasquer
  - nentier ou null
    Nombre d'observations derrière la valeur ; null si sans objet.
    0 au moins
  - provenancetexte ou null
    mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
    Valeurs : mesure, estime
  - incertitudeobjet ou null
    Incertitude de la valeur : fourchette et demi-largeur.
    Afficher les 3 champsMasquer
    demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
    basnombre ou null
    hautnombre ou null
  - drapeauxliste de textes
    Ce qui doit faire lire la valeur avec prudence ; vide si rien.
    Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
  - methodetexte ou null
    Méthode de calcul ou de rattachement, en clair.
  - donnees_dutexte ou null
    Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
  - sourcetexte
    Source publique ou moteur Pillr, en clair.
auditobjet ou nullfacultatif
Afficher les 6 champsMasquer
- etabli_letexte ou null
- nbentier ou null
- cout_travaux_maxnombre ou null
- classe_viseetexte ou null
  Valeurs : A, B, C, D, E, F, G
- pack_pre_ventebooléen ou null
  Un DPE et un audit établis ensemble, comme avant une vente.
- qualiteobjet
  Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
  Afficher les 7 champsMasquer
  - nentier ou null
    Nombre d'observations derrière la valeur ; null si sans objet.
    0 au moins
  - provenancetexte ou null
    mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
    Valeurs : mesure, estime
  - incertitudeobjet ou null
    Incertitude de la valeur : fourchette et demi-largeur.
    Afficher les 3 champsMasquer
    demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
    basnombre ou null
    hautnombre ou null
  - drapeauxliste de textes
    Ce qui doit faire lire la valeur avec prudence ; vide si rien.
    Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
  - methodetexte ou null
    Méthode de calcul ou de rattachement, en clair.
  - donnees_dutexte ou null
    Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
  - sourcetexte
    Source publique ou moteur Pillr, en clair.
ventesobjet ou nullfacultatif
Ventes DVF au numéro, résumées par mutation ; le détail est servi par le domaine Ventes DVF.
Afficher les 6 champsMasquer
- nentier
- premiere_letexte ou null
- derniereobjet ou null
  Afficher les 5 champsMasquer
  - datetexte ou null
  - prixnombre ou null
  - typetexte ou null
  - surface_m2nombre ou null
  - prix_m2nombre ou null
- historiqueliste d'objets
  Afficher les 4 champsMasquer
  - datetexte ou null
  - prixnombre ou null
  - typetexte ou null
  - surface_m2nombre ou null
- vendu_apres_dpebooléen ou null
- qualiteobjet
  Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
  Afficher les 7 champsMasquer
  - nentier ou null
    Nombre d'observations derrière la valeur ; null si sans objet.
    0 au moins
  - provenancetexte ou null
    mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
    Valeurs : mesure, estime
  - incertitudeobjet ou null
    Incertitude de la valeur : fourchette et demi-largeur.
    Afficher les 3 champsMasquer
    demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
    basnombre ou null
    hautnombre ou null
  - drapeauxliste de textes
    Ce qui doit faire lire la valeur avec prudence ; vide si rien.
    Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
  - methodetexte ou null
    Méthode de calcul ou de rattachement, en clair.
  - donnees_dutexte ou null
    Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
  - sourcetexte
    Source publique ou moteur Pillr, en clair.
ilotobjetfacultatif
Afficher les 10 champsMasquer
- ventes_5aentier ou null
- mediane_m2_5anombre ou null
  Prix au m² médian des ventes de l'îlot sur 5 ans, servi quel que soit le nombre de ventes.
- derniere_vente_letexte ou null
- anciennete_derniere_vente_jentier ou null
- en_venteentier ou null
  Annonces actives dans l'îlot.
- vente_directeentier ou null
  Annonces actives de particuliers dans l'îlot.
- coprobooléen ou null
- lots_maxentier ou null
- sans_syndicbooléen ou null
- qualiteobjet
  Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
  Afficher les 7 champsMasquer
  - nentier ou null
    Nombre d'observations derrière la valeur ; null si sans objet.
    0 au moins
  - provenancetexte ou null
    mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
    Valeurs : mesure, estime
  - incertitudeobjet ou null
    Incertitude de la valeur : fourchette et demi-largeur.
    Afficher les 3 champsMasquer
    demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
    basnombre ou null
    hautnombre ou null
  - drapeauxliste de textes
    Ce qui doit faire lire la valeur avec prudence ; vide si rien.
    Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
  - methodetexte ou null
    Méthode de calcul ou de rattachement, en clair.
  - donnees_dutexte ou null
    Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
  - sourcetexte
    Source publique ou moteur Pillr, en clair.
coproobjet ou nullfacultatif
Afficher les 8 champsMasquer
- immatriculationtexte ou null
- lots_habitationentier ou null
- lots_totalentier ou null
- type_syndictexte ou null
- mandattexte ou null
- immatriculee_letexte ou null
- periode_constructiontexte ou null
- aideebooléen ou null
permisobjet ou nullfacultatif
Afficher les 10 champsMasquer
- n_7aentier
- dernier_letexte ou null
- dernier_typetexte ou null
- dernier_naturetexte ou null
- logements_crees_7aentier ou null
- extensionbooléen ou null
- piscinebooléen ou null
- demandeur_probooléen ou null
  Au moins une autorisation demandée par une personne morale (SIREN).
- historiqueliste d'objets
  Afficher les 4 champsMasquer
  - datetexte ou null
  - typetexte ou null
  - naturetexte ou null
  - logementsentier ou null
- qualiteobjet
  Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
  Afficher les 7 champsMasquer
  - nentier ou null
    Nombre d'observations derrière la valeur ; null si sans objet.
    0 au moins
  - provenancetexte ou null
    mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
    Valeurs : mesure, estime
  - incertitudeobjet ou null
    Incertitude de la valeur : fourchette et demi-largeur.
    Afficher les 3 champsMasquer
    demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
    basnombre ou null
    hautnombre ou null
  - drapeauxliste de textes
    Ce qui doit faire lire la valeur avec prudence ; vide si rien.
    Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
  - methodetexte ou null
    Méthode de calcul ou de rattachement, en clair.
  - donnees_dutexte ou null
    Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
  - sourcetexte
    Source publique ou moteur Pillr, en clair.
societes_civilesobjet ou nullfacultatif
Sociétés civiles (personnes morales) dont le siège est à l'adresse, nommées avec leur SIREN quand l'avis le porte.
Afficher les 9 champsMasquer
- nentier
  Sociétés civiles dont le siège est à l'adresse.
- derniere_denominationtexte ou null
- dernier_avistexte ou null
- dernier_avis_letexte ou null
- radiation_letexte ou null
  Dernier avis de radiation ou de dissolution.
- procedure_letexte ou null
  Dernier avis de procédure collective.
- cession_letexte ou null
  Dernier avis de vente ou de cession.
- societesliste d'objets
  Afficher les 4 champsMasquer
  - denominationtexte
  - sirentexte ou null
  - formetexte ou null
  - avisliste d'objets
    Afficher les 2 champsMasquer
    datetexte
    typetexte ou null
- qualiteobjet
  Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
  Afficher les 7 champsMasquer
  - nentier ou null
    Nombre d'observations derrière la valeur ; null si sans objet.
    0 au moins
  - provenancetexte ou null
    mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
    Valeurs : mesure, estime
  - incertitudeobjet ou null
    Incertitude de la valeur : fourchette et demi-largeur.
    Afficher les 3 champsMasquer
    demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
    basnombre ou null
    hautnombre ou null
  - drapeauxliste de textes
    Ce qui doit faire lire la valeur avec prudence ; vide si rien.
    Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
  - methodetexte ou null
    Méthode de calcul ou de rattachement, en clair.
  - donnees_dutexte ou null
    Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
  - sourcetexte
    Source publique ou moteur Pillr, en clair.
annonceobjet ou nullfacultatif
La mise en vente de l'adresse : déduite du rattachement d'annonces à l'adresse, jamais déclarée par le vendeur. La confiance et la méthode disent comment lire la valeur.
Afficher les 6 champsMasquer
- deja_en_ventebooléen ou null
  Une annonce en cours est rattachée à l'adresse (concordance ou empreinte active).
- mise_en_vente_letexte ou null
  Première parution de la mise en vente en cours, lue par l'empreinte de l'adresse.
- derniere_parution_letexte ou null
- concordanteobjet ou null
  L'annonce rattachée par croisement, avec sa confiance et sa méthode.
  Afficher les 9 champsMasquer
  - activebooléen ou null
    L'annonce rattachée est-elle encore en ligne ?
  - nbnombre ou null
    Annonces rattachées à l'adresse par cette méthode.
  - idtexte ou null
    Identifiant de l'annonce au lac de Pillr.
  - prixnombre ou null
  - surface_m2nombre ou null
  - type_vendeurtexte ou null
    Professionnel ou particulier, selon le portail ; null si le portail ne le dit pas.
    Valeurs : professionnel, particulier
  - lientexte ou null
    Lien d'origine de l'annonce, servi quand la clé porte la portée lien_origine.
  - confiancenombre ou null
    Confiance du rattachement de l'annonce à l'adresse, de 0 à 1.
  - methodetexte ou null
    Méthode du rattachement (croisement DVF et DPE, DPE et copropriété, etc.).
- empreinteobjet ou null
  L'annonce reconnue par l'empreinte de l'adresse.
  Afficher les 7 champsMasquer
  - activebooléen ou null
  - nbnombre ou null
    Parutions reconnues comme le même bien à cette adresse.
  - idtexte ou null
  - parue_letexte ou null
  - prixnombre ou null
  - type_vendeurtexte ou null
    Professionnel ou particulier, selon le portail ; null si le portail ne le dit pas.
    Valeurs : professionnel, particulier
  - lientexte ou null
    Lien d'origine de l'annonce, servi quand la clé porte la portée lien_origine.
- qualiteobjet
  Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
  Afficher les 7 champsMasquer
  - nentier ou null
    Nombre d'observations derrière la valeur ; null si sans objet.
    0 au moins
  - provenancetexte ou null
    mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
    Valeurs : mesure, estime
  - incertitudeobjet ou null
    Incertitude de la valeur : fourchette et demi-largeur.
    Afficher les 3 champsMasquer
    demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
    basnombre ou null
    hautnombre ou null
  - drapeauxliste de textes
    Ce qui doit faire lire la valeur avec prudence ; vide si rien.
    Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
  - methodetexte ou null
    Méthode de calcul ou de rattachement, en clair.
  - donnees_dutexte ou null
    Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
  - sourcetexte
    Source publique ou moteur Pillr, en clair.
communeobjet ou nullfacultatif
Contexte de la commune, au dernier mois calculé.
Afficher les 9 champsMasquer
- prix_m2_mediannombre ou null
  Prix au m² médian des annonces de la commune.
- dvf_prix_m2_mediannombre ou null
  Prix au m² médian des ventes DVF de la commune.
- taux_vacancenombre ou null
- vente_directe_pctnombre ou null
  Part des annonces entrées publiées par des particuliers, en %.
- entreesentier ou null
- stockentier ou null
- duree_mediane_jnombre ou null
- moistexte ou null
- qualiteobjet
  Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
  Afficher les 7 champsMasquer
  - nentier ou null
    Nombre d'observations derrière la valeur ; null si sans objet.
    0 au moins
  - provenancetexte ou null
    mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
    Valeurs : mesure, estime
  - incertitudeobjet ou null
    Incertitude de la valeur : fourchette et demi-largeur.
    Afficher les 3 champsMasquer
    demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
    basnombre ou null
    hautnombre ou null
  - drapeauxliste de textes
    Ce qui doit faire lire la valeur avec prudence ; vide si rien.
    Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
  - methodetexte ou null
    Méthode de calcul ou de rattachement, en clair.
  - donnees_dutexte ou null
    Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
  - sourcetexte
    Source publique ou moteur Pillr, en clair.
pre_marcheobjet ou nullfacultatif
Variables du pré-marché, datées au jour du DPE (la probabilité calibrée est servie par le domaine Pré-marché).
Afficher les 9 champsMasquer
- decroissance_age_dpenombre ou null
- ventes_ilot_avant_dpeentier ou null
- achat_avant_dpe_letexte ou null
- annees_detention_au_dpenombre ou null
- dpe_valide_au_dpebooléen ou null
- nb_dpe_365j_avantentier ou null
- sci_connue_au_dpebooléen ou null
- audit_connu_letexte ou null
- hors_perimetretexte ou null
  Motif d'exclusion du périmètre du pré-marché ; null dans le périmètre.
calcule_letexte ou null
creditsobjet
Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).
Afficher les 2 champsMasquer
- debitesentier
  0 au moins
- restantsentier ou null

Erreurs possibles

400parametres_invalidesUn paramètre manque ou ne passe pas son contrôle ; le détail est donné champ par champ
401cle_absenteL'en-tête Authorization manque
401cle_invalideLa clé est inconnue, révoquée ou expirée
403organisation_suspendueL'organisation de la clé n'est pas active
403portee_insuffisanteLa clé ou l'accès de l'organisation n'ouvre pas cette opération
403hors_bac_a_sableUne clé pk_test_ l'appelle : l'opération n'a pas de bac à sable
402credits_insuffisantsLes crédits ne suffisent plus pour cet appel
429plafond_cleLe plafond mensuel de crédits de la clé est atteint
429quota_minuteLe débit par minute de l'organisation est atteint
503charge_globaleL'API est momentanément surchargée, tous clients confondus ; rien n'est débité
504delai_depasseLe calcul dépasse le délai de l'opération ; rien n'est débité
503service_indisponibleL'API est momentanément indisponible
500erreur_interneUne erreur de notre côté ; rien n'est servi ni débité

Une ressource absente répond par un code de la famille des ressources absentes, propre à l'opération, sans débit.

Histoire datée d'une adresse

GET/api/v1/adresses/{cle_ban}/histoire

GET/api/v1/adresses/histoire

La frise datée et sourcée d'une adresse, par sa clé BAN, l'adresse en texte ou un point : construction déclarée, DPE depuis 2013 et audits énergétiques, autorisations d'urbanisme depuis 2013 (demandeur personne morale nommé), ventes DVF depuis 2018 au numéro, à la parcelle ou par position, copropriété (syndic professionnel nommé), sociétés civiles domiciliées nommées avec leur SIREN, annonces passées et baisses de prix avec l'agence nommée, catastrophes naturelles de la commune depuis 1982 (Géorisques). Chaque évènement dit son rattachement (adresse, parcelle, immeuble, position ou commune) et chaque source son état. Le même moteur que l'outil Historimmo du Hub ; le nombre d'évènements est plafonné, la construction et la première vente toujours gardées.

Coût: 10 crédits par appel réussi
Accès: À l'usage ou avec l'abonnement Data
Portée: adresse
Outil MCP: histoire_adresse
Bac à sable: Non
Mémoire: 12 h
Délai: 25 s

Essayer en direct

Paramètres de /api/v1/adresses/{cle_ban}/histoire

cle_bantexteobligatoire
Clé d'interopérabilité de la Base Adresse Nationale, ex. 69383_1234_00012.

Paramètres de /api/v1/adresses/histoire

qtexteobligatoire
Adresse en texte, numéro compris, géocodée par la Base Adresse Nationale.
de 5 à 200 caractères
latnombreobligatoire
Latitude en degrés décimaux (WGS 84).
de -90 à 90
lonnombreobligatoire
Longitude en degrés décimaux (WGS 84).
de -180 à 180
code_postaltexteobligatoire
Code postal, pour départager une adresse homonyme (avec q).

Exemple d'appel

curl https://pillr.fr/api/v1/adresses/histoire \
  -H "Authorization: Bearer $PILLR_CLE"

Réponse

adresseobjet
Afficher les 13 champsMasquer
- libelletexte
- cle_bantexte ou null
- inseetexte
- code_postaltexte ou null
- communetexte
- numerotexte ou null
- suffixetexte ou null
- voietexte ou null
- code_voietexte ou null
- latnombre
- lonnombre
- parcellesliste de textes
- score_geocodagenombre ou null
bienobjet ou null
Afficher les 11 champsMasquer
- type_bientexte ou null
- surface_m2nombre ou null
- annee_constructionnombre ou null
- periode_constructiontexte ou null
- etiquette_dpetexte ou null
- etiquette_gestexte ou null
- chauffagetexte ou null
- nombre_niveauxnombre ou null
- nombre_logementsnombre ou null
- copro_lotsnombre ou null
- copro_type_syndictexte ou null
evenementsliste d'objets
Du plus ancien au plus récent ; la construction et la première vente sont toujours gardées.
Afficher les 11 champsMasquer
- idtexte
- datetexte
- date_precisiontexte
  Valeurs : jour, mois, annee
- typetexte
  construction, dpe, audit, vente, annonce_parue, annonce_baisse, annonce_retiree, permis_construire, declaration_prealable, permis_amenager, permis_demolir, ouverture_chantier, achevement_travaux, copro_immatriculation, copro_reglement, copro_fin_mandat, societe_civile, catastrophe_naturelle.
- familletexte
  Valeurs : bien, transaction, marche, urbanisme, copropriete, societe, commune
- titretexte
- detailtexte ou null
- valeursliste d'objets
  Afficher les 2 champsMasquer
  - libelletexte
  - valeurtexte
- sourcetexte
- rattachementtexte
  À quel point l'évènement est rattaché à l'adresse : même adresse, même parcelle, par position, un autre lot du même immeuble, ou la commune.
  Valeurs : adresse, parcelle, position, immeuble, commune
- lientexte ou null
  Lien public (annonce d'origine avec la portée lien_origine, texte officiel).
periodeobjet
Afficher les 2 champsMasquer
- debuttexte ou null
- fintexte ou null
sourcesliste d'objets
Afficher les 6 champsMasquer
- idtexte
- libelletexte
- depuisentier ou null
- statuttexte
  Valeurs : ok, vide, indisponible
- nbentier
- notetexte ou null
resumeobjet
Afficher les 5 champsMasquer
- nb_evenementsentier
- nb_ventesentier
- derniere_venteobjet ou null
  Afficher les 2 champsMasquer
  - datetexte
  - prixnombre ou null
- premier_evenementobjet ou null
  Afficher les 2 champsMasquer
  - datetexte
  - titretexte
- en_ventebooléen
mise_en_venteobjet ou null
La mise en vente de l'adresse : déduite du rattachement d'annonces à l'adresse, jamais déclarée par le vendeur. La confiance et la méthode disent comment lire la valeur.
Afficher les 6 champsMasquer
- deja_en_ventebooléen ou null
  Une annonce en cours est rattachée à l'adresse (concordance ou empreinte active).
- mise_en_vente_letexte ou null
  Première parution de la mise en vente en cours, lue par l'empreinte de l'adresse.
- derniere_parution_letexte ou null
- concordanteobjet ou null
  L'annonce rattachée par croisement, avec sa confiance et sa méthode.
  Afficher les 9 champsMasquer
  - activebooléen ou null
    L'annonce rattachée est-elle encore en ligne ?
  - nbnombre ou null
    Annonces rattachées à l'adresse par cette méthode.
  - idtexte ou null
    Identifiant de l'annonce au lac de Pillr.
  - prixnombre ou null
  - surface_m2nombre ou null
  - type_vendeurtexte ou null
    Professionnel ou particulier, selon le portail ; null si le portail ne le dit pas.
    Valeurs : professionnel, particulier
  - lientexte ou null
    Lien d'origine de l'annonce, servi quand la clé porte la portée lien_origine.
  - confiancenombre ou null
    Confiance du rattachement de l'annonce à l'adresse, de 0 à 1.
  - methodetexte ou null
    Méthode du rattachement (croisement DVF et DPE, DPE et copropriété, etc.).
- empreinteobjet ou null
  L'annonce reconnue par l'empreinte de l'adresse.
  Afficher les 7 champsMasquer
  - activebooléen ou null
  - nbnombre ou null
    Parutions reconnues comme le même bien à cette adresse.
  - idtexte ou null
  - parue_letexte ou null
  - prixnombre ou null
  - type_vendeurtexte ou null
    Professionnel ou particulier, selon le portail ; null si le portail ne le dit pas.
    Valeurs : professionnel, particulier
  - lientexte ou null
    Lien d'origine de l'annonce, servi quand la clé porte la portée lien_origine.
- qualiteobjet
  Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
  Afficher les 7 champsMasquer
  - nentier ou null
    Nombre d'observations derrière la valeur ; null si sans objet.
    0 au moins
  - provenancetexte ou null
    mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
    Valeurs : mesure, estime
  - incertitudeobjet ou null
    Incertitude de la valeur : fourchette et demi-largeur.
    Afficher les 3 champsMasquer
    demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
    basnombre ou null
    hautnombre ou null
  - drapeauxliste de textes
    Ce qui doit faire lire la valeur avec prudence ; vide si rien.
    Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
  - methodetexte ou null
    Méthode de calcul ou de rattachement, en clair.
  - donnees_dutexte ou null
    Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
  - sourcetexte
    Source publique ou moteur Pillr, en clair.
societes_civilesobjet ou null
Sociétés civiles (personnes morales) dont le siège est à l'adresse, nommées avec leur SIREN quand l'avis le porte.
Afficher les 9 champsMasquer
- nentier
  Sociétés civiles dont le siège est à l'adresse.
- derniere_denominationtexte ou null
- dernier_avistexte ou null
- dernier_avis_letexte ou null
- radiation_letexte ou null
  Dernier avis de radiation ou de dissolution.
- procedure_letexte ou null
  Dernier avis de procédure collective.
- cession_letexte ou null
  Dernier avis de vente ou de cession.
- societesliste d'objets
  Afficher les 4 champsMasquer
  - denominationtexte
  - sirentexte ou null
  - formetexte ou null
  - avisliste d'objets
    Afficher les 2 champsMasquer
    datetexte
    typetexte ou null
- qualiteobjet
  Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
  Afficher les 7 champsMasquer
  - nentier ou null
    Nombre d'observations derrière la valeur ; null si sans objet.
    0 au moins
  - provenancetexte ou null
    mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
    Valeurs : mesure, estime
  - incertitudeobjet ou null
    Incertitude de la valeur : fourchette et demi-largeur.
    Afficher les 3 champsMasquer
    demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
    basnombre ou null
    hautnombre ou null
  - drapeauxliste de textes
    Ce qui doit faire lire la valeur avec prudence ; vide si rien.
    Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
  - methodetexte ou null
    Méthode de calcul ou de rattachement, en clair.
  - donnees_dutexte ou null
    Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
  - sourcetexte
    Source publique ou moteur Pillr, en clair.
alternativesliste d'objets
Autres adresses proposées par la BAN quand la saisie est ambiguë ; vide sinon.
Afficher les 3 champsMasquer
- libelletexte
- cle_bantexte ou null
- scorenombre ou null
notetexte
calcule_letexte
qualiteobjet
Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
Afficher les 7 champsMasquer
- nentier ou null
  Nombre d'observations derrière la valeur ; null si sans objet.
  0 au moins
- provenancetexte ou null
  mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
  Valeurs : mesure, estime
- incertitudeobjet ou null
  Incertitude de la valeur : fourchette et demi-largeur.
  Afficher les 3 champsMasquer
  - demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
  - basnombre ou null
  - hautnombre ou null
- drapeauxliste de textes
  Ce qui doit faire lire la valeur avec prudence ; vide si rien.
  Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
- methodetexte ou null
  Méthode de calcul ou de rattachement, en clair.
- donnees_dutexte ou null
  Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
- sourcetexte
  Source publique ou moteur Pillr, en clair.
creditsobjet
Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).
Afficher les 2 champsMasquer
- debitesentier
  0 au moins
- restantsentier ou null

Erreurs possibles

400parametres_invalidesUn paramètre manque ou ne passe pas son contrôle ; le détail est donné champ par champ
401cle_absenteL'en-tête Authorization manque
401cle_invalideLa clé est inconnue, révoquée ou expirée
403organisation_suspendueL'organisation de la clé n'est pas active
403portee_insuffisanteLa clé ou l'accès de l'organisation n'ouvre pas cette opération
403hors_bac_a_sableUne clé pk_test_ l'appelle : l'opération n'a pas de bac à sable
402credits_insuffisantsLes crédits ne suffisent plus pour cet appel
429plafond_cleLe plafond mensuel de crédits de la clé est atteint
429quota_minuteLe débit par minute de l'organisation est atteint
503charge_globaleL'API est momentanément surchargée, tous clients confondus ; rien n'est débité
503creneau_reserveEntre 20h30 et minuit (heure de Paris), la réponse n'est pas déjà en mémoire
504delai_depasseLe calcul dépasse le délai de l'opération ; rien n'est débité
503service_indisponibleL'API est momentanément indisponible
500erreur_interneUne erreur de notre côté ; rien n'est servi ni débité

Une ressource absente répond par un code de la famille des ressources absentes, propre à l'opération, sans débit.

Annonces vues à une adresse

GET/api/v1/adresses/{cle_ban}/annonces

Toutes les annonces de vente rattachées à une adresse BAN, actives et passées : l'annonce concordante (dé-floutée par croisement), l'annonce reconnue par l'empreinte de l'adresse, les annonces reconnues par l'empreinte d'un DPE de l'adresse et celles dont l'adresse résolue tombe à moins de 25 m. Pour chacune : portail, prix, surface, type de vendeur, agence nommée avec son SIREN pour un professionnel, dates de parution et de retrait, baisses de prix, méthode et confiance du rattachement. La réponse dit aussi si l'adresse est en vente et depuis quand. Rien n'est débité quand aucune annonce n'est rattachée à l'adresse.

Coût: 3 crédits par appel réussi
Accès: À l'usage ou avec l'abonnement Data
Portée: adresse
Outil MCP: annonces_adresse
Bac à sable: Non
Mémoire: 1 h
Délai: 8 s

Essayer en direct

Paramètres

cle_bantexteobligatoire
Clé d'interopérabilité de la Base Adresse Nationale, ex. 69383_1234_00012.
actives_seulementvaleur
true : seulement les annonces encore en ligne.

Exemple d'appel

curl https://pillr.fr/api/v1/adresses/{cle_ban}/annonces \
  -H "Authorization: Bearer $PILLR_CLE"

Réponse

cle_bantexte
deja_en_ventebooléen ou null
mise_en_vente_letexte ou null
derniere_parution_letexte ou null
annoncesliste d'objets
Les annonces rattachées, de la plus récente à la plus ancienne parution.
Afficher les 16 champsMasquer
- idtexte
  Identifiant de portail (lbc:<numéro>, bienici:<identifiant>, seloger:<numéro>) quand le lien le donne, sinon identifiant du lac de Pillr.
- sourcetexte ou null
  Portail d'origine.
- lientexte ou null
  Lien d'origine de l'annonce, servi quand la clé porte la portée lien_origine.
- activebooléen ou null
- prixnombre ou null
- surface_m2nombre ou null
- type_bientexte ou null
- type_vendeurtexte
  Valeurs : professionnel, particulier, inconnu
- annonceurobjet ou null
  L'agence ou le professionnel qui publie l'annonce, nommé avec son SIREN ; null pour un particulier, qui n'est jamais nommé.
  Afficher les 4 champsMasquer
  - type_vendeurtexte
    Valeurs : professionnel, particulier, inconnu
  - nomtexte ou null
  - enseignetexte ou null
  - sirentexte ou null
- parue_letexte ou null
- retiree_letexte ou null
- baissesliste d'objets
  Baisses de prix relevées sur l'annonce, hors aberrations (chute de plus de moitié, facteur 10).
  Afficher les 4 champsMasquer
  - letexte
  - denombre
  - anombre
  - ecart_pctnombre ou null
    Écart en %, négatif pour une baisse.
- methodetexte
  Comment l'annonce est rattachée à l'adresse.
  Valeurs : concordante, empreinte_adresse, empreinte_dpe, position
- confiancenombre ou null
  Confiance du rattachement, de 0 à 1, quand la méthode en donne une.
- distance_mnombre ou null
  Distance entre la position résolue de l'annonce et l'adresse (méthode position).
- qualiteobjet
  Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
  Afficher les 7 champsMasquer
  - nentier ou null
    Nombre d'observations derrière la valeur ; null si sans objet.
    0 au moins
  - provenancetexte ou null
    mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
    Valeurs : mesure, estime
  - incertitudeobjet ou null
    Incertitude de la valeur : fourchette et demi-largeur.
    Afficher les 3 champsMasquer
    demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
    basnombre ou null
    hautnombre ou null
  - drapeauxliste de textes
    Ce qui doit faire lire la valeur avec prudence ; vide si rien.
    Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
  - methodetexte ou null
    Méthode de calcul ou de rattachement, en clair.
  - donnees_dutexte ou null
    Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
  - sourcetexte
    Source publique ou moteur Pillr, en clair.
donnees_dutexte ou null
creditsobjet
Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).
Afficher les 2 champsMasquer
- debitesentier
  0 au moins
- restantsentier ou null

Erreurs possibles

400parametres_invalidesUn paramètre manque ou ne passe pas son contrôle ; le détail est donné champ par champ
401cle_absenteL'en-tête Authorization manque
401cle_invalideLa clé est inconnue, révoquée ou expirée
403organisation_suspendueL'organisation de la clé n'est pas active
403portee_insuffisanteLa clé ou l'accès de l'organisation n'ouvre pas cette opération
403hors_bac_a_sableUne clé pk_test_ l'appelle : l'opération n'a pas de bac à sable
402credits_insuffisantsLes crédits ne suffisent plus pour cet appel
429plafond_cleLe plafond mensuel de crédits de la clé est atteint
429quota_minuteLe débit par minute de l'organisation est atteint
503charge_globaleL'API est momentanément surchargée, tous clients confondus ; rien n'est débité
504delai_depasseLe calcul dépasse le délai de l'opération ; rien n'est débité
503service_indisponibleL'API est momentanément indisponible
500erreur_interneUne erreur de notre côté ; rien n'est servi ni débité

Une ressource absente répond par un code de la famille des ressources absentes, propre à l'opération, sans débit.

Parcelle cadastrale et ce qui s'y rattache

GET/api/v1/parcelles/{id_parcelle}

GET/api/v1/adresses/{cle_ban}/parcelles

Une parcelle cadastrale, par son identifiant à 14 caractères ou par la clé BAN d'une adresse : contenance, section, numéro et géométrie (API Carto de l'IGN, en direct), adresses BAN rattachées, ventes DVF de la parcelle, autorisations d'urbanisme Sitadel qui la citent (demandeur personne morale nommé), copropriétés qui la citent et zone du document d'urbanisme à son point intérieur. Par une clé BAN, la parcelle servie est la première de l'adresse, ou celle qui contient le numéro, et la réponse liste les autres.

Coût: 3 crédits par appel réussi
Accès: À l'usage ou avec l'abonnement Data
Portée: adresse
Outil MCP: parcelle
Bac à sable: Non
Mémoire: 24 h
Délai: 15 s

Essayer en direct

Paramètres de /api/v1/parcelles/{id_parcelle}

id_parcelletexteobligatoire
Identifiant cadastral de la parcelle sur 14 caractères : code INSEE, préfixe, section et numéro, ex. 35238000AB0123.

Paramètres de /api/v1/adresses/{cle_ban}/parcelles

cle_bantexteobligatoire
Clé d'interopérabilité de la Base Adresse Nationale, ex. 69383_1234_00012.

Exemple d'appel

curl https://pillr.fr/api/v1/parcelles/{id_parcelle} \
  -H "Authorization: Bearer $PILLR_CLE"

Réponse

id_parcelletexte
inseetexte ou null
prefixetexte ou null
Préfixe de la commune absorbée ; 000 sinon.
sectiontexte ou null
numerotexte ou null
communetexte ou null
contenance_m2nombre ou null
Contenance cadastrale (surface du terrain), en m².
geometrieobjet
Géométrie GeoJSON de la parcelle (WGS 84).
Afficher les 2 champsMasquer
- typetexte
  Valeurs : Polygon, MultiPolygon
- coordinatesliste de valeurs
  Coordonnées GeoJSON, en degrés (longitude, latitude).
centreobjet
Point intérieur de la parcelle.
Afficher les 2 champsMasquer
- latnombre
- lonnombre
parcelles_adresseliste de textes ou null
Toutes les parcelles de l'adresse, quand la parcelle est demandée par une clé BAN ; null sinon.
adressesliste d'objets
Adresses BAN rattachées à la parcelle.
Afficher les 2 champsMasquer
- cle_bantexte
- adressetexte ou null
ventesliste d'objets
Ventes DVF de la parcelle (2021 à 2025), une ligne par local ou culture de la mutation.
Afficher les 9 champsMasquer
- id_mutationtexte
- datetexte ou null
- naturetexte ou null
- valeur_foncierenombre ou null
- type_localtexte ou null
- surface_bati_m2nombre ou null
- surface_terrain_m2nombre ou null
- nombre_lotsentier ou null
- prix_atypiquebooléen ou null
permisliste d'objets
Autorisations d'urbanisme Sitadel dont le dossier cite la parcelle.
Afficher les 6 champsMasquer
- numerotexte ou null
- typetexte ou null
- datetexte ou null
- naturetexte ou null
- logementsentier ou null
- demandeurobjet ou null
  Le demandeur personne morale ; null pour une personne physique, jamais nommée.
  Afficher les 2 champsMasquer
  - denominationtexte ou null
  - sirentexte ou null
coproprietesliste d'objets
Copropriétés du Registre national qui citent la parcelle.
Afficher les 4 champsMasquer
- numerotexte
- nom_usagetexte ou null
- lots_totalentier ou null
- lots_habitationentier ou null
zone_pluobjet ou null
Zone du document d'urbanisme au point intérieur de la parcelle (Géoportail de l'urbanisme) ; null hors zonage connu.
Afficher les 3 champsMasquer
- libelletexte ou null
- typetexte ou null
- documenttexte ou null
qualiteobjet
Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
Afficher les 7 champsMasquer
- nentier ou null
  Nombre d'observations derrière la valeur ; null si sans objet.
  0 au moins
- provenancetexte ou null
  mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
  Valeurs : mesure, estime
- incertitudeobjet ou null
  Incertitude de la valeur : fourchette et demi-largeur.
  Afficher les 3 champsMasquer
  - demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
  - basnombre ou null
  - hautnombre ou null
- drapeauxliste de textes
  Ce qui doit faire lire la valeur avec prudence ; vide si rien.
  Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
- methodetexte ou null
  Méthode de calcul ou de rattachement, en clair.
- donnees_dutexte ou null
  Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
- sourcetexte
  Source publique ou moteur Pillr, en clair.
creditsobjet
Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).
Afficher les 2 champsMasquer
- debitesentier
  0 au moins
- restantsentier ou null

Erreurs possibles

400parametres_invalidesUn paramètre manque ou ne passe pas son contrôle ; le détail est donné champ par champ
401cle_absenteL'en-tête Authorization manque
401cle_invalideLa clé est inconnue, révoquée ou expirée
403organisation_suspendueL'organisation de la clé n'est pas active
403portee_insuffisanteLa clé ou l'accès de l'organisation n'ouvre pas cette opération
403hors_bac_a_sableUne clé pk_test_ l'appelle : l'opération n'a pas de bac à sable
402credits_insuffisantsLes crédits ne suffisent plus pour cet appel
429plafond_cleLe plafond mensuel de crédits de la clé est atteint
429quota_minuteLe débit par minute de l'organisation est atteint
503charge_globaleL'API est momentanément surchargée, tous clients confondus ; rien n'est débité
504delai_depasseLe calcul dépasse le délai de l'opération ; rien n'est débité
503service_indisponibleL'API est momentanément indisponible
500erreur_interneUne erreur de notre côté ; rien n'est servi ni débité

Une ressource absente répond par un code de la famille des ressources absentes, propre à l'opération, sans débit.

Bâtiments autour d'un point ou sur une parcelle

GET/api/v1/batiments

GET/api/v1/parcelles/{id_parcelle}/batiments

Les bâtiments de la BD TOPO de l'IGN (service WFS de la Géoplateforme, en direct) autour d'un point, dans un rayon de 200 m au plus (50 m par défaut), ou sur une parcelle cadastrale : niveaux (estimés sur la hauteur quand la BD TOPO ne les donne pas, et la réponse le dit), hauteur, usage, nature, nombre de logements, emprise au sol et adresse BAN la plus proche. Avec un étage, chaque bâtiment dit s'il compte assez de niveaux.

Coût: 2 crédits par appel réussi
Accès: À l'usage ou avec l'abonnement Data
Portée: adresse
Outil MCP: batiments
Bac à sable: Non
Mémoire: 24 h
Délai: 20 s

Essayer en direct

Paramètres de /api/v1/batiments

latnombre
Latitude en degrés décimaux (WGS 84).
de -90 à 90
lonnombre
Longitude en degrés décimaux (WGS 84).
de -180 à 180
rayon_mentier
Rayon de recherche autour du point, en mètres.
de 1 à 200
etageentier
Étage d'un logement : chaque bâtiment dit s'il compte assez de niveaux.
de 0 à 80

Paramètres de /api/v1/parcelles/{id_parcelle}/batiments

id_parcelletexteobligatoire
Identifiant cadastral de la parcelle sur 14 caractères : code INSEE, préfixe, section et numéro, ex. 35238000AB0123.

Exemple d'appel

curl https://pillr.fr/api/v1/batiments \
  -H "Authorization: Bearer $PILLR_CLE"

Réponse

batimentsliste d'objets
Afficher les 15 champsMasquer
- idtexte ou null
  Identifiant BD TOPO du bâtiment.
- cle_bantexte ou null
  Clé BAN de l'adresse la plus proche (dans le bâtiment, sinon à 30 m au plus).
- adressetexte ou null
- niveauxentier ou null
  Nombre d'étages de la BD TOPO, sinon estimé sur la hauteur (3 m par niveau).
- niveaux_estimesbooléen
  Vrai quand les niveaux sont estimés sur la hauteur.
- hauteur_mnombre ou null
- usagetexte ou null
- naturetexte ou null
- logementsentier ou null
- emprise_m2nombre ou null
  Emprise au sol, calculée sur la géométrie BD TOPO.
- compatible_etagebooléen ou null
  Avec le paramètre etage : vrai si le bâtiment compte au moins autant de niveaux que l'étage demandé (la BD TOPO peut sous-estimer les niveaux) ; null sans etage ou sans niveaux.
- distance_mnombre ou null
  Distance du centre du bâtiment au point demandé (recherche par point).
- part_sur_parcellenombre ou null
  Part de l'emprise sur la parcelle, de 0 à 1 (recherche par parcelle).
- latnombre ou null
- lonnombre ou null
tronquebooléen
Vrai si la zone compte plus de bâtiments que ceux lus.
qualiteobjet
Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
Afficher les 7 champsMasquer
- nentier ou null
  Nombre d'observations derrière la valeur ; null si sans objet.
  0 au moins
- provenancetexte ou null
  mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
  Valeurs : mesure, estime
- incertitudeobjet ou null
  Incertitude de la valeur : fourchette et demi-largeur.
  Afficher les 3 champsMasquer
  - demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
  - basnombre ou null
  - hautnombre ou null
- drapeauxliste de textes
  Ce qui doit faire lire la valeur avec prudence ; vide si rien.
  Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
- methodetexte ou null
  Méthode de calcul ou de rattachement, en clair.
- donnees_dutexte ou null
  Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
- sourcetexte
  Source publique ou moteur Pillr, en clair.
creditsobjet
Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).
Afficher les 2 champsMasquer
- debitesentier
  0 au moins
- restantsentier ou null

Erreurs possibles

400parametres_invalidesUn paramètre manque ou ne passe pas son contrôle ; le détail est donné champ par champ
401cle_absenteL'en-tête Authorization manque
401cle_invalideLa clé est inconnue, révoquée ou expirée
403organisation_suspendueL'organisation de la clé n'est pas active
403portee_insuffisanteLa clé ou l'accès de l'organisation n'ouvre pas cette opération
403hors_bac_a_sableUne clé pk_test_ l'appelle : l'opération n'a pas de bac à sable
402credits_insuffisantsLes crédits ne suffisent plus pour cet appel
429plafond_cleLe plafond mensuel de crédits de la clé est atteint
429quota_minuteLe débit par minute de l'organisation est atteint
503charge_globaleL'API est momentanément surchargée, tous clients confondus ; rien n'est débité
504delai_depasseLe calcul dépasse le délai de l'opération ; rien n'est débité
503service_indisponibleL'API est momentanément indisponible
500erreur_interneUne erreur de notre côté ; rien n'est servi ni débité

Une ressource absente répond par un code de la famille des ressources absentes, propre à l'opération, sans débit.

Copropriétés du Registre national

GET/api/v1/coproprietes

GET/api/v1/coproprietes/{numero}

GET/api/v1/adresses/{cle_ban}/copropriete

Les copropriétés immatriculées au Registre national des copropriétés, par numéro d'immatriculation, par la clé BAN d'une adresse (immatriculation portée par le DPE, sinon parcelle commune, sinon position à 30 m au plus), ou par filtres (commune, code postal, ou point et rayon, puis nombre de lots, type de syndic, copropriété aidée) : adresse et nom d'usage, lots (total, habitation, stationnement), période de construction, syndic professionnel nommé (raison sociale, SIRET, APE), mandat en cours et fin du dernier mandat, parcelles, dispositifs publics et aide. Le représentant d'un syndic bénévole n'est jamais servi. L'agrégat de la commune accompagne la liste.

Coût: 1 crédit par élément rendu
Accès: À l'usage ou avec l'abonnement Data
Portée: adresse
Outil MCP: coproprietes
Bac à sable: Non
Mémoire: 24 h
Délai: 6 s

Essayer en direct

Paramètres de /api/v1/coproprietes

inseetexte
Code INSEE de la commune ou de l'arrondissement (5 caractères, 2A ou 2B pour la Corse).
cptexte
Code postal.
latnombre
Latitude en degrés décimaux (WGS 84).
de -90 à 90
lonnombre
Longitude en degrés décimaux (WGS 84).
de -180 à 180
rayon_mentier
Rayon autour du point, en mètres.
de 10 à 3 000
lots_minentier
Nombre total de lots, au moins.
0 au moins
lots_maxentier
Nombre total de lots, au plus.
0 au moins
type_syndictexte
Valeurs : professionnel, benevole, non_renseigne
aideevaleur
true : seulement les copropriétés aidées ; false : seulement les autres.
limiteentier
Nombre d'éléments par page (50 au plus).
de 1 à 50 ; par défaut 20
curseurtexte
Curseur opaque rendu par la page précédente (curseur_suivant), à repasser tel quel.
de 1 à 1 024 caractères

Paramètres de /api/v1/coproprietes/{numero}

numerotexteobligatoire
Numéro d'immatriculation de la copropriété au Registre national des copropriétés, 9 caractères, ex. AA1234567.

Paramètres de /api/v1/adresses/{cle_ban}/copropriete

cle_bantexteobligatoire
Clé d'interopérabilité de la Base Adresse Nationale, ex. 69383_1234_00012.

Exemple d'appel

curl https://pillr.fr/api/v1/coproprietes \
  -H "Authorization: Bearer $PILLR_CLE"

Réponse

donneesliste d'objets
Afficher les 26 champsMasquer
- numerotexte
- immatriculee_letexte ou null
- maj_letexte ou null
- nom_usagetexte ou null
- adressetexte ou null
- code_postaltexte ou null
- inseetexte ou null
- communetexte ou null
- latnombre ou null
- lonnombre ou null
- distance_mnombre ou null
  Distance au point ou à l'adresse demandés, en mètres.
- lots_totalentier ou null
- lots_habitationentier ou null
- lots_habitation_bureaux_commercesentier ou null
- lots_stationnemententier ou null
- periode_constructiontexte ou null
- reglement_letexte ou null
- syndicobjet
  Afficher les 6 champsMasquer
  - typetexte ou null
  - raison_socialetexte ou null
    Raison sociale d'un syndic professionnel ; null pour un syndic bénévole ou coopératif, dont le représentant n'est jamais servi.
  - sirettexte ou null
  - apetexte ou null
  - mandat_en_courstexte ou null
  - fin_mandattexte ou null
- parcellesliste de textes
- dispositifsliste de textes
  Dispositifs publics : acv (Action cœur de ville), pvd (Petites villes de demain), qpv (quartier prioritaire), plan_sauvegarde.
- aideebooléen ou null
- qpobjet ou null
  Quartier prioritaire de la politique de la ville (2024).
  Afficher les 2 champsMasquer
  - codetexte ou null
  - nomtexte ou null
- residence_servicebooléen ou null
- syndicat_cooperatifbooléen ou null
- rattachementobjet ou null
  Par une clé BAN : comment la copropriété est rattachée à l'adresse (immatriculation portée par le DPE, parcelle commune, position à 30 m au plus).
  Afficher les 2 champsMasquer
  - methodetexte
    Valeurs : dpe, parcelle, position
  - distance_mnombre ou null
- qualiteobjet
  Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
  Afficher les 7 champsMasquer
  - nentier ou null
    Nombre d'observations derrière la valeur ; null si sans objet.
    0 au moins
  - provenancetexte ou null
    mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
    Valeurs : mesure, estime
  - incertitudeobjet ou null
    Incertitude de la valeur : fourchette et demi-largeur.
    Afficher les 3 champsMasquer
    demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
    basnombre ou null
    hautnombre ou null
  - drapeauxliste de textes
    Ce qui doit faire lire la valeur avec prudence ; vide si rien.
    Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
  - methodetexte ou null
    Méthode de calcul ou de rattachement, en clair.
  - donnees_dutexte ou null
    Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
  - sourcetexte
    Source publique ou moteur Pillr, en clair.
communeobjet ou null
L'agrégat de la commune, quand la recherche porte sur une seule commune.
Afficher les 9 champsMasquer
- inseetexte
- coprosentier ou null
- lots_totalentier ou null
- lots_habitationentier ou null
- sans_mandatentier ou null
- aideesentier ou null
- plan_sauvegardeentier ou null
- syndic_benevoleentier ou null
- donnees_dutexte ou null
curseur_suivanttexte ou null
Curseur de la page suivante, à repasser dans curseur ; null sur la dernière page.
creditsobjet
Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).
Afficher les 2 champsMasquer
- debitesentier
  0 au moins
- restantsentier ou null

Erreurs possibles

400parametres_invalidesUn paramètre manque ou ne passe pas son contrôle ; le détail est donné champ par champ
401cle_absenteL'en-tête Authorization manque
401cle_invalideLa clé est inconnue, révoquée ou expirée
403organisation_suspendueL'organisation de la clé n'est pas active
403portee_insuffisanteLa clé ou l'accès de l'organisation n'ouvre pas cette opération
403hors_bac_a_sableUne clé pk_test_ l'appelle : l'opération n'a pas de bac à sable
402credits_insuffisantsLes crédits ne suffisent plus pour cet appel
429plafond_cleLe plafond mensuel de crédits de la clé est atteint
429quota_minuteLe débit par minute de l'organisation est atteint
503charge_globaleL'API est momentanément surchargée, tous clients confondus ; rien n'est débité
504delai_depasseLe calcul dépasse le délai de l'opération ; rien n'est débité
503service_indisponibleL'API est momentanément indisponible
500erreur_interneUne erreur de notre côté ; rien n'est servi ni débité

Une ressource absente répond par un code de la famille des ressources absentes, propre à l'opération, sans débit.

DVF à l'adresse : toutes les mutations

GET/api/v1/adresses/{cle_ban}/ventes

GET/api/v1/parcelles/{id_parcelle}/ventes

Toutes les mutations DVF enregistrées à une adresse de la Base Adresse Nationale (par sa clé), ou à une parcelle cadastrale, regroupées par mutation. Les ventes de 2021 et suivantes sont lues au numéro (code de voie et numéro DVF), sinon aux parcelles de l'adresse ; celles de 2018 à 2020, dont le fichier n'a ni adresse ni parcelle, sont rapprochées par position autour du numéro. Pour chaque mutation : date, nature, valeur foncière, adresse DVF, locaux (type, surface bâtie, pièces, lots et surfaces Carrez), terrains, parcelles, volumes, position. Le prix au m² est recalculé à la mutation sur la surface de ses logements, avec sa qualité : vente en bloc, dépendance, local professionnel, prix atypique et son motif, rattachement incertain. Aucune vente : 404 ressource_absente, rien n'est débité. L'Alsace-Moselle (livre foncier) n'est pas dans DVF.

Coût: 5 crédits par appel réussi
Accès: À l'usage ou avec l'abonnement Data
Portée: adresse
Outil MCP: ventes_adresse
Bac à sable: Non
Mémoire: 24 h
Délai: 15 s

Essayer en direct

Paramètres de /api/v1/adresses/{cle_ban}/ventes

cle_bantexteobligatoire
Clé d'interopérabilité de la Base Adresse Nationale, ex. 69383_1234_00012.
depuistexte
Ne garder que les mutations à partir de cette date (AAAA-MM-JJ).
jusqu_atexte
Ne garder que les mutations jusqu'à cette date comprise (AAAA-MM-JJ).
inclure_2018_2020valeur
Ajouter les ventes de 2018 à 2020 rapprochées par position (adresse seulement). Vrai par défaut.
par défaut true
rayon_position_mentier
Rayon du rapprochement par position des ventes de 2018 à 2020, en mètres (15 par défaut, 100 au plus).
de 1 à 100 ; par défaut 15

Paramètres de /api/v1/parcelles/{id_parcelle}/ventes

id_parcelletexteobligatoire
Identifiant de parcelle cadastrale à 14 caractères, ex. 35238000AB0123.

Exemple d'appel

curl https://pillr.fr/api/v1/adresses/{cle_ban}/ventes \
  -H "Authorization: Bearer $PILLR_CLE"

Réponse

cle_bantexte ou null
Clé BAN demandée ; null pour une demande par parcelle.
id_parcelletexte ou null
Parcelle demandée ; null pour une demande par adresse.
rattachementtexte ou null
Comment les ventes 2021 et suivantes ont été trouvées : au numéro, sinon aux parcelles de l'adresse ; null si aucune.
Valeurs : numero, parcelle, position
adresseobjet ou null
L'adresse résolue (Base Adresse Nationale et faits Pillr de l'adresse) ; null pour une demande par parcelle.
Afficher les 7 champsMasquer
- numerotexte ou null
- voietexte ou null
- code_postaltexte ou null
- inseetexte ou null
- communetexte ou null
- latnombre ou null
- lonnombre ou null
parcelles_luesliste de textes
Parcelles lues pour le rattachement par parcelle.
mutationsliste d'objets
Toutes les mutations, la plus récente d'abord.
Afficher les 23 champsMasquer
- id_mutationtexte ou null
  Identifiant DVF de la mutation ; null pour une vente de 2018 à 2020 (fichier sans identifiant).
- datetexte
  Date de la mutation (AAAA-MM-JJ).
- naturetexte ou null
  Nature de la mutation : Vente, Vente en l'état futur d'achèvement, Adjudication, Échange...
- valeur_foncierenombre ou null
  Valeur foncière de la mutation entière, en euros.
- adresseobjet ou null
  Adresse DVF de la mutation (celle de ses logements d'abord) ; null quand DVF n'en donne pas.
  Afficher les 4 champsMasquer
  - numerotexte ou null
    Numéro dans la voie, suffixe compris (« 12 bis »), tel que DVF l'écrit.
  - voietexte ou null
    Libellé DVF de la voie, souvent abrégé.
  - code_voietexte ou null
    Code FANTOIR de la voie, le même que dans la clé BAN.
  - cle_bantexte ou null
    Clé BAN reconstituée depuis la commune, le code de voie et le numéro DVF : elle peut ne pas exister dans la Base Adresse Nationale.
- code_postaltexte ou null
- inseetexte ou null
  Code INSEE de la commune DVF (l'arrondissement à Paris, Lyon et Marseille).
- nb_dispositionsentier
  Dispositions de l'acte (une vente peut en compter plusieurs).
- locauxliste d'objets
  Locaux de la mutation, lus une fois par parcelle.
  Afficher les 5 champsMasquer
  - typetexte
    Type de local DVF : Appartement, Maison, Dépendance, Local industriel. commercial ou assimilé.
  - surface_batinombre ou null
    Surface réelle bâtie du local, en m².
  - piecesentier ou null
    Nombre de pièces principales.
  - id_parcelletexte ou null
  - lotsliste d'objets
    Lots déclarés sur la ligne du local (cinq au plus dans DVF).
    Afficher les 2 champsMasquer
    numerotexte
    Numéro du lot de copropriété.
    carreznombre ou null
    Surface Carrez du lot, en m² ; null quand elle n'est pas déclarée.
- nombre_lotsentier ou null
  Lots de copropriété déclarés dans la mutation.
- terrainsliste d'objets
  Terrains de la mutation, par parcelle et nature de culture.
  Afficher les 4 champsMasquer
  - id_parcelletexte ou null
  - nature_culturetexte ou null
    Nature de culture du terrain (sols, jardins, terres...).
  - nature_culture_specialetexte ou null
  - surfacenombre ou null
    Surface du terrain, en m².
- surface_terrainnombre ou null
  Somme des surfaces de terrain, en m².
- parcellesliste de textes
  Parcelles cadastrales de la mutation.
- volumesliste de textes
  Numéros de volume (division en volumes), s'il y en a.
- latnombre ou null
- lonnombre ou null
- surface_logementsnombre ou null
  Surface bâtie des appartements et maisons, en m².
- prix_m2nombre ou null
  Valeur foncière rapportée à la surface bâtie des logements, en euros par m², arrondie ; null sans logement. Recalculé à la mutation, jamais à la ligne.
- indicateursobjet
  Afficher les 6 champsMasquer
  - logementsentier
    Appartements et maisons de la mutation.
  - vente_en_blocbooléen
    Plus d'un logement : le prix au m² porte sur l'ensemble des logements.
  - avec_dependancebooléen
    La mutation comprend une dépendance (cave, parking, garage).
  - avec_local_probooléen
    La mutation comprend un local industriel, commercial ou assimilé.
  - prix_atypiquebooléen
    Surface ou prix au m² hors des bornes du barème Pillr : à lire avec prudence.
  - motiftexte ou null
    Pourquoi le prix est atypique ; null sinon.
- qualiteobjet
  Qualité du prix au m² de cette vente : une observation, ses drapeaux et sa méthode.
  Afficher les 7 champsMasquer
  - nentier ou null
    Nombre d'observations derrière la valeur ; null si sans objet.
    0 au moins
  - provenancetexte ou null
    mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
    Valeurs : mesure, estime
  - incertitudeobjet ou null
    Incertitude de la valeur : fourchette et demi-largeur.
    Afficher les 3 champsMasquer
    demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
    basnombre ou null
    hautnombre ou null
  - drapeauxliste de textes
    Ce qui doit faire lire la valeur avec prudence ; vide si rien.
    Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
  - methodetexte ou null
    Méthode de calcul ou de rattachement, en clair.
  - donnees_dutexte ou null
    Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
  - sourcetexte
    Source publique ou moteur Pillr, en clair.
- millesimetexte ou null
  Millésime du fichier DVF qui porte la mutation.
- rattachementtexte
  numero : la vente porte le code de voie et le numéro de l'adresse ; parcelle : elle porte une parcelle de l'adresse ; position : vente de 2018 à 2020 rapprochée par sa position.
  Valeurs : numero, parcelle, position
- distance_mentier ou null
  Distance entre la vente et l'adresse demandée, en mètres ; null sans position.
resumeobjet
Afficher les 4 champsMasquer
- nentier
  Mutations servies.
- n_2021_et_apresentier
- n_2018_2020entier
- derniereobjet ou null
  La mutation la plus récente.
  Afficher les 3 champsMasquer
  - datetexte
  - prixnombre ou null
  - prix_m2nombre ou null
millesimesobjet
Premier et dernier millésimes DVF des mutations servies.
Afficher les 2 champsMasquer
- premiertexte ou null
- derniertexte ou null
donnees_dutexte ou null
Date de chargement des lignes DVF servies (horodatage ISO 8601).
limitesliste de textes
Ce que la réponse ne couvre pas, en clair.
creditsobjet
Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).
Afficher les 2 champsMasquer
- debitesentier
  0 au moins
- restantsentier ou null

Erreurs possibles

400parametres_invalidesUn paramètre manque ou ne passe pas son contrôle ; le détail est donné champ par champ
401cle_absenteL'en-tête Authorization manque
401cle_invalideLa clé est inconnue, révoquée ou expirée
403organisation_suspendueL'organisation de la clé n'est pas active
403portee_insuffisanteLa clé ou l'accès de l'organisation n'ouvre pas cette opération
403hors_bac_a_sableUne clé pk_test_ l'appelle : l'opération n'a pas de bac à sable
402credits_insuffisantsLes crédits ne suffisent plus pour cet appel
429plafond_cleLe plafond mensuel de crédits de la clé est atteint
429quota_minuteLe débit par minute de l'organisation est atteint
503charge_globaleL'API est momentanément surchargée, tous clients confondus ; rien n'est débité
503creneau_reserveEntre 20h30 et minuit (heure de Paris), la réponse n'est pas déjà en mémoire
504delai_depasseLe calcul dépasse le délai de l'opération ; rien n'est débité
503service_indisponibleL'API est momentanément indisponible
500erreur_interneUne erreur de notre côté ; rien n'est servi ni débité

Une ressource absente répond par un code de la famille des ressources absentes, propre à l'opération, sans débit.

Ventes DVF autour d'un point, dans une commune ou par mutation

GET/api/v1/ventes

GET/api/v1/ventes/{id_mutation}

Les mutations DVF une par une, avec toutes leurs lignes, leur adresse DVF, leurs lots, leurs parcelles et leur position : autour d'un point (rayon de 2000 m au plus), dans une commune (l'arrondissement à Paris, Lyon et Marseille), ou par identifiant de mutation. Filtres : type de local, nature de la mutation, période, surface des logements, valeur foncière. Tri par date (le plus récent d'abord) ou par distance. Le prix au m² est recalculé à la mutation sur la surface de ses logements, avec sa qualité (vente en bloc, prix atypique et son motif). Les filtres de surface et de valeur s'appliquent après lecture : une page peut compter moins de mutations que la limite, curseur_suivant dit s'il en reste. Ventes de 2021 et suivantes ; les lignes d'une mutation situées dans une autre commune ne sont pas relues.

Coût: 1 crédit par élément rendu
Accès: À l'usage ou avec l'abonnement Data
Portée: adresse
Outil MCP: ventes
Bac à sable: Non
Mémoire: 24 h
Délai: 15 s

Essayer en direct

Paramètres de /api/v1/ventes

latnombre
Latitude du point (WGS 84), avec lon.
de -90 à 90
lonnombre
Longitude du point (WGS 84), avec lat.
de -180 à 180
rayon_mentier
Rayon autour du point, en mètres (300 par défaut, 2000 au plus).
de 10 à 2 000
inseetexte
Code INSEE de la commune DVF (l'arrondissement à Paris, Lyon et Marseille).
typetexte
Ne garder que les mutations qui comptent ce type de local.
Valeurs : appartement, maison, dependance, local
naturetexte
Nature de la mutation : vente, vefa, terrain_a_batir, adjudication, echange, expropriation.
Valeurs : vente, vefa, terrain_a_batir, adjudication, echange, expropriation
depuistexte
Mutations à partir de cette date (AAAA-MM-JJ).
jusqu_atexte
Mutations jusqu'à cette date comprise (AAAA-MM-JJ).
surface_minnombre
Surface bâtie des logements, minimum, en m².
0 au moins
surface_maxnombre
Surface bâtie des logements, maximum, en m².
0 au moins
prix_minnombre
Valeur foncière de la mutation, minimum, en euros.
0 au moins
prix_maxnombre
Valeur foncière de la mutation, maximum, en euros.
0 au moins
tritexte
date (le plus récent d'abord) ou distance (autour d'un point seulement). Par défaut : distance autour d'un point, date sinon.
Valeurs : date, distance
limiteentier
Nombre d'éléments par page (50 au plus).
de 1 à 50 ; par défaut 20
curseurtexte
Curseur opaque rendu par la page précédente (curseur_suivant), à repasser tel quel.
de 1 à 1 024 caractères

Paramètres de /api/v1/ventes/{id_mutation}

id_mutationtexteobligatoire
Identifiant DVF de la mutation, ex. 2024-426100.

Exemple d'appel

curl https://pillr.fr/api/v1/ventes \
  -H "Authorization: Bearer $PILLR_CLE"

Réponse

rechercheobjet
La recherche servie, telle que lue.
Afficher les 6 champsMasquer
- modetexte
  Valeurs : mutation, point, commune
- tritexte
  Valeurs : date, distance
- inseetexte ou null
- latnombre ou null
- lonnombre ou null
- rayon_mentier ou null
donneesliste d'objets
Les mutations de la page, chacune avec toutes ses lignes et son adresse.
Afficher les 23 champsMasquer
- id_mutationtexte ou null
  Identifiant DVF de la mutation ; null pour une vente de 2018 à 2020 (fichier sans identifiant).
- datetexte
  Date de la mutation (AAAA-MM-JJ).
- naturetexte ou null
  Nature de la mutation : Vente, Vente en l'état futur d'achèvement, Adjudication, Échange...
- valeur_foncierenombre ou null
  Valeur foncière de la mutation entière, en euros.
- adresseobjet ou null
  Adresse DVF de la mutation (celle de ses logements d'abord) ; null quand DVF n'en donne pas.
  Afficher les 4 champsMasquer
  - numerotexte ou null
    Numéro dans la voie, suffixe compris (« 12 bis »), tel que DVF l'écrit.
  - voietexte ou null
    Libellé DVF de la voie, souvent abrégé.
  - code_voietexte ou null
    Code FANTOIR de la voie, le même que dans la clé BAN.
  - cle_bantexte ou null
    Clé BAN reconstituée depuis la commune, le code de voie et le numéro DVF : elle peut ne pas exister dans la Base Adresse Nationale.
- code_postaltexte ou null
- inseetexte ou null
  Code INSEE de la commune DVF (l'arrondissement à Paris, Lyon et Marseille).
- nb_dispositionsentier
  Dispositions de l'acte (une vente peut en compter plusieurs).
- locauxliste d'objets
  Locaux de la mutation, lus une fois par parcelle.
  Afficher les 5 champsMasquer
  - typetexte
    Type de local DVF : Appartement, Maison, Dépendance, Local industriel. commercial ou assimilé.
  - surface_batinombre ou null
    Surface réelle bâtie du local, en m².
  - piecesentier ou null
    Nombre de pièces principales.
  - id_parcelletexte ou null
  - lotsliste d'objets
    Lots déclarés sur la ligne du local (cinq au plus dans DVF).
    Afficher les 2 champsMasquer
    numerotexte
    Numéro du lot de copropriété.
    carreznombre ou null
    Surface Carrez du lot, en m² ; null quand elle n'est pas déclarée.
- nombre_lotsentier ou null
  Lots de copropriété déclarés dans la mutation.
- terrainsliste d'objets
  Terrains de la mutation, par parcelle et nature de culture.
  Afficher les 4 champsMasquer
  - id_parcelletexte ou null
  - nature_culturetexte ou null
    Nature de culture du terrain (sols, jardins, terres...).
  - nature_culture_specialetexte ou null
  - surfacenombre ou null
    Surface du terrain, en m².
- surface_terrainnombre ou null
  Somme des surfaces de terrain, en m².
- parcellesliste de textes
  Parcelles cadastrales de la mutation.
- volumesliste de textes
  Numéros de volume (division en volumes), s'il y en a.
- latnombre ou null
- lonnombre ou null
- surface_logementsnombre ou null
  Surface bâtie des appartements et maisons, en m².
- prix_m2nombre ou null
  Valeur foncière rapportée à la surface bâtie des logements, en euros par m², arrondie ; null sans logement. Recalculé à la mutation, jamais à la ligne.
- indicateursobjet
  Afficher les 6 champsMasquer
  - logementsentier
    Appartements et maisons de la mutation.
  - vente_en_blocbooléen
    Plus d'un logement : le prix au m² porte sur l'ensemble des logements.
  - avec_dependancebooléen
    La mutation comprend une dépendance (cave, parking, garage).
  - avec_local_probooléen
    La mutation comprend un local industriel, commercial ou assimilé.
  - prix_atypiquebooléen
    Surface ou prix au m² hors des bornes du barème Pillr : à lire avec prudence.
  - motiftexte ou null
    Pourquoi le prix est atypique ; null sinon.
- qualiteobjet
  Qualité du prix au m² de cette vente : une observation, ses drapeaux et sa méthode.
  Afficher les 7 champsMasquer
  - nentier ou null
    Nombre d'observations derrière la valeur ; null si sans objet.
    0 au moins
  - provenancetexte ou null
    mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
    Valeurs : mesure, estime
  - incertitudeobjet ou null
    Incertitude de la valeur : fourchette et demi-largeur.
    Afficher les 3 champsMasquer
    demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
    basnombre ou null
    hautnombre ou null
  - drapeauxliste de textes
    Ce qui doit faire lire la valeur avec prudence ; vide si rien.
    Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
  - methodetexte ou null
    Méthode de calcul ou de rattachement, en clair.
  - donnees_dutexte ou null
    Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
  - sourcetexte
    Source publique ou moteur Pillr, en clair.
- millesimetexte ou null
  Millésime du fichier DVF qui porte la mutation.
- distance_mentier ou null
  Distance au point demandé, en mètres ; null hors d'une recherche autour d'un point.
- iristexte ou null
  Code IRIS de la vente (ventes de logement rattachées par Pillr) ; null sinon.
limitesliste de textes
Ce que la page ne couvre pas, en clair.
curseur_suivanttexte ou null
Curseur de la page suivante, à repasser dans curseur ; null sur la dernière page.
creditsobjet
Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).
Afficher les 2 champsMasquer
- debitesentier
  0 au moins
- restantsentier ou null

Erreurs possibles

400parametres_invalidesUn paramètre manque ou ne passe pas son contrôle ; le détail est donné champ par champ
401cle_absenteL'en-tête Authorization manque
401cle_invalideLa clé est inconnue, révoquée ou expirée
403organisation_suspendueL'organisation de la clé n'est pas active
403portee_insuffisanteLa clé ou l'accès de l'organisation n'ouvre pas cette opération
403hors_bac_a_sableUne clé pk_test_ l'appelle : l'opération n'a pas de bac à sable
402credits_insuffisantsLes crédits ne suffisent plus pour cet appel
429plafond_cleLe plafond mensuel de crédits de la clé est atteint
429quota_minuteLe débit par minute de l'organisation est atteint
503charge_globaleL'API est momentanément surchargée, tous clients confondus ; rien n'est débité
503creneau_reserveEntre 20h30 et minuit (heure de Paris), la réponse n'est pas déjà en mémoire
504delai_depasseLe calcul dépasse le délai de l'opération ; rien n'est débité
503service_indisponibleL'API est momentanément indisponible
500erreur_interneUne erreur de notre côté ; rien n'est servi ni débité

Une ressource absente répond par un code de la famille des ressources absentes, propre à l'opération, sans débit.

Ventes d'une rue ou d'une commune

GET/api/v1/ventes/rue

Les ventes DVF d'une rue (par son nom géocodé dans la Base Adresse Nationale, ou par son code de voie) ou d'une commune (l'arrondissement à Paris, Lyon et Marseille), lues à la vente entière : une vente d'un seul logement, hors local professionnel et vente en bloc, comme le barème Pillr. Par type de bien, sur la période entière puis année par année : nombre de ventes, médiane, quartiles dès 2 ventes, minimum, maximum, surface médiane, dernière vente, sans seuil de publication. Les ventes au prix atypique sont écartées des agrégats et comptées. À la voie, chaque vente est listée avec son numéro et sa qualité. Le prix de référence de la commune est le barème Pillr, le même que les pages communes. Mêmes calculs que l'outil ventes_rue du Hub.

Coût: 5 crédits par appel réussi
Accès: À l'usage ou avec l'abonnement Data
Portée: adresse
Outil MCP: ventes_rue
Bac à sable: Non
Mémoire: 24 h
Délai: 15 s

Essayer en direct

Paramètres

voietexte
Nom de la voie, ex. « rue de Genève ».
de 2 à 160 caractères
code_voietexte
Code FANTOIR de la voie (deuxième segment de la clé BAN), avec insee, au lieu de son nom.
inseetexte
Code INSEE de la commune DVF (l'arrondissement à Paris, Lyon et Marseille).
code_postaltexte
Code postal, à défaut du code INSEE.
typetexte
Ne servir qu'un type de bien.
Valeurs : appartement, maison
depuistexte
Ne compter que les ventes à partir de cette date (AAAA-MM-JJ).

Exemple d'appel

curl https://pillr.fr/api/v1/ventes/rue \
  -H "Authorization: Bearer $PILLR_CLE"

Réponse

cibleobjet
Afficher les 6 champsMasquer
- perimetretexte
  Valeurs : voie, commune
- voietexte ou null
  La voie retenue (libellé de la Base Adresse Nationale, ou celui que DVF écrit quand la voie est donnée par son code).
- code_voietexte ou null
- communetexte ou null
- inseetexte
- code_postaltexte ou null
par_typeobjet
Afficher les 2 champsMasquer
- appartementobjet ou null
  Afficher les 3 champsMasquer
  - periodeobjet ou null
    Toutes les années réunies, prix non ramenés à une même date ; null sans vente typique.
    Afficher les 11 champsMasquer
    periodetexte
    Période couverte, ex. « 2021 à 2025 ».
    nentier
    Ventes typiques qui portent l'agrégat : à lire avant la médiane.
    mediane_m2nombre
    Prix au m² médian, en euros.
    q1nombre ou null
    Premier quartile du prix au m², dès 2 ventes.
    q3nombre ou null
    Troisième quartile du prix au m², dès 2 ventes.
    minnombre
    maxnombre
    surface_medianenombre
    Surface médiane, en m².
    derniere_vente_letexte
    n_prix_atypiquesentier
    Ventes au prix atypique du groupe, écartées de l'agrégat (listées à la voie).
    qualiteobjet
    Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
    Afficher les 7 champsMasquer
    nentier ou null
    Nombre d'observations derrière la valeur ; null si sans objet.
    0 au moins
    provenancetexte ou null
    mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
    Valeurs : mesure, estime
    incertitudeobjet ou null
    Incertitude de la valeur : fourchette et demi-largeur.
    Afficher les 3 champsMasquer
    demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
    basnombre ou null
    hautnombre ou null
    drapeauxliste de textes
    Ce qui doit faire lire la valeur avec prudence ; vide si rien.
    Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
    methodetexte ou null
    Méthode de calcul ou de rattachement, en clair.
    donnees_dutexte ou null
    Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
    sourcetexte
    Source publique ou moteur Pillr, en clair.
  - par_anneeliste d'objets
    Chaque année qui compte au moins une vente typique, la plus récente d'abord.
    Afficher les 11 champsMasquer
    anneeentier
    nentier
    Ventes typiques qui portent l'agrégat : à lire avant la médiane.
    mediane_m2nombre
    Prix au m² médian, en euros.
    q1nombre ou null
    Premier quartile du prix au m², dès 2 ventes.
    q3nombre ou null
    Troisième quartile du prix au m², dès 2 ventes.
    minnombre
    maxnombre
    surface_medianenombre
    Surface médiane, en m².
    derniere_vente_letexte
    n_prix_atypiquesentier
    Ventes au prix atypique du groupe, écartées de l'agrégat (listées à la voie).
    qualiteobjet
    Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
    Afficher les 7 champsMasquer
    nentier ou null
    Nombre d'observations derrière la valeur ; null si sans objet.
    0 au moins
    provenancetexte ou null
    mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
    Valeurs : mesure, estime
    incertitudeobjet ou null
    Incertitude de la valeur : fourchette et demi-largeur.
    Afficher les 3 champsMasquer
    demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
    basnombre ou null
    hautnombre ou null
    drapeauxliste de textes
    Ce qui doit faire lire la valeur avec prudence ; vide si rien.
    Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
    methodetexte ou null
    Méthode de calcul ou de rattachement, en clair.
    donnees_dutexte ou null
    Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
    sourcetexte
    Source publique ou moteur Pillr, en clair.
  - notetexte ou null
- maisonobjet ou null
  Afficher les 3 champsMasquer
  - periodeobjet ou null
    Toutes les années réunies, prix non ramenés à une même date ; null sans vente typique.
    Afficher les 11 champsMasquer
    periodetexte
    Période couverte, ex. « 2021 à 2025 ».
    nentier
    Ventes typiques qui portent l'agrégat : à lire avant la médiane.
    mediane_m2nombre
    Prix au m² médian, en euros.
    q1nombre ou null
    Premier quartile du prix au m², dès 2 ventes.
    q3nombre ou null
    Troisième quartile du prix au m², dès 2 ventes.
    minnombre
    maxnombre
    surface_medianenombre
    Surface médiane, en m².
    derniere_vente_letexte
    n_prix_atypiquesentier
    Ventes au prix atypique du groupe, écartées de l'agrégat (listées à la voie).
    qualiteobjet
    Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
    Afficher les 7 champsMasquer
    nentier ou null
    Nombre d'observations derrière la valeur ; null si sans objet.
    0 au moins
    provenancetexte ou null
    mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
    Valeurs : mesure, estime
    incertitudeobjet ou null
    Incertitude de la valeur : fourchette et demi-largeur.
    Afficher les 3 champsMasquer
    demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
    basnombre ou null
    hautnombre ou null
    drapeauxliste de textes
    Ce qui doit faire lire la valeur avec prudence ; vide si rien.
    Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
    methodetexte ou null
    Méthode de calcul ou de rattachement, en clair.
    donnees_dutexte ou null
    Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
    sourcetexte
    Source publique ou moteur Pillr, en clair.
  - par_anneeliste d'objets
    Chaque année qui compte au moins une vente typique, la plus récente d'abord.
    Afficher les 11 champsMasquer
    anneeentier
    nentier
    Ventes typiques qui portent l'agrégat : à lire avant la médiane.
    mediane_m2nombre
    Prix au m² médian, en euros.
    q1nombre ou null
    Premier quartile du prix au m², dès 2 ventes.
    q3nombre ou null
    Troisième quartile du prix au m², dès 2 ventes.
    minnombre
    maxnombre
    surface_medianenombre
    Surface médiane, en m².
    derniere_vente_letexte
    n_prix_atypiquesentier
    Ventes au prix atypique du groupe, écartées de l'agrégat (listées à la voie).
    qualiteobjet
    Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
    Afficher les 7 champsMasquer
    nentier ou null
    Nombre d'observations derrière la valeur ; null si sans objet.
    0 au moins
    provenancetexte ou null
    mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
    Valeurs : mesure, estime
    incertitudeobjet ou null
    Incertitude de la valeur : fourchette et demi-largeur.
    Afficher les 3 champsMasquer
    demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
    basnombre ou null
    hautnombre ou null
    drapeauxliste de textes
    Ce qui doit faire lire la valeur avec prudence ; vide si rien.
    Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
    methodetexte ou null
    Méthode de calcul ou de rattachement, en clair.
    donnees_dutexte ou null
    Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
    sourcetexte
    Source publique ou moteur Pillr, en clair.
  - notetexte ou null
ventesliste d'objets
À la voie : chaque vente, numéro compris, la plus récente d'abord ; vide pour une commune.
Afficher les 9 champsMasquer
- datetexte
- numerotexte ou null
  Numéro dans la voie, suffixe compris ; null quand DVF n'en donne pas.
- adressetexte ou null
  Numéro et voie, tels que DVF les écrit.
- typetexte
  Valeurs : appartement, maison
- surfacenombre
  Surface du logement, en m².
- prixnombre ou null
  Valeur foncière de la mutation, en euros.
- prix_m2nombre
- id_mutationtexte ou null
- qualiteobjet
  Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
  Afficher les 7 champsMasquer
  - nentier ou null
    Nombre d'observations derrière la valeur ; null si sans objet.
    0 au moins
  - provenancetexte ou null
    mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
    Valeurs : mesure, estime
  - incertitudeobjet ou null
    Incertitude de la valeur : fourchette et demi-largeur.
    Afficher les 3 champsMasquer
    demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
    basnombre ou null
    hautnombre ou null
  - drapeauxliste de textes
    Ce qui doit faire lire la valeur avec prudence ; vide si rien.
    Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
  - methodetexte ou null
    Méthode de calcul ou de rattachement, en clair.
  - donnees_dutexte ou null
    Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
  - sourcetexte
    Source publique ou moteur Pillr, en clair.
ventes_totalentier ou null
Ventes de la voie quand la liste est tronquée ; null sinon.
prix_reference_communeobjet
Afficher les 3 champsMasquer
- appartementobjet ou null
  Afficher les 3 champsMasquer
  - prix_m2nombre
  - libelletexte
    Comment citer ce prix.
  - qualiteobjet
    Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
    Afficher les 7 champsMasquer
    nentier ou null
    Nombre d'observations derrière la valeur ; null si sans objet.
    0 au moins
    provenancetexte ou null
    mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
    Valeurs : mesure, estime
    incertitudeobjet ou null
    Incertitude de la valeur : fourchette et demi-largeur.
    Afficher les 3 champsMasquer
    demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
    basnombre ou null
    hautnombre ou null
    drapeauxliste de textes
    Ce qui doit faire lire la valeur avec prudence ; vide si rien.
    Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
    methodetexte ou null
    Méthode de calcul ou de rattachement, en clair.
    donnees_dutexte ou null
    Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
    sourcetexte
    Source publique ou moteur Pillr, en clair.
- maisonobjet ou null
  Afficher les 3 champsMasquer
  - prix_m2nombre
  - libelletexte
    Comment citer ce prix.
  - qualiteobjet
    Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
    Afficher les 7 champsMasquer
    nentier ou null
    Nombre d'observations derrière la valeur ; null si sans objet.
    0 au moins
    provenancetexte ou null
    mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
    Valeurs : mesure, estime
    incertitudeobjet ou null
    Incertitude de la valeur : fourchette et demi-largeur.
    Afficher les 3 champsMasquer
    demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
    basnombre ou null
    hautnombre ou null
    drapeauxliste de textes
    Ce qui doit faire lire la valeur avec prudence ; vide si rien.
    Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
    methodetexte ou null
    Méthode de calcul ou de rattachement, en clair.
    donnees_dutexte ou null
    Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
    sourcetexte
    Source publique ou moteur Pillr, en clair.
- sourcetexte
millesimestexte ou null
notetexte
limitesliste de textes
creditsobjet
Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).
Afficher les 2 champsMasquer
- debitesentier
  0 au moins
- restantsentier ou null

Erreurs possibles

400parametres_invalidesUn paramètre manque ou ne passe pas son contrôle ; le détail est donné champ par champ
401cle_absenteL'en-tête Authorization manque
401cle_invalideLa clé est inconnue, révoquée ou expirée
403organisation_suspendueL'organisation de la clé n'est pas active
403portee_insuffisanteLa clé ou l'accès de l'organisation n'ouvre pas cette opération
403hors_bac_a_sableUne clé pk_test_ l'appelle : l'opération n'a pas de bac à sable
402credits_insuffisantsLes crédits ne suffisent plus pour cet appel
429plafond_cleLe plafond mensuel de crédits de la clé est atteint
429quota_minuteLe débit par minute de l'organisation est atteint
503charge_globaleL'API est momentanément surchargée, tous clients confondus ; rien n'est débité
503creneau_reserveEntre 20h30 et minuit (heure de Paris), la réponse n'est pas déjà en mémoire
504delai_depasseLe calcul dépasse le délai de l'opération ; rien n'est débité
503service_indisponibleL'API est momentanément indisponible
500erreur_interneUne erreur de notre côté ; rien n'est servi ni débité

Une ressource absente répond par un code de la famille des ressources absentes, propre à l'opération, sans débit.

Tous les DPE d'une adresse, logement par logement

GET/api/v1/adresses/{cle_ban}/dpe

Tous les DPE d'une adresse de la Base Adresse Nationale, logement par logement : numéro, dates, étiquettes énergie et GES, consommation et émissions, surface, type, étage et complément d'adresse, méthode, fin de validité, DPE remplacé, échéance d'interdiction de louer. Sources : DPE de logements existants et neufs et DPE tertiaires portant la clé BAN, DPE d'avant juillet 2021 rapprochés par position (30 m au plus). S'y ajoutent l'historique des étiquettes de l'adresse, ses audits énergétiques (classe visée, coût maximal) et la répartition des DPE de sa commune. Aucun DPE, aucun audit ni aucun historique : 404 ressource_absente, rien n'est débité.

Coût: 3 crédits par appel réussi
Accès: À l'usage ou avec l'abonnement Data
Portée: adresse
Outil MCP: dpe_adresse
Bac à sable: Non
Mémoire: 24 h
Délai: 8 s

Essayer en direct

Paramètres

cle_bantexteobligatoire
Clé d'interopérabilité de la Base Adresse Nationale, ex. 69383_1234_00012.
sourcesvaleur
Les sources à lire (existant, neuf, tertiaire, ancien), séparées par des virgules ; toutes par défaut.

Exemple d'appel

curl https://pillr.fr/api/v1/adresses/{cle_ban}/dpe \
  -H "Authorization: Bearer $PILLR_CLE"

Réponse

cle_bantexte
adresseobjet ou null
Afficher les 5 champsMasquer
- inseetexte ou null
- code_postaltexte ou null
- communetexte ou null
- latnombre ou null
- lonnombre ou null
dpeliste d'objets
Tous les DPE de l'adresse, logement par logement, le plus récent d'abord.
Afficher les 22 champsMasquer
- numerotexte
- sourcetexte
  existant, neuf, tertiaire (depuis juillet 2021) ou ancien (avant juillet 2021).
  Valeurs : existant, neuf, tertiaire, ancien
- etabli_letexte ou null
- fin_validitetexte ou null
- remplacetexte ou null
  Numéro du DPE que celui-ci remplace.
- etiquettetexte ou null
  Valeurs : A, B, C, D, E, F, G
- gestexte ou null
  Valeurs : A, B, C, D, E, F, G
- conso_kwh_m2nombre ou null
  Consommation d'énergie primaire, en kWh par m² et par an.
- ges_kg_m2nombre ou null
  Émissions de gaz à effet de serre, en kg de CO2 par m² et par an.
- surfacenombre ou null
  Surface habitable du logement (surface utile pour un DPE tertiaire), en m².
- typetexte ou null
  Type de bâtiment (maison, appartement, immeuble), ou secteur d'activité d'un DPE tertiaire.
- etageentier ou null
- complementtexte ou null
  Complément d'adresse du logement (porte, bâtiment), tel que le diagnostiqueur l'écrit.
- methodetexte ou null
- periodetexte ou null
  Période de construction.
- annee_constructionentier ou null
- chauffagetexte ou null
  Énergie principale du chauffage.
- rattachementtexte
  cle_ban : le DPE porte la clé BAN de l'adresse ; position : DPE d'avant juillet 2021 rapproché par sa position.
  Valeurs : cle_ban, position
- distance_mentier ou null
  Distance à l'adresse d'un DPE rapproché par position ; null sinon.
- interdiction_locationtexte ou null
  Premier jour où la location d'un logement de cette classe est interdite (AAAA-MM-JJ), selon le calendrier de la loi Climat et résilience en métropole (G 2025, F 2028, E 2034). null : classe sans échéance, DPE absent, ou adresse hors de la métropole (le calendrier des outre-mer n'est pas servi).
- mois_restantsentier ou null
  Mois pleins avant l'échéance ; 0 quand l'interdiction est déjà en vigueur ; null sans échéance.
- qualiteobjet
  Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
  Afficher les 7 champsMasquer
  - nentier ou null
    Nombre d'observations derrière la valeur ; null si sans objet.
    0 au moins
  - provenancetexte ou null
    mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
    Valeurs : mesure, estime
  - incertitudeobjet ou null
    Incertitude de la valeur : fourchette et demi-largeur.
    Afficher les 3 champsMasquer
    demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
    basnombre ou null
    hautnombre ou null
  - drapeauxliste de textes
    Ce qui doit faire lire la valeur avec prudence ; vide si rien.
    Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
  - methodetexte ou null
    Méthode de calcul ou de rattachement, en clair.
  - donnees_dutexte ou null
    Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
  - sourcetexte
    Source publique ou moteur Pillr, en clair.
historiqueliste d'objets
Les étiquettes successives de l'adresse, la plus ancienne d'abord.
Afficher les 2 champsMasquer
- datetexte
- etiquettetexte ou null
  Valeurs : A, B, C, D, E, F, G
auditsliste d'objets
Afficher les 7 champsMasquer
- n_audittexte
- etabli_letexte ou null
- classe_departtexte ou null
  Classe du logement à l'état initial de l'audit.
  Valeurs : A, B, C, D, E, F, G
- classe_viseetexte ou null
  Meilleure classe atteinte par une étape de l'audit.
  Valeurs : A, B, C, D, E, F, G
- cout_maxnombre ou null
  Coût cumulé le plus élevé chiffré par l'audit, en euros.
- etapesentier
- qualiteobjet
  Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
  Afficher les 7 champsMasquer
  - nentier ou null
    Nombre d'observations derrière la valeur ; null si sans objet.
    0 au moins
  - provenancetexte ou null
    mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
    Valeurs : mesure, estime
  - incertitudeobjet ou null
    Incertitude de la valeur : fourchette et demi-largeur.
    Afficher les 3 champsMasquer
    demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
    basnombre ou null
    hautnombre ou null
  - drapeauxliste de textes
    Ce qui doit faire lire la valeur avec prudence ; vide si rien.
    Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
  - methodetexte ou null
    Méthode de calcul ou de rattachement, en clair.
  - donnees_dutexte ou null
    Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
  - sourcetexte
    Source publique ou moteur Pillr, en clair.
contexte_communeobjet ou null
Les DPE de la commune de l'adresse : répartition des étiquettes et part de passoires ; null si indisponible.
Afficher les 6 champsMasquer
- inseetexte
- totalentier ou null
- repartitionobjet
  Afficher les 8 champsMasquer
  - Aentier ou null
  - Bentier ou null
  - Centier ou null
  - Dentier ou null
  - Eentier ou null
  - Fentier ou null
  - Gentier ou null
  - non_renseigneentier ou null
- part_passoires_pctnombre ou null
- part_f_g_pctnombre ou null
- qualiteobjet
  Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
  Afficher les 7 champsMasquer
  - nentier ou null
    Nombre d'observations derrière la valeur ; null si sans objet.
    0 au moins
  - provenancetexte ou null
    mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
    Valeurs : mesure, estime
  - incertitudeobjet ou null
    Incertitude de la valeur : fourchette et demi-largeur.
    Afficher les 3 champsMasquer
    demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
    basnombre ou null
    hautnombre ou null
  - drapeauxliste de textes
    Ce qui doit faire lire la valeur avec prudence ; vide si rien.
    Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
  - methodetexte ou null
    Méthode de calcul ou de rattachement, en clair.
  - donnees_dutexte ou null
    Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
  - sourcetexte
    Source publique ou moteur Pillr, en clair.
limitesliste de textes
creditsobjet
Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).
Afficher les 2 champsMasquer
- debitesentier
  0 au moins
- restantsentier ou null

Erreurs possibles

400parametres_invalidesUn paramètre manque ou ne passe pas son contrôle ; le détail est donné champ par champ
401cle_absenteL'en-tête Authorization manque
401cle_invalideLa clé est inconnue, révoquée ou expirée
403organisation_suspendueL'organisation de la clé n'est pas active
403portee_insuffisanteLa clé ou l'accès de l'organisation n'ouvre pas cette opération
403hors_bac_a_sableUne clé pk_test_ l'appelle : l'opération n'a pas de bac à sable
402credits_insuffisantsLes crédits ne suffisent plus pour cet appel
429plafond_cleLe plafond mensuel de crédits de la clé est atteint
429quota_minuteLe débit par minute de l'organisation est atteint
503charge_globaleL'API est momentanément surchargée, tous clients confondus ; rien n'est débité
504delai_depasseLe calcul dépasse le délai de l'opération ; rien n'est débité
503service_indisponibleL'API est momentanément indisponible
500erreur_interneUne erreur de notre côté ; rien n'est servi ni débité

Une ressource absente répond par un code de la famille des ressources absentes, propre à l'opération, sans débit.

Un DPE par son numéro, ou les DPE d'un disque ou d'une commune

GET/api/v1/dpe

GET/api/v1/dpe/{numero_dpe}

Un DPE par son numéro (logement existant ou neuf, tertiaire, ou d'avant juillet 2021) avec toutes ses colonnes ADEME : étiquettes, consommations et émissions par usage et par énergie, coûts, déperditions, isolation, chauffage, eau chaude, ventilation, copropriété, identifiant RNB. Ou les DPE de logements existants autour d'un point (2000 m au plus, le plus proche d'abord) ou dans une commune (le plus récent d'abord), filtrés par étiquette, GES, surface, type de bâtiment et date : le DPE inversé. Les annonces dont l'empreinte concorde avec le DPE sont jointes. Le paramètre champs réduit chaque DPE aux champs demandés.

Coût: 1 crédit par élément rendu
Accès: À l'usage ou avec l'abonnement Data
Portée: adresse
Outil MCP: dpe
Bac à sable: Non
Mémoire: 24 h
Délai: 15 s

Essayer en direct

Paramètres de /api/v1/dpe

latnombre
de -90 à 90
lonnombre
de -180 à 180
rayon_mentier
Rayon autour du point, en mètres (250 par défaut).
de 10 à 2 000
inseetexte
Code INSEE de la commune ou de l'arrondissement (5 caractères, 2A ou 2B pour la Corse).
etiquettevaleur
Une ou plusieurs étiquettes A à G, ex. E,F,G.
gesvaleur
Une ou plusieurs étiquettes GES A à G.
surface_minnombre
0 au moins
surface_maxnombre
0 au moins
typetexte
Type de bâtiment du DPE.
Valeurs : appartement, maison, immeuble
depuistexte
DPE établis à partir de cette date.
jusqu_atexte
DPE établis jusqu'à cette date comprise.
limiteentier
Nombre d'éléments par page (50 au plus).
de 1 à 50 ; par défaut 20
curseurtexte
Curseur opaque rendu par la page précédente (curseur_suivant), à repasser tel quel.
de 1 à 1 024 caractères
champsvaleur
Champs rendus, séparés par des virgules (« prix,surface,analyse.score ») ; tous si absent.

Paramètres de /api/v1/dpe/{numero_dpe}

numero_dpetexteobligatoire
Numéro du DPE à l'ADEME, ex. 2435E0123456X.

Exemple d'appel

curl https://pillr.fr/api/v1/dpe \
  -H "Authorization: Bearer $PILLR_CLE"

Réponse

rechercheobjet
Afficher les 5 champsMasquer
- modetexte
  Valeurs : numero, point, commune
- inseetexte ou null
- latnombre ou null
- lonnombre ou null
- rayon_mentier ou null
donneesliste d'objets
Afficher les 29 champsMasquer
- numero_dpetexte
- sourcetextefacultatif
  existant, neuf, tertiaire (depuis juillet 2021) ou ancien (avant juillet 2021).
  Valeurs : existant, neuf, tertiaire, ancien
- etabli_letexte ou nullfacultatif
- fin_validitetexte ou nullfacultatif
- remplacetexte ou nullfacultatif
- etiquettetexte ou nullfacultatif
  Valeurs : A, B, C, D, E, F, G
- gestexte ou nullfacultatif
  Valeurs : A, B, C, D, E, F, G
- conso_kwh_m2nombre ou nullfacultatif
- ges_kg_m2nombre ou nullfacultatif
- surfacenombre ou nullfacultatif
- typetexte ou nullfacultatif
- periodetexte ou nullfacultatif
- annee_constructionentier ou nullfacultatif
- etageentier ou nullfacultatif
- complementtexte ou nullfacultatif
- id_rnbtexte ou nullfacultatif
  Identifiant du bâtiment au Référentiel national des bâtiments.
- coproprietetexte ou nullfacultatif
  Numéro d'immatriculation de la copropriété au registre national.
- cle_bantexte ou nullfacultatif
- adresse_bantexte ou nullfacultatif
- inseetexte ou nullfacultatif
- code_postaltexte ou nullfacultatif
- latnombre ou nullfacultatif
- lonnombre ou nullfacultatif
- distance_mentier ou nullfacultatif
  Distance au point demandé, en mètres ; null hors d'une recherche autour d'un point.
- interdiction_locationtexte ou nullfacultatif
  Premier jour où la location d'un logement de cette classe est interdite (AAAA-MM-JJ), selon le calendrier de la loi Climat et résilience en métropole (G 2025, F 2028, E 2034). null : classe sans échéance, DPE absent, ou adresse hors de la métropole (le calendrier des outre-mer n'est pas servi).
- mois_restantsentier ou nullfacultatif
  Mois pleins avant l'échéance ; 0 quand l'interdiction est déjà en vigueur ; null sans échéance.
- annonces_rattacheesliste d'objetsfacultatif
  Annonces dont l'empreinte (étiquettes, consommation, surface, adresse) concorde avec ce DPE.
  Afficher les 4 champsMasquer
  - idtexte ou null
    Identifiant de l'annonce sur son portail (lbc:, bienici:, seloger:), quand Pillr le reconnaît.
  - parue_letexte ou null
  - activebooléen ou null
  - ecart_surfacenombre ou null
    Écart entre la surface de l'annonce et celle du DPE, en m².
- ademeobjetfacultatif
  Toutes les colonnes du DPE telles que l'ADEME les publie (consommations et coûts par usage et par énergie, déperditions, isolation, systèmes).
- qualiteobjetfacultatif
  Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
  Afficher les 7 champsMasquer
  - nentier ou null
    Nombre d'observations derrière la valeur ; null si sans objet.
    0 au moins
  - provenancetexte ou null
    mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
    Valeurs : mesure, estime
  - incertitudeobjet ou null
    Incertitude de la valeur : fourchette et demi-largeur.
    Afficher les 3 champsMasquer
    demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
    basnombre ou null
    hautnombre ou null
  - drapeauxliste de textes
    Ce qui doit faire lire la valeur avec prudence ; vide si rien.
    Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
  - methodetexte ou null
    Méthode de calcul ou de rattachement, en clair.
  - donnees_dutexte ou null
    Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
  - sourcetexte
    Source publique ou moteur Pillr, en clair.
limitesliste de textes
curseur_suivanttexte ou null
Curseur de la page suivante, à repasser dans curseur ; null sur la dernière page.
creditsobjet
Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).
Afficher les 2 champsMasquer
- debitesentier
  0 au moins
- restantsentier ou null

Erreurs possibles

400parametres_invalidesUn paramètre manque ou ne passe pas son contrôle ; le détail est donné champ par champ
401cle_absenteL'en-tête Authorization manque
401cle_invalideLa clé est inconnue, révoquée ou expirée
403organisation_suspendueL'organisation de la clé n'est pas active
403portee_insuffisanteLa clé ou l'accès de l'organisation n'ouvre pas cette opération
403hors_bac_a_sableUne clé pk_test_ l'appelle : l'opération n'a pas de bac à sable
402credits_insuffisantsLes crédits ne suffisent plus pour cet appel
429plafond_cleLe plafond mensuel de crédits de la clé est atteint
429quota_minuteLe débit par minute de l'organisation est atteint
503charge_globaleL'API est momentanément surchargée, tous clients confondus ; rien n'est débité
503creneau_reserveEntre 20h30 et minuit (heure de Paris), la réponse n'est pas déjà en mémoire
504delai_depasseLe calcul dépasse le délai de l'opération ; rien n'est débité
503service_indisponibleL'API est momentanément indisponible
500erreur_interneUne erreur de notre côté ; rien n'est servi ni débité

Une ressource absente répond par un code de la famille des ressources absentes, propre à l'opération, sans débit.

Audits énergétiques et leurs scénarios

GET/api/v1/audits/{n_audit}

GET/api/v1/adresses/{cle_ban}/audits

Les audits énergétiques réglementaires de l'ADEME, par numéro d'audit ou à une adresse de la Base Adresse Nationale, avec tous leurs scénarios et leurs étapes de travaux : classe atteinte, consommation, coût de l'étape et coût cumulé, gains de facture et de consommation, travaux décrits par l'auditeur. Ce sont des estimations d'auditeur, pas des devis. Aucun audit : 404 ressource_absente, rien n'est débité.

Coût: 3 crédits par élément rendu
Accès: À l'usage ou avec l'abonnement Data
Portée: adresse
Outil MCP: audits_energetiques
Bac à sable: Non
Mémoire: 24 h
Délai: 15 s

Essayer en direct

Paramètres de /api/v1/audits/{n_audit}

n_audittexteobligatoire
Numéro de l'audit énergétique à l'ADEME, ex. A243500000001.

Paramètres de /api/v1/adresses/{cle_ban}/audits

cle_bantexteobligatoire
Clé d'interopérabilité de la Base Adresse Nationale, ex. 69383_1234_00012.

Exemple d'appel

curl https://pillr.fr/api/v1/audits/{n_audit} \
  -H "Authorization: Bearer $PILLR_CLE"

Réponse

auditsliste d'objets
Les audits, le plus récent d'abord.
Afficher les 17 champsMasquer
- n_audittexte
- etabli_letexte ou null
- fin_validitetexte ou null
- remplacetexte ou null
- numero_dpetexte ou null
  Numéro du DPE de l'état initial.
- cle_bantexte ou null
- adresse_bantexte ou null
- inseetexte ou null
- typetexte ou null
- surfacenombre ou null
- periodetexte ou null
- zone_climatiquetexte ou null
- classe_departtexte ou null
  Classe du logement à l'état initial de l'audit.
  Valeurs : A, B, C, D, E, F, G
- classe_viseetexte ou null
  Meilleure classe atteinte par une étape de l'audit.
  Valeurs : A, B, C, D, E, F, G
- cout_maxnombre ou null
- scenariosliste d'objets
  Afficher les 2 champsMasquer
  - categorietexte ou null
  - etapesliste d'objets
    Afficher les 11 champsMasquer
    etapetexte ou null
    Étape du parcours de travaux, telle que l'ADEME la nomme.
    classe_bilantexte ou null
    Classe atteinte à cette étape.
    Valeurs : A, B, C, D, E, F, G
    gestexte ou null
    Valeurs : A, B, C, D, E, F, G
    conso_kwh_m2nombre ou null
    Consommation d'énergie primaire après l'étape, en kWh par m² et par an.
    cout_travauxnombre ou null
    Coût des travaux de l'étape, en euros.
    couts_cumulesnombre ou null
    Coût cumulé des travaux jusqu'à cette étape, en euros.
    gain_financiernombre ou null
    gain_facture_minnombre ou null
    gain_facture_maxnombre ou null
    gain_conso_pctnombre ou null
    Gain relatif de consommation, en %.
    travauxtexte ou null
    Travaux de l'étape, tels que l'auditeur les décrit.
- qualiteobjet
  Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
  Afficher les 7 champsMasquer
  - nentier ou null
    Nombre d'observations derrière la valeur ; null si sans objet.
    0 au moins
  - provenancetexte ou null
    mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
    Valeurs : mesure, estime
  - incertitudeobjet ou null
    Incertitude de la valeur : fourchette et demi-largeur.
    Afficher les 3 champsMasquer
    demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
    basnombre ou null
    hautnombre ou null
  - drapeauxliste de textes
    Ce qui doit faire lire la valeur avec prudence ; vide si rien.
    Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
  - methodetexte ou null
    Méthode de calcul ou de rattachement, en clair.
  - donnees_dutexte ou null
    Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
  - sourcetexte
    Source publique ou moteur Pillr, en clair.
creditsobjet
Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).
Afficher les 2 champsMasquer
- debitesentier
  0 au moins
- restantsentier ou null

Erreurs possibles

400parametres_invalidesUn paramètre manque ou ne passe pas son contrôle ; le détail est donné champ par champ
401cle_absenteL'en-tête Authorization manque
401cle_invalideLa clé est inconnue, révoquée ou expirée
403organisation_suspendueL'organisation de la clé n'est pas active
403portee_insuffisanteLa clé ou l'accès de l'organisation n'ouvre pas cette opération
403hors_bac_a_sableUne clé pk_test_ l'appelle : l'opération n'a pas de bac à sable
402credits_insuffisantsLes crédits ne suffisent plus pour cet appel
429plafond_cleLe plafond mensuel de crédits de la clé est atteint
429quota_minuteLe débit par minute de l'organisation est atteint
503charge_globaleL'API est momentanément surchargée, tous clients confondus ; rien n'est débité
503creneau_reserveEntre 20h30 et minuit (heure de Paris), la réponse n'est pas déjà en mémoire
504delai_depasseLe calcul dépasse le délai de l'opération ; rien n'est débité
503service_indisponibleL'API est momentanément indisponible
500erreur_interneUne erreur de notre côté ; rien n'est servi ni débité

Une ressource absente répond par un code de la famille des ressources absentes, propre à l'opération, sans débit.

Échéance de location et coût de sortie de passoire

POST/api/v1/energie/sortie-passoire

L'échéance d'interdiction de louer d'un logement selon son étiquette (calendrier de la loi Climat et résilience en métropole : G 2025, F 2028, E 2034) et les mois restants. Pour une étiquette E, F ou G, le coût pour atteindre D, C ou B, mesuré sur les audits énergétiques ADEME de logements comparables (type, zone climatique, période de construction) : médiane et quartiles, euros par m², coût à la surface du bien, part des audits qui dépassent la cible, finesse de la cellule retenue. Une estimation d'auditeur, pas un devis. Métropole seulement : le calendrier des outre-mer n'est pas servi.

Coût: 1 crédit par appel réussi
Accès: À l'usage ou avec l'abonnement Data
Portée: adresse
Outil MCP: sortie_passoire
Bac à sable: Oui, sans débit, sur un jeu figé
Mémoire: 24 h
Délai: 2 s

Essayer en direct

Paramètres

etiquettetexteobligatoire
Étiquette DPE du logement.
Valeurs : A, B, C, D, E, F, G
typetexteobligatoire
appartement ou maison.
Valeurs : appartement, maison
inseetexte
Code INSEE de la commune : donne la zone climatique et le territoire.
zone_climatiquetexte
Zone climatique H1, H2 ou H3, à défaut du code INSEE (métropole).
Valeurs : H1, H2, H3
periode_constructiontexte
Période de construction, à défaut de l'année.
Valeurs : avant_1948, 1948_1974, 1975_2000, apres_2000
annee_constructionentier
de 1 000 à 2 100
surfacenombre
Surface habitable du logement, en m² : ramène le coût au bien.
10 000 au plus ; plus de 0

Exemple d'appel

curl -X POST https://pillr.fr/api/v1/energie/sortie-passoire \
  -H "Authorization: Bearer $PILLR_CLE" \
  -H "Content-Type: application/json" \
  -d '{"etiquette":"A","type":"appartement"}'

Réponse

etiquettetexte
Valeurs : A, B, C, D, E, F, G
interdiction_locationtexte ou null
Premier jour où la location d'un logement de cette classe est interdite (AAAA-MM-JJ), selon le calendrier de la loi Climat et résilience en métropole (G 2025, F 2028, E 2034). null : classe sans échéance, DPE absent, ou adresse hors de la métropole (le calendrier des outre-mer n'est pas servi).
mois_restantsentier ou null
Mois pleins avant l'échéance ; 0 quand l'interdiction est déjà en vigueur ; null sans échéance.
sortieobjet ou null
Coût de sortie d'une passoire (classe E, F ou G) vers D, C ou B, mesuré sur les audits énergétiques réglementaires de l'ADEME pour des logements comparables. null hors des classes E à G, pour un type de logement sans comparable, ou hors de la métropole.
Afficher les 4 champsMasquer
- classe_departtexte
  Valeurs : E, F, G
- ciblesliste d'objets
  Afficher les 9 champsMasquer
  - verstexte
    Classe visée.
    Valeurs : D, C, B
  - n_auditsentier
    Nombre d'audits comparables de la cellule retenue.
  - eurosobjet
    Coût des travaux chiffré par les audits comparables, sur leurs propres surfaces, en euros arrondis à la centaine.
    Afficher les 3 champsMasquer
    medianenombre
    p25nombre
    p75nombre
  - eur_m2objet ou null
    Le même coût rapporté à la surface habitable, en euros par m² ; null s'il y a trop peu d'audits avec surface.
    Afficher les 3 champsMasquer
    medianenombre
    p25nombre
    p75nombre
  - surface_mediane_m2nombre ou null
    Surface habitable médiane des logements audités.
  - pour_la_surfaceobjet ou null
    Le coût au m² des audits appliqué à la surface du bien, quand elle est connue : le chiffre à citer.
    Afficher les 4 champsMasquer
    surface_m2nombre
    medianenombre
    p25nombre
    p75nombre
  - part_au_delanombre ou null
    Part des audits (0 à 1) dont l'étape chiffrée atteint déjà la classe suivante : le chiffrage dépasse alors la cible.
  - perimetretexte
    Les audits comparables, en clair (type de logement, zone climatique, période de construction).
  - niveautexte
    Finesse de la cellule retenue, de la plus fine (type, zone climatique et période) à la plus large (type seul, France métropolitaine).
    Valeurs : complet, sans_periode, sans_zone, national
- lecturetexte
  Ce que mesure le chiffre : une estimation d'auditeur, pas un devis.
- sourcetexte
retenuobjet
Ce qui a été retenu pour choisir les audits comparables.
Afficher les 4 champsMasquer
- typetexte
  Valeurs : appartement, maison
- zone_climatiquetexte ou null
  Valeurs : H1, H2, H3
- periodetexte ou null
  Valeurs : avant_1948, 1948_1974, 1975_2000, apres_2000
- surfacenombre ou null
  Surface retenue pour ramener le coût au bien ; null hors des bornes des audits.
qualiteobjet
Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
Afficher les 7 champsMasquer
- nentier ou null
  Nombre d'observations derrière la valeur ; null si sans objet.
  0 au moins
- provenancetexte ou null
  mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
  Valeurs : mesure, estime
- incertitudeobjet ou null
  Incertitude de la valeur : fourchette et demi-largeur.
  Afficher les 3 champsMasquer
  - demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
  - basnombre ou null
  - hautnombre ou null
- drapeauxliste de textes
  Ce qui doit faire lire la valeur avec prudence ; vide si rien.
  Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
- methodetexte ou null
  Méthode de calcul ou de rattachement, en clair.
- donnees_dutexte ou null
  Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
- sourcetexte
  Source publique ou moteur Pillr, en clair.
creditsobjet
Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).
Afficher les 2 champsMasquer
- debitesentier
  0 au moins
- restantsentier ou null

Erreurs possibles

400parametres_invalidesUn paramètre manque ou ne passe pas son contrôle ; le détail est donné champ par champ
415type_contenuLe corps n'est pas envoyé en application/json
400corps_illisibleLe corps n'est pas un JSON lisible
413corps_trop_lourdLe corps dépasse la taille permise
401cle_absenteL'en-tête Authorization manque
401cle_invalideLa clé est inconnue, révoquée ou expirée
403organisation_suspendueL'organisation de la clé n'est pas active
403portee_insuffisanteLa clé ou l'accès de l'organisation n'ouvre pas cette opération
403hors_bac_a_sableUne clé pk_test_ demande une entrée hors du jeu figé de l'opération
402credits_insuffisantsLes crédits ne suffisent plus pour cet appel
429plafond_cleLe plafond mensuel de crédits de la clé est atteint
429quota_minuteLe débit par minute de l'organisation est atteint
503charge_globaleL'API est momentanément surchargée, tous clients confondus ; rien n'est débité
504delai_depasseLe calcul dépasse le délai de l'opération ; rien n'est débité
503service_indisponibleL'API est momentanément indisponible
500erreur_interneUne erreur de notre côté ; rien n'est servi ni débité

Une ressource absente répond par un code de la famille des ressources absentes, propre à l'opération, sans débit.

Autorisations d'urbanisme d'une adresse ou d'une parcelle

GET/api/v1/adresses/{cle_ban}/permis

GET/api/v1/parcelles/{id_parcelle}/permis

Toutes les autorisations d'urbanisme Sitadel d'une adresse (clé BAN) ou d'une parcelle cadastrale : permis de construire, déclarations préalables, permis d'aménager et de démolir, locaux non résidentiels. Pour chacune : type, état, dates d'autorisation, d'ouverture de chantier et d'achèvement, nature du projet, logements créés par taille, sociaux et en prêt à taux zéro, surfaces, superficie du terrain, demandeur personne morale nommé avec son SIREN (une personne physique n'est jamais nommée), parcelles, et tous les champs publiés. Le rattachement se fait par une parcelle du terrain, sinon par le numéro et la voie, et chaque autorisation dit lequel. Les dates postérieures à aujourd'hui sont des dates prévisionnelles de la source, signalées.

Coût: 3 crédits par appel réussi
Accès: À l'usage ou avec l'abonnement Data
Portée: adresse
Outil MCP: permis_adresse
Bac à sable: Non
Mémoire: 24 h
Délai: 15 s

Essayer en direct

Paramètres de /api/v1/adresses/{cle_ban}/permis

cle_bantexteobligatoire
Clé d'interopérabilité de la Base Adresse Nationale, ex. 69383_1234_00012.
depuistexte
Autorisations délivrées depuis cette date (AAAA-MM-JJ).

Paramètres de /api/v1/parcelles/{id_parcelle}/permis

id_parcelletexteobligatoire
Identifiant de la parcelle cadastrale à 14 caractères : code INSEE, préfixe, section et numéro (ex. 35238000AB0123).

Exemple d'appel

curl https://pillr.fr/api/v1/adresses/{cle_ban}/permis \
  -H "Authorization: Bearer $PILLR_CLE"

Réponse

cle_bantexte ou null
Clé BAN demandée ; null pour une parcelle.
id_parcelletexte ou null
Parcelle demandée ; null pour une clé BAN.
inseetexte
Code INSEE de la commune de l'adresse ou de la parcelle.
parcellesliste de textes
Parcelles de l'adresse (ou la parcelle demandée) qui ont servi au rattachement.
permisliste d'objets
Afficher les 19 champsMasquer
- numerotexte
  Numéro de l'autorisation (num_dau, num_pa ou num_pd de Sitadel).
- typetexte ou null
  PC permis de construire, DP déclaration préalable, PA permis d'aménager, PD permis de démolir.
  Valeurs : PC, DP, PA, PD
- sourcetexte
  Table Sitadel : logements, locaux non résidentiels, démolitions, aménagements.
  Valeurs : logements, locaux, demolir, amenager
- etatobjet
  Afficher les 2 champsMasquer
  - codetexte ou null
    Code d'état de Sitadel.
  - libelletexte ou null
    autorisee (2), annulee (4), commencee (5, chantier ouvert), achevee (6, achèvement déclaré).
    Valeurs : autorisee, annulee, commencee, achevee
- depose_enentier ou null
  Année de dépôt de la demande.
- autorise_letexte ou null
- ouvert_letexte ou null
  Date d'ouverture du chantier déclarée.
- acheve_letexte ou null
  Date d'achèvement déclarée (DAACT).
- date_prevuebooléen
  Vrai si une date est postérieure à aujourd'hui : Sitadel publie aussi des dates prévisionnelles.
- natureobjet
  Afficher les 3 champsMasquer
  - declareetexte ou null
    Code de nature du projet déclarée (1 : nouvelle construction, 2 : travaux sur construction existante).
  - completeetexte ou null
    Code de nature du projet complétée par le service instructeur, tel que publié.
  - libelletexte ou null
    Libellé de la nature déclarée.
- destinationtexte ou null
  Code de destination principale, tel que publié par Sitadel.
- logementsobjet ou null
  Logements créés (table logements seulement).
  Afficher les 8 champsMasquer
  - totalentier ou null
  - individuelsentier ou null
  - collectifsentier ou null
  - par_tailleobjet
    Afficher les 6 champsMasquer
    p1entier ou null
    p2entier ou null
    p3entier ou null
    p4entier ou null
    p5entier ou null
    p6_et_plusentier ou null
  - sociauxentier ou null
    Logements financés par un prêt locatif social.
  - accession_socialeentier ou null
    Logements en accession sociale hors prêt à taux zéro.
  - ptzentier ou null
    Logements financés par un prêt à taux zéro.
  - demolisentier ou null
- surfacesobjet
  Afficher les 4 champsMasquer
  - habitation_creee_m2nombre ou null
  - habitation_demolie_m2nombre ou null
  - locaux_crees_m2nombre ou null
  - locaux_demolis_m2nombre ou null
- superficie_terrain_m2nombre ou null
- demandeurobjet ou null
  Demandeur personne morale, nommé avec son SIREN ; null pour une personne physique (jamais nommée).
  Afficher les 5 champsMasquer
  - denominationtexte
  - sirentexte ou null
  - sirettexte ou null
  - categorie_juridiquetexte ou null
  - code_apetexte ou null
- terrainobjet
  Afficher les 6 champsMasquer
  - communetexte ou null
    Code INSEE de la commune dans Sitadel (commune entière pour Paris, Lyon et Marseille).
  - numerotexte ou null
  - voietexte ou null
  - lieu_dittexte ou null
  - code_postaltexte ou null
  - localitetexte ou null
- parcellesliste de textes
  Parcelles du terrain (14 caractères), préfixées par la commune de l'adresse.
- champsobjet
  Tous les champs de l'autorisation, tels que publiés par Sitadel (demandeur personne physique retiré par la source).
- rattachementtexte
  parcelle : une parcelle du terrain est celle de l'adresse ; adresse : même numéro et même voie.
  Valeurs : parcelle, adresse
qualiteobjet
Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
Afficher les 7 champsMasquer
- nentier ou null
  Nombre d'observations derrière la valeur ; null si sans objet.
  0 au moins
- provenancetexte ou null
  mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
  Valeurs : mesure, estime
- incertitudeobjet ou null
  Incertitude de la valeur : fourchette et demi-largeur.
  Afficher les 3 champsMasquer
  - demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
  - basnombre ou null
  - hautnombre ou null
- drapeauxliste de textes
  Ce qui doit faire lire la valeur avec prudence ; vide si rien.
  Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
- methodetexte ou null
  Méthode de calcul ou de rattachement, en clair.
- donnees_dutexte ou null
  Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
- sourcetexte
  Source publique ou moteur Pillr, en clair.
creditsobjet
Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).
Afficher les 2 champsMasquer
- debitesentier
  0 au moins
- restantsentier ou null

Erreurs possibles

400parametres_invalidesUn paramètre manque ou ne passe pas son contrôle ; le détail est donné champ par champ
401cle_absenteL'en-tête Authorization manque
401cle_invalideLa clé est inconnue, révoquée ou expirée
403organisation_suspendueL'organisation de la clé n'est pas active
403portee_insuffisanteLa clé ou l'accès de l'organisation n'ouvre pas cette opération
403hors_bac_a_sableUne clé pk_test_ l'appelle : l'opération n'a pas de bac à sable
402credits_insuffisantsLes crédits ne suffisent plus pour cet appel
429plafond_cleLe plafond mensuel de crédits de la clé est atteint
429quota_minuteLe débit par minute de l'organisation est atteint
503charge_globaleL'API est momentanément surchargée, tous clients confondus ; rien n'est débité
503creneau_reserveEntre 20h30 et minuit (heure de Paris), la réponse n'est pas déjà en mémoire
504delai_depasseLe calcul dépasse le délai de l'opération ; rien n'est débité
503service_indisponibleL'API est momentanément indisponible
500erreur_interneUne erreur de notre côté ; rien n'est servi ni débité

Une ressource absente répond par un code de la famille des ressources absentes, propre à l'opération, sans débit.

Sociétés civiles domiciliées à une adresse

GET/api/v1/adresses/{cle_ban}/societes-civiles

Les sociétés civiles (immobilières, de moyens...) domiciliées à une adresse de la Base Adresse Nationale, par sa clé : dénomination, SIREN, forme, avis BODACC (création, modification, radiation, procédure, cession) avec leur date, et présence d'une société avant le dernier DPE. Les avis sont ceux que la gold de Pillr rattache à l'adresse ; le SIREN est rapproché par la dénomination et le code postal. Les gérants et associés ne sont jamais nommés. Adresse inconnue : 404 adresse_introuvable, rien n'est débité ; une adresse sans société civile rend n = 0.

Coût: 3 crédits par appel réussi
Accès: À l'usage ou avec l'abonnement Data
Portée: adresse
Outil MCP: societes_civiles
Bac à sable: Non
Mémoire: 24 h
Délai: 15 s

Essayer en direct

Paramètres

cle_bantexteobligatoire
Clé d'interopérabilité de la Base Adresse Nationale, ex. 69383_1234_00012.

Exemple d'appel

curl https://pillr.fr/api/v1/adresses/{cle_ban}/societes-civiles \
  -H "Authorization: Bearer $PILLR_CLE"

Réponse

cle_bantexte
inseetexte ou null
code_postaltexte ou null
nentier
Sociétés civiles domiciliées à l'adresse.
n_avisentier
societesliste d'objets
Afficher les 10 champsMasquer
- denominationtexte ou null
- sirentexte ou null
  SIREN rapproché par la dénomination et le code postal dans le BODACC ; null s'il n'a pas été trouvé.
- siren_rapprochementtexte ou null
  Comment le SIREN a été trouvé : par la dénomination et le code postal de l'adresse (pas par le registre de l'avis).
  Valeurs : denomination_code_postal
- formetexte ou null
  Forme juridique (société civile immobilière, de moyens...).
- avisliste d'objets
  Avis BODACC de la société domiciliée à l'adresse, le plus récent d'abord.
  Afficher les 3 champsMasquer
  - datetexte
    Date de l'avis (AAAA-MM-JJ).
  - familletexte
    Famille de l'avis (codes du BODACC ; autre pour un libellé inconnu).
    Valeurs : creation, immatriculation, modification, radiation, collective, conciliation, retablissement_professionnel, vente, dpc, autre
  - typetexte ou null
    Libellé de l'avis tel que publié (Créations, Modifications diverses, Radiations...).
- creation_letexte ou null
- radiation_letexte ou null
- procedure_letexte ou null
- cession_letexte ou null
- dernier_avis_letexte ou null
derniere_denominationtexte ou null
dernier_avistexte ou null
dernier_avis_letexte ou null
connue_au_dpebooléen ou null
Vrai si une société civile était déjà domiciliée à l'adresse avant le dernier DPE ; null sans DPE ou sans société.
donnees_dutexte ou null
Date du calcul de la gold à l'adresse (horodatage ISO 8601).
qualiteobjet
Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
Afficher les 7 champsMasquer
- nentier ou null
  Nombre d'observations derrière la valeur ; null si sans objet.
  0 au moins
- provenancetexte ou null
  mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
  Valeurs : mesure, estime
- incertitudeobjet ou null
  Incertitude de la valeur : fourchette et demi-largeur.
  Afficher les 3 champsMasquer
  - demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
  - basnombre ou null
  - hautnombre ou null
- drapeauxliste de textes
  Ce qui doit faire lire la valeur avec prudence ; vide si rien.
  Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
- methodetexte ou null
  Méthode de calcul ou de rattachement, en clair.
- donnees_dutexte ou null
  Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
- sourcetexte
  Source publique ou moteur Pillr, en clair.
limitesliste de textes
Ce que la réponse ne couvre pas, en clair.
creditsobjet
Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).
Afficher les 2 champsMasquer
- debitesentier
  0 au moins
- restantsentier ou null

Erreurs possibles

400parametres_invalidesUn paramètre manque ou ne passe pas son contrôle ; le détail est donné champ par champ
401cle_absenteL'en-tête Authorization manque
401cle_invalideLa clé est inconnue, révoquée ou expirée
403organisation_suspendueL'organisation de la clé n'est pas active
403portee_insuffisanteLa clé ou l'accès de l'organisation n'ouvre pas cette opération
403hors_bac_a_sableUne clé pk_test_ l'appelle : l'opération n'a pas de bac à sable
402credits_insuffisantsLes crédits ne suffisent plus pour cet appel
429plafond_cleLe plafond mensuel de crédits de la clé est atteint
429quota_minuteLe débit par minute de l'organisation est atteint
503charge_globaleL'API est momentanément surchargée, tous clients confondus ; rien n'est débité
503creneau_reserveEntre 20h30 et minuit (heure de Paris), la réponse n'est pas déjà en mémoire
504delai_depasseLe calcul dépasse le délai de l'opération ; rien n'est débité
503service_indisponibleL'API est momentanément indisponible
500erreur_interneUne erreur de notre côté ; rien n'est servi ni débité

Une ressource absente répond par un code de la famille des ressources absentes, propre à l'opération, sans débit.

Lots d'un immeuble établis par ses DPE

GET/api/v1/adresses/{cle_ban}/lots

Les lots d'un immeuble à une adresse (clé BAN), établis par les DPE de ses logements (ADEME) : un lot par DPE d'appartement de moins de 10 ans, surface, étiquette, étage, numéros de DPE ; un DPE remplacé rejoint le lot de son remplaçant. Deux DPE du même étage à la même surface sans lien de remplacement sont signalés comme doublon possible, jamais fusionnés. Le compte est confronté au registre des copropriétés et au DPE de l'immeuble ; chaque écart est dit dans desaccords.

Coût: 3 crédits par appel réussi
Accès: À l'usage ou avec l'abonnement Data
Portée: adresse
Outil MCP: lots_adresse
Bac à sable: Non
Mémoire: 24 h
Délai: 5 s

Essayer en direct

Paramètres

cle_bantexteobligatoire
Clé d'interopérabilité de la Base Adresse Nationale, ex. 69383_1234_00012.

Exemple d'appel

curl https://pillr.fr/api/v1/adresses/{cle_ban}/lots \
  -H "Authorization: Bearer $PILLR_CLE"

Réponse

cle_bantexte
adressetexte ou null
inseetexte
nb_lotsentier
lotsliste d'objets
Afficher les 5 champsMasquer
- surface_m2nombre ou null
- etiquette_dpetexte ou null
- etageentier ou null
  Étage porté par le DPE, 0 pour le rez-de-chaussée ; null s'il ne le dit pas.
- dpeliste d'objets
  Le DPE en vigueur d'abord, puis ceux qu'il remplace.
  Afficher les 4 champsMasquer
  - numero_dpetexte
  - datetexte ou null
  - etiquette_dpetexte ou null
  - surface_m2nombre ou null
- confiancetexte
  doublon_possible : un autre lot du même étage, à la même surface à 1 m² près, porte un DPE d'une autre date sans dire qu'il le remplace.
  Valeurs : distinct, doublon_possible
nb_dpe_ecartesentier
DPE de l'adresse non retenus : hors appartement, de plus de 10 ans, trop petits, ou remplacés.
registreobjet
Ce que disent le registre des copropriétés et le DPE de l'immeuble, pour contrôler le compte des lots.
Afficher les 3 champsMasquer
- lots_habitationentier ou null
  Lots d'habitation déclarés au registre national des copropriétés.
- immatriculationtexte ou null
- logements_dpe_immeubleentier ou null
  Nombre d'appartements que le DPE le plus récent attribue à l'immeuble, quand il en décrit plusieurs.
desaccordsliste de textes
methodetexte
qualiteobjet
Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
Afficher les 7 champsMasquer
- nentier ou null
  Nombre d'observations derrière la valeur ; null si sans objet.
  0 au moins
- provenancetexte ou null
  mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
  Valeurs : mesure, estime
- incertitudeobjet ou null
  Incertitude de la valeur : fourchette et demi-largeur.
  Afficher les 3 champsMasquer
  - demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
  - basnombre ou null
  - hautnombre ou null
- drapeauxliste de textes
  Ce qui doit faire lire la valeur avec prudence ; vide si rien.
  Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
- methodetexte ou null
  Méthode de calcul ou de rattachement, en clair.
- donnees_dutexte ou null
  Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
- sourcetexte
  Source publique ou moteur Pillr, en clair.
calcule_letexte
creditsobjet
Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).
Afficher les 2 champsMasquer
- debitesentier
  0 au moins
- restantsentier ou null

Erreurs possibles

400parametres_invalidesUn paramètre manque ou ne passe pas son contrôle ; le détail est donné champ par champ
401cle_absenteL'en-tête Authorization manque
401cle_invalideLa clé est inconnue, révoquée ou expirée
403organisation_suspendueL'organisation de la clé n'est pas active
403portee_insuffisanteLa clé ou l'accès de l'organisation n'ouvre pas cette opération
403hors_bac_a_sableUne clé pk_test_ l'appelle : l'opération n'a pas de bac à sable
402credits_insuffisantsLes crédits ne suffisent plus pour cet appel
429plafond_cleLe plafond mensuel de crédits de la clé est atteint
429quota_minuteLe débit par minute de l'organisation est atteint
503charge_globaleL'API est momentanément surchargée, tous clients confondus ; rien n'est débité
504delai_depasseLe calcul dépasse le délai de l'opération ; rien n'est débité
503service_indisponibleL'API est momentanément indisponible
500erreur_interneUne erreur de notre côté ; rien n'est servi ni débité

Une ressource absente répond par un code de la famille des ressources absentes, propre à l'opération, sans débit.