Pré-marché

8 opérations servies.

/

Pré-marché d'une adresse

GET/api/v1/adresses/{cle_ban}/pre-marche

Pour une adresse (clé BAN), la probabilité calibrée qu'une vente DVF y soit enregistrée dans les 12 mois, calculée à la lecture comme dans le Hub : indice des coefficients mesurés, bande de calibration et son taux de vente réel, lift, fenêtre de mandat et priorité, fiabilité (mesure sur les maisons positionnées, indicatif ailleurs), raisons chiffrées, coefficients retenus, faits datés au jour du DPE, frise des évènements de l'adresse (DPE, audit, ventes, sociétés civiles, permis, copropriété, annonce) et sociétés civiles domiciliées, nommées avec leur SIREN quand le BODACC le rattache. Hors du périmètre calibré (Alsace-Moselle notamment), la raison est servie à la place du calcul.

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

Essayer en direct

Paramètres

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

Exemple d'appel

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

Réponse

cle_bantexte
hors_perimetretexte ou null
Pourquoi l'adresse sort du périmètre calibré (Alsace-Moselle, DPE collectif, neuf livré, adresse sans position...) ; null si elle est calculée.
adresseobjet ou null
Le calcul de l'adresse ; null hors du périmètre calibré.
Afficher les 31 champsMasquer
- rangentier
- cle_bantexte
- adressetexte
- communetexte
- code_postaltexte ou null
- inseetexte
- latnombre
- lonnombre
- type_bientexte
  Valeurs : maison, appartement, immeuble, autre
- dpetexte ou null
- periode_constructiontexte ou null
- chauffagetexte ou null
- dpe_letexte
- age_dpe_joursentier
- audit_letexte ou null
- pack_pre_ventebooléen
- p_ventenombre
  Probabilité calibrée qu'une vente DVF soit enregistrée à l'adresse dans les 12 mois.
- liftnombre ou null
  p_vente divisée par le taux de vente mesuré du type de bien.
- fiabilitetexte
  mesure : maison positionnée dans la BAN, la population où la calibration est démontrée ; indicatif sinon.
  Valeurs : mesure, indicatif
- raisonsliste de textes
  Les coefficients réellement appliqués, du plus fort au plus faible, puis l'âge du DPE et la fenêtre de mandat.
- fenetre_mandatobjet
  Afficher les 2 champsMasquer
  - valeurnombre
    Part des vendeurs encore libres d'un mandat à cet âge du DPE (mesurée sur le délai entre le DPE et la première annonce).
  - libelletexte
- prioritenombre
  p_vente multipliée par la fenêtre de mandat : l'ordre du classement.
- deja_en_ventebooléen
- annonceobjet ou null
  Afficher les 6 champsMasquer
  - idtexte ou null
  - lientexte ou null
    Lien d'origine de l'annonce, servi quand la clé porte la portée lien_origine.
  - parue_letexte ou null
  - prixnombre ou null
  - type_vendeurtexte
    Valeurs : pro, particulier, inconnu
  - agenceobjet ou null
    L'agence qui publie l'annonce ; null pour un vendeur particulier ou inconnu.
    Afficher les 3 champsMasquer
    nomtexte ou null
    enseignetexte ou null
    sirentexte ou null
- derniere_venteobjet ou null
  Afficher les 2 champsMasquer
  - datetexte ou null
  - prixnombre ou null
- annees_detentionnombre ou null
- societes_civilesliste d'objets
  Afficher les 5 champsMasquer
  - denominationtexte ou null
  - sirentexte ou null
    SIREN lu dans le BODACC pour cette dénomination et ce code postal ; null s'il n'est pas rattaché sans ambiguïté.
  - formetexte ou null
  - dernier_avistexte ou null
  - letexte ou null
- permisobjet ou null
  Afficher les 3 champsMasquer
  - nentier
  - dernier_letexte ou null
  - typetexte ou null
- coproobjet ou null
  Afficher les 2 champsMasquer
  - lotsnombre ou null
  - syndictexte ou null
