{ "openapi": "3.0.1", "info": { "title": "Caixa Imoveis Leilões API", "description": "API de leilões de imóveis da Caixa Econômica Federal com dados estruturados e atualizados. Permite consultar imóveis por estado, cidade e modalidade, ideal para automações, análise do mercado imobiliário e integração com sistemas.", "version": "0.0", "x-build-id": "jYyFQJIOuSeyTaacm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pizani~caixa-imoveis-leiloes-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pizani-caixa-imoveis-leiloes-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/pizani~caixa-imoveis-leiloes-api/runs": { "post": { "operationId": "runs-sync-pizani-caixa-imoveis-leiloes-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/pizani~caixa-imoveis-leiloes-api/run-sync": { "post": { "operationId": "run-sync-pizani-caixa-imoveis-leiloes-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", "required": [ "estado" ], "properties": { "estado": { "title": "State (UF)", "enum": [ "AC", "AL", "AM", "AP", "BA", "CE", "DF", "ES", "GO", "MA", "MG", "MS", "MT", "PA", "PB", "PE", "PI", "PR", "RJ", "RN", "RO", "RR", "RS", "SC", "SE", "SP", "TO" ], "type": "string", "description": "Brazilian state to search in, as a two-letter UF code (required). Example: SC for Santa Catarina, SP for São Paulo." }, "cidade_nome": { "title": "City name", "type": "string", "description": "City name to filter by, in uppercase and without accents (optional — leave empty to search the whole state). Examples: SAO JOSE, FLORIANOPOLIS, RIO DE JANEIRO. Must be a city that belongs to the selected state." }, "modalidade": { "title": "Sale type", "enum": [ "", "auction", "bid", "online", "direct" ], "type": "string", "description": "Sale modality of the property. Use 'auction' for SFI auctions (leilão), 'bid' for open bidding (licitação aberta), 'online' for online sales, 'direct' for direct purchase (compra direta), or empty for all.", "default": "" }, "tipo_imovel": { "title": "Property type", "enum": [ "", "Casa", "Apartamento" ], "type": "string", "description": "Property type filter. The values are in Portuguese and must be sent exactly as listed: 'Casa' (house), 'Apartamento' (apartment), or empty for all types.", "default": "" }, "faixa_valor": { "title": "Price range", "enum": [ "", "Até R$100.000,00", "De R$100.000,01 até R$200.000,00", "De R$200.000,01 até R$400.000,00", "De R$400.000,01 até R$750.000,00", "Acima de R$750.000,00", "Indiferente" ], "type": "string", "description": "Price range filter in Brazilian reais (BRL). The values are fixed Portuguese strings and must be sent exactly as listed. 'Até R$100.000,00' means up to 100k BRL; 'De R$100.000,01 até R$200.000,00' means 100k-200k BRL, and so on. Empty means no price filter.", "default": "" }, "pagina": { "title": "Page", "minimum": 1, "type": "integer", "description": "Results page to fetch (default: 1). The first dataset item (tipo: schema_info) reports total_paginas and total_imoveis so you know how many pages exist.", "default": 1 }, "itens_por_pagina": { "title": "Items per page", "minimum": 10, "maximum": 50, "type": "integer", "description": "Number of properties per page, between 10 and 50 (default: 10).", "default": 10 }, "detalhes_completos": { "title": "Full details", "type": "boolean", "description": "If true (default), fetches the full detail record for each property — one extra request per property, slower but returns complete data (address, auction dates, legal notes).", "default": true } } }, "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 } } } } } } } } } }