Skip to main content
POST
/
v2
/
protected
/
properties
/
search
/
lite
Lite Search properties
curl --request POST \
  --url https://api.fluximmo.io/v2/protected/properties/search/lite \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "orderBy": "DESC",
  "search": {
    "filterProperty": {
      "land": {
        "surface": {
          "max": 123,
          "min": 123
        }
      },
      "location": [],
      "meta": {
        "firstSeenAt": {
          "max": "2022-10-21T11:31:33.593Z",
          "min": "2022-10-21T11:31:33.593Z"
        },
        "isTotallyOffline": true,
        "lastPublishedAt": {
          "max": "2022-10-21T11:31:33.593Z",
          "min": "2022-10-21T11:31:33.593Z"
        },
        "lastSeenAt": {
          "max": "2022-10-21T11:31:33.593Z",
          "min": "2022-10-21T11:31:33.593Z"
        },
        "lastUpdatedAt": {
          "max": "2022-10-21T11:31:33.593Z",
          "min": "2022-10-21T11:31:33.593Z"
        }
      },
      "price": {
        "latest": {
          "value": {
            "max": 123,
            "min": 123
          },
          "valuePerArea": {
            "max": 123,
            "min": 123
          }
        }
      },
      "type": [
        "CLASS_HOUSE"
      ],
      "offer": [],
      "habitation": {
        "bedroomCount": {
          "max": 123,
          "min": 123
        },
        "roomCount": {
          "max": 123,
          "min": 123
        },
        "characteristics": {
          "hasBalcony": true,
          "hasCellar": true,
          "hasGarage": true,
          "hasLift": true,
          "hasParking": true,
          "hasPool": true,
          "hasTerrace": true
        },
        "climate": {
          "epcClimate": [],
          "epcEnergy": []
        },
        "surface": {
          "total": {
            "max": 123,
            "min": 123
          }
        },
        "features": {
          "furniture": [],
          "propertyFloor": {
            "max": 123,
            "min": 123
          },
          "propertyTotalFloor": {
            "max": 123,
            "min": 123
          }
        },
        "propertyCondition": [
          {
            "constructionYear": 123,
            "generalConditions": []
          }
        ]
      }
    },
    "fullTexts": [
      "<string>"
    ],
    "keywords": [
      "<string>"
    ]
  },
  "size": 10,
  "sortBy": "FIRST_SEEN_AT",
  "searchAfterHash": "<string>"
}
'
{
  "data": {
    "items": [
      {
        "adverts": [
          {
            "contactInCharge": {
              "email": "<string>",
              "firstName": "<string>",
              "lastName": "<string>",
              "phoneNumber": "<string>",
              "pseudonym": "<string>"
            },
            "description": "<string>",
            "firstSeenAt": "2022-10-21T11:31:33.593Z",
            "flxId": "<string>",
            "isOnline": true,
            "lastSeenAt": "2022-10-21T11:31:33.593Z",
            "location": [
              123
            ],
            "medias": {
              "images": [
                {
                  "gaussianHash": "<string>",
                  "imageId": "<string>",
                  "meanHash": "<string>",
                  "perceptualHash": "<string>",
                  "colorHash": "<string>",
                  "differenceHash": "<string>",
                  "url": "<string>"
                }
              ],
              "virtualVisitExternalUrl": [
                "<string>"
              ]
            },
            "price": {
              "charges": {
                "yearlyCondoniumFees": 123,
                "yearlyElectricityFees": 123,
                "yearlyHeatingFees": 123,
                "yearlyHousingTax": 123,
                "yearlyLivingTax": 123,
                "yearlyRentalFees": 123,
                "monthlyRentSupplement": 123
              },
              "currency": null,
              "initial": {
                "source": {
                  "flxId": "<string>",
                  "url": "<string>",
                  "website": "<string>"
                },
                "value": 123,
                "valuePerArea": 123
              },
              "isAuction": true,
              "latest": {
                "source": {
                  "flxId": "<string>",
                  "url": "<string>",
                  "website": "<string>"
                },
                "value": 123,
                "valuePerArea": 123
              },
              "scope": null,
              "warrantyDeposit": 123,
              "variation": {
                "sinceLastModified": 123,
                "sincePublished": 123,
                "absoluteSinceLastModified": 123,
                "absoluteSincePublished": 123
              }
            },
            "source": {
              "flxId": "<string>",
              "url": "<string>",
              "website": "<string>"
            },
            "title": "<string>",
            "offlineAt": "2022-10-21T11:31:33.593Z",
            "hasAnomaly": true,
            "isPro": true,
            "seller": {
              "flxId": "<string>",
              "name": "<string>",
              "siren": "<string>",
              "type": "SELLER_TYPE_AGENCY"
            },
            "isExclusive": true
          }
        ],
        "description": "<string>",
        "flxId": "<string>",
        "habitation": {
          "bathroomCount": 123,
          "bedroomCount": 123,
          "characteristics": {
            "hasAlarm": true,
            "hasBalcony": true,
            "hasCellar": true,
            "hasConcierge": true,
            "hasDigicode": true,
            "hasFireplace": true,
            "hasGarage": true,
            "hasGarden": true,
            "hasGrenier": true,
            "hasInterphone": true,
            "hasJacuzzi": true,
            "hasLand": true,
            "hasLift": true,
            "hasMezzanine": true,
            "hasParking": true,
            "hasPool": true,
            "hasTerrace": true,
            "hasVisAVis": true,
            "isPeaceful": true
          },
          "climate": {
            "epcClimate": "GREENHOUSE_CLASSIFICATION_C",
            "epcClimateScore": 123,
            "epcEnergy": "ENERGY_CLASSIFICATION_C",
            "epcEnergyScore": 123,
            "epcClimateDate": "2022-10-21T11:31:33.593Z",
            "epcEnergyDate": "2022-10-21T11:31:33.593Z"
          },
          "features": {
            "exposure": null,
            "furniture": null,
            "propertyFloor": 123,
            "propertyTotalFloor": 123,
            "viewTypes": [],
            "constructionMaterials": [],
            "hasThroughExposure": true,
            "viewOns": []
          },
          "heatTypes": [],
          "heatTypeDetails": [],
          "heatings": [],
          "propertyCondition": {
            "constructionYear": 123,
            "interiorCondition": null,
            "renovationYear": 123,
            "generalConditions": []
          },
          "roomCount": 123,
          "surface": {
            "balconies": 123,
            "floorSpace": 123,
            "gardens": 123,
            "groundFloor": 123,
            "kitchen": 123,
            "livingSpace": 123,
            "livingRoom": 123,
            "terraces": 123,
            "total": 123
          },
          "type": [],
          "wcCount": 123
        },
        "hasAnomaly": true,
        "isUrgent": true,
        "land": {
          "canConstruct": true,
          "hasBuildingPermit": true,
          "hasElectricity": true,
          "hasTelecom": true,
          "hasWater": true,
          "isServiced": true,
          "surface": 123,
          "surfaceConstructable": 123,
          "type": null
        },
        "location": {
          "city": "<string>",
          "cityCoordinate": {
            "location": [
              2.3522,
              48.8566
            ]
          },
          "department": "<string>",
          "inseeCode": "<string>",
          "irisCode": "<string>",
          "locationCoordinate": {
            "location": [
              2.3522,
              48.8566
            ]
          },
          "postalCode": "<string>"
        },
        "medias": {
          "images": [
            {
              "gaussianHash": "<string>",
              "imageId": "<string>",
              "meanHash": "<string>",
              "perceptualHash": "<string>",
              "colorHash": "<string>",
              "differenceHash": "<string>",
              "url": "<string>"
            }
          ],
          "virtualVisitExternalUrl": [
            "<string>"
          ]
        },
        "meta": {
          "firstSeenAt": "2022-10-21T11:31:33.593Z",
          "isTotallyOffline": true,
          "lastPublishedAt": "2023-11-07T05:31:56Z",
          "lastSeenAt": "2022-10-21T11:31:33.593Z",
          "lastUpdatedAt": "2022-10-21T11:31:33.593Z",
          "totallyOfflineAt": "2022-10-21T11:31:33.593Z"
        },
        "parking": {
          "count": 123,
          "numberOfCars": 123,
          "surface": 123,
          "type": null
        },
        "price": {
          "charges": {
            "yearlyCondoniumFees": 123,
            "yearlyElectricityFees": 123,
            "yearlyHeatingFees": 123,
            "yearlyHousingTax": 123,
            "yearlyLivingTax": 123,
            "yearlyRentalFees": 123,
            "monthlyRentSupplement": 123
          },
          "currency": null,
          "initial": {
            "source": {
              "flxId": "<string>",
              "url": "<string>",
              "website": "<string>"
            },
            "value": 123,
            "valuePerArea": 123
          },
          "isAuction": true,
          "latest": {
            "source": {
              "flxId": "<string>",
              "url": "<string>",
              "website": "<string>"
            },
            "value": 123,
            "valuePerArea": 123
          },
          "scope": null,
          "warrantyDeposit": 123,
          "variation": {
            "sinceLastModified": 123,
            "sincePublished": 123,
            "absoluteSinceLastModified": 123,
            "absoluteSincePublished": 123
          }
        },
        "tags": [
          "<string>"
        ],
        "title": "<string>",
        "type": "CLASS_HOUSE",
        "offer": {
          "isCurrentlyOccupied": true,
          "renting": {
            "isColocation": true,
            "isLongTerm": true,
            "isShortTerm": true,
            "isSubLease": true
          },
          "type": "OFFER_BUY"
        }
      }
    ],
    "searchAfterHash": "<string>",
    "count": 123
  }
}

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.

Variante allégée du POST /v2/protected/properties/search : schéma de réponse réduit (champs essentiels uniquement) pour des temps de réponse plus courts. Pensée pour les contextes interactifs où la latence prime sur la richesse du payload de retour. À privilégier pour : auto-complétion d’une UI mobile, prévisualisation de carte, suggestions instantanées, prefetch côté front. À éviter quand vous avez besoin de toute la richesse du modèle property (analytics, AVM, peer comparison) — utilisez la variante full dans ce cas. Différences vs full : les filtres suivants ne sont pas disponibles dans la version lite :
  • adverts[] (filtres nested sur les annonces source)
  • parking
  • process
  • tags
  • hasAnomaly
  • isUrgent
  • cityCoordinate (utiliser locationCoordinate à la place)
Tous les autres filtres (location administratif, locationCoordinate pour les modes géo, offer, type, price, habitation, land, meta) sont disponibles à l’identique.

​
Cas d’usage

  • Auto-complétion d’adresse → preview des biens disponibles à mesure que l’utilisateur tape
  • App mobile : liste paginée rapide, scroll infini
  • Carte interactive avec markers (peu de champs nécessaires par marker)
  • Prefetch / cache côté front pour minimiser la latence perçue
  • Widgets embarqués (extensions, plugins tiers)

