Felo API PlatformFelo API Platform

Data API / DataForSEO / Business Data

Live Google Hotel Searches Tasks

Searches Google Hotels for properties matching a query, with dates and occupancy. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. This is how to find the hotel whose id the info endpoints need; post_dataforseo_business_google_hotel_info_live is the detail view.

Parameters

No path, query, or header parameters.

Request body

  • keywordstringOptional

    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

  • location_namestringOptional

    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_codeintegerOptional

    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_coordinatestringOptional

    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_namestringOptional

    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_codestringOptional

    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

  • depthintegerOptional

    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_instringOptional

    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_outstringOptional

    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

  • currencystringOptional

    currency optional field example: "USD"

  • adultsintegerOptional

    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

  • childreninteger[]Optional

    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]

  • starsinteger[]Optional

    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_ratingnumberOptional

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

  • sort_bystringOptional

    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_priceintegerOptional

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

  • max_priceintegerOptional

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

  • free_cancellationbooleanOptional

    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_rentalsbooleanOptional

    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

  • amenitiesstring[]Optional

    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"

  • tagstringOptional

    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

Example request

curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/business_data/google/hotel_searches/live" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "keyword": "<string>",
  "location_name": "<string>",
  "location_code": 0,
  "location_coordinate": "<string>",
  "language_name": "<string>",
  "language_code": "<string>",
  "depth": 0,
  "check_in": "<string>"
}'

Response

Response fields

  • versionstringOptional

    the current version of the API

  • status_codeintegerOptional

    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

  • status_messagestringOptional

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

  • timestringOptional

    execution time, seconds

  • costnumberOptional

    total tasks cost, USD

  • tasks_countintegerOptional

    *the number of tasks in the tasksarray*

  • tasks_errorintegerOptional

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

  • tasksstring[]Optional

    array of tasks

  • idstringOptional

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

  • status_codeintegerOptional

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

  • status_messagestringOptional

    informational message of the task

  • timestringOptional

    execution time, seconds

  • costnumberOptional

    cost of the task, USD

  • result_countintegerOptional

    number of elements in the result array

  • pathstring[]Optional

    URL path

  • dataobjectOptional

    contains the same parameters that you specified in the POST request

  • resultstring[]Optional

    array of results

  • keywordstringOptional

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

  • location_codeintegerOptional

    location code in a POST array

  • language_codestringOptional

    language code in a POST array

  • check_urlstringOptional

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

  • datetimestringOptional

    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

  • items_countintegerOptional

    item types the number of items in the items array

  • itemsstring[]Optional

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

  • typestringOptional

    *type of element = ‘hotel\_search\_item’*

  • hotel_identifierstringOptional

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

  • titlestringOptional

    title of the hotel

  • starsintegerOptional

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

  • is_paidbooleanOptional

    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

  • locationobjectOptional

    GPS coordinates of the hotel’s location

  • latitudenumberOptional

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

  • longitudenumberOptional

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

  • reviewsobjectOptional

    hotel reviews and rating information

  • valuenumberOptional

    the average rating based on all reviews

  • votes_countintegerOptional

    the number of votes

  • mentionsstring[]Optional

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

  • rating_distributionobjectOptional

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

  • other_sites_reviewsstring[]Optional

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

  • overview_imagesstring[]Optional

    featured images for a hotel

  • pricesobjectOptional

    hotel price

  • priceintegerOptional

    price per night

  • price_without_discountintegerOptional

    full price per night without a discount applied

  • currencystringOptional

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

  • discount_textstringOptional

    text about a discount applied

  • check_instringOptional

    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

  • check_outstringOptional

    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

  • visitorsintegerOptional

    number of hotel visitors for this price

  • itemsstring[]Optional

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