Skip to main content
POST
travel.hotels.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

Hotel name, at least three characters.

Required string length: 3 - 200
cityCode
string

City code; refused when the source cannot select it.

Pattern: ^[A-Z]{3}$
coordinates
object

Search center.

radiusKm
integer
default:5

Radius in kilometers, 1 to 100.

Required range: 1 <= x <= 100
country
string

Country filter; refused when unsupported.

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

Maximum properties, up to 50.

Required range: 1 <= x <= 50
cursor
string

Private continuation cursor; currently unsupported.

Required string length: 1 - 1024

Response

The result

results
object[]
required

Matching properties; empty when none match.

Maximum array length: 50