{
  "openapi": "3.0.1",
  "info": {
    "title": "Leilão Imóvel Scraper - Brazil Property Auctions",
    "description": "[💰 $2.5 / 1K] Extract Brazilian real-estate auction listings from leilaoimovel.com.br — price, appraisal value, discount %, modalities, closing date, location, and URL. Filter by state, city, property type, bank, sale type, payment, discount, and price, or paste search URLs.",
    "version": "1.0",
    "x-build-id": "1uD1biuYK484NL1RP"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/solidcode~leilaoimovel-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-solidcode-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/solidcode~leilaoimovel-scraper/runs": {
      "post": {
        "operationId": "runs-sync-solidcode-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/solidcode~leilaoimovel-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-solidcode-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": {
          "state": {
            "title": "State",
            "enum": [
              "any",
              "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": "Brazilian state (UF) to search. Choose 'Any' to cover the whole country. Ignored when Start URLs are provided.",
            "default": "any"
          },
          "city": {
            "title": "City",
            "type": "string",
            "description": "City to filter by (e.g. 'São Paulo' or 'Rio de Janeiro'). Matched against each listing's city after collection, so results are limited to that city. For a very rare city with few listings, the search may stop after scanning many pages without finding more. Leave empty to search the whole state. Ignored when Start URLs are provided."
          },
          "propertyType": {
            "title": "Property Type",
            "enum": [
              "any",
              "casa",
              "apartamento",
              "terreno",
              "area-rural",
              "comercial",
              "garagem",
              "area-industrial",
              "galpao",
              "agencia",
              "outros"
            ],
            "type": "string",
            "description": "Filter by property category. Choose 'Any' to include all types.",
            "default": "any"
          },
          "bank": {
            "title": "Bank / Institution",
            "enum": [
              "any",
              "caixa",
              "banco-do-brasil",
              "banco-inter",
              "banco-brb",
              "santander",
              "emgea",
              "itau",
              "bradesco",
              "assefaz",
              "reverts"
            ],
            "type": "string",
            "description": "Filter by the selling bank or institution. Choose 'Any' to include all sellers.",
            "default": "any"
          },
          "saleType": {
            "title": "Sale Type",
            "uniqueItems": true,
            "type": "array",
            "description": "Only include listings offered under these sale types (auction modes). Leave empty to include all sale types.",
            "items": {
              "type": "string",
              "enum": [
                "compra-direta",
                "judicial",
                "extrajudicial",
                "particular",
                "venda-online",
                "venda-direta",
                "licitacao-publica",
                "licitacao-aberta-caixa",
                "leilao-sfi-caixa",
                "comprei-pgfn",
                "outro"
              ],
              "enumTitles": [
                "Direct Purchase",
                "Judicial",
                "Extrajudicial",
                "Private",
                "Online Sale",
                "Direct Sale",
                "Public Bidding",
                "Caixa Open Bidding",
                "Caixa SFI Auction",
                "PGFN Purchase",
                "Other"
              ]
            },
            "default": []
          },
          "paymentMethod": {
            "title": "Payment Method",
            "uniqueItems": true,
            "type": "array",
            "description": "Only include listings that accept these payment methods. Leave empty to include all.",
            "items": {
              "type": "string",
              "enum": [
                "financiamento",
                "fgts"
              ],
              "enumTitles": [
                "Financing Accepted",
                "FGTS Accepted"
              ]
            },
            "default": []
          },
          "minDiscount": {
            "title": "Minimum Discount (%)",
            "minimum": 0,
            "maximum": 99,
            "type": "integer",
            "description": "Only include listings discounted at least this much below the appraisal value. 0 = no minimum.",
            "default": 0
          },
          "priceMin": {
            "title": "Minimum Price (R$)",
            "minimum": 0,
            "type": "integer",
            "description": "Only include listings with a minimum bid at or above this amount in Brazilian Reais. Leave empty for no minimum."
          },
          "priceMax": {
            "title": "Maximum Price (R$)",
            "minimum": 0,
            "type": "integer",
            "description": "Only include listings with a minimum bid at or below this amount in Brazilian Reais. Leave empty for no maximum."
          },
          "sortBy": {
            "title": "Sort By",
            "enum": [
              "default_order",
              "price_a",
              "price_d",
              "discount_a",
              "discount_d",
              "dt_insert_d",
              "dt_insert_a",
              "dt_auction_a",
              "dt_auction_d"
            ],
            "type": "string",
            "description": "Order in which listings are collected. 'Default' uses the site's standard order.",
            "default": "default_order"
          },
          "includeDetails": {
            "title": "Include Full Details (slower)",
            "type": "boolean",
            "description": "When enabled, each listing is enriched with extra fields from its own page — auctioneer, official notice (edital) PDF link, area in m², registration number (matrícula), county (comarca), and 1st/2nd auction round dates. This opens one extra page per listing, so runs take noticeably longer. Leave OFF (default) for the fastest, cheapest runs — the core fields (price, appraisal, discount, location, photo, modalities, closing date) are always collected either way.",
            "default": false
          },
          "startUrls": {
            "title": "Start URLs",
            "type": "array",
            "description": "Power-user input. Paste exact leilaoimovel.com.br search-result URLs or individual listing URLs. When provided, these override the State / City / Property Type / Filters settings above.",
            "items": {
              "type": "string"
            }
          },
          "maxResults": {
            "title": "Max Results",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum number of listings to collect across all searches and URLs. Set 0 for unlimited (up to 100,000 per run). Results are collected in full pages, so the final page may overshoot this cap by a few records.",
            "default": 100
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}