​
Filtres clés

Identiques à la version full (voir Filtres communs) à l’exception des filtres listés en intro. Pour la géo, voir Recherche géographique.
Le filtre location[].city est ignoré côté moteur de recherche. Utilisez postalCode, inseeCode ou department pour filtrer par zone administrative — sinon le résultat couvre toute la France.

​
Exemples

​
Exemple 1 — Combo standard adapté lite (Paris achat appartement)

Même cas que l’exemple #1 du search full, ajusté pour la variante lite (suppression du filtre nested adverts[] qui n’est pas supporté). 
{
  "size": 25,
  "sortBy": "FIRST_SEEN_AT",
  "orderBy": "DESC",
  "search": {
    "filterProperty": {
      "location": [{ "postalCode": "75001" }],
      "type": ["CLASS_FLAT", "CLASS_HOUSE", "CLASS_PROGRAM"],
      "offer": [{ "type": "OFFER_BUY" }],
      "price": { "latest": { "value": { "min": 100000, "max": 350000 } } },
      "habitation": {
        "surface": { "total": { "min": 30, "max": 110 } },
        "bedroomCount": { "min": 1, "max": 3 }
      },
      "meta": {
        "isTotallyOffline": false,
        "firstSeenAt": { "min": "2025-01-01T00:00:00.000Z" }
      }
    }
  }
}

curl -X POST https://api.fluximmo.io/v2/protected/properties/search/lite \
  -H "x-api-key: $FLUXIMMO_API_KEY" \
  -H "Content-Type: application/json" \
  -d @payload.json

​
Exemple 2 — Auto-complétion mobile (Paris flat, top 10)

Cas UI mobile : filtres minimaux, size réduite à 10, tri canonique. Latence cible < 300 ms typiquement. 
{
  "size": 10,
  "sortBy": "FIRST_SEEN_AT",
  "orderBy": "DESC",
  "search": {
    "filterProperty": {
      "location": [{ "postalCode": "75001" }],
      "type": ["CLASS_FLAT"],
      "offer": [{ "type": "OFFER_BUY" }],
      "meta": { "isTotallyOffline": false }
    }
  }
}

curl -X POST https://api.fluximmo.io/v2/protected/properties/search/lite \
  -H "x-api-key: $FLUXIMMO_API_KEY" \
  -H "Content-Type: application/json" \
  -d @payload.json

​
Pagination

Identique à search full : cursor searchAfterHash retourné dans la réponse, à renvoyer dans le payload suivant. size 1-25 recommandé, sortBy / orderBy à figer entre deux pages pour préserver la stabilité du cursor.

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
orderBy
enum<string>
required
Available options:
ASC,
DESC
Example:

"DESC"

​
search
object
required
​
size
number
default:10
required
Example:

10

​
sortBy
enum<string>
required
Available options:
FIRST_SEEN_AT,
PRICE,
LAST_UPDATED_AT,
LAST_SEEN_AT,
RELEVANCE
Example:

"FIRST_SEEN_AT"

​
searchAfterHash
string

The searchAfterHash parameter allows you to retrieve the next page of results by using the searchAfterHash value returned in the response from the previous page. This method eliminates the complexities of traditional pagination methods and ensures accurate results, regardless of insertions or deletions in the dataset.

Response

​
data
object
required