{
  "openapi": "3.0.1",
  "info": {
    "title": "QuintoAndar Scraper - Brazil Real Estate Listings & API",
    "description": "Scrape QuintoAndar Brazil property listings for rent and sale. Export price, rent, condominio, IPTU, area, bedrooms, amenities, photos and geo as JSON, CSV or Excel. Filter by city, neighborhood, type, price, area, bedrooms, furnished and pets. Fast HTTP data API, no login.",
    "version": "0.1",
    "x-build-id": "Ns2jGGdDm2hltQpMP"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrapers_lat~quintoandar-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrapers_lat-quintoandar-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/scrapers_lat~quintoandar-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scrapers_lat-quintoandar-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/scrapers_lat~quintoandar-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scrapers_lat-quintoandar-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",
        "required": [
          "operation"
        ],
        "properties": {
          "city": {
            "title": "City",
            "enum": [
              "sao-paulo-sp-brasil",
              "rio-de-janeiro-rj-brasil",
              "belo-horizonte-mg-brasil",
              "curitiba-pr-brasil",
              "porto-alegre-rs-brasil",
              "brasilia-df-brasil",
              "campinas-sp-brasil",
              "recife-pe-brasil",
              "guarulhos-sp-brasil",
              "santo-andre-sp-brasil",
              "sao-bernardo-do-campo-sp-brasil",
              "osasco-sp-brasil",
              "niteroi-rj-brasil"
            ],
            "type": "string",
            "description": "Brazilian city to search. QuintoAndar coverage is concentrated in these markets. Ignored when Start URLs are provided.",
            "default": "sao-paulo-sp-brasil"
          },
          "operation": {
            "title": "Operation",
            "enum": [
              "sale",
              "rent"
            ],
            "type": "string",
            "description": "Listing type: sale (comprar) or rent (alugar). Ignored for a Start URL that already encodes the operation.",
            "default": "sale"
          },
          "startUrls": {
            "title": "Start URLs (optional)",
            "type": "array",
            "description": "Paste one or more QuintoAndar search/result URLs (for example https://www.quintoandar.com.br/alugar/imovel/sao-paulo-sp-brasil). The city slug and operation are read from each URL, overriding the City and Operation fields above.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "propertyTypes": {
            "title": "Property types",
            "type": "array",
            "description": "Restrict to these property types. Leave empty for all types.",
            "items": {
              "type": "string",
              "enum": [
                "Apartamento",
                "Casa",
                "CasaCondominio",
                "StudioOuKitchenette"
              ],
              "enumTitles": [
                "Apartment",
                "House",
                "House in condo",
                "Studio / kitchenette"
              ]
            },
            "default": []
          },
          "neighborhood": {
            "title": "Neighborhood contains",
            "type": "string",
            "description": "Keep only listings whose neighborhood or region contains this text (accent and case insensitive). Optional."
          },
          "maxListings": {
            "title": "Max listings",
            "minimum": 1,
            "maximum": 1000000,
            "type": "integer",
            "description": "Maximum number of listings to collect across all searches. The source caps deep pagination near 1000 listings per query. Leave blank for as many as the source allows."
          },
          "minBedrooms": {
            "title": "Minimum bedrooms",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "Only return listings with at least this many bedrooms."
          },
          "minBathrooms": {
            "title": "Minimum bathrooms",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "Only return listings with at least this many bathrooms."
          },
          "minParkingSpaces": {
            "title": "Minimum parking spaces",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "Only return listings with at least this many parking spaces."
          },
          "minSuites": {
            "title": "Minimum suites",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "Only return listings with at least this many en-suite bedrooms."
          },
          "minPrice": {
            "title": "Minimum price (BRL)",
            "minimum": 0,
            "type": "integer",
            "description": "Minimum price. Compared against sale price for sale, against total monthly cost for rent."
          },
          "maxPrice": {
            "title": "Maximum price (BRL)",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum price. Compared against sale price for sale, against total monthly cost for rent."
          },
          "minArea": {
            "title": "Minimum area (m2)",
            "minimum": 0,
            "type": "integer",
            "description": "Only return listings with at least this usable area in square meters."
          },
          "maxArea": {
            "title": "Maximum area (m2)",
            "minimum": 0,
            "type": "integer",
            "description": "Only return listings with at most this usable area in square meters."
          },
          "furnished": {
            "title": "Furnished",
            "enum": [
              "any",
              "furnished",
              "unfurnished"
            ],
            "type": "string",
            "description": "Filter by furnishing. Any, only furnished, or only unfurnished.",
            "default": "any"
          },
          "petsAllowedOnly": {
            "title": "Pets allowed only",
            "type": "boolean",
            "description": "Only return listings that allow pets.",
            "default": false
          },
          "nearSubwayOnly": {
            "title": "Near subway/train only",
            "type": "boolean",
            "description": "Only return listings close to a subway or train station.",
            "default": false
          },
          "amenities": {
            "title": "Unit amenities",
            "type": "array",
            "description": "Require these unit amenity codes, for example AR_CONDICIONADO, VARANDA, MOBILIADO. See the README for the full code list.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "condoAmenities": {
            "title": "Building amenities",
            "type": "array",
            "description": "Require these building amenity codes, for example PISCINA, ACADEMIA, SALAO_DE_FESTAS, PERTO_DE_METRO_OU_TREM. See the README for the full code list.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Optional. The actor runs fine on Apify without a proxy. A Brazilian residential proxy is used automatically as a fallback if the direct connection is blocked.",
            "default": {}
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}