# QuintoAndar Imoveis Brasil (`pmodinger/quintoandar-brasil`) Actor

Dados estruturados de imoveis do QuintoAndar Brasil para aluguel e compra, com precos, localizacao, atributos, imagens e URL auditavel.

- **URL**: https://apify.com/pmodinger/quintoandar-brasil.md
- **Developed by:** [Latin America Data](https://apify.com/pmodinger) (community)
- **Categories:** Lead generation, E-commerce
- **Stats:** 2 total users, 0 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

$3.00 / 1,000 imovel entregues

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

## QuintoAndar Imoveis Brasil

Transforme buscas do QuintoAndar em uma base estruturada para inteligencia imobiliaria, monitoramento de precos, analise de oferta e prospeccao no mercado residencial brasileiro.

Use este Actor para acompanhar imoveis de aluguel e compra com dados prontos para planilhas, dashboards, CRM, BI e estudos de mercado. Cada resultado inclui uma URL de origem para auditoria e revisao individual.

### Ideal para

- Monitorar precos de aluguel e venda por cidade, bairro ou regiao
- Acompanhar estoque residencial e novas oportunidades de mercado
- Comparar atributos de imoveis semelhantes
- Alimentar dashboards de inteligencia imobiliaria
- Enriquecer bases internas com dados comerciais verificaveis
- Criar amostras de mercado com custo controlado

### O que voce recebe

- ID da listagem
- URL auditavel do imovel
- URL da busca de origem
- Aluguel, custo total e preco de venda
- Bairro, regiao, cidade e endereco
- Area, quartos, banheiros, suites e vagas
- Tipo de imovel
- Flags de aluguel/compra
- Mobiliado
- Condicoes especiais e tags
- Comodidades e instalacoes
- Imagem principal e lista de imagens
- Pagina e posicao na busca

### Exemplo de input

```json
{
  "startUrls": [
    "https://www.quintoandar.com.br/alugar/imovel/sao-paulo-sp-brasil"
  ],
  "maxItemsPerUrl": 24,
  "maxPagesPerUrl": 2,
  "startPage": 1,
  "pageSize": 12,
  "failOnNoResults": false
}
````

Para compra, use uma URL `/comprar/imovel/...` ou informe `businessContext: "SALE"` junto com `locationSlugs`.

Os limites padrao foram pensados para uma primeira execucao economica. Aumente `maxItemsPerUrl` e `maxPagesPerUrl` gradualmente conforme a cobertura desejada.

### Exemplo de resultado

```json
{
  "status": "success",
  "country": "BR",
  "source": "QuintoAndar",
  "business_context": "RENT",
  "listing_id": "895323482",
  "title": "Kitnet mobiliada para aluguel na Republica, 1 quarto.",
  "property_type": "StudioOuKitchenette",
  "neighborhood": "Republica",
  "region": "Santa Cecilia",
  "city": "Sao Paulo",
  "area_m2": 49,
  "bedrooms": 1,
  "bathrooms": 1,
  "rent_price": 4450,
  "total_cost": 6422,
  "currency": "BRL",
  "source_url": "https://www.quintoandar.com.br/imovel/895323482/alugar",
  "search_url": "https://www.quintoandar.com.br/alugar/imovel/sao-paulo-sp-brasil",
  "page": 1,
  "rank": 1
}
```

### Custo e controle

Cada imovel entregue com `status: "success"` cobra o evento `result` a USD 0.003.

Linhas de status `no_results`, `blocked` e `failed` ajudam a auditar a execucao e nao representam imoveis entregues.

### Estados de saida

- `success`: imovel encontrado e entregue no dataset
- `no_results`: a busca nao encontrou imoveis
- `blocked`: a fonte restringiu a consulta naquele momento
- `failed`: a entrada nao pode ser processada

### Observacoes

- O Actor entrega dados de listagens de busca, com foco em comparacao e monitoramento de mercado.
- URLs ou slugs de localizacao nao reconhecidos retornam `no_results`.
- Use limites menores para validacoes rapidas e aumente o volume quando a configuracao estiver pronta.

# Actor input Schema

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

URLs de busca do QuintoAndar. Exemplo: https://www.quintoandar.com.br/alugar/imovel/sao-paulo-sp-brasil

## `locationSlugs` (type: `array`):

Opcional. Slugs como sao-paulo-sp-brasil ou pinheiros-sao-paulo-sp-brasil. Usado quando startUrls nao for suficiente.

## `businessContext` (type: `string`):

Usado para slugs sem URL. URLs /alugar/ e /comprar/ detectam o tipo automaticamente.

## `maxItemsPerUrl` (type: `integer`):

Limite de imoveis entregues por URL. Controla custo porque cada resultado custa USD 0.003.

## `maxPagesPerUrl` (type: `integer`):

Quantidade maxima de paginas de resultados por URL.

## `startPage` (type: `integer`):

Pagina inicial dos resultados. Use 1 para a primeira pagina e 2 para continuar da segunda.

## `pageSize` (type: `integer`):

Quantidade de resultados solicitados por pagina.

## `rawFilters` (type: `object`):

Opcional. Use somente quando precisar combinar criterios adicionais de busca.

## `requestTimeoutSecs` (type: `integer`):

Tempo maximo, em segundos, para cada tentativa de consulta.

## `retries` (type: `integer`):

Tentativas em erros temporarios.

## `ignoreUrlFailures` (type: `boolean`):

Quando ativo, uma URL com falha vira linha failed/blocked sem interromper as demais.

## `failOnNoResults` (type: `boolean`):

Quando ativo, a execucao falha se nenhuma entrada entregar imoveis.

## Actor input object example

```json
{
  "startUrls": [
    "https://www.quintoandar.com.br/alugar/imovel/sao-paulo-sp-brasil"
  ],
  "businessContext": "RENT",
  "maxItemsPerUrl": 24,
  "maxPagesPerUrl": 2,
  "startPage": 1,
  "pageSize": 12,
  "requestTimeoutSecs": 30,
  "retries": 2,
  "ignoreUrlFailures": true,
  "failOnNoResults": false
}
```

# Actor output Schema

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

Listagens de imoveis e linhas de status (success, no\_results, blocked, failed).

## `summary` (type: `string`):

Resumo da execucao com status, paginas consultadas, limites e totais.

# 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 = {};

// Run the Actor and wait for it to finish
const run = await client.actor("pmodinger/quintoandar-brasil").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 = {}

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

```

## MCP server setup

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

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "QuintoAndar Imoveis Brasil",
        "description": "Dados estruturados de imoveis do QuintoAndar Brasil para aluguel e compra, com precos, localizacao, atributos, imagens e URL auditavel.",
        "version": "0.1",
        "x-build-id": "FUXsE5LAJ4zbQJXgb"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/pmodinger~quintoandar-brasil/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-pmodinger-quintoandar-brasil",
                "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/pmodinger~quintoandar-brasil/runs": {
            "post": {
                "operationId": "runs-sync-pmodinger-quintoandar-brasil",
                "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/pmodinger~quintoandar-brasil/run-sync": {
            "post": {
                "operationId": "run-sync-pmodinger-quintoandar-brasil",
                "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",
                "properties": {
                    "startUrls": {
                        "title": "URLs de busca",
                        "type": "array",
                        "description": "URLs de busca do QuintoAndar. Exemplo: https://www.quintoandar.com.br/alugar/imovel/sao-paulo-sp-brasil",
                        "items": {
                            "type": "string"
                        },
                        "default": [
                            "https://www.quintoandar.com.br/alugar/imovel/sao-paulo-sp-brasil"
                        ]
                    },
                    "locationSlugs": {
                        "title": "Slugs de localizacao",
                        "type": "array",
                        "description": "Opcional. Slugs como sao-paulo-sp-brasil ou pinheiros-sao-paulo-sp-brasil. Usado quando startUrls nao for suficiente.",
                        "items": {
                            "type": "string"
                        }
                    },
                    "businessContext": {
                        "title": "Tipo de negocio",
                        "enum": [
                            "RENT",
                            "SALE"
                        ],
                        "type": "string",
                        "description": "Usado para slugs sem URL. URLs /alugar/ e /comprar/ detectam o tipo automaticamente.",
                        "default": "RENT"
                    },
                    "maxItemsPerUrl": {
                        "title": "Maximo de resultados por URL",
                        "minimum": 1,
                        "maximum": 50000,
                        "type": "integer",
                        "description": "Limite de imoveis entregues por URL. Controla custo porque cada resultado custa USD 0.003.",
                        "default": 24
                    },
                    "maxPagesPerUrl": {
                        "title": "Maximo de paginas por URL",
                        "minimum": 1,
                        "maximum": 500,
                        "type": "integer",
                        "description": "Quantidade maxima de paginas de resultados por URL.",
                        "default": 2
                    },
                    "startPage": {
                        "title": "Pagina inicial",
                        "minimum": 1,
                        "maximum": 500,
                        "type": "integer",
                        "description": "Pagina inicial dos resultados. Use 1 para a primeira pagina e 2 para continuar da segunda.",
                        "default": 1
                    },
                    "pageSize": {
                        "title": "Resultados por pagina",
                        "minimum": 1,
                        "maximum": 30,
                        "type": "integer",
                        "description": "Quantidade de resultados solicitados por pagina.",
                        "default": 12
                    },
                    "rawFilters": {
                        "title": "Filtros personalizados",
                        "type": "object",
                        "description": "Opcional. Use somente quando precisar combinar criterios adicionais de busca."
                    },
                    "requestTimeoutSecs": {
                        "title": "Timeout por requisicao",
                        "minimum": 15,
                        "maximum": 180,
                        "type": "integer",
                        "description": "Tempo maximo, em segundos, para cada tentativa de consulta.",
                        "default": 30
                    },
                    "retries": {
                        "title": "Tentativas por pagina",
                        "minimum": 1,
                        "maximum": 6,
                        "type": "integer",
                        "description": "Tentativas em erros temporarios.",
                        "default": 2
                    },
                    "ignoreUrlFailures": {
                        "title": "Ignorar falhas por URL",
                        "type": "boolean",
                        "description": "Quando ativo, uma URL com falha vira linha failed/blocked sem interromper as demais.",
                        "default": true
                    },
                    "failOnNoResults": {
                        "title": "Falhar se nao houver resultados",
                        "type": "boolean",
                        "description": "Quando ativo, a execucao falha se nenhuma entrada entregar imoveis.",
                        "default": false
                    }
                }
            },
            "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
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
