API reference · DataForSEO
dataforseo/v3/business_data/google/hotel_searches/live/advanced
Integrate this model through SandBase's unified API, with production-ready schemas and examples.
Production endpoint
Send your first request
OpenAI-compatible endpoint with unified authentication and usage tracking.
POST
https://api.sandbase.ai/v1/runModel ID
dataforseo/v3/business_data/google/hotel_searches/live/advanced01
Input Schema
22 parameters · 0 required · 22 optional
| Parameter | Type | Required | Description |
|---|---|---|---|
tag | string | Optional | user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object... |
depth | integer | Optional | parsing depthoptional fieldnumber of results in Google Hotelsdefault value: 18 organic resultsmax value: 140Note: your account will be billed per each 18 organic results regardless of paid listings in... |
stars | array | Optional | hotel starsoptional fieldset this field to [5] if you want to get the list of 5-star hotels onlyexample:[3,4,5] |
adults | integer | Optional | number of adultsoptional fieldif you don't specify this field, the default value of 2 will be applied;note that you can specify up to 6 persons including both adults and childrenexample:1 |
keyword | string | Optional | keywordoptional fieldthe keyword you specify is used to search for the list of hotels;if you don't use this field, we will return the list of hotels found in a specified location;you can specify up to... |
sort_by | string | Optional | results sorting parametersoptional fieldyou can use this field to sort the resultspossible types of sorting:relevance – sort by most relevantlowest_price – sort by the lowest pricehighest_rating – sor... |
check_in | string | Optional | check-in dateoptional fieldif you don't specify this field, tomorrow's date will be used by default;date format: "yyyy-mm-dd"example:"2019-01-15"Note: the value cannot precede the today's date |
children | array | Optional | number and age of childrenoptional fieldif you don't specify this field, no children will be included in the search;age of child can be from 0 to 17;note that you can specify up to 6 persons including... |
currency | string | Optional | currencyoptional fieldexample:"USD" |
amenities | array | Optional | hotel amenitiesoptional fieldyou can use this field to specify different hotel amenitiesexample: [ "free_parking", "pets_allowed" ]possible values:"air_conditioning","all... |
check_out | string | Optional | check-out dateoptional fieldif you don't specify this field, our system will apply the date of two days from now by default;date format: "yyyy-mm-dd"example:"2019-01-15"Note: the value cannot be less ... |
max_price | integer | Optional | maximum price per nightoptional fieldthe currency of this value depends on the currency fieldexample:600 |
min_price | integer | Optional | minimum price per nightoptional fieldthe currency of this value depends on the currency fieldexample:100 |
min_rating | number | Optional | minimum ratingoptional fieldyou can use this field to specify guest rating higher than a certain valueexample:2.5 |
language_code | string | Optional | search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages with their lan... |
language_name | string | Optional | full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages with l... |
location_code | integer | Optional | search engine location coderequired field if you don't specify location_name_or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive ... |
location_name | string | Optional | full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can ... |
search_this_area | boolean | Optional | show hotels from the displayed areaoptional fieldcan take the values: true, falsedefault value: trueif set to false the search_this_area mode will be turned offNote: if the search_this_area mode is tu... |
free_cancellation | boolean | Optional | hotels with a free cancellationoptional fieldset this field to true if you want to get the list of hotels with free cancellation of reservationsdefault value: false |
is_vacation_rentals | boolean | Optional | search for vacation rentalsoptional fieldset this field to true if you want to get the list of vacation rentals instead of hotelsdefault value: false |
location_coordinate | string | Optional | GPS coordinates of a locationrequired field if you don't specify location_name_or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parame... |
02
Output Schema
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier for the generation task |
status | string | Task status: pending, running, completed, failed, timeout |
model | string | Model used for the generation |
outputs | array | Array of output items |
outputs[].url | string | URL of the generated artifact |
outputs[].content_type | string | MIME type (e.g. image/png, video/mp4) |
error | object | null | Error details if failed, null on success |
error.type | string | Machine-readable error type code |
error.message | string | Human-readable error description |
03
Code Examples
Ready-to-run snippets
curl -X POST https://api.sandbase.ai/v1/run \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
"model": "dataforseo/v3/business_data/google/hotel_searches/live/advanced",
"prompt": "a beautiful sunset over mountains"
}'