Get Google AI Overview

Inputs

• qstring, optional

  Search query, up to 2,048 characters. Required unless ludocid or kgmid is supplied.

• crstring, optional

  Country restriction: one or more countryXX values joined with |, such as countryUS.

• glstring, optional

  Lowercase two-letter country code used to localize results.

• hlstring, optional

  Google interface and result language, such as en, en-US, or de. Defaults to en.

• lrstring, optional

  Language restriction: one or more lang_xx values joined with |, such as lang_en.

• oqstring, optional

  Original query text from a Google URL, up to 2,048 characters; forwarded unchanged.

• sistring, optional

  Opaque cached Google search context, up to 4,096 characters.

• ibpstring, optional

  Google layout or expansion control, up to 4,096 characters.

• latnumber, optional

  Latitude between -90 and 90. Supply with lon; conflicts with location and uule.

• lonnumber, optional

  Longitude between -180 and 180. Supply with lat; conflicts with location and uule.

• numinteger, optional

  Requested result count, 1 to 10. A best-effort hint: Google may return fewer rows, and results are never padded.

• pwsstring: 0, 1, optional

  Google personalization flag: 0 or 1. 0 asks for non-personalized results.

• tbmstring: lcl, vid, nws, shop, pts, optional

  Google vertical: lcl, vid, nws, shop, or pts. Google Images (isch) is rejected with 400 unsupported_search_vertical.

• tbsstring, optional

  Google search-filter string, such as qdr:w, up to 4,096 characters.

• udsstring, optional

  Opaque Google filter token, up to 4,096 characters.

• as_qstring, optional

  Additional terms that must all match, up to 2,048 characters.

• lsigstring, optional

  Opaque Google local or Knowledge Graph signature, up to 4,096 characters.

• nfprstring: 0, 1, optional

  Set 1 to disable Google spelling auto-correction, or 0 to allow it.

• safestring: active, off, optional

  Google adult-content filtering: active or off.

• uulestring, optional

  Pre-encoded Google location token, up to 2,048 characters. Use only one of location, uule, or lat and lon.

• as_dtstring: i, e, optional

  Include (i) or exclude (e) the as_sitesearch host. Requires as_sitesearch.

• as_eqstring, optional

  Words the results must not contain, up to 2,048 characters.

• as_lqstring, optional

  Return pages that link to this complete HTTP(S) URL.

• as_oqstring, optional

  Additional terms of which any may match, up to 2,048 characters.

• as_rqstring, optional

  Return pages related to this complete HTTP(S) URL.

• gs_lpstring, optional

  Opaque Google autocomplete-session value from a Google URL, up to 4,096 characters; forwarded unchanged.

• kgmidstring, optional

  Google Knowledge Graph machine ID, such as /m/0k8z. Can replace q.

• startinteger, optional

  Result offset for pagination. Defaults to 0.

• as_epqstring, optional

  Exact phrase the results must contain, up to 2,048 characters.

• as_nhiinteger, optional

  Upper bound of a number range. Supply with as_nlo.

• as_nlointeger, optional

  Lower bound of a number range. Supply with as_nhi.

• as_qdrstring, optional

  Date range: d, w, m, or y with an optional positive count, such as m3 for the past three months.

• devicestring: desktop, tablet, mobile, optional

  Google returns its real layout for the selected device: desktop, tablet, or mobile.

• filterstring: 0, 1, optional

  Google similar-results filtering: 0 or 1.

• radiusnumber, optional

  Search radius in meters around location or lat and lon, which it requires. 1 to 199 on desktop, 1 to 1,000 on tablet or mobile.

• ludocidstring, optional

  Decimal Google CID for a local entity search. Can replace q.

• sclientstring, optional

  Google client label such as gws-wiz-serp: up to 64 letters, digits, dots, underscores, or hyphens.

• timeoutnumber, optional

  Optional budget for the entire request in seconds, measured from gateway receipt until the response is ready to send. Includes admission, queueing and settlement. Must be greater than 0 and at most 90. On expiry, the call is not billed and returns 503 request_deadline_exceeded with retryable=true and a request ID. Omit to retain the standard server deadline.

• locationstring, optional

  Human-readable search location, up to 512 characters. Use only one of location, uule, or lat and lon.

• peek_pwsstring: 0, 1, optional

  Google personalization companion flag: 0 or 1, forwarded to Google unchanged.

• color_schemestring: light, dark, optional

  Google's light or dark result presentation.

• as_sitesearchstring, optional

  Hostname to include or exclude, such as example.com. A hostname, not a URL.

• google_domainstring, optional

  A Google domain from Google's supported list, such as google.com or google.co.uk.