v1

latestOpenAPI 3.1.02026-07-2470277.8 KB

Cached Search

get/search

Query parameters

origin_airportstring required

A list of origin airports. Comma-delimited if multiple, such as "SFO,LAX".

destination_airportstring required

A list of destination airports. Comma-delimited if multiple, such as "FRA,LHR".

start_datestring

Results must depart between start_date and end_date when specified, in YYYY-MM-DD format.

end_datestring

Results must depart between start_date and end_date when specified, in YYYY-MM-DD format.

cursorinteger

A cursor you obtained from a previous search call.

takeinteger

Maximum amount of results to respond with. Must be >= 10 and <= 1000.

order_bystring

By default, results are ordered by departure date and then by available cabins, with available premium cabins ranked above results without them available. You can alternatively specify lowest_mileage in this parameter to return results with the cheapest prices first.

skipinteger

How many results to skip.

include_tripsboolean

Include trip-level details in the API response. This may degrade response time and sizing.

only_direct_flightsboolean

Only return results that have a direct flight available. Respects the cabin parameter if provided.

carriersstring

Only return results involving these comma-separated carriers (i.e. "DL,AA"). Respects the cabin parameter if provided.

include_filteredboolean

Return results that only have raw (filtered) results. Enable this when using the raw fields to prevent dynamic price filtering.

sourcesstring

A list of mileage programs to filter by. Comma-delimited if multiple, such as "aeroplan,united".

minify_tripsboolean

When include_trips and minify_trips are both enabled, returns a reduced amount of fields in each trip to improve performance.

cabinsstring

Results must have these cabins available when specified. Comma-delimited if multiple, such as "economy,business". Must not be provided if "cabin" was provided.

Response

200

countinteger
hasMoreboolean
cursorinteger

Example response

{
  "data": [
    {
      "ID": "2QSaUXJ0ZuSVqgrRWqkSlXhnVbS",
      "RouteID": "2HmSwbzAS9SnEdtIsf3nkjozpX1",
      "Route": {
        "ID": "2HmSwbzAS9SnEdtIsf3nkjozpX1",
        "OriginAirport": "SFO",
        "OriginRegion": "North America",
        "DestinationAirport": "JFK",
        "DestinationRegion": "North America",
        "NumDaysOut": 75,
        "Distance": 2582,
        "Source": "american"
      },
      "Date": "2023-08-11",
      "ParsedDate": "2023-08-11T00:00:00Z",
      "YAvailable": true,
      "JAvailable": true,
      "FAvailable": true,
      "YMileageCost": "12500",
      "WMileageCost": "0",
      "JMileageCost": "33000",
      "FMileageCost": "33000",
      "YAirlines": "AA, B6",
      "JAirlines": "AA, B6",
      "FAirlines": "AA",
      "YDirect": true,
      "JDirect": true,
      "FDirect": true,
      "Source": "american",
      "CreatedAt": "2023-05-29T08:37:32.218426Z",
      "UpdatedAt": "2023-07-10T13:52:23.343425Z"
    }
  ],
  "count": 42,
  "cursor": 1689009958
}
All 7 operations