Skip to content
Docs

Property details

The address-bearing render for one property token.

POST/v1/hotels/property
5 creditsTry it

The search card omits the mailing address; pinning the token answers with the details widget, parsed like any property card: name, mailing address, phone, rating, review count, class, times. Use it to confirm a /v1/hotels/search result is the property you meant before targeting it with rate or review calls. The stay dates it prices are transport for this call and not its answer.

Request

POSThttps://api.scrapercompany.com/v1/hotels/property

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

Run this request on your own API key from this page, with the values you type. Signed out? Sign in or get an API key.

Body

JSON object. Unknown fields are rejected with 422.

  • property_tokenstringrequiredmin length 10, max length 200

    Token returned by POST /v1/hotels/search.

  • 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

    Country for the request.

    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

  • hlstringdefault en

    Language for the request.

Example request

curl -X POST "https://api.scrapercompany.com/v1/hotels/property" \
  -H "x-api-key: $SCRAPERCOMPANY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "property_token": "ChUIoben2Mv6-CYaCi9tLzA3czVwbjQQAQ"
  }'

Response

200 — One property's details record: name, mailing address, phone. Metered responses carry x-credits-charged and x-credits-remaining headers (see credit headers).

200 response
{
  "type": "hotel",
  "property_token": "ChUIoben2Mv6-CYaCi9tLzA3czVwbjQQAQ",
  "name": "Hilton Chicago",
  "data_id": "0x880e2c99242c7a2f:0x4de3d4bb09dba1",
  "description": "Modern lodging with a restaurant & an indoor pool.",
  "gps_coordinates": {
    "latitude": 41.8722592,
    "longitude": -87.624696
  },
  "country": "US",
  "address": "720 S Michigan Ave, Chicago, IL 60605, United States",
  "phone": "+1 312-922-4400",
  "check_in_time": "3:00 PM",
  "check_out_time": "11:00 AM",
  "hotel_class": "3-star hotel",
  "extracted_hotel_class": 3,
  "rating": 4.3,
  "reviews": 10999,
  "reviews_histogram": {
    "1": 596,
    "2": 428,
    "3": 880,
    "4": 2607,
    "5": 6488
  },
  "reviews_breakdown": [],
  "amenities": [
    "Free Wi-Fi",
    "Indoor pool"
  ],
  "amenity_codes": [
    [
      1,
      165
    ]
  ],
  "excluded_amenities": [],
  "essential_info": [],
  "thumbnail": "https://lh3.googleusercontent.com/gps-cs-s/REDACTED",
  "images": [],
  "nearby_places": [],
  "rate": {
    "currency": "USD",
    "check_in": "2027-03-24",
    "check_out": "2027-03-25",
    "nights": 1,
    "from_display_text": false
  }
}

Errors

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

StatusMeaningRetry?
401Unauthorized

Missing or invalid API key.

{"detail":"missing or invalid API key"}
No, fix the request
402Payment Required

Not enough credits for this request: the account's credits mode is enforce (mode in GET /v1/billing) and the request costs more than the available credits. Nothing is run or charged.

{"detail":"insufficient credits: this request costs 5, 0 available. Credits renew 2026-11-01."}
No, fix the request
404Not Found

The property, stay, job or record was not found.

{"detail":"job not found"}
No, fix the request
422Unprocessable Content

Request validation failed. detail is a list of problems for schema errors, or a string for semantic checks performed by the endpoint.

{"detail":[{"loc":["body","name"],"msg":"Field required","type":"missing"}]}
No, fix the request
429Too Many Requests

Too many requests: the key's requests-per-minute limit was exceeded, or (in enforce credits mode) the plan's concurrent-request limit. No rate-limit or Retry-After headers are sent; back off and retry.

{"detail":"rate limit 60/min exceeded"}
Yes, with backoff
502Bad Gateway

The upstream source failed, blocked the request or returned an unusable answer. Safe to retry later; failed requests are not charged.

{"detail":"RuntimeError"}
Yes, with backoff
503Service Unavailable

Temporarily unavailable: a dependency of this endpoint is down, or the upstream source changed its contract. Retry later.

{"detail":"database unavailable: OperationalError"}
Yes, with backoff

Try it

Press Try it above to run this request on your own key, with the values you type (sign in first). For a no-code walkthrough, use the workspace’s guided Try it.

  1. Export your key: export SCRAPERCOMPANY_API_KEY=sk_... (no key yet? start a free trial).
  2. Copy the cURL example above and run it in a terminal.

Credits

5 credits per successful call. Failed, blocked and empty results are free.

Questions about this page?

Send the page link and your question, and the team will answer.

Email support