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.

Vous allez : (1) voir un payload sans inscription, (2) récupérer une clé test gratuite sur my.fluximmo.io, (3) lancer votre premier search authentifié. Tout en self-service.
Couverture & fraîcheur — ce que vous interrogez derrière l’API :
  • 75 000+ nouvelles annonces ingérées chaque jour
  • Médiane de 5 minutes entre publication portail et mise à disposition (webhook / API)
  • 99 % du marché immobilier français couvert
  • Service en production continue depuis 2017
1

Voir un payload sans clé

L’endpoint sample/properties est public, sans authentification. Il renvoie 10 properties représentatives pour valider votre parsing.
curl --location 'https://api.fluximmo.io/v2/sample/properties'
Trois autres endpoints sample sont disponibles (adverts + payloads webhook type). Voir Données d’exemple.
2

Créer une clé test gratuite

Rendez-vous sur my.fluximmo.io → onglet API → Générer une clé test.
  • Gratuite, valable 1 semaine
  • Accès limité (volume et périmètre réduits, suffisant pour valider une intégration)
  • Aucun paiement, aucune carte bancaire requise
Conservez la clé en variable d’environnement :
export FLUXIMMO_API_KEY="votre-cle-test"
3

Premier search PROPERTIES authentifié

L’endpoint properties/search retourne des biens dédupliqués multi-portails. Ici, on demande 10 biens en vente dans le 75001.
curl --location 'https://api.fluximmo.io/v2/protected/properties/search' \
  --header 'x-api-key: '"$FLUXIMMO_API_KEY"'' \
  --header 'Content-Type: application/json' \
  --data '{
    "size": 10,
    "sortBy": "FIRST_SEEN_AT",
    "orderBy": "DESC",
    "search": {
      "filterProperty": {
        "location": [{ "postalCode": "75001" }],
        "offer": [{ "type": "OFFER_BUY" }]
      },
      "fullTexts": [],
      "keywords": []
    }
  }'
La réponse retourne un objet paginé { data: { count, items: Property[], searchAfterHash } }. Schéma complet : POST /v2/protected/properties/search.
4

Aller plus loin

Property vs Advert

Comprendre la différence entre annonce brute et bien dédupliqué avant de choisir l’endpoint.

Webhooks

ADVERT = payload complet, PROPERTY = IDs + refetch. Cycle de vie et events.

Match types & alertes

Cycle de vie d’une alerte, events PRICE / REPUBLISHED / UNPUBLISHED.

Playbook : alerte ADVERT

Mettre en place une alerte temps réel sur un département en 15 minutes.

Page LLM-ready

Spec consolidée à coller dans ChatGPT / Claude pour générer des payloads valides.

FAQ

Questions fréquentes sur les rate-limits, la facturation, la qualité de la donnée.
Vous générez vos payloads avec un LLM (ChatGPT, Claude) ? Copiez la page LLM-ready dans votre prompt pour des payloads valides du premier coup.

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 requis.