API
It's your data, use it, share it.
 

If you would like to integrate the data stored on our servers with other applications, display it on your website or offer it to others, you can do so using our simple REST API to access your data. The API is an authenticated read-only view into your groups's aircraft, flight logs and position reports. The command set is described below. All returned data is held in an easily parsable JSON object. If you run into problems or have questions, we are here to help. Just send an email to support@airbly.com.

All requests require a valid group API key to be sent. This key can be generated in the Airbly web application on the group page. Everytime a new key is generated, the old one is invalidated. There can only be one valid API key per group at a time.

Arguments can be sent either with GET or POST. All responses will include the server's timestamp, the name of the object requested and a descriptive error string if necessary.

groupAircraftList

Calls for an groupAircraftList object will return a list of all aircraft associated with a group. There are no filtering options.

Arguments

Name Required Description
groupKey yes The group's API key

Fields

Name Datatype Description
cmd string Object requested
error string Human readable description of any errors during processing
authSuccess boolean True if the API key was valid
timeStamp integer 32-bit unix timestamp at the time of the request
aircrafts container List of aircrafts associated with the group
UUID container UUID of the particular aircraft described
tail string Tail number of this aircraft
make string Make of this aircraft
model string Model of this aircraft
year string Year of this aircraft
serialNumber string Serial number of this aircraft
description string Description of this aircraft
lastUpdate integer 32-bit unix timestamp of the last time the aircraft was updated
totalEngine decimal Total number of hours on the engine
totalTach decimal Total number of hours on the tachometer
totalAir decimal Total number of hours on the airframe
totalLandings integer Total number of landings on the airframe
status select stopped, flying, unavailable, sos
needsAttention boolean Indicates one of the 10 most recent flights requires attention
maintenance select current, due, overdue
deviceId UUID UUID of the device currently assigned to this aircraft
deviceESN string ESN (serial number) of the device currently assigned to this aircraft
deviceBattery string Battery level the last time it was reported, good or low
deviceFirmware integer The version of firmware installed on the device
deviceLastSync integer 32-bit unix timestamp at the time of the last sync


{
    cmd: "groupAircraftList",
    error: "",
    authGroupApiKey: "9C4NSsnLig3zlgzPHqLkXwHPtKv7OC",
    authGroupKeySuccess: true,
    authGroupUUID: "00000001-4444-1100-0000-000000000001",
    timeStamp: 1502371000,
    aircraft: {
        00000001-4444-2000-8846-001471040618: {
            tail: "N44API",
            make: "Cessna",
            model: "172",
            year: "1980",
            serialNumber: "1234567",
            description: "API Test Aircraft",
            lastUpdate: 1502370986,
            totalEngine: "436.9",
            totalTach: "0.0",
            totalAir: "8567.3",
            totalLandings: 9985,
            status: "stopped",
            needsAttention: false,
            maintenance: "current",
            deviceId: "00000001-4444-3000-0000-000000000001",
            deviceESN: "C100-0000000",
            deviceFirmware: 34,
            deviceBattery: "good",
            deviceLastSync: 1502370986
        }
    }
}

                     

Examples

GET

https://airbly.com/api/v1.2.0/groupAircraftList?
  groupKey=9C4NSsnLig3zlgzPHqLkXwHPtKv7OC

PUT
Not supported

UPDATE
Not supported

DELETE
Not supported

groupFlightLogList

Requests for groupFlightLogList will return log entries for a particular aircraft and can be filtered using start and end 32-bit unix timestamp values. Logs are always returned in descending (most recent first) order.

Arguments

Name Required Description
groupKey yes The group's API key
aircraftUUID yes UUID of the aircraft who's flight logs to retrieve
startTimestamp no 32-bit unix timestamp of the earliest flight log which should be returned
endTimestamp no 32-bit unix timestamp of the latest flight log which should be returned
limit no Integer value of the number of logs to return

Fields

Name Datatype Description
cmd string Object requested
error string Human readable description of any errors during processing
authSuccess boolean True if the API key was valid
timeStamp integer 32-bit unix timestamp at the time of the request
flightLogs container List of flightLogs associated with the requested aircraft
UUID container UUID of the particular flightLog described
happenedAt integer 32-bit unix timestamp of when the flight was completed
engineHours decimal Number of hours the engine was operational during the flight
engineMinutes integer Number of minutes the engine was operational during the flight
engineStartTimestamp integer 32-bit unix timestamp of when the engine started
engineStopTimestamp integer 32-bit unix timestamp of when the engine stopped
blockHours decimal Number of hours the aircraft was off blocks
blockMinutes integer Number of minutes the aircraft was off blocks
blockStartTimestamp integer 32-bit unix timestamp of when the first movement occurred
blockStopTimestamp integer 32-bit unix timestamp of when the last movement occurred
airHours decimal Number of hours the aircraft was in the air during the flight
airMinutes integer Number of minutes the aircraft was in the air during the flight
airStartTimestamp integer 32-bit unix timestamp of when first takeoff occurred
airStopTimestamp integer 32-bit unix timestamp of when the last landing occurred
tachHours decimal Number of hours of tach time during the flight
landings integer The number of landings completed during the flight
departure string ICAO identifier of the departure airport
arrival string ICAO identified of the arrival airport
lastUpdate integer 32-bit unix timestamp of the last time the aircraft was updated
pilotId UUID The UUID of the pilot who flew the flight
pilotName string The name of the pilot who flew the flight
inFlight boolean Indicates the flight is still in progress
attentionRequired boolean Indicates the flight requires attention
alarmSOS boolean Indicates there was an SOS alarm during the flight
alarmG boolean Indicates there was a G force alarm during the flight
alarmPitchRoll boolean Indicates there was a pitch/roll alarm during the flight
alarmClimbDescent boolean Indicates there was a high climb or decent rate during the flight

{
    cmd: "groupFlightLogList",
    error: "",
    authGroupApiKey: "9C4NSsnLig3zlgzPHqLkXwHPtKv7OC",
    authGroupKeySuccess: true,
    authGroupUUID: "00000001-4444-1100-0000-000000000001",
    timeStamp: 1502371000,
    flightLogs: {
        00000001-4444-4000-8790-001470940562: {
            happenedAt: 1470940562,
            engineHours: "0.8",
            engineMinutes: "48",
            engineStartTimestamp: 1470937682,
            engineStartTimestamp: 1470940562,
            blockHours: "0.7",
            blockMinutes: "41",
            blockStartTimestamp: 1470937862,
            blockStopTimestamp: 1470940322,
            airHours: "0.6",
            airMinutes: "37",
            airStartTimestamp: 1470938042,
            airStopTimestamp: 1470940262,
            tachHours: "0.7",
            landings: 1,
            departure: "KPWM",
            arrival: "KASH",
            lastUpdate: 1471079873,
            pilotId: "00000001-4444-1000-3295-001453387958",
            pilotName: "Chris VanHorn",
            inFlight: false, 
            attentionRequired: false,
            alarmSOS: false,
            alarmG: false,
            alarmPitchRoll: false,
            alarmClimbDescent: false
        }
    }
}
                

Examples

GET

https://airbly.com/api/v1.2.0/groupFlightLogList?
  aircraftUUID=00000001-4444-2000-8846-001471040618
  &groupKey=9C4NSsnLig3zlgzPHqLkXwHPtKv7OC

https://airbly.com/api/v1.2.0/groupFlightLogList?
  aircraftUUID=00000001-4444-2000-8846-001471040618
  &groupKey=9C4NSsnLig3zlgzPHqLkXwHPtKv7OC
  &startTimestamp=1470940560
  &endTimestamp=1470940564
  &limit=1

PUT Not supported

UPDATE Not supported

DELETE Not supported

groupFlightLogPoints

Requests for groupFlightLogPoints will return all of the points created during the creation of the flightLog. They are returned in descending (most recent first) order. Points can be created via a satellite transmission or through a synchronization process using a smartphone or tablet. Points which are transmitted by satellite have a longer period (every 5 or 10 minutes) and some fields maybe empty. Alarm indicators will indicate an alarm occured at some point between the current and previous reporting points.

Arguments

Name Required Description
groupKey yes The group's API key
flightLogUUID yes UUID of the flight log to be retrieved

Fields

Name Datatype Description
cmd string Object requested
error string Human readable description of any errors during processing
authSuccess boolean True if the API key was valid
timeStamp integer 32-bit unix timestamp at the time of the request
points container List of points associated with the requested flightLog
UUID container UUID of the particular point
happenedAt integer 32-bit unix timestamp of when the point was recorded
bleSyncedAt integer 32-bit unix timestamp of when this point was synced with a smartphone or tablet. If the value is 0, the point was received via satellite.
type select departure, inroute, limited, landing, alarm, arrival - indicating the phase of flight when this point was created
latitude decimal Latitude of the aircraft when the point was created
longitude decimal Longitude of the aircraft when the point was created
altitude integer Altitude in feet of the aircraft when the point was created
gForce decimal The vertical gForce on the aircraft when the point was created (not available over satellite)
pitch integer Degrees of pitch of the aircraft when the point was created (not available over satellite)
roll integer Degrees of roll of the aircraft when the point was created (not available over satellite)
verticalSpeed integer Vertical speed in feet of the aircraft when the point was created (not available over satellite)
alarmSOS boolean Indicates there was an SOS alarm when this point was created
alarmG boolean Indicates there was a G alarm when this point was created
alarmPitchRoll boolean Indicates there was a pitch/roll alarm when this point was created
alarmClimbDescent boolean Indicates there was a high climb or descent rate when this point was created

{
    cmd: "groupFlightLogPoints",
    error: "",
    authGroupApiKey: "9C4NSsnLig3zlgzPHqLkXwHPtKv7OC",
    authGroupKeySuccess: true,
    authGroupUUID: "00000001-4444-1100-0000-000000000001",
    timeStamp: 1502371000,
    points: {
        00000001-4444-4200-0047-001470748191: {
            happenedAt: 1470937502,
            blesyncedat: 0,
            type: "departure",
            latitude: "43.6508",
            longitude: "-70.3085",
            altitude: 0,
            gForce: 1,
            pitch: 0,
            roll: 0,
            verticalSpeed: 0,
            alarmSOS: false,
            alarmG: false,
            alarmPitchRoll: false,
            alarmClimbDescent: false
        }
    }
}

                    

Examples

GET

https://airbly.com/api/v1.2.0/groupFlightLogPoints?
  flightLogUUID=00000001-4444-4000-8790-001470940562
  &groupKey=9C4NSsnLig3zlgzPHqLkXwHPtKv7OC

PUT Not supported

UPDATE Not supported

DELETE Not supported