Properties General Analytics for search filters

Authorizations

x-api-key

string

header

required

Body

application/json

query

object

required

query.filterProperty

object

required

query.filterProperty.habitation

object

query.filterProperty.habitation.bedroomCount

object

query.filterProperty.habitation.bedroomCount.max

number

The maximum value of the range

query.filterProperty.habitation.bedroomCount.min

number

The minimum value of the range

query.filterProperty.habitation.characteristics

object

query.filterProperty.habitation.characteristics.hasBalcony

boolean

query.filterProperty.habitation.characteristics.hasCellar

boolean

query.filterProperty.habitation.characteristics.hasGarage

boolean

query.filterProperty.habitation.characteristics.hasLift

boolean

query.filterProperty.habitation.characteristics.hasParking

boolean

query.filterProperty.habitation.characteristics.hasPool

boolean

query.filterProperty.habitation.characteristics.hasTerrace

boolean

query.filterProperty.habitation.climate

object

query.filterProperty.habitation.climate.epcClimate

enum<string>[]

The classification value of the greenhouse gas emission classification - GES

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.climate.epcEnergy

enum<string>[]

The classification value of the energy classification - DPE

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

query.filterProperty.habitation.features

object

query.filterProperty.habitation.features.furniture

enum<string>[]

Available options:

UNKNOWN_FURNITURE,

UNFURNISHED,

PARTIALLY_FURNISHED,

FULLY_FURNISHED

query.filterProperty.habitation.features.propertyFloor

object

query.filterProperty.habitation.features.propertyTotalFloor

object

query.filterProperty.habitation.propertyCondition

object[]

query.filterProperty.habitation.propertyCondition.constructionYear

number

query.filterProperty.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

query.filterProperty.habitation.roomCount

object

query.filterProperty.habitation.roomCount.max

number

The maximum value of the range

query.filterProperty.habitation.roomCount.min

number

The minimum value of the range

query.filterProperty.habitation.surface

object

query.filterProperty.habitation.surface.total

object

The total habitable surface of the property in m²

query.filterProperty.land

object

query.filterProperty.land.surface

object

query.filterProperty.land.surface.max

number

The maximum value of the range

query.filterProperty.land.surface.min

number

The minimum value of the range

query.filterProperty.location

object[]

query.filterProperty.location.department

string

query.filterProperty.location.inseeCode

string

query.filterProperty.location.irisCode

string

query.filterProperty.location.locationCoordinate

object

query.filterProperty.location.locationCoordinate.location

object

Filter by location geo coordinates

query.filterProperty.location.postalCode

string

query.filterProperty.meta

object

query.filterProperty.meta.firstSeenAt

object

query.filterProperty.meta.firstSeenAt.max

string

Date filter - Date should be in ISO format (ex: 2022-10-21T11:31:33.593Z)

query.filterProperty.meta.firstSeenAt.min

string

Date filter - Date should be in ISO format (ex: 2022-10-21T11:31:33.593Z)

query.filterProperty.meta.isTotallyOffline

boolean

query.filterProperty.meta.lastPublishedAt

object

query.filterProperty.meta.lastPublishedAt.max

string

Date filter - Date should be in ISO format (ex: 2022-10-21T11:31:33.593Z)

query.filterProperty.meta.lastPublishedAt.min

string

Date filter - Date should be in ISO format (ex: 2022-10-21T11:31:33.593Z)

query.filterProperty.meta.lastSeenAt

object

query.filterProperty.meta.lastSeenAt.max

string

Date filter - Date should be in ISO format (ex: 2022-10-21T11:31:33.593Z)

query.filterProperty.meta.lastSeenAt.min

string

Date filter - Date should be in ISO format (ex: 2022-10-21T11:31:33.593Z)

query.filterProperty.meta.lastUpdatedAt

object

query.filterProperty.meta.lastUpdatedAt.max

string

Date filter - Date should be in ISO format (ex: 2022-10-21T11:31:33.593Z)

query.filterProperty.meta.lastUpdatedAt.min

string

Date filter - Date should be in ISO format (ex: 2022-10-21T11:31:33.593Z)

query.filterProperty.offer

object[]

query.filterProperty.offer.type

enum<string>

Available options:

OFFER_UNKNOWN,

OFFER_BUY,

OFFER_RENT,

OFFER_BUSINESS_TAKE_OVER,

OFFER_LEASE_BACK,

OFFER_LIFE_ANNUITY_SALE,

OFFER_HOLIDAYS

query.filterProperty.price

object

query.filterProperty.price.latest

object

query.filterProperty.price.latest.value

object

query.filterProperty.price.latest.valuePerArea

object

query.filterProperty.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

query.fullTexts

string[]

required

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).

query.keywords

string[]

required

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).

studiedData

enum<string>

required

Available options:

PRICE_ANALYZED_TYPE,

HABITATION_SURFACE_ANALYZED_TYPE,

LAND_SURFACE_ANALYZED_TYPE,

PRICE_PER_AREA_ANALYZED_TYPE

type

enum<string>

required

Available options:

SUMMARY_ANALYSIS_TYPE,

ADVANCED_ANALYSIS_TYPE,

BOX_PLOT_ANALYSIS_TYPE,

PERCENTILES_ANALYSIS_TYPE

Response

200 - application/json

data

object

Analytics data for the given context

data.advancedKpiValue

object

data.advancedKpiValue.avg

number

data.advancedKpiValue.count

number

data.advancedKpiValue.max

number

data.advancedKpiValue.min

number

data.advancedKpiValue.stdDeviation

number

data.advancedKpiValue.stdDeviationBounds

object

data.advancedKpiValue.stdDeviationBounds.lower

number

data.advancedKpiValue.stdDeviationBounds.lowerPopulation

number

data.advancedKpiValue.stdDeviationBounds.lowerSampling

number

data.advancedKpiValue.stdDeviationBounds.upper

number

data.advancedKpiValue.stdDeviationBounds.upperPopulation

number

data.advancedKpiValue.stdDeviationBounds.upperSampling

number

data.advancedKpiValue.stdDeviationPopulation

number

data.advancedKpiValue.stdDeviationSampling

number

data.advancedKpiValue.sum

number

data.advancedKpiValue.sumOfSquares

number

data.advancedKpiValue.variance

number

data.advancedKpiValue.variancePopulation

number

data.advancedKpiValue.varianceSampling

number

data.boxplotValue

object

data.boxplotValue.lower

number

data.boxplotValue.max

number

data.boxplotValue.min

number

data.boxplotValue.q1

number

data.boxplotValue.q2

number

data.boxplotValue.q3

number

data.boxplotValue.upper

number

data.countValue

number

data.percentilesValues

object

data.percentilesValues.percentiles

object

data.percentilesValues.percentiles.1.0

number

data.percentilesValues.percentiles.25.0

number

data.percentilesValues.percentiles.5.0

number

data.percentilesValues.percentiles.50.0

number

data.percentilesValues.percentiles.75.0

number

data.percentilesValues.percentiles.95.0

number

data.percentilesValues.percentiles.99.0

number

data.summaryValue

object

data.summaryValue.avg

number

data.summaryValue.count

number

data.summaryValue.max

number

data.summaryValue.min

number

data.summaryValue.sum

number

Properties Analytics

Market Analytics

Authorizations

Body

Response