--- title: "Encadrement des loyers" method: GET path: "/encadrement-loyers" --- # Encadrement des loyers `GET /encadrement-loyers` ## Request - Base URL: `https://pillr.fr/api/v1` - URL: `https://pillr.fr/api/v1/encadrement-loyers` - Auth: HTTP bearer Encadrement des loyers d'un logement à Paris, décrit par son code postal, son nombre de pièces, son époque de construction, la location meublée ou non et sa surface, ou par une annonce du catalogue : loyers de référence, minoré et majoré au m² du barème le plus récent (quartier nommé, ou moyenne des quartiers de l'arrondissement), loyer maximal légal hors complément de loyer, et dépassement d'un loyer envisagé. Hors de Paris, applicable vaut faux et encadrement_en_vigueur dit si la commune figure parmi les communes encadrées ; leur barème n'est pas servi. Coût : 1 crédit par appel réussi. ## Query parameters - `annonce` string: Identifiant d'une annonce : son code postal, sa surface, ses pièces, sa location meublée et son loyer estimé servent de défaut. - `code_postal` string: Code postal. - `quartier` string: Quartier administratif de Paris (ex. Belleville) ; sans lui, la moyenne des quartiers de l'arrondissement. - `pieces` integer: Nombre de pièces principales. - `epoque` 'avant_1946' | '1946_1970' | '1971_1990' | 'apres_1990': Sans époque : la moyenne des quatre époques. - `meuble` union: Location meublée (true) ou nue (false, par défaut). - boolean - 'true' | 'false' - `surface` number: Surface habitable, en m². - `loyer` number: Loyer mensuel envisagé hors charges, en euros. ## Response `200` Réponse servie et débitée (sauf réponse identique déjà servie dans les 24 h). - object - `applicable` boolean, required: Vrai : le barème d'encadrement de ce lieu est servi (Paris). Faux ailleurs, y compris dans une commune encadrée dont le barème n'est pas chargé. - `encadrement_en_vigueur` boolean, required: La commune applique l'encadrement des loyers (liste des communes encadrées du simulateur de pillr.fr). - `commune` string, nullable, required - `code_postal` string, nullable, required - `insee` string, nullable, required - `arrondissement` integer, nullable, required - `quartier` string, nullable, required: Quartier retenu, ou l'arrondissement quand la moyenne de ses quartiers est prise. - `annee_bareme` integer, nullable, required: Année du barème lu (la plus récente chargée). - `criteres` object, required - `pieces` integer, nullable, required: Pièces du barème, 1 à 4 (4 : quatre pièces et plus). - `epoque` 'avant_1946' | '1946_1970' | '1971_1990' | 'apres_1990', nullable, required: Époque de construction : avant_1946, 1946_1970, 1971_1990 ou apres_1990. - `meuble` boolean, required - `loyer_reference_eur_m2` number, nullable, required: Loyer de référence, en euros par m² et par mois. - `loyer_minore_eur_m2` number, nullable, required: Loyer de référence minoré, en euros par m² et par mois. - `loyer_majore_eur_m2` number, nullable, required: Loyer de référence majoré, en euros par m² et par mois. - `surface_m2` number, nullable, required - `loyer_max_legal_eur_mois` number, nullable, required: Loyer de référence majoré multiplié par la surface : le loyer hors charges maximal, hors complément de loyer. - `loyer_estime_eur_mois` number, nullable, required: Le loyer comparé : celui donné, ou le loyer estimé de l'annonce (charges comprises, voir hypotheses). - `depassement_pct` number, nullable, required: Écart du loyer comparé au loyer maximal légal, en % (positif : au-dessus). - `conforme` boolean, nullable, required: Vrai si le loyer comparé ne dépasse pas le loyer maximal légal ; null sans loyer ou sans plafond. - `lignes_bareme` object[], required: Les lignes du barème retenues pour les moyennes. - `id_quartier` string, nullable, required - `quartier` string, nullable, required - `epoque` string, nullable, required - `loyer_reference` number, nullable, required - `loyer_minore` number, nullable, required - `loyer_majore` number, nullable, required - `hypotheses` string[], required - `note` string, 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. - `source` string, 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)