---
title: "Ajouter un favori"
method: POST
path: "/compte/favoris"
---

# Ajouter un favori

`POST /compte/favoris`

## Request

- Base URL: `https://pillr.fr/api/v1`
- URL: `https://pillr.fr/api/v1/compte/favoris`
- Auth: HTTP bearer

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. Exige une clé rattachée à un compte Pillr. Coût : 0 crédit par appel réussi.

## Request body

- object
  - `annonce` string: Identifiant de l'annonce : lbc:<numéro>, bienici:<identifiant>, seloger:<numéro> ou identifiant Pillr.
  - `url` string, uri: Lien de l'annonce sur son portail.

## Response `200`

Écriture faite et débitée selon le barème.

- object
  - `favori` object, required
    - `id` string, uuid, required
    - `annonce_id` string, nullable, required: Identifiant de l'annonce (lbc:<n>, bienici:<id>, seloger:<id>, ou identifiant Pillr), null si elle n'est plus au catalogue.
    - `lien` string, nullable, required: Lien d'origine de l'annonce, servi quand la clé porte la portée lien_origine.
    - `bien` object, required: Le bien à la date de l'ajout, complété par l'annonce telle qu'elle est aujourd'hui.
      - `titre` string, nullable, required
      - `prix_ajout` number, nullable, required: Prix au moment de l'ajout, en euros.
      - `prix_actuel` number, nullable, required: Prix affiché aujourd'hui, null si l'annonce n'est plus au catalogue.
      - `surface` number, nullable, required
      - `pieces` number, nullable, required
      - `ville` string, nullable, required
      - `code_postal` string, nullable, required
      - `dpe` 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G', nullable, required
      - `actif` boolean, nullable, required: Vrai si l'annonce est encore en ligne ; null si elle n'est plus au catalogue.
      - `photos` string[], required
      - `type_vendeur` 'pro' | 'particulier' | 'inconnu', required
    - `analyse` object, required: L'analyse gardée à la date de l'ajout.
      - `score` number, nullable, required
      - `profil` string, nullable, required
      - `loyer_mensuel` number, nullable, required
      - `rendement_brut` number, nullable, required
    - `analysis_id` string, nullable, required
    - `ajoute_le` string, nullable, required: Horodatage ISO 8601.
  - `deja_present` boolean, required
  - `credits` object, required: 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).
    - `debites` integer, required
    - `restants` integer, nullable, required

## Other responses

- `400`: Paramètres invalides
- `401`: Clé d'API absente
- `402`: Crédits insuffisants ; Carte requise ; Plafond mensuel de dépense atteint
- `403`: Portée insuffisante ; Clé sans compte rattaché
- `404`: Ressource absente : rien n'est débité
- `429`: Trop de requêtes par minute
- `500`: Erreur interne
- `503`: API indisponible ; Donnée momentanément indisponible

---

[API](https://skmtc.dev/pillr/apis/api-pillr.md) · [All operations](https://skmtc.dev/pillr/apis/api-pillr/llms.txt) · [OpenAPI document](https://skmtc.dev/pillr/apis/api-pillr/revisions/218b2866bd6c?raw)