DvfAggregateLayer- Generate map layer of DVF's transaction that aggregate KPIs. - Real-estate data API

Authorizations

x-api-key

string

header

required

API Key used to be authentified to these APIs. Please contact Fluximmo to get one

Body

application/json

field

enum<string>

default:

ANALYZED_FIELD_UNKNOWN

Available options:

ANALYZED_FIELD_UNKNOWN,

ANALYZED_FIELD_ROOMS,

ANALYZED_FIELD_SURFACE,

ANALYZED_FIELD_PRICE_PER_AREA,

ANALYZED_FIELD_PRICE,

ANALYZED_FIELD_BEDROOMS

options

object

options.bounds

object

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.

options.bounds.bottomRight

object

options.bounds.bottomRight.lat

number

The latitude in degrees. It must be in the range [-90.0, +90.0].

options.bounds.bottomRight.lon

number

The longitude in degrees. It must be in the range [-180.0, +180.0].

options.bounds.topLeft

object

options.bounds.topLeft.lat

number

The latitude in degrees. It must be in the range [-90.0, +90.0].

options.bounds.topLeft.lon

number

The longitude in degrees. It must be in the range [-180.0, +180.0].

options.layer

enum<string>

default:

LAYER_TYPE_UNKNOWN

Available options:

LAYER_TYPE_UNKNOWN,

LAYER_TYPE_DEPARTMENT,

LAYER_TYPE_CITY,

LAYER_TYPE_TILE,

LAYER_TYPE_HASH

options.type

enum<string>

default:

UNKNOWN_ANALYSIS_TYPE

Available options:

UNKNOWN_ANALYSIS_TYPE,

DISTRIBUTION_ANALYSIS_TYPE,

SUMMARY_ANALYSIS_TYPE,

ADVANCED_ANALYSIS_TYPE,

BOX_PLOT_ANALYSIS_TYPE,

PERCENTILES_ANALYSIS_TYPE

query

object

query.filters

object

query.filters.flxId

string

query.filters.group

enum<string>

default:

LOCAL_GROUP_UNKNOWN

Available options:

LOCAL_GROUP_UNKNOWN,

LOCAL_GROUP_HOUSE,

LOCAL_GROUP_APARTMENT,

LOCAL_GROUP_INDUSTRIAL_COMMERCIAL,

LOCAL_GROUP_TERRAIN,

LOCAL_GROUP_MULTIPLE

query.filters.inflatedPrice

object[]

query.filters.inflatedPrice.source

object

query.filters.inflatedPrice.source.flxId

string

query.filters.inflatedPrice.source.url

string

query.filters.inflatedPrice.source.website

string

query.filters.inflatedPrice.value

object

query.filters.inflatedPrice.value.max

number

query.filters.inflatedPrice.value.min

number

query.filters.inflatedPrice.valuePerArea

object

query.filters.inflatedPrice.valuePerArea.max

number

query.filters.inflatedPrice.valuePerArea.min

number

query.filters.inflatedPrice.valuePerAreaCarrez

object

query.filters.inflatedPrice.valuePerAreaCarrez.max

number

query.filters.inflatedPrice.valuePerAreaCarrez.min

number

query.filters.location

object

query.filters.location.address

object

query.filters.location.address.number

string

query.filters.location.address.streetName

string

query.filters.location.city

string

query.filters.location.cityCoordinate

object

query.filters.location.cityCoordinate.h3Indices

object

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

query.filters.location.cityCoordinate.location

object

query.filters.location.department

string

query.filters.location.inseeCode

string

query.filters.location.irisCode

string

query.filters.location.locationCoordinate

object

query.filters.location.locationCoordinate.h3Indices

object

query.filters.location.locationCoordinate.location

object

query.filters.location.postalCode

string

query.filters.mainAdress

object[]

query.filters.mainAdress.number

string

query.filters.mainAdress.streetName

string

query.filters.mainProperty

object

query.filters.mainProperty.localType

enum<string>

default:

LOCAL_TYPE_UNKNOWN

Available options:

LOCAL_TYPE_UNKNOWN,

LOCAL_TYPE_HOUSE,

LOCAL_TYPE_APARTMENT,

LOCAL_TYPE_INDUSTRIAL_COMMERCIAL,

LOCAL_TYPE_DEPENDANCE

query.filters.mainProperty.mainRoomsCount

object

query.filters.mainProperty.mainRoomsCount.max

integer

query.filters.mainProperty.mainRoomsCount.min

integer

query.filters.mainProperty.surface

object

query.filters.mainProperty.surface.max

number

query.filters.mainProperty.surface.min

number

query.filters.mainProperty.type

enum<string>

default:

PROPERTY_TYPE_UNKNOWN

Available options:

PROPERTY_TYPE_UNKNOWN,

PROPERTY_TYPE_T1,

PROPERTY_TYPE_T2,

PROPERTY_TYPE_T3,

PROPERTY_TYPE_T4,

PROPERTY_TYPE_T5,

PROPERTY_TYPE_T5_MORE,

PROPERTY_TYPE_HOUSE,

PROPERTY_TYPE_COMMERCIAL

query.filters.meta

object

query.filters.meta.anomalies

enum<string>[]

Available options:

ANOMALY_UNKNOWN,

ANOMALY_OUTLIER,

ANOMALY_LOW_PRICE,

ANOMALY_HIGH_PRICE,

ANOMALY_LOW_SURFACE,

ANOMALY_HIGH_SURFACE

query.filters.meta.hasAnomaly

boolean

query.filters.meta.mutationDate

object

query.filters.meta.mutationDate.max

string

query.filters.meta.mutationDate.min

string

query.filters.meta.mutationId

string

query.filters.parcels

object[]

query.filters.parcels.id

string

query.filters.parcels.landDetail

object[]

query.filters.parcels.landDetail.nature

object[]

query.filters.parcels.landDetail.surface

object

query.filters.parcels.locals

enum<string>[]

Available options:

LOCAL_TYPE_UNKNOWN,

LOCAL_TYPE_HOUSE,

LOCAL_TYPE_APARTMENT,

LOCAL_TYPE_INDUSTRIAL_COMMERCIAL,

LOCAL_TYPE_DEPENDANCE

query.filters.parcels.location

object

query.filters.parcels.location.address

object

query.filters.parcels.location.city

string

query.filters.parcels.location.cityCoordinate

object

query.filters.parcels.location.department

string

query.filters.parcels.location.inseeCode

string

query.filters.parcels.location.irisCode

string

query.filters.parcels.location.locationCoordinate

object

query.filters.parcels.location.postalCode

string

query.filters.parcels.lotCount

object

query.filters.parcels.lotCount.max

number

query.filters.parcels.lotCount.min

number

query.filters.parcels.lots

object[]

query.filters.parcels.lots.number

object

query.filters.parcels.lots.surface

object

query.filters.parcels.propertyDetail

object[]

query.filters.parcels.propertyDetail.localType

enum<string>

default:

LOCAL_TYPE_UNKNOWN

Available options:

LOCAL_TYPE_UNKNOWN,

LOCAL_TYPE_HOUSE,

LOCAL_TYPE_APARTMENT,

LOCAL_TYPE_INDUSTRIAL_COMMERCIAL,

LOCAL_TYPE_DEPENDANCE

query.filters.parcels.propertyDetail.mainRoomsCount

object

query.filters.parcels.propertyDetail.surface

object

query.filters.parcels.propertyDetail.type

enum<string>

default:

PROPERTY_TYPE_UNKNOWN

Available options:

PROPERTY_TYPE_UNKNOWN,

PROPERTY_TYPE_T1,

PROPERTY_TYPE_T2,

PROPERTY_TYPE_T3,

PROPERTY_TYPE_T4,

PROPERTY_TYPE_T5,

PROPERTY_TYPE_T5_MORE,

PROPERTY_TYPE_HOUSE,

PROPERTY_TYPE_COMMERCIAL

query.filters.price

object[]

query.filters.price.source

object

query.filters.price.source.flxId

string

query.filters.price.source.url

string

query.filters.price.source.website

string

query.filters.price.value

object

query.filters.price.value.max

number

query.filters.price.value.min

number

