{ "openapi": "3.0.1", "info": { "title": "Leilão de Imóveis Brasil Scraper", "description": "Scraper de leilão de imóveis no Brasil com preços, avaliações, descontos, localização, tipo, banco, modalidades judicial, extrajudicial e venda online, datas da 1ª e 2ª praça, edital e matrícula. Filtre por cidade, estado, preço, desconto, FGTS e monitore novas oportunidades.", "version": "0.1", "x-build-id": "JXDqWZbnjw6tqUSF2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/getascraper~leilaoimovel-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-getascraper-leilaoimovel-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/getascraper~leilaoimovel-scraper/runs": { "post": { "operationId": "runs-sync-getascraper-leilaoimovel-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/getascraper~leilaoimovel-scraper/run-sync": { "post": { "operationId": "run-sync-getascraper-leilaoimovel-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": { "startUrls": { "title": "Start URLs", "type": "array", "description": "Optional public Leilão Imóvel home, search, taxonomy, or property-detail URLs. In Auto source mode, the default home URL is combined with a generated search URL when filters are selected.", "default": [ { "url": "https://www.leilaoimovel.com.br/" } ], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "sourceMode": { "title": "Source mode", "enum": [ "auto", "provided_urls" ], "type": "string", "description": "Auto builds the source search URL from the filters and keeps the home page as a resilient fallback. Provided URLs uses only the URLs above.", "default": "auto" }, "state": { "title": "State (UF)", "enum": [ "all", "ac", "al", "ap", "am", "ba", "ce", "df", "es", "go", "ma", "mt", "ms", "mg", "pa", "pb", "pr", "pe", "pi", "rj", "rn", "rs", "ro", "rr", "sc", "sp", "se", "to" ], "type": "string", "description": "Keep properties whose verified detail URL identifies this Brazilian state. All states is the default.", "default": "all" }, "city": { "title": "City", "type": "string", "description": "Optional city or municipality name. Matching is case-insensitive and uses the listing address, title, and verified property URL.", "default": "" }, "keyword": { "title": "Keyword", "type": "string", "description": "Optional free-text phrase such as a neighborhood, condominium, or property identifier.", "default": "" }, "propertyTypes": { "title": "Property types", "maxItems": 10, "uniqueItems": true, "type": "array", "description": "Keep only selected property types when the source card or detail page exposes enough evidence.", "items": { "type": "string", "enum": [ "agencia", "apartamento", "area-industrial", "area-rural", "casa", "comercial", "galpao", "garagem", "terreno", "outros" ], "enumTitles": [ "Agency", "Apartment", "Industrial area", "Rural area", "House", "Commercial", "Warehouse", "Garage", "Land", "Other" ] }, "default": [] }, "banks": { "title": "Banks", "maxItems": 13, "uniqueItems": true, "type": "array", "description": "Keep listings associated with one or more supported seller banks. The source must expose the bank in the card, URL, or detail content.", "items": { "type": "string", "enum": [ "caixa", "banco-do-brasil", "brb", "inter", "santander", "bradesco", "embracon", "emgea", "assefaz", "itau", "porto", "reverts", "sicoob" ], "enumTitles": [ "Caixa Econômica Federal", "Banco do Brasil", "Banco BRB", "Banco Inter", "Santander", "Bradesco", "Embracon", "Emgea", "Fundação Assefaz", "Itaú", "Porto Seguro", "Reverts", "Sicoob" ] }, "default": [] }, "saleTypes": { "title": "Sale modalities", "maxItems": 9, "uniqueItems": true, "type": "array", "description": "Filter by the public sale or auction modality shown by the source.", "items": { "type": "string", "enum": [ "compra-direta", "leilao-sfi-caixa", "licitacao-aberta-caixa", "venda-online", "comprei-pgfn", "extrajudicial", "judicial", "particular", "venda-direta" ], "enumTitles": [ "Direct purchase", "Caixa SFI auction", "Caixa open bid", "Online sale", "Comprei PGFN", "Extrajudicial", "Judicial", "Private sale", "Direct sale" ] }, "default": [] }, "paymentMethods": { "title": "Payment methods", "maxItems": 3, "uniqueItems": true, "type": "array", "description": "Keep listings whose source category or enriched detail evidence matches the selected payment method. Enable detail enrichment to receive acceptance flags.", "items": { "type": "string", "enum": [ "fgts", "financiamento", "parcelamento" ], "enumTitles": [ "FGTS", "Financing", "Installments" ] }, "default": [] }, "minPrice": { "title": "Minimum price (BRL)", "minimum": 0, "maximum": 100000000000, "type": "number", "description": "Minimum current or opening bid price in Brazilian reais. Set 0 for no minimum.", "default": 0 }, "maxPrice": { "title": "Maximum price (BRL)", "minimum": 0, "maximum": 100000000000, "type": "number", "description": "Maximum current or opening bid price in Brazilian reais. Set 0 for no maximum.", "default": 0 }, "minDiscount": { "title": "Minimum discount (%)", "minimum": 0, "maximum": 100, "type": "number", "description": "Minimum published discount percentage. Set 0 for no minimum.", "default": 0 }, "maxDiscount": { "title": "Maximum discount (%)", "minimum": 0, "maximum": 100, "type": "number", "description": "Maximum published discount percentage. Set 100 for no maximum.", "default": 100 }, "sortBy": { "title": "Sort order", "enum": [ "default", "newest", "ending-soon", "price-asc", "price-desc", "discount-desc" ], "type": "string", "description": "Sort the extracted card results before applying the item limit.", "default": "default" }, "includeDetails": { "title": "Fetch property details", "type": "boolean", "description": "When enabled, visit up to the detail-page limit for description, area, rooms, documents, legal notes, auctioneer, and payment evidence. Detail enrichment is optional and billed separately; verified card fields remain available when detail pages are challenged.", "default": false }, "maxDetailPages": { "title": "Max detail pages", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of property pages to request after list-card discovery. This cap protects runtime and source load.", "default": 25 }, "enableChangeDetection": { "title": "Track changes between runs", "type": "boolean", "description": "Persist a compact snapshot keyed by record_id and mark each row new, changed, or unchanged when price, discount, or closing date changes.", "default": true }, "changeFilter": { "title": "Change filter", "enum": [ "all", "new", "changed", "unchanged" ], "type": "string", "description": "Choose which monitoring states to emit. Selecting new, changed, or unchanged automatically keeps change tracking enabled.", "default": "all" }, "maxItems": { "title": "Max listings", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of listing records to emit. The limit is applied before optional detail enrichment and is bounded to protect source load.", "default": 25 }, "maxPages": { "title": "Max list pages", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of list/search pages to process across the run.", "default": 3 }, "maxConcurrency": { "title": "HTTP concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Number of simultaneous HTTP requests. Lower values are gentler on the public source and are recommended when detail enrichment is enabled.", "default": 3 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional Apify Proxy settings. Datacenter rotation is enabled by default in Apify Cloud when available; use a more capable proxy only when your account and use case support it.", "default": { "useApifyProxy": 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 } } } } } } } } } }