---
title: "Synthèse complète d'une commune"
method: GET
path: "/communes/{insee}/synthese"
---

# Synthèse complète d'une commune

`GET /communes/{insee}/synthese`

## Request

- Base URL: `https://pillr.fr/api/v1`
- URL: `https://pillr.fr/api/v1/communes/{insee}/synthese`
- Auth: HTTP bearer

Une commune en un appel, avec les chiffres de l'outil de zone du Hub : marché (prix et provenance, rendements, demande, vacance, loyer, évolutions, passoires, transactions), démographie, moyennes des annonces analysées par Pillr dans la commune, score Pillr et ses huit sous-scores, marchabilité et équipements à 500 m, loyer prédit avec son intervalle à 95 %, loyers par typologie et loyer d'un logement donné (typologie, surface), mesures de zone (équipements, gare et aéroport, délinquance, risques), signal de prix, QPV et zone ABC, ratios d'accessibilité, courte durée, points forts et signaux d'alerte de l'analyse rédigée, marché en vente du dernier mois. Paris, Lyon et Marseille se lisent par arrondissement. Coût : 3 crédits par appel réussi.

## Path parameters

- `insee` string, required: Code INSEE de la commune ou de l'arrondissement (5 caractères, 2A ou 2B pour la Corse).

## Query parameters

- `typologie` 'T1' | 'T2' | 'T3' | 'T4' | 'T5' | 'maison': Typologie du logement dont estimer le loyer (T1 à T5 ou maison).
- `surface_m2` number: Surface du logement dont estimer le loyer, en m².

## Response `200`

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

