# VivaReal & ZAP Imóveis Scraper (Brazil real estate) (`datahamster/brazil-real-estate-listings`) Actor

Brazilian property listings from VivaReal and ZAP Imóveis as flat rows: rent/sale price, condo fee, IPTU, area, bedrooms, bathrooms, parking, address with coordinates, advertiser, photos. Search by state, city, neighbourhood, type and price, or paste any result URL. Monitor mode alerts on changes.

- **URL**: https://apify.com/datahamster/brazil-real-estate-listings.md
- **Developed by:** [Viktor Dubnytskiy](https://apify.com/datahamster) (community)
- **Categories:** E-commerce
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $1.00 / 1,000 result items

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/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
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.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — 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)

Brazil's two largest property portals (same platform, same data) as flat rows: rent or sale price with condo fee and IPTU, usable / total area, bedrooms, bathrooms, suites, parking, floor, street and neighbourhood with coordinates, construction status, advertiser (name, tier, phone as published), photos. Search by state, city, neighbourhood, property type, bedrooms and price, or paste any VivaReal / ZAP result URL. Monitor mode on a saved Task returns only new listings and price changes since the last run, with optional webhook / Telegram summary. For brokers, investors, proptech and market research.

### What you get

`listingId`, `portal`, `url`, `title`, `description`, `business`, `unitType`, `listingType`, `publicationType`, `price`, `currency`, `pricePeriod`, `condoFee`, `iptu`, `salePrice`, `rentPrice`, `usableArea`, `totalArea`, `bedrooms`, `bathrooms`, `suites`, `parkingSpaces`, `floor`, `street`, `streetNumber`, `neighborhood`, `city`, `state`, `lat`, `lon`, `condominiumName`, `constructionStatus`, `images[]`, `advertiserId`, `advertiserName`, `advertiserTier`, `advertiserPhone`, `externalId`, `stamps[]`, `page`, `rank`, `scrapedAt`.

### Input

- `portal`, `business`, `state`, `city`, optional `neighborhood`, `propertyType`, `bedrooms`, `priceFrom` / `priceTo`; or `searchUrls`. `maxPages` × 30.
- `maxItems`; `mode: monitor` for alerts.

### Pricing

| Event | Price |
|---|---|
| result | $0.001 per listing ($1 per 1,000) |
| monitor-check | $0.005 per monitor run |
| change | $0.001 per new/changed listing |

Charged only for listings actually pushed. The portals serve full pages to Brazilian residential IPs; Apify bills that proxy traffic on top (about 1.4 MB per page of 30).

### Limits

- Listing detail pages are not opened (`url` leads to the listing).
- ZAP occasionally renders results client-side; when a ZAP page carries no embedded listings the run reports it instead of charging.

### Changelog

- 0.1: initial release.

# Actor input Schema

## `portal` (type: `string`):

Which portal to search

## `business` (type: `string`):

Rent or sale listings

## `state` (type: `string`):

State acronym, e.g. sp, rj, mg

## `city` (type: `string`):

City name

## `neighborhood` (type: `string`):

Optional bairro, e.g. Pinheiros

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

apartamento, casa, kitnet, cobertura, terreno, comercial…

## `bedrooms` (type: `integer`):

Minimum number of quartos

## `priceFrom` (type: `integer`):

Lower price bound

## `priceTo` (type: `integer`):

Upper price bound

## `searchUrls` (type: `array`):

Any VivaReal or ZAP result URL with filters — overrides the fields above

## `maxPages` (type: `integer`):

30 listings per page

## `maxItems` (type: `integer`):

Stop after this many results (you are charged only for pushed items)

## `mode` (type: `string`):

scrape = full results; monitor = only new/changed items since the previous run of this task

## `monitorKey` (type: `string`):

Optional state key when not running as a saved task

## `webhookUrl` (type: `string`):

POST a change summary here in monitor mode

## `telegramBotToken` (type: `string`):

Optional: bot token for monitor-mode change summaries

## `telegramChatId` (type: `string`):

Optional: chat id that receives monitor-mode summaries

## Actor input object example

```json
{
  "portal": "vivareal",
  "business": "rent",
  "state": "sp",
  "city": "São Paulo",
  "maxPages": 3,
  "maxItems": 200,
  "mode": "scrape"
}
```

# Actor output Schema

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

All pushed rows (dataset, JSON)

## `resultsTable` (type: `string`):

Dataset in the Console viewer

## `runSummary` (type: `string`):

RUN\_SUMMARY record (pushed, skipped, emptyReason)

# 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("datahamster/brazil-real-estate-listings").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("datahamster/brazil-real-estate-listings").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).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 datahamster/brazil-real-estate-listings --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,datahamster/brazil-real-estate-listings"
        }
    }
}

```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/tAboIyLOd7BJwcnl7/builds/ZqC6Tsxco6QF9uogn/openapi.json