Google Hotels property (SearchAPI)

Request#

Authenticate with your API key in the x-api-key header (see Authentication).

Body#

JSON object. Unknown fields are rejected with 422.

• property_tokenstringrequiredmin length 8

  Google property token — SearchAPI's name for the same value /v1/search returns as token.

• check_in_datestring (date)required

  First night of the stay, YYYY-MM-DD.

• check_out_datestring (date)required

  Departure date. Must be after check_in_date.

• adultsintegerdefault 2min 1, max 8

  Adults in the room. Two is the hotel default; pass one for a hostel, which is priced per bed. Any value from 1 to 8 is accepted.

• currencystringdefault USD

  ISO 4217 code for the returned prices. Major currencies include AED, AUD, BRL, CAD, CHF, CNY, EUR, GBP, HKD, INR, JPY, KRW, MXN, NZD, SGD, USD; all 39 supported codes are listed in the enum.

  39 allowed values

  AED, ARS, AUD, BRL, CAD, CHF, CLP, CNY, COP, CZK, DKK, EGP, EUR, GBP, HKD, HUF, IDR, ILS, INR, JPY, KRW, MXN, MYR, NOK, NZD, PEN, PHP, PLN, QAR, RON, SAR, SEK, SGD, THB, TRY, TWD, USD, VND, ZAR

• glstringdefault us

  Two-letter country for the Google request, SearchAPI's spelling of market.

  251 allowed values

  ad, ae, af, ag, ai, al, am, ao, aq, ar, as, at, au, aw, ax, az, ba, bb, bd, be, bf, bg, bh, bi, bj, bl, bm, bn, bo, bq, br, bs, bt, bv, bw, by, bz, ca, cc, cd, cf, cg, ch, ci, ck, cl, cm, cn, co, cr, cu, cv, cw, cx, cy, cz, de, dj, dk, dm, do, dz, ec, ee, eg, eh, er, es, et, fi, fj, fk, fm, fo, fr, ga, gb, gd, ge, gf, gg, gh, gi, gl, gm, gn, gp, gq, gr, gs, gt, gu, gw, gy, hk, hm, hn, hr, ht, hu, id, ie, il, im, in, io, iq, ir, is, it, je, jm, jo, jp, ke, kg, kh, ki, km, kn, kp, kr, kw, ky, kz, la, lb, lc, li, lk, lr, ls, lt, lu, lv, ly, ma, mc, md, me, mf, mg, mh, mk, ml, mm, mn, mo, mp, mq, mr, ms, mt, mu, mv, mw, mx, my, mz, na, nc, ne, nf, ng, ni, nl, no, np, nr, nu, nz, om, pa, pe, pf, pg, ph, pk, pl, pm, pn, pr, ps, pt, pw, py, qa, re, ro, rs, ru, rw, sa, sb, sc, sd, se, sg, sh, si, sj, sk, sl, sm, sn, so, sr, ss, st, sv, sx, sy, sz, tc, td, tf, tg, th, tj, tk, tl, tm, tn, to, tr, tt, tv, tw, tz, ua, ug, uk, um, us, uy, uz, va, vc, ve, vg, vi, vn, vu, wf, ws, xk, ye, yt, za, zm, zw

• property_namestringdefault

  Optional. Improves official-site detection when the hotel's own row is labelled with its brand name.

• sourcesarray of string | nullmin items 1, max items 20

  Optional seller allowlist. Names are canonicalized, so Expedia.com and Expedia are equivalent. Omit for all Google sellers.

• source_coveragestringdefault full

  full starts iPhone and desktop renders in parallel for maximum breadth. adaptive starts with iPhone and fetches desktop only when a requested seller is absent.

  One ofadaptivefull

Example request#

curl -X POST "https://api.scrapercompany.com/v1/serp/google_hotels_property" \
  -H "x-api-key: $SCRAPERCOMPANY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "property_token": "ChUIoben2Mv6-CYaCi9tLzA3czVwbjQQAQ",
    "check_in_date": "2026-11-30",
    "check_out_date": "2026-12-01",
    "adults": 2,
    "currency": "USD",
    "gl": "us"
  }'

Response#

200 — SearchAPI's google_hotels_property shape. `extracted_price` is populated, which theirs omits. Metered responses carry x-credits-charged and x-credits-remaining headers (see credit headers).

{
  "search_parameters": {
    "engine": "google_hotels_property",
    "property_token": "ChUIoben2Mv6-CYaCi9tLzA3czVwbjQQAQ",
    "check_in_date": "2029-02-05",
    "check_out_date": "2029-02-06",
    "adults": 2,
    "currency": "USD",
    "gl": "us",
    "nights": 1
  },
  "property": {
    "property_token": "ChUIoben2Mv6-CYaCi9tLzA3czVwbjQQAQ",
    "name": "Hilton Chicago",
    "hotel_class": "4-star hotel",
    "hotel_class_stars": 4,
    "rating": 4.3,
    "reviews": 10695,
    "deal": "25% less than usual",
    "deal_description": "Great Deal",
    "has_deal": true,
    "price_insights": {
      "lowest_price": "$304",
      "price_level": "typical",
      "price_level_code": 2,
      "typical_price_range": {
        "low_price": "$304",
        "high_price": "$521"
      }
    },
    "all_offers": [
      {
        "source": "Hilton Chicago",
        "is_official": true,
        "num_guests": 2,
        "room_id": "rate-plan-42",
        "price_per_night": {
          "price": "$2,907",
          "extracted_price": 2907.11,
          "extracted_price_before_taxes": 2445,
          "currency": "USD"
        },
        "total_price": {
          "price": "$2,907",
          "extracted_price": 2907.11,
          "extracted_price_before_taxes": 2445,
          "currency": "USD"
        },
        "tax_basis": "deeplink",
        "is_outlier": false
      }
    ],
    "featured_offers": [
      {
        "source": "Hilton Chicago",
        "is_official": true,
        "num_guests": 2,
        "room_id": "rate-plan-42",
        "price_per_night": {
          "price": "$2,907",
          "extracted_price": 2907.11,
          "extracted_price_before_taxes": 2445,
          "currency": "USD"
        },
        "total_price": {
          "price": "$2,907",
          "extracted_price": 2907.11,
          "extracted_price_before_taxes": 2445,
          "currency": "USD"
        },
        "tax_basis": "deeplink",
        "is_outlier": false
      }
    ],
    "price_per_night": {
      "price": "$2,208",
      "extracted_price": 2207.96
    },
    "currency_verified": true,
    "tax_profile": {
      "rate": 0.208,
      "confidence": "low"
    }
  },
  "meta": {
    "wire_bytes": 2754373,
    "elapsed_s": 1.548,
    "offers": 15,
    "priced": 15,
    "property_fetch": "miss",
    "tax_profile_cache": "hit"
  }
}

Response fields#

Fields marked required are always present; others appear when they apply.

• search_parametersobjectrequired
  Show 10 child fieldsHide child fields

  • search_parameters.enginestringrequired

    One ofgoogle_hotels_property

  • search_parameters.property_tokenstringrequired
  • search_parameters.check_in_datestring (date)required
  • search_parameters.check_out_datestring (date)required
  • search_parameters.adultsintegerrequired
  • search_parameters.currencystringrequired
  • search_parameters.glstringrequired
  • search_parameters.nightsintegerrequired
  • search_parameters.sourcesarray of string

    Present only when sources was requested.

  • search_parameters.source_coveragestring

    Present only when sources was requested.