- logementsobjet
  Afficher les 2 champsMasquer
  - nombreentier ou null
  - sourcetexte ou null
    Valeurs : dpe, copropriete, maison
- friseliste d'objets
  Afficher les 5 champsMasquer
  - datetexte
  - typetexte
    Valeurs : dpe, audit, vente, sci, permis, copro, annonce
  - libelletexte
  - detailtexte ou null
  - apres_dpebooléen
    Vrai si l'évènement est postérieur au dernier DPE.
bandeobjet ou null
La bande de calibration qui contient l'indice : son nombre d'adresses et son taux de vente mesuré.
Afficher les 5 champsMasquer
- bandeentier
- nentier
- indice_minnombre
- indice_maxnombre
- taux_vente_12m_pctnombre
indicenombre ou null
Produit des coefficients mesurés (public.pre_marche_indice_v3).
coefficientsliste d'objets
Les coefficients retenus pour ce type de bien, tels que mesurés.
Afficher les 5 champsMasquer
- signaltexte
- groupetexte ou null
- coefficientnombre ou null
- lift_dvfnombre ou null
- n_dvfnombre ou null
variablesobjet ou null
Les faits datés au jour du DPE qui entrent dans l'indice.
Afficher les 10 champsMasquer
- audit_connubooléen
- annees_detention_au_dpenombre ou null
- dpe_valide_au_dpebooléen
- nb_dpe_365j_avantnombre ou null
- sci_connue_au_dpebooléen
- ventes_ilot_avant_dpenombre ou null
- ventes_numero_avant_dpenombre ou null
- copro_ilotbooléen
- surface_m2nombre ou null
- multiplicateur_age_dpenombre ou null
precisionobjet
Afficher les 4 champsMasquer
- base_pctnombre ou null
  Taux de vente DVF à 12 mois mesuré du type de bien, en %.
- haut_pctnombre ou null
  Taux mesuré dans la bande de probabilité la plus haute, en %.
- descriptiontexte
- mesure_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.
calcule_letexte ou null
creditsobjet
Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).
Afficher les 2 champsMasquer
- debitesentier
  0 au moins
- restantsentier ou null

Erreurs possibles

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

Adresses à prospecter d'un secteur

GET/api/v1/pre-marche

Les adresses d'un secteur (une commune, une liste de communes, une intercommunalité, un code postal ou un cercle) dont le DPE a moins de 24 mois, classées par priorité de prospection : la probabilité calibrée de vente DVF à 12 mois multipliée par la fenêtre de mandat. La réponse comprend le comptage du secteur, la précision mesurée, puis pour chaque adresse ses raisons, sa frise, l'annonce et l'agence quand elle est déjà en vente, ses sociétés civiles nommées, sa dernière vente, sa copropriété et son nombre de logements, et le total des logements pour un boîtage. Les adresses déjà en vente ou vendues depuis le DPE sont exclues, sauf demande.

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

Essayer en direct

Paramètres

inseetexte
Code INSEE de la commune ou de l'arrondissement (5 caractères, 2A ou 2B pour la Corse).
communestexte
Communes du secteur, noms ou codes INSEE séparés par des virgules (40 au plus).
de 1 à 2 000 caractères
cptexte
Code postal.
epcitexte
Intercommunalité : son code SIREN à 9 chiffres, ou son nom.
de 2 à 120 caractères
latnombre
de -90 à 90
lonnombre
de -180 à 180
rayon_kmnombre
Rayon du cercle autour de lat et lon, de 0,3 à 15 km (2 par défaut).
de 0,3 à 15
type_bientexte
tous par défaut.
Valeurs : maison, appartement, tous
inclure_deja_en_ventetexte
true : garder les adresses déjà en vente ou vendues depuis le DPE.
Valeurs : true, false
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

Exemple d'appel

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

Réponse

secteurobjet
Afficher les 6 champsMasquer
- libelletexte
- communesliste d'objets
  Afficher les 2 champsMasquer
  - inseetexte
  - communetexte
- intercommunaliteobjet ou null
  Afficher les 3 champsMasquer
  - codetexte
  - nomtexte
  - extrait_letexte
- code_postaltexte ou null
- centreobjet ou null
  Afficher les 3 champsMasquer
  - latnombre
  - lonnombre
  - rayon_kmnombre
- introuvablesliste de textes
type_bientexte
Valeurs : maison, appartement, tous
comptageobjet
Afficher les 7 champsMasquer
- adresses_dpe_24mentier
- dpe_moins_90jentier
- avec_packentier
- deja_en_venteentier
- vendues_depuisentier
- hors_perimetreentier
- prospectablesentier
precisionobjet
Afficher les 4 champsMasquer
- base_pctnombre ou null
  Taux de vente DVF à 12 mois mesuré du type de bien, en %.
- haut_pctnombre ou null
  Taux mesuré dans la bande de probabilité la plus haute, en %.
- descriptiontexte
- mesure_letexte ou null
adressesliste d'objets
Afficher les 31 champsMasquer
- rangentier
- cle_bantexte
- adressetexte
- communetexte
- code_postaltexte ou null
- inseetexte
- latnombre
- lonnombre
- type_bientexte
  Valeurs : maison, appartement, immeuble, autre
- dpetexte ou null
- periode_constructiontexte ou null
- chauffagetexte ou null
- dpe_letexte
- age_dpe_joursentier
- audit_letexte ou null
- pack_pre_ventebooléen
- p_ventenombre
  Probabilité calibrée qu'une vente DVF soit enregistrée à l'adresse dans les 12 mois.
- liftnombre ou null
  p_vente divisée par le taux de vente mesuré du type de bien.
- fiabilitetexte
  mesure : maison positionnée dans la BAN, la population où la calibration est démontrée ; indicatif sinon.
  Valeurs : mesure, indicatif
- raisonsliste de textes
  Les coefficients réellement appliqués, du plus fort au plus faible, puis l'âge du DPE et la fenêtre de mandat.
- fenetre_mandatobjet
  Afficher les 2 champsMasquer
  - valeurnombre
    Part des vendeurs encore libres d'un mandat à cet âge du DPE (mesurée sur le délai entre le DPE et la première annonce).
  - libelletexte
- prioritenombre
  p_vente multipliée par la fenêtre de mandat : l'ordre du classement.
- deja_en_ventebooléen
- annonceobjet ou null
  Afficher les 6 champsMasquer
  - idtexte ou null
  - lientexte ou null
    Lien d'origine de l'annonce, servi quand la clé porte la portée lien_origine.
  - parue_letexte ou null
  - prixnombre ou null
  - type_vendeurtexte
    Valeurs : pro, particulier, inconnu
  - agenceobjet ou null
    L'agence qui publie l'annonce ; null pour un vendeur particulier ou inconnu.
    Afficher les 3 champsMasquer
    nomtexte ou null
    enseignetexte ou null
    sirentexte ou null
- derniere_venteobjet ou null
  Afficher les 2 champsMasquer
  - datetexte ou null
  - prixnombre ou null
- annees_detentionnombre ou null
- societes_civilesliste d'objets
  Afficher les 5 champsMasquer
  - denominationtexte ou null
  - sirentexte ou null
    SIREN lu dans le BODACC pour cette dénomination et ce code postal ; null s'il n'est pas rattaché sans ambiguïté.
  - formetexte ou null
  - dernier_avistexte ou null
  - letexte ou null
- permisobjet ou null
  Afficher les 3 champsMasquer
  - nentier
  - dernier_letexte ou null
  - typetexte ou null
- coproobjet ou null
  Afficher les 2 champsMasquer
  - lotsnombre ou null
  - syndictexte ou null
- logementsobjet
  Afficher les 2 champsMasquer
  - nombreentier ou null
  - sourcetexte ou null
    Valeurs : dpe, copropriete, maison
- friseliste d'objets
  Afficher les 5 champsMasquer
  - datetexte
  - typetexte
    Valeurs : dpe, audit, vente, sci, permis, copro, annonce
  - libelletexte
  - detailtexte ou null
  - apres_dpebooléen
    Vrai si l'évènement est postérieur au dernier DPE.
