Retrieve a property by advert flxId

curl --request GET \
  --url https://api.fluximmo.io/v2/protected/properties/advert/{flxId} \
  --header 'x-api-key: <api-key>'

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

GET

protected

properties

advert

{flxId}

Retrieve a property by advert flxId

curl --request GET \
  --url https://api.fluximmo.io/v2/protected/properties/advert/{flxId} \
  --header 'x-api-key: <api-key>'

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

Authorizations

x-api-key

string

header

required

Path Parameters

flxId

string

required

Response

data

object

Show child attributes

data.adverts

object[]

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

Show child attributes

data.adverts.contactInCharge

object

required

Show child attributes

data.adverts.contactInCharge.email

string

data.adverts.contactInCharge.firstName

string

data.adverts.contactInCharge.lastName

string

data.adverts.contactInCharge.phoneNumber

string

data.adverts.contactInCharge.pseudonym

string

data.adverts.description

string

data.adverts.firstSeenAt

string<date-time>

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

Example:

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

data.adverts.flxId

string

data.adverts.isOnline

boolean

data.adverts.lastSeenAt

string<date-time>

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

Example:

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

data.adverts.location

number[]

Longitude and latitude as an array of number, first longitude then latitude [lng, lat]

data.adverts.medias

object

Show child attributes

data.adverts.medias.images

object[]

Show child attributes

data.adverts.medias.images.gaussianHash

string

required

data.adverts.medias.images.imageId

string

required

data.adverts.medias.images.meanHash

string

required

data.adverts.medias.images.perceptualHash

string

required

data.adverts.medias.images.colorHash

string

required

data.adverts.medias.images.differenceHash

string

required

data.adverts.medias.images.url

string

data.adverts.medias.virtualVisitExternalUrl

string[]

data.adverts.price

object

Show child attributes

data.adverts.price.currency

enum<string>

Available options:

CURRENCY_EUR,

CURRENCY_USD

Example:

null

data.adverts.price.initial

object

The initial price of the property - price of the first advert we found for this property

Show child attributes

data.adverts.price.initial.source

object

Show child attributes

data.adverts.price.initial.source.flxId

string

data.adverts.price.initial.source.url

string

data.adverts.price.initial.source.website

string

data.adverts.price.initial.value

number

data.adverts.price.initial.valuePerArea

number

data.adverts.price.isAuction

boolean

data.adverts.price.latest

object

The latest price of the property - price of the last advert we found for this property

Show child attributes

data.adverts.price.latest.source

object

Show child attributes

data.adverts.price.latest.source.flxId

string

data.adverts.price.latest.source.url

string

data.adverts.price.latest.source.website

string

data.adverts.price.latest.value

number

data.adverts.price.latest.valuePerArea

number

data.adverts.price.scope

enum<string>

Available options:

PRICING_ONE_OFF,

PRICING_MENSUAL

Example:

null

data.adverts.price.warrantyDeposit

number

data.adverts.price.variation

object

The variation of the price between two states of the advert

Show child attributes

data.adverts.price.variation.sinceLastModified

number

The value of the price variation in %

data.adverts.price.variation.sincePublished

number

The value of the price variation in %

data.adverts.price.variation.absoluteSinceLastModified

number

The absolute value of the price variation in %

data.adverts.price.variation.absoluteSincePublished

number

The absolute value of the price variation in %

data.adverts.source

object

Show child attributes

data.adverts.source.flxId

string

data.adverts.source.url

string

data.adverts.source.website

string

data.adverts.title

string

data.adverts.offlineAt

string<date-time>

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

Example:

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

data.adverts.hasAnomaly

boolean

An anomaly or incoherence have been detected

data.adverts.isPro

boolean

data.adverts.seller

object

Show child attributes

data.adverts.seller.flxId

string

data.adverts.seller.name

string

data.adverts.seller.siren

string

data.adverts.seller.type

enum<string>

Available options:

SELLER_TYPE_UNKNOWN,

SELLER_TYPE_AGENCY,

SELLER_TYPE_NETWORK

Example:

"SELLER_TYPE_AGENCY"

data.adverts.isExclusive

boolean

data.description

string

By default, will be the description of the first advert

data.flxId

string

Unique identifier of the property

data.habitation

object

Habitation characteristics of the property

Show child attributes

data.habitation.bathroomCount

number

data.habitation.bedroomCount

number

data.habitation.characteristics

object

Show child attributes

data.habitation.characteristics.hasAlarm

boolean

data.habitation.characteristics.hasBalcony

boolean

data.habitation.characteristics.hasCellar

boolean

data.habitation.characteristics.hasConcierge

boolean

data.habitation.characteristics.hasDigicode

boolean

data.habitation.characteristics.hasFireplace

