/zapimoveis/properties/search

POST /api/zapimoveis/properties/search

Price: 10 credits

Search ZAP Imóveis real-estate listings across Brazil by free-text location (city, neighborhood or street) with sale, rental or new-development context and a full set of filters (property type, price range, usable area range, bedrooms, bathrooms, parking, construction stage, amenities, listing code, sort). Returns listings with title, description, address and coordinates, price, condo fee, IPTU, areas, bedrooms, bathrooms, suites, parking, amenities, advertiser, images and image count.

How to use it

Search ZAP Imóveis listings by location text (location='São Paulo' or a neighborhood like 'Moema', business_type=SALE/RENTAL/DEVELOPMENT). Optional filters: property_types, min_price/max_price, min_area/max_area, bedrooms_min, bathrooms_min, parking_min, listing_stage, amenities, listing_code, sort. Each item has id, url, title, description, address, neighborhood, city, latitude/longitude, price, condo_fee, iptu, usable_area, bedroom_count, bathroom_count, suite_count, parking_count, amenities, image, images and seller.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• location string required — Free-text location (city, neighborhood or street), e.g. 'São Paulo' or 'Moema' (examples: "São Paulo", "Moema", "Rio de Janeiro"; minLength: 1)
• business_type string — Sale, rental or new development listings (default: "SALE"; one of: "SALE", "RENTAL", "DEVELOPMENT")
• property_types array nullable — Restrict to these property types (multiple allowed) (one of: "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 nullable — Minimum price (BRL; per month for rentals) (min: 0)
• max_price integer nullable — Maximum price (BRL; per month for rentals) (min: 0)
• min_area integer nullable — Minimum usable area (m²) (min: 0)
• max_area integer nullable — Maximum usable area (m²) (min: 0)
• bedrooms_min integer nullable — Minimum number of bedrooms (min: 1; max: 4)
• bathrooms_min integer nullable — Minimum number of bathrooms (min: 1; max: 4)
• parking_min integer nullable — Minimum number of parking spaces (min: 1; max: 4)
• listing_stage array nullable — Construction stage filter for new developments (multiple allowed) (one of: "PLAN_ONLY", "UNDER_CONSTRUCTION", "BUILT")
• amenities array nullable — Required property and building features (multiple allowed) (one of: "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 nullable — Filter by an exact advertiser listing code (minLength: 1)
• sort string — Result ordering (default: "relevance"; one of: "relevance", "price_asc", "price_desc", "area_desc", "area_asc", "newest")
• count integer required — Max number of results to return (min: 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 — No matching location found for the given text 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.