Introduction
Welcome to the IF Checklists API! You can use our API to access daily aircraft suggestions for Infinite Flight.
You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.
If you have any questions about the API, please contact us at [email protected].
Security
To use our API, you need an API key. You can request a new IF Checklists API key by emailing us at [email protected].
Your personal API key needs to be included in all API requests to the server in a header that looks like the following:
apiKey: yourApiKey
All requests are served securely over HTTPS.
Aircraft suggestions
Get Aicraft Suggestions
import requests
url = "https://api.ifchecklists.com/wt-49a7ca99be51555279b5b77556ebfa9b-0/getAircraftSuggestions"
headers = {
"apiKey": "yourApiKey"
}
response = requests.request("GET", url, headers=headers)
print(response.text)
$.ajax({
url: 'https://api.ifchecklists.com/wt-49a7ca99be51555279b5b77556ebfa9b-0/getAircraftSuggestions',
type: 'GET',
dataType: 'json',
headers: {
'apiKey': 'yourApiKey'
},
success: function (data) {
console.log(data)
},
error: function (error) {
console.log(error)
}
});
$request = new HttpRequest();
$request->setUrl('https://api.ifchecklists.com/wt-49a7ca99be51555279b5b77556ebfa9b-0/getAircraftSuggestions');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders(array(
'apiKey' => 'yourApiKey'
));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
var client = new RestClient("https://api.ifchecklists.com/wt-49a7ca99be51555279b5b77556ebfa9b-0/getAircraftSuggestions");
var request = new RestRequest(Method.GET);
request.AddHeader("apiKey", "yourApiKey");
IRestResponse response = client.Execute(request);
The above command returns JSON structured like this:
{
"aircraft": [
"A330-200F",
"B757-200",
"B777-200F",
"DC-10F",
"MD-11F"
],
"reason": "Suggestions based on IFATC schedule"
}
If there are no aircraft suggestions available, the above command will return the following:
{
"status": "unavailable"
}
This endpoint retrieves all aircraft suggestions. The aircraft suggestions are hand-picked and updated everyday. Up to five aircraft can be suggested. The suggestions are based on factors such as the following:
- FNF event
- IFATC schedule
- Infinite Flight's Flash Flight
- Infinite Flight's latest release
HTTP Request
GET https://api.ifchecklists.com/wt-49a7ca99be51555279b5b77556ebfa9b-0/getAircraftSuggestions
Response
| Name | Type | Description |
|---|---|---|
aircraft |
object |
Suggested aircrafts. |
reason |
string |
Reason for the suggestions. |
Errors
All errors will return the following response. It contains useful information about the issue.
{
"message": "<ERROR_MESSAGE>",
"success": false
}
The IF Checklists API uses the following error codes:
| Error Code | Meaning |
|---|---|
| 401 | Unauthorized - Make sure your API key is included as a header and valid. |
| 405 | Method Not Allowed - The only valid method is GET. |
| 503 | Service Unavailable - We're temporarily offline for maintenance. Please try again later. |