boolean

data.habitation.characteristics.hasGarage

boolean

data.habitation.characteristics.hasGarden

boolean

data.habitation.characteristics.hasGrenier

boolean

data.habitation.characteristics.hasInterphone

boolean

data.habitation.characteristics.hasJacuzzi

boolean

data.habitation.characteristics.hasLand

boolean

data.habitation.characteristics.hasLift

boolean

data.habitation.characteristics.hasMezzanine

boolean

data.habitation.characteristics.hasParking

boolean

data.habitation.characteristics.hasPool

boolean

data.habitation.characteristics.hasTerrace

boolean

data.habitation.characteristics.hasVisAVis

boolean

data.habitation.characteristics.isPeaceful

boolean

data.habitation.climate

object

The energetic classes of the property (DPE/GES)

Show child attributes

data.habitation.climate.epcClimate

enum<string>

The classification value of the greenhouse gas emission classification - GES

Available options:

GREENHOUSE_CLASSIFICATION_UNKNOWN,

GREENHOUSE_CLASSIFICATION_G,

GREENHOUSE_CLASSIFICATION_F,

GREENHOUSE_CLASSIFICATION_E,

GREENHOUSE_CLASSIFICATION_D,

GREENHOUSE_CLASSIFICATION_C,

GREENHOUSE_CLASSIFICATION_B,

GREENHOUSE_CLASSIFICATION_A,

GREENHOUSE_CLASSIFICATION_NC

Example:

"GREENHOUSE_CLASSIFICATION_C"

data.habitation.climate.epcClimateScore

number

The value of the greenhouse gas emission classification - GES in kgCO2/m²/year

data.habitation.climate.epcEnergy

enum<string>

The classification value of the energy classification - DPE

Available options:

ENERGY_CLASSIFICATION_UNKNOWN,

ENERGY_CLASSIFICATION_G,

ENERGY_CLASSIFICATION_F,

ENERGY_CLASSIFICATION_E,

ENERGY_CLASSIFICATION_D,

ENERGY_CLASSIFICATION_C,

ENERGY_CLASSIFICATION_B,

ENERGY_CLASSIFICATION_A,

ENERGY_CLASSIFICATION_NC

Example:

"ENERGY_CLASSIFICATION_C"

data.habitation.climate.epcEnergyScore

number

The value of the energy classification - DPE in kWhEP/m²/year

data.habitation.climate.epcClimateDate

string<date-time>

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

Example:

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

data.habitation.climate.epcEnergyDate

string<date-time>

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

Example:

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

data.habitation.features

object

Show child attributes

data.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

data.habitation.features.furniture

enum<string>

Available options:

UNKNOWN_FURNITURE,

UNFURNISHED,

PARTIALLY_FURNISHED,

FULLY_FURNISHED

Example:

null

data.habitation.features.propertyFloor

number

data.habitation.features.propertyTotalFloor

number

data.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:

[]

data.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:

[]

data.habitation.features.hasThroughExposure

boolean

data.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:

[]

data.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:

[]

data.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:

[]

data.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:

[]

data.habitation.propertyCondition

object

Show child attributes

data.habitation.propertyCondition.constructionYear

number

data.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

data.habitation.propertyCondition.renovationYear

number

data.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:

[]

data.habitation.roomCount

number

data.habitation.surface

object

Show child attributes

data.habitation.surface.balconies

number

The surface of the balconies in m² - we rarely have this information

data.habitation.surface.floorSpace

number

The surface of the total floors in m² - we rarely have this information

data.habitation.surface.gardens

number

The surface of the gardens in m² - we rarely have this information

data.habitation.surface.groundFloor

number

The surface of the ground floor in m² - we rarely have this information

data.habitation.surface.kitchen

number

The surface of the kitchen in m² - we rarely have this information

data.habitation.surface.livingSpace

number

The surface of the living space in m² - we rarely have this information

data.habitation.surface.livingRoom

number

The surface of the living room in m² - we rarely have this information

data.habitation.surface.terraces

number

The surface of the terraces in m² - we rarely have this information

data.habitation.surface.total

number

The total habitable surface of the property in m²

data.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:

[]

data.habitation.wcCount

number

data.hasAnomaly

boolean

An anomaly or incoherence have been detected

data.isUrgent

boolean

Is the property marked as urgent

data.land

object

Land details of the property

Show child attributes

data.land.canConstruct

boolean

data.land.hasBuildingPermit

boolean

data.land.hasElectricity

boolean

data.land.hasTelecom

boolean

data.land.hasWater

boolean

data.land.isServiced

boolean

data.land.surface

number

data.land.surfaceConstructable

number

data.land.type

enum<string>

Available options:

LAND_UNKNOWN,

