{ "openapi": "3.0.1", "info": { "title": "VivaReal Scraper: Brazil Property Listing Alerts", "description": "VivaReal scraper by search: get one row per listing (price, condo fee, IPTU, area, bedrooms, bathrooms, parking, neighbourhood, link). Turn on monitoring for only new listings and price drops since your last run. No login required; empty searches and quiet monitoring runs are free.", "version": "1.0", "x-build-id": "dWvA1eTmTqa1RqJQO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/accountable_eel~vivareal-listing-lookup/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-accountable_eel-vivareal-listing-lookup", "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/accountable_eel~vivareal-listing-lookup/runs": { "post": { "operationId": "runs-sync-accountable_eel-vivareal-listing-lookup", "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/accountable_eel~vivareal-listing-lookup/run-sync": { "post": { "operationId": "run-sync-accountable_eel-vivareal-listing-lookup", "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": [ "searches" ], "properties": { "searches": { "title": "VivaReal searches to run (a pasted search URL, or state-slug/city-slug)", "type": "array", "description": "One per line: paste a full vivareal.com.br search-results URL (its own filters are kept), or type a location as / using VivaReal's own slugs, e.g. \"sp/sao-paulo\" or \"minas-gerais/belo-horizonte\" — combined with \"Operation\" and \"Property type\" below. No login required. Accepted formats: sp/sao-paulo, minas-gerais/belo-horizonte, https://www.vivareal.com.br/venda/sp/sao-paulo/apartamento_residencial/. You're only charged for the ones we actually find — a miss costs nothing.", "items": { "type": "string" } }, "testRun": { "title": "Try it first — only process the first 5", "type": "boolean", "description": "Turn this on to test your input on a small sample before running the full list. Turn it off to process everything.", "default": false }, "onlyFound": { "title": "Hide rows with no result", "type": "boolean", "description": "Only keep rows where something was actually found. Misses are always free, whether or not you show them here.", "default": false }, "includeKeywords": { "title": "Only include listings whose text contains one of these", "type": "array", "description": "Optional. Matched against the title, description, street and neighbourhood (values, not field names). Case-insensitive.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Drop listings whose text contains any of these", "type": "array", "description": "Optional. Same fields as above.", "items": { "type": "string" } }, "maxResults": { "title": "Stop after this many results", "minimum": 1, "type": "integer", "description": "Optional. Stop the run once this many results have been found — useful for a quick, cheap sample. Leave blank for no limit." }, "operation": { "title": "Operation", "enum": [ "buy", "rent" ], "type": "string", "description": "Applied to any search line that is a location (state-slug/city-slug), not a pasted URL. A pasted URL keeps whatever operation it already has.", "default": "buy" }, "propertyType": { "title": "Property type", "enum": [ "apartment", "house", "condo-house", "land", "commercial" ], "type": "string", "description": "Applied to any search line that is a location (state-slug/city-slug), not a pasted URL, using VivaReal's own path slugs.", "default": "apartment" }, "sort": { "title": "Sort order", "enum": [ "newest", "price-asc", "price-desc" ], "type": "string", "description": "VivaReal's search results carry no sort parameter in the page itself (confirmed live 2026-09-18), so this actor sorts the fetched page(s) itself using each listing's own posted date or price. Forced to \"Newest first\" whenever monitoring is on.", "default": "newest" }, "maxListingsPerSearch": { "title": "Most listings to return per search", "type": "integer", "description": "VivaReal shows 30 listings per page; this actor pages through UNBLOCKER to reach your limit (one paid proxy request per page). You pay per listing returned, so this is also your budget control.", "default": 60 }, "minPrice": { "title": "Minimum price (BRL)", "type": "integer", "description": "Optional. Drop listings priced below this. Leave empty for no minimum." }, "maxPrice": { "title": "Maximum price (BRL)", "type": "integer", "description": "Optional. Drop listings priced above this. Leave empty for no maximum." }, "minBedrooms": { "title": "Minimum bedrooms", "type": "integer", "description": "Optional. Drop listings with fewer bedrooms than this." }, "deltaMode": { "title": "Only return results that are new, or dropped in price, since the last run", "type": "boolean", "description": "Turns this actor into a monitor. A listing counts as new when its VivaReal listing ID has not been returned by a previous run of the same watchlist, and as a price drop when its price falls since it was last seen (see \"Minimum price drop\" below). Already-seen, unchanged listings are dropped before you are billed, so a quiet run costs only the run fee. The first run has nothing to compare against, so (unless \"Seed silently\" is on) it returns everything and remembers it.", "default": false }, "deltaName": { "title": "Watchlist name (optional)", "type": "string", "description": "Leave empty and we derive one from this run's search settings, so two schedules with different settings keep separate memories. Type your own name to keep one memory across a settings change, or to have two schedules share one.", "default": "" }, "alertOnNew": { "title": "Alert on new listings", "type": "boolean", "description": "On by default. Turn off to have this watchlist report price drops only, not brand-new listings.", "default": true }, "alertOnPriceDrop": { "title": "Alert on price drops", "type": "boolean", "description": "On by default. Turn off to have this watchlist report new listings only, ignoring price changes on ones you've already seen.", "default": true }, "minPriceDropPct": { "title": "Minimum price drop to count as an alert (%)", "type": "integer", "description": "A listing must drop by at least this percentage since it was last seen to be reported as a price-drop.", "default": 5 }, "skipFirstRun": { "title": "Seed silently (no rows on the first run)", "type": "boolean", "description": "When on, instead of returning every current listing as \"new\" the first time a watchlist runs, this banks them silently and starts alerting from the second run on. Stops a fresh watchlist from spamming a hundred messages to your webhook on day one.", "default": false }, "includeSellerInfo": { "title": "Include raw advertiser info", "type": "boolean", "description": "Off by default. VivaReal does not expose an advertiser ID on this route, so this has no effect yet — left in the schema so a saved task that sets it keeps working if this actor adds seller fields later. Agent and owner phone numbers, WhatsApp numbers and emails are never collected, on or off.", "default": false }, "columns": { "title": "Which columns do you want?", "type": "array", "description": "Choose which pieces of information to include in each result row. All are included by default.", "items": { "type": "string", "enum": [ "searchQuery", "listingCount", "totalAvailable", "truncated", "newCount", "priceDropCount", "monitorStatus", "listings", "listingId", "title", "operation", "price", "currency", "condoFee", "iptu", "areaM2", "bedrooms", "bathrooms", "parkingSpaces", "floorLevel", "street", "neighbourhood", "city", "state", "adTier", "advertiserName", "postedAt", "photoCount", "imageUrl", "description", "changeType", "isNew", "previousPrice", "priceDropPct", "firstSeenAt", "url" ], "enumTitles": [ "Search", "Listings returned", "Total matching on VivaReal", "More results were available", "New listings this run", "Price drops this run", "Monitoring status (quiet / seeded runs)", "All listings found (full list)", "VivaReal listing ID (shared with ZAP Imoveis for the same property)", "Title", "Buy or rent", "Price (BRL)", "Currency", "Condo fee (BRL/month)", "IPTU property tax (BRL/year)", "Area (m²)", "Bedrooms", "Bathrooms", "Parking spaces", "Floor level", "Street", "Neighbourhood", "City", "State (UF)", "Ad tier (standard / premium / super premium)", "Advertiser (agencies only)", "Posted", "Photo count", "Image", "Description", "new / price-drop / seen", "Is this listing new?", "Previous price (BRL)", "Price drop %", "First seen on a run", "Listing link" ] }, "default": [ "searchQuery", "listingCount", "totalAvailable", "truncated", "newCount", "priceDropCount", "monitorStatus", "listings", "listingId", "title", "operation", "price", "currency", "condoFee", "iptu", "areaM2", "bedrooms", "bathrooms", "parkingSpaces", "floorLevel", "street", "neighbourhood", "city", "state", "adTier", "advertiserName", "postedAt", "photoCount", "imageUrl", "description", "changeType", "isNew", "previousPrice", "priceDropPct", "firstSeenAt", "url" ] }, "expandRows": { "title": "One row per listing (recommended) — turn off for one row per search instead", "type": "boolean", "description": "When on, each listing found gets its own row instead of being grouped under its search. You're still only charged once per search, no matter how many rows it produces.", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Parallel requests. Keep conservative — this target has no browser fallback, so getting blocked costs more than slow-and-steady.", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy config. Residential recommended for anti-bot-sensitive targets.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "UNBLOCKER" ] } } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }