# VivaReal & ZAP Imóveis Scraper - Brazil Real Estate (`scrapesage/vivareal-zap-imoveis-scraper`) Actor Scrape VivaReal & ZAP Imóveis — Brazil's top real estate portals. Apartments & houses for sale or rent with prices, condo fees, IPTU, area, photos, geo, amenities & broker leads (phone, WhatsApp, website, CRECI). Filter by city, price, bedrooms. Monitor new listings & price drops. Export JSON, CSV. - **URL**: https://apify.com/scrapesage/vivareal-zap-imoveis-scraper.md - **Developed by:** [Scrape Sage](https://apify.com/scrapesage) (community) - **Categories:** Real estate, Lead generation, Automation - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $4.00 / 1,000 property scrapeds This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## VivaReal & ZAP Imóveis Scraper — Brazil Real Estate Listings + Broker Leads Extract **complete Brazilian real estate data** from **VivaReal** and **ZAP Imóveis** — Brazil's #1 and #2 property portals. Get apartments and houses **for sale and for rent** with **real prices, condo fees (condomínio), IPTU, price per m², usable & total area, bedrooms, bathrooms, suites, parking, floor, amenities, full address with GPS coordinates, every photo, and the advertising agency's direct contact** — name, phone, mobile, WhatsApp, website and CRECI license. No login, no API key, no browser — fast keyless JSON extraction with 99%+ reliability. ### Why this VivaReal / ZAP scraper? Both portals run on the same listing database, so this one actor covers **both** — and ships the **richest dataset in the category**. Most VivaReal/ZAP scrapers just dump listing cards and stop. This actor adds the full property detail, translated amenities, computed costs, and — uniquely — turns every listing into a **ready-to-contact broker lead**. | Data | Typical scrapers | This actor | |---|---|---| | Price, condo fee, IPTU, price per m² | partial | ✅ all four | | Usable + total area, beds, baths, suites, parking, floor | partial | ✅ | | Full description + translated amenities | ❌ | ✅ | | Full address + GPS latitude/longitude | partial | ✅ | | All listing photos + video tour | partial | ✅ | | Agency name, **phone, mobile, WhatsApp** | ❌ | ✅ | | Agency website + **CRECI license** | ❌ | ✅ | | Deduplicated **agency lead** records + lead score | ❌ | ✅ | | New-listing & price-drop monitoring | ❌ | ✅ | | Both VivaReal **and** ZAP Imóveis | one or the other | ✅ | ### Use cases - **Lead generation** — every listing exposes the listing agency/broker with a direct phone, mobile, WhatsApp, website and CRECI license. Get deduplicated `agencyLead` records scored 0–100 and feed them straight into your CRM. - **Real estate market & pricing intelligence** — track asking prices, price per m², condo fees and inventory by city or neighborhood (São Paulo, Rio de Janeiro, Belo Horizonte, Curitiba, Porto Alegre, Brasília, and thousands more). - **Property aggregation & portals** — power your own search site, app or newsletter with structured, photo-rich listings. - **Price-drop & new-listing alerts** — turn on monitor mode and schedule recurring runs to capture only newly listed properties and price changes. - **Investment sourcing** — filter by price, area, bedrooms and amenities to find deals, then compute yields from rent + condo fee + IPTU. ### How to use 1. [Sign up for Apify](https://console.apify.com/sign-up) — the free plan is enough to try this actor. 2. Open the **VivaReal & ZAP Imóveis Scraper**, choose a portal, type one or more locations (e.g. `São Paulo, SP`, `Pinheiros`), set your filters, and click **Start**. 3. Watch results stream into the dataset table. 4. **Export** as JSON, CSV, Excel, XML, or RSS — or pull results programmatically via the [Apify API](https://docs.apify.com/api/v2). ### Input ```json { "portal": "vivareal", "locationQueries": ["Pinheiros, São Paulo", "Rio de Janeiro"], "businessType": "SALE", "propertyStatus": "USED", "unitTypes": ["APARTMENT"], "priceMin": 400000, "priceMax": 1200000, "minBedrooms": 2, "sort": "newest", "maxResults": 200, "includeAgencyLeads": true, "monitorMode": false } ```` - **portal** — `vivareal` or `zap` (ZAP Imóveis). Both share the same database. - **locationQueries** — free-text cities or neighborhoods; each is auto-resolved to the right portal location. - **businessType** — `SALE` or `RENTAL`. - **propertyStatus** — `USED` (resale) or `DEVELOPMENT` (new builds / lançamentos). - **unitTypes** — optional: `APARTMENT`, `HOME`, `CONDOMINIUM`, `PENTHOUSE`, `FLAT`, `KITNET`, `FARM`, `OFFICE`, `COMMERCIAL_PROPERTY`, `BUSINESS`, `ALLOTMENT_LAND`, `BUILDING`. - **priceMin / priceMax / minBedrooms / minBathrooms / minParkingSpaces / minArea / maxArea / amenities** — optional filters. - **searchUrls** — optional: paste VivaReal/ZAP search-page URLs or raw glue-api URLs. - **sort** — `relevance`, `price-asc`, `price-desc`, `newest`, `area-desc`. - **includeAgencyLeads** *(default true)* — also output one deduplicated lead record per agency/broker. - **monitorMode** *(default false)* + **monitorKey** — only flag new listings and price changes across runs. ### Output One record per property (`type: "property"`), plus optional agency lead records (`type: "agencyLead"`): ```json { "type": "property", "portal": "VivaReal", "listingId": "2893872029", "url": "https://www.vivareal.com.br/imovel/apartamento-2-quartos-pinheiros-sao-paulo-sp-id-2893872029/", "title": "Apartamento para venda em Pinheiros com 2 quartos, sendo 1 suíte, 57m²", "description": "Apartamento à venda em Pinheiros, Rua Cardeal Arcoverde…", "businessType": "SALE", "businessLabel": "For sale", "listingType": "USED", "propertyType": "APARTMENT", "propertyTypeLabel": "Apartment", "currency": "BRL", "price": 990000, "monthlyCondoFee": 1000, "iptu": 320, "iptuPeriod": "YEARLY", "pricePerSquareMeter": 17368, "usableAreas": 57, "bedrooms": 2, "bathrooms": 2, "suites": 1, "parkingSpaces": 1, "amenities": ["Barbecue grill", "Pets allowed", "Balcony", "24h concierge", "Party hall"], "neighborhood": "Pinheiros", "city": "São Paulo", "stateAbbr": "SP", "zipCode": "05408000", "latitude": -23.560297, "longitude": -46.686072, "images": ["https://resizedimgs.vivareal.com/img/vr-listing/…/img.jpg?action=PRODUCT&dimension=870x653"], "imageCount": 30, "listedAt": "2026-06-10T12:00:00Z", "agencyId": "a92ccbad-…", "agencyName": "City Tower Imóveis", "agencyPhone": "(11) 3071-0000", "agencyMobile": "(11) 98441-3073", "agencyWhatsapp": "11984413073", "agencyWebsite": "http://www.citytowerimoveis.com.br", "agencyLicense": "CRECI 12345-J", "searchLocation": "Pinheiros, São Paulo", "scrapedAt": "2026-06-19T12:00:00.000Z" } ``` And the optional lead record: ```json { "type": "agencyLead", "agencyName": "City Tower Imóveis", "agencyPhone": "(11) 3071-0000", "agencyMobile": "(11) 98441-3073", "agencyWhatsapp": "11984413073", "agencyWebsite": "http://www.citytowerimoveis.com.br", "agencyLicense": "CRECI 12345-J", "cities": ["São Paulo"], "neighborhoods": ["Pinheiros", "Vila Madalena"], "propertyTypes": ["Apartment"], "minPrice": 480000, "maxPrice": 2900000, "activeListingCount": 14, "leadScore": 86 } ``` ### Automate & schedule Run this actor on autopilot and pull results into your own stack: - **[Apify API](https://docs.apify.com/api/v2)** — start runs, fetch datasets, and manage schedules over REST. - **[apify-client for JavaScript](https://docs.apify.com/api/client/js/)** and **[apify-client for Python](https://docs.apify.com/api/client/python/)** — official SDKs. - **[Schedules](https://docs.apify.com/platform/schedules)** — run it daily/weekly to monitor a city or neighborhood for new listings and price drops; perfect for alerts and lead pipelines. - **[Webhooks](https://docs.apify.com/platform/integrations/webhooks)** — trigger downstream actions (CRM import, Slack alert, email sequence) the moment a run finishes. ```js import { ApifyClient } from 'apify-client'; const client = new ApifyClient({ token: 'MY_APIFY_TOKEN' }); const run = await client.actor('scrapesage/vivareal-zap-imoveis-scraper').call({ portal: 'vivareal', locationQueries: ['São Paulo, SP'], businessType: 'SALE', minBedrooms: 2, maxResults: 500, includeAgencyLeads: true, }); const { items } = await client.dataset(run.defaultDatasetId).listItems(); console.log(`Got ${items.length} properties & agency leads`); ``` ### Integrate with any app Connect the dataset to 5,000+ apps — no code required: - **[Make](https://docs.apify.com/platform/integrations/make)** — multi-step automation scenarios. - **[Zapier](https://docs.apify.com/platform/integrations/zapier)** — push new broker leads straight into your CRM. - **[Slack](https://docs.apify.com/platform/integrations/slack)** — get notified when a monitored search finds new listings. - **[Google Drive / Sheets](https://docs.apify.com/platform/integrations/drive)** — auto-export every run to a spreadsheet. - **[Airbyte](https://docs.apify.com/platform/integrations/airbyte)** — pipe results into your data warehouse. - **[GitHub](https://docs.apify.com/platform/integrations/github)** — trigger runs from commits or releases. ### Use with AI assistants (MCP) The output is clean, LLM-ready JSON. Call this actor from Claude, ChatGPT, or any agent framework through the **[Apify MCP server](https://docs.apify.com/platform/integrations/mcp)** — ask your assistant to "find 2-bedroom apartments for sale in Pinheiros under R$1M and list the listing agencies" and let it run this scraper for you. ### More scrapers from scrapesage Build a complete real estate & lead-gen stack: - **[OLX Brazil Scraper](https://apify.com/scrapesage/olx-brazil-scraper)** — Brazil's #1 classifieds: cars, real estate, jobs and for-sale items. - **[Redfin Scraper](https://apify.com/scrapesage/redfin-scraper)** — US real estate listings, prices and agents. - **[Rightmove Scraper](https://apify.com/scrapesage/rightmove-scraper)** — UK property listings and agents. - **[Realtor.ca Scraper](https://apify.com/scrapesage/realtor-ca-scraper)** — Canadian real estate listings and agents. - **[Immoweb Scraper](https://apify.com/scrapesage/immoweb-scraper)** — Belgium's #1 real estate portal + agency leads. - **[Property Finder Scraper](https://apify.com/scrapesage/property-finder-scraper)** — UAE/Dubai real estate listings and agent contacts. - **[Rent.com Scraper](https://apify.com/scrapesage/rent-com-scraper)** — US rental listings and property-management leads. - **[Website Contact Scraper](https://apify.com/scrapesage/website-contact-scraper)** — enrich any agency website with emails, phones and socials. ### Tips - **Go deeper than 10k results**: the listing API caps pagination at ~10,000 per search. To exhaust a big city, split runs by neighborhood, price band, or property type. - **Both portals**: VivaReal and ZAP share one database — pick the `portal` whose ranking you prefer; you don't need to run both. - **Rentals**: for `RENTAL`, `price` is the monthly rent and `totalMonthlyCost` adds the condo fee and monthly IPTU. - **Proxies**: keep the default residential **Brazil** proxy — the API blocks datacenter IPs. - **Lead quality**: sort `agencyLead` records by `leadScore` (0–100) — it rewards direct phone/mobile/WhatsApp, a website, a CRECI license and listing volume. ### FAQ **How do I scrape VivaReal or ZAP for a specific city?** Put the city or neighborhood in `locationQueries` (e.g. `São Paulo, SP` or `Copacabana`). The actor resolves it to the correct portal location automatically. You can also paste a search-page URL into `searchUrls`. **Does it work without the VivaReal/ZAP API?** Yes — there is no public API. This actor reads the same keyless JSON backend the websites use, no key or login needed. **Where do the broker phone numbers come from?** They are published by the listing agency on the listing itself (phone, mobile, WhatsApp, website and CRECI license) — the same contact a visitor sees. The actor formats and deduplicates them. **Can I export to Google Sheets, CSV, or Excel?** Yes — one click in the dataset view, or automatically on every run via the [Google Drive integration](https://docs.apify.com/platform/integrations/drive). **How do I monitor new listings or price drops automatically?** Turn on `monitorMode`, give it a `monitorKey`, and create a [Schedule](https://docs.apify.com/platform/schedules). Each run flags `isNewListing` and `priceChangedSinceLastRun` (with `previousPrice`), and you can add a [webhook](https://docs.apify.com/platform/integrations/webhooks) to push them to Slack or your CRM. **Is scraping VivaReal / ZAP legal?** This actor collects publicly available data only. You are responsible for using the data in compliance with applicable laws (LGPD for personal data) and each portal's terms. **A field is null — why?** Some listings genuinely don't publish a condo fee, IPTU, exact address (privacy), or agency website. Fields are `null` only when the data doesn't exist, not because the scraper skipped them. ### Need help? Open an issue on the actor's **Issues** tab, or visit the [Apify help center](https://help.apify.com/). Feature requests are welcome — this actor is actively maintained. # Actor input Schema ## `portal` (type: `string`): Which Brazilian portal to scrape. Both share the same listing database; pick the one whose ranking and inventory you want. ## `locationQueries` (type: `array`): Free-text Brazilian locations — a city (São Paulo, SP, Rio de Janeiro) or a neighborhood (Pinheiros, Copacabana). Each is resolved automatically to the right portal location and searched with the filters below. ## `businessType` (type: `string`): Transaction type to search. ## `propertyStatus` (type: `string`): Resale/used properties or new developments (lançamentos). ## `unitTypes` (type: `array`): Optional property types (codes): APARTMENT, HOME, CONDOMINIUM, PENTHOUSE, FLAT, KITNET, FARM, OFFICE, COMMERCIAL\_PROPERTY, BUSINESS, ALLOTMENT\_LAND, BUILDING. Leave empty for all. ## `searchUrls` (type: `array`): Paste VivaReal or ZAP Imóveis search-page URLs (e.g. https://www.vivareal.com.br/venda/sp/sao-paulo/apartamento\_residencial/) or raw glue-api URLs. Used in addition to the locations above. ## `priceMin` (type: `integer`): Minimum price. For rentals this is the monthly rent. ## `priceMax` (type: `integer`): Maximum price. For rentals this is the monthly rent. ## `minBedrooms` (type: `integer`): Minimum number of bedrooms. ## `minBathrooms` (type: `integer`): Minimum number of bathrooms. ## `minParkingSpaces` (type: `integer`): Minimum number of parking spaces. ## `minArea` (type: `integer`): Minimum usable area in square meters. ## `maxArea` (type: `integer`): Maximum usable area in square meters. ## `amenities` (type: `array`): Optional amenity codes the property must have: POOL, GYM, BARBECUE\_GRILL, PLAYGROUND, PARTY\_HALL, ELEVATOR, BALCONY, FURNISHED, AIR\_CONDITIONING, GATED\_COMMUNITY, PETS\_ALLOWED. ## `sort` (type: `string`): Result ordering. ## `maxResults` (type: `integer`): Maximum number of property records to scrape across all locations. ## `includeAgencyLeads` (type: `boolean`): In addition to property records, output one deduplicated lead record per real-estate agency / broker (type = "agencyLead") with name, phone, mobile, WhatsApp, website, CRECI license, address, active-listing count and a 0–100 lead score. ## `maxAgencyLeads` (type: `integer`): Maximum number of deduplicated agency lead records to output. ## `monitorMode` (type: `boolean`): Remember listings seen on previous runs (in a named key-value store) and flag new listings (isNewListing) and price changes (priceChangedSinceLastRun, previousPrice). Combine with Apify Schedules to build a fresh-listing / price-drop feed. ## `monitorKey` (type: `string`): Name for this monitor's saved state. Use a different key per saved search so their histories don't mix. ## `proxyConfiguration` (type: `object`): Proxies to use. Residential Brazil proxies are required — the listing API blocks datacenter IPs. ## Actor input object example ```json { "portal": "vivareal", "locationQueries": [ "São Paulo, SP" ], "businessType": "SALE", "propertyStatus": "USED", "sort": "relevance", "maxResults": 100, "includeAgencyLeads": true, "maxAgencyLeads": 200, "monitorMode": false, "monitorKey": "default", "proxyConfiguration": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "BR" } } ``` # Actor output Schema ## `results` (type: `string`): All scraped property records and optional agency lead records as JSON items in the default dataset. # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "locationQueries": [ "São Paulo, SP" ], "proxyConfiguration": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "BR" } }; // Run the Actor and wait for it to finish const run = await client.actor("scrapesage/vivareal-zap-imoveis-scraper").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "locationQueries": ["São Paulo, SP"], "proxyConfiguration": { "useApifyProxy": True, "apifyProxyGroups": ["RESIDENTIAL"], "apifyProxyCountry": "BR", }, } # Run the Actor and wait for it to finish run = client.actor("scrapesage/vivareal-zap-imoveis-scraper").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "locationQueries": [ "São Paulo, SP" ], "proxyConfiguration": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "BR" } }' | apify call scrapesage/vivareal-zap-imoveis-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=scrapesage/vivareal-zap-imoveis-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "VivaReal & ZAP Imóveis Scraper - Brazil Real Estate", "description": "Scrape VivaReal & ZAP Imóveis — Brazil's top real estate portals. Apartments & houses for sale or rent with prices, condo fees, IPTU, area, photos, geo, amenities & broker leads (phone, WhatsApp, website, CRECI). Filter by city, price, bedrooms. Monitor new listings & price drops. Export JSON, CSV.", "version": "0.1", "x-build-id": "a2qHpYUtD1ePgDlkt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapesage~vivareal-zap-imoveis-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapesage-vivareal-zap-imoveis-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/scrapesage~vivareal-zap-imoveis-scraper/runs": { "post": { "operationId": "runs-sync-scrapesage-vivareal-zap-imoveis-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/scrapesage~vivareal-zap-imoveis-scraper/run-sync": { "post": { "operationId": "run-sync-scrapesage-vivareal-zap-imoveis-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "portal": { "title": "Portal", "enum": [ "vivareal", "zap" ], "type": "string", "description": "Which Brazilian portal to scrape. Both share the same listing database; pick the one whose ranking and inventory you want.", "default": "vivareal" }, "locationQueries": { "title": "Locations (city or neighborhood)", "type": "array", "description": "Free-text Brazilian locations — a city (São Paulo, SP, Rio de Janeiro) or a neighborhood (Pinheiros, Copacabana). Each is resolved automatically to the right portal location and searched with the filters below.", "items": { "type": "string" } }, "businessType": { "title": "For sale or for rent", "enum": [ "SALE", "RENTAL" ], "type": "string", "description": "Transaction type to search.", "default": "SALE" }, "propertyStatus": { "title": "Listing type", "enum": [ "USED", "DEVELOPMENT" ], "type": "string", "description": "Resale/used properties or new developments (lançamentos).", "default": "USED" }, "unitTypes": { "title": "Property types", "type": "array", "description": "Optional property types (codes): APARTMENT, HOME, CONDOMINIUM, PENTHOUSE, FLAT, KITNET, FARM, OFFICE, COMMERCIAL_PROPERTY, BUSINESS, ALLOTMENT_LAND, BUILDING. Leave empty for all.", "items": { "type": "string" } }, "searchUrls": { "title": "Start URLs (optional)", "type": "array", "description": "Paste VivaReal or ZAP Imóveis search-page URLs (e.g. https://www.vivareal.com.br/venda/sp/sao-paulo/apartamento_residencial/) or raw glue-api URLs. Used in addition to the locations above.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "priceMin": { "title": "Min price (BRL)", "minimum": 0, "type": "integer", "description": "Minimum price. For rentals this is the monthly rent." }, "priceMax": { "title": "Max price (BRL)", "minimum": 0, "type": "integer", "description": "Maximum price. For rentals this is the monthly rent." }, "minBedrooms": { "title": "Min bedrooms", "minimum": 1, "maximum": 5, "type": "integer", "description": "Minimum number of bedrooms." }, "minBathrooms": { "title": "Min bathrooms", "minimum": 1, "maximum": 5, "type": "integer", "description": "Minimum number of bathrooms." }, "minParkingSpaces": { "title": "Min parking spaces", "minimum": 1, "maximum": 5, "type": "integer", "description": "Minimum number of parking spaces." }, "minArea": { "title": "Min usable area (m²)", "minimum": 0, "type": "integer", "description": "Minimum usable area in square meters." }, "maxArea": { "title": "Max usable area (m²)", "minimum": 0, "type": "integer", "description": "Maximum usable area in square meters." }, "amenities": { "title": "Amenities", "type": "array", "description": "Optional amenity codes the property must have: POOL, GYM, BARBECUE_GRILL, PLAYGROUND, PARTY_HALL, ELEVATOR, BALCONY, FURNISHED, AIR_CONDITIONING, GATED_COMMUNITY, PETS_ALLOWED.", "items": { "type": "string" } }, "sort": { "title": "Sort order", "enum": [ "relevance", "price-asc", "price-desc", "newest", "area-desc" ], "type": "string", "description": "Result ordering.", "default": "relevance" }, "maxResults": { "title": "Max properties", "minimum": 1, "type": "integer", "description": "Maximum number of property records to scrape across all locations.", "default": 100 }, "includeAgencyLeads": { "title": "Emit agency / broker lead records", "type": "boolean", "description": "In addition to property records, output one deduplicated lead record per real-estate agency / broker (type = \"agencyLead\") with name, phone, mobile, WhatsApp, website, CRECI license, address, active-listing count and a 0–100 lead score.", "default": true }, "maxAgencyLeads": { "title": "Max agency leads", "minimum": 1, "type": "integer", "description": "Maximum number of deduplicated agency lead records to output.", "default": 200 }, "monitorMode": { "title": "Monitor mode (only new + changed)", "type": "boolean", "description": "Remember listings seen on previous runs (in a named key-value store) and flag new listings (isNewListing) and price changes (priceChangedSinceLastRun, previousPrice). Combine with Apify Schedules to build a fresh-listing / price-drop feed.", "default": false }, "monitorKey": { "title": "Monitor key", "type": "string", "description": "Name for this monitor's saved state. Use a different key per saved search so their histories don't mix.", "default": "default" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxies to use. Residential Brazil proxies are required — the listing API blocks datacenter IPs.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "BR" } } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```