Flight location 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 100

  City, airport or region name, or a code (paris, Heathrow, NYC).

• hlstringdefault enpattern ^[A-Za-z]{2,3}(-[A-Za-z]{2,4})?$

  Language of the returned names.

• glstringdefault us

  Market/country code (two letters).

  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

Example request#

curl -X POST "https://api.scrapercompany.com/v1/serp/google_flights_location_search" \
  -H "x-api-key: $SCRAPERCOMPANY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "q": "paris",
    "gl": "us"
  }'

Response#

200 — Airports, cities (with their airports) and regions matching the query. Metered responses carry x-credits-charged and x-credits-remaining headers (see credit headers).

{
  "q": "paris",
  "locations": [
    {
      "type": "city",
      "name": "Paris, France",
      "id": "/m/05qtj",
      "city": "Paris",
      "description": "Capital of France",
      "airports": [
        {
          "iata": "CDG",
          "name": "Aéroport de Paris-Charles de Gaulle",
          "city": "Paris",
          "type": "airport",
          "distance": "14 mi"
        },
        {
          "iata": "ORY",
          "name": "Paris Orly Airport",
          "city": "Paris",
          "type": "airport",
          "distance": "9 mi"
        }
      ]
    },
    {
      "type": "airport",
      "name": "Paris Airport-Le Bourget",
      "iata": "LBG",
      "id": "/m/02vwgn",
      "city": "Paris",
      "description": "Airport in France",
      "airports": []
    }
  ],
  "count": 5,
  "wire_bytes": 1593,
  "elapsed_s": 0.146,
  "cached": false
}

Response fields#

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

• qstringrequired

  Echo of the request's q.

• locationsarray of objectrequired

  Google's autocomplete results, in its order. An empty list is not billed.

  Show 7 child fieldsHide child fields

  • locations[].typestringrequired

    One ofairportcityregiontrain_station

  • locations[].namestringrequired

    e.g. Paris, France.

  • locations[].iatastring | nullrequired

    IATA code of an airport or train station; null for cities and regions.

  • locations[].idstring | nullrequired

    Google entity id, e.g. /m/05qtj. A city's id can be passed as departure_id/arrival_id (or a multi_city leg's departure/arrival) of /v1/serp/google_flights to search all of its airports.

  • locations[].citystring | nullrequired
  • locations[].descriptionstring | nullrequired

    e.g. Capital of France, Airport in France.

  • locations[].airportsarray of objectrequired

    For a city: its airports and train stations. Empty otherwise.

    Show 5 child fieldsHide child fields

    • locations[].airports[].iatastringrequired
    • locations[].airports[].namestring | nullrequired
    • locations[].airports[].citystring | nullrequired
    • locations[].airports[].typestringrequired

      One ofairportcityregiontrain_station

    • locations[].airports[].distancestring | nullrequired

      Distance from the city as Google shows it, e.g. 14 mi.

• countintegerrequired

  Number of entries in locations.

• wire_bytesintegerrequired

  Size of Google's response, bytes; 0 when served from cache.

• elapsed_snumberrequired

  Time Google took to answer, seconds; 0 when served from cache.

• cachedbooleanrequired

  Served from the 6-hour cache of repeated queries.

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.