# Zap Imoveis Brasil (`pmodinger/zap-imoveis-brasil`) Actor

Extrai anuncios de imoveis do Zap Imoveis Brasil a partir de buscas por localidade ou URLs diretas, com paginacao, estados auditaveis e custo por resultado.

- **URL**: https://apify.com/pmodinger/zap-imoveis-brasil.md
- **Developed by:** [Latin America Data](https://apify.com/pmodinger) (community)
- **Categories:** Real estate, Lead generation
- **Stats:** 2 total users, 0 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per usage

This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage

## 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 Imoveis Brasil

Extrai anuncios do Zap Imoveis Brasil a partir de buscas por localidade ou URLs diretas.

### Como usar

Use os defaults para um smoke test barato:

```json
{
  "businessType": "venda",
  "propertyType": "imoveis",
  "locations": ["sp+sao-paulo"],
  "maxItemsPerUrl": 100,
  "maxPagesPerUrl": 4,
  "proxyConfig": { "useApifyProxy": false }
}
````

Tambem e possivel usar URLs diretas do Zap Imoveis em `startUrls`. Quando `startUrls` e informado, o actor usa essas URLs e nao gera buscas por `businessType`, `propertyType` e `locations`.

### Campos de entrada

- `businessType`: `venda` ou `aluguel`.
- `propertyType`: seletor com os tipos suportados pelo actor, como `imoveis`, `apartamentos`, `casas` e `casas-de-condominio`.
- `propertyTypes`: opcional via API para compatibilidade com integracoes antigas que enviam varios slugs.
- `locations`: slugs da URL do Zap ou texto comum. Exemplos: `sp+sao-paulo`, `rj+rio-de-janeiro`, `Sao Paulo`, `Sao Paulo, SP`.
- `keywords`: opcional; adiciona `q` nas URLs geradas.
- `maxItemsPerUrl`: limite de anuncios entregues por URL. O default e 100 para evitar amostras pequenas demais em cidades grandes.
- `maxPagesPerUrl`: limite de paginas por URL. O default e 4, suficiente para entregar ate 100 anuncios quando a busca tem volume.
- `startPage`: primeira pagina da busca.
- `proxyConfig`: use proxy da Apify se a origem bloquear requisicoes diretas.

### Saida

Cada linha com `status: "success"` representa um anuncio e inclui, quando disponivel:

- preco de venda ou aluguel, condominio e IPTU
- area, quartos, banheiros e vagas
- endereco normalizado, bairro, cidade, estado e coordenadas
- anunciante, amenities, imagens e URL do anuncio
- `search_url`, `source_url`, pagina e posicao para auditoria

Linhas `no_results`, `blocked` e `failed` sao salvas sem cobranca por evento para facilitar auditoria.

### Cobranca

Este actor usa Pay Per Event. O usuario assume o custo de uso e paga USD 0.003 por cada anuncio entregue com o evento `result`. Por politica da Apify, a cobranca configurada neste publish fica efetiva em `2026-06-28T00:00:00Z`.

### Limites conhecidos

O contrato primario e o payload SSR/RSC da propria pagina de resultados. Se o contrato mudar, o actor tenta usar JSON-LD publico como fallback. Um `403`, captcha ou pagina de verificacao e tratado como `blocked`, nao como `no_results`.

# Actor input Schema

## `startUrls` (type: `array`):

Opcional. Use URLs diretas do Zap Imoveis quando quiser controlar filtros da busca. Se informado, substitui a geracao por localidade.

## `businessType` (type: `string`):

Tipo de busca no Zap Imoveis.

## `propertyType` (type: `string`):

Tipo de imovel usado para gerar a URL de busca do Zap Imoveis.

## `locations` (type: `array`):

Aceita slugs de localidade do Zap Imoveis ou texto comum. Exemplos: sp+sao-paulo, rj+rio-de-janeiro, Sao Paulo, Sao Paulo, SP.

## `keywords` (type: `array`):

Opcional. Adiciona o parametro q na URL gerada. Deixe vazio para buscar todos os anuncios da localidade.

## `maxItemsPerUrl` (type: `integer`):

Limite total por URL de busca. O usuario paga apenas por anuncios entregues com status success.

## `maxPagesPerUrl` (type: `integer`):

Quantidade maxima de paginas a percorrer por URL.

## `startPage` (type: `integer`):

Numero da primeira pagina da busca.

## `requestTimeoutSecs` (type: `integer`):

Timeout em segundos para cada pagina.

## `retries` (type: `integer`):

Numero de tentativas por pagina em erros transitorios.

## `ignoreUrlFailures` (type: `boolean`):

Se ativado, uma URL bloqueada ou com falha nao interrompe a execucao quando outras URLs ainda podem retornar dados.

## `proxyConfig` (type: `object`):

Use proxy da Apify se a origem bloquear requisicoes diretas.

## `failOnNoResults` (type: `boolean`):

Se ativado, a execucao falha quando todas as URLs retornarem no\_results.

## Actor input object example

```json
{
  "businessType": "venda",
  "propertyType": "imoveis",
  "locations": [
    "sp+sao-paulo"
  ],
  "maxItemsPerUrl": 100,
  "maxPagesPerUrl": 4,
  "startPage": 1,
  "requestTimeoutSecs": 30,
  "retries": 2,
  "ignoreUrlFailures": true,
  "proxyConfig": {
    "useApifyProxy": false
  },
  "failOnNoResults": false
}
```

# Actor output Schema

## `results` (type: `string`):

Anuncios 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 '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {};

// Run the Actor and wait for it to finish
const run = await client.actor("pmodinger/zap-imoveis-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 '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {}

# Run the Actor and wait for it to finish
run = client.actor("pmodinger/zap-imoveis-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/zap-imoveis-brasil --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=pmodinger/zap-imoveis-brasil",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "Zap Imoveis Brasil",
        "description": "Extrai anuncios de imoveis do Zap Imoveis Brasil a partir de buscas por localidade ou URLs diretas, com paginacao, estados auditaveis e custo por resultado.",
        "version": "0.1",
        "x-build-id": "Zps7eB7zDE1KQxdGh"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/pmodinger~zap-imoveis-brasil/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-pmodinger-zap-imoveis-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~zap-imoveis-brasil/runs": {
            "post": {
                "operationId": "runs-sync-pmodinger-zap-imoveis-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~zap-imoveis-brasil/run-sync": {
            "post": {
                "operationId": "run-sync-pmodinger-zap-imoveis-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": [
                    "businessType",
                    "propertyType",
                    "locations"
                ],
                "properties": {
                    "startUrls": {
                        "title": "URLs de busca do Zap Imoveis",
                        "type": "array",
                        "description": "Opcional. Use URLs diretas do Zap Imoveis quando quiser controlar filtros da busca. Se informado, substitui a geracao por localidade.",
                        "items": {
                            "type": "string"
                        }
                    },
                    "businessType": {
                        "title": "Tipo de negocio",
                        "enum": [
                            "venda",
                            "aluguel"
                        ],
                        "type": "string",
                        "description": "Tipo de busca no Zap Imoveis.",
                        "default": "venda"
                    },
                    "propertyType": {
                        "title": "Tipo de imovel",
                        "enum": [
                            "imoveis",
                            "apartamentos",
                            "casas",
                            "casas-de-condominio",
                            "sobrados",
                            "coberturas",
                            "kitnets",
                            "studios",
                            "lofts",
                            "terrenos-lotes-condominios",
                            "fazendas-sitios-chacaras",
                            "galpoes-depositos-armazens",
                            "salas-comerciais",
                            "lojas-saloes",
                            "conjuntos-comerciais",
                            "predios-comerciais",
                            "pontos-comerciais"
                        ],
                        "type": "string",
                        "description": "Tipo de imovel usado para gerar a URL de busca do Zap Imoveis.",
                        "default": "imoveis"
                    },
                    "locations": {
                        "title": "Localidades",
                        "type": "array",
                        "description": "Aceita slugs de localidade do Zap Imoveis ou texto comum. Exemplos: sp+sao-paulo, rj+rio-de-janeiro, Sao Paulo, Sao Paulo, SP.",
                        "items": {
                            "type": "string"
                        },
                        "default": [
                            "sp+sao-paulo"
                        ]
                    },
                    "keywords": {
                        "title": "Palavras-chave",
                        "type": "array",
                        "description": "Opcional. Adiciona o parametro q na URL gerada. Deixe vazio para buscar todos os anuncios da localidade.",
                        "items": {
                            "type": "string"
                        }
                    },
                    "maxItemsPerUrl": {
                        "title": "Maximo de anuncios por URL",
                        "minimum": 1,
                        "maximum": 50000,
                        "type": "integer",
                        "description": "Limite total por URL de busca. O usuario paga apenas por anuncios entregues com status success.",
                        "default": 100
                    },
                    "maxPagesPerUrl": {
                        "title": "Maximo de paginas por URL",
                        "minimum": 1,
                        "maximum": 500,
                        "type": "integer",
                        "description": "Quantidade maxima de paginas a percorrer por URL.",
                        "default": 4
                    },
                    "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.",
                        "default": 30
                    },
                    "retries": {
                        "title": "Tentativas por pagina",
                        "minimum": 1,
                        "maximum": 6,
                        "type": "integer",
                        "description": "Numero de tentativas por pagina em erros transitorios.",
                        "default": 2
                    },
                    "ignoreUrlFailures": {
                        "title": "Ignorar falhas por URL",
                        "type": "boolean",
                        "description": "Se ativado, uma URL bloqueada ou com falha nao interrompe a execucao quando outras URLs ainda podem retornar dados.",
                        "default": true
                    },
                    "proxyConfig": {
                        "title": "Configuracao de proxy",
                        "type": "object",
                        "description": "Use proxy da Apify se a origem bloquear requisicoes diretas.",
                        "default": {
                            "useApifyProxy": false
                        }
                    },
                    "failOnNoResults": {
                        "title": "Falhar quando nenhuma URL retornar resultado",
                        "type": "boolean",
                        "description": "Se ativado, a execucao falha quando todas as URLs retornarem no_results.",
                        "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
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
