/immobiliare/properties/search

POST /api/immobiliare/properties/search

Price: 5 credits

Search Immobiliare.it real estate listings by location (city, province, neighbourhood or zone) with contract (sale/rent/auction), property type, price, surface, rooms, bathrooms, floor, condition, garage, garden, heating, balcony/terrace and amenity filters and ordering. Returns listing cards with title, property type, price, surface, rooms, bedrooms, bathrooms, floor, energy class, condition, address, coordinates, photos and the listing agency.

How to use it

Search Immobiliare.it listings in a location. location is a city ('Roma'), province or neighbourhood/zone ('Roma Centocelle'); contract selects sale, rent or auction; property_type filters apartment/attic/detached_house/loft/farmhouse/villa/terraced_house; sort orders by relevance, price or surface; min_price/max_price, min_surface/max_surface, min_rooms/max_rooms, bathrooms, floor, condition, garage, garden, heating, outdoor, has_elevator, is_furnished, has_cellar, has_pool, has_virtual_tour and exclude_auctions narrow the results. Each result has id, url, title, property_type, typology, price, surface, rooms, bedrooms, bathrooms, floor, energy_class, condition, features, address, zone, microzone, city, province, region, coordinates, photos and agency.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• location string required — City, province, neighbourhood or zone to search in (examples: "Roma", "Milano", "Roma Centocelle"; minLength: 1)
• contract string — Listing contract (default: "sale"; one of: "sale", "rent", "auction")
• property_type string nullable — Residential property type filter (one of: "apartment", "attic", "detached_house", "loft", "farmhouse", "villa", "terraced_house")
• sort string — Result ordering (default: "relevance"; one of: "relevance", "price_asc", "price_desc", "surface_desc", "date_desc")
• min_price integer nullable — Minimum price filter in euro (min: 0)
• max_price integer nullable — Maximum price filter in euro (min: 0)
• min_surface integer nullable — Minimum surface filter in m² (min: 0)
• max_surface integer nullable — Maximum surface filter in m² (min: 0)
• min_rooms integer nullable — Minimum number of rooms filter (min: 1)
• max_rooms integer nullable — Maximum number of rooms filter (min: 1)
• bathrooms integer nullable — Exact number of bathrooms filter (4 means 3 or more) (min: 1; max: 4)
• floor array nullable — Floor band filter (one of: "ground_floor", "intermediate_floors", "top_floor")
• condition string nullable — Property condition filter (one of: "new_or_under_construction", "excellent_or_renovated", "good_or_habitable", "to_be_renovated")
• garage array nullable — Garage / parking filter (one of: "single_garage", "double_garage", "parking_space")
• garden array nullable — Garden filter (one of: "private_garden", "shared_garden")
• heating array nullable — Heating / air conditioning filter (one of: "autonomous", "centralized", "air_conditioning")
• outdoor array nullable — Balcony / terrace filter (one of: "terrace", "balcony")
• has_elevator boolean nullable — Only listings with an elevator
• is_furnished boolean nullable — Only furnished listings
• has_cellar boolean nullable — Only listings with a cellar
• has_pool boolean nullable — Only listings with a swimming pool
• has_virtual_tour boolean nullable — Only listings with a virtual tour
• exclude_auctions boolean nullable — Exclude auction listings
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "ImmobiliarePropertyCard")
• id integer required
• url string nullable
• caption string nullable
• contract string nullable
• property_type string nullable
• typology string nullable
• is_new boolean nullable
• is_luxury boolean nullable
• price integer nullable
• price_range string nullable
• surface number nullable
• rooms integer nullable
• bedrooms integer nullable
• bathrooms integer nullable
• floor string nullable
• has_elevator boolean nullable
• energy_class string nullable
• heating string nullable
• condition string nullable
• features array (default: [])
• address string nullable
• zone string nullable
• microzone string nullable
• city string nullable
• province string nullable
• region string nullable
• latitude number nullable
• longitude number nullable
• description string nullable
• photos array (default: [])
• agency object nullable
  • @type string (default: "ImmobiliareAgency")
  • id integer nullable
  • name string nullable
  • label string nullable
  • phone string nullable
  • url string nullable
  • image string nullable
  • agent_name string nullable
  • agent_phone string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Location could not be resolved Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.