Property

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

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

Example:

"CLASS_HOUSE"

offer

object

Offer information of the property

Retrieve a realestate company from it's official identifier Advert

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

System

Properties

Adverts

RealEstate Companies

Models