{
  "openapi": "3.0.1",
  "info": {
    "title": "Leilão de Imóveis Caixa Scraper: Mega, Superbid",
    "description": "Brazilian property auction lots in one flat feed: appraisal value, minimum bid, discount, auction rounds, occupancy, FGTS and financing, edital, matrícula and photos. Covers Caixa repossessed homes, Superbid and Mega Leilões. Filter by state, city, discount and property type.",
    "version": "0.1",
    "x-build-id": "l9UPUgl5GNwbfTC7F"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/allanmxr~brazil-real-estate-auctions/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-allanmxr-brazil-real-estate-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-real-estate-auctions/runs": {
      "post": {
        "operationId": "runs-sync-allanmxr-brazil-real-estate-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-real-estate-auctions/run-sync": {
      "post": {
        "operationId": "run-sync-allanmxr-brazil-real-estate-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": "Portals to search. With more than one selected you get a single merged list and Max items is split evenly between them.",
            "items": {
              "type": "string",
              "enum": [
                "caixa",
                "superbid",
                "megaleiloes"
              ],
              "enumTitles": [
                "Caixa Econômica Federal (venda de imóveis)",
                "Superbid Imóveis",
                "Mega Leilões Imóveis"
              ]
            },
            "default": [
              "caixa",
              "superbid",
              "megaleiloes"
            ]
          },
          "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"
            }
          },
          "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 written in the lot description (Superbid and Mega Leilões). Caixa does not publish occupancy for any lot: choosing Vacant or Occupied without Unknown leaves every Caixa lot out. Add Unknown to keep the lots whose occupancy is not stated.",
            "items": {
              "type": "string",
              "enum": [
                "vacant",
                "occupied",
                "unknown"
              ],
              "enumTitles": [
                "Vacant",
                "Occupied",
                "Unknown"
              ]
            }
          },
          "minBedrooms": {
            "title": "Min bedrooms",
            "minimum": 0,
            "type": "integer",
            "description": "Lots that do not state bedrooms (land, commercial) are dropped when a bedroom filter is set."
          },
          "maxBedrooms": {
            "title": "Max bedrooms",
            "minimum": 0,
            "type": "integer",
            "description": "Highest number of bedrooms."
          },
          "minArea": {
            "title": "Min area",
            "minimum": 0,
            "type": "number",
            "description": "Built or private area of the property."
          },
          "maxArea": {
            "title": "Max area",
            "minimum": 0,
            "type": "number",
            "description": "Built or private area of the property."
          },
          "minDiscountPct": {
            "title": "Min discount over appraisal",
            "minimum": 0,
            "maximum": 100,
            "type": "number",
            "description": "Only lots whose minimum bid is at least this much below the appraisal value, for example 40."
          },
          "minPrice": {
            "title": "Min bid",
            "minimum": 0,
            "type": "integer",
            "description": "Lowest minimum bid, in reais."
          },
          "maxPrice": {
            "title": "Max bid",
            "minimum": 0,
            "type": "integer",
            "description": "Highest minimum bid, in reais."
          },
          "acceptsFinancing": {
            "title": "Only lots that accept financing",
            "type": "boolean",
            "description": "Keep only lots that state they accept bank financing.",
            "default": false
          },
          "acceptsFgts": {
            "title": "Only lots that accept FGTS",
            "type": "boolean",
            "description": "Keep only lots that state they accept FGTS. Caixa publishes this for every lot.",
            "default": false
          },
          "auctionTypes": {
            "title": "Sale types",
            "uniqueItems": true,
            "type": "array",
            "description": "Leave empty for all. Open bidding (licitação aberta) exists only on Caixa.",
            "items": {
              "type": "string",
              "enum": [
                "judicial",
                "extrajudicial",
                "directSale",
                "openBidding"
              ],
              "enumTitles": [
                "Judicial auction",
                "Extrajudicial auction (SFI, banks)",
                "Direct sale",
                "Open bidding (Caixa licitação)"
              ]
            }
          },
          "auctionDateFrom": {
            "title": "Auction on or after",
            "type": "string",
            "description": "Next auction round on or after this date. Direct sales have no auction date and are dropped when a date is set."
          },
          "auctionDateTo": {
            "title": "Auction on or before",
            "type": "string",
            "description": "Next auction round on or before this date."
          },
          "maxItems": {
            "title": "Max items",
            "minimum": 1,
            "type": "integer",
            "description": "Total lots across all portals, best discount first inside each portal. 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 already picks the cheapest connection that each portal accepts (Caixa needs Brazilian residential IPs, the others need no proxy). 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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}