Flight Search API Documentation

Authentication

All API requests require an X-API-Key header for authentication.

API Parameters

Parameter	Endpoints	Type	Default	Required	Image	Description
rangeStartDate	All	string	-	Required	-	Flight search start date (YYYY-MM-DD). For /offers and /offersAI: used with trip length to find all possible offers. For /flights: exact outbound date. Range: today+1 to today+365 days.
rangeEndDate	All	string	-	Required	-	Flight search end date (YYYY-MM-DD). For one-way flights: searches all dates between start and end. For /flights: exact inbound date. Max: startDate + 199 days.
origins	All	array[string]	-	Required	-	List of 3-digit IATA airport codes for departure cities, (offers and offersAI can have up to 100 codes, but for flights and links exactly 1)
destinations	All	array[string]	-	Required	-	List of 3-digit IATA airport codes for arrival cities, (offers and offersAI can have up to 100 codes, but for flights and links exactly 1)
passengerType.adults	All	integer	1	Optional		Number of adult passengers, (sum of all must be between 1 and 9)
passengerType.children	All	integer	0	Optional		Number of child passengers (2-11 years old), at most 2 per adult
passengerType.infantInSeat	All	integer	0	Optional		Number of infants requiring their own seat (under 2 years), at most 2 per adult
passengerType.infantOnLap	All	integer	0	Optional		Number of infants traveling on adult's lap (under 2 years), at most 2 per adult
itineraryType	All	string	ROUND-TRIP	Optional		Type of trip itinerary. Options: ROUND-TRIP, ONE-WAY, MULTI-CITY, MULTI-CITY is not implemented yet
cabin	All	string	ECONOMY	Optional		Preferred cabin class. Options: ECONOMY, PREMIUM, BUSINESS, FIRST
numStops	All	string	ANY-STOPS	Optional		Maximum stops allowed. Options: NON-STOP, ONE-OR-FEWER-STOPS, TWO-OR-FEWER-STOPS, ANY-STOPS
currency	All	string	USD	Optional		ISO 4217 currency code for pricing
language	All	string	en	Optional		Language code for localized content
maxPrice	All	integer	-	Optional		Maximum price filter in selected currency
flightDuration	All	integer	-	Optional		Maximum total flight duration in minutes
showSeparateTickets	All	boolean	false	Optional		Include flights requiring separate tickets.
excludedAirlines	All	array[string]	[]	Optional		List of 2-digit IATA airline codes to exclude from results
onlyAirlines	All	array[string]	[]	Optional		List of 2-digit IATA airline codes to include exclusively
excludedAirports	All	array[string]	[]	Optional		List of 3-digit IATA airport codes to avoid for connections/layovers
onlyAirports	All	array[string]	[]	Optional		List of 3-digit IATA airport codes - if connections exist, they must be at these airports
maxLayover	All	integer	-	Optional		Maximum layover time in minutes
minLayover	All	integer	-	Optional		Minimum layover time in minutes - useful to avoid tight connections or explore layover cities like setting a layover of 1200 minutes to explore a city
avoidUSConnections	All	boolean	false	Optional	-	Exclude flights with connections through US airports
requestLocation	All	string	US	Optional		Request origin region - affects US connection handling. Options: US, EU
departHourStart	All	integer	-	Optional		Earliest acceptable departure hour (0-23, where 0 = midnight)
departHourEnd	All	integer	-	Optional		Latest acceptable departure hour (0-23, where 23 = 11 PM)
arrivalHourStart	All	integer	-	Optional		Earliest acceptable arrival hour (0-23, where 0 = midnight)
arrivalHourEnd	All	integer	-	Optional		Latest acceptable arrival hour (0-23, where 23 = 11 PM)
emissions	All	boolean	false	Optional		Filter to show only low-emission flights (environmentally friendly options)
excludeBasicEconomy	All	boolean	false	Optional		Exclude basic economy fares (works for flights within/between USA and Canada)
requestCheapestFlights	All	boolean	false	Optional		Prioritize cheapest options (searches random OTAs) vs best flights
showAllFlights	All	boolean	true	Optional		Return all available flights vs top results only (recommended: true for comprehensive results)
minTripLength	offers, offersAI	integer	-	Mandatory for offers/offersAI	-	Minimum trip duration in days - filters offers based on stay length
maxTripLength	offers, offersAI	integer	-	Mandatory for offers/offersAI	-	Maximum trip duration in days - filters offers based on stay length
sortByIndex	flights	integer	1	Optional		Sort results by: 1=Top flights, 2=Price, 3=Departure time, 4=Arrival time, 5=Duration, 6=Emissions
outboundFlightLegs	flights, links	array[object]	-	flights: Optional, links: Required		Selected outbound flight details (origin, date, destination, airline, flightNumber)
inboundFlightLegs	links	array[object]	-	Optional		Selected inbound flight details (required for round-trip bookings)

