Maps places search

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 200

  Maps search query.

• glstringdefault us

  Country 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

• hlstringdefault en

  Language.

Example request#

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

Response#

200 — Places matching a Maps query, with tokens for the detail call. Metered responses carry x-credits-charged and x-credits-remaining headers (see credit headers).

{
  "search_parameters": {
    "engine": "google_maps_search",
    "q": "Hilton Chicago",
    "gl": "us",
    "hl": "en"
  },
  "places": [
    {
      "place_token": "0x880e2c99242c7a2f:0x4de3d4bb09dba1",
      "name": "Hilton Chicago",
      "address": "720 S Michigan Ave, Chicago, IL 60605",
      "gps_coordinates": {
        "latitude": 41.872259199999995,
        "longitude": -87.624696
      },
      "rating": 4.3,
      "phone": "(312) 922-4400",
      "website": "https://www.hilton.com/en/hotels/chichhh-hilton-chicago/",
      "category": "Hotel"
    },
    {
      "place_token": "0x880e2c99242c7a2f:0x31660dda0c86665",
      "name": "The Chicago Hotel Collection Wrigleyville",
      "address": "844 W Addison St, Chicago, IL 60613",
      "gps_coordinates": {
        "latitude": 41.945531,
        "longitude": -87.654866
      },
      "rating": 4.1,
      "phone": "(773) 525-4700",
      "website": "https://www.chicago-hotel-collection.com/",
      "category": "Hotel"
    }
  ],
  "total": 2,
  "meta": {
    "source": "google_maps",
    "wire_bytes": 270014,
    "elapsed_s": 0.712
  }
}

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.