System
Properties
RealEstate Companies
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>",
"colorHash": "<string>",
"differenceHash": "<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>"
}
]
}
}Sample advert webhook body
Sample of an alert webhook body for 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>",
"colorHash": "<string>",
"differenceHash": "<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
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Currency of the advert
CURRENCY_EUR, CURRENCY_USD null
Description of the advert as it is on the source
Date should be in ISO format (ex: 2022-10-21T11:31:33.593Z)
"2022-10-21T11:31:33.593Z"
Unique identifier of the advert
Habitation details of the property
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The energetic classes of the property (DPE/GES)
Show child attributes
Show child attributes
The classification value of the greenhouse gas emission classification - GES
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 "GREENHOUSE_CLASSIFICATION_C"
The value of the greenhouse gas emission classification - GES in kgCO2/m²/year
The classification value of the energy classification - DPE
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 "ENERGY_CLASSIFICATION_C"
The value of the energy classification - DPE in kWhEP/m²/year
Date should be in ISO format (ex: 2022-10-21T11:31:33.593Z)
"2022-10-21T11:31:33.593Z"
Date should be in ISO format (ex: 2022-10-21T11:31:33.593Z)
"2022-10-21T11:31:33.593Z"
Show child attributes
Show child attributes
EXPOSURE_UNKNOWN, EXPOSURE_NORTH, EXPOSURE_NORTH_EAST, EXPOSURE_EAST, EXPOSURE_SOUTH_EAST, EXPOSURE_SOUTH, EXPOSURE_SOUTH_WEST, EXPOSURE_WEST, EXPOSURE_NORTH_WEST null
UNKNOWN_FURNITURE, UNFURNISHED, PARTIALLY_FURNISHED, FULLY_FURNISHED null
VIEW_TYPE_UNKNOWN, VIEW_TYPE_GLIMPSE, VIEW_TYPE_PANORAMIC, VIEW_TYPE_CLEAR, VIEW_TYPE_EXCEPTIONAL, VIEW_TYPE_DOMINANT []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 []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 []HEAT_TYPE_UNKNOWN, HEAT_TYPE_INDIVIDUAL, HEAT_TYPE_SHARED, HEAT_TYPE_MIX, HEAT_TYPE_CITY, HEAT_TYPE_CISTERN []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 []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 []Show child attributes
Show child attributes
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 null
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 []Show child attributes
Show child attributes
The surface of the balconies in m² - we rarely have this information
The surface of the total floors in m² - we rarely have this information
The surface of the gardens in m² - we rarely have this information
The surface of the ground floor in m² - we rarely have this information
The surface of the kitchen in m² - we rarely have this information
The surface of the living space in m² - we rarely have this information
The surface of the living room in m² - we rarely have this information
The surface of the terraces in m² - we rarely have this information
The total habitable surface of the property in m²
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
Show child attributes
Show child attributes
LAND_UNKNOWN, LAND_BUILDING_PLOT, LAND_AGRICULTURAL, LAND_VINEYARD, LAND_INDUSTRIAL, LAND_POND, LAND_FOREST null
Date should be in ISO format (ex: 2022-10-21T11:31:33.593Z)
"2022-10-21T11:31:33.593Z"
Location details of the advert
Show child attributes
Show child attributes
INSEE code of the city
IRIS code of the city
Postal code of the city
Medias of the advert
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Parking details of the property
Pricing scope of the advert - mensual or onetime
PRICING_ONE_OFF, PRICING_MENSUAL null
Unstructured tags of the advert
Title of the advert as it is on the source
Type of the advert
CLASS_UNKNOWN, CLASS_HOUSE, CLASS_FLAT, CLASS_PROGRAM, CLASS_SHOP, CLASS_PREMISES, CLASS_OFFICE, CLASS_LAND, CLASS_BUILDING, CLASS_PARKING "CLASS_HOUSE"
Warranty deposit for renting this property
Offer details of the advert
Show child attributes
Show child attributes
The property is sold with someone living in it
Renting contract details
Show child attributes
Show child attributes
The offer is for a colocation
The offer is for long term renting (more than 6 months)
The offer is for short term renting (less than 6 months)
The offer is for a sublease
OFFER_UNKNOWN, OFFER_BUY, OFFER_RENT, OFFER_BUSINESS_TAKE_OVER, OFFER_LEASE_BACK, OFFER_LIFE_ANNUITY_SALE, OFFER_HOLIDAYS "OFFER_BUY"
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
Seller details of the advert
Is the advert exclusive to the seller
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Unique identifier of the advert
Is the advert online or not
Was this page helpful?