{ "openapi": "3.0.1", "info": { "title": "Bradesco Imóveis: Brazil Property Auction Scraper", "description": "Scrape Bradesco Imóveis (Vitrine Bradesco) property auctions in Brazil. Filter leilão de imóveis by state, city, property type, auction house, price, discount, and auction date. Export auction stages, prices, images, due-diligence signals, and links for research, lead generation, and automation.", "version": "1.0", "x-build-id": "i0B9ng6PvKudpJ5hH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/getascraper~bradesco-imoveis-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-getascraper-bradesco-imoveis-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~bradesco-imoveis-scraper/runs": { "post": { "operationId": "runs-sync-getascraper-bradesco-imoveis-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~bradesco-imoveis-scraper/run-sync": { "post": { "operationId": "run-sync-getascraper-bradesco-imoveis-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 Vitrine Bradesco auction or public API listing URLs. These URLs provide the source query, while the filters below can refine it.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "states": { "title": "States", "type": "array", "description": "Brazilian state abbreviations to include, such as SP or RJ. Leave empty to search all states.", "default": [ "SP" ], "items": { "type": "string" } }, "city": { "title": "City", "type": "string", "description": "Exact city name to keep after the API response is received. Use City ID when you know the source identifier.", "default": "" }, "cityId": { "title": "City ID", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Vitrine Bradesco city identifier. This takes priority over City and is sent directly to the source service." }, "neighborhood": { "title": "Neighborhood", "type": "string", "description": "Exact neighborhood name to keep in the output.", "default": "" }, "searchTerm": { "title": "Search term", "type": "string", "description": "Search across listing title, legal description, city, and neighborhood.", "default": "" }, "propertyCategory": { "title": "Property category", "type": "string", "description": "Property category, for example Casa, Apartamento, Terreno, or Sítio. The actor resolves recognized names to the source category ID and verifies the returned name.", "default": "" }, "auctionType": { "title": "Auction type", "type": "string", "description": "Auction modality returned by the source, such as alienacao-fiduciaria or convencional.", "default": "" }, "auctioneer": { "title": "Auctioneer crawl token", "type": "string", "description": "Source auctioneer token, such as zukerman_leiloes. Use the auctioneer directory to discover current tokens.", "default": "" }, "onlyWithoutDebts": { "title": "Only listings without debts", "type": "boolean", "description": "Keep only listings marked by the source as having no debts.", "default": false }, "onlyWithVisitAllowed": { "title": "Only listings with visits allowed", "type": "boolean", "description": "Keep only listings marked by the source as allowing visits.", "default": false }, "onlyWithLegalActions": { "title": "Only listings with legal actions", "type": "boolean", "description": "Keep only listings returned by the source legal-actions filter.", "default": false }, "minPriceBrl": { "title": "Minimum effective price", "minimum": 0, "maximum": 1000000000, "type": "number", "description": "Minimum effective auction value in Brazilian reais. The actor checks final value, second-stage value, first-stage value, then listed price." }, "maxPriceBrl": { "title": "Maximum effective price", "minimum": 0, "maximum": 1000000000, "type": "number", "description": "Maximum effective auction value in Brazilian reais. Listings without a usable auction value do not pass a numeric price filter." }, "minDiscountPercent": { "title": "Minimum discount from first bid", "minimum": 0, "maximum": 100, "type": "number", "description": "Minimum percentage reduction from the first auction value to the final or second-stage value." }, "auctionEndBefore": { "title": "Auction end before", "type": "string", "description": "Keep listings whose latest available auction date is on or before this date." }, "includeDetails": { "title": "Enrich with detail records", "type": "boolean", "description": "Fetch the source detail record for each returned listing to add the external auction URL, address, update time, and online location.", "default": true }, "includeDescription": { "title": "Include legal description", "type": "boolean", "description": "Include the full source description, including area, registry, occupancy, and legal notes when provided.", "default": true }, "includeImages": { "title": "Include property images", "type": "boolean", "description": "Include all source image URLs and the primary image URL.", "default": true }, "includeAuctioneer": { "title": "Include auctioneer details", "type": "boolean", "description": "Include auctioneer identity, website, logo, owner name, crawl token, and synchronization status.", "default": true }, "includeRawSource": { "title": "Include raw source object", "type": "boolean", "description": "Add the merged source and detail object for pipelines that need fields beyond the normalized dataset contract.", "default": false }, "maxItems": { "title": "Maximum listings", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Maximum final listing rows. Set to 0 only when you intentionally want all matching listings within the selected page limit.", "default": 10 }, "maxPages": { "title": "Maximum API pages", "minimum": 0, "maximum": 100, "type": "integer", "description": "Maximum listing pages to request. Each page contains up to 30 source records. Set to 0 only for an explicit unlimited crawl.", "default": 2 }, "requestDelayMs": { "title": "Delay between requests", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Delay between API page and detail requests in milliseconds. The public service exposes a finite request rate, so keep a small delay for repeated runs.", "default": 150 }, "maxRetries": { "title": "Retries per request", "minimum": 0, "maximum": 5, "type": "integer", "description": "Number of automatic retries for temporary API or connection failures.", "default": 3 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional Apify Proxy routing. Datacenter proxy is enabled by default and can be disabled for this public API.", "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 } } } } } } } } } }