---
title: "Audit d'une liste de biens face au marché"
method: POST
path: "/portefeuilles/audit"
---

# Audit d'une liste de biens face au marché

`POST /portefeuilles/audit`

## Request

- Base URL: `https://pillr.fr/api/v1`
- URL: `https://pillr.fr/api/v1/portefeuilles/audit`
- Auth: HTTP bearer

Audite une liste d'annonces suivies, ou les favoris du compte de la clé : prix au m² du bien contre celui du secteur (même type de bien), baisse depuis l'ajout, échéance de la loi Climat, loyer estimé contre loyer de marché, score et rendement, avec des alertes d'arbitrage. Mêmes calculs que l'outil d'audit du Hub. Un crédit par bien audité. Coût : 1 crédit par élément rendu.

## Request body

- object
  - `biens` object[]
    - `id` string, required: Identifiant de l'annonce : lbc:<numéro>, bienici:<identifiant>, seloger:<numéro> ou identifiant Pillr.
    - `prix_ajout` number: Prix au moment où le bien a été suivi, en euros.
    - `ajoute_le` string
  - `favoris` true: Vrai : audite les favoris du compte de la clé (clé personnelle).

## Response `200`

Réponse servie et débitée (sauf réponse identique déjà servie dans les 24 h).

- object
  - `nb_biens` integer, required
  - `biens` object[], required
    - `id` string, required: Identifiant demandé (lbc:<n>...) ou identifiant de l'annonce du favori.
    - `annonce_id` string, nullable, required
    - `titre` string, nullable, required
    - `ville` string, nullable, required
    - `code_postal` string, nullable, required
    - `surface` number, nullable, required
    - `dpe` 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G', nullable, required
    - `score` number, nullable, required
    - `prix` number, nullable, required
    - `prix_ajout` number, nullable, required
    - `prix_m2_bien` number, nullable, required
    - `prix_m2_marche` number, nullable, required
    - `ecart_prix_pct` number, nullable, required
    - `rendement_brut_pct` number, nullable, required
    - `loyer_estime` number, nullable, required
    - `loyer_marche_estime` number, nullable, required
    - `actif` boolean, nullable, required
    - `alertes` object[], required
      - `code` string, required
      - `texte` string, required
    - `type_vendeur` 'pro' | 'particulier' | 'inconnu', required
    - `qualite` object, required: Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
      - `n` integer, nullable, required: Nombre d'observations derrière la valeur ; null si sans objet.
      - `provenance` 'mesure' | 'estime', nullable, required: mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
      - `incertitude` object, nullable, required: Incertitude de la valeur : fourchette et demi-largeur.
        - `demi_largeur_pct` number, nullable, required: Demi-largeur de la fourchette, en % de la valeur.
        - `bas` number, nullable, required
        - `haut` number, nullable, required
      - `drapeaux` string[], required: Ce qui doit faire lire la valeur avec prudence ; vide si rien.
      - `methode` string, nullable, required: Méthode de calcul ou de rattachement, en clair.
      - `donnees_du` string, nullable, required: Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
      - `source` string, required: Source publique ou moteur Pillr, en clair.
  - `non_trouves` string[], required: Identifiants absents du catalogue : non audités, non débités.
  - `hors_perimetre` string[], required: Identifiants hors du périmètre du contrat de la clé : non audités, non débités.
  - `tronque` boolean, required: Vrai si le compte a plus de favoris que l'audit n'en lit.
  - `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
- `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)
