Flux d'évènements
8 opérations servies.
Flux d'évènements des annonces
/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
- Mémoire
- 0 min
- Délai
- 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
- 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
- 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
- 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.
Flux de nouveautés à l'adresse
/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
- Mémoire
- 1 min
- Délai
- 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
- 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
- 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
- 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 agent de veille
/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
- Mémoire
- Jamais gardée
- Délai
- 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 de communes (le moteur des veilles suit les communes par leur nom).
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 '{}'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
- 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.
Agents de veille du compte
/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
- Mémoire
- Jamais gardée
- Délai
- 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
- 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.
Modifier un agent de veille
/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
- Mémoire
- Jamais gardée
- Délai
- 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 POST https://pillr.fr/api/v1/veilles/{id} \
-H "Authorization: Bearer $PILLR_CLE" \
-H "Content-Type: application/json" \
-d '{}'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
- 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.
Résultats des veilles et des alertes
/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 priorité et leur probabilité. 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
- Mémoire
- Jamais gardée
- Délai
- 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 nullPriorité d'une adresse du pré-marché (probabilité de mise en vente multipliée par la fenêtre de mandat).
p_mise_en_vente_6mnombre ou nullProbabilité de mise en vente sous 6 mois d'une adresse du pré-marché.
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
- 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.
Notifications du compte
/api/v1/compte/notificationsLes signaux détectés chaque matin sur ce que suit l'utilisateur de la clé : baisse de prix d'un favori (price_drop), annonce sur-cotée en ligne depuis plus de soixante jours sans baisse (nego_opportunity), valorisation possible après des travaux raisonnables (post_works_profit), prix en baisse dans une commune suivie (zone_trend). Les plus récentes d'abord, les écartées exclues sauf demande. Le scan ne tourne que pour les comptes qui ont un profil investisseur.
- Coût
- 1 crédit par évènement livré
- Accès
- À l'usage ou avec l'abonnement Data
- Portée
- flux
- Outil MCP
- notifications
- Bac à sable
- Non
- Mémoire
- Jamais gardée
- Délai
- 3 s
Paramètres
depuistexteLes notifications créées à partir de cette date.
typesvaleurTypes à rendre (paramètre répétable).
non_luesvaleurVrai : les non lues seulement.
ecarteesvaleurVrai : inclut les notifications écartées.
limiteentierNombre d'éléments par page (50 au plus).
de 1 à 50 ; par défaut 30
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/compte/notifications \
-H "Authorization: Bearer $PILLR_CLE"Réponse
notificationsliste d'objetsAfficher les 10 champsMasquer
idtexteformat uuid
typetexteprice_drop, nego_opportunity, post_works_profit ou zone_trend.
annonce_idtexte ou nullIdentifiant Pillr de l'annonce concernée.
importancetextebasse, moyenne ou haute.
titretextemessagetextechargeobjetLe détail du signal, tel que le scan l'a écrit.
cree_letexte ou nullHorodatage ISO 8601.
lue_letexte ou nullHorodatage ISO 8601.
ecartee_letexte ou nullHorodatage ISO 8601.
non_luesentierNotifications non lues et non écartées du compte.
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
- 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.
Marquer une notification
/api/v1/compte/notifications/{id}Marque une notification du compte comme lue ou non lue, écartée ou non. Le même appel deux fois 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
- notifications_modifier
- Bac à sable
- Non
- Mémoire
- Jamais gardée
- Délai
- 3 s
Paramètres
idtexteobligatoireIdentifiant de la notification.
format uuid
luebooléenecarteebooléen
Exemple d'appel
curl -X POST https://pillr.fr/api/v1/compte/notifications/{id} \
-H "Authorization: Bearer $PILLR_CLE" \
-H "Content-Type: application/json" \
-d '{}'Réponse
notificationobjetAfficher les 10 champsMasquer
idtexteformat uuid
typetexteprice_drop, nego_opportunity, post_works_profit ou zone_trend.
annonce_idtexte ou nullIdentifiant Pillr de l'annonce concernée.
importancetextebasse, moyenne ou haute.
titretextemessagetextechargeobjetLe détail du signal, tel que le scan l'a écrit.
cree_letexte ou nullHorodatage ISO 8601.
lue_letexte ou nullHorodatage ISO 8601.
ecartee_letexte ou nullHorodatage ISO 8601.
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
- 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.