Property Search
/api/vivareal/search
Search rent and sale listings on ZAP or VivaReal with price, area, room and location filters
Scrappa's read-only VivaReal and ZAP Imoveis API turns two of Brazil's largest property portals into structured JSON. Search rent (aluguel) and sale (venda) listings with price, condo fee, IPTU, area, bedrooms and location filters, read full listing records with images and advertiser identity, resolve places to location ids, and pull neighbourhood price insights and map pins. One portal parameter switches between ZAP and VivaReal.
Try it now
Use the first endpoint in this API family with a Scrappa API key. Every account includes 500 free monthly credits, so you can validate the response shape before buying credits.
curl -X GET "https://scrappa.co/api/vivareal/search?portal=ZAP&business=RENTAL&location_id=BR%3ESao%20Paulo%3ENULL%3ESao%20Paulo%3EZona%20Oeste%3EPinheiros&bedrooms=2&rows=5" \
-H "Accept: application/json" \
-H "X-API-KEY: YOUR_API_KEY"
{
"success": true,
"total": 4255,
"total_is_approximate": true,
"page": 1,
"rows": 5,
"returned": 1,
"total_pages": 851,
"window_limit": 1500,
"applied_filters": { "portal": "ZAP", "business": "RENTAL", "bedrooms": [2] },
"listings": [
{
"id": "2814207417",
"title": "Apartamento com 2 quartos em Pinheiros, Sao Paulo",
"prices": [{ "business": "RENTAL", "price": 12800, "condo_fee": 2060, "iptu": null, "rent_total": 14860 }],
"usable_area_m2": 85,
"bedrooms": 2,
"address": { "neighborhood": "Pinheiros", "city": "Sao Paulo", "state_code": "SP" }
}
],
"meta": { "billable": true, "endpoint_family": "search", "portal": "ZAP", "attempts": 1 }
}
Structured data for real applications. Here are some ideas.
Build Portuguese-language rent and sale search with filters for price, condo fee, IPTU, area, bedrooms, parking spaces and location.
Track asking rents and total monthly cost (rent plus condo fee plus IPTU) across neighbourhoods with stable price and area sorting.
Read advertiser identity, CRECI license number, tier and trust score, and page through the live stock of one advertiser.
Resolve place names to location ids, parse free text into filters and plot clustered listing pins on a map.
Use average price, average area and price per square metre for a neighbourhood, with price brackets and nearby locations.
VivaReal and ZAP Imoveis scraper API
The VivaReal and ZAP Imoveis API is built for proptech teams, analysts and agencies working with the Brazilian property market. Search aluguel and venda listings in reais by price, condo fee, IPTU, area, rooms and location, then read listing details, advertiser identity, neighbourhood price insights and map pins. Broker phone numbers are not returned.
Search rent (aluguel) or sale (venda) listings on ZAP Imoveis or VivaReal with one portal parameter.
Filter by price, condo fee, IPTU-inclusive rent total, area, bedrooms, bathrooms, parking spaces, unit types and amenities.
Resolve neighbourhoods and cities to location ids, or parse free text into filters.
Get full listing records with images, address, coordinates and advertiser identity.
Use neighbourhood price insights and clustered map pins.
Call 9 read-only endpoints that return structured JSON.
Resolve a place with location autocomplete, then pass its location id to the search endpoint with business set to RENTAL or SALE. Use BIGGEST_PRICE or BIGGEST_AREA for stable paging.
Open VivaReal Property Search API docsTake the advertiser id from a listing, read the advertiser profile and page through that advertiser's live listings.
Open VivaReal Advertiser API docsCombine price insights with map pins to show average prices, price brackets and listing clusters for a neighbourhood.
Open VivaReal Price Insights API docsEverything you need in one API.
/api/vivareal/search
Search rent and sale listings on ZAP or VivaReal with price, area, room and location filters
/api/vivareal/count
Approximate total and amenity facet counts for a filter set
/api/vivareal/listing
Full listing record with images, advertiser and development units
/api/vivareal/advertiser
Advertiser identity, CRECI, tier, trust score and live listing count
/api/vivareal/advertiser-listings
Live stock of one advertiser
/api/vivareal/location-autocomplete
Resolve place names to search location ids
/api/vivareal/parse-filters
Turn free text into location and unit type filters
/api/vivareal/price-insights
Average price, area and price per m2 for a location
/api/vivareal/map-pins
Clustered listing pins with coordinates and prices
See how Scrappa compares to the official API.
| Feature | Scrappa | Do-it-yourself property data extraction |
|---|---|---|
| Dedicated VivaReal and ZAP endpoints | yes (9 endpoints) | |
| Output format | Structured JSON | Raw page content |
| Both portals in one API | Two parsers | |
| Price, condo fee and IPTU fields | Included | Build your own parser |
| Request mode | Read-only | Depends on implementation |
| Parser maintenance | Handled by Scrappa | Your team |
It is Scrappa's read-only REST API for two Brazilian property portals that share one backend. It covers rent and sale search, listing details, advertisers, locations, price insights and map pins.
No. Scrappa is an independent service and is not affiliated with or endorsed by VivaReal, ZAP Imoveis or their owners. A Scrappa API key is used to access the endpoints on this page.
Set the portal parameter to ZAP (default) or VIVAREAL. Both portals use the same field names and filters.
Each query reaches at most 1500 rows, 30 per page. Narrow the filters with a location id, price or area to reach more listings. The total is approximate.
No. Phone and WhatsApp numbers are never returned. Advertiser identity such as name, logo, license number and tier is included.
No. All endpoints on this page are read-only.