Adverts Alerts
Get the search criteria of an Advert alert
System
- System
Properties
- Samples
- Properties
- Reporting
- Properties Alerts
Adverts
RealEstate Companies
- Agency details
Adverts Alerts
Get the search criteria of an Advert alert
Get the search criteria of an Advert alert by its id (alertId)
GET
/
v2
/
protected
/
adverts
/
search
/
alerts
/
{alertId}
curl --request GET \
--url https://api.fluximmo.io/v2/protected/adverts/search/alerts/{alertId} \
--header 'x-api-key: <api-key>'{
"data": {
"search_query": {
"filterAd": {
"currentPrice": {
"value": {
"max": 123,
"min": 123
},
"valuePerArea": {
"max": 123,
"min": 123
}
},
"habitation": {
"bathroomCount": {
"max": 123,
"min": 123
},
"bedroomCount": {
"max": 123,
"min": 123
},
"characteristics": {
"hasAlarm": true,
"hasBalcony": true,
"hasCellar": true,
"hasConcierge": true,
"hasDigicode": true,
"hasFireplace": true,
"hasGarage": true,
"hasGarden": true,
"hasGrenier": true,
"hasInterphone": true,
"hasJacuzzi": true,
"hasLand": true,
"hasLift": true,
"hasMezzanine": true,
"hasParking": true,
"hasPool": true,
"hasTerrace": true,
"hasVisAVis": true,
"isPeaceful": true
},
"climate": {
"epcClimate": [],
"epcClimateScore": {
"max": 123,
"min": 123
},
"epcEnergy": [],
"epcEnergyScore": {
"max": 123,
"min": 123
},
"epcClimateDate": {
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
},
"epcEnergyDate": {
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
}
},
"features": {
"exposure": [],
"furniture": [],
"propertyFloor": {
"max": 123,
"min": 123
},
"propertyTotalFloor": {
"max": 123,
"min": 123
},
"constructionMaterials": [],
"glazingTypes": [],
"hasThroughExposure": true,
"viewOns": [],
"viewTypes": []
},
"heatTypes": [],
"heatTypeDetails": [],
"heatings": [],
"propertyCondition": [
{
"constructionYear": 123,
"interiorCondition": null,
"renovationYear": 123,
"generalConditions": []
}
],
"roomCount": {
"max": 123,
"min": 123
},
"surface": {
"balconies": {
"max": 123,
"min": 123
},
"floorSpace": {
"max": 123,
"min": 123
},
"gardens": {
"max": 123,
"min": 123
},
"groundFloor": {
"max": 123,
"min": 123
},
"kitchen": {
"max": 123,
"min": 123
},
"livingSpace": {
"max": 123,
"min": 123
},
"livingroom": {
"max": 123,
"min": 123
},
"terraces": {
"max": 123,
"min": 123
},
"total": {
"max": 123,
"min": 123
}
},
"type": "PROPERTY_TYPE_T1_T2",
"wcCount": {
"max": 123,
"min": 123
}
},
"hasAnomaly": true,
"isAuction": true,
"isUrgent": true,
"land": {
"canConstruct": true,
"isServiced": true,
"surface": {
"max": 123,
"min": 123
},
"surfaceConstructable": {
"max": 123,
"min": 123
},
"type": [],
"haveBuildingPermit": true,
"haveElectricity": true,
"haveTelecom": true,
"haveWater": true
},
"lastModifiedAt": [
{
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
}
],
"offer": [
{
"isCurrentlyOccupied": true,
"renting": {
"isColocation": true,
"isLongTerm": true,
"isShortTerm": true,
"isSubLease": true
},
"type": "OFFER_BUY"
}
],
"parking": {
"count": {
"max": 123,
"min": 123
},
"numberOfCars": {
"max": 123,
"min": 123
},
"surface": {
"max": 123,
"min": 123
},
"type": []
},
"process": [],
"scope": [],
"tags": [
"<string>"
],
"type": [
"CLASS_HOUSE"
],
"warrantyDeposit": {
"max": 123,
"min": 123
},
"firstSeenAt": [
{
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
}
],
"location": {
"city": "<string>",
"cityCoordinate": {
"location": {
"geoBoundingBox": {
"bottomRight": {
"lat": 123,
"lon": 123
},
"topLeft": {
"lat": 123,
"lon": 123
}
},
"geoDistance": {
"distanceKm": 123,
"pin": {
"lat": 123,
"lon": 123
}
},
"geoInseeCodeDistance": {
"distanceKm": 123,
"inseeCode": "<string>"
}
}
},
"department": "<string>",
"inseeCode": "<string>",
"irisCode": "<string>",
"locationCoordinate": {
"location": {
"geoBoundingBox": {
"bottomRight": {
"lat": 123,
"lon": 123
},
"topLeft": {
"lat": 123,
"lon": 123
}
},
"geoDistance": {
"distanceKm": 123,
"pin": {
"lat": 123,
"lon": 123
}
},
"geoInseeCodeDistance": {
"distanceKm": 123,
"inseeCode": "<string>"
}
}
},
"postalCode": "<string>"
},
"source": {
"flxId": "<string>",
"url": "<string>",
"website": "<string>"
},
"currency": [],
"mainPropertyAdFlxId": [
"<string>"
],
"propertyFlxId": [
"<string>"
],
"isPro": true,
"seller": [],
"isOnline": true,
"isExclusive": true
},
"fullTexts": [
"<string>"
],
"keywords": [
"<string>"
]
},
"webhook_url": "<string>",
"search_name": "<string>",
"context": {
"metadata": {}
},
"match": [
"ALERT_MATCH_CREATED"
],
"activated": true,
"alert_id": "<string>"
}
}Authorizations
Path Parameters
Response
200
application/json
Available options:
HEAT_TYPE_UNKNOWN, HEAT_TYPE_INDIVIDUAL, HEAT_TYPE_SHARED, HEAT_TYPE_MIX, HEAT_TYPE_CITY, HEAT_TYPE_CISTERN Example:
[]
Available options:
HEAT_DETAIL_UNKNOWN, HEAT_DETAIL_FLOOR, HEAT_DETAIL_CEILING, HEAT_DETAIL_FIREPLACE, HEAT_DETAIL_INSERT, HEAT_DETAIL_AIR_CON, HEAT_DETAIL_REVERSIBLE_AIR_CON, HEAT_DETAIL_RADIANTS_TUBES, HEAT_DETAIL_RADIATOR, HEAT_DETAIL_SHEAHS, HEAT_DETAIL_CONVECTOR Example:
[]
Available options:
HEATING_UNKNOWN, HEATING_FUEL_OIL, HEATING_ELECTRICAL, HEATING_GAS, HEATING_BIOMASS, HEATING_SOLAR, HEATING_GEOTHERMAL, HEATING_WOOD, HEATING_HEAT_PUMP, HEATING_PELLET, HEATING_CANADIAN_WELL, HEATING_COAL Example:
[]
Available options:
PROPERTY_TYPE_UNKNOWN, PROPERTY_TYPE_STUDIO, PROPERTY_TYPE_T1, PROPERTY_TYPE_T1_T2, PROPERTY_TYPE_T2, PROPERTY_TYPE_T2_T3, PROPERTY_TYPE_T3, PROPERTY_TYPE_T3_4, PROPERTY_TYPE_T4, PROPERTY_TYPE_T4_5, PROPERTY_TYPE_T5_MORE, PROPERTY_TYPE_LOFT, PROPERTY_TYPE_DUPLEX, PROPERTY_TYPE_OTHER_APARTMENT_TYPE, PROPERTY_TYPE_INDIVIDUAL, PROPERTY_TYPE_ONE_SIDE_TERRACED, PROPERTY_TYPE_TWO_SIDE_TERRACED, PROPERTY_TYPE_SINGLE_STOREY, PROPERTY_TYPE_TRADITIONAL, PROPERTY_TYPE_CONTEMPORARY, PROPERTY_TYPE_BOURGEOIS, PROPERTY_TYPE_VILLA, PROPERTY_TYPE_MANOR, PROPERTY_TYPE_CASTLE, PROPERTY_TYPE_FARM, PROPERTY_TYPE_MAS, PROPERTY_TYPE_BASTIDE, PROPERTY_TYPE_CHALET, PROPERTY_TYPE_ANCIENT, PROPERTY_TYPE_HERITAGE_LISTED, PROPERTY_TYPE_BUNGALOW An anomaly or incoherence have been detected
Available options:
LAND_UNKNOWN, LAND_BUILDING_PLOT, LAND_AGRICULTURAL, LAND_VINEYARD, LAND_INDUSTRIAL, LAND_POND, LAND_FOREST Example:
[]
Date filter - Date should be in ISO format (ex: 2022-10-21T11:31:33.593Z)
Example:
"2022-10-21T11:31:33.593Z"
Date filter - Date should be in ISO format (ex: 2022-10-21T11:31:33.593Z)
Example:
"2022-10-21T11:31:33.593Z"
Available options:
PROCESS_UNKNOWN, PROCESS_AVAILABLE_ON_MARKET, PROCESS_UNDER_COMPROMISE, PROCESS_RENTED_SOLD, PROCESS_REMOVED, PROCESS_RESERVED, PROCESS_ARCHIVED Example:
[]
Available options:
PRICING_ONE_OFF, PRICING_MENSUAL Example:
[]
Available options:
CLASS_UNKNOWN, CLASS_HOUSE, CLASS_FLAT, CLASS_PROGRAM, CLASS_SHOP, CLASS_PREMISES, CLASS_OFFICE, CLASS_LAND, CLASS_BUILDING, CLASS_PARKING Example:
["CLASS_HOUSE"]
Date filter - Date should be in ISO format (ex: 2022-10-21T11:31:33.593Z)
Example:
"2022-10-21T11:31:33.593Z"
Date filter - Date should be in ISO format (ex: 2022-10-21T11:31:33.593Z)
Example:
"2022-10-21T11:31:33.593Z"
Available options:
CURRENCY_EUR, CURRENCY_USD Example:
[]
Search terms for full text search. We'll search in title, description, and keywords for terms similar to these (typically, we'll use a fuzzy search).
Search terms for keyword search. We'll search in title, description, and keywords for exact matches to these terms (typically, we'll use a term search).
Any metadata associated to this query. This will be returned in the response, and can be used to store any data you want to associate to this query. For example, you can store the ID of the user who created this query, or the ID of the alert that triggered this query.
Available options:
ALERT_MATCH_UNKNOWN, ALERT_MATCH_CREATED, ALERT_MATCH_ADVERT_EVENT Example:
["ALERT_MATCH_CREATED"]
Was this page helpful?
curl --request GET \
--url https://api.fluximmo.io/v2/protected/adverts/search/alerts/{alertId} \
--header 'x-api-key: <api-key>'{
"data": {
"search_query": {
"filterAd": {
"currentPrice": {
"value": {
"max": 123,
"min": 123
},
"valuePerArea": {
"max": 123,
"min": 123
}
},
"habitation": {
"bathroomCount": {
"max": 123,
"min": 123
},
"bedroomCount": {
"max": 123,
"min": 123
},
"characteristics": {
"hasAlarm": true,
"hasBalcony": true,
"hasCellar": true,
"hasConcierge": true,
"hasDigicode": true,
"hasFireplace": true,
"hasGarage": true,
"hasGarden": true,
"hasGrenier": true,
"hasInterphone": true,
"hasJacuzzi": true,
"hasLand": true,
"hasLift": true,
"hasMezzanine": true,
"hasParking": true,
"hasPool": true,
"hasTerrace": true,
"hasVisAVis": true,
"isPeaceful": true
},
"climate": {
"epcClimate": [],
"epcClimateScore": {
"max": 123,
"min": 123
},
"epcEnergy": [],
"epcEnergyScore": {
"max": 123,
"min": 123
},
"epcClimateDate": {
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
},
"epcEnergyDate": {
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
}
},
"features": {
"exposure": [],
"furniture": [],
"propertyFloor": {
"max": 123,
"min": 123
},
"propertyTotalFloor": {
"max": 123,
"min": 123
},
"constructionMaterials": [],
"glazingTypes": [],
"hasThroughExposure": true,
"viewOns": [],
"viewTypes": []
},
"heatTypes": [],
"heatTypeDetails": [],
"heatings": [],
"propertyCondition": [
{
"constructionYear": 123,
"interiorCondition": null,
"renovationYear": 123,
"generalConditions": []
}
],
"roomCount": {
"max": 123,
"min": 123
},
"surface": {
"balconies": {
"max": 123,
"min": 123
},
"floorSpace": {
"max": 123,
"min": 123
},
"gardens": {
"max": 123,
"min": 123
},
"groundFloor": {
"max": 123,
"min": 123
},
"kitchen": {
"max": 123,
"min": 123
},
"livingSpace": {
"max": 123,
"min": 123
},
"livingroom": {
"max": 123,
"min": 123
},
"terraces": {
"max": 123,
"min": 123
},
"total": {
"max": 123,
"min": 123
}
},
"type": "PROPERTY_TYPE_T1_T2",
"wcCount": {
"max": 123,
"min": 123
}
},
"hasAnomaly": true,
"isAuction": true,
"isUrgent": true,
"land": {
"canConstruct": true,
"isServiced": true,
"surface": {
"max": 123,
"min": 123
},
"surfaceConstructable": {
"max": 123,
"min": 123
},
"type": [],
"haveBuildingPermit": true,
"haveElectricity": true,
"haveTelecom": true,
"haveWater": true
},
"lastModifiedAt": [
{
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
}
],
"offer": [
{
"isCurrentlyOccupied": true,
"renting": {
"isColocation": true,
"isLongTerm": true,
"isShortTerm": true,
"isSubLease": true
},
"type": "OFFER_BUY"
}
],
"parking": {
"count": {
"max": 123,
"min": 123
},
"numberOfCars": {
"max": 123,
"min": 123
},
"surface": {
"max": 123,
"min": 123
},
"type": []
},
"process": [],
"scope": [],
"tags": [
"<string>"
],
"type": [
"CLASS_HOUSE"
],
"warrantyDeposit": {
"max": 123,
"min": 123
},
"firstSeenAt": [
{
"max": "2022-10-21T11:31:33.593Z",
"min": "2022-10-21T11:31:33.593Z"
}
],
"location": {
"city": "<string>",
"cityCoordinate": {
"location": {
"geoBoundingBox": {
"bottomRight": {
"lat": 123,
"lon": 123
},
"topLeft": {
"lat": 123,
"lon": 123
}
},
"geoDistance": {
"distanceKm": 123,
"pin": {
"lat": 123,
"lon": 123
}
},
"geoInseeCodeDistance": {
"distanceKm": 123,
"inseeCode": "<string>"
}
}
},
"department": "<string>",
"inseeCode": "<string>",
"irisCode": "<string>",
"locationCoordinate": {
"location": {
"geoBoundingBox": {
"bottomRight": {
"lat": 123,
"lon": 123
},
"topLeft": {
"lat": 123,
"lon": 123
}
},
"geoDistance": {
"distanceKm": 123,
"pin": {
"lat": 123,
"lon": 123
}
},
"geoInseeCodeDistance": {
"distanceKm": 123,
"inseeCode": "<string>"
}
}
},
"postalCode": "<string>"
},
"source": {
"flxId": "<string>",
"url": "<string>",
"website": "<string>"
},
"currency": [],
"mainPropertyAdFlxId": [
"<string>"
],
"propertyFlxId": [
"<string>"
],
"isPro": true,
"seller": [],
"isOnline": true,
"isExclusive": true
},
"fullTexts": [
"<string>"
],
"keywords": [
"<string>"
]
},
"webhook_url": "<string>",
"search_name": "<string>",
"context": {
"metadata": {}
},
"match": [
"ALERT_MATCH_CREATED"
],
"activated": true,
"alert_id": "<string>"
}
}