{ "openapi": "3.0.1", "info": { "title": "Leilo Brazil Property Auctions & Lots Scraper", "description": "Scrape Leilo.com.br property auctions in Brazil: lots, starting bids, addresses, areas, matricula and edital documents, closed results. Export CSV, Excel, JSON, XML.", "version": "0.1", "x-build-id": "hD4NoEPQvVYM0lAew" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/recordsdata~leilo-br-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-recordsdata-leilo-br-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/recordsdata~leilo-br-scraper/runs": { "post": { "operationId": "runs-sync-recordsdata-leilo-br-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/recordsdata~leilo-br-scraper/run-sync": { "post": { "operationId": "run-sync-recordsdata-leilo-br-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 leilo.com.br pages to read: a lot page (leilo.com.br/lote//), an auction event page (leilo.com.br/leilao/evento//) or a listing page such as leilo.com.br/leilao/goias/imoveis/. Leave empty to search the whole property catalog with the filters below. A state or city in a listing URL is applied as a filter.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "lotIds": { "title": "Lot IDs", "type": "array", "description": "Optional list of lot ids (the UUID in the lot URL, for example a7ce5921-b76b-11f1-97f6-02420a000006). These lots are fetched directly, whatever their status, and the search filters are not applied to them. An id that does not exist returns one free error row.", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Free users: Limited to 10 items (preview). Paid users: Optional, max 1,000,000" }, "recordTypes": { "title": "Record types", "type": "array", "description": "What to return. Lots: one row per property lot (price, address, areas, registry number, occupancy, photos, documents). Auctions: one row per auction (edital, house, dates, lot totals) built from the lots found. Sellers: one row per seller (comitente) with lot counts and value totals. Every row counts toward Max Items.", "items": { "type": "string", "enum": [ "lots", "auctions", "sellers" ], "enumTitles": [ "Lots (properties)", "Auctions (events)", "Sellers (comitentes)" ] }, "default": [ "lots" ] }, "lotScope": { "title": "Lot scope", "enum": [ "upcoming", "closed", "all" ], "type": "string", "description": "Upcoming and live lots (open for bids today), closed lots (results of past auctions: sold, unsold, awaiting payment, cancelled; reaches back to 2023), or both. Closed lots are charged as their own event.", "default": "upcoming" }, "fetchDetails": { "title": "Fetch full lot details", "type": "boolean", "description": "Open every lot record for the full description, photo gallery, edital and matricula documents, bid increment, commission, registry office and amenities. Billed as the lot-detail event. Turn off for a cheaper list-only pass.", "default": true }, "sortBy": { "title": "Sort by", "enum": [ "auctionDate", "auctionDateDesc", "priceAsc", "priceDesc", "recentlyUpdated" ], "type": "string", "description": "Order of the lots in the search. Auction date puts the soonest first.", "default": "auctionDate" }, "states": { "title": "States", "type": "array", "description": "Only lots in these Brazilian states. Leave empty for all states. The state comes from the lot title and description.", "items": { "type": "string", "enum": [ "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" ], "enumTitles": [ "Acre (AC)", "Alagoas (AL)", "Amapá (AP)", "Amazonas (AM)", "Bahia (BA)", "Ceará (CE)", "Distrito Federal (DF)", "Espírito Santo (ES)", "Goiás (GO)", "Maranhão (MA)", "Mato Grosso (MT)", "Mato Grosso do Sul (MS)", "Minas Gerais (MG)", "Pará (PA)", "Paraíba (PB)", "Paraná (PR)", "Pernambuco (PE)", "Piauí (PI)", "Rio de Janeiro (RJ)", "Rio Grande do Norte (RN)", "Rio Grande do Sul (RS)", "Rondônia (RO)", "Roraima (RR)", "Santa Catarina (SC)", "São Paulo (SP)", "Sergipe (SE)", "Tocantins (TO)" ] }, "default": [] }, "cities": { "title": "Cities", "type": "array", "description": "Only lots in these cities, for example Goiânia, Rio de Janeiro or Campinas/SP. Accents and capitals do not matter; add /UF to tell same-name cities apart.", "default": [], "items": { "type": "string" } }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Only these property types. Leave empty for all types.", "items": { "type": "string", "enum": [ "apartment", "house", "land", "farm", "commercial", "warehouse", "building", "other" ], "enumTitles": [ "Apartment", "House", "Land / lot", "Farm / rural", "Commercial unit", "Warehouse / industrial", "Building", "Other" ] }, "default": [] }, "minPrice": { "title": "Minimum starting price (BRL)", "minimum": 0, "type": "integer", "description": "Only lots whose current starting bid is at least this value, in Brazilian reais. 0 means no minimum.", "default": 0 }, "maxPrice": { "title": "Maximum starting price (BRL)", "minimum": 0, "type": "integer", "description": "Only lots whose current starting bid is at most this value, in Brazilian reais. 0 means no maximum.", "default": 0 }, "minArea": { "title": "Minimum area (m2)", "minimum": 0, "type": "integer", "description": "Only lots with at least this land or built area, in square meters. 0 means no minimum.", "default": 0 }, "maxArea": { "title": "Maximum area (m2)", "minimum": 0, "type": "integer", "description": "Only lots with at most this land or built area, in square meters. 0 means no maximum.", "default": 0 }, "occupancy": { "title": "Occupancy", "enum": [ "any", "vacant", "occupied" ], "type": "string", "description": "Vacant or occupied properties, read from the lot description. Occupied lots may need an eviction after the sale. This filter needs the lot description, so lots are opened for detail.", "default": "any" }, "sellers": { "title": "Sellers (comitentes)", "type": "array", "description": "Only lots from these sellers, matched on part of the seller name without accents or capitals, for example Banco, Caixa, Prefeitura or Tribunal.", "default": [], "items": { "type": "string" } }, "lotStatuses": { "title": "Lot statuses", "type": "array", "description": "Only lots in these statuses. Leave empty for all statuses of the chosen scope.", "items": { "type": "string", "enum": [ "open", "live", "sold", "awaiting-payment", "conditional", "unsold", "cancelled" ], "enumTitles": [ "Open for bids", "Live now", "Sold (paid)", "Sold, awaiting payment", "Conditional (seller to approve)", "Unsold", "Cancelled" ] }, "default": [] }, "auctionDateFrom": { "title": "Auction date from (YYYY-MM-DD)", "type": "string", "description": "Only lots whose bidding ends on or after this day (Brasilia time). Example: 2026-11-30. Leave empty for no start date.", "default": "" }, "auctionDateTo": { "title": "Auction date to (YYYY-MM-DD)", "type": "string", "description": "Only lots whose bidding ends on or before this day (Brasilia time). Leave empty for no end date.", "default": "" }, "searchText": { "title": "Search text", "type": "string", "description": "Keep only lots whose title, description, city or seller contains this text (accents and capitals do not matter), for example apartamento, rural or alienação fiduciária.", "default": "" }, "maxEditions": { "title": "Max past auction editions", "minimum": 1, "maximum": 200, "type": "integer", "description": "For closed lots: how many of the most recent past auction editions to read, newest first. Each edition holds a few dozen lots. About 80 editions exist back to 2023.", "default": 12 }, "maxRunSeconds": { "title": "Max run time (seconds)", "minimum": 30, "maximum": 7200, "type": "integer", "description": "Stop collecting after this many seconds and return what was gathered, so a large closed-lot history never runs unbounded.", "default": 600 }, "onlyNew": { "title": "Only new rows (monitor mode)", "type": "boolean", "description": "Only new rows: skip every lot, auction or seller this same search already returned in an earlier run, so a scheduled run returns just the new lots and you are not charged for skipped rows. Max Items then means N new rows. Off by default.", "default": false }, "stateKey": { "title": "Monitor name (optional)", "type": "string", "description": "Name of this monitor. Leave empty to derive it from your filters. Use a name to run two monitors with the same filters.", "default": "" }, "resetSeen": { "title": "Forget previously seen rows", "type": "boolean", "description": "Clear the saved list for this monitor before the run, so everything counts as new again.", "default": false }, "includeContactDetails": { "title": "Include auction house contact", "type": "boolean", "description": "Add the auction house public business phone, WhatsApp, e-mail and address (from the leilo.com.br home page) to lot, auction and seller rows. Business data only: no bidder or private-seller personal data is ever returned. Off by default.", "default": false } } }, "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 } } } } } } } } } }