# QuintoAndar Listings Scraper (`national_scrim/quintoandar-listings-scraper`) Actor

Extrai anúncios públicos de aluguel e venda no QuintoAndar.

- **URL**: https://apify.com/national\_scrim/quintoandar-listings-scraper.md
- **Developed by:** [Bruno-Arantir](https://apify.com/national_scrim) (community)
- **Categories:**
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 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.

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

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

## QuintoAndar Listings Scraper

**Public rental and sale listings from Brazil’s largest digital housing marketplace.**

Monitore preços, condomínio e estoque de imóveis no QuintoAndar para pesquisa de mercado, pricing e originação — só páginas públicas de busca.

- Lê o `__NEXT_DATA__` SSR das URLs `/alugar/imovel/{cidade}` e `/comprar/imovel/{cidade}` (HTTP/Cheerio, sem browser).
- Filtros de cidade, bairro, aluguel/venda e faixa de preço.
- Campos: preço, condo+IPTU, m², quartos, banheiros, bairro, amenities e URL estável.
- Dedup por listing id. Challenge HTML encerra o run (fail closed).
- Bom custo PPE: uma página de busca já traz dezenas de cards.

### Fonte

Páginas públicas, por exemplo:

`https://www.quintoandar.com.br/alugar/imovel/sao-paulo-sp-brasil`

Não usamos GraphQL interno autenticado nem contas de usuário.

### Amostra de saída

Formato extraído de `__NEXT_DATA__` público (São Paulo, aluguel). Valores mudam o tempo todo — rode o Actor para o estoque atual.

```json
{
  "id": "894948651",
  "listingType": "rent",
  "price": 3950,
  "totalCost": 5007,
  "condoIptu": 904,
  "areaM2": 37,
  "bedrooms": 1,
  "bathrooms": 1,
  "neighborhood": "Indianópolis",
  "city": "São Paulo",
  "amenities": ["AR_CONDICIONADO", "VARANDA"],
  "url": "https://www.quintoandar.com.br/imovel/894948651"
}
```

### Configuração

| Campo | Default | Descrição |
| --- | --- | --- |
| `city` | São Paulo | Nome ou slug |
| `neighborhood` | — | Ex. Pinheiros |
| `listingType` | rent | rent / sale |
| `minPrice` / `maxPrice` | — | Filtro em R$ |
| `maxItems` | 40 | Teto 5.000 |
| `searchUrl` | — | Cola uma URL de resultados |
| `proxyConfiguration` | — | Opcional |

### PPE

Evento `dataset-item`: **US$ 3,00 / 1.000 anúncios** sugerido.

### LGPD

Anúncios são ofertas públicas. Não extraímos dados de locatários, proprietários logados nem conversas.

### Desenvolvimento

```bash
cd actors/quintoandar-listings-scraper
npm install && npm test && npm run build
apify run
```

# Actor input Schema

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

Nome da cidade como no site (São Paulo, Rio de Janeiro, Belo Horizonte) ou slug (sao-paulo-sp-brasil).

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

Opcional. Ex.: Pinheiros, Copacabana. Vira slug no caminho da busca.

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

Alugar ou comprar.

## `minPrice` (type: `integer`):

Filtro local sobre o preço do anúncio (aluguel ou venda).

## `maxPrice` (type: `integer`):

Filtro local sobre o preço do anúncio.

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

Limite rígido (teto 5.000). A primeira página SSR entrega ~24 imóveis; páginas seguintes são tentadas via URL de busca.

## `searchUrl` (type: `string`):

Cole uma URL pública do QuintoAndar, ex. https://www.quintoandar.com.br/alugar/imovel/sao-paulo-sp-brasil. Sobrescreve cidade/bairro.

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

Recomendado em volumes altos. O HTML público respondeu sem proxy neste ambiente.

## Actor input object example

```json
{
  "city": "São Paulo",
  "listingType": "rent",
  "maxItems": 20
}
```

# 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 '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "city": "São Paulo",
    "maxItems": 20
};

// Run the Actor and wait for it to finish
const run = await client.actor("national_scrim/quintoandar-listings-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": "São Paulo",
    "maxItems": 20,
}

# Run the Actor and wait for it to finish
run = client.actor("national_scrim/quintoandar-listings-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": "São Paulo",
  "maxItems": 20
}' |
apify call national_scrim/quintoandar-listings-scraper --silent --output-dataset

```

## MCP server setup

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