// request reference
Google Maps parameters
Send query parameters with GET /api/google/maps. 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.
Search or exact place
Use a query, or one exact-place identifier. The API validates combinations.
qRequired for a search request.
Example / input hint: coffee shops in Austin, TX
typeChoose search or force one exact place result.
searchplaceplace_idGoogle Place ID for an exact-place lookup.
Example / input hint: ChIJ…
data_cidDecimal Google CID for an exact-place lookup.
Example / input hint: 1234567890
dataCopied Google Maps protobuf sequence, up to 8,192 characters.
Example / input hint: !4m5!3m4…
Geography
Choose one viewport family: ll, location, or latitude and longitude.
llUse @lat,lon,zoomz or @lat,lon,radiusm.
Example / input hint: @30.2672,-97.7431,14z
locationHuman-readable location. Pair with z or m.
Example / input hint: Austin, Texas
latSupply with lon and either z or m.
Example / input hint: 30.2672
lonSupply with lat and either z or m.
Example / input hint: -97.7431
zZoom level from 3 through 30.
Example / input hint: 14
mRadius from 1 through 15,028,132 meters.
Example / input hint: 5000
nearbyRemove IP-relative “near me” wording when a viewport is supplied.
truefalseFilters
Named filters are encoded into Google Maps native filter messages.
min_priceNon-negative Google price level.
Example / input hint: 1
max_priceMust be greater than or equal to minimum price.
Example / input hint: 4
min_ratingGoogle treats this as a relevance preference.
2.02.53.03.54.04.5open_stateCannot be combined with open day or hour.
now Open now24h Open 24 hoursopen_on_dayChoose a weekday, optionally with an hour.
mon Mondaytue Tuesdaywed Wednesdaythu Thursdayfri Fridaysat Saturdaysun Sundayopen_at_hourHour from 0 through 23. Requires open_on_day.
Example / input hint: 18
Localization & pagination
Control locale and the native Maps result offset.
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
startNon-negative native Maps offset.
Example / input hint: 0
// response
Work with the complete JSON response
Response groups include local_results, place_results, search_information, 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.