Aller au contenu

Documentation

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
GET/api/v1/flux/annonces

Les é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

  • depuistexte

    Ne lire que les évènements écrits depuis cette date (AAAA-MM-JJ ou horodatage ISO 8601).

    40 caractères au plus

  • genresvaleur

    Genre, ou liste de genres (paramètre répété) ; tous si absent.

  • inseevaleur

    Code INSEE, ou liste de 20 codes au plus (paramètre répété).

  • cpvaleur

    Code postal, ou liste de 20 codes au plus.

  • departementvaleur

    Code de département, ou liste de 10 codes au plus.

  • limiteentier

    Nombre d'éléments par page (1000 au plus).

    de 1 à 1 000 ; par défaut 100

  • curseurtexte

    Curseur opaque rendu par la page précédente (curseur_suivant), à repasser tel quel.

    de 1 à 1 024 caractères

Exemple d'appel

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

Réponse

  • evenementsliste d'objets

    Les évènements, dans l'ordre du flux.

    Afficher les 7 champs
    • idtexte

      Identifiant de l'évènement, croissant dans l'ordre du flux.

    • genretexte

      nouvelle (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_agences

    • letexte

      Horodatage de l'évènement (ISO 8601).

    • annonce_idtexte

      Identifiant Pillr de l'annonce.

    • avantobjet ou null

      État de l'annonce avant ou après l'évènement.

      Afficher les 10 champs
      • prixnombre ou null

        Prix, en euros (baisse_prix, hausse_prix, nouvelle).

      • ecart_pctnombre ou null

        Écart du prix, en % (baisse_prix, hausse_prix).

      • detecte_letexte ou null

        Date de détection du changement de prix.

      • actifbooléen ou null

        Annonce en ligne (retrait, reactivation, nouvelle).

      • analyse_letexte ou null

        Date de l'analyse (analyse, reanalyse).

      • scorenombre ou null

        Score Pillr de l'analyse (analyse, reanalyse).

      • nb_agencesnombre ou null

        Agences qui publient le bien (multi_agences).

      • nb_portailsnombre ou null

        Portails qui publient le bien (multi_agences).

      • prix_minnombre ou null

        Prix le plus bas entre les annonces du bien (multi_agences).

      • prix_maxnombre ou null

        Prix 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 champs
      • prixnombre ou null

        Prix, en euros (baisse_prix, hausse_prix, nouvelle).

      • ecart_pctnombre ou null

        Écart du prix, en % (baisse_prix, hausse_prix).

      • detecte_letexte ou null

        Date de détection du changement de prix.

      • actifbooléen ou null

        Annonce en ligne (retrait, reactivation, nouvelle).

      • analyse_letexte ou null

        Date de l'analyse (analyse, reanalyse).

      • scorenombre ou null

        Score Pillr de l'analyse (analyse, reanalyse).

      • nb_agencesnombre ou null

        Agences qui publient le bien (multi_agences).

      • nb_portailsnombre ou null

        Portails qui publient le bien (multi_agences).

      • prix_minnombre ou null

        Prix le plus bas entre les annonces du bien (multi_agences).

      • prix_maxnombre ou null

        Prix le plus haut entre les annonces du bien (multi_agences).

    • annonceobjet ou null

      L'annonce au format liste ; null si elle n'est plus servie (doublon d'un autre portail, sortie du catalogue).

      Afficher les 26 champs
      • idtexte

        Identifiant Pillr de l'annonce (à repasser à /annonces/{id}).

      • id_portailtexte ou null

        Identifiant chez le portail, servi avec la portée lien_origine.

      • lientexte ou null

        Lien d'origine de l'annonce, servi avec la portée lien_origine.

      • sourcetexte ou null

        Portail d'origine : lbc, bienici ou seloger.

      • statuttexte ou null

        actif, retire ou masque.

      • typetexte ou null

        appartement, maison ou immeuble.

      • communetexte ou null
      • code_postaltexte ou null
      • inseetexte ou null
      • departementtexte ou null
      • latnombre ou null
      • lonnombre ou null
      • precision_coordonneestexte ou null

        adresse, approchee, centre_commune ou inconnue.

      • prixnombre ou null
      • surfacenombre ou null
      • piecesnombre ou null
      • prix_m2nombre ou null

        Prix divisé par la surface (jamais la valeur du portail).

      • dpetexte ou null

        Valeurs : A, B, C, D, E, F, G

      • scorenombre ou null

        Score Pillr sur 100 ; null tant que l'annonce n'est pas analysée.

      • rendement_brutnombre ou null

        Rendement brut en %, recalculé depuis le loyer estimé et le prix.

      • rendement_netnombre ou null

        Rendement net en %, recalculé sur le budget total.

      • etat_visuelnombre ou null

        État visuel lu sur les photos, sur 100.

      • premiere_parutiontexte ou null
      • type_vendeurtexte

        Statut du vendeur déclaré par le portail : pro (agence, réseau, promoteur), particulier, ou inconnu.

        Valeurs : pro, particulier, inconnu

      • annonceurobjet

        Le vendeur : un professionnel est nommé, un particulier jamais.

        Afficher les 4 champs
        • type_vendeurtexte

          Statut du vendeur déclaré par le portail : pro (agence, réseau, promoteur), particulier, ou inconnu.

          Valeurs : pro, particulier, inconnu

        • nomtexte ou null

          Nom de l'agence ou du professionnel ; null pour un particulier.

        • enseignetexte ou null

          Enseigne ou réseau du professionnel ; null pour un particulier.

        • sirentexte ou null

          SIREN du professionnel quand le portail le publie ; null pour un particulier.

      • drapeauxliste de textes

        Ce qui doit faire lire l'annonce avec prudence ; vide si rien.

        Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne

  • a_jourbooléen

    Vrai quand le flux n'a plus rien à lire pour l'instant : repassez curseur_suivant plus tard pour reprendre.

  • qualiteobjet

    Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.

    Afficher les 7 champs
    • nentier ou null

      Nombre d'observations derrière la valeur ; null si sans objet.

      0 au moins

    • provenancetexte ou null

      mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.

      Valeurs : mesure, estime

    • incertitudeobjet ou null

      Incertitude de la valeur : fourchette et demi-largeur.

      Afficher les 3 champs
      • demi_largeur_pctnombre ou null

        Demi-largeur de la fourchette, en % de la valeur.

      • basnombre ou null
      • hautnombre ou null
    • drapeauxliste de textes

      Ce qui doit faire lire la valeur avec prudence ; vide si rien.

      Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne

    • methodetexte ou null

      Méthode de calcul ou de rattachement, en clair.

    • donnees_dutexte ou null

      Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).

    • sourcetexte

      Source publique ou moteur Pillr, en clair.

  • curseur_suivanttexte ou null

    Curseur de la page suivante, à repasser dans curseur ; null sur la dernière page.

  • creditsobjet

    Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).

    Afficher les 2 champs
    • debitesentier

      0 au moins

    • restantsentier ou null