/offersPOST

Test Parameters

Required Parameters

Origins

Destinations

Start Date

End Date

Passengers

Adults

Children

Infant Seat

Infant Lap

Trip Configuration

Mandatory for offers

Min Trip Length (days)

Max Trip Length (days)

Itinerary Type

Cabin

Stops

Currency

Price & Duration

Max Price

Max Duration (min)

Airlines & Airports

Excluded Airlines

Only Airlines

Excluded Airports

Only Airports

Time Preferences

Depart Hour Start

Depart Hour End

Arrival Hour Start

Arrival Hour End

Special Options

Low emissions only

Exclude basic economy

Avoid US connections

Response Schema

{
  "offers": [
    {
      "startDate": "2024-01-15",
      "returnDate": "2024-01-22", 
      "price": 450,
      "tripLength": 7,
      "origin": "LAX",
      "destination": "LHR",
      "url": "https://booking-link.com/..."
    }
  ],
  "combinations": 1250,
  "average": 520,
  "minPrice": 380,
  "maxPrice": 890
}

/offersAIPOST

Test Parameters

Required Parameters

Origins

Destinations

Start Date

End Date

Passengers

Adults

Children

Infant Seat

Infant Lap

Trip Configuration

Mandatory for offersAI

Min Trip Length (days)

Max Trip Length (days)

Itinerary Type

Cabin

Stops

Currency

Price & Duration

Max Price

Max Duration (min)

Airlines & Airports

Excluded Airlines

Only Airlines

Excluded Airports

Only Airports

Time Preferences

Depart Hour Start

Depart Hour End

Arrival Hour Start

Arrival Hour End

Special Options

Low emissions only

Exclude basic economy

Avoid US connections

Response Schema

{
  "routes": {
    "LAX": {
      "LHR": {
        "7": [
          {
            "s": "2024-01-15",
            "r": "2024-01-22",
            "p": 450,
            "u": "https://booking-link.com/..."
          }
        ]
      }
    }
  },
  "combinations": 1250,
  "average": 520,
  "minPrice": 380,
  "maxPrice": 890
}

/flightsPOST

Test Parameters

Required Parameters

Origins

Destinations

Start Date

End Date

Passengers

Adults

Children

Infant Seat

Infant Lap

Trip Configuration

Itinerary Type

Cabin

Stops

Currency

Price & Duration

Max Price

Max Duration (min)

Airlines & Airports

Excluded Airlines

Only Airlines

Excluded Airports

Only Airports

Time Preferences

Depart Hour Start

Depart Hour End

Arrival Hour Start

Arrival Hour End

Special Options

Low emissions only

Exclude basic economy

Avoid US connections

Flights Options

Sort By

Response Schema

/urlsPOST

Test Parameters

Required Parameters

Origins

Destinations

Start Date

End Date

Passengers

Adults

Children

Infant Seat

Infant Lap

Trip Configuration

Itinerary Type

Cabin

Stops

Currency

Price & Duration

Max Price

Max Duration (min)

Airlines & Airports

Excluded Airlines

Only Airlines

Excluded Airports

Only Airports

Time Preferences

Depart Hour Start

Depart Hour End

Arrival Hour Start

Arrival Hour End

Special Options

Low emissions only

Exclude basic economy

Avoid US connections

Response Schema

{
  "url": "https://www.google.com/travel/flights/search?tfs=CBwQAhooEgoyMDI0LTAxLTE1agcIARIDTEFYcgcIARIDTEhSGgoyMDI0LTAxLTIyagcIARIDTEhScgcIARIDTEFYcAGCAQsI____________AUABSAGYAQE"
}