{ "openapi": "3.0.1", "info": { "title": "Vrbo Scraper: Vacation Rentals, Prices, Calendar", "description": "Search Vrbo vacation rentals by place, map area, link or property id and read past Vrbo's 400 home window, no login. Each home: nightly price and stay total for your dates, deals, guest rating, bedrooms, Premier Host. Add details, 24 month calendars, reviews. JSON, CSV, Excel, API; pay per home.", "version": "0.1", "x-build-id": "cq02NVZ1Xum8RIAbZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automation_craft~vrbo-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automation_craft-vrbo-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/automation_craft~vrbo-scraper/runs": { "post": { "operationId": "runs-sync-automation_craft-vrbo-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/automation_craft~vrbo-scraper/run-sync": { "post": { "operationId": "run-sync-automation_craft-vrbo-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": { "locations": { "title": "Places", "type": "array", "description": "Place names as you would type them in Vrbo's search box, for example \"Destin, Florida\", \"Lake Tahoe\" or \"Paris, France\". Vrbo picks the place; every row and the search row name the place it searched. Write the region or state for common names (\"Springfield, Missouri\").", "items": { "type": "string" } }, "regionIds": { "title": "Region ids", "type": "array", "description": "Vrbo's own place numbers, for example 6906 (Destin, Florida): the \"regionId\" of every search row and of Vrbo's search links. Each is one search, like a place.", "items": { "type": "string" } }, "placeSuggestions": { "title": "Place suggestions", "type": "array", "description": "Up to 15 texts to complete the way Vrbo's search box does, for example \"dest\" or \"lake tah\": each gives up to 10 free place rows (type place) with Vrbo's region id, the place's full name, its kind (city, neighbourhood, point of interest) and coordinates, on the run's site. Use a region id in \"regionIds\" to search exactly that place.", "items": { "type": "string" } }, "startUrls": { "title": "Vrbo links", "type": "array", "description": "Vrbo search links and home links (vrbo.com/5507150, vrbo.com/11198782ha, FeWo-direkt, Abritel and Bookabach homes). A link keeps its own dates and party (and a search link its place and sort) unless you set them here. Add \"/reviews\" to a home link for its reviews too. A home link without the id (vrbo.com/) costs a Link lookup; one with expediaPropertyId=, or the id in \"propertyIds\", costs none. A search link carrying a filter is refused free.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "propertyIds": { "title": "Property ids", "type": "array", "description": "Vrbo property ids: the numeric \"id\" of every row (for example 136933871). Listing numbers work too when written with their letters (4518938ha) or in the old dotted form (321.2880733.3452770); a plain vrbo.com listing number goes in as a link (vrbo.com/2880733). A home asked by id or link is that home: the search filters do not apply to it; your dates do.", "items": { "type": "string" } }, "mapAreas": { "title": "Map areas", "type": "array", "description": "Areas searched as Vrbo's map searches them (the area's box), each home checked to lie inside: a circle {\"latitude\": 30.39, \"longitude\": -86.49, \"radiusKm\": 3} (0.1 to 50 km), a box {\"north\": 30.41, \"south\": 30.37, \"east\": -86.45, \"west\": -86.53} (at most 1 degree by 1.5 degrees) or a polygon {\"polygon\": [[30.41, -86.53], [30.41, -86.45], [30.37, -86.49]]} (3 to 200 points)." }, "site": { "title": "Site", "enum": [ "vrbo", "fewodirekt", "abritel", "bookabach" ], "type": "string", "description": "The Vrbo site to read places, ids and areas on: vrbo.com, or its sister sites FeWo-direkt, Abritel and Bookabach (the same homes, in that site's language and currency). A link is read on its own site." }, "checkIn": { "title": "Check-in date", "type": "string", "description": "YYYY-MM-DD, with \"checkOut\". From the run's day to 500 days ahead." }, "checkOut": { "title": "Check-out date", "type": "string", "description": "YYYY-MM-DD, with \"checkIn\". A stay of 1 to 28 nights." }, "checkInDaysFromToday": { "title": "Check-in, days from today", "minimum": 0, "maximum": 500, "type": "integer", "description": "Instead of fixed dates: check in this many days after the run's day (0 is the run's day). Handy for scheduled runs." }, "nights": { "title": "Nights", "minimum": 1, "maximum": 28, "type": "integer", "description": "With \"checkInDaysFromToday\": the stay's length (default 3)." }, "adults": { "title": "Adults", "minimum": 1, "maximum": 30, "type": "integer", "description": "Adults in the party (default 2)." }, "childrenAges": { "title": "Children's ages", "type": "array", "description": "One age per child, 0 to 17, for example [5, 10]." }, "rooms": { "title": "Rooms", "minimum": 1, "maximum": 8, "type": "integer", "description": "Rooms or units for the party (default 1); the adults are spread over them. Few vacation rentals take more than one." }, "pets": { "title": "Bringing pets", "type": "boolean", "description": "Only homes that allow pets (Vrbo's own \"Pets allowed\" filter); the booking link says pets are coming." }, "minPrice": { "title": "Minimum price", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "In the site's currency (US dollars on vrbo.com), per night or for the whole stay (\"priceType\"). Homes without a price for your dates are left out free under a price filter." }, "maxPrice": { "title": "Maximum price", "minimum": 1, "maximum": 10000000, "type": "integer", "description": "In the site's currency, per night or for the whole stay (\"priceType\")." }, "priceType": { "title": "Price limits count", "enum": [ "nightly", "total" ], "type": "string", "description": "Whether \"minPrice\" and \"maxPrice\" are per night (default) or for the whole stay." }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Vrbo's own property types; homes of any of them.", "items": { "type": "string", "enum": [ "house", "apartmentOrCondo", "cottage", "estate", "resort", "hotel", "villa", "cabin", "houseboat", "guestHouse", "boat", "chalet", "rv" ], "enumTitles": [ "House", "Apartment or condo", "Cottage", "Estate", "Resort", "Hotel", "Villa", "Cabin", "Houseboat", "Guest house", "Boat", "Chalet", "RV" ] } }, "minBedrooms": { "title": "Bedrooms, at least", "enum": [ "1", "2", "3", "4", "5", "6" ], "type": "string", "description": "At least this many bedrooms (a home whose card shows no bedroom count is left out free)." }, "maxBedrooms": { "title": "Bedrooms, at most", "minimum": 1, "maximum": 50, "type": "integer", "description": "At most this many bedrooms, checked on every home (Vrbo has no such filter): a home over it, or whose card shows no bedroom count, is left out free." }, "minBathrooms": { "title": "Bathrooms, at least", "enum": [ "1", "2", "3", "4" ], "type": "string", "description": "At least this many bathrooms (Vrbo's own filter)." }, "amenities": { "title": "Amenities", "type": "array", "description": "Homes with every amenity chosen.", "items": { "type": "string", "enum": [ "pool", "privatePool", "heatedPool", "hotTub", "kitchen", "airConditioning", "internet", "washer", "dryer", "parking", "evCharging", "balcony", "patioOrDeck", "gardenOrBackyard", "outdoorGrill", "outdoorSpace", "fireplace", "television", "kingSizedBed", "bedLinens", "crib", "highChair", "microwave", "dishwasher", "stove", "oven", "ironAndBoard", "diningRoom", "livingRoom", "carbonMonoxideDetector", "smokeDetector" ], "enumTitles": [ "Pool", "Private pool", "Heated pool", "Hot tub", "Kitchen", "Air conditioning", "Internet or wifi", "Washer", "Dryer", "Parking", "EV charging station", "Balcony", "Patio or deck", "Garden or backyard", "Outdoor grill", "Outdoor space", "Fireplace", "Television", "King sized bed", "Bed linens provided", "Crib", "High chair", "Microwave", "Dishwasher", "Stove", "Oven", "Iron and board", "Dining room", "Living room", "Carbon monoxide detector", "Smoke detector" ] } }, "accessibility": { "title": "Accessibility", "type": "array", "description": "Homes with the accessibility features chosen.", "items": { "type": "string", "enum": [ "elevator", "wheelchairAccessible", "singleLevel", "stairFreeEntrance", "accessiblePath", "accessiblePool", "accessibleParking", "entranceRamp", "handrails", "accessibleVanParking" ], "enumTitles": [ "Elevator", "Wheelchair accessible", "Single level home", "Stair free path to entrance", "Accessible path", "Accessible pool", "Accessible parking", "Entrance ramp", "Handrails in stairs and halls", "Accessible van parking" ] } }, "locationTypes": { "title": "Location type", "type": "array", "description": "Oceanfront, waterfront, lake, mountains and more.", "items": { "type": "string", "enum": [ "oceanfront", "waterfront", "downtown", "lake", "golfCourse", "village", "mountains", "rural", "skiInSkiOut" ], "enumTitles": [ "Oceanfront", "Waterfront", "Downtown", "Lake", "Golf course", "Village", "Mountains", "Rural", "Ski in, ski out" ] } }, "beachAccess": { "title": "Beach access", "type": "array", "description": "On the beach, or within a 15 minute walk.", "items": { "type": "string", "enum": [ "onTheBeach", "nearTheBeach" ], "enumTitles": [ "On the beach", "Near the beach (15 minute walk)" ] } }, "nearbyActivities": { "title": "Nearby activities", "type": "array", "description": "Activities near the home.", "items": { "type": "string", "enum": [ "fishing", "golfing", "spaAndWellness", "shopping", "tennis", "cycling", "themeParks", "hiking", "scubaOrSnorkeling", "watersports", "casinos", "wineriesOrBreweries", "zooOrWildlife", "skiingOrSnowboarding", "horsebackRiding", "museums", "winterActivities", "climbing" ], "enumTitles": [ "Fishing", "Golfing", "Spa and wellness", "Shopping", "Tennis", "Cycling", "Theme parks", "Hiking", "Scuba diving or snorkeling", "Watersports", "Casinos", "Wineries or breweries", "Zoo or wildlife viewing", "Skiing or snowboarding", "Horseback riding", "Museums", "Winter activities", "Rock or mountain climbing" ] } }, "houseRules": { "title": "House rules", "type": "array", "description": "Pets, children, events or smoking allowed, or pet free.", "items": { "type": "string", "enum": [ "petsAllowed", "petFree", "childrenAllowed", "eventsAllowed", "smokingAllowed" ], "enumTitles": [ "Pets allowed", "Pet free", "Children allowed", "Events allowed", "Smoking allowed" ] } }, "bookingOptions": { "title": "Booking options", "type": "array", "description": "Instant confirmation, reserve now pay later, pay later with Affirm.", "items": { "type": "string", "enum": [ "instantConfirmation", "reserveNowPayLater", "payLaterWithAffirm" ], "enumTitles": [ "Instant confirmation", "Reserve now, pay later", "Pay later with Affirm" ] } }, "discounts": { "title": "Discounts", "type": "array", "description": "Homes offering these deals. Vrbo pads deal results with homes it cannot price for the dates; those are left out free.", "items": { "type": "string", "enum": [ "newListing", "weekly", "monthly", "earlyBooking", "lastMinute" ], "enumTitles": [ "New listing price", "Weekly discount", "Monthly discount", "Early booking", "Last minute" ] } }, "goodFor": { "title": "Guests rate it good for", "type": "array", "description": "Families, location or cleanliness.", "items": { "type": "string", "enum": [ "families", "location", "cleanliness" ], "enumTitles": [ "Families", "Location", "Cleanliness" ] } }, "minRating": { "title": "Guest rating, at least", "enum": [ "9", "8", "7" ], "type": "string", "description": "Vrbo's rating filter (out of 10). A home with no rating yet is left out free." }, "freeCancellationDays": { "title": "Free cancellation", "enum": [ "1", "5", "14", "30" ], "type": "string", "description": "A full refund is still possible this long before check-in." }, "premierHostOnly": { "title": "Premier Hosts only", "type": "boolean", "description": "Homes of Vrbo Premier Hosts only." }, "lovedByGuestsOnly": { "title": "Loved by Guests only", "type": "boolean", "description": "Vrbo's \"Loved by Guests\" homes only (its top rated tenth)." }, "virtualTourOnly": { "title": "Virtual tour only", "type": "boolean", "description": "Homes with a virtual tour only." }, "neighborhoodIds": { "title": "Neighbourhood ids", "type": "array", "description": "Vrbo neighbourhood ids (digits, as in a Vrbo link's neighborhoodId) to search within.", "items": { "type": "string" } }, "includeUnavailable": { "title": "Include homes without a price for the dates", "type": "boolean", "description": "Also deliver homes Vrbo lists for the place but cannot price for your dates (available: false, no price), each billed as a home. Off: they are left out free. Never under a price filter." }, "sortBy": { "title": "Sort", "enum": [ "recommended", "priceLowToHigh", "priceHighToLow", "guestRating", "reviewCount", "distance" ], "type": "string", "description": "Vrbo's order of the homes (default Recommended)." }, "maxItems": { "title": "Max homes in the run", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Stop after this many home rows in the whole run (reviews are not counted)." }, "maxItemsPerSearch": { "title": "Max homes per search", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Vrbo shows at most 400 homes per search. Above 400 the Actor splits a search that fills that window to read further: by property type and nightly price, and a map area into smaller boxes (default 400)." }, "includeDetails": { "title": "Property details", "type": "boolean", "description": "For every home: the description, every amenity, house rules with check-in and check-out times, rooms and beds, the host (name, Premier Host, languages, score card, profile), cancellation terms, the quote for your dates (total, base rate, taxes and fees, instant booking, damage deposit), the review summary with category ratings, the registration number where shown, nearby places and the full photo gallery. Charged per home only when read in full." }, "includeCalendar": { "title": "Availability calendar", "type": "boolean", "description": "For every home: its availability calendar for up to 24 months (each day: available, check-in and check-out allowed, minimum and maximum stay, and the nightly price Vrbo shows on about the next eight months), plus a summary per 30, 90 and 365 days (share of days not available, average, lowest and highest listed price, first possible check-in). One charge per home." }, "calendarMonths": { "title": "Calendar months", "minimum": 1, "maximum": 24, "type": "integer", "description": "With \"includeCalendar\": how many months of days to deliver (default 24)." }, "includeReviews": { "title": "Guest reviews", "type": "boolean", "description": "For every home delivered: its guest reviews, one row each (rating, title, text, date, stay, liked and disliked, photos, helpful votes, host response, the reviewer's first name as Vrbo shows it), and a free row per home with the category ratings and how far the walk got." }, "maxReviewsPerProperty": { "title": "Max reviews per home", "minimum": 1, "maximum": 10000, "type": "integer", "description": "With \"includeReviews\" (default 50)." }, "reviewsSort": { "title": "Review order", "enum": [ "newest", "highest", "lowest", "mostRelevant" ], "type": "string", "description": "With \"includeReviews\" (default newest first)." }, "reviewsFrom": { "title": "Reviews since", "type": "string", "description": "With \"includeReviews\": only reviews posted on or after this date (YYYY-MM-DD)." }, "includeRawCard": { "title": "Raw search card", "type": "boolean", "description": "Add Vrbo's own search card of each home, as served, to its row (field rawCard)." }, "skipStatusRows": { "title": "Skip status rows", "type": "boolean", "description": "Leave out the free rows about input entries not read and places not found (the search, lookup and summary rows stay)." }, "maxConcurrency": { "title": "Parallel reads", "minimum": 1, "maximum": 3, "type": "integer", "description": "How many reads run at once (1 to 3, default 3)." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. By default the Actor reads Vrbo from its own address and switches to a residential exit in the site's country when Vrbo refuses that address. Apify proxy with the RESIDENTIAL group starts on residential exits (in the site's country; a country chosen here is refused); Apify's other groups are read as the default, since Vrbo refuses Apify's datacenter proxy. Your own http:// proxy links are used as given (https:// and socks links are refused)." } } }, "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 } } } } } } } } } }