{
  "openapi": "3.0.1",
  "info": {
    "title": "Quinto Andar API",
    "description": "Quinto Andar API: extraia dados detalhados de imóveis no Brasil utilizando esse scraper do Quinto Andar, incluindo tipo, localização, preço e descrição.\nIdeal para análise de mercado e buscas imobiliárias. Automatize a coleta de informações do Quinto Andar com eficiência.",
    "version": "0.0",
    "x-build-id": "ZHZeSgFjesTMNgwHH"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/brasil-scrapers~quinto-andar-api/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-brasil-scrapers-quinto-andar-api",
        "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/brasil-scrapers~quinto-andar-api/runs": {
      "post": {
        "operationId": "runs-sync-brasil-scrapers-quinto-andar-api",
        "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/brasil-scrapers~quinto-andar-api/run-sync": {
      "post": {
        "operationId": "run-sync-brasil-scrapers-quinto-andar-api",
        "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",
        "required": [
          "location",
          "searchType"
        ],
        "properties": {
          "location": {
            "title": "Location",
            "type": "string",
            "description": "Locations to search for properties. Acceptable values. Must be one of the two options: \n - URLs of the search made on Quinto Andar website. (Example: https://www.quintoandar.com.br/alugar/imovel/sao-paulo-sp-brasil) \n - City name. Available cities: `São Paulo`, `Rio de Janeiro`, `Belo Horizonte`, `Porto Alegre`, `Brasília`, `Curitiba`, `Goiania`, `Campinas`, `Canoas`, `Guarulhos`, `Jundiaí`, `Nova Lima`, `Novo Hamburgo`, `Niterói`, `Osasco`, `Santo André`, `São Bernardo do Campo`, `São Caetano do Sul`, `Barueri`, `São Leopoldo`, `Florianópolis`, `São José`, `Contagem`, `Taboão da Serra`, `Diadema`, `São José dos Pinhais`, `Várzea Paulista`, `Pinhais`, `Santana de Parnaíba`, `Santos`, `Recife`, `Salvador`, `Mogi das Cruzes`, `São José dos Campos`, `Cotia`, `Ribeirão Preto`, `Sorocaba`, `São José do Rio Preto`, `Uberlândia`, `Vinhedo`, `Indaiatuba`, `Nova Iguaçu`, `Americana`, `Hortolândia`, `Paulínia`, `Praia Grande`, `Guarujá`, `Carapicuíba`, `Votorantim`, `São Vicente`, `Duque de Caxias`, `São Gonçalo`, `Betim`, `Aparecida de Goiânia`, `Suzano`, `Itaquaquecetuba`, `Sumaré`, `Embu das Artes`, `Ferraz de Vasconcelos`, `Poá`, `Gravataí`, `Viamão`, `Alvorada`, `Jaboatão dos Guararapes`, `Belford Roxo`, `Nilópolis`, `Mesquita`, `Taubaté`, `Jacareí`, `Ribeirão das Neves`, `Ribeirão Pires`, `Brumadinho`, `Itabirito`, `Lagoa Santa`, `Sabará`, `Vespasiano`, `Fortaleza`, `Manaus`, `Belém`"
          },
          "searchType": {
            "title": "Search Type",
            "enum": [
              "rent",
              "buy"
            ],
            "type": "string",
            "description": "Type of search to be performed, rent or buy. The default value is rent.",
            "default": "rent"
          },
          "maxItems": {
            "title": "Maximum number of properties",
            "type": "integer",
            "description": "Maximum number of properties to scrape data. The default value is 5. If the URL provided doesn't have the total requested, everything will be returned.",
            "default": 5
          },
          "maxConcurrency": {
            "title": "Maximum concurrency",
            "type": "integer",
            "description": "Maximum number of concurrent requests that can be made at a time. The default value is 5.",
            "default": 5
          },
          "apartments": {
            "title": "Apartments",
            "type": "boolean",
            "description": "Search for apartments",
            "default": true
          },
          "houses": {
            "title": "Houses",
            "type": "boolean",
            "description": "Search for houses",
            "default": true
          },
          "condominiumHouses": {
            "title": "Condominium houses",
            "type": "boolean",
            "description": "Search for condominium houses",
            "default": true
          },
          "studioApartments": {
            "title": "Studio Apartment",
            "type": "boolean",
            "description": "Search for studio apartments",
            "default": true
          },
          "minArea": {
            "title": "Minimum area (m²)",
            "type": "integer",
            "description": "Minimum property area in square meters. Default limit is 20 m² if not specified."
          },
          "maxArea": {
            "title": "Maximum area (m²)",
            "type": "integer",
            "description": "Maximum property area in square meters. Default limit is 10000 m² if not specified."
          },
          "minPrice": {
            "title": "Minimum price (R$)",
            "type": "integer",
            "description": "Minimum property price in Brazilian Reais. For rent: monthly rent amount. For buy: total sale price."
          },
          "maxPrice": {
            "title": "Maximum price (R$)",
            "type": "integer",
            "description": "Maximum property price in Brazilian Reais. For rent: monthly rent amount. For buy: total sale price."
          },
          "rentValueType": {
            "title": "Rent value type",
            "enum": [
              "total",
              "rentOnly"
            ],
            "type": "string",
            "description": "Type of rent value to filter. 'total' includes rent + condominium + IPTU. 'rentOnly' filters only by base rent value. Only applies when searchType is 'rent'.",
            "default": "total"
          },
          "minCondoPrice": {
            "title": "Minimum condominium fee (R$)",
            "type": "integer",
            "description": "Minimum condominium fee + IPTU in Brazilian Reais. Default limit is 0 if not specified. Only applies when searchType is 'buy'."
          },
          "maxCondoPrice": {
            "title": "Maximum condominium fee (R$)",
            "type": "integer",
            "description": "Maximum condominium fee + IPTU in Brazilian Reais. Default limit is 15000 if not specified. Only applies when searchType is 'buy'."
          },
          "minBedrooms": {
            "title": "Minimum bedrooms",
            "minimum": 1,
            "type": "integer",
            "description": "Minimum number of bedrooms (1+ means 1 or more, 2+ means 2 or more, etc.)."
          },
          "minBathrooms": {
            "title": "Minimum bathrooms",
            "minimum": 1,
            "maximum": 4,
            "type": "integer",
            "description": "Minimum number of bathrooms (range from 1 to 4)."
          },
          "minGarages": {
            "title": "Minimum parking spaces",
            "minimum": 1,
            "maximum": 3,
            "type": "integer",
            "description": "Minimum number of parking/garage spaces (range from 1 to 3)."
          },
          "minSuits": {
            "title": "Minimum suites",
            "minimum": 1,
            "type": "integer",
            "description": "Minimum number of suites/master bedrooms (1+ means 1 or more, etc.)."
          },
          "furnished": {
            "title": "Furnished",
            "enum": [
              "both",
              "furnished",
              "unfurnished"
            ],
            "type": "string",
            "description": "Filter by furnished status. 'furnished' = only furnished, 'unfurnished' = only unfurnished, 'both' = no filter.",
            "default": "both"
          },
          "closeToSubway": {
            "title": "Close to subway",
            "enum": [
              "both",
              "yes",
              "no"
            ],
            "type": "string",
            "description": "Filter properties close to subway/metro stations. 'yes' = only near subway, 'no' = not near subway, 'both' = no filter.",
            "default": "both"
          },
          "acceptPets": {
            "title": "Accepts pets",
            "enum": [
              "both",
              "yes",
              "no"
            ],
            "type": "string",
            "description": "Filter by pet acceptance. 'yes' = only pet-friendly, 'no' = no pets allowed, 'both' = no filter. Only applies when searchType is 'rent'.",
            "default": "both"
          },
          "availability": {
            "title": "Availability",
            "enum": [
              "both",
              "available",
              "soon"
            ],
            "type": "string",
            "description": "Filter by property availability. 'available' = immediately available, 'soon' = available soon, 'both' = no filter. Only applies when searchType is 'rent'.",
            "default": "both"
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}