# Booking.com Hotel Data Extractor (`crawlio/booking-com-scraper`) Actor Extract Booking.com hotel search results, property details, live pricing, room availability, guest reviews, ratings, photos, facilities, and policies using destination queries, destination IDs, or property IDs. Ideal for travel data, hotel leads, and market research. - **URL**: https://apify.com/crawlio/booking-com-scraper.md - **Developed by:** [Crawlio](https://apify.com/crawlio) (community) - **Categories:** Travel, Lead generation - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing from $0.50 / 1,000 search results This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## 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 ## Booking.com Scraper & Hotel Data Extractor ### What does Booking.com Scraper do? Booking.com Scraper lets you collect Booking hotel search results, property details, and guest reviews directly from Booking.com using destination queries, Booking destination IDs, Booking property IDs, or Booking property URLs. Booking.com Scraper can scrape: - Hotel search results for a destination - Filtered hotel search results using Booking-style dropdown and toggle filters - Property details with live pricing and room availability - Paginated property reviews ### Why scrape Booking.com? Booking.com listings contain useful pricing, availability, rating, and review data for travel research, market analysis, lead generation, and competitive monitoring. Here are some common use cases: - Compare hotel pricing and ratings across destinations - Monitor filtered hotel inventories for specific market segments - Collect property-level room and availability data - Analyze guest review volume, scores, and review text If you would like more inspiration on how scraping travel and local listing platforms could help your business or organization, check out our [industry pages](https://apify.com/industries). ### How to scrape Booking.com It is straightforward to run Booking.com Scraper. 1. Click on **Try for free**. 2. Select operation: - **Hotel search** -> Search Booking hotels for a destination - **Property details** -> Fetch one Booking property with pricing and rooms - **Property reviews** -> Fetch paginated reviews for one Booking property 3. Fill in the input fields. 4. Click on **Run**. 5. When the run finishes, open the **Dataset** tab to preview or download the results. ### Supported operations The Actor supports three operations: - `search` - fetch Booking hotel search results - `property` - fetch one Booking property with pricing and room details - `reviews` - fetch Booking guest reviews for one property `search` is the default mode for new runs. --- #### Hotel search Use hotel search when you want Booking results for a destination. You can pass a destination query and let the Actor resolve the destination automatically, or provide a Booking `destinationId` directly. For consistent pagination, hotel search results are returned in a deterministic order before `limit` and `offset` are applied. This makes repeated runs more stable, but it can differ from Booking's live on-site ranking order. You can also apply Booking filters such as: - Property type - Minimum star rating - Minimum review score - Distance from city center - Free cancellation - Breakfast included - Swimming pool - Internet - Parking - Airport transfer - Gym / fitness **Example input:** ```json { "mode": "search", "search": { "query": "New York", "checkIn": "2026-05-24", "checkOut": "2026-05-27", "adults": 2, "children": 0, "childAges": [], "rooms": 1, "limit": 3, "offset": 0, "propertyType": "hotel" }, "currency": "USD", "languageLocale": "en-us" } ```` **Example output:** ```json { "resultType": "search", "property_id": 5579202, "property_url": "https://www.booking.com/hotel/us/sonder-116-john.html", "name": "Nester Finn Financial District", "city": "New York", "country_code": "us", "stars": 4, "review_score": 9, "review_score_word": "Superb", "review_count": 6, "price_total": 738.37, "currency": "USD", "check_in": "2026-05-24", "check_out": "2026-05-27", "distance_to_city_center_km": null, "accommodation_type_id": 204, "accommodation_type": "Hotel", "free_cancellation": false, "breakfast_included": false, "is_preferred": true, "is_genius_deal": false, "is_mobile_deal": false, "thumbnail": "https://cf.bstatic.com/xdata/images/hotel/square60/680668299.jpg?k=6039115fabf68970c9064ca0c82d240a57bf14ed721eba8a9ef45125d04232dc&o=", "source_query": "New York", "source_url": "https://www.booking.com/hotel/us/sonder-116-john.html" } ``` #### Property details Use property details when you already know the Booking property ID or Booking property URL and want one record with hotel information, live pricing, available room offers, policies, nearby places, and other Booking property sections. You can use either `propertyId` or `propertyUrl`. If you set `children` above `0`, provide matching child ages. Turn on `enrichPricing` when you want richer room pricing details. **Example input:** ```json { "mode": "property", "property": { "adults": 2, "checkIn": "2026-05-24", "checkOut": "2026-05-27", "children": 0, "childAges": [], "enrichPricing": true, "includeQAndA": false, "propertyUrl": "https://www.booking.com/hotel/us/riu-plaza-manhattan-times-square.html?hotel_id=6966158", "rooms": 1 }, "currency": "USD", "languageLocale": "en-us" } ``` **Example output:** ```json { "resultType": "property", "property_id": 6966158, "property_url": "https://www.booking.com/hotel/us/riu-plaza-manhattan-times-square.html", "name": "Riu Plaza Manhattan Times Square", "address": "145 West 47th Street, New York, NY 10036, United States", "city": "New York", "country": "United States", "country_code": "us", "review_count": 9680, "wifi_rating": 9.1, "latitude": 40.758951, "longitude": -73.983386, "check_in": "2026-05-24", "check_out": "2026-05-27", "currency": "USD", "price_total_min": 920.32, "price_nightly_min": 306.77, "free_cancellation": false, "non_refundable_available": true, "breakfast_included": false, "amenities": [ "Non-smoking rooms", "Fitness centre", "Facilities for disabled guests", "Restaurant", "Free WiFi" ], "room_offers": [ { "name": "Deluxe King - Low rate - no money back", "total_price": 920.32, "currency": "USD", "free_cancellation": false, "rooms_left": 10 } ], "total_blocks": 16, "pricing_enriched": true, "source_query": "Riu Plaza Manhattan Times Square", "source_url": "https://www.booking.com/hotel/us/riu-plaza-manhattan-times-square.html" } ``` `pricing_enriched` is true only when Booking returns room offers from the pricing endpoint. If `enrichPricing` is enabled but the selected dates have no availability, the property details still return but `pricing_enriched` is false, `room_offers` is empty, and price fields can be null. Example unavailable pricing output: ```json { "property_id": 6966158, "name": "Riu Plaza Manhattan Times Square", "check_in": "2026-05-19", "check_out": "2026-05-30", "price_total_min": null, "price_nightly_min": null, "room_offers": [], "total_blocks": 0, "pricing_enriched": false } ``` #### Property reviews Use property reviews when you want guest review text, rating summaries, filters, and paginated comments for one Booking property. **Example input:** ```json { "mode": "reviews", "reviews": { "propertyId": 1397916, "propertyUrl": "", "limit": 3, "offset": 0, "sortBy": "mostRelevant" }, "currency": "USD", "languageLocale": "en-us" } ``` **Example output:** ```json { "resultType": "review", "property_id": 1397916, "property_url": "https://www.booking.com/hotel/us/riu-plaza-new-york-times-square.html", "review_id": "0d5e474d76b6cae3", "reviewer_name": "Sonia", "reviewer_country": "us", "language_code": "en-us", "rating": 3.59999990463257, "review_text": "Cleanliness, great location and free breakfast!", "negative_text": "Check in - new employee who struggled just adding names to our reservation for several minutes before agreeing to ask a colleague for help.", "travel_type": "young couple", "review_date": "2026-05-13 16:53:14", "source_url": "https://www.booking.com/hotel/us/riu-plaza-new-york-times-square.html" } ``` *** ### Input notes - Use `query` in `search` when you want the Actor to resolve the destination for you. - Use `destinationId` in `search` if you already know the Booking destination ID. - Use either `propertyId` or `propertyUrl` in `property` and `reviews`. - `limit` and `offset` are used in `search` and `reviews`. - Use `childAges` in `search` and `property` as an array of integers such as `[4, 8]`. - When `children` is greater than `0`, provide exactly one age per child. - Use `enrichPricing` in `property` when you want richer room-level pricing details. ### Output Each dataset item represents one result for the selected operation: - `search` returns one dataset item per hotel - `property` returns one dataset item for the property - `reviews` returns one dataset item per review comment The Actor also stores a compact run summary in the default key-value store `OUTPUT` record. ### Is it legal to scrape Booking.com? Personal data may be protected by GDPR in the European Union and by other privacy regulations around the world. You should only scrape and process personal data when you have a legitimate reason to do so. If you are unsure, consult your lawyers. We also recommend reading our blog post: [is web scraping legal?](https://blog.apify.com/is-web-scraping-legal/) # Actor input Schema ## `mode` (type: `string`): Choose what to extract from Booking. ## `search` (type: `object`): Configure a Booking search run. ## `property` (type: `object`): Configure a single Booking property run. ## `reviews` (type: `object`): Configure a Booking property reviews run. ## `languageLocale` (type: `string`): Language locale used in Booking requests. ## `currency` (type: `string`): Currency code for returned prices. ## Actor input object example ```json { "mode": "search", "search": { "query": "New York", "checkIn": "", "checkOut": "", "adults": 2, "children": 0, "childAges": [], "rooms": 1, "limit": 20, "offset": 0, "propertyType": "any", "starRatingMin": "any", "reviewScoreMin": "any", "cityCenterDistance": "any", "freeCancellation": false, "breakfastIncluded": false, "internet": false, "parking": false, "airportTransfer": false, "gymFitness": false, "swimmingPool": false, "entireHomesApartments": false, "familyFriendlyProperties": false, "allInclusive": false, "breakfastDinnerIncluded": false, "selfCatering": false, "allMealsIncluded": false, "breakfastLunchIncluded": false, "petsAllowed": false, "freeWifi": false, "paidParking": false, "familyRooms": false, "spaWellness": false, "frontDesk24h": false, "restaurant": false, "bbqFacilities": false, "airportShuttleFree": false, "nonSmokingRooms": false, "wheelchairAccessible": false, "roomService": false, "evChargingStation": false, "airConditioning": false, "kitchenKitchenette": false, "washingMachine": false, "balcony": false, "privateBathroom": false, "terrace": false, "kitchenette": false, "view": false, "bath": false, "flatScreenTv": false, "electricKettle": false, "coffeeTeaMaker": false, "coffeeMachine": false, "soundproofing": false, "desk": false, "cots": false, "doubleBed": false, "twoSingleBeds": false, "familyTravelGroup": false, "travelProud": false, "sustainabilityCertification": false, "acceptsOnlinePayments": false, "upperFloorsElevator": false, "groundFloorUnit": false, "wheelchairAccessibleUnit": false, "walkInShower": false, "adaptedBath": false, "rollInShower": false, "showerChair": false, "emergencyCordBathroom": false, "toiletGrabRails": false, "raisedToilet": false, "loweredSink": false, "auditoryGuidance": false, "tactileSigns": false, "braille": false, "accessibleToiletGrabRails": false, "accessibleEmergencyCordBathroom": false, "accessibleRaisedToilet": false, "accessibleLowerBathroomSink": false, "minBedrooms": "any", "minBathrooms": "any", "minBeds": "any" }, "property": { "propertyId": 1397916, "propertyUrl": "", "checkIn": "", "checkOut": "", "adults": 2, "children": 0, "childAges": [], "rooms": 1, "enrichPricing": false, "includeQAndA": false }, "reviews": { "propertyId": 1397916, "propertyUrl": "", "limit": 20, "offset": 0, "sortBy": "newest" }, "languageLocale": "en-us", "currency": "USD" } ``` # Actor output Schema ## `results` (type: `string`): Default dataset used by search, property details, and reviews runs. ## `runSummary` (type: `string`): Summary stored in the OUTPUT record of the default key-value store. # 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 = { "search": { "query": "New York", "checkIn": "", "checkOut": "", "adults": 2, "children": 0, "childAges": [], "rooms": 1, "limit": 20, "offset": 0, "propertyType": "any", "starRatingMin": "any", "reviewScoreMin": "any", "cityCenterDistance": "any", "freeCancellation": false, "breakfastIncluded": false, "internet": false, "parking": false, "airportTransfer": false, "gymFitness": false, "swimmingPool": false, "entireHomesApartments": false, "familyFriendlyProperties": false, "allInclusive": false, "breakfastDinnerIncluded": false, "selfCatering": false, "allMealsIncluded": false, "breakfastLunchIncluded": false, "petsAllowed": false, "freeWifi": false, "paidParking": false, "familyRooms": false, "spaWellness": false, "frontDesk24h": false, "restaurant": false, "bbqFacilities": false, "airportShuttleFree": false, "nonSmokingRooms": false, "wheelchairAccessible": false, "roomService": false, "evChargingStation": false, "airConditioning": false, "kitchenKitchenette": false, "washingMachine": false, "balcony": false, "privateBathroom": false, "terrace": false, "kitchenette": false, "view": false, "bath": false, "flatScreenTv": false, "electricKettle": false, "coffeeTeaMaker": false, "coffeeMachine": false, "soundproofing": false, "desk": false, "cots": false, "doubleBed": false, "twoSingleBeds": false, "familyTravelGroup": false, "travelProud": false, "sustainabilityCertification": false, "acceptsOnlinePayments": false, "upperFloorsElevator": false, "groundFloorUnit": false, "wheelchairAccessibleUnit": false, "walkInShower": false, "adaptedBath": false, "rollInShower": false, "showerChair": false, "emergencyCordBathroom": false, "toiletGrabRails": false, "raisedToilet": false, "loweredSink": false, "auditoryGuidance": false, "tactileSigns": false, "braille": false, "accessibleToiletGrabRails": false, "accessibleEmergencyCordBathroom": false, "accessibleRaisedToilet": false, "accessibleLowerBathroomSink": false, "minBedrooms": "any", "minBathrooms": "any", "minBeds": "any" }, "property": { "propertyId": 1397916, "propertyUrl": "", "checkIn": "", "checkOut": "", "adults": 2, "children": 0, "childAges": [], "rooms": 1, "enrichPricing": false, "includeQAndA": false }, "reviews": { "propertyId": 1397916, "propertyUrl": "", "limit": 20, "offset": 0, "sortBy": "newest" } }; // Run the Actor and wait for it to finish const run = await client.actor("crawlio/booking-com-scraper").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 = { "search": { "query": "New York", "checkIn": "", "checkOut": "", "adults": 2, "children": 0, "childAges": [], "rooms": 1, "limit": 20, "offset": 0, "propertyType": "any", "starRatingMin": "any", "reviewScoreMin": "any", "cityCenterDistance": "any", "freeCancellation": False, "breakfastIncluded": False, "internet": False, "parking": False, "airportTransfer": False, "gymFitness": False, "swimmingPool": False, "entireHomesApartments": False, "familyFriendlyProperties": False, "allInclusive": False, "breakfastDinnerIncluded": False, "selfCatering": False, "allMealsIncluded": False, "breakfastLunchIncluded": False, "petsAllowed": False, "freeWifi": False, "paidParking": False, "familyRooms": False, "spaWellness": False, "frontDesk24h": False, "restaurant": False, "bbqFacilities": False, "airportShuttleFree": False, "nonSmokingRooms": False, "wheelchairAccessible": False, "roomService": False, "evChargingStation": False, "airConditioning": False, "kitchenKitchenette": False, "washingMachine": False, "balcony": False, "privateBathroom": False, "terrace": False, "kitchenette": False, "view": False, "bath": False, "flatScreenTv": False, "electricKettle": False, "coffeeTeaMaker": False, "coffeeMachine": False, "soundproofing": False, "desk": False, "cots": False, "doubleBed": False, "twoSingleBeds": False, "familyTravelGroup": False, "travelProud": False, "sustainabilityCertification": False, "acceptsOnlinePayments": False, "upperFloorsElevator": False, "groundFloorUnit": False, "wheelchairAccessibleUnit": False, "walkInShower": False, "adaptedBath": False, "rollInShower": False, "showerChair": False, "emergencyCordBathroom": False, "toiletGrabRails": False, "raisedToilet": False, "loweredSink": False, "auditoryGuidance": False, "tactileSigns": False, "braille": False, "accessibleToiletGrabRails": False, "accessibleEmergencyCordBathroom": False, "accessibleRaisedToilet": False, "accessibleLowerBathroomSink": False, "minBedrooms": "any", "minBathrooms": "any", "minBeds": "any", }, "property": { "propertyId": 1397916, "propertyUrl": "", "checkIn": "", "checkOut": "", "adults": 2, "children": 0, "childAges": [], "rooms": 1, "enrichPricing": False, "includeQAndA": False, }, "reviews": { "propertyId": 1397916, "propertyUrl": "", "limit": 20, "offset": 0, "sortBy": "newest", }, } # Run the Actor and wait for it to finish run = client.actor("crawlio/booking-com-scraper").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 '{ "search": { "query": "New York", "checkIn": "", "checkOut": "", "adults": 2, "children": 0, "childAges": [], "rooms": 1, "limit": 20, "offset": 0, "propertyType": "any", "starRatingMin": "any", "reviewScoreMin": "any", "cityCenterDistance": "any", "freeCancellation": false, "breakfastIncluded": false, "internet": false, "parking": false, "airportTransfer": false, "gymFitness": false, "swimmingPool": false, "entireHomesApartments": false, "familyFriendlyProperties": false, "allInclusive": false, "breakfastDinnerIncluded": false, "selfCatering": false, "allMealsIncluded": false, "breakfastLunchIncluded": false, "petsAllowed": false, "freeWifi": false, "paidParking": false, "familyRooms": false, "spaWellness": false, "frontDesk24h": false, "restaurant": false, "bbqFacilities": false, "airportShuttleFree": false, "nonSmokingRooms": false, "wheelchairAccessible": false, "roomService": false, "evChargingStation": false, "airConditioning": false, "kitchenKitchenette": false, "washingMachine": false, "balcony": false, "privateBathroom": false, "terrace": false, "kitchenette": false, "view": false, "bath": false, "flatScreenTv": false, "electricKettle": false, "coffeeTeaMaker": false, "coffeeMachine": false, "soundproofing": false, "desk": false, "cots": false, "doubleBed": false, "twoSingleBeds": false, "familyTravelGroup": false, "travelProud": false, "sustainabilityCertification": false, "acceptsOnlinePayments": false, "upperFloorsElevator": false, "groundFloorUnit": false, "wheelchairAccessibleUnit": false, "walkInShower": false, "adaptedBath": false, "rollInShower": false, "showerChair": false, "emergencyCordBathroom": false, "toiletGrabRails": false, "raisedToilet": false, "loweredSink": false, "auditoryGuidance": false, "tactileSigns": false, "braille": false, "accessibleToiletGrabRails": false, "accessibleEmergencyCordBathroom": false, "accessibleRaisedToilet": false, "accessibleLowerBathroomSink": false, "minBedrooms": "any", "minBathrooms": "any", "minBeds": "any" }, "property": { "propertyId": 1397916, "propertyUrl": "", "checkIn": "", "checkOut": "", "adults": 2, "children": 0, "childAges": [], "rooms": 1, "enrichPricing": false, "includeQAndA": false }, "reviews": { "propertyId": 1397916, "propertyUrl": "", "limit": 20, "offset": 0, "sortBy": "newest" } }' | apify call crawlio/booking-com-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=crawlio/booking-com-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Booking.com Hotel Data Extractor", "description": "Extract Booking.com hotel search results, property details, live pricing, room availability, guest reviews, ratings, photos, facilities, and policies using destination queries, destination IDs, or property IDs. Ideal for travel data, hotel leads, and market research.", "version": "0.1", "x-build-id": "OlTOZ4ZegKeBUQhuQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlio~booking-com-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlio-booking-com-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/crawlio~booking-com-scraper/runs": { "post": { "operationId": "runs-sync-crawlio-booking-com-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/crawlio~booking-com-scraper/run-sync": { "post": { "operationId": "run-sync-crawlio-booking-com-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": { "mode": { "title": "Mode", "enum": [ "search", "property", "reviews" ], "type": "string", "description": "Choose what to extract from Booking.", "default": "search" }, "search": { "title": "Hotel search input", "type": "object", "description": "Configure a Booking search run.", "properties": { "query": { "title": "Destination query", "type": "string", "description": "Destination name to resolve automatically, such as New York, Miami, or Las Vegas.", "default": "New York", "editor": "textfield" }, "destinationId": { "title": "Destination ID (Optional)", "type": "integer", "description": "Booking destination ID. Use this if you already know the exact destination ID.", "editor": "number" }, "checkIn": { "title": "Check-in", "type": "string", "description": "Check-in date in YYYY-MM-DD format. If left empty, the Actor automatically uses an upcoming date.", "default": "", "editor": "datepicker" }, "checkOut": { "title": "Check-out", "type": "string", "description": "Check-out date in YYYY-MM-DD format. If left empty, the Actor automatically uses an upcoming date.", "default": "", "editor": "datepicker" }, "adults": { "title": "Adults", "type": "integer", "description": "Number of adult guests.", "default": 2, "minimum": 1, "maximum": 20, "editor": "number" }, "children": { "title": "Children", "type": "integer", "description": "Number of child guests.", "default": 0, "minimum": 0, "maximum": 10, "editor": "number" }, "childAges": { "title": "Children ages", "type": "array", "description": "Optional array of child ages, for example [4, 8]. Leave it empty when Children is 0.", "editor": "json", "items": { "type": "integer", "minimum": 0, "maximum": 17 }, "default": [] }, "rooms": { "title": "Rooms", "type": "integer", "description": "Number of rooms.", "default": 1, "minimum": 1, "maximum": 8, "editor": "number" }, "limit": { "title": "Limit", "type": "integer", "description": "Maximum unique properties to return.", "default": 20, "minimum": 1, "maximum": 1000, "editor": "number" }, "offset": { "title": "Offset", "type": "integer", "description": "Skip this many unique properties before returning data.", "default": 0, "minimum": 0, "maximum": 5000, "editor": "number" }, "propertyType": { "title": "Property type", "type": "string", "description": "Filter by Booking property type.", "default": "any", "enum": [ "any", "hotel", "apartment", "villa", "ryokan", "resort", "holiday_home", "hostel", "campsite", "chalet", "holiday_park", "guest_house", "motel", "love_hotel", "lodge", "homestay", "bed_and_breakfast", "capsule_hotel", "luxury_tent" ], "enumTitles": [ "Any", "Hotels", "Apartments", "Villas", "Ryokans", "Resorts", "Holiday homes", "Hostels", "Campsites", "Chalets", "Holiday parks", "Guest houses", "Motels", "Love hotels", "Lodges", "Homestays", "Bed and breakfasts", "Capsule hotels", "Luxury tents" ], "editor": "select" }, "starRatingMin": { "title": "Minimum star rating", "type": "string", "description": "Minimum Booking star rating.", "default": "any", "enum": [ "any", "0", "1", "2", "3", "4", "5" ], "enumTitles": [ "Any", "Unrated", "1 star", "2+ stars", "3+ stars", "4+ stars", "5 stars" ], "editor": "select" }, "reviewScoreMin": { "title": "Minimum review score", "type": "string", "description": "Minimum guest review score bucket.", "default": "any", "enum": [ "any", "5", "6", "7", "8", "9" ], "enumTitles": [ "Any", "5+ Passable", "6+ Pleasant", "7+ Good", "8+ Very good", "9+ Superb" ], "editor": "select" }, "cityCenterDistance": { "title": "Distance from city center", "type": "string", "description": "Filter by Booking distance from city centre.", "default": "any", "enum": [ "any", "inside_city_center", "lt_1km", "lt_2km", "lt_3km", "lt_5km", "2_to_5km", "5_to_10km", "gt_10km" ], "enumTitles": [ "Any", "Inside city center", "Less than 1 km", "Less than 2 km", "Less than 3 km", "Less than 5 km", "2-5 km", "5-10 km", "More than 10 km" ], "editor": "select" }, "freeCancellation": { "title": "Free cancellation", "type": "boolean", "description": "Only show properties with free cancellation options.", "default": false, "editor": "checkbox" }, "breakfastIncluded": { "title": "Breakfast included", "type": "boolean", "description": "Only show properties with breakfast-included offers.", "default": false, "editor": "checkbox" }, "internet": { "title": "Wi-Fi", "type": "boolean", "description": "Only show properties with Wi-Fi or internet-related filters applied.", "default": false, "editor": "checkbox" }, "parking": { "title": "Parking", "type": "boolean", "description": "Only show properties with parking-related filters applied.", "default": false, "editor": "checkbox" }, "airportTransfer": { "title": "Airport transfer", "type": "boolean", "description": "Only show properties with airport transfer-related filters applied.", "default": false, "editor": "checkbox" }, "gymFitness": { "title": "Gym / fitness", "type": "boolean", "description": "Only show properties with gym or fitness-related filters applied.", "default": false, "editor": "checkbox" }, "swimmingPool": { "title": "Swimming pool", "type": "boolean", "description": "Only show properties with swimming pool-related filters applied.", "default": false, "editor": "checkbox" }, "entireHomesApartments": { "title": "Entire homes & apartments", "type": "boolean", "description": "Only show entire homes and apartments.", "default": false, "editor": "checkbox" }, "familyFriendlyProperties": { "title": "Family friendly properties", "type": "boolean", "description": "Only show family friendly properties.", "default": false, "editor": "checkbox" }, "allInclusive": { "title": "All-inclusive", "type": "boolean", "description": "Only show all-inclusive meal plans.", "default": false, "editor": "checkbox" }, "breakfastDinnerIncluded": { "title": "Breakfast & dinner included", "type": "boolean", "description": "Only show breakfast and dinner included offers.", "default": false, "editor": "checkbox" }, "selfCatering": { "title": "Self catering", "type": "boolean", "description": "Only show self-catering offers.", "default": false, "editor": "checkbox" }, "allMealsIncluded": { "title": "All meals included", "type": "boolean", "description": "Only show full-board offers.", "default": false, "editor": "checkbox" }, "breakfastLunchIncluded": { "title": "Breakfast & lunch included", "type": "boolean", "description": "Only show breakfast and lunch included offers.", "default": false, "editor": "checkbox" }, "petsAllowed": { "title": "Pets allowed", "type": "boolean", "description": "Only show properties that allow pets.", "default": false, "editor": "checkbox" }, "freeWifi": { "title": "Free WiFi", "type": "boolean", "description": "Only show properties with free WiFi.", "default": false, "editor": "checkbox" }, "paidParking": { "title": "Parking", "type": "boolean", "description": "Only show properties with parking.", "default": false, "editor": "checkbox" }, "familyRooms": { "title": "Family rooms", "type": "boolean", "description": "Only show properties with family rooms.", "default": false, "editor": "checkbox" }, "spaWellness": { "title": "Spa and wellness centre", "type": "boolean", "description": "Only show properties with spa and wellness facilities.", "default": false, "editor": "checkbox" }, "frontDesk24h": { "title": "24-hour front desk", "type": "boolean", "description": "Only show properties with a 24-hour front desk.", "default": false, "editor": "checkbox" }, "restaurant": { "title": "Restaurant", "type": "boolean", "description": "Only show properties with a restaurant.", "default": false, "editor": "checkbox" }, "bbqFacilities": { "title": "BBQ facilities", "type": "boolean", "description": "Only show properties with BBQ facilities.", "default": false, "editor": "checkbox" }, "airportShuttleFree": { "title": "Airport shuttle (free)", "type": "boolean", "description": "Only show properties with a free airport shuttle.", "default": false, "editor": "checkbox" }, "nonSmokingRooms": { "title": "Non-smoking rooms", "type": "boolean", "description": "Only show properties with non-smoking rooms.", "default": false, "editor": "checkbox" }, "wheelchairAccessible": { "title": "Wheelchair accessible", "type": "boolean", "description": "Only show wheelchair accessible properties.", "default": false, "editor": "checkbox" }, "roomService": { "title": "Room service", "type": "boolean", "description": "Only show properties with room service.", "default": false, "editor": "checkbox" }, "evChargingStation": { "title": "Electric vehicle charging station", "type": "boolean", "description": "Only show properties with EV charging.", "default": false, "editor": "checkbox" }, "airConditioning": { "title": "Air conditioning", "type": "boolean", "description": "Only show rooms with air conditioning.", "default": false, "editor": "checkbox" }, "kitchenKitchenette": { "title": "Kitchen/kitchenette", "type": "boolean", "description": "Only show rooms with a kitchen or kitchenette.", "default": false, "editor": "checkbox" }, "washingMachine": { "title": "Washing machine", "type": "boolean", "description": "Only show rooms with a washing machine.", "default": false, "editor": "checkbox" }, "balcony": { "title": "Balcony", "type": "boolean", "description": "Only show rooms with a balcony.", "default": false, "editor": "checkbox" }, "privateBathroom": { "title": "Private bathroom", "type": "boolean", "description": "Only show rooms with a private bathroom.", "default": false, "editor": "checkbox" }, "terrace": { "title": "Terrace", "type": "boolean", "description": "Only show rooms with a terrace.", "default": false, "editor": "checkbox" }, "kitchenette": { "title": "Kitchenette", "type": "boolean", "description": "Only show rooms with a kitchenette.", "default": false, "editor": "checkbox" }, "view": { "title": "View", "type": "boolean", "description": "Only show rooms with a view.", "default": false, "editor": "checkbox" }, "bath": { "title": "Bath", "type": "boolean", "description": "Only show rooms with a bath.", "default": false, "editor": "checkbox" }, "flatScreenTv": { "title": "Flat-screen TV", "type": "boolean", "description": "Only show rooms with a flat-screen TV.", "default": false, "editor": "checkbox" }, "electricKettle": { "title": "Electric kettle", "type": "boolean", "description": "Only show rooms with an electric kettle.", "default": false, "editor": "checkbox" }, "coffeeTeaMaker": { "title": "Coffee/tea maker", "type": "boolean", "description": "Only show rooms with coffee or tea making facilities.", "default": false, "editor": "checkbox" }, "coffeeMachine": { "title": "Coffee machine", "type": "boolean", "description": "Only show rooms with a coffee machine.", "default": false, "editor": "checkbox" }, "soundproofing": { "title": "Soundproofing", "type": "boolean", "description": "Only show rooms with soundproofing.", "default": false, "editor": "checkbox" }, "desk": { "title": "Desk", "type": "boolean", "description": "Only show rooms with a desk.", "default": false, "editor": "checkbox" }, "cots": { "title": "Cots", "type": "boolean", "description": "Only show properties with cots.", "default": false, "editor": "checkbox" }, "doubleBed": { "title": "Double bed", "type": "boolean", "description": "Only show double-bed options.", "default": false, "editor": "checkbox" }, "twoSingleBeds": { "title": "2 single beds", "type": "boolean", "description": "Only show twin-bed options.", "default": false, "editor": "checkbox" }, "familyTravelGroup": { "title": "Travel group: family", "type": "boolean", "description": "Only show family travel group properties.", "default": false, "editor": "checkbox" }, "travelProud": { "title": "Travel Proud (LGBTQ+ friendly)", "type": "boolean", "description": "Only show Travel Proud properties.", "default": false, "editor": "checkbox" }, "sustainabilityCertification": { "title": "Sustainability certification", "type": "boolean", "description": "Only show properties with sustainability certification.", "default": false, "editor": "checkbox" }, "acceptsOnlinePayments": { "title": "Accepts online payments", "type": "boolean", "description": "Only show properties that accept online payments.", "default": false, "editor": "checkbox" }, "upperFloorsElevator": { "title": "Upper floors accessible by elevator", "type": "boolean", "description": "Only show rooms with upper floors accessible by elevator.", "default": false, "editor": "checkbox" }, "groundFloorUnit": { "title": "Entire unit located on ground floor", "type": "boolean", "description": "Only show ground-floor units.", "default": false, "editor": "checkbox" }, "wheelchairAccessibleUnit": { "title": "Entire unit wheelchair accessible", "type": "boolean", "description": "Only show wheelchair accessible units.", "default": false, "editor": "checkbox" }, "walkInShower": { "title": "Walk-in shower", "type": "boolean", "description": "Only show rooms with a walk-in shower.", "default": false, "editor": "checkbox" }, "adaptedBath": { "title": "Adapted bath", "type": "boolean", "description": "Only show rooms with an adapted bath.", "default": false, "editor": "checkbox" }, "rollInShower": { "title": "Roll-in shower", "type": "boolean", "description": "Only show rooms with a roll-in shower.", "default": false, "editor": "checkbox" }, "showerChair": { "title": "Shower chair", "type": "boolean", "description": "Only show rooms with a shower chair.", "default": false, "editor": "checkbox" }, "emergencyCordBathroom": { "title": "Emergency cord in bathroom", "type": "boolean", "description": "Only show rooms with an emergency cord in the bathroom.", "default": false, "editor": "checkbox" }, "toiletGrabRails": { "title": "Toilet with grab rails", "type": "boolean", "description": "Only show rooms with toilet grab rails.", "default": false, "editor": "checkbox" }, "raisedToilet": { "title": "Raised toilet", "type": "boolean", "description": "Only show rooms with a raised toilet.", "default": false, "editor": "checkbox" }, "loweredSink": { "title": "Lowered sink", "type": "boolean", "description": "Only show rooms with a lowered sink.", "default": false, "editor": "checkbox" }, "auditoryGuidance": { "title": "Auditory guidance", "type": "boolean", "description": "Only show properties with auditory guidance.", "default": false, "editor": "checkbox" }, "tactileSigns": { "title": "Visual aids: tactile signs", "type": "boolean", "description": "Only show properties with tactile signs.", "default": false, "editor": "checkbox" }, "braille": { "title": "Visual aids: Braille", "type": "boolean", "description": "Only show properties with Braille visual aids.", "default": false, "editor": "checkbox" }, "accessibleToiletGrabRails": { "title": "Property toilet with grab rails", "type": "boolean", "description": "Only show properties with toilet grab rails.", "default": false, "editor": "checkbox" }, "accessibleEmergencyCordBathroom": { "title": "Property emergency cord in bathroom", "type": "boolean", "description": "Only show properties with an emergency cord in the bathroom.", "default": false, "editor": "checkbox" }, "accessibleRaisedToilet": { "title": "Property raised toilet", "type": "boolean", "description": "Only show properties with a raised toilet.", "default": false, "editor": "checkbox" }, "accessibleLowerBathroomSink": { "title": "Property lower bathroom sink", "type": "boolean", "description": "Only show properties with a lower bathroom sink.", "default": false, "editor": "checkbox" }, "minBedrooms": { "title": "Minimum bedrooms", "type": "string", "description": "Filter by Booking minimum bedrooms option.", "default": "any", "enum": [ "any", "1", "2", "3", "4", "5" ], "enumTitles": [ "Any", "1+", "2+", "3+", "4+", "5+" ], "editor": "select" }, "minBathrooms": { "title": "Minimum bathrooms", "type": "string", "description": "Filter by Booking minimum bathrooms option.", "default": "any", "enum": [ "any", "1", "2", "3", "4", "5" ], "enumTitles": [ "Any", "1+", "2+", "3+", "4+", "5+" ], "editor": "select" }, "minBeds": { "title": "Minimum beds", "type": "string", "description": "Filter by Booking minimum beds option.", "default": "any", "enum": [ "any", "1", "2", "3", "4", "5" ], "enumTitles": [ "Any", "1+", "2+", "3+", "4+", "5+" ], "editor": "select" } }, "default": { "query": "New York", "checkIn": "", "checkOut": "", "adults": 2, "children": 0, "childAges": [], "rooms": 1, "limit": 20, "offset": 0, "propertyType": "any", "starRatingMin": "any", "reviewScoreMin": "any", "cityCenterDistance": "any", "freeCancellation": false, "breakfastIncluded": false, "internet": false, "parking": false, "airportTransfer": false, "gymFitness": false, "swimmingPool": false, "entireHomesApartments": false, "familyFriendlyProperties": false, "allInclusive": false, "breakfastDinnerIncluded": false, "selfCatering": false, "allMealsIncluded": false, "breakfastLunchIncluded": false, "petsAllowed": false, "freeWifi": false, "paidParking": false, "familyRooms": false, "spaWellness": false, "frontDesk24h": false, "restaurant": false, "bbqFacilities": false, "airportShuttleFree": false, "nonSmokingRooms": false, "wheelchairAccessible": false, "roomService": false, "evChargingStation": false, "airConditioning": false, "kitchenKitchenette": false, "washingMachine": false, "balcony": false, "privateBathroom": false, "terrace": false, "kitchenette": false, "view": false, "bath": false, "flatScreenTv": false, "electricKettle": false, "coffeeTeaMaker": false, "coffeeMachine": false, "soundproofing": false, "desk": false, "cots": false, "doubleBed": false, "twoSingleBeds": false, "familyTravelGroup": false, "travelProud": false, "sustainabilityCertification": false, "acceptsOnlinePayments": false, "upperFloorsElevator": false, "groundFloorUnit": false, "wheelchairAccessibleUnit": false, "walkInShower": false, "adaptedBath": false, "rollInShower": false, "showerChair": false, "emergencyCordBathroom": false, "toiletGrabRails": false, "raisedToilet": false, "loweredSink": false, "auditoryGuidance": false, "tactileSigns": false, "braille": false, "accessibleToiletGrabRails": false, "accessibleEmergencyCordBathroom": false, "accessibleRaisedToilet": false, "accessibleLowerBathroomSink": false, "minBedrooms": "any", "minBathrooms": "any", "minBeds": "any" }, "additionalProperties": false }, "property": { "title": "Property details input", "type": "object", "description": "Configure a single Booking property run.", "properties": { "propertyId": { "title": "Property ID (Optional)", "type": "integer", "description": "Booking property ID. Use either Property ID or Property URL.", "default": 1397916, "editor": "number" }, "propertyUrl": { "title": "Property URL (Optional)", "type": "string", "description": "Booking property URL. Use either Property ID or Property URL.", "default": "", "editor": "textfield" }, "checkIn": { "title": "Check-in", "type": "string", "description": "Check-in date in YYYY-MM-DD format. If left empty, the Actor automatically uses an upcoming date.", "default": "", "editor": "datepicker" }, "checkOut": { "title": "Check-out", "type": "string", "description": "Check-out date in YYYY-MM-DD format. If left empty, the Actor automatically uses an upcoming date.", "default": "", "editor": "datepicker" }, "adults": { "title": "Adults", "type": "integer", "description": "Number of adult guests.", "default": 2, "minimum": 1, "maximum": 20, "editor": "number" }, "children": { "title": "Children", "type": "integer", "description": "Number of child guests.", "default": 0, "minimum": 0, "maximum": 10, "editor": "number" }, "childAges": { "title": "Children ages", "type": "array", "description": "Optional array of child ages, for example [4, 8]. Leave it empty when Children is 0.", "editor": "json", "items": { "type": "integer", "minimum": 0, "maximum": 17 }, "default": [] }, "rooms": { "title": "Rooms", "type": "integer", "description": "Number of rooms.", "default": 1, "minimum": 1, "maximum": 8, "editor": "number" }, "enrichPricing": { "title": "Enrich pricing", "type": "boolean", "description": "Fetch richer room pricing details and charge the pricing enrichment event only when enrichment data is returned.", "default": false, "editor": "checkbox" }, "includeQAndA": { "title": "Include Q&A", "type": "boolean", "description": "Fetch property Q&A pairs without extra charge.", "default": false, "editor": "checkbox" } }, "default": { "propertyId": 1397916, "propertyUrl": "", "checkIn": "", "checkOut": "", "adults": 2, "children": 0, "childAges": [], "rooms": 1, "enrichPricing": false, "includeQAndA": false }, "additionalProperties": false }, "reviews": { "title": "Property reviews input", "type": "object", "description": "Configure a Booking property reviews run.", "properties": { "propertyId": { "title": "Property ID (Optional)", "type": "integer", "description": "Booking property ID. Use either Property ID or Property URL.", "default": 1397916, "editor": "number" }, "propertyUrl": { "title": "Property URL (Optional)", "type": "string", "description": "Booking property URL. Use either Property ID or Property URL.", "default": "", "editor": "textfield" }, "limit": { "title": "Limit", "type": "integer", "description": "Maximum unique review rows to return.", "default": 20, "minimum": 1, "maximum": 1000, "editor": "number" }, "offset": { "title": "Offset", "type": "integer", "description": "Skip this many unique review rows before returning data.", "default": 0, "minimum": 0, "maximum": 5000, "editor": "number" }, "sortBy": { "title": "Review sort", "type": "string", "description": "Review sorting mode.", "default": "newest", "enum": [ "newest", "mostRelevant", "highestScore" ], "enumTitles": [ "Newest", "Most relevant", "Highest score" ], "editor": "select" } }, "default": { "propertyId": 1397916, "propertyUrl": "", "limit": 20, "offset": 0, "sortBy": "newest" }, "additionalProperties": false }, "languageLocale": { "title": "Language locale", "type": "string", "description": "Language locale used in Booking requests.", "default": "en-us" }, "currency": { "title": "Currency", "type": "string", "description": "Currency code for returned prices.", "default": "USD" } } }, "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 } } } } } } } } } } ```