boitageobjet
Afficher les 2 champsMasquer
- logementsentier
  Logements des adresses de la page, pour dimensionner un boîtage.
- adresses_sans_nombreentier
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 ou null
curseur_suivanttexte ou null
Curseur de la page suivante, à repasser dans curseur ; null sur la dernière page.
creditsobjet
Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).
Afficher les 2 champsMasquer
- debitesentier
  0 au moins
- restantsentier ou null

Erreurs possibles

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

Radar de prospection d'une commune ou d'un département

GET/api/v1/communes/{insee}/radar

GET/api/v1/departements/{departement}/radar

Radar de prospection mensuel d'une commune, ou de toutes les communes d'un département classées par score : score sur 100, rang dans le département, cinq blocs (vendeurs sans agence, mandats qui patinent, absence d'agence dominante, parc immobile, signaux amont) et leur détail (pression des DPE, vente directe, mandats essoufflés, stock, agences présentes, part du leader et concentration, exclusifs, prix au m² médian, durée médiane, baisses). Le dernier mois calculé, ou le mois demandé. Des agrégats communaux, sans adresse ni nom. Liste paginée.

Coût: 3 crédits par élément rendu
Accès: À l'usage ou avec l'abonnement Data
Portée: pre_marche
Outil MCP: radar_prospection
Bac à sable: Oui, sans débit, sur un jeu figé
Mémoire: 24 h
Délai: 15 s

Essayer en direct

Paramètres de /api/v1/communes/{insee}/radar

inseetexteobligatoire
Code INSEE de la commune ou de l'arrondissement (5 caractères, 2A ou 2B pour la Corse).
moistexte
Mois du radar, AAAA-MM ; le dernier calculé par défaut.
limiteentier
Nombre d'éléments par page (50 au plus).
de 1 à 50 ; par défaut 20
curseurtexte
Curseur opaque rendu par la page précédente (curseur_suivant), à repasser tel quel.
de 1 à 1 024 caractères

Paramètres de /api/v1/departements/{departement}/radar

departementtexteobligatoire
Code du département (01 à 95, 2A, 2B, 971 à 976).

Exemple d'appel

curl https://pillr.fr/api/v1/communes/{insee}/radar \
  -H "Authorization: Bearer $PILLR_CLE"

Réponse

moistexte ou null
Mois du radar servi, AAAA-MM.
perimetreobjet
Afficher les 2 champsMasquer
- niveautexte
  Valeurs : commune, departement
- codetexte
donneesliste d'objets
Afficher les 6 champsMasquer
- inseetexte
- communetexte ou null
- scorenombre ou null
  Score de prospection sur 100.
- rang_departemententier ou null
- blocsobjet
  Afficher les 5 champsMasquer
  - gisementnombre ou null
    Vendeurs sans agence (percentile).
  - essoufflementnombre ou null
    Mandats en place qui patinent (percentile).
  - ouverturenombre ou null
    Aucune agence ne tient le secteur (percentile).
  - dormantnombre ou null
    Parc immobile (percentile).
  - amontnombre ou null
- detailobjet ou null
  Afficher les 15 champsMasquer
  - pression_dpe_idxnombre ou null
  - dpe_moisnombre ou null
  - dpe_attendunombre ou null
  - dpe_passoiresnombre ou null
  - vente_directenombre ou null
  - vente_directe_pctnombre ou null
  - mandats_essouflesnombre ou null
  - stocknombre ou null
  - agences_presentesnombre ou null
  - part_leadernombre ou null
  - concentration_hhinombre ou null
  - exclusifs_pctnombre ou null
  - prix_m2_mediannombre ou null
  - duree_mediane_jnombre ou null
  - baisses_pctnombre ou null
qualiteobjet
Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
Afficher les 7 champsMasquer
- nentier ou null
  Nombre d'observations derrière la valeur ; null si sans objet.
  0 au moins
- provenancetexte ou null
  mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
  Valeurs : mesure, estime
- incertitudeobjet ou null
  Incertitude de la valeur : fourchette et demi-largeur.
  Afficher les 3 champsMasquer
  - demi_largeur_pctnombre ou null
    Demi-largeur de la fourchette, en % de la valeur.
  - basnombre ou null
  - hautnombre ou null
- drapeauxliste de textes
  Ce qui doit faire lire la valeur avec prudence ; vide si rien.
  Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne
- methodetexte ou null
  Méthode de calcul ou de rattachement, en clair.
- donnees_dutexte ou null
  Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
- sourcetexte
  Source publique ou moteur Pillr, en clair.
donnees_dutexte ou null
curseur_suivanttexte ou null
Curseur de la page suivante, à repasser dans curseur ; null sur la dernière page.
creditsobjet
Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).
Afficher les 2 champsMasquer
- debitesentier
  0 au moins
- restantsentier ou null

Erreurs possibles

400parametres_invalidesUn paramètre manque ou ne passe pas son contrôle ; le détail est donné champ par champ
401cle_absenteL'en-tête Authorization manque
401cle_invalideLa clé est inconnue, révoquée ou expirée
403organisation_suspendueL'organisation de la clé n'est pas active
403portee_insuffisanteLa clé ou l'accès de l'organisation n'ouvre pas cette opération
403hors_bac_a_sableUne clé pk_test_ 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.

Plan de prospection rédigé

POST/api/v1/communes/{insee}/radar/plan

Plan de prospection d'une commune, rédigé par un modèle de langage à partir des faits du radar du mois (score, blocs, flux d'annonces, vente directe, agences, vacance, copropriétés, ventes), rendus avec le plan : trois à cinq phrases, aucun chiffre absent des faits (une réponse qui en invente est rejetée), aucune adresse ni aucun nom, jamais de démarchage téléphonique d'un particulier. Sans plan fiable, rien n'est débité.

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

Essayer en direct

Paramètres

inseetexteobligatoire
Code INSEE de la commune ou de l'arrondissement (5 caractères, 2A ou 2B pour la Corse).
moistexte
Mois du radar, AAAA-MM ; le dernier calculé par défaut.

Exemple d'appel

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

Réponse

inseetexte
Code INSEE demandé.
communetexte ou null
Nom de la commune ou de l'arrondissement.
moistexte
plantexte
Le plan rédigé, trois à cinq phrases, sans chiffre absent des faits.
faits_utilisesobjet
Afficher les 17 champsMasquer
- scorenombre ou null
- rang_departemententier ou null
- blocsobjet
  Afficher les 4 champsMasquer
  - gisementnombre ou null
  - essoufflementnombre ou null
  - ouverturenombre ou null
  - dormantnombre ou null
- entreesnombre ou null
- vente_directenombre ou null
- vente_directe_pctnombre ou null
- stocknombre ou null
- duree_mediane_jnombre ou null
- prix_m2_mediannombre ou null
- agencesnombre ou null
- part_leadernombre ou null
- logements_privesnombre ou null
- taux_vacancenombre ou null
- vacants_2ansnombre ou null
- coprosnombre ou null
- copros_sans_mandatnombre ou null
- ventes_trimestrenombre ou null
sourcesliste de textes
modeletexte 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.

Créer un suivi de zone

POST/api/v1/alertes/zones

Crée un suivi de zone rattaché au compte de la clé : une commune, un code INSEE, un code postal, un disque autour d'un point, une liste de communes ou une intercommunalité (une alerte par commune). Trois volets, actifs par défaut : le pré-marché (adresses dont la priorité dépasse le seuil), les annonces de particuliers qui stagnent, baissent ou republient, et les signaux marché (baisses de la veille, passages en multi-mandat). Passage chaque nuit, quotidien ou hebdomadaire ; le premier a lieu le lendemain matin. Rien n'est créé si le secteur dépasse les places libres sous le plafond des suivis actifs du compte.

Coût: 0 crédit par appel réussi
Accès: À l'usage ou avec l'abonnement Data
Portée: pre_marche
Outil MCP: alertes_zone_creer
Bac à sable: Non
Mémoire: Jamais gardée
Délai: 10 s

