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 é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/palmares

L'indicateur du classement.

Paramètres facultatifs (6)

Code du département (01 à 95, 2A, 2B, 971 à 976).

Région : code INSEE, nom court ou nom. de 2 à 60 caractères

Population minimale ; par défaut celle des pages de classement du site, plus basse en maille géographique et pour les classements d'étude. Le seuil appliqué est rendu dans filtres_appliques.

Ventes minimales.

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

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

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/palmares?indicateur=rendement-locatif" \
  -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