Erreurs possibles

  • 400parametres_invalidesUn paramètre manque ou ne passe pas son contrôle ; le détail est donné champ par champ
  • 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'API

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
GET/api/v1/flux/adresses

Les 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

  • depuistexte

    Ne lire que les évènements entrés au journal depuis cette date.

    40 caractères au plus

  • genresvaleur

    Genre, ou liste de genres ; tous si absent.

  • inseevaleur

    Code INSEE, ou liste de 20 codes au plus (paramètre répété).

  • cpvaleur

    Code postal, ou liste de 20 codes au plus.

  • limiteentier

    Nombre d'éléments par page (1000 au plus).

    de 1 à 1 000 ; par défaut 100

  • curseurtexte

    Curseur opaque rendu par la page précédente (curseur_suivant), à repasser tel quel.

    de 1 à 1 024 caractères

Exemple d'appel

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

Réponse

  • evenementsliste de valeurs

    Les évènements, dans l'ordre du journal.

  • a_jourbooléen

    Vrai quand le journal n'a plus rien à lire pour l'instant : repassez curseur_suivant plus tard pour reprendre.

  • qualiteobjet

    Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.

    Afficher les 7 champs
    • nentier ou null

      Nombre d'observations derrière la valeur ; null si sans objet.

      0 au moins

    • provenancetexte ou null

      mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.

      Valeurs : mesure, estime

    • incertitudeobjet ou null

      Incertitude de la valeur : fourchette et demi-largeur.

      Afficher les 3 champs
      • demi_largeur_pctnombre ou null

        Demi-largeur de la fourchette, en % de la valeur.

      • basnombre ou null
      • hautnombre ou null
    • drapeauxliste de textes

      Ce qui doit faire lire la valeur avec prudence ; vide si rien.

      Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne

    • methodetexte ou null

      Méthode de calcul ou de rattachement, en clair.

    • donnees_dutexte ou null

      Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).

    • sourcetexte

      Source publique ou moteur Pillr, en clair.

  • curseur_suivanttexte ou null

    Curseur de la page suivante, à repasser dans curseur ; null sur la dernière page.

  • creditsobjet

    Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).

    Afficher les 2 champs
    • debitesentier

      0 au moins

    • restantsentier ou null

Erreurs possibles

  • 400parametres_invalidesUn paramètre manque ou ne passe pas son contrôle ; le détail est donné champ par champ
  • 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'API

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
POST/api/v1/webhooks

Abonne 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

  • urltexteobligatoire

    URL https publique qui recevra les livraisons.

    500 caractères au plus

  • genresliste de textesobligatoire

    Les genres suivis.

    Valeurs : nouvelle, analyse, reanalyse, baisse_prix, hausse_prix, retrait, reactivation, multi_agences, tache.terminee, tache.echouee, veille.resultat, alerte.resultat

    1 éléments au moins ; 10 éléments au plus

  • filtresobjet

    Filtres des évènements d'annonces ; tous facultatifs, combinés en ET.

    Afficher les 6 champs
    • inseeliste de textes

      Codes INSEE (50 au plus).

      50 éléments au plus

    • cpliste de textes

      Codes postaux (50 au plus).

      50 éléments au plus

    • departementliste de textes

      Départements (20 au plus).

      20 éléments au plus

    • type_bienliste de textes

      Types de bien du catalogue.

      Valeurs : apartment, house, immeuble

      3 éléments au plus

    • prix_minentier

      0 au moins

    • prix_maxentier

      0 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

  • webhookobjet
    Afficher les 10 champs
    • idtexte
    • urltexte
    • genresliste de textes
    • filtresobjet

      Filtres des évènements d'annonces ; tous facultatifs, combinés en ET.

      Afficher les 6 champs
      • inseeliste de textesfacultatif

        Codes INSEE (50 au plus).

        50 éléments au plus

      • cpliste de textesfacultatif

        Codes postaux (50 au plus).

        50 éléments au plus

      • departementliste de textesfacultatif

        Départements (20 au plus).

        20 éléments au plus

      • type_bienliste de textesfacultatif

        Types de bien du catalogue.

        Valeurs : apartment, house, immeuble

        3 éléments au plus

      • prix_minentierfacultatif

        0 au moins

      • prix_maxentierfacultatif

        0 au moins

    • actifbooléen
    • echecs_consecutifsentier
    • coupe_letexte ou null

      Date de la coupure automatique, après trop d'échecs consécutifs.

    • motif_coupuretexte ou null
    • cree_letexte
    • dernieres_livraisonsliste d'objets

      Les dernières livraisons, les plus récentes d'abord.

      Afficher les 5 champs
      • letexte
      • genretexte
      • statuttexte

        Valeurs : a_livrer, en_cours, livree, echec, epuisee

      • tentativesentier
      • reponseentier ou null

        Dernier code HTTP reçu de votre serveur.

  • secrettexte

    Secret de signature de cet abonnement, affiché cette seule fois : gardez-le pour vérifier l'en-tête Pillr-Signature.

  • signaturetexte

    Comment vérifier une livraison, en clair.

  • creditsobjet

    Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).

    Afficher les 2 champs
    • debitesentier

      0 au moins

    • restantsentier ou null

Erreurs possibles

Afficher les 11 erreurs communes à toute l'API

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
GET/api/v1/webhooks

Les 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'objets
    Afficher les 10 champs
    • idtexte
    • urltexte
    • genresliste de textes
    • filtresobjet

      Filtres des évènements d'annonces ; tous facultatifs, combinés en ET.

      Afficher les 6 champs
      • inseeliste de textesfacultatif

        Codes INSEE (50 au plus).

        50 éléments au plus

      • cpliste de textesfacultatif

        Codes postaux (50 au plus).

        50 éléments au plus

      • departementliste de textesfacultatif

        Départements (20 au plus).

        20 éléments au plus

      • type_bienliste de textesfacultatif

        Types de bien du catalogue.

        Valeurs : apartment, house, immeuble

        3 éléments au plus

      • prix_minentierfacultatif

        0 au moins

      • prix_maxentierfacultatif

        0 au moins

    • actifbooléen
    • echecs_consecutifsentier
    • coupe_letexte ou null

      Date de la coupure automatique, après trop d'échecs consécutifs.

    • motif_coupuretexte ou null
    • cree_letexte
    • dernieres_livraisonsliste d'objets

      Les dernières livraisons, les plus récentes d'abord.

      Afficher les 5 champs
      • letexte
      • genretexte
      • statuttexte

        Valeurs : a_livrer, en_cours, livree, echec, epuisee

      • tentativesentier
      • reponseentier ou null

        Dernier code HTTP reçu de votre serveur.

  • maxentier

    Abonnements permis par le plan de l'organisation.

  • creditsobjet

    Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).

    Afficher les 2 champs
    • debitesentier

      0 au moins

    • restantsentier ou null

Erreurs possibles

  • 400parametres_invalidesUn paramètre manque ou ne passe pas son contrôle ; le détail est donné champ par champ
  • 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'API

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
DELETE/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

  • idtexteobligatoire

    Identifiant 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

  • idtexte
  • supprimebooléen
  • creditsobjet

    Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).

    Afficher les 2 champs
    • debitesentier

      0 au moins

    • restantsentier ou null

Erreurs possibles

  • 400parametres_invalidesUn paramètre manque ou ne passe pas son contrôle ; le détail est donné champ par champ
  • 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'API

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
POST/api/v1/webhooks/{id}/test

Envoie 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

  • idtexteobligatoire

    Identifiant 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

  • idtexte
  • reussibooléen

    Vrai si votre serveur a répondu par un code 2xx.

  • statut_httpentier ou null

    Code HTTP reçu ; null si votre serveur n'a pas répondu.

  • duree_msentier
  • erreurtexte ou null

    Pourquoi la livraison n'a pas abouti ; null si elle a abouti.

  • reactivebooléen

    Vrai si l'abonnement était coupé et a été réactivé par ce test réussi.

  • creditsobjet

    Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).

    Afficher les 2 champs
    • debitesentier

      0 au moins

    • restantsentier ou null

Erreurs possibles

Afficher les 11 erreurs communes à toute l'API

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
POST/api/v1/veilles

