Veille, évènements et webhooks
Flux datés, abonnements signés, agents de veille et alertes. 14 opérations servies.
Flux d'évènements des annonces
Essayer en direct/api/v1/flux/annoncesLes évènements datés du catalogue des annonces de vente, dans l'ordre où ils ont été écrits : nouvelle annonce, analyse publiée ou refaite, baisse et hausse de prix, retrait, réactivation, passage à plusieurs agences. Chaque évènement porte l'état avant et après, et l'annonce au format liste. Filtres : depuis (date), genres, communes, codes postaux, départements. Le curseur_suivant est rendu même sur la dernière page : repassez-le plus tard, avec les mêmes filtres, pour ne lire que la suite ; a_jour dit qu'il n'y a plus rien à lire pour l'instant. Les baisses de prix sont dédoublonnées au jour et au nouveau prix.
- Coût
- 1 crédit par évènement livré
- Accès
- Avec l'abonnement Data
- Portée
- flux
- Outil MCP
- flux_annonces
- Bac à sable
- Non
- Cache serveur
- 0 min
- Délai maximal
- 6 s
Paramètres
depuistexteNe lire que les évènements écrits depuis cette date (AAAA-MM-JJ ou horodatage ISO 8601).
40 caractères au plus
genresvaleurGenre, ou liste de genres (paramètre répété) ; tous si absent.
inseevaleurCode INSEE, ou liste de 20 codes au plus (paramètre répété).
cpvaleurCode postal, ou liste de 20 codes au plus.
departementvaleurCode de département, ou liste de 10 codes au plus.
limiteentierNombre d'éléments par page (1000 au plus).
de 1 à 1 000 ; par défaut 100
curseurtexteCurseur 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/flux/annonces \
-H "Authorization: Bearer $PILLR_CLE"Réponse
evenementsliste d'objetsLes évènements, dans l'ordre du flux.
Afficher les 7 champsMasquer
idtexteIdentifiant de l'évènement, croissant dans l'ordre du flux.
genretextenouvelle (annonce entrée au catalogue), analyse (première analyse publiée), reanalyse (analyse refaite), baisse_prix, hausse_prix, retrait (annonce retirée du portail), reactivation, multi_agences (le bien passe à deux agences ou plus).
Valeurs :
nouvelle,analyse,reanalyse,baisse_prix,hausse_prix,retrait,reactivation,multi_agencesletexteHorodatage de l'évènement (ISO 8601).
annonce_idtexteIdentifiant Pillr de l'annonce.
avantobjet ou nullÉtat de l'annonce avant ou après l'évènement.
Afficher les 10 champsMasquer
prixnombre ou nullPrix, en euros (baisse_prix, hausse_prix, nouvelle).
ecart_pctnombre ou nullÉcart du prix, en % (baisse_prix, hausse_prix).
detecte_letexte ou nullDate de détection du changement de prix.
actifbooléen ou nullAnnonce en ligne (retrait, reactivation, nouvelle).
analyse_letexte ou nullDate de l'analyse (analyse, reanalyse).
scorenombre ou nullScore Pillr de l'analyse (analyse, reanalyse).
nb_agencesnombre ou nullAgences qui publient le bien (multi_agences).
nb_portailsnombre ou nullPortails qui publient le bien (multi_agences).
prix_minnombre ou nullPrix le plus bas entre les annonces du bien (multi_agences).
prix_maxnombre ou nullPrix le plus haut entre les annonces du bien (multi_agences).
apresobjet ou nullÉtat de l'annonce avant ou après l'évènement.
Afficher les 10 champsMasquer
prixnombre ou nullPrix, en euros (baisse_prix, hausse_prix, nouvelle).
ecart_pctnombre ou nullÉcart du prix, en % (baisse_prix, hausse_prix).
detecte_letexte ou nullDate de détection du changement de prix.
actifbooléen ou nullAnnonce en ligne (retrait, reactivation, nouvelle).
analyse_letexte ou nullDate de l'analyse (analyse, reanalyse).
scorenombre ou nullScore Pillr de l'analyse (analyse, reanalyse).
nb_agencesnombre ou nullAgences qui publient le bien (multi_agences).
nb_portailsnombre ou nullPortails qui publient le bien (multi_agences).
prix_minnombre ou nullPrix le plus bas entre les annonces du bien (multi_agences).
prix_maxnombre ou nullPrix le plus haut entre les annonces du bien (multi_agences).
annonceobjet ou nullL'annonce au format liste ; null si elle n'est plus servie (doublon d'un autre portail, sortie du catalogue).
Afficher les 26 champsMasquer
idtexteIdentifiant Pillr de l'annonce (à repasser à /annonces/{id}).
id_portailtexte ou nullIdentifiant chez le portail, servi avec la portée lien_origine.
lientexte ou nullLien d'origine de l'annonce, servi avec la portée lien_origine.
sourcetexte ou nullPortail d'origine : lbc, bienici ou seloger.
statuttexte ou nullactif, retire ou masque.
typetexte ou nullappartement, maison ou immeuble.
communetexte ou nullcode_postaltexte ou nullinseetexte ou nulldepartementtexte ou nulllatnombre ou nulllonnombre ou nullprecision_coordonneestexte ou nulladresse, approchee, centre_commune ou inconnue.
prixnombre ou nullsurfacenombre ou nullpiecesnombre ou nullprix_m2nombre ou nullPrix divisé par la surface (jamais la valeur du portail).
dpetexte ou nullValeurs :
A,B,C,D,E,F,Gscorenombre ou nullScore Pillr sur 100 ; null tant que l'annonce n'est pas analysée.
rendement_brutnombre ou nullRendement brut en %, recalculé depuis le loyer estimé et le prix.
rendement_netnombre ou nullRendement net en %, recalculé sur le budget total.
etat_visuelnombre ou nullÉtat visuel lu sur les photos, sur 100.
premiere_parutiontexte ou nulltype_vendeurtexteStatut du vendeur déclaré par le portail : pro (agence, réseau, promoteur), particulier, ou inconnu.
Valeurs :
pro,particulier,inconnuannonceurobjetLe vendeur : un professionnel est nommé, un particulier jamais.
Afficher les 4 champsMasquer
type_vendeurtexteStatut du vendeur déclaré par le portail : pro (agence, réseau, promoteur), particulier, ou inconnu.
Valeurs :
pro,particulier,inconnunomtexte ou nullNom de l'agence ou du professionnel ; null pour un particulier.
enseignetexte ou nullEnseigne ou réseau du professionnel ; null pour un particulier.
sirentexte ou nullSIREN du professionnel quand le portail le publie ; null pour un particulier.
drapeauxliste de textesCe 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
a_jourbooléenVrai quand le flux n'a plus rien à lire pour l'instant : repassez curseur_suivant plus tard pour reprendre.
qualiteobjetCe qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
Afficher les 7 champsMasquer
nentier ou nullNombre d'observations derrière la valeur ; null si sans objet.
0 au moins
provenancetexte ou nullmesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
Valeurs :
mesure,estimeincertitudeobjet ou nullIncertitude de la valeur : fourchette et demi-largeur.
Afficher les 3 champsMasquer
demi_largeur_pctnombre ou nullDemi-largeur de la fourchette, en % de la valeur.
basnombre ou nullhautnombre ou null
drapeauxliste de textesCe 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_anciennemethodetexte ou nullMéthode de calcul ou de rattachement, en clair.
donnees_dutexte ou nullDate de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
sourcetexteSource publique ou moteur Pillr, en clair.
curseur_suivanttexte ou nullCurseur de la page suivante, à repasser dans curseur ; null sur la dernière page.
creditsobjetCré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
debitesentier0 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
- 403palier_insuffisantL'accès de l'organisation n'atteint pas celui que l'opération exige
- 403hors_bac_a_sableUne clé pk_test_ l'appelle : l'opération n'a pas de bac à sable
Afficher les 11 erreurs communes à toute l'APIMasquer les erreurs communes
- 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
- 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. Guide des erreurs
Flux de nouveautés à l'adresse
Essayer en direct/api/v1/flux/adressesLes nouveautés datées à l'adresse, lues dans le journal tenu chaque nuit après la reconstruction de la donnée à l'adresse : nouveau DPE, nouvel audit énergétique, nouvelle autorisation d'urbanisme, nouvel avis d'une société civile au siège, nouvelle vente DVF. Chaque évènement porte la clé BAN, la date à la source, le détail et la source publique. Filtres : depuis (date d'entrée au journal), genres, communes, codes postaux. Le curseur_suivant est rendu même sur la dernière page : repassez-le plus tard, avec les mêmes filtres, pour ne lire que la suite.
- Coût
- 1 crédit par évènement livré
- Accès
- Avec l'abonnement Data
- Portée
- flux
- Outil MCP
- flux_adresses
- Bac à sable
- Non
- Cache serveur
- 1 min
- Délai maximal
- 4 s
Paramètres
depuistexteNe lire que les évènements entrés au journal depuis cette date.
40 caractères au plus
genresvaleurGenre, ou liste de genres ; tous si absent.
inseevaleurCode INSEE, ou liste de 20 codes au plus (paramètre répété).
cpvaleurCode postal, ou liste de 20 codes au plus.
limiteentierNombre d'éléments par page (1000 au plus).
de 1 à 1 000 ; par défaut 100
curseurtexteCurseur 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/flux/adresses \
-H "Authorization: Bearer $PILLR_CLE"Réponse
evenementsliste de valeursLes évènements, dans l'ordre du journal.
a_jourbooléenVrai quand le journal n'a plus rien à lire pour l'instant : repassez curseur_suivant plus tard pour reprendre.
qualiteobjetCe qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
Afficher les 7 champsMasquer
nentier ou nullNombre d'observations derrière la valeur ; null si sans objet.
0 au moins
provenancetexte ou nullmesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
Valeurs :
mesure,estimeincertitudeobjet ou nullIncertitude de la valeur : fourchette et demi-largeur.
Afficher les 3 champsMasquer
demi_largeur_pctnombre ou nullDemi-largeur de la fourchette, en % de la valeur.
basnombre ou nullhautnombre ou null
drapeauxliste de textesCe 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_anciennemethodetexte ou nullMéthode de calcul ou de rattachement, en clair.
donnees_dutexte ou nullDate de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
sourcetexteSource publique ou moteur Pillr, en clair.
curseur_suivanttexte ou nullCurseur de la page suivante, à repasser dans curseur ; null sur la dernière page.
creditsobjetCré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
debitesentier0 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
- 403palier_insuffisantL'accès de l'organisation n'atteint pas celui que l'opération exige
- 403hors_bac_a_sableUne clé pk_test_ l'appelle : l'opération n'a pas de bac à sable
Afficher les 11 erreurs communes à toute l'APIMasquer les erreurs communes
- 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
- 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. Guide des erreurs
Créer un abonnement webhook
Essayer en direct/api/v1/webhooksAbonne une URL https aux évènements du flux des annonces (genres et filtres au choix), à la fin des opérations asynchrones de l'organisation, et aux résultats des veilles et des alertes que l'organisation a créées par l'API (livrés 15 minutes au moins après leur remontée, au format de resultats_veilles). Chaque livraison est un POST JSON signé par l'en-tête Pillr-Signature (t=horodatage, v1=HMAC-SHA256 du texte « horodatage.corps » avec le secret de l'abonnement), reprise à 1 min, 5 min, 30 min, 2 h et 12 h en cas d'échec ; l'abonnement est coupé après 50 échecs consécutifs. Le secret n'est affiché qu'à la création. Chaque évènement d'annonce et chaque résultat livré est débité au barème evenement (1 crédit).
- Coût
- 0 crédit par appel réussi
- Accès
- Avec l'abonnement Data
- Portée
- webhooks
- Outil MCP
- webhooks_creer
- Bac à sable
- Non
- Cache serveur
- Jamais mis en cache
- Délai maximal
- 4 s
Paramètres
urltexteobligatoireURL https publique qui recevra les livraisons.
500 caractères au plus
genresliste de textesobligatoireLes genres suivis.
Valeurs :
nouvelle,analyse,reanalyse,baisse_prix,hausse_prix,retrait,reactivation,multi_agences,tache.terminee,tache.echouee,veille.resultat,alerte.resultat1 éléments au moins ; 10 éléments au plus
filtresobjetFiltres des évènements d'annonces ; tous facultatifs, combinés en ET.
Afficher les 6 champsMasquer
inseeliste de textesCodes INSEE (50 au plus).
50 éléments au plus
cpliste de textesCodes postaux (50 au plus).
50 éléments au plus
departementliste de textesDépartements (20 au plus).
20 éléments au plus
type_bienliste de textesTypes de bien du catalogue.
Valeurs :
apartment,house,immeuble3 éléments au plus
prix_minentier0 au moins
prix_maxentier0 au moins
Exemple d'appel
curl -X POST https://pillr.fr/api/v1/webhooks \
-H "Authorization: Bearer $PILLR_CLE" \
-H "Content-Type: application/json" \
-d '{"url":"https://votre-serveur.exemple.fr/webhooks/pillr","genres":["nouvelle","baisse_prix"],"filtres":{"insee":["76540"]}}'Réponse
webhookobjetAfficher les 10 champsMasquer
idtexteurltextegenresliste de textesfiltresobjetFiltres des évènements d'annonces ; tous facultatifs, combinés en ET.
Afficher les 6 champsMasquer
inseeliste de textesfacultatifCodes INSEE (50 au plus).
50 éléments au plus
cpliste de textesfacultatifCodes postaux (50 au plus).
50 éléments au plus
departementliste de textesfacultatifDépartements (20 au plus).
20 éléments au plus
type_bienliste de textesfacultatifTypes de bien du catalogue.
Valeurs :
apartment,house,immeuble3 éléments au plus
prix_minentierfacultatif0 au moins
prix_maxentierfacultatif0 au moins
actifbooléenechecs_consecutifsentiercoupe_letexte ou nullDate de la coupure automatique, après trop d'échecs consécutifs.
motif_coupuretexte ou nullcree_letextedernieres_livraisonsliste d'objetsLes dernières livraisons, les plus récentes d'abord.
Afficher les 5 champsMasquer
letextegenretextestatuttexteValeurs :
a_livrer,en_cours,livree,echec,epuiseetentativesentierreponseentier ou nullDernier code HTTP reçu de votre serveur.
secrettexteSecret de signature de cet abonnement, affiché cette seule fois : gardez-le pour vérifier l'en-tête Pillr-Signature.
signaturetexteComment vérifier une livraison, en clair.
creditsobjetCré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
debitesentier0 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
- 403palier_insuffisantL'accès de l'organisation n'atteint pas celui que l'opération exige
- 403hors_bac_a_sableUne clé pk_test_ l'appelle : l'opération n'a pas de bac à sable
Afficher les 11 erreurs communes à toute l'APIMasquer les erreurs communes
- 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
- 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. Guide des erreurs
Abonnements webhook de l'organisation
Essayer en direct/api/v1/webhooksLes abonnements webhook de l'organisation, sans leur secret, avec leur état (actif ou coupé, échecs consécutifs) et leurs dernières livraisons.
- Coût
- 0 crédit par appel réussi
- Accès
- Avec l'abonnement Data
- Portée
- webhooks
- Outil MCP
- webhooks
- Bac à sable
- Non
- Cache serveur
- Jamais mis en cache
- Délai maximal
- 4 s
Paramètres
Aucun.
Exemple d'appel
curl https://pillr.fr/api/v1/webhooks \
-H "Authorization: Bearer $PILLR_CLE"Réponse
webhooksliste d'objetsAfficher les 10 champsMasquer
idtexteurltextegenresliste de textesfiltresobjetFiltres des évènements d'annonces ; tous facultatifs, combinés en ET.
Afficher les 6 champsMasquer
inseeliste de textesfacultatifCodes INSEE (50 au plus).
50 éléments au plus
cpliste de textesfacultatifCodes postaux (50 au plus).
50 éléments au plus
departementliste de textesfacultatifDépartements (20 au plus).
20 éléments au plus
type_bienliste de textesfacultatifTypes de bien du catalogue.
Valeurs :
apartment,house,immeuble3 éléments au plus
prix_minentierfacultatif0 au moins
prix_maxentierfacultatif0 au moins
actifbooléenechecs_consecutifsentiercoupe_letexte ou nullDate de la coupure automatique, après trop d'échecs consécutifs.
motif_coupuretexte ou nullcree_letextedernieres_livraisonsliste d'objetsLes dernières livraisons, les plus récentes d'abord.
Afficher les 5 champsMasquer
letextegenretextestatuttexteValeurs :
a_livrer,en_cours,livree,echec,epuiseetentativesentierreponseentier ou nullDernier code HTTP reçu de votre serveur.
maxentierAbonnements permis par le plan de l'organisation.
creditsobjetCré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
debitesentier0 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
- 403palier_insuffisantL'accès de l'organisation n'atteint pas celui que l'opération exige
- 403hors_bac_a_sableUne clé pk_test_ l'appelle : l'opération n'a pas de bac à sable
Afficher les 11 erreurs communes à toute l'APIMasquer les erreurs communes
- 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
- 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. Guide des erreurs
Supprimer un abonnement webhook
Essayer en direct/api/v1/webhooks/{id}Supprime un abonnement webhook de l'organisation et ses livraisons en attente.
- Coût
- 0 crédit par appel réussi
- Accès
- Avec l'abonnement Data
- Portée
- webhooks
- Outil MCP
- webhooks_supprimer
- Bac à sable
- Non
- Cache serveur
- Jamais mis en cache
- Délai maximal
- 4 s
Paramètres
idtexteobligatoireIdentifiant de l'abonnement.
format uuid
Exemple d'appel
curl -X DELETE https://pillr.fr/api/v1/webhooks/00000000-0000-4000-8000-000000000001 \
-H "Authorization: Bearer $PILLR_CLE"Réponse
idtextesupprimebooléencreditsobjetCré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
debitesentier0 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
- 403palier_insuffisantL'accès de l'organisation n'atteint pas celui que l'opération exige
- 403hors_bac_a_sableUne clé pk_test_ l'appelle : l'opération n'a pas de bac à sable
Afficher les 11 erreurs communes à toute l'APIMasquer les erreurs communes
- 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
- 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. Guide des erreurs
Tester un abonnement webhook
Essayer en direct/api/v1/webhooks/{id}/testEnvoie tout de suite à l'URL de l'abonnement une livraison d'essai signée (genre test), sans reprise, et rend le code HTTP reçu. Un essai réussi réactive un abonnement coupé.
- Coût
- 0 crédit par appel réussi
- Accès
- Avec l'abonnement Data
- Portée
- webhooks
- Outil MCP
- webhooks_tester
- Bac à sable
- Non
- Cache serveur
- Jamais mis en cache
- Délai maximal
- 15 s
Paramètres
idtexteobligatoireIdentifiant de l'abonnement.
format uuid
Exemple d'appel
curl -X POST https://pillr.fr/api/v1/webhooks/00000000-0000-4000-8000-000000000001/test \
-H "Authorization: Bearer $PILLR_CLE" \
-H "Content-Type: application/json" \
-d '{}'Réponse
idtextereussibooléenVrai si votre serveur a répondu par un code 2xx.
statut_httpentier ou nullCode HTTP reçu ; null si votre serveur n'a pas répondu.
duree_msentiererreurtexte ou nullPourquoi la livraison n'a pas abouti ; null si elle a abouti.
reactivebooléenVrai si l'abonnement était coupé et a été réactivé par ce test réussi.
creditsobjetCré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
debitesentier0 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
- 403palier_insuffisantL'accès de l'organisation n'atteint pas celui que l'opération exige
- 403hors_bac_a_sableUne clé pk_test_ l'appelle : l'opération n'a pas de bac à sable
Afficher les 11 erreurs communes à toute l'APIMasquer les erreurs communes
- 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
- 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. Guide des erreurs
Créer un agent de veille
Essayer en direct/api/v1/veillesCrée un agent de veille sur les annonces, rattaché au compte de la clé : à partir d'une mission en langage naturel, traduite en pré-filtre par un modèle de langage, ou de critères exacts (recherche), sans modèle. L'agent remonte chaque jour les nouvelles annonces qui collent, jugées contre la mission par le juge IA ; ses résultats se lisent par resultats_veilles. Le compte garde un plafond d'agents actifs. Un agent créé par l'API est rattaché à l'organisation de la clé et débité, tant qu'il est actif, de 1 crédit par jour (barème veille_jour).
- Coût
- 20 crédits par appel réussi ; 0 crédit par appel réussi avec des critères exacts (recherche)
- Accès
- À l'usage ou avec l'abonnement Data
- Portée
- flux
- Outil MCP
- veilles_creer
- Bac à sable
- Non
- Cache serveur
- Jamais mis en cache
- Délai maximal
- 30 s
Paramètres
missiontexteCe que l'agent surveille, en une phrase.
de 3 à 500 caractères
rechercheobjetCritères exacts, sans interprétation par un modèle.
Afficher les 22 champsMasquer
communesliste de textesNoms ou codes INSEE de communes. Le moteur des veilles suit les communes par leur nom : un code INSEE est enregistré sous le nom officiel de sa commune (75056, 69123 et 13055 sous Paris, Lyon et Marseille, arrondissements compris). Un code d'arrondissement se remplace par le code postal (cp).
60 éléments au plus
cpliste de textes60 éléments au plus
departementliste de textes20 éléments au plus
autourobjetUn cercle autour d'un point ; il remplace les communes.
Afficher les 3 champsMasquer
latnombreobligatoirede -90 à 90
lonnombreobligatoirede -180 à 180
rayon_kmnombreobligatoirede 0,5 à 100
typetexteValeurs :
appartement,maison,immeubleprix_minnombre0 au moins
prix_maxnombre0 au moins
surface_minnombre0 au moins
surface_maxnombre0 au moins
pieces_minentierde 0 à 50
pieces_maxentierde 0 à 50
prix_m2_minnombre0 au moins
prix_m2_maxnombre0 au moins
terrain_minnombre0 au moins
terrain_maxnombre0 au moins
travaux_minnombre0 au moins
travaux_maxnombre0 au moins
rendement_minnombreRendement brut minimal, en %.
de 0 à 100
rendement_net_minnombrede 0 à 100
score_minnombrede 0 à 100
dpe_maxtextePire DPE accepté.
Valeurs :
A,B,C,D,E,F,Gexclure_residences_gereesbooléen
nomtextede 1 à 120 caractères
frequencetexteimmediate, daily (défaut) ou weekly : cadence des notifications du compte.
Valeurs :
immediate,daily,weeklysignauxobjetLes signaux suivis par l'agent.
Afficher les 3 champsMasquer
nouvellesbooléenNouvelles annonces qui correspondent (vrai par défaut).
baissesbooléenBaisses de prix des annonces qui correspondent (faux par défaut).
negociationbooléenAnnonces dont la décote par rapport à la cible de négociation est forte (faux par défaut).
actifbooléenFaux : l'agent est créé en pause (vrai par défaut).
Exemple d'appel
curl -X POST https://pillr.fr/api/v1/veilles \
-H "Authorization: Bearer $PILLR_CLE" \
-H "Content-Type: application/json" \
-d '{"nom":"Appartements sous 150 000 € à Rouen","recherche":{"communes":["76540"],"type":"appartement","prix_max":150000},"frequence":"weekly"}'Réponse
veilleobjetAfficher les 9 champsMasquer
idtextenomtexte ou nullmissiontexte ou nullIntention en langage naturel, lue chaque jour par le juge IA.
actifbooléenfrequencetexte ou nullcriteresliste de textesLes critères enregistrés, en clair, relus sur la ligne enregistrée.
dernier_jugement_iatexte ou nullbiens_7jentierBiens remontés par l'agent sur les 7 derniers jours.
cree_letexte ou null
non_reprisliste de textesCe que le moteur des veilles ne filtre pas et que seul le juge IA lit dans la mission.
vivierentier ou nullAnnonces analysées qui collent déjà au pré-filtre ; null s'il n'a pas pu être compté.
creditsobjetCré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
debitesentier0 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
- 403hors_bac_a_sableUne clé pk_test_ l'appelle : l'opération n'a pas de bac à sable
Afficher les 11 erreurs communes à toute l'APIMasquer les erreurs communes
- 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
- 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. Guide des erreurs
Agents de veille du compte
Essayer en direct/api/v1/veillesLes agents de veille du compte de la clé, actifs d'abord : mission, critères enregistrés, date du dernier jugement IA et biens remontés sur 7 jours.
- Coût
- 0 crédit par appel réussi
- Accès
- À l'usage ou avec l'abonnement Data
- Portée
- flux
- Outil MCP
- veilles
- Bac à sable
- Non
- Cache serveur
- Jamais mis en cache
- Délai maximal
- 4 s
Paramètres
Aucun.
Exemple d'appel
curl https://pillr.fr/api/v1/veilles \
-H "Authorization: Bearer $PILLR_CLE"Réponse
veillesliste d'objetsAfficher les 9 champsMasquer
idtextenomtexte ou nullmissiontexte ou nullIntention en langage naturel, lue chaque jour par le juge IA.
actifbooléenfrequencetexte ou nullcriteresliste de textesLes critères enregistrés, en clair, relus sur la ligne enregistrée.
dernier_jugement_iatexte ou nullbiens_7jentierBiens remontés par l'agent sur les 7 derniers jours.
cree_letexte ou null
activesentiermax_activesentierAgents actifs permis au compte.
creditsobjetCré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
debitesentier0 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
- 403hors_bac_a_sableUne clé pk_test_ l'appelle : l'opération n'a pas de bac à sable
Afficher les 11 erreurs communes à toute l'APIMasquer les erreurs communes
- 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
- 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. Guide des erreurs
Modifier un agent de veille
Essayer en direct/api/v1/veilles/{id}Met un agent de veille en pause ou le réactive, le renomme, change sa mission ou sa fréquence. Une réactivation respecte le plafond d'agents actifs du compte. Le même appel répété laisse le même état.
- Coût
- 0 crédit par appel réussi
- Accès
- À l'usage ou avec l'abonnement Data
- Portée
- flux
- Outil MCP
- veilles_modifier
- Bac à sable
- Non
- Cache serveur
- Jamais mis en cache
- Délai maximal
- 6 s
Paramètres
idtexteobligatoireIdentifiant de l'agent.
format uuid
actifbooléennomtextede 1 à 120 caractères
missiontextede 3 à 500 caractères
frequencetexteValeurs :
immediate,daily,weekly
Exemple d'appel
curl -X PATCH https://pillr.fr/api/v1/veilles/00000000-0000-4000-8000-000000000001 \
-H "Authorization: Bearer $PILLR_CLE" \
-H "Content-Type: application/json" \
-d '{"actif":true}'Réponse
veilleobjetAfficher les 9 champsMasquer
idtextenomtexte ou nullmissiontexte ou nullIntention en langage naturel, lue chaque jour par le juge IA.
actifbooléenfrequencetexte ou nullcriteresliste de textesLes critères enregistrés, en clair, relus sur la ligne enregistrée.
dernier_jugement_iatexte ou nullbiens_7jentierBiens remontés par l'agent sur les 7 derniers jours.
cree_letexte ou null
creditsobjetCré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
debitesentier0 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
- 403hors_bac_a_sableUne clé pk_test_ l'appelle : l'opération n'a pas de bac à sable
Afficher les 11 erreurs communes à toute l'APIMasquer les erreurs communes
- 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
- 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. Guide des erreurs
Créer un suivi de zone
Essayer en direct/api/v1/alertes/zonesCré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 probabilité de mise en vente 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
- Cache serveur
- Jamais mis en cache
- Délai maximal
- 10 s
Paramètres
communetexteNom de la commune suivie.
de 1 à 80 caractères
inseetexteCode INSEE de la commune ou de l'arrondissement (5 caractères, 2A ou 2B pour la Corse).
cptexteCode postal.
autourobjetUn disque autour d'un point : le seul moyen d'enregistrer un rayon.
Afficher les 3 champsMasquer
latnombreobligatoirede -90 à 90
lonnombreobligatoirede -180 à 180
rayon_kmnombreRayon en km (borné par le moteur des alertes).
plus de 0
type_bientexteValeurs :
maison,appartement,tousnomtextede 1 à 120 caractères
communesliste de textesPlusieurs communes, noms ou codes INSEE : une alerte chacune.
1 éléments au moins ; 40 éléments au plus
intercommunalitetexteNom ou SIREN d'une intercommunalité : une alerte par commune membre.
de 2 à 120 caractères
pre_marchebooléenseuil_priorite_pctentierSeuil de probabilité du volet pré-marché, en %.
de 5 à 90
particuliersbooléenjours_minentierAncienneté à partir de laquelle une annonce de particulier stagne, en jours.
de 15 à 180
marchebooléenbaissesbooléenmulti_mandatbooléenfrequencetexteValeurs :
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 '{"insee":"76540","frequence":"hebdomadaire"}'Réponse
alertesliste d'objetsLes alertes créées : une par commune pour une liste de communes ou une intercommunalité.
Afficher les 12 champsMasquer
idtexteformuletexteValeurs :
suivi_de_zone,pre_marche_seulnomtexte ou nullsecteurtexte ou nullLe secteur en une ligne (« Gex · tous biens »).
voletsliste de textesCe que l'alerte surveille, en clair, une phrase par volet actif.
seuil_priorite_pctnombre ou nulljours_minnombre ou nullfrequencetexte ou nullactivebooléenpar_courrielbooléenVrai si les résultats partent aussi dans le courriel du matin du compte.
dernier_passagetexte ou nullcree_letexte ou null
perimetre_enregistreobjetCe que la ou les alertes surveillent réellement, relu sur ce qui a été enregistré.
Afficher les 5 champsMasquer
communesliste d'objetsAfficher les 2 champsMasquer
communetexte ou nullinseetexte ou null
code_postaltexte ou nullrayonobjet ou nullAfficher les 3 champsMasquer
latnombrelonnombrerayon_kmnombre
type_bientextephrasetexteLe périmètre enregistré, en clair.
deja_suiviesliste de textesCommunes déjà suivies par une alerte active, non recréées.
introuvablesliste de textesnon_creeesliste d'objetsAfficher les 2 champsMasquer
communetexteraisontexte
doublon_possibletexte ou nullNom d'une alerte active qui couvre déjà ce secteur ; null sinon.
creditsobjetCré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
debitesentier0 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
- 403hors_bac_a_sableUne clé pk_test_ l'appelle : l'opération n'a pas de bac à sable
Afficher les 11 erreurs communes à toute l'APIMasquer les erreurs communes
- 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
- 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. Guide des erreurs
Créer une veille pré-marché
Essayer en direct/api/v1/alertes/pre-marcheCré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 probabilité de mise en vente 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
- Cache serveur
- Jamais mis en cache
- Délai maximal
- 8 s
Paramètres
communetexteNom de la commune suivie.
de 1 à 80 caractères
inseetexteCode INSEE de la commune ou de l'arrondissement (5 caractères, 2A ou 2B pour la Corse).
cptexteCode postal.
autourobjetUn disque autour d'un point : le seul moyen d'enregistrer un rayon.
Afficher les 3 champsMasquer
latnombreobligatoirede -90 à 90
lonnombreobligatoirede -180 à 180
rayon_kmnombreRayon en km (borné par le moteur des alertes).
plus de 0
type_bientexteValeurs :
maison,appartement,tousnomtextede 1 à 120 caractères
seuil_priorite_pctentierSeuil de probabilité, 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 '{"insee":"76540"}'Réponse
alertesliste d'objetsLes alertes créées : une par commune pour une liste de communes ou une intercommunalité.
Afficher les 12 champsMasquer
idtexteformuletexteValeurs :
suivi_de_zone,pre_marche_seulnomtexte ou nullsecteurtexte ou nullLe secteur en une ligne (« Gex · tous biens »).
voletsliste de textesCe que l'alerte surveille, en clair, une phrase par volet actif.
seuil_priorite_pctnombre ou nulljours_minnombre ou nullfrequencetexte ou nullactivebooléenpar_courrielbooléenVrai si les résultats partent aussi dans le courriel du matin du compte.
dernier_passagetexte ou nullcree_letexte ou null
perimetre_enregistreobjetCe que la ou les alertes surveillent réellement, relu sur ce qui a été enregistré.
Afficher les 5 champsMasquer
communesliste d'objetsAfficher les 2 champsMasquer
communetexte ou nullinseetexte ou null
code_postaltexte ou nullrayonobjet ou nullAfficher les 3 champsMasquer
latnombrelonnombrerayon_kmnombre
type_bientextephrasetexteLe périmètre enregistré, en clair.
deja_suiviesliste de textesCommunes déjà suivies par une alerte active, non recréées.
introuvablesliste de textesnon_creeesliste d'objetsAfficher les 2 champsMasquer
communetexteraisontexte
doublon_possibletexte ou nullNom d'une alerte active qui couvre déjà ce secteur ; null sinon.
creditsobjetCré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
debitesentier0 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
- 403hors_bac_a_sableUne clé pk_test_ l'appelle : l'opération n'a pas de bac à sable
Afficher les 11 erreurs communes à toute l'APIMasquer les erreurs communes
- 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
- 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. Guide des erreurs
Alertes du compte
Essayer en direct/api/v1/alertesLes 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
- Cache serveur
- Jamais mis en cache
- Délai maximal
- 4 s
Paramètres
Aucun.
Exemple d'appel
curl https://pillr.fr/api/v1/alertes \
-H "Authorization: Bearer $PILLR_CLE"Réponse
alertesliste d'objetsAfficher les 12 champsMasquer
idtexteformuletexteValeurs :
suivi_de_zone,pre_marche_seulnomtexte ou nullsecteurtexte ou nullLe secteur en une ligne (« Gex · tous biens »).
voletsliste de textesCe que l'alerte surveille, en clair, une phrase par volet actif.
seuil_priorite_pctnombre ou nulljours_minnombre ou nullfrequencetexte ou nullactivebooléenpar_courrielbooléenVrai si les résultats partent aussi dans le courriel du matin du compte.
dernier_passagetexte ou nullcree_letexte ou null
actives_zoneentiermax_zoneentieractives_pre_marcheentiermax_pre_marcheentiercreditsobjetCré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
debitesentier0 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
- 403hors_bac_a_sableUne clé pk_test_ l'appelle : l'opération n'a pas de bac à sable
Afficher les 11 erreurs communes à toute l'APIMasquer les erreurs communes
- 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
- 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. Guide des erreurs
Supprimer une alerte
Essayer en direct/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
- Cache serveur
- Jamais mis en cache
- Délai maximal
- 4 s
Paramètres
idtexteobligatoireIdentifiant de l'alerte.
format uuid
Exemple d'appel
curl -X DELETE https://pillr.fr/api/v1/alertes/00000000-0000-4000-8000-000000000001 \
-H "Authorization: Bearer $PILLR_CLE"Réponse
idtexteformuletexteValeurs :
suivi_de_zone,pre_marche_seulsupprimeebooléencreditsobjetCré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
debitesentier0 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
- 403hors_bac_a_sableUne clé pk_test_ l'appelle : l'opération n'a pas de bac à sable
Afficher les 11 erreurs communes à toute l'APIMasquer les erreurs communes
- 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
- 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. Guide des erreurs
Résultats des veilles et des alertes
Essayer en direct/api/v1/resultats/api/v1/veilles/{veille}/resultats/api/v1/alertes/{alerte}/resultatsCe que les veilles et les alertes du compte de la clé ont remonté, du plus ancien au plus récent : pour un agent de veille, les annonces retenues avec le signal et la raison du juge IA ; pour un suivi de zone, les signaux par volet avec leur clé, leur score et leur instantané ; pour une veille pré-marché, les adresses avec leur probabilité de mise en vente. Chaque résultat dit s'il est déjà parti dans une notification du compte. Un crédit par résultat rendu, sauf un résultat déjà livré et débité par un abonnement webhook.
- Coût
- 1 crédit par évènement livré
- Accès
- À l'usage ou avec l'abonnement Data
- Portée
- flux
- Outil MCP
- resultats_veilles
- Bac à sable
- Non
- Cache serveur
- Jamais mis en cache
- Délai maximal
- 5 s
Paramètres de /api/v1/resultats
depuistexteNe lire que les résultats remontés depuis cette date.
40 caractères au plus
genretexteValeurs :
annonce,signal_zone,adresse_pre_marchevolettexteVolet d'un suivi de zone.
Valeurs :
pre_marche,particuliers,marchenon_notifiesvaleurVrai : seulement les résultats pas encore notifiés.
limiteentierNombre d'éléments par page (50 au plus).
de 1 à 50 ; par défaut 20
curseurtexteCurseur opaque rendu par la page précédente (curseur_suivant), à repasser tel quel.
de 1 à 1 024 caractères
Paramètres de /api/v1/veilles/{veille}/resultats
veilletexteobligatoireIdentifiant d'un agent de veille.
format uuid
Paramètres de /api/v1/alertes/{alerte}/resultats
alertetexteobligatoireIdentifiant d'un suivi de zone ou d'une veille pré-marché.
format uuid
Exemple d'appel
curl https://pillr.fr/api/v1/resultats \
-H "Authorization: Bearer $PILLR_CLE"Réponse
resultatsliste d'objetsLes résultats, du plus ancien au plus récent.
Afficher les 16 champsMasquer
idtextealerte_idtexteIdentifiant de la veille ou de l'alerte qui a remonté ce résultat.
genretexteannonce (agent de veille), signal_zone (suivi de zone) ou adresse_pre_marche (veille pré-marché).
Valeurs :
annonce,signal_zone,adresse_pre_marcheannonce_idtexte ou nullcle_bantexte ou nullvolettexte ou nullVolet d'un suivi de zone : pre_marche, particuliers ou marche.
signaltexte ou nullLe signal : new, price_drop, nego, multi_agency, ai (veilles) ; pre_marche, stagne, baisse_pap, republie, baisse, multi_mandat (zones).
detailobjet ou nullLe contexte du signal (ancien et nouveau prix, décote, raison du juge IA).
scorenombre ou nullOrdre d'affichage dans le volet d'un suivi de zone.
prioritenombre ou nullLa probabilité de mise en vente à 12 mois d'une adresse du pré-marché, le même chiffre que p_mise_en_vente_6m, gardé pour compatibilité.
p_mise_en_vente_6mnombre ou nullAncien nom de la probabilité de mise en vente à 12 mois d'une adresse du pré-marché, gardé pour compatibilité : même chiffre, ce n'est pas une probabilité à 6 mois.
instantaneobjet ou nullL'annonce ou l'adresse telle qu'elle était au moment du signal.
letexteDate du résultat.
notifiebooléenVrai si ce résultat est déjà parti dans une notification du compte.
livre_par_webhookbooléenVrai si ce résultat a déjà été livré et débité par un abonnement webhook : il n'est pas débité de nouveau.
qualiteobjetCe qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
Afficher les 7 champsMasquer
nentier ou nullNombre d'observations derrière la valeur ; null si sans objet.
0 au moins
provenancetexte ou nullmesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
Valeurs :
mesure,estimeincertitudeobjet ou nullIncertitude de la valeur : fourchette et demi-largeur.
Afficher les 3 champsMasquer
demi_largeur_pctnombre ou nullDemi-largeur de la fourchette, en % de la valeur.
basnombre ou nullhautnombre ou null
drapeauxliste de textesCe 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_anciennemethodetexte ou nullMéthode de calcul ou de rattachement, en clair.
donnees_dutexte ou nullDate de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
sourcetexteSource publique ou moteur Pillr, en clair.
curseur_suivanttexte ou nullCurseur de la page suivante, à repasser dans curseur ; null sur la dernière page.
creditsobjetCré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
debitesentier0 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
- 403hors_bac_a_sableUne clé pk_test_ l'appelle : l'opération n'a pas de bac à sable
Afficher les 11 erreurs communes à toute l'APIMasquer les erreurs communes
- 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
- 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. Guide des erreurs