Skip to main content
POST
places.autocomplete

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
input
string
required

Partial search text, possibly personal data.

Required string length: 1 - 2048
offset
integer

Unicode character offset.

Required range: 0 <= x <= 9007199254740991
circle
object

Location bias.

bounds
object

Location bias or restriction.

restrictArea
boolean
default:false

Restrict rather than bias to area.

categories
string[]

Primary categories.

Maximum array length: 5
Required string length: 1 - 80
countries
string[]

Country codes.

Maximum array length: 15
Required string length: 1 - 2
Pattern: ^[A-Z]{2}$
origin
object

Distance origin.

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}$
includeQueries
boolean
default:false

Include query suggestions.

Response

The result

results
object[]
required

Place and query predictions.

Maximum array length: 20