Cré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

  • missiontexte

    Ce que l'agent surveille, en une phrase.

    de 3 à 500 caractères

  • rechercheobjet

    Critères exacts, sans interprétation par un modèle.

    Afficher les 22 champs
    • communesliste de textes

      Noms 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 textes

      60 éléments au plus

    • departementliste de textes

      20 éléments au plus

    • autourobjet

      Un cercle autour d'un point ; il remplace les communes.

      Afficher les 3 champs
      • latnombreobligatoire

        de -90 à 90

      • lonnombreobligatoire

        de -180 à 180

      • rayon_kmnombreobligatoire

        de 0,5 à 100

    • typetexte

      Valeurs : appartement, maison, immeuble

    • prix_minnombre

      0 au moins

    • prix_maxnombre

      0 au moins

    • surface_minnombre

      0 au moins

    • surface_maxnombre

      0 au moins

    • pieces_minentier

      de 0 à 50

    • pieces_maxentier

      de 0 à 50

    • prix_m2_minnombre

      0 au moins

    • prix_m2_maxnombre

      0 au moins

    • terrain_minnombre

      0 au moins

    • terrain_maxnombre

      0 au moins

    • travaux_minnombre

      0 au moins

    • travaux_maxnombre

      0 au moins

    • rendement_minnombre

      Rendement brut minimal, en %.

      de 0 à 100

    • rendement_net_minnombre

      de 0 à 100

    • score_minnombre

      de 0 à 100

    • dpe_maxtexte

      Pire DPE accepté.

      Valeurs : A, B, C, D, E, F, G

    • exclure_residences_gereesbooléen
  • nomtexte

    de 1 à 120 caractères

  • frequencetexte

    immediate, daily (défaut) ou weekly : cadence des notifications du compte.

    Valeurs : immediate, daily, weekly

  • signauxobjet

    Les signaux suivis par l'agent.

    Afficher les 3 champs
    • nouvellesbooléen

      Nouvelles annonces qui correspondent (vrai par défaut).

    • baissesbooléen

      Baisses de prix des annonces qui correspondent (faux par défaut).

    • negociationbooléen

      Annonces dont la décote par rapport à la cible de négociation est forte (faux par défaut).

  • actifbooléen

    Faux : 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

  • veilleobjet
    Afficher les 9 champs
    • idtexte
    • nomtexte ou null
    • missiontexte ou null

      Intention en langage naturel, lue chaque jour par le juge IA.

    • actifbooléen
    • frequencetexte ou null
    • criteresliste de textes

      Les critères enregistrés, en clair, relus sur la ligne enregistrée.

    • dernier_jugement_iatexte ou null
    • biens_7jentier

      Biens remontés par l'agent sur les 7 derniers jours.

    • cree_letexte ou null
  • non_reprisliste de textes

    Ce que le moteur des veilles ne filtre pas et que seul le juge IA lit dans la mission.

  • vivierentier ou null

    Annonces analysées qui collent déjà au pré-filtre ; null s'il n'a pas pu être compté.

  • creditsobjet

    Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).

    Afficher les 2 champs
    • debitesentier

      0 au moins

    • restantsentier ou null

Erreurs possibles

Afficher les 11 erreurs communes à toute l'API

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
GET/api/v1/veilles

Les 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'objets
    Afficher les 9 champs
    • idtexte
    • nomtexte ou null
    • missiontexte ou null

      Intention en langage naturel, lue chaque jour par le juge IA.

    • actifbooléen
    • frequencetexte ou null
    • criteresliste de textes

      Les critères enregistrés, en clair, relus sur la ligne enregistrée.

    • dernier_jugement_iatexte ou null
    • biens_7jentier

      Biens remontés par l'agent sur les 7 derniers jours.

    • cree_letexte ou null
  • activesentier
  • max_activesentier

    Agents actifs permis au compte.

  • creditsobjet

    Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).

    Afficher les 2 champs
    • debitesentier

      0 au moins

    • restantsentier ou null

Erreurs possibles

  • 400parametres_invalidesUn paramètre manque ou ne passe pas son contrôle ; le détail est donné champ par champ
  • 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'API

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
PATCH/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

  • idtexteobligatoire

    Identifiant de l'agent.

    format uuid

  • actifbooléen
  • nomtexte

    de 1 à 120 caractères

  • missiontexte

    de 3 à 500 caractères

  • frequencetexte

    Valeurs : 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

  • veilleobjet
    Afficher les 9 champs
    • idtexte
    • nomtexte ou null
    • missiontexte ou null

      Intention en langage naturel, lue chaque jour par le juge IA.

    • actifbooléen
    • frequencetexte ou null
    • criteresliste de textes

      Les critères enregistrés, en clair, relus sur la ligne enregistrée.

    • dernier_jugement_iatexte ou null
    • biens_7jentier

      Biens remontés par l'agent sur les 7 derniers jours.

    • cree_letexte ou null
  • creditsobjet

    Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).

    Afficher les 2 champs
    • debitesentier

      0 au moins

    • restantsentier ou null

Erreurs possibles

Afficher les 11 erreurs communes à toute l'API

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
POST/api/v1/alertes/zones

