Advert

contactInCharge

object

required

currency

enum<string>

Currency of the advert

Available options:

CURRENCY_EUR,

CURRENCY_USD

Example:

null

currentPrice

object

Current price of the advert

description

string

Description of the advert as it is on the source

firstSeenAt

string

Date should be in ISO format (ex: 2022-10-21T11:31:33.593Z)

Example:

"2022-10-21T11:31:33.593Z"

flxId

string

Unique identifier of the advert

habitation

object

Habitation details of the property

habitation.bathroomCount

number

habitation.bedroomCount

number

habitation.characteristics

object

habitation.climate

object

The energetic classes of the property (DPE/GES)

habitation.features

object

habitation.features.exposure

enum<string>

Available options:

EXPOSURE_UNKNOWN,

EXPOSURE_NORTH,

EXPOSURE_NORTH_EAST,

EXPOSURE_EAST,

EXPOSURE_SOUTH_EAST,

EXPOSURE_SOUTH,

EXPOSURE_SOUTH_WEST,

EXPOSURE_WEST,

EXPOSURE_NORTH_WEST

Example:

null

habitation.features.furniture

enum<string>

Available options:

UNKNOWN_FURNITURE,

UNFURNISHED,

PARTIALLY_FURNISHED,

FULLY_FURNISHED

Example:

null

habitation.features.propertyFloor

number

habitation.features.propertyTotalFloor

number

habitation.features.viewTypes

enum<string>[]

Available options:

VIEW_TYPE_UNKNOWN,

VIEW_TYPE_GLIMPSE,

VIEW_TYPE_PANORAMIC,

VIEW_TYPE_CLEAR,

VIEW_TYPE_EXCEPTIONAL,

VIEW_TYPE_DOMINANT

Example:

[]

habitation.features.constructionMaterials

enum<string>[]

Available options:

MATERIAL_UNKNOWN,

MATERIAL_WOODEN,

MATERIAL_STEEL,

MATERIAL_STONE,

MATERIAL_PVC,

MATERIAL_CONCRETE,

MATERIAL_ALUMINIUM,

MATERIAL_HALF_TIMBERED,

MATERIAL_MARBLE,

MATERIAL_BRICK,

MATERIAL_CINDER_BLOCK,

MATERIAL_PREFABRICATED,

MATERIAL_ADOBE,

MATERIAL_COATING

Example:

[]

habitation.features.hasThroughExposure

boolean

habitation.features.viewOns

enum<string>[]

Available options:

VIEW_ON_UNKNOWN,

VIEW_ON_SEA,

VIEW_ON_HILLS,

VIEW_ON_RIVERS,

VIEW_ON_CITY,

VIEW_ON_PARK,

VIEW_ON_VERDURE,

VIEW_ON_STREET,

VIEW_ON_COURTYARD,

VIEW_ON_COUNTRYSIDE,

VIEW_ON_MOUNTAIN,

VIEW_ON_GARDEN_TERRACE,

VIEW_ON_LAKE,

VIEW_ON_SKI_SLOPES,

VIEW_ON_PORT,

VIEW_ON_POI,

VIEW_ON_SKY,

VIEW_ON_WATER,

VIEW_ON_VINEYARD,

VIEW_ON_ROOF

Example:

[]

habitation.heatTypes

enum<string>[]

Available options:

HEAT_TYPE_UNKNOWN,

HEAT_TYPE_INDIVIDUAL,

HEAT_TYPE_SHARED,

HEAT_TYPE_MIX,

HEAT_TYPE_CITY,

HEAT_TYPE_CISTERN

Example:

[]

habitation.heatTypeDetails

enum<string>[]

Available options:

HEAT_DETAIL_UNKNOWN,

HEAT_DETAIL_FLOOR,

HEAT_DETAIL_CEILING,

HEAT_DETAIL_FIREPLACE,

HEAT_DETAIL_INSERT,

HEAT_DETAIL_AIR_CON,

HEAT_DETAIL_REVERSIBLE_AIR_CON,

HEAT_DETAIL_RADIANTS_TUBES,

HEAT_DETAIL_RADIATOR,

HEAT_DETAIL_SHEAHS,

HEAT_DETAIL_CONVECTOR

Example:

[]

habitation.heatings

enum<string>[]

Available options:

HEATING_UNKNOWN,

HEATING_FUEL_OIL,

HEATING_ELECTRICAL,

HEATING_GAS,

HEATING_BIOMASS,

HEATING_SOLAR,

HEATING_GEOTHERMAL,

HEATING_WOOD,

HEATING_HEAT_PUMP,

HEATING_PELLET,

HEATING_CANADIAN_WELL,

HEATING_COAL

Example:

[]

habitation.propertyCondition

object

habitation.propertyCondition.constructionYear

number

habitation.propertyCondition.interiorCondition

enum<string>

Available options:

INTERIOR_CONDITION_UNKNOWN,

INTERIOR_CONDITION_EXCELLENT,

INTERIOR_CONDITION_TO_REFRESH,

INTERIOR_CONDITION_SMALL_WORKS_TO_BE_PLANNED,

INTERIOR_CONDITION_MAJOR_WORKS_TO_BE_PALLNED,

INTERIOR_CONDITION_BRAND_NEW,

INTERIOR_CONDITION_GOOD_CONDITION,

INTERIOR_CONDITION_TO_BE_RENOVATED

Example:

null

habitation.propertyCondition.renovationYear

number

habitation.propertyCondition.generalConditions

enum<string>[]

Available options:

GENERAL_CONDITION_UNKNOWN,

GENERAL_CONDITION_TO_BE_RENOVATED,

GENERAL_CONDITION_BRAND_NEW,

GENERAL_CONDITION_RENOVATED,

