Aller au contenu

Documentation

Essai en direct

Appelez une opération de l'API depuis votre navigateur avec une clé de test pk_test_ : la réponse, ses en-têtes de crédits et l'appel équivalent en curl. Une clé de test se crée dans le mon espace.

1 crédit par appel réussi. Bac à sable : une clé de test reçoit la réponse sur un jeu figé, sans débit. Référence

GET/api/v1/encadrement-loyers

Paramètres facultatifs (8)

Identifiant d'une annonce : son code postal, sa surface, ses pièces, sa location meublée et son loyer estimé servent de défaut. de 3 à 200 caractères

Code postal.

Quartier administratif de Paris (ex. Belleville) ; sans lui, la moyenne des quartiers de l'arrondissement. de 2 à 80 caractères

Nombre de pièces principales. de 1 à 30

Sans époque : la moyenne des quatre époques.

Location meublée (true) ou nue (false, par défaut).

Surface habitable, en m². 1 000 au plus ; plus de 0

Loyer mensuel envisagé hors charges, en euros. 100 000 au plus ; plus de 0

Seule une clé pk_test_ est acceptée : sans débit, sur le bac à sable. Elle reste dans cette page, le temps de la visite : ni conservée, ni journalisée, ni envoyée ailleurs qu'à l'API.

Appel équivalent
curl https://pillr.fr/api/v1/encadrement-loyers \
  -H "Authorization: Bearer $PILLR_CLE"

La réponse, ses en-têtes de crédits et sa durée s'affichent ici.

    Essai en direct | Pillr Data