Top Destinations

The Top Destinations API retrieves top booked leisure destinations from a given origin and returns them in ascending rank order.

The API looks up the traffic volume booked via the Sabre® GDS to the top destinations for the previous 2, 8 or 12 weeks. It returns up to 50 results per origin by rank — rank one is most popular; whereas, rank 50 is least popular. Origin can be a multi-airport city (MAC) code, airport code, country code, or all possible origins (domestic and international) combined.

Examples

Request for most popular destinations

You could use this API to feature the most popular destinations around the world from a given origin. For example, to search for top destinations out of New York City, use the multi-airport city (MAC) code "NYC" for origin. The response will be up to 50 of the top destinations, and from any airport associated with New York City, including but not limited to, John F. Kennedy International (JFK).

Request for most popular destinations by theme

You could use this API to feature top destinations by theme . For example, using San Francisco International (SFO) airport code "SFO" for origin, the response will be top destinations such as McCarran International Airport (LAS), Las Vegas, and Aruba (AUA). Both destinations are associated to, and can be filtered by theme. Las Vegas is associated as a GAMBLING theme, and Aruba, a BEACH theme.

See usage notes: for more information on retrieving multi-airport city (MAC) codes using the Multi-Airport City Lookup API, retrieving a list of airport codes associated with a theme using the Theme Airport Lookup API.

Data used by Top Destinations API

  • Top Destinations API data is derived from flights booked via the Sabre GDS during the 2, 8 or 12 weeks before an API request.
  • Destination data is based on combined passenger types.
  • From each booking, the final destination of the outbound flight leg is used as input data.
  • Destination data is combined at the city level by multi-airport city (MAC) code. If an airport does not belong to a MAC, then data is returned at the airport code level.
  • Destination data is derived from bookings made by leisure travel agencies throughout the world.

API suitability

This API is suitable for:

  • Travelers who want to choose a destination based on popularity.
  • Travelers who want to choose a destination based on theme, e.g., BEACH .
  • Travelers who want to choose a destination based on country or region, e.g., EUROPE .

See usage notes: for more information on retrieving a list of airport codes associated with a theme using the Theme Airport Lookup API.

HTTP method and endpoint

GET /v1/lists/top/destinations

Request

All parameters are optional and can be used in any combination in any request. Values are not case sensitive.

origin

string, optional

3-letter IATA code of the origin airport or multi-airport city (MAC) code

Sample value: origin=ATL

If origin and origincountry are both specified, the API returns an error (only one value is accepted).

If no origin or origincountry  is specified, the API retrieves top destinations for all origins combined.

Note: If origin airport code and multi-airport city (MAC) are the same 3-letter string, origin airport is replaced with MAC-level data instead. For example, Cincinnati is a MAC (code: "CVG") containing two airports, "CVG" and "LUK." Only top destinations for the MAC "CVG" will be returned.

See usage notes: for more information on retrieving multi-airport city (MAC) codes using the Multi-Airport City Lookup API, or to identify the airports associated with a MAC using the Airports at Cities Lookup API.

origincountry

string, optional

2-letter ISO 3166 country code

Retrieves top destinations data specific to flights booked to this specified origin country

Only one value is accepted

Default: all origin countries

If origin and origincountry are both specified, thenthe API returns an error (only one value is accepted).

If no origin specified, then the API retrieves data for origincountry 

If no origin or origincountry specified, then API retrieves top destinations for all origins combined

Sample value: origincountry=MX

destinationtype

string, optional

Default value: overall

Valid values: domestic, international or overall*

If no origin or origincountry specified, the API returns an error

Note: destinationtype  only applicable if origin or origincountry is specified

*Domestic is defined as a destination located in the same country as the origin. International is defined as a destination located in a country other than the origin. Overall does not consider either international or domestic origin and uses both domestic and international combined.

theme

string, optional

Finds destination airport codes associated with a travel theme

Valid values: any valid custom or supported Sabre travel theme

Sample value: theme=beach

See usage notes: for more information on the Custom Theme API, retrieving a list of Sabre themes using the Travel Theme Lookup API, or to retrieve airport codes associated with a Sabre theme using the Theme Airport Lookup API.

topdestinations

number, optional

A filter that returns up to the quantity defined by this parameter. For example, if a quantity of 3 is defined, i.e., topdestinations=3, then three of the most popular destinations will be returned in ascending rank order.

Default value: 50

Valid values: a single value from 1-50, inclusive

Note: The API returns up to 50 results per origin by rank — rank one is most popular; whereas, rank 50 is least popular.

destinationcountry

string, optional

2-letter ISO 3166 country code

Retrieves top destinations data specific to flights booked to this specified destination country

Only one value is accepted

Default: all destination countries

