Google Search

Google AI Overview

Returns only the AI Overview from a Google results page, and accepts the Google Search parameters except fast_mode. When Google shows no AI Overview for the query, ai_overview is null, search_metadata.ai_overview_state is not_served, and the call is not billed.

get/api/google/ai-overview

Request

  • Base URL: https://api.litescrape.com
  • URL: https://api.litescrape.com/api/google/ai-overview
  • Auth: one of:
    • HTTP bearer
    • API key in header zc-signature

Query parameters

qstring
Example:coffee shops in Austin

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

ludocidstring
Example:1234567890123456789

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

kgmidstring
Example:/m/0k8z

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

locationstring
Example:Austin, Texas, United States

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

uulestring

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

latnumber
Example:30.2672

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

lonnumber
Example:-97.7431

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

radiusnumber

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.

lsigstring

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

sistring

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

ibpstring

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

udsstring

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

color_scheme'light' | 'dark'

Google's light or dark result presentation.

google_domainstring
Example:google.com

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

glstring
Example:us

Lowercase two-letter country code used to localize results.

hlstring
Example:en

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

crstring
Example:countryUS

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

lrstring
Example:lang_en

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

device'desktop' | 'tablet' | 'mobile'
Example:desktop

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

tbsstring

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

safe'active' | 'off'

Google adult-content filtering: active or off.

nfpr'0' | '1'

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

filter'0' | '1'

Google similar-results filtering: 0 or 1.

pws'0' | '1'

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

peek_pws'0' | '1'

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

tbm'lcl' | 'vid' | 'nws' | 'shop' | 'pts'

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

startinteger
Example:10

Result offset for pagination. Defaults to 0.

numinteger

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

as_dt'i' | 'e'

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

as_epqstring

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

as_eqstring

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

as_lqstring

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

as_nlointeger

Lower bound of a number range. Supply with as_nhi.

as_nhiinteger

Upper bound of a number range. Supply with as_nlo.

as_oqstring

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

as_qstring

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

as_qdrstring
Example:m3

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

as_rqstring

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

as_sitesearchstring
Example:example.com

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

oqstring

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

gs_lpstring

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

sclientstring

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

timeoutnumber

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.

Response

Successful response. When Google shows no AI Overview for the query, ai_overview is null, search_metadata.ai_overview_state is not_served, and the call is not billed.

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.