Skip to main content
POST
places.area.insights

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
categories
string[]
required

Included categories.

Required array length: 1 - 50 elements
Required string length: 1 - 80
circle
object

Circular area.

polygon
object[]

Closed area polygon.

Required array length: 4 - 1000 elements
excludedCategories
string[]

Excluded categories.

Maximum array length: 50
Required string length: 1 - 80
minRating
number

Minimum rating.

Required range: 0 <= x <= 5
maxRating
number

Maximum rating.

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

Allowed prices.

Maximum array length: 5
Available options:
free,
inexpensive,
moderate,
expensive,
very_expensive
statuses
enum<string>[]

Operating statuses.

Maximum array length: 3
Available options:
operational,
temporarily_closed,
permanently_closed
includePlaces
boolean
default:false

Include handles when at most 100 places match.

Response

The result

count
integer
required

Matching place count.

Required range: 0 <= x <= 9007199254740991
results
object[]

Matching place handles when requested and available.

Maximum array length: 100