Sample value: destinationcountry=MX

region

string, optional

Retrieves destination airport codes that are associated with the specified region

Only one value is allowed

Valid values:

  • Africa 
  • Asia Pacific 
  • Europe 
  • Latin America 
  • Middle East 
  • North America 

Sample value: region=Europe

lookbackweeks

number, optional

Looks up the traffic volume booked via the Sabre GDS to the top destinations in this specified time window (weeks)

Look-back window for ticketed traffic volume begins on the date the API request is request is made

Default value: 2

Valid values: 2, 8, 12

Sample value: lookbackweeks=8

Note: The API may return a 404 NOT_FOUND error if no data is available for the specific market and look-back period combination.

Response

The response provides a list of top destination objects that reflect the grouping of data by response type: Multi-airport city (MAC) code | Airport code

The primary sort order in the response is by Rank. Rank one is most popular; whereas, rank 50 is least popular.

Multi-airport city (MAC) code

This table describes response data for a MAC destination.

Destinations

array

The parent object for Rank, Destination 

Rank

number

Ranks results by popularity in ascending rank order

Destination

object

The parent object for DestinationLocation, MetropolitanAreaName, CountryCode, CountryName, RegionName, Type, Links 

DestinationLocation

string

3-letter multi-airport city (MAC) code

MetropolitanAreaName

string

The name of the airport that corresponds to DestinationLocation 

CountryCode

string

2-letter ISO 3166 country code that corresponds to DestinationLocation 

CountryName

string

The name of the country that corresponds to DestinationLocation 

RegionName

string

The name of the region that corresponds to DestinationLocation 

Type

string

The type of response that corresponds to DestinationLocation 

Valid value: City

Note: This Type reflects a multi-airport city (MAC) code destination response.

Links

This response describes the MAC links array.

Links

array

Contains airportsInCity link objects for each multi-airport city (MAC)

See usage notes: for more information on links nodes.

airportsInCity

object

Invokes the Airports at Cities Lookup API helper

See usage notes: for more information on the Airports at Cities Lookup API.

Airport code

This table describes response data for an airport code destination.

Destinations

array

The parent object for Rank, Destination 

Rank

number

Ranks results by popularity in ascending rank order

Destination

object

The parent object for DestinationLocation, AirportName, CityName, CountryCode, CountryName, RegionName, Type 

DestinationLocation

string

3-letter IATA airport code

AirportName

string

The name of the airport that corresponds to DestinationLocation 

CityName

string

The city name that corresponds to the 3-letter IATA airport code in DestinationLocation 

CountryCode

string

2-letter ISO 3166 country code that corresponds to DestinationLocation 

CountryName

string

The name of the country that corresponds to DestinationLocation 

RegionName

string

The name of the region that corresponds to DestinationLocation 

Type

string

The type of response that corresponds to DestinationLocation 

Valid value: Airport

Note: This Type reflects an airport code destination response.

Overall response

LookBackWeeks

number

The look-back window for ticketed traffic volume specified in the request

Note: If no value is specified in the request, LookBackWeeks uses the default look-back value of 2 (weeks).

Links

Contains self and linkTemplate 

self

object

Returns the URL of the request that generated the response

linkTemplate

object

Formats a Top Destinations API request with placeholders for every parameter

See usage notes: for more information on links nodes.

Examples: request and response

This example demonstrates a request for the top 5 trending destinations from any airport associated with the multi-airport city (MAC) code for New York City ("NYC"). The following optional filters are also specified: a lookbackweeks value of 8, and a topdestinations value of 5.

GET https://api.sabre.com/v1/lists/top/destinations?origin=NYC&lookbackweeks=8&topdestinations=5 HTTP/1.1
{
    OriginLocation: "NYC",
    Destinations: [{
        Rank: 1,
        Destination: {
            DestinationLocation: "CHI",
            CountryCode: "US",
            CountryName: "United States",
            RegionName: "North America",
            MetropolitanAreaName: "Chicago",
            Links: [{
                rel: "airportsInCity",
                href: "https://api.sabre.com/v1/lists/supported/cities/CHI/airports"
            }],
            Type: "City"
        }
    }, {
        Rank: 2,
        Destination: {
            DestinationLocation: "CUN",
            AirportName: "Cancun",
            CityName: "Cancun",
            CountryCode: "MX",
            CountryName: "Mexico",
            RegionName: "Latin America",
            Type: "Airport"
        }
    }, {
        Rank: 3,
        Destination: {
            DestinationLocation: "LAS",
            AirportName: "McCarran International Airport",
            CityName: "Las Vegas",
            CountryCode: "US",
            CountryName: "United States",
            RegionName: "North America",
            Type: "Airport"
        }
    }, {
        Rank: 4,
        Destination: {
            DestinationLocation: "ORL",
            CountryCode: "US",
            CountryName: "United States",
            RegionName: "North America",
            MetropolitanAreaName: "Orlando",
            Links: [{
                rel: "airportsInCity",
                href: "https://api.sabre.com/v1/lists/supported/cities/ORL/airports"
            }],
            Type: "City"
        }
    }, {
        Rank: 5,
        Destination: {
            DestinationLocation: "MIA",
            AirportName: "Miami International Airport",
            CityName: "Miami",
            CountryCode: "US",
            CountryName: "United States",
            RegionName: "North America",
            Type: "Airport"
        }
    }],
    LookBackWeeks: 8,
    Links: [{
        rel: "self",
        href: "https://api.sabre.com/v1/lists/top/destinations?origin=NYC&lookbackweeks=8&topdestinations=5"
    }, {
        rel: "linkTemplate",
        href: "https://api.sabre.com/v1/lists/top/destinations?origin=<origin>&origincountry=<origincountry>&topdestinations=<topdestinations>&destinationtype=<destinationtype>&theme=<theme>&destinationcountry=<destinationcountry>®ion=<region>&lookbackweeks=<lookbackweeks>"
    }]
}
        

This example demonstrates a request for all top trending destinations from "SFO" (San Francisco International). The following optional filters are also specified: a theme value of BEACH, and a Region value of North America. See usage notes: for more information on retrieving a list of airport codes associated with a theme using the Theme Airport Lookup API.

GET https://api.sabre.com/v1/lists/top/destinations?origin=SFO&theme=BEACH&region=North America HTTP/1.1
{
    Theme: "BEACH",
    OriginLocation: "SFO",
    Destinations: [{
        Rank: 1,
        Destination: {
            DestinationLocation: "BOS",
            AirportName: "General Edward Lawrence Logan Internatio",
            CityName: "Boston",
            CountryCode: "US",
            CountryName: "United States",
            RegionName: "North America",
            Type: "Airport"
        }
    }, {
        Rank: 2,
        Destination: {
            DestinationLocation: "HNL",
            AirportName: "Honolulu International Airport",
            CityName: "Honolulu",
            CountryCode: "US",
            CountryName: "United States",
            RegionName: "North America",
            Type: "Airport"
        }
    }, {
        Rank: 3,
        Destination: {
            DestinationLocation: "SEA",
            CountryCode: "US",
            CountryName: "United States",
            RegionName: "North America",
            MetropolitanAreaName: "Seattle",
            Links: [{
                rel: "airportsInCity",
                href: "https://api.sabre.com/v1/lists/supported/cities/SEA/airports"
            }],
            Type: "City"
        }
    }, {
        Rank: 4,
        Destination: {
            DestinationLocation: "LAX",
            AirportName: "Los Angeles International Airport",
            CityName: "Los Angeles",
            CountryCode: "US",
            CountryName: "United States",
            RegionName: "North America",
            Type: "Airport"
        }
    }, {
        Rank: 5,
        Destination: {
            DestinationLocation: "ORL",
            CountryCode: "US",
            CountryName: "United States",
            RegionName: "North America",
            MetropolitanAreaName: "Orlando",
            Links: [{
                rel: "airportsInCity",
                href: "https://api.sabre.com/v1/lists/supported/cities/ORL/airports"
            }],
            Type: "City"
        }
    }, {
        Rank: 6,
        Destination: {
            DestinationLocation: "MIA",
            AirportName: "Miami International Airport",
            CityName: "Miami",
            CountryCode: "US",
            CountryName: "United States",
            RegionName: "North America",
            Type: "Airport"
        }
    }, {
        Rank: 7,
        Destination: {
            DestinationLocation: "OGG",
            AirportName: "Kahului Airport",
            CityName: "Kahului",
            CountryCode: "US",
            CountryName: "United States",
            RegionName: "North America",
            Type: "Airport"
        }
    }, {
        Rank: 8,
        Destination: {
            DestinationLocation: "SNA",
            AirportName: "John Wayne Airport",
            CityName: "Santa Ana",
            CountryCode: "US",
            CountryName: "United States",
            RegionName: "North America",
            Type: "Airport"
        }
    }, {
        Rank: 9,
        Destination: {
            DestinationLocation: "FLL",
            AirportName: "Fort Lauderdale - Hollywood Internationa",
            CityName: "Fort Lauderdale",
            CountryCode: "US",
            CountryName: "United States",
            RegionName: "North America",
            Type: "Airport"
        }
    }, {
        Rank: 10,
        Destination: {
            DestinationLocation: "RDU",
            AirportName: "Raleigh-Durham International Airport",
            CityName: "Durham",
            CountryCode: "US",
            CountryName: "United States",
            RegionName: "North America",
            Type: "Airport"
        }
    }, {
        Rank: 11,
        Destination: {
            DestinationLocation: "TPA",
            CountryCode: "US",
            CountryName: "United States",
            RegionName: "North America",
            MetropolitanAreaName: "Tampa - St Petersburg",
            Links: [{
                rel: "airportsInCity",
                href: "https://api.sabre.com/v1/lists/supported/cities/TPA/airports"
            }],
            Type: "City"
        }
    }],
    LookBackWeeks: 2,
    Links: [{
        rel: "self",
        href: "https://api.sabre.com/v1/lists/top/destinations?origin=SFO&theme=BEACH®ion=North%20America"
    }, {
        rel: "linkTemplate",
        href: "https://api.sabre.com/v1/lists/top/destinations?origin=<origin>&origincountry=<origincountry>&topdestinations=<topdestinations>&destinationtype=<destinationtype>&theme=<theme>&destinationcountry=<destinationcountry>®ion=<region>&lookbackweeks=<lookbackweeks>"
    }]
}
        

