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.

/

Opération

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

GET/api/v1/communes/classement

Paramètres facultatifs (16)

autour_detexte, requête

Code INSEE de la commune de départ du rayon.

rayon_kmnombre, requête

Rayon autour de la commune de départ, en km (50 par défaut, 150 au plus).

budget_eurnombre, requête

Budget d'achat, en euros : fixe le prix au m² maximal avec la surface type.

surface_type_m2nombre, requête

Surface type pour le budget, en m² (50 par défaut).

rendement_brut_min_pctnombre, requête

prix_m2_maxnombre, requête

population_minnombre, requête

Population minimale (2 000 par défaut).

securite_minnombre, requête

Sous-score de sécurité minimal, sur 100.

vacance_max_pctnombre, requête

evol_3y_min_pctnombre, requête

exclure_qpvvaleur, requête

true : écarte les communes qui comptent un quartier prioritaire.

typetexte, requête

Type de bien : appartement (par défaut) ou maison. par défaut "appartement"

strategietexte, requête

rendement (par défaut, aucun filtre de plus), cashflow, patrimonial, pinel ou deal : les seuils de la page des opportunités. par défaut "rendement"

tritexte, requête

Tri : rendement (par défaut), score_pillr ou distance (avec autour_de).

limiteentier, requête

Nombre d'éléments par page (50 au plus). de 1 à 50 ; par défaut 20

curseurtexte, requête

Curseur opaque rendu par la page précédente (curseur_suivant), à repasser tel quel. de 1 à 1 024 caractères

Clé de test

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/communes/classement \
  -H "Authorization: Bearer $PILLR_CLE"

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