Search properties with filters

Returns a paginated list of properties based on searchable fields

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 status: current: available

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.

Afficher attributs enfants

Example:

["apartment", "house"]

transactionType · enum<string> · required

Options disponibles:

rent,

sale

energyDpeLabels · enum<string>[]

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

Afficher attributs enfants

Example:

["a", "b"]

energyGesLabels · enum<string>[]

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

Afficher attributs enfants

Example:

["a", "b"]

locationDepartments · string[]

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

Example:

["75", "92"]

locationGeoBbox · object

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

Afficher attributs enfants

locationGeoCircle · object

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

Afficher attributs enfants

locationInseeCodes · string[]

List of INSEE city codes.

Example:

["75056", "92050"]

locationPostcodes · string[]

List of French postcodes.

Example:

["75001", "92000"]

orderBy · enum<string> · default: desc

Direction applied to sortBy. Defaults to desc.

Options disponibles:

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

sortBy · enum<string> · default: firstSeenAt

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

Options disponibles:

firstSeenAt,

lastSeenAt,

lastUpdatedAt,

price,

priceChangeDate,

pricePerSquareMeter,

relevance

sourceDomains · string[]

Limit results to classifieds originating from the provided domains.

Example:

["bienici.com", "orpi.com"]

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

200

application/json

List of properties matching the filters

items · object[] · required

Afficher attributs enfants

meta · object · required

Afficher attributs enfants