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.

Aucun compte requis. Idéal pour tester votre parsing en local ou découvrir le format avant de demander une clé test. Les 4 endpoints renvoient des données réelles, anonymisées si besoin.

1. Échantillon de properties

10 properties (biens dédupliqués multi-portails). Schéma identique à POST /v2/protected/properties/search.
curl --location 'https://api.fluximmo.io/v2/sample/properties'
Référence : GET /v2/sample/properties.

2. Échantillon d’adverts

10 adverts (annonces brutes, 1 advert = 1 URL portail). Schéma identique au payload livré par une alerte ADVERT en webhook.
curl --location 'https://api.fluximmo.io/v2/sample/adverts'
Référence : GET /v2/sample/adverts.

3. Webhook properties — payload type

Exemple du body envoyé par Fluximmo sur un webhook PROPERTY (création / merge). Le payload contient les IDs uniquement : un refetch via GET /v2/protected/properties/{flxId} est requis pour récupérer la donnée enrichie.
curl --location 'https://api.fluximmo.io/v2/sample/webhook/properties'
Référence : GET /v2/sample/webhook/properties.

4. Webhook adverts — payload type

Exemple du body envoyé par Fluximmo sur un webhook ADVERT (création, changement de prix, republication, mise hors-ligne). Le payload est complet, pas de refetch nécessaire.
curl --location 'https://api.fluximmo.io/v2/sample/webhook/adverts'
Référence : GET /v2/sample/webhook/adverts.

Property vs Advert — différences clés

Avant de choisir l’endpoint à intégrer, comprenez la distinction. Détail complet : Property vs Advert.
CritèreADVERTPROPERTY
DéfinitionAnnonce individuelle sur un portail (1 URL = 1 advert).Bien physique unique, agrégé à partir d’une chaîne de déduplication d’adverts.
IdentifiantflxId (advert) + propertyFlxId (rattachement à la chaîne de dédup)flxId (property) + adverts[] (constituants)
Mode d’accèsWebhook uniquement via alerte ADVERT (pas d’endpoint de search public). Le payload de l’alerte est identique à celui d’un search property côté schéma de filtres.API BAAS à la demande : POST /v2/protected/properties/search (+ alerte webhook qui livre des IDs uniquement).
Filtres clés spécifiquesisOnline, isPro, isExclusive, source, seller[], firstSeenAtmeta.isTotallyOffline, meta.firstSeenAt, filtre nested adverts.*
Webhook payloadPayload COMPLET de l’advert + bloc event.IDs uniquement → refetch via GET /v2/protected/properties/{flxId} (facturé).
Events supportésOUI : PRICE, REPUBLISHED, UNPUBLISHED (ALERT_MATCH_ADVERT_EVENT).Limité : CREATED et MERGED (uniquement quand fusion d’une nouvelle advert dans la property). Pas d’event UNPUBLISHED côté property.
Cas d’usage idéalRéplication BDD multi-portails, monitoring temps réel, tracking concurrentiel par seller, alerte chasseur avec payload self-contained.Recherche multi-portail BAAS API, analytics agrégé, valorisation, market intel, dédup côté serveur Fluximmo.
Anti-patternAnalytics agrégé sans grouper par propertyFlxId (un bien physique compté N fois).Stocker en DB les résultats search/alertes : pas conçu pour ça, pas d’event UNPUBLISHED côté property → drift garanti sans re-fetch régulier.
Coût/perfVolume webhook élevé (toutes les annonces matching, doublons inclus). Seule option pour répliquer la donnée Fluximmo en local.À la demande via API : volume contrôlé, mais ownership donnée moindre (pas de stream continu côté client).
Reconstituer la dédup côté client — chaque advert porte un propertyFlxId. Deux adverts avec le même propertyFlxId sont des doublons d’un même bien physique. La première advert non-dupliquée a flx_id == property_id ; les suivantes héritent du property_id de la chaîne. Un client ADVERTS-only peut donc reconstruire sa propre vue agrégée à la Property côté DB.
Cycle de vie alerte — Supprimer + recréer une alerte = perte d’historique des events sur les annonces matchées par l’ancienne alerte. Préférez PATCH /alerts/{flxId} pour modifier en place.
Pas de backfill à la création — Une alerte ne match QUE les adverts/properties traitées après sa création. Les annonces antérieures qualifiantes ne seront jamais émises. Pour couvrir le passé : demandez le backfill historique sur votre webhook par mail à [email protected].
Events ADVERT réelsPRICE (toute variation, même 1 €), REPUBLISHED (offline → online), UNPUBLISHED (online → offline). CHECK (vérification sans changement) ne déclenche pas de webhook.

Étape suivante

Quickstart 5 min

Récupérer une clé test gratuite et lancer un premier search authentifié.

Property vs Advert

Décider quel endpoint correspond à votre cas d’usage.

Clé test gratuite — 1 semaine

Créez un compte sur my.fluximmo.io pour récupérer une clé API test gratuite (1 semaine, accès limité). Aucun paiement, aucun appel commercial.