CreateAdsAlert - The alert is an ISO's version of the SearchAds query. Once the alert is created it will be available to be match against any new property created.
CreateAdsAlert - The alert is an ISO's version of the SearchAds query. Once the alert is created it will be available to be match against any new property created.
PUT
/
v2
/
alert
/
ads
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
*
alert
object
alert
object
fullTexts
array
fullTexts
array
keywords
array
keywords
array
filterAd
object
filterAd
object
firstSeenAt
array
firstSeenAt
array
firstPublishedAt
array
firstPublishedAt
array
lastModifiedAt
array
lastModifiedAt
array
offlineAt
array
offlineAt
array
tags
array
tags
array
isUrgent
boolean
isUrgent
boolean
offer
array
offer
array
type
array
type
array
process
array
process
array
currentPrice
object
currentPrice
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
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
warrantyDeposit
object
warrantyDeposit
object
min
number
min
number
max
number
max
number
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
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
source
object
source
object
website
string
website
string
url
string
url
string
flxId
string
flxId
string
location
object
location
object
address
object
address
object
number
string
number
string
streetName
string
streetName
string
postalCode
string
postalCode
string
inseeCode
string
inseeCode
string
irisCode
string
irisCode
string
department
string
department
string
city
string
city
string
locationCoordinate
object
locationCoordinate
object
location
object
location
object
preregisteredShape
PreregisteredShape · object
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.
index
enum<string>
index
enum<string>
id
string
id
string
geoDistance
GeoDistance · object
geoDistance
object
Matches geopoint values within a given distance of a geopoint (pin).
distanceKm
number
distanceKm
number
pin
object
pin
object
lat
number
lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
lon
number
lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
geoBoundingBox
GeoBoundingBox · object
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.
topLeft
object
topLeft
object
lat
number
lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
lon
number
lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
bottomRight
object
bottomRight
object
lat
number
lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
lon
number
lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
geoShape
GeoShape · object
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/)
relation
enum<string>
relation
enum<string>
type
enum<string>
type
enum<string>
coordinates
array
coordinates
array
geoInseeCodeDistance
GeoInseeCodeDistance · object
geoInseeCodeDistance
object
Matches geopoint values within a given distance of a insee code.
distanceKm
number
distanceKm
number
inseeCode
string
inseeCode
string
h3Indices
H3Index · object
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
h3Index1
string
h3Index1
string
h3Index2
string
h3Index2
string
h3Index3
string
h3Index3
string
h3Index4
string
h3Index4
string
h3Index5
string
h3Index5
string
h3Index6
string
h3Index6
string
h3Index7
string
h3Index7
string
h3Index8
string
h3Index8
string
h3Index9
string
h3Index9
string
h3Index10
string
h3Index10
string
h3Index11
string
h3Index11
string
h3Index12
string
h3Index12
string
cityCoordinate
object
cityCoordinate
object
location
object
location
object
preregisteredShape
PreregisteredShape · object
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.
index
enum<string>
index
enum<string>
id
string
id
string
geoDistance
GeoDistance · object
geoDistance
object
Matches geopoint values within a given distance of a geopoint (pin).
distanceKm
number
distanceKm
number
pin
object
pin
object
lat
number
lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
lon
number
lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
geoBoundingBox
GeoBoundingBox · object
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.
topLeft
object
topLeft
object
lat
number
lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
lon
number
lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
bottomRight
object
bottomRight
object
lat
number
lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
lon
number
lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
geoShape
GeoShape · object
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/)
relation
enum<string>
relation
enum<string>
type
enum<string>
type
enum<string>
coordinates
array
coordinates
array
geoInseeCodeDistance
GeoInseeCodeDistance · object
geoInseeCodeDistance
object
Matches geopoint values within a given distance of a insee code.
distanceKm
number
distanceKm
number
inseeCode
string
inseeCode
string
h3Indices
H3Index · object
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
h3Index1
string
h3Index1
string
h3Index2
string
h3Index2
string
h3Index3
string
h3Index3
string
h3Index4
string
h3Index4
string
h3Index5
string
h3Index5
string
h3Index6
string
h3Index6
string
h3Index7
string
h3Index7
string
h3Index8
string
h3Index8
string
h3Index9
string
h3Index9
string
h3Index10
string
h3Index10
string
h3Index11
string
h3Index11
string
h3Index12
string
h3Index12
string
hasAnomaly
boolean
hasAnomaly
boolean
anomalies
array
anomalies
array
isPro
boolean
isPro
boolean
seller
array
seller
array
contactInCharge
object
contactInCharge
object
firstName
string
firstName
string
lastName
string
lastName
string
phoneNumber
string
phoneNumber
string
email
string
email
string
pseudonym
string
pseudonym
string
isKnownProperty
boolean
isKnownProperty
boolean
mainPropertyAdFlxId
array
mainPropertyAdFlxId
array
propertyFlxId
array
propertyFlxId
array
isOnline
boolean
isOnline
boolean
isExclusive
boolean
isExclusive
boolean
isActive
boolean
isActive
boolean
match
array
match
array
context
object
context
object
metadata
object
metadata
object
Authorizations
x-api-key
string
headerrequiredAPI Key used to be authentified to these APIs. Please contact Fluximmo to get one
Body
application/json
alert
object
alert.fullTexts
string[]
alert.keywords
string[]
alert.filterAd
object
alert.filterAd.firstSeenAt
object[]
alert.filterAd.firstSeenAt.min
string
alert.filterAd.firstSeenAt.max
string
alert.filterAd.firstPublishedAt
object[]
alert.filterAd.firstPublishedAt.min
string
alert.filterAd.firstPublishedAt.max
string
alert.filterAd.lastModifiedAt
object[]
alert.filterAd.lastModifiedAt.min
string
alert.filterAd.lastModifiedAt.max
string
alert.filterAd.offlineAt
object[]
alert.filterAd.offlineAt.min
string
alert.filterAd.offlineAt.max
string
alert.filterAd.tags
string[]
alert.filterAd.isUrgent
boolean
alert.filterAd.offer
object[]
alert.filterAd.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.filterAd.offer.renting
object
alert.filterAd.offer.renting.isSubLease
boolean
alert.filterAd.offer.renting.isShortTerm
boolean
alert.filterAd.offer.renting.isLongTerm
boolean
alert.filterAd.offer.renting.isColocation
boolean
alert.filterAd.offer.isCurrentlyOccupied
boolean
alert.filterAd.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.filterAd.process
enum<string>[]
Available options:
PROCESS_UNKNOWN, PROCESS_AVAILABLE_ON_MARKET, PROCESS_UNDER_COMPROMISE, PROCESS_RENTED_SOLD, PROCESS_REMOVED, PROCESS_RESERVED, PROCESS_ARCHIVED alert.filterAd.currentPrice
object
alert.filterAd.currentPrice.value
object
alert.filterAd.currentPrice.value.min
integer
alert.filterAd.currentPrice.value.max
integer
alert.filterAd.currentPrice.valuePerArea
object
alert.filterAd.currentPrice.valuePerArea.min
integer
alert.filterAd.currentPrice.valuePerArea.max
integer
alert.filterAd.currentPrice.source
object
alert.filterAd.currentPrice.source.website
string
alert.filterAd.currentPrice.source.url
string
alert.filterAd.currentPrice.source.flxId
string
alert.filterAd.estimatedPrice
object
alert.filterAd.estimatedPrice.value
object
alert.filterAd.estimatedPrice.value.min
integer
alert.filterAd.estimatedPrice.value.max
integer
alert.filterAd.estimatedPrice.valuePerArea
object
alert.filterAd.estimatedPrice.valuePerArea.min
integer
alert.filterAd.estimatedPrice.valuePerArea.max
integer
alert.filterAd.estimatedPrice.source
object
alert.filterAd.estimatedPrice.source.website
string
alert.filterAd.estimatedPrice.source.url
string
alert.filterAd.estimatedPrice.source.flxId
string
alert.filterAd.warrantyDeposit
object
alert.filterAd.warrantyDeposit.min
number
alert.filterAd.warrantyDeposit.max
number
alert.filterAd.charges
object
alert.filterAd.charges.yearlyRentalFees
number
alert.filterAd.charges.yearlyCondoniumFees
number
alert.filterAd.charges.yearlyHeatingFees
number
alert.filterAd.charges.yearlyElectricityFees
number
alert.filterAd.charges.yearlyHousingTax
number
alert.filterAd.charges.yearlyLivingTax
number
alert.filterAd.charges.monthlyRentSupplement
number
alert.filterAd.isAuction
boolean
alert.filterAd.scope
enum<string>[]
Available options:
PRICING_ONE_OFF, PRICING_MENSUAL alert.filterAd.currency
enum<string>[]
Available options:
CURRENCY_EUR, CURRENCY_USD alert.filterAd.habitation
object
alert.filterAd.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.filterAd.habitation.roomCount
object
alert.filterAd.habitation.roomCount.min
integer
alert.filterAd.habitation.roomCount.max
integer
alert.filterAd.habitation.bedroomCount
object
alert.filterAd.habitation.bedroomCount.min
integer
alert.filterAd.habitation.bedroomCount.max
integer
alert.filterAd.habitation.bathroomCount
object
alert.filterAd.habitation.bathroomCount.min
integer
alert.filterAd.habitation.bathroomCount.max
integer
alert.filterAd.habitation.wcCount
object
alert.filterAd.habitation.wcCount.min
integer
alert.filterAd.habitation.wcCount.max
integer
alert.filterAd.habitation.roomsDetails
object[]
alert.filterAd.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.filterAd.habitation.roomsDetails.area
number
alert.filterAd.habitation.roomsDetails.floor
integer
alert.filterAd.habitation.roomsDetails.contextInfo
string[]
alert.filterAd.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.filterAd.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.filterAd.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.filterAd.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.filterAd.habitation.features
object
alert.filterAd.habitation.features.propertyTotalFloor
object
alert.filterAd.habitation.features.propertyTotalFloor.min
integer
alert.filterAd.habitation.features.propertyTotalFloor.max
integer
alert.filterAd.habitation.features.propertyFloor
object
alert.filterAd.habitation.features.propertyFloor.min
integer
alert.filterAd.habitation.features.propertyFloor.max
integer
alert.filterAd.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.filterAd.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.filterAd.habitation.features.furniture
enum<string>[]
Available options:
UNKNOWN_FURNITURE, UNFURNISHED, PARTIALLY_FURNISHED, FULLY_FURNISHED alert.filterAd.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.filterAd.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.filterAd.habitation.features.glazingTypes
enum<string>[]
Available options:
GLAZING_TYPE_UNKNOWN, GLAZING_TYPE_SIMPLE, GLAZING_TYPE_DOUBLE, GLAZING_TYPE_TRIPLE alert.filterAd.habitation.features.hasThroughExposure
boolean
alert.filterAd.habitation.characteristics
object
alert.filterAd.habitation.characteristics.hasLift
boolean
alert.filterAd.habitation.characteristics.hasCellar
boolean
alert.filterAd.habitation.characteristics.hasBalcony
boolean
alert.filterAd.habitation.characteristics.hasTerrace
boolean
alert.filterAd.habitation.characteristics.hasGarden
boolean
alert.filterAd.habitation.characteristics.hasFireplace
boolean
alert.filterAd.habitation.characteristics.hasGrenier
boolean
alert.filterAd.habitation.characteristics.hasPool
boolean
alert.filterAd.habitation.characteristics.hasParking
boolean
alert.filterAd.habitation.characteristics.hasGarage
boolean
alert.filterAd.habitation.characteristics.hasLand
boolean
alert.filterAd.habitation.characteristics.hasConcierge
boolean
alert.filterAd.habitation.characteristics.hasDigicode
boolean
alert.filterAd.habitation.characteristics.hasInterphone
boolean
alert.filterAd.habitation.characteristics.hasAlarm
boolean
alert.filterAd.habitation.characteristics.hasVisAVis
boolean
alert.filterAd.habitation.characteristics.isPeaceful
boolean
alert.filterAd.habitation.characteristics.hasMezzanine
boolean
alert.filterAd.habitation.characteristics.hasJacuzzi
boolean
alert.filterAd.habitation.climate
object
alert.filterAd.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.filterAd.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.filterAd.habitation.climate.epcEnergyScore
object
alert.filterAd.habitation.climate.epcEnergyScore.min
integer
alert.filterAd.habitation.climate.epcEnergyScore.max
integer
alert.filterAd.habitation.climate.epcClimateScore
object
alert.filterAd.habitation.climate.epcClimateScore.min
integer
alert.filterAd.habitation.climate.epcClimateScore.max
integer
alert.filterAd.habitation.climate.epcClimateDate
object
alert.filterAd.habitation.climate.epcClimateDate.min
string
alert.filterAd.habitation.climate.epcClimateDate.max
string
alert.filterAd.habitation.climate.epcEnergyDate
object
alert.filterAd.habitation.climate.epcEnergyDate.min
string
alert.filterAd.habitation.climate.epcEnergyDate.max
string
alert.filterAd.habitation.propertyCondition
object[]
alert.filterAd.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.filterAd.habitation.propertyCondition.constructionYear
integer
alert.filterAd.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.filterAd.habitation.propertyCondition.renovationYear
integer
alert.filterAd.habitation.surface
object
alert.filterAd.habitation.surface.total
object
alert.filterAd.habitation.surface.total.min
integer
alert.filterAd.habitation.surface.total.max
integer
alert.filterAd.habitation.surface.livingSpace
object
alert.filterAd.habitation.surface.livingSpace.min
integer
alert.filterAd.habitation.surface.livingSpace.max
integer
alert.filterAd.habitation.surface.floorSpace
object
alert.filterAd.habitation.surface.floorSpace.min
integer
alert.filterAd.habitation.surface.floorSpace.max
integer
alert.filterAd.habitation.surface.livingroom
object
alert.filterAd.habitation.surface.livingroom.min
integer
alert.filterAd.habitation.surface.livingroom.max
integer
alert.filterAd.habitation.surface.kitchen
object
alert.filterAd.habitation.surface.kitchen.min
integer
alert.filterAd.habitation.surface.kitchen.max
integer
alert.filterAd.habitation.surface.groundFloor
object
alert.filterAd.habitation.surface.groundFloor.min
integer
alert.filterAd.habitation.surface.groundFloor.max
integer
alert.filterAd.habitation.surface.balconies
object
alert.filterAd.habitation.surface.balconies.min
integer
alert.filterAd.habitation.surface.balconies.max
integer
alert.filterAd.habitation.surface.terraces
object
alert.filterAd.habitation.surface.terraces.min
integer
alert.filterAd.habitation.surface.terraces.max
integer
alert.filterAd.habitation.surface.gardens
object
alert.filterAd.habitation.surface.gardens.min
integer
alert.filterAd.habitation.surface.gardens.max
integer
alert.filterAd.parking
object
alert.filterAd.parking.type
enum<string>[]
Available options:
PARKING_UNKNOWN, PARKING_GARAGE, PARKING_PARKING alert.filterAd.parking.count
object
alert.filterAd.parking.count.min
integer
alert.filterAd.parking.count.max
integer
alert.filterAd.parking.numberOfCars
object
alert.filterAd.parking.numberOfCars.min
integer
alert.filterAd.parking.numberOfCars.max
integer
alert.filterAd.parking.surface
object
alert.filterAd.parking.surface.min
integer
alert.filterAd.parking.surface.max
integer
alert.filterAd.land
object
alert.filterAd.land.type
enum<string>[]
Available options:
LAND_UNKNOWN, LAND_BUILDING_PLOT, LAND_AGRICULTURAL, LAND_VINEYARD, LAND_INDUSTRIAL, LAND_POND, LAND_FOREST alert.filterAd.land.haveBuildingPermit
boolean
alert.filterAd.land.canConstruct
boolean
alert.filterAd.land.surfaceConstructable
object
alert.filterAd.land.surfaceConstructable.min
integer
alert.filterAd.land.surfaceConstructable.max
integer
alert.filterAd.land.surface
object
alert.filterAd.land.surface.min
integer
alert.filterAd.land.surface.max
integer
alert.filterAd.land.isServiced
boolean
alert.filterAd.land.haveWater
boolean
alert.filterAd.land.haveElectricity
boolean
alert.filterAd.land.haveTelecom
boolean
alert.filterAd.source
object
alert.filterAd.source.website
string
alert.filterAd.source.url
string
alert.filterAd.source.flxId
string
alert.filterAd.location
object
alert.filterAd.location.address
object
alert.filterAd.location.address.number
string
alert.filterAd.location.address.streetName
string
alert.filterAd.location.postalCode
string
alert.filterAd.location.inseeCode
string
alert.filterAd.location.irisCode
string
alert.filterAd.location.department
string
alert.filterAd.location.city
string
alert.filterAd.location.locationCoordinate
object
alert.filterAd.location.locationCoordinate.location
object
alert.filterAd.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.filterAd.location.locationCoordinate.location.preregisteredShape.index
enum<string>
Available options:
UNKNOWN_GEO_INDEX, DEPARTMENT_GEO_INDEX, CITY_GEO_INDEX, REGION_GEO_INDEX alert.filterAd.location.locationCoordinate.location.preregisteredShape.id
string
alert.filterAd.location.locationCoordinate.location.geoDistance
object
Matches geopoint values within a given distance of a geopoint (pin).
alert.filterAd.location.locationCoordinate.location.geoDistance.distanceKm
number
alert.filterAd.location.locationCoordinate.location.geoDistance.pin
object
alert.filterAd.location.locationCoordinate.location.geoDistance.pin.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
alert.filterAd.location.locationCoordinate.location.geoDistance.pin.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
alert.filterAd.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.filterAd.location.locationCoordinate.location.geoBoundingBox.topLeft
object
alert.filterAd.location.locationCoordinate.location.geoBoundingBox.topLeft.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
alert.filterAd.location.locationCoordinate.location.geoBoundingBox.topLeft.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
alert.filterAd.location.locationCoordinate.location.geoBoundingBox.bottomRight
object
alert.filterAd.location.locationCoordinate.location.geoBoundingBox.bottomRight.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
alert.filterAd.location.locationCoordinate.location.geoBoundingBox.bottomRight.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
alert.filterAd.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.filterAd.location.locationCoordinate.location.geoShape.relation
enum<string>
Available options:
UNKNOWN_SPATIAL_RELATION, WITHIN, CONTAINS, DISJOINT, INTERSECTS alert.filterAd.location.locationCoordinate.location.geoShape.type
enum<string>
Available options:
UNKNOWN_GEO_SHAPE_TYPE, POINT, LINE_STRING, POLYGON, MULTI_POINT, MULTI_LINE_STRING alert.filterAd.location.locationCoordinate.location.geoShape.coordinates
object[]
alert.filterAd.location.locationCoordinate.location.geoShape.coordinates.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
alert.filterAd.location.locationCoordinate.location.geoShape.coordinates.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
alert.filterAd.location.locationCoordinate.location.geoInseeCodeDistance
object
Matches geopoint values within a given distance of a insee code.
alert.filterAd.location.locationCoordinate.location.geoInseeCodeDistance.distanceKm
number
alert.filterAd.location.locationCoordinate.location.geoInseeCodeDistance.inseeCode
string
alert.filterAd.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.filterAd.location.locationCoordinate.h3Indices.h3Index1
string
alert.filterAd.location.locationCoordinate.h3Indices.h3Index2
string
alert.filterAd.location.locationCoordinate.h3Indices.h3Index3
string
alert.filterAd.location.locationCoordinate.h3Indices.h3Index4
string
alert.filterAd.location.locationCoordinate.h3Indices.h3Index5
string
alert.filterAd.location.locationCoordinate.h3Indices.h3Index6
string
alert.filterAd.location.locationCoordinate.h3Indices.h3Index7
string
alert.filterAd.location.locationCoordinate.h3Indices.h3Index8
string
alert.filterAd.location.locationCoordinate.h3Indices.h3Index9
string
alert.filterAd.location.locationCoordinate.h3Indices.h3Index10
string
alert.filterAd.location.locationCoordinate.h3Indices.h3Index11
string
alert.filterAd.location.locationCoordinate.h3Indices.h3Index12
string
alert.filterAd.location.cityCoordinate
object
alert.filterAd.location.cityCoordinate.location
object
alert.filterAd.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.filterAd.location.cityCoordinate.location.preregisteredShape.index
enum<string>
Available options:
UNKNOWN_GEO_INDEX, DEPARTMENT_GEO_INDEX, CITY_GEO_INDEX, REGION_GEO_INDEX alert.filterAd.location.cityCoordinate.location.preregisteredShape.id
string
alert.filterAd.location.cityCoordinate.location.geoDistance
object
Matches geopoint values within a given distance of a geopoint (pin).
alert.filterAd.location.cityCoordinate.location.geoDistance.distanceKm
number
alert.filterAd.location.cityCoordinate.location.geoDistance.pin
object
alert.filterAd.location.cityCoordinate.location.geoDistance.pin.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
alert.filterAd.location.cityCoordinate.location.geoDistance.pin.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
alert.filterAd.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.filterAd.location.cityCoordinate.location.geoBoundingBox.topLeft
object
alert.filterAd.location.cityCoordinate.location.geoBoundingBox.topLeft.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
alert.filterAd.location.cityCoordinate.location.geoBoundingBox.topLeft.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
alert.filterAd.location.cityCoordinate.location.geoBoundingBox.bottomRight
object
alert.filterAd.location.cityCoordinate.location.geoBoundingBox.bottomRight.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
alert.filterAd.location.cityCoordinate.location.geoBoundingBox.bottomRight.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
alert.filterAd.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.filterAd.location.cityCoordinate.location.geoShape.relation
enum<string>
Available options:
UNKNOWN_SPATIAL_RELATION, WITHIN, CONTAINS, DISJOINT, INTERSECTS alert.filterAd.location.cityCoordinate.location.geoShape.type
enum<string>
Available options:
UNKNOWN_GEO_SHAPE_TYPE, POINT, LINE_STRING, POLYGON, MULTI_POINT, MULTI_LINE_STRING alert.filterAd.location.cityCoordinate.location.geoShape.coordinates
object[]
alert.filterAd.location.cityCoordinate.location.geoShape.coordinates.lat
number
The latitude in degrees. It must be in the range [-90.0, +90.0].
alert.filterAd.location.cityCoordinate.location.geoShape.coordinates.lon
number
The longitude in degrees. It must be in the range [-180.0, +180.0].
alert.filterAd.location.cityCoordinate.location.geoInseeCodeDistance
object
Matches geopoint values within a given distance of a insee code.
alert.filterAd.location.cityCoordinate.location.geoInseeCodeDistance.distanceKm
number
alert.filterAd.location.cityCoordinate.location.geoInseeCodeDistance.inseeCode
string
alert.filterAd.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.filterAd.location.cityCoordinate.h3Indices.h3Index1
string
alert.filterAd.location.cityCoordinate.h3Indices.h3Index2
string
alert.filterAd.location.cityCoordinate.h3Indices.h3Index3
string
alert.filterAd.location.cityCoordinate.h3Indices.h3Index4
string
alert.filterAd.location.cityCoordinate.h3Indices.h3Index5
string
alert.filterAd.location.cityCoordinate.h3Indices.h3Index6
string
alert.filterAd.location.cityCoordinate.h3Indices.h3Index7
string
alert.filterAd.location.cityCoordinate.h3Indices.h3Index8
string
alert.filterAd.location.cityCoordinate.h3Indices.h3Index9
string
alert.filterAd.location.cityCoordinate.h3Indices.h3Index10
string
alert.filterAd.location.cityCoordinate.h3Indices.h3Index11
string
alert.filterAd.location.cityCoordinate.h3Indices.h3Index12
string
alert.filterAd.hasAnomaly
boolean
alert.filterAd.anomalies
string[]
alert.filterAd.isPro
boolean
alert.filterAd.seller
object[]
alert.filterAd.seller.type
enum<string>
default: SELLER_TYPE_UNKNOWNAvailable options:
SELLER_TYPE_UNKNOWN, SELLER_TYPE_AGENCY, SELLER_TYPE_NETWORK alert.filterAd.seller.flxId
string
alert.filterAd.seller.name
string
alert.filterAd.seller.siren
string
alert.filterAd.contactInCharge
object
alert.filterAd.contactInCharge.firstName
string
alert.filterAd.contactInCharge.lastName
string
alert.filterAd.contactInCharge.phoneNumber
string
alert.filterAd.contactInCharge.email
string
alert.filterAd.contactInCharge.pseudonym
string
alert.filterAd.isKnownProperty
boolean
alert.filterAd.mainPropertyAdFlxId
string[]
alert.filterAd.propertyFlxId
string[]
alert.filterAd.isOnline
boolean
alert.filterAd.isExclusive
boolean
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
Response
200 - application/json
kind
string
internalDelay
integer
created
string
updated
string
deleted
string
noop
string
Was this page helpful?