• propertyobjectrequired
  Show 20 child fieldsHide child fields

  • property.property_tokenstringrequired
  • property.namestringrequired
  • property.hotel_classstringrequired
  • property.hotel_class_starsinteger | nullrequired
  • property.ratingnumber | nullrequired
  • property.reviewsinteger | nullrequired
  • property.dealstring | nullrequired
  • property.deal_descriptionstring | nullrequired
  • property.has_dealbooleanrequired
  • property.price_insightsobjectrequired
    Show 4 child fieldsHide child fields

    • property.price_insights.lowest_pricestring | nullrequired

      As Google displays it, e.g. $304.

    • property.price_insights.price_levelstring | nullrequired
    • property.price_insights.price_level_codeinteger | nullrequired
    • property.price_insights.typical_price_rangeobject | nullrequired
  • property.all_offersarray of objectrequired
    Show 18 child fieldsHide child fields

    • property.all_offers[].sourcestringrequired

      Seller label (official offers use the hotel's rendered name).

    • property.all_offers[].raw_sourcestringrequired
    • property.all_offers[].is_officialbooleanrequired
    • property.all_offers[].num_guestsintegerrequired
    • property.all_offers[].room_idstring | nullrequired
    • property.all_offers[].price_per_nightobjectrequired
    • property.all_offers[].total_priceobjectrequired
    • property.all_offers[].tax_basisstringrequired

      One ofdeeplinkderivedunknown

    • property.all_offers[].is_outlierbooleanrequired
    • property.all_offers[].roomsarray of objectrequired
    • property.all_offers[].is_featuredbooleanrequired
    • property.all_offers[].has_free_cancellationbooleanrequired
    • property.all_offers[].free_cancellation_untilstring | nullrequired
    • property.all_offers[].free_cancellation_timestring | nullrequired
    • property.all_offers[].price_derived_from_roombooleanrequired
    • property.all_offers[].headline_price_totalnumber | nullrequired
    • property.all_offers[].headline_price_before_taxesnumber | nullrequired
    • property.all_offers[].provenanceobjectrequired

      Where, when and how one normalized price was observed.

  • property.featured_offersarray of objectrequired

    Offers Google rendered as featured cards.

    Show 18 child fieldsHide child fields

    • property.featured_offers[].sourcestringrequired

      Seller label (official offers use the hotel's rendered name).

    • property.featured_offers[].raw_sourcestringrequired
    • property.featured_offers[].is_officialbooleanrequired
    • property.featured_offers[].num_guestsintegerrequired
    • property.featured_offers[].room_idstring | nullrequired
    • property.featured_offers[].price_per_nightobjectrequired
    • property.featured_offers[].total_priceobjectrequired
    • property.featured_offers[].tax_basisstringrequired

      One ofdeeplinkderivedunknown

    • property.featured_offers[].is_outlierbooleanrequired
    • property.featured_offers[].roomsarray of objectrequired
    • property.featured_offers[].is_featuredbooleanrequired
    • property.featured_offers[].has_free_cancellationbooleanrequired
    • property.featured_offers[].free_cancellation_untilstring | nullrequired
    • property.featured_offers[].free_cancellation_timestring | nullrequired
    • property.featured_offers[].price_derived_from_roombooleanrequired
    • property.featured_offers[].headline_price_totalnumber | nullrequired
    • property.featured_offers[].headline_price_before_taxesnumber | nullrequired
    • property.featured_offers[].provenanceobjectrequired

      Where, when and how one normalized price was observed.

  • property.price_per_nightobject | nullrequired

    Lowest all-in nightly price across offers.

    Show 2 child fieldsHide child fields

    • property.price_per_night.pricestringrequired
    • property.price_per_night.extracted_pricenumberrequired
  • property.provenanceobject | nullrequired

    Provenance of the lowest-priced offer.

    Show 15 child fieldsHide child fields

    • property.provenance.schema_versionintegerrequired

      Provenance schema version (currently 1).

    • property.provenance.observation_idstringrequired

      Deterministic id of this price observation (rateobs_...).

    • property.provenance.collection_idstringrequired

      Id shared by every price from one upstream fetch (ratecol_...).

    • property.provenance.observed_atstringrequired

      UTC observation time, ISO-8601.

    • property.provenance.sourcestringrequired

      Upstream source, e.g. google_hotels_calendar.

    • property.provenance.source_kindstringrequired

      Kind of source, e.g. calendar, offer, ota_calendar, official.

    • property.provenance.collectorstringrequired

      Identifier of the collector that produced the price.

    • property.provenance.source_property_idstringrequired

      Property identifier at the source.

    • property.provenance.requested_marketstring | nullrequired
    • property.provenance.requested_currencystring | nullrequired
    • property.provenance.returned_currencystring | nullrequired
    • property.provenance.egress_modestringrequired

      How the request reached the source, e.g. direct.

    • property.provenance.price_basisstringrequired

      What the price represents, e.g. room_base_before_taxes_and_fees.

    • property.provenance.derivationstringrequired

      How the figure was derived, e.g. normalized_upstream.

    • property.provenance.upstream_rate_idstring | nullrequired

      Source-native rate/room id when available.

  • property.currency_verifiedbooleanrequired
  • property.requested_marketstringrequired
  • property.egress_marketstring | nullrequired
  • property.egress_geo_locked_okbooleanrequired
  • property.price_insights_market_verifiedbooleanrequired
  • property.tax_profileobject | nullrequired
    Show 2 child fieldsHide child fields

    • property.tax_profile.ratenumberrequired
    • property.tax_profile.confidencestringrequired

      One ofhighlownone

• metaobjectrequired
  Show 6 child fieldsHide child fields

  • meta.wire_bytesintegerrequired
  • meta.elapsed_snumberrequired
  • meta.offersintegerrequired
  • meta.pricedintegerrequired
  • meta.property_fetchstringrequired
  • meta.tax_profile_cachestringrequired

Errors#

Errors return a JSON body with a detail field. Failed requests are not charged. See Errors for the full list and retry advice.

Try it#

1. Export your key: export SCRAPERCOMPANY_API_KEY=sk_... (no key yet? request access).
2. Copy the cURL example above and run it in a terminal.
3. Or open the interactive playground on api.scrapercompany.com, paste your key and pick this endpoint.