Search properties with filters
curl --request POST \
--url https://api.immoteur.com/public/v1/properties/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"page": 1,
"transactionType": "sale",
"propertyTypes": [
"apartment",
"house"
],
"searchQuery": "terrasse ascenseur",
"searchThreshold": 0.2,
"locationDepartments": [
"75",
"92"
],
"locationInseeCodes": [
"75056",
"92050"
],
"locationPostcodes": [
"75001",
"92000"
],
"locationGeoBbox": {
"sw": {
"lat": 48.8156,
"lng": 2.2241
},
"ne": {
"lat": 48.9021,
"lng": 2.4699
}
},
"locationGeoCircle": {
"center": {
"lat": 48.8566,
"lng": 2.3522
},
"radiusMeters": 5000
},
"transactionPriceMin": 200000,
"transactionPriceMax": 1000000,
"propertyBedroomCountMin": 2,
"propertyAreaMin": 40,
"propertyElevatorExists": true,
"propertyTerraceExists": true,
"propertyParkingExists": true,
"sourceDomains": [
"bienici.com",
"orpi.com"
],
"sourceDomainsCountMin": 1,
"sourceDomainsCountMax": 3
}
'import requests
url = "https://api.immoteur.com/public/v1/properties/search"
payload = {
"page": 1,
"transactionType": "sale",
"propertyTypes": ["apartment", "house"],
"searchQuery": "terrasse ascenseur",
"searchThreshold": 0.2,
"locationDepartments": ["75", "92"],
"locationInseeCodes": ["75056", "92050"],
"locationPostcodes": ["75001", "92000"],
"locationGeoBbox": {
"sw": {
"lat": 48.8156,
"lng": 2.2241
},
"ne": {
"lat": 48.9021,
"lng": 2.4699
}
},
"locationGeoCircle": {
"center": {
"lat": 48.8566,
"lng": 2.3522
},
"radiusMeters": 5000
},
"transactionPriceMin": 200000,
"transactionPriceMax": 1000000,
"propertyBedroomCountMin": 2,
"propertyAreaMin": 40,
"propertyElevatorExists": True,
"propertyTerraceExists": True,
"propertyParkingExists": True,
"sourceDomains": ["bienici.com", "orpi.com"],
"sourceDomainsCountMin": 1,
"sourceDomainsCountMax": 3
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
page: 1,
transactionType: 'sale',
propertyTypes: ['apartment', 'house'],
searchQuery: 'terrasse ascenseur',
searchThreshold: 0.2,
locationDepartments: ['75', '92'],
locationInseeCodes: ['75056', '92050'],
locationPostcodes: ['75001', '92000'],
locationGeoBbox: {sw: {lat: 48.8156, lng: 2.2241}, ne: {lat: 48.9021, lng: 2.4699}},
locationGeoCircle: {center: {lat: 48.8566, lng: 2.3522}, radiusMeters: 5000},
transactionPriceMin: 200000,
transactionPriceMax: 1000000,
propertyBedroomCountMin: 2,
propertyAreaMin: 40,
propertyElevatorExists: true,
propertyTerraceExists: true,
propertyParkingExists: true,
sourceDomains: ['bienici.com', 'orpi.com'],
sourceDomainsCountMin: 1,
sourceDomainsCountMax: 3
})
};
fetch('https://api.immoteur.com/public/v1/properties/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.immoteur.com/public/v1/properties/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'page' => 1,
'transactionType' => 'sale',
'propertyTypes' => [
'apartment',
'house'
],
'searchQuery' => 'terrasse ascenseur',
'searchThreshold' => 0.2,
'locationDepartments' => [
'75',
'92'
],
'locationInseeCodes' => [
'75056',
'92050'
],
'locationPostcodes' => [
'75001',
'92000'
],
'locationGeoBbox' => [
'sw' => [
'lat' => 48.8156,
'lng' => 2.2241
],
'ne' => [
'lat' => 48.9021,
'lng' => 2.4699
]
],
'locationGeoCircle' => [
'center' => [
'lat' => 48.8566,
'lng' => 2.3522
],
'radiusMeters' => 5000
],
'transactionPriceMin' => 200000,
'transactionPriceMax' => 1000000,
'propertyBedroomCountMin' => 2,
'propertyAreaMin' => 40,
'propertyElevatorExists' => true,
'propertyTerraceExists' => true,
'propertyParkingExists' => true,
'sourceDomains' => [
'bienici.com',
'orpi.com'
],
'sourceDomainsCountMin' => 1,
'sourceDomainsCountMax' => 3
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.immoteur.com/public/v1/properties/search"
payload := strings.NewReader("{\n \"page\": 1,\n \"transactionType\": \"sale\",\n \"propertyTypes\": [\n \"apartment\",\n \"house\"\n ],\n \"searchQuery\": \"terrasse ascenseur\",\n \"searchThreshold\": 0.2,\n \"locationDepartments\": [\n \"75\",\n \"92\"\n ],\n \"locationInseeCodes\": [\n \"75056\",\n \"92050\"\n ],\n \"locationPostcodes\": [\n \"75001\",\n \"92000\"\n ],\n \"locationGeoBbox\": {\n \"sw\": {\n \"lat\": 48.8156,\n \"lng\": 2.2241\n },\n \"ne\": {\n \"lat\": 48.9021,\n \"lng\": 2.4699\n }\n },\n \"locationGeoCircle\": {\n \"center\": {\n \"lat\": 48.8566,\n \"lng\": 2.3522\n },\n \"radiusMeters\": 5000\n },\n \"transactionPriceMin\": 200000,\n \"transactionPriceMax\": 1000000,\n \"propertyBedroomCountMin\": 2,\n \"propertyAreaMin\": 40,\n \"propertyElevatorExists\": true,\n \"propertyTerraceExists\": true,\n \"propertyParkingExists\": true,\n \"sourceDomains\": [\n \"bienici.com\",\n \"orpi.com\"\n ],\n \"sourceDomainsCountMin\": 1,\n \"sourceDomainsCountMax\": 3\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.immoteur.com/public/v1/properties/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"page\": 1,\n \"transactionType\": \"sale\",\n \"propertyTypes\": [\n \"apartment\",\n \"house\"\n ],\n \"searchQuery\": \"terrasse ascenseur\",\n \"searchThreshold\": 0.2,\n \"locationDepartments\": [\n \"75\",\n \"92\"\n ],\n \"locationInseeCodes\": [\n \"75056\",\n \"92050\"\n ],\n \"locationPostcodes\": [\n \"75001\",\n \"92000\"\n ],\n \"locationGeoBbox\": {\n \"sw\": {\n \"lat\": 48.8156,\n \"lng\": 2.2241\n },\n \"ne\": {\n \"lat\": 48.9021,\n \"lng\": 2.4699\n }\n },\n \"locationGeoCircle\": {\n \"center\": {\n \"lat\": 48.8566,\n \"lng\": 2.3522\n },\n \"radiusMeters\": 5000\n },\n \"transactionPriceMin\": 200000,\n \"transactionPriceMax\": 1000000,\n \"propertyBedroomCountMin\": 2,\n \"propertyAreaMin\": 40,\n \"propertyElevatorExists\": true,\n \"propertyTerraceExists\": true,\n \"propertyParkingExists\": true,\n \"sourceDomains\": [\n \"bienici.com\",\n \"orpi.com\"\n ],\n \"sourceDomainsCountMin\": 1,\n \"sourceDomainsCountMax\": 3\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.immoteur.com/public/v1/properties/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"page\": 1,\n \"transactionType\": \"sale\",\n \"propertyTypes\": [\n \"apartment\",\n \"house\"\n ],\n \"searchQuery\": \"terrasse ascenseur\",\n \"searchThreshold\": 0.2,\n \"locationDepartments\": [\n \"75\",\n \"92\"\n ],\n \"locationInseeCodes\": [\n \"75056\",\n \"92050\"\n ],\n \"locationPostcodes\": [\n \"75001\",\n \"92000\"\n ],\n \"locationGeoBbox\": {\n \"sw\": {\n \"lat\": 48.8156,\n \"lng\": 2.2241\n },\n \"ne\": {\n \"lat\": 48.9021,\n \"lng\": 2.4699\n }\n },\n \"locationGeoCircle\": {\n \"center\": {\n \"lat\": 48.8566,\n \"lng\": 2.3522\n },\n \"radiusMeters\": 5000\n },\n \"transactionPriceMin\": 200000,\n \"transactionPriceMax\": 1000000,\n \"propertyBedroomCountMin\": 2,\n \"propertyAreaMin\": 40,\n \"propertyElevatorExists\": true,\n \"propertyTerraceExists\": true,\n \"propertyParkingExists\": true,\n \"sourceDomains\": [\n \"bienici.com\",\n \"orpi.com\"\n ],\n \"sourceDomainsCountMin\": 1,\n \"sourceDomainsCountMax\": 3\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"id": "3a8f1d72-3d0b-4ee6-9a83-a7a9a73ae6c2",
"status": {
"current": "available"
},
"description": "Appartement lumineux de 3 pièces avec balcon.",
"location": {
"city": {
"name": "Paris",
"inseeCode": "75056"
},
"country": "france",
"department": "75",
"postcode": "75001",
"latitude": 48.8606,
"longitude": 2.3376
},
"media": {
"images": [
{
"id": "2f6bb0f5-1e2f-4dc9-8f46-8fd0c1f7cafe",
"position": 1,
"url": "https://images.immoteur.com/sample/apt-paris-1.jpg"
}
]
},
"property": {
"type": "apartment",
"area": 52.5,
"bedroomCount": 2,
"roomCount": 3,
"balconyExists": true
},
"classifieds": [
{
"id": "75caa436-207a-4f06-b0d1-3c1a3508dbbb",
"status": {
"current": "available"
},
"source": {
"domain": "seloger.com",
"url": "https://www.seloger.com/annonces/achat/appartement/paris-1er-75/5-pieces/0.htm"
},
"publisher": {
"isProfessional": true,
"type": "agency",
"email": "contact@agence-paris.fr",
"phone": "+33123456789",
"feesUrl": "https://www.agence-paris.fr/honoraires",
"siren": "123456789"
},
"transaction": {
"current": 650000,
"history": [
{
"id": "0aa4bc4b-7db0-4bf2-9a4a-f2e6f8d4f99a",
"value": 680000,
"timestamp": "2025-06-20T10:23:00Z"
},
{
"id": "4d4744d6-d7f1-4f8b-8c3c-fb8a1e3c0f8a",
"value": 650000,
"timestamp": "2025-06-25T07:45:00Z"
}
],
"initial": 680000,
"perSquareUnit": 12500
}
}
],
"transaction": {
"type": "sale",
"price": {
"current": 650000,
"history": [
{
"id": "0aa4bc4b-7db0-4bf2-9a4a-f2e6f8d4f99a",
"value": 680000,
"timestamp": "2025-06-20T10:23:00Z"
},
{
"id": "4d4744d6-d7f1-4f8b-8c3c-fb8a1e3c0f8a",
"value": 650000,
"timestamp": "2025-06-25T07:45:00Z"
}
],
"initial": 680000,
"perSquareUnit": 12500
}
},
"meta": {
"firstSeenAt": "2025-05-10T08:00:00Z",
"lastSeenAt": "2025-06-20T11:00:00Z"
},
"energy": {
"dpe": {
"date": "2023-05-10",
"label": "d",
"value": 180
},
"ges": {
"date": "2023-05-10",
"label": "e",
"value": 45
},
"heating": {
"source": "gas",
"system": "radiator",
"type": "individual"
}
}
}
],
"meta": {
"subscriptionPlan": "pro200",
"dataAccessLimit": {
"departments": [
"75",
"92"
],
"sirens": [
"123456789"
],
"sirets": [
"12345678900011"
]
},
"page": 1,
"nextPage": 2,
"perPage": 20,
"total": 240,
"totalPages": 12
}
}{
"code": "resource_not_found",
"detail": "The requested resource could not be found.",
"instance": "/public/v1/properties/019c12dc-339f-72ce-98db-663b44c0d924",
"status": 404,
"title": "Resource not found",
"traceId": "b94f4db5-2f5e-4b8f-9dd0-f2fe5c7a7a4f",
"type": "https://docs.immoteur.com/problems/resource_not_found"
}{
"code": "resource_not_found",
"detail": "The requested resource could not be found.",
"instance": "/public/v1/properties/019c12dc-339f-72ce-98db-663b44c0d924",
"status": 404,
"title": "Resource not found",
"traceId": "b94f4db5-2f5e-4b8f-9dd0-f2fe5c7a7a4f",
"type": "https://docs.immoteur.com/problems/resource_not_found"
}{
"code": "resource_not_found",
"detail": "The requested resource could not be found.",
"instance": "/public/v1/properties/019c12dc-339f-72ce-98db-663b44c0d924",
"status": 404,
"title": "Resource not found",
"traceId": "b94f4db5-2f5e-4b8f-9dd0-f2fe5c7a7a4f",
"type": "https://docs.immoteur.com/problems/resource_not_found"
}{
"code": "resource_not_found",
"detail": "The requested resource could not be found.",
"instance": "/public/v1/properties/019c12dc-339f-72ce-98db-663b44c0d924",
"status": 404,
"title": "Resource not found",
"traceId": "b94f4db5-2f5e-4b8f-9dd0-f2fe5c7a7a4f",
"type": "https://docs.immoteur.com/problems/resource_not_found"
}{
"message": "Data access (SIREN / SIRET / Department) not configured.",
"configurationUrl": "https://immoteur.com/en/dashboard/billing#data-access",
"documentationUrl": "https://docs.immoteur.com/pages/en/introduction"
}{
"code": "validation_error",
"detail": "One or more request fields are invalid.",
"instance": "/public/v1/properties/search",
"status": 422,
"title": "Validation error",
"traceId": "4bdb0c23-53fc-4d14-a300-c63eb420ec5e",
"type": "https://docs.immoteur.com/problems/validation_error",
"violations": [
{
"code": "validation",
"field": "id",
"message": "The id field must be a valid UUID."
}
]
}{
"code": "resource_not_found",
"detail": "The requested resource could not be found.",
"instance": "/public/v1/properties/019c12dc-339f-72ce-98db-663b44c0d924",
"status": 404,
"title": "Resource not found",
"traceId": "b94f4db5-2f5e-4b8f-9dd0-f2fe5c7a7a4f",
"type": "https://docs.immoteur.com/problems/resource_not_found"
}{
"code": "resource_not_found",
"detail": "The requested resource could not be found.",
"instance": "/public/v1/properties/019c12dc-339f-72ce-98db-663b44c0d924",
"status": 404,
"title": "Resource not found",
"traceId": "b94f4db5-2f5e-4b8f-9dd0-f2fe5c7a7a4f",
"type": "https://docs.immoteur.com/problems/resource_not_found"
}Property
Search properties with filters
Returns a paginated list of properties based on searchable fields
POST
/
properties
/
search
Search properties with filters
curl --request POST \
--url https://api.immoteur.com/public/v1/properties/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"page": 1,
"transactionType": "sale",
"propertyTypes": [
"apartment",
"house"
],
"searchQuery": "terrasse ascenseur",
"searchThreshold": 0.2,
"locationDepartments": [
"75",
"92"
],
"locationInseeCodes": [
"75056",
"92050"
],
"locationPostcodes": [
"75001",
"92000"
],
"locationGeoBbox": {
"sw": {
"lat": 48.8156,
"lng": 2.2241
},
"ne": {
"lat": 48.9021,
"lng": 2.4699
}
},
"locationGeoCircle": {
"center": {
"lat": 48.8566,
"lng": 2.3522
},
"radiusMeters": 5000
},
"transactionPriceMin": 200000,
"transactionPriceMax": 1000000,
"propertyBedroomCountMin": 2,
"propertyAreaMin": 40,
"propertyElevatorExists": true,
"propertyTerraceExists": true,
"propertyParkingExists": true,
"sourceDomains": [
"bienici.com",
"orpi.com"
],
"sourceDomainsCountMin": 1,
"sourceDomainsCountMax": 3
}
'import requests
url = "https://api.immoteur.com/public/v1/properties/search"
payload = {
"page": 1,
"transactionType": "sale",
"propertyTypes": ["apartment", "house"],
"searchQuery": "terrasse ascenseur",
"searchThreshold": 0.2,
"locationDepartments": ["75", "92"],
"locationInseeCodes": ["75056", "92050"],
"locationPostcodes": ["75001", "92000"],
"locationGeoBbox": {
"sw": {
"lat": 48.8156,
"lng": 2.2241
},
"ne": {
"lat": 48.9021,
"lng": 2.4699
}
},
"locationGeoCircle": {
"center": {
"lat": 48.8566,
"lng": 2.3522
},
"radiusMeters": 5000
},
"transactionPriceMin": 200000,
"transactionPriceMax": 1000000,
"propertyBedroomCountMin": 2,
"propertyAreaMin": 40,
"propertyElevatorExists": True,
"propertyTerraceExists": True,
"propertyParkingExists": True,
"sourceDomains": ["bienici.com", "orpi.com"],
"sourceDomainsCountMin": 1,
"sourceDomainsCountMax": 3
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
page: 1,
transactionType: 'sale',
propertyTypes: ['apartment', 'house'],
searchQuery: 'terrasse ascenseur',
searchThreshold: 0.2,
locationDepartments: ['75', '92'],
locationInseeCodes: ['75056', '92050'],
locationPostcodes: ['75001', '92000'],
locationGeoBbox: {sw: {lat: 48.8156, lng: 2.2241}, ne: {lat: 48.9021, lng: 2.4699}},
locationGeoCircle: {center: {lat: 48.8566, lng: 2.3522}, radiusMeters: 5000},
transactionPriceMin: 200000,
transactionPriceMax: 1000000,
propertyBedroomCountMin: 2,
propertyAreaMin: 40,
propertyElevatorExists: true,
propertyTerraceExists: true,
propertyParkingExists: true,
sourceDomains: ['bienici.com', 'orpi.com'],
sourceDomainsCountMin: 1,
sourceDomainsCountMax: 3
})
};
fetch('https://api.immoteur.com/public/v1/properties/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.immoteur.com/public/v1/properties/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'page' => 1,
'transactionType' => 'sale',
'propertyTypes' => [
'apartment',
'house'
],
'searchQuery' => 'terrasse ascenseur',
'searchThreshold' => 0.2,
'locationDepartments' => [
'75',
'92'
],
'locationInseeCodes' => [
'75056',
'92050'
],
'locationPostcodes' => [
'75001',
'92000'
],
'locationGeoBbox' => [
'sw' => [
'lat' => 48.8156,
'lng' => 2.2241
],
'ne' => [
'lat' => 48.9021,
'lng' => 2.4699
]
],
'locationGeoCircle' => [
'center' => [
'lat' => 48.8566,
'lng' => 2.3522
],
'radiusMeters' => 5000
],
'transactionPriceMin' => 200000,
'transactionPriceMax' => 1000000,
'propertyBedroomCountMin' => 2,
'propertyAreaMin' => 40,
'propertyElevatorExists' => true,
'propertyTerraceExists' => true,
'propertyParkingExists' => true,
'sourceDomains' => [
'bienici.com',
'orpi.com'
],
'sourceDomainsCountMin' => 1,
'sourceDomainsCountMax' => 3
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.immoteur.com/public/v1/properties/search"
payload := strings.NewReader("{\n \"page\": 1,\n \"transactionType\": \"sale\",\n \"propertyTypes\": [\n \"apartment\",\n \"house\"\n ],\n \"searchQuery\": \"terrasse ascenseur\",\n \"searchThreshold\": 0.2,\n \"locationDepartments\": [\n \"75\",\n \"92\"\n ],\n \"locationInseeCodes\": [\n \"75056\",\n \"92050\"\n ],\n \"locationPostcodes\": [\n \"75001\",\n \"92000\"\n ],\n \"locationGeoBbox\": {\n \"sw\": {\n \"lat\": 48.8156,\n \"lng\": 2.2241\n },\n \"ne\": {\n \"lat\": 48.9021,\n \"lng\": 2.4699\n }\n },\n \"locationGeoCircle\": {\n \"center\": {\n \"lat\": 48.8566,\n \"lng\": 2.3522\n },\n \"radiusMeters\": 5000\n },\n \"transactionPriceMin\": 200000,\n \"transactionPriceMax\": 1000000,\n \"propertyBedroomCountMin\": 2,\n \"propertyAreaMin\": 40,\n \"propertyElevatorExists\": true,\n \"propertyTerraceExists\": true,\n \"propertyParkingExists\": true,\n \"sourceDomains\": [\n \"bienici.com\",\n \"orpi.com\"\n ],\n \"sourceDomainsCountMin\": 1,\n \"sourceDomainsCountMax\": 3\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.immoteur.com/public/v1/properties/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"page\": 1,\n \"transactionType\": \"sale\",\n \"propertyTypes\": [\n \"apartment\",\n \"house\"\n ],\n \"searchQuery\": \"terrasse ascenseur\",\n \"searchThreshold\": 0.2,\n \"locationDepartments\": [\n \"75\",\n \"92\"\n ],\n \"locationInseeCodes\": [\n \"75056\",\n \"92050\"\n ],\n \"locationPostcodes\": [\n \"75001\",\n \"92000\"\n ],\n \"locationGeoBbox\": {\n \"sw\": {\n \"lat\": 48.8156,\n \"lng\": 2.2241\n },\n \"ne\": {\n \"lat\": 48.9021,\n \"lng\": 2.4699\n }\n },\n \"locationGeoCircle\": {\n \"center\": {\n \"lat\": 48.8566,\n \"lng\": 2.3522\n },\n \"radiusMeters\": 5000\n },\n \"transactionPriceMin\": 200000,\n \"transactionPriceMax\": 1000000,\n \"propertyBedroomCountMin\": 2,\n \"propertyAreaMin\": 40,\n \"propertyElevatorExists\": true,\n \"propertyTerraceExists\": true,\n \"propertyParkingExists\": true,\n \"sourceDomains\": [\n \"bienici.com\",\n \"orpi.com\"\n ],\n \"sourceDomainsCountMin\": 1,\n \"sourceDomainsCountMax\": 3\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.immoteur.com/public/v1/properties/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"page\": 1,\n \"transactionType\": \"sale\",\n \"propertyTypes\": [\n \"apartment\",\n \"house\"\n ],\n \"searchQuery\": \"terrasse ascenseur\",\n \"searchThreshold\": 0.2,\n \"locationDepartments\": [\n \"75\",\n \"92\"\n ],\n \"locationInseeCodes\": [\n \"75056\",\n \"92050\"\n ],\n \"locationPostcodes\": [\n \"75001\",\n \"92000\"\n ],\n \"locationGeoBbox\": {\n \"sw\": {\n \"lat\": 48.8156,\n \"lng\": 2.2241\n },\n \"ne\": {\n \"lat\": 48.9021,\n \"lng\": 2.4699\n }\n },\n \"locationGeoCircle\": {\n \"center\": {\n \"lat\": 48.8566,\n \"lng\": 2.3522\n },\n \"radiusMeters\": 5000\n },\n \"transactionPriceMin\": 200000,\n \"transactionPriceMax\": 1000000,\n \"propertyBedroomCountMin\": 2,\n \"propertyAreaMin\": 40,\n \"propertyElevatorExists\": true,\n \"propertyTerraceExists\": true,\n \"propertyParkingExists\": true,\n \"sourceDomains\": [\n \"bienici.com\",\n \"orpi.com\"\n ],\n \"sourceDomainsCountMin\": 1,\n \"sourceDomainsCountMax\": 3\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"id": "3a8f1d72-3d0b-4ee6-9a83-a7a9a73ae6c2",
"status": {
"current": "available"
},
"description": "Appartement lumineux de 3 pièces avec balcon.",
"location": {
"city": {
"name": "Paris",
"inseeCode": "75056"
},
"country": "france",
"department": "75",
"postcode": "75001",
"latitude": 48.8606,
"longitude": 2.3376
},
"media": {
"images": [
{
"id": "2f6bb0f5-1e2f-4dc9-8f46-8fd0c1f7cafe",
"position": 1,
"url": "https://images.immoteur.com/sample/apt-paris-1.jpg"
}
]
},
"property": {
"type": "apartment",
"area": 52.5,
"bedroomCount": 2,
"roomCount": 3,
"balconyExists": true
},
"classifieds": [
{
"id": "75caa436-207a-4f06-b0d1-3c1a3508dbbb",
"status": {
"current": "available"
},
"source": {
"domain": "seloger.com",
"url": "https://www.seloger.com/annonces/achat/appartement/paris-1er-75/5-pieces/0.htm"
},
"publisher": {
"isProfessional": true,
"type": "agency",
"email": "contact@agence-paris.fr",
"phone": "+33123456789",
"feesUrl": "https://www.agence-paris.fr/honoraires",
"siren": "123456789"
},
"transaction": {
"current": 650000,
"history": [
{
"id": "0aa4bc4b-7db0-4bf2-9a4a-f2e6f8d4f99a",
"value": 680000,
"timestamp": "2025-06-20T10:23:00Z"
},
{
"id": "4d4744d6-d7f1-4f8b-8c3c-fb8a1e3c0f8a",
"value": 650000,
"timestamp": "2025-06-25T07:45:00Z"
}
],
"initial": 680000,
"perSquareUnit": 12500
}
}
],
"transaction": {
"type": "sale",
"price": {
"current": 650000,
"history": [
{
"id": "0aa4bc4b-7db0-4bf2-9a4a-f2e6f8d4f99a",
"value": 680000,
"timestamp": "2025-06-20T10:23:00Z"
},
{
"id": "4d4744d6-d7f1-4f8b-8c3c-fb8a1e3c0f8a",
"value": 650000,
"timestamp": "2025-06-25T07:45:00Z"
}
],
"initial": 680000,
"perSquareUnit": 12500
}
},
"meta": {
"firstSeenAt": "2025-05-10T08:00:00Z",
"lastSeenAt": "2025-06-20T11:00:00Z"
},
"energy": {
"dpe": {
"date": "2023-05-10",
"label": "d",
"value": 180
},
"ges": {
"date": "2023-05-10",
"label": "e",
"value": 45
},
"heating": {
"source": "gas",
"system": "radiator",
"type": "individual"
}
}
}
],
"meta": {
"subscriptionPlan": "pro200",
"dataAccessLimit": {
"departments": [
"75",
"92"
],
"sirens": [
"123456789"
],
"sirets": [
"12345678900011"
]
},
"page": 1,
"nextPage": 2,
"perPage": 20,
"total": 240,
"totalPages": 12
}
}{
"code": "resource_not_found",
"detail": "The requested resource could not be found.",
"instance": "/public/v1/properties/019c12dc-339f-72ce-98db-663b44c0d924",
"status": 404,
"title": "Resource not found",
"traceId": "b94f4db5-2f5e-4b8f-9dd0-f2fe5c7a7a4f",
"type": "https://docs.immoteur.com/problems/resource_not_found"
}{
"code": "resource_not_found",
"detail": "The requested resource could not be found.",
"instance": "/public/v1/properties/019c12dc-339f-72ce-98db-663b44c0d924",
"status": 404,
"title": "Resource not found",
"traceId": "b94f4db5-2f5e-4b8f-9dd0-f2fe5c7a7a4f",
"type": "https://docs.immoteur.com/problems/resource_not_found"
}{
"code": "resource_not_found",
"detail": "The requested resource could not be found.",
"instance": "/public/v1/properties/019c12dc-339f-72ce-98db-663b44c0d924",
"status": 404,
"title": "Resource not found",
"traceId": "b94f4db5-2f5e-4b8f-9dd0-f2fe5c7a7a4f",
"type": "https://docs.immoteur.com/problems/resource_not_found"
}{
"code": "resource_not_found",
"detail": "The requested resource could not be found.",
"instance": "/public/v1/properties/019c12dc-339f-72ce-98db-663b44c0d924",
"status": 404,
"title": "Resource not found",
"traceId": "b94f4db5-2f5e-4b8f-9dd0-f2fe5c7a7a4f",
"type": "https://docs.immoteur.com/problems/resource_not_found"
}{
"message": "Data access (SIREN / SIRET / Department) not configured.",
"configurationUrl": "https://immoteur.com/en/dashboard/billing#data-access",
"documentationUrl": "https://docs.immoteur.com/pages/en/introduction"
}{
"code": "validation_error",
"detail": "One or more request fields are invalid.",
"instance": "/public/v1/properties/search",
"status": 422,
"title": "Validation error",
"traceId": "4bdb0c23-53fc-4d14-a300-c63eb420ec5e",
"type": "https://docs.immoteur.com/problems/validation_error",
"violations": [
{
"code": "validation",
"field": "id",
"message": "The id field must be a valid UUID."
}
]
}{
"code": "resource_not_found",
"detail": "The requested resource could not be found.",
"instance": "/public/v1/properties/019c12dc-339f-72ce-98db-663b44c0d924",
"status": 404,
"title": "Resource not found",
"traceId": "b94f4db5-2f5e-4b8f-9dd0-f2fe5c7a7a4f",
"type": "https://docs.immoteur.com/problems/resource_not_found"
}{
"code": "resource_not_found",
"detail": "The requested resource could not be found.",
"instance": "/public/v1/properties/019c12dc-339f-72ce-98db-663b44c0d924",
"status": 404,
"title": "Resource not found",
"traceId": "b94f4db5-2f5e-4b8f-9dd0-f2fe5c7a7a4f",
"type": "https://docs.immoteur.com/problems/resource_not_found"
}Autorisations
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
Corps
application/json
1-based page index.
Plage requise:
1 <= x <= 500Exemple:
1
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.
Options disponibles:
apartment, building, house, land, office, other, parking, premises, shop Exemple:
["apartment", "house"]
Options disponibles:
rent, sale Filter results to properties whose DPE label matches one of the provided letters.
Options disponibles:
a, b, c, d, e, f, g Exemple:
["a", "b"]
Filter results to properties whose greenhouse-gas (GES) label matches one of the provided letters.
Options disponibles:
a, b, c, d, e, f, g Exemple:
["a", "b"]
List of French department codes (e.g., "75" for Paris).
Exemple:
["75", "92"]
Bounding box filter built from south-west and north-east corners in EPSG:4326.
Show child attributes
Show child attributes
Circular geo filter defined by a center and radius in meters.
Show child attributes
Show child attributes
List of INSEE city codes.
Exemple:
["75056", "92050"]
List of French postcodes.
Exemple:
["75001", "92000"]
Direction applied to sortBy. Defaults to desc.
Options disponibles:
asc, desc Maximum property area (m²).
Exemple:
100
Minimum property area (m²).
Exemple:
40
Filter results to properties that have a balcony.
Exemple:
true
Minimum number of bedrooms.
Plage requise:
x >= 0Exemple:
2
Filter results to properties that have a cellar.
Exemple:
false
Filter results to properties that have an elevator.
Exemple:
true
Filter results to properties that have a garage.
Exemple:
false
Filter results to properties that have a garden.
Exemple:
false
Limit to new-build/off-plan programs.
Exemple:
false
Filter results to properties that have parking.
Exemple:
true
Minimum total room count.
Plage requise:
x >= 0Exemple:
3
Filter results to properties that have a swimming pool.
Exemple:
false
Filter results to properties that have a terrace.
Exemple:
true
Optional full-text query. When omitted, an empty query is used.
Maximum string length:
400Exemple:
"terrasse ascenseur"
Minimum relevance score required for a hit to be kept.
Plage requise:
0 <= x <= 1Exemple:
0.2
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 Limit results to classifieds originating from the provided domains.
Exemple:
["bienici.com", "orpi.com"]
Maximum number of distinct source domains attached to each property.
Exemple:
3
Minimum number of distinct source domains attached to each property.
Exemple:
1
Only properties whose price has changed recently.
Exemple:
false
Maximum current price.
Exemple:
1000000
Minimum current price.
Exemple:
200000
⌘I