// request reference
Google Search parameters
Send query parameters with GET /api/google/search. Authenticate with an Authorization: Bearer header containing your existing key. Keep keys on your server, not in browser code.
The groups below list every request field, including compatibility restrictions. Read the extended reference for detailed types, defaults, parameter combinations and additional examples.
Query or entity
Supply a query, Google local CID, or Knowledge Graph machine ID.
fast_modeReturn organic results only. Skips AI Overview and all other result groups.
true Onfalse OffqRequired unless ludocid or kgmid is supplied; up to 2,048 characters.
Example / input hint: coffee shops in Austin
ludocidDecimal Google CID for a local entity search.
Example / input hint: 1234567890123456789
kgmidGoogle Knowledge Graph machine ID.
Example / input hint: /m/0k8z
Geography
Choose location, uule, or latitude and longitude. Radius depends on device.
locationHuman-readable location; conflicts with uule and lat/lon.
Example / input hint: Austin, Texas
uulePre-encoded Google location; conflicts with location and lat/lon.
Example / input hint: w+CAIQICI…
latBetween -90 and 90; supply with longitude.
Example / input hint: 30.2672
lonBetween -180 and 180; supply with latitude.
Example / input hint: -97.7431
radiusDecimal meters from 1–199 on desktop or 1–1,000 on tablet/mobile; requires geography.
Example / input hint: 150.75
Knowledge Graph controls
Pass Google entity, layout, and cached-context tokens without rewriting them.
lsigOpaque local/Knowledge Graph signature.
siOpaque cached Google search context.
ibpGoogle layout or expansion control.
udsOpaque Google filter token.
color_schemeSelect Google’s light or dark result presentation.
lightdarkLocalization
Control Google domain, language, country, restrictions, and device.
hlGoogle interface and result language.
Example / input hint: en
glTwo-letter country localization code.
Example / input hint: us
google_domainA Google domain such as google.com or google.co.uk.
Example / input hint: google.com
crOne or more countryXX values joined with |.
Example / input hint: countryUS
lrOne or more lang_xx values joined with |.
Example / input hint: lang_en
deviceSelect desktop, tablet, or mobile request behavior.
desktoptabletmobileFiltering & pagination
Apply native Google filtering, vertical, date, safety, and offset controls.
tbsGoogle tbs filter string.
safeGoogle adult-content filtering.
activeoffnfprSet Google nfpr to 0 or 1.
01filterSet Google result filtering to 0 or 1.
01pwsSet Google pws to 0 or 1; 0 asks for non-personalized results.
01peek_pwsSet Google peek_pws to 0 or 1; forwarded to Google unchanged.
01tbmGoogle vertical such as nws, shop, vid, lcl, or pts. Google Images (isch) is not supported.
Example / input hint: nws
startNon-negative Google result offset.
Example / input hint: 0
numBest-effort first-page result count, 1 to 100.
Example / input hint: 10
Advanced query
Expose Google’s complete advanced-search parameter family.
as_dtInclude or exclude as_sitesearch.
i includee excludeas_epqExact phrase query.
as_eqExcluded phrase query.
as_lqRequire results that link to this HTTP(S) URL.
Example / input hint: https://example.com
as_nloInteger lower bound; requires as_nhi.
Example / input hint: 10
as_nhiInteger upper bound; requires as_nlo.
Example / input hint: 100
as_oqAny-of terms.
as_qAdditional all-of terms.
as_qdrd, w, m, or y with an optional positive count.
Example / input hint: m3
as_rqFind pages related to this HTTP(S) URL.
Example / input hint: https://example.com
as_sitesearchHostname to include or exclude.
Example / input hint: example.com
oqAutocomplete original-query lineage value; forwarded verbatim.
gs_lpGoogle gs_lp autocomplete-session token; forwarded verbatim.
sclientGoogle client identifier such as gws-wiz-serp.
Example / input hint: gws-wiz-serp
// response
Work with the complete JSON response
Response groups include organic_results, knowledge_graph, ai_overview, related_questions, related_searches, shopping_results, immersive_products, perspectives, pagination. Groups and fields depend on the upstream result.
The SDK examples use raise_for_error() or raiseForError() so API errors are not mistaken for successful results.