Skip to main content
POST
/
api
/
zapimoveis
/
properties
/
search
/zapimoveis/properties/search
curl --request POST \
  --url https://api.anysite.io/api/zapimoveis/properties/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "location": "<string>",
  "count": 2,
  "timeout": 300,
  "business_type": "SALE",
  "property_types": [],
  "min_price": 1,
  "max_price": 1,
  "min_area": 1,
  "max_area": 1,
  "bedrooms_min": 2,
  "bathrooms_min": 2,
  "parking_min": 2,
  "listing_stage": [],
  "amenities": [],
  "listing_code": "<string>",
  "sort": "relevance"
}
'
[
  {
    "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
location
string
required

Free-text location (city, neighborhood or street), e.g. 'São Paulo' or 'Moema'

Minimum string length: 1
Examples:

"São Paulo"

"Moema"

"Rio de Janeiro"

count
integer
required

Max number of results to return

Required range: x >= 1
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
business_type
enum<string>
default:SALE

Sale, rental or new development listings

Available options:
SALE,
RENTAL,
DEVELOPMENT
property_types
enum<string>[] | null

Restrict to these property types (multiple allowed)

Available options:
APARTMENT,
STUDIO,
KITNET,
LOFT,
PENTHOUSE,
FLAT,
HOME,
TWO_STORY_HOUSE,
VILLAGE_HOUSE,
CONDO_HOUSE,
ALLOTMENT_LAND,
CONDOMINIUM,
FARM,
SHED_DEPOSIT_WAREHOUSE,
BUSINESS,
OFFICE,
CORPORATE_FLOOR,
BUILDING,
HOTEL_FLAT,
GARAGE
min_price
integer | null

Minimum price (BRL; per month for rentals)

Required range: x >= 0
max_price
integer | null

Maximum price (BRL; per month for rentals)

Required range: x >= 0
min_area
integer | null

Minimum usable area (m²)

Required range: x >= 0
max_area
integer | null

Maximum usable area (m²)

Required range: x >= 0
bedrooms_min
integer | null

Minimum number of bedrooms

Required range: 1 <= x <= 4
bathrooms_min
integer | null

Minimum number of bathrooms

Required range: 1 <= x <= 4
parking_min
integer | null

Minimum number of parking spaces

Required range: 1 <= x <= 4
listing_stage
enum<string>[] | null

Construction stage filter for new developments (multiple allowed)

Available options:
PLAN_ONLY,
UNDER_CONSTRUCTION,
BUILT
amenities
enum<string>[] | null

Required property and building features (multiple allowed)

Available options:
PETS_ALLOWED,
HEATING,
AIR_CONDITIONING,
SERVICE_AREA,
BUILTIN_WARDROBE,
KITCHEN_CABINETS,
CLOSET,
INTERNET_ACCESS,
AMERICAN_KITCHEN,
DEPOSIT,
HOME_OFFICE,
INTERCOM,
FURNISHED,
CABLE_TV,
BALCONY,
GOURMET_BALCONY,
LAVABO,
PANTRY,
PORCELAIN,
WOOD_FLOOR,
COLD_FLOOR,
EXTERIOR_VIEW,
SERVICE_BATHROOM,
DINNER_ROOM,
COPA,
ENTRANCE_HALL,
BARBECUE_BALCONY,
WALL_BALCONY,
GYM,
FITNESS_ROOM,
BARBECUE_GRILL,
CINEMA,
GOURMET_SPACE,
GREEN_SPACE,
GARDEN,
POOL,
ADULT_POOL,
CHILDRENS_POOL,
HEATED_POOL,
PLAYGROUND,
TOYS_PLACE,
TENNIS_COURT,
SPORTS_COURT,
INDOOR_SOCCER,
PARTY_HALL,
ADULT_GAME_ROOM,
GAMES_ROOM,
RECREATION_AREA,
PET_SPACE,
DISABLED_ACCESS,
BICYCLES_PLACE,
COWORKING,
KITCHEN,
ELEVATOR,
GARAGE,
ELECTRIC_GENERATOR,
LAUNDRY,
RECEPTION,
SAUNA,
SPA,
SAFETY_CIRCUIT,
GATED_COMMUNITY,
ELECTRONIC_GATE,
CONCIERGE_24H,
ALARM_SYSTEM,
WATCHMAN,
CARETAKER,
PATROL,
ARMORED_SECURITY_CABIN,
NEAR_PUBLIC_TRANSPORT,
NEAR_SCHOOL,
NEAR_HOSPITAL,
NEAR_SHOPPING_CENTER,
NEAR_ACCESS_ROADS,
ESSENTIAL_PUBLIC_SERVICES
listing_code
string | null

Filter by an exact advertiser listing code

Minimum string length: 1
sort
enum<string>
default:relevance

Result ordering

Available options:
relevance,
price_asc,
price_desc,
area_desc,
area_asc,
newest

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