{ "openapi": "3.0.1", "info": { "title": "Caixa Imóveis Leilão Scraper - Brazil Property Auctions", "description": "Every repossessed property Caixa Econômica Federal has for sale, across all 27 Brazilian states. Minimum bid, appraisal, discount, auction dates, occupancy, payment rules, matrícula and edital PDF links. Filter by state, city, sale type, property type, price and minimum discount.", "version": "0.1", "x-build-id": "9LoKO4lnp8rbVKfxd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dami_studio~caixa-imoveis-leilao-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dami_studio-caixa-imoveis-leilao-scraper", "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/dami_studio~caixa-imoveis-leilao-scraper/runs": { "post": { "operationId": "runs-sync-dami_studio-caixa-imoveis-leilao-scraper", "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/dami_studio~caixa-imoveis-leilao-scraper/run-sync": { "post": { "operationId": "run-sync-dami_studio-caixa-imoveis-leilao-scraper", "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": { "states": { "title": "States (UF)", "type": "array", "description": "Two-letter Brazilian state codes, one per line: SP, RJ, MG, GO, BA and so on. Caixa holds stock in 26 of the 27 states on any given day. Leave empty only if you are pasting property pages below.", "items": { "type": "string" } }, "cities": { "title": "Cities (optional)", "type": "array", "description": "City names to narrow the search inside the states above, one per line. Accents and case do not matter — \"sao jose do rio preto\" matches. Caixa only lists cities that have property for sale today; if none of yours does, the run says so and names the cities that do.", "items": { "type": "string" } }, "saleMode": { "title": "Sale type", "enum": [ "", "leilao-sfi", "licitacao-aberta", "venda-online", "venda-direta-online", "direito-de-preferencia" ], "type": "string", "description": "Caixa sells the same repossessed stock four ways. Leilão SFI is the public auction with a first and second round. Licitação Aberta takes sealed competing offers on one date. Venda Online and Venda Direta Online are fixed-price sales that close on a deadline instead of a hammer." }, "propertyType": { "title": "Property type", "enum": [ "", "casa", "apartamento", "outros" ], "type": "string", "description": "Caixa's own three buckets. \"Others\" holds land, shops, sheds, rural plots and everything that is not a house or a flat." }, "priceBand": { "title": "Price band", "enum": [ "", "ate-100k", "100k-200k", "200k-400k", "400k-750k", "acima-750k" ], "type": "string", "description": "Caixa's own bands, applied on its side before anything is fetched. For an exact ceiling use \"Maximum price\" further down instead." }, "minBedrooms": { "title": "Bedrooms", "enum": [ "", "1", "2", "3" ], "type": "string", "description": "Caixa records bedrooms only for houses and flats, so setting this drops land and commercial units." }, "garageSpaces": { "title": "Garage spaces", "enum": [ "", "1", "2", "3" ], "type": "string", "description": "Minimum parking spaces." }, "acceptsFinancing": { "title": "Caixa financing", "enum": [ "", "S", "N" ], "type": "string", "description": "Most of this stock is cash-only. Set this to \"Yes\" to see just the properties Caixa will finance — on a typical day that is well under a tenth of a state's listings." }, "minDiscountPercent": { "title": "Minimum discount (%)", "minimum": 0, "maximum": 99, "type": "integer", "description": "Keep only properties whose minimum bid is at least this far under Caixa's own appraisal. 0 keeps everything. Properties dropped here are not charged." }, "maxPriceBrl": { "title": "Maximum price (R$)", "minimum": 0, "type": "integer", "description": "Exact ceiling on the minimum bid, in reais. 0 means no ceiling. Properties dropped here are not charged." }, "includeAuctionDetails": { "title": "Open each property page", "type": "boolean", "description": "On (recommended): opens every property's own page and returns the auction dates, the appraisal and discount, occupancy, the registry details, the accepted payment methods and links to the matrícula and edital PDFs. Off: reads the result list only — about ten times faster, but you get no auction dates, no PDFs, no occupancy, and appraisal and discount only on the fixed-price listings." }, "maxItems": { "title": "Maximum properties", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap on properties returned across every state and city in this run. You are charged per property returned." }, "propertyUrls": { "title": "Specific properties (optional)", "type": "array", "description": "Paste Caixa property pages (https://venda-imoveis.caixa.gov.br/sistema/detalhe-imovel.asp?hdnimovel=8787704299058) or bare property numbers (878770429905-8), one per line. Works on its own or alongside a search.", "items": { "type": "string" } }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. Leave this alone unless you need the run to go out through a particular network. Your own proxy servers are used exactly as given." } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }