Aller au contenu

Documentation

Compte et personnalisation

8 opérations servies.

Enregistrer l'adresse validée d'une annonce

POST/api/v1/annonces/{id}/adresse-validee

Enregistre l'adresse que l'utilisateur de la clé a confirmée pour une annonce, dans le cache partagé des localisations de Pillr : une adresse par annonce, la dernière validation remplace la précédente. Elle est ensuite rendue par adresse_annonce et par localiser_annonce (etape disque), et le Hub la lit aussi. Exige une clé rattachée à un compte Pillr.

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

Essayer en direct

Paramètres

  • idtexteobligatoire

    Identifiant de l'annonce : lbc:<numéro>, bienici:<identifiant>, seloger:<numéro> ou identifiant Pillr.

    de 3 à 200 caractères

  • libelletexteobligatoire

    L'adresse confirmée, en clair.

    de 5 à 300 caractères

  • latnombre

    de -90 à 90

  • lonnombre

    de -180 à 180

  • precisiontexte

    Précision de l'adresse confirmée.

    Valeurs : numero, rue, lieu_dit, commune

  • confiancetexte

    Ce qui fonde la validation (Street View, DPE...).

    120 caractères au plus

Exemple d'appel

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

Réponse

  • enregistrebooléen
  • idtexte

    Identifiant Pillr de l'annonce.

  • libelletexte
  • notetexte
  • 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

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

Mémoire du compte

GET/api/v1/compte/memoire

Les faits durables retenus sur l'utilisateur de la clé (TMI, apport, stratégie, secteurs, métier), que le Hub et question_hub reprennent dans leur contexte, les plus récents d'abord, avec la TMI et l'apport rangés dans le profil.

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

Essayer en direct

Paramètres

Aucun.

Exemple d'appel

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

Réponse

  • faitsliste d'objets

    Les faits retenus, les plus récents d'abord.

    Afficher les 2 champs
    • faittexte
    • datetexte
  • totalentier
  • plafondentier
  • tmi_pctnombre ou null
  • apport_eurnombre 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

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

Ajouter des faits à la mémoire

POST/api/v1/compte/memoire

Ajoute des faits durables à la mémoire du compte, avec les règles du Hub : dédoublonnage, plafond (le plus ancien sort), refus des données sensibles, d'un contact ou de la donnée d'un tiers nommé, avec leur motif. Une TMI ou un apport reconnus renseignent aussi le profil investisseur.

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

Essayer en direct

Paramètres

  • faitsliste de textesobligatoire

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

Exemple d'appel

curl -X POST https://pillr.fr/api/v1/compte/memoire \
  -H "Authorization: Bearer $PILLR_CLE" \
  -H "Content-Type: application/json" \
  -d '{"faits":["<faits>"]}'

Réponse

  • faitsliste d'objets

    Les faits retenus, les plus récents d'abord.

    Afficher les 2 champs
    • faittexte
    • datetexte
  • totalentier
  • plafondentier
  • tmi_pctnombre ou null
  • apport_eurnombre ou null
  • retenusliste de textes
  • deja_connuliste de textes
  • refusliste d'objets
    Afficher les 2 champs
    • faittexte
    • motiftexte
  • oubliesliste de textes

    Faits sortis parce que le plafond était atteint.

  • 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

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

Profil investisseur du compte

GET/api/v1/compte/profil

La thèse d'investissement de l'utilisateur de la clé, que le Hub, les briefs, les notifications et les recommandations réutilisent : stratégie, budgets et apport, zones, critères, objectifs, TMI, profil professionnel et préférences de notification.

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

Essayer en direct

Paramètres

Aucun.

Exemple d'appel

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

Réponse

  • existebooléen

    Faux tant que le compte n'a pas de profil investisseur ; les autres champs valent alors null.

  • strategietexte ou null

    cashflow, patrimoine, mixte ou lcd (courte durée).

  • budget_totalnombre ou null
  • budget_par_biennombre ou null
  • apport_pctnombre ou null
  • apport_eurnombre ou null
  • regionsliste de textes
  • villesliste de textes
  • departementsliste de textes
  • partoutbooléen ou null

    Vrai : ouvert à toute la France.

  • typesliste de textes

    appartement, maison.

  • surface_minnombre ou null
  • surface_maxnombre ou null
  • pieces_minnombre ou null
  • dpe_maxtexte ou null
  • tolerance_travauxtexte ou null

    aucun, legers, moderes ou lourds.

  • rendement_minnombre ou null
  • score_minnombre ou null
  • objectifsobjet
    Afficher les 3 champs
    • nb_biensnombre ou null
    • horizon_ansnombre ou null
    • revenu_mensuelnombre ou null
  • tmi_pctnombre ou null
  • profil_proobjet ou null

    Profil professionnel déclaré : métier, réseau, secteurs travaillés.

    Afficher les 3 champs
    • metiertexte ou null
    • reseautexte ou null
    • secteursliste de textes
  • notificationsobjet
    Afficher les 7 champs
    • par_courrier_electroniquebooléen ou null
    • tableau_de_bordbooléen ou null
    • baissesbooléen ou null
    • negociationbooléen ou null
    • comparablesbooléen ou null
    • apres_travauxbooléen ou null
    • tendances_zonebooléen ou null
  • cree_letexte ou null

    Horodatage ISO 8601.

  • maj_letexte ou null

    Horodatage ISO 8601.

  • 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

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

