GeneralAnalytics - Retrieve advanced statistics of historical immo's market.
GeneralAnalytics - Retrieve advanced statistics of historical immo's market.
POST
/
v2
/
analytics
/
analysis
/
property
/
_search
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
*
query
object
query
object
fullTexts
array
fullTexts
array
keywords
array
keywords
array
filterProperty
object
filterProperty
object
indexTimestamp
array
indexTimestamp
array
meta
object
meta
object
firstSeenAt
object
firstSeenAt
object
lastUpdatedAt
object
lastUpdatedAt
object
firstPublishedAt
object
firstPublishedAt
object
lastPublishedAt
object
lastPublishedAt
object
lastSeenAt
object
lastSeenAt
object
isTotallyOffline
boolean
isTotallyOffline
boolean
tags
array
tags
array
isUrgent
boolean
isUrgent
boolean
offer
array
offer
array
type
array
type
array
process
array
process
array
price
object
price
object
latest
object
latest
object
lowest
object
lowest
object
highest
object
highest
object
initial
object
initial
object
warrantyDeposit
object
warrantyDeposit
object
charges
object
charges
object
isAuction
boolean
isAuction
boolean
scope
array
scope
array
currency
array
currency
array
variation
array
variation
array
habitation
object
habitation
object
type
enum<string>
type
enum<string>
roomCount
object
roomCount
object
bedroomCount
object
bedroomCount
object
bathroomCount
object
bathroomCount
object
wcCount
object
wcCount
object
roomsDetails
array
roomsDetails
array
heatTypes
array
heatTypes
array
heatTypeDetails
array
heatTypeDetails
array
heatings
array
heatings
array
kitchenEquipped
array
kitchenEquipped
array
features
object
features
object
characteristics
object
characteristics
object
climate
object
climate
object
propertyCondition
array
propertyCondition
array
surface
object
surface
object
parking
object
parking
object
type
array
type
array
count
object
count
object
numberOfCars
object
numberOfCars
object
surface
object
surface
object
land
object
land
object
type
array
type
array
haveBuildingPermit
boolean
haveBuildingPermit
boolean
canConstruct
boolean
canConstruct
boolean
surfaceConstructable
object
surfaceConstructable
object
surface
object
surface
object
isServiced
boolean
isServiced
boolean
haveWater
boolean
haveWater
boolean
haveElectricity
boolean
haveElectricity
boolean
haveTelecom
boolean
haveTelecom
boolean
location
array
location
array
history
array
history
array
adverts
array
adverts
array
isCityCenter
boolean
isCityCenter
boolean
hasAnomaly
boolean
hasAnomaly
boolean
estimatedPrice
object
estimatedPrice
object
value
object
value
object
valuePerArea
object
valuePerArea
object
source
object
source
object
imagesLength
object
imagesLength
object
min
integer
min
integer
max
integer
max
integer
advertsLength
object
advertsLength
object
min
integer
min
integer
max
integer
max
integer
historyLength
object
historyLength
object
min
integer
min
integer
max
integer
max
integer
anomalies
array
anomalies
array
studiedData
enum<string>
studiedData
enum<string>
type
enum<string>
type
enum<string>
Authorizations
API Key used to be authentified to these APIs. Please contact Fluximmo to get one
Body
application/json
Available options:
OFFER_UNKNOWN, OFFER_BUY, OFFER_RENT, OFFER_BUSINESS_TAKE_OVER, OFFER_LEASE_BACK, OFFER_LIFE_ANNUITY_SALE, OFFER_HOLIDAYS Available options:
CLASS_UNKNOWN, CLASS_HOUSE, CLASS_FLAT, CLASS_PROGRAM, CLASS_SHOP, CLASS_PREMISES, CLASS_OFFICE, CLASS_LAND, CLASS_BUILDING, CLASS_PARKING Available options:
PROCESS_UNKNOWN, PROCESS_AVAILABLE_ON_MARKET, PROCESS_UNDER_COMPROMISE, PROCESS_RENTED_SOLD, PROCESS_REMOVED, PROCESS_RESERVED, PROCESS_ARCHIVED Available options:
PRICING_ONE_OFF, PRICING_MENSUAL Available options:
CURRENCY_EUR, CURRENCY_USD 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_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 Available options:
ROOM_TYPE_UNKNOWN, ROOM_TYPE_MASTER_BEDROOM, ROOM_TYPE_BEDROOM, ROOM_TYPE_KITCHEN, ROOM_TYPE_LIVING_ROOM, ROOM_TYPE_OFFICE Available options:
HEAT_TYPE_UNKNOWN, HEAT_TYPE_INDIVIDUAL, HEAT_TYPE_SHARED, HEAT_TYPE_MIXED, HEAT_TYPE_CITY, HEAT_TYPE_CISTERN 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 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 Available options:
KITCHEN_UNKNOWN_EQUIPPED, KITCHEN_NON_EQUIPPED, KITCHEN_PARTIALLY_EQUIPPED, KITCHEN_FULLY_EQUIPPED, KITCHEN_FURNISHED, KITCHEN_NAKED, KITCHEN_EQUIPPED_FURNISHED Available options:
VIEW_TYPE_UNKNOWN, VIEW_TYPE_GLIMPSE, VIEW_TYPE_PANORAMIC, VIEW_TYPE_CLEAR, VIEW_TYPE_EXCEPTIONAL, VIEW_TYPE_DOMINANT Available options:
EXPOSURE_UNKNOWN, EXPOSURE_NORTH, EXPOSURE_NORTH_EAST, EXPOSURE_EAST, EXPOSURE_SOUTH_EAST, EXPOSURE_SOUTH, EXPOSURE_SOUTH_WEST, EXPOSURE_WEST, EXPOSURE_NORTH_WEST Available options:
UNKNOWN_FURNITURE, UNFURNISHED, PARTIALLY_FURNISHED, FULLY_FURNISHED 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 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 Available options:
GLAZING_TYPE_UNKNOWN, GLAZING_TYPE_SIMPLE, GLAZING_TYPE_DOUBLE, GLAZING_TYPE_TRIPLE 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 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 query.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 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 Available options:
PARKING_UNKNOWN, PARKING_GARAGE, PARKING_PARKING Available options:
LAND_UNKNOWN, LAND_BUILDING_PLOT, LAND_AGRICULTURAL, LAND_VINEYARD, LAND_INDUSTRIAL, LAND_POND, LAND_FOREST 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
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
Available options:
SELLER_TYPE_UNKNOWN, SELLER_TYPE_AGENCY, SELLER_TYPE_NETWORK Available options:
PRICING_ONE_OFF, PRICING_MENSUAL Available options:
CURRENCY_EUR, CURRENCY_USD 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.
Matches geopoint values within a given distance of a geopoint (pin).
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.
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/)
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 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 Available options:
UNKNOWN_ANALYZED_TYPE, PRICE_ANALYZED_TYPE, HABITATION_SURFACE_ANALYZED_TYPE, LAND_SURFACE_ANALYZED_TYPE, PRICE_PER_AREA_ANALYZED_TYPE, TIME_ON_MARKET_ANALYZED_TYPE Available options:
UNKNOWN_ANALYSIS_TYPE, DISTRIBUTION_ANALYSIS_TYPE, SUMMARY_ANALYSIS_TYPE, ADVANCED_ANALYSIS_TYPE, BOX_PLOT_ANALYSIS_TYPE, PERCENTILES_ANALYSIS_TYPE Response
200 - application/json
Was this page helpful?