Flights query object

The query object is used when querying the flights autosuggest endpoint.

Layout

query object
├── market
├── locale
├── searchQuery
├── limit
├── isDestination
├── includedEntityTypes

Description

Market and locale are the only required parameters.

Omitting the searchQuery will return a list of popular results. Including the query will return a list of places matches the input query string.

Parameter	Description	Example	Default
market	The market/country your user is in	UK	Required
locale	The locale you want the results in (ISO locale)	en-GB	Required
searchQuery	The query string you wish to search for	GBP	n/a
limit	The number of entities in response, default is 10, min is 1, max is 50	20	10
isDestination	Whether to sort the results for origin or for destination	true	false
includedEntityTypes	Filter the results by one or all of [Nation, Territory, City, Airport] (array input, case sensitive)	[Nation, Territory, City, Airport]	All included

For includedEntityTypes note that an array input is required.

Here is a sample of a query object:

{
  "market": "UK",
  "locale": "en-GB",
  "searchQuery": "united",
  "limit": 10,
  "includedEntityTypes": ["Nation", "City"],
  "isDestination": true
}