skytracker.api.v1.aircraft.api_search_aircraft#

async skytracker.api.v1.aircraft.api_search_aircraft(storage: Storage = Depends(get_storage), registration: str | None = Query(None), icao24: str | None = Query(None), callsign: str | None = Query(None), model: str | None = Query(None), airline: str | None = Query(None), engine_count: int | None = Query(None), engine_type: Literal['JET', 'UNKNOWN', 'TURBOFAN', 'TURBOPROP'] | None = Query(None), limit: int = Query(0)) → list[Aircraft]#

Search for an aircraft based on given information

Parameters:

  • storage (Storage) – backend storage manager

  • registration (str | None) – aircraft registration (tail number)

  • icao24 (str | None) – aircraft ICAO 24-bit address (hex, 6 characters)

  • callsign (str | None) – aircraft callsign (ICAO)

  • model (str | None) – aircraft model IATA code (4 characters)

  • airline (str | None) – airline IATA code (2 characters)

  • engine_count (int | None) – number of engines on aircraft (2, 3, or 4)

  • engine_type (Literal['JET', 'UNKNOWN', 'TURBOPROP', 'TURBOFAN'] | None) – type of engines on aircaft (JET, TURBOPROP, TURBOFAN, or UNKNOWN)

  • limit (int, optional) – maximum number of aircraft to retrieve (0=all). Defaults to 0 (all).

Returns:

aircraft search results

Return type:

list[AircraftState]