GENERAL_CONDITION_TO_BE_REFRESHED,

GENERAL_CONDITION_GOOD,

GENERAL_CONDITION_EXCELLENT,

GENERAL_CONDITION_DECREPIT,

GENERAL_CONDITION_TO_BE_BUILT

Example:

[]

habitation.roomCount

number

habitation.surface

object

habitation.type

enum<string>

Available options:

PROPERTY_TYPE_UNKNOWN,

PROPERTY_TYPE_STUDIO,

PROPERTY_TYPE_T1,

PROPERTY_TYPE_T1_T2,

PROPERTY_TYPE_T2,

PROPERTY_TYPE_T2_T3,

PROPERTY_TYPE_T3,

PROPERTY_TYPE_T3_4,

PROPERTY_TYPE_T4,

PROPERTY_TYPE_T4_5,

PROPERTY_TYPE_T5_MORE,

PROPERTY_TYPE_LOFT,

PROPERTY_TYPE_DUPLEX,

PROPERTY_TYPE_OTHER_APARTMENT_TYPE,

PROPERTY_TYPE_INDIVIDUAL,

PROPERTY_TYPE_ONE_SIDE_TERRACED,

PROPERTY_TYPE_TWO_SIDE_TERRACED,

PROPERTY_TYPE_SINGLE_STOREY,

PROPERTY_TYPE_TRADITIONAL,

PROPERTY_TYPE_CONTEMPORARY,

PROPERTY_TYPE_BOURGEOIS,

PROPERTY_TYPE_VILLA,

PROPERTY_TYPE_MANOR,

PROPERTY_TYPE_CASTLE,

PROPERTY_TYPE_FARM,

PROPERTY_TYPE_MAS,

PROPERTY_TYPE_BASTIDE,

PROPERTY_TYPE_CHALET,

PROPERTY_TYPE_ANCIENT,

PROPERTY_TYPE_HERITAGE_LISTED,

PROPERTY_TYPE_BUNGALOW

Example:

[]

habitation.wcCount

number

hasAnomaly

boolean

An anomaly or incoherence have been detected

isAuction

boolean

Is this advert an auction

isUrgent

boolean

Is this advert marked as urgent

land

object

Land details of the property

lastModifiedAt

string

Date should be in ISO format (ex: 2022-10-21T11:31:33.593Z)

Example:

"2022-10-21T11:31:33.593Z"

location

object

Location details of the advert

medias

object

Medias of the advert

parking

object

Parking details of the property

scope

enum<string>

Pricing scope of the advert - mensual or onetime

Available options:

PRICING_ONE_OFF,

PRICING_MENSUAL

Example:

null

source

object

Source of the advert

tags

string[]

Unstructured tags of the advert

title

string

Title of the advert as it is on the source

type

enum<string>

Type of the advert

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"

warrantyDeposit

number

Warranty deposit for renting this property

offer

object

Offer details of the advert

mainPropertyAdFlxId

string

FlxId of the first duplicated advert we found for this advertised property

propertyFlxId

string

FlxId of the property this advert is linked to

isOnline

boolean

Is the advert online or not

lastSeenAt

string

Last time we saw this advert

isPro

boolean

Is the seller a professional or not

seller

object

Seller details of the advert

isExclusive

boolean

Is the advert exclusive to the seller

Was this page helpful?

Property

{
  "contactInCharge": {
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "phoneNumber": "<string>",
    "pseudonym": "<string>"
  },
  "currency": null,
  "currentPrice": {
    "value": 123,
    "valuePerArea": 123
  },
  "description": "<string>",
  "firstSeenAt": "2022-10-21T11:31:33.593Z",
  "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,
  "isAuction": true,
  "isUrgent": true,
  "land": {
    "canConstruct": true,
    "hasBuildingPermit": true,
    "hasElectricity": true,
    "hasTelecom": true,
    "hasWater": true,
    "isServiced": true,
    "surface": 123,
    "surfaceConstructable": 123,
    "type": null
  },
  "lastModifiedAt": "2022-10-21T11:31:33.593Z",
  "location": {
    "city": "<string>",
    "cityCoordinate": {
      "location": [
        123
      ]
    },
    "department": "<string>",
    "inseeCode": "<string>",
    "irisCode": "<string>",
    "locationCoordinate": {
      "location": [
        123
      ]
    },
    "postalCode": "<string>"
  },
  "medias": {
    "images": [
      {
        "gaussianHash": "<string>",
        "imageId": "<string>",
        "meanHash": "<string>",
        "perceptualHash": "<string>",
        "url": "<string>"
      }
    ],
    "virtualVisitExternalUrl": [
      "<string>"
    ]
  },
  "parking": {
    "count": 123,
    "numberOfCars": 123,
    "surface": 123,
    "type": null
  },
  "scope": null,
  "source": {
    "flxId": "<string>",
    "url": "<string>",
    "website": "<string>"
  },
  "tags": [
    "<string>"
  ],
  "title": "<string>",
  "type": "CLASS_HOUSE",
  "warrantyDeposit": 123,
  "offer": {
    "isCurrentlyOccupied": true,
    "renting": {
      "isColocation": true,
      "isLongTerm": true,
      "isShortTerm": true,
      "isSubLease": true
    },
    "type": "OFFER_BUY"
  },
  "mainPropertyAdFlxId": "<string>",
  "propertyFlxId": "<string>",
  "isOnline": true,
  "lastSeenAt": "2023-11-07T05:31:56Z",
  "isPro": true,
  "seller": {
    "flxId": "<string>",
    "name": "<string>",
    "siren": "<string>",
    "type": "SELLER_TYPE_AGENCY"
  },
  "isExclusive": true
}

System

Properties

Adverts

RealEstate Companies

Models