Skip to main content
POST
/immobiliare/properties/search

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
location
string
required
Minimum string length: 1
count
integer
required
Required range: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
contract
enum<string>
default:sale
Available options:
sale,
rent,
auction
property_type
enum<string> | null
Available options:
apartment,
attic,
detached_house,
loft,
farmhouse,
villa,
terraced_house
sort
enum<string>
default:relevance
Available options:
relevance,
price_asc,
price_desc,
surface_desc,
date_desc
min_price
integer | null
Required range: x >= 0
max_price
integer | null
Required range: x >= 0
min_surface
integer | null
Required range: x >= 0
max_surface
integer | null
Required range: x >= 0
min_rooms
integer | null
Required range: x >= 1
max_rooms
integer | null
Required range: x >= 1
bathrooms
integer | null
Required range: 1 <= x <= 4
floor
enum<string>[] | null
Available options:
ground_floor,
intermediate_floors,
top_floor
condition
enum<string> | null
Available options:
new_or_under_construction,
excellent_or_renovated,
good_or_habitable,
to_be_renovated
garage
enum<string>[] | null
Available options:
single_garage,
double_garage,
parking_space
garden
enum<string>[] | null
Available options:
private_garden,
shared_garden
heating
enum<string>[] | null
Available options:
autonomous,
centralized,
air_conditioning
outdoor
enum<string>[] | null
Available options:
terrace,
balcony
has_elevator
boolean | null
is_furnished
boolean | null
has_cellar
boolean | null
has_pool
boolean | null
has_virtual_tour
boolean | null
exclude_auctions
boolean | null

Response

Successful Response

id
integer
required
@type
string
default:ImmobiliarePropertyCard
url
string | null
caption
string | null
contract
string | null
property_type
string | null
typology
string | null
is_new
boolean | null
is_luxury
boolean | null
price
integer | null
price_range
string | null
surface
number | null
rooms
integer | null
bedrooms
integer | null
bathrooms
integer | null
floor
string | null
has_elevator
boolean | null
energy_class
string | null
heating
string | null
condition
string | null
features
string[]
address
string | null
zone
string | null
microzone
string | null
city
string | null
province
string | null
region
string | null
latitude
number | null
longitude
number | null
photos
string[]
agency
object | null