WebScrapingAPI Docs
Travel APIsBooking Search APIGetting started

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 scraping 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

ParameterRequiredTypeDescription
api_key✅stringSpecify your unique API access key to authenticate with the API. Your API access key can be found in your account dashboard.
engine✅stringThe engine of the API. Needs to be set to booking_async for all Booking API requests.
type✅stringThe Booking API uses search types to return categorized results. Supported values are hotel, hotel_pricing, and search.
discover_by❌stringDiscovery mode for type=hotel_pricing. Use search_input when submitting hotel pricing inputs by search query.
snapshot_idPoll onlystringThe ID returned by the submit request. Do not include engine or type when polling.

Request Body

Submit a JSON array. Each object contains the inputs for the selected Booking search type. The request schema supports up to 5000 items; the deployed batch limit may be lower.

Common body fields include:

FieldUsed byNotes
urlhotel, searchBooking hotel URL, Booking search URL, or https://www.booking.com for location-based search.
locationsearchDestination or query text.
check_insearchISO date or ISO timestamp for check-in.
check_outsearchISO date or ISO timestamp for check-out.
adultssearchNumber of adults.
childrensearchNumber of children.
roomssearchNumber of rooms.
countrysearchCountry code for the search context.
currencysearchOptional currency code.

See the search type pages for complete runnable examples.

On this page