Skip to main content
POST
travel.flight-offers.search

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

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
slices
object[]
required

Journey legs, up to six.

Required array length: 1 - 6 elements
passengers
object[]
required

Passenger labels and age or category, up to nine.

Required array length: 1 - 9 elements
cabinClass
enum<string>

Travel cabin.

Available options:
economy,
premium_economy,
business,
first
maxConnections
integer

Maximum connections per leg.

Required range: 0 <= x <= 2
currency
string

Requested quote currency; refused if the source cannot select it.

Pattern: ^[A-Z]{3}$
limit
integer
default:20

Maximum offers returned, at most 100.

Required range: 1 <= x <= 100
allowSplitTickets
boolean
default:false

Explicit split-ticket request; refused until supported.

airlineCreditRefs
string[]

Private airline credit references; requires a future scoped resolver.

Maximum array length: 9

The ref returned by a future airline credit call.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
privateFares
object[]

Explicit private fare codes; no user or account IDs.

Maximum array length: 10

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.