Skip to main content
POST
/zapimoveis/properties/search

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
location
string
required
Minimum string length: 1
count
integer
required
Required range: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
business_type
enum<string>
default:SALE
Available options:
SALE,
RENTAL,
DEVELOPMENT
property_types
enum<string>[] | null
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
Required range: x >= 0
max_price
integer | null
Required range: x >= 0
min_area
integer | null
Required range: x >= 0
max_area
integer | null
Required range: x >= 0
bedrooms_min
integer | null
Required range: 1 <= x <= 4
bathrooms_min
integer | null
Required range: 1 <= x <= 4
parking_min
integer | null
Required range: 1 <= x <= 4
listing_stage
enum<string>[] | null
Available options:
PLAN_ONLY,
UNDER_CONSTRUCTION,
BUILT
amenities
enum<string>[] | null
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
Minimum string length: 1
sort
enum<string>
default:relevance
Available options:
relevance,
price_asc,
price_desc,
area_desc,
area_asc,
newest

Response

Successful Response

id
string
required
url
string
required
@type
string
default:ZapimoveisProperty
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
object | null