DataForSEO
SEO, search-engine results, keyword research, backlinks and AI visibility data.
Setting Google Hotel Searches Tasks
Queues a Google Hotels search, returning a task id. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. Retrieve with get_dataforseo_business_google_hotel_searches_fetch.
Pricing reference
- Metering: Reported response cost.
- Reference request estimate: USD 0.2428.
- Reference customer multiplier: 1.0. Do not apply it again to a settled customer amount.
Reference metadata only, not an account quote, a guaranteed price or a spending cap. Resource credits are not Felo credits. Final charges follow Felo billing records.
- Type: array (object | null)[]
- adultsType: integer | null
number of adults
optional field
if you don't specify this field, the default value of2will be applied;
note that you can specify up to 6 persons including both adults and children
example:1 - amenitiesType: array string[] | null
hotel amenities
optional field
you can use this field to specify different hotel amenities
example:[
"free_parking",
"pets_allowed"
]
possible values:"air_conditioning",
"all_inclusive_available",
"bar",
"free_breakfast",
"fitness_center",
"kid_friendly",
"free_parking",
"pets_allowed",
"pool",
"restaurant",
"room_service",
"spa",
"free_wifi",
"parking",
"indoor_pool",
"outdoor_pool",
"wheelchair_accessible",
"beach_access" - checkType: string | null
_in check-in date
optional field
if 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 - checkType: string | null
_out check-out date
optional field
if 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 than or equal tocheck_in;
the range betweencheck_inandcheck_outvalues cannot exceed 30 days - childrenType: array string[] | null
number and age of children
optional field
if you don't specify this field, no children will be included in the search;
age of child can be from0to17;
note that you can specify up to 6 persons including both adults and children
set the following value if you want to include one 14-year-old child:[14]
set the following value if you want to include one 13-year-old child and one 8-year-old child:[13,8] - currencyType: string | null
currency
optional field
example:"USD" - depthType: integer | null
parsing depth
optional field
number of results in Google Hotels
default value:18organic results
max value:140
Note: your account will be billed per each 18 organic results regardless of paid listings in the response;
thus, setting a depth above18may result in additional charges if Google Hotels return more than 18 results;
if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance - freeType: boolean | null
_cancellation hotels with a free cancellation
optional field
set this field totrueif you want to get the list of hotels with free cancellation of reservations
default value:false - isType: boolean | null
_vacation _rentals search for vacation rentals
optional field
set this field totrueif you want to get the list of vacation rentals instead of hotels
default value:false - keywordType: string | null
keyword
optional field
the 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 700 characters in thekeywordfiled
all %## will be decoded (plus character ‘+’ will be decoded to a space character)
if you need to use the “%” character for yourkeyword, please specify it as “%25”;
Note: in order to obtain accurate search results, the location name is appended to the keyword automaticallylearn more about rules and limitations of
keywordandkeywordsfields in DataForSEO APIs in this Help Center article - languageType: string
_code search engine language code
required field if you don't specifylanguage_name
if you use this field, you don't need to specifylanguage_name
you can receive the list of available languages with theirlanguage_code_by making a separate request tohttps://api.dataforseo.com/v3/business_data/google/languages
example:en - languageType: string
_name full name of search engine language
required field if you don't specifylanguage_code
if you use this field, you don't need to specifylanguage_code
you can receive the list of available languages withlanguage_nameby making a separate request tohttps://api.dataforseo.com/v3/business_data/google/languages
example:English - locationType: integer
_code search engine location code
required field if you don't specifylocation_name_orlocation_coordinate
if you use this field, you don't need to specifylocation_nameorlocation_coordinate
you can receive the list of available locations withlocation_codeby making a separate request to thehttps://api.dataforseo.com/v3/business_data/google/locations
example:2840n - locationType: string
_coordinate GPS coordinates of a location
required field if you don't specifylocation_name_orlocation_code
if you use this field, you don't need to specifylocation_nameorlocation_codelocation_coordinateparameter should be specified in the "latitude,longitude" format
the maximum number of decimal digits for "latitude" and "longitude": 7
Note: if the coordinates are used to set a location, the search will occur in the nearest settlement;
example:53.476225,-2.243572 - locationType: string
_name full name of search engine location
required field if you don't specifylocation_codeorlocation_coordinate
if you use this field, you don't need to specifylocation_codeorlocation_coordinate
you can receive the list of available locations withlocation_nameby making a separate request tohttps://api.dataforseo.com/v3/business_data/google/locations
example:London,England,United Kingdom
Note: in order to obtain accurate search results, thelocation_nameyou specify will be automatically appended to the keyword - maxType: integer | null
_price maximum price per night
optional field
the currency of this value depends on thecurrencyfield
example:600 - minType: integer | null
_price minimum price per night
optional field
the currency of this value depends on thecurrencyfield
example:100 - minType: number | null
_rating minimum rating
optional field
you can use this field to specify guest rating higher than a certain value
example:2.5 - pingbackType: string | null
_url notification URL of a completed task
optional field
when a task is completed we will notify you by GET request sent to the URL you have specified
you can use the ‘$id’ string as a$idvariable and ‘$tag’ as urlencoded$tagvariable. We will set the necessary values before sending the request.
example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
Note: special characters inpingback_urlwill be urlencoded;
i.a., the#character will be encoded into%23 - postbackType: string | null
_url URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in thegzipformat to thepostback_urlyou specified
you can use the ‘$id’ string as a$idvariable and ‘$tag’ as urlencoded$tagvariable. We will set the necessary values before sending the request.
example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
Note: special characters inpostback_urlwill be urlencoded;
i.a., the#character will be encoded into%23 - priorityType: integer | null
- searchType: boolean | null
_this _area show hotels from the displayed area
optional field
can take the values:true,false
default value:true
if set tofalsethesearch_this_areamode will be turned off
Note: if thesearch_this_areamode is turned off, thelocation_namewon't be appended to thekeywordduring search
learn more about this parameter on our Help Center - sortType: string | null
_by results sorting parameters
optional field
you can use this field to sort the results
possible types of sorting:relevance– sort by most relevantlowest_price– sort by the lowest pricehighest_rating– sort by highest ratingmost_reviewed– sort by most reviewed
default value:relevance - starsType: array string[] | null
hotel stars
optional field
set this field to[5]if you want to get the list of 5-star hotels only
example:[3,4,5] - tagType: string | null
user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specifiedtagvalue in thedataobject of the response
- Type: object | null · Response36Afe1097B20_BusinessDataGoogleHotelSearchesTaskPostResponseInfo200
- Type: number | null Format: doublecost
total tasks cost, USD
- Type: integer | nullstatus
_code general status code you can find the full list of the response codes here
- Type: string | nullstatus
_message general informational message you can find the full list of general informational messages here
- Type: array (object | null)[] | nulltasks
array of tasks
- Type: object | null · Response36Afe1097B20_BusinessDataGoogleHotelSearchesTaskPostTaskInfo
- costType: number | null Format: double
total tasks cost, USD
- dataType: object | null
contains the same parameters that you specified in the POST request
- propertyType: object | null
Name
- idType: string | null
task identifier unique task identifier in our system in the UUID format
- pathType: array (string | null)[] | null
URL path
- resultType: object | null
array of results
in this case, the value will benull - resultType: integer | null Format: int64
_count number of elements in the result array
- statusType: integer | null
_code status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- statusType: string | null
_message informational message of the task you can find the full list of general informational messages here
- timeType: string | null
execution time, seconds
- Type: integer | null Format: int64tasks
_count the number of tasks in the tasks array
- Type: integer | null Format: int64tasks
_error the number of tasks in the tasks array returned with an error
- Type: string | nulltime
total execution time, seconds
- Type: string | nullversion
the current version of the API
application/json - 400
The request could not be processed. Check the request parameters.
- 401
A valid Felo API key is required.
- 402
The request cannot proceed because a billing requirement is not met.
- 403
The account is not permitted to perform this operation.
- 429
A request or spending limit has been reached.
- 502
The service could not complete the request.
- 503
The API or billing service is temporarily unavailable.
- 504
The service timed out while processing the request.
- default
Error response; upstream passthrough responses may use provider formats
application/json
curl https://openapi.felo.ai/v1/beta/dataforseo/business_data/google/hotel_searches/task_post \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '[
{
"language_code": "en",
"location_name": "New York,New York,United States",
"keyword": "cheap hotel",
"check_in": "2023-06-01",
"check_out": "2023-06-30",
"currency": "USD",
"adults": 2,
"children": [
"14"
],
"sort_by": "highest_rating",
"priority": 2,
"tag": "example"
}
]'
{
"version": null,
"status_code": null,
"status_message": null,
"time": null,
"cost": null,
"tasks_count": null,
"tasks_error": null,
"tasks": [
{
"id": null,
"status_code": null,
"status_message": null,
"time": null,
"cost": null,
"result_count": null,
"path": [
null
],
"data": null,
"result": null
}
]
}