# ChavesNaMao Scraper (`crawlerbros/chavesnamao-scraper`) Actor

Scrape ChavesNaMao - one of Brazil's largest property portals. Search residential and commercial properties for sale and rent across 15 major Brazilian cities. Returns price, bedrooms, bathrooms, area, neighborhood, city, coordinates, property type, condominium fee, IPTU, and listing URL.

- **URL**: https://apify.com/crawlerbros/chavesnamao-scraper.md
- **Developed by:** [Crawler Bros](https://apify.com/crawlerbros) (community)
- **Categories:** Automation, Lead generation, Real estate
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN bookmarks
- **User rating**: No ratings yet

## Pricing

from $3.00 / 1,000 results

This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage.
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

## ChavesNaMao Scraper

Scrape residential and commercial property listings from **ChavesNaMao.com.br** — one of Brazil's largest property portals. Search properties for sale and rent across 15 major Brazilian cities and retrieve structured data including price, bedrooms, bathrooms, area, neighborhood, coordinates, condominium fee, IPTU, and direct listing URLs.

### Features

- Search properties **for sale** or **for rent**
- Cover **15 major Brazilian cities** across all major states
- Returns up to **500 listings** per run
- Full **address, neighborhood, city, and state** details
- **Price display** with condominium fee and IPTU where available
- **GPS coordinates** (latitude/longitude) for mapping
- **Property type** (Apartment, House, Commercial, etc.)
- **Pet-friendly** flag included
- **Suite and garage** counts

### Input

| Field | Type | Description |
|-------|------|-------------|
| `mode` | String | `sell` for sale listings, `rent` for rental listings |
| `city` | String | Brazilian city (sao-paulo, rio-de-janeiro, belo-horizonte, etc.) |
| `maxItems` | Integer | Max number of results (1–500, default 20) |

#### Supported Cities

São Paulo (SP), Rio de Janeiro (RJ), Belo Horizonte (MG), Porto Alegre (RS), Curitiba (PR), Salvador (BA), Florianópolis (SC), Goiânia (GO), Recife (PE), Fortaleza (CE), Brasília (DF), Vitória (ES), Manaus (AM), Belém (PA), Cuiabá (MT)

#### Example Input

```json
{
  "mode": "sell",
  "city": "sao-paulo",
  "maxItems": 50
}
````

### Output

Each item in the dataset represents one property listing:

| Field | Type | Description |
|-------|------|-------------|
| `propertyId` | String | Unique ChavesNaMao property ID |
| `title` | String | Property listing title |
| `transactionType` | String | SELL or RENT |
| `price` | Integer | Asking price or monthly rent in BRL |
| `priceDisplay` | String | Formatted price string (e.g. R$ 450.000) |
| `condominiumFee` | String | Monthly condominium fee (if applicable) |
| `iptuValue` | String | Annual IPTU property tax (if applicable) |
| `propertyType` | String | Property type (Apartment, House, Commercial, etc.) |
| `bedrooms` | Integer | Number of bedrooms |
| `bathrooms` | Integer | Number of bathrooms |
| `suites` | Integer | Number of suites |
| `garages` | Integer | Number of garage spaces |
| `areaSqM` | Float | Property area in square metres |
| `neighborhood` | String | Neighbourhood name |
| `city` | String | City name |
| `stateAcronym` | String | State code (SP, RJ, MG, etc.) |
| `street` | String | Street name (if available) |
| `latitude` | Float | GPS latitude |
| `longitude` | Float | GPS longitude |
| `description` | String | Property description (up to 2000 characters) |
| `reference` | String | Listing reference code |
| `petFriendly` | Boolean | Whether pets are allowed |
| `propertyUrl` | String | Direct link to ChavesNaMao listing |
| `scrapedAt` | String | ISO timestamp of when data was scraped |

#### Example Output

```json
{
  "propertyId": "987654321",
  "title": "Apartamento 2 quartos Pinheiros",
  "transactionType": "SELL",
  "price": 650000,
  "priceDisplay": "R$ 650.000",
  "condominiumFee": "R$ 800",
  "propertyType": "Apartment",
  "bedrooms": 2,
  "bathrooms": 2,
  "suites": 1,
  "garages": 1,
  "areaSqM": 72.0,
  "neighborhood": "Pinheiros",
  "city": "São Paulo",
  "stateAcronym": "SP",
  "latitude": -23.5631,
  "longitude": -46.6901,
  "description": "Excelente apartamento com 2 dormitórios, sendo 1 suíte, localizado no coração de Pinheiros.",
  "petFriendly": true,
  "propertyUrl": "https://www.chavesnamao.com.br/imovel/sp-sao-paulo/987654321",
  "scrapedAt": "2026-06-02T10:30:00+00:00"
}
```

### FAQ

**Does it require proxies?**
No. ChavesNaMao listing data is publicly accessible without authentication, cookies, or proxies.

**How many results can I get?**
Up to 500 listings per run. The actor automatically paginates through results.

**Which states are covered?**
All 15 cities span major Brazilian states: SP, RJ, MG, RS, PR, BA, SC, GO, PE, CE, DF, ES, AM, PA, and MT.

**What currency are prices in?**
All prices are in Brazilian Reais (BRL).

**What is IPTU?**
IPTU (Imposto Predial e Territorial Urbano) is the Brazilian annual urban property tax, similar to council tax in the UK.

**What's the data freshness?**
Listings are live from ChavesNaMao at the time of scraping.

# Actor input Schema

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

Whether to search for properties for sale or rent.

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

Brazilian city to search in.

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

Maximum number of listings to return (1–500).

## Actor input object example

```json
{
  "mode": "sell",
  "city": "sao-paulo",
  "maxItems": 20
}
```

# Actor output Schema

## `listings` (type: `string`):

Dataset containing all scraped ChavesNaMao property listings.

# 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 = {
    "mode": "sell",
    "city": "sao-paulo",
    "maxItems": 20
};

// Run the Actor and wait for it to finish
const run = await client.actor("crawlerbros/chavesnamao-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 = {
    "mode": "sell",
    "city": "sao-paulo",
    "maxItems": 20,
}

# Run the Actor and wait for it to finish
run = client.actor("crawlerbros/chavesnamao-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 '{
  "mode": "sell",
  "city": "sao-paulo",
  "maxItems": 20
}' |
apify call crawlerbros/chavesnamao-scraper --silent --output-dataset

```

## MCP server setup

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

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "ChavesNaMao Scraper",
        "description": "Scrape ChavesNaMao - one of Brazil's largest property portals. Search residential and commercial properties for sale and rent across 15 major Brazilian cities. Returns price, bedrooms, bathrooms, area, neighborhood, city, coordinates, property type, condominium fee, IPTU, and listing URL.",
        "version": "1.0",
        "x-build-id": "lEgaF27zbGhqj4kPt"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/crawlerbros~chavesnamao-scraper/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-crawlerbros-chavesnamao-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/crawlerbros~chavesnamao-scraper/runs": {
            "post": {
                "operationId": "runs-sync-crawlerbros-chavesnamao-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/crawlerbros~chavesnamao-scraper/run-sync": {
            "post": {
                "operationId": "run-sync-crawlerbros-chavesnamao-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",
                "required": [
                    "mode",
                    "city"
                ],
                "properties": {
                    "mode": {
                        "title": "Transaction type",
                        "enum": [
                            "sell",
                            "rent"
                        ],
                        "type": "string",
                        "description": "Whether to search for properties for sale or rent.",
                        "default": "sell"
                    },
                    "city": {
                        "title": "City",
                        "enum": [
                            "sao-paulo",
                            "rio-de-janeiro",
                            "belo-horizonte",
                            "porto-alegre",
                            "curitiba",
                            "brasilia",
                            "salvador",
                            "fortaleza",
                            "recife",
                            "campinas",
                            "manaus",
                            "belem",
                            "goiania",
                            "florianopolis",
                            "vitoria"
                        ],
                        "type": "string",
                        "description": "Brazilian city to search in.",
                        "default": "sao-paulo"
                    },
                    "maxItems": {
                        "title": "Max items",
                        "minimum": 1,
                        "maximum": 500,
                        "type": "integer",
                        "description": "Maximum number of listings to return (1–500).",
                        "default": 20
                    }
                }
            },
            "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
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
