Skip to main content
POST
places.search

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
query
string
required

Search text.

Required string length: 1 - 2048
circle
object

Point and radius search area.

bounds
object

Rectangle search area.

routeCorridor
object

Search along a route.

categories
string[]

Included categories.

Maximum array length: 50
Required string length: 1 - 80
excludedCategories
string[]

Excluded categories.

Maximum array length: 50
Required string length: 1 - 80
brands
string[]

Brand filters.

Maximum array length: 20
Required string length: 1 - 128
openNow
boolean

Only currently open places.

minRating
number

Minimum average rating.

Required range: 0 <= x <= 5
priceLevels
enum<string>[]

Allowed price categories.

Maximum array length: 5
Available options:
free,
inexpensive,
moderate,
expensive,
very_expensive
language
string

Language tag, such as en or en-US.

Required string length: 1 - 35
Pattern: ^[a-zA-Z]{2,8}(?:-[a-zA-Z0-9]{1,8})*$
region
string

Two-letter region code.

Required string length: 1 - 2
Pattern: ^[A-Za-z]{2}$
limit
integer
default:10

Maximum rows, at most 50; a source may decline lower limits it cannot honor.

Required range: 1 <= x <= 50
groups
enum<string>[]

Extra output groups; reviews and summary use the highest price tier.

Maximum array length: 6
Available options:
contact,
hours,
rating,
photos,
reviews,
summary
rank
enum<string>

Result ordering.

Available options:
relevance,
distance,
popularity
strictCategories
boolean

Require category matches.

includeServiceAreaBusinesses
boolean

Include businesses without storefronts.

includeFutureOpeningBusinesses
boolean

Include businesses not yet open.

cursor
string

Next-page cursor; repeat the same query options.

Required string length: 1 - 20000

Response

The result

results
object[]
required

Matching places.

Maximum array length: 50
nextCursor
string

Next-page cursor.

Required string length: 1 - 20000