# ZAP Imóveis Scraper (`haketa/zapimoveis-scraper`) Actor Scrape ZAP Imóveis, Brazil's premium real estate portal (QuintoAndar Group): property listings, commercial real estate (sala, galpão, conjunto), lançamentos and 200K+ imobiliária profiles. Get price, condomínio, IPTU, CRECI, agency, building class, sem fiador and FGTS data. - **URL**: https://apify.com/haketa/zapimoveis-scraper.md - **Developed by:** [Haketa](https://apify.com/haketa) (community) - **Categories:** Real estate, Developer tools, Automation - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing from $3.00 / 1,000 results This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have. 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 ## ZAP Imóveis Scraper Extract property listings and agency profiles from **[ZAP Imóveis](https://www.zapimoveis.com.br)** — Brazil's 25-year-old premium broker-centric real estate portal (QuintoAndar Group, ex-Globo Group). Covers residential, commercial real estate (sala/conjunto/galpão), lançamentos pipeline and the imobiliária directory. [![Apify Actor](https://img.shields.io/badge/Apify-Actor-blue)](https://apify.com) [![No Browser](https://img.shields.io/badge/Engine-Direct%20API-green)]() [![Portals](https://img.shields.io/badge/Portals-ZAP%20%2B%20VivaReal-orange)]() --- ### Why ZAP (and not just VivaReal)? ZAP and VivaReal share the same Glue API backend but serve **different personas**. VivaReal is mass-market and classifieds-leaning; ZAP is the premium, broker-trusted, **B2B/professional** brand. Same shop, different inventory tier: - ZAP listings skew **higher price-point**, longer broker-written descriptions - ZAP **agency directory** is a unique 200K+ imobiliária profile layer (B2B intelligence goldmine) - ZAP has a **deeper commercial vertical** (sala, conjunto comercial, galpão, andar corporativo) - ZAP carries **premium constructor pipelines** (Cyrela CYRE3, EZTec EZTC3, Tegra, Even EVEN3, Mitre MTRE3) - ZAP's **"sem fiador"** segment tracks the modern rental model competing with QuintoAndar/Loft This actor also supports VivaReal via the `portal` parameter — same code, switch one input. --- ### How It Works ZAP exposes a Glue API REST endpoint used by its own web UI. This actor calls it directly: ```` GET https://glue-api.zapimoveis.com.br/v2/listings ?portal=ZAP \&business=SALE \&listingType=USED \&usageTypes=RESIDENTIAL \&addressState=São Paulo\&addressCity=São Paulo \&size=24\&from=0 ``` For agencies (`mode: "agencies"`): ``` GET https://glue-api.zapimoveis.com.br/v2/account/{id}?portal=ZAP GET https://glue-api.zapimoveis.com.br/v2/account/{id}/listings?portal=ZAP ```` No browser, no headless Chrome. Pure HTTP with realistic headers. --- ### Cloudflare & Proxy ZAP sits behind Cloudflare. **Brazilian residential proxies are strongly recommended** — data-center IPs get challenged or blocked within a few requests. Default input prefills the Apify residential proxy with `BR` country: ```json "proxyConfiguration": { "useApifyProxy": true, "apifyProxyGroups": ["RESIDENTIAL"], "apifyProxyCountry": "BR" } ```` If you bring your own proxies, point `proxyUrls` at a BR residential pool. Without proxies you will likely see HTTP 403 / 503 errors after a handful of requests. *** ### Input ```json { "mode": "listings", "portal": "ZAP", "business": ["SALE"], "listingType": ["USED"], "usageTypes": ["RESIDENTIAL"], "unitTypes": ["APARTMENT"], "states": ["SP"], "cities": ["sao-paulo"], "neighborhoods": ["pinheiros"], "minPrice": 0, "maxPrice": 0, "minBedrooms": 2, "sortBy": "newest", "maxListings": 200, "pageSize": 24 } ``` #### Listings mode | Parameter | Type | Default | Description | |---|---|---|---| | `mode` | string | `listings` | `listings` or `agencies` | | `portal` | string | `ZAP` | `ZAP` or `VIVA_REAL` | | `business` | array | `["SALE"]` | `SALE`, `RENTAL` | | `listingType` | array | `["USED"]` | `USED`, `DEVELOPMENT` (lançamentos) | | `usageTypes` | array | `["RESIDENTIAL"]` | `RESIDENTIAL`, `COMMERCIAL` | | `unitTypes` | array | `[]` | `APARTMENT`, `HOME`, `OFFICE`, `WAREHOUSE_SHED`, etc. | | `states` | array | `["SP"]` | 2-letter UF codes | | `cities` | array | `["sao-paulo"]` | URL-slug format (lowercase, hyphenated) | | `neighborhoods` | array | `[]` | Bairro slugs | | `minPrice` / `maxPrice` | integer | 0 | BRL range filter | | `minArea` / `maxArea` | integer | 0 | m² range filter | | `minBedrooms` | integer | 0 | Minimum quartos | | `minParkingSpaces` | integer | 0 | Minimum vagas | | `semFiador` | boolean | `false` | Rentals without guarantor requirement | | `sortBy` | string | `relevance` | `newest`, `lowest_price`, `highest_price`, `lowest_area`, `highest_area` | #### Agencies mode | Parameter | Type | Default | Description | |---|---|---|---| | `agencyIds` | array | `[]` | Explicit imobiliária IDs to fetch | | `agencyIdRangeStart` | integer | 0 | Start of sequential ID range crawl | | `agencyIdRangeEnd` | integer | 0 | End of sequential range (max span 100K) | | `fetchAgencyListings` | boolean | `false` | Also fetch each agency's listings portfolio | #### Common controls | Parameter | Type | Default | Description | |---|---|---|---| | `maxListings` | integer | 200 | Total record cap (0 = unlimited) | | `maxPages` | integer | 20 | Pages per task (24 listings/page) | | `pageSize` | integer | 24 | Records per API call | | `requestDelay` | integer (ms) | 800 | Delay between requests | | `maxConcurrency` | integer | 1 | Parallel tasks (keep low) | | `maxRetries` | integer | 3 | Retries on 403/503/429 | | `proxyConfiguration` | object | BR residential | Proxy settings | *** ### Brazilian UF Codes | UF | State | UF | State | UF | State | |---|---|---|---|---|---| | `SP` | São Paulo | `RJ` | Rio de Janeiro | `MG` | Minas Gerais | | `RS` | Rio Grande do Sul | `PR` | Paraná | `SC` | Santa Catarina | | `BA` | Bahia | `DF` | Distrito Federal | `GO` | Goiás | | `PE` | Pernambuco | `CE` | Ceará | `ES` | Espírito Santo | | `PA` | Pará | `AM` | Amazonas | `MA` | Maranhão | | `MT` | Mato Grosso | `MS` | Mato Grosso do Sul | `AL` | Alagoas | *** ### City Slugs (Selection) ZAP uses URL-friendly lowercase hyphenated slugs (no accents): | Slug | City | Slug | City | |---|---|---|---| | `sao-paulo` | São Paulo | `rio-de-janeiro` | Rio de Janeiro | | `belo-horizonte` | Belo Horizonte | `brasilia` | Brasília | | `salvador` | Salvador | `fortaleza` | Fortaleza | | `curitiba` | Curitiba | `porto-alegre` | Porto Alegre | | `florianopolis` | Florianópolis | `recife` | Recife | | `niteroi` | Niterói | `campinas` | Campinas | | `santos` | Santos | `goiania` | Goiânia | | `vitoria` | Vitória | `cajamar` | Cajamar (logistics hub) | Unknown slugs fall back to title-case (`some-bairro` → `Some Bairro`). For accent-sensitive cities, prefer the curated map. *** ### Unit Types #### Residential `APARTMENT`, `HOME`, `CONDOMINIUM`, `PENTHOUSE`, `FLAT`, `KITNET` #### Commercial (ZAP's strong vertical) `OFFICE` (sala comercial), `COMMERCIAL_BUILDING` (prédio comercial), `COMMERCIAL_PROPERTY` (conjunto comercial), `BUSINESS` (ponto comercial), `WAREHOUSE_SHED` (galpão), `HOTEL` #### Other `FARM` (sítio/fazenda), `LAND_LOT` (terreno), `GARAGE` *** ### Output #### Listing record example ```json { "recordType": "listing", "listingId": "2853746", "portal": "ZAP", "url": "https://www.zapimoveis.com.br/imovel/apartamento-3-quartos-pinheiros-sao-paulo-sp-id-2853746/", "title": "Apartamento 3 quartos Pinheiros 95m²", "business": "SALE", "listingType": "USED", "usageType": "RESIDENTIAL", "unitType": "APARTMENT", "category": "residential", "subCategory": "apartamento", "priceBRL": 1250000, "condominioMonthlyBRL": 1800, "iptuYearlyBRL": 7800, "pricePerSqmBRL": 13157, "usableArea": 95, "bedrooms": 3, "bathrooms": 3, "suites": 1, "parkingSpaces": 2, "uf": "SP", "city": "São Paulo", "neighborhood": "Pinheiros", "zone": "Zona Oeste", "latitude": -23.5677, "longitude": -46.6856, "amenities": ["GYM", "POOL", "PARTY_HALL", "PLAYGROUND"], "isLancamento": false, "isFiadorFree": false, "isFGTSEligible": true, "agencyId": "122847", "agencyName": "Premium Real Estate", "agencyCRECI": "J-12345", "agencyTier": "premium", "publishedAt": "2026-04-15T10:00:00Z", "updatedAt": "2026-05-09T14:00:00Z", "imageCount": 24, "listingQualityScore": 95, "searchBusiness": "SALE", "searchState": "SP", "searchCity": "sao-paulo", "searchNeighborhood": "pinheiros", "scrapedAt": "2026-05-12T10:00:00Z" } ``` #### Agency record example ```json { "recordType": "agency", "listingId": "122847", "portal": "ZAP", "url": "https://www.zapimoveis.com.br/imobiliaria/122847/", "title": "Premium Real Estate", "agencyId": "122847", "agencyName": "Premium Real Estate", "agencyCRECI": "J-12345", "agencyCNPJ": "00.000.000/0001-00", "agencyPhone": "+5511999999999", "agencyAddress": "Rua dos Pinheiros, 100, Pinheiros, São Paulo, SP", "agencyTier": "premium", "agencyTotalListings": 234, "uf": "SP", "city": "São Paulo", "neighborhood": "Pinheiros", "scrapedAt": "2026-05-12T10:00:00Z" } ``` #### Notes - `agencyCNPJ` / `agencyEmail` / `agencyWebsite` may be `null` for listings (only present in agency profile responses) - `isLancamento`, `launchPhase`, `constructorName` only populated when `listingType=DEVELOPMENT` - `alsoOnVivaReal` / `vivaRealId` are reserved for a future cross-portal correlation actor - `latitude` / `longitude` may be `null` for hidden-address listings - `mobileNo` equivalent (`agencyPhone`) is publisher contact, not seller direct *** ### Use Cases - **Brazilian CRE intelligence** — CBRE/JLL/Cushman & Wakefield Brasil prime office vacancy, galpão demand - **Listed constructor equity research** — Cyrela/EZTec/Tegra/MRV/Tenda launch pipeline for buy/sell calls - **FII (REIT) fund manager input** — BCFF11, HGLG11, HGRE11 property selection & pricing - **B2B PropTech lead pipeline** — Agency directory crawl → CRM/training/SaaS targeting (Vista, Apolo, Tabela) - **QuintoAndar/Loft competitive analysis** — Track "sem fiador" inventory share - **Cross-portal arbitrage (with VivaReal)** — Detect same listing at different price tiers - **Brazilian Portuguese real estate NLP corpus** — Broker-written long descriptions, premium tier *** ### Cost & Performance - **~0.005 CU per 100 listings** (no browser, just HTTP) - **~1 record/sec** with 800ms delay + BR residential proxy (Cloudflare-safe) - **No CAPTCHA solving** needed in normal operation — if you hit one, increase `requestDelay` and verify proxy quality *** ### Limitations - **Agency phone unlock**: ZAP requires an authenticated employer session for some agency contact info. This actor only scrapes publicly visible search/profile data. - **Cloudflare**: occasional 403/503; the actor retries with backoff but persistent failures need better proxy quality. - **GraphQL? No.** Despite some external references, the public-facing search uses REST-style `v2/listings`. The endpoint is stable as of April 2026 but ZAP's frontend team can change parameter names — feedback welcome. - **Address granularity**: Brazilian addresses with hidden street/number show city + bairro only; this is a publisher choice, not a scraper limit. *** ### Changelog | Version | Date | Notes | |---|---|---| | 1.0.0 | 2026-05-13 | Initial release — Glue API direct integration, listings + agency modes, ZAP & VivaReal portal switch | # Actor input Schema ## `mode` (type: `string`): What to scrape. 'listings' = property search (residential, commercial, lançamentos). 'agencies' = imobiliária directory profiles (CRECI-J, CNPJ, portfolio stats). ## `portal` (type: `string`): ZAP and VivaReal share the same Glue API backend. Switch to scrape VivaReal via the same actor. Default: ZAP. ## `business` (type: `array`): Transaction type. SALE = venda. RENTAL = aluguel. Empty = both. ## `listingType` (type: `array`): USED = standard resale/rental inventory. DEVELOPMENT = lançamentos (new developer projects, Cyrela/EZTec/Tegra etc). ## `usageTypes` (type: `array`): RESIDENTIAL = apartamento/casa/cobertura etc. COMMERCIAL = sala comercial/galpão/conjunto comercial/loja (ZAP's strong vertical). ## `unitTypes` (type: `array`): Property type filter. Use ZAP's UnitType enum. Common: APARTMENT, HOME, CONDOMINIUM, PENTHOUSE, FLAT, KITNET, FARM, OFFICE, COMMERCIAL\_BUILDING, COMMERCIAL\_PROPERTY, BUSINESS, WAREHOUSE\_SHED, GARAGE, LAND\_LOT. ## `states` (type: `array`): Brazilian state codes (2-letter UF). Examples: SP, RJ, MG, RS, PR, SC, BA, DF, GO, PE, CE, ES. ## `cities` (type: `array`): City names in ZAP's URL slug format (lowercase, hyphenated, no accents). Examples: 'sao-paulo', 'rio-de-janeiro', 'belo-horizonte', 'porto-alegre', 'curitiba', 'florianopolis', 'salvador', 'brasilia', 'recife', 'fortaleza'. Leave empty for state-wide search. ## `neighborhoods` (type: `array`): Neighborhood slugs to filter. Examples: 'pinheiros', 'itaim-bibi', 'vila-olimpia', 'faria-lima', 'jardins', 'moema', 'copacabana', 'ipanema', 'leblon', 'barra-da-tijuca'. Requires single city. ## `minPrice` (type: `integer`): Minimum price in Brazilian Reais. 0 = no minimum. ## `maxPrice` (type: `integer`): Maximum price in Brazilian Reais. 0 = no maximum. ## `minArea` (type: `integer`): Minimum usable area in square meters. 0 = no minimum. ## `maxArea` (type: `integer`): Maximum usable area in square meters. 0 = no maximum. ## `minBedrooms` (type: `integer`): Minimum bedroom count. 0 = no filter. ## `minParkingSpaces` (type: `integer`): Minimum parking space count. 0 = no filter. ## `semFiador` (type: `boolean`): Filter rental listings that don't require a fiador (guarantor). ZAP's modern rental segment — competes with QuintoAndar/Loft model. ## `sortBy` (type: `string`): Result ordering. ## `agencyIds` (type: `array`): Explicit list of imobiliária IDs to crawl in 'agencies' mode. Examples: '231067' (Brasil Brokers Copacabana), '233859' (Brasil Brokers Ipanema), '122847' (VivaReal). Ignored in 'listings' mode. ## `agencyIdRangeStart` (type: `integer`): Start of sequential agency ID range to crawl (agencies mode). Useful for discovering new agencies. 0 = disabled. ## `agencyIdRangeEnd` (type: `integer`): End of sequential agency ID range. Must be > start. ZAP agency IDs range up to ~850000. 0 = disabled. ## `fetchAgencyListings` (type: `boolean`): In agencies mode, also fetch the agency's listings portfolio (slower). When false, only profile metadata is saved. ## `maxListings` (type: `integer`): Maximum total records to scrape across all tasks. Set 0 for unlimited. ## `maxPages` (type: `integer`): Maximum pages per task (each task = state/city/business combination). Each page returns up to 24 listings. ## `pageSize` (type: `integer`): Listings per API call. ZAP default is 24. Max recommended: 36. ## `proxyConfiguration` (type: `object`): Brazilian residential proxy STRONGLY recommended. ZAP is fronted by Cloudflare and DC IPs get blocked fast. Use Apify Proxy with RESIDENTIAL group and BR country, or supply your own BR residential proxies. ## `requestDelay` (type: `integer`): Delay between requests in milliseconds. Increase if hitting Cloudflare challenges. ## `maxConcurrency` (type: `integer`): Parallel tasks. Keep low (1-2) to avoid Cloudflare rate limits. ## `maxRetries` (type: `integer`): Retry attempts per failed request (Cloudflare 403/503 errors). ## Actor input object example ```json { "mode": "listings", "portal": "ZAP", "business": [ "SALE" ], "listingType": [ "USED" ], "usageTypes": [ "RESIDENTIAL" ], "unitTypes": [], "states": [ "SP" ], "cities": [ "sao-paulo" ], "neighborhoods": [], "minPrice": 0, "maxPrice": 0, "minArea": 0, "maxArea": 0, "minBedrooms": 0, "minParkingSpaces": 0, "semFiador": false, "sortBy": "relevance", "agencyIds": [], "agencyIdRangeStart": 0, "agencyIdRangeEnd": 0, "fetchAgencyListings": false, "maxListings": 200, "maxPages": 20, "pageSize": 24, "proxyConfiguration": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "BR" }, "requestDelay": 800, "maxConcurrency": 1, "maxRetries": 3 } ``` # Actor output Schema ## `recordType` (type: `string`): listing / agency ## `listingId` (type: `string`): ZAP internal listing or agency ID ## `portal` (type: `string`): ZAP or VIVA\_REAL ## `url` (type: `string`): Full listing/agency URL ## `title` (type: `string`): Listing or agency display title ## `description` (type: `string`): Listing description text ## `business` (type: `string`): SALE / RENTAL ## `listingType` (type: `string`): USED / DEVELOPMENT (lançamento) ## `usageType` (type: `string`): RESIDENTIAL / COMMERCIAL ## `unitType` (type: `string`): APARTMENT / HOME / OFFICE / WAREHOUSE\_SHED etc. ## `unitSubType` (type: `string`): Sub-type (cobertura, kitnet, sala comercial...) ## `category` (type: `string`): Normalized category (residential/comercial/...) ## `subCategory` (type: `string`): Specific sub-category (sala-comercial, galpao...) ## `priceBRL` (type: `string`): Listing price in Brazilian Reais ## `rentPeriod` (type: `string`): MONTHLY / WEEKLY / DAILY (rentals only) ## `condominioMonthlyBRL` (type: `string`): Monthly building maintenance fee ## `iptuYearlyBRL` (type: `string`): Annual municipal property tax ## `totalMonthlyCostBRL` (type: `string`): Derived: rent + condomínio + (IPTU/12) ## `pricePerSqmBRL` (type: `string`): Derived: price / usable area ## `usableArea` (type: `string`): Área útil ## `totalArea` (type: `string`): Área total ## `bedrooms` (type: `string`): Number of quartos ## `bathrooms` (type: `string`): Number of banheiros ## `suites` (type: `string`): Number of suítes ## `parkingSpaces` (type: `string`): Vagas de garagem ## `uf` (type: `string`): Brazilian state code ## `city` (type: `string`): Cidade ## `neighborhood` (type: `string`): Bairro ## `zone` (type: `string`): Zona Sul/Norte/Leste/Oeste ## `street` (type: `string`): Rua/Avenida ## `streetNumber` (type: `string`): Number on street ## `zipCode` (type: `string`): Postal code ## `latitude` (type: `string`): Latitude coordinate ## `longitude` (type: `string`): Longitude coordinate ## `amenities` (type: `string`): Property amenities (comma separated) ## `buildingClass` (type: `string`): A+/A/B+/B/C (CRE classification) ## `buildingName` (type: `string`): Edifício/condomínio name ## `ceilingHeight` (type: `string`): Pé direito in meters ## `isCommercialCondo` (type: `string`): Part of commercial business park ## `zoning` (type: `string`): Zoning code (comercial/industrial/misto) ## `isLancamento` (type: `string`): New development listing ## `launchName` (type: `string`): Developer project name ## `launchPhase` (type: `string`): Pré-lançamento/Lançamento/Em obras/Pronto ## `constructorName` (type: `string`): Constructora (Cyrela, EZTec, Tegra...) ## `constructorCNPJ` (type: `string`): Constructor Brazilian tax ID ## `deliveryDate` (type: `string`): Estimated delivery ## `totalUnits` (type: `string`): Project total unit count ## `isFiadorFree` (type: `string`): Rental without guarantor requirement ## `acceptsExchange` (type: `string`): Accepts property exchange ## `isFinancing` (type: `string`): Bank financing accepted ## `isFGTSEligible` (type: `string`): Eligible for FGTS withdrawal usage ## `isMCMVEligible` (type: `string`): Minha Casa Minha Vida program eligible ## `agencyId` (type: `string`): Imobiliária ID ## `agencyName` (type: `string`): Imobiliária name ## `agencyCRECI` (type: `string`): CRECI registration (J = jurídica) ## `agencyCNPJ` (type: `string`): Brazilian corporate tax ID ## `agencyPhone` (type: `string`): Contact phone ## `agencyEmail` (type: `string`): Contact email ## `agencyWebsite` (type: `string`): Corporate website ## `agencyAddress` (type: `string`): Agency physical address ## `agencyLogoUrl` (type: `string`): Logo image URL ## `agencyTier` (type: `string`): Free / Premium / Premium+ ## `agencyVerified` (type: `string`): ZAP verification badge ## `agencyEstablishedYear` (type: `string`): Year founded ## `agencyTotalListings` (type: `string`): Active listing count ## `agencyServiceAreas` (type: `string`): Cities/bairros served (comma separated) ## `agencySpecializations` (type: `string`): Residencial/Comercial/Luxo/Litoral ## `agencyBranchCount` (type: `string`): Number of branches ## `publisherType` (type: `string`): Owner / Agency ## `publishedAt` (type: `string`): First published timestamp ## `updatedAt` (type: `string`): Last updated timestamp ## `imageCount` (type: `string`): Total images ## `thumbnailUrl` (type: `string`): First image URL ## `imageUrls` (type: `string`): All images (comma separated) ## `videoUrls` (type: `string`): Video tour URLs ## `hasVideo` (type: `string`): Has video tour ## `hasFloorplan` (type: `string`): Has floorplan image ## `hasVirtualTour` (type: `string`): Has 3D virtual tour ## `listingQualityScore` (type: `string`): Derived quality score 0-100 ## `alsoOnVivaReal` (type: `string`): Cross-portal duplicate flag ## `vivaRealId` (type: `string`): Matching VivaReal listing ID ## `searchBusiness` (type: `string`): Business filter used in search ## `searchState` (type: `string`): UF used in search ## `searchCity` (type: `string`): City slug used in search ## `searchNeighborhood` (type: `string`): Bairro slug used in search ## `scrapedAt` (type: `string`): ISO timestamp when scraped # 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 = { "business": [ "SALE" ], "listingType": [ "USED" ], "usageTypes": [ "RESIDENTIAL" ], "unitTypes": [], "states": [ "SP" ], "cities": [ "sao-paulo" ], "neighborhoods": [], "agencyIds": [], "proxyConfiguration": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "BR" } }; // Run the Actor and wait for it to finish const run = await client.actor("haketa/zapimoveis-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 = { "business": ["SALE"], "listingType": ["USED"], "usageTypes": ["RESIDENTIAL"], "unitTypes": [], "states": ["SP"], "cities": ["sao-paulo"], "neighborhoods": [], "agencyIds": [], "proxyConfiguration": { "useApifyProxy": True, "apifyProxyGroups": ["RESIDENTIAL"], "apifyProxyCountry": "BR", }, } # Run the Actor and wait for it to finish run = client.actor("haketa/zapimoveis-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 '{ "business": [ "SALE" ], "listingType": [ "USED" ], "usageTypes": [ "RESIDENTIAL" ], "unitTypes": [], "states": [ "SP" ], "cities": [ "sao-paulo" ], "neighborhoods": [], "agencyIds": [], "proxyConfiguration": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "BR" } }' | apify call haketa/zapimoveis-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=haketa/zapimoveis-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "ZAP Imóveis Scraper", "description": "Scrape ZAP Imóveis, Brazil's premium real estate portal (QuintoAndar Group): property listings, commercial real estate (sala, galpão, conjunto), lançamentos and 200K+ imobiliária profiles. Get price, condomínio, IPTU, CRECI, agency, building class, sem fiador and FGTS data.", "version": "0.0", "x-build-id": "A4KZTtcreeNJYdmqC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/haketa~zapimoveis-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-haketa-zapimoveis-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/haketa~zapimoveis-scraper/runs": { "post": { "operationId": "runs-sync-haketa-zapimoveis-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/haketa~zapimoveis-scraper/run-sync": { "post": { "operationId": "run-sync-haketa-zapimoveis-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": { "mode": { "title": "Scrape Mode", "enum": [ "listings", "agencies" ], "type": "string", "description": "What to scrape. 'listings' = property search (residential, commercial, lançamentos). 'agencies' = imobiliária directory profiles (CRECI-J, CNPJ, portfolio stats).", "default": "listings" }, "portal": { "title": "Portal", "enum": [ "ZAP", "VIVA_REAL" ], "type": "string", "description": "ZAP and VivaReal share the same Glue API backend. Switch to scrape VivaReal via the same actor. Default: ZAP.", "default": "ZAP" }, "business": { "title": "Business Type", "uniqueItems": true, "type": "array", "description": "Transaction type. SALE = venda. RENTAL = aluguel. Empty = both.", "items": { "type": "string", "enum": [ "SALE", "RENTAL" ], "enumTitles": [ "Sale (Venda)", "Rental (Aluguel)" ] } }, "listingType": { "title": "Listing Type", "uniqueItems": true, "type": "array", "description": "USED = standard resale/rental inventory. DEVELOPMENT = lançamentos (new developer projects, Cyrela/EZTec/Tegra etc).", "items": { "type": "string", "enum": [ "USED", "DEVELOPMENT" ], "enumTitles": [ "Used (Padrão)", "Development (Lançamentos)" ] } }, "usageTypes": { "title": "Usage Types", "uniqueItems": true, "type": "array", "description": "RESIDENTIAL = apartamento/casa/cobertura etc. COMMERCIAL = sala comercial/galpão/conjunto comercial/loja (ZAP's strong vertical).", "items": { "type": "string", "enum": [ "RESIDENTIAL", "COMMERCIAL" ], "enumTitles": [ "Residential", "Commercial (CRE)" ] } }, "unitTypes": { "title": "Unit Types", "type": "array", "description": "Property type filter. Use ZAP's UnitType enum. Common: APARTMENT, HOME, CONDOMINIUM, PENTHOUSE, FLAT, KITNET, FARM, OFFICE, COMMERCIAL_BUILDING, COMMERCIAL_PROPERTY, BUSINESS, WAREHOUSE_SHED, GARAGE, LAND_LOT.", "items": { "type": "string" } }, "states": { "title": "States (UF)", "type": "array", "description": "Brazilian state codes (2-letter UF). Examples: SP, RJ, MG, RS, PR, SC, BA, DF, GO, PE, CE, ES.", "items": { "type": "string" } }, "cities": { "title": "Cities", "type": "array", "description": "City names in ZAP's URL slug format (lowercase, hyphenated, no accents). Examples: 'sao-paulo', 'rio-de-janeiro', 'belo-horizonte', 'porto-alegre', 'curitiba', 'florianopolis', 'salvador', 'brasilia', 'recife', 'fortaleza'. Leave empty for state-wide search.", "items": { "type": "string" } }, "neighborhoods": { "title": "Neighborhoods (Bairros)", "type": "array", "description": "Neighborhood slugs to filter. Examples: 'pinheiros', 'itaim-bibi', 'vila-olimpia', 'faria-lima', 'jardins', 'moema', 'copacabana', 'ipanema', 'leblon', 'barra-da-tijuca'. Requires single city.", "items": { "type": "string" } }, "minPrice": { "title": "Min Price (BRL)", "minimum": 0, "type": "integer", "description": "Minimum price in Brazilian Reais. 0 = no minimum.", "default": 0 }, "maxPrice": { "title": "Max Price (BRL)", "minimum": 0, "type": "integer", "description": "Maximum price in Brazilian Reais. 0 = no maximum.", "default": 0 }, "minArea": { "title": "Min Area (m²)", "minimum": 0, "type": "integer", "description": "Minimum usable area in square meters. 0 = no minimum.", "default": 0 }, "maxArea": { "title": "Max Area (m²)", "minimum": 0, "type": "integer", "description": "Maximum usable area in square meters. 0 = no maximum.", "default": 0 }, "minBedrooms": { "title": "Min Bedrooms (Quartos)", "minimum": 0, "type": "integer", "description": "Minimum bedroom count. 0 = no filter.", "default": 0 }, "minParkingSpaces": { "title": "Min Parking Spaces (Vagas)", "minimum": 0, "type": "integer", "description": "Minimum parking space count. 0 = no filter.", "default": 0 }, "semFiador": { "title": "Sem Fiador (No Guarantor)", "type": "boolean", "description": "Filter rental listings that don't require a fiador (guarantor). ZAP's modern rental segment — competes with QuintoAndar/Loft model.", "default": false }, "sortBy": { "title": "Sort Order", "enum": [ "relevance", "newest", "lowest_price", "highest_price", "lowest_area", "highest_area" ], "type": "string", "description": "Result ordering.", "default": "relevance" }, "agencyIds": { "title": "Agency IDs (Agencies Mode)", "type": "array", "description": "Explicit list of imobiliária IDs to crawl in 'agencies' mode. Examples: '231067' (Brasil Brokers Copacabana), '233859' (Brasil Brokers Ipanema), '122847' (VivaReal). Ignored in 'listings' mode.", "items": { "type": "string" } }, "agencyIdRangeStart": { "title": "Agency ID Range Start", "minimum": 0, "type": "integer", "description": "Start of sequential agency ID range to crawl (agencies mode). Useful for discovering new agencies. 0 = disabled.", "default": 0 }, "agencyIdRangeEnd": { "title": "Agency ID Range End", "minimum": 0, "type": "integer", "description": "End of sequential agency ID range. Must be > start. ZAP agency IDs range up to ~850000. 0 = disabled.", "default": 0 }, "fetchAgencyListings": { "title": "Fetch Agency Listings", "type": "boolean", "description": "In agencies mode, also fetch the agency's listings portfolio (slower). When false, only profile metadata is saved.", "default": false }, "maxListings": { "title": "Max Total Listings/Records", "minimum": 0, "type": "integer", "description": "Maximum total records to scrape across all tasks. Set 0 for unlimited.", "default": 200 }, "maxPages": { "title": "Max Pages per Search", "minimum": 0, "type": "integer", "description": "Maximum pages per task (each task = state/city/business combination). Each page returns up to 24 listings.", "default": 20 }, "pageSize": { "title": "Page Size", "minimum": 1, "maximum": 50, "type": "integer", "description": "Listings per API call. ZAP default is 24. Max recommended: 36.", "default": 24 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Brazilian residential proxy STRONGLY recommended. ZAP is fronted by Cloudflare and DC IPs get blocked fast. Use Apify Proxy with RESIDENTIAL group and BR country, or supply your own BR residential proxies." }, "requestDelay": { "title": "Request Delay (ms)", "minimum": 0, "maximum": 15000, "type": "integer", "description": "Delay between requests in milliseconds. Increase if hitting Cloudflare challenges.", "default": 800 }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 5, "type": "integer", "description": "Parallel tasks. Keep low (1-2) to avoid Cloudflare rate limits.", "default": 1 }, "maxRetries": { "title": "Max Retries", "minimum": 0, "maximum": 10, "type": "integer", "description": "Retry attempts per failed request (Cloudflare 403/503 errors).", "default": 3 } } }, "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 } } } } } } } } } } ```