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 l'espace API de votre tableau de bord.

2 crédits par élément rendu. Pas de bac à sable : une clé de test reçoit l'erreur hors_bac_a_sable. Référence

GET/api/v1/annonces/pilier

Paramètres facultatifs (30)

Code INSEE d'une commune, ou liste de 10 codes au plus (paramètre répété).

Code postal, ou liste de 10 codes au plus.

Code de département, ou liste de 8 codes au plus.

Latitude du point de recherche (avec lon et rayon_km). de -90 à 90

Longitude du point de recherche (avec lat et rayon_km). de -180 à 180

Rayon autour du point, en km (50 au plus). 50 au plus ; plus de 0

SIREN d'une agence nommée.

Type de bien : appartement, maison ou immeuble entier.

0 au moins

0 au moins

0 au moins

0 au moins

Parues à partir de cette date (AAAA-MM-JJ).

Parues avant cette date.

Retirées à partir de cette date.

Retirées avant cette date.

toutes par défaut.

Statut du vendeur déclaré par le portail : pro (agence, réseau, promoteur), particulier, ou inconnu.

Au moins ce nombre de baisses de prix retenues. de 1 à 50

Vrai : seulement les biens en ligne chez au moins deux agences nommées.

Vrai : seulement les annonces qui ont leur propre analyse ; faux : seulement celles qui n'en ont pas.

Version du moteur d'analyse. Obligatoire avec score_min, rendement_brut_min ou rendement_net_min : deux versions ne se comparent pas. de 1 à 99

de 0 à 100

En %. de 0 à 100

En %. de 0 à 100

date (défaut, plus récentes d'abord), prix, prix_desc, score, rendement (brut).

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

Champs rendus, séparés par des virgules (« prix,surface,analyse.score ») ; tous si absent.

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/annonces/pilier?insee=76540" \
  -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