Skip to main content
POST
Search properties with filters

Authorizations

​
Authorization
string
header
required

Send your Immoteur Personal Access Token in the Authorization header: Authorization: Bearer <token>

You can create and manage your Personal Access Tokens here: https://immoteur.com/dashboard/settings

Body

application/json
​
page
integer
default:1
required

1-based page index.

Required range: 1 <= x <= 500
Example:

1

​
propertyTypes
enum<string>[]
required

One or more property types to include.

  • House: Residential building sold as an entire unit (e.g., a single-family home, villa, or full residence).
  • Apartment: A single residential unit within a larger building.
  • Shop: Commercial property with public access, such as boutiques, barbers, or butcher shops.
  • Premises: Non-residential units like cellars, attics, or general storage/local spaces.
  • Office: Properties intended for professional work environments.
  • Land: Plots of terrain, undeveloped or partially developed.
  • Building: An entire non-residential building sold as a unit, such as a hotel or hangar.
  • Parking: Spaces or boxes designed for vehicle storage.
Available options:
apartment,
building,
house,
land,
office,
other,
parking,
premises,
shop
Example:
​
transactionType
enum<string>
required
Available options:
rent,
sale
​
energyDpeLabels
enum<string>[]

Filter results to properties whose DPE label matches one of the provided letters.

Available options:
a,
b,
c,
d,
e,
f,
g
Example:
​
energyGesLabels
enum<string>[]

Filter results to properties whose greenhouse-gas (GES) label matches one of the provided letters.

Available options:
a,
b,
c,
d,
e,
f,
g
Example:
​
locationDepartments
string[]

List of French department codes (e.g., "75" for Paris).

Example:
​
locationGeoBbox
object

Bounding box filter built from south-west and north-east corners in EPSG:4326.

​
locationGeoCircle
object

Circular geo filter defined by a center and radius in meters.

​
locationInseeCodes
string[]

List of INSEE city codes.

Example:
​
locationPostcodes
string[]

List of French postcodes.

Example:
​
orderBy
enum<string>
default:desc

Direction applied to sortBy. Defaults to desc.

Available options:
asc,
desc
​
propertyAreaMax
integer

Maximum property area (m²).

Example:

100

​
propertyAreaMin
integer

Minimum property area (m²).

Example:

40

​
propertyBalconyExists
boolean

Filter results to properties that have a balcony.

Example:

true

​
propertyBedroomCountMin
integer

Minimum number of bedrooms.

Required range: x >= 0
Example:

2

​
propertyCellarExists
boolean

Filter results to properties that have a cellar.

Example:

false

​
propertyElevatorExists
boolean

Filter results to properties that have an elevator.

Example:

true

​
propertyGarageExists
boolean

Filter results to properties that have a garage.

Example:

false

​
propertyGardenExists
boolean

Filter results to properties that have a garden.

Example:

false

​
propertyIsProgram
boolean

Limit to new-build/off-plan programs.

Example:

false

​
propertyParkingExists
boolean

Filter results to properties that have parking.

Example:

true

​
propertyRoomCountMin
integer

Minimum total room count.

Required range: x >= 0
Example:

3

​
propertySwimmingPoolExists
boolean

Filter results to properties that have a swimming pool.

Example:

false

​
propertyTerraceExists
boolean

Filter results to properties that have a terrace.

Example:

true

​
searchQuery
string

Optional full-text query. When omitted, an empty query is used.

Maximum string length: 400
Example:

"terrasse ascenseur"

​
searchThreshold
number<float>
default:0.2

Minimum relevance score required for a hit to be kept.

Required range: 0 <= x <= 1
Example:

0.2

​
sortBy
enum<string>
default:firstSeenAt

Field used to sort results. Set orderBy to switch between ascending or descending order. Defaults to firstSeenAt with desc.

Available options:
firstSeenAt,
lastSeenAt,
lastUpdatedAt,
price,
priceChangeDate,
pricePerSquareMeter,
relevance
​
sourceDomains
string[]

Limit results to classifieds originating from the provided domains.

Example:
​
sourceDomainsCountMax
integer

Maximum number of distinct source domains attached to each property.

Example:

3

​
sourceDomainsCountMin
integer

Minimum number of distinct source domains attached to each property.

Example:

1

​
transactionPriceHasChanged
boolean

Only properties whose price has changed recently.

Example:

false

​
transactionPriceMax
integer

Maximum current price.

Example:

1000000

​
transactionPriceMin
integer

Minimum current price.

Example:

200000

Response

List of properties matching the filters

​
items
object[]
required
​
meta
object
required