{ "openapi": "3.0.1", "info": { "title": "VRBO Search Results Scraper", "description": "Scrape VRBO vacation rentals and Expedia hotels from search results by destination, dates, and guests. Returns property name, price, location, ID, photos, amenities, ratings, and direct booking URL. No browser overhead.", "version": "0.1", "x-build-id": "c6b2cZSI4hf5JwPbu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cirkit~vrbo-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cirkit-vrbo-search-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/cirkit~vrbo-search-scraper/runs": { "post": { "operationId": "runs-sync-cirkit-vrbo-search-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/cirkit~vrbo-search-scraper/run-sync": { "post": { "operationId": "run-sync-cirkit-vrbo-search-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", "required": [ "locations" ], "properties": { "locations": { "title": "Locations", "type": "array", "description": "List of destinations to search (city, neighborhood, region, or country). VRBO resolves each string server-side. For exact region targeting on heavily-trafficked queries, use regionIds instead.", "items": { "type": "string" } }, "regionIds": { "title": "Region IDs (optional)", "type": "array", "description": "VRBO regionId values for exact region targeting. Bypasses destination text resolution. Find the regionId in any VRBO search URL after performing the search in a browser (e.g. ?regionId=6054439 for Pigeon Forge).", "items": { "type": "string" } }, "checkIn": { "title": "Check-in date", "type": "string", "description": "Check-in date in YYYY-MM-DD format. Defaults to today + 30 days." }, "checkOut": { "title": "Check-out date", "type": "string", "description": "Check-out date in YYYY-MM-DD format. Defaults to check-in + 5 days." }, "adults": { "title": "Number of guests", "minimum": 1, "maximum": 16, "type": "integer", "description": "Number of adult guests (1 to 16).", "default": 2 }, "maxResults": { "title": "Max properties per location", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum properties to extract per location (1 to 500). The actor paginates through VRBO search pages until this cap is hit or results run out.", "default": 50 }, "propertyType": { "title": "Property type filter", "enum": [ "ALL", "VACATION_RENTAL_ONLY", "HOTEL_ONLY" ], "type": "string", "description": "Filter results. VACATION_RENTAL_ONLY excludes hotels (best for STR analytics and property managers). HOTEL_ONLY returns hotels only. ALL returns everything (default).", "default": "ALL" }, "currency": { "title": "Currency", "type": "string", "description": "Currency for displayed prices (USD, EUR, GBP, ...).", "default": "USD" }, "locale": { "title": "Locale", "type": "string", "description": "Response locale (en_US, es_MX, fr_FR, ...).", "default": "en_US" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Residential US proxies are required for reliable VRBO scraping (Akamai Bot Manager blocks datacenter IPs)." } } }, "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 } } } } } } } } } }