Skip to main content
POST
places.query.parse

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

Place search text to interpret.

Required string length: 1 - 512
limit
number

Interpretations to return, up to 10; default 5.

Required range: x >= 1
countries
string[]

Restrict interpretation to these countries.

Required array length: 1 - 20 elements

Two-letter country code.

Pattern: ^[A-Z]{2}$
language
string

Language tag, such as en-GB.

Pattern: ^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,2}$
bias
object

Point used to favor nearby interpretations.

Response

The result

results
object[]
required

Alternative interpretations of the query.