- object
  - `insee` string, required: Code INSEE demandé.
  - `commune` string, nullable, required: Nom de la commune ou de l'arrondissement.
  - `code_postal` string, nullable, required
  - `departement` string, nullable, required
  - `region` string, nullable, required
  - `marche` object, required
    - `prix_m2_appartement` number, nullable, required
    - `prix_m2_maison` number, nullable, required
    - `provenance_appartement` 'mesure' | 'estime', nullable, required: mesure : mesuré sur les ventes DVF de la commune ; estime : estimé par le barème sur trop peu de ventes pour une mesure, à lire avec le nombre de ventes ; null : non étiquetée.
    - `provenance_maison` 'mesure' | 'estime', nullable, required: mesure : mesuré sur les ventes DVF de la commune ; estime : estimé par le barème sur trop peu de ventes pour une mesure, à lire avec le nombre de ventes ; null : non étiquetée.
    - `ventes_appartement` integer, nullable, required
    - `ventes_maison` integer, nullable, required
    - `rendement_brut_appartement_pct` number, nullable, required
    - `rendement_brut_maison_pct` number, nullable, required
    - `score_demande` number, nullable, required
    - `vacance_locative_pct` number, nullable, required
    - `loyer_m2` number, nullable, required
    - `evolution_prix_1_an_pct` number, nullable, required
    - `evolution_prix_3_ans_pct` number, nullable, required
    - `evolution_prix_5_ans_pct` number, nullable, required
    - `confiance_evolution` string, nullable, required
    - `passoires_dpe_fg_pct` number, nullable, required
    - `transactions_recentes` integer, nullable, 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.
  - `demographie` object, required
    - `population` integer, nullable, required
    - `salaire_median` number, nullable, required
    - `taux_chomage_pct` number, nullable, required
    - `part_hlm_pct` number, nullable, required
    - `profil_socio` string, nullable, required
  - `catalogue_pillr` object, required
    - `annonces_analysees` integer, required
    - `score_moyen` number, nullable, required
    - `rendement_brut_moyen_pct` number, nullable, 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.
  - `score_pillr` number, nullable, required
  - `scores_detail` object, required
    - `rentabilite` number, nullable, required
    - `demande` number, nullable, required
    - `liquidite` number, nullable, required
    - `croissance` number, nullable, required
    - `stabilite` number, nullable, required
    - `qualite` number, nullable, required
    - `services` number, nullable, required
    - `securite` number, nullable, required
  - `qualite_lieu` object, required
    - `walkability` number, nullable, required
    - `qualite_vie` number, nullable, required
  - `poi_500m` object, required
    - `total` number, nullable, required
    - `transports` number, nullable, required
    - `ecoles` number, nullable, required
    - `commerces` number, nullable, required
    - `sante` number, nullable, required
    - `loisirs` number, nullable, required
    - `restauration` number, nullable, required
  - `loyer_predit` object, required
    - `loyer_m2_mensuel` number, nullable, required
    - `ic95_min` number, nullable, required
    - `ic95_max` number, nullable, required
    - `source` string, nullable, 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.
  - `loyers_par_typologie` object[], required
    - `typologie` 'T1' | 'T2' | 'T3' | 'T4' | 'T5' | 'maison', required
    - `surface_m2` number, required
    - `segment` 'appartement' | 'appartement_t1_t2' | 'appartement_t3plus' | 'maison', required
    - `repli` boolean, required
    - `loyer_m2` number, required
    - `loyer_mensuel` number, required
    - `fourchette_mensuelle` object, nullable, required
      - `min` number, required
      - `max` number, required
  - `loyers_millesime` string, nullable, required
  - `loyer_estime` object, nullable, required: Loyer d'un logement donné (typologie, surface) ; null sans l'une ni l'autre.
    - `typologie` 'T1' | 'T2' | 'T3' | 'T4' | 'T5' | 'maison', required
    - `surface_m2` number, nullable, required
    - `estimation` object, nullable, required
      - `typologie` 'T1' | 'T2' | 'T3' | 'T4' | 'T5' | 'maison', required
      - `surface_m2` number, required
      - `segment` 'appartement' | 'appartement_t1_t2' | 'appartement_t3plus' | 'maison', required
      - `repli` boolean, required
      - `loyer_m2` number, required
      - `loyer_mensuel` number, required
      - `fourchette_mensuelle` object, nullable, required
        - `min` number, required
        - `max` number, required
    - `indisponible` string, nullable, required: Pourquoi aucun loyer n'est estimé (maison sans loyer publié, surface invalide).
  - `mesures_zone` object, required
    - `equipements` object, nullable, required
      - `comptes` object, required
      - `essentiels_absents` string[], required
      - `resume` string, required
    - `acces` string, nullable, required
    - `securite` string, nullable, required
    - `risques` string, required
  - `signal_prix` object, required
    - `signal_deal` string, nullable, required
    - `prix_residuel_pct` number, nullable, required
    - `prix_attendu_m2` number, nullable, required
    - `volatilite_prix` number, nullable, required
  - `contraintes` object, required
    - `est_en_qpv` boolean, nullable, required
    - `nb_qpv` integer, nullable, required
    - `zone_abc` string, nullable, required
  - `accessibilite_prix` object, required
    - `ratio_loyer_revenu` number, nullable, required
    - `prix_revenu_annees` number, nullable, required
  - `courte_duree` object, required
    - `revenu_lcd_annuel_eur` number, nullable, required
    - `taux_occupation_pct` number, nullable, required
    - `revpar_eur` number, nullable, required
    - `score_lcd` number, nullable, required
    - `score_lld` number, nullable, required
    - `part_residences_secondaires_pct` number, nullable, required
  - `avis_pillr` object, required
    - `points_forts` object[], required
      - `titre` string, required
      - `raison` string, nullable, required
    - `signaux_alerte` object[], required
      - `titre` string, required
      - `raison` string, nullable, required
      - `attenuation` string, nullable, required
  - `marche_en_vente` object, required
    - `statut` 'ok' | 'perime' | 'absent' | 'indisponible', required: ok : chiffres servis ; perime : calcul trop ancien ; absent : aucune annonce de la commune le dernier mois ; indisponible : source momentanément injoignable.
    - `mois` string, nullable, required: Mois des chiffres, AAAA-MM.
    - `calcule_le` string, nullable, required
    - `annonces_en_ligne` number, nullable, required
    - `nouvelles_annonces` number, nullable, required
    - `annonces_retirees` number, nullable, required
    - `delai_median_jours` number, nullable, required
    - `part_baissees_pct` number, nullable, required
    - `prix_affiche_m2_median` number, nullable, required
    - `variation_annonces_en_ligne_pct` number, nullable, required
    - `variation_nouvelles_annonces_pct` number, nullable, required
    - `variation_prix_affiche_m2_pct` number, nullable, required
    - `volumes_comparables` boolean, nullable, required: Faux quand l'un des deux mois comparés précède la stabilisation de la collecte : aucune variation de volume n'est alors calculée.
    - `mois_mise_a_jour_collecte` boolean, nullable, required: Vrai quand le mois trahit un changement de la collecte plutôt que du marché : seuls les nouvelles annonces et le prix affiché sont servis.
  - `donnees_du` string, nullable, 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

- `304`: Non modifiée depuis l'ETag fourni : rien n'est débité.
- `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)