Modifier le profil investisseur

POST/api/v1/compte/profil

Crée ou met à jour le profil investisseur de l'utilisateur de la clé, champ par champ : seuls les champs fournis changent, mêmes bornes que le formulaire du site. Rend le profil à jour.

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

Essayer en direct

Paramètres

  • strategietexte

    Valeurs : cashflow, patrimoine, mixte, lcd

  • budget_totalentier ou null

    de 0 à 100 000 000

  • budget_par_bienentier ou null

    de 0 à 100 000 000

  • apport_pctentier

    de 0 à 100

  • apport_eurentier ou null

    de 0 à 100 000 000

  • regionsliste de textes

    50 éléments au plus

  • villesliste de textes

    50 éléments au plus

  • departementsliste de textes

    50 éléments au plus

  • partoutbooléen
  • typesliste de textes

    Valeurs : appartement, maison

    2 éléments au plus

  • surface_minentier ou null

    de 0 à 10 000

  • surface_maxentier ou null

    de 0 à 10 000

  • pieces_minentier ou null

    de 0 à 50

  • dpe_maxtexte ou null

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

  • tolerance_travauxtexte

    Valeurs : aucun, legers, moderes, lourds

  • rendement_minnombre ou null

    de 0 à 99

  • score_minentier ou null

    de 0 à 100

  • objectifsobjet
    Afficher les 3 champs
    • nb_biensentier ou null

      de 0 à 1 000

    • horizon_ansentier ou null

      de 0 à 100

    • revenu_mensuelentier ou null

      de 0 à 1 000 000

  • tmi_pctentier ou null
  • profil_proobjet ou null
    Afficher les 3 champs
    • metiertexte ou null

      80 caractères au plus

    • reseautexte ou null

      80 caractères au plus

    • secteursliste de textes

      20 éléments au plus

  • notificationsobjet
    Afficher les 7 champs
    • par_courrier_electroniquebooléen
    • tableau_de_bordbooléen
    • baissesbooléen
    • negociationbooléen
    • comparablesbooléen
    • apres_travauxbooléen
    • tendances_zonebooléen

Exemple d'appel

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

Réponse

  • existebooléen

    Faux tant que le compte n'a pas de profil investisseur ; les autres champs valent alors null.

  • strategietexte ou null

    cashflow, patrimoine, mixte ou lcd (courte durée).

  • budget_totalnombre ou null
  • budget_par_biennombre ou null
  • apport_pctnombre ou null
  • apport_eurnombre ou null
  • regionsliste de textes
  • villesliste de textes
  • departementsliste de textes
  • partoutbooléen ou null

    Vrai : ouvert à toute la France.

  • typesliste de textes

    appartement, maison.

  • surface_minnombre ou null
  • surface_maxnombre ou null
  • pieces_minnombre ou null
  • dpe_maxtexte ou null
  • tolerance_travauxtexte ou null

    aucun, legers, moderes ou lourds.

  • rendement_minnombre ou null
  • score_minnombre ou null
  • objectifsobjet
    Afficher les 3 champs
    • nb_biensnombre ou null
    • horizon_ansnombre ou null
    • revenu_mensuelnombre ou null
  • tmi_pctnombre ou null
  • profil_proobjet ou null

    Profil professionnel déclaré : métier, réseau, secteurs travaillés.

    Afficher les 3 champs
    • metiertexte ou null
    • reseautexte ou null
    • secteursliste de textes
  • notificationsobjet
    Afficher les 7 champs
    • par_courrier_electroniquebooléen ou null
    • tableau_de_bordbooléen ou null
    • baissesbooléen ou null
    • negociationbooléen ou null
    • comparablesbooléen ou null
    • apres_travauxbooléen ou null
    • tendances_zonebooléen ou null
  • cree_letexte ou null

    Horodatage ISO 8601.

  • maj_letexte ou null

    Horodatage ISO 8601.

  • 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

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

