{ "openapi": "3.0.1", "info": { "title": "VivaReal Property Scraper - Brazil Real Estate Data", "description": "Scrape property listings from VivaReal Brazil — search any city or neighborhood, for sale or rent. Every row has price, condo fee, IPTU, bedrooms, bathrooms, area, amenities, full address with geo coordinates, all photos and the advertiser. Fast JSON API, no page limits. JSON/CSV/Excel.", "version": "0.1", "x-build-id": "XblGlc2j8fFDQVFnj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/memo23~vivareal-property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-memo23-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/memo23~vivareal-property-scraper/runs": { "post": { "operationId": "runs-sync-memo23-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/memo23~vivareal-property-scraper/run-sync": { "post": { "operationId": "run-sync-memo23-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": { "locationQueries": { "title": "Locations", "type": "array", "description": "Cities or neighborhoods to search, e.g. `São Paulo, SP`, `Rio de Janeiro`, `Copacabana`. Add the state acronym (`, SP`, `, RJ`) to disambiguate same-named places. Each is resolved and paginated.", "items": { "type": "string" } }, "businessType": { "title": "Sale or rental", "enum": [ "SALE", "RENTAL" ], "type": "string", "description": "Whether to scrape properties for sale or for rent. Applies to the Locations above.", "default": "SALE" }, "propertyTypes": { "title": "Property types (optional)", "type": "array", "description": "Restrict to specific property types. Leave empty for all. Common values: `APARTMENT`, `HOME`, `CONDOMINIUM`, `PENTHOUSE`, `FLAT`, `KITNET`, `ALLOTMENT_LAND`, `FARM`, `OFFICE`, `BUSINESS`.", "items": { "type": "string" } }, "startUrls": { "title": "VivaReal URLs (optional)", "type": "array", "description": "Paste VivaReal search URLs (`https://www.vivareal.com.br/venda/sp/sao-paulo/...` or `/aluguel/...`) and/or property URLs (`https://www.vivareal.com.br/imovel/...-id-/`). Auto-classified.", "items": { "type": "string" } }, "maxItems": { "title": "Max results (whole run)", "minimum": 1, "type": "integer", "description": "Hard cap on rows across the entire run. Each row is one paid `property` event. Default 1000. Free-tier users are additionally capped at 100.", "default": 1000 }, "maxItemsPerSearch": { "title": "Max results per location", "minimum": 1, "type": "integer", "description": "Cap per location / search URL. VivaReal serves at most 1500 listings per search (30 per API page) — split a big city into neighborhoods or property types to reach more. Default 1000.", "default": 1000 }, "maxConcurrency": { "title": "Max parallel requests", "minimum": 1, "maximum": 15, "type": "integer", "description": "Parallel HTTP requests (mainly affects pasted property URLs). Default 6.", "default": 6 }, "maxRequestRetries": { "title": "Max request retries", "minimum": 0, "type": "integer", "description": "Per-request retry budget on Cloudflare blocks (403), 429 and network errors. Each retry rotates to a fresh Brazilian residential IP. Default 12.", "default": 12 }, "proxy": { "title": "Proxy configuration (optional override)", "type": "object", "description": "Leave empty — the actor already routes all traffic through its own built-in Brazilian residential proxy at no extra cost to you. Only set this if you want to use your own proxies." }, "customProxyUrls": { "title": "Custom proxy URLs (advanced)", "type": "array", "description": "Optional — bring your own HTTP proxy (e.g. `http://user:pass@host:port`). When set, these are used instead of Apify Proxy on any plan; the scraper rotates the session per request. You usually don't need this: the default Brazilian residential proxy reaches the VivaReal API reliably. Must work from Apify's cloud egress (test with a real run first).", "items": { "type": "string" } } } }, "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 } } } } } } } } } }