Docs
View as Markdown

google.hotels_search

beta 12 credits needs a pack

Search Google Hotels: matching hotels with id, name, stars, rating and location.

GET /v1/google/hotels_search

What you get#

A list of Google results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

What it costs#

  • 12 credits for a fresh fetch, charged only when it succeeds.
  • Free when served from cache (0.2 credit for a cached response over 100 KB).
  • Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

NameTypeRequiredDefaultWhat it isConstraints
keywordstringyes(required)Hotel search query, e.g. hotels in New Yorkmax 200 chars; must match [^\r\n]{2,200}; trimmed, repeated spaces collapsed
location_namestringnoUnited StatesLocation to search from, as an English place name (country, region or city)max 100 chars; must match [A-Za-z0-9 ,.'()-]{2,100}; trimmed, repeated spaces collapsed
language_codestringnoenResult language, ISO code (en, de, fr-CA ...)max 8 chars; must match [a-z]{2}(-[a-z]{2,4})?; trimmed, lowercased

Request#

curl "https://api.onekey.dev/v1/google/hotels_search?keyword=hotels%20in%20New%20York" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Google response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json
{
  "success": true,
  "data": [
    {
      "entity": {
        "id": "ChkIt-example-1",
        "name": "Example Grand Hotel",
        "stats": {
          "rating": 4.4,
          "ratingCount": 5400
        }
      },
      "ext": {
        "stars": 4,
        "sponsored": false
      },
      "place": {
        "lat": 40.7506,
        "lon": -73.9936
      }
    },
    {
      "entity": {
        "id": "ChkIt-example-2",
        "name": "Example Boutique Inn",
        "stats": {
          "rating": 4.1,
          "ratingCount": 900
        }
      },
      "ext": {
        "stars": 3,
        "sponsored": true
      },
      "place": {
        "lat": 40.7306,
        "lon": -73.9866
      }
    }
  ],
  "metadata": {
    "platform": "google",
    "endpoint": "hotels_search",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 12,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source pathOnekey fieldTransform
hotel_identifierentity.id-
titleentity.name-
reviews.valueentity.stats.ratingtoNumber
reviews.votes_countentity.stats.ratingCounttoNumber
starsext.starstoNumber
location.latitudeplace.lattoNumber
location.longitudeplace.lontoNumber
is_paidext.sponsored-

Caching and freshness#

  • Fresh for about 30 minutes. Repeat calls in that window are served from cache and are free.
  • Between 30 minutes and 6 hours the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
  • If the source is down when a refresh is needed, the last copy can be served for up to 1 day more (marked stale).
  • A "not found" is remembered for 2 minutes and is free.
  • The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundUnknown endpoint path.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: beta (not yet verified against the live source).