Flights live pricing API (3.0)

Authentication

UserAuth

Security Scheme Type	API Key
Header parameter name:	x-api-key

FlightsService

/search/create

Authorizations:

UserAuth

Request Body schema: application/json

object (liveQuery)

Query object for request.

market	string Market for which the search is for. e.g. `UK`. We provide a Culture API to get all the markets we support. See Culture API Documentation.
locale	string Locale that the results are returned in. e.g. `en-GB`. We provide a Culture API to get all the locales we support. See Culture API Documentation.
currency	string Currency that the search results are returned in. e.g. `GBP`. We provide a Culture API to get all the currencies we support. See Culture API Documentation.
	Array of objects (liveQueryLeg) [ items ] List of legs to search for.
cabinClass	string (liveCabinClass) Default: "CABIN_CLASS_UNSPECIFIED" Enum: "CABIN_CLASS_UNSPECIFIED" "CABIN_CLASS_ECONOMY" "CABIN_CLASS_PREMIUM_ECONOMY" "CABIN_CLASS_BUSINESS" "CABIN_CLASS_FIRST" Cabin class Enum to specify class. E.g.: `economy`, `business`, `first`. CABIN_CLASS_UNSPECIFIED: cabin class is not specified. CABIN_CLASS_ECONOMY: cabin class is economy. CABIN_CLASS_PREMIUM_ECONOMY: cabin class is premium economy. CABIN_CLASS_BUSINESS: cabin class is business. CABIN_CLASS_FIRST: cabin class is first class.
adults	integer <int32> Number of adults. Should be greater than or equal to 1.
childrenAges	Array of integers <int32> [ items <int32 > ] List of children ages.
includedCarriersIds	Array of strings List of included carriers.
excludedCarriersIds	Array of strings List of excluded carriers.
includedAgentsIds	Array of strings List of included agents.
excludedAgentsIds	Array of strings List of excluded agents.
includeSustainabilityData	boolean Option to include sustainability data.
nearbyAirports	boolean (Option to include nearby airports)

Responses

Request samples

Payload

Content type

application/json

{"query": {"market": "string",
"locale": "string",
"currency": "string",
"queryLegs": [{"originPlaceId": {"iata": "string",
"entityId": "string"
},
"destinationPlaceId": {"iata": "string",
"entityId": "string"
},
"date": {"year": 0,
"month": 0,
"day": 0
}
}
],
"cabinClass": "CABIN_CLASS_UNSPECIFIED",
"adults": 0,
"childrenAges": [0
],
"includedCarriersIds": ["string"
],
"excludedCarriersIds": ["string"
],
"includedAgentsIds": ["string"
],
"excludedAgentsIds": ["string"
],
"includeSustainabilityData": true,
"nearbyAirports": true
}
}

Response samples

Content type

application/json

{"sessionToken": "string",
"status": "RESULT_STATUS_UNSPECIFIED",
"action": "RESULT_ACTION_UNSPECIFIED",
"content": {"results": {"itineraries": {"property1": {"pricingOptions": [{"price": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED"
},
"agentIds": ["string"
],
"items": [{"price": {"amount": null,
"unit": null
},
"agentId": "string",
"deepLink": "string",
"fares": [null
]
}
],
"transferType": "TRANSFER_TYPE_UNSPECIFIED"
}
],
"legIds": ["string"
],
"sustainabilityData": {"isEcoContender": true,
"ecoContenderDelta": 0
}
},
"property2": {"pricingOptions": [{"price": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED"
},
"agentIds": ["string"
],
"items": [{"price": {"amount": null,
"unit": null
},
"agentId": "string",
"deepLink": "string",
"fares": [null
]
}
],
"transferType": "TRANSFER_TYPE_UNSPECIFIED"
}
],
"legIds": ["string"
],
"sustainabilityData": {"isEcoContender": true,
"ecoContenderDelta": 0
}
}
},
"legs": {"property1": {"originPlaceId": "string",
"destinationPlaceId": "string",
"departureDateTime": {"year": 0,
"month": 0,
"day": 0,
"hour": 0,
"minute": 0,
"second": 0
},
"arrivalDateTime": {"year": 0,
"month": 0,
"day": 0,
"hour": 0,
"minute": 0,
"second": 0
},
"durationInMinutes": 0,
"stopCount": 0,
"marketingCarrierIds": ["string"
],
"operatingCarrierIds": ["string"
],
"segmentIds": ["string"
]
},
"property2": {"originPlaceId": "string",
"destinationPlaceId": "string",
"departureDateTime": {"year": 0,
"month": 0,
"day": 0,
"hour": 0,
"minute": 0,
"second": 0
},
"arrivalDateTime": {"year": 0,
"month": 0,
"day": 0,
"hour": 0,
"minute": 0,
"second": 0
},
"durationInMinutes": 0,
"stopCount": 0,
"marketingCarrierIds": ["string"
],
"operatingCarrierIds": ["string"
],
"segmentIds": ["string"
]
}
},
"segments": {"property1": {"originPlaceId": "string",
"destinationPlaceId": "string",
"departureDateTime": {"year": 0,
"month": 0,
"day": 0,
"hour": 0,
"minute": 0,
"second": 0
},
"arrivalDateTime": {"year": 0,
"month": 0,
"day": 0,
"hour": 0,
"minute": 0,
"second": 0
},
"durationInMinutes": 0,
"marketingFlightNumber": "string",
"marketingCarrierId": "string",
"operatingCarrierId": "string"
},
"property2": {"originPlaceId": "string",
"destinationPlaceId": "string",
"departureDateTime": {"year": 0,
"month": 0,
"day": 0,
"hour": 0,
"minute": 0,
"second": 0
},
"arrivalDateTime": {"year": 0,
"month": 0,
"day": 0,
"hour": 0,
"minute": 0,
"second": 0
},
"durationInMinutes": 0,
"marketingFlightNumber": "string",
"marketingCarrierId": "string",
"operatingCarrierId": "string"
}
},
"places": {"property1": {"entityId": "string",
"parentId": "string",
"name": "string",
"type": "PLACE_TYPE_UNSPECIFIED",
"iata": "string",
"coordinates": {"latitude": 0,
"longitude": 0
}
},
"property2": {"entityId": "string",
"parentId": "string",
"name": "string",
"type": "PLACE_TYPE_UNSPECIFIED",
"iata": "string",
"coordinates": {"latitude": 0,
"longitude": 0
}
}
},
"carriers": {"property1": {"name": "string",
"allianceId": "string",
"imageUrl": "string",
"iata": "string"
},
"property2": {"name": "string",
"allianceId": "string",
"imageUrl": "string",
"iata": "string"
}
},
"agents": {"property1": {"name": "string",
"type": "AGENT_TYPE_UNSPECIFIED",
"imageUrl": "string",
"feedbackCount": 0,
"rating": 0,
"ratingBreakdown": {"customerService": 0,
"reliablePrices": 0,
"clearExtraFees": 0,
"easeOfBooking": 0,
"other": 0
},
"isOptimisedForMobile": true
},
"property2": {"name": "string",
"type": "AGENT_TYPE_UNSPECIFIED",
"imageUrl": "string",
"feedbackCount": 0,
"rating": 0,
"ratingBreakdown": {"customerService": 0,
"reliablePrices": 0,
"clearExtraFees": 0,
"easeOfBooking": 0,
"other": 0
},
"isOptimisedForMobile": true
}
},
"alliances": {"property1": {"name": "string"
},
"property2": {"name": "string"
}
}
},
"stats": {"itineraries": {"minDuration": 0,
"maxDuration": 0,
"total": {"count": 0,
"minPrice": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED"
}
},
"stops": {"direct": {"total": {"count": 0,
"minPrice": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED"
}
},
"ticketTypes": {"singleTicket": {"count": 0,
"minPrice": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED"
}
},
"multiTicketNonNpt": {"count": 0,
"minPrice": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED"
}
},
"multiTicketNpt": {"count": 0,
"minPrice": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED"
}
}
}
},
"oneStop": {"total": {"count": 0,
"minPrice": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED"
}
},
"ticketTypes": {"singleTicket": {"count": 0,
"minPrice": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED"
}
},
"multiTicketNonNpt": {"count": 0,
"minPrice": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED"
}
},
"multiTicketNpt": {"count": 0,
"minPrice": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED"
}
}
}
},
"twoPlusStops": {"total": {"count": 0,
"minPrice": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED"
}
},
"ticketTypes": {"singleTicket": {"count": 0,
"minPrice": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED"
}
},
"multiTicketNonNpt": {"count": 0,
"minPrice": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED"
}
},
"multiTicketNpt": {"count": 0,
"minPrice": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED"
}
}
}
}
},
"hasChangeAirportTransfer": true
}
},
"sortingOptions": {"best": [{"score": 0,
"itineraryId": "string"
}
],
"cheapest": [{"score": 0,
"itineraryId": "string"
}
],
"fastest": [{"score": 0,
"itineraryId": "string"
}
]
}
}
}

/search/poll

Authorizations:

UserAuth

path Parameters

sessionToken

required

string

Session token required for polling operations.

Responses

Response samples

Content type

application/json

{"sessionToken": "string",
"status": "RESULT_STATUS_UNSPECIFIED",
"action": "RESULT_ACTION_UNSPECIFIED",
"content": {"results": {"itineraries": {"property1": {"pricingOptions": [{"price": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED"
},
"agentIds": ["string"
],
"items": [{"price": {"amount": null,
"unit": null
},
"agentId": "string",
"deepLink": "string",
"fares": [null
]
}
],
"transferType": "TRANSFER_TYPE_UNSPECIFIED"
}
],
"legIds": ["string"
],
"sustainabilityData": {"isEcoContender": true,
"ecoContenderDelta": 0
}
},
"property2": {"pricingOptions": [{"price": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED"
},
"agentIds": ["string"
],
"items": [{"price": {"amount": null,
"unit": null
},
"agentId": "string",
"deepLink": "string",
"fares": [null
]
}
],
"transferType": "TRANSFER_TYPE_UNSPECIFIED"
}
],
"legIds": ["string"
],
"sustainabilityData": {"isEcoContender": true,
"ecoContenderDelta": 0
}
}
},
"legs": {"property1": {"originPlaceId": "string",
"destinationPlaceId": "string",
"departureDateTime": {"year": 0,
"month": 0,
"day": 0,
"hour": 0,
"minute": 0,
"second": 0
},
"arrivalDateTime": {"year": 0,
"month": 0,
"day": 0,
"hour": 0,
"minute": 0,
"second": 0
},
"durationInMinutes": 0,
"stopCount": 0,
"marketingCarrierIds": ["string"
],
"operatingCarrierIds": ["string"
],
"segmentIds": ["string"
]
},
"property2": {"originPlaceId": "string",
"destinationPlaceId": "string",
"departureDateTime": {"year": 0,
"month": 0,
"day": 0,
"hour": 0,
"minute": 0,
"second": 0
},
"arrivalDateTime": {"year": 0,
"month": 0,
"day": 0,
"hour": 0,
"minute": 0,
"second": 0
},
"durationInMinutes": 0,
"stopCount": 0,
"marketingCarrierIds": ["string"
],
"operatingCarrierIds": ["string"
],
"segmentIds": ["string"
]
}
},
"segments": {"property1": {"originPlaceId": "string",
"destinationPlaceId": "string",
"departureDateTime": {"year": 0,
"month": 0,
"day": 0,
"hour": 0,
"minute": 0,
"second": 0
},
"arrivalDateTime": {"year": 0,
"month": 0,
"day": 0,
"hour": 0,
"minute": 0,
"second": 0
},
"durationInMinutes": 0,
"marketingFlightNumber": "string",
"marketingCarrierId": "string",
"operatingCarrierId": "string"
},
"property2": {"originPlaceId": "string",
"destinationPlaceId": "string",
"departureDateTime": {"year": 0,
"month": 0,
"day": 0,
"hour": 0,
"minute": 0,
"second": 0
},
"arrivalDateTime": {"year": 0,
"month": 0,
"day": 0,
"hour": 0,
"minute": 0,
"second": 0
},
"durationInMinutes": 0,
"marketingFlightNumber": "string",
"marketingCarrierId": "string",
"operatingCarrierId": "string"
}
},
"places": {"property1": {"entityId": "string",
"parentId": "string",
"name": "string",
"type": "PLACE_TYPE_UNSPECIFIED",
"iata": "string",
"coordinates": {"latitude": 0,
"longitude": 0
}
},
"property2": {"entityId": "string",
"parentId": "string",
"name": "string",
"type": "PLACE_TYPE_UNSPECIFIED",
"iata": "string",
"coordinates": {"latitude": 0,
"longitude": 0
}
}
},
"carriers": {"property1": {"name": "string",
"allianceId": "string",
"imageUrl": "string",
"iata": "string"
},
"property2": {"name": "string",
"allianceId": "string",
"imageUrl": "string",
"iata": "string"
}
},
"agents": {"property1": {"name": "string",
"type": "AGENT_TYPE_UNSPECIFIED",
"imageUrl": "string",
"feedbackCount": 0,
"rating": 0,
"ratingBreakdown": {"customerService": 0,
"reliablePrices": 0,
"clearExtraFees": 0,
"easeOfBooking": 0,
"other": 0
},
"isOptimisedForMobile": true
},
"property2": {"name": "string",
"type": "AGENT_TYPE_UNSPECIFIED",
"imageUrl": "string",
"feedbackCount": 0,
"rating": 0,
"ratingBreakdown": {"customerService": 0,
"reliablePrices": 0,
"clearExtraFees": 0,
"easeOfBooking": 0,
"other": 0
},
"isOptimisedForMobile": true
}
},
"alliances": {"property1": {"name": "string"
},
"property2": {"name": "string"
}
}
},
"stats": {"itineraries": {"minDuration": 0,
"maxDuration": 0,
"total": {"count": 0,
"minPrice": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED"
}
},
"stops": {"direct": {"total": {"count": 0,
"minPrice": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED"
}
},
"ticketTypes": {"singleTicket": {"count": 0,
"minPrice": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED"
}
},
"multiTicketNonNpt": {"count": 0,
"minPrice": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED"
}
},
"multiTicketNpt": {"count": 0,
"minPrice": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED"
}
}
}
},
"oneStop": {"total": {"count": 0,
"minPrice": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED"
}
},
"ticketTypes": {"singleTicket": {"count": 0,
"minPrice": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED"
}
},
"multiTicketNonNpt": {"count": 0,
"minPrice": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED"
}
},
"multiTicketNpt": {"count": 0,
"minPrice": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED"
}
}
}
},
"twoPlusStops": {"total": {"count": 0,
"minPrice": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED"
}
},
"ticketTypes": {"singleTicket": {"count": 0,
"minPrice": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED"
}
},
"multiTicketNonNpt": {"count": 0,
"minPrice": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED"
}
},
"multiTicketNpt": {"count": 0,
"minPrice": {"amount": "string",
"unit": "PRICE_UNIT_UNSPECIFIED"
}
}
}
}
},
"hasChangeAirportTransfer": true
}
},
"sortingOptions": {"best": [{"score": 0,
"itineraryId": "string"
}
],
"cheapest": [{"score": 0,
"itineraryId": "string"
}
],
"fastest": [{"score": 0,
"itineraryId": "string"
}
]
}
}
}