/immobiliare/agencies/search

POST /api/immobiliare/agencies/search

Price: 20 credits

Search Immobiliare.it real estate agencies by location (city or province) with contract, association and franchising group filters. Returns agency cards with name, type, description, address, phone, image, association, listing counts, years on the portal, quality index, badge and location with coordinates.

How to use it

Search Immobiliare.it real estate agencies in a location. location is a city ('Roma') or province; contract filters agencies that have sale/rent listings (all by default); association filters by membership (anama/fiaip/fimaa/ance/air); franchising filters by group name ('Gabetti', 'Tecnocasa', 'RE/MAX'). Each result has id, name, url, type, description, address, phone, image, association, listing_count, sale_listing_count, years_on_site, quality_index, badge, is_guaranteed and location (city, province, region, zone, coordinates).

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 or province to search agencies in (examples: "Roma", "Milano"; minLength: 1)
• contract string — Agency listing contract (default: "all"; one of: "all", "sale", "rent")
• association string nullable — Filter by real estate association membership (one of: "anama", "fiaip", "fimaa", "ance", "air")
• franchising string nullable — Filter by franchising group name (e.g. Gabetti, Tecnocasa, RE/MAX)
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "ImmobiliareAgencyListItem")
• id integer required
• name string nullable
• url string nullable
• type string nullable
• description string nullable
• address string nullable
• phone string nullable
• image string nullable
• association string nullable
• listing_count integer nullable
• sale_listing_count integer nullable
• years_on_site integer nullable
• quality_index integer nullable
• badge string nullable
• is_guaranteed boolean nullable
• location object nullable
  • @type string (default: "ImmobiliareAgencyLocation")
  • address string nullable
  • city string nullable
  • province string nullable
  • region string nullable
  • zone string nullable
  • latitude number nullable
  • longitude number 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, or franchising group name not found 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.