Essayer en direct

Paramètres

communetexte
Nom de la commune suivie.
de 1 à 80 caractères
inseetexte
Code INSEE de la commune ou de l'arrondissement (5 caractères, 2A ou 2B pour la Corse).
cptexte
Code postal.
autourobjet
Un disque autour d'un point : le seul moyen d'enregistrer un rayon.
Afficher les 3 champsMasquer
- latnombreobligatoire
  de -90 à 90
- lonnombreobligatoire
  de -180 à 180
- rayon_kmnombre
  Rayon en km (borné par le moteur des alertes).
  plus de 0
type_bientexte
Valeurs : maison, appartement, tous
nomtexte
de 1 à 120 caractères
communesliste de textes
Plusieurs communes, noms ou codes INSEE : une alerte chacune.
1 éléments au moins ; 40 éléments au plus
intercommunalitetexte
Nom ou SIREN d'une intercommunalité : une alerte par commune membre.
de 2 à 120 caractères
pre_marchebooléen
seuil_priorite_pctentier
Seuil de priorité du volet pré-marché, en %.
de 5 à 90
particuliersbooléen
jours_minentier
Ancienneté à partir de laquelle une annonce de particulier stagne, en jours.
de 15 à 180
marchebooléen
baissesbooléen
multi_mandatbooléen
frequencetexte
Valeurs : quotidien, hebdomadaire

Exemple d'appel

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

Réponse

alertesliste d'objets
Les alertes créées : une par commune pour une liste de communes ou une intercommunalité.
Afficher les 12 champsMasquer
- idtexte
- formuletexte
  Valeurs : suivi_de_zone, pre_marche_seul
- nomtexte ou null
- secteurtexte ou null
  Le secteur en une ligne (« Gex · tous biens »).
- voletsliste de textes
  Ce que l'alerte surveille, en clair, une phrase par volet actif.
- seuil_priorite_pctnombre ou null
- jours_minnombre ou null
- frequencetexte ou null
- activebooléen
- par_courrielbooléen
  Vrai si les résultats partent aussi dans le courriel du matin du compte.
- dernier_passagetexte ou null
- cree_letexte ou null
perimetre_enregistreobjet
Ce que la ou les alertes surveillent réellement, relu sur ce qui a été enregistré.
Afficher les 5 champsMasquer
- communesliste d'objets
  Afficher les 2 champsMasquer
  - communetexte ou null
  - inseetexte ou null
- code_postaltexte ou null
- rayonobjet ou null
  Afficher les 3 champsMasquer
  - latnombre
  - lonnombre
  - rayon_kmnombre
- type_bientexte
- phrasetexte
  Le périmètre enregistré, en clair.
deja_suiviesliste de textes
Communes déjà suivies par une alerte active, non recréées.
introuvablesliste de textes
non_creeesliste d'objets
Afficher les 2 champsMasquer
- communetexte
- raisontexte
doublon_possibletexte ou null
Nom d'une alerte active qui couvre déjà ce secteur ; null sinon.
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.

Créer une veille pré-marché

POST/api/v1/alertes/pre-marche

