# Viva Real Scraper (`makemakers/viva-real-scraper`) Actor

Extracts real estate listings from www.vivareal.com.br a brazilian real estate platform

- **URL**: https://apify.com/makemakers/viva-real-scraper.md
- **Developed by:** [makemakers](https://apify.com/makemakers) (community)
- **Categories:** Real estate, Automation, Developer tools
- **Stats:** 118 total users, 1 monthly users, 100.0% runs succeeded, 6 bookmarks
- **User rating**: 3.00 out of 5 stars

## Pricing

$10.00/month + usage

To use this Actor, you pay a monthly rental fee to the developer. The rent is subtracted from your prepaid usage every month after the free trial period. You also pay for the Apify platform usage, which gets cheaper the higher Apify subscription plan you have.

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

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

### Viva Real Scrapper

This scrapper extracts real estate listings from www.vivareal.com.br, a prominent Brazilian real estate property portal. It allows you to gather comprehensive information about properties available for sale or rent directly from search results. The scraper provides a structured, easy-to-use dataset containing all the relevant property details, such as price, location, bedroom and bathroom count, amenities, and more.

### How to use

#### 1- passing location details

```json
{
  "state": "sp",
  "municipality": "sao-paulo",
  "number_of_results": 10,
  "search_type": "aluguel"
}
```

##### state

State must be one of the following: 'acre', 'alagoas', 'amapa', 'amazonas', 'bahia', 'ceara', 'espirito-santo', 'goias', 'maranhao', 'mato-grosso', 'mato-grosso-do-sul', 'minas-gerais', 'para', 'paraiba', 'parana', 'pernambuco', 'piaui', 'rj', 'rio-grande-do-norte', 'rio-grande-do-sul', 'rondonia', 'roraima', 'santa-catarina', 'sp', 'sergipe', 'tocantins', 'distrito-federal'

##### search\_type

search\_type can be either 'aluguel' or 'venda'. Default is 'aluguel'. If you want to search for new property, use the crawler passing url instead.

##### municipality

Municipality where you want to search for properties. Must be the name of the municipality without accent mark. Example: 'sao-paulo', 'rio-de-janeiro', etc.

#### 2- passing URL

```json
{
  "number_of_results": 10,
  "url": "https://www.vivareal.com.br/venda/distrito-federal/brasilia/bairros/asa-sul/?transacao=venda&onde=,Distrito%20Federal,Bras%C3%ADlia,Bairros,Asa%20Sul,,,neighborhood,BR%3EDistrito%20Federal%3ENULL%3EBrasilia%3EBarrios%3EAsa%20Sul,-15.811417,-47.894501,&pagina=1&banheiros=2,3,4&quartos=3,4"
}
```

### Sample Output JSON

```json
{
  "id": "2807962083",
  "url": "https://www.vivareal.com.br/imovel/apartamento-3-quartos-jardim-caravelas-sao-paulo-com-garagem-84m2-aluguel-RS5400-id-2807962083/?source=ranking%2Crp",
  "title": "Apartamento na Rua Anhembi, 170, Jardim Caravelas em São Paulo, por R$ 5.400/Mês - Viva Real",
  "address": "Rua Anhembi, 170 - Jardim Caravelas, São Paulo - SP",
  "street": "Rua Anhembi",
  "city": "São Paulo - SP",
  "neigborhood": "Jardim Caravelas",
  "iptu": "R$ 274",
  "condo": "R$ 770",
  "area": "84",
  "bedrooms": "3",
  "suites": "1",
  "bathrooms": "2",
  "parking_spaces": "2",
  "amenities": [
    "14 andar",
    "Aceita animais",
    "Piscina",
    "Elevador",
    "Churrasqueira",
    "Condomínio fechado",
    "Academia",
    "Espaço gourmet",
    "Jardim",
    "Área de serviço",
    "Playground",
    "Varanda gourmet",
    "Salão de festas",
    "Bicicletário",
    "Portaria 24h",
    "Área de lazer",
    "Conexão à internet",
    "Portão eletrônico",
    "Ambientes integrados",
    "Brinquedoteca",
    "Salão de jogos",
    "Acesso para deficientes"
  ]
}
```

# Actor input Schema

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

State where you want to search for properties.

## `municipality` (type: `string`):

Municipality where you want to search for properties. Must be the name of the municipality without accent mark. Example: sao paulo

## `number_of_results` (type: `integer`):

Maximum number of results returned. Default: 10

## `search_type` (type: `string`):

Type of search to perform. Search type must be 'aluguel' or 'venda'. Default: 'aluguel'

## `url` (type: `string`):

URL where you want to search for properties. URL of a search. Example: https://www.vivareal.com.br/imoveis-lancamento/sao-paulo/

## Actor input object example

```json
{
  "state": "sp",
  "municipality": "sao paulo",
  "number_of_results": 10,
  "search_type": "aluguel",
  "url": "https://www.vivareal.com.br/imoveis-lancamento/sao-paulo/"
}
```

# 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 = {
    "state": "sp",
    "municipality": "sao paulo",
    "number_of_results": 10,
    "search_type": "aluguel",
    "url": "https://www.vivareal.com.br/imoveis-lancamento/sao-paulo/"
};

// Run the Actor and wait for it to finish
const run = await client.actor("makemakers/viva-real-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 = {
    "state": "sp",
    "municipality": "sao paulo",
    "number_of_results": 10,
    "search_type": "aluguel",
    "url": "https://www.vivareal.com.br/imoveis-lancamento/sao-paulo/",
}

# Run the Actor and wait for it to finish
run = client.actor("makemakers/viva-real-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 '{
  "state": "sp",
  "municipality": "sao paulo",
  "number_of_results": 10,
  "search_type": "aluguel",
  "url": "https://www.vivareal.com.br/imoveis-lancamento/sao-paulo/"
}' |
apify call makemakers/viva-real-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,makemakers/viva-real-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/d47EE2uPGsv1IB2z7/builds/U9Xuf81iEa5lJQSzv/openapi.json