Live Google Hotel Searches Tasks

curl --request POST \
  --url https://api.aisa.one/apis/v1/dataforseo/business_data/google/hotel_searches/live \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "location_name": "<string>",
  "location_code": 123,
  "location_coordinate": "<string>",
  "language_name": "<string>",
  "language_code": "<string>",
  "keyword": "<string>",
  "depth": 123,
  "check_in": "<string>",
  "check_out": "<string>",
  "currency": "<string>",
  "adults": 123,
  "children": [
    "<string>"
  ],
  "stars": [
    "<string>"
  ],
  "min_rating": 123,
  "sort_by": "<string>",
  "min_price": 123,
  "max_price": 123,
  "free_cancellation": true,
  "is_vacation_rentals": true,
  "amenities": [
    "<string>"
  ],
  "tag": "<string>"
}
'

{
  "version": "<string>",
  "version.status_code": 123,
  "version.status_message": "<string>",
  "version.time": "<string>",
  "version.cost": 123,
  "version.tasks_count": 123,
  "version.tasks_error": 123,
  "tasks": [
    "<string>"
  ],
  "tasks.id": "<string>",
  "tasks.status_code": 123,
  "tasks.status_message": "<string>",
  "tasks.time": "<string>",
  "tasks.cost": 123,
  "tasks.result_count": 123,
  "tasks.path": [
    "<string>"
  ],
  "tasks.data": {},
  "result": [
    "<string>"
  ],
  "result.keyword": "<string>",
  "result.location_code": 123,
  "result.language_code": "<string>",
  "result.check_url": "<string>",
  "result.datetime": "<string>",
  "result.items_count": 123,
  "items": [
    "<string>"
  ],
  "items.type": "<string>",
  "items.hotel_identifier": "<string>",
  "items.title": "<string>",
  "items.stars": 123,
  "items.is_paid": true,
  "items.location": {},
  "items.latitude": 123,
  "items.longitude": 123,
  "items.reviews": {},
  "items.value": 123,
  "items.votes_count": 123,
  "items.mentions": [
    "<string>"
  ],
  "items.rating_distribution": {},
  "items.other_sites_reviews": [
    "<string>"
  ],
  "items.overview_images": [
    "<string>"
  ],
  "items.prices": {},
  "items.price": 123,
  "items.price_without_discount": 123,
  "items.currency": "<string>",
  "items.discount_text": "<string>",
  "items.check_in": "<string>",
  "items.check_out": "<string>",
  "items.visitors": 123,
  "items.items": [
    "<string>"
  ]
}

POST

https://api.aisa.one/apis/v1

dataforseo

business_data

google

hotel_searches

live

Live Google Hotel Searches Tasks

curl --request POST \
  --url https://api.aisa.one/apis/v1/dataforseo/business_data/google/hotel_searches/live \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "location_name": "<string>",
  "location_code": 123,
  "location_coordinate": "<string>",
  "language_name": "<string>",
  "language_code": "<string>",
  "keyword": "<string>",
  "depth": 123,
  "check_in": "<string>",
  "check_out": "<string>",
  "currency": "<string>",
  "adults": 123,
  "children": [
    "<string>"
  ],
  "stars": [
    "<string>"
  ],
  "min_rating": 123,
  "sort_by": "<string>",
  "min_price": 123,
  "max_price": 123,
  "free_cancellation": true,
  "is_vacation_rentals": true,
  "amenities": [
    "<string>"
  ],
  "tag": "<string>"
}
'