LAND_BUILDING_PLOT,

LAND_AGRICULTURAL,

LAND_VINEYARD,

LAND_INDUSTRIAL,

LAND_POND,

LAND_FOREST

Example:

null

data.location

object

Location details of the property

Show child attributes

data.location.city

string

data.location.cityCoordinate

object

The coordinates of the city center

Show child attributes

data.location.cityCoordinate.location

number[]

Longitude and latitude as an array of number, first longitude then latitude [lng, lat]

Example:

[2.3522, 48.8566]

data.location.department

string

data.location.inseeCode

string

data.location.irisCode

string

data.location.locationCoordinate

object

Coordinates of the property - could not be accurate or precise enough

Show child attributes

data.location.locationCoordinate.location

number[]

Longitude and latitude as an array of number, first longitude then latitude [lng, lat]

Example:

[2.3522, 48.8566]

data.location.postalCode

string

data.medias

object

All the medias of the different adverts of the property

Show child attributes

data.medias.images

object[]

Show child attributes

data.medias.images.gaussianHash

string

required

data.medias.images.imageId

string

required

data.medias.images.meanHash

string

required

data.medias.images.perceptualHash

string

required

data.medias.images.colorHash

string

required

data.medias.images.differenceHash

string

required

data.medias.images.url

string

data.medias.virtualVisitExternalUrl

string[]

data.meta

object

Meta data of the property

Show child attributes

data.meta.firstSeenAt

string<date-time>

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

Example:

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

data.meta.isTotallyOffline

boolean

All the adverts of this property are offline - Meaning the property is not available anymore (sold, rented, etc.)

data.meta.lastPublishedAt

string<date-time>

data.meta.lastSeenAt

string<date-time>

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

Example:

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

data.meta.lastUpdatedAt

string<date-time>

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

Example:

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

data.meta.totallyOfflineAt

string<date-time>

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

Example:

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

data.parking

object

Parking details of the property

Show child attributes

data.parking.count

number

data.parking.numberOfCars

number

data.parking.surface

number

data.parking.type

enum<string>

Available options:

PARKING_UNKNOWN,

PARKING_GARAGE,

PARKING_PARKING

Example:

null

data.price

object

Price details of the property

Show child attributes

data.price.currency

enum<string>

Available options:

CURRENCY_EUR,

CURRENCY_USD

Example:

null

data.price.initial

object

The initial price of the property - price of the first advert we found for this property

Show child attributes

data.price.initial.source

object

Show child attributes

data.price.initial.source.flxId

string

data.price.initial.source.url

string

data.price.initial.source.website

string

data.price.initial.value

number

data.price.initial.valuePerArea

number

data.price.isAuction

boolean

data.price.latest

object

The latest price of the property - price of the last advert we found for this property

Show child attributes

data.price.latest.source

object

Show child attributes

data.price.latest.source.flxId

string

data.price.latest.source.url

string

data.price.latest.source.website

string

data.price.latest.value

number

data.price.latest.valuePerArea

number

data.price.scope

enum<string>

Available options:

PRICING_ONE_OFF,

PRICING_MENSUAL

Example:

null

data.price.warrantyDeposit

number

data.price.variation

object

The variation of the price between two states of the advert

Show child attributes

data.price.variation.sinceLastModified

number

The value of the price variation in %

data.price.variation.sincePublished

number

The value of the price variation in %

data.price.variation.absoluteSinceLastModified

number

The absolute value of the price variation in %

data.price.variation.absoluteSincePublished

number

The absolute value of the price variation in %

data.tags

string[]

List of unstructured tags of the property

data.title

string

By default, will be the title of the first advert

data.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"

data.offer

object

Offer information of the property

Show child attributes

data.offer.isCurrentlyOccupied

boolean

The property is sold with someone living in it

data.offer.renting

object

Renting contract details

Show child attributes

data.offer.renting.isColocation

boolean

The offer is for a colocation

data.offer.renting.isLongTerm

boolean

The offer is for long term renting (more than 6 months)

data.offer.renting.isShortTerm

boolean

The offer is for short term renting (less than 6 months)

data.offer.renting.isSubLease

boolean

The offer is for a sublease

data.offer.type

enum<string>

Available options:

OFFER_UNKNOWN,

OFFER_BUY,

OFFER_RENT,

OFFER_BUSINESS_TAKE_OVER,

OFFER_LEASE_BACK,

OFFER_LIFE_ANNUITY_SALE,

OFFER_HOLIDAYS

Example:

"OFFER_BUY"

Retreive properties by their flx_ids Retrieve a property by url

⌘I

System

Properties

Adverts

RealEstate Companies

Models

Retrieve a property by advert flxId

Authorizations

Path Parameters

Response