Usage notes

Country and airport codes

Links nodes

  • Sabre® REST APIs have one or more Links nodes that combine related URI resources in a response. For more information, see the links nodes page.

Airports at Cities Lookup API

To identify the airports associated with a multi-airport city (MAC) code, use the Airports at Cities Lookup API and pass one of the MACs in the request. The Airports at Cities Lookup API retrieves our list of major airport, rail station and other codes that are associated with a single multi-airport city (MAC) code in the request.

Multi-Airport City Lookup API

To get a list of city codes that are served by more than one airport, use the Multi-Airport City Lookup API. These multi-airport city codes can be used with applicable REST APIs.

Custom Theme API

The Custom Theme API enables you to modify and customize themes. You can create a custom travel theme and associate that theme with airport and multi-airport city (MAC) codes. You can then pass your custom theme as a filter in a request with any REST API that supports a theme. The response will be destinations that are associated with your theme.

Theme Airport Lookup API

To get a list of destination airport codes that are associated with the optional theme parameter, use the Theme Airport Lookup API. The response will be a list of valid themes that we associate with that destination, e.g., Las Vegas would be associated as a GAMBLING  destination.

Travel Theme Lookup API

To get a list of valid themes, use the Travel Theme Lookup API. The response will be a list of themes, such as BEACH, GAMBLING .

Errors

An HTTP status code is always returned.

Errors that are specific to this API follow. For more information about HTTP status codes and application error response format, see status codes and errors.

Note: optional parameters are checked for errors when a value is supplied. For example, we do not throw an error if an empty value is passed because all parameters are optional.

404 NOT_FOUND

No results were found

The service cannot find data to fulfill the parameters in the request. For example, data is not available for the origin or dates.

An origin or destination in the request is not a valid IATA airport code or multi-airport city (MAC) code.

The origin is not supported.

Status 413 FULL head

The API returns this error when a request URI is too long. For example, the HTTP request’s query string exceeds the server limit.

The response will be empty as a result.

Please consider reducing the number of request parameters in the URI or separating parameters into multiple HTTP requests.

400 BAD REQUEST

Parameter 'origin' must be a valid airport or city code

Origin must contain 3 letters.

Parameter 'origincountry' must be country code

Value is not a valid country code type, e.g., location=1U.

We do not support specified country code.

Both 'origin' and 'origincountry' have been specified

Value must specify either originor originCountry.

Parameter 'topdestinations' must be between 1 and 50

Value must be between 1-50 inclusive.

Parameter 'topdestinations' must be of type 'number'

Value must be a number (and be between 1-50 inclusive).

Parameter 'destinationtype' must be one of {Domestic,International,Overall}

Value must be domestic, international or overall. Overall indicates both domestic and international combined.

Either 'origin' or 'origincountry' must be specified

originor origincountryvalue must be specified when domestic or international specified.

Parameter 'theme' must be a valid value

The value provided in theme is not supported or not valid.

See usage notes: for more information on the Custom Theme API, retrieving a list of Sabre themes using the Travel Theme Lookup API, or to retrieve airport codes associated with a Sabre theme using the Theme Airport Lookup API.

Parameter 'destinationcountry' must be country code

Value is not a valid country code.

Value is not a valid country code type, e.g., location=1U.

Parameter 'region' must be one of '{Africa,Asia Pacific,Europe,Latin America,Middle East,North America}

Value is not a valid regionvalue.

Parameter 'lookbackweeks' must be of type 'number'

Value must be a number (and be 2, 8 or 12).

Parameter 'lookbackweeks' must be one of '{2,8,12}'

Value must be 2, 8 or 12.

Docs Navigation