# VivaReal & ZAP Imóveis Scraper: Brazil Property Listings (`automatic/vivareal-zap-imoveis-scraper`) Actor

Collect public Brazilian property listings from VivaReal and ZAP Imóveis as structured records with BRL prices, areas, room counts, location, amenities, images and source links.

- **URL**: https://apify.com/automatic/vivareal-zap-imoveis-scraper.md
- **Developed by:** [Philip Kirkbride](https://apify.com/automatic) (community)
- **Categories:** Real estate
- **Security:** Limited permissions
- **Stats:** 3 total users, 2 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $0.60 / 1,000 listings

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

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

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
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.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## 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.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## VivaReal and ZAP Imóveis Brazil Listings

Collect public Brazilian property listings from VivaReal and ZAP Imóveis as structured records with BRL prices, areas, room counts, location, amenities, images and source links.

The default input returns up to 20 properties for sale in São Paulo. Choose rentals, a city and state, a property type or price range, or paste a sale/rental search URL from either portal.

```json
{"portal":"vivareal","businessType":"sale","city":"São Paulo","state":"SP","maxResults":20}
```

| Input | Default | Meaning |
| --- | --- | --- |
| `portal` | `vivareal` | `vivareal`, `zap` or `both` |
| `businessType` | `sale` | `sale` or `rent` |
| `city` | `São Paulo` | Brazilian city name |
| `state` | `SP` | State abbreviation or full name |
| `propertyType` | `all` | `all`, `apartment`, `house`, `condominium`, `land`, `commercial` |
| `minPrice`, `maxPrice` | unset | BRL price bounds |
| `searchUrl` | unset | HTTPS sale/rental search URL from either portal |
| `maxResults` | `20` | Total delivered rows, from 1 to 1,000 |

For example, collect rentals from both portals:

```json
{"portal":"both","businessType":"rent","city":"Curitiba","state":"PR","maxResults":40}
```

A pasted search URL supplies its own portal, location, operation and property filters. City, state, portal, businessType and propertyType inputs do not override it. Price bounds additionally filter returned rows. With `both`, the total budget is shared across the portals; the same property may appear once per portal. Agency promotions and changing rankings mean this is a snapshot, with no promise of exhaustive coverage.

Each row contains `listingId`, `portal`, `businessType`, `propertyType`, `price`, `currency`, `condoFee`, `iptu`, `iptuPeriod`, `usableAreaM2`, `totalAreaM2`, `bedrooms`, `bathrooms`, `suites`, `parkingSpaces`, `street`, `neighborhood`, `city`, `state`, `latitude`, `longitude`, `amenities`, `title`, `description`, `imageUrls`, `agencyName`, `createdAt`, `updatedAt`, `url` and `observedAt`.

Amounts and areas are numbers; unavailable values are null. `iptuPeriod` is `year` for API rows and `source-unspecified` for pasted-URL rows. Prices, fees and areas reflect the source, including inconsistencies. Coordinates can be approximate. Street and coordinates are omitted when the source does not expose the street. Images are limited to five. Dates use ISO 8601; the pasted-URL search state generally omits creation/update dates and total area.

No phone numbers, emails or individual advertiser identities are output. Agency names require a company real-estate license. Descriptions are omitted for advertisers without that evidence; contact text is removed from retained descriptions. Private individual names are not used as advertiser identities.

Rows are saved after each page. A partial run with delivered rows succeeds and identifies blocked searches in its final status. A run with no rows fails with a plain status message. The actor reserves time to save rows near the run deadline. Large searches should be split into narrower price ranges or neighborhoods; each run is capped at 1,000 results.

This actor has no configured Store price yet. For local development, install `requirements-dev.txt` in a uv environment and run `python -m unittest discover -s tests`. Run the actor with `python -m src`.

# Actor input Schema

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

Choose VivaReal, ZAP Imóveis, or both portals. The result limit applies across all selected portals.

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

Choose properties for sale or for rent. Rental prices are monthly amounts in Brazilian reais.

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

Brazilian city to search, for example São Paulo. A search URL overrides this location.

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

Two-letter Brazilian state abbreviation, for example SP. A search URL overrides this location.

## `searchUrl` (type: `string`):

HTTPS sale or rental search page on either portal. Its portal and filters take precedence over location, portal, business and property inputs.

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

Choose a property category, or all to include every property type.

## `minPrice` (type: `number`):

Minimum sale price or monthly rent in Brazilian reais (BRL). Leave empty for no minimum.

## `maxPrice` (type: `number`):

Maximum sale price or monthly rent in Brazilian reais (BRL). Leave empty for no maximum.

## `maxResults` (type: `integer`):

Maximum number of listings to return in total across the selected portals, from 1 to 1000.

## Actor input object example

```json
{
  "portal": "vivareal",
  "businessType": "sale",
  "city": "São Paulo",
  "state": "SP",
  "propertyType": "all",
  "maxResults": 20
}
```

# Actor output Schema

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

No description

# 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 = {
    "maxResults": 20
};

// Run the Actor and wait for it to finish
const run = await client.actor("automatic/vivareal-zap-imoveis-scraper").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = { "maxResults": 20 }

# Run the Actor and wait for it to finish
run = client.actor("automatic/vivareal-zap-imoveis-scraper").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 '{
  "maxResults": 20
}' |
apify call automatic/vivareal-zap-imoveis-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,automatic/vivareal-zap-imoveis-scraper"
        }
    }
}
```

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/PjMI6cYqw8WEXDiUD/builds/RsIkPsdD4hCRr3bsn/openapi.json