/zapimoveis/properties

POST /api/zapimoveis/properties

Price: 1 credit

Get full ZAP Imóveis listing details by numeric ID (or listing URL): title, description, address and coordinates, business type, listing status, price, condo fee, IPTU, usable and total area, bedrooms, bathrooms, suites, parking, unit floor, amenities, advertiser (agency/broker) with contact phones, publication date, listing code and all images.

How to use it

Fetch a single ZAP Imóveis listing by numeric ID (e.g. 2528260885) or a listing URL (https://www.zapimoveis.com.br/imovel/...-id-{id}/). Returns one item with title, description, address, neighborhood, city, state, zip_code, latitude/longitude, price, condo_fee, iptu, usable_area, total_area, bedroom_count, bathroom_count, suite_count, parking_count, amenities, image, images, image_count and seller.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• property string required — ZAP Imóveis numeric listing ID or a listing URL containing it (examples: "2528260885", "https://www.zapimoveis.com.br/imovel/apartamento-id-2528260885/"; minLength: 1)

Response

• @type string (default: "ZapimoveisProperty")
• id string required
• url string required
• description string nullable
• business_type string nullable
• listing_type string nullable
• property_type string nullable
• unit_types array (default: [])
• unit_sub_types array (default: [])
• publication_type string nullable
• construction_status string nullable
• status string nullable
• street string nullable
• street_number string nullable
• neighborhood string nullable
• zone string nullable
• city string nullable
• state string nullable
• state_acronym string nullable
• zip_code string nullable
• location_id string nullable
• latitude number nullable
• longitude number nullable
• price number nullable
• total_price number nullable
• condo_fee number nullable
• iptu number nullable
• usable_area number nullable
• total_area number nullable
• usable_area_max number nullable
• bedroom_count integer nullable
• suite_count integer nullable
• bathroom_count integer nullable
• parking_count integer nullable
• unit_floor integer nullable
• floor_count integer nullable
• accepts_exchange boolean nullable
• external_id string nullable
• created_at string nullable
• updated_at string nullable
• amenities array (default: [])
• image string nullable
• images array (default: [])
• image_count integer nullable
• seller object nullable
  • @type string (default: "ZapimoveisSeller")
  • id string nullable
  • name string nullable
  • image string nullable
  • license_number string nullable
  • legacy_zap_id string nullable
  • legacy_vivareal_id string nullable
  • phones 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 — Listing 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.