SearchProperties - Allow to obtain properties with a end-user oriented search-experience.
SearchProperties - Allow to obtain properties with a end-user oriented search-experience.
POST
/
v2
/
property
/
_search
x-api-key
string
*
x-api-key
Required
string
API Key used to be authentified to these APIs. Please contact Fluximmo to get one
Search ยท object
*
search
object
search
object
fullTexts
array
fullTexts
array
keywords
array
keywords
array
filterProperty
object
filterProperty
object
indexTimestamp
array
indexTimestamp
array
meta
object
meta
object
firstSeenAt
object
firstSeenAt
object
min
string
min
string
max
string
max
string
lastUpdatedAt
object
lastUpdatedAt
object
min
string
min
string
max
string
max
string
firstPublishedAt
object
firstPublishedAt
object
min
string
min
string
max
string
max
string
lastPublishedAt
object
lastPublishedAt
object
min
string
min
string
max
string
max
string
lastSeenAt
object
lastSeenAt
object
min
string
min
string
max
string
max
string
isTotallyOffline
boolean
isTotallyOffline
boolean
tags
array
tags
array
isUrgent
boolean
isUrgent
boolean
offer
array
offer
array
type
array
type
array
process
array
process
array
price
object
price
object
latest
object
latest
object
value
object
value
object
min
integer
min
integer
max
integer
max
integer
valuePerArea
object
valuePerArea
object
min
integer
min
integer
max
integer
max
integer
source
object
source
object
website
string
website
string
url
string
url
string
flxId
string
flxId
string
lowest
object
lowest
object
value
object
value
object
min
integer
min
integer
max
integer
max
integer
valuePerArea
object
valuePerArea
object
min
integer
min
integer
max
integer
max
integer
source
object
source
object
website
string
website
string
url
string
url
string
flxId
string
flxId
string
highest
object
highest
object
value
object
value
object
min
integer
min
integer
max
integer
max
integer
valuePerArea
object
valuePerArea
object
min
integer
min
integer
max
integer
max
integer
source
object
source
object
website
string
website
string
url
string
url
string
flxId
string
flxId
string
initial
object
initial
object
value
object
value
object
min
integer
min
integer
max
integer
max
integer
valuePerArea
object
valuePerArea
object
min
integer
min
integer
max
integer
max
integer
source
object
source
object
website
string
website
string
url
string
url
string
flxId
string
flxId
string
warrantyDeposit
object
warrantyDeposit
object
min
integer
min
integer
max
integer
max
integer
charges
object
charges
object
yearlyRentalFees
number
yearlyRentalFees
number
yearlyCondoniumFees
number
yearlyCondoniumFees
number
yearlyHeatingFees
number
yearlyHeatingFees
number
yearlyElectricityFees
number
yearlyElectricityFees
number
yearlyHousingTax
number
yearlyHousingTax
number
yearlyLivingTax
number
yearlyLivingTax
number
monthlyRentSupplement
number
monthlyRentSupplement
number
isAuction
boolean
isAuction
boolean
scope
array
scope
array
currency
array
currency
array
variation
array
variation
array
habitation
object
habitation
object
type
enum<string>
type
enum<string>
roomCount
object
roomCount
object
min
integer
min
integer
max
integer
max
integer
bedroomCount
object
bedroomCount
object
min
integer
min
integer
max
integer
max
integer
bathroomCount
object
bathroomCount
object
min
integer
min
integer
max
integer
max
integer
wcCount
object
wcCount
object
min
integer
min
integer
max
integer
max
integer
roomsDetails
array
roomsDetails
array
heatTypes
array
heatTypes
array
heatTypeDetails
array
heatTypeDetails
array
heatings
array
heatings
array
kitchenEquipped
array
kitchenEquipped
array
features
object
features
object
propertyTotalFloor
object
propertyTotalFloor
object
min
integer
min
integer
max
integer
max
integer
propertyFloor
object
propertyFloor
object
min
integer
min
integer
max
integer
max
integer
viewTypes
array
viewTypes
array
exposure
array
exposure
array
furniture
array
furniture
array
constructionMaterials
array
constructionMaterials
array
viewOns
array
viewOns
array
glazingTypes
array
glazingTypes
array
hasThroughExposure
boolean
hasThroughExposure
boolean
characteristics
object
characteristics
object
hasLift
boolean
hasLift
boolean
hasCellar
boolean
hasCellar
boolean
hasBalcony
boolean
hasBalcony
boolean
hasTerrace
boolean
hasTerrace
boolean
hasGarden
boolean
hasGarden
boolean
hasFireplace
boolean
hasFireplace
boolean
hasGrenier
boolean
hasGrenier
boolean
hasPool
boolean
hasPool
boolean
hasParking
boolean
hasParking
boolean
hasGarage
boolean
hasGarage
boolean
hasLand
boolean
hasLand
boolean
hasConcierge
boolean
hasConcierge
boolean
hasDigicode
boolean
hasDigicode
boolean
hasInterphone
boolean
hasInterphone
boolean
hasAlarm
boolean
hasAlarm
boolean
hasVisAVis
boolean
hasVisAVis
boolean
isPeaceful
boolean
isPeaceful
boolean
hasMezzanine
boolean
hasMezzanine
boolean
hasJacuzzi
boolean
hasJacuzzi
boolean
climate
object
climate
object
epcEnergy
array
epcEnergy
array
epcClimate
array
epcClimate
array
epcEnergyScore
object
epcEnergyScore
object
min
integer
min
integer
max
integer
max
integer
epcClimateScore
object
epcClimateScore
object
min
integer
min
integer
max
integer
max
integer
epcClimateDate
object
epcClimateDate
object
min
string
min
string
max
string
max
string
epcEnergyDate
object
epcEnergyDate
object
min
string
min
string
max
string
max
string
propertyCondition
array
propertyCondition
array
surface
object
surface
object
total
object
total
object
min
integer
min
integer
max
integer
max
integer
livingSpace
object
livingSpace
object
min
integer
min
integer
max
integer
max
integer
floorSpace
object
floorSpace
object
min
integer
min
integer
max
integer
max
integer
livingroom
object
livingroom
object
min
integer
min
integer
max
integer
max
integer
kitchen
object
kitchen
object
min
integer
min
integer
max
integer
max
integer
groundFloor
object
groundFloor
object
min
integer
min
integer
max
integer
max
integer
balconies
object
balconies
object
min
integer
min
integer
max
integer
max
integer
terraces
object
terraces
object
min
integer
min
integer
max
integer
max
integer
gardens
object
gardens
object
min
integer
min
integer
max
integer
max
integer
parking
object
parking
object
type
array
type
array
count
object
count
object
min
integer
min
integer
max
integer
max
integer
numberOfCars
object
numberOfCars
object
min
integer
min
integer
max
integer
max
integer
surface
object
surface
object
min
integer
min
integer
max
integer
max
integer
land
object
land
object
type
array
type
array
haveBuildingPermit
boolean
haveBuildingPermit
boolean
canConstruct
boolean
canConstruct
boolean
surfaceConstructable
object
surfaceConstructable
object
min
integer
min
integer
max
integer
max
integer
surface
object
surface
object
min
integer
min
integer
max
integer
max
integer
isServiced
boolean
isServiced
boolean
haveWater
boolean
haveWater
boolean
haveElectricity
boolean
haveElectricity
boolean
haveTelecom
boolean
haveTelecom
boolean
location
array
location
array
history
array
history
array
adverts
array
adverts
array
isCityCenter
boolean
isCityCenter
boolean
hasAnomaly
boolean
hasAnomaly
boolean
estimatedPrice
object
estimatedPrice
object
value
object
value
object
min
integer
min
integer
max
integer
max
integer
valuePerArea
object
valuePerArea
object
min
integer
min
integer
max
integer
max
integer
source
object
source
object
website
string
website
string
url
string
url
string
flxId
string
flxId
string
imagesLength
object
imagesLength
object
min
integer
min
integer
max
integer
max
integer
advertsLength
object
advertsLength
object
min
integer
min
integer
max
integer
max
integer
historyLength
object
historyLength
object
min
integer
min
integer
max
integer
max
integer
anomalies
array
anomalies
array
searchAfter
array
searchAfter
array
sortBy
enum<string>
sortBy
enum<string>
orderBy
enum<string>
orderBy
enum<string>
size
integer
size
integer
excludedFields
array
excludedFields
array
includedFields
array
includedFields
array
Authorizations
x-api-key
string
headerrequiredAPI Key used to be authentified to these APIs. Please contact Fluximmo to get one
Body
application/json
search
object
search.fullTexts
string[]
search.keywords
string[]
search.filterProperty
object
search.filterProperty.indexTimestamp
object[]
search.filterProperty.indexTimestamp.min
string
search.filterProperty.indexTimestamp.max
string
search.filterProperty.meta
object
search.filterProperty.meta.firstSeenAt
object
search.filterProperty.meta.firstSeenAt.min
string
search.filterProperty.meta.firstSeenAt.max
string
search.filterProperty.meta.lastUpdatedAt
object
search.filterProperty.meta.lastUpdatedAt.min
string
search.filterProperty.meta.lastUpdatedAt.max
string
search.filterProperty.meta.firstPublishedAt
object
search.filterProperty.meta.firstPublishedAt.min
string
search.filterProperty.meta.firstPublishedAt.max
string
search.filterProperty.meta.lastPublishedAt
object
search.filterProperty.meta.lastPublishedAt.min
string
search.filterProperty.meta.lastPublishedAt.max
string
search.filterProperty.meta.lastSeenAt
object
search.filterProperty.meta.lastSeenAt.min
string
search.filterProperty.meta.lastSeenAt.max
string
search.filterProperty.meta.isTotallyOffline
boolean
search.filterProperty.tags
string[]
search.filterProperty.isUrgent
boolean
search.filterProperty.offer
object[]
search.filterProperty.offer.type
enum<string>
default: OFFER_UNKNOWNAvailable options:
OFFER_UNKNOWN, OFFER_BUY, OFFER_RENT, OFFER_BUSINESS_TAKE_OVER, OFFER_LEASE_BACK, OFFER_LIFE_ANNUITY_SALE, OFFER_HOLIDAYS search.filterProperty.offer.renting
object
search.filterProperty.offer.renting.isSubLease
boolean
search.filterProperty.offer.renting.isShortTerm
boolean
search.filterProperty.offer.renting.isLongTerm
boolean
search.filterProperty.offer.renting.isColocation
boolean
search.filterProperty.offer.isCurrentlyOccupied
boolean
search.filterProperty.type
enum<string>[]
Available options:
CLASS_UNKNOWN, CLASS_HOUSE, CLASS_FLAT, CLASS_PROGRAM, CLASS_SHOP, CLASS_PREMISES, CLASS_OFFICE, CLASS_LAND, CLASS_BUILDING, CLASS_PARKING search.filterProperty.process
enum<string>[]
Available options:
PROCESS_UNKNOWN, PROCESS_AVAILABLE_ON_MARKET, PROCESS_UNDER_COMPROMISE, PROCESS_RENTED_SOLD, PROCESS_REMOVED, PROCESS_RESERVED, PROCESS_ARCHIVED search.filterProperty.price
object
search.filterProperty.price.latest
object
search.filterProperty.price.latest.value
object
search.filterProperty.price.latest.value.min
integer
search.filterProperty.price.latest.value.max
integer
search.filterProperty.price.latest.valuePerArea
object
search.filterProperty.price.latest.valuePerArea.min
integer
search.filterProperty.price.latest.valuePerArea.max
integer
search.filterProperty.price.latest.source
object
search.filterProperty.price.latest.source.website
string
search.filterProperty.price.latest.source.url
string
search.filterProperty.price.latest.source.flxId
string
search.filterProperty.price.lowest
object
search.filterProperty.price.lowest.value
object
search.filterProperty.price.lowest.value.min
integer
search.filterProperty.price.lowest.value.max
integer
search.filterProperty.price.lowest.valuePerArea
object
search.filterProperty.price.lowest.valuePerArea.min
integer
search.filterProperty.price.lowest.valuePerArea.max
integer
search.filterProperty.price.lowest.source
object
search.filterProperty.price.lowest.source.website
string
search.filterProperty.price.lowest.source.url
string
search.filterProperty.price.lowest.source.flxId
string
search.filterProperty.price.highest
object
search.filterProperty.price.highest.value
object
search.filterProperty.price.highest.value.min
integer
search.filterProperty.price.highest.value.max
integer
search.filterProperty.price.highest.valuePerArea
object
search.filterProperty.price.highest.valuePerArea.min
integer
search.filterProperty.price.highest.valuePerArea.max
integer
search.filterProperty.price.highest.source
object
search.filterProperty.price.highest.source.website
string
search.filterProperty.price.highest.source.url
string
search.filterProperty.price.highest.source.flxId
string
search.filterProperty.price.initial
object
search.filterProperty.price.initial.value
object
search.filterProperty.price.initial.value.min
integer
search.filterProperty.price.initial.value.max
integer
search.filterProperty.price.initial.valuePerArea
object
search.filterProperty.price.initial.valuePerArea.min
integer
search.filterProperty.price.initial.valuePerArea.max
integer
search.filterProperty.price.initial.source
object
search.filterProperty.price.initial.source.website
string
search.filterProperty.price.initial.source.url
string
search.filterProperty.price.initial.source.flxId
string
search.filterProperty.price.warrantyDeposit
object
search.filterProperty.price.warrantyDeposit.min
integer
search.filterProperty.price.warrantyDeposit.max
integer
search.filterProperty.price.charges
object
search.filterProperty.price.charges.yearlyRentalFees
number
search.filterProperty.price.charges.yearlyCondoniumFees
number
search.filterProperty.price.charges.yearlyHeatingFees
number
search.filterProperty.price.charges.yearlyElectricityFees
number
search.filterProperty.price.charges.yearlyHousingTax
number
search.filterProperty.price.charges.yearlyLivingTax
number
search.filterProperty.price.charges.monthlyRentSupplement
number
search.filterProperty.price.isAuction
boolean
search.filterProperty.price.scope
enum<string>[]
Available options:
PRICING_ONE_OFF, PRICING_MENSUAL search.filterProperty.price.currency
enum<string>[]
Available options:
CURRENCY_EUR, CURRENCY_USD search.filterProperty.price.variation
object[]
search.filterProperty.price.variation.sincePublished
object
search.filterProperty.price.variation.sincePublished.min
number
search.filterProperty.price.variation.sincePublished.max
number
search.filterProperty.price.variation.sinceLastModified
object
search.filterProperty.price.variation.sinceLastModified.min
number
search.filterProperty.price.variation.sinceLastModified.max
number
search.filterProperty.habitation
object
search.filterProperty.habitation.type
enum<string>
default: PROPERTY_TYPE_UNKNOWNAvailable 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_INDIVIDUAL, 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, PROPERTY_TYPE_STUDETTE search.filterProperty.habitation.roomCount
object
search.filterProperty.habitation.roomCount.min
integer
search.filterProperty.habitation.roomCount.max
integer
search.filterProperty.habitation.bedroomCount
object
search.filterProperty.habitation.bedroomCount.min
integer
search.filterProperty.habitation.bedroomCount.max
integer
search.filterProperty.habitation.bathroomCount
object
search.filterProperty.habitation.bathroomCount.min
integer
search.filterProperty.habitation.bathroomCount.max
integer
search.filterProperty.habitation.wcCount
object
search.filterProperty.habitation.wcCount.min
integer
search.filterProperty.habitation.wcCount.max
integer
search.filterProperty.habitation.roomsDetails
object[]
search.filterProperty.habitation.roomsDetails.roomType
enum<string>
default: ROOM_TYPE_UNKNOWNAvailable options:
ROOM_TYPE_UNKNOWN, ROOM_TYPE_MASTER_BEDROOM, ROOM_TYPE_BEDROOM, ROOM_TYPE_KITCHEN, ROOM_TYPE_LIVING_ROOM, ROOM_TYPE_OFFICE search.filterProperty.habitation.roomsDetails.area
number
search.filterProperty.habitation.roomsDetails.floor
integer
search.filterProperty.habitation.roomsDetails.contextInfo
string[]
search.filterProperty.habitation.heatTypes
enum<string>[]
Available options:
HEAT_TYPE_UNKNOWN, HEAT_TYPE_INDIVIDUAL, HEAT_TYPE_SHARED, HEAT_TYPE_MIXED, HEAT_TYPE_CITY, HEAT_TYPE_CISTERN search.filterProperty.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_RADIANTS_TUBES, HEAT_DETAIL_RADIATOR, HEAT_DETAIL_SHEATHS, HEAT_DETAIL_CONVECTOR search.filterProperty.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 search.filterProperty.habitation.kitchenEquipped
enum<string>[]
Available options:
KITCHEN_UNKNOWN_EQUIPPED, KITCHEN_NON_EQUIPPED, KITCHEN_PARTIALLY_EQUIPPED, KITCHEN_FULLY_EQUIPPED, KITCHEN_FURNISHED, KITCHEN_NAKED, KITCHEN_EQUIPPED_FURNISHED search.filterProperty.habitation.features
object
search.filterProperty.habitation.features.propertyTotalFloor
object
search.filterProperty.habitation.features.propertyTotalFloor.min
integer
search.filterProperty.habitation.features.propertyTotalFloor.max
integer
search.filterProperty.habitation.features.propertyFloor
object
search.filterProperty.habitation.features.propertyFloor.min
integer
search.filterProperty.habitation.features.propertyFloor.max
integer
search.filterProperty.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 search.filterProperty.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 search.filterProperty.habitation.features.furniture
enum<string>[]
Available options:
UNKNOWN_FURNITURE, UNFURNISHED, PARTIALLY_FURNISHED, FULLY_FURNISHED search.filterProperty.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 search.filterProperty.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 search.filterProperty.habitation.features.glazingTypes
enum<string>[]
Available options:
GLAZING_TYPE_UNKNOWN, GLAZING_TYPE_SIMPLE, GLAZING_TYPE_DOUBLE, GLAZING_TYPE_TRIPLE search.filterProperty.habitation.features.hasThroughExposure
boolean
search.filterProperty.habitation.characteristics
object
search.filterProperty.habitation.characteristics.hasLift
boolean
search.filterProperty.habitation.characteristics.hasCellar
boolean
search.filterProperty.habitation.characteristics.hasBalcony
boolean
search.filterProperty.habitation.characteristics.hasTerrace
boolean
search.filterProperty.habitation.characteristics.hasGarden
boolean
search.filterProperty.habitation.characteristics.hasFireplace
boolean
search.filterProperty.habitation.characteristics.hasGrenier
boolean
search.filterProperty.habitation.characteristics.hasPool
boolean
search.filterProperty.habitation.characteristics.hasParking
boolean
search.filterProperty.habitation.characteristics.hasGarage
boolean
search.filterProperty.habitation.characteristics.hasLand
boolean
search.filterProperty.habitation.characteristics.hasConcierge
boolean
search.filterProperty.habitation.characteristics.hasDigicode
boolean
search.filterProperty.habitation.characteristics.hasInterphone
boolean
search.filterProperty.habitation.characteristics.hasAlarm
boolean
search.filterProperty.habitation.characteristics.hasVisAVis
boolean
search.filterProperty.habitation.characteristics.isPeaceful
boolean
search.filterProperty.habitation.characteristics.hasMezzanine
boolean
search.filterProperty.habitation.characteristics.hasJacuzzi
boolean
search.filterProperty.habitation.climate
object
search.filterProperty.habitation.climate.epcEnergy
enum<string>[]
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 search.filterProperty.habitation.climate.epcClimate
enum<string>[]
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 search.filterProperty.habitation.climate.epcEnergyScore
object
search.filterProperty.habitation.climate.epcEnergyScore.min
integer
search.filterProperty.habitation.climate.epcEnergyScore.max
integer
search.filterProperty.habitation.climate.epcClimateScore
object
search.filterProperty.habitation.climate.epcClimateScore.min
integer
search.filterProperty.habitation.climate.epcClimateScore.max
integer
search.filterProperty.habitation.climate.epcClimateDate
object
search.filterProperty.habitation.climate.epcClimateDate.min
string
search.filterProperty.habitation.climate.epcClimateDate.max
string
search.filterProperty.habitation.climate.epcEnergyDate
object
search.filterProperty.habitation.climate.epcEnergyDate.min
string
search.filterProperty.habitation.climate.epcEnergyDate.max
string
search.filterProperty.habitation.propertyCondition
object[]
search.filterProperty.habitation.propertyCondition.interiorCondition
enum<string>
default: INTERIOR_CONDITION_UNKNOWNAvailable 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 search.filterProperty.habitation.propertyCondition.constructionYear
integer
search.filterProperty.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 search.filterProperty.habitation.propertyCondition.renovationYear
integer
search.filterProperty.habitation.surface
object
search.filterProperty.habitation.surface.total
object
search.filterProperty.habitation.surface.total.min
integer
search.filterProperty.habitation.surface.total.max
integer
search.filterProperty.habitation.surface.livingSpace
object
search.filterProperty.habitation.surface.livingSpace.min
integer
search.filterProperty.habitation.surface.livingSpace.max
integer
search.filterProperty.habitation.surface.floorSpace
object
search.filterProperty.habitation.surface.floorSpace.min
integer
search.filterProperty.habitation.surface.floorSpace.max
integer
search.filterProperty.habitation.surface.livingroom
object
search.filterProperty.habitation.surface.livingroom.min
integer
search.filterProperty.habitation.surface.livingroom.max
integer
search.filterProperty.habitation.surface.kitchen
object
search.filterProperty.habitation.surface.kitchen.min
integer
search.filterProperty.habitation.surface.kitchen.max
integer
search.filterProperty.habitation.surface.groundFloor
object
search.filterProperty.habitation.surface.groundFloor.min
integer
search.filterProperty.habitation.surface.groundFloor.max
integer
search.filterProperty.habitation.surface.balconies
object
search.filterProperty.habitation.surface.balconies.min
integer
search.filterProperty.habitation.surface.balconies.max
integer
search.filterProperty.habitation.surface.terraces
object
search.filterProperty.habitation.surface.terraces.min
integer
search.filterProperty.habitation.surface.terraces.max
integer
search.filterProperty.habitation.surface.gardens
object
search.filterProperty.habitation.surface.gardens.min
integer
search.filterProperty.habitation.surface.gardens.max
integer
search.filterProperty.parking
object
search.filterProperty.parking.type
enum<string>[]
Available options:
PARKING_UNKNOWN, PARKING_GARAGE, PARKING_PARKING search.filterProperty.parking.count
object
search.filterProperty.parking.count.min
integer
search.filterProperty.parking.count.max
integer
search.filterProperty.parking.numberOfCars
object
search.filterProperty.parking.numberOfCars.min
integer
search.filterProperty.parking.numberOfCars.max
integer
search.filterProperty.parking.surface
object
search.filterProperty.parking.surface.min
integer
search.filterProperty.parking.surface.max
integer
search.filterProperty.land
object
search.filterProperty.land.type
enum<string>[]
Available options:
LAND_UNKNOWN, LAND_BUILDING_PLOT, LAND_AGRICULTURAL, LAND_VINEYARD, LAND_INDUSTRIAL, LAND_POND, LAND_FOREST search.filterProperty.land.haveBuildingPermit
boolean
search.filterProperty.land.canConstruct
boolean
search.filterProperty.land.surfaceConstructable
object
search.filterProperty.land.surfaceConstructable.min
integer
search.filterProperty.land.surfaceConstructable.max
integer
search.filterProperty.land.surface
object
search.filterProperty.land.surface.min
integer
search.filterProperty.land.surface.max
integer
search.filterProperty.land.isServiced
boolean
search.filterProperty.land.haveWater
boolean
search.filterProperty.land.haveElectricity
boolean
search.filterProperty.land.haveTelecom
boolean
search.filterProperty.location
object[]
search.filterProperty.location.address
object
search.filterProperty.location.address.number
string
search.filterProperty.location.address.streetName
string
search.filterProperty.location.postalCode
string
search.filterProperty.location.inseeCode
string
search.filterProperty.location.irisCode
string
search.filterProperty.location.department
string
search.filterProperty.location.city
string
search.filterProperty.location.locationCoordinate
object
search.filterProperty.location.locationCoordinate.location
object
search.filterProperty.location.locationCoordinate.location.preregisteredShape
object
Shape which has already been stored inside fluximmo services. This is particularly useful for when you have a pre-defined list of shapes and you want to reference the list using a logical name (for example Ile-de-France) rather than having to provide coordinates each time.
search.filterProperty.location.locationCoordinate.location.preregisteredShape.index
enum<string>
Available options:
UNKNOWN_GEO_INDEX, DEPARTMENT_GEO_INDEX, CITY_GEO_INDEX, REGION_GEO_INDEX search.filterProperty.location.locationCoordinate.location.preregisteredShape.id
string
search.filterProperty.location.locationCoordinate.location.geoDistance
object
Matches geopoint values within a given distance of a geopoint (pin).
search.filterProperty.location.locationCoordinate.location.geoDistance.distanceKm
number
search.filterProperty.location.locationCoordinate.location.geoDistance.pin
object
search.filterProperty.location.locationCoordinate.location.geoDistance.pin.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
search.filterProperty.location.locationCoordinate.location.geoDistance.pin.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
search.filterProperty.location.locationCoordinate.location.geoBoundingBox
object
Use a geo_bounding_box filter to match geo_point values that intersect a bounding box. To define the box, provide geopoint values for two opposite corners.
search.filterProperty.location.locationCoordinate.location.geoBoundingBox.topLeft
object
search.filterProperty.location.locationCoordinate.location.geoBoundingBox.topLeft.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
search.filterProperty.location.locationCoordinate.location.geoBoundingBox.topLeft.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
search.filterProperty.location.locationCoordinate.location.geoBoundingBox.bottomRight
object
search.filterProperty.location.locationCoordinate.location.geoBoundingBox.bottomRight.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
search.filterProperty.location.locationCoordinate.location.geoBoundingBox.bottomRight.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
search.filterProperty.location.locationCoordinate.location.geoShape
object
Filter documents indexed using. The behaviour of the GeoShape query depends on the type and relation defined. This have the same specs as the GeoJson RFC 7946 (read more here: https://geojson.org/)
search.filterProperty.location.locationCoordinate.location.geoShape.relation
enum<string>
Available options:
UNKNOWN_SPATIAL_RELATION, WITHIN, CONTAINS, DISJOINT, INTERSECTS search.filterProperty.location.locationCoordinate.location.geoShape.type
enum<string>
Available options:
UNKNOWN_GEO_SHAPE_TYPE, POINT, LINE_STRING, POLYGON, MULTI_POINT, MULTI_LINE_STRING search.filterProperty.location.locationCoordinate.location.geoShape.coordinates
object[]
search.filterProperty.location.locationCoordinate.location.geoShape.coordinates.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
search.filterProperty.location.locationCoordinate.location.geoShape.coordinates.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
search.filterProperty.location.locationCoordinate.location.geoInseeCodeDistance
object
Matches geopoint values within a given distance of a insee code.
search.filterProperty.location.locationCoordinate.location.geoInseeCodeDistance.distanceKm
number
search.filterProperty.location.locationCoordinate.location.geoInseeCodeDistance.inseeCode
string
search.filterProperty.location.locationCoordinate.h3Indices
object
Hierarchical Geobased data-representation. This create a grid of the world with a certain level of details depending on the actual picked index. Please see more here: https://h3geo.org/docs/core-library/restable
search.filterProperty.location.locationCoordinate.h3Indices.h3Index1
string
search.filterProperty.location.locationCoordinate.h3Indices.h3Index2
string
search.filterProperty.location.locationCoordinate.h3Indices.h3Index3
string
search.filterProperty.location.locationCoordinate.h3Indices.h3Index4
string
search.filterProperty.location.locationCoordinate.h3Indices.h3Index5
string
search.filterProperty.location.locationCoordinate.h3Indices.h3Index6
string
search.filterProperty.location.locationCoordinate.h3Indices.h3Index7
string
search.filterProperty.location.locationCoordinate.h3Indices.h3Index8
string
search.filterProperty.location.locationCoordinate.h3Indices.h3Index9
string
search.filterProperty.location.locationCoordinate.h3Indices.h3Index10
string
search.filterProperty.location.locationCoordinate.h3Indices.h3Index11
string
search.filterProperty.location.locationCoordinate.h3Indices.h3Index12
string
search.filterProperty.location.cityCoordinate
object
search.filterProperty.location.cityCoordinate.location
object
search.filterProperty.location.cityCoordinate.location.preregisteredShape
object
Shape which has already been stored inside fluximmo services. This is particularly useful for when you have a pre-defined list of shapes and you want to reference the list using a logical name (for example Ile-de-France) rather than having to provide coordinates each time.
search.filterProperty.location.cityCoordinate.location.preregisteredShape.index
enum<string>
Available options:
UNKNOWN_GEO_INDEX, DEPARTMENT_GEO_INDEX, CITY_GEO_INDEX, REGION_GEO_INDEX search.filterProperty.location.cityCoordinate.location.preregisteredShape.id
string
search.filterProperty.location.cityCoordinate.location.geoDistance
object
Matches geopoint values within a given distance of a geopoint (pin).
search.filterProperty.location.cityCoordinate.location.geoDistance.distanceKm
number
search.filterProperty.location.cityCoordinate.location.geoDistance.pin
object
search.filterProperty.location.cityCoordinate.location.geoDistance.pin.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
search.filterProperty.location.cityCoordinate.location.geoDistance.pin.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
search.filterProperty.location.cityCoordinate.location.geoBoundingBox
object
Use a geo_bounding_box filter to match geo_point values that intersect a bounding box. To define the box, provide geopoint values for two opposite corners.
search.filterProperty.location.cityCoordinate.location.geoBoundingBox.topLeft
object
search.filterProperty.location.cityCoordinate.location.geoBoundingBox.topLeft.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
search.filterProperty.location.cityCoordinate.location.geoBoundingBox.topLeft.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
search.filterProperty.location.cityCoordinate.location.geoBoundingBox.bottomRight
object
search.filterProperty.location.cityCoordinate.location.geoBoundingBox.bottomRight.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
search.filterProperty.location.cityCoordinate.location.geoBoundingBox.bottomRight.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
search.filterProperty.location.cityCoordinate.location.geoShape
object
Filter documents indexed using. The behaviour of the GeoShape query depends on the type and relation defined. This have the same specs as the GeoJson RFC 7946 (read more here: https://geojson.org/)
search.filterProperty.location.cityCoordinate.location.geoShape.relation
enum<string>
Available options:
UNKNOWN_SPATIAL_RELATION, WITHIN, CONTAINS, DISJOINT, INTERSECTS search.filterProperty.location.cityCoordinate.location.geoShape.type
enum<string>
Available options:
UNKNOWN_GEO_SHAPE_TYPE, POINT, LINE_STRING, POLYGON, MULTI_POINT, MULTI_LINE_STRING search.filterProperty.location.cityCoordinate.location.geoShape.coordinates
object[]
search.filterProperty.location.cityCoordinate.location.geoShape.coordinates.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
search.filterProperty.location.cityCoordinate.location.geoShape.coordinates.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
search.filterProperty.location.cityCoordinate.location.geoInseeCodeDistance
object
Matches geopoint values within a given distance of a insee code.
search.filterProperty.location.cityCoordinate.location.geoInseeCodeDistance.distanceKm
number
search.filterProperty.location.cityCoordinate.location.geoInseeCodeDistance.inseeCode
string
search.filterProperty.location.cityCoordinate.h3Indices
object
Hierarchical Geobased data-representation. This create a grid of the world with a certain level of details depending on the actual picked index. Please see more here: https://h3geo.org/docs/core-library/restable
search.filterProperty.location.cityCoordinate.h3Indices.h3Index1
string
search.filterProperty.location.cityCoordinate.h3Indices.h3Index2
string
search.filterProperty.location.cityCoordinate.h3Indices.h3Index3
string
search.filterProperty.location.cityCoordinate.h3Indices.h3Index4
string
search.filterProperty.location.cityCoordinate.h3Indices.h3Index5
string
search.filterProperty.location.cityCoordinate.h3Indices.h3Index6
string
search.filterProperty.location.cityCoordinate.h3Indices.h3Index7
string
search.filterProperty.location.cityCoordinate.h3Indices.h3Index8
string
search.filterProperty.location.cityCoordinate.h3Indices.h3Index9
string
search.filterProperty.location.cityCoordinate.h3Indices.h3Index10
string
search.filterProperty.location.cityCoordinate.h3Indices.h3Index11
string
search.filterProperty.location.cityCoordinate.h3Indices.h3Index12
string
search.filterProperty.history
object[]
search.filterProperty.history.seenAt
object
search.filterProperty.history.seenAt.min
string
search.filterProperty.history.seenAt.max
string
search.filterProperty.history.price
object
search.filterProperty.history.price.min
integer
search.filterProperty.history.price.max
integer
search.filterProperty.history.pricePerArea
object
search.filterProperty.history.pricePerArea.min
integer
search.filterProperty.history.pricePerArea.max
integer
search.filterProperty.history.nbDaysPublished
object
search.filterProperty.history.nbDaysPublished.min
integer
search.filterProperty.history.nbDaysPublished.max
integer
search.filterProperty.history.source
object
search.filterProperty.history.source.website
string
search.filterProperty.history.source.url
string
search.filterProperty.history.source.flxId
string
search.filterProperty.adverts
object[]
search.filterProperty.adverts.flxId
string[]
search.filterProperty.adverts.isPro
boolean
search.filterProperty.adverts.seller
object[]
search.filterProperty.adverts.seller.type
enum<string>
default: SELLER_TYPE_UNKNOWNAvailable options:
SELLER_TYPE_UNKNOWN, SELLER_TYPE_AGENCY, SELLER_TYPE_NETWORK search.filterProperty.adverts.seller.flxId
string
search.filterProperty.adverts.seller.name
string
search.filterProperty.adverts.seller.siren
string
search.filterProperty.adverts.contactInCharge
object
search.filterProperty.adverts.contactInCharge.firstName
string
search.filterProperty.adverts.contactInCharge.lastName
string
search.filterProperty.adverts.contactInCharge.phoneNumber
string
search.filterProperty.adverts.contactInCharge.email
string
search.filterProperty.adverts.contactInCharge.pseudonym
string
search.filterProperty.adverts.source
object
search.filterProperty.adverts.source.website
string
search.filterProperty.adverts.source.url
string
search.filterProperty.adverts.source.flxId
string
search.filterProperty.adverts.title
string[]
search.filterProperty.adverts.description
string[]
search.filterProperty.adverts.isOnline
boolean
search.filterProperty.adverts.firstSeenAt
object
search.filterProperty.adverts.firstSeenAt.min
string
search.filterProperty.adverts.firstSeenAt.max
string
search.filterProperty.adverts.lastUpdatedAt
object
search.filterProperty.adverts.lastUpdatedAt.min
string
search.filterProperty.adverts.lastUpdatedAt.max
string
search.filterProperty.adverts.firstPublishedAt
object
search.filterProperty.adverts.firstPublishedAt.min
string
search.filterProperty.adverts.firstPublishedAt.max
string
search.filterProperty.adverts.lastSeenAt
object
search.filterProperty.adverts.lastSeenAt.min
string
search.filterProperty.adverts.lastSeenAt.max
string
search.filterProperty.adverts.price
object
search.filterProperty.adverts.price.latest
object
search.filterProperty.adverts.price.latest.value
object
search.filterProperty.adverts.price.latest.value.min
integer
search.filterProperty.adverts.price.latest.value.max
integer
search.filterProperty.adverts.price.latest.valuePerArea
object
search.filterProperty.adverts.price.latest.valuePerArea.min
integer
search.filterProperty.adverts.price.latest.valuePerArea.max
integer
search.filterProperty.adverts.price.latest.source
object
search.filterProperty.adverts.price.latest.source.website
string
search.filterProperty.adverts.price.latest.source.url
string
search.filterProperty.adverts.price.latest.source.flxId
string
search.filterProperty.adverts.price.lowest
object
search.filterProperty.adverts.price.lowest.value
object
search.filterProperty.adverts.price.lowest.value.min
integer
search.filterProperty.adverts.price.lowest.value.max
integer
search.filterProperty.adverts.price.lowest.valuePerArea
object
search.filterProperty.adverts.price.lowest.valuePerArea.min
integer
search.filterProperty.adverts.price.lowest.valuePerArea.max
integer
search.filterProperty.adverts.price.lowest.source
object
search.filterProperty.adverts.price.lowest.source.website
string
search.filterProperty.adverts.price.lowest.source.url
string
search.filterProperty.adverts.price.lowest.source.flxId
string
search.filterProperty.adverts.price.highest
object
search.filterProperty.adverts.price.highest.value
object
search.filterProperty.adverts.price.highest.value.min
integer
search.filterProperty.adverts.price.highest.value.max
integer
search.filterProperty.adverts.price.highest.valuePerArea
object
search.filterProperty.adverts.price.highest.valuePerArea.min
integer
search.filterProperty.adverts.price.highest.valuePerArea.max
integer
search.filterProperty.adverts.price.highest.source
object
search.filterProperty.adverts.price.highest.source.website
string
search.filterProperty.adverts.price.highest.source.url
string
search.filterProperty.adverts.price.highest.source.flxId
string
search.filterProperty.adverts.price.initial
object
search.filterProperty.adverts.price.initial.value
object
search.filterProperty.adverts.price.initial.value.min
integer
search.filterProperty.adverts.price.initial.value.max
integer
search.filterProperty.adverts.price.initial.valuePerArea
object
search.filterProperty.adverts.price.initial.valuePerArea.min
integer
search.filterProperty.adverts.price.initial.valuePerArea.max
integer
search.filterProperty.adverts.price.initial.source
object
search.filterProperty.adverts.price.initial.source.website
string
search.filterProperty.adverts.price.initial.source.url
string
search.filterProperty.adverts.price.initial.source.flxId
string
search.filterProperty.adverts.price.warrantyDeposit
object
search.filterProperty.adverts.price.warrantyDeposit.min
integer
search.filterProperty.adverts.price.warrantyDeposit.max
integer
search.filterProperty.adverts.price.charges
object
search.filterProperty.adverts.price.charges.yearlyRentalFees
number
search.filterProperty.adverts.price.charges.yearlyCondoniumFees
number
search.filterProperty.adverts.price.charges.yearlyHeatingFees
number
search.filterProperty.adverts.price.charges.yearlyElectricityFees
number
search.filterProperty.adverts.price.charges.yearlyHousingTax
number
search.filterProperty.adverts.price.charges.yearlyLivingTax
number
search.filterProperty.adverts.price.charges.monthlyRentSupplement
number
search.filterProperty.adverts.price.isAuction
boolean
search.filterProperty.adverts.price.scope
enum<string>[]
Available options:
PRICING_ONE_OFF, PRICING_MENSUAL search.filterProperty.adverts.price.currency
enum<string>[]
Available options:
CURRENCY_EUR, CURRENCY_USD search.filterProperty.adverts.price.variation
object[]
search.filterProperty.adverts.price.variation.sincePublished
object
search.filterProperty.adverts.price.variation.sincePublished.min
number
search.filterProperty.adverts.price.variation.sincePublished.max
number
search.filterProperty.adverts.price.variation.sinceLastModified
object
search.filterProperty.adverts.price.variation.sinceLastModified.min
number
search.filterProperty.adverts.price.variation.sinceLastModified.max
number
search.filterProperty.adverts.location
object
search.filterProperty.adverts.location.preregisteredShape
object
Shape which has already been stored inside fluximmo services. This is particularly useful for when you have a pre-defined list of shapes and you want to reference the list using a logical name (for example Ile-de-France) rather than having to provide coordinates each time.
search.filterProperty.adverts.location.preregisteredShape.index
enum<string>
Available options:
UNKNOWN_GEO_INDEX, DEPARTMENT_GEO_INDEX, CITY_GEO_INDEX, REGION_GEO_INDEX search.filterProperty.adverts.location.preregisteredShape.id
string
search.filterProperty.adverts.location.geoDistance
object
Matches geopoint values within a given distance of a geopoint (pin).
search.filterProperty.adverts.location.geoDistance.distanceKm
number
search.filterProperty.adverts.location.geoDistance.pin
object
search.filterProperty.adverts.location.geoDistance.pin.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
search.filterProperty.adverts.location.geoDistance.pin.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
search.filterProperty.adverts.location.geoBoundingBox
object
Use a geo_bounding_box filter to match geo_point values that intersect a bounding box. To define the box, provide geopoint values for two opposite corners.
search.filterProperty.adverts.location.geoBoundingBox.topLeft
object
search.filterProperty.adverts.location.geoBoundingBox.topLeft.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
search.filterProperty.adverts.location.geoBoundingBox.topLeft.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
search.filterProperty.adverts.location.geoBoundingBox.bottomRight
object
search.filterProperty.adverts.location.geoBoundingBox.bottomRight.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
search.filterProperty.adverts.location.geoBoundingBox.bottomRight.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
search.filterProperty.adverts.location.geoShape
object
Filter documents indexed using. The behaviour of the GeoShape query depends on the type and relation defined. This have the same specs as the GeoJson RFC 7946 (read more here: https://geojson.org/)
search.filterProperty.adverts.location.geoShape.relation
enum<string>
Available options:
UNKNOWN_SPATIAL_RELATION, WITHIN, CONTAINS, DISJOINT, INTERSECTS search.filterProperty.adverts.location.geoShape.type
enum<string>
Available options:
UNKNOWN_GEO_SHAPE_TYPE, POINT, LINE_STRING, POLYGON, MULTI_POINT, MULTI_LINE_STRING search.filterProperty.adverts.location.geoShape.coordinates
object[]
search.filterProperty.adverts.location.geoShape.coordinates.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
search.filterProperty.adverts.location.geoShape.coordinates.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
search.filterProperty.adverts.location.geoInseeCodeDistance
object
Matches geopoint values within a given distance of a insee code.
search.filterProperty.adverts.location.geoInseeCodeDistance.distanceKm
number
search.filterProperty.adverts.location.geoInseeCodeDistance.inseeCode
string
search.filterProperty.adverts.hasAnomaly
boolean
search.filterProperty.adverts.anomalies
enum<string>[]
Available options:
UNKNOWN_ANOMALY, NO_EXACT_LOCATION_ANOMALY, NO_PARKING_COUNT_ANOMALY, NO_DESCRIPTION_ANOMALY, NO_MEDIAS_ANOMALY, NO_PICTURE_ANOMALY, TOO_SHORT_DESCRIPTION_ANOMALY, TOO_SHORT_TITLE_ANOMALY, LOW_PRICE_ANOMALY, HIGH_PRICE_ANOMALY, INCOHERENT_LOCATION_ANOMALY, INCOHERENT_LAND_VALUES_ANOMALY, INCOHERENT_HABITATION_VALUES_ANOMALY, TOO_SMALL_ROOM_ANOMALY, SURFACE_IS_NONE, ROOM_COUNT_IS_NONE, BEDROOM_COUNT_IS_NONE, PRICE_INCOHERENT, TITLE_TOO_SHORT, DESCRIPTION_TOO_SHORT, PRICE_IS_NONE, POSTAL_CODE_IS_NONE, INSEE_CODE_IS_NONE, CITY_IS_NONE, OFFER_TYPE_IS_NONE, TYPE_IS_NONE search.filterProperty.adverts.isExclusive
boolean
search.filterProperty.isCityCenter
boolean
search.filterProperty.hasAnomaly
boolean
search.filterProperty.estimatedPrice
object
search.filterProperty.estimatedPrice.value
object
search.filterProperty.estimatedPrice.value.min
integer
search.filterProperty.estimatedPrice.value.max
integer
search.filterProperty.estimatedPrice.valuePerArea
object
search.filterProperty.estimatedPrice.valuePerArea.min
integer
search.filterProperty.estimatedPrice.valuePerArea.max
integer
search.filterProperty.estimatedPrice.source
object
search.filterProperty.estimatedPrice.source.website
string
search.filterProperty.estimatedPrice.source.url
string
search.filterProperty.estimatedPrice.source.flxId
string
search.filterProperty.imagesLength
object
search.filterProperty.imagesLength.min
integer
search.filterProperty.imagesLength.max
integer
search.filterProperty.advertsLength
object
search.filterProperty.advertsLength.min
integer
search.filterProperty.advertsLength.max
integer
search.filterProperty.historyLength
object
search.filterProperty.historyLength.min
integer
search.filterProperty.historyLength.max
integer
search.filterProperty.anomalies
enum<string>[]
Available options:
UNKNOWN_ANOMALY, NO_EXACT_LOCATION_ANOMALY, NO_PARKING_COUNT_ANOMALY, NO_DESCRIPTION_ANOMALY, NO_MEDIAS_ANOMALY, NO_PICTURE_ANOMALY, TOO_SHORT_DESCRIPTION_ANOMALY, TOO_SHORT_TITLE_ANOMALY, LOW_PRICE_ANOMALY, HIGH_PRICE_ANOMALY, INCOHERENT_LOCATION_ANOMALY, INCOHERENT_LAND_VALUES_ANOMALY, INCOHERENT_HABITATION_VALUES_ANOMALY, TOO_SMALL_ROOM_ANOMALY, SURFACE_IS_NONE, ROOM_COUNT_IS_NONE, BEDROOM_COUNT_IS_NONE, PRICE_INCOHERENT, TITLE_TOO_SHORT, DESCRIPTION_TOO_SHORT, PRICE_IS_NONE, POSTAL_CODE_IS_NONE, INSEE_CODE_IS_NONE, CITY_IS_NONE, OFFER_TYPE_IS_NONE, TYPE_IS_NONE searchAfter
string[]
sortBy
enum<string>
default: RELEVANCEAvailable options:
RELEVANCE, PRICE, FIRST_SEEN_AT, LAST_UPDATED_AT, LAST_SEEN_AT orderBy
enum<string>
default: ASCAvailable options:
ASC, DESC size
integer
excludedFields
string[]
includedFields
string[]
Response
200 - application/json
apiVersion
string
context
string
data
object
data.results
object
data.results.kind
string
data.results.id
string
data.results.lang
string
data.results.updated
string
data.results.deleted
string
data.results.items
object[]
data.results.items.firstKnownAdFlxId
string
data.results.items.flxId
string
data.results.items.indexTimestamp
string
data.results.items.firstKnownAdLegacyId
string
data.results.items.meta
object
data.results.items.meta.firstSeenAt
string
data.results.items.meta.lastUpdatedAt
string
data.results.items.meta.firstPublishedAt
string
data.results.items.meta.lastPublishedAt
string
data.results.items.meta.lastSeenAt
string
data.results.items.meta.isTotallyOffline
boolean
data.results.items.meta.totallyOfflineAt
string
data.results.items.title
string
data.results.items.description
string
data.results.items.tags
string[]
data.results.items.medias
object
data.results.items.medias.virtualVisitExternalUrl
string[]
data.results.items.medias.images
object[]
data.results.items.medias.images.imageId
string
data.results.items.medias.images.url
string
data.results.items.medias.images.s3Path
string
data.results.items.medias.images.gaussianHash
string
data.results.items.medias.images.perceptualHash
string
data.results.items.medias.images.meanHash
string
data.results.items.medias.images.tags
string[]
data.results.items.medias.images.caption
string
data.results.items.medias.images.room
enum<string>
Available options:
ROOM_UNKNOWN, ROOM_BLUEPRINT, ROOM_BATHROOM, ROOM_BEDROOM, ROOM_LIVINGROOM_DININGROOM, ROOM_GARAGE, ROOM_HALLWAY, ROOM_LAUNDRY_ROOM, ROOM_OFFICE, ROOM_EXTERIOR data.results.items.isUrgent
boolean
data.results.items.offer
object
data.results.items.offer.type
enum<string>
default: OFFER_UNKNOWNAvailable options:
OFFER_UNKNOWN, OFFER_BUY, OFFER_RENT, OFFER_BUSINESS_TAKE_OVER, OFFER_LEASE_BACK, OFFER_LIFE_ANNUITY_SALE, OFFER_HOLIDAYS data.results.items.offer.renting
object
data.results.items.offer.renting.isSubLease
boolean
data.results.items.offer.renting.isShortTerm
boolean
data.results.items.offer.renting.isLongTerm
boolean
data.results.items.offer.renting.isColocation
boolean
data.results.items.offer.isCurrentlyOccupied
boolean
data.results.items.type
enum<string>
default: CLASS_UNKNOWNAvailable options:
CLASS_UNKNOWN, CLASS_HOUSE, CLASS_FLAT, CLASS_PROGRAM, CLASS_SHOP, CLASS_PREMISES, CLASS_OFFICE, CLASS_LAND, CLASS_BUILDING, CLASS_PARKING data.results.items.process
enum<string>
default: PROCESS_UNKNOWNAvailable options:
PROCESS_UNKNOWN, PROCESS_AVAILABLE_ON_MARKET, PROCESS_UNDER_COMPROMISE, PROCESS_RENTED_SOLD, PROCESS_REMOVED, PROCESS_RESERVED, PROCESS_ARCHIVED data.results.items.price
object
data.results.items.price.latest
object
data.results.items.price.latest.value
number
data.results.items.price.latest.valuePerArea
number
data.results.items.price.latest.source
object
data.results.items.price.latest.source.website
string
data.results.items.price.latest.source.url
string
data.results.items.price.latest.source.flxId
string
data.results.items.price.lowest
object
data.results.items.price.lowest.value
number
data.results.items.price.lowest.valuePerArea
number
data.results.items.price.lowest.source
object
data.results.items.price.lowest.source.website
string
data.results.items.price.lowest.source.url
string
data.results.items.price.lowest.source.flxId
string
data.results.items.price.highest
object
data.results.items.price.highest.value
number
data.results.items.price.highest.valuePerArea
number
data.results.items.price.highest.source
object
data.results.items.price.highest.source.website
string
data.results.items.price.highest.source.url
string
data.results.items.price.highest.source.flxId
string
data.results.items.price.initial
object
data.results.items.price.initial.value
number
data.results.items.price.initial.valuePerArea
number
data.results.items.price.initial.source
object
data.results.items.price.initial.source.website
string
data.results.items.price.initial.source.url
string
data.results.items.price.initial.source.flxId
string
data.results.items.price.warrantyDeposit
number
data.results.items.price.charges
object
data.results.items.price.charges.yearlyRentalFees
number
data.results.items.price.charges.yearlyCondoniumFees
number
data.results.items.price.charges.yearlyHeatingFees
number
data.results.items.price.charges.yearlyElectricityFees
number
data.results.items.price.charges.yearlyHousingTax
number
data.results.items.price.charges.yearlyLivingTax
number
data.results.items.price.charges.monthlyRentSupplement
number
data.results.items.price.isAuction
boolean
data.results.items.price.scope
enum<string>
Available options:
PRICING_ONE_OFF, PRICING_MENSUAL data.results.items.price.currency
enum<string>
Available options:
CURRENCY_EUR, CURRENCY_USD data.results.items.price.variation
object
data.results.items.price.variation.sincePublished
number
data.results.items.price.variation.sinceLastModified
number
data.results.items.price.variation.absoluteSincePublished
number
data.results.items.price.variation.absoluteSinceLastModified
number
data.results.items.habitation
object
data.results.items.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_INDIVIDUAL, 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, PROPERTY_TYPE_STUDETTE data.results.items.habitation.roomCount
integer
data.results.items.habitation.bedroomCount
integer
data.results.items.habitation.bathroomCount
integer
data.results.items.habitation.wcCount
integer
data.results.items.habitation.roomsDetails
object[]
data.results.items.habitation.roomsDetails.roomType
enum<string>
default: ROOM_TYPE_UNKNOWNAvailable options:
ROOM_TYPE_UNKNOWN, ROOM_TYPE_MASTER_BEDROOM, ROOM_TYPE_BEDROOM, ROOM_TYPE_KITCHEN, ROOM_TYPE_LIVING_ROOM, ROOM_TYPE_OFFICE data.results.items.habitation.roomsDetails.area
number
data.results.items.habitation.roomsDetails.floor
integer
data.results.items.habitation.roomsDetails.contextInfo
string[]
data.results.items.habitation.heatTypes
enum<string>[]
Available options:
HEAT_TYPE_UNKNOWN, HEAT_TYPE_INDIVIDUAL, HEAT_TYPE_SHARED, HEAT_TYPE_MIXED, HEAT_TYPE_CITY, HEAT_TYPE_CISTERN data.results.items.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_RADIANTS_TUBES, HEAT_DETAIL_RADIATOR, HEAT_DETAIL_SHEATHS, HEAT_DETAIL_CONVECTOR data.results.items.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 data.results.items.habitation.kitchenEquipped
enum<string>
default: KITCHEN_UNKNOWN_EQUIPPEDAvailable options:
KITCHEN_UNKNOWN_EQUIPPED, KITCHEN_NON_EQUIPPED, KITCHEN_PARTIALLY_EQUIPPED, KITCHEN_FULLY_EQUIPPED, KITCHEN_FURNISHED, KITCHEN_NAKED, KITCHEN_EQUIPPED_FURNISHED data.results.items.habitation.features
object
data.results.items.habitation.features.propertyTotalFloor
integer
data.results.items.habitation.features.propertyFloor
integer
data.results.items.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 data.results.items.habitation.features.exposure
enum<string>
default: EXPOSURE_UNKNOWNAvailable options:
EXPOSURE_UNKNOWN, EXPOSURE_NORTH, EXPOSURE_NORTH_EAST, EXPOSURE_EAST, EXPOSURE_SOUTH_EAST, EXPOSURE_SOUTH, EXPOSURE_SOUTH_WEST, EXPOSURE_WEST, EXPOSURE_NORTH_WEST data.results.items.habitation.features.furniture
enum<string>
default: UNKNOWN_FURNITUREAvailable options:
UNKNOWN_FURNITURE, UNFURNISHED, PARTIALLY_FURNISHED, FULLY_FURNISHED data.results.items.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 data.results.items.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 data.results.items.habitation.features.glazingTypes
enum<string>[]
Available options:
GLAZING_TYPE_UNKNOWN, GLAZING_TYPE_SIMPLE, GLAZING_TYPE_DOUBLE, GLAZING_TYPE_TRIPLE data.results.items.habitation.features.hasThroughExposure
boolean
data.results.items.habitation.characteristics
object
data.results.items.habitation.characteristics.hasLift
boolean
data.results.items.habitation.characteristics.hasCellar
boolean
data.results.items.habitation.characteristics.hasBalcony
boolean
data.results.items.habitation.characteristics.hasTerrace
boolean
data.results.items.habitation.characteristics.hasGarden
boolean
data.results.items.habitation.characteristics.hasFireplace
boolean
data.results.items.habitation.characteristics.hasGrenier
boolean
data.results.items.habitation.characteristics.hasPool
boolean
data.results.items.habitation.characteristics.hasParking
boolean
data.results.items.habitation.characteristics.hasGarage
boolean
data.results.items.habitation.characteristics.hasLand
boolean
data.results.items.habitation.characteristics.hasConcierge
boolean
data.results.items.habitation.characteristics.hasDigicode
boolean
data.results.items.habitation.characteristics.hasInterphone
boolean
data.results.items.habitation.characteristics.hasAlarm
boolean
data.results.items.habitation.characteristics.hasVisAVis
boolean
data.results.items.habitation.characteristics.isPeaceful
boolean
data.results.items.habitation.characteristics.hasMezzanine
boolean
data.results.items.habitation.characteristics.hasJacuzzi
boolean
data.results.items.habitation.climate
object
data.results.items.habitation.climate.epcEnergy
enum<string>
default: ENERGY_CLASSIFICATION_UNKNOWNAvailable 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 data.results.items.habitation.climate.epcClimate
enum<string>
default: GREENHOUSE_CLASSIFICATION_UNKNOWNAvailable 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 data.results.items.habitation.climate.epcEnergyScore
number
data.results.items.habitation.climate.epcClimateScore
number
data.results.items.habitation.climate.epcClimateDate
string
data.results.items.habitation.climate.epcEnergyDate
string
data.results.items.habitation.propertyCondition
object
data.results.items.habitation.propertyCondition.interiorCondition
enum<string>
default: INTERIOR_CONDITION_UNKNOWNAvailable 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 data.results.items.habitation.propertyCondition.constructionYear
integer
data.results.items.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 data.results.items.habitation.propertyCondition.renovationYear
integer
data.results.items.habitation.surface
object
data.results.items.habitation.surface.total
integer
data.results.items.habitation.surface.livingSpace
integer
data.results.items.habitation.surface.floorSpace
integer
data.results.items.habitation.surface.livingRoom
integer
data.results.items.habitation.surface.kitchen
integer
data.results.items.habitation.surface.groundFloor
integer
data.results.items.habitation.surface.balconies
integer
data.results.items.habitation.surface.terraces
integer
data.results.items.habitation.surface.gardens
integer
data.results.items.parking
object
data.results.items.parking.type
enum<string>
default: PARKING_UNKNOWNAvailable options:
PARKING_UNKNOWN, PARKING_GARAGE, PARKING_PARKING data.results.items.parking.count
integer
data.results.items.parking.numberOfCars
integer
data.results.items.parking.surface
integer
data.results.items.land
object
data.results.items.land.type
enum<string>
default: LAND_UNKNOWNAvailable options:
LAND_UNKNOWN, LAND_BUILDING_PLOT, LAND_AGRICULTURAL, LAND_VINEYARD, LAND_INDUSTRIAL, LAND_POND, LAND_FOREST data.results.items.land.hasBuildingPermit
boolean
data.results.items.land.canConstruct
boolean
data.results.items.land.surfaceConstructable
integer
data.results.items.land.surface
integer
data.results.items.land.isServiced
boolean
data.results.items.land.hasWater
boolean
data.results.items.land.hasElectricity
boolean
data.results.items.land.hasTelecom
boolean
data.results.items.location
object
data.results.items.location.address
object
data.results.items.location.address.number
string
data.results.items.location.address.streetName
string
data.results.items.location.postalCode
string
data.results.items.location.inseeCode
string
data.results.items.location.irisCode
string
data.results.items.location.department
string
data.results.items.location.city
string
data.results.items.location.locationCoordinate
object
data.results.items.location.locationCoordinate.location
number[]
data.results.items.location.locationCoordinate.h3Indices
object
Hierarchical Geobased data-representation. This create a grid of the world with a certain level of details depending on the actual picked index. Please see more here: https://h3geo.org/docs/core-library/restable
data.results.items.location.locationCoordinate.h3Indices.h3Index1
string
data.results.items.location.locationCoordinate.h3Indices.h3Index2
string
data.results.items.location.locationCoordinate.h3Indices.h3Index3
string
data.results.items.location.locationCoordinate.h3Indices.h3Index4
string
data.results.items.location.locationCoordinate.h3Indices.h3Index5
string
data.results.items.location.locationCoordinate.h3Indices.h3Index6
string
data.results.items.location.locationCoordinate.h3Indices.h3Index7
string
data.results.items.location.locationCoordinate.h3Indices.h3Index8
string
data.results.items.location.locationCoordinate.h3Indices.h3Index9
string
data.results.items.location.locationCoordinate.h3Indices.h3Index10
string
data.results.items.location.locationCoordinate.h3Indices.h3Index11
string
data.results.items.location.locationCoordinate.h3Indices.h3Index12
string
data.results.items.location.cityCoordinate
object
data.results.items.location.cityCoordinate.location
number[]
data.results.items.location.cityCoordinate.h3Indices
object
Hierarchical Geobased data-representation. This create a grid of the world with a certain level of details depending on the actual picked index. Please see more here: https://h3geo.org/docs/core-library/restable
data.results.items.location.cityCoordinate.h3Indices.h3Index1
string
data.results.items.location.cityCoordinate.h3Indices.h3Index2
string
data.results.items.location.cityCoordinate.h3Indices.h3Index3
string
data.results.items.location.cityCoordinate.h3Indices.h3Index4
string
data.results.items.location.cityCoordinate.h3Indices.h3Index5
string
data.results.items.location.cityCoordinate.h3Indices.h3Index6
string
data.results.items.location.cityCoordinate.h3Indices.h3Index7
string
data.results.items.location.cityCoordinate.h3Indices.h3Index8
string
data.results.items.location.cityCoordinate.h3Indices.h3Index9
string
data.results.items.location.cityCoordinate.h3Indices.h3Index10
string
data.results.items.location.cityCoordinate.h3Indices.h3Index11
string
data.results.items.location.cityCoordinate.h3Indices.h3Index12
string
data.results.items.history
object[]
data.results.items.history.seenAt
string
data.results.items.history.price
number
data.results.items.history.pricePerArea
number
data.results.items.history.daysSinceFirstSeen
number
data.results.items.history.source
object
data.results.items.history.source.website
string
data.results.items.history.source.url
string
data.results.items.history.source.flxId
string
data.results.items.adverts
object[]
data.results.items.adverts.flxId
string
data.results.items.adverts.isPro
boolean
data.results.items.adverts.seller
object
data.results.items.adverts.seller.type
enum<string>
default: SELLER_TYPE_UNKNOWNAvailable options:
SELLER_TYPE_UNKNOWN, SELLER_TYPE_AGENCY, SELLER_TYPE_NETWORK data.results.items.adverts.seller.flxId
string
data.results.items.adverts.seller.name
string
data.results.items.adverts.seller.siren
string
data.results.items.adverts.contactInCharge
object
data.results.items.adverts.contactInCharge.firstName
string
data.results.items.adverts.contactInCharge.lastName
string
data.results.items.adverts.contactInCharge.phoneNumber
string
data.results.items.adverts.contactInCharge.email
string
data.results.items.adverts.contactInCharge.pseudonym
string
data.results.items.adverts.source
object
data.results.items.adverts.source.website
string
data.results.items.adverts.source.url
string
data.results.items.adverts.source.flxId
string
data.results.items.adverts.title
string
data.results.items.adverts.description
string
data.results.items.adverts.isOnline
boolean
data.results.items.adverts.firstSeenAt
string
data.results.items.adverts.lastUpdatedAt
string
data.results.items.adverts.firstPublishedAt
string
data.results.items.adverts.lastSeenAt
string
data.results.items.adverts.price
object
data.results.items.adverts.price.latest
object
data.results.items.adverts.price.latest.value
number
data.results.items.adverts.price.latest.valuePerArea
number
data.results.items.adverts.price.latest.source
object
data.results.items.adverts.price.latest.source.website
string
data.results.items.adverts.price.latest.source.url
string
data.results.items.adverts.price.latest.source.flxId
string
data.results.items.adverts.price.lowest
object
data.results.items.adverts.price.lowest.value
number
data.results.items.adverts.price.lowest.valuePerArea
number
data.results.items.adverts.price.lowest.source
object
data.results.items.adverts.price.lowest.source.website
string
data.results.items.adverts.price.lowest.source.url
string
data.results.items.adverts.price.lowest.source.flxId
string
data.results.items.adverts.price.highest
object
data.results.items.adverts.price.highest.value
number
data.results.items.adverts.price.highest.valuePerArea
number
data.results.items.adverts.price.highest.source
object
data.results.items.adverts.price.highest.source.website
string
data.results.items.adverts.price.highest.source.url
string
data.results.items.adverts.price.highest.source.flxId
string
data.results.items.adverts.price.initial
object
data.results.items.adverts.price.initial.value
number
data.results.items.adverts.price.initial.valuePerArea
number
data.results.items.adverts.price.initial.source
object
data.results.items.adverts.price.initial.source.website
string
data.results.items.adverts.price.initial.source.url
string
data.results.items.adverts.price.initial.source.flxId
string
data.results.items.adverts.price.warrantyDeposit
number
data.results.items.adverts.price.charges
object
data.results.items.adverts.price.charges.yearlyRentalFees
number
data.results.items.adverts.price.charges.yearlyCondoniumFees
number
data.results.items.adverts.price.charges.yearlyHeatingFees
number
data.results.items.adverts.price.charges.yearlyElectricityFees
number
data.results.items.adverts.price.charges.yearlyHousingTax
number
data.results.items.adverts.price.charges.yearlyLivingTax
number
data.results.items.adverts.price.charges.monthlyRentSupplement
number
data.results.items.adverts.price.isAuction
boolean
data.results.items.adverts.price.scope
enum<string>
Available options:
PRICING_ONE_OFF, PRICING_MENSUAL data.results.items.adverts.price.currency
enum<string>
Available options:
CURRENCY_EUR, CURRENCY_USD data.results.items.adverts.price.variation
object
data.results.items.adverts.price.variation.sincePublished
number
data.results.items.adverts.price.variation.sinceLastModified
number
data.results.items.adverts.price.variation.absoluteSincePublished
number
data.results.items.adverts.price.variation.absoluteSinceLastModified
number
data.results.items.adverts.location
number[]
data.results.items.adverts.legacyId
string
data.results.items.adverts.offlineAt
string
data.results.items.adverts.medias
object
data.results.items.adverts.medias.virtualVisitExternalUrl
string[]
data.results.items.adverts.medias.images
object[]
data.results.items.adverts.medias.images.imageId
string
data.results.items.adverts.medias.images.url
string
data.results.items.adverts.medias.images.s3Path
string
data.results.items.adverts.medias.images.gaussianHash
string
data.results.items.adverts.medias.images.perceptualHash
string
data.results.items.adverts.medias.images.meanHash
string
data.results.items.adverts.medias.images.tags
string[]
data.results.items.adverts.medias.images.caption
string
data.results.items.adverts.medias.images.room
enum<string>
Available options:
ROOM_UNKNOWN, ROOM_BLUEPRINT, ROOM_BATHROOM, ROOM_BEDROOM, ROOM_LIVINGROOM_DININGROOM, ROOM_GARAGE, ROOM_HALLWAY, ROOM_LAUNDRY_ROOM, ROOM_OFFICE, ROOM_EXTERIOR data.results.items.adverts.anomalies
enum<string>[]
Available options:
UNKNOWN_ANOMALY, NO_EXACT_LOCATION_ANOMALY, NO_PARKING_COUNT_ANOMALY, NO_DESCRIPTION_ANOMALY, NO_MEDIAS_ANOMALY, NO_PICTURE_ANOMALY, TOO_SHORT_DESCRIPTION_ANOMALY, TOO_SHORT_TITLE_ANOMALY, LOW_PRICE_ANOMALY, HIGH_PRICE_ANOMALY, INCOHERENT_LOCATION_ANOMALY, INCOHERENT_LAND_VALUES_ANOMALY, INCOHERENT_HABITATION_VALUES_ANOMALY, TOO_SMALL_ROOM_ANOMALY, SURFACE_IS_NONE, ROOM_COUNT_IS_NONE, BEDROOM_COUNT_IS_NONE, PRICE_INCOHERENT, TITLE_TOO_SHORT, DESCRIPTION_TOO_SHORT, PRICE_IS_NONE, POSTAL_CODE_IS_NONE, INSEE_CODE_IS_NONE, CITY_IS_NONE, OFFER_TYPE_IS_NONE, TYPE_IS_NONE data.results.items.adverts.hasAnomaly
boolean
data.results.items.adverts.isExclusive
boolean
data.results.items.isCityCenter
boolean
data.results.items.hasAnomaly
boolean
data.results.items.anomalies
enum<string>[]
Available options:
UNKNOWN_ANOMALY, NO_EXACT_LOCATION_ANOMALY, NO_PARKING_COUNT_ANOMALY, NO_DESCRIPTION_ANOMALY, NO_MEDIAS_ANOMALY, NO_PICTURE_ANOMALY, TOO_SHORT_DESCRIPTION_ANOMALY, TOO_SHORT_TITLE_ANOMALY, LOW_PRICE_ANOMALY, HIGH_PRICE_ANOMALY, INCOHERENT_LOCATION_ANOMALY, INCOHERENT_LAND_VALUES_ANOMALY, INCOHERENT_HABITATION_VALUES_ANOMALY, TOO_SMALL_ROOM_ANOMALY, SURFACE_IS_NONE, ROOM_COUNT_IS_NONE, BEDROOM_COUNT_IS_NONE, PRICE_INCOHERENT, TITLE_TOO_SHORT, DESCRIPTION_TOO_SHORT, PRICE_IS_NONE, POSTAL_CODE_IS_NONE, INSEE_CODE_IS_NONE, CITY_IS_NONE, OFFER_TYPE_IS_NONE, TYPE_IS_NONE data.results.items.estimatedPrice
object
data.results.items.estimatedPrice.value
number
data.results.items.estimatedPrice.valuePerArea
number
data.results.items.estimatedPrice.source
object
data.results.items.estimatedPrice.source.website
string
data.results.items.estimatedPrice.source.url
string
data.results.items.estimatedPrice.source.flxId
string
data.results.items.imagesLength
integer
data.results.items.advertsLength
integer
data.results.items.historyLength
integer
data.results.items.websiteRefs
string[]
data.searchAfter
string[]
internalDelay
integer
count
integer
Was this page helpful?