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/annonces

Paramètres facultatifs (36)

inseevaleur, requête

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

cpvaleur, requête

Code postal, ou liste de 10 codes au plus.

departementvaleur, requête

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

latnombre, requête

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

lonnombre, requête

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

rayon_kmnombre, requête

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

mots_clestexte, requête

Mots à trouver dans le titre ou la description (4 mots au plus, accents indifférents). de 3 à 100 caractères

typetexte, requête

Type de bien : appartement, maison ou immeuble entier.

prix_minnombre, requête

0 au moins

prix_maxnombre, requête

0 au moins

pieces_minentier, requête

0 au moins

pieces_maxentier, requête

0 au moins

chambres_minentier, requête

0 au moins

surface_minnombre, requête

0 au moins

surface_maxnombre, requête

0 au moins

prix_m2_maxnombre, requête

0 au moins

rendement_minnombre, requête

Rendement brut minimal, en %. de 0 à 100

rendement_net_minnombre, requête

Rendement net minimal, en %. de 0 à 100

score_minnombre, requête

de 0 à 100

dpevaleur, requête

Étiquettes DPE acceptées (une ou plusieurs).

dpe_maxtexte, requête

Étiquette DPE la moins bonne acceptée (D : de A à D).

passoiresvaleur, requête

Vrai : les seules passoires thermiques (F et G).

etat_visuel_maxnombre, requête

État visuel maximal sur 100 (pour chercher des biens à rénover). de 0 à 100

travaux_minnombre, requête

Travaux minimaux, sur le bas de la fourchette, en euros. 0 au moins

travaux_maxnombre, requête

Travaux maximaux, sur le haut de la fourchette (le pire cas), en euros. 0 au moins

travaux_max_m2nombre, requête

0 au moins

type_vendeurtexte, requête

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

sirentexte, requête

SIREN de l'agence ou du professionnel.

enseignetexte, requête

Nom ou enseigne de l'agence (début du nom). de 2 à 80 caractères

exclure_residences_gereesvaleur, requête

Vrai : écarte les logements de résidence gérée.

sous_le_marchevaleur, requête

Vrai : la règle « sous le marché » de la carte du site (rendement brut d'au moins 7 % et score d'au moins 70).

publie_depuistexte, requête

Annonces parues depuis cette date (AAAA-MM-JJ).

tritexte, requête

rendement (défaut), rendement_net, score, etat (meilleur état d'abord), date (plus récentes), prix, prix_desc, prix_m2, distance (avec lat, lon, rayon_km), opportunite (radar du Hub, sur les 250 annonces les mieux notées de la recherche).

limiteentier, requête

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

curseurtexte, requête

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

champsvaleur, requête

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

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

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