--- title: "Score Pillr et scores d'une commune" method: GET path: "/communes/{insee}/scores" --- # Score Pillr et scores d'une commune `GET /communes/{insee}/scores` ## Request - Base URL: `https://pillr.fr/api/v1` - URL: `https://pillr.fr/api/v1/communes/{insee}/scores` - Auth: HTTP bearer Scores d'une commune tels que le pipeline de Pillr les publie : score Pillr sur 100 et ses huit sous-scores (rentabilité, demande, liquidité, croissance, stabilité, qualité, services, sécurité), scores d'attractivité, de location longue et courte durée, de tourisme et de démographie, z-scores et percentiles des prix, du rendement et des loyers, volatilité, prix attendu par le modèle départemental et écart au prix observé, ratios d'accessibilité. Un sous-score de rentabilité posé par défaut faute de rendement mesuré est signalé. Paris, Lyon et Marseille se lisent par arrondissement. Coût : 2 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). ## 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. - `score_pillr` number, nullable, required: Score Pillr sur 100 : moyenne pondérée des huit sous-scores. - `sous_scores` object, required - `rentabilite` number, nullable, required: Note sur 100 ; null si non calculée. - `demande` number, nullable, required: Note sur 100 ; null si non calculée. - `liquidite` number, nullable, required: Note sur 100 ; null si non calculée. - `croissance` number, nullable, required: Note sur 100 ; null si non calculée. - `stabilite` number, nullable, required: Note sur 100 ; null si non calculée. - `qualite` number, nullable, required: Note sur 100 ; null si non calculée. - `services` number, nullable, required: Note sur 100 ; null si non calculée. - `securite` number, nullable, required: Note sur 100 ; null si non calculée. - `sous_scores_imputes` string[], required: Sous-scores posés à leur valeur par défaut faute de donnée (rentabilité sans aucun rendement mesuré). - `scores` object, required - `attractivite` number, nullable, required: Note sur 100 ; null si non calculée. - `location_longue_duree` number, nullable, required: Note sur 100 ; null si non calculée. - `location_courte_duree` number, nullable, required: Note sur 100 ; null si non calculée. - `tourisme` number, nullable, required: Note sur 100 ; null si non calculée. - `demographie` number, nullable, required: Note sur 100 ; null si non calculée. - `zscores` object, required - `prix_appartement_national` number, nullable, required - `prix_appartement_regional` number, nullable, required - `prix_appartement_departemental` number, nullable, required - `rendement_national` number, nullable, required - `loyer_national` number, nullable, required - `percentiles` object, required - `prix_appartement_national` number, nullable, required - `prix_appartement_regional` number, nullable, required - `rendement_national` number, nullable, required - `loyer_national` number, nullable, required - `volatilite_prix` number, nullable, required - `prix_attendu_m2` number, nullable, required: Prix au m² attendu par le modèle départemental (revenu, services). - `prix_residuel_pct` number, nullable, required: Écart du prix observé au prix attendu, en % ; négatif : sous le prix attendu. - `residuel_sature` boolean, nullable, required: Vrai quand le modèle est hors de son domaine de validité (écart plafonné). - `signal_deal` string, nullable, required: Position face au prix attendu du département (bien_en_dessous_dept à bien_au_dessus_dept). - `ratio_loyer_revenu` number, nullable, required: Loyer mensuel de 30 m² rapporté au revenu médian mensuel. - `prix_revenu_annees` number, nullable, required: Années de revenu médian pour acheter 50 m² d'appartement au prix de la commune. - `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. - `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)