# VivaReal Brazil Real Estate Data Scraper (`pmodinger/vivareal-brasil`) Actor Extraia anúncios do VivaReal com preços, localização, área, quartos, vagas e imobiliária. Scraper para leads, pesquisa e inteligência imobiliária. Exporte em JSON, CSV ou Excel e integre por API, webhooks e automações. - **URL**: https://apify.com/pmodinger/vivareal-brasil.md - **Developed by:** [Latin America Data](https://apify.com/pmodinger) (community) - **Categories:** Real estate, Lead generation - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $1.00 / 1,000 imovel extraidos This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage. 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 O **VivaReal Scraper** transforma dados públicos de [VivaReal](https://www.vivareal.com.br/) em registros estruturados e prontos para análise. Cole pesquisas do portal e transforme anúncios de venda e aluguel em uma base estruturada. A saída é adequada para estudos de oferta, comparáveis de preço e monitoramento de mercados imobiliários locais. ### O que você pode extrair com VivaReal Scraper - Título, finalidade e tipo de propriedade. - Preço, moeda, metragem, quartos, banheiros e vagas. - Bairro, cidade, estado e anunciante. - Links da pesquisa e do anúncio para validação dos dados. Os registros incluem `source_url` para conferência. Campos que não aparecem na fonte permanecem vazios; o actor não inventa valores para completar o dataset. ### Casos de uso para dados de VivaReal - Medir preço e oferta de imóveis por cidade ou bairro. - Criar bases de comparáveis para avaliação imobiliária. - Acompanhar anúncios e gerar sinais para prospecção de proprietários e imobiliárias. - Produzir relatórios de mercado para incorporadoras, fundos e consultorias. ### Como usar o VivaReal Scraper 1. Abra a aba **Input** e informe os termos, locais, filtros ou URLs necessários. 2. Para a primeira execução, use um limite pequeno se quiser validar rapidamente o formato. 3. Clique em **Start** e acompanhe a execução no Console da Apify. 4. Abra o dataset para revisar e exportar os resultados. #### Principais campos de entrada | Campo | Nome no formulário | Finalidade | Padrão | | --- | --- | --- | --- | | `startUrls` | URLs de busca do VivaReal | Cole URLs de busca do VivaReal. Exemplo: https://www.vivareal.com.br/venda/sp/sao-paulo/apartamento_residencial/ | `["https://www.vivareal.com.br/venda/sp/sao-paulo/apartamento_residencial/"]` | | `startPage` | Pagina inicial | Numero da primeira pagina da busca. | `1` | | `maxItemsPerUrl` | Maximo de imoveis por URL | Opcional. Se omitido, entrega todos os resultados encontrados para cada URL. | opcional | | `maxPagesPerUrl` | Maximo de paginas por URL | Opcional. Se omitido, continua em cada URL ate a fonte nao retornar novos resultados. | opcional | Limites como `maxItems` e `maxPages` só restringem a coleta quando recebem um valor. Quando ficam vazios, o actor continua enquanto a fonte fornecer novos resultados dentro do escopo informado. #### Exemplo de entrada ```json { "startUrls": [ "https://www.vivareal.com.br/venda/sp/sao-paulo/apartamento_residencial/" ], "startPage": 1, "ignoreUrlFailures": true, "failOnNoResults": false } ```` ### Dados de saída do VivaReal Scraper - Anúncio: `title`, `business_type`, `property_type`, `price` e `currency`. - Características: `area_sqm`, `bedrooms`, `bathrooms` e `parking_spaces`. - Localização: `neighborhood`, `city` e `state`. - Auditoria: `seller_name`, `search_url`, `source_url` e `scraped_at`. Cada linha usa `status=success` quando contém um imóvel entregue. Pesquisas válidas sem correspondência podem gerar `no_results`; indisponibilidades controladas aparecem como `blocked` ou `failed`. Essas linhas operacionais tornam a execução auditável e não são cobradas como resultado. O dataset pode ser baixado em **JSON, CSV ou Excel**. Você também pode consultar os registros pela API da Apify sem alterar o formato definido pelo actor. ### API, integrações e automações para VivaReal Execute o actor por Python, JavaScript, cURL, MCP ou pela API da Apify. Para acompanhar VivaReal continuamente, salve a entrada como tarefa e conecte agendamentos ou webhooks ao destino usado pela sua equipe. ### Quanto custa usar o VivaReal Scraper? O preço atual é **USD 0.001 por imóvel entregue**; 1.000 resultados bem-sucedidos representam USD 1.00 em eventos de resultado. Linhas `no_results`, `blocked` e `failed` não são cobradas. O usuário assume o custo de uso da plataforma e pode definir limites durante os testes. ### Perguntas frequentes sobre VivaReal #### Como escolher a região no VivaReal scraper? Abra a pesquisa desejada no VivaReal, aplique os filtros de localização e cole a URL resultante em `startUrls`. #### É possível coletar mais de uma pesquisa? Sim. Envie várias URLs e o actor processará cada recorte separadamente, mantendo a URL de origem em cada linha. ### Outros scrapers de dados do Brasil - [QuintoAndar Brazil Real Estate Data Scraper](https://apify.com/pmodinger/quintoandar-brasil) - [ZAP Imóveis Brazil Real Estate Data Scraper](https://apify.com/pmodinger/zap-imoveis-brasil) - [OLX Brazil Classified Ads & Price Scraper](https://apify.com/pmodinger/olx-brasil) ### Independência e uso responsável Este actor independente da **Latin America Data** não é afiliado nem operado por VivaReal. Use os dados com finalidade legítima, respeite a legislação e os termos aplicáveis, e valide decisões importantes nos links de origem. # Actor input Schema ## `startUrls` (type: `array`): Cole URLs de busca do VivaReal. Exemplo: https://www.vivareal.com.br/venda/sp/sao-paulo/apartamento\_residencial/ ## `maxItemsPerUrl` (type: `integer`): Opcional. Se omitido, entrega todos os resultados encontrados para cada URL. ## `maxPagesPerUrl` (type: `integer`): Opcional. Se omitido, continua em cada URL ate a fonte nao retornar novos resultados. ## `startPage` (type: `integer`): Numero da primeira pagina da busca. ## `requestTimeoutSecs` (type: `integer`): Timeout em segundos para cada pagina VivaReal. ## `retries` (type: `integer`): Numero de tentativas em erros temporarios. ## `ignoreUrlFailures` (type: `boolean`): Se ativado, uma URL bloqueada ou com falha nao interrompe URLs seguintes. ## `failOnNoResults` (type: `boolean`): Se ativado, a execucao falha quando todas as URLs ficam sem resultados. ## Actor input object example ```json { "startUrls": [ "https://www.vivareal.com.br/venda/sp/sao-paulo/apartamento_residencial/" ], "startPage": 1, "requestTimeoutSecs": 30, "retries": 2, "ignoreUrlFailures": true, "failOnNoResults": false } ``` # Actor output Schema ## `results` (type: `string`): Registros de imoveis e linhas de status (success, no\_results, blocked, failed). ## `summary` (type: `string`): Objeto com estatisticas de scraping e status geral. # 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 = {}; // Run the Actor and wait for it to finish const run = await client.actor("pmodinger/vivareal-brasil").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 = {} # Run the Actor and wait for it to finish run = client.actor("pmodinger/vivareal-brasil").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 '{}' | apify call pmodinger/vivareal-brasil --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=pmodinger/vivareal-brasil", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "VivaReal Brazil Real Estate Data Scraper", "description": "Extraia anúncios do VivaReal com preços, localização, área, quartos, vagas e imobiliária. Scraper para leads, pesquisa e inteligência imobiliária. Exporte em JSON, CSV ou Excel e integre por API, webhooks e automações.", "version": "0.4", "x-build-id": "wYKhmDu3HsFzQ5jN2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pmodinger~vivareal-brasil/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pmodinger-vivareal-brasil", "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/pmodinger~vivareal-brasil/runs": { "post": { "operationId": "runs-sync-pmodinger-vivareal-brasil", "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/pmodinger~vivareal-brasil/run-sync": { "post": { "operationId": "run-sync-pmodinger-vivareal-brasil", "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", "required": [ "startUrls" ], "properties": { "startUrls": { "title": "URLs de busca do VivaReal", "type": "array", "description": "Cole URLs de busca do VivaReal. Exemplo: https://www.vivareal.com.br/venda/sp/sao-paulo/apartamento_residencial/", "items": { "type": "string" }, "default": [ "https://www.vivareal.com.br/venda/sp/sao-paulo/apartamento_residencial/" ] }, "maxItemsPerUrl": { "title": "Maximo de imoveis por URL", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Opcional. Se omitido, entrega todos os resultados encontrados para cada URL." }, "maxPagesPerUrl": { "title": "Maximo de paginas por URL", "minimum": 1, "maximum": 500, "type": "integer", "description": "Opcional. Se omitido, continua em cada URL ate a fonte nao retornar novos resultados." }, "startPage": { "title": "Pagina inicial", "minimum": 1, "maximum": 500, "type": "integer", "description": "Numero da primeira pagina da busca.", "default": 1 }, "requestTimeoutSecs": { "title": "Timeout por pagina", "minimum": 15, "maximum": 180, "type": "integer", "description": "Timeout em segundos para cada pagina VivaReal.", "default": 30 }, "retries": { "title": "Tentativas por pagina", "minimum": 1, "maximum": 6, "type": "integer", "description": "Numero de tentativas em erros temporarios.", "default": 2 }, "ignoreUrlFailures": { "title": "Ignorar falhas por URL", "type": "boolean", "description": "Se ativado, uma URL bloqueada ou com falha nao interrompe URLs seguintes.", "default": true }, "failOnNoResults": { "title": "Falhar quando nenhuma URL retornar resultado", "type": "boolean", "description": "Se ativado, a execucao falha quando todas as URLs ficam sem resultados.", "default": false } } }, "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 } } } } } } } } } } ```