Overview
The SITA Airline Reference API helps developers who want to quickly integrate reliable and up-to-date airline information into their apps. It lets apps autocomplete partial user inputs or link airline names with data like IATA Codes or home countries.
Features
The API comes with the following features:
- Airline Match This service returns all the airlines matching your search term and is an excellent solution if you need to build an airline autocomplete field.
Example of information included: name: "GoJet Airlines", iataCode: "G7", icaoCode: "GJS",alias: "GATEWAY", country: "United States", svcType: "PASSENGER"
This API can be used to answer:
- What are the codes used by ATI for various airlines?
- To which country does the airline belong?
SITA Airline Reference API
1 Revision History
| Date | Version | Description | Author |
|---|---|---|---|
|
|
|
|
|
2 Introduction
The SITA Data API is a REST based service which provides information about Airports, Airlines and Aircrafts around the world.
To access the APIs you will need an API key. These can be obtained by creating an account on https://www.developer.aero/ and registering your interest for access to the API.
2.1 Authentication
To access the APIs an OAuth access token must be supplied. To obtain an OAuth token a request must be sent to the https://sitaopen.api.aero/data/oauth/token endpoint using the OAuth2 Client Credential flow, using your API key as the client_id, and your consumer secret as the client_secret.
Once an access token has been obtained, it can be placed in the Authorization HTTP header as a bearer token, for example:
Authorization: Bearer eyJ92dNw9dka...
2.2 Security
-
All incoming requests will be REST over HTTPS.
-
Users are authenticated using their OAuth token.
-
Certain response payload elements will be filtered based on permissions associated with their token.
2.3 Rate Limiting
All incoming requests are subject to a rate limiting restriction. The following headers are included in HTTP responses:
| Header | Description |
|---|---|
|
|
The total number of requests allowed in the current time window |
|
|
The number of requests left for the current time window |
|
|
The policy describing how many request per time window are allowed |
|
|
The number of seconds remaining in the current time window. Header not displayed after rate limit has been exceeded |
|
|
The EPOCH timestamp at which the current rate limit window resets. Header only displayed after rate limit has been exceeded |
3 SITA Airline Reference API
The SITA Airline Reference API is a REST based service which provides information about Airlines around the world.
3.1 Resources
This section describes the SITA Airline Reference API.
Detailed API structure, example requests and responses, JSON schema for request (where appropriate) and responses, and error response codes and formats are included.
3.2 Airline
3.2.1 Get All Airlines
Request headers
| Name | Description |
|---|---|
|
|
The Content-Type of this request. |
|
|
Authorization header that contains the access token. |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
|
ICAO Airline code |
|
|
|
Airline Alias code |
|
|
|
Airline’s country |
|
|
|
Indicates if request was correctly processed |
|
|
|
List of existing Airlines |
|
|
|
Airline name |
|
|
|
IATA Airline code |
Curl request
$ curl 'https://data-qa.api.aero/v1/airlines' -i -X GET \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJkb2N1bWVudGF0aW9uIiwidG9rZW4ifQ...'
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 326
{
"success" : true,
"airlines" : [ {
"name" : "Virgin Australia",
"iataCode" : "VA",
"icaoCode" : "VOZ",
"alias" : "VIRGIN",
"country" : "Australia"
}, {
"name" : "Copa Airlines",
"iataCode" : "CM",
"icaoCode" : "CMP",
"alias" : "COPA",
"country" : "Panama"
} ]
}
3.2.2 Get Airline by Code
Path parameters
| Parameter | Description |
|---|---|
|
|
Valid IATA Airline Code |
Request headers
| Name | Description |
|---|---|
|
|
The Content-Type of this request. |
|
|
Authorization header that contains the access token. |
Response fields
| Path | Type | Description |
|---|---|---|
|
|
|
ICAO Airline code |
|
|
|
Airline Alias code |
|
|
|
Airline’s country |
|
|
|
Indicates if request was correctly processed |
|
|
|
List of existing Airlines |
|
|
|
Airline name |
|
|
|
IATA Airline code |
Curl request
$ curl 'https://data-qa.api.aero/v1/airlines/VA' -i -X GET \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJkb2N1bWVudGF0aW9uIiwidG9rZW4ifQ...'
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 189
{
"success" : true,
"airlines" : [ {
"name" : "Virgin Australia",
"iataCode" : "VA",
"icaoCode" : "VOZ",
"alias" : "VIRGIN",
"country" : "Australia"
} ]
}
4 Error Response
4.1 Response fields
| Path | Type | Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
4.2 HTTP Response
HTTP/1.1 400 Bad Request
Content-Type: application/json
Content-Length: 159
{
"errors" : {
"error" : [ {
"description" : "Error Description",
"code" : 9999,
"invalidParam" : "parameterName"
} ]
}
}
5 Appendix A - Airline Reference Use Cases
|
Scenario: |
As an API user I want to make a request to the Airline Reference API to return data for a specific airline |
|
Request: |
GET /data/v1/airlines/KL |
|
Response: |
Returns data for the airline KL |
|
Scenario: |
As an API user I want to make a request to the Airline Reference API to return data for all airlines |
|
Request: |
GET /data/v1/airlines |
|
Response: |
Returns data for all airlines |
|
Scenario: |
As an API user I want to make a request to the Airline Reference API to match airlines by name or by code (IATA or ICAO) |
|
Request: |
GET /data/v1/airlines/match/EI |
|
Response: |
Checks for airline with a name/code of EI and returns its data |
Contact Us
For subscription and sales queries, please contact:
Product Inquiries
Contact Us
For any technical queries and support, please contact:
Technical Support Team
Contact Us
