Advanced
TimeSeriesAnalytics - Retrieve statistical analysis on a time-series base of historical immo's market.
- Book a call
- Contact us
- Basic
- Advanced
- Live
- Sold
- Market
- General
- Population
- Conditions
- Habitation
- Basic
Properties
Market Stat
City
DVF
Advanced
TimeSeriesAnalytics - Retrieve statistical analysis on a time-series base of historical immo's market.
POST
/
v2
/
analytics
/
timeseries
/
properties
/
_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
object
*
query
object
query
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
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
studiedData
enum<string>
studiedData
enum<string>
type
enum<string>
type
enum<string>
interval
enum<string>
interval
enum<string>
Authorizations
x-api-key
string
headerrequiredAPI Key used to be authentified to these APIs. Please contact Fluximmo to get one
Body
application/json
query
object
query.fullTexts
string[]
query.keywords
string[]
query.filterProperty
object
query.filterProperty.indexTimestamp
object[]
query.filterProperty.indexTimestamp.min
string
query.filterProperty.indexTimestamp.max
string
query.filterProperty.meta
object
query.filterProperty.meta.firstSeenAt
object
query.filterProperty.meta.firstSeenAt.min
string
query.filterProperty.meta.firstSeenAt.max
string
query.filterProperty.meta.lastUpdatedAt
object
query.filterProperty.meta.lastUpdatedAt.min
string
query.filterProperty.meta.lastUpdatedAt.max
string
query.filterProperty.meta.firstPublishedAt
object
query.filterProperty.meta.firstPublishedAt.min
string
query.filterProperty.meta.firstPublishedAt.max
string
query.filterProperty.meta.lastPublishedAt
object
query.filterProperty.meta.lastPublishedAt.min
string
query.filterProperty.meta.lastPublishedAt.max
string
query.filterProperty.meta.lastSeenAt
object
query.filterProperty.meta.lastSeenAt.min
string
query.filterProperty.meta.lastSeenAt.max
string
query.filterProperty.meta.isTotallyOffline
boolean
query.filterProperty.tags
string[]
query.filterProperty.isUrgent
boolean
query.filterProperty.offer
object[]
query.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 query.filterProperty.offer.renting
object
query.filterProperty.offer.renting.isSubLease
boolean
query.filterProperty.offer.renting.isShortTerm
boolean
query.filterProperty.offer.renting.isLongTerm
boolean
query.filterProperty.offer.renting.isColocation
boolean
query.filterProperty.offer.isCurrentlyOccupied
boolean
query.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 query.filterProperty.process
enum<string>[]
Available options:
PROCESS_UNKNOWN, PROCESS_AVAILABLE_ON_MARKET, PROCESS_UNDER_COMPROMISE, PROCESS_RENTED_SOLD, PROCESS_REMOVED, PROCESS_RESERVED, PROCESS_ARCHIVED query.filterProperty.price
object
query.filterProperty.price.latest
object
query.filterProperty.price.latest.value
object
query.filterProperty.price.latest.value.min
integer
query.filterProperty.price.latest.value.max
integer
query.filterProperty.price.latest.valuePerArea
object
query.filterProperty.price.latest.valuePerArea.min
integer
query.filterProperty.price.latest.valuePerArea.max
integer
query.filterProperty.price.latest.source
object
query.filterProperty.price.latest.source.website
string
query.filterProperty.price.latest.source.url
string
query.filterProperty.price.latest.source.flxId
string
query.filterProperty.price.lowest
object
query.filterProperty.price.lowest.value
object
query.filterProperty.price.lowest.value.min
integer
query.filterProperty.price.lowest.value.max
integer
query.filterProperty.price.lowest.valuePerArea
object
query.filterProperty.price.lowest.valuePerArea.min
integer
query.filterProperty.price.lowest.valuePerArea.max
integer
query.filterProperty.price.lowest.source
object
query.filterProperty.price.lowest.source.website
string
query.filterProperty.price.lowest.source.url
string
query.filterProperty.price.lowest.source.flxId
string
query.filterProperty.price.highest
object
query.filterProperty.price.highest.value
object
query.filterProperty.price.highest.value.min
integer
query.filterProperty.price.highest.value.max
integer
query.filterProperty.price.highest.valuePerArea
object
query.filterProperty.price.highest.valuePerArea.min
integer
query.filterProperty.price.highest.valuePerArea.max
integer
query.filterProperty.price.highest.source
object
query.filterProperty.price.highest.source.website
string
query.filterProperty.price.highest.source.url
string
query.filterProperty.price.highest.source.flxId
string
query.filterProperty.price.initial
object
query.filterProperty.price.initial.value
object
query.filterProperty.price.initial.value.min
integer
query.filterProperty.price.initial.value.max
integer
query.filterProperty.price.initial.valuePerArea
object
query.filterProperty.price.initial.valuePerArea.min
integer
query.filterProperty.price.initial.valuePerArea.max
integer
query.filterProperty.price.initial.source
object
query.filterProperty.price.initial.source.website
string
query.filterProperty.price.initial.source.url
string
query.filterProperty.price.initial.source.flxId
string
query.filterProperty.price.warrantyDeposit
object
query.filterProperty.price.warrantyDeposit.min
integer
query.filterProperty.price.warrantyDeposit.max
integer
query.filterProperty.price.charges
object
query.filterProperty.price.charges.yearlyRentalFees
number
query.filterProperty.price.charges.yearlyCondoniumFees
number
query.filterProperty.price.charges.yearlyHeatingFees
number
query.filterProperty.price.charges.yearlyElectricityFees
number
query.filterProperty.price.charges.yearlyHousingTax
number
query.filterProperty.price.charges.yearlyLivingTax
number
query.filterProperty.price.charges.monthlyRentSupplement
number
query.filterProperty.price.isAuction
boolean
query.filterProperty.price.scope
enum<string>[]
Available options:
PRICING_ONE_OFF, PRICING_MENSUAL query.filterProperty.price.currency
enum<string>[]
Available options:
CURRENCY_EUR, CURRENCY_USD query.filterProperty.price.variation
object[]
query.filterProperty.price.variation.sincePublished
object
query.filterProperty.price.variation.sincePublished.min
number
query.filterProperty.price.variation.sincePublished.max
number
query.filterProperty.price.variation.sinceLastModified
object
query.filterProperty.price.variation.sinceLastModified.min
number
query.filterProperty.price.variation.sinceLastModified.max
number
query.filterProperty.habitation
object
query.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 query.filterProperty.habitation.roomCount
object
query.filterProperty.habitation.roomCount.min
integer
query.filterProperty.habitation.roomCount.max
integer
query.filterProperty.habitation.bedroomCount
object
query.filterProperty.habitation.bedroomCount.min
integer
query.filterProperty.habitation.bedroomCount.max
integer
query.filterProperty.habitation.bathroomCount
object
query.filterProperty.habitation.bathroomCount.min
integer
query.filterProperty.habitation.bathroomCount.max
integer
query.filterProperty.habitation.wcCount
object
query.filterProperty.habitation.wcCount.min
integer
query.filterProperty.habitation.wcCount.max
integer
query.filterProperty.habitation.roomsDetails
object[]
query.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 query.filterProperty.habitation.roomsDetails.area
number
query.filterProperty.habitation.roomsDetails.floor
integer
query.filterProperty.habitation.roomsDetails.contextInfo
string[]
query.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 query.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 query.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 query.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 query.filterProperty.habitation.features
object
query.filterProperty.habitation.features.propertyTotalFloor
object
query.filterProperty.habitation.features.propertyTotalFloor.min
integer
query.filterProperty.habitation.features.propertyTotalFloor.max
integer
query.filterProperty.habitation.features.propertyFloor
object
query.filterProperty.habitation.features.propertyFloor.min
integer
query.filterProperty.habitation.features.propertyFloor.max
integer
query.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 query.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 query.filterProperty.habitation.features.furniture
enum<string>[]
Available options:
UNKNOWN_FURNITURE, UNFURNISHED, PARTIALLY_FURNISHED, FULLY_FURNISHED query.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 query.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 query.filterProperty.habitation.features.glazingTypes
enum<string>[]
Available options:
GLAZING_TYPE_UNKNOWN, GLAZING_TYPE_SIMPLE, GLAZING_TYPE_DOUBLE, GLAZING_TYPE_TRIPLE query.filterProperty.habitation.features.hasThroughExposure
boolean
query.filterProperty.habitation.characteristics
object
query.filterProperty.habitation.characteristics.hasLift
boolean
query.filterProperty.habitation.characteristics.hasCellar
boolean
query.filterProperty.habitation.characteristics.hasBalcony
boolean
query.filterProperty.habitation.characteristics.hasTerrace
boolean
query.filterProperty.habitation.characteristics.hasGarden
boolean
query.filterProperty.habitation.characteristics.hasFireplace
boolean
query.filterProperty.habitation.characteristics.hasGrenier
boolean
query.filterProperty.habitation.characteristics.hasPool
boolean
query.filterProperty.habitation.characteristics.hasParking
boolean
query.filterProperty.habitation.characteristics.hasGarage
boolean
query.filterProperty.habitation.characteristics.hasLand
boolean
query.filterProperty.habitation.characteristics.hasConcierge
boolean
query.filterProperty.habitation.characteristics.hasDigicode
boolean
query.filterProperty.habitation.characteristics.hasInterphone
boolean
query.filterProperty.habitation.characteristics.hasAlarm
boolean
query.filterProperty.habitation.characteristics.hasVisAVis
boolean
query.filterProperty.habitation.characteristics.isPeaceful
boolean
query.filterProperty.habitation.characteristics.hasMezzanine
boolean
query.filterProperty.habitation.characteristics.hasJacuzzi
boolean
query.filterProperty.habitation.climate
object
query.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 query.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 query.filterProperty.habitation.climate.epcEnergyScore
object
query.filterProperty.habitation.climate.epcEnergyScore.min
integer
query.filterProperty.habitation.climate.epcEnergyScore.max
integer
query.filterProperty.habitation.climate.epcClimateScore
object
query.filterProperty.habitation.climate.epcClimateScore.min
integer
query.filterProperty.habitation.climate.epcClimateScore.max
integer
query.filterProperty.habitation.propertyCondition
object[]
query.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 query.filterProperty.habitation.propertyCondition.constructionYear
integer
query.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 query.filterProperty.habitation.propertyCondition.renovationYear
integer
query.filterProperty.habitation.surface
object
query.filterProperty.habitation.surface.total
object
query.filterProperty.habitation.surface.total.min
integer
query.filterProperty.habitation.surface.total.max
integer
query.filterProperty.habitation.surface.livingSpace
object
query.filterProperty.habitation.surface.livingSpace.min
integer
query.filterProperty.habitation.surface.livingSpace.max
integer
query.filterProperty.habitation.surface.floorSpace
object
query.filterProperty.habitation.surface.floorSpace.min
integer
query.filterProperty.habitation.surface.floorSpace.max
integer
query.filterProperty.habitation.surface.livingroom
object
query.filterProperty.habitation.surface.livingroom.min
integer
query.filterProperty.habitation.surface.livingroom.max
integer
query.filterProperty.habitation.surface.kitchen
object
query.filterProperty.habitation.surface.kitchen.min
integer
query.filterProperty.habitation.surface.kitchen.max
integer
query.filterProperty.habitation.surface.groundFloor
object
query.filterProperty.habitation.surface.groundFloor.min
integer
query.filterProperty.habitation.surface.groundFloor.max
integer
query.filterProperty.habitation.surface.balconies
object
query.filterProperty.habitation.surface.balconies.min
integer
query.filterProperty.habitation.surface.balconies.max
integer
query.filterProperty.habitation.surface.terraces
object
query.filterProperty.habitation.surface.terraces.min
integer
query.filterProperty.habitation.surface.terraces.max
integer
query.filterProperty.habitation.surface.gardens
object
query.filterProperty.habitation.surface.gardens.min
integer
query.filterProperty.habitation.surface.gardens.max
integer
query.filterProperty.parking
object
query.filterProperty.parking.type
enum<string>[]
Available options:
PARKING_UNKNOWN, PARKING_GARAGE, PARKING_PARKING query.filterProperty.parking.count
object
query.filterProperty.parking.count.min
integer
query.filterProperty.parking.count.max
integer
query.filterProperty.parking.numberOfCars
object
query.filterProperty.parking.numberOfCars.min
integer
query.filterProperty.parking.numberOfCars.max
integer
query.filterProperty.parking.surface
object
query.filterProperty.parking.surface.min
integer
query.filterProperty.parking.surface.max
integer
query.filterProperty.land
object
query.filterProperty.land.type
enum<string>[]
Available options:
LAND_UNKNOWN, LAND_BUILDING_PLOT, LAND_AGRICULTURAL, LAND_VINEYARD, LAND_INDUSTRIAL, LAND_POND, LAND_FOREST query.filterProperty.land.haveBuildingPermit
boolean
query.filterProperty.land.canConstruct
boolean
query.filterProperty.land.surfaceConstructable
object
query.filterProperty.land.surfaceConstructable.min
integer
query.filterProperty.land.surfaceConstructable.max
integer
query.filterProperty.land.surface
object
query.filterProperty.land.surface.min
integer
query.filterProperty.land.surface.max
integer
query.filterProperty.land.isServiced
boolean
query.filterProperty.land.haveWater
boolean
query.filterProperty.land.haveElectricity
boolean
query.filterProperty.land.haveTelecom
boolean
query.filterProperty.location
object[]
query.filterProperty.location.address
object
query.filterProperty.location.address.number
string
query.filterProperty.location.address.streetName
string
query.filterProperty.location.postalCode
string
query.filterProperty.location.inseeCode
string
query.filterProperty.location.irisCode
string
query.filterProperty.location.department
string
query.filterProperty.location.city
string
query.filterProperty.location.locationCoordinate
object
query.filterProperty.location.locationCoordinate.location
object
query.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.
query.filterProperty.location.locationCoordinate.location.preregisteredShape.index
enum<string>
Available options:
UNKNOWN_GEO_INDEX, DEPARTMENT_GEO_INDEX, CITY_GEO_INDEX, REGION_GEO_INDEX query.filterProperty.location.locationCoordinate.location.preregisteredShape.id
string
query.filterProperty.location.locationCoordinate.location.geoDistance
object
Matches geopoint values within a given distance of a geopoint (pin).
query.filterProperty.location.locationCoordinate.location.geoDistance.distanceKm
number
query.filterProperty.location.locationCoordinate.location.geoDistance.pin
object
query.filterProperty.location.locationCoordinate.location.geoDistance.pin.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
query.filterProperty.location.locationCoordinate.location.geoDistance.pin.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
query.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.
query.filterProperty.location.locationCoordinate.location.geoBoundingBox.topLeft
object
query.filterProperty.location.locationCoordinate.location.geoBoundingBox.topLeft.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
query.filterProperty.location.locationCoordinate.location.geoBoundingBox.topLeft.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
query.filterProperty.location.locationCoordinate.location.geoBoundingBox.bottomRight
object
query.filterProperty.location.locationCoordinate.location.geoBoundingBox.bottomRight.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
query.filterProperty.location.locationCoordinate.location.geoBoundingBox.bottomRight.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
query.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/)
query.filterProperty.location.locationCoordinate.location.geoShape.relation
enum<string>
Available options:
UNKNOWN_SPATIAL_RELATION, WITHIN, CONTAINS, DISJOINT, INTERSECTS query.filterProperty.location.locationCoordinate.location.geoShape.type
enum<string>
Available options:
UNKNOWN_GEO_SHAPE_TYPE, POINT, LINE_STRING, POLYGON, MULTI_POINT, MULTI_LINE_STRING query.filterProperty.location.locationCoordinate.location.geoShape.coordinates
object[]
query.filterProperty.location.locationCoordinate.location.geoShape.coordinates.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
query.filterProperty.location.locationCoordinate.location.geoShape.coordinates.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
query.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
query.filterProperty.location.locationCoordinate.h3Indices.h3Index1
string
query.filterProperty.location.locationCoordinate.h3Indices.h3Index2
string
query.filterProperty.location.locationCoordinate.h3Indices.h3Index3
string
query.filterProperty.location.locationCoordinate.h3Indices.h3Index4
string
query.filterProperty.location.locationCoordinate.h3Indices.h3Index5
string
query.filterProperty.location.locationCoordinate.h3Indices.h3Index6
string
query.filterProperty.location.locationCoordinate.h3Indices.h3Index7
string
query.filterProperty.location.locationCoordinate.h3Indices.h3Index8
string
query.filterProperty.location.locationCoordinate.h3Indices.h3Index9
string
query.filterProperty.location.locationCoordinate.h3Indices.h3Index10
string
query.filterProperty.location.locationCoordinate.h3Indices.h3Index11
string
query.filterProperty.location.locationCoordinate.h3Indices.h3Index12
string
query.filterProperty.location.cityCoordinate
object
query.filterProperty.location.cityCoordinate.location
object
query.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.
query.filterProperty.location.cityCoordinate.location.preregisteredShape.index
enum<string>
Available options:
UNKNOWN_GEO_INDEX, DEPARTMENT_GEO_INDEX, CITY_GEO_INDEX, REGION_GEO_INDEX query.filterProperty.location.cityCoordinate.location.preregisteredShape.id
string
query.filterProperty.location.cityCoordinate.location.geoDistance
object
Matches geopoint values within a given distance of a geopoint (pin).
query.filterProperty.location.cityCoordinate.location.geoDistance.distanceKm
number
query.filterProperty.location.cityCoordinate.location.geoDistance.pin
object
query.filterProperty.location.cityCoordinate.location.geoDistance.pin.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
query.filterProperty.location.cityCoordinate.location.geoDistance.pin.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
query.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.
query.filterProperty.location.cityCoordinate.location.geoBoundingBox.topLeft
object
query.filterProperty.location.cityCoordinate.location.geoBoundingBox.topLeft.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
query.filterProperty.location.cityCoordinate.location.geoBoundingBox.topLeft.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
query.filterProperty.location.cityCoordinate.location.geoBoundingBox.bottomRight
object
query.filterProperty.location.cityCoordinate.location.geoBoundingBox.bottomRight.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
query.filterProperty.location.cityCoordinate.location.geoBoundingBox.bottomRight.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
query.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/)
query.filterProperty.location.cityCoordinate.location.geoShape.relation
enum<string>
Available options:
UNKNOWN_SPATIAL_RELATION, WITHIN, CONTAINS, DISJOINT, INTERSECTS query.filterProperty.location.cityCoordinate.location.geoShape.type
enum<string>
Available options:
UNKNOWN_GEO_SHAPE_TYPE, POINT, LINE_STRING, POLYGON, MULTI_POINT, MULTI_LINE_STRING query.filterProperty.location.cityCoordinate.location.geoShape.coordinates
object[]
query.filterProperty.location.cityCoordinate.location.geoShape.coordinates.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
query.filterProperty.location.cityCoordinate.location.geoShape.coordinates.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
query.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
query.filterProperty.location.cityCoordinate.h3Indices.h3Index1
string
query.filterProperty.location.cityCoordinate.h3Indices.h3Index2
string
query.filterProperty.location.cityCoordinate.h3Indices.h3Index3
string
query.filterProperty.location.cityCoordinate.h3Indices.h3Index4
string
query.filterProperty.location.cityCoordinate.h3Indices.h3Index5
string
query.filterProperty.location.cityCoordinate.h3Indices.h3Index6
string
query.filterProperty.location.cityCoordinate.h3Indices.h3Index7
string
query.filterProperty.location.cityCoordinate.h3Indices.h3Index8
string
query.filterProperty.location.cityCoordinate.h3Indices.h3Index9
string
query.filterProperty.location.cityCoordinate.h3Indices.h3Index10
string
query.filterProperty.location.cityCoordinate.h3Indices.h3Index11
string
query.filterProperty.location.cityCoordinate.h3Indices.h3Index12
string
query.filterProperty.history
object[]
query.filterProperty.history.seenAt
object
query.filterProperty.history.seenAt.min
string
query.filterProperty.history.seenAt.max
string
query.filterProperty.history.price
object
query.filterProperty.history.price.min
integer
query.filterProperty.history.price.max
integer
query.filterProperty.history.pricePerArea
object
query.filterProperty.history.pricePerArea.min
integer
query.filterProperty.history.pricePerArea.max
integer
query.filterProperty.history.nbDaysPublished
object
query.filterProperty.history.nbDaysPublished.min
integer
query.filterProperty.history.nbDaysPublished.max
integer
query.filterProperty.history.source
object
query.filterProperty.history.source.website
string
query.filterProperty.history.source.url
string
query.filterProperty.history.source.flxId
string
query.filterProperty.adverts
object[]
query.filterProperty.adverts.flxId
string[]
query.filterProperty.adverts.isPro
boolean
query.filterProperty.adverts.seller
object[]
query.filterProperty.adverts.seller.type
enum<string>
default: SELLER_TYPE_UNKNOWNAvailable options:
SELLER_TYPE_UNKNOWN, SELLER_TYPE_AGENCY, SELLER_TYPE_NETWORK query.filterProperty.adverts.seller.flxId
string
query.filterProperty.adverts.seller.name
string
query.filterProperty.adverts.seller.siren
string
query.filterProperty.adverts.contactInCharge
object
query.filterProperty.adverts.contactInCharge.firstName
string
query.filterProperty.adverts.contactInCharge.lastName
string
query.filterProperty.adverts.contactInCharge.phoneNumber
string
query.filterProperty.adverts.contactInCharge.email
string
query.filterProperty.adverts.contactInCharge.pseudonym
string
query.filterProperty.adverts.source
object
query.filterProperty.adverts.source.website
string
query.filterProperty.adverts.source.url
string
query.filterProperty.adverts.source.flxId
string
query.filterProperty.adverts.title
string[]
query.filterProperty.adverts.description
string[]
query.filterProperty.adverts.isOnline
boolean
query.filterProperty.adverts.firstSeenAt
object
query.filterProperty.adverts.firstSeenAt.min
string
query.filterProperty.adverts.firstSeenAt.max
string
query.filterProperty.adverts.lastUpdatedAt
object
query.filterProperty.adverts.lastUpdatedAt.min
string
query.filterProperty.adverts.lastUpdatedAt.max
string
query.filterProperty.adverts.firstPublishedAt
object
query.filterProperty.adverts.firstPublishedAt.min
string
query.filterProperty.adverts.firstPublishedAt.max
string
query.filterProperty.adverts.lastSeenAt
object
query.filterProperty.adverts.lastSeenAt.min
string
query.filterProperty.adverts.lastSeenAt.max
string
query.filterProperty.adverts.price
object
query.filterProperty.adverts.price.latest
object
query.filterProperty.adverts.price.latest.value
object
query.filterProperty.adverts.price.latest.value.min
integer
query.filterProperty.adverts.price.latest.value.max
integer
query.filterProperty.adverts.price.latest.valuePerArea
object
query.filterProperty.adverts.price.latest.valuePerArea.min
integer
query.filterProperty.adverts.price.latest.valuePerArea.max
integer
query.filterProperty.adverts.price.latest.source
object
query.filterProperty.adverts.price.latest.source.website
string
query.filterProperty.adverts.price.latest.source.url
string
query.filterProperty.adverts.price.latest.source.flxId
string
query.filterProperty.adverts.price.lowest
object
query.filterProperty.adverts.price.lowest.value
object
query.filterProperty.adverts.price.lowest.value.min
integer
query.filterProperty.adverts.price.lowest.value.max
integer
query.filterProperty.adverts.price.lowest.valuePerArea
object
query.filterProperty.adverts.price.lowest.valuePerArea.min
integer
query.filterProperty.adverts.price.lowest.valuePerArea.max
integer
query.filterProperty.adverts.price.lowest.source
object
query.filterProperty.adverts.price.lowest.source.website
string
query.filterProperty.adverts.price.lowest.source.url
string
query.filterProperty.adverts.price.lowest.source.flxId
string
query.filterProperty.adverts.price.highest
object
query.filterProperty.adverts.price.highest.value
object
query.filterProperty.adverts.price.highest.value.min
integer
query.filterProperty.adverts.price.highest.value.max
integer
query.filterProperty.adverts.price.highest.valuePerArea
object
query.filterProperty.adverts.price.highest.valuePerArea.min
integer
query.filterProperty.adverts.price.highest.valuePerArea.max
integer
query.filterProperty.adverts.price.highest.source
object
query.filterProperty.adverts.price.highest.source.website
string
query.filterProperty.adverts.price.highest.source.url
string
query.filterProperty.adverts.price.highest.source.flxId
string
query.filterProperty.adverts.price.initial
object
query.filterProperty.adverts.price.initial.value
object
query.filterProperty.adverts.price.initial.value.min
integer
query.filterProperty.adverts.price.initial.value.max
integer
query.filterProperty.adverts.price.initial.valuePerArea
object
query.filterProperty.adverts.price.initial.valuePerArea.min
integer
query.filterProperty.adverts.price.initial.valuePerArea.max
integer
query.filterProperty.adverts.price.initial.source
object
query.filterProperty.adverts.price.initial.source.website
string
query.filterProperty.adverts.price.initial.source.url
string
query.filterProperty.adverts.price.initial.source.flxId
string
query.filterProperty.adverts.price.warrantyDeposit
object
query.filterProperty.adverts.price.warrantyDeposit.min
integer
query.filterProperty.adverts.price.warrantyDeposit.max
integer
query.filterProperty.adverts.price.charges
object
query.filterProperty.adverts.price.charges.yearlyRentalFees
number
query.filterProperty.adverts.price.charges.yearlyCondoniumFees
number
query.filterProperty.adverts.price.charges.yearlyHeatingFees
number
query.filterProperty.adverts.price.charges.yearlyElectricityFees
number
query.filterProperty.adverts.price.charges.yearlyHousingTax
number
query.filterProperty.adverts.price.charges.yearlyLivingTax
number
query.filterProperty.adverts.price.charges.monthlyRentSupplement
number
query.filterProperty.adverts.price.isAuction
boolean
query.filterProperty.adverts.price.scope
enum<string>[]
Available options:
PRICING_ONE_OFF, PRICING_MENSUAL query.filterProperty.adverts.price.currency
enum<string>[]
Available options:
CURRENCY_EUR, CURRENCY_USD query.filterProperty.adverts.price.variation
object[]
query.filterProperty.adverts.price.variation.sincePublished
object
query.filterProperty.adverts.price.variation.sincePublished.min
number
query.filterProperty.adverts.price.variation.sincePublished.max
number
query.filterProperty.adverts.price.variation.sinceLastModified
object
query.filterProperty.adverts.price.variation.sinceLastModified.min
number
query.filterProperty.adverts.price.variation.sinceLastModified.max
number
query.filterProperty.adverts.location
object
query.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.
query.filterProperty.adverts.location.preregisteredShape.index
enum<string>
Available options:
UNKNOWN_GEO_INDEX, DEPARTMENT_GEO_INDEX, CITY_GEO_INDEX, REGION_GEO_INDEX query.filterProperty.adverts.location.preregisteredShape.id
string
query.filterProperty.adverts.location.geoDistance
object
Matches geopoint values within a given distance of a geopoint (pin).
query.filterProperty.adverts.location.geoDistance.distanceKm
number
query.filterProperty.adverts.location.geoDistance.pin
object
query.filterProperty.adverts.location.geoDistance.pin.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
query.filterProperty.adverts.location.geoDistance.pin.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
query.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.
query.filterProperty.adverts.location.geoBoundingBox.topLeft
object
query.filterProperty.adverts.location.geoBoundingBox.topLeft.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
query.filterProperty.adverts.location.geoBoundingBox.topLeft.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
query.filterProperty.adverts.location.geoBoundingBox.bottomRight
object
query.filterProperty.adverts.location.geoBoundingBox.bottomRight.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
query.filterProperty.adverts.location.geoBoundingBox.bottomRight.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
query.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/)
query.filterProperty.adverts.location.geoShape.relation
enum<string>
Available options:
UNKNOWN_SPATIAL_RELATION, WITHIN, CONTAINS, DISJOINT, INTERSECTS query.filterProperty.adverts.location.geoShape.type
enum<string>
Available options:
UNKNOWN_GEO_SHAPE_TYPE, POINT, LINE_STRING, POLYGON, MULTI_POINT, MULTI_LINE_STRING query.filterProperty.adverts.location.geoShape.coordinates
object[]
query.filterProperty.adverts.location.geoShape.coordinates.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
query.filterProperty.adverts.location.geoShape.coordinates.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
query.filterProperty.adverts.hasAnomaly
boolean
query.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 query.filterProperty.isCityCenter
boolean
query.filterProperty.hasAnomaly
boolean
query.filterProperty.estimatedPrice
object
query.filterProperty.estimatedPrice.value
object
query.filterProperty.estimatedPrice.value.min
integer
query.filterProperty.estimatedPrice.value.max
integer
query.filterProperty.estimatedPrice.valuePerArea
object
query.filterProperty.estimatedPrice.valuePerArea.min
integer
query.filterProperty.estimatedPrice.valuePerArea.max
integer
query.filterProperty.estimatedPrice.source
object
query.filterProperty.estimatedPrice.source.website
string
query.filterProperty.estimatedPrice.source.url
string
query.filterProperty.estimatedPrice.source.flxId
string
query.filterProperty.imagesLength
object
query.filterProperty.imagesLength.min
integer
query.filterProperty.imagesLength.max
integer
query.filterProperty.advertsLength
object
query.filterProperty.advertsLength.min
integer
query.filterProperty.advertsLength.max
integer
query.filterProperty.historyLength
object
query.filterProperty.historyLength.min
integer
query.filterProperty.historyLength.max
integer
query.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 studiedData
enum<string>
default: UNKNOWN_ANALYZED_TYPEAvailable options:
UNKNOWN_ANALYZED_TYPE, PRICE_ANALYZED_TYPE, HABITATION_SURFACE_ANALYZED_TYPE, LAND_SURFACE_ANALYZED_TYPE, PRICE_PER_AREA_ANALYZED_TYPE, TIME_ON_MARKET_ANALYZED_TYPE type
enum<string>
default: UNKNOWN_ANALYSIS_TYPEAvailable options:
UNKNOWN_ANALYSIS_TYPE, DISTRIBUTION_ANALYSIS_TYPE, SUMMARY_ANALYSIS_TYPE, ADVANCED_ANALYSIS_TYPE, BOX_PLOT_ANALYSIS_TYPE, PERCENTILES_ANALYSIS_TYPE interval
enum<string>
default: UNKNOWN_TIME_SERIES_INTERVALAvailable options:
UNKNOWN_TIME_SERIES_INTERVAL, DAY_TIME_SERIES_INTERVAL, WEEK_TIME_SERIES_INTERVAL, MONTH_TIME_SERIES_INTERVAL, QUARTER_TIME_SERIES_INTERVAL, YEAR_TIME_SERIES_INTERVAL Response
200 - application/json
apiVersion
string
kind
string
context
string
internalDelay
integer
data
object
data.startTimestamp
string
Must be present for cumulative metrics. The time when the cumulative value was reset to zero. Exclusive. The cumulative value is over the time interval (start_timestamp, timestamp]. If not specified, the backend can use the previous recorded value.
data.points
object[]
The data points of this timeseries. Point.value type MUST match the MetricDescriptor.type.
data.points.timestamp
string
data.points.analysis
object
data.points.analysis.countValue
number
data.points.analysis.summaryValue
object
data.points.analysis.summaryValue.count
integer
data.points.analysis.summaryValue.min
number
data.points.analysis.summaryValue.max
number
data.points.analysis.summaryValue.avg
number
data.points.analysis.summaryValue.sum
number
data.points.analysis.advancedKpiValue
object
data.points.analysis.advancedKpiValue.count
integer
data.points.analysis.advancedKpiValue.min
number
data.points.analysis.advancedKpiValue.max
number
data.points.analysis.advancedKpiValue.avg
number
data.points.analysis.advancedKpiValue.sum
number
data.points.analysis.advancedKpiValue.sumOfSquares
number
data.points.analysis.advancedKpiValue.variance
number
data.points.analysis.advancedKpiValue.variancePopulation
number
data.points.analysis.advancedKpiValue.varianceSampling
number
data.points.analysis.advancedKpiValue.stdDeviation
number
data.points.analysis.advancedKpiValue.stdDeviationSampling
number
data.points.analysis.advancedKpiValue.stdDeviationPopulation
number
data.points.analysis.advancedKpiValue.stdDeviationBounds
object
data.points.analysis.advancedKpiValue.stdDeviationBounds.upper
number
data.points.analysis.advancedKpiValue.stdDeviationBounds.lower
number
data.points.analysis.advancedKpiValue.stdDeviationBounds.upperPopulation
number
data.points.analysis.advancedKpiValue.stdDeviationBounds.lowerPopulation
number
data.points.analysis.advancedKpiValue.stdDeviationBounds.upperSampling
number
data.points.analysis.advancedKpiValue.stdDeviationBounds.lowerSampling
number
data.points.analysis.boxplotValue
object
data.points.analysis.boxplotValue.min
number
data.points.analysis.boxplotValue.max
number
data.points.analysis.boxplotValue.q1
number
data.points.analysis.boxplotValue.q2
number
data.points.analysis.boxplotValue.q3
number
data.points.analysis.boxplotValue.lower
number
data.points.analysis.boxplotValue.upper
number
data.points.analysis.percentilesValues
object
data.points.analysis.percentilesValues.percentiles
object