myFleet API Documentation

This is the documentation to access the Aviation Flights Group myFleet API.

The API Platform is only available via a REST API, in which you have to let your application grab a URL with parameters and it returns all output in either JSON format. This makes it easy to grab the data using any Programming Language of your choice. The API will always only show 100 results at a time.

Your API key is:

The root URLs for the API is:

GET https://aviation.flights/api/myfleet

Only Aircraft in your own myFleet list will be shown in this API and it determines that based based on your own API key.

Certain Flight Activity will not show up in the API. This includes any Flight Activity that contains "Added to Database", "Spotted" and any Flights initially picked up by a Flight Tracker where Commercial use is not permitted.

Rate Limits

For the longest time it didn't need to be done but as of February 4, 2025 there is now a temporary rate limit of one request per 5 seconds.

Required Header Request

The following header is required on all requests:

x-api-key: The API key provided to you

Optional URL Parameters

The following parameters are all optional:

Parameter

Description

date

The Month and Year you want to get the myFleet Flights from. If ommited by default it will query the current month. Must be in the format: Y-m

Output Values for JSON

The following output values are returned after successful query:

Field

Description

Aircraft Information

msn

The MSN Construction Number

line_number

The Line Number

aircraft_family

The Aircraft Family

aircraft_type

The Aircraft Type

engine_type

The engine type being used

test_registration

The Test Registration in which the Aircraft is associated with.

delivery_registration

The Delivery Registration in which the Aircraft is associated with.

production_site

The airport details where the aircraft has been assembled

is_delivered

Can be either true or false

is_test_aircraft

Can be either true or false

is_scrapped

Can be either true or false

is_written_off

Can be either true or false

aircraft_url

The full URL to the Aircraft Profile.

Flight Information

aircraft_type

The Aircraft type, mostly used for post delivery flight activity.

airline

The Airline in which the Flight Activity is associated with.

registration

The Registration in which the Flight Activity is associated with.

flight_activity

The description of the Flight Activity. This usually contains Airport codes in IATA format.

airports_involved

A object showing Airports involed within the Flight Activity. Only works on actual flights.

title

the title of the airport.

icao_code

ICAO code of the airport.

iata_code

IATA code of the airport.

latitude

Geographic latitude coordinate of the Airport.

longitude

Geographic longitude coordinate of the Airport.

callsign

The Callsign in which the Flight Activity is associated with.

hex

The Hex code in which the Flight Activity is associated with.

date_time

The textual representaton of the Flight Activity's Date as well as the Flights start and ending time.

flight_time

The calculated Flight time based on the date & times from the date_time field.

special_notes

Any special notes about this Flight Activity.

is_post_delivery

Can be either true or false

first_seen

The Date & Time in which the Flight Activity was first seen 'Y-m-d hh:ii:ss' format.

Error Codes for JSON

The following are all error codes that can be returned with this function:

Error Message

Description

No API key provided!

No API key has been provided.

API key invalid!

The API key is invalid.

Sample Output

{
    "status": "success",
    "results": [
        {
            "aircraft_information": [
                {
                    "msn": "62536",
                    "line_number": "7763",
                    "aircraft_type": "737-8 Max",
                    "engine_type": "",
                    "test_registration": "N8743K",
                    "delivery_registration": "N8743K",
                    "is_delivered": false,
                    "is_scrapped": false,
                    "is_written_off": false,
                    "is_test_aircraft": false,
                    "aircraft_url": "https://boefamily.flights/737/62536"
                }
            ],
            "flight_information": [
                {
                    "aircraft_type": "737-8 Max",
                    "airline": "Southwest Airlines",
                    "registration": "N8743K",
                    "flight_activity": "Test Flight BFI-BFI",
                    "airports_involved": [
                        {
                            "title": "Seattle, United States (KBFI/BFI)",
                            "icao_code": "KBFI",
                            "iata_code": "BFI",
                            "latitude": "47.53",
                            "longitude": "-122.301947"
                        }
                    ],
                    "callsign": "BOE049",
                    "hex": "AC07FD",
                    "date_time": "Jan 16 2021 16:55-19:01 UTC",
                    "flight_time": "3h 6m",
                    "special_notes": "",
                    "is_post_delivery": false,
                    "first_seen": "2021-01-16 16:55:00"
                }
            ]
        }
    ]
}