{ "openapi": "3.0.1", "info": { "title": "VivaReal Scraper — Brazil Property Data & API", "description": "VivaReal scraper & real estate data API for one of Brazil's biggest property portals (Grupo OLX). Sale & rent listings: price, condo fee, IPTU, size, rooms, baths, address, GPS, photos, broker phone/WhatsApp/CRECI — clean JSON/CSV. Overview or detail. No API key needed.", "version": "1.0", "x-build-id": "hSuEjqzid5xpHKNwO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sian.agency~vivareal-property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sian.agency-vivareal-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/sian.agency~vivareal-property-scraper/runs": { "post": { "operationId": "runs-sync-sian.agency-vivareal-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/sian.agency~vivareal-property-scraper/run-sync": { "post": { "operationId": "run-sync-sian.agency-vivareal-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", "properties": { "scrapeMode": { "title": "⚡ Scrape mode", "enum": [ "overview", "detail" ], "type": "string", "description": "⚡ **OVERVIEW** — fast, cheap. Pulls a full record per listing straight from the VivaReal search page (price, condo fee, IPTU, size, rooms, baths, parking, full address, GPS, photos, broker phone/WhatsApp/CRECI, description).\n\n🔍 **DETAIL** — same record plus the full long description and complete media gallery for a specific listing. Slower and priced higher per result.\n\n**TIP:** Start with Overview — the search page already carries almost every field. Use Detail only when you need the full description / all photos for specific listings.", "default": "overview" }, "searchMode": { "title": "🧭 Search by", "enum": [ "byPlace", "bySearchUrl", "byListingUrl" ], "type": "string", "description": "🧭 How to tell the scraper what to fetch:\n\n- **By place** — pick sale/rent and (optionally) a state + city (e.g. SP / São Paulo).\n- **By search URL** — paste a VivaReal search-results URL; the path filters and on-page filters in the URL are honored.\n- **By listing URL** — Detail mode only: paste VivaReal listing URLs to fetch specific properties.", "default": "byPlace" }, "contract": { "title": "🏷️ Contract", "enum": [ "sale", "rent" ], "type": "string", "description": "🏷️ **Sale** (venda) or **Rent** (aluguel). Applies to By place searches.", "default": "sale" }, "state": { "title": "🗺️ State (UF)", "type": "string", "description": "🗺️ Optional. Brazilian state acronym (UF), e.g. `sp`, `rj`, `mg`. Used when **Search by = By place**.\n\n**TIP:** Combine with City for a precise city search; leave both blank for nationwide." }, "city": { "title": "🏙️ City", "type": "string", "description": "🏙️ Optional. City name, e.g. `São Paulo`, `Rio de Janeiro` — automatically slugified. Used with **State** in **By place** mode." }, "searchUrls": { "title": "🔗 Search URLs", "type": "array", "description": "🔗 VivaReal search-results URLs to scrape. Used when **Search by = By search URL**.\n\n**TIP:** Build any search on vivareal.com.br (set your area, sale/rent, filters), then copy the URL from the address bar — the path and on-page filters are honored.\n\n**BULK EDIT:** Click \"Bulk edit\" to paste many URLs, one per line.", "items": { "type": "string" } }, "listingUrls": { "title": "🆔 Listing URLs", "type": "array", "description": "🆔 **Detail mode only.** VivaReal listing URLs (e.g. https://www.vivareal.com.br/imovel/...-id-2885444503/).\n\n**BULK EDIT:** Click \"Bulk edit\" to paste many URLs, one per line.", "items": { "type": "string" } }, "maxResults": { "title": "🔢 Max results", "minimum": 1, "type": "integer", "description": "🔢 Maximum listings to extract this run.\n\n- **FREE tier:** capped at 25 listings per run.\n- **PAID tier:** unlimited — set as high as you need.", "default": 100 }, "minPrice": { "title": "💰 Min price (R$)", "minimum": 0, "type": "integer", "description": "💰 Optional. Minimum price filter in Brazilian reais (By place mode)." }, "maxPrice": { "title": "💰 Max price (R$)", "minimum": 0, "type": "integer", "description": "💰 Optional. Maximum price filter in Brazilian reais (By place mode)." }, "minArea": { "title": "📐 Min area (m²)", "minimum": 0, "type": "integer", "description": "📐 Optional. Minimum usable area in m² (By place mode)." }, "minRooms": { "title": "🛏️ Min bedrooms", "minimum": 0, "type": "integer", "description": "🛏️ Optional. Minimum number of bedrooms (By place mode)." } } }, "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 } } } } } } } } } }