Indicators
Price / Meter Evolution
This endpoint returns the price per meter average, median and time series of properties matching the given criteria.
GET
Query parameters
string
default:"month"
Date histogram granularity for time series. Can be
month or year.integer
Maximum price of advert. Filters based on any non expired adverts prices.
integer
Minimum price of advert. Filters based on any non expired adverts prices.
integer
The maximum number of bedrooms in the property.
integer
The minimum number of bedrooms in the property.
integer
The maximum budget for the property.
integer
The minimum budget for the property.
integer
The maximum condominium fees for the property.
integer
The minimum condominium fees for the property.
integer
The maximum construction year of the property.
integer
The minimum construction year of the property.
array
The energy efficiency categories of the property.
integer
The maximum energy value of the property.
integer
The minimum energy value of the property.
date
The date from which an event of type price is created (inclusive).
number
The maximum variation of an event of type price. Expressed in percent.
number
The minimum variation of an event of type price. Expressed in percent.
date
The date before which an event of type price is created (inclusive).
date
The date from which an event of type surface is created (inclusive).
number
The maximum variation of an event of type surface. Expressed in percent.
number
The minimum variation of an event of type surface. Expressed in percent.
date
The date before which an event of type surface is created (inclusive).
array
Cities to be excluded.
array
Insee codes to be excluded.
array
Properties to be excluded.
array
Zipcodes to be excluded.
boolean
Filter for expired properties.
array
Full text matching including/excluding words & phrases in the title or the description of the property.
Example:
expressions[0][0][word]=travaux&expressions[0][0][options][includes]=true&expressions[0][0][options][strict]=false&expressions[0][1][word]=lumineux&expressions[0][1][options][includes]=true&expressions[0][1][options][strict]=false which will search for properties that contain both the keywords lumineux and travaux.number
The maximum percentage of fees.
number
The minimum percentage of fees.
integer
Responsibility for fees (0 for seller, 1 for purchaser).
integer
The maximum number of floors in the property.
integer
The minimum number of floors in the property.
date
The date from which the property is created (inclusive).
date
The date from which the property is updated (inclusive).
boolean
Filter for furnished properties.
array
Filters properties by geocoding confidence level. Use
1 to keep only house-number level matches and 2 to include neighborhood-level approximations.array
Filters properties within specified geographic areas. Example:
geoShapes[0][0][0]=6.063201&geoShapes[0][0][1]=44.549092&geoShapes[0][1][0]=6.063201&geoShapes[0][1][1]=44.543009&geoShapes[0][2][0]=6.073453&geoShapes[0][2][1]=44.543293&geoShapes[0][3][0]=6.073453&geoShapes[0][3][1]=44.549092&geoShapes[0][4][0]=6.063201&geoShapes[0][4][1]=44.549092.array
Green house gas performance letter array of the property.
integer
The maximum value of green house gas of the property.
integer
The minimum value of green house gas of the property.
array
Located in given cities. Example: includedCities[]=/cities/30953&includedCities[]=/cities/30952
array
Located in given departments. Example: includedDepartments[]=includedDepartments[]=/departments/77
array
Located in given insee codes. Example: includedInseeCodes[]=75117&includedInseeCodes[]=75118
array
Located in given zipcodes. Example: includedZipcodes[]=75017&includedZipcodes[]=75018
number
Lower than or equal to inventoryPriceMax. Example: inventoryPriceMax=500
number
Greater than or equal to inventoryPriceMin. Example: inventoryPriceMin=250
integer
default:"30"
The number of items per page. Max is 30.
number
Latitude. Used if radius & lat/lon are set. Example: lat=48.864716
number
Longitude. Used if radius & lat/lon are given. Example: lon=2.349014
integer
Lower than or equal to lotCountMax. Example: lotCountMax=12
integer
Greater than or equal to lotCountMin. Example: lotCountMin=4
integer
default:"desc"
Order properties by creation date.
integer
Order properties by update date.
integer
default:"1"
The collection page number.
number
Lower than or equal to priceExcludingFeesMax. Example: priceExcludingFeesMax=427500
number
Greater than or equal to priceExcludingFeesMin. Example: priceExcludingFeesMin=405000
integer
Lower than or equal to pricePerMeterMax. Example: pricePerMeterMax=11500
integer
Greater than or equal to pricePerMeterMin. Example: pricePerMeterMin=9500
array
0: FLAT, 1: HOUSE, 2: BUILDING, 3: PARKING, 4: OFFICE, 5: LAND, 6: SHOP
array
0 : INDIVIDUAL, 1 : PROFESSIONAL
integer
Distance expressed in kilometers. Used if lat & lon are set. Example: radius=20
number
Lower than or equal to rentalChargesMax. Example: rentalChargesMax=100
number
Greater than or equal to rentalChargesMin. Example: rentalChargesMin=50
number
Lower than or equal to rentalPledgeMax. Example: rentalPledgeMax=800
number
Greater than or equal to rentalPledgeMin. Example: rentalPledgeMin=500
number
Lower than or equal to renterFeesMax. Example: renterFeesMax=80
number
Greater than or equal to renterFeesMin. Example: renterFeesMin=50
integer
Having maximum x rooms. Example: roomMax=6
integer
Having minimum x rooms. Example: roomMin=3
string
default:"property"
Property: fromDate/toDate criteria will be applied to property root object. Items will be sorted by property createdAt dates. Advert: fromDate/toDate criteria will be applied to adverts nested objects. Items will be sorted by advert createdAt dates. Example: sortMode=property
integer
Lower than or equal to surfaceMax. Example: surfaceMax=84
integer
Greater than or equal to surfaceMin. Example: surfaceMin=42
date
To datetime (inclusive). Example: toDate=2021-05-07 12:42:42
date
Since datetime (inclusive). Example: toUpdatedAt=2021-05-07 12:42:42
integer
0 : SELL, 1 : RENT
boolean
Restrict results to properties that have a resolved location.
boolean
default:"true"
Filter properties with coherent price. Example: withCoherentPrice=true
boolean
Having a virtual tour video link. Example: withVirtualTour=true