Modèle Property - API de données immobilières

{
  "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"
  }
}

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.

Champ	Type	Description
`flxId`	`string`	Identifiant unique Fluximmo de la property.
`type`	`enum`	`CLASS_FLAT`, `CLASS_HOUSE`, `CLASS_PROGRAM`, `CLASS_LAND`, `CLASS_PARKING`, `CLASS_OFFICE`, `CLASS_SHOP`, `CLASS_BUILDING`, `CLASS_PREMISES`, `CLASS_ROOM`, `CLASS_OTHER`, `CLASS_UNKNOWN`.
`title`	`string`	Par défaut : titre de la première advert.
`description`	`string`	Par défaut : description de la première advert.
`offer`	`OfferDto`	`{ type, isCurrentlyOccupied, renting }` — `type` ∈ `OFFER_BUY`, `OFFER_RENT`, `OFFER_LIFE_ANNUITY_SALE`, `OFFER_HOLIDAYS`, `OFFER_AUCTION`, `OFFER_BUSINESS_TAKE_OVER`, `OFFER_LEASE_BACK`, `OFFER_UNKNOWN`.
`price`	`PriceDto`	`{ initial, latest, variation, currency, scope, charges, isAuction, warrantyDeposit }`. `initial` = prix de la première advert ; `latest` = prix de la dernière. `scope` ∈ `PRICING_ONE_OFF`, `PRICING_MENSUAL`.
`location`	`LocationDto`	`{ city, postalCode, inseeCode, irisCode, department, cityCoordinate, locationCoordinate }`. Coordonnées au format `{ location: [lng, lat] }` (GeoJSON).
`habitation`	`TypeHabitationDto`	`{ surface: { total, balconies, terraces, ... } (m²), roomCount, bedroomCount, bathroomCount, wcCount, type, characteristics, climate (DPE/GES), features, propertyCondition }`.
`land`	`TypeLandDto`	Détails terrain (surface, etc.).
`parking`	`TypeParkingDto`	Détails parking.
`medias`	`MediasDto`	Photos / médias agrégés depuis les adverts.
`meta`	`MetaDto`	`{ firstSeenAt, lastSeenAt, lastUpdatedAt, lastPublishedAt, isTotallyOffline, totallyOfflineAt }` — voir ci-dessous.
`adverts`	`PropertyAdvertDto[]`	Liste des adverts constituantes (présent selon endpoint, peut être tronqué).
`tags`	`string[]`	Tags non structurés.
`hasAnomaly`	`boolean`	Une incohérence a été détectée.
`isUrgent`	`boolean`	Property 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": { "location": [2.376, 48.857] }
  },
  "habitation": {
    "surface": { "total": 70 },
    "roomCount": 3,
    "bedroomCount": 2,
    "climate": { "epcEnergy": "ENERGY_CLASSIFICATION_C", "epcClimate": "GREENHOUSE_CLASSIFICATION_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. 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

POST /v2/protected/properties/search — recherche dédupliquée.
GET /v2/protected/properties/{flxId} — fetch d’une property par son flxId (utile après webhook).
Match types & cycle alerte — events CREATED, MERGED côté property.

adverts

object[]

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

Show child attributes

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

Show child attributes

hasAnomaly

boolean

An anomaly or incoherence have been detected

isUrgent

boolean

Is the property marked as urgent

land

object

Land details of the property

Show child attributes

location

object

Location details of the property

Show child attributes

medias

object

All the medias of the different adverts of the property

Show child attributes

Documentation Index

​Champs principaux

​meta.isTotallyOffline (champ clé en prod)

​JSON exemple

​Différences clés vs Advert

​Cas d’usage

​Endpoints associés

Champs principaux

`meta.isTotallyOffline` (champ clé en prod)

JSON exemple

Différences clés vs Advert

Cas d’usage

Endpoints associés