Skip to main content
POST
/
api
/
zapimoveis
/
properties
/zapimoveis/properties
curl --request POST \
  --url https://api.anysite.io/api/zapimoveis/properties \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "property": "<string>",
  "timeout": 300
}
'
[
  {
    "id": "<string>",
    "url": "<string>",
    "@type": "@zapimoveis_property",
    "title": "<string>",
    "description": "<string>",
    "business_type": "<string>",
    "listing_type": "<string>",
    "property_type": "<string>",
    "unit_types": [],
    "unit_sub_types": [],
    "publication_type": "<string>",
    "construction_status": "<string>",
    "status": "<string>",
    "street": "<string>",
    "street_number": "<string>",
    "neighborhood": "<string>",
    "zone": "<string>",
    "city": "<string>",
    "state": "<string>",
    "state_acronym": "<string>",
    "zip_code": "<string>",
    "location_id": "<string>",
    "latitude": 123,
    "longitude": 123,
    "price": 123,
    "total_price": 123,
    "condo_fee": 123,
    "iptu": 123,
    "usable_area": 123,
    "total_area": 123,
    "usable_area_max": 123,
    "bedroom_count": 123,
    "suite_count": 123,
    "bathroom_count": 123,
    "parking_count": 123,
    "unit_floor": 123,
    "floor_count": 123,
    "accepts_exchange": true,
    "external_id": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "amenities": [],
    "image": "<string>",
    "images": [],
    "image_count": 123,
    "seller": {
      "@type": "@zapimoveis_seller",
      "id": "<string>",
      "name": "<string>",
      "image": "<string>",
      "license_number": "<string>",
      "legacy_zap_id": "<string>",
      "legacy_vivareal_id": "<string>",
      "phones": []
    }
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
property
string
required

ZAP Imóveis numeric listing ID or a listing URL containing it

Minimum string length: 1
Examples:

"2528260885"

"https://www.zapimoveis.com.br/imovel/apartamento-id-2528260885/"

timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

Response

Successful Response

id
string
required
url
string
required
@type
string
default:@zapimoveis_property
title
string | null
description
string | null
business_type
string | null
listing_type
string | null
property_type
string | null
unit_types
string[]
unit_sub_types
string[]
publication_type
string | null
construction_status
string | null
status
string | null
street
string | null
street_number
string | null
neighborhood
string | null
zone
string | null
city
string | null
state
string | null
state_acronym
string | null
zip_code
string | null
location_id
string | null
latitude
number | null
longitude
number | null
price
number | null
total_price
number | null
condo_fee
number | null
iptu
number | null
usable_area
number | null
total_area
number | null
usable_area_max
number | null
bedroom_count
integer | null
suite_count
integer | null
bathroom_count
integer | null
parking_count
integer | null
unit_floor
integer | null
floor_count
integer | null
accepts_exchange
boolean | null
external_id
string | null
created_at
string | null
updated_at
string | null
amenities
string[]
image
string | null
images
string[]
image_count
integer | null
seller
ZapimoveisSeller · object