Google Hotel Searches Live

{
  "$defs": {
    "BusinessDataGoogleHotelSearchesLiveRequestInfo": {
      "properties": {
        "adults": {
          "anyOf": [
            {
              "description": "number of adultsoptional fieldif 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 childrenexample:1",
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "amenities": {
          "anyOf": [
            {
              "description": "hotel amenitiesoptional fieldyou can use this field to specify different hotel amenitiesexample: [ \"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\"`",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ]
        },
        "check_in": {
          "anyOf": [
            {
              "description": "check-in dateoptional fieldif 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",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "check_out": {
          "anyOf": [
            {
              "description": "check-out dateoptional fieldif 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",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "children": {
          "anyOf": [
            {
              "description": "number and age of childrenoptional fieldif 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 childrenset 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]",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ]
        },
        "currency": {
          "anyOf": [
            {
              "description": "currencyoptional fieldexample:\"USD\"",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "depth": {
          "anyOf": [
            {
              "description": "parsing depthoptional fieldnumber of results in Google Hotelsdefault value: 18 organic resultsmax value: 140Note: 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",
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "free_cancellation": {
          "anyOf": [
            {
              "description": "hotels with a free cancellationoptional fieldset this field to true if you want to get the list of hotels with free cancellation of reservationsdefault value: false",
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "is_vacation_rentals": {
          "anyOf": [
            {
              "description": "search for vacation rentalsoptional fieldset this field to true if you want to get the list of vacation rentals instead of hotelsdefault value: false",
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "keyword": {
          "anyOf": [
            {
              "description": "keywordoptional fieldthe 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 filedall %## 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 autom",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "language_code": {
          "description": "search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages with their language_code_by making a separate request to",
          "type": "string"
        },
        "language_name": {
          "description": "full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages with language_name by making a separate request to",
          "type": "string"
        },
        "location_code": {
          "description": "search engine location coderequired field if you don't specify location_name_or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations with location_code by making a separate request to the",
          "type": "integer"
        },
        "location_coordinate": {
          "description": "GPS coordinates of a locationrequired field if you don't specify location_name_or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the \"latitude,longitude\" formatthe maximum number of decimal digits for \"latitude\" and \"longitude\": 7Note: if the coordinates are used to set a location, the search will occur in the nearest settlementexample:53.476225,-2.243572n",
          "type": "string"
        },
        "location_name": {
          "description": "full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations with location_name by making a separate request to KingdomNote: in order to obtain accurate search results, the location_name you specify will be automatically appended t",
          "type": "string"
        },
        "max_price": {
          "anyOf": [
            {
              "description": "maximum price per nightoptional fieldthe currency of this value depends on the currency fieldexample:600",
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "min_price": {
          "anyOf": [
            {
              "description": "minimum price per nightoptional fieldthe currency of this value depends on the currency fieldexample:100",
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "min_rating": {
          "anyOf": [
            {
              "description": "minimum ratingoptional fieldyou can use this field to specify guest rating higher than a certain valueexample:2.5",
              "type": "number"
            },
            {
              "type": "null"
            }
          ]
        },
        "search_this_area": {
          "anyOf": [
            {
              "description": "show hotels from the displayed areaoptional fieldcan take the values: true, falsedefault value: trueif set to false the search_this_area mode will be turned offNote: if the search_this_area mode is turned off, the location_name won't be appended to the keyword during searchlearn more about this parameter on our Help Center",
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "sort_by": {
          "anyOf": [
            {
              "description": "results sorting parametersoptional fieldyou can use this field to sort the resultspossible types of sorting:relevance – sort by most relevantlowest_price – sort by the lowest pricehighest_rating – sort by highest ratingmost_reviewed – sort by most revieweddefault value: relevance",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "stars": {
          "anyOf": [
            {
              "description": "hotel starsoptional fieldset this field to [5] if you want to get the list of 5-star hotels onlyexample:[3,4,5]",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ]
        },
        "tag": {
          "anyOf": [
            {
              "description": "user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "body": {
      "items": {
        "anyOf": [
          {
            "oneOf": [
              {
                "$ref": "#/$defs/BusinessDataGoogleHotelSearchesLiveRequestInfo"
              }
            ],
            "type": "object"
          },
          {
            "type": "null"
          }
        ]
      },
      "type": "array"
    }
  },
  "required": [],
  "type": "object"
}