keyword filedkeyword, please specify it as “%25”; learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article"
},
"priority": {
"type": [
"integer",
"null"
],
"description": "task priority
optional field
can take the following values:
1 – normal execution priority (set by default)
2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.
The cost can be calculated on the Pricing page."
},
"location_name": {
"type": "string",
"description": "full name of search engine location
required field if you don't specify location_code or location_coordinate
if you use this field, you don't need to specify location_code or location_coordinate
you can receive the list of available locations with location_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/locations
example:London,England,United Kingdom
Note: in order to obtain accurate search results, the location_name you specify will be automatically appended to the keyword"
},
"location_code": {
"type": "integer",
"description": "search engine location code
required field if you don't specify location_name_or location_coordinate
if you use this field, you don't need to specify location_name or location_coordinate
you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations
example:2840n"
},
"location_coordinate": {
"type": "string",
"description": "GPS coordinates of a location
required field if you don't specify location_name_or location_code
if you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter 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"
},
"search_this_area": {
"type": [
"boolean",
"null"
],
"description": "show hotels from the displayed area
optional field
can take the values: true, false
default value: true
if set to false the search_this_area mode will be turned off
Note: if the search_this_area mode is turned off, the location_name won't be appended to the keyword during search
learn more about this parameter on our Help Center"
},
"language_name": {
"type": "string",
"description": "full name of search engine language
required field if you don't specify language_code
if you use this field, you don't need to specify language_code
you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages
example:English"
},
"language_code": {
"type": "string",
"description": "search engine language code
required field if you don't specify language_name
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code_by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages
example:en"
},
"depth": {
"type": [
"integer",
"null"
],
"description": "parsing depth
optional field
number of results in Google Hotels
default value: 18 organic 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 above 18 may 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"
},
"check_in": {
"type": [
"string",
"null"
],
"description": "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"
},
"check_out": {
"type": [
"string",
"null"
],
"description": "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 to check_in;
the range between check_in and check_out values cannot exceed 30 days"
},
"currency": {
"type": [
"string",
"null"
],
"description": "currency
optional field
example:\"USD\""
},
"adults": {
"type": [
"integer",
"null"
],
"description": "number of adults
optional field
if 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 children
example:1"
},
"children": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "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 from 0 to 17;
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]"
},
"stars": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "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]"
},
"min_rating": {
"type": [
"number",
"null"
],
"description": "minimum rating
optional field
you can use this field to specify guest rating higher than a certain value
example:2.5"
},
"sort_by": {
"type": [
"string",
"null"
],
"description": "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"
},
"min_price": {
"type": [
"integer",
"null"
],
"description": "minimum price per night
optional field
the currency of this value depends on the currency field
example:100"
},
"max_price": {
"type": [
"integer",
"null"
],
"description": "maximum price per night
optional field
the currency of this value depends on the currency field
example:600"
},
"free_cancellation": {
"type": [
"boolean",
"null"
],
"description": "hotels with a free cancellation
optional field
set this field to true if you want to get the list of hotels with free cancellation of reservations
default value: false"
},
"is_vacation_rentals": {
"type": [
"boolean",
"null"
],
"description": "search for vacation rentals
optional field
set this field to true if you want to get the list of vacation rentals instead of hotels
default value: false"
},
"amenities": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "hotel amenities
optional field
you can use this field to specify different hotel amenities
example: [
\"free_parking\",
\"pets_allowed\"
]
possible values:\"air_conditioning\","
},
"tag": {
"type": [
"string",
"null"
],
"description": "user-defined task identifier
\"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\"
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 specified tag value in the data object of the response"
},
"postback_url": {
"type": [
"string",
"null"
],
"description": "URL for sending task results
optional field
once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. 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 in postback_url will be urlencoded;
i.a., the # character will be encoded into %23
learn more on our Help Center"
},
"pingback_url": {
"type": [
"string",
"null"
],
"description": "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 $id variable and ‘$tag’ as urlencoded $tag variable. 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 in pingback_url will be urlencoded;
i.a., the # character will be encoded into %23
learn more on our Help Center"
}
},
"example": [
{
"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"
}
]
}
]
},
"example": [
{
"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"
}
]
}
```
## Responses
### 200 — Successful operation
Headers:
- `X-Request-Id` (string) — Request identifier to include when contacting Felo support.
**application/json**
Schema: object | null
```json
{
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BusinessDataGoogleHotelSearchesTaskPostResponseInfo"
}
]
}
```
### 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**
Schema:
```json
{}
```
## Schema definitions
### Response36Afe1097B20_BaseResponseInfo
`#/components/schemas/Response36Afe1097B20_BaseResponseInfo`
```json
{
"properties": {
"version": {
"type": [
"string",
"null"
],
"description": "the current version of the API"
},
"status_code": {
"type": [
"integer",
"null"
],
"description": "general status code\nyou can find the full list of the response codes here"
},
"status_message": {
"type": [
"string",
"null"
],
"description": "general informational message\nyou can find the full list of general informational messages here"
},
"time": {
"type": [
"string",
"null"
],
"description": "total execution time, seconds"
},
"cost": {
"type": [
"number",
"null"
],
"description": "total tasks cost, USD",
"format": "double"
},
"tasks_count": {
"type": [
"integer",
"null"
],
"description": "the number of tasks in the tasks array",
"format": "int64"
},
"tasks_error": {
"type": [
"integer",
"null"
],
"description": "the number of tasks in the tasks array returned with an error",
"format": "int64"
}
}
}
```
### Response36Afe1097B20_BaseResponseTaskInfo
`#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo`
```json
{
"properties": {
"id": {
"type": [
"string",
"null"
],
"description": "task identifier\nunique task identifier in our system in the UUID format"
},
"status_code": {
"type": [
"integer",
"null"
],
"description": "status code of the task\ngenerated by DataForSEO, can be within the following range: 10000-60000\nyou can find the full list of the response codes here"
},
"status_message": {
"type": [
"string",
"null"
],
"description": "informational message of the task\nyou can find the full list of general informational messages here"
},
"time": {
"type": [
"string",
"null"
],
"description": "execution time, seconds"
},
"cost": {
"type": [
"number",
"null"
],
"description": "total tasks cost, USD",
"format": "double"
},
"result_count": {
"type": [
"integer",
"null"
],
"description": "number of elements in the result array",
"format": "int64"
},
"path": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string",
"null"
]
},
"description": "URL path"
},
"data": {
"type": [
"object",
"null"
],
"additionalProperties": {
"type": [
"object",
"null"
]
},
"description": "contains the same parameters that you specified in the POST request"
}
}
}
```
### Response36Afe1097B20_BusinessDataGoogleHotelSearchesTaskPostResponseInfo
`#/components/schemas/Response36Afe1097B20_BusinessDataGoogleHotelSearchesTaskPostResponseInfo`
```json
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseInfo"
},
{
"type": "object",
"properties": {
"tasks": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BusinessDataGoogleHotelSearchesTaskPostTaskInfo"
}
]
},
"description": "array of tasks"
}
}
}
]
}
```
### Response36Afe1097B20_BusinessDataGoogleHotelSearchesTaskPostTaskInfo
`#/components/schemas/Response36Afe1097B20_BusinessDataGoogleHotelSearchesTaskPostTaskInfo`
```json
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
},
{
"type": "object",
"properties": {
"result": {
"type": [
"object",
"null"
],
"description": "array of results
in this case, the value will be null"
}
}
}
]
}
```