Référence · Annonces

Rechercher des annonces dans un secteur

GET/v1/listingsDroit listings:read

Un et un seul secteur : commune (codes INSEE séparés par des virgules, 50 au plus), departement, region, lat+lon+radius_m, ou bbox. Le total n’est donné que sur la première page, plafonné à 10 000 (total_capped).

Paramètres

ParamètreTypeDescription
communefacultatifliste (a,b,c)Codes INSEE de communes, séparés par des virgules (50 au plus). Paris, Lyon et Marseille : le code de la ville réunit ses arrondissements.
departementfacultatifchaîneCode de département (13, 2A, 974).
regionfacultatifchaîneCode INSEE de région (93 : Provence-Alpes-Côte d’Azur).
latfacultatifnombre, -90 à 90Latitude du centre d’un rayon (avec lon et radius_m).
lonfacultatifnombre, -180 à 180Longitude du centre d’un rayon (avec lat et radius_m).
radius_mfacultatifentier, 100 à 50000Rayon en mètres, de 100 à 50 000.
bboxfacultatifchaîneCadre « minLon,minLat,maxLon,maxLat » (WGS84).
property_typefacultatifmaison | appartementType de bien.
min_pricefacultatifentierPrix minimal, en euros.
max_pricefacultatifentierPrix maximal, en euros.
min_surfacefacultatifnombreSurface habitable minimale, en m².
max_surfacefacultatifnombreSurface habitable maximale, en m².
min_surface_terrainfacultatifnombreSurface de terrain minimale, en m².
max_surface_terrainfacultatifnombreSurface de terrain maximale, en m².
min_roomsfacultatifentierNombre de pièces minimal.
max_roomsfacultatifentierNombre de pièces maximal.
viagerfacultatifexclude | onlyVentes en viager : écartées (exclude) ou seules retenues (only). Absent : incluses.
nue_proprietefacultatifexclude | onlyVentes en nue-propriété : écartées ou seules retenues. Absent : incluses.
sourcesfacultatifliste (a,b,c)Plateformes, séparées par des virgules : au moins une annonce en ligne sur l’une d’elles (autre : plateforme inconnue).
labelsfacultatifliste (a,b,c)Libellés d’audit (TBA,BA…), droit valuations:read : ne garde que les biens valorisés.
on_sale_afterfacultatifdate-heure (ISO 8601)Mises en vente à partir de cette date (ISO 8601).
sortfacultatifrecent | oldest | price_asc | price_desc | deltarecent (défaut) et oldest : date de mise en vente ; price_asc / price_desc : prix ; delta : meilleurs écarts au prix de marché d’abord (droit valuations:read).
limitfacultatifentier, 1 à 100Taille de page, de 1 à 100 (50 par défaut).
cursorfacultatifchaînenext_cursor de la page précédente, tel quel (avec le même sort).

Réponse 200

ChampTypeDescription
datatableau de objetAnnonces de la page.
↳ iduuidIdentifiant du bien (stable : un même bien vu sur plusieurs plateformes garde le même).
↳ titlechaîneTitre de l’annonce affichée.
↳ property_typepeut être nullmaison | appartementType de bien.
↳ priceentierPrix demandé, en euros.
↳ price_per_sqmpeut être nullentierPrix demandé au m², en euros.
↳ surfacepeut être nullnombreSurface habitable, en m².
↳ surface_terrainpeut être nullnombreSurface du terrain, en m².
↳ roomspeut être nullentierNombre de pièces.
↳ bedroomspeut être nullentierNombre de chambres.
↳ construction_yearpeut être nullentierAnnée de construction déclarée.
↳ dpe_letterpeut être nullA | B | C | D | E | F | GClasse énergie (DPE).
↳ ges_letterpeut être nullA | B | C | D | E | F | GClasse climat (GES).
↳ works_neededpeut être nullnone | light | moderate | heavyTravaux à prévoir : aucun, légers, modérés, lourds.
↳ outdoor_spacepeut être nullnone | balcon | loggia | terrasse | jardinExtérieur : aucun, balcon, loggia, terrasse ou jardin.
↳ seller_typepeut être nullparticulier | proVendeur : particulier ou professionnel.
↳ communeobjetCommune du bien.
↳ codechaîneCode INSEE.
↳ namechaîneNom de la commune.
↳ positionpeut être nullobjetPosition du bien ; null si inconnue.
↳ lonnombreLongitude (WGS84).
↳ latnombreLatitude (WGS84).
↳ precisionpoint | secteur | communepoint : adresse exacte ; secteur : zone floutée par la plateforme ; commune : centre de la commune.
↳ radius_mpeut être nullentierRayon de la zone floutée, en mètres (secteur seulement).
↳ photostableau de adresse (URL)Adresses des photos, la principale d’abord.
↳ sourcestableau de objetPlateformes où le bien est en ligne.
↳ idchaîneIdentifiant normalisé de la plateforme (seloger, leboncoin… ; autre si inconnue).
↳ namechaîneNom lisible de la plateforme.
↳ price_droppeut être nullobjetDernière baisse de prix ; null si aucune.
↳ pctnombreBaisse, en % (négatif).
↳ from_priceentierPrix avant la baisse.
↳ to_priceentierPrix après la baisse.
↳ drops_countentierNombre de baisses depuis la mise en vente.
↳ days_agoentierJours écoulés depuis la dernière baisse.
↳ on_sale_sincedate-heure (ISO 8601)Mise en vente déclarée par les plateformes (à défaut, notre premier relevé).
↳ first_seen_atdate-heure (ISO 8601)Notre premier relevé du bien.
↳ changes_countentierNombre de modifications connues (prix, liens, titre, retraits…).
↳ auditfacultatifobjetRésumé de l’audit de prix, présent seulement avec le droit valuations:read.
↳ statuspeut être nullOK | INSUFFICIENT_DATA | COVERAGE_UNAVAILABLEOK : estimation disponible. INSUFFICIENT_DATA (aucune vente comparable) ou COVERAGE_UNAVAILABLE (pas de données DVF dans la commune) : ni estimation, ni libellé. null : pas encore valorisée.
↳ estimated_pricepeut être nullentierPrix de marché estimé, en euros, base prix affichés (comparable au prix demandé).
↳ delta_pctpeut être nullnombreÉcart du prix demandé au prix de marché, en % (−12,5 = 12,5 % sous le marché).
↳ labelpeut être nullTBA | BA | N | MA | TMATBA (très bonne affaire), BA (bonne affaire), N (dans le marché), MA (mauvaise affaire), TMA (très mauvaise affaire).
↳ confidencepeut être nullnombre, 0 à 1Confiance de l’estimation, de 0 à 1 (nombre et proximité des ventes comparables).
↳ location_precisionpoint | secteur | communePrécision de la localisation qui a fondé l’estimation : adresse exacte, zone floutée par la plateforme, ou centre de la commune.
↳ decote_unexplainedbooléenBonne affaire apparente sans facteur de décote identifié : à vérifier.
next_cursorpeut être nullchaîneÀ renvoyer dans cursor pour la page suivante ; null : dernière page.
totalfacultatifentierNombre total de résultats, sur la première page seulement (sans curseur), plafonné à 10 000.
total_cappedfacultatifbooléenVrai si le total a atteint le plafond : il y a AU MOINS total résultats.

Erreurs

400 · Requête invalide401 · Clé absente ou invalide403 · Droit manquant ou accès coupé429 · Limite atteinte503 · Requête trop longue

Toutes les erreurs ont la forme { "error": { "code", "message", "request_id" } } : voir Erreurs.