# Banco do Brasil Imóveis API (`brasil-scrapers/banco-do-brasil-imoveis-api`) Actor API confiável de leilões de imóvel Banco do Brasil. Esta ferramente de web scraper permite buscar dados no site de leilões do Banco do Brasil com diversos filtros específicos por estado, cidade e etc. Solução ótima para criar automações e análise do mercado de leilões imobiliário. - **URL**: https://apify.com/brasil-scrapers/banco-do-brasil-imoveis-api.md - **Developed by:** [Brasil Scrapers](https://apify.com/brasil-scrapers) (community) - **Categories:** Real estate, Automation, Developer tools - **Stats:** 1 total users, 0 monthly users, 0.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing from $20.00 / 1,000 results 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 ## Seu Imóvel BB API Extraia imóveis do catálogo do site Seu Imóvel BB usando um Actor simples na Apify. Este Actor abre o catálogo, aplica os filtros disponíveis no painel lateral, percorre a paginação e salva os resultados no dataset padrão. ### Recomendação de Proxy Recomendamos usar `Apify Proxy` em execuções de produção. Este Actor depende de abrir o site em um navegador real, interagir com o painel de filtros e navegar pelas páginas do catálogo. Sem proxy, a execução pode ficar menos estável, principalmente em coletas maiores, execuções repetidas ou quando o site começar a limitar ou bloquear requisições. Configuração recomendada: ```json { "proxy": { "useApifyProxy": true } } ```` Se você pretende rodar em escala, mantenha o proxy habilitado desde o início. ### Entrada O Actor aceita filtros simples do catálogo e limites de coleta. #### Campos de entrada | Campo | Tipo | Descrição | | ------------------------- | ------- | ------------------------------------------------------------------------ | | `uf` | String | Filtra por um único estado. Exemplo: `RS`. | | `ufs` | String | Lista de estados separada por vírgula. Exemplo: `RS, SC, PR`. | | `city` | String | Filtra por uma única cidade exatamente como aparece no site. | | `cities` | String | Lista de cidades separada por vírgula. | | `category` | String | Tipo de imóvel. Exemplo: `Casa`, `Apartamento`, `Residencial`. | | `categories` | String | Lista de tipos de imóvel separada por vírgula. | | `saleType` | String | Tipo de venda. Exemplo: `Venda direta`, `Leilão alienação fiduciária`. | | `saleTypes` | String | Lista de tipos de venda separada por vírgula. | | `minPrice` | Integer | Preço mínimo em reais. | | `maxPrice` | Integer | Preço máximo em reais. | | `cashOnly` | Boolean | Marca a condição de pagamento `À vista`. | | `maxPages` | Integer | Número máximo de páginas do catálogo a capturar. Padrão: `30`. | | `waitAfterPaginationMs` | Integer | Tempo de espera após aplicar filtros e trocar de página. Padrão: `1500`. | | `proxy.useApifyProxy` | Boolean | Ativa o Apify Proxy. Recomendado: `true`. | | `proxy.apifyProxyGroups` | Array | Grupos opcionais do proxy da Apify. | | `proxy.apifyProxyCountry` | String | País opcional para o proxy. | #### Exemplo de entrada ```json { "ufs": "RS, SC", "cities": "Porto Alegre, Caxias do Sul", "categories": "Casa, Apartamento", "saleTypes": "Venda direta", "minPrice": 100000, "maxPrice": 500000, "cashOnly": true, "maxPages": 20, "waitAfterPaginationMs": 1500, "proxy": { "useApifyProxy": true } } ``` #### Observações sobre a entrada - O painel do Actor expõe `uf` e `ufs`, mas a API do Actor também aceita os aliases `state` e `states`. - Os filtros `city`, `cities`, `category`, `categories`, `saleType` e `saleTypes` são resolvidos pelos textos visíveis no site. Use os nomes como aparecem no catálogo. - O filtro de cidade depende das opções carregadas pelo site. Quando possível, envie `uf` ou `ufs` junto com `city` ou `cities`. - Se nenhum filtro for enviado, o Actor inicia com a listagem padrão do catálogo. ### Saída O Actor salva os resultados no dataset padrão. Durante a execução, você pode receber até quatro tipos de registro: - item de imóvel - registro de resumo - registro de nenhum resultado - registro de erro #### 1. Item de imóvel Cada card do catálogo é salvo como um item no dataset. O Actor captura os principais campos visíveis do card e adiciona metadados com prefixo `_`. Exemplo de saída: ```json { "propertyId": "7109", "detailUrl": "https://www.seuimovelbb.com.br/imovel/id/7109", "imageUrl": "https://www.seuimovelbb.com.br/imagem/imovel/7109_1.jpg", "category": "Casa", "badge": "Novidade", "location": "Mossoró - RN", "city": "Mossoró", "state": "RN", "price": "R$ 40.530,00", "priceLabel": "Valor para proposta", "offerText": null, "saleLabel": "Venda direta", "saleId": "97710", "saleDate": null, "partner": "Parceiro: Escritório de Leilões", "visibleText": [ "Novidade", "Casa", "R$ 40.530,00", "Valor para proposta", "Mossoró - RN", "Venda direta - ID 97710", "Parceiro: Escritório de Leilões" ], "_page": 1, "_capturedAt": "2026-04-09T18:00:00.000Z", "_sourceUrl": "https://www.seuimovelbb.com.br/catalogo", "_totalPages": 30 } ``` Principais metadados adicionados pelo Actor: | Campo | Descrição | | ------------- | ------------------------------------------------------ | | `_page` | Página do catálogo em que o item foi capturado. | | `_capturedAt` | Data e hora da captura em formato ISO. | | `_sourceUrl` | URL da página usada como origem da captura. | | `_totalPages` | Total de páginas do catálogo identificado na execução. | #### 2. Registro de resumo Ao final da execução, o Actor grava um item de resumo para facilitar a validação do resultado. Exemplo: ```json { "_summary": true, "_capturedAt": "2026-04-09T18:30:00.000Z", "_sourceUrl": "https://www.seuimovelbb.com.br/catalogo", "monetizationMode": "legacy", "monetizationEventName": "catalog-item", "uniquePagesCaptured": 12, "totalItemsCaptured": 384, "totalPagesFromCatalog": 12, "stopReason": "TOTAL_PAGES_REACHED" } ``` #### 3. Registro de nenhum resultado Se o catálogo não retornar cards após aplicar os filtros selecionados, o Actor grava um registro indicando isso. ```json { "_notFound": true, "_capturedAt": "2026-04-09T18:05:00.000Z", "_sourceUrl": "https://www.seuimovelbb.com.br/catalogo", "_message": "No property cards were found in the catalog." } ``` #### 4. Registro de erro Atualmente este Actor não grava um item de erro estruturado no dataset. Quando ocorre uma falha de navegação, paginação ou carregamento do site, o erro fica disponível nos logs da execução. ### Quando a execução para O Actor encerra a execução quando uma destas condições é atingida: - todas as páginas disponíveis do catálogo foram capturadas - o limite definido em `maxPages` foi atingido - não foi possível avançar para a próxima página - o catálogo retornou nenhum card para os filtros informados - o limite de monetização por evento foi atingido na plataforma Apify - o limite de itens pagos no dataset foi atingido ### Boas práticas - Ative `proxy.useApifyProxy`. - Comece com um valor menor de `maxPages` para validar filtros novos. - Ao usar `city` ou `cities`, envie também `uf` ou `ufs` para reduzir inconsistências do carregamento dinâmico do site. - Verifique o registro final com `_summary: true` para confirmar quantas páginas e quantos itens foram capturados. ### Links úteis - [Seu Imóvel BB](https://www.seuimovelbb.com.br/catalogo) - [Criscon](https://criscon.com.br/) - Empresa de tecnologia especializada em soluções de scraping e automação de dados. # Actor input Schema ## `uf` (type: `string`): Filtra por um único estado. Exemplo: RS. ## `ufs` (type: `string`): Lista de estados separada por vírgula. Exemplo: RS, SC, PR. ## `city` (type: `string`): Filtra por uma única cidade exatamente como aparece no site. Exemplo: Porto Alegre. ## `cities` (type: `string`): Lista de cidades separada por vírgula. Exemplo: Porto Alegre, Caxias do Sul. ## `category` (type: `string`): Tipo de imóvel. Exemplo: Casa, Apartamento, Residencial. ## `categories` (type: `string`): Lista de tipos de imóvel separada por vírgula. Exemplo: Casa, Apartamento. ## `saleType` (type: `string`): Tipo de venda. Exemplo: Venda direta, Leilão alienação fiduciária. ## `saleTypes` (type: `string`): Lista de tipos de venda separada por vírgula. ## `minPrice` (type: `integer`): Preço mínimo em reais. Exemplo: 100000. ## `maxPrice` (type: `integer`): Preço máximo em reais. Exemplo: 500000. ## `cashOnly` (type: `boolean`): Marca a condição de pagamento 'À vista'. ## `maxPages` (type: `integer`): Limite máximo de páginas do catálogo a capturar. ## `waitAfterPaginationMs` (type: `integer`): Tempo de espera após aplicar filtros e trocar de página. ## `proxy` (type: `object`): Define proxy to pass data through ## Actor input object example ```json { "cashOnly": false, "maxPages": 30, "waitAfterPaginationMs": 1500, "proxy": { "useApifyProxy": false } } ``` # 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 '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "proxy": { "useApifyProxy": false } }; // Run the Actor and wait for it to finish const run = await client.actor("brasil-scrapers/banco-do-brasil-imoveis-api").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 '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "proxy": { "useApifyProxy": False } } # Run the Actor and wait for it to finish run = client.actor("brasil-scrapers/banco-do-brasil-imoveis-api").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 '{ "proxy": { "useApifyProxy": false } }' | apify call brasil-scrapers/banco-do-brasil-imoveis-api --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=brasil-scrapers/banco-do-brasil-imoveis-api", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Banco do Brasil Imóveis API", "description": "API confiável de leilões de imóvel Banco do Brasil. Esta ferramente de web scraper permite buscar dados no site de leilões do Banco do Brasil com diversos filtros específicos por estado, cidade e etc. Solução ótima para criar automações e análise do mercado de leilões imobiliário.", "version": "0.0", "x-build-id": "fqYhTulnx8JwlPgXN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/brasil-scrapers~banco-do-brasil-imoveis-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-brasil-scrapers-banco-do-brasil-imoveis-api", "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/brasil-scrapers~banco-do-brasil-imoveis-api/runs": { "post": { "operationId": "runs-sync-brasil-scrapers-banco-do-brasil-imoveis-api", "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/brasil-scrapers~banco-do-brasil-imoveis-api/run-sync": { "post": { "operationId": "run-sync-brasil-scrapers-banco-do-brasil-imoveis-api", "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": { "uf": { "title": "UF", "enum": [ "AL", "AM", "BA", "CE", "DF", "ES", "GO", "MA", "MT", "MS", "MG", "PA", "PB", "PR", "PE", "PI", "RJ", "RN", "RS", "RO", "RR", "SC", "SP", "SE" ], "type": "string", "description": "Filtra por um único estado. Exemplo: RS." }, "ufs": { "title": "UFs", "type": "string", "description": "Lista de estados separada por vírgula. Exemplo: RS, SC, PR." }, "city": { "title": "Cidade", "type": "string", "description": "Filtra por uma única cidade exatamente como aparece no site. Exemplo: Porto Alegre." }, "cities": { "title": "Cidades", "type": "string", "description": "Lista de cidades separada por vírgula. Exemplo: Porto Alegre, Caxias do Sul." }, "category": { "title": "Tipo de imóvel", "type": "string", "description": "Tipo de imóvel. Exemplo: Casa, Apartamento, Residencial." }, "categories": { "title": "Tipos de imóvel", "type": "string", "description": "Lista de tipos de imóvel separada por vírgula. Exemplo: Casa, Apartamento." }, "saleType": { "title": "Tipo de venda", "type": "string", "description": "Tipo de venda. Exemplo: Venda direta, Leilão alienação fiduciária." }, "saleTypes": { "title": "Tipos de venda", "type": "string", "description": "Lista de tipos de venda separada por vírgula." }, "minPrice": { "title": "Preço mínimo", "minimum": 0, "type": "integer", "description": "Preço mínimo em reais. Exemplo: 100000." }, "maxPrice": { "title": "Preço máximo", "minimum": 0, "type": "integer", "description": "Preço máximo em reais. Exemplo: 500000." }, "cashOnly": { "title": "Somente à vista", "type": "boolean", "description": "Marca a condição de pagamento 'À vista'.", "default": false }, "maxPages": { "title": "Máximo de páginas", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Limite máximo de páginas do catálogo a capturar.", "default": 30 }, "waitAfterPaginationMs": { "title": "Espera após paginação/filtros (ms)", "minimum": 0, "type": "integer", "description": "Tempo de espera após aplicar filtros e trocar de página.", "default": 1500 }, "proxy": { "title": "Proxy", "type": "object", "description": "Define proxy to pass data through", "default": { "useApifyProxy": 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 } } } } } } } } } } ```