Google search-box suggestions for a partial query

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 1, max length 400

  The partial query to complete.

• clientstringdefault chrome

  Which Google suggest client to impersonate: chrome (type + relevance), firefox, safari, toolbar, psy-ab/gws-wiz (entity title, description, thumbnail), or youtube.

  One ofchromefirefoxgws-wizpsy-absafaritoolbaryoutube

• cpinteger | nullmin 0, max 400

  Cursor position inside q (0 = start). Google completes the word at the cursor; omitted means the end of q.

• glstringdefault us

  Country market (Google gl): results are localized to this country.

  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

  Interface language (Google hl).

Example request#

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

Response#

200 — Google's search-box suggestions with type and relevance. Metered responses carry x-credits-charged and x-credits-remaining headers (see credit headers).

{
  "search_parameters": {
    "engine": "google_autocomplete",
    "q": "coffee",
    "client": "chrome",
    "gl": "us",
    "hl": "en"
  },
  "suggestions": [
    {
      "value": "coffee near me",
      "type": "QUERY",
      "relevance": 1250
    },
    {
      "value": "coffee shops near me",
      "type": "QUERY",
      "relevance": 950
    }
  ],
  "verbatim_relevance": 1300,
  "total": 4,
  "meta": {
    "source": "google_autocomplete",
    "wire_bytes": 828,
    "elapsed_s": 0.21,
    "egress_mode": "direct"
  }
}

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.