Crée un suivi de zone rattaché au compte de la clé : une commune, un code INSEE, un code postal, un disque autour d'un point, une liste de communes ou une intercommunalité (une alerte par commune). Trois volets, actifs par défaut : le pré-marché (adresses dont la 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

  • communetexte

    Nom de la commune suivie.

    de 1 à 80 caractères

  • inseetexte

    Code INSEE de la commune ou de l'arrondissement (5 caractères, 2A ou 2B pour la Corse).

  • cptexte

    Code postal.

  • autourobjet

    Un disque autour d'un point : le seul moyen d'enregistrer un rayon.

    Afficher les 3 champs
    • latnombreobligatoire

      de -90 à 90

    • lonnombreobligatoire

      de -180 à 180

    • rayon_kmnombre

      Rayon en km (borné par le moteur des alertes).

      plus de 0

  • type_bientexte

    Valeurs : maison, appartement, tous

  • nomtexte

    de 1 à 120 caractères

  • communesliste de textes

    Plusieurs communes, noms ou codes INSEE : une alerte chacune.

    1 éléments au moins ; 40 éléments au plus

  • intercommunalitetexte

    Nom ou SIREN d'une intercommunalité : une alerte par commune membre.

    de 2 à 120 caractères

  • pre_marchebooléen
  • seuil_priorite_pctentier

    Seuil de probabilité du volet pré-marché, en %.

    de 5 à 90

  • particuliersbooléen
  • jours_minentier

    Ancienneté à partir de laquelle une annonce de particulier stagne, en jours.

    de 15 à 180

  • marchebooléen
  • baissesbooléen
  • multi_mandatbooléen
  • frequencetexte

    Valeurs : quotidien, hebdomadaire

Exemple d'appel

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

Réponse

  • alertesliste d'objets

    Les alertes créées : une par commune pour une liste de communes ou une intercommunalité.

    Afficher les 12 champs
    • idtexte
    • formuletexte

      Valeurs : suivi_de_zone, pre_marche_seul

    • nomtexte ou null
    • secteurtexte ou null

      Le secteur en une ligne (« Gex · tous biens »).

    • voletsliste de textes

      Ce que l'alerte surveille, en clair, une phrase par volet actif.

    • seuil_priorite_pctnombre ou null
    • jours_minnombre ou null
    • frequencetexte ou null
    • activebooléen
    • par_courrielbooléen

      Vrai si les résultats partent aussi dans le courriel du matin du compte.

    • dernier_passagetexte ou null
    • cree_letexte ou null
  • perimetre_enregistreobjet

    Ce que la ou les alertes surveillent réellement, relu sur ce qui a été enregistré.

    Afficher les 5 champs
    • communesliste d'objets
      Afficher les 2 champs
      • communetexte ou null
      • inseetexte ou null
    • code_postaltexte ou null
    • rayonobjet ou null
      Afficher les 3 champs
      • latnombre
      • lonnombre
      • rayon_kmnombre
    • type_bientexte
    • phrasetexte

      Le périmètre enregistré, en clair.

  • deja_suiviesliste de textes

    Communes déjà suivies par une alerte active, non recréées.

  • introuvablesliste de textes
  • non_creeesliste d'objets
    Afficher les 2 champs
    • communetexte
    • raisontexte
  • doublon_possibletexte ou null

    Nom d'une alerte active qui couvre déjà ce secteur ; null sinon.

  • creditsobjet

    Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).

    Afficher les 2 champs
    • debitesentier

      0 au moins

    • restantsentier ou null

Erreurs possibles

Afficher les 11 erreurs communes à toute l'API

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
POST/api/v1/alertes/pre-marche

