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.

Une Property = bien physique unique. Agrégation de N adverts (annonces sur N portails) après déduplication. C’est l’objet à utiliser pour l’analytique, la valorisation et la vue dédupliquée d’un bien.

Champs principaux

Le schéma OpenAPI complet est rendu plus bas par Mintlify (PropertyDto). Ce tableau décrit les champs porteurs de sens métier.
ChampTypeDescription
flxIdstringIdentifiant unique Fluximmo de la property.
typeenumCLASS_FLAT, CLASS_HOUSE, CLASS_PROGRAM, CLASS_LAND, CLASS_PARKING, CLASS_OFFICE, CLASS_SHOP, CLASS_BUILDING, CLASS_PREMISES, CLASS_ROOM, CLASS_OTHER, CLASS_UNKNOWN.
titlestringPar défaut : titre de la première advert.
descriptionstringPar défaut : description de la première advert.
offerOfferDto{ type, isCurrentlyOccupied, renting }typeOFFER_BUY, OFFER_RENT, OFFER_LIFE_ANNUITY_SALE, OFFER_HOLIDAYS, OFFER_AUCTION, OFFER_BUSINESS_TAKE_OVER, OFFER_LEASE_BACK.
pricePriceDto{ initial, latest, variation, currency, scope, charges, isAuction, warrantyDeposit }. initial = prix de la première advert ; latest = prix de la dernière. scopePRICING_ONE_OFF, PRICING_MENSUAL.
locationLocationDto{ city, postalCode, inseeCode, irisCode, department, cityCoordinate, locationCoordinate }. Coordonnées au format { lat, lng }.
habitationTypeHabitationDto{ surface, roomCount, bedroomCount, bathroomCount, wcCount, type[], characteristics, climate (DPE/GES), features, propertyCondition, heatTypes[], heatings[] }.
landTypeLandDtoDétails terrain (surface, etc.).
parkingTypeParkingDtoDétails parking.
mediasMediasDtoPhotos / médias agrégés depuis les adverts.
metaMetaDto{ firstSeenAt, lastSeenAt, lastUpdatedAt, lastPublishedAt, isTotallyOffline, totallyOfflineAt } — voir ci-dessous.
advertsPropertyAdvertDto[]Liste des adverts constituantes (présent selon endpoint, peut être tronqué).
tagsstring[]Tags non structurés.
hasAnomalybooleanUne incohérence a été détectée.
isUrgentbooleanProperty marquée urgent.

meta.isTotallyOffline (champ clé en prod)

true ⇔ toutes les adverts associées sont offline (bien vendu, retiré, loué). Filtre standard côté search :
{ "meta": { "isTotallyOffline": false } }
→ exclut les biens hors ligne. Pour suivre le moment où un bien est passé totalement offline, utilisez meta.totallyOfflineAt.

JSON exemple

Extrait minimal — tous les champs ne sont pas affichés.
{
  "flxId": "prop_01HXY...",
  "type": "CLASS_FLAT",
  "title": "Appartement T3 lumineux 70m²",
  "offer": { "type": "OFFER_BUY", "isCurrentlyOccupied": false },
  "price": {
    "currency": "CURRENCY_EUR",
    "scope": "PRICING_ONE_OFF",
    "initial": { "value": 450000, "valuePerArea": 6428 },
    "latest":  { "value": 435000, "valuePerArea": 6214 }
  },
  "location": {
    "postalCode": "75011",
    "inseeCode": "75111",
    "department": "75",
    "city": "Paris",
    "locationCoordinate": { "lat": 48.857, "lng": 2.376 }
  },
  "habitation": {
    "surface": { "total": 70 },
    "roomCount": 3,
    "bedroomCount": 2,
    "climate": { "dpe": "C", "ges": "B" }
  },
  "meta": {
    "firstSeenAt": "2025-01-12T08:14:21.000Z",
    "lastSeenAt":  "2025-04-30T11:02:08.000Z",
    "isTotallyOffline": false
  },
  "adverts": [ /* PropertyAdvertDto[] — voir endpoint dédié */ ]
}
Pour un échantillon live (jeu de données réel servant de bac à sable), utilisez GET /v2/sample/properties — voir Sample data.

Différences clés vs Advert

Pour les détails conceptuels (déduplication, parent-enfant, choix d’endpoint) : Property vs Advert.

Cas d’usage

Analytique multi-portails. Une property = 1 ligne par bien réel. Idéal pour comptages, pricing moyen, distribution géographique sans gonfler les chiffres avec les doublons inter-portails. Déduplication. L’agrégation est faite par Fluximmo (matching titre/prix/géo/médias/seller). Vous lisez un bien unique, sans avoir à dédupliquer côté client. Estimation / AVM. price.initial vs price.latest + price.variation donnent la trajectoire de prix observée. Couplé à meta.isTotallyOffline=true + totallyOfflineAt, vous reconstituez les prix de transaction observables.

Endpoints associés

adverts
object[]

List of adverts linked to this property - adverts can be from different sources, different prices, different agencies, etc.

description
string

By default, will be the description of the first advert

flxId
string

Unique identifier of the property

habitation
object

Habitation characteristics of the property

hasAnomaly
boolean

An anomaly or incoherence have been detected

isUrgent
boolean

Is the property marked as urgent

land
object

Land details of the property

location
object

Location details of the property

medias
object

All the medias of the different adverts of the property

meta
object

Meta data of the property

parking
object

Parking details of the property

price
object

Price details of the property

tags
string[]

List of unstructured tags of the property

title
string

By default, will be the title of the first advert

type
enum<string>

Type of the property

Available options:
CLASS_UNKNOWN,
CLASS_HOUSE,
CLASS_FLAT,
CLASS_PROGRAM,
CLASS_SHOP,
CLASS_PREMISES,
CLASS_OFFICE,
CLASS_LAND,
CLASS_BUILDING,
CLASS_PARKING,
CLASS_ROOM,
CLASS_OTHER
Example:

"CLASS_HOUSE"

offer
object

Offer information of the property