/quintoandar/properties

POST /api/quintoandar/properties

Price: 10 credits

Get full QuintoAndar property details by numeric ID (or property URL): address and coordinates, listing status, rent and sale price, condominium fee, IPTU, total cost, tenant service fee, area, bedrooms, bathrooms, suites, parking, floor range, construction year, availability, visit status, condo type, published date, accepts pets, furnished, near subway, description, amenities, building installations, accessibility features, nearby places, photos and video.

How to use it

Fetch a single QuintoAndar property by numeric ID (e.g. 895519971) or a property URL (https://www.quintoandar.com.br/imovel/{id}/...). Returns one item with address, city/state/zip, latitude/longitude, rent_value, sale_price, condominium, iptu, total_cost, tenant_service_fee, area, bedroom_count, bathroom_count, suite_count, parking_count, construction_year, availability, visit_status, condo_type, published_at, accepts_pets, is_furnished, is_near_subway, description, amenities, installations, accessibility, places_nearby, photos 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", "https://www.quintoandar.com.br/imovel/895519971/alugar"; minLength: 1)

Response

• @type string (default: "QuintoandarProperty")
• id string required
• url string required
• display_id string nullable
• business_context array (default: [])
• house_type string nullable
• status string nullable
• street string nullable
• neighbourhood string nullable
• city string nullable
• state string nullable
• zip_code string nullable
• latitude number nullable
• longitude number nullable
• region_name string nullable
• rent_value number nullable
• sale_price number nullable
• condominium number nullable
• iptu number nullable
• total_cost number nullable
• area number nullable
• bedroom_count integer nullable
• bathroom_count integer nullable
• suite_count integer nullable
• parking_count integer nullable
• floor_min integer nullable
• floor_max integer nullable
• construction_year integer nullable
• availability string nullable
• visit_status string nullable
• condo_type string nullable
• published_at string nullable
• tenant_service_fee number nullable
• accepts_pets boolean nullable
• is_furnished boolean nullable
• is_near_subway boolean nullable
• for_rent boolean nullable
• for_sale boolean nullable
• yield_rate number nullable
• description string nullable
• amenities array (default: [])
• installations array (default: [])
• accessibility array (default: [])
• special_conditions array (default: [])
• listing_tags array (default: [])
• places_nearby array (default: [])
  • @type string (default: "QuintoandarPlaceNearby")
  • name string required
  • type string nullable
  • alias string nullable
• photos array (default: [])
  • @type string (default: "QuintoandarPhoto")
  • url string required
  • caption string nullable
  • is_cover boolean nullable
• video_url string nullable
• 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.