Felo API PlatformFelo API Platform
All DataForSEO endpoints
v0.2.0-beta
OpenAPI 3.1.0

Setting Google Hotel Searches Tasks

Server:https://openapi.felo.ai
Client Libraries

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.

Body
application/json
  • Type: array (object | null)[]
    • adults
      Type: integer | null

      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

    • amenities
      Type: 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"

    • check_in
      Type: string | null

      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

      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

    • children
      Type: 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 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]

    • currency
      Type: string | null

      currency
      optional field
      example:
      "USD"

    • depth
      Type: integer | null

      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

    • free_cancellation
      Type: boolean | null

      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

      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

    • keyword
      Type: 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 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

    • language_code
      Type: string

      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

    • language_name
      Type: string

      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

    • location_code
      Type: integer

      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

      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

    • location_name
      Type: string

      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

    • max_price
      Type: integer | null

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

    • min_price
      Type: integer | null

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

    • min_rating
      Type: number | null

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

    • pingback_url
      Type: string | null

      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=$id
      http://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

    • postback_url
      Type: string | null

      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=$id
      http://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

    • priority
      Type: integer | null

      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.

    • search_this_area
      Type: boolean | null

      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

    • sort_by
      Type: string | null

      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

    • stars
      Type: 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]

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

Responses
  • 200
    Type: object | null · Response36Afe1097B20_BusinessDataGoogleHotelSearchesTaskPostResponseInfo
    • cost
      Type: number | null Format: double

      total tasks cost, USD

    • status_code
      Type: integer | null

      general status code you can find the full list of the response codes here

    • status_message
      Type: string | null

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

    • tasks
      Type: array (object | null)[] | null

      array of tasks

      • Type: object | null · Response36Afe1097B20_BusinessDataGoogleHotelSearchesTaskPostTaskInfo
        • cost
          Type: number | null Format: double

          total tasks cost, USD

        • data
          Type: object | null

          contains the same parameters that you specified in the POST request

          • propertyName
            Type: object | null
        • id
          Type: string | null

          task identifier unique task identifier in our system in the UUID format

        • path
          Type: array (string | null)[] | null

          URL path

        • result
          Type: object | null

          array of results
          in this case, the value will be null

        • result_count
          Type: integer | null Format: int64

          number of elements in the result array

        • status_code
          Type: integer | null

          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

        • status_message
          Type: string | null

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

        • time
          Type: string | null

          execution time, seconds

    • tasks_count
      Type: integer | null Format: int64

      the number of tasks in the tasks array

    • tasks_error
      Type: integer | null Format: int64

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

    • time
      Type: string | null

      total execution time, seconds

    • version
      Type: string | null

      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
Request Example for post/v1/beta/dataforseo/business_data/google/hotel_searches/task_post
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
    }
  ]
}
Setting Google Hotel Searches Tasks

Need help?