{ "openapi": "3.0.1", "info": { "title": "QuintoAndar Scraper", "description": "Scrape property listings from QuintoAndar (quintoandar.com.br). Apartments, houses, condos for rent or sale. Filter by city, price, bedrooms, bathrooms, area. Extracts prices, addresses, amenities, photos. Ideal for real estate market research in Brazil.", "version": "0.0", "x-build-id": "XaBrHkiXcN5TQFdPK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/gio21~quintoandar-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-gio21-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/gio21~quintoandar-scraper/runs": { "post": { "operationId": "runs-sync-gio21-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/gio21~quintoandar-scraper/run-sync": { "post": { "operationId": "run-sync-gio21-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": [ "location" ], "properties": { "location": { "title": "Location", "type": "string", "description": "City name (e.g. 'São Paulo') or a Quinto Andar search URL (e.g. https://www.quintoandar.com.br/alugar/imovel/sao-paulo-sp-brasil)" }, "searchType": { "title": "Search Type", "enum": [ "rent", "buy" ], "type": "string", "description": "Search for rental or sale properties", "default": "rent" }, "maxItems": { "title": "Maximum Properties", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of properties to scrape. Each scraped property costs $0.001.", "default": 100 }, "apartments": { "title": "Include Apartments", "type": "boolean", "description": "Include apartment listings", "default": true }, "houses": { "title": "Include Houses", "type": "boolean", "description": "Include house listings", "default": true }, "condominiumHouses": { "title": "Include Condominium Houses", "type": "boolean", "description": "Include condominium house listings", "default": true }, "studioApartments": { "title": "Include Studio Apartments", "type": "boolean", "description": "Include studio apartment listings", "default": true }, "minArea": { "title": "Minimum Area (m²)", "type": "integer", "description": "Minimum property area in square meters. Defaults to 20 m² if not specified." }, "maxArea": { "title": "Maximum Area (m²)", "type": "integer", "description": "Maximum property area in square meters. Defaults to 10,000 m² if not specified." }, "minPrice": { "title": "Minimum Price (R$)", "type": "integer", "description": "Minimum price in Brazilian Reais. For rent: monthly amount. For buy: total sale price." }, "maxPrice": { "title": "Maximum Price (R$)", "type": "integer", "description": "Maximum price in Brazilian Reais. For rent: monthly amount. For buy: total sale price." }, "rentValueType": { "title": "Rent Value Type", "enum": [ "total", "rentOnly" ], "type": "string", "description": "Type of rent value to filter. Only applies for rent searches.", "default": "total" }, "minCondoPrice": { "title": "Minimum Condo Fee (R$)", "type": "integer", "description": "Minimum condominium fee + IPTU. Only applies for buy searches." }, "maxCondoPrice": { "title": "Maximum Condo Fee (R$)", "type": "integer", "description": "Maximum condominium fee + IPTU. Only applies for buy searches." }, "minBedrooms": { "title": "Minimum Bedrooms", "type": "integer", "description": "Minimum number of bedrooms. Setting to 2 means 2+ bedrooms, etc." }, "minBathrooms": { "title": "Minimum Bathrooms", "type": "integer", "description": "Minimum number of bathrooms (1 to 4)." }, "minGarages": { "title": "Minimum Parking Spaces", "type": "integer", "description": "Minimum number of parking spaces." }, "minSuits": { "title": "Minimum Suites", "type": "integer", "description": "Minimum number of suites." }, "furnished": { "title": "Furnished", "enum": [ "", "yes", "no" ], "type": "string", "description": "Filter by furnished status. Leave empty for both." }, "closeToSubway": { "title": "Close to Subway", "enum": [ "", "yes", "no" ], "type": "string", "description": "Filter by proximity to subway stations." }, "acceptPets": { "title": "Accepts Pets", "enum": [ "", "yes", "no" ], "type": "string", "description": "Filter by pet policy." }, "availability": { "title": "Availability", "enum": [ "", "available", "unavailable" ], "type": "string", "description": "Filter by availability status." } } }, "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 } } } } } } } } } }