/quintoandar/properties/similar

POST /api/quintoandar/properties/similar

Price: 1 credit

Get QuintoAndar listings recommended for a given property by scope (nearby, same condominium, or same neighbourhood). Returns listings with address, neighbourhood and coordinates, rent and sale price, total cost, area, bedrooms, bathrooms, suites, parking, amenities, installations, listing tags and images.

How to use it

Fetch QuintoAndar listings similar to a property (property=895519971, scope=nearby/condominium/neighbourhood, business_context=RENT or SALE). Each item has id, url, address, neighbourhood, city, latitude/longitude, rent_value, sale_price, total_cost, area, bedroom_count, bathroom_count, suite_count, parking_count, amenities, installations, listing_tags, image and images.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• property string required — QuintoAndar numeric property ID or a property URL containing it (examples: "895519971"; minLength: 1)
• scope string — Recommendation scope (default: "nearby"; one of: "nearby", "condominium", "neighbourhood")
• business_context string — Rent or sale listings (default: "RENT"; one of: "RENT", "SALE")
• count integer required — Max number of similar listings to return (min: 1)

Response

• @type string (default: "QuintoandarListing")
• id string required
• url string required
• house_type string nullable
• address string nullable
• neighbourhood string nullable
• region_name string nullable
• city string nullable
• latitude number nullable
• longitude number nullable
• rent_value number nullable
• sale_price number nullable
• total_cost number nullable
• condominium number nullable
• iptu_plus_condominium number nullable
• area number nullable
• bedroom_count integer nullable
• bathroom_count integer nullable
• suite_count integer nullable
• parking_count integer nullable
• is_furnished boolean nullable
• has_elevator boolean nullable
• for_rent boolean nullable
• for_sale boolean nullable
• visit_status string nullable
• yield_rate number nullable
• listing_tags array (default: [])
• special_conditions array (default: [])
• amenities array (default: [])
• installations array (default: [])
• accessibility array (default: [])
• image string nullable
• images array (default: [])

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 — Property not found (well-formed but nonexistent ID) 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.