Properties
Properties
Returns a collection of properties matching given criteria.
GET
Query parameters
number
Minimum price of advert. Filters properties based on any non expired adverts prices.
number
Maximum price of advert. Filters properties based on any non expired adverts prices.
number
Maximum number of bedrooms in the property.
number
Minimum number of bedrooms in the property.
number
Maximum budget for the property.
number
Minimum budget for the property.
number
Maximum condominium fees for the property.
number
Minimum condominium fees for the property.
number
Maximum construction year of the property.
number
Minimum construction year of the property.
array
The energy efficiency categories of the property. Can be:
A B C D E F G
Example: energyCategories[]=A&energyCategories[]=Bnumber
Maximum energy value of the property.
number
Minimum energy value of the property.
date
Date from which an event of type price is created — inclusive.
number
Maximum percent variation of an event of type price.
number
Minimum percent variation of an event of type price.
date
Date before which an event of type price is created — inclusive.
date
Date from which an event of type surface is created — inclusive.
number
Maximum percent variation of an event of type surface.
number
Minimum percent variation of an event of type surface.
date
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
Sources sites to be excluded.
array
Zipcodes to be excluded.
boolean
default:"null"
Whether to show properties that are expired. A property is considered expired when all its adverts are expired. Can be
true, false or null. Default is null which returns all properties no matter if they’re expired or not.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
Maximum percentage of fees.
number
Minimum percentage of fees.
number
Responsibility for fees.
0 for seller, 1 for buyer.number
Maximum number of floors in the property.
number
Minimum number of floors in the property.
date
Date from which the property is created — inclusive.
date
Date from which the advert is expired — inclusive.
date
Date from which the property is updated — inclusive.
boolean
Filter for furnished properties.
array
Filters properties by geographic accuracy level. “1” (HOUSE NUMBER - precise location at house number level), “2” (NEIGHBORHOOD - broader location within a neighborhood). Example: geoAccuracy[]=0
array
Filters properties within specified geographic areas. Example:
geoShapes=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.
number
Maximum value of green house gas of the property.
number
Minimum value of green house gas of the property.
array
Located in given cities. Example:
includedCities[]=/cities/30953&includedCities[]=/cities/30952. Use locations to get the desired city ids.array
Located in given departments. Example:
includedDepartments[]=/departments/77. Use locations to get the desired department ids.array
Located in given insee codes. Example:
includedInseeCodes[]=75117&includedInseeCodes[]=75118array
Sources sites to be included.
array
Located in given zipcodes. Example:
includedZipcodes[]=75017&includedZipcodes[]=75018number
Lower than or equal to given inventory price. Example:
inventoryPriceMax=500number
Greater than or equal to given inventory price. Example:
inventoryPriceMin=250number
default:"10"
The number of items per page. Max is
30.number
Maximum land surface.
number
Minimum land surface.
number
Latitude. Will work if latitude exists in the property. Example:
lat=48.864716number
Longitude. Will work if latitude exists in the property. Example:
lon=2.349014number
Lower than or equal to given lot count. Example:
lotCountMax=12number
Greater than or equal to given lot count. Example:
lotCountMin=4string
default:"desc"
Order properties by creation date. Can be
asc or desc.string
Order properties by update date (API parameter name includes the double “d”). Can be
asc or desc.string
default:"desc"
Order properties by price per meter. Can be
asc or desc.string
Order properties by price. Can be
asc or desc.string
Order properties by surface. Can be
asc or desc.string
Order properties by update date. Can be
asc or desc.number
default:"1"
The collection page number.
number
Lower than or equal to given price excluding fees. Example:
priceExcludingFeesMax=427500number
Greater than or equal to given price excluding fees. Example:
priceExcludingFeesMin=405000number
Lower than or equal to given price per meter. Example:
pricePerMeterMax=11500number
Greater than or equal to given price per meter. Example:
pricePerMeterMin=9500array
Type of property. Apartment
0, House 1, Building 2, Parking 3, Office 4, Land 5, Shop 6. Example: propertyTypes[]=0&propertyTypes[]=1array
Type of publisher. Individual
0, Professional 1. Example: publisherTypes[]=0&publisherTypes[]=1number
Distance expressed in kilometers. Will work if latitude & longitude parameters are also set. Example:
radius=20, radius=0.5number
Lower than or equal to given rental charges amount. Example:
rentalChargesMax=100number
Greater than or equal to given rental charges amount. Example:
rentalChargesMin=50number
Lower than or equal to given rental pledge amount. Example:
rentalPledgeMax=800number
Greater than or equal to given rental pledge amount. Example:
rentalPledgeMin=500number
Lower than or equal to given renter fees. Example:
renterFeesMax=80number
Greater than or equal to given renter fees. Example:
renterFeesMin=50number
Maximum rooms of the property. Example:
roomMax=6number
Minimum rooms of the property. Example:
roomMin=3string
default:"property"
Whether to sort results by properties or by adverts.If
property is chosen, fromDate and toDate parameters will be overridden so that the results will be sorted by the createdAt of each property.If advert is chosen: fromDate and toDate parameters will be overridden so that the results will be sorted by createdAt of each advert.Example: sortMode=propertyPlease check our glossary for more information about the distinction between adverts and properties.number
Lower than or equal to given surface. Example:
surfaceMax=84number
Greater than or equal to given surface. Example:
surfaceMin=42date
Date until which the property is created — inclusive. Example:
toDate=2021-05-07 12:42:42date
Date from which the advert is expired — inclusive.
Example:
toExpiredAt=2021-05-07 12:42:42date
Date until which the property is updated — inclusive. Example:
toUpdatedAt=2021-05-07 12:42:42number
Type of transaction. Sell
0, Rent 1. Example: transactionType=0boolean
default:"true"
Filter properties with coherent price. Example:
withCoherentPrice=trueboolean
Having a latitude and longitude. Example:
withLocation=trueboolean
Having a virtual tour video link. Example:
withVirtualTour=true