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.

2 crédits 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

POST/api/v1/courte-duree/estimations

Code INSEE de la commune ou de l'arrondissement (5 caractères, 2A ou 2B pour la Corse).

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

Paramètres facultatifs (7)

Chambres ; sans elles, la capacité est déduite de la surface. de 0 à 20

Nuits ouvertes à la location dans l'année. de 1 à 365

Occupation imposée, en % des nuits ouvertes ; sinon celle du marché, ajustée à la capacité. de 0 à 100

Gestion par l'investisseur seul, ou par une conciergerie (par défaut).

Meublé de tourisme classé (oui par défaut).

Étiquette DPE : une nouvelle autorisation l'exige suffisante.

Loyer mensuel en location nue, pour le repli et la comparaison ; sinon le loyer de marché de la commune. 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 -X POST https://pillr.fr/api/v1/courte-duree/estimations \
  -H "Authorization: Bearer $PILLR_CLE" \
  -H "Content-Type: application/json" \
  -d '{"insee":"<insee>","surface":1}'

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

    Essai en direct | Pillr Data