Crée une veille pré-marché rattachée au compte de la clé, sur un secteur (commune, code INSEE, code postal ou disque autour d'un point) : chaque nuit, les nouvelles adresses dont la 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

  • communetexte

    Nom de la commune suivie.

    de 1 à 80 caractères

  • inseetexte

    Code INSEE de la commune ou de l'arrondissement (5 caractères, 2A ou 2B pour la Corse).

  • cptexte

    Code postal.

  • autourobjet

    Un disque autour d'un point : le seul moyen d'enregistrer un rayon.

    Afficher les 3 champs
    • latnombreobligatoire

      de -90 à 90

    • lonnombreobligatoire

      de -180 à 180

    • rayon_kmnombre

      Rayon en km (borné par le moteur des alertes).

      plus de 0

  • type_bientexte

    Valeurs : maison, appartement, tous

  • nomtexte

    de 1 à 120 caractères

  • seuil_priorite_pctentier

    Seuil de 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'objets

    Les alertes créées : une par commune pour une liste de communes ou une intercommunalité.

    Afficher les 12 champs
    • idtexte
    • formuletexte

      Valeurs : suivi_de_zone, pre_marche_seul

    • nomtexte ou null
    • secteurtexte ou null

      Le secteur en une ligne (« Gex · tous biens »).

    • voletsliste de textes

      Ce que l'alerte surveille, en clair, une phrase par volet actif.

    • seuil_priorite_pctnombre ou null
    • jours_minnombre ou null
    • frequencetexte ou null
    • activebooléen
    • par_courrielbooléen

      Vrai si les résultats partent aussi dans le courriel du matin du compte.

    • dernier_passagetexte ou null
    • cree_letexte ou null
  • perimetre_enregistreobjet

    Ce que la ou les alertes surveillent réellement, relu sur ce qui a été enregistré.

    Afficher les 5 champs
    • communesliste d'objets
      Afficher les 2 champs
      • communetexte ou null
      • inseetexte ou null
    • code_postaltexte ou null
    • rayonobjet ou null
      Afficher les 3 champs
      • latnombre
      • lonnombre
      • rayon_kmnombre
    • type_bientexte
    • phrasetexte

      Le périmètre enregistré, en clair.

  • deja_suiviesliste de textes

    Communes déjà suivies par une alerte active, non recréées.

  • introuvablesliste de textes
  • non_creeesliste d'objets
    Afficher les 2 champs
    • communetexte
    • raisontexte
  • doublon_possibletexte ou null

    Nom d'une alerte active qui couvre déjà ce secteur ; null sinon.

  • creditsobjet

    Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).

    Afficher les 2 champs
    • debitesentier

      0 au moins

    • restantsentier ou null

Erreurs possibles

Afficher les 11 erreurs communes à toute l'API

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
GET/api/v1/alertes

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

Coût
0 crédit par appel réussi
Accès
À l'usage ou avec l'abonnement Data
Portée
pre_marche
Outil MCP
alertes
Bac à sable
Non
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'objets
    Afficher les 12 champs
    • idtexte
    • formuletexte

      Valeurs : suivi_de_zone, pre_marche_seul

    • nomtexte ou null
    • secteurtexte ou null

      Le secteur en une ligne (« Gex · tous biens »).

    • voletsliste de textes

      Ce que l'alerte surveille, en clair, une phrase par volet actif.

    • seuil_priorite_pctnombre ou null
    • jours_minnombre ou null
    • frequencetexte ou null
    • activebooléen
    • par_courrielbooléen

      Vrai si les résultats partent aussi dans le courriel du matin du compte.

    • dernier_passagetexte ou null
    • cree_letexte ou null
  • actives_zoneentier
  • max_zoneentier
  • actives_pre_marcheentier
  • max_pre_marcheentier
  • creditsobjet

    Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).

    Afficher les 2 champs
    • debitesentier

      0 au moins

    • restantsentier ou null

Erreurs possibles

  • 400parametres_invalidesUn paramètre manque ou ne passe pas son contrôle ; le détail est donné champ par champ
  • 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'API

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
DELETE/api/v1/alertes/{id}

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

Coût
0 crédit par appel réussi
Accès
À l'usage ou avec l'abonnement Data
Portée
pre_marche
Outil MCP
alertes_supprimer
Bac à sable
Non
Cache serveur
Jamais mis en cache
Délai maximal
4 s

Paramètres

  • idtexteobligatoire

    Identifiant 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

  • idtexte
  • formuletexte

    Valeurs : suivi_de_zone, pre_marche_seul

  • supprimeebooléen
  • creditsobjet

    Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).

    Afficher les 2 champs
    • debitesentier

      0 au moins

    • restantsentier ou null

