Skip to main content

List routes

GET 
/v2/routes

List routes. This is a paginated endpoint.

Request​

Query Parameters

    airlineId string

    Filter by airline. Example: 01gevxx0g090m0a78xmvhtfre4

    departureIcao string

    Filter by departure airport. Example: KJFK

    arrivalIcao string

    Filter by arrival airport. Example: YSSY

    icaoFlightNumber string

    Filter by the flight number. This does not include the airline code. Example: 1234

    includeArchived boolean

    Whether to include archived routes. Defaults to false.

    pageSize uint64

    The maximum number of results to return. Defaults to 100. Maximum is 1000.

    pageToken string

    The next_page_token value returned from a previous List request, if any. If used, all other parameters must match the call that provided the token.

Responses​

OK

Schema

    routes

    object[]

    The list of routes.

  • Array [

    • id string

    The unique identifier for the route.

    airline

    object

    An Airline resource represents an airline.

    id string

    Unique identifier for the airline.

    icaoCode string

    The ICAO airline code. Unique. Example: UAL

    iataCode string

    The IATA airline code. This field is not unique. Example: UA

    displayIcaoCode string

    The ICAO airline display code. This is the code that is displayed to users and is usually the same as the ICAO code. However, some airlines have different display codes when they are a subsidiary of another airline, but use the same ICAO code as their parent company. As such, this field may not be unique. Example: UAL

    displayIataCode string

    The IATA airline display code. This is the code that is displayed to users and is usually the same as the IATA code. Currently, this will always be the same as the IATA code. Example: UA

    name string

    The airline name. Example: United Airlines

    icaoFlightNumber string

    This does not include the airline code. Example: 1234

    departure

    object

    An Airport resource represents an airport.

    id string

    The unique identifier of the airport.

    icaoCode string

    The ICAO airport identifier. Unique.

    iataCode string

    The IATA airport identifier. This field is not unique.

    arrival

    object

    An Airport resource represents an airport.

    id string

    The unique identifier of the airport.

    icaoCode string

    The ICAO airport identifier. Unique.

    iataCode string

    The IATA airport identifier. This field is not unique.

    departureTime

    object

    Represents a time of day. The date and time zone are either not significant or are specified elsewhere.

    hours int32

    Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

    minutes int32

    Minutes of hour of day. Must be from 0 to 59.

    seconds int32

    Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

    nanos int32

    Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

    arrivalTime

    object

    Represents a time of day. The date and time zone are either not significant or are specified elsewhere.

    hours int32

    Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

    minutes int32

    Minutes of hour of day. Must be from 0 to 59.

    seconds int32

    Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

    nanos int32

    Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

    duration

    object

    A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years. # Examples Example 1: Compute Duration from two Timestamps in pseudo code. Timestamp start = ...; Timestamp end = ...; Duration duration = ...; duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - start.nanos; if (duration.seconds < 0 && duration.nanos > 0) { duration.seconds += 1; duration.nanos -= 1000000000; } else if (duration.seconds > 0 && duration.nanos < 0) { duration.seconds -= 1; duration.nanos += 1000000000; } Example 2: Compute Timestamp from Timestamp + Duration in pseudo code. Timestamp start = ...; Duration duration = ...; Timestamp end = ...; end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + duration.nanos; if (end.nanos < 0) { end.seconds -= 1; end.nanos += 1000000000; } else if (end.nanos >= 1000000000) { end.seconds += 1; end.nanos -= 1000000000; } Example 3: Compute Duration from datetime.timedelta in Python. td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration.FromTimedelta(td) # JSON Mapping In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".

    seconds int64

    Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

    nanos int32

    Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 seconds field and a positive or negative nanos field. For durations of one second or more, a non-zero value for the nanos field must be of the same sign as the seconds field. Must be from -999,999,999 to +999,999,999 inclusive.

    daysFlown enum[]

    Possible values: [DAY_OF_WEEK_UNSPECIFIED, DAY_OF_WEEK_MONDAY, DAY_OF_WEEK_TUESDAY, DAY_OF_WEEK_WEDNESDAY, DAY_OF_WEEK_THURSDAY, DAY_OF_WEEK_FRIDAY, DAY_OF_WEEK_SATURDAY, DAY_OF_WEEK_SUNDAY]

    The days of the week that this flight operates.

    aircraftModels

    object[]

    The aircraft models that operate this route.

  • Array [

    • id string

    Unique identifier of the aircraft model.

    aircraftType

    object

    An AircraftType resource represents a type of aircraft, irrespective of the airline that operates it.

    id string

    Unique identifier of the aircraft type.

    icaoCode string

    The ICAO aircraft type code. Unique. Example: B738

    iataCode string

    The IATA aircraft type code. Example: 738

    name string

    The name of the aircraft type. Example: Boeing 737-800

    airline

    object

    An Airline resource represents an airline.

    id string

    Unique identifier for the airline.

    icaoCode string

    The ICAO airline code. Unique. Example: UAL

    iataCode string

    The IATA airline code. This field is not unique. Example: UA

    displayIcaoCode string

    The ICAO airline display code. This is the code that is displayed to users and is usually the same as the ICAO code. However, some airlines have different display codes when they are a subsidiary of another airline, but use the same ICAO code as their parent company. As such, this field may not be unique. Example: UAL

    displayIataCode string

    The IATA airline display code. This is the code that is displayed to users and is usually the same as the IATA code. Currently, this will always be the same as the IATA code. Example: UA

    name string

    The airline name. Example: United Airlines

    name string

    The name of the aircraft model. Example: Boeing 737-824(WL)

  • ]

    • archived boolean

    Whether this route is archived. An archived route cannot be booked by pilots.

  • ]

    • nextPageToken string

    The next_page_token value to include in a subsequent List request. When paginating, all other parameters provided to List must match the call that provided the page token. When this field is empty, there are no more results. However, if the field is non-empty, there may not be any more results on the next page.

Loading...