{
  "openapi": "3.0.1",
  "info": {
    "title": "Caixa Imóveis & Leilões Scraper: Brazil Property Auctions",
    "description": "Caixa imóveis and leilões scraper: every property Caixa Econômica Federal sells in Brazil, from venda direta to leilão SFI. Minimum price, appraisal, discount, auction dates, FGTS and financing, matrícula and edital PDFs, photos. Filter by state, city, mode and discount; daily alerts.",
    "version": "0.1",
    "x-build-id": "r9THLpeQLjS1zhmMb"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/automatic~caixa-imoveis-leiloes-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-automatic-caixa-imoveis-leiloes-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/automatic~caixa-imoveis-leiloes-scraper/runs": {
      "post": {
        "operationId": "runs-sync-automatic-caixa-imoveis-leiloes-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/automatic~caixa-imoveis-leiloes-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-automatic-caixa-imoveis-leiloes-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": {
          "states": {
            "title": "States (UF)",
            "type": "array",
            "description": "States to search, e.g. SP and RJ. Leave empty for all 27 states.",
            "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": [
                "AC - Acre",
                "AL - Alagoas",
                "AM - Amazonas",
                "AP - Amapá",
                "BA - Bahia",
                "CE - Ceará",
                "DF - Distrito Federal",
                "ES - Espírito Santo",
                "GO - Goiás",
                "MA - Maranhão",
                "MG - Minas Gerais",
                "MS - Mato Grosso do Sul",
                "MT - Mato Grosso",
                "PA - Pará",
                "PB - Paraíba",
                "PE - Pernambuco",
                "PI - Piauí",
                "PR - Paraná",
                "RJ - Rio de Janeiro",
                "RN - Rio Grande do Norte",
                "RO - Rondônia",
                "RR - Roraima",
                "RS - Rio Grande do Sul",
                "SC - Santa Catarina",
                "SE - Sergipe",
                "SP - São Paulo",
                "TO - Tocantins"
              ]
            }
          },
          "cities": {
            "title": "Cities",
            "type": "array",
            "description": "Optional city names, written as you would say them: 'São Paulo', 'Rio de Janeiro', 'Goiânia'. Accents, capitals and hyphens do not matter. Select the city's state above, or leave States empty. Leave empty for every city of the chosen states.",
            "items": {
              "type": "string"
            }
          },
          "neighborhoods": {
            "title": "Neighborhoods (bairros)",
            "type": "array",
            "description": "Optional neighborhood names, e.g. 'Campo Grande' or 'Copacabana'. Use together with a city.",
            "items": {
              "type": "string"
            }
          },
          "saleModes": {
            "title": "Sale modes",
            "type": "array",
            "description": "Which ways of selling to include. Leave empty for all of them.",
            "items": {
              "type": "string",
              "enum": [
                "venda_direta_online",
                "venda_online",
                "licitacao_aberta",
                "leilao_sfi"
              ],
              "enumTitles": [
                "Venda Direta Online (buy now at the listed price)",
                "Venda Online (online bidding)",
                "Licitação Aberta (open tender)",
                "Leilão SFI (auction, 1st and 2nd round)"
              ]
            }
          },
          "propertyTypes": {
            "title": "Property types",
            "type": "array",
            "description": "Which property types to include. Leave empty for all of them.",
            "items": {
              "type": "string",
              "enum": [
                "apartamento",
                "casa",
                "sobrado",
                "terreno",
                "gleba",
                "imovel_rural",
                "predio",
                "comercial",
                "loja",
                "sala",
                "galpao",
                "outros"
              ],
              "enumTitles": [
                "Apartamento",
                "Casa",
                "Sobrado",
                "Terreno (land)",
                "Gleba (large plot)",
                "Imóvel rural",
                "Prédio (building)",
                "Comercial",
                "Loja (shop)",
                "Sala (office)",
                "Galpão (warehouse)",
                "Outros"
              ]
            }
          },
          "minPrice": {
            "title": "Minimum price (R$)",
            "minimum": 0,
            "type": "integer",
            "description": "Only properties whose minimum sale price is at least this, in reais."
          },
          "maxPrice": {
            "title": "Maximum price (R$)",
            "minimum": 0,
            "type": "integer",
            "description": "Only properties whose minimum sale price is at most this, in reais."
          },
          "minDiscount": {
            "title": "Minimum discount (%)",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Only properties priced at least this many percent below their appraisal value, e.g. 40."
          },
          "minBedrooms": {
            "title": "Minimum bedrooms",
            "minimum": 0,
            "maximum": 50,
            "type": "integer",
            "description": "Only properties with at least this many bedrooms (quartos)."
          },
          "financing": {
            "title": "Accepts financing",
            "enum": [
              "any",
              "yes",
              "no"
            ],
            "type": "string",
            "description": "Keep only properties Caixa will finance (yes), only cash sales (no), or both.",
            "default": "any"
          },
          "fgts": {
            "title": "Accepts FGTS",
            "enum": [
              "any",
              "yes",
              "no"
            ],
            "type": "string",
            "description": "Keep only properties where FGTS can be used (yes), where it cannot (no), or both. This filter reads each property page.",
            "default": "any"
          },
          "sortBy": {
            "title": "Order",
            "enum": [
              "list",
              "discount"
            ],
            "type": "string",
            "description": "Caixa's order (state by state, city by city), or the largest discount first. With 'largest discount first' and a maximum, you get the best deals of the chosen states, not the first ones; every chosen state's list is read before the property pages.",
            "default": "list"
          },
          "includeDetails": {
            "title": "Include property page details",
            "type": "boolean",
            "description": "Add auction dates, 1st and 2nd auction prices, edital, matrícula and photos, FGTS, payment and expense rules, registry office and the full address with CEP. Turn off for a faster price-list run.",
            "default": true
          },
          "maxResults": {
            "title": "Maximum properties",
            "minimum": 1,
            "maximum": 50000,
            "type": "integer",
            "description": "Stop after this many properties. Caixa lists about 24,000 nationwide.",
            "default": 50
          },
          "onlyNewSinceLastRun": {
            "title": "Only new or changed since the last run",
            "type": "boolean",
            "description": "Deliver only properties this feed has not delivered before, plus the ones whose price, discount, sale mode or financing changed, with changeType set to new or changed. The history is kept in a named key-value store in your account, so a daily schedule becomes an alert feed.",
            "default": false
          },
          "reportRemoved": {
            "title": "Also report sold or withdrawn properties",
            "type": "boolean",
            "description": "With 'Only new or changed' on: when a property this feed delivered disappears from Caixa's list (sold, withdrawn or moved to another sale), deliver it once more with changeType 'removed', its last-known details and removedAt. Each removed row counts as one property.",
            "default": false
          },
          "monitoringKey": {
            "title": "Monitoring key",
            "type": "string",
            "description": "Optional name for the saved history, up to 64 characters, e.g. 'sp-apartamentos'. Use a different key for each feed with different filters."
          },
          "proxyConfiguration": {
            "title": "Connection",
            "type": "object",
            "description": "Leave empty: the Actor chooses its connection itself."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}