Erreurs possibles

  • 400parametres_invalidesUn paramètre manque ou ne passe pas son contrôle ; le détail est donné champ par champ
  • 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'API

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
GET/api/v1/resultats
GET/api/v1/veilles/{veille}/resultats
GET/api/v1/alertes/{alerte}/resultats

Ce 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

  • depuistexte

    Ne lire que les résultats remontés depuis cette date.

    40 caractères au plus

  • genretexte

    Valeurs : annonce, signal_zone, adresse_pre_marche

  • volettexte

    Volet d'un suivi de zone.

    Valeurs : pre_marche, particuliers, marche

  • non_notifiesvaleur

    Vrai : seulement les résultats pas encore notifiés.

  • limiteentier

    Nombre d'éléments par page (50 au plus).

    de 1 à 50 ; par défaut 20

  • curseurtexte

    Curseur opaque rendu par la page précédente (curseur_suivant), à repasser tel quel.

    de 1 à 1 024 caractères

Paramètres de /api/v1/veilles/{veille}/resultats

  • veilletexteobligatoire

    Identifiant d'un agent de veille.

    format uuid

Paramètres de /api/v1/alertes/{alerte}/resultats

  • alertetexteobligatoire

    Identifiant 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'objets

    Les résultats, du plus ancien au plus récent.

    Afficher les 16 champs
    • idtexte
    • alerte_idtexte

      Identifiant de la veille ou de l'alerte qui a remonté ce résultat.

    • genretexte

      annonce (agent de veille), signal_zone (suivi de zone) ou adresse_pre_marche (veille pré-marché).

      Valeurs : annonce, signal_zone, adresse_pre_marche

    • annonce_idtexte ou null
    • cle_bantexte ou null
    • volettexte ou null

      Volet d'un suivi de zone : pre_marche, particuliers ou marche.

    • signaltexte ou null

      Le signal : new, price_drop, nego, multi_agency, ai (veilles) ; pre_marche, stagne, baisse_pap, republie, baisse, multi_mandat (zones).

    • detailobjet ou null

      Le contexte du signal (ancien et nouveau prix, décote, raison du juge IA).

    • scorenombre ou null

      Ordre d'affichage dans le volet d'un suivi de zone.

    • prioritenombre ou null

      La 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 null

      Ancien 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 null

      L'annonce ou l'adresse telle qu'elle était au moment du signal.

    • letexte

      Date du résultat.

    • notifiebooléen

      Vrai si ce résultat est déjà parti dans une notification du compte.

    • livre_par_webhookbooléen

      Vrai si ce résultat a déjà été livré et débité par un abonnement webhook : il n'est pas débité de nouveau.

    • qualiteobjet

      Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.

      Afficher les 7 champs
      • nentier ou null

        Nombre d'observations derrière la valeur ; null si sans objet.

        0 au moins

      • provenancetexte ou null

        mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.

        Valeurs : mesure, estime

      • incertitudeobjet ou null

        Incertitude de la valeur : fourchette et demi-largeur.

        Afficher les 3 champs
        • demi_largeur_pctnombre ou null

          Demi-largeur de la fourchette, en % de la valeur.

        • basnombre ou null
        • hautnombre ou null
      • drapeauxliste de textes

        Ce qui doit faire lire la valeur avec prudence ; vide si rien.

        Valeurs : prix_atypique, surface_atypique, vente_en_bloc, doublon_probable, date_estimee, peu_d_observations, valeur_imputee, rattachement_incertain, donnee_ancienne

      • methodetexte ou null

        Méthode de calcul ou de rattachement, en clair.

      • donnees_dutexte ou null

        Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).

      • sourcetexte

        Source publique ou moteur Pillr, en clair.

  • curseur_suivanttexte ou null

    Curseur de la page suivante, à repasser dans curseur ; null sur la dernière page.

  • creditsobjet

    Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).

    Afficher les 2 champs
    • debitesentier

      0 au moins

    • restantsentier ou null

Erreurs possibles

  • 400parametres_invalidesUn paramètre manque ou ne passe pas son contrôle ; le détail est donné champ par champ
  • 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'API

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

    Veille, évènements et webhooks : référence de l'API | Pillr Data