Whitebox Plugin - Aircraft Data

This is an Aircraft Data plugin for Whitebox.

Installation

Simply install the plugin to Whitebox:

poetry add whitebox-plugin-data-aircraft

Aircraft lookup API

The plugin provides the data-aircraft capability and looks up aircraft registration, model, operator, and type information in the managed OpenSky and aircraft type datasets.

Discover the endpoint through the plugin URL map:

const url = Whitebox.api.getPluginProvidedPath("data-aircraft.lookup");
const response = await Whitebox.api.client.get(url, {
  params: { icao_addr: "5055096" },
});

The direct endpoint is:

GET /plugin-views/whitebox_plugin_data_aircraft/aircraft/lookup/?icao_addr=<icao_addr>

The required icao_addr parameter accepts a decimal ICAO address or a hexadecimal ICAO24 address. Decimal values are returned as unpadded lowercase hexadecimal; other values are lowercased as-is.

A successful lookup returns the OpenSky row and, when available, its joined aircraft type row:

{
  "found": true,
  "icao24": "4d2278",
  "aircraft": {
    "registration": "9H-TJD",
    "model": "Boeing 737-800",
    "operator": "Corendon Airlines",
    "typecode": "B738"
  },
  "type_info": {
    "manufacturer_name": "BOEING",
    "model": "737-800"
  }
}

When no aircraft row or dataset is available, the endpoint returns HTTP 200:

{
  "found": false,
  "icao24": "4d2278"
}

Omitting icao_addr returns HTTP 400:

{
  "error": "Query parameter 'icao_addr' is required"
}

Additional Instructions

• Plugin Development Guide
• Plugin Testing Guide
• Contributing Guidelines