{ "openapi": "3.0.1", "info": { "title": "VivaReal Colombia Real Estate Listings by City & Price", "description": "Search VivaReal Colombia for properties for sale or rent by city, neighborhood, property type, price range, bedrooms, and area, and get back price, size, address, photo, and listing URL for each match.", "version": "1.1", "x-build-id": "qV2ux6HuxEezQno99" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dataspryva~vivareal-colombia-real-estate-listings-by-city/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dataspryva-vivareal-colombia-real-estate-listings-by-city", "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/dataspryva~vivareal-colombia-real-estate-listings-by-city/runs": { "post": { "operationId": "runs-sync-dataspryva-vivareal-colombia-real-estate-listings-by-city", "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/dataspryva~vivareal-colombia-real-estate-listings-by-city/run-sync": { "post": { "operationId": "run-sync-dataspryva-vivareal-colombia-real-estate-listings-by-city", "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": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "sale", "rent", "byUrls", "searchForSale", "searchForRent" ], "type": "string", "description": "Search a Brazilian city for sale/rent listings, or fetch specific listings by URL or ID.", "default": "sale" }, "city": { "title": "City", "type": "string", "description": "Brazilian city to search, for example São Paulo, Rio de Janeiro, or Belo Horizonte. Use with State.", "default": "São Paulo" }, "state": { "title": "State", "enum": [ "AC", "AL", "AP", "AM", "BA", "CE", "DF", "ES", "GO", "MA", "MT", "MS", "MG", "PA", "PB", "PR", "PE", "PI", "RJ", "RN", "RS", "RO", "RR", "SC", "SP", "SE", "TO" ], "type": "string", "description": "Brazilian state (UF) that contains the city.", "default": "SP" }, "neighborhood": { "title": "Neighborhood", "type": "string", "description": "Optional neighborhood within the city, for example Pinheiros or Copacabana." }, "propertyType": { "title": "Property Type", "enum": [ "ANY", "APARTMENT", "HOME", "PENTHOUSE", "FLAT", "KITNET", "OFFICE", "ALLOTMENT_LAND", "COMMERCIAL_PROPERTY", "COMMERCIAL_BUILDING", "WAREHOUSE", "GARAGE", "FARM", "HOTEL", "TERRAIN", "COMMERCIAL" ], "type": "string", "description": "Filter by property type. Legacy values TERRAIN and COMMERCIAL still work.", "default": "ANY" }, "usageType": { "title": "Usage", "enum": [ "ANY", "RESIDENTIAL", "COMMERCIAL" ], "type": "string", "description": "Residential, commercial, or any usage.", "default": "ANY" }, "listingType": { "title": "Listing Type", "enum": [ "USED", "DEVELOPMENT", "ALL" ], "type": "string", "description": "Used resale listings, new-development listings, or both.", "default": "USED" }, "priceMin": { "title": "Min Price (BRL)", "minimum": 0, "maximum": 10000000000, "type": "integer", "description": "Minimum price in Brazilian reais. Not Colombian pesos." }, "priceMax": { "title": "Max Price (BRL)", "minimum": 0, "maximum": 10000000000, "type": "integer", "description": "Maximum price in Brazilian reais. Not Colombian pesos." }, "bedroomsMin": { "title": "Min Bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Minimum number of bedrooms." }, "bedroomsMax": { "title": "Max Bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Maximum number of bedrooms." }, "bathroomsMin": { "title": "Min Bathrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Minimum number of bathrooms." }, "bathroomsMax": { "title": "Max Bathrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Maximum number of bathrooms." }, "parkingMin": { "title": "Min Parking Spaces", "minimum": 0, "maximum": 20, "type": "integer", "description": "Minimum number of parking spaces." }, "areaMin": { "title": "Min Usable Area (m²)", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Minimum usable area in square meters." }, "areaMax": { "title": "Max Usable Area (m²)", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Maximum usable area in square meters." }, "amenities": { "title": "Amenities", "type": "array", "description": "Optional amenity codes the listing must have, for example POOL, GYM, ELEVATOR, BARBECUE_GRILL, or PETS_ALLOWED.", "items": { "type": "string" } }, "listingUrls": { "title": "Listing URLs or IDs", "type": "array", "description": "VivaReal listing URLs or numeric IDs to fetch (mode=byUrls). Example: https://www.vivareal.com.br/imovel/2918839249/", "items": { "type": "string" } }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of listings to return.", "default": 50 } } }, "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 } } } } } } } } } }