# QuintoAndar Property Listings Scraper (`bovi/quintoandar-scraper`) Actor

Collect public QuintoAndar sale and rental listings with prices, location, property details, descriptions, and images.

- **URL**: https://apify.com/bovi/quintoandar-scraper.md
- **Developed by:** [Vitalii Bondarev](https://apify.com/bovi) (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 $1.10 / 1,000 quintoandar property listings scrapers

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

## QuintoAndar Property Listings Scraper

Collect public property listings from [QuintoAndar](https://www.quintoandar.com.br/) in Brazil. The actor reads the server-rendered listing page and returns stable listing IDs, public detail URLs, sale and rent prices, currency, area, rooms, address area, source descriptions, amenities, and image URLs. It does not require an account or login. Each run reads one location search page; the source currently renders up to 24 cards in that page.

### Input

- `dealType`: `sale` or `rent`; defaults to `sale`.
- `city`: a QuintoAndar location slug such as `sao-paulo-sp-brasil` (required and prefilled).
- `neighborhood`: optional neighborhood name, such as `Vila Mariana`.
- `maxResults`: maximum number of records to save; defaults to 50. The actor never saves more than this value.
- `proxyConfiguration`: optional Apify proxy settings. Leave it empty to connect directly. When enabled, the actor passes these settings to `Actor.create_proxy_configuration` without forcing a proxy group.

### Example output

```json
{
  "record_type": "property_listing",
  "record_id": "892808496",
  "source_context": {
    "source_url": "https://www.quintoandar.com.br/comprar/imovel/sao-paulo-sp-brasil",
    "source_name": "QuintoAndar",
    "source_domain": "quintoandar.com.br",
    "page_index": 1,
    "seed": {"type": "location", "value": "sao-paulo-sp-brasil"},
    "external_ids": {"listing_id": "892808496"}
  },
  "entity": {
    "title": "Apartamento com 4 dorms, 243m²",
    "url": "https://www.quintoandar.com.br/imovel/892808496/comprar/apartamento-4-quartos-jardim-vitoria-regia-sao-paulo",
    "external_ids": {"listing_id": "892808496"}
  },
  "listing": {"listing_id": "892808496", "deal_type": "sale"},
  "pricing": {"sale_price": 1770000, "currency": "BRL"},
  "location": {
    "neighborhood": "Jardim Vitória Régia",
    "region": "Panamby",
    "city": "São Paulo",
    "state": "SP",
    "country": "BR"
  },
  "property": {
    "property_type": "Apartamento",
    "area_sqm": 243,
    "bedrooms": 4,
    "bathrooms": 3,
    "parking_spots": 4
  }
}
```

### Price per result

The champion reference rate is **$0.000002 USD per saved listing** ($0.002 per 1,000 output records). This actor does not call `Actor.charge`; Apify handles saved dataset-item billing, and platform compute charges may also apply.

# Actor input Schema

## `dealType` (type: `string`):

Collect listings for sale or rent.

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

QuintoAndar location slug, for example sao-paulo-sp-brasil.

## `neighborhood` (type: `string`):

Optional neighborhood name within the selected city, for example Vila Mariana.

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

Maximum number of listing records to save from the search page.

## `proxyConfiguration` (type: `object`):

Optional Apify proxy settings. Leave empty to connect directly.

## Actor input object example

```json
{
  "dealType": "sale",
  "city": "sao-paulo-sp-brasil",
  "maxResults": 50,
  "proxyConfiguration": {
    "useApifyProxy": true,
    "apifyProxyGroups": [
      "RESIDENTIAL"
    ]
  }
}
```

# Actor output Schema

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

Dataset with the collected QuintoAndar 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 = {
    "city": "sao-paulo-sp-brasil",
    "proxyConfiguration": {
        "useApifyProxy": true,
        "apifyProxyGroups": [
            "RESIDENTIAL"
        ]
    }
};

// Run the Actor and wait for it to finish
const run = await client.actor("bovi/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 = {
    "city": "sao-paulo-sp-brasil",
    "proxyConfiguration": {
        "useApifyProxy": True,
        "apifyProxyGroups": ["RESIDENTIAL"],
    },
}

# Run the Actor and wait for it to finish
run = client.actor("bovi/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 '{
  "city": "sao-paulo-sp-brasil",
  "proxyConfiguration": {
    "useApifyProxy": true,
    "apifyProxyGroups": [
      "RESIDENTIAL"
    ]
  }
}' |
apify call bovi/quintoandar-scraper --silent --output-dataset

```

## MCP server setup

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