{ "openapi": "3.0.1", "info": { "title": "VivaReal Scraper| $1.5 / 1k | Fast & Reliable", "description": "Extract structured Brazil property listings from VivaReal Imoveis with pricing, locations, seller details, media assets, and contact data. Built for enterprise-grade Brazil real estate intelligence, listing monitoring, lead enrichment and automated analytics pipelines.", "version": "1.2", "x-build-id": "cx1vk2TZXrjo2rUCE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fatihtahta~vivareal-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fatihtahta-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/fatihtahta~vivareal-scraper/runs": { "post": { "operationId": "runs-sync-fatihtahta-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/fatihtahta~vivareal-scraper/run-sync": { "post": { "operationId": "run-sync-fatihtahta-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": { "deal_type": { "title": "Select the Type of Listing", "enum": [ "sale", "rent" ], "type": "string", "description": "Pick `sale` to search properties that are being sold, or choose `rent` to focus on listings available to lease.", "default": "sale" }, "location": { "title": "Search in a Specific Location", "type": "string", "description": "Type one location or address-style query, such as `Rio de Janeiro`, `Estrada de Pau-Ferro`, `Borrazopolis`, or `Borralho`." }, "property_type": { "title": "Choose Which Property Types to Include", "uniqueItems": true, "type": "array", "description": "Leave this empty to include every property type in the selected area, or choose one or more options to focus on specific kinds of listings.", "items": { "type": "string", "enum": [ "apartment", "studio", "kitnet", "house", "gated_house", "villa_house", "penthouse", "flat", "loft", "residential_land", "townhouse", "farm", "store", "office", "commercial_house", "hotel", "corporate_floor", "building", "commercial_land", "storage", "garage" ], "enumTitles": [ "🏠 Apartamento | Apartment", "🏠 Studio | Studio", "🏠 Kitnet | Studio apartment", "🏠 Casa | House", "🏠 Casa de Condomínio | Gated community house", "🏠 Casa de Vila | Villa house", "🏠 Cobertura | Penthouse", "🏠 Flat | Serviced apartment", "🏠 Loft | Loft", "🏠 Terreno / Lote / Condomínio | Land / Plot / Condominium lot", "🏠 Sobrados | Townhouse", "🏠 Fazenda / Sítio / Chácara | Farm / Country house", "🏢 Loja / Salão / Ponto Comercial | Store / Shop / Commercial space", "🏢 Conjunto Comercial / Sala | Commercial office / Room", "🏢 Casa Comercial | Commercial house", "🏢 Hotel / Motel / Pousada | Hotel / Motel / Guesthouse", "🏢 Andar / Laje Corporativa | Corporate floor / Office floor", "🏢 Prédio Inteiro | Entire building", "🏢 Terrenos / Lotes Comerciais | Commercial land / Plots", "🏢 Galpão / Depósito / Armazém | Warehouse / Storage / Depot", "🏢 Garagem | Garage" ] } }, "amenities": { "title": "Choose Which Amenities to Look For", "uniqueItems": true, "type": "array", "description": "Leave this empty to include all listings, or select one or more amenities to keep only properties that match your preferences.", "items": { "type": "string", "enum": [ "pets_allowed", "heating", "air_conditioning", "service_area", "builtin_wardrobe", "bedroom_wardrobe", "kitchen_cabinets", "bathroom_cabinets", "blindex_box", "gas_shower", "closet", "internet_access", "american_kitchen", "gourmet_kitchen", "large_kitchen", "home_office", "intercom", "large_window", "furnished", "backyard", "cable_tv", "balcony", "gourmet_balcony", "natural_ventilation", "bathtub", "panoramic_view", "freezer", "cooker", "deposit", "private_pool" ], "enumTitles": [ "✨ Aceita animais | Pets allowed", "✨ Aquecimento | Heating", "✨ Ar-condicionado | Air conditioning", "✨ Área de serviço | Laundry area", "✨ Armário embutido | Built-in wardrobe", "✨ Armário embutido no quarto | Built-in wardrobe in bedroom", "✨ Armário na cozinha | Kitchen cabinets", "✨ Armário no banheiro | Bathroom cabinets", "✨ Box blindex | Glass shower enclosure", "✨ Chuveiro a gás | Gas shower", "✨ Closet | Walk-in closet", "✨ Conexão à internet | Internet connection", "✨ Cozinha americana | Open-plan kitchen", "✨ Cozinha gourmet | Gourmet kitchen", "✨ Cozinha grande | Large kitchen", "✨ Escritório | Home office", "✨ Interfone | Intercom", "✨ Janela grande | Large windows", "✨ Mobiliado | Furnished", "✨ Quintal | Backyard", "✨ TV a cabo | Cable TV", "✨ Varanda | Balcony", "✨ Varanda gourmet | Gourmet balcony", "✨ Ventilação natural | Natural ventilation", "✨ Banheira | Bathtub", "✨ Vista panorâmica | Panoramic view", "✨ Freezer | Freezer", "✨ Fogão | Cooker", "✨ Depósito | Deposit", "✨ Piscina privativa | Private pool" ] } }, "min_bedroom": { "title": "Set a Minimum Number of Bedrooms", "enum": [ "1", "2", "3", "4" ], "type": "string", "description": "Choose the fewest bedrooms a property must have to stay in the results. For example, `2+` keeps listings with 2 or more bedrooms." }, "min_bathroom": { "title": "Set a Minimum Number of Bathrooms", "enum": [ "1", "2", "3", "4" ], "type": "string", "description": "Choose the fewest bathrooms a property must have to stay in the results. For example, `2+` keeps listings with 2 or more bathrooms." }, "min_parking": { "title": "Set a Minimum Number of Parking Spaces", "enum": [ "1", "2", "3", "4" ], "type": "string", "description": "Choose the fewest parking spaces a property must have to stay in the results. For example, `1+` keeps listings with 1 or more spaces." }, "min_price": { "title": "Set the Lowest Price to Include", "minimum": 0, "type": "integer", "description": "Enter the lowest listing price you want to include. For example, `400000` keeps properties priced at 400,000 and above." }, "max_price": { "title": "Set the Highest Price to Include", "minimum": 0, "type": "integer", "description": "Enter the highest listing price you want to include. For example, `3000000` keeps properties priced at 3,000,000 and below." }, "min_sqm": { "title": "Set the Smallest Usable Area to Include", "minimum": 0, "type": "integer", "description": "Enter the minimum usable area in square meters. For example, `35` keeps listings that are 35 sqm or larger." }, "max_sqm": { "title": "Set the Largest Usable Area to Include", "minimum": 0, "type": "integer", "description": "Enter the maximum usable area in square meters. For example, `100` keeps listings that are 100 sqm or smaller." }, "near_transit": { "title": "Show Only Listings Near Transit", "type": "boolean", "description": "Turn this on to keep only properties that VivaReal identifies as being close to public transit.", "default": false }, "below_market_price": { "title": "Show Only Below-Market Deals", "type": "boolean", "description": "Turn this on to keep only listings with VivaReal's below-market pricing badge.", "default": false }, "limit": { "title": "Set a Maximum Number of Results", "minimum": 1, "type": "integer", "description": "Enter how many listings to save for this run. Leave it empty to collect all available results for your selected search." }, "maximize_coverage": { "title": "Improve Coverage for Large Searches", "type": "boolean", "description": "Turn this on to help collect a more complete set of listings when your search returns a very large number of matches.", "default": true } } }, "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 } } } } } } } } } }