Annonces

21 opérations servies.

/

Annonce par lien ou identifiant

GET/api/v1/annonces/{id}

GET/api/v1/annonces/par-url

Fiche complète d'une annonce de vente analysée, retrouvée par son lien Leboncoin, BienIci ou SeLoger, ou par son identifiant : faits du bien et détails du portail (honoraires, taxe foncière, copropriété, équipements), vendeur professionnel nommé avec son enseigne, son SIREN et son mandat, photos et description, analyse complète (score et sous-scores, verdict, forces et faiblesses, leviers et cibles de négociation, loyer, rendements recalculés, budget, travaux par poste lus sur les photos, stratégie locative, régime fiscal), valeurs brutes du modèle à côté des valeurs recalculées, coût de sortie de passoire, échéance de location, historique des prix et diffusion en nombres. Données brutes du portail avec inclure=brut, pour un professionnel. Rien n'est débité si l'annonce est absente ou pas encore analysée.

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

Essayer en direct

Paramètres de /api/v1/annonces/{id}

idtexteobligatoire
Identifiant de l'annonce : lbc:<numéro>, bienici:<identifiant>, seloger:<numéro> ou identifiant Pillr.
de 3 à 200 caractères
incluretexte
brut : ajoute les données brutes du portail (vendeur professionnel seulement).
Valeurs : brut
champsvaleur
Champs rendus, séparés par des virgules (« prix,surface,analyse.score ») ; tous si absent.

Paramètres de /api/v1/annonces/par-url

urltexteobligatoire
Lien de l'annonce sur le portail d'origine.
500 caractères au plus ; adresse web

Exemple d'appel

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

Réponse

idtexte
Identifiant Pillr de l'annonce.
id_portailtexte ou nullfacultatif
Identifiant chez le portail (lbc:<n>, bienici:<id>, seloger:<id>), servi avec la portée lien_origine.
lientexte ou nullfacultatif
Lien d'origine de l'annonce, servi avec la portée lien_origine.
sourcetextefacultatif
statuttextefacultatif
actif : en ligne ; retire : retirée du portail ; masque : ni l'un ni l'autre (contrôle en cours).
Valeurs : actif, retire, masque
actifbooléenfacultatif
typetextefacultatif
neuf_ancientexte ou nullfacultatif
communetexte ou nullfacultatif
code_postaltexte ou nullfacultatif
inseetexte ou nullfacultatif
departementtexte ou nullfacultatif
regiontexte ou nullfacultatif
positionobjet ou nullfacultatif
Position telle que le portail la donne, avec sa précision.
Afficher les 3 champsMasquer
- latnombre
- lonnombre
- precisiontexte
  adresse, approchee, centre_commune ou inconnue.
prixnombre ou nullfacultatif
prix_m2nombre ou nullfacultatif
Prix divisé par la surface (jamais la valeur du portail).
prix_m2_portailnombre ou nullfacultatif
Prix au m² affiché par le portail, servi à côté.
surfacenombre ou nullfacultatif
piecesnombre ou nullfacultatif
chambresnombre ou nullfacultatif
etagenombre ou nullfacultatif
nb_etagesnombre ou nullfacultatif
salles_de_bainnombre ou nullfacultatif
salles_d_eaunombre ou nullfacultatif
terrain_m2nombre ou nullfacultatif
jardin_privatif_m2nombre ou nullfacultatif
terrain_portail_m2nombre ou nullfacultatif
terrain_suspectbooléen ou nullfacultatif
Vrai si le terrain d'une maison est plus petit que sa surface habitable.
annee_constructionnombre ou nullfacultatif
dpeobjetfacultatif
Afficher les 7 champsMasquer
- etiquettetexte ou null
  Valeurs : A, B, C, D, E, F, G
- conso_kwh_m2_annombre ou null
- gestexte ou null
  Valeurs : A, B, C, D, E, F, G
- ges_kg_m2_annombre ou null
- ges_statuttexte ou null
  Valeurs : non_soumis, vierge
- 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.
equipementsobjetfacultatif
Afficher les 15 champsMasquer
- ascenseurbooléen ou null
- balconbooléen ou null
- cavebooléen ou null
- parkingbooléen ou null
- meublebooléen ou null
- terrassebooléen ou null
- jardinbooléen ou null
- piscinebooléen ou null
- garagebooléen ou null
- cuisine_equipeebooléen ou null
- visite_virtuellebooléen ou null
- orientationtexte ou null
- chauffagetexte ou null
- chauffage_modetexte ou null
- listeliste de textes
  Équipements listés par le portail.
details_portailobjetfacultatif
Afficher les 11 champsMasquer
- prix_hors_honorairesnombre ou null
- honorairesnombre ou null
- honoraires_a_chargetexte ou null
- taxe_foncierenombre ou null
- charges_copro_annuellesnombre ou null
- charges_suspectesbooléen ou null
  Vrai si les charges annuelles d'un appartement en copropriété semblent mensuelles.
- budget_energie_minnombre ou null
- budget_energie_maxnombre ou null
- lots_copronombre ou null
- procedure_coprobooléen ou null
- en_coprobooléen ou null
type_vendeurtextefacultatif
Statut du vendeur déclaré par le portail : pro (agence, réseau, promoteur), particulier, ou inconnu.
Valeurs : pro, particulier, inconnu
annonceurobjetfacultatif
Le vendeur : un professionnel est servi en entier (nom, enseigne, SIREN, mandat, coordonnées professionnelles), un particulier jamais.
Afficher les 7 champsMasquer
- type_vendeurtexte
  Statut du vendeur déclaré par le portail : pro (agence, réseau, promoteur), particulier, ou inconnu.
  Valeurs : pro, particulier, inconnu
- nomtexte ou null
- enseignetexte ou null
- sirentexte ou null
- mandattexte ou null
  Type de mandat publié (simple, exclusif) ; null si inconnu.
- telephonetexte ou null
  Téléphone professionnel publié par le portail ; jamais celui d'un particulier.
- emailtexte ou null
  Adresse électronique professionnelle publiée par le portail ; jamais celle d'un particulier.
titretexte ou nullfacultatif
descriptiontexte ou nullfacultatif
Description du portail, en texte ; les coordonnées d'un vendeur qui n'est pas un professionnel en sont retirées.
photosliste de textesfacultatif
Liens des photos chez le portail.
premiere_parutionobjetfacultatif
Afficher les 2 champsMasquer
- datetexte ou null
- estimeebooléen
  Vrai quand la date est une estimation (portail qui ne la publie pas).
vu_letexte ou nullfacultatif
retire_letexte ou nullfacultatif
entree_letexte ou nullfacultatif
maj_letexte ou nullfacultatif
bien_uidtexte ou nullfacultatif
Bien dédoublonné qui porte l'annonce (opération bien).
analyseobjetfacultatif
Afficher les 36 champsMasquer
- scorenombre ou null
  Score Pillr sur 100.
- sous_scoresobjet
  Afficher les 9 champsMasquer
  - localisationnombre ou null
  - transportnombre ou null
  - rentabilitenombre ou null
  - potentielnombre ou null
  - etatnombre ou null
  - marchenombre ou null
  - fiscalitenombre ou null
  - risquesnombre ou null
  - qualite_annoncenombre ou null
- profiltexte ou null
- verdicttexte ou null
- forcesliste de textes
- faiblessesliste de textes
- recommandationtexte ou null
- leviersliste de textes
  Leviers de négociation.
- negociationobjet
  Afficher les 4 champsMasquer
  - cible_minnombre ou null
    Cible basse, bornée entre 60 % et 100 % du prix.
  - cible_maxnombre ou null
  - cible_min_moteurnombre ou null
    Cible basse écrite par le modèle, avant bornage.
  - cible_max_moteurnombre ou null
- loyerobjet
  Afficher les 3 champsMasquer
  - estimenombre ou null
    Loyer mensuel estimé, en euros ; null quand le moteur s'est replié sur un forfait ou a écarté son estimation.
  - sourcetexte ou null
    carte_des_loyers, repli, ecarte ou non_precise.
  - estime_moteurnombre ou null
    Loyer écrit par le moteur, servi tel quel.
- rendement_brutnombre ou null
  Rendement brut en %, recalculé depuis le loyer estimé et le prix.
- rendement_brut_moteurnombre ou null
- rendement_netnombre ou null
  Rendement net en %, recalculé sur le budget total.
- rendement_net_moteurnombre ou null
- frais_notairenombre ou null
  Frais de notaire au taux de l'ancien, en euros.
- frais_notaire_moteurnombre ou null
- budget_totalnombre ou null
  Prix, frais de notaire et milieu de la fourchette des travaux, en euros ; null si les travaux ne sont pas évalués.
- budget_total_moteurnombre ou null
  Budget écrit par le modèle : son sens varie selon les analyses, à lire avec prudence.
- etat_visuelnombre ou null
  État visuel lu sur les photos, sur 100 ; null avec des photos de catalogue.
- photosobjet
  Afficher les 3 champsMasquer
  - exploitablesentier ou null
  - totalentier ou null
  - qualite_annonceentier ou null
- travauxobjet
  Afficher les 13 champsMasquer
  - statuttexte
    chiffre : travaux chiffrés poste par poste sur les photos ; aucun : aucun travaux vu ; partiel : chiffrés, mais la cuisine ou la salle de bain n'apparaît pas sur les photos ; non_evalue : photos absentes, inexploitables ou de catalogue ; non_analyse : annonce pas encore analysée.
    Valeurs : chiffre, aucun, partiel, non_evalue, non_analyse
  - minnombre ou null
    Bas de la fourchette du barème déterministe, en euros.
  - maxnombre ou null
    Haut de la fourchette du barème déterministe, en euros.
  - max_m2nombre ou null
  - postesliste d'objets
    Travaux par poste, lus sur les photos.
    Afficher les 5 champsMasquer
    postetexte ou null
    libelletexte ou null
    minnombre ou null
    maxnombre ou null
    prioritetexte ou null
  - defautsobjet ou null
    Défauts relevés sur les photos, par gravité.
    Afficher les 3 champsMasquer
    mineurentier ou null
    moyenentier ou null
    majeurentier ou null
  - pieces_vuesliste de textes
    Pièces vues sur les photos.
  - pieces_manquantesliste de textes
    Pièces clés absentes des photos (cuisine, salle de bain).
  - etat_general_moteurtexte ou null
  - urgence_moteurtexte ou null
  - min_moteurnombre ou null
    Budget bas écrit par le modèle de langage, servi à côté du barème.
  - max_moteurnombre ou null
    Budget haut écrit par le modèle de langage, servi à côté du barème.
  - alertesliste de textes
- strategie_locativetexte ou null
- strategie_locative_raisontexte ou null
- regime_fiscaltexte ou null
- regime_fiscal_fiablebooléen
  Faux quand le régime vaut LMNP_REEL : le modèle le propose sur presque toutes les analyses.
- regime_fiscal_raisontexte ou null
- economie_fiscale_annombre ou null
- taxe_fonciere_moteurnombre ou null
- charges_annuelles_moteurnombre ou null
- drapeauxobjet
  Afficher les 5 champsMasquer
  - encherebooléen ou null
  - photos_cataloguebooléen ou null
  - vendubooléen ou null
  - louebooléen ou null
  - raisonstexte ou null
- confianceobjet
  Afficher les 3 champsMasquer
  - niveau_moteurtexte ou null
    Confiance déclarée par le modèle lui-même (high sur la plupart des analyses).
  - facteursliste de textes
  - limitesliste de textes
- completudetexte ou null
  Valeurs : haute, moyenne, basse
- completude_criteresobjet
  Afficher les 5 champsMasquer
  - dpebooléen ou null
  - loyer_communalbooléen ou null
  - prix_dvfbooléen ou null
  - photos_exploitablesbooléen ou null
  - cuisine_salle_de_bain_vuesbooléen ou null
- sourcesliste de textes
- moteurobjet
  Afficher les 3 champsMasquer
  - modeletexte ou null
  - versionnombre ou null
  - analyse_letexte 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.
sortie_passoireobjet ou nullfacultatif
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
prix_historiqueliste d'objetsfacultatif
Variations de prix détectées, dédoublonnées au jour ; le détail est dans vie_annonce.
Afficher les 4 champsMasquer
- letexte
- denombre ou null
- anombre
- doublon_probablebooléen
diffusionobjet ou nullfacultatif
Le même bien chez d'autres annonceurs, en nombres ; les agences nommées sont dans vie_annonce.
Afficher les 7 champsMasquer
- annoncesentier
- agencesentier
- particuliersentier
- portailsentier
- prix_minnombre ou null
- prix_maxnombre ou null
- premiere_parutiontexte ou null
brutobjet ou nullfacultatif
Données brutes du portail, avec inclure=brut, pour un vendeur professionnel seulement ; null sinon.
drapeauxliste de textesfacultatif
Ce qui doit faire lire l'annonce 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
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.
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.

Annonce par lien ou identifiant, en lot

POST/api/v1/annonces/lot

Annonce par lien ou identifiant pour 100 éléments au plus en un appel : chaque élément est servi ou refusé seul, avec son code d'erreur, et seuls les éléments servis sont débités. Fiche complète d'une annonce de vente analysée, retrouvée par son lien Leboncoin, BienIci ou SeLoger, ou par son identifiant : faits du bien et détails du portail (honoraires, taxe foncière, copropriété, équipements), vendeur professionnel nommé avec son enseigne, son SIREN et son mandat, photos et description, analyse complète (score et sous-scores, verdict, forces et faiblesses, leviers et cibles de négociation, loyer, rendements recalculés, budget, travaux par poste lus sur les photos, stratégie locative, régime fiscal), valeurs brutes du modèle à côté des valeurs recalculées, coût de sortie de passoire, échéance de location, historique des prix et diffusion en nombres. Données brutes du portail avec inclure=brut, pour un professionnel. Rien n'est débité si l'annonce est absente ou pas encore analysée.

Coût: 3 crédits par élément rendu
Accès: À l'usage ou avec l'abonnement Data
Portée: annonces
Outil MCP: annonce_lot
Bac à sable: Non
Mémoire: Jamais gardée
Délai: 120 s

Essayer en direct

Paramètres

elementsliste d'objetsobligatoire
Les entrées de l'opération unitaire, 100 au plus.
1 éléments au moins ; 100 éléments au plus
Afficher les 3 champsMasquer
- idtexte
  Identifiant de l'annonce : lbc:<numéro>, bienici:<identifiant>, seloger:<numéro> ou identifiant Pillr.
  de 3 à 200 caractères
- urltexte
  Lien de l'annonce sur le portail d'origine.
  500 caractères au plus ; adresse web
- incluretexte
  brut : ajoute les données brutes du portail (vendeur professionnel seulement).
  Valeurs : brut

Exemple d'appel

curl -X POST https://pillr.fr/api/v1/annonces/lot \
  -H "Authorization: Bearer $PILLR_CLE" \
  -H "Content-Type: application/json" \
  -d '{"elements":[{}]}'

Réponse

resultatsliste de valeurs
Un résultat par élément, dans l'ordre de l'entrée : la sortie de l'opération, ou l'erreur de cet élément.
n_okentier
0 au moins
n_erreursentier
0 au moins
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_ 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.

Recherche d'annonces analysées

GET/api/v1/annonces

Annonces de vente actives et analysées, par communes, codes postaux, départements ou autour d'un point, filtrées par type (appartement, maison, immeuble), prix, pièces, chambres, surface, prix au m², rendement brut ou net, score, DPE, passoires, état visuel, travaux, type de vendeur, SIREN ou enseigne de l'agence, mots-clés, date de parution, résidences gérées et règle « sous le marché ». Tri par rendement, score, état, date, prix, prix au m², distance ou opportunité (le radar du Hub : décote sur la commune, rendement, score, ancienneté). Chaque annonce porte son vendeur (professionnel nommé), sa diffusion multi-agences et ses drapeaux. Un crédit par annonce rendue.

Coût: 1 crédit par élément rendu
Accès: À l'usage ou avec l'abonnement Data
Portée: annonces
Outil MCP: rechercher_annonces
Bac à sable: Oui, sans débit, sur un jeu figé
Mémoire: 15 min
Délai: 5 s

Essayer en direct

Paramètres

inseevaleur
Code INSEE d'une commune, ou liste de 10 codes au plus (paramètre répété).
cpvaleur
Code postal, ou liste de 10 codes au plus.
departementvaleur
Code de département, ou liste de 8 codes au plus.
latnombre
Latitude du point de recherche (avec lon et rayon_km).
de -90 à 90
lonnombre
Longitude du point de recherche (avec lat et rayon_km).
de -180 à 180
rayon_kmnombre
Rayon autour du point, en km (50 au plus).
50 au plus ; plus de 0
mots_clestexte
Mots à trouver dans le titre ou la description (4 mots au plus, accents indifférents).
de 3 à 100 caractères
typetexte
Type de bien : appartement, maison ou immeuble entier.
Valeurs : appartement, maison, immeuble
prix_minnombre
0 au moins
prix_maxnombre
0 au moins
pieces_minentier
0 au moins
pieces_maxentier
0 au moins
chambres_minentier
0 au moins
surface_minnombre
0 au moins
surface_maxnombre
0 au moins
prix_m2_maxnombre
0 au moins
rendement_minnombre
Rendement brut minimal, en %.
de 0 à 100
rendement_net_minnombre
Rendement net minimal, en %.
de 0 à 100
score_minnombre
de 0 à 100
dpevaleur
Étiquettes DPE acceptées (une ou plusieurs).
dpe_maxtexte
Étiquette DPE la moins bonne acceptée (D : de A à D).
Valeurs : A, B, C, D, E, F, G
passoiresvaleur
Vrai : les seules passoires thermiques (F et G).
etat_visuel_maxnombre
État visuel maximal sur 100 (pour chercher des biens à rénover).
de 0 à 100
travaux_minnombre
Travaux minimaux, sur le bas de la fourchette, en euros.
0 au moins
travaux_maxnombre
Travaux maximaux, sur le haut de la fourchette (le pire cas), en euros.
0 au moins
travaux_max_m2nombre
0 au moins
type_vendeurtexte
Statut du vendeur déclaré par le portail : pro (agence, réseau, promoteur), particulier, ou inconnu.
Valeurs : pro, particulier, inconnu
sirentexte
SIREN de l'agence ou du professionnel.
enseignetexte
Nom ou enseigne de l'agence (début du nom).
de 2 à 80 caractères
exclure_residences_gereesvaleur
Vrai : écarte les logements de résidence gérée.
sous_le_marchevaleur
Vrai : la règle « sous le marché » de la carte du site (rendement brut d'au moins 7 % et score d'au moins 70).
publie_depuistexte
Annonces parues depuis cette date (AAAA-MM-JJ).
tritexte
rendement (défaut), rendement_net, score, etat (meilleur état d'abord), date (plus récentes), prix, prix_desc, prix_m2, distance (avec lat, lon, rayon_km), opportunite (radar du Hub, sur les 250 annonces les mieux notées de la recherche).
Valeurs : rendement, rendement_net, score, etat, date, prix, prix_desc, prix_m2, opportunite, distance
limiteentier
Nombre d'éléments par page (50 au plus).
de 1 à 50 ; par défaut 10
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.

Exemple d'appel

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

Réponse

donneesliste d'objets
Afficher les 31 champsMasquer
- idtexte
  Identifiant Pillr de l'annonce (à repasser à /annonces/{id}).
- id_portailtexte ou nullfacultatif
  Identifiant chez le portail (lbc:<n>, bienici:<id>, seloger:<id>), servi avec la portée lien_origine.
- lientexte ou nullfacultatif
  Lien d'origine de l'annonce, servi avec la portée lien_origine.
- sourcetextefacultatif
  Portail d'origine : lbc, bienici ou seloger.
- typetextefacultatif
  Type de bien : appartement, maison, immeuble.
- inseetexte ou nullfacultatif
- code_postaltexte ou nullfacultatif
- communetexte ou nullfacultatif
- latnombre ou nullfacultatif
- lonnombre ou nullfacultatif
- precision_coordonneestexte ou nullfacultatif
  Précision de la position : adresse, approchee, centre_commune, ou inconnue tant que le lac ne l'a pas dite.
- prixnombre ou nullfacultatif
- surfacenombre ou nullfacultatif
- piecesnombre ou nullfacultatif
- prix_m2nombre ou nullfacultatif
  Prix divisé par la surface (jamais la valeur du portail).
- dpetexte ou nullfacultatif
  Valeurs : A, B, C, D, E, F, G
- scorenombre ou nullfacultatif
  Score Pillr sur 100.
- rendement_brutnombre ou nullfacultatif
  Rendement brut en %, recalculé : loyer estimé sur 12 mois divisé par le prix.
- rendement_netnombre ou nullfacultatif
  Rendement net en %, recalculé sur le budget total (prix, frais de notaire, travaux).
- loyer_estimenombre ou nullfacultatif
  Loyer mensuel estimé, en euros ; null quand le moteur s'est replié sur un forfait.
- etat_visuelnombre ou nullfacultatif
  État visuel lu sur les photos, sur 100 (100 : neuf) ; null sans photos exploitables.
- travauxobjetfacultatif
  Afficher les 4 champsMasquer
  - statuttexte
    chiffre : travaux chiffrés poste par poste sur les photos ; aucun : aucun travaux vu ; partiel : chiffrés, mais la cuisine ou la salle de bain n'apparaît pas sur les photos ; non_evalue : photos absentes, inexploitables ou de catalogue ; non_analyse : annonce pas encore analysée.
    Valeurs : chiffre, aucun, partiel, non_evalue, non_analyse
  - minnombre ou null
    Bas de la fourchette des travaux, en euros.
  - maxnombre ou null
    Haut de la fourchette des travaux, en euros.
  - max_m2nombre ou null
    Haut de la fourchette rapporté à la surface, en euros par m².
- profiltexte ou nullfacultatif
  Profil de l'annonce selon le moteur d'analyse.
- type_vendeurtextefacultatif
  Statut du vendeur déclaré par le portail : pro (agence, réseau, promoteur), particulier, ou inconnu.
  Valeurs : pro, particulier, inconnu
- annonceurobjetfacultatif
  Le vendeur : un professionnel est nommé, un particulier jamais.
  Afficher les 4 champsMasquer
  - type_vendeurtexte
    Statut du vendeur déclaré par le portail : pro (agence, réseau, promoteur), particulier, ou inconnu.
    Valeurs : pro, particulier, inconnu
  - nomtexte ou null
    Nom de l'agence ou du professionnel tel que le portail l'affiche ; null pour un particulier.
  - enseignetexte ou null
    Enseigne ou réseau du professionnel ; null pour un particulier.
  - sirentexte ou null
    SIREN du professionnel quand le portail le publie ; null pour un particulier.
- agencesentier ou nullfacultatif
  Agences qui proposent le même bien (diffusion multi-agences) ; null si une seule annonce connue.
- residence_gereebooléenfacultatif
  Vrai si le titre ou la description décrit un logement de résidence gérée (bail commercial).
- premiere_parutiontexte ou nullfacultatif
- distance_kmnombre ou nullfacultatif
  Distance au point de recherche, en km ; null sans point.
- drapeauxliste de textesfacultatif
  Ce qui doit faire lire l'annonce 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
- opportuniteobjet ou nullfacultatif
  Lecture d'opportunité du radar du Hub, avec tri=opportunite seulement ; null sinon.
  Afficher les 5 champsMasquer
  - notenombre
    Note composite du radar : décote bornée, rendement borné, score, ancienneté, taille du marché.
  - signauxliste de textes
  - ecart_marche_pctnombre ou null
    Écart du prix au m² au prix médian de la commune pour ce type de bien, en %.
  - prix_m2_marchenombre ou null
    Prix médian au m² de la commune pour ce type de bien.
  - fiablebooléen
    Vrai si l'annonce passe les garde-fous du radar (marché assez peuplé, écart et prix plausibles).
totalentier ou null
Annonces qui répondent, comptées sur la première page jusqu'à 10 000 ; null au-delà ou sur les pages suivantes.
notesliste de textes
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.
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_ 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.

Recherche d'annonces en langage naturel

GET/api/v1/annonces/recherche-naturelle

Une phrase libre (« T3 avec balcon sous 250 000 euros à Nantes ») traduite en filtres de rechercher_annonces, d'abord par le parseur de règles du site, sinon par un modèle de langage, puis exécutée comme rechercher_annonces : 12 annonces au plus, comprises dans le prix. La réponse dit les filtres retenus, ce qui a été ignoré et l'interprétation de la phrase. Les crédits sont rendus si la traduction échoue.

Coût: 15 crédits par appel réussi
Accès: À l'usage ou avec l'abonnement Data
Portée: annonces
Outil MCP: recherche_phrase
Bac à sable: Non
Mémoire: 15 min
Délai: 25 s

Essayer en direct

Paramètres

qtexteobligatoire
La recherche, en une phrase.
de 3 à 400 caractères
limiteentier
Annonces rendues (12 au plus).
de 1 à 12

Exemple d'appel

curl "https://pillr.fr/api/v1/annonces/recherche-naturelle?q=%3Cq%3E" \
  -H "Authorization: Bearer $PILLR_CLE"

Réponse

interpretationtexte
Ce que la phrase a été comprise vouloir dire.
parseurtexte
local : lue par le parseur de règles du site ; modele : traduite par un modèle de langage.
Valeurs : local, modele
filtres_retenusobjet
Les filtres de rechercher_annonces tirés de la phrase, exécutés tels quels.
ignoresliste de textes
Ce que la phrase demandait et que la recherche ne sait pas appliquer.
donneesliste d'objets
Afficher les 30 champsMasquer
- idtexte
  Identifiant Pillr de l'annonce (à repasser à /annonces/{id}).
- id_portailtexte ou null
  Identifiant chez le portail (lbc:<n>, bienici:<id>, seloger:<id>), servi avec la portée lien_origine.
- lientexte ou null
  Lien d'origine de l'annonce, servi avec la portée lien_origine.
- sourcetexte
  Portail d'origine : lbc, bienici ou seloger.
- typetexte
  Type de bien : appartement, maison, immeuble.
- inseetexte ou null
- code_postaltexte ou null
- communetexte ou null
- latnombre ou null
- lonnombre ou null
- precision_coordonneestexte ou null
  Précision de la position : adresse, approchee, centre_commune, ou inconnue tant que le lac ne l'a pas dite.
- prixnombre ou null
- surfacenombre ou null
- piecesnombre ou null
- prix_m2nombre ou null
  Prix divisé par la surface (jamais la valeur du portail).
- dpetexte ou null
  Valeurs : A, B, C, D, E, F, G
- scorenombre ou null
  Score Pillr sur 100.
- rendement_brutnombre ou null
  Rendement brut en %, recalculé : loyer estimé sur 12 mois divisé par le prix.
- rendement_netnombre ou null
  Rendement net en %, recalculé sur le budget total (prix, frais de notaire, travaux).
- loyer_estimenombre ou null
  Loyer mensuel estimé, en euros ; null quand le moteur s'est replié sur un forfait.
- etat_visuelnombre ou null
  État visuel lu sur les photos, sur 100 (100 : neuf) ; null sans photos exploitables.
- travauxobjet
  Afficher les 4 champsMasquer
  - statuttexte
    chiffre : travaux chiffrés poste par poste sur les photos ; aucun : aucun travaux vu ; partiel : chiffrés, mais la cuisine ou la salle de bain n'apparaît pas sur les photos ; non_evalue : photos absentes, inexploitables ou de catalogue ; non_analyse : annonce pas encore analysée.
    Valeurs : chiffre, aucun, partiel, non_evalue, non_analyse
  - minnombre ou null
    Bas de la fourchette des travaux, en euros.
  - maxnombre ou null
    Haut de la fourchette des travaux, en euros.
  - max_m2nombre ou null
    Haut de la fourchette rapporté à la surface, en euros par m².
- profiltexte ou null
  Profil de l'annonce selon le moteur d'analyse.
- type_vendeurtexte
  Statut du vendeur déclaré par le portail : pro (agence, réseau, promoteur), particulier, ou inconnu.
  Valeurs : pro, particulier, inconnu
- annonceurobjet
  Le vendeur : un professionnel est nommé, un particulier jamais.
  Afficher les 4 champsMasquer
  - type_vendeurtexte
    Statut du vendeur déclaré par le portail : pro (agence, réseau, promoteur), particulier, ou inconnu.
    Valeurs : pro, particulier, inconnu
  - nomtexte ou null
    Nom de l'agence ou du professionnel tel que le portail l'affiche ; null pour un particulier.
  - enseignetexte ou null
    Enseigne ou réseau du professionnel ; null pour un particulier.
  - sirentexte ou null
    SIREN du professionnel quand le portail le publie ; null pour un particulier.
- agencesentier ou null
  Agences qui proposent le même bien (diffusion multi-agences) ; null si une seule annonce connue.
- residence_gereebooléen
  Vrai si le titre ou la description décrit un logement de résidence gérée (bail commercial).
- premiere_parutiontexte ou null
- distance_kmnombre ou null
  Distance au point de recherche, en km ; null sans point.
- drapeauxliste de textes
  Ce qui doit faire lire l'annonce 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
totalentier ou null
notesliste de textes
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.

Biens semblables à une annonce

GET/api/v1/annonces/{id}/similaires

Annonces actives et analysées proches d'une annonce de référence. Mode memes_criteres (défaut, outil du Hub) : même type, même commune, surface et prix à plus ou moins 20 %, classées par score. Mode proximite (fiche du site) : même code postal, surface et prix à plus ou moins 30 %, élargi à la commune (surface seule) quand il y a moins de quatre candidats, classées par une note qui mêle score, type, code postal, distance et écarts de prix et de surface. Une seule page. Un crédit par annonce rendue ; rien si la référence est absente.

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

Essayer en direct

Paramètres

idtexteobligatoire
Identifiant de l'annonce : lbc:<numéro>, bienici:<identifiant>, seloger:<numéro> ou identifiant Pillr.
de 3 à 200 caractères
modetexte
Valeurs : memes_criteres, proximite
limiteentier
Nombre d'éléments par page (50 au plus).
de 1 à 50 ; par défaut 5
curseurtexte
Curseur opaque rendu par la page précédente (curseur_suivant), à repasser tel quel.
de 1 à 1 024 caractères

Exemple d'appel

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

Réponse

reference_idtexte
Identifiant Pillr de l'annonce de référence.
modetexte
Valeurs : memes_criteres, proximite
criteresobjet
Afficher les 7 champsMasquer
- typetexte ou null
- inseetexte ou null
- code_postaltexte ou null
- surface_minnombre ou null
- surface_maxnombre ou null
- prix_minnombre ou null
- prix_maxnombre ou null
donneesliste d'objets
Afficher les 31 champsMasquer
- idtexte
  Identifiant Pillr de l'annonce (à repasser à /annonces/{id}).
- id_portailtexte ou null
  Identifiant chez le portail (lbc:<n>, bienici:<id>, seloger:<id>), servi avec la portée lien_origine.
- lientexte ou null
  Lien d'origine de l'annonce, servi avec la portée lien_origine.
- sourcetexte
  Portail d'origine : lbc, bienici ou seloger.
- typetexte
  Type de bien : appartement, maison, immeuble.
- inseetexte ou null
- code_postaltexte ou null
- communetexte ou null
- latnombre ou null
- lonnombre ou null
- precision_coordonneestexte ou null
  Précision de la position : adresse, approchee, centre_commune, ou inconnue tant que le lac ne l'a pas dite.
- prixnombre ou null
- surfacenombre ou null
- piecesnombre ou null
- prix_m2nombre ou null
  Prix divisé par la surface (jamais la valeur du portail).
- dpetexte ou null
  Valeurs : A, B, C, D, E, F, G
- scorenombre ou null
  Score Pillr sur 100.
- rendement_brutnombre ou null
  Rendement brut en %, recalculé : loyer estimé sur 12 mois divisé par le prix.
- rendement_netnombre ou null
  Rendement net en %, recalculé sur le budget total (prix, frais de notaire, travaux).
- loyer_estimenombre ou null
  Loyer mensuel estimé, en euros ; null quand le moteur s'est replié sur un forfait.
- etat_visuelnombre ou null
  État visuel lu sur les photos, sur 100 (100 : neuf) ; null sans photos exploitables.
- travauxobjet
  Afficher les 4 champsMasquer
  - statuttexte
    chiffre : travaux chiffrés poste par poste sur les photos ; aucun : aucun travaux vu ; partiel : chiffrés, mais la cuisine ou la salle de bain n'apparaît pas sur les photos ; non_evalue : photos absentes, inexploitables ou de catalogue ; non_analyse : annonce pas encore analysée.
    Valeurs : chiffre, aucun, partiel, non_evalue, non_analyse
  - minnombre ou null
    Bas de la fourchette des travaux, en euros.
  - maxnombre ou null
    Haut de la fourchette des travaux, en euros.
  - max_m2nombre ou null
    Haut de la fourchette rapporté à la surface, en euros par m².
- profiltexte ou null
  Profil de l'annonce selon le moteur d'analyse.
- type_vendeurtexte
  Statut du vendeur déclaré par le portail : pro (agence, réseau, promoteur), particulier, ou inconnu.
  Valeurs : pro, particulier, inconnu
- annonceurobjet
  Le vendeur : un professionnel est nommé, un particulier jamais.
  Afficher les 4 champsMasquer
  - type_vendeurtexte
    Statut du vendeur déclaré par le portail : pro (agence, réseau, promoteur), particulier, ou inconnu.
    Valeurs : pro, particulier, inconnu
  - nomtexte ou null
    Nom de l'agence ou du professionnel tel que le portail l'affiche ; null pour un particulier.
  - enseignetexte ou null
    Enseigne ou réseau du professionnel ; null pour un particulier.
  - sirentexte ou null
    SIREN du professionnel quand le portail le publie ; null pour un particulier.
- agencesentier ou null
  Agences qui proposent le même bien (diffusion multi-agences) ; null si une seule annonce connue.
- residence_gereebooléen
  Vrai si le titre ou la description décrit un logement de résidence gérée (bail commercial).
- premiere_parutiontexte ou null
- distance_kmnombre ou null
  Distance au point de recherche, en km ; null sans point.
- drapeauxliste de textes
  Ce qui doit faire lire l'annonce 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
- similaritenombre ou null
  Note de similarité du mode proximité ; null en mode mêmes critères.
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.
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.

Vie d'une annonce : prix, diffusion, fatigue vendeur

GET/api/v1/annonces/{id}/vie

La vie d'une annonce en un appel : chaque variation de prix datée (doublons et corrections de prix mal lus signalés et écartés des calculs), baisse nette et cumulée, nombre de baisses et de hausses, plus forte baisse, prix en yo-yo, jours sur le marché et depuis la dernière baisse ; diffusion du même bien chez tous ses annonceurs, agences nommées avec leur SIREN quand il se rapproche, prix par agence, écart et agence la moins chère, première parution réelle ; parcours du bien étape par étape (annonceur, portails, début et fin, prix d'entrée et de sortie, mandat exclusif, republications) et date du passage en multi-mandat ; fatigue vendeur et republications. Un particulier n'est jamais nommé. Rien n'est débité si l'annonce est absente.

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

Essayer en direct

Paramètres

idtexteobligatoire
Identifiant de l'annonce : lbc:<numéro>, bienici:<identifiant>, seloger:<numéro> ou identifiant Pillr.
de 3 à 200 caractères

Exemple d'appel

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

Réponse

idtexte
prixobjet
Afficher les 13 champsMasquer
- initialnombre ou null
- actuelnombre ou null
- baisse_totale_eurnombre ou null
  Variation nette du prix initial au prix actuel, en euros (négatif : baisse).
- baisse_pctnombre ou null
- baisses_cumulees_eurnombre
  Somme des seules baisses, en euros.
- nb_baissesentier
- nb_haussesentier
- plus_forte_baisse_pctnombre ou null
- en_yoyobooléen
  Vrai si le prix revient à des valeurs déjà vues, avec des hausses et des baisses : souvent un prix avec ou sans honoraires.
- evenementsliste d'objets
  Afficher les 8 champsMasquer
  - datetexte
  - anciennombre ou null
  - nouveaunombre
  - variation_eurnombre ou null
  - variation_pctnombre ou null
  - sourcetexte ou null
  - doublon_probablebooléen
    Même mouvement que le précédent, écrit deux fois : écarté des calculs.
  - aberrantbooléen
    Correction d'un prix mal lu (facteur dix, ou variation hors de toute plausibilité) : écartée des calculs.
- suivi_depuistexte
  Date de début de la détection des variations de prix.
- publiee_avant_le_suivibooléen
  Vrai si l'annonce était en ligne avant le début du suivi : son prix a pu bouger avant.
- 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.
jours_sur_le_marcheentier ou null
jours_depuis_derniere_baisseentier ou null
diffusionobjet ou null
Le même bien chez tous ses annonceurs (dédoublonnage du catalogue) ; null si une seule annonce est connue.
Afficher les 18 champsMasquer
- nb_annoncesentier
- nb_agencesentier
- nb_particuliersentier
- nb_portailsentier
- prix_minnombre ou null
- prix_maxnombre ou null
- ecart_prix_eurnombre ou null
- ecart_prix_pctnombre ou null
- ecart_crediblebooléen
  Faux au-delà de l'écart plausible entre honoraires : erreur de saisie ou deux biens mal rapprochés.
- premiere_parutiontexte ou null
- jours_reelsentier ou null
  Jours depuis la première parution du bien, toutes annonces confondues.
- agencesliste d'objets
  Afficher les 10 champsMasquer
  - particulierbooléen
  - nomtexte ou null
    Nom de l'agence ; jamais celui d'un particulier.
  - sirentexte ou null
    SIREN de l'agence, rapproché par son nom dans la commune ; null si aucun rapprochement.
  - portailsliste de textes
  - prixnombre ou null
  - prix_maxnombre ou null
  - activebooléen
  - depuistexte ou null
  - vue_letexte ou null
  - la_moins_cherebooléen
- parcoursliste d'objets
  Le parcours du bien : une étape par annonceur et par période de diffusion continue, dans l'ordre ; vide tant que le parcours n'est pas calculé.
  Afficher les 13 champsMasquer
  - annonceurtexte
    Valeurs : agence, particulier, inconnu
  - nomtexte ou null
    Nom de l'agence ; jamais celui d'un particulier.
  - portailsliste de textes
  - debuttexte ou null
  - debut_avant_suivibooléen
    Vrai si le début est la date déclarée par le portail, antérieure à notre premier relevé : « depuis au moins ».
  - fintexte ou null
    Dernière vue au balayage ; null si l'annonceur diffuse encore le bien.
  - prix_entreenombre ou null
    Premier prix relevé (pas forcément celui de la mise en ligne si debut_avant_suivi).
  - prix_sortienombre ou null
    Dernier prix relevé, actuel si l'étape est en cours.
  - nb_baissesentier
  - nb_haussesentier
  - exclusifbooléen
    Mandat exclusif lu sur au moins une annonce de l'étape.
  - exclusif_jusqu_autexte ou null
    Dernière date à laquelle le mandat a été lu exclusif, s'il ne l'est plus.
  - republicationsentier
    Annonces republiées par le même annonceur sur le même portail dans l'étape.
- multi_mandat_depuistexte ou null
  Date à laquelle au moins deux agences nommées proposent le bien en même temps ; null s'il n'est pas en multi-mandat aujourd'hui.
- nb_agences_maxentier ou null
  Le plus grand nombre d'agences nommées en même temps sur toute l'histoire du bien.
- exclusif_en_coursbooléen ou null
  Une agence diffuse aujourd'hui le bien en mandat exclusif.
- maj_letexte 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.
fatigue_vendeurtexte
Valeurs : faible, moderee, elevee, inconnue
republicationsentier ou null
Republications de l'annonce relevées par le balayage.
methodetexte
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.

Bien dédoublonné et toutes ses annonces

GET/api/v1/biens/{bien_uid}

GET/api/v1/annonces/{id}/bien

Le bien unique derrière ses annonces, tous portails et toutes périodes confondus, par son identifiant ou par celui d'une de ses annonces : toutes les annonces rattachées, actives et retirées, avec leur vendeur (professionnel nommé) ; verdict et méthode du rattachement, servis tels quels, indécis compris ; clés d'identité et empreintes des photos ; agrégat (statut, agences, portails, republications, prix minimal, maximal et dernier) ; journal de certification des doublons. Rien n'est débité si le bien est inconnu.

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

Essayer en direct

Paramètres de /api/v1/biens/{bien_uid}

bien_uidtexteobligatoire
Identifiant Pillr du bien dédoublonné (bien_uid).
format uuid

Paramètres de /api/v1/annonces/{id}/bien

idtexteobligatoire
Identifiant de l'annonce : lbc:<numéro>, bienici:<identifiant>, seloger:<numéro> ou identifiant Pillr.
de 3 à 200 caractères

Exemple d'appel

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

Réponse

bien_uidtexte
verdicttexte ou null
Verdict du dédoublonnage pour l'annonce qui ancre le bien : rattachee, nouvelle ou indecise (servi tel quel).
methodetexte ou null
Méthode du rattachement de l'annonce qui ancre le bien ; chaque annonce porte la sienne.
ancre_idtexte ou null
Annonce du lac qui ancre le bien.
decide_letexte ou null
annoncesliste d'objets
Afficher les 13 champsMasquer
- id_lactexte
- id_portailtexte ou null
- lientexte ou null
- sourcetexte ou null
- prixnombre ou null
- actifbooléen ou null
- parue_letexte ou null
- vue_letexte ou null
- retiree_letexte ou null
- verdicttexte ou null
- methodetexte ou null
- type_vendeurtexte
  Statut du vendeur déclaré par le portail : pro (agence, réseau, promoteur), particulier, ou inconnu.
  Valeurs : pro, particulier, inconnu
- annonceurobjet
  Le vendeur : un professionnel est nommé, un particulier jamais.
  Afficher les 4 champsMasquer
  - type_vendeurtexte
    Statut du vendeur déclaré par le portail : pro (agence, réseau, promoteur), particulier, ou inconnu.
    Valeurs : pro, particulier, inconnu
  - nomtexte ou null
    Nom de l'agence ou du professionnel tel que le portail l'affiche ; null pour un particulier.
  - enseignetexte ou null
    Enseigne ou réseau du professionnel ; null pour un particulier.
  - sirentexte ou null
    SIREN du professionnel quand le portail le publie ; null pour un particulier.
clesliste d'objets ou null
Clés d'identité des annonces (code postal, typologie, prix, empreinte de description) ; null si la vue des clés n'est pas encore publiée.
Afficher les 5 champsMasquer
- id_lactexte
- cptexte ou null
- tntexte ou null
- pntexte ou null
- dhtexte ou null
empreintes_photoliste d'objets ou null
Empreintes perceptuelles des photos ; null si la lecture a échoué.
Afficher les 4 champsMasquer
- id_lactexte
- rangentier
- phashtexte ou null
- phototexte ou null
agregatobjet
Afficher les 10 champsMasquer
- statuttexte
  Valeurs : en_vente, retire
- nb_annoncesentier
- nb_agencesentier
- nb_portailsentier
- nb_republicationsentier ou null
- prix_minnombre ou null
- prix_maxnombre ou null
- dernier_prixnombre ou null
- ecart_prix_pctnombre ou null
- premiere_parutiontexte ou null
certificationsliste d'objets
Afficher les 5 champsMasquer
- id_lactexte
- regletexte ou null
- verdict_avanttexte ou null
- applique_letexte ou null
- annule_letexte 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.

Pige complète : annonces actives et retirées du lac

GET/api/v1/annonces/archives

Toutes les annonces collectées par Pillr, actives et retirées, analysées ou non, avec les champs du portail et la vie de l'annonce (jours en ligne, baisses, republications, retrait) : par commune, code postal, département, point et rayon, ou SIREN d'agence, filtrées par type, prix, surface, dates de parution et de retrait, statut, portail, type de vendeur et baisse de prix. Le fonds pige et le fonds scraper_lbc servent les archives figées de l'ancienne pige et de l'ancien balayage Leboncoin, sans code INSEE, date de retrait ni statut actuel (un filtre qu'un fonds ne connaît pas est refusé sans débit).Un vendeur professionnel est servi en entier ; un particulier jamais par son nom ni ses coordonnées. Lecture lourde : servie depuis la mémoire seulement entre 20h30 et minuit. Un crédit par annonce rendue.

Coût: 1 crédit par élément rendu
Accès: À l'usage ou avec l'abonnement Data
Portée: annonces
Outil MCP: annonces_archives
Bac à sable: Oui, sans débit, sur un jeu figé
Mémoire: 1 h
Délai: 16 s

Essayer en direct

Paramètres

fondstexte
lac (défaut) : toutes les annonces balayées par Pillr ; pige et scraper_lbc : archives figées de l'ancienne pige et de l'ancien balayage Leboncoin.
Valeurs : lac, pige, scraper_lbc
inseevaleur
Code INSEE d'une commune, ou liste de 10 codes au plus (paramètre répété).
cpvaleur
Code postal, ou liste de 10 codes au plus.
departementvaleur
Code de département, ou liste de 8 codes au plus.
latnombre
Latitude du point de recherche (avec lon et rayon_km).
de -90 à 90
lonnombre
Longitude du point de recherche (avec lat et rayon_km).
de -180 à 180
rayon_kmnombre
Rayon autour du point, en km (50 au plus).
50 au plus ; plus de 0
sirentexte
typetexte
Type de bien : appartement, maison ou immeuble entier.
Valeurs : appartement, maison, immeuble
prix_minnombre
0 au moins
prix_maxnombre
0 au moins
surface_minnombre
0 au moins
surface_maxnombre
0 au moins
publie_aprestexte
Parues à partir de cette date (AAAA-MM-JJ).
publie_avanttexte
Parues avant cette date.
retire_aprestexte
Retirées à partir de cette date.
retire_avanttexte
Retirées avant cette date.
statuttexte
toutes par défaut.
Valeurs : active, retiree, toutes
sourcetexte
Valeurs : lbc, bienici, seloger, zefir
type_vendeurtexte
Statut du vendeur déclaré par le portail : pro (agence, réseau, promoteur), particulier, ou inconnu.
Valeurs : pro, particulier, inconnu
avec_baissevaleur
Vrai : seulement les annonces dont le prix a baissé.
tritexte
date (défaut, plus récentes d'abord), prix, prix_desc.
Valeurs : date, prix, prix_desc
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.

Exemple d'appel

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

Réponse

donneesliste d'objets
Afficher les 61 champsMasquer
- idtexte
  Identifiant de l'annonce dans son fonds (lac : identifiant du lac ; archives : identifiant chez le portail).
- fondstexte
  Valeurs : lac, pige, scraper_lbc
- id_portailtexte ou nullfacultatif
- lientexte ou nullfacultatif
- sourcetexte ou nullfacultatif
- titretexte ou nullfacultatif
- descriptiontexte ou nullfacultatif
- typetexte ou nullfacultatif
- neuf_ancientexte ou nullfacultatif
- prixnombre ou nullfacultatif
- prix_m2nombre ou nullfacultatif
- surfacenombre ou nullfacultatif
- sejour_m2nombre ou nullfacultatif
- piecesnombre ou nullfacultatif
- chambresnombre ou nullfacultatif
- salles_de_bainnombre ou nullfacultatif
- salles_d_eaunombre ou nullfacultatif
- etagenombre ou nullfacultatif
- nb_etagesnombre ou nullfacultatif
- terrain_m2nombre ou nullfacultatif
- annee_constructionnombre ou nullfacultatif
- inseetexte ou nullfacultatif
- code_postaltexte ou nullfacultatif
- communetexte ou nullfacultatif
- departementtexte ou nullfacultatif
- regiontexte ou nullfacultatif
- latnombre ou nullfacultatif
- lonnombre ou nullfacultatif
- precisiontexte ou nullfacultatif
- dpetexte ou nullfacultatif
- dpe_valeurnombre ou nullfacultatif
- gestexte ou nullfacultatif
- ges_valeurnombre ou nullfacultatif
- equipementsobjetfacultatif
  Afficher les 13 champsMasquer
  - ascenseurbooléen ou null
  - balconbooléen ou null
  - terrassebooléen ou null
  - jardinbooléen ou null
  - cavebooléen ou null
  - piscinebooléen ou null
  - parkingbooléen ou null
  - garagebooléen ou null
  - meublebooléen ou null
  - cuisine_equipeebooléen ou null
  - chauffagetexte ou null
  - chauffage_modetexte ou null
  - orientationtexte ou null
- charges_annuellesnombre ou nullfacultatif
- taxe_foncierenombre ou nullfacultatif
- prix_hors_honorairesnombre ou nullfacultatif
- honorairesnombre ou nullfacultatif
- honoraires_a_chargetexte ou nullfacultatif
- frais_notaire_estimesnombre ou nullfacultatif
- budget_energie_minnombre ou nullfacultatif
- budget_energie_maxnombre ou nullfacultatif
- lots_copronombre ou nullfacultatif
- en_coprobooléen ou nullfacultatif
- type_vendeurtextefacultatif
  Statut du vendeur déclaré par le portail : pro (agence, réseau, promoteur), particulier, ou inconnu.
  Valeurs : pro, particulier, inconnu
- annonceurobjetfacultatif
  Le vendeur : un professionnel est servi en entier (nom, enseigne, SIREN, mandat, coordonnées professionnelles), un particulier jamais.
  Afficher les 7 champsMasquer
  - type_vendeurtexte
    Statut du vendeur déclaré par le portail : pro (agence, réseau, promoteur), particulier, ou inconnu.
    Valeurs : pro, particulier, inconnu
  - nomtexte ou null
  - enseignetexte ou null
  - sirentexte ou null
  - mandattexte ou null
    Type de mandat publié (simple, exclusif) ; null si inconnu.
  - telephonetexte ou null
    Téléphone professionnel publié par le portail ; jamais celui d'un particulier.
  - emailtexte ou null
    Adresse électronique professionnelle publiée par le portail ; jamais celle d'un particulier.
- photosliste de textesfacultatif
- vignettetexte ou nullfacultatif
- visite_virtuellebooléen ou nullfacultatif
- premiere_parutiontexte ou nullfacultatif
- premiere_parution_estimeebooléen ou nullfacultatif
- vue_letexte ou nullfacultatif
- retiree_letexte ou nullfacultatif
- actifbooléen ou nullfacultatif
- jours_en_ligneentier ou nullfacultatif
- nb_baissesentier ou nullfacultatif
- baisse_totale_pctnombre ou nullfacultatif
- nb_republicationsentier ou nullfacultatif
- bien_uidtexte ou nullfacultatif
- etattexte ou nullfacultatif
  État du bien déclaré par le portail.
- drapeauxliste de textesfacultatif
  Ce qui doit faire lire l'annonce 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
notesliste de textes
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.
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_ 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é
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 dans une emprise de carte

GET/api/v1/annonces/carte

Les points des annonces actives et analysées dans une emprise de carte (sud, ouest, nord, est ; 3 degrés de côté au plus), filtrables par communes, départements, mots-clés, type, type de vendeur, DPE, travaux et règle « sous le marché » (rendement brut d'au moins 7 % et score d'au moins 70, comme la carte du site). Chaque point porte sa position et sa précision, son prix, sa surface, son score, son rendement et son identifiant. Les mieux notés d'abord, 1 000 points par page au plus.

Coût: 1 crédit par tranche de 10 lignes rendues
Accès: À l'usage ou avec l'abonnement Data
Portée: annonces
Outil MCP: annonces_carte
Bac à sable: Non
Mémoire: 15 min
Délai: 6 s

Essayer en direct

Paramètres

bboxtexteobligatoire
Emprise de la carte : sud,ouest,nord,est en degrés décimaux (3 degrés de côté au plus).
120 caractères au plus
inseevaleur
departementvaleur
cpvaleur
mots_clestexte
de 3 à 100 caractères
typetexte
Type de bien : appartement, maison ou immeuble entier.
Valeurs : appartement, maison, immeuble
type_vendeurtexte
Statut du vendeur déclaré par le portail : pro (agence, réseau, promoteur), particulier, ou inconnu.
Valeurs : pro, particulier, inconnu
dpevaleur
travaux_maxnombre
0 au moins
sous_le_marchevaleur
limiteentier
Nombre d'éléments par page (1000 au plus).
de 1 à 1 000 ; par défaut 500
curseurtexte
Curseur opaque rendu par la page précédente (curseur_suivant), à repasser tel quel.
de 1 à 1 024 caractères

Exemple d'appel

curl "https://pillr.fr/api/v1/annonces/carte?bbox=%3Cbbox%3E" \
  -H "Authorization: Bearer $PILLR_CLE"

Réponse

pointsliste d'objets
Afficher les 11 champsMasquer
- idtexte
- latnombre
- lonnombre
- precision_coordonneestexte ou null
- prixnombre ou null
- surfacenombre ou null
- prix_m2nombre ou null
- scorenombre ou null
- rendement_brutnombre ou null
- dpetexte ou null
  Valeurs : A, B, C, D, E, F, G
- typetexte
totalentier ou null
Points de l'emprise qui répondent, comptés sur la première page jusqu'à 10 000 ; null au-delà ou sur les pages suivantes.
tronquebooléen
Vrai s'il reste des points après cette page (curseur_suivant).
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.
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.

Écart au marché, anomalies et ventes du rayon

GET/api/v1/annonces/{id}/ecart-marche

Écart du prix au m² d'une annonce analysée au prix de référence Pillr de sa commune (le chiffre de la fiche, calculé par le même module canonique), avec le signal du modèle prédictif, les anomalies annonce contre marché du moteur de règles, les données de l'analyse (travaux, rendements, loyer, score, profil), les cibles et leviers de négociation, et toutes les ventes DVF du rayon une par une, reconstituées à la mutation entière, avec leurs agrégats par type et par année. Aucun seuil ne masque : chaque agrégat porte son nombre de ventes, chaque vente atypique son drapeau. Rien n'est débité si l'annonce est absente.

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

Essayer en direct

Paramètres

idtexteobligatoire
Identifiant de l'annonce : lbc:<numéro>, bienici:<identifiant>, seloger:<numéro> ou identifiant Pillr.
de 3 à 200 caractères
rayon_mentier
Rayon des ventes DVF autour de l'annonce, en mètres, de 50 à 1 000 (défaut 300).
de 50 à 1 000

Exemple d'appel

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

Réponse

idtexte
id_portailtexte ou null
type_vendeurtexte
Statut du vendeur : pro (professionnel nommé), particulier, ou inconnu quand le portail ne le dit pas. Une annonce qui n'est pas celle d'un professionnel perd les téléphones et les emails de ses textes.
Valeurs : pro, particulier, inconnu
prix_m2_annoncenombre ou null
prix_m2_marchenombre ou null
Prix de référence Pillr de la commune pour ce type de bien : le chiffre de la fiche.
ecart_pctnombre ou null
Écart du prix au m² de l'annonce au prix de référence, en % (positif : plus cher). null quand la référence n'est pas mesurée sur des ventes.
verdicttexte
Valeurs : tres_sous_cote, sous_cote, au_marche, sur_cote, tres_sur_cote, inconnu
signal_mltexte ou null
Signal du modèle prédictif départemental (un signal, jamais la valeur du marché).
referenceobjet
Afficher les 5 champsMasquer
- communetexte ou null
- code_inseetexte ou null
- code_postaltexte ou null
- provenancetexte ou null
  dvf : médiane de ventes notariées ; estimation : modèle Pillr, faute de ventes locales du type.
  Valeurs : dvf, estimation
- 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.
anomaliesliste d'objets
Afficher les 3 champsMasquer
- typetexte
- severitetexte
- messagetexte
donnees_annonceobjet
Afficher les 9 champsMasquer
- travaux_statuttexte ou null
- travaux_minnombre ou null
- travaux_maxnombre ou null
- rendement_brutnombre ou null
- rendement_netnombre ou null
- loyernombre ou null
- loyer_sourcetexte ou null
- scorenombre ou null
- profiltexte ou null
negociationobjet
Afficher les 3 champsMasquer
- cible_minnombre ou null
- cible_maxnombre ou null
- leviersliste de textes
ventes_rayonobjet
Afficher les 13 champsMasquer
- rayon_mentier
- nentier
  Ventes typiques du type de l'annonce dans le rayon, toutes années.
  0 au moins
- mediane_m2nombre ou null
- q1nombre ou null
- q3nombre ou null
- minnombre ou null
- maxnombre ou null
- millesimestexte ou null
- agregatsliste d'objets
  Afficher les 11 champsMasquer
  - type_bientexte
    Valeurs : appartement, maison
  - periodetexte
  - nb_ventesentier
    0 au moins
  - prix_m2_mediannombre ou null
  - prix_m2_q1nombre ou null
  - prix_m2_q3nombre ou null
  - prix_m2_minnombre ou null
  - prix_m2_maxnombre ou null
  - surface_mediane_m2nombre ou null
  - derniere_vente_letexte ou null
  - nb_prix_atypiquesentier
    Ventes du groupe écartées de l'agrégat pour prix atypique (listées une par une).
    0 au moins
- par_anneeliste d'objets
  Afficher les 11 champsMasquer
  - type_bientexte
    Valeurs : appartement, maison
  - periodetexte
  - nb_ventesentier
    0 au moins
  - prix_m2_mediannombre ou null
  - prix_m2_q1nombre ou null
  - prix_m2_q3nombre ou null
  - prix_m2_minnombre ou null
  - prix_m2_maxnombre ou null
  - surface_mediane_m2nombre ou null
  - derniere_vente_letexte ou null
  - nb_prix_atypiquesentier
    Ventes du groupe écartées de l'agrégat pour prix atypique (listées une par une).
    0 au moins
- ventesliste d'objets
  Toutes les ventes du rayon, une par une, les plus proches d'abord, chacune avec son drapeau prix_atypique.
  Afficher les 10 champsMasquer
  - datetexte
  - adressetexte ou null
    Numéro et voie tels que DVF les écrit ; null sans numéro.
  - type_bientexte
    Valeurs : appartement, maison
  - surface_m2nombre
  - prixnombre ou null
    Valeur foncière de la mutation entière.
  - prix_m2nombre
  - distance_mnombre ou null
  - id_mutationtexte ou null
  - prix_atypiquebooléen
  - motif_atypiquetexte ou null
- notetexte 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.
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.

Recommandation de négociation et lettre d'offre

POST/api/v1/annonces/{id}/negociation

Recommandation de négociation et lettre de proposition d'achat pour une annonce analysée : prix proposé (le vôtre, ou le prix demandé moins les travaux estimés et une marge de négociation, borné, comme sur la fiche), cibles et leviers relevés par l'analyse, vie de l'annonce (jours en ligne, baisses de prix), écart au prix de référence de la commune, puis arguments et lettre rédigés par l'IA à partir de ce seul contexte, au ton et au destinataire choisis. Un appel à un modèle Gemini par appel. Rien n'est débité si l'annonce est absente ou si l'IA ne rend rien d'exploitable.

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

Essayer en direct

Paramètres

idtexteobligatoire
Identifiant de l'annonce : lbc:<numéro>, bienici:<identifiant>, seloger:<numéro> ou identifiant Pillr.
de 3 à 200 caractères
prix_proposeentier
Votre prix proposé, en euros ; à défaut, le prix recommandé est calculé.
de 1 000 à 50 000 000
tontexte
Ton de la lettre (défaut : neutre).
Valeurs : cordial, neutre, ferme
destinatairetexte
À qui la lettre s'adresse : l'agence ou le vendeur.
Valeurs : agence, vendeur

Exemple d'appel

curl -X POST https://pillr.fr/api/v1/annonces/{id}/negociation \
  -H "Authorization: Bearer $PILLR_CLE" \
  -H "Content-Type: application/json" \
  -d '{}'

Réponse

idtexte
id_portailtexte ou null
type_vendeurtexte
Statut du vendeur : pro (professionnel nommé), particulier, ou inconnu quand le portail ne le dit pas. Une annonce qui n'est pas celle d'un professionnel perd les téléphones et les emails de ses textes.
Valeurs : pro, particulier, inconnu
prix_demandenombre
recommandationobjet
Afficher les 5 champsMasquer
- prix_proposenombre
- remisenombre
- remise_pctnombre
- originetexte
  calcul : prix demandé moins les travaux et une marge, borné ; client : le prix proposé par l'appelant.
  Valeurs : calcul, client
- methodetexte
cibleobjet
Afficher les 3 champsMasquer
- minnombre ou null
- maxnombre 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.
leviersliste de textes
Leviers de négociation relevés par l'analyse de l'annonce.
argumentsliste de textes
Arguments rédigés par l'IA, tirés du seul contexte servi.
lettretexte
Lettre de proposition d'achat, à compléter du nom et de la date.
vieobjet
Afficher les 5 champsMasquer
- premiere_parutiontexte ou null
- jours_en_lignenombre ou null
- baissesentier
  0 au moins
- baisse_cumulee_pctnombre ou null
- dernier_changement_letexte ou null
ecart_marcheobjet
Afficher les 3 champsMasquer
- prix_m2_annoncenombre ou null
- prix_m2_marchenombre ou null
- ecart_pctnombre ou null
sourcesliste de textes
moteurobjet
Afficher les 2 champsMasquer
- modeletexte ou null
- genere_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
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_ 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.

Potentiel de division d'un bien

GET/api/v1/annonces/{id}/division

Potentiel de division d'une annonce analysée, par la règle du Hub : la parcelle cadastrale du point de l'annonce (contenance, section, numéro, lue en direct à l'API Carto de l'IGN) croisée avec la surface habitable, le terrain déclaré, le prix au m² face au prix de référence de la commune et la demande locative. Rend un verdict (faible, modéré ou élevé) et ses signaux. Le point d'une annonce est souvent approché : la parcelle est celle du point servi, avec sa précision. Rien n'est débité si l'annonce est absente.

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

Essayer en direct

Paramètres

idtexteobligatoire
Identifiant de l'annonce : lbc:<numéro>, bienici:<identifiant>, seloger:<numéro> ou identifiant Pillr.
de 3 à 200 caractères

Exemple d'appel

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

Réponse

idtexte
id_portailtexte ou null
type_vendeurtexte
Statut du vendeur : pro (professionnel nommé), particulier, ou inconnu quand le portail ne le dit pas. Une annonce qui n'est pas celle d'un professionnel perd les téléphones et les emails de ses textes.
Valeurs : pro, particulier, inconnu
communetexte ou null
surface_bien_m2nombre ou null
piecesnombre ou null
terrain_annonce_m2nombre ou null
Terrain déclaré par le portail.
prix_m2_biennombre ou null
prix_m2_marchenombre ou null
ecart_prix_m2_pctnombre ou null
score_demandenombre ou null
Score de demande locative de la commune, sur 100.
pointobjet
Afficher les 3 champsMasquer
- latnombre ou null
- lonnombre ou null
- precisiontexte
  adresse, approchee, centre de la commune ou inconnue : la précision du point donné par le portail.
parcelleobjet ou null
Parcelle cadastrale qui contient le point de l'annonce (API Carto de l'IGN) ; null sans point ou sans réponse.
Afficher les 4 champsMasquer
- contenance_m2nombre ou null
- sectiontexte ou null
- numerotexte ou null
- communetexte ou null
potentiel_decoupetexte
Valeurs : faible, modere, eleve
signauxliste de textes
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.

Adresse retrouvée d'une annonce

GET/api/v1/annonces/{id}/adresse

Adresse retrouvée d'une annonce floutée, de trois façons, chacune avec sa qualité : l'adresse résolue par le croisement de sources indépendantes dans le disque de flou (ventes DVF, DPE, copropriétés, parcelles), avec sa confiance, sa méthode, la distance entre les sources et la clé BAN quand la Base Adresse Nationale la retrouve au numéro ; les adresses que désigne l'empreinte du DPE affiché (numéro de DPE, clé BAN, écart de surface), ambiguë quand elle en désigne plusieurs ; l'adresse validée par un utilisateur de Pillr. La résolution n'est pas relancée à l'appel : elle date du dernier passage du résolveur (resolue_le). Rien n'est débité si aucune des trois n'existe.

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

Essayer en direct

Paramètres

idtexteobligatoire
Identifiant de l'annonce : lbc:<numéro>, bienici:<identifiant>, seloger:<numéro> ou identifiant Pillr.
de 3 à 200 caractères

Exemple d'appel

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

Réponse

idtexte ou null
Identifiant Pillr de l'annonce dans la base servie ; null quand l'annonce n'est connue que des archives du lac.
id_portailtexte ou null
Identifiant de l'annonce chez son portail : lbc:<n>, bienici:<id> ou seloger:<id>.
resolueobjet ou null
Adresse résolue par le croisement de sources indépendantes dans le disque de flou ; null si l'annonce n'a pas été résolue.
Afficher les 12 champsMasquer
- adressetexte ou null
- cle_bantexte ou null
  Clé BAN de l'adresse résolue, quand la Base Adresse Nationale la retrouve au numéro ; null sinon.
- latnombre
- lonnombre
- confiancenombre
  Confiance du résolveur, de 0 à 1.
  de 0 à 1
- methodetexte
  Croisement retenu (dvf_x_dpe, dpe_x_copro, dvf_x_copro, dvf_x_parcelle, dpe_x_parcelle...).
- sourcesliste de textes
  Sources indépendantes qui concordent (dvf, dpe, copro, parcelle).
- concordance_mentier ou null
  Distance entre les positions des sources concordantes, en mètres.
- rayon_disque_mentier ou null
  Rayon du flou de l'annonce au moment de la résolution, en mètres.
- resolue_letexte ou null
- versiontexte ou null
  Version du résolveur.
- 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.
empreinte_dpeobjet ou null
Adresses retrouvées par l'empreinte du DPE affiché (étiquette, surface, date) ; null si aucune.
Afficher les 3 champsMasquer
- n_adressesentier
  Adresses que l'empreinte du DPE affiché désigne ; plus d'une : empreinte ambiguë.
- candidatsliste d'objets
  Afficher les 5 champsMasquer
  - numero_dpetexte
  - cle_bantexte ou null
  - date_dpetexte ou null
  - type_batimenttexte ou null
  - ecart_surface_m2nombre ou null
    Écart entre la surface du DPE et celle de l'annonce, en m².
- 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.
valideeobjet ou null
Adresse confirmée par un utilisateur de Pillr (cache partagé des localisations) ; null si aucune.
Afficher les 7 champsMasquer
- adressetexte
- latnombre ou null
- lonnombre ou null
- precisiontexte ou null
  Valeurs : numero, rue, lieu_dit, commune
- confiancetexte ou null
  Ce qui a fondé la validation, en clair (Street View, DPE...).
- letexte ou null
  Date de la validation.
- 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.

Localisation pas à pas (étapes déterministes)

GET/api/v1/annonces/{id}/localisation

Étapes déterministes de la localisation d'une annonce floutée, une par appel (etape), celles de l'outil du Hub : disque (centre et rayon du flou du portail, adresse BAN du centre, précision honnête des coordonnées, immeuble annoncé, adresse validée) ; dpe (DPE du miroir ADEME dans le disque, à la même étiquette, à la surface près et du même type, repli sur l'API de l'ADEME) ; dvf (ventes DVF de 2018 à 2025 du même type à 3 % de surface près, adresse retrouvée par la BAN) ; copro (copropriétés du registre national au nombre de lots annoncé) ; parcelle (maisons : parcelles du cadastre IGN à la contenance du terrain annoncé) ; batiments (bâtiments BD TOPO du disque, compatibles d'abord avec l'étage annoncé) ; geocoder (saisie q géocodée par la Base Adresse Nationale, au code postal de l'annonce ou à code_postal, et contrôlée contre le flou). Les candidats sont croisés avec les disques des rediffusions du même bien sur d'autres portails. tolerance règle l'étape : surface en m² pour dpe (1 à 15), lots pour copro (1 à 8), contenance en % pour parcelle (1 à 30). Street View, Google Maps et l'image aérienne ne sont donnés qu'en lien. Rien n'est débité quand l'annonce ne permet pas l'étape (sans étiquette DPE, sans surface, sans position, hors copropriété, sans terrain).

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

Essayer en direct

Paramètres

idtexteobligatoire
Identifiant de l'annonce : lbc:<numéro>, bienici:<identifiant>, seloger:<numéro> ou identifiant Pillr.
de 3 à 200 caractères
etapetexteobligatoire
L'étape à exécuter.
Valeurs : disque, dpe, dvf, copro, parcelle, batiments, geocoder
tolerancenombre
Tolérance de l'étape dpe (m²), copro (lots) ou parcelle (% de contenance), bornée par l'étape.
de 1 à 30
qtexte
geocoder : la rue, le lieu ou l'adresse à géocoder.
de 2 à 200 caractères
code_postaltexte
geocoder : code postal de la recherche (par défaut, celui de l'annonce).

Exemple d'appel

curl "https://pillr.fr/api/v1/annonces/{id}/localisation?etape=disque" \
  -H "Authorization: Bearer $PILLR_CLE"

Réponse

idtexte ou null
Identifiant Pillr de l'annonce dans la base servie ; null quand l'annonce n'est connue que des archives du lac.
id_portailtexte ou null
Identifiant de l'annonce chez son portail : lbc:<n>, bienici:<id> ou seloger:<id>.
etapetexte
Valeurs : disque, dpe, dvf, copro, parcelle, batiments, geocoder
criteresobjet
Les critères que l'étape a appliqués.
Afficher les 12 champsMasquer
- dpetexte ou null
  Valeurs : A, B, C, D, E, F, G
- type_bientexte ou null
- surface_m2nombre ou null
- tolerancenombre ou null
  Tolérance appliquée, après bornage par l'étape.
- unite_tolerancetexte ou null
  Valeurs : m2, lots, pct
- lotsentier ou null
- terrain_m2nombre ou null
- etageentier ou null
- etage_minimumentier ou null
- code_postaltexte ou null
- qtexte ou null
- anneesliste d'entiers ou null
disqueobjet ou null
Afficher les 5 champsMasquer
- centreobjet
  Afficher les 2 champsMasquer
  - latnombre
  - lonnombre
- rayon_flou_mentier ou null
  Rayon du flou donné par le portail ; null quand il ne le donne pas.
- rayon_recherche_mentier
  Rayon de recherche : le flou, ou le rayon supposé, plus la marge de géocodage.
- originetexte
  Valeurs : flou_du_portail, coordonnees_annonce
- rediffusions_croiseesentier ou null
  Disques des rediffusions du même bien sur d'autres portails, croisés avec celui-ci ; null quand l'étape ne les croise pas.
nb_candidatsentier
candidatsliste d'objets
Afficher les 27 champsMasquer
- adressetexte ou null
- cle_bantexte ou null
  Clé BAN du candidat quand il est retrouvé au numéro ; null sinon.
- latnombre ou null
- lonnombre ou null
- distance_mentier ou null
  Distance au centre du disque, en mètres.
- ecartnombre ou null
  Écart au critère de l'étape : m² de surface (dpe, dvf), lots (copro), m² de terrain (parcelle) ; null pour batiments et geocoder.
- dpetexte ou null
  Valeurs : A, B, C, D, E, F, G
- gestexte ou null
  Valeurs : A, B, C, D, E, F, G
- datetexte ou null
  Date du DPE (dpe) ou de la vente (dvf).
- surface_m2nombre ou null
- typetexte ou null
  Type de bâtiment du DPE (dpe).
- periode_constructiontexte ou null
- valeur_foncierenombre ou null
  Prix de la vente DVF, en euros (dvf).
- lots_totalentier ou null
- lots_habitationentier ou null
- nom_coproprietetexte ou null
  Nom d'usage de la copropriété au registre (copro).
- contenance_m2nombre ou null
- sectiontexte ou null
- numero_parcelletexte ou null
- niveauxentier ou null
  Niveaux du bâtiment BD TOPO, sinon estimés par sa hauteur (batiments).
- hauteur_mnombre ou null
- usagetexte ou null
- logementsentier ou null
- compatible_etagebooléen ou null
  Vrai si l'étage annoncé existe dans le bâtiment ; null sans étage annoncé ou sans hauteur connue.
- precisiontexte ou null
  Type du résultat de la Base Adresse Nationale (geocoder) : housenumber, street, locality, municipality.
- scorenombre ou null
  Score de la Base Adresse Nationale, de 0 à 1 (geocoder).
- liensobjet
  Liens vers le point ; null quand le point manque.
  Afficher les 3 champsMasquer
  - street_viewtexte ou null
    Lien Google Street View du point (un lien : aucune image Google n'est servie).
  - mapstexte ou null
    Lien Google Maps du point.
  - orthotexte ou null
    Image aérienne de l'IGN (Géoplateforme, service WMS) centrée sur le point.
dans_le_disquebooléen ou null
geocoder : vrai si l'adresse tombe dans le flou du portail, faux pour une voie homonyme hors du disque ; null sans flou.
situationobjet ou null
disque : ce que l'annonce dit de sa position ; null pour les autres étapes.
Afficher les 8 champsMasquer
- precisiontexte
  Précision honnête des coordonnées affichées : avec un flou, jamais au numéro.
  Valeurs : aucune, disque_de_flou, numero, rue, approchee
- adresse_procheobjet ou null
  Adresse BAN la plus proche du centre : celle du centre du flou, pas celle du bien.
  Afficher les 4 champsMasquer
  - adressetexte
  - cle_bantexte ou null
  - typetexte
  - scorenombre
- communetexte ou null
- code_postaltexte ou null
- inseetexte ou null
- quartiertexte ou null
- batimentobjet
  Afficher les 5 champsMasquer
  - etageentier ou null
  - nb_etagesentier ou null
  - en_coproprietebooléen ou null
  - lots_coproentier ou null
  - ascenseurbooléen ou null
- liensobjet
  Liens vers le point ; null quand le point manque.
  Afficher les 3 champsMasquer
  - street_viewtexte ou null
    Lien Google Street View du point (un lien : aucune image Google n'est servie).
  - mapstexte ou null
    Lien Google Maps du point.
  - orthotexte ou null
    Image aérienne de l'IGN (Géoplateforme, service WMS) centrée sur le point.
adresse_valideeobjet ou null
Adresse confirmée par un utilisateur de Pillr (cache partagé des localisations) ; null si aucune.
Afficher les 7 champsMasquer
- adressetexte
- latnombre ou null
- lonnombre ou null
- precisiontexte ou null
  Valeurs : numero, rue, lieu_dit, commune
- confiancetexte ou null
  Ce qui a fondé la validation, en clair (Street View, DPE...).
- letexte ou null
  Date de la validation.
- 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.
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.

Indices de localisation lus sur les photos

GET/api/v1/annonces/{id}/localisation/indices-photos

Lecture par vision (Gemini) des 4 premières photos et de la description d'une annonce : noms de rue, enseignes, numéros de voirie, monuments, lieux cités, vue depuis les fenêtres, quartier et indice le plus fort. Seuls des indices lus sont rendus, jamais devinés : un indice se géocode ensuite par localiser_annonce (etape geocoder) ou lieu_par_indice. Les photos sont lues sur les serveurs des portails ; la description d'un particulier est passée au modèle sans ses coordonnées.

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

Essayer en direct

Paramètres

idtexteobligatoire
Identifiant de l'annonce : lbc:<numéro>, bienici:<identifiant>, seloger:<numéro> ou identifiant Pillr.
de 3 à 200 caractères

Exemple d'appel

curl https://pillr.fr/api/v1/annonces/{id}/localisation/indices-photos \
  -H "Authorization: Bearer $PILLR_CLE"

Réponse

idtexte ou null
Identifiant Pillr de l'annonce dans la base servie ; null quand l'annonce n'est connue que des archives du lac.
id_portailtexte ou null
Identifiant de l'annonce chez son portail : lbc:<n>, bienici:<id> ou seloger:<id>.
vues_exterieuresbooléen
Vrai si au moins une photo montre l'extérieur, la façade, la rue ou une vue.
quartiertexte ou null
ruesliste de textes
Noms de rue ou de place lus sur un panneau ou dans la description.
enseignesliste de textes
Enseignes de commerces lisibles.
numerosliste de textes
Numéros de voirie visibles.
monumentsliste de textes
Monuments, églises, gares, écoles identifiés par leur nom.
lieux_prochesliste de textes
Lieux nommés dans la description.
vuetexte ou null
Ce qui se voit depuis les fenêtres ou le balcon.
indice_principaltexte ou null
L'indice le plus exploitable pour situer le bien.
photos_analyseesentier
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.

Lieu réel d'un indice par Google Maps

GET/api/v1/annonces/{id}/localisation/lieux

Résout un indice de localisation (enseigne, repère, ligne de tram) en lieu réel par Gemini avec l'outil Google Maps, biaisé sur le centre du flou de l'annonce (sinon sur lat et lon, sinon sur sa position affichée) pour écarter les homonymes lointains : la réponse du modèle et 5 lieux Google Maps au plus. Le lieu trouvé se contrôle ensuite par localiser_annonce (etape geocoder), qui dit s'il tombe dans le disque. Résultat soumis aux conditions de Google Maps Platform : jamais gardé en mémoire par Pillr, la source est citée.

Coût: 40 crédits par appel réussi
Accès: À l'usage ou avec l'abonnement Data
Portée: annonces
Outil MCP: lieu_par_indice
Bac à sable: Non
Mémoire: Jamais gardée
Délai: 30 s

Essayer en direct

Paramètres

idtexteobligatoire
Identifiant de l'annonce : lbc:<numéro>, bienici:<identifiant>, seloger:<numéro> ou identifiant Pillr.
de 3 à 200 caractères
qtexteobligatoire
L'indice à résoudre : enseigne, repère, ligne de transport.
de 2 à 200 caractères
latnombre
Latitude du biais, quand l'annonce n'a pas de flou.
de -90 à 90
lonnombre
Longitude du biais, quand l'annonce n'a pas de flou.
de -180 à 180

Exemple d'appel

curl "https://pillr.fr/api/v1/annonces/{id}/localisation/lieux?q=%3Cq%3E" \
  -H "Authorization: Bearer $PILLR_CLE"

Réponse

idtexte ou null
Identifiant Pillr de l'annonce dans la base servie ; null quand l'annonce n'est connue que des archives du lac.
id_portailtexte ou null
Identifiant de l'annonce chez son portail : lbc:<n>, bienici:<id> ou seloger:<id>.
qtexte
reponsetexte
La réponse du modèle : le lieu le plus probable, son adresse ou son quartier.
lieuxliste d'objets
Les lieux Google Maps cités par la réponse.
Afficher les 3 champsMasquer
- titretexte
- uritexte ou null
- place_idtexte ou null
point_de_biaisobjet ou null
Le point autour duquel la recherche est biaisée : le centre du flou, sinon lat et lon, sinon la position affichée.
Afficher les 2 champsMasquer
- latnombre
- lonnombre
sourcetexte
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.

Comparaison de façade avec Street View

POST/api/v1/annonces/{id}/localisation/street-view

Compare par vision (Gemini) la façade des 4 premières photos de l'annonce aux images Google Street View de 1 à 3 adresses candidates, en une seule passe : verdict (oui, non, incertain), confiance, raison et classement des candidats. Un candidat sans couverture Street View n'est pas comparé ni payé. Les images Street View ne sont jamais servies ni gardées : seul un lien l'est. Rien n'est débité sans photo d'annonce, sans couverture ou si le service est coupé.

Coût: 40 crédits par appel réussi
Accès: À l'usage ou avec l'abonnement Data
Portée: annonces
Outil MCP: street_view
Bac à sable: Non
Mémoire: Jamais gardée
Délai: 60 s

Essayer en direct

Paramètres

idtexteobligatoire
Identifiant de l'annonce : lbc:<numéro>, bienici:<identifiant>, seloger:<numéro> ou identifiant Pillr.
de 3 à 200 caractères
candidatsliste d'objets
Les adresses candidates.
1 éléments au moins ; 3 éléments au plus
Afficher les 3 champsMasquer
- latnombreobligatoire
  de -90 à 90
- lonnombreobligatoire
  de -180 à 180
- libelletexte
  Adresse ou nom du candidat, repris dans le classement.
  200 caractères au plus
latnombre
Un seul candidat : sa latitude (sans candidats).
de -90 à 90
lonnombre
Un seul candidat : sa longitude (sans candidats).
de -180 à 180
capnombre
Cap de la prise de vue Street View, en degrés.
de 0 à 360

Exemple d'appel

curl -X POST https://pillr.fr/api/v1/annonces/{id}/localisation/street-view \
  -H "Authorization: Bearer $PILLR_CLE" \
  -H "Content-Type: application/json" \
  -d '{}'

Réponse

idtexte ou null
Identifiant Pillr de l'annonce dans la base servie ; null quand l'annonce n'est connue que des archives du lac.
id_portailtexte ou null
Identifiant de l'annonce chez son portail : lbc:<n>, bienici:<id> ou seloger:<id>.
correspondancetexte
Verdict du candidat retenu : oui, non ou incertain.
Valeurs : oui, non, incertain
confiancenombre ou null
Confiance déclarée par le modèle, de 0 à 1.
de 0 à 1
raisontexte ou null
lien_street_viewtexte ou null
Lien Google Street View du candidat retenu (aucune image n'est servie).
images_compareesentier
Images Street View réellement comparées (un candidat sans couverture n'est pas payé).
classementliste d'objets
Afficher les 8 champsMasquer
- candidatentier
  Rang du candidat dans la demande, à partir de 1.
- libelletexte ou null
- correspondancetexte
  Valeurs : oui, non, incertain
- confiancenombre ou null
  de 0 à 1
- raisontexte ou null
- latnombre ou null
- lonnombre ou null
- lien_street_viewtexte 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
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_ 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.

Dossier d'un immeuble de rapport

GET/api/v1/annonces/{id}/immeuble

Le dossier d'un immeuble de rapport, en cinq blocs, celui de l'outil analyse_immeuble du Hub : 1. les lots établis par les DPE de l'adresse (candidats dans un rayon de 250 m, confiance par concordance de surface et nombre de logements annoncé, désaccord) ; 2. l'état locatif lot par lot au loyer de la Carte des loyers selon la taille de chaque lot, et une découpe en lots de 40 ou 30 m² ; 3. le prix face à la prime de division DVF de la commune (repli départemental), servie quel que soit le nombre de ventes ; 4. les seuils fiscaux propres à l'immeuble ; 5. les risques datés, dont le calendrier énergétique par étiquette. Le vendeur n'est jamais nommé. Pour une annonce d'immeuble du catalogue Pillr, par son identifiant.

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

Essayer en direct

Paramètres

idtexteobligatoire
Identifiant de l'annonce : lbc:<numéro>, bienici:<identifiant>, seloger:<numéro> ou identifiant Pillr.
de 3 à 200 caractères

Exemple d'appel

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

Réponse

annonceobjet
L'annonce de l'immeuble ; le vendeur n'y est jamais nommé.
Afficher les 14 champsMasquer
- idtexte ou null
  Identifiant Pillr de l'annonce analysée ; null pour un immeuble du lac pas encore analysé.
- sourcetexte
- lientexte ou null
  Lien d'origine de l'annonce, servi quand la clé porte la portée lien_origine.
- titretexte ou null
- communetexte ou null
- code_postaltexte ou null
- inseetexte ou null
- prixnombre ou null
- surface_m2nombre ou null
- piecesnombre ou null
- dpetexte ou null
- latnombre ou null
- lonnombre ou null
- type_vendeurtexte
  Valeurs : pro, particulier, inconnu
bloc_1_lotsobjet
Afficher les 13 champsMasquer
- disponiblebooléen
- confiancetexte
  mesure : lots énumérés dont la surface cumulée concorde à 20 % près avec la surface annoncée ; indice : lots énumérés sans concordance ; inconnu : aucun DPE exploitable.
  Valeurs : mesure, indice, inconnu
- nb_lotsentier
- nb_lots_annonceentier ou null
  Nombre de logements que le titre ou la description annonce.
- adressetexte ou null
  Adresse BAN des DPE retenus.
- surface_cumulee_m2nombre ou null
- surface_annoncee_m2nombre ou null
- ecart_surface_pctnombre ou null
- lotsliste d'objets
  Afficher les 3 champsMasquer
  - surface_m2nombre ou null
  - etiquette_dpetexte ou null
  - dpe_etabli_letexte ou null
- desaccordtexte ou null
- autres_candidatsliste d'objets
  Afficher les 3 champsMasquer
  - adressetexte ou null
  - nb_lotsentier
  - surface_cumulee_m2nombre ou null
- 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.
bloc_2_etat_locatifobjet
Afficher les 9 champsMasquer
- loyer_m2_communenombre ou null
- loyer_sourcetexte ou null
- loyer_mensuel_estimenombre ou null
- loyer_annuel_estimenombre ou null
- rendement_brut_pctnombre ou null
- detail_lotsliste d'objets
  Afficher les 3 champsMasquer
  - surface_m2nombre ou null
  - etiquette_dpetexte ou null
  - loyer_mensuel_eurnombre ou null
- methodetexte
- decoupeobjet
  Afficher les 7 champsMasquer
  - disponiblebooléen
  - en_lots_de_40_m2objet ou null
    Afficher les 4 champsMasquer
    nb_lotsentier
    surface_par_lot_m2nombre
    loyer_mensuelnombre ou null
    ecart_pctnombre ou null
    Écart au loyer de la configuration actuelle, en %.
  - en_lots_de_30_m2objet ou null
    Afficher les 4 champsMasquer
    nb_lotsentier
    surface_par_lot_m2nombre
    loyer_mensuelnombre ou null
    ecart_pctnombre ou null
    Écart au loyer de la configuration actuelle, en %.
  - loyer_m2_t1_t2nombre ou null
  - loyer_m2_t3plusnombre ou null
  - sourcetexte ou null
  - avertissementtexte 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.
bloc_3_prixobjet
Afficher les 10 champsMasquer
- disponiblebooléen
- mailletexte ou null
  Valeurs : commune, departement
- prix_m2_unitenombre ou null
- prix_m2_blocnombre ou null
- rapportnombre ou null
- n_uniteentier
- n_blocentier
- positiontexte ou null
  Le prix au m² de l'annonce situé entre le prix en bloc et le prix à l'unité.
- avertissementtexte
- 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.
bloc_4_fiscaliteobjet
Afficher les 4 champsMasquer
- seuil_micro_bic_par_lot_eurnombre
- seuil_micro_foncier_eurnombre
- seuil_cotisations_sociales_lcd_eurnombre
- particularitesliste de textes
bloc_5_risquesobjet
Afficher les 4 champsMasquer
- calendrier_energetiquetexte ou null
- concentrationtexte
- lots_sous_contrainteentier ou null
  Lots en F ou G parmi les lots établis.
- a_verifierliste de textes
ordretexte
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é
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.

Dossier d'un immeuble pas encore analysé

POST/api/v1/immeubles/analyses

Le dossier d'un immeuble de rapport, en cinq blocs, celui de l'outil analyse_immeuble du Hub : 1. les lots établis par les DPE de l'adresse (candidats dans un rayon de 250 m, confiance par concordance de surface et nombre de logements annoncé, désaccord) ; 2. l'état locatif lot par lot au loyer de la Carte des loyers selon la taille de chaque lot, et une découpe en lots de 40 ou 30 m² ; 3. le prix face à la prime de division DVF de la commune (repli départemental), servie quel que soit le nombre de ventes ; 4. les seuils fiscaux propres à l'immeuble ; 5. les risques datés, dont le calendrier énergétique par étiquette. Le vendeur n'est jamais nommé. Pour un immeuble collecté par Pillr que la file d'analyse n'a pas encore atteint, par le lien de son annonce (source_url).

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

Essayer en direct

Paramètres

source_urltexteobligatoire
Lien de l'annonce de l'immeuble sur son portail d'origine.
500 caractères au plus ; adresse web

Exemple d'appel

curl -X POST https://pillr.fr/api/v1/immeubles/analyses \
  -H "Authorization: Bearer $PILLR_CLE" \
  -H "Content-Type: application/json" \
  -d '{"source_url":"<source_url>"}'

Réponse

annonceobjet
L'annonce de l'immeuble ; le vendeur n'y est jamais nommé.
Afficher les 14 champsMasquer
- idtexte ou null
  Identifiant Pillr de l'annonce analysée ; null pour un immeuble du lac pas encore analysé.
- sourcetexte
- lientexte ou null
  Lien d'origine de l'annonce, servi quand la clé porte la portée lien_origine.
- titretexte ou null
- communetexte ou null
- code_postaltexte ou null
- inseetexte ou null
- prixnombre ou null
- surface_m2nombre ou null
- piecesnombre ou null
- dpetexte ou null
- latnombre ou null
- lonnombre ou null
- type_vendeurtexte
  Valeurs : pro, particulier, inconnu
bloc_1_lotsobjet
Afficher les 13 champsMasquer
- disponiblebooléen
- confiancetexte
  mesure : lots énumérés dont la surface cumulée concorde à 20 % près avec la surface annoncée ; indice : lots énumérés sans concordance ; inconnu : aucun DPE exploitable.
  Valeurs : mesure, indice, inconnu
- nb_lotsentier
- nb_lots_annonceentier ou null
  Nombre de logements que le titre ou la description annonce.
- adressetexte ou null
  Adresse BAN des DPE retenus.
- surface_cumulee_m2nombre ou null
- surface_annoncee_m2nombre ou null
- ecart_surface_pctnombre ou null
- lotsliste d'objets
  Afficher les 3 champsMasquer
  - surface_m2nombre ou null
  - etiquette_dpetexte ou null
  - dpe_etabli_letexte ou null
- desaccordtexte ou null
- autres_candidatsliste d'objets
  Afficher les 3 champsMasquer
  - adressetexte ou null
  - nb_lotsentier
  - surface_cumulee_m2nombre ou null
- 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.
bloc_2_etat_locatifobjet
Afficher les 9 champsMasquer
- loyer_m2_communenombre ou null
- loyer_sourcetexte ou null
- loyer_mensuel_estimenombre ou null
- loyer_annuel_estimenombre ou null
- rendement_brut_pctnombre ou null
- detail_lotsliste d'objets
  Afficher les 3 champsMasquer
  - surface_m2nombre ou null
  - etiquette_dpetexte ou null
  - loyer_mensuel_eurnombre ou null
- methodetexte
- decoupeobjet
  Afficher les 7 champsMasquer
  - disponiblebooléen
  - en_lots_de_40_m2objet ou null
    Afficher les 4 champsMasquer
    nb_lotsentier
    surface_par_lot_m2nombre
    loyer_mensuelnombre ou null
    ecart_pctnombre ou null
    Écart au loyer de la configuration actuelle, en %.
  - en_lots_de_30_m2objet ou null
    Afficher les 4 champsMasquer
    nb_lotsentier
    surface_par_lot_m2nombre
    loyer_mensuelnombre ou null
    ecart_pctnombre ou null
    Écart au loyer de la configuration actuelle, en %.
  - loyer_m2_t1_t2nombre ou null
  - loyer_m2_t3plusnombre ou null
  - sourcetexte ou null
  - avertissementtexte 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.
bloc_3_prixobjet
Afficher les 10 champsMasquer
- disponiblebooléen
- mailletexte ou null
  Valeurs : commune, departement
- prix_m2_unitenombre ou null
- prix_m2_blocnombre ou null
- rapportnombre ou null
- n_uniteentier
- n_blocentier
- positiontexte ou null
  Le prix au m² de l'annonce situé entre le prix en bloc et le prix à l'unité.
- avertissementtexte
- 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.
bloc_4_fiscaliteobjet
Afficher les 4 champsMasquer
- seuil_micro_bic_par_lot_eurnombre
- seuil_micro_foncier_eurnombre
- seuil_cotisations_sociales_lcd_eurnombre
- particularitesliste de textes
bloc_5_risquesobjet
Afficher les 4 champsMasquer
- calendrier_energetiquetexte ou null
- concentrationtexte
- lots_sous_contrainteentier ou null
  Lots en F ou G parmi les lots établis.
- a_verifierliste de textes
ordretexte
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
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_ 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.

Audit d'une liste de biens face au marché

POST/api/v1/portefeuilles/audit

Audite une liste d'annonces suivies, ou les favoris du compte de la clé : prix au m² du bien contre celui du secteur (même type de bien), baisse depuis l'ajout, échéance de la loi Climat, loyer estimé contre loyer de marché, score et rendement, avec des alertes d'arbitrage. Mêmes calculs que l'outil d'audit du Hub. Un crédit par bien audité.

Coût: 1 crédit par élément rendu
Accès: À l'usage ou avec l'abonnement Data
Portée: annonces
Outil MCP: audit_portefeuille
Bac à sable: Non
Mémoire: Jamais gardée
Délai: 8 s

Essayer en direct

Paramètres

biensliste d'objets
1 éléments au moins ; 50 éléments au plus
Afficher les 3 champsMasquer
- idtexteobligatoire
  Identifiant de l'annonce : lbc:<numéro>, bienici:<identifiant>, seloger:<numéro> ou identifiant Pillr.
  de 3 à 200 caractères
- prix_ajoutnombre
  Prix au moment où le bien a été suivi, en euros.
  0 au moins
- ajoute_letexte
favorisbooléen
Vrai : audite les favoris du compte de la clé (clé personnelle).

Exemple d'appel

curl -X POST https://pillr.fr/api/v1/portefeuilles/audit \
  -H "Authorization: Bearer $PILLR_CLE" \
  -H "Content-Type: application/json" \
  -d '{}'

Réponse

nb_biensentier
biensliste d'objets
Afficher les 20 champsMasquer
- idtexte
  Identifiant demandé (lbc:<n>...) ou identifiant de l'annonce du favori.
- annonce_idtexte ou null
- titretexte ou null
- villetexte ou null
- code_postaltexte ou null
- surfacenombre ou null
- dpetexte ou null
  Valeurs : A, B, C, D, E, F, G
- scorenombre ou null
- prixnombre ou null
- prix_ajoutnombre ou null
- prix_m2_biennombre ou null
- prix_m2_marchenombre ou null
- ecart_prix_pctnombre ou null
- rendement_brut_pctnombre ou null
- loyer_estimenombre ou null
- loyer_marche_estimenombre ou null
- actifbooléen ou null
- alertesliste d'objets
  Afficher les 2 champsMasquer
  - codetexte
  - textetexte
- type_vendeurtexte
  Valeurs : pro, particulier, inconnu
- 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.
non_trouvesliste de textes
Identifiants absents du catalogue : non audités, non débités.
hors_perimetreliste de textes
Identifiants hors du périmètre du contrat de la clé : non audités, non débités.
tronquebooléen
Vrai si le compte a plus de favoris que l'audit n'en lit.
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_ 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.

Annonces recommandées pour le compte

GET/api/v1/compte/recommandations

Des annonces actives et analysées choisies pour l'utilisateur de la clé, avec les règles de la page du site : d'après les motifs de ses favoris (ville, type, budget et surface autour de leur moyenne), sinon d'après la stratégie de son profil investisseur, sinon les meilleurs scores du catalogue. Les motifs retenus sont rendus avec les annonces.

Coût: 1 crédit par élément rendu
Accès: À l'usage ou avec l'abonnement Data
Portée: annonces
Outil MCP: recommandations
Bac à sable: Non
Mémoire: Jamais gardée
Délai: 5 s

Essayer en direct

Paramètres

nombreentier
Annonces rendues au plus.
de 1 à 12 ; par défaut 3

Exemple d'appel

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

Réponse

donneesliste d'objets
Afficher les 17 champsMasquer
- idtexte
  Identifiant de l'annonce : lbc:<n>, bienici:<id> ou seloger:<id>.
- typetexte
- communetexte ou null
- code_postaltexte ou null
- prixnombre ou null
- surfacenombre ou null
- piecesnombre ou null
- prix_m2nombre ou null
- dpetexte ou null
  Valeurs : A, B, C, D, E, F, G
- scorenombre ou null
- loyer_estimenombre ou null
- rendement_brutnombre ou null
- rendement_netnombre ou null
- travaux_maxnombre ou null
- type_vendeurtexte
  Valeurs : pro, particulier, inconnu
- lientexte ou null
  Lien d'origine, 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.
basetexte
Ce sur quoi la sélection s'appuie.
Valeurs : favoris, profil, catalogue
raisontexte
motifsobjet
Afficher les 6 champsMasquer
- typetexte ou null
  Valeurs : appartement, maison
- budgetobjet ou null
  Afficher les 2 champsMasquer
  - minnombre ou null
  - maxnombre ou null
- surfaceobjet ou null
  Afficher les 2 champsMasquer
  - minnombre ou null
  - maxnombre ou null
- dpeliste de textes
  Valeurs : A, B, C, D, E, F, G
- villesliste de textes
- strategietexte 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.

Annonces : référence de l'API | Pillr Data