Skip to main content

Documentation Index

Fetch the complete documentation index at: https://doc.fluximmo.io/llms.txt

Use this file to discover all available pages before exploring further.

Cette page liste les filtres communs aux endpoints search Properties et alertes Properties / Adverts. Le payload de filtres d’une alerte ADVERT est identique à celui d’un search property côté schéma — seules les clés racine du payload diffèrent. Il n’existe pas d’endpoint search ADVERT public ; les annonces brutes passent toujours par une alerte webhook. Chaque sous-objet est optionnel ; les filtres absents ne contraignent pas le résultat. Tous les filtres sont combinés en AND logique.

location[] — zones géographiques

location est un tableau : plusieurs zones sont combinées en OR (ex. Paris OU 92 OU 93). Chaque entrée accepte exactement un des modes ci-dessous.
ModeTypeExemple
postalCodestring"75011"
inseeCodestring"75056"
departmentstring (2 chars)"75"
citystring⚠️ ignoré par le moteur
locationCoordinate.geoBoundingBoxobjetbbox carte
locationCoordinate.geoDistanceobjetrayon autour d’un point
Détails complets, exemples par mode et logique multi-zones : Recherche géographique.
{ "location": [{ "postalCode": "75011" }, { "department": "92" }] }

offer[].type — type d’offre

offer est un tableau. Le champ type est un enum :
ValeurSens
OFFER_BUYVente
OFFER_RENTLocation
OFFER_LIFE_ANNUITY_SALEViager
OFFER_HOLIDAYSLocation vacances
OFFER_AUCTIONVente aux enchères
OFFER_BUSINESS_TAKE_OVERReprise de fonds de commerce
OFFER_LEASE_BACKLease-back
OFFER_UNKNOWNInconnu (à éviter)
{ "offer": [{ "type": "OFFER_BUY" }] }

price — prix

ChampTypeSens
price.initial.value.min / .maxintRange du prix initial (à la première publication).
price.latest.value.min / .maxintRange du prix courant (le plus récent).
price.initial.valuePerArea.min / .maxintPrix au m² initial.
price.latest.valuePerArea.min / .maxintPrix au m² courant.
{ "price": { "latest": { "value": { "min": 200000, "max": 450000 } } } }

habitation — caractéristiques du logement

ChampType
habitation.surface.total.min / .maxfloat (m²)
habitation.bedroomCount.min / .maxint
habitation.roomCount.min / .maxint
habitation.bathroomCount.min / .maxint
habitation.wcCount.min / .maxint
habitation.heatTypes[]enum array
habitation.heatings[]enum array
habitation.propertyCondition[]array
Note : habitation.floor n’est pas un champ direct du DTO — il fait partie de habitation.characteristics ou habitation.features selon le modèle. Utilisez surface, bedroomCount, roomCount pour les filtres usuels.
{
  "habitation": {
    "surface": { "total": { "min": 40, "max": 80 } },
    "bedroomCount": { "min": 2 },
    "roomCount": { "min": 3 }
  }
}

type[] — classe de bien

Tableau d’enum EnumPropertyClassDto :
ValeurSens
CLASS_FLATAppartement
CLASS_HOUSEMaison
CLASS_PROGRAMProgramme neuf
CLASS_LANDTerrain
CLASS_PARKINGParking / box
CLASS_OFFICEBureau
CLASS_SHOPLocal commercial
CLASS_PREMISESLocal pro / professionnel
CLASS_BUILDINGImmeuble
CLASS_ROOMChambre
CLASS_OTHERAutre
CLASS_UNKNOWNInconnu (à éviter)
{ "type": ["CLASS_FLAT", "CLASS_HOUSE"] }

meta — métadonnées de cycle de vie

ChampTypeSens
meta.isTotallyOfflinebooleanfalse = exclure les biens dont toutes les adverts sont offline. Très utile pour ne voir que des biens encore actifs.
meta.firstSeenAtrange datePremière fois que Fluximmo a vu le bien (min / max ISO 8601).
meta.lastSeenAtrange dateDernière fois que Fluximmo a vu le bien.
{
  "meta": {
    "isTotallyOffline": false,
    "firstSeenAt": { "min": "2025-01-01T00:00:00Z" }
  }
}

Filtres spécifiques Adverts (alerte)

Au-delà des filtres communs ci-dessus, les alertes ADVERTS exposent : isOnline (équivalent advert de meta.isTotallyOffline côté property), isPro, isExclusive, source (portail d’origine), seller[], firstSeenAt. Voir Advert — modèle complet.

Pour aller plus loin