GetPropertiesAlert - Retrieve alert for a given alert id
GetPropertiesAlert - Retrieve alert for a given alert id
GET
/
v2
/
alert
/
properties
/
{alertId}
x-api-key
string
*
x-api-key
Required
string
API Key used to be authentified to these APIs. Please contact Fluximmo to get one
alertId
string
*
alertId
Required
string
Authorizations
x-api-key
string
headerrequiredAPI Key used to be authentified to these APIs. Please contact Fluximmo to get one
Path Parameters
alertId
string
requiredResponse
200 - application/json
alert
object
alert.fullTexts
string[]
alert.keywords
string[]
alert.filterProperty
object
alert.filterProperty.indexTimestamp
object[]
alert.filterProperty.indexTimestamp.min
string
alert.filterProperty.indexTimestamp.max
string
alert.filterProperty.meta
object
alert.filterProperty.meta.firstSeenAt
object
alert.filterProperty.meta.firstSeenAt.min
string
alert.filterProperty.meta.firstSeenAt.max
string
alert.filterProperty.meta.lastUpdatedAt
object
alert.filterProperty.meta.lastUpdatedAt.min
string
alert.filterProperty.meta.lastUpdatedAt.max
string
alert.filterProperty.meta.firstPublishedAt
object
alert.filterProperty.meta.firstPublishedAt.min
string
alert.filterProperty.meta.firstPublishedAt.max
string
alert.filterProperty.meta.lastPublishedAt
object
alert.filterProperty.meta.lastPublishedAt.min
string
alert.filterProperty.meta.lastPublishedAt.max
string
alert.filterProperty.meta.lastSeenAt
object
alert.filterProperty.meta.lastSeenAt.min
string
alert.filterProperty.meta.lastSeenAt.max
string
alert.filterProperty.meta.isTotallyOffline
boolean
alert.filterProperty.tags
string[]
alert.filterProperty.isUrgent
boolean
alert.filterProperty.offer
object[]
alert.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 alert.filterProperty.offer.renting
object
alert.filterProperty.offer.renting.isSubLease
boolean
alert.filterProperty.offer.renting.isShortTerm
boolean
alert.filterProperty.offer.renting.isLongTerm
boolean
alert.filterProperty.offer.renting.isColocation
boolean
alert.filterProperty.offer.isCurrentlyOccupied
boolean
alert.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 alert.filterProperty.process
enum<string>[]
Available options:
PROCESS_UNKNOWN, PROCESS_AVAILABLE_ON_MARKET, PROCESS_UNDER_COMPROMISE, PROCESS_RENTED_SOLD, PROCESS_REMOVED, PROCESS_RESERVED, PROCESS_ARCHIVED alert.filterProperty.price
object
alert.filterProperty.price.latest
object
alert.filterProperty.price.latest.value
object
alert.filterProperty.price.latest.value.min
integer
alert.filterProperty.price.latest.value.max
integer
alert.filterProperty.price.latest.valuePerArea
object
alert.filterProperty.price.latest.valuePerArea.min
integer
alert.filterProperty.price.latest.valuePerArea.max
integer
alert.filterProperty.price.latest.source
object
alert.filterProperty.price.latest.source.website
string
alert.filterProperty.price.latest.source.url
string
alert.filterProperty.price.latest.source.flxId
string
alert.filterProperty.price.lowest
object
alert.filterProperty.price.lowest.value
object
alert.filterProperty.price.lowest.value.min
integer
alert.filterProperty.price.lowest.value.max
integer
alert.filterProperty.price.lowest.valuePerArea
object
alert.filterProperty.price.lowest.valuePerArea.min
integer
alert.filterProperty.price.lowest.valuePerArea.max
integer
alert.filterProperty.price.lowest.source
object
alert.filterProperty.price.lowest.source.website
string
alert.filterProperty.price.lowest.source.url
string
alert.filterProperty.price.lowest.source.flxId
string
alert.filterProperty.price.highest
object
alert.filterProperty.price.highest.value
object
alert.filterProperty.price.highest.value.min
integer
alert.filterProperty.price.highest.value.max
integer
alert.filterProperty.price.highest.valuePerArea
object
alert.filterProperty.price.highest.valuePerArea.min
integer
alert.filterProperty.price.highest.valuePerArea.max
integer
alert.filterProperty.price.highest.source
object
alert.filterProperty.price.highest.source.website
string
alert.filterProperty.price.highest.source.url
string
alert.filterProperty.price.highest.source.flxId
string
alert.filterProperty.price.initial
object
alert.filterProperty.price.initial.value
object
alert.filterProperty.price.initial.value.min
integer
alert.filterProperty.price.initial.value.max
integer
alert.filterProperty.price.initial.valuePerArea
object
alert.filterProperty.price.initial.valuePerArea.min
integer
alert.filterProperty.price.initial.valuePerArea.max
integer
alert.filterProperty.price.initial.source
object
alert.filterProperty.price.initial.source.website
string
alert.filterProperty.price.initial.source.url
string
alert.filterProperty.price.initial.source.flxId
string
alert.filterProperty.price.warrantyDeposit
object
alert.filterProperty.price.warrantyDeposit.min
integer
alert.filterProperty.price.warrantyDeposit.max
integer
alert.filterProperty.price.charges
object
alert.filterProperty.price.charges.yearlyRentalFees
number
alert.filterProperty.price.charges.yearlyCondoniumFees
number
alert.filterProperty.price.charges.yearlyHeatingFees
number
alert.filterProperty.price.charges.yearlyElectricityFees
number
alert.filterProperty.price.charges.yearlyHousingTax
number
alert.filterProperty.price.charges.yearlyLivingTax
number
alert.filterProperty.price.charges.monthlyRentSupplement
number
alert.filterProperty.price.isAuction
boolean
alert.filterProperty.price.scope
enum<string>[]
Available options:
PRICING_ONE_OFF, PRICING_MENSUAL alert.filterProperty.price.currency
enum<string>[]
Available options:
CURRENCY_EUR, CURRENCY_USD alert.filterProperty.price.variation
object[]
alert.filterProperty.price.variation.sincePublished
object
alert.filterProperty.price.variation.sincePublished.min
number
alert.filterProperty.price.variation.sincePublished.max
number
alert.filterProperty.price.variation.sinceLastModified
object
alert.filterProperty.price.variation.sinceLastModified.min
number
alert.filterProperty.price.variation.sinceLastModified.max
number
alert.filterProperty.habitation
object
alert.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 alert.filterProperty.habitation.roomCount
object
alert.filterProperty.habitation.roomCount.min
integer
alert.filterProperty.habitation.roomCount.max
integer
alert.filterProperty.habitation.bedroomCount
object
alert.filterProperty.habitation.bedroomCount.min
integer
alert.filterProperty.habitation.bedroomCount.max
integer
alert.filterProperty.habitation.bathroomCount
object
alert.filterProperty.habitation.bathroomCount.min
integer
alert.filterProperty.habitation.bathroomCount.max
integer
alert.filterProperty.habitation.wcCount
object
alert.filterProperty.habitation.wcCount.min
integer
alert.filterProperty.habitation.wcCount.max
integer
alert.filterProperty.habitation.roomsDetails
object[]
alert.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 alert.filterProperty.habitation.roomsDetails.area
number
alert.filterProperty.habitation.roomsDetails.floor
integer
alert.filterProperty.habitation.roomsDetails.contextInfo
string[]
alert.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 alert.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 alert.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 alert.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 alert.filterProperty.habitation.features
object
alert.filterProperty.habitation.features.propertyTotalFloor
object
alert.filterProperty.habitation.features.propertyTotalFloor.min
integer
alert.filterProperty.habitation.features.propertyTotalFloor.max
integer
alert.filterProperty.habitation.features.propertyFloor
object
alert.filterProperty.habitation.features.propertyFloor.min
integer
alert.filterProperty.habitation.features.propertyFloor.max
integer
alert.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 alert.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 alert.filterProperty.habitation.features.furniture
enum<string>[]
Available options:
UNKNOWN_FURNITURE, UNFURNISHED, PARTIALLY_FURNISHED, FULLY_FURNISHED alert.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 alert.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 alert.filterProperty.habitation.features.glazingTypes
enum<string>[]
Available options:
GLAZING_TYPE_UNKNOWN, GLAZING_TYPE_SIMPLE, GLAZING_TYPE_DOUBLE, GLAZING_TYPE_TRIPLE alert.filterProperty.habitation.features.hasThroughExposure
boolean
alert.filterProperty.habitation.characteristics
object
alert.filterProperty.habitation.characteristics.hasLift
boolean
alert.filterProperty.habitation.characteristics.hasCellar
boolean
alert.filterProperty.habitation.characteristics.hasBalcony
boolean
alert.filterProperty.habitation.characteristics.hasTerrace
boolean
alert.filterProperty.habitation.characteristics.hasGarden
boolean
alert.filterProperty.habitation.characteristics.hasFireplace
boolean
alert.filterProperty.habitation.characteristics.hasGrenier
boolean
alert.filterProperty.habitation.characteristics.hasPool
boolean
alert.filterProperty.habitation.characteristics.hasParking
boolean
alert.filterProperty.habitation.characteristics.hasGarage
boolean
alert.filterProperty.habitation.characteristics.hasLand
boolean
alert.filterProperty.habitation.characteristics.hasConcierge
boolean
alert.filterProperty.habitation.characteristics.hasDigicode
boolean
alert.filterProperty.habitation.characteristics.hasInterphone
boolean
alert.filterProperty.habitation.characteristics.hasAlarm
boolean
alert.filterProperty.habitation.characteristics.hasVisAVis
boolean
alert.filterProperty.habitation.characteristics.isPeaceful
boolean
alert.filterProperty.habitation.characteristics.hasMezzanine
boolean
alert.filterProperty.habitation.characteristics.hasJacuzzi
boolean
alert.filterProperty.habitation.climate
object
alert.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 alert.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 alert.filterProperty.habitation.climate.epcEnergyScore
object
alert.filterProperty.habitation.climate.epcEnergyScore.min
integer
alert.filterProperty.habitation.climate.epcEnergyScore.max
integer
alert.filterProperty.habitation.climate.epcClimateScore
object
alert.filterProperty.habitation.climate.epcClimateScore.min
integer
alert.filterProperty.habitation.climate.epcClimateScore.max
integer
alert.filterProperty.habitation.climate.epcClimateDate
object
alert.filterProperty.habitation.climate.epcClimateDate.min
string
alert.filterProperty.habitation.climate.epcClimateDate.max
string
alert.filterProperty.habitation.climate.epcEnergyDate
object
alert.filterProperty.habitation.climate.epcEnergyDate.min
string
alert.filterProperty.habitation.climate.epcEnergyDate.max
string
alert.filterProperty.habitation.propertyCondition
object[]
alert.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 alert.filterProperty.habitation.propertyCondition.constructionYear
integer
alert.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 alert.filterProperty.habitation.propertyCondition.renovationYear
integer
alert.filterProperty.habitation.surface
object
alert.filterProperty.habitation.surface.total
object
alert.filterProperty.habitation.surface.total.min
integer
alert.filterProperty.habitation.surface.total.max
integer
alert.filterProperty.habitation.surface.livingSpace
object
alert.filterProperty.habitation.surface.livingSpace.min
integer
alert.filterProperty.habitation.surface.livingSpace.max
integer
alert.filterProperty.habitation.surface.floorSpace
object
alert.filterProperty.habitation.surface.floorSpace.min
integer
alert.filterProperty.habitation.surface.floorSpace.max
integer
alert.filterProperty.habitation.surface.livingroom
object
alert.filterProperty.habitation.surface.livingroom.min
integer
alert.filterProperty.habitation.surface.livingroom.max
integer
alert.filterProperty.habitation.surface.kitchen
object
alert.filterProperty.habitation.surface.kitchen.min
integer
alert.filterProperty.habitation.surface.kitchen.max
integer
alert.filterProperty.habitation.surface.groundFloor
object
alert.filterProperty.habitation.surface.groundFloor.min
integer
alert.filterProperty.habitation.surface.groundFloor.max
integer
alert.filterProperty.habitation.surface.balconies
object
alert.filterProperty.habitation.surface.balconies.min
integer
alert.filterProperty.habitation.surface.balconies.max
integer
alert.filterProperty.habitation.surface.terraces
object
alert.filterProperty.habitation.surface.terraces.min
integer
alert.filterProperty.habitation.surface.terraces.max
integer
alert.filterProperty.habitation.surface.gardens
object
alert.filterProperty.habitation.surface.gardens.min
integer
alert.filterProperty.habitation.surface.gardens.max
integer
alert.filterProperty.parking
object
alert.filterProperty.parking.type
enum<string>[]
Available options:
PARKING_UNKNOWN, PARKING_GARAGE, PARKING_PARKING alert.filterProperty.parking.count
object
alert.filterProperty.parking.count.min
integer
alert.filterProperty.parking.count.max
integer
alert.filterProperty.parking.numberOfCars
object
alert.filterProperty.parking.numberOfCars.min
integer
alert.filterProperty.parking.numberOfCars.max
integer
alert.filterProperty.parking.surface
object
alert.filterProperty.parking.surface.min
integer
alert.filterProperty.parking.surface.max
integer
alert.filterProperty.land
object
alert.filterProperty.land.type
enum<string>[]
Available options:
LAND_UNKNOWN, LAND_BUILDING_PLOT, LAND_AGRICULTURAL, LAND_VINEYARD, LAND_INDUSTRIAL, LAND_POND, LAND_FOREST alert.filterProperty.land.haveBuildingPermit
boolean
alert.filterProperty.land.canConstruct
boolean
alert.filterProperty.land.surfaceConstructable
object
alert.filterProperty.land.surfaceConstructable.min
integer
alert.filterProperty.land.surfaceConstructable.max
integer
alert.filterProperty.land.surface
object
alert.filterProperty.land.surface.min
integer
alert.filterProperty.land.surface.max
integer
alert.filterProperty.land.isServiced
boolean
alert.filterProperty.land.haveWater
boolean
alert.filterProperty.land.haveElectricity
boolean
alert.filterProperty.land.haveTelecom
boolean
alert.filterProperty.location
object[]
alert.filterProperty.location.address
object
alert.filterProperty.location.address.number
string
alert.filterProperty.location.address.streetName
string
alert.filterProperty.location.postalCode
string
alert.filterProperty.location.inseeCode
string
alert.filterProperty.location.irisCode
string
alert.filterProperty.location.department
string
alert.filterProperty.location.city
string
alert.filterProperty.location.locationCoordinate
object
alert.filterProperty.location.locationCoordinate.location
object
alert.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.
alert.filterProperty.location.locationCoordinate.location.preregisteredShape.index
enum<string>
Available options:
UNKNOWN_GEO_INDEX, DEPARTMENT_GEO_INDEX, CITY_GEO_INDEX, REGION_GEO_INDEX alert.filterProperty.location.locationCoordinate.location.preregisteredShape.id
string
alert.filterProperty.location.locationCoordinate.location.geoDistance
object
Matches geopoint values within a given distance of a geopoint (pin).
alert.filterProperty.location.locationCoordinate.location.geoDistance.distanceKm
number
alert.filterProperty.location.locationCoordinate.location.geoDistance.pin
object
alert.filterProperty.location.locationCoordinate.location.geoDistance.pin.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
alert.filterProperty.location.locationCoordinate.location.geoDistance.pin.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
alert.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.
alert.filterProperty.location.locationCoordinate.location.geoBoundingBox.topLeft
object
alert.filterProperty.location.locationCoordinate.location.geoBoundingBox.topLeft.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
alert.filterProperty.location.locationCoordinate.location.geoBoundingBox.topLeft.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
alert.filterProperty.location.locationCoordinate.location.geoBoundingBox.bottomRight
object
alert.filterProperty.location.locationCoordinate.location.geoBoundingBox.bottomRight.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
alert.filterProperty.location.locationCoordinate.location.geoBoundingBox.bottomRight.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
alert.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/)
alert.filterProperty.location.locationCoordinate.location.geoShape.relation
enum<string>
Available options:
UNKNOWN_SPATIAL_RELATION, WITHIN, CONTAINS, DISJOINT, INTERSECTS alert.filterProperty.location.locationCoordinate.location.geoShape.type
enum<string>
Available options:
UNKNOWN_GEO_SHAPE_TYPE, POINT, LINE_STRING, POLYGON, MULTI_POINT, MULTI_LINE_STRING alert.filterProperty.location.locationCoordinate.location.geoShape.coordinates
object[]
alert.filterProperty.location.locationCoordinate.location.geoShape.coordinates.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
alert.filterProperty.location.locationCoordinate.location.geoShape.coordinates.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
alert.filterProperty.location.locationCoordinate.location.geoInseeCodeDistance
object
Matches geopoint values within a given distance of a insee code.
alert.filterProperty.location.locationCoordinate.location.geoInseeCodeDistance.distanceKm
number
alert.filterProperty.location.locationCoordinate.location.geoInseeCodeDistance.inseeCode
string
alert.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
alert.filterProperty.location.locationCoordinate.h3Indices.h3Index1
string
alert.filterProperty.location.locationCoordinate.h3Indices.h3Index2
string
alert.filterProperty.location.locationCoordinate.h3Indices.h3Index3
string
alert.filterProperty.location.locationCoordinate.h3Indices.h3Index4
string
alert.filterProperty.location.locationCoordinate.h3Indices.h3Index5
string
alert.filterProperty.location.locationCoordinate.h3Indices.h3Index6
string
alert.filterProperty.location.locationCoordinate.h3Indices.h3Index7
string
alert.filterProperty.location.locationCoordinate.h3Indices.h3Index8
string
alert.filterProperty.location.locationCoordinate.h3Indices.h3Index9
string
alert.filterProperty.location.locationCoordinate.h3Indices.h3Index10
string
alert.filterProperty.location.locationCoordinate.h3Indices.h3Index11
string
alert.filterProperty.location.locationCoordinate.h3Indices.h3Index12
string
alert.filterProperty.location.cityCoordinate
object
alert.filterProperty.location.cityCoordinate.location
object
alert.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.
alert.filterProperty.location.cityCoordinate.location.preregisteredShape.index
enum<string>
Available options:
UNKNOWN_GEO_INDEX, DEPARTMENT_GEO_INDEX, CITY_GEO_INDEX, REGION_GEO_INDEX alert.filterProperty.location.cityCoordinate.location.preregisteredShape.id
string
alert.filterProperty.location.cityCoordinate.location.geoDistance
object
Matches geopoint values within a given distance of a geopoint (pin).
alert.filterProperty.location.cityCoordinate.location.geoDistance.distanceKm
number
alert.filterProperty.location.cityCoordinate.location.geoDistance.pin
object
alert.filterProperty.location.cityCoordinate.location.geoDistance.pin.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
alert.filterProperty.location.cityCoordinate.location.geoDistance.pin.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
alert.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.
alert.filterProperty.location.cityCoordinate.location.geoBoundingBox.topLeft
object
alert.filterProperty.location.cityCoordinate.location.geoBoundingBox.topLeft.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
alert.filterProperty.location.cityCoordinate.location.geoBoundingBox.topLeft.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
alert.filterProperty.location.cityCoordinate.location.geoBoundingBox.bottomRight
object
alert.filterProperty.location.cityCoordinate.location.geoBoundingBox.bottomRight.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
alert.filterProperty.location.cityCoordinate.location.geoBoundingBox.bottomRight.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
alert.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/)
alert.filterProperty.location.cityCoordinate.location.geoShape.relation
enum<string>
Available options:
UNKNOWN_SPATIAL_RELATION, WITHIN, CONTAINS, DISJOINT, INTERSECTS alert.filterProperty.location.cityCoordinate.location.geoShape.type
enum<string>
Available options:
UNKNOWN_GEO_SHAPE_TYPE, POINT, LINE_STRING, POLYGON, MULTI_POINT, MULTI_LINE_STRING alert.filterProperty.location.cityCoordinate.location.geoShape.coordinates
object[]
alert.filterProperty.location.cityCoordinate.location.geoShape.coordinates.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
alert.filterProperty.location.cityCoordinate.location.geoShape.coordinates.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
alert.filterProperty.location.cityCoordinate.location.geoInseeCodeDistance
object
Matches geopoint values within a given distance of a insee code.
alert.filterProperty.location.cityCoordinate.location.geoInseeCodeDistance.distanceKm
number
alert.filterProperty.location.cityCoordinate.location.geoInseeCodeDistance.inseeCode
string
alert.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
alert.filterProperty.location.cityCoordinate.h3Indices.h3Index1
string
alert.filterProperty.location.cityCoordinate.h3Indices.h3Index2
string
alert.filterProperty.location.cityCoordinate.h3Indices.h3Index3
string
alert.filterProperty.location.cityCoordinate.h3Indices.h3Index4
string
alert.filterProperty.location.cityCoordinate.h3Indices.h3Index5
string
alert.filterProperty.location.cityCoordinate.h3Indices.h3Index6
string
alert.filterProperty.location.cityCoordinate.h3Indices.h3Index7
string
alert.filterProperty.location.cityCoordinate.h3Indices.h3Index8
string
alert.filterProperty.location.cityCoordinate.h3Indices.h3Index9
string
alert.filterProperty.location.cityCoordinate.h3Indices.h3Index10
string
alert.filterProperty.location.cityCoordinate.h3Indices.h3Index11
string
alert.filterProperty.location.cityCoordinate.h3Indices.h3Index12
string
alert.filterProperty.history
object[]
alert.filterProperty.history.seenAt
object
alert.filterProperty.history.seenAt.min
string
alert.filterProperty.history.seenAt.max
string
alert.filterProperty.history.price
object
alert.filterProperty.history.price.min
integer
alert.filterProperty.history.price.max
integer
alert.filterProperty.history.pricePerArea
object
alert.filterProperty.history.pricePerArea.min
integer
alert.filterProperty.history.pricePerArea.max
integer
alert.filterProperty.history.nbDaysPublished
object
alert.filterProperty.history.nbDaysPublished.min
integer
alert.filterProperty.history.nbDaysPublished.max
integer
alert.filterProperty.history.source
object
alert.filterProperty.history.source.website
string
alert.filterProperty.history.source.url
string
alert.filterProperty.history.source.flxId
string
alert.filterProperty.adverts
object[]
alert.filterProperty.adverts.flxId
string[]
alert.filterProperty.adverts.isPro
boolean
alert.filterProperty.adverts.seller
object[]
alert.filterProperty.adverts.seller.type
enum<string>
default: SELLER_TYPE_UNKNOWNAvailable options:
SELLER_TYPE_UNKNOWN, SELLER_TYPE_AGENCY, SELLER_TYPE_NETWORK alert.filterProperty.adverts.seller.flxId
string
alert.filterProperty.adverts.seller.name
string
alert.filterProperty.adverts.seller.siren
string
alert.filterProperty.adverts.contactInCharge
object
alert.filterProperty.adverts.contactInCharge.firstName
string
alert.filterProperty.adverts.contactInCharge.lastName
string
alert.filterProperty.adverts.contactInCharge.phoneNumber
string
alert.filterProperty.adverts.contactInCharge.email
string
alert.filterProperty.adverts.contactInCharge.pseudonym
string
alert.filterProperty.adverts.source
object
alert.filterProperty.adverts.source.website
string
alert.filterProperty.adverts.source.url
string
alert.filterProperty.adverts.source.flxId
string
alert.filterProperty.adverts.title
string[]
alert.filterProperty.adverts.description
string[]
alert.filterProperty.adverts.isOnline
boolean
alert.filterProperty.adverts.firstSeenAt
object
alert.filterProperty.adverts.firstSeenAt.min
string
alert.filterProperty.adverts.firstSeenAt.max
string
alert.filterProperty.adverts.lastUpdatedAt
object
alert.filterProperty.adverts.lastUpdatedAt.min
string
alert.filterProperty.adverts.lastUpdatedAt.max
string
alert.filterProperty.adverts.firstPublishedAt
object
alert.filterProperty.adverts.firstPublishedAt.min
string
alert.filterProperty.adverts.firstPublishedAt.max
string
alert.filterProperty.adverts.lastSeenAt
object
alert.filterProperty.adverts.lastSeenAt.min
string
alert.filterProperty.adverts.lastSeenAt.max
string
alert.filterProperty.adverts.price
object
alert.filterProperty.adverts.price.latest
object
alert.filterProperty.adverts.price.latest.value
object
alert.filterProperty.adverts.price.latest.value.min
integer
alert.filterProperty.adverts.price.latest.value.max
integer
alert.filterProperty.adverts.price.latest.valuePerArea
object
alert.filterProperty.adverts.price.latest.valuePerArea.min
integer
alert.filterProperty.adverts.price.latest.valuePerArea.max
integer
alert.filterProperty.adverts.price.latest.source
object
alert.filterProperty.adverts.price.latest.source.website
string
alert.filterProperty.adverts.price.latest.source.url
string
alert.filterProperty.adverts.price.latest.source.flxId
string
alert.filterProperty.adverts.price.lowest
object
alert.filterProperty.adverts.price.lowest.value
object
alert.filterProperty.adverts.price.lowest.value.min
integer
alert.filterProperty.adverts.price.lowest.value.max
integer
alert.filterProperty.adverts.price.lowest.valuePerArea
object
alert.filterProperty.adverts.price.lowest.valuePerArea.min
integer
alert.filterProperty.adverts.price.lowest.valuePerArea.max
integer
alert.filterProperty.adverts.price.lowest.source
object
alert.filterProperty.adverts.price.lowest.source.website
string
alert.filterProperty.adverts.price.lowest.source.url
string
alert.filterProperty.adverts.price.lowest.source.flxId
string
alert.filterProperty.adverts.price.highest
object
alert.filterProperty.adverts.price.highest.value
object
alert.filterProperty.adverts.price.highest.value.min
integer
alert.filterProperty.adverts.price.highest.value.max
integer
alert.filterProperty.adverts.price.highest.valuePerArea
object
alert.filterProperty.adverts.price.highest.valuePerArea.min
integer
alert.filterProperty.adverts.price.highest.valuePerArea.max
integer
alert.filterProperty.adverts.price.highest.source
object
alert.filterProperty.adverts.price.highest.source.website
string
alert.filterProperty.adverts.price.highest.source.url
string
alert.filterProperty.adverts.price.highest.source.flxId
string
alert.filterProperty.adverts.price.initial
object
alert.filterProperty.adverts.price.initial.value
object
alert.filterProperty.adverts.price.initial.value.min
integer
alert.filterProperty.adverts.price.initial.value.max
integer
alert.filterProperty.adverts.price.initial.valuePerArea
object
alert.filterProperty.adverts.price.initial.valuePerArea.min
integer
alert.filterProperty.adverts.price.initial.valuePerArea.max
integer
alert.filterProperty.adverts.price.initial.source
object
alert.filterProperty.adverts.price.initial.source.website
string
alert.filterProperty.adverts.price.initial.source.url
string
alert.filterProperty.adverts.price.initial.source.flxId
string
alert.filterProperty.adverts.price.warrantyDeposit
object
alert.filterProperty.adverts.price.warrantyDeposit.min
integer
alert.filterProperty.adverts.price.warrantyDeposit.max
integer
alert.filterProperty.adverts.price.charges
object
alert.filterProperty.adverts.price.charges.yearlyRentalFees
number
alert.filterProperty.adverts.price.charges.yearlyCondoniumFees
number
alert.filterProperty.adverts.price.charges.yearlyHeatingFees
number
alert.filterProperty.adverts.price.charges.yearlyElectricityFees
number
alert.filterProperty.adverts.price.charges.yearlyHousingTax
number
alert.filterProperty.adverts.price.charges.yearlyLivingTax
number
alert.filterProperty.adverts.price.charges.monthlyRentSupplement
number
alert.filterProperty.adverts.price.isAuction
boolean
alert.filterProperty.adverts.price.scope
enum<string>[]
Available options:
PRICING_ONE_OFF, PRICING_MENSUAL alert.filterProperty.adverts.price.currency
enum<string>[]
Available options:
CURRENCY_EUR, CURRENCY_USD alert.filterProperty.adverts.price.variation
object[]
alert.filterProperty.adverts.price.variation.sincePublished
object
alert.filterProperty.adverts.price.variation.sincePublished.min
number
alert.filterProperty.adverts.price.variation.sincePublished.max
number
alert.filterProperty.adverts.price.variation.sinceLastModified
object
alert.filterProperty.adverts.price.variation.sinceLastModified.min
number
alert.filterProperty.adverts.price.variation.sinceLastModified.max
number
alert.filterProperty.adverts.location
object
alert.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.
alert.filterProperty.adverts.location.preregisteredShape.index
enum<string>
Available options:
UNKNOWN_GEO_INDEX, DEPARTMENT_GEO_INDEX, CITY_GEO_INDEX, REGION_GEO_INDEX alert.filterProperty.adverts.location.preregisteredShape.id
string
alert.filterProperty.adverts.location.geoDistance
object
Matches geopoint values within a given distance of a geopoint (pin).
alert.filterProperty.adverts.location.geoDistance.distanceKm
number
alert.filterProperty.adverts.location.geoDistance.pin
object
alert.filterProperty.adverts.location.geoDistance.pin.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
alert.filterProperty.adverts.location.geoDistance.pin.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
alert.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.
alert.filterProperty.adverts.location.geoBoundingBox.topLeft
object
alert.filterProperty.adverts.location.geoBoundingBox.topLeft.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
alert.filterProperty.adverts.location.geoBoundingBox.topLeft.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
alert.filterProperty.adverts.location.geoBoundingBox.bottomRight
object
alert.filterProperty.adverts.location.geoBoundingBox.bottomRight.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
alert.filterProperty.adverts.location.geoBoundingBox.bottomRight.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
alert.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/)
alert.filterProperty.adverts.location.geoShape.relation
enum<string>
Available options:
UNKNOWN_SPATIAL_RELATION, WITHIN, CONTAINS, DISJOINT, INTERSECTS alert.filterProperty.adverts.location.geoShape.type
enum<string>
Available options:
UNKNOWN_GEO_SHAPE_TYPE, POINT, LINE_STRING, POLYGON, MULTI_POINT, MULTI_LINE_STRING alert.filterProperty.adverts.location.geoShape.coordinates
object[]
alert.filterProperty.adverts.location.geoShape.coordinates.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
alert.filterProperty.adverts.location.geoShape.coordinates.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
alert.filterProperty.adverts.location.geoInseeCodeDistance
object
Matches geopoint values within a given distance of a insee code.
alert.filterProperty.adverts.location.geoInseeCodeDistance.distanceKm
number
alert.filterProperty.adverts.location.geoInseeCodeDistance.inseeCode
string
alert.filterProperty.adverts.hasAnomaly
boolean
alert.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 alert.filterProperty.adverts.isExclusive
boolean
alert.filterProperty.isCityCenter
boolean
alert.filterProperty.hasAnomaly
boolean
alert.filterProperty.estimatedPrice
object
alert.filterProperty.estimatedPrice.value
object
alert.filterProperty.estimatedPrice.value.min
integer
alert.filterProperty.estimatedPrice.value.max
integer
alert.filterProperty.estimatedPrice.valuePerArea
object
alert.filterProperty.estimatedPrice.valuePerArea.min
integer
alert.filterProperty.estimatedPrice.valuePerArea.max
integer
alert.filterProperty.estimatedPrice.source
object
alert.filterProperty.estimatedPrice.source.website
string
alert.filterProperty.estimatedPrice.source.url
string
alert.filterProperty.estimatedPrice.source.flxId
string
alert.filterProperty.imagesLength
object
alert.filterProperty.imagesLength.min
integer
alert.filterProperty.imagesLength.max
integer
alert.filterProperty.advertsLength
object
alert.filterProperty.advertsLength.min
integer
alert.filterProperty.advertsLength.max
integer
alert.filterProperty.historyLength
object
alert.filterProperty.historyLength.min
integer
alert.filterProperty.historyLength.max
integer
alert.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 isActive
boolean
match
enum<string>[]
Available options:
ALERT_MATCH_UNKNOWN, ALERT_MATCH_PRICE, ALERT_MATCH_CREATED, ALERT_MATCH_OFFLINE, ALERT_MATCH_MERGED context
object
context.metadata
object
Was this page helpful?