Samples
Sample advert webhook body
System
- System
Properties
- Samples
- Properties
- Reporting
- Properties Alerts
Adverts
- Samples
- Reporting
- Adverts
- Adverts Alerts
RealEstate Companies
- Agency details
Samples
Sample advert webhook body
Sample of an alert webhook body for Adverts
GET
/
v2
/
sample
/
webhook
/
adverts
curl --request GET \
--url https://api.fluximmo.io/v2/sample/webhook/adverts{
"data": {
"created": [
{
"adverts": [
{
"contactInCharge": {
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"pseudonym": "<string>"
},
"currency": null,
"currentPrice": {
"value": 123,
"valuePerArea": 123
},
"description": "<string>",
"firstSeenAt": "2022-10-21T11:31:33.593Z",
"flxId": "<string>",
"habitation": {
"bathroomCount": 123,
"bedroomCount": 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": "GREENHOUSE_CLASSIFICATION_C",
"epcClimateScore": 123,
"epcEnergy": "ENERGY_CLASSIFICATION_C",
"epcEnergyScore": 123,
"epcClimateDate": "2022-10-21T11:31:33.593Z",
"epcEnergyDate": "2022-10-21T11:31:33.593Z"
},
"features": {
"exposure": null,
"furniture": null,
"propertyFloor": 123,
"propertyTotalFloor": 123,
"viewTypes": [],
"constructionMaterials": [],
"hasThroughExposure": true,
"viewOns": []
},
"heatTypes": [],
"heatTypeDetails": [],
"heatings": [],
"propertyCondition": {
"constructionYear": 123,
"interiorCondition": null,
"renovationYear": 123,
"generalConditions": []
},
"roomCount": 123,
"surface": {
"balconies": 123,
"floorSpace": 123,
"gardens": 123,
"groundFloor": 123,
"kitchen": 123,
"livingSpace": 123,
"livingRoom": 123,
"terraces": 123,
"total": 123
},
"type": [],
"wcCount": 123
},
"hasAnomaly": true,
"isAuction": true,
"isUrgent": true,
"land": {
"canConstruct": true,
"hasBuildingPermit": true,
"hasElectricity": true,
"hasTelecom": true,
"hasWater": true,
"isServiced": true,
"surface": 123,
"surfaceConstructable": 123,
"type": null
},
"lastModifiedAt": "2022-10-21T11:31:33.593Z",
"location": {
"city": "<string>",
"cityCoordinate": {
"location": [
123
]
},
"department": "<string>",
"inseeCode": "<string>",
"irisCode": "<string>",
"locationCoordinate": {
"location": [
123
]
},
"postalCode": "<string>"
},
"medias": {
"images": [
{
"gaussianHash": "<string>",
"imageId": "<string>",
"meanHash": "<string>",
"perceptualHash": "<string>",
"url": "<string>"
}
],
"virtualVisitExternalUrl": [
"<string>"
]
},
"parking": {
"count": 123,
"numberOfCars": 123,
"surface": 123,
"type": null
},
"scope": null,
"source": {
"flxId": "<string>",
"url": "<string>",
"website": "<string>"
},
"tags": [
"<string>"
],
"title": "<string>",
"type": "CLASS_HOUSE",
"warrantyDeposit": 123,
"offer": {
"isCurrentlyOccupied": true,
"renting": {
"isColocation": true,
"isLongTerm": true,
"isShortTerm": true,
"isSubLease": true
},
"type": "OFFER_BUY"
},
"mainPropertyAdFlxId": "<string>",
"propertyFlxId": "<string>",
"isOnline": true,
"lastSeenAt": "2023-11-07T05:31:56Z",
"isPro": true,
"seller": {
"flxId": "<string>",
"name": "<string>",
"siren": "<string>",
"type": "SELLER_TYPE_AGENCY"
},
"isExclusive": true
}
],
"alert_id": "<string>"
}
],
"updated": [
{
"adverts": [
{
"currentPrice": {
"value": 123,
"valuePerArea": 123
},
"flxId": "<string>",
"isOnline": true
}
],
"alert_id": "<string>"
}
]
}
}Response
200
application/json
Currency of the advert
Available options:
CURRENCY_EUR, CURRENCY_USD Description of the advert as it is on the source
Date should be in ISO format (ex: 2022-10-21T11:31:33.593Z)
Example:
"2022-10-21T11:31:33.593Z"
Unique identifier of the advert
Habitation details of the property
The energetic classes of the property (DPE/GES)
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
Is this advert an auction
Is this advert marked as urgent
Land details of the property
Available options:
LAND_UNKNOWN, LAND_BUILDING_PLOT, LAND_AGRICULTURAL, LAND_VINEYARD, LAND_INDUSTRIAL, LAND_POND, LAND_FOREST Date should be in ISO format (ex: 2022-10-21T11:31:33.593Z)
Example:
"2022-10-21T11:31:33.593Z"
Location details of the advert
City coordinates - center of the city
INSEE code of the city
IRIS code of the city
Coordinates of the property - could not be accurate or precise enough
Postal code of the city
Pricing scope of the advert - mensual or onetime
Available options:
PRICING_ONE_OFF, PRICING_MENSUAL Unstructured tags of the advert
Title of the advert as it is on the source
Type of the advert
Available options:
CLASS_UNKNOWN, CLASS_HOUSE, CLASS_FLAT, CLASS_PROGRAM, CLASS_SHOP, CLASS_PREMISES, CLASS_OFFICE, CLASS_LAND, CLASS_BUILDING, CLASS_PARKING Warranty deposit for renting this property
Offer details of the advert
The property is sold with someone living in it
Renting contract details
Available options:
OFFER_UNKNOWN, OFFER_BUY, OFFER_RENT, OFFER_BUSINESS_TAKE_OVER, OFFER_LEASE_BACK, OFFER_LIFE_ANNUITY_SALE, OFFER_HOLIDAYS FlxId of the first duplicated advert we found for this advertised property
FlxId of the property this advert is linked to
Is the advert online or not
Last time we saw this advert
Is the seller a professional or not
Is the advert exclusive to the seller
Unique identifier of the advert
Is the advert online or not
Was this page helpful?
curl --request GET \
--url https://api.fluximmo.io/v2/sample/webhook/adverts{
"data": {
"created": [
{
"adverts": [
{
"contactInCharge": {
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"pseudonym": "<string>"
},
"currency": null,
"currentPrice": {
"value": 123,
"valuePerArea": 123
},
"description": "<string>",
"firstSeenAt": "2022-10-21T11:31:33.593Z",
"flxId": "<string>",
"habitation": {
"bathroomCount": 123,
"bedroomCount": 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": "GREENHOUSE_CLASSIFICATION_C",
"epcClimateScore": 123,
"epcEnergy": "ENERGY_CLASSIFICATION_C",
"epcEnergyScore": 123,
"epcClimateDate": "2022-10-21T11:31:33.593Z",
"epcEnergyDate": "2022-10-21T11:31:33.593Z"
},
"features": {
"exposure": null,
"furniture": null,
"propertyFloor": 123,
"propertyTotalFloor": 123,
"viewTypes": [],
"constructionMaterials": [],
"hasThroughExposure": true,
"viewOns": []
},
"heatTypes": [],
"heatTypeDetails": [],
"heatings": [],
"propertyCondition": {
"constructionYear": 123,
"interiorCondition": null,
"renovationYear": 123,
"generalConditions": []
},
"roomCount": 123,
"surface": {
"balconies": 123,
"floorSpace": 123,
"gardens": 123,
"groundFloor": 123,
"kitchen": 123,
"livingSpace": 123,
"livingRoom": 123,
"terraces": 123,
"total": 123
},
"type": [],
"wcCount": 123
},
"hasAnomaly": true,
"isAuction": true,
"isUrgent": true,
"land": {
"canConstruct": true,
"hasBuildingPermit": true,
"hasElectricity": true,
"hasTelecom": true,
"hasWater": true,
"isServiced": true,
"surface": 123,
"surfaceConstructable": 123,
"type": null
},
"lastModifiedAt": "2022-10-21T11:31:33.593Z",
"location": {
"city": "<string>",
"cityCoordinate": {
"location": [
123
]
},
"department": "<string>",
"inseeCode": "<string>",
"irisCode": "<string>",
"locationCoordinate": {
"location": [
123
]
},
"postalCode": "<string>"
},
"medias": {
"images": [
{
"gaussianHash": "<string>",
"imageId": "<string>",
"meanHash": "<string>",
"perceptualHash": "<string>",
"url": "<string>"
}
],
"virtualVisitExternalUrl": [
"<string>"
]
},
"parking": {
"count": 123,
"numberOfCars": 123,
"surface": 123,
"type": null
},
"scope": null,
"source": {
"flxId": "<string>",
"url": "<string>",
"website": "<string>"
},
"tags": [
"<string>"
],
"title": "<string>",
"type": "CLASS_HOUSE",
"warrantyDeposit": 123,
"offer": {
"isCurrentlyOccupied": true,
"renting": {
"isColocation": true,
"isLongTerm": true,
"isShortTerm": true,
"isSubLease": true
},
"type": "OFFER_BUY"
},
"mainPropertyAdFlxId": "<string>",
"propertyFlxId": "<string>",
"isOnline": true,
"lastSeenAt": "2023-11-07T05:31:56Z",
"isPro": true,
"seller": {
"flxId": "<string>",
"name": "<string>",
"siren": "<string>",
"type": "SELLER_TYPE_AGENCY"
},
"isExclusive": true
}
],
"alert_id": "<string>"
}
],
"updated": [
{
"adverts": [
{
"currentPrice": {
"value": 123,
"valuePerArea": 123
},
"flxId": "<string>",
"isOnline": true
}
],
"alert_id": "<string>"
}
]
}
}