{
  "openapi": "3.0.1",
  "info": {
    "title": "Leilão Judicial de Imóveis Scraper (Brasil)",
    "description": "Brazilian court (judicial) and bank (extrajudicial) property auctions: 1st and 2nd round dates and values, appraisal, discount, CNJ process number, court, vara, occupancy and IPTU/condominium debts. Leilões Judiciais, Leilão Imóvel, Portal Zuk, Grupo Lance, Frazão, Biasi.",
    "version": "0.1",
    "x-build-id": "UFbRdy0Tg2p2s1uK8"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/allanmxr~brazil-judicial-property-auctions/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-allanmxr-brazil-judicial-property-auctions",
        "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/allanmxr~brazil-judicial-property-auctions/runs": {
      "post": {
        "operationId": "runs-sync-allanmxr-brazil-judicial-property-auctions",
        "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/allanmxr~brazil-judicial-property-auctions/run-sync": {
      "post": {
        "operationId": "run-sync-allanmxr-brazil-judicial-property-auctions",
        "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": {
          "sources": {
            "title": "Sources",
            "minItems": 1,
            "uniqueItems": true,
            "type": "array",
            "description": "Auction portals to search. With more than one selected you get a single merged list and Max items is split evenly between them. Caixa, Mega Leilões and Superbid are in our Brazil Real Estate Auctions actor.",
            "items": {
              "type": "string",
              "enum": [
                "leiloesjudiciais",
                "leilaoimovel",
                "zuk",
                "grupolance",
                "frazao",
                "biasi"
              ],
              "enumTitles": [
                "Leilões Judiciais (network of court auctioneers, 1,800+ properties)",
                "Leilão Imóvel (aggregator: 75+ court auctioneers not covered by the other sources)",
                "Portal Zuk / Zukerman (TJSP and banks)",
                "Grupo Lance / Lance Judicial",
                "Frazão Leilões (banks and courts)",
                "Biasi Leilões (banks)"
              ]
            },
            "default": [
              "leiloesjudiciais",
              "leilaoimovel",
              "zuk",
              "grupolance",
              "frazao",
              "biasi"
            ]
          },
          "states": {
            "title": "States (UF)",
            "uniqueItems": true,
            "type": "array",
            "description": "Leave empty to search all of Brazil.",
            "items": {
              "type": "string",
              "enum": [
                "AC",
                "AL",
                "AM",
                "AP",
                "BA",
                "CE",
                "DF",
                "ES",
                "GO",
                "MA",
                "MG",
                "MS",
                "MT",
                "PA",
                "PB",
                "PE",
                "PI",
                "PR",
                "RJ",
                "RN",
                "RO",
                "RR",
                "RS",
                "SC",
                "SE",
                "SP",
                "TO"
              ],
              "enumTitles": [
                "Acre (AC)",
                "Alagoas (AL)",
                "Amazonas (AM)",
                "Amapá (AP)",
                "Bahia (BA)",
                "Ceará (CE)",
                "Distrito Federal (DF)",
                "Espírito Santo (ES)",
                "Goiás (GO)",
                "Maranhão (MA)",
                "Minas Gerais (MG)",
                "Mato Grosso do Sul (MS)",
                "Mato Grosso (MT)",
                "Pará (PA)",
                "Paraíba (PB)",
                "Pernambuco (PE)",
                "Piauí (PI)",
                "Paraná (PR)",
                "Rio de Janeiro (RJ)",
                "Rio Grande do Norte (RN)",
                "Rondônia (RO)",
                "Roraima (RR)",
                "Rio Grande do Sul (RS)",
                "Santa Catarina (SC)",
                "Sergipe (SE)",
                "São Paulo (SP)",
                "Tocantins (TO)"
              ]
            }
          },
          "cities": {
            "title": "Cities",
            "type": "array",
            "description": "City names, one per line, for example Campinas or São Paulo. Accents and capital letters do not matter. Needs at least one state selected above.",
            "items": {
              "type": "string"
            }
          },
          "auctionTypes": {
            "title": "Auction types",
            "uniqueItems": true,
            "type": "array",
            "description": "Judicial: court-ordered auctions (praças) with a process number. Extrajudicial: bank and fiduciary sales (Lei 9.514) and direct sales. Leave empty for both.",
            "items": {
              "type": "string",
              "enum": [
                "judicial",
                "extrajudicial"
              ],
              "enumTitles": [
                "Judicial auction (leilão judicial)",
                "Extrajudicial (banks, alienação fiduciária, venda direta)"
              ]
            }
          },
          "onlySecondRound": {
            "title": "Only lots in the 2nd round (2ª praça)",
            "type": "boolean",
            "description": "Keep only lots whose 1st round already closed without bids, where the minimum bid is usually 50% to 60% of the appraisal.",
            "default": false
          },
          "auctionDateFrom": {
            "title": "Auction on or after",
            "type": "string",
            "description": "Next auction round on or after this date."
          },
          "auctionDateTo": {
            "title": "Auction on or before",
            "type": "string",
            "description": "Next auction round on or before this date."
          },
          "propertyTypes": {
            "title": "Property types",
            "uniqueItems": true,
            "type": "array",
            "description": "Leave empty for all types.",
            "items": {
              "type": "string",
              "enum": [
                "apartment",
                "house",
                "land",
                "rural",
                "commercial",
                "parking",
                "other"
              ],
              "enumTitles": [
                "Apartment",
                "House",
                "Land / lot",
                "Rural",
                "Commercial",
                "Parking spot",
                "Other"
              ]
            }
          },
          "occupancy": {
            "title": "Occupancy",
            "uniqueItems": true,
            "type": "array",
            "description": "Vacant or occupied, as published by the portal. Add Unknown to keep the lots whose occupancy is not stated (common in court auctions).",
            "items": {
              "type": "string",
              "enum": [
                "vacant",
                "occupied",
                "unknown"
              ],
              "enumTitles": [
                "Vacant",
                "Occupied",
                "Unknown"
              ]
            }
          },
          "minDiscountPct": {
            "title": "Min discount over appraisal",
            "minimum": 0,
            "maximum": 100,
            "type": "number",
            "description": "Only lots whose current minimum bid is at least this much below the appraisal value, for example 40. Lots without a published appraisal are dropped when this is set."
          },
          "minPrice": {
            "title": "Min bid",
            "minimum": 0,
            "type": "integer",
            "description": "Lowest current minimum bid, in reais."
          },
          "maxPrice": {
            "title": "Max bid",
            "minimum": 0,
            "type": "integer",
            "description": "Highest current minimum bid, in reais."
          },
          "maxItems": {
            "title": "Max items",
            "minimum": 1,
            "type": "integer",
            "description": "Total lots across all portals, split evenly between them (best discount first in most portals, next auction first in Portal Zuk and Frazão). The run stops as soon as it is reached and you pay only for the lots delivered.",
            "default": 100
          },
          "proxyConfiguration": {
            "title": "Proxy configuration (optional)",
            "type": "object",
            "description": "Leave empty: the actor connects directly and only falls back to Apify Proxy when a portal blocks it. Set a proxy only to force your own."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}