{
  "version": "<string>",
  "version.status_code": 123,
  "version.status_message": "<string>",
  "version.time": "<string>",
  "version.cost": 123,
  "version.tasks_count": 123,
  "version.tasks_error": 123,
  "tasks": [
    "<string>"
  ],
  "tasks.id": "<string>",
  "tasks.status_code": 123,
  "tasks.status_message": "<string>",
  "tasks.time": "<string>",
  "tasks.cost": 123,
  "tasks.result_count": 123,
  "tasks.path": [
    "<string>"
  ],
  "tasks.data": {},
  "result": [
    "<string>"
  ],
  "result.keyword": "<string>",
  "result.location_code": 123,
  "result.language_code": "<string>",
  "result.check_url": "<string>",
  "result.datetime": "<string>",
  "result.items_count": 123,
  "items": [
    "<string>"
  ],
  "items.type": "<string>",
  "items.hotel_identifier": "<string>",
  "items.title": "<string>",
  "items.stars": 123,
  "items.is_paid": true,
  "items.location": {},
  "items.latitude": 123,
  "items.longitude": 123,
  "items.reviews": {},
  "items.value": 123,
  "items.votes_count": 123,
  "items.mentions": [
    "<string>"
  ],
  "items.rating_distribution": {},
  "items.other_sites_reviews": [
    "<string>"
  ],
  "items.overview_images": [
    "<string>"
  ],
  "items.prices": {},
  "items.price": 123,
  "items.price_without_discount": 123,
  "items.currency": "<string>",
  "items.discount_text": "<string>",
  "items.check_in": "<string>",
  "items.check_out": "<string>",
  "items.visitors": 123,
  "items.items": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

location_name

string

required

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

integer

required

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: 2840

location_coordinate

string

required

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_code location_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

language_name

string

required

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

string

required

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

keyword

string

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 the keyword filed all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “%25”; Note: in order to obtain accurate search results, the location name is appended to the keyword automatically learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article

depth

integer

parsing depth optional field number of results in Google Hotels default value: 20 organic results max value: 140 Note: your account will be billed per each 20 organic results regardless of paid listings in the response; thus, setting a depth above 20 may result in additional charges if Google Hotels return more than 20 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

string

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

string

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

string

currency optional field example: "USD"

adults

integer

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

string[]

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

string[]

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

number

minimum rating optional field you can use this field to specify guest rating higher than a certain value example: 2.5

sort_by

string

results sorting parameters optional field you can use this field to sort the results possible types of sorting: relevance – sort by most relevant lowest_price – sort by the lowest price highest_rating – sort by highest rating most_reviewed – sort by most reviewed default value: relevance

min_price

integer

minimum price per night optional field the currency of this value depends on the currency field example: 100

max_price

integer

maximum price per night optional field the currency of this value depends on the currency field example: 600

free_cancellation

boolean

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

boolean

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

string[]

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"

tag

string

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 specified tag value in the data object of the response

Response

Successful response

version

string

the current version of the API

version.status_code

integer

general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions

version.status_message

string

general informational message you can find the full list of general informational messages here

version.time

string

execution time, seconds

version.cost

number

total tasks cost, USD

version.tasks_count

integer

*the number of tasks in the **tasks*array

version.tasks_error

integer

the number of tasks in the tasks array returned with an error

tasks

string[]

array of tasks

tasks.id

string

unique task identifier in our system in the Universally unique identifier (UUID) format

tasks.status_code

integer

status code of the task generated by DataForSEO; can be within the following range: 10000-60000

tasks.status_message

string

informational message of the task

tasks.time

string

execution time, seconds

tasks.cost

number

cost of the task, USD

tasks.result_count

integer

number of elements in the result array

tasks.path

string[]

URL path

tasks.data

object

contains the same parameters that you specified in the POST request

result

string[]

array of results

result.keyword

string

keyword received in a POST array keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character)

result.location_code

integer

location code in a POST array

result.language_code

string

language code in a POST array

result.check_url

string

direct URL to search engine results you can use it to make sure that we provided accurate results

result.datetime

string

date and time when the result was received in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00

result.items_count

integer

item types the number of items in the items array

items

string[]

encountered item types types of search engine results encountered in the items array; possible item types: hotel_search_item

items.type

string

type of element = ‘hotel_search_item’

items.hotel_identifier

string

unique identifier of a hotel entity in Google search example: CgoI-KWyzenM_MV3EAE

items.title

string

title of the hotel

items.stars

integer

hotel class rating class rating that ranges between 1-5 stars

items.is_paid

boolean

indicates a paid hotel listing if true, related hotel_search_item is a paid ad if false, related hotel_search_item is an organic hotel listing

items.location

object

GPS coordinates of the hotel’s location

items.latitude

number

latitude coordinate of the hotel in google maps example: "latitude": 51.584091

items.longitude

number

longitude coordinate of the hotel in google maps example: "longitude": -0.31365919999999997

items.reviews

object

hotel reviews and rating information

items.value

number

the average rating based on all reviews

items.votes_count

integer

the number of votes

items.mentions

string[]

hotel mentions note: this field always equals null; use it to facilitate integration and ensure interoperability with the Hotel Info endpoint

items.rating_distribution

object

rating distribution by votes note: this field always equals null; use it to facilitate integration and ensure interoperability with the Hotel Info endpoint

items.other_sites_reviews

string[]

reviews on third-party sites note: this field always equals null; use it to facilitate integration and ensure interoperability with the Hotel Info endpoint

items.overview_images

string[]

featured images for a hotel

items.prices

object

hotel price

items.price

integer

price per night

items.price_without_discount

integer

full price per night without a discount applied

items.currency

string

price currency USD is applied by default, unless specified in the POST array

items.discount_text

string

text about a discount applied

items.check_in

string

check-in date and time in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00

items.check_out

string

check-out date and time in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00

items.visitors

integer

number of hotel visitors for this price

items.items

string[]

array of items note: this field always equals null; use it to facilitate integration and ensure interoperability with the Hotel Info endpoint

Get Hotel Searches Completed Tasks Setting Google Hotel Searches Tasks

Documentation Index

Authorizations

Body

Response