Panorama - Flight Detail

View as Markdown
### Description Returns detailed award-flight options for a specific airport pair and travel date or date range. Results may include economy, premium economy, business, and first-class itineraries. For example, you can retrieve cached flight details from `SFO` to `JFK` for `2024-11-24`. ### Request Fields - `origin` — Origin airport’s IATA code, such as `SFO`. - `arrival` — Destination airport’s IATA code, such as `JFK`. - `date` — Start date of the search in `YYYY-MM-DD` format. - `date_end` — Optional end date in `YYYY-MM-DD` format. When omitted, the API searches only the date specified in `date`. ### Response Fields The response contains flight availability for a specific route, travel date, and loyalty program. #### Top-Level Fields - `date_program` — Travel date and loyalty-program code in `YYYY-MM-DD@PROGRAM` format, such as `2024-02-15@AA`. - `route` — Airport pair in `ORIGIN-DESTINATION` format, such as `SFO-JFK`. - `data_ct` — Total number of cached itineraries found for each cabin class. - `ns_data_ct` — Number of nonstop itineraries found for each cabin class. - `data` — Flight itineraries grouped by cabin class. Each cabin contains a list of available options. - `ls` — Unix timestamp, in seconds, indicating when the response data was last observed. - `ls_s` — Human-readable representation of `ls`. The applicable time zone should be documented. - `status` — Response status code. A value of `200` indicates a successful request. Cabin names such as `Economy`, `Premium Economy`, `Business`, and `First` may appear as dynamic keys in `data`, `data_ct`, and `ns_data_ct`. A cabin may be omitted when no qualifying availability is found. #### `data_ct` Contains the total number of cached itineraries found for each cabin class. ``` { "Economy": 40, "First": 39, "Business": 4 } ``` The count may be greater than the number of itineraries returned in `data` because the API returns only a limited number of the best options for each cabin. #### `ns_data_ct` Contains the number of nonstop itineraries found for each cabin class. ``` { "Economy": 5, "First": 4, "Business": 4 } ``` #### `data` Contains flight options grouped by cabin class: ``` { "Economy": [], "Business": [], "First": [] } ``` Each itinerary may contain the following fields: - `date` — Travel date in `YYYY-MM-DD` format. - `award_points` — Points required for a one-way award ticket for one adult. - `surcharge` — Taxes and carrier-imposed fees associated with the award ticket. - `currency` — ISO currency code used for `surcharge` and `payment.tax`, such as `USD`. - `cabin_type` — Cabin classes included in the itinerary. For mixed-cabin itineraries, cabin names are joined with an ampersand, such as `Economy & First`. - `airline_name` — Airlines operating the itinerary. For itineraries involving multiple airlines, names are joined with an ampersand. - `airline_code` — IATA codes of the operating airlines. Multiple codes are joined with an ampersand, such as `AS & AA`. - `program_code` — Loyalty-program code through which the award can be booked. - `seats` — Number of award seats known to be available at the displayed price. A value of `-1` indicates that seat availability is unknown. - `last_seen` — Unix timestamp, in seconds, indicating when the itinerary was last observed. - `percent_premium` — Percentage of in-flight travel time spent in the requested premium cabin. For example, a first-class result containing an economy segment may have a value below `100`. - `transfer_options` — Other supported points programs or transferable currencies that may be used to book the award. - `payment` — Summary of the points and taxes required for the award. - `fare` — General itinerary information, including total travel time and individual flight segments. ### `transfer_options` Each transfer option may contain: - `program` — Transferable-points program, such as `bilt`. - `points` — Number of transferable points required. ``` { "program": "bilt", "points": 11500 } ``` ### `payment` Contains a summary of the award cost: - `cabin` — Cabin class used to price the award. - `miles` — Number of miles or points required. - `tax` — Taxes and fees charged in the currency specified by `currency`. ``` { "cabin": "Economy", "miles": 11500, "tax": 5.6 } ``` ### `fare` Contains itinerary-level information: - `travel_minutes_total` — Total journey duration in minutes, including connections and layovers. - `travel_time_display` — Human-readable total journey duration, such as `5h 25m`. - `day_count` — Number of calendar-day changes between departure and arrival. A value of `0` indicates arrival on the same calendar date. - `products` — Ordered list of flight segments that make up the itinerary. ### `products` Each item in `products` represents one flight segment: - `origin` — Origin airport’s IATA code. - `destination` — Destination airport’s IATA code. - `departure_time` — Local scheduled departure date and time. - `arrival_time` — Local scheduled arrival date and time. - `airline_code` — IATA code of the airline operating the segment. - `flight_number` — Flight number, including the airline code. - `aircraft` — Aircraft type scheduled for the segment. - `cabin_type` — Cabin class for the segment. - `travel_minutes` — Scheduled flight duration in minutes. - `layover_time` — Layover after this segment, in minutes. A value of `0` generally indicates the final segment or a nonstop itinerary.

Request

This endpoint expects an object.
programstringRequired
originstringRequired
arrivalstringRequired
dateintegerRequired
api_keystringRequired

Response

OK
date_programstring
routestring
data_ctobject
dataobject
lsinteger
ls_sstring
ns_data_ctobject
statusinteger