Resolve by name and address

Request#

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

Body#

JSON object. Unknown fields are rejected with 422.

• qstringrequiredmin length 2, max length 200

  Hotel name plus city, region or country.

• glstringdefault us

  Country market for the search.

  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 search.

• limitintegerdefault 3min 1, max 3

  How many candidates to resolve with addresses (1-3).

• 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

Example request#

curl -X POST "https://api.scrapercompany.com/v1/hotels/resolve" \
  -H "x-api-key: $SCRAPERCOMPANY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "q": "Hilton Chicago"
  }'

Response#

200 — Properties matching a name and place, each with its property token and mailing address. Metered responses carry x-credits-charged and x-credits-remaining headers (see credit headers).

{
  "search_parameters": {
    "q": "Hilton Chicago",
    "gl": "us",
    "hl": "en",
    "currency": "USD",
    "limit": 3
  },
  "location": "Chicago",
  "properties": [
    {
      "property_token": "ChUIoben2Mv6-CYaCi9tLzA3czVwbjQQAQ",
      "name": "Hilton Chicago",
      "rating": 4.3,
      "reviews": 10999,
      "type": "hotel",
      "address": "720 S Michigan Ave, Chicago, IL 60605, United States",
      "phone": "+1 312-922-4400"
    },
    {
      "property_token": "ChgImtDg_rW5k8iWARoLL2cvMXRzamQ4NncQAQ",
      "name": "Hilton Chicago/Magnificent Mile Suites",
      "rating": 4.2,
      "reviews": 2808,
      "type": "hotel",
      "address": "540 N Michigan Ave, Chicago, IL 60611, United States",
      "phone": "+1 312-661-0640"
    }
  ]
}

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.