query.filters.price.valuePerArea

object

query.filters.price.valuePerArea.max

number

query.filters.price.valuePerArea.min

number

query.filters.price.valuePerAreaCarrez

object

query.filters.price.valuePerAreaCarrez.max

number

query.filters.price.valuePerAreaCarrez.min

number

query.filters.properties

object[]

query.filters.properties.localType

enum<string>

default:

LOCAL_TYPE_UNKNOWN

Available options:

LOCAL_TYPE_UNKNOWN,

LOCAL_TYPE_HOUSE,

LOCAL_TYPE_APARTMENT,

LOCAL_TYPE_INDUSTRIAL_COMMERCIAL,

LOCAL_TYPE_DEPENDANCE

query.filters.properties.mainRoomsCount

object

query.filters.properties.mainRoomsCount.max

integer

query.filters.properties.mainRoomsCount.min

integer

query.filters.properties.surface

object

query.filters.properties.surface.max

number

query.filters.properties.surface.min

number

query.filters.properties.type

enum<string>

default:

PROPERTY_TYPE_UNKNOWN

Available options:

PROPERTY_TYPE_UNKNOWN,

PROPERTY_TYPE_T1,

PROPERTY_TYPE_T2,

PROPERTY_TYPE_T3,

PROPERTY_TYPE_T4,

PROPERTY_TYPE_T5,

PROPERTY_TYPE_T5_MORE,

PROPERTY_TYPE_HOUSE,

PROPERTY_TYPE_COMMERCIAL

query.filters.totalSurface

number

query.filters.type

enum<string>[]

Available options:

MUTATION_NATURE_UNKNOWN,

MUTATION_NATURE_SALE,

MUTATION_NATURE_SALE_TO_BE_FINNISHED,

MUTATION_NATURE_LAND_TO_BUILD,

MUTATION_NATURE_EXTENSION,

MUTATION_NATURE_EVICTION,

MUTATION_NATURE_EXCHANGE

Response

200 - application/json

apiVersion

string

context

string

data

object[]

data.analysis

object

data.analysis.advancedKpiValue

object

data.analysis.advancedKpiValue.avg

number

data.analysis.advancedKpiValue.count

integer

data.analysis.advancedKpiValue.max

number

data.analysis.advancedKpiValue.min

number

data.analysis.advancedKpiValue.stdDeviation

number

data.analysis.advancedKpiValue.stdDeviationBounds

object

data.analysis.advancedKpiValue.stdDeviationBounds.lower

number

data.analysis.advancedKpiValue.stdDeviationBounds.lowerPopulation

number

data.analysis.advancedKpiValue.stdDeviationBounds.lowerSampling

number

data.analysis.advancedKpiValue.stdDeviationBounds.upper

number

data.analysis.advancedKpiValue.stdDeviationBounds.upperPopulation

number

data.analysis.advancedKpiValue.stdDeviationBounds.upperSampling

number

data.analysis.advancedKpiValue.stdDeviationPopulation

number

data.analysis.advancedKpiValue.stdDeviationSampling

number

data.analysis.advancedKpiValue.sum

number

data.analysis.advancedKpiValue.sumOfSquares

number

data.analysis.advancedKpiValue.variance

number

data.analysis.advancedKpiValue.variancePopulation

number

data.analysis.advancedKpiValue.varianceSampling

number

data.analysis.boxplotValue

object

data.analysis.boxplotValue.lower

number

data.analysis.boxplotValue.max

number

data.analysis.boxplotValue.min

number

data.analysis.boxplotValue.q1

number

data.analysis.boxplotValue.q2

number

data.analysis.boxplotValue.q3

number

data.analysis.boxplotValue.upper

number

data.analysis.countValue

number

data.analysis.percentilesValues

object

data.analysis.percentilesValues.percentiles

object

data.analysis.percentilesValues.percentiles.{key}

number

data.analysis.summaryValue

object

data.analysis.summaryValue.avg

number

data.analysis.summaryValue.count

integer

data.analysis.summaryValue.max

number

data.analysis.summaryValue.min

number

data.analysis.summaryValue.sum

number

data.name

string

internalDelay

integer

kind

string