{ "openapi": "3.0.1", "info": { "title": "QuintoAndar Property Scraper", "description": "Scrape QuintoAndar property listings across 80+ Brazilian cities. Extract prices, rooms, area, amenities, location, and photos for sale and rent listings. Export JSON, CSV, Excel via API.", "version": "1.0", "x-build-id": "bJ4eY6w0da7JPAkkE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parsebird~quintoandar-property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parsebird-quintoandar-property-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/parsebird~quintoandar-property-scraper/runs": { "post": { "operationId": "runs-sync-parsebird-quintoandar-property-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/parsebird~quintoandar-property-scraper/run-sync": { "post": { "operationId": "run-sync-parsebird-quintoandar-property-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": [ "city" ], "properties": { "deal_type": { "title": "Deal type", "enum": [ "sale", "rent" ], "type": "string", "description": "Choose which market to collect from.", "default": "sale" }, "city": { "title": "City", "enum": [ "sao-paulo-sp-brasil", "rio-de-janeiro-rj-brasil", "belo-horizonte-mg-brasil", "porto-alegre-rs-brasil", "brasilia-df-brasil", "curitiba-pr-brasil", "goiania-go-brasil", "campinas-sp-brasil", "canoas-rs-brasil", "guarulhos-sp-brasil", "jundiai-sp-brasil", "nova-lima-mg-brasil", "novo-hamburgo-rs-brasil", "niteroi-rj-brasil", "osasco-sp-brasil", "santo-andre-sp-brasil", "sao-bernardo-do-campo-sp-brasil", "sao-caetano-do-sul-sp-brasil", "barueri-sp-brasil", "sao-leopoldo-rs-brasil", "florianopolis-sc-brasil", "sao-jose-sc-brasil", "palhoca-sc-brasil", "contagem-mg-brasil", "taboao-da-serra-sp-brasil", "diadema-sp-brasil", "sao-jose-dos-pinhais-pr-brasil", "varzea-paulista-sp-brasil", "pinhais-pr-brasil", "santana-de-parnaiba-sp-brasil", "santos-sp-brasil", "recife-pe-brasil", "salvador-ba-brasil", "mogi-das-cruzes-sp-brasil", "sao-jose-dos-campos-sp-brasil", "cotia-sp-brasil", "vitoria-es-brasil", "ribeirao-preto-sp-brasil", "sorocaba-sp-brasil", "sao-jose-do-rio-preto-sp-brasil", "uberlandia-mg-brasil", "maua-sp-brasil", "belem-pa-brasil", "fortaleza-ce-brasil", "manaus-am-brasil", "valinhos-sp-brasil", "vinhedo-sp-brasil", "indaiatuba-sp-brasil", "nova-iguacu-rj-brasil", "americana-sp-brasil", "hortolandia-sp-brasil", "paulinia-sp-brasil", "praia-grande-sp-brasil", "guaruja-sp-brasil", "carapicuiba-sp-brasil", "votorantim-sp-brasil", "sao-vicente-sp-brasil", "duque-de-caxias-rj-brasil", "sao-goncalo-rj-brasil", "vila-velha-es-brasil", "betim-mg-brasil", "aparecida-de-goiania-go-brasil", "suzano-sp-brasil", "itaquaquecetuba-sp-brasil", "sumare-sp-brasil", "embu-das-artes-sp-brasil", "ferraz-de-vasconcelos-sp-brasil", "poa-sp-brasil", "gravatai-rs-brasil", "viamao-rs-brasil", "alvorada-rs-brasil", "jaboatao-dos-guararapes-pe-brasil", "belford-roxo-rj-brasil", "nilopolis-rj-brasil", "mesquita-rj-brasil", "taubate-sp-brasil", "jacarei-sp-brasil", "ribeirao-das-neves-mg-brasil", "ribeirao-pires-sp-brasil", "brumadinho-mg-brasil", "itabirito-mg-brasil", "lagoa-santa-mg-brasil", "sabara-mg-brasil", "vespasiano-mg-brasil", "rio-acima-mg-brasil", "santa-luzia-mg-brasil", "marica-rj-brasil", "cabo-frio-rj-brasil" ], "type": "string", "description": "City to search on QuintoAndar." }, "neighborhood": { "title": "Neighborhood", "type": "string", "description": "Optional neighborhood name to narrow the search within the selected city, such as Pinheiros or Jardim Paulista.", "default": "" }, "sort_by": { "title": "Sort by", "enum": [ "closest", "most_relevant", "most_recent", "lowest_price", "highest_price" ], "type": "string", "description": "Controls result ordering before collection.", "default": "most_relevant" }, "property_type": { "title": "Property type", "type": "array", "description": "Property categories to include. Leave empty to include all supported property types.", "items": { "type": "string", "enum": [ "apartment", "house", "condominium", "studio" ], "enumTitles": [ "Apartment", "House", "Condominium (house in a gated community)", "Studio" ] }, "default": [] }, "min_bedroom": { "title": "Minimum bedrooms", "enum": [ "", "1", "2", "3", "4" ], "type": "string", "description": "Minimum bedroom count.", "default": "" }, "min_bathroom": { "title": "Minimum bathrooms", "enum": [ "", "1", "2", "3", "4" ], "type": "string", "description": "Minimum bathroom count.", "default": "" }, "min_parking": { "title": "Minimum parking spaces", "enum": [ "", "0", "1", "2", "3" ], "type": "string", "description": "Minimum parking spaces.", "default": "" }, "min_sqm": { "title": "Minimum area (m²)", "minimum": 1, "type": "integer", "description": "Minimum usable area in square meters." }, "max_sqm": { "title": "Maximum area (m²)", "minimum": 1, "type": "integer", "description": "Maximum usable area in square meters." }, "min_price": { "title": "Minimum price (BRL)", "minimum": 0, "type": "integer", "description": "Lowest price to include in the results." }, "max_price": { "title": "Maximum price (BRL)", "minimum": 0, "type": "integer", "description": "Highest price to include in the results." }, "furnished": { "title": "Furnishing", "enum": [ "all", "furnished", "unfurnished" ], "type": "string", "description": "Furnishing preference.", "default": "all" }, "pets_allowed": { "title": "Pet-friendly only", "type": "boolean", "description": "Keep only pet-friendly rental listings. Does not change sale searches.", "default": false }, "near_transit": { "title": "Near public transit only", "type": "boolean", "description": "Keep only listings marked as near public transit.", "default": false }, "amenities": { "title": "In-home amenities", "type": "array", "description": "In-home features to require.", "items": { "type": "string", "enum": [ "penthouse_apartment", "air_conditioning", "bathtub", "shower_enclosure", "barbecue_grill", "gas_shower", "walk_in_closet", "garden_private_outdoor_area", "new_or_renovated", "private_pool", "single_house_on_the_property", "laundry_sink", "television", "kitchen_utensils", "ceiling_fan" ], "enumTitles": [ "Penthouse apartment", "Air conditioning", "Bathtub", "Shower enclosure", "Barbecue grill", "Gas shower", "Walk-in closet", "Garden / private outdoor area", "New or renovated", "Private pool", "Single house on the property", "Laundry sink", "Television", "Kitchen utensils", "Ceiling fan" ] }, "default": [] }, "condo_amenities": { "title": "Building / condo amenities", "type": "array", "description": "Shared building features to require.", "items": { "type": "string", "enum": [ "gym", "green_area", "playroom", "barbecue_area", "elevator", "laundry_room", "swimming_pool", "playground", "24_hour_concierge", "sports_court", "party_room", "game_room", "sauna" ], "enumTitles": [ "Gym", "Green area", "Playroom", "Barbecue area", "Elevator", "Laundry room", "Swimming pool", "Playground", "24-hour concierge", "Sports court", "Party room", "Game room", "Sauna" ] }, "default": [] }, "limit": { "title": "Max listings", "minimum": 1, "type": "integer", "description": "Maximum number of listings to save. Leave empty to collect all matching results for the configured search." }, "maximize_coverage": { "title": "Maximize coverage", "type": "boolean", "description": "When enabled, broad searches aim to collect a more complete set of matching listings by combining several QuintoAndar result pages and sub-searches. Uses more requests.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional Apify Proxy configuration for collection reliability. QuintoAndar's public pages do not require a proxy, so this is disabled by default.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }