This site uses cookies to personalise content, adverts, and to analyse traffic. I'm ok with that Learn More

API Documentation

Find out how to use the REST API

API Documentation

This is the documentation to access the BOE Family Flights API. The API is exactly the same on both AIB Family Flights and BOE Family Flights, except depending on the domain it pulls either Airbus or Boeing data.

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.

You will need your API key to access the API Platform. You can get a API key by becoming a "Become a Aviation Data Expert!" member on Patreon.

The root URL for the API is:

GET https://boefamily.flights/api?key=[API_KEY]

The best way to play around with the API is to use the Detailed Search. You can fill out any parameter as you wish and afterwards, if you have an API key, underneath the result count you'll get a link directly to the API output with all the parameters pre-selected. However, full documentation is still listed below.

Required Parameters

The following parameters are all required:

Parameter
Description
key
The API key provided to you

Optional Parameters

The following parameters are all optional:

Parameter
Description
family
Aircraft Family
msn
The MSN Construction Number
line_number
The Line Number
registration
The registration of a Aircraft
aircraft_type
The Aircraft Type
airline
Name of an Airline
flight_activity
Flight Activity
callsign
The Callsign in which the Flight Activity is associated with.
hex
The Hex code in which the Flight Activity is associated with.
start_date
The start date of Flight activities in 'Y-m-d' format.
end_date
The end date of Flight activities in 'Y-m-d' format.
flight_special_notes
Any special notes regarding the flight
fal
The airport iata code of the final assembly line airport
airport
The airport iata code of any airport
undelivered
if set to true it will only return undelivered aircraft
delivered
if set to true it will only return delivered aircraft
exclude_transport_charter
if set to true it will exclude transport and charter flights
exclude_post_delivery
if set to true it will exclude all flights recorded post delivery from Boeing
exclude_post_delivery
if set to true it will only include Private Jets
flight_special_notes_only
if set to true it will only include flights that have special notes associated with them
p2f
if set to true it will only include flights that are associated with Passenger to Freighter (P2F)
special_livery
if set to true it will only include flight activity that have special c/s in the description.
limit
pagination of the results in the format of 0,100. To go to page 2 of the result use 100,200 etc. Only returns 100 returns per request.

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
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
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.
test_registration
The Test Registration in which the Flight Activity is associated with.
delivery_registration
The Delivery 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.
live_data
A object showing current live flight data.
latitude
Geographic latitude coordinate of the aircraft position
longitude
Geographic longitude coordinate of the aircraft position
altitude
The altitude of the aircraft in feet (ft).
speed
The ground speed of the aircraft in knots (kn).
heading
The directional heading of the aircraft in degrees.
vertical_speed
The vertical speed of the aircraft in feet per minute (fpm).
altitude_change
A textual description of the vertical speed. Is either up, down or simply empty.
track
A object showing all live flight track data.
latitude
Geographic latitude coordinate of the aircraft position
longitude
Geographic longitude coordinate of the aircraft position
altitude
The altitude of the aircraft in feet (ft).
speed
The ground speed of the aircraft in knots (kn).
heading
The directional heading of the aircraft in degrees.
vertical_speed
The vertical speed of the aircraft in feet per minute (fpm).
altitude_change
A textual description of the vertical speed. Is either up, down or simply empty.
time
The time of the data entry in the format 'H:i', in the UTC timezone.
date_string
The date & time in the ISO-8601 format.
last_updated
The Date & Time of the data entry in the '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": "",
            "is_delivered": false,
            "is_test_aircraft": false,
            "aircraft_url": "https://boefamily.flights/737/62536"
        }],
        "flight_information": [{
            "aircraft_type": "737-8 Max",
            "airline": "Southwest Airlines",
            "test_registration": "N8743K",
            "delivery_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",
            "live_data": [{
                "latitude": "43.58",
                "longitude": "1.35",
                "altitude": "7300",
                "speed": "260",
                "heading": "315",
                "vertical_speed": "2624",
                "altitude_change": "up",
                "track": [{
                    "latitude": "43.6",
                    "longitude": "1.39",
                    "altitude": "2150",
                    "speed": "154",
                    "heading": "143",
                    "vertical_speed": "3456",
                    "altitude_change": "up",
                    "time": "15:20 UTC",
                    "date_string": "2022-05-10T15:20:52+00:00",
                    "last_updated": "2022-05-10 15:20:52"
                }]
            }]
        }]
    }]
}