Documentation
Terminology
Several terms used in the API have special meanings or are travel-industry specific. They are defined below. For more general information on using the API, please see Basics.
Common Response Properties
Certain key properties are returned on all GET responses.
apiVersion
The version of the API that serviced the request. As of now, this value will always match the version of the endpoint used by the caller as indicated in the URL. This documentation will be updated for any future changes to API versions of sub-versions.
serviceUnits
Responses contain a variable number of objects organized in a typical tree structure. Service Units is the count of the objects found in the leaves of the tree and are typically the billable unit for a paid API call. This property is primarily intended for auditing purposes and not for display in end-user products and services.
Airport Object
iataCode
The common three-letter code assigned to each airport worldwide by the International Air Transport Association. It is the same code that is used when consumer travelers are booking flights. Example: LAX and JFK.
icaoCode
The four-letter code assigned to each airport worldwide by the International Civil Aviation Organization.
shortName
The acronym for the official name of the airport. Example: ABIA is used for Austin-Bergstrom International Airport. Not every airport has a well-known acronym. For those that don't, their nickname will be used instead.
fullName
The full unabbreviated name of the airport. Example: Los Angeles International Airport.
Checkpoint Queue Object
accessTypes
Queue Access Types describe the accessibility of the queue to travelers, depending on the security privileges or special requirements they may have. The table below describes each possible type. Note that a queue may have more than one access type.
Checkpoint Queue Status
reportedClosed
A boolean true/false value that indicates if the queue is reported as closed.
reportStatus
An enumerated value that describes additional known conditions related to queue status reporting.
Additional notes
It is possible a queue could report 'TemporaryClosure' status even if it does not report normal daily/operational closures. In this case it will return to 'NotReported' status when the temporary closure ends.
It is possible a queue could report 'Closure' when the queue is under conditions of a 'TemporaryClosure'. The status will be reported as 'TemporaryClosure' only if it is explicitly reported as such.
Queues reporting a closure will still return the last reported queueWaitTime values to maintain backwards compatibility.
SafeDistance Metrics
Certain key properties are returned on GET responses.
SafeDistance Object
safetyGrade
A risk assessment value that combines social distancing, exposure time, and population size. Reported as a number between 0 and 1.
ragStatus
A status of red, amber, or green that can be used on visual interfaces to indicate the current Safety Grade.