Skip to main content
POST
/
api
/
immobiliare
/
properties
/
search
/immobiliare/properties/search
curl --request POST \
  --url https://api.anysite.io/api/immobiliare/properties/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "location": "<string>",
  "count": 2,
  "timeout": 300,
  "contract": "sale",
  "sort": "relevance",
  "min_price": 1,
  "max_price": 1,
  "min_surface": 1,
  "max_surface": 1,
  "min_rooms": 2,
  "max_rooms": 2,
  "bathrooms": 2,
  "floor": [],
  "garage": [],
  "garden": [],
  "heating": [],
  "outdoor": [],
  "has_elevator": true,
  "is_furnished": true,
  "has_cellar": true,
  "has_pool": true,
  "has_virtual_tour": true,
  "exclude_auctions": true
}
'
[
  {
    "id": 123,
    "@type": "@immobiliare_property_card",
    "url": "<string>",
    "title": "<string>",
    "caption": "<string>",
    "contract": "<string>",
    "property_type": "<string>",
    "typology": "<string>",
    "is_new": true,
    "is_luxury": true,
    "price": 123,
    "price_range": "<string>",
    "surface": 123,
    "rooms": 123,
    "bedrooms": 123,
    "bathrooms": 123,
    "floor": "<string>",
    "has_elevator": true,
    "energy_class": "<string>",
    "heating": "<string>",
    "condition": "<string>",
    "features": [],
    "address": "<string>",
    "zone": "<string>",
    "microzone": "<string>",
    "city": "<string>",
    "province": "<string>",
    "region": "<string>",
    "latitude": 123,
    "longitude": 123,
    "description": "<string>",
    "photos": [],
    "agency": {
      "@type": "@immobiliare_agency",
      "id": 123,
      "name": "<string>",
      "label": "<string>",
      "phone": "<string>",
      "url": "<string>",
      "image": "<string>",
      "agent_name": "<string>",
      "agent_phone": "<string>"
    }
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
location
string
required

City, province, neighbourhood or zone to search in

Minimum string length: 1
Examples:

"Roma"

"Milano"

"Roma Centocelle"

count
integer
required

Max number of results to return

Required range: x >= 1
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
contract
enum<string>
default:sale

Listing contract

Available options:
sale,
rent,
auction
property_type
enum<string> | null

Residential property type filter

Available options:
apartment,
attic,
detached_house,
loft,
farmhouse,
villa,
terraced_house
sort
enum<string>
default:relevance

Result ordering

Available options:
relevance,
price_asc,
price_desc,
surface_desc,
date_desc
min_price
integer | null

Minimum price filter in euro

Required range: x >= 0
max_price
integer | null

Maximum price filter in euro

Required range: x >= 0
min_surface
integer | null

Minimum surface filter in m²

Required range: x >= 0
max_surface
integer | null

Maximum surface filter in m²

Required range: x >= 0
min_rooms
integer | null

Minimum number of rooms filter

Required range: x >= 1
max_rooms
integer | null

Maximum number of rooms filter

Required range: x >= 1
bathrooms
integer | null

Exact number of bathrooms filter (4 means 3 or more)

Required range: 1 <= x <= 4
floor
enum<string>[] | null

Floor band filter

Available options:
ground_floor,
intermediate_floors,
top_floor
condition
enum<string> | null

Property condition filter

Available options:
new_or_under_construction,
excellent_or_renovated,
good_or_habitable,
to_be_renovated
garage
enum<string>[] | null

Garage / parking filter

Available options:
single_garage,
double_garage,
parking_space
garden
enum<string>[] | null

Garden filter

Available options:
private_garden,
shared_garden
heating
enum<string>[] | null

Heating / air conditioning filter

Available options:
autonomous,
centralized,
air_conditioning
outdoor
enum<string>[] | null

Balcony / terrace filter

Available options:
terrace,
balcony
has_elevator
boolean | null

Only listings with an elevator

is_furnished
boolean | null

Only furnished listings

has_cellar
boolean | null

Only listings with a cellar

has_pool
boolean | null

Only listings with a swimming pool

has_virtual_tour
boolean | null

Only listings with a virtual tour

exclude_auctions
boolean | null

Exclude auction listings

Response

Successful Response

id
integer
required
@type
string
default:@immobiliare_property_card
url
string | null
title
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
description
string | null
photos
string[]
agency
ImmobiliareAgency · object