{ "openapi": "3.0.1", "info": { "title": "VivaReal Scraper | Brazil Real Estate BRL Pricing", "description": "Scrape vivareal.com.br, Brazil's top property portal. Apartamentos, casas, coberturas & terrenos. FGTS/MCMV eligibility, CRECI license, IPTU+condomínio, quartos/suítes & bairro location.", "version": "0.0", "x-build-id": "Ykuy7uU69xm1khEVU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/haketa~vivareal-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-haketa-vivareal-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/haketa~vivareal-scraper/runs": { "post": { "operationId": "runs-sync-haketa-vivareal-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/haketa~vivareal-scraper/run-sync": { "post": { "operationId": "run-sync-haketa-vivareal-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": { "startUrls": { "title": "Start URLs", "type": "array", "description": "Direct VivaReal search URLs. Example: 'https://www.vivareal.com.br/venda/sp/sao-paulo/pinheiros/'", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "transacao": { "title": "Transaction Type", "enum": [ "venda", "aluguel", "lancamentos", "temporada", "all" ], "type": "string", "description": "Buy, rent, new launches or vacation rental.", "default": "venda" }, "propertyType": { "title": "Property Type", "enum": [ "all", "apartamento_residencial", "casa_residencial", "cobertura_residencial", "kitnet_residencial", "studio_residencial", "terreno", "sala_comercial" ], "type": "string", "description": "Type of property to search.", "default": "all" }, "uf": { "title": "State (UF)", "type": "string", "description": "Brazilian state code. Examples: 'sp', 'rj', 'mg', 'pr', 'df'. Leave empty for all." }, "cidade": { "title": "City", "type": "string", "description": "City slug. Examples: 'sao-paulo', 'rio-de-janeiro', 'belo-horizonte'. Leave empty for all." }, "bairro": { "title": "Bairro (Neighborhood)", "type": "string", "description": "Neighborhood slug. Examples: 'pinheiros', 'copacabana', 'itaim-bibi', 'leblon'. Leave empty for all." }, "scrapeDetails": { "title": "Scrape Detail Pages", "type": "boolean", "description": "Visit each listing for full description, amenities, FGTS/MCMV eligibility, CRECI license, coordinates and all images.", "default": false }, "maxRecords": { "title": "Max Records", "minimum": 0, "type": "integer", "description": "Maximum total listings. Set 0 for unlimited.", "default": 0 }, "maxPages": { "title": "Max Pages", "minimum": 0, "type": "integer", "description": "Maximum pages per search. Set 0 for unlimited.", "default": 0 }, "requestDelay": { "title": "Request Delay (ms)", "minimum": 1000, "maximum": 10000, "type": "integer", "description": "Delay between requests. 2500ms recommended.", "default": 2500 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Brazilian RESIDENTIAL proxy strongly recommended. Cloudflare active." } } }, "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 } } } } } } } } } }