# VivaReal Brazil Real Estate Listings Scraper (`scrapers_lat/vivareal-scraper`) Actor
Extract real estate listings from VivaReal Brazil. Scrape prices, bedrooms, area, condo fees, neighborhood, images, advertiser and coordinates. Export to JSON, CSV, Excel or XML, run via API or schedule runs.
- **URL**: https://apify.com/scrapers\_lat/vivareal-scraper.md
- **Developed by:** [Scrapers Lat](https://apify.com/scrapers_lat) (community)
- **Categories:** Real estate, Automation, Developer tools
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet
## Pricing
from $2.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
[](https://console.apify.com/actors/Icn8ebXebCaCErF40/input)
## VivaReal Brazil Real Estate Listings Scraper
> Extract real estate listings, prices, and property details from VivaReal, one of Brazil's largest property portals with millions of homes and apartments for sale and rent nationwide.
24 fields per record
Brazil nationwide coverage
JSON / CSV / Excel output formats
### What you get
Each listing returns a structured record ready to load into any database, spreadsheet, or analytics pipeline:
- **imageUrl**: main property photo
- **title**: listing headline as shown on VivaReal
- **price**: asking price or monthly rent
- **currency**: ISO currency code (BRL)
- **operationType**: venda (for sale) or aluguel (for rent)
- **propertyType**: property category such as apartment, house, penthouse, land or farm
- **bedrooms**: number of bedrooms
- **bathrooms**: number of bathrooms
- **parkingSpaces**: number of parking spaces
- **totalAreaM2**: total area in square meters
- **usableAreaM2**: usable area in square meters
- **condoFee**: monthly condominium fee, when listed
- **neighborhood**: neighborhood name
- **city**: city name
- **state**: state name
- **zone**: city zone or region
- **zipCode**: postal code
- **url**: direct link to the listing page
- **listingId**: unique VivaReal listing ID
- **advertiser**: name of the agency or advertiser
- **advertiserPhone**: advertiser contact phone number, as published on the listing
- **advertiserLogo**: agency logo image, when available
- **publishedAt**: when the listing was first published
- **updatedAt**: when the listing was last updated
- **description\***: full property description text
- **amenities\***: list of property features and amenities
- **images\***: all listing photos
- **latitude\***: approximate latitude of the property
- **longitude\***: approximate longitude of the property
- **observedAt**: when this listing was last seen by the scraper
*\*These fields only appear when withDetails is set to true.*
### Who is it for
| Use case | Who benefits |
|---|---|
| Price monitoring | Real estate teams tracking the Brazilian market |
| Market research | Analysts studying housing supply and pricing trends |
| Lead generation | Agencies and brokers sourcing listings and advertisers |
| Data pipelines | Developers feeding BI dashboards or valuation models |
| Investment analysis | Investors comparing yields across cities and neighborhoods |
### Frequently Asked Questions
**Does it cover all of Brazil?**
Yes. The actor searches VivaReal across every Brazilian city and neighborhood. Enter a location like Sao Paulo, Rio de Janeiro, Belo Horizonte or a neighborhood like Copacabana, and the matching VivaReal area is resolved automatically.
**How many listings can I get per search?**
VivaReal limits each search result set to roughly 1,000 listings. For larger datasets, split your searches by city, neighborhood, operation type or property type and run them separately.
**Can I filter by sale, rent, and property type?**
Yes. Choose between for sale (venda) and for rent (aluguel), pick a property type such as apartment, house, penthouse, land or farm, and select used resale or new development listings. You can also paste a VivaReal search URL and the filters are read from it.
**Does it return property descriptions and photos?**
Enable the withDetails option to add the full description, amenities, all photos and approximate coordinates to every record. With it off, you still get the core listing fields including the main image, a direct link and the advertiser name, phone and logo.
**What happens if a listing has missing data?**
Optional fields like condo fee, total area or amenities are returned only when VivaReal provides them, otherwise they are left empty. If a search request fails, the actor records the reason in the error field and continues without stopping the run.
### Export, API and AI agents (x402 + MCP)
Export the scraped data to **JSON, CSV or Excel**, pull it as a **dataset** through the Apify **API**, or wire it into your app with **no code**. This web scraper and data extractor also works for bulk data extraction and scheduled runs.
For AI agents: this Actor is available on **x402**, Apify's agentic payment standard built with Coinbase. An AI agent can discover, pay for and run it on its own with a funded wallet and a single HTTP request: no account, no subscription, no API key and no human in the loop. It also runs as an **MCP** tool inside Claude, Cursor and other AI clients out of the box. Learn more about [x402 agentic payments on Apify](https://docs.apify.com/platform/integrations/x402).
### Example use cases
Ready-to-run example tasks, each preconfigured for a common scenario. Open one and press run, or use it as a template:
- [Sao Paulo Apartments for Sale (VivaReal)](https://apify.com/scrapers_lat/vivareal-scraper/examples/vivareal-sao-paulo-apartments-sale): Scrape apartments for sale in Sao Paulo from VivaReal: price, bedrooms, area, neighborhood, condo fee, advertiser phone and photos.
- [Sao Paulo Apartments for Rent (VivaReal)](https://apify.com/scrapers_lat/vivareal-scraper/examples/vivareal-sao-paulo-apartments-rent): Scrape apartments for rent in Sao Paulo from VivaReal: monthly rent, bedrooms, area, neighborhood, condo fee, advertiser and photos.
- [Rio de Janeiro Apartments for Sale (VivaReal)](https://apify.com/scrapers_lat/vivareal-scraper/examples/vivareal-rio-de-janeiro-apartments-sale): Scrape apartments for sale in Rio de Janeiro from VivaReal: price, bedrooms, area, neighborhood, condo fee, advertiser phone and photos.
- [Rio de Janeiro Houses for Rent (VivaReal)](https://apify.com/scrapers_lat/vivareal-scraper/examples/vivareal-rio-de-janeiro-houses-rent): Scrape houses for rent in Rio de Janeiro from VivaReal: monthly rent, bedrooms, bathrooms, area, neighborhood and advertiser contacts.
- [Belo Horizonte Apartments for Sale (VivaReal)](https://apify.com/scrapers_lat/vivareal-scraper/examples/vivareal-belo-horizonte-apartments-sale): Scrape apartments for sale in Belo Horizonte from VivaReal: price, bedrooms, area, neighborhood, condo fee, advertiser and photos.
- [Belo Horizonte Houses for Sale (VivaReal)](https://apify.com/scrapers_lat/vivareal-scraper/examples/vivareal-belo-horizonte-houses-sale): Scrape houses for sale in Belo Horizonte from VivaReal: price, bedrooms, bathrooms, land area, neighborhood and advertiser contacts.
- [Curitiba Apartments for Rent (VivaReal)](https://apify.com/scrapers_lat/vivareal-scraper/examples/vivareal-curitiba-apartments-rent): Scrape apartments for rent in Curitiba from VivaReal: monthly rent, bedrooms, area, neighborhood, condo fee, advertiser and photos.
- [Curitiba Houses for Sale (VivaReal)](https://apify.com/scrapers_lat/vivareal-scraper/examples/vivareal-curitiba-houses-sale): Scrape houses for sale in Curitiba from VivaReal: price, bedrooms, bathrooms, land area, neighborhood and advertiser contact phone.
- [Brasilia Apartments for Sale (VivaReal)](https://apify.com/scrapers_lat/vivareal-scraper/examples/vivareal-brasilia-apartments-sale): Scrape apartments for sale in Brasilia from VivaReal: price, bedrooms, area, neighborhood, condo fee, advertiser phone and photos.
- [Porto Alegre Apartments for Rent (VivaReal)](https://apify.com/scrapers_lat/vivareal-scraper/examples/vivareal-porto-alegre-apartments-rent): Scrape apartments for rent in Porto Alegre from VivaReal: monthly rent, bedrooms, area, neighborhood, condo fee and advertiser contacts.
### Related scrapers
Need data from the same space? Here are other scrapers we build and maintain:
- [InfoCasas Real Estate Listings Scraper](https://apify.com/scrapers_lat/infocasas-scraper): Scrape Infocasas real estate listings across Uruguay, Paraguay and more. Extract price, currency...
- [Urbania Peru Property Listings Scraper](https://apify.com/scrapers_lat/urbania-scraper): Scrape Urbania property listings in Peru. Extract price, currency, operation, property type...
- [Adondevivir Peru Property Listings Scraper](https://apify.com/scrapers_lat/adondevivir-scraper): Scrape Adondevivir property listings in Peru. Extract price, currency, operation, property type...
- [MercadoLibre Product Listings Scraper](https://apify.com/scrapers_lat/mercadolibre-scraper): Extract products, prices and seller data from MercadoLibre across 18 LATAM countries. Scrape...
- [Quince Product Scraper](https://apify.com/scrapers_lat/quince-scraper): Extract Quince.com products with prices, traditional retail price, discounts, variants, images and...
- [Rappi Restaurants & Stores Scraper](https://apify.com/scrapers_lat/rappi-scraper): Scrape restaurants and stores from Rappi Colombia! Extract store name, logo, category, rating...
### More scrapers at scrapers.lat
This actor is built and maintained by [scrapers.lat](https://scrapers.lat), where we publish scrapers for Latin American and US public platforms: real estate, jobs, e-commerce, company registries and government data. Browse the full catalog, see live sample output for each one, or ask us for a custom scraper at [scrapers.lat](https://scrapers.lat).
---
> This actor is an independent tool and has no affiliation with VivaReal or Grupo ZAP. It only accesses data that is publicly available on the platform. Use it in accordance with VivaReal's terms of service.
# Actor input Schema
## `maxItems` (type: `integer`):
Maximum number of listings to collect. Optional.
## `withDetails` (type: `boolean`):
When enabled, each listing also includes description, amenities, all images, advertiser and coordinates.
## `searchTerm` (type: `string`):
City or neighborhood to search on VivaReal, e.g. "Sao Paulo", "Rio de Janeiro", "Copacabana". Resolved automatically to the matching VivaReal location.
## `startUrl` (type: `string`):
Optional. A VivaReal search results URL (e.g. https://www.vivareal.com.br/venda/sp/sao-paulo/apartamento_residencial/). The location, operation and property type are read from the URL and override the fields below.
## `business` (type: `string`):
Buy (venda) or rent (aluguel).
## `listingType` (type: `string`):
Used (resale) properties or new developments.
## `unitType` (type: `string`):
Type of property to search for.
## Actor input object example
```json
{
"maxItems": 10,
"withDetails": true,
"searchTerm": "Sao Paulo",
"business": "SALE",
"listingType": "USED",
"unitType": "APARTMENT"
}
````
# 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 '' with your token
const client = new ApifyClient({
token: '',
});
// Prepare Actor input
const input = {
"maxItems": 10,
"searchTerm": "Sao Paulo"
};
// Run the Actor and wait for it to finish
const run = await client.actor("scrapers_lat/vivareal-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 = {
"maxItems": 10,
"searchTerm": "Sao Paulo",
}
# Run the Actor and wait for it to finish
run = client.actor("scrapers_lat/vivareal-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 '{
"maxItems": 10,
"searchTerm": "Sao Paulo"
}' |
apify call scrapers_lat/vivareal-scraper --silent --output-dataset
```
## MCP server setup
```json
{
"mcpServers": {
"apify": {
"command": "npx",
"args": [
"mcp-remote",
"https://mcp.apify.com/?tools=scrapers_lat/vivareal-scraper",
"--header",
"Authorization: Bearer "
]
}
}
}
```
## OpenAPI specification
```json
{
"openapi": "3.0.1",
"info": {
"title": "VivaReal Brazil Real Estate Listings Scraper",
"description": "Extract real estate listings from VivaReal Brazil. Scrape prices, bedrooms, area, condo fees, neighborhood, images, advertiser and coordinates. Export to JSON, CSV, Excel or XML, run via API or schedule runs.",
"version": "0.1",
"x-build-id": "HjtPeyzotP60aGHea"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/scrapers_lat~vivareal-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-scrapers_lat-vivareal-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/scrapers_lat~vivareal-scraper/runs": {
"post": {
"operationId": "runs-sync-scrapers_lat-vivareal-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/scrapers_lat~vivareal-scraper/run-sync": {
"post": {
"operationId": "run-sync-scrapers_lat-vivareal-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": {
"maxItems": {
"title": "Max Items",
"minimum": 1,
"maximum": 1000000,
"type": "integer",
"description": "Maximum number of listings to collect. Optional."
},
"withDetails": {
"title": "With Details",
"type": "boolean",
"description": "When enabled, each listing also includes description, amenities, all images, advertiser and coordinates.",
"default": true
},
"searchTerm": {
"title": "Location",
"type": "string",
"description": "City or neighborhood to search on VivaReal, e.g. \"Sao Paulo\", \"Rio de Janeiro\", \"Copacabana\". Resolved automatically to the matching VivaReal location."
},
"startUrl": {
"title": "Search URL (optional)",
"type": "string",
"description": "Optional. A VivaReal search results URL (e.g. https://www.vivareal.com.br/venda/sp/sao-paulo/apartamento_residencial/). The location, operation and property type are read from the URL and override the fields below."
},
"business": {
"title": "Operation",
"enum": [
"SALE",
"RENTAL"
],
"type": "string",
"description": "Buy (venda) or rent (aluguel).",
"default": "SALE"
},
"listingType": {
"title": "Listing Type",
"enum": [
"USED",
"DEVELOPMENT"
],
"type": "string",
"description": "Used (resale) properties or new developments.",
"default": "USED"
},
"unitType": {
"title": "Property Type",
"enum": [
"APARTMENT",
"HOME",
"PENTHOUSE",
"ALLOTMENT_LAND",
"FARM",
"RESIDENTIAL_BUILDING",
"ANY"
],
"type": "string",
"description": "Type of property to search for.",
"default": "APARTMENT"
}
}
},
"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
}
}
}
}
}
}
}
}
}
}
```