API Parameters
Customise the response from the Booking API by adding parameters to your request.
Set engine=booking_async for every Booking Search API request.
The Booking API submits asynchronous dataset jobs to https://ecom.webscrapingapi.com/v1. Send a POST request with query parameters and a JSON request body; the API returns a snapshot_id that you can poll later.
Query Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
api_key | ✅ | string | Specify your unique API access key to authenticate with the API. Your API access key can be found in your account dashboard. |
engine | ✅ | string | The engine of the API. Needs to be set to booking_async for all Booking API requests. |
type | ✅ | string | The Booking API uses search types to return categorized results. Supported values are hotel, hotel_pricing, and search. |
discover_by | ❌ | string | Discovery mode for type=hotel_pricing. Use search_input when submitting hotel pricing inputs by search query. |
snapshot_id | Poll only | string | The ID returned by the submit request. Do not include engine or type when polling. |
Request Body
Submit a JSON array. Each object is passed to the selected BrightData-backed Booking dataset. The API accepts batches up to 5000 items.
Common body fields include:
| Field | Used by | Notes |
|---|---|---|
url | hotel, search | Booking hotel URL, Booking search URL, or https://www.booking.com for location-based search. |
location | search | Destination or query text. |
check_in | search | ISO date or ISO timestamp for check-in. |
check_out | search | ISO date or ISO timestamp for check-out. |
adults | search | Number of adults. |
children | search | Number of children. |
rooms | search | Number of rooms. |
country | search | Country code for the search context. |
currency | search | Optional currency code. |
See the search type pages for complete runnable examples.