# VRBO Extractor 4.0 (`jupri/vrbo-property`) Actor πŸ’« All-In-One VRBO.com Scraper - **URL**: https://apify.com/jupri/vrbo-property.md - **Developed by:** [cat](https://apify.com/jupri) (community) - **Categories:** Travel, Real estate - **Stats:** 312 total users, 8 monthly users, 55.8% runs succeeded, 12 bookmarks - **User rating**: No ratings yet ## Pricing $30.00/month + usage To use this Actor, you pay a monthly rental fee to the developer. The rent is subtracted from your prepaid usage every month after the free trial period.You also pay for the Apify platform usage, which gets cheaper the higher Apify subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#rental-actors ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## Welcome to Vrbo Scraper ![dont be sad readme is here](https://raw.githubusercontent.com/JupriGH/resources/main/cats/catframe.png) ### πŸ‚ About Vrbo.com **Vrbo** is an American [vacation rental](https://en.wikipedia.org/wiki/Vacation_rental "Vacation rental") [online marketplace](https://en.wikipedia.org/wiki/Online_marketplace "Online marketplace") originally known as **Vacation Rentals by Owner** or **VRBO**. It was acquired by [HomeAway](https://en.wikipedia.org/wiki/HomeAway "HomeAway") in 2006. [Expedia Group](https://en.wikipedia.org/wiki/Expedia_Group "Expedia Group") acquired HomeAway in December 2015. In March 2019, VRBO was re-branded Vrbo, including a new logo, capitalization, and pronunciation. In July 2020, the HomeAway and Vrbo websites became a single Vrbo website. ### πŸ‚ About This Actor Extract data from vrbo.com. Scrape and download prices, descriptions, and reviews based on desired location and dates. ### πŸ‚ Tutorial #### πŸƒ Parameters | Paramater | Type | Values | Description | |-|-|-|-| | `location` | ***string*** | location / coordinate / hotel IDs | Search specific location | `limit` | ***integer*** | number | Limit number of results | `check_in` | ***string*** | year-month-date | Check in date | `check_out` | ***string*** | year-month-date | Check out date | `includes` | ***object*** | | Additional Data #### πŸƒ _`location` Possible Values :_ | Format | Example | Description | |-|-|-| | `` | `Bali` | **Place Name**: City, Country. | `region:` | `region:12003` | **Region** by ID | `LAT,LON` | `-7.288445, 112.676966` | Map Center **Coordinate** | `` | `500140ha` | **VRBO** Hotel IDs #### πŸƒ Additional Data | Paramater | Type | Description | |-|-|-| | `includes:description` | ***boolean*** | Property Descriptions | `includes:policies` | ***boolean*** | Property Policies | `includes:amenities` | ***boolean*** | Complete Amenities | `includes:gallery` | ***boolean*** | Complete Gallery | `includes:faq` | ***boolean*** | Frequently Asked Questions | `includes:location` | ***boolean*** | Location and Nearby POI's | `includes:landmarks` | ***boolean*** | Nearby Landmarks | `includes:offers` | ***boolean*** | Room Offers (More Detail Prices) | `includes:calendar` | ***boolean*** | Lowest prices in the past 24 hours | `includes:availability` | ***boolean*** | Availability Calendar | `includes:review` | ***boolean*** | Hotel Reviews ### πŸ‚ Examples #### Example #1: Search by location ```yaml { "location": "Europe", "limit": 10, "check_in": "2022-11-20", "check_out": "2022-11-25", "hotelname": "Hyatt" } ```` #### Example #2: Search by coordinate (latitude, longitude) ```yaml { "location": "-7.288445, 112.676966", "limit": 10 } ``` ### πŸ‚ Support Feel free to [reach out](https://console.apify.com/actors/kRRC9n6Rv5lEcE3b3/issues) to the developer for any issues or suggestions for improvement. # Actor input Schema ## `prompt` (type: `string`): No description ## `location` (type: `array`): No description ## `example` (type: `string`): πŸ’‘ Location INPUT Examples ## `limit` (type: `integer`): πŸ’‘ Number of results (per-query) ## `sort` (type: `string`): πŸ’‘ Listing order ## `site` (type: `string`): Region/Currency ## `language` (type: `string`): πŸ’‘ example: en\_GB ## `map_viewer` (type: `boolean`): No description ## `includes:all` (type: `boolean`): πŸ’‘Check All ## `includes:description` (type: `boolean`): πŸ’‘Property Descriptions ## `includes:policies` (type: `boolean`): πŸ’‘Property Policies ## `includes:amenities` (type: `boolean`): πŸ’‘Complete Amenities ## `includes:faq` (type: `boolean`): πŸ’‘Frequently Asked Questions ## `includes:location` (type: `boolean`): πŸ’‘Location and Nearby Point of Interests ## `includes:landmarks` (type: `boolean`): πŸ’‘Nearby Landmarks ## `includes:offers` (type: `boolean`): πŸ’‘Room Offers ## `includes:calendar` (type: `boolean`): πŸ’‘ Lowest prices in the past 24 hours ## `includes:availability` (type: `integer`): πŸ’‘ Availability Calendar. Date range: TODAY until specific number of months ahead. ## `includes:gallery` (type: `string`): πŸ’‘ Complete Gallery ## `includes:review` (type: `boolean`): Reviews summary ## `includes:review_count` (type: `integer`): πŸ’‘ Number of Reviews (default=3). To Filters or Search within reviews, please use Reviews Filters below. ## `review_search` (type: `string`): Search reviews ## `review_sort` (type: `string`): Reviews sorting ## `review_type` (type: `string`): Reviews Traveler Type ## `check_in` (type: `string`): YYYY-MM-DD ## `check_out` (type: `string`): YYYY-MM-DD ## `flex_days` (type: `integer`): Flexible search (Β± days) ## `flex_unit` (type: `string`): πŸ’‘ How long do you want to stay? ## `flex_weekend` (type: `boolean`): No description ## `flex_months` (type: `array`): πŸ’‘ When do you want to travel? (this year months) ## `adults:0` (type: `integer`): Number of adults ## `children:0` (type: `string`): No description ## `adults:1` (type: `integer`): Number of adults ## `children:1` (type: `string`): No description ## `adults:2` (type: `integer`): Number of adults ## `children:2` (type: `string`): No description ## `adults:3` (type: `integer`): Number of adults ## `children:3` (type: `string`): No description ## `adults:4` (type: `integer`): Number of adults ## `children:4` (type: `string`): No description ## `adults:5` (type: `integer`): Number of adults ## `children:5` (type: `string`): No description ## `adults:6` (type: `integer`): Number of adults ## `children:6` (type: `string`): No description ## `adults:7` (type: `integer`): Number of adults ## `children:7` (type: `string`): No description ## `price_mode` (type: `string`): No description ## `min_price` (type: `integer`): No description ## `max_price` (type: `integer`): No description ## `filters:discounts` (type: `array`): No description ## `filters:booking_options` (type: `array`): No description ## `filters:free_cancellation` (type: `boolean`): No description ## `filters:property_reviews` (type: `array`): No description ## `filters:premier_host` (type: `boolean`): The owner or manager of this property consistently provides great experiences for their guests. ## `filters:property_type` (type: `array`): No description ## `min_bedroom` (type: `integer`): πŸ’‘ Min. Bedrooms ## `min_beds` (type: `integer`): πŸ’‘ Min. Beds ## `min_bathroom` (type: `integer`): πŸ’‘ Min. Bathrooms ## `min_king_beds` (type: `integer`): πŸ’‘ Min. King Beds ## `min_queen_beds` (type: `integer`): πŸ’‘ Min. Queen Beds ## `min_full_beds` (type: `integer`): πŸ’‘ Min. Full/Double Beds ## `min_twin_beds` (type: `integer`): πŸ’‘ Min. Twin Beds ## `min_bunk_beds` (type: `integer`): πŸ’‘ Min. Bunk Beds ## `min_size` (type: `integer`): No description ## `max_size` (type: `integer`): No description ## `filters:common_spaces` (type: `array`): No description ## `filters:amenities_facilities` (type: `array`): No description ## `filters:location` (type: `array`): No description ## `filters:nearby_activities` (type: `array`): No description ## `filters:house_rules` (type: `array`): No description ## `filters:safety` (type: `array`): No description ## `filters:accessibility_features` (type: `array`): No description ## `filters:properties_good_for` (type: `array`): No description ## `filters:virtual_tour` (type: `boolean`): No description ## `dev_proxy_config` (type: `object`): πŸ’‘ Supported protocol:

HTTP(S), SOCKS5
{http|socks5}://{user:pass}@{hostname|ip-address}:port

Example: socks5://example.com:9000 ## `dev_custom_headers` (type: `array`): πŸ’‘ Additional HTTP Headers ## `dev_custom_cookies` (type: `array`): πŸ’‘ Additional HTTP Cookies ## `dev_transform_fields` (type: `array`): πŸ’‘ Transform the resulting output. Select only needed fields.

For nested object use DOT. For example: 
address.streetAddress

For nested array use NUMBER (index of array element starting from index=0). For example: 
images.0.url
## `dev_dataset_name` (type: `string`): πŸ’‘ Save results into custom named Dataset, use mask to customize dataset name

{ACTOR} = actor name
{DATE} = date (YYYYMMDD)
{TIME} = time (HHMMSS)

This masks can be used to autogenerate Dataset Name.

example: data-{DATE}
Depending on today date the dataset name will be: data-20230603

default: data-{ACTOR}-{DATE}-{TIME} ## `dev_dataset_clear` (type: `boolean`): Clear Dataset before insert/update. ## `dev_no_strip` (type: `boolean`): πŸ’‘ Keep/Save empty values (NULL, FALSE, empty ARRAY, empty OBJECT, empty STRING) ## `dev_fileupload` (type: `string`): πŸ’‘ Upload your file and copy & paste the URL somewhere. ## Actor input object example ```json { "location": [ "New York" ], "limit": 5 } ``` # Actor output Schema ## `overview` (type: `string`): No description ## `extras` (type: `string`): No description ## `results` (type: `string`): No description ## `mapViewer` (type: `string`): No description # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "location": [ "New York" ], "limit": 5 }; // Run the Actor and wait for it to finish const run = await client.actor("jupri/vrbo-property").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`πŸ’Ύ Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // πŸ“š Want to learn more πŸ“–? Go to β†’ https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "location": ["New York"], "limit": 5, } # Run the Actor and wait for it to finish run = client.actor("jupri/vrbo-property").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("πŸ’Ύ Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # πŸ“š Want to learn more πŸ“–? Go to β†’ https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "location": [ "New York" ], "limit": 5 }' | apify call jupri/vrbo-property --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=jupri/vrbo-property", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "VRBO Extractor 4.0", "description": "πŸ’« All-In-One VRBO.com Scraper", "version": "0.4", "x-build-id": "UXcPblWR0WYwY0uTX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jupri~vrbo-property/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jupri-vrbo-property", "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/jupri~vrbo-property/runs": { "post": { "operationId": "runs-sync-jupri-vrbo-property", "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/jupri~vrbo-property/run-sync": { "post": { "operationId": "run-sync-jupri-vrbo-property", "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": { "prompt": { "title": "✨ AI Search Prompt", "type": "string", "description": "" }, "location": { "title": "🧭 Location", "type": "array", "description": "", "items": { "type": "string" } }, "example": { "title": "πŸ’‘ Examples", "enum": [ "Bali", "region:2554", "-7.7956, 110.3695", "10440084", "10440084/reviews", "4193579ha", "4193579ha/reviews" ], "type": "string", "description": "πŸ’‘ Location INPUT Examples" }, "limit": { "title": "♾️ Limit", "type": "integer", "description": "πŸ’‘ Number of results (per-query)" }, "sort": { "title": "πŸ”€ Sorting", "enum": [ "recommended", "price_low", "price_high", "distance", "review", "rating", "relevant", "vacation" ], "type": "string", "description": "πŸ’‘ Listing order" }, "site": { "title": "🌐 Portal", "enum": [ "9001001", "9002003", "9002004", "9004006", "9003008", "9003009", "9003011", "9003015", "9003016", "9003017", "9003019", "9005024", "9021025", "9022026", "9023027", "9007028", "9006029", "9008031", "9009032" ], "type": "string", "description": "Region/Currency" }, "language": { "title": "πŸ“’ Language", "enum": [ "es_AR", "en_AU", "de_AT", "nl_BE", "fr_BE", "pt_BR", "en_CA", "fr_CA", "zh_CN", "da_DK", "fi_FI", "fr_FR", "de_DE", "zh_HK", "en_HK", "id_ID", "en_IE", "it_IT", "ja_JP", "ko_KR", "ms_MY", "en_MY", "es_MX", "nl_NL", "nb_NO", "en_PH", "es_ES", "ca_ES", "sv_SE", "de_CH", "fr_CH", "th_TH", "en_GB", "en_SG", "en_US", "vi_VN", "zh_TW" ], "type": "string", "description": "πŸ’‘ example: en_GB" }, "map_viewer": { "title": "Enable", "type": "boolean", "description": "" }, "includes:all": { "title": "All Info", "type": "boolean", "description": "πŸ’‘Check All" }, "includes:description": { "title": "Description", "type": "boolean", "description": "πŸ’‘Property Descriptions" }, "includes:policies": { "title": "Policies", "type": "boolean", "description": "πŸ’‘Property Policies" }, "includes:amenities": { "title": "Amenities", "type": "boolean", "description": "πŸ’‘Complete Amenities" }, "includes:faq": { "title": "FAQ", "type": "boolean", "description": "πŸ’‘Frequently Asked Questions" }, "includes:location": { "title": "Location", "type": "boolean", "description": "πŸ’‘Location and Nearby Point of Interests" }, "includes:landmarks": { "title": "Landmarks", "type": "boolean", "description": "πŸ’‘Nearby Landmarks" }, "includes:offers": { "title": "Offers", "type": "boolean", "description": "πŸ’‘Room Offers" }, "includes:calendar": { "title": "Calendar Rates", "type": "boolean", "description": "πŸ’‘ Lowest prices in the past 24 hours" }, "includes:availability": { "title": "πŸ“… Availability Calendar", "type": "integer", "description": "πŸ’‘ Availability Calendar. Date range: TODAY until specific number of months ahead." }, "includes:gallery": { "title": "πŸ“· Image Gallery", "enum": [ "1", "2" ], "type": "string", "description": "πŸ’‘ Complete Gallery" }, "includes:review": { "title": "Reviews Summary", "type": "boolean", "description": "Reviews summary" }, "includes:review_count": { "title": "Number of Reviews", "type": "integer", "description": "πŸ’‘ Number of Reviews (default=3). To Filters or Search within reviews, please use Reviews Filters below." }, "review_search": { "title": "Search Reviews", "type": "string", "description": "Search reviews" }, "review_sort": { "title": "Review Sorting", "enum": [ "relevant", "date", "rating_high", "rating_low" ], "type": "string", "description": "Reviews sorting" }, "review_type": { "title": "Type", "enum": [ "all", "couples", "solo_travelers", "business_travelers", "families", "families_with_small_children", "groups", "travelers_with_pets" ], "type": "string", "description": "Reviews Traveler Type" }, "check_in": { "title": "Check-in", "type": "string", "description": "YYYY-MM-DD" }, "check_out": { "title": "Check-out", "type": "string", "description": "YYYY-MM-DD" }, "flex_days": { "title": "Flexible Days", "type": "integer", "description": "Flexible search (Β± days)" }, "flex_unit": { "title": "Flexible Dates", "enum": [ "1D", "2D", "4D", "6D", "1W", "2W", "1M" ], "type": "string", "description": "πŸ’‘ How long do you want to stay?" }, "flex_weekend": { "title": "Must include weekend", "type": "boolean", "description": "" }, "flex_months": { "title": "Flexible Months", "type": "array", "description": "πŸ’‘ When do you want to travel? (this year months)", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12" ], "enumTitles": [ "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December" ] } }, "adults:0": { "title": "πŸͺŸ Room #1: Adults", "type": "integer", "description": "Number of adults" }, "children:0": { "title": "Children Ages", "type": "string", "description": "" }, "adults:1": { "title": "πŸͺŸ Room #2: Adults", "type": "integer", "description": "Number of adults" }, "children:1": { "title": "Children Ages", "type": "string", "description": "" }, "adults:2": { "title": "πŸͺŸ Room #3: Adults", "type": "integer", "description": "Number of adults" }, "children:2": { "title": "Children Ages", "type": "string", "description": "" }, "adults:3": { "title": "πŸͺŸ Room #4: Adults", "type": "integer", "description": "Number of adults" }, "children:3": { "title": "Children Ages", "type": "string", "description": "" }, "adults:4": { "title": "πŸͺŸ Room #5: Adults", "type": "integer", "description": "Number of adults" }, "children:4": { "title": "Children Ages", "type": "string", "description": "" }, "adults:5": { "title": "πŸͺŸ Room #6: Adults", "type": "integer", "description": "Number of adults" }, "children:5": { "title": "Children Ages", "type": "string", "description": "" }, "adults:6": { "title": "πŸͺŸ Room #7: Adults", "type": "integer", "description": "Number of adults" }, "children:6": { "title": "Children Ages", "type": "string", "description": "" }, "adults:7": { "title": "πŸͺŸ Room #8: Adults", "type": "integer", "description": "Number of adults" }, "children:7": { "title": "Children Ages", "type": "string", "description": "" }, "price_mode": { "title": "Price Range", "enum": [ "nightly", "total" ], "type": "string", "description": "" }, "min_price": { "title": "", "type": "integer", "description": "" }, "max_price": { "title": "", "type": "integer", "description": "" }, "filters:discounts": { "title": "Discounts", "type": "array", "description": "", "items": { "type": "string", "enum": [ "early_booking", "last_minute", "monthly_discount", "new_listing_price", "weekly_discount" ], "enumTitles": [ "Early booking", "Last minute booking", "Monthly stay", "New listing discount", "Weekly stay" ] } }, "filters:booking_options": { "title": "Booking Options", "type": "array", "description": "", "items": { "type": "string", "enum": [ "instant_confirmation", "pay_later_with_affirm" ], "enumTitles": [ "Instant Confirmation", "Pay later with Affirm" ] } }, "filters:free_cancellation": { "title": "Free Cancellation", "type": "boolean", "description": "" }, "filters:property_reviews": { "title": "Reviews", "type": "array", "description": "", "items": { "type": "string", "enum": [ "loved_by_guests", "45_stars", "4_stars", "35_stars" ], "enumTitles": [ "Loved by guests", "Wonderful 9+", "Very good 8+", "Good 7+" ] } }, "filters:premier_host": { "title": "Premier Host", "type": "boolean", "description": "The owner or manager of this property consistently provides great experiences for their guests." }, "filters:property_type": { "title": "Property Types", "type": "array", "description": "", "items": { "type": "string", "enum": [ "apartment_or_condo", "boat", "cabin", "castle", "chalet", "cottage", "estate", "guest_house", "hotel", "house", "houseboat", "RV", "resort", "villa", "lodge" ], "enumTitles": [ "Apartment or condo", "Boat", "Cabin", "Castle", "Chalet", "Cottage", "Estate", "Guest house", "Hotel", "House", "Houseboat", "RV", "Resort", "Villa", "Lodge" ] } }, "min_bedroom": { "title": "Bedrooms", "type": "integer", "description": "πŸ’‘ Min. Bedrooms" }, "min_beds": { "title": "Beds", "type": "integer", "description": "πŸ’‘ Min. Beds" }, "min_bathroom": { "title": "Bathrooms", "type": "integer", "description": "πŸ’‘ Min. Bathrooms" }, "min_king_beds": { "title": "King Beds", "type": "integer", "description": "πŸ’‘ Min. King Beds" }, "min_queen_beds": { "title": "Queen Beds", "type": "integer", "description": "πŸ’‘ Min. Queen Beds" }, "min_full_beds": { "title": "Full/Double Beds", "type": "integer", "description": "πŸ’‘ Min. Full/Double Beds" }, "min_twin_beds": { "title": "Twin Beds", "type": "integer", "description": "πŸ’‘ Min. Twin Beds" }, "min_bunk_beds": { "title": "Bunk Beds", "type": "integer", "description": "πŸ’‘ Min. Bunk Beds" }, "min_size": { "title": "Property Size", "type": "integer", "description": "" }, "max_size": { "title": "", "type": "integer", "description": "" }, "filters:common_spaces": { "title": "Common spaces", "type": "array", "description": "", "items": { "type": "string", "enum": [ "kitchen", "outdoor_space", "living_room", "dining_room" ], "enumTitles": [ "Kitchen", "Outdoor space", "Living Room", "Dining Room" ] } }, "filters:amenities_facilities": { "title": "πŸ’Ž Amenities", "type": "array", "description": "", "items": { "type": "string", "enum": [ "air_conditioning", "balcony", "bed_linens_provided", "crib", "dishwasher", "clothes_dryer", "electric_vehicle_charging_station", "fireplace", "garden_or_backyard", "outdoor_grill", "heated_pool", "hot_tub", "internet_available", "iron_and_board", "kids_high_chair", "king_sized_bed", "microwave", "oven", "parking", "patio_or_deck", "pool", "private_pool", "stove", "television", "washer" ], "enumTitles": [ "Air conditioning", "Balcony", "Bed linens provided", "Crib", "Dishwasher", "Dryer", "Electric vehicle charging available", "Fireplace", "Garden or backyard", "Grill", "Heated pool", "Hot tub", "Internet or WiFi", "Iron and board", "Kids' high chair", "King-sized bed", "Microwave", "Oven", "Parking", "Patio or deck", "Pool", "Private pool", "Stove", "TV", "Washer" ] } }, "filters:location": { "title": "🧭 Location", "type": "array", "description": "", "items": { "type": "string", "enum": [ "beach", "beach_view", "beachfront", "downtown_location", "golf_course", "lake_location", "mountains_location", "ocean", "oceanfront", "rural_location", "skiin_skiout", "village_location", "waterfront" ], "enumTitles": [ "Beach", "Beach view", "Beachfront", "Downtown", "Golf course", "Lake", "Mountains", "Ocean", "Oceanfront", "Rural", "Ski-in/ski-out", "Village", "Waterfront" ] } }, "filters:nearby_activities": { "title": "πŸ€ Nearby activities", "type": "array", "description": "", "items": { "type": "string", "enum": [ "casinos", "cycling", "fishing", "golfing", "hiking", "horseback_riding", "museums", "rock_or_mountain_climbing", "scuba_diving_or_snorkeling", "shopping", "skiing_or_snowboarding", "spa_and_wellness", "tennis", "theme_parks", "watersports", "wineries_or_breweries", "winter_activities", "zoo_or_wildlife_viewing" ], "enumTitles": [ "Casinos", "Cycling", "Fishing", "Golfing", "Hiking", "Horseback riding", "Museums", "Rock or mountain climbing", "Scuba diving or snorkeling", "Shopping", "Skiing or snowboarding", "Spa and wellness", "Tennis", "Theme parks", "Watersports", "Wineries or breweries", "Winter activities", "Zoo or wildlife viewing" ] } }, "filters:house_rules": { "title": "πŸ“– House rules", "type": "array", "description": "", "items": { "type": "string", "enum": [ "pets_allowed", "children_allowed", "smoking_allowed", "events_allowed", "pet_free" ], "enumTitles": [ "Pets allowed", "Children welcome", "Smoking allowed", "Events allowed", "No pets allowed" ] } }, "filters:safety": { "title": "πŸ›‘οΈ Safety", "type": "array", "description": "", "items": { "type": "string", "enum": [ "smoke_detector", "carbon_monoxide_detector" ], "enumTitles": [ "Smoke detector", "Carbon-monoxide detector" ] } }, "filters:accessibility_features": { "title": "♿️ Accessibility", "type": "array", "description": "", "items": { "type": "string", "enum": [ "accessible_parking", "accessible_path", "accessible_pool", "accessible_van_parking", "elevator", "entrance_ramp", "handrail_stairway_hallway", "single_level_property", "stair_free_path_to_entrance", "wheelchair_accessible" ], "enumTitles": [ "Accessible parking", "Accessible path of travel", "Accessible pool", "Accessible van parking", "Elevator", "Entrance ramp", "Handrail in stairway or hallway", "Single-level property", "Stair-free path to entrance", "Wheelchair accessible" ] } }, "filters:properties_good_for": { "title": "Properties good for", "type": "array", "description": "", "items": { "type": "string", "enum": [ "cleanliness", "families", "location" ], "enumTitles": [ "Cleanliness", "Families", "Location" ] } }, "filters:virtual_tour": { "title": "Virtual Tour", "type": "boolean", "description": "" }, "dev_proxy_config": { "title": "🌐 PROXY NETWORKING", "type": "object", "description": "πŸ’‘ Supported protocol:

HTTP(S), SOCKS5
{http|socks5}://{user:pass}@{hostname|ip-address}:port

Example: socks5://example.com:9000" }, "dev_custom_headers": { "title": "πŸ“œ HTTP HEADERS", "type": "array", "description": "πŸ’‘ Additional HTTP Headers", "items": { "type": "object", "required": [ "key", "value" ], "properties": { "key": { "type": "string", "title": "Key" }, "value": { "type": "string", "title": "Value" } } } }, "dev_custom_cookies": { "title": "🍰 HTTP COOKIES", "type": "array", "description": "πŸ’‘ Additional HTTP Cookies", "items": { "type": "object", "required": [ "key", "value" ], "properties": { "key": { "type": "string", "title": "Key" }, "value": { "type": "string", "title": "Value" } } } }, "dev_transform_fields": { "title": "♻️ CUSTOM FIELD", "type": "array", "description": "πŸ’‘ Transform the resulting output. Select only needed fields.

For nested object use DOT. For example: 
address.streetAddress

For nested array use NUMBER (index of array element starting from index=0). For example: 
images.0.url
", "items": { "type": "object", "required": [ "key", "value" ], "properties": { "key": { "type": "string", "title": "Key" }, "value": { "type": "string", "title": "Value" } } } }, "dev_dataset_name": { "title": "πŸ“ CUSTOM STORAGE", "type": "string", "description": "πŸ’‘ Save results into custom named Dataset, use mask to customize dataset name

{ACTOR} = actor name
{DATE} = date (YYYYMMDD)
{TIME} = time (HHMMSS)

This masks can be used to autogenerate Dataset Name.

example: data-{DATE}
Depending on today date the dataset name will be: data-20230603

default: data-{ACTOR}-{DATE}-{TIME}" }, "dev_dataset_clear": { "title": "Clear Storage", "type": "boolean", "description": "Clear Dataset before insert/update." }, "dev_no_strip": { "title": "Disable data cleansing", "type": "boolean", "description": "πŸ’‘ Keep/Save empty values (NULL, FALSE, empty ARRAY, empty OBJECT, empty STRING)" }, "dev_fileupload": { "title": "πŸ“ FILE UPLOADER", "type": "string", "description": "πŸ’‘ Upload your file and copy & paste the URL somewhere." } } }, "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 } } } } } } } } } } ```