{ "openapi": "3.0.1", "info": { "title": "Brazilian Property Auction Scraper", "description": "Judicial and extrajudicial property auctions across Brazil. Minimum bid, appraisal, discount, both praça dates with their own minimum bids, auction house, selling bank, occupancy, areas, court case reference, and the matrícula and edital PDFs. Filter by state, city, auction type and price.", "version": "0.1", "x-build-id": "0wfvgX6svrw9d46Wc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dami_studio~leilao-imovel-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dami_studio-leilao-imovel-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~leilao-imovel-scraper/runs": { "post": { "operationId": "runs-sync-dami_studio-leilao-imovel-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~leilao-imovel-scraper/run-sync": { "post": { "operationId": "run-sync-dami_studio-leilao-imovel-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": { "auctionCategories": { "title": "Auction type", "uniqueItems": true, "type": "array", "description": "Which kind of auction to pull. Judicial auctions are ordered by a court; extrajudicial ones are run by a bank or creditor outside court. Leave empty for all of them. The four Caixa categories are included for completeness, but if Caixa stock is all you want, the dedicated Caixa actor reads it from Caixa directly and returns more of its paperwork.", "items": { "type": "string", "enum": [ "judicial", "extrajudicial", "venda-direta", "comprei-pgfn", "particular", "outro", "caixa-leilao-sfi", "caixa-licitacao-aberta", "caixa-venda-online", "caixa-compra-direta" ], "enumTitles": [ "Judicial (court-ordered)", "Extrajudicial (creditor-run)", "Venda Direta (direct sale)", "Comprei PGFN (federal tax debt)", "Particular (private)", "Outro (other)", "Caixa — Leilão SFI", "Caixa — Licitação Aberta", "Caixa — Venda Online", "Caixa — Compra Direta" ] } }, "states": { "title": "States (UF)", "type": "array", "description": "Two-letter Brazilian state codes, one per line: SP, RJ, MG, BA and so on. Leave empty to search the whole country. Each state is searched as its own query, which is also how you get past the portal's result ceiling — see the README.", "items": { "type": "string" } }, "cities": { "title": "Cities", "type": "array", "description": "Municipality names, one per line. Accents and case do not matter — \"sao jose do rio preto\" matches. When you set cities the state filter is dropped, because the cities already pin the location. A name the portal does not list is reported back rather than silently ignored.", "items": { "type": "string" } }, "propertyTypes": { "title": "Property type", "uniqueItems": true, "type": "array", "description": "Leave empty for every type.", "items": { "type": "string", "enum": [ "apartamento", "casa", "terreno", "area-rural", "comercial", "galpao", "area-industrial", "garagem", "agencia", "outros" ], "enumTitles": [ "Apartamento (flat)", "Casa (house)", "Terreno (plot)", "Área rural (rural land)", "Comercial (commercial unit)", "Galpão (warehouse)", "Área industrial", "Garagem (parking space)", "Agência (bank branch)", "Outros" ] } }, "sellerInstitutions": { "title": "Selling institution", "uniqueItems": true, "type": "array", "description": "Only properties being sold by these banks or funds. Leave empty for all sellers, including the court-ordered auctions that have no bank behind them.", "items": { "type": "string", "enum": [ "caixa", "banco-do-brasil", "santander", "itau", "bradesco", "banco-inter", "brb", "btg", "bv", "safra", "sicoob", "porto-seguro", "embracon", "emgea", "assefaz", "reverts" ], "enumTitles": [ "Caixa Econômica Federal", "Banco do Brasil", "Santander", "Itaú Unibanco", "Bradesco", "Banco Inter", "Banco BRB", "BTG Pactual", "Banco BV", "Banco Safra", "Sicoob", "Porto Seguro", "Embracon", "Emgea", "Fundação Assefaz", "Reverts" ] } }, "keyword": { "title": "Keyword", "type": "string", "description": "Free text matched against the listing, for example a condominium name, a street or \"praia\". Leave empty to skip it." }, "minPriceBrl": { "title": "Minimum price (R$)", "minimum": 0, "type": "integer", "description": "Floor on the minimum bid, in reais. 0 means no floor." }, "maxPriceBrl": { "title": "Maximum price (R$)", "minimum": 0, "type": "integer", "description": "Ceiling on the minimum bid, in reais. 0 means no ceiling." }, "minDiscountPercent": { "title": "Minimum discount (%)", "minimum": 0, "maximum": 99, "type": "integer", "description": "Keep only properties whose minimum bid is at least this far under the appraisal. 0 keeps everything." }, "paymentOptions": { "title": "Payment", "uniqueItems": true, "type": "array", "description": "Most of this stock is cash only. Set this to see just the properties that accept financing, instalments or FGTS.", "items": { "type": "string", "enum": [ "financiamento", "parcelamento", "fgts" ], "enumTitles": [ "Bank financing accepted", "Instalments accepted", "FGTS accepted" ] } }, "auctionBefore": { "title": "Auction closes before", "type": "string", "description": "Only auctions closing on or before this date, as YYYY-MM-DD. Leave empty for no cut-off." }, "sortBy": { "title": "Order", "enum": [ "", "price-asc", "price-desc", "discount-desc", "discount-asc", "listed-desc", "listed-asc", "auction-asc", "auction-desc" ], "type": "string", "description": "Which end of the list to take first. This matters when your search finds more than the run's limit: the order decides which properties you get." }, "includeAuctionDetails": { "title": "Open each property page", "type": "boolean", "description": "On (recommended): opens every property's own page and returns the auction rounds with their dates and minimum bids, the auction house, the areas, occupancy, the registry and case references and links to the matrícula and edital PDFs. Off: reads the results list only — far faster, but you get no auction dates, no auction house, no PDFs and no areas. Both settings charge the same per property." }, "maxItems": { "title": "Maximum properties", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap on properties returned across every state and filter in this run. You are charged per property returned." }, "propertyUrls": { "title": "Specific properties", "type": "array", "description": "Paste property pages from the portal, one per line. Works on its own or alongside a search.", "items": { "type": "string" } }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Leave this alone unless you must exit from a particular network. The actor picks a working address by itself." } } }, "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 } } } } } } } } } }