skytracker.api.v1.state.api_search_state#

async skytracker.api.v1.state.api_search_state(storage: Storage = Depends(get_storage), callsign: str | None = Query(None), status: Literal['UNKNOWN', 'STARTED', 'LANDED', 'EN_ROUTE'] | None = Query(None), model: str | None = Query(None), registration: str | None = Query(None), airline: str | None = Query(None), arrival: str | None = Query(None), departure: str | None = Query(None), on_ground: bool | None = Query(None), squawk: str | None = Query(None), limit: int = Query(0)) → list[State]#

Search for a state based on given information

Parameters:

  • storage (Storage) – backend storage manager

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

  • status (Literal['UNKNOWN', 'STARTED', 'LANDED', 'EN_ROUTE'] | None) – aircraft status

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

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

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

  • arrival (str | None) – arrival airport IATA code (3 characters)

  • departure (str | None) – departure airport IATA code (3 characters)

  • on_ground (bool | None) – whether aircraft is on ground

  • squawk (str | None) – transponder squawk code

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

Returns:

state search results

Return type:

list[State]