# 🏢 QuintoAndar Scraper — Brazil Property Listings (`hipersoft/quintoandar-scraper`) Actor

Scrape public real-estate listings from QuintoAndar, Brazil's largest rental & sale property portal. Pick a city or paste a search URL and export one clean row per property: price, rent, area, bedrooms, bathrooms, parking, address, neighbourhood, photos and listing URL — as JSON, CSV or Excel.

- **URL**: https://apify.com/hipersoft/quintoandar-scraper.md
- **Developed by:** [hiper soft](https://apify.com/hipersoft) (community)
- **Categories:** Real estate
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $0.0015 / item scraped

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

## 🏢 QuintoAndar Scraper — Brazil Property Listings

Scrape public real-estate listings from **QuintoAndar**, Brazil's largest rental and sale property portal, and export clean, structured data. Pick a city and choose sale or rent — or paste a ready-made QuintoAndar search or property URL — and get one tidy row per property: sale price, rent, condo + IPTU cost, area, bedrooms, bathrooms, parking, address, neighbourhood, photos and the listing link. Download everything as **JSON, CSV or Excel**, or pull it straight from the API.

Great for real-estate market research, price benchmarking, investment analysis, building a property feed, or tracking listings across Brazilian cities.

### What it does

- 🏙️ **Search by city** — e.g. `sao-paulo-sp-brasil`, `rio-de-janeiro-rj-brasil`, `belo-horizonte-mg-brasil`, `curitiba-pr-brasil`.
- 🏷️ **For sale or for rent** — choose the listing type you want.
- 🔗 **Paste Start URLs** — drop in any QuintoAndar search or property URL straight from your browser.
- 📐 **Rich property fields** — price, rent, total cost, area (m²), bedrooms, bathrooms, parking, furnished flag, amenities and photos.
- 📍 **Location details** — street, neighbourhood, city and state (plus map coordinates on property pages).
- 📊 **Clean, flat output** — ready for spreadsheets, databases and dashboards.

### Input

| Field | Description |
| --- | --- |
| **City** | City to search, written as in a QuintoAndar URL (e.g. `sao-paulo-sp-brasil`). |
| **Listing type** | Collect properties **for sale** or **for rent**. |
| **Start URLs** | Optional list of QuintoAndar search or property URLs. When set, these are used instead of City / Listing type. |
| **Max items** | Maximum number of properties to collect (0 = no limit). |

#### Example input

```json
{
  "citySlug": "sao-paulo-sp-brasil",
  "listingType": "sale",
  "maxItems": 100
}
```

### Output

Each property is one record. Example (fields vary by listing):

```json
{
  "id": "893786684",
  "listingType": "sale",
  "type": "Apartamento",
  "salePrice": 1200000,
  "rentPrice": 4500,
  "totalCost": 5706,
  "condoIptu": 1032,
  "area": 77,
  "bedrooms": 2,
  "bathrooms": 2,
  "parkingSpots": 2,
  "isFurnished": false,
  "forSale": true,
  "forRent": true,
  "street": "Rua Amaral Gama",
  "neighbourhood": "Santana",
  "city": "São Paulo",
  "state": "SP",
  "latitude": -23.4978458,
  "longitude": -46.6275126,
  "coverImage": "https://www.quintoandar.com.br/img/med/original893786684-405...IMG1968.jpg",
  "photos": ["https://www.quintoandar.com.br/img/med/original893786684-405...IMG1968.jpg"],
  "photoCount": 12,
  "listingTags": ["NEW_AD"],
  "amenities": ["Varanda", "Ar condicionado", "Área de serviço"],
  "url": "https://www.quintoandar.com.br/imovel/893786684/comprar",
  "collectedAt": "2026-09-06T08:27:39.083Z"
}
```

> Search results always include price, area, rooms, address, neighbourhood, photos and the listing link. Map coordinates (`latitude` / `longitude`) and the readable amenity list are filled in when you scrape a single property URL.

### Tips

- For a specific neighbourhood or filter combination, run your search on the QuintoAndar website, then paste the resulting URL into **Start URLs** — the city and filters in the URL are respected.
- Set **Listing type** to `rent` to collect rental listings, or `sale` for properties on the market to buy.
- Use **Max items** to cap large searches, or set it to `0` to collect everything a search surfaces.

### Notes

This scraper collects **public property listings only**. It does not access, require or return any user account, login or private data. Please use the data responsibly and in line with QuintoAndar's terms.

# Actor input Schema

## `citySlug` (type: `string`):

City to search, written as it appears in a QuintoAndar URL — for example 'sao-paulo-sp-brasil', 'rio-de-janeiro-rj-brasil' or 'belo-horizonte-mg-brasil'. Ignored when Start URLs are set.

## `listingType` (type: `string`):

Whether to collect properties for sale or for rent.

## `startUrls` (type: `array`):

Optional. One or more QuintoAndar search or property URLs to scrape. Paste the URL straight from your browser. When set, these are used instead of the City / Listing type fields.

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

Maximum number of properties to collect across all searches (0 = no limit; collect everything the searches return).

## Actor input object example

```json
{
  "citySlug": "sao-paulo-sp-brasil",
  "listingType": "sale",
  "maxItems": 100
}
```

# Actor output Schema

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

The results as dataset items.

# 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 = {
    "citySlug": "sao-paulo-sp-brasil"
};

// Run the Actor and wait for it to finish
const run = await client.actor("hipersoft/quintoandar-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 = { "citySlug": "sao-paulo-sp-brasil" }

# Run the Actor and wait for it to finish
run = client.actor("hipersoft/quintoandar-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 '{
  "citySlug": "sao-paulo-sp-brasil"
}' |
apify call hipersoft/quintoandar-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,hipersoft/quintoandar-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/gvX0beIoOHLNR42Cd/builds/e9nTH3fRVc3Q6asTc/openapi.json