Favoris du compte

GET/api/v1/compte/favoris

Les biens suivis par l'utilisateur de la clé, les plus récents d'abord : le bien et son analyse à la date de l'ajout, complétés par l'annonce telle qu'elle est aujourd'hui (prix actuel, DPE, en ligne ou non).

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

Essayer en direct

Paramètres

Aucun.

Exemple d'appel

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

Réponse

  • favorisliste d'objets
    Afficher les 7 champs
    • idtexte

      format uuid

    • annonce_idtexte ou null

      Identifiant de l'annonce (lbc:<n>, bienici:<id>, seloger:<id>, ou identifiant Pillr), null si elle n'est plus au catalogue.

    • lientexte ou null

      Lien d'origine de l'annonce, servi quand la clé porte la portée lien_origine.

    • bienobjet

      Le bien à la date de l'ajout, complété par l'annonce telle qu'elle est aujourd'hui.

      Afficher les 11 champs
      • titretexte ou null
      • prix_ajoutnombre ou null

        Prix au moment de l'ajout, en euros.

      • prix_actuelnombre ou null

        Prix affiché aujourd'hui, null si l'annonce n'est plus au catalogue.

      • surfacenombre ou null
      • piecesnombre ou null
      • villetexte ou null
      • code_postaltexte ou null
      • dpetexte ou null

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

      • actifbooléen ou null

        Vrai si l'annonce est encore en ligne ; null si elle n'est plus au catalogue.

      • photosliste de textes
      • type_vendeurtexte

        Valeurs : pro, particulier, inconnu

    • analyseobjet

      L'analyse gardée à la date de l'ajout.

      Afficher les 4 champs
      • scorenombre ou null
      • profiltexte ou null
      • loyer_mensuelnombre ou null
      • rendement_brutnombre ou null
    • analysis_idtexte ou null
    • ajoute_letexte ou null

      Horodatage ISO 8601.

  • 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

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

Ajouter un favori

POST/api/v1/compte/favoris

Met une annonce du catalogue en favori, par son identifiant ou son lien : le bien et son analyse du jour sont gardés comme sur le site. Ajouter deux fois la même annonce rend le favori existant.

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

Essayer en direct

Paramètres

  • annoncetexte

    Identifiant de l'annonce : lbc:<numéro>, bienici:<identifiant>, seloger:<numéro> ou identifiant Pillr.

    de 3 à 200 caractères

  • urltexte

    Lien de l'annonce sur son portail.

    500 caractères au plus ; adresse web

Exemple d'appel

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

Réponse

  • favoriobjet
    Afficher les 7 champs
    • idtexte

      format uuid

    • annonce_idtexte ou null

      Identifiant de l'annonce (lbc:<n>, bienici:<id>, seloger:<id>, ou identifiant Pillr), null si elle n'est plus au catalogue.

    • lientexte ou null

      Lien d'origine de l'annonce, servi quand la clé porte la portée lien_origine.

    • bienobjet

      Le bien à la date de l'ajout, complété par l'annonce telle qu'elle est aujourd'hui.

      Afficher les 11 champs
      • titretexte ou null
      • prix_ajoutnombre ou null

        Prix au moment de l'ajout, en euros.

      • prix_actuelnombre ou null

        Prix affiché aujourd'hui, null si l'annonce n'est plus au catalogue.

      • surfacenombre ou null
      • piecesnombre ou null
      • villetexte ou null
      • code_postaltexte ou null
      • dpetexte ou null

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

      • actifbooléen ou null

        Vrai si l'annonce est encore en ligne ; null si elle n'est plus au catalogue.

      • photosliste de textes
      • type_vendeurtexte

        Valeurs : pro, particulier, inconnu

    • analyseobjet

      L'analyse gardée à la date de l'ajout.

      Afficher les 4 champs
      • scorenombre ou null
      • profiltexte ou null
      • loyer_mensuelnombre ou null
      • rendement_brutnombre ou null
    • analysis_idtexte ou null
    • ajoute_letexte ou null

      Horodatage ISO 8601.

  • deja_presentboolé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

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

Retirer un favori

POST/api/v1/compte/favoris/{id}/retrait

Retire un favori du compte. Retirer un favori absent ne change rien.

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

Essayer en direct

Paramètres

  • idtexteobligatoire

    Identifiant du favori.

    format uuid

Exemple d'appel

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

Réponse

  • idtexte

    format uuid

  • retireboolé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

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

    Compte et personnalisation : référence de l'API | Pillr Data