Crée une veille pré-marché rattachée au compte de la clé, sur un secteur (commune, code INSEE, code postal ou disque autour d'un point) : chaque nuit, les nouvelles adresses dont la priorité dépasse le seuil. Le compte garde un plafond de veilles pré-marché actives.

Coût: 0 crédit par appel réussi
Accès: À l'usage ou avec l'abonnement Data
Portée: pre_marche
Outil MCP: alertes_pre_marche_creer
Bac à sable: Non
Mémoire: Jamais gardée
Délai: 8 s

Essayer en direct

Paramètres

communetexte
Nom de la commune suivie.
de 1 à 80 caractères
inseetexte
Code INSEE de la commune ou de l'arrondissement (5 caractères, 2A ou 2B pour la Corse).
cptexte
Code postal.
autourobjet
Un disque autour d'un point : le seul moyen d'enregistrer un rayon.
Afficher les 3 champsMasquer
- latnombreobligatoire
  de -90 à 90
- lonnombreobligatoire
  de -180 à 180
- rayon_kmnombre
  Rayon en km (borné par le moteur des alertes).
  plus de 0
type_bientexte
Valeurs : maison, appartement, tous
nomtexte
de 1 à 120 caractères
seuil_priorite_pctentier
Seuil de priorité, en %.
de 5 à 90

Exemple d'appel

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

Réponse

alertesliste d'objets
Les alertes créées : une par commune pour une liste de communes ou une intercommunalité.
Afficher les 12 champsMasquer
- idtexte
- formuletexte
  Valeurs : suivi_de_zone, pre_marche_seul
- nomtexte ou null
- secteurtexte ou null
  Le secteur en une ligne (« Gex · tous biens »).
- voletsliste de textes
  Ce que l'alerte surveille, en clair, une phrase par volet actif.
- seuil_priorite_pctnombre ou null
- jours_minnombre ou null
- frequencetexte ou null
- activebooléen
- par_courrielbooléen
  Vrai si les résultats partent aussi dans le courriel du matin du compte.
- dernier_passagetexte ou null
- cree_letexte ou null
perimetre_enregistreobjet
Ce que la ou les alertes surveillent réellement, relu sur ce qui a été enregistré.
Afficher les 5 champsMasquer
- communesliste d'objets
  Afficher les 2 champsMasquer
  - communetexte ou null
  - inseetexte ou null
- code_postaltexte ou null
- rayonobjet ou null
  Afficher les 3 champsMasquer
  - latnombre
  - lonnombre
  - rayon_kmnombre
- type_bientexte
- phrasetexte
  Le périmètre enregistré, en clair.
deja_suiviesliste de textes
Communes déjà suivies par une alerte active, non recréées.
introuvablesliste de textes
non_creeesliste d'objets
Afficher les 2 champsMasquer
- communetexte
- raisontexte
doublon_possibletexte ou null
Nom d'une alerte active qui couvre déjà ce secteur ; null sinon.
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.

Alertes du compte

GET/api/v1/alertes

Les suivis de zone et les veilles pré-marché du compte de la clé, actives d'abord : secteur, volets suivis, seuils, fréquence et dernier passage.

Coût: 0 crédit par appel réussi
Accès: À l'usage ou avec l'abonnement Data
Portée: pre_marche
Outil MCP: alertes
Bac à sable: Non
Mémoire: Jamais gardée
Délai: 4 s

Essayer en direct

Paramètres

Aucun.

Exemple d'appel

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

Réponse

alertesliste d'objets
Afficher les 12 champsMasquer
- idtexte
- formuletexte
  Valeurs : suivi_de_zone, pre_marche_seul
- nomtexte ou null
- secteurtexte ou null
  Le secteur en une ligne (« Gex · tous biens »).
- voletsliste de textes
  Ce que l'alerte surveille, en clair, une phrase par volet actif.
- seuil_priorite_pctnombre ou null
- jours_minnombre ou null
- frequencetexte ou null
- activebooléen
- par_courrielbooléen
  Vrai si les résultats partent aussi dans le courriel du matin du compte.
- dernier_passagetexte ou null
- cree_letexte ou null
actives_zoneentier
max_zoneentier
actives_pre_marcheentier
max_pre_marcheentier
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.

Supprimer une alerte

DELETE/api/v1/alertes/{id}

Supprime un suivi de zone ou une veille pré-marché du compte de la clé, avec ses résultats.

Coût: 0 crédit par appel réussi
Accès: À l'usage ou avec l'abonnement Data
Portée: pre_marche
Outil MCP: alertes_supprimer
Bac à sable: Non
Mémoire: Jamais gardée
Délai: 4 s

Essayer en direct

Paramètres

idtexteobligatoire
Identifiant de l'alerte.
format uuid

Exemple d'appel

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

Réponse

idtexte
formuletexte
Valeurs : suivi_de_zone, pre_marche_seul
supprimeebooléen
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.