Skip to main content
POST
travel.locations.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-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
query
string

Airport or city name or public code.

Required string length: 1 - 200
coordinates
object

Search center.

radiusKm
number
default:5

Nearby search radius in kilometers.

Required range: 0.001 <= x <= 100
types
enum<string>[]

Location types to keep.

Required array length: 1 - 2 elements
Available options:
airport,
city
country
string

Country filter; currently unsupported.

Pattern: ^[A-Z]{2}$
limit
integer
default:10

Maximum locations, up to 50.

Required range: 1 <= x <= 50

Response

The result

results
object[]
required

Matching places; empty when none match.

Maximum array length: 50