Types

types ¤

Modules:

Name	Description
`cache`
`grpc`
`isqx`
`json`
`static`

Attributes:

Name	Type	Description
`M`		Method
`IntoTimestamp`	`TypeAlias`	A type that can be converted to a timestamp (in seconds).
`IntFlightId`	`TypeAlias`	Flight ID as an integer.
`StrFlightIdHex`	`TypeAlias`	Flight ID as a hexadecimal string.
`IntoFlightId`	`TypeAlias`	A type that can be converted to a flight ID.

M `module-attribute` ¤

M = TypeVar('M')

Method

IntoTimestamp `module-attribute` ¤

IntoTimestamp: TypeAlias = Union[TimestampS[int], datetime]

A type that can be converted to a timestamp (in seconds).

IntFlightId `module-attribute` ¤

IntFlightId: TypeAlias = int

Flight ID as an integer.

StrFlightIdHex `module-attribute` ¤

StrFlightIdHex: TypeAlias = str

Flight ID as a hexadecimal string.

IntoFlightId `module-attribute` ¤

IntoFlightId: TypeAlias = Union[
    IntFlightId, StrFlightIdHex, bytes
]

A type that can be converted to a flight ID.

cache ¤

Classes:

Name	Description
`DType`	A newtype for annotating types in TypedDicts.
`FlightListRecord`
`PlaybackTrackEMSRecord`
`PlaybackTrackRecord`
`RecentPositionRecord`
`FlightRecord`
`NearbyFlightRecord`
`LiveFlightStatusRecord`
`TopFlightRecord`
`EMSRecord`
`TrailPointRecord`
`FlightDetailsRecord`
`PlaybackFlightRecord`

Functions:

Name	Description
`to_schema`	Generate a polars schema from a TypedDict.

Attributes:

Name	Type	Description
`flight_list_schema`
`playback_track_ems_schema`
`playback_track_schema`
`position_buffer_struct_schema`
`live_feed_schema`
`nearest_flights_schema`
`live_flights_status_schema`
`top_flights_schema`
`ems_struct_schema`
`trail_point_schema`
`flight_details_schema`
`playback_flight_schema`
`TabularFileFmt`

flight_list_schema `module-attribute` ¤

flight_list_schema = to_schema(FlightListRecord)

playback_track_ems_schema `module-attribute` ¤

playback_track_ems_schema = to_schema(
    PlaybackTrackEMSRecord
)

playback_track_schema `module-attribute` ¤

playback_track_schema = to_schema(PlaybackTrackRecord)

position_buffer_struct_schema `module-attribute` ¤

position_buffer_struct_schema = to_schema(
    RecentPositionRecord
)

live_feed_schema `module-attribute` ¤

live_feed_schema = to_schema(FlightRecord)

nearest_flights_schema `module-attribute` ¤

nearest_flights_schema = to_schema(NearbyFlightRecord)

live_flights_status_schema `module-attribute` ¤

live_flights_status_schema = to_schema(
    LiveFlightStatusRecord
)

top_flights_schema `module-attribute` ¤

top_flights_schema = to_schema(TopFlightRecord)

ems_struct_schema `module-attribute` ¤

ems_struct_schema = to_schema(EMSRecord)

trail_point_schema `module-attribute` ¤

trail_point_schema = to_schema(TrailPointRecord)

flight_details_schema `module-attribute` ¤

flight_details_schema = to_schema(FlightDetailsRecord)

playback_flight_schema `module-attribute` ¤

playback_flight_schema = to_schema(PlaybackFlightRecord)

TabularFileFmt `module-attribute` ¤

TabularFileFmt = Literal['parquet', 'csv']

DType `dataclass` ¤

DType(type_: DataType)

A newtype for annotating types in TypedDicts.

Methods:

Name	Description
`__post_init__`

Attributes:

Name	Type	Description
`type_`	`DataType`

type_ `instance-attribute` ¤

type_: DataType

__post_init__ ¤

__post_init__() -> None

FlightListRecord ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`flight_id`	`Annotated[Union[IntFlightId, None], DType(UInt64())]`
`number`	`Annotated[Union[str, None], DType(String())]`
`callsign`	`Annotated[Union[str, None], DType(String())]`
`icao24`	`Annotated[Union[int, None], DType(UInt32())]`
`registration`	`Annotated[Union[str, None], DType(String())]`
`typecode`	`Annotated[str, DType(String())]`
`origin`	`Annotated[Union[str, None], DType(String())]`
`destination`	`Annotated[Union[str, None], DType(String())]`
`status`	`Annotated[Union[str, None], DType(String())]`
`STOD`	`Annotated[Union[TimestampMs[int], None], DType(Datetime('ms', time_zone='UTC'))]`
`ETOD`	`Annotated[Union[TimestampMs[int], None], DType(Datetime('ms', time_zone='UTC'))]`
`ATOD`	`Annotated[Union[TimestampMs[int], None], DType(Datetime('ms', time_zone='UTC'))]`
`STOA`	`Annotated[Union[TimestampMs[int], None], DType(Datetime('ms', time_zone='UTC'))]`
`ETOA`	`Annotated[Union[TimestampMs[int], None], DType(Datetime('ms', time_zone='UTC'))]`
`ATOA`	`Annotated[Union[TimestampMs[int], None], DType(Datetime('ms', time_zone='UTC'))]`

flight_id `instance-attribute` ¤

flight_id: Annotated[
    Union[IntFlightId, None], DType(UInt64())
]

number `instance-attribute` ¤

number: Annotated[Union[str, None], DType(String())]

callsign `instance-attribute` ¤

callsign: Annotated[Union[str, None], DType(String())]

icao24 `instance-attribute` ¤

icao24: Annotated[Union[int, None], DType(UInt32())]

registration `instance-attribute` ¤

registration: Annotated[Union[str, None], DType(String())]

typecode `instance-attribute` ¤

typecode: Annotated[str, DType(String())]

origin `instance-attribute` ¤

origin: Annotated[Union[str, None], DType(String())]

destination `instance-attribute` ¤

destination: Annotated[Union[str, None], DType(String())]

status `instance-attribute` ¤

status: Annotated[Union[str, None], DType(String())]

STOD `instance-attribute` ¤

STOD: Annotated[
    Union[TimestampMs[int], None],
    DType(Datetime("ms", time_zone="UTC")),
]

ETOD `instance-attribute` ¤

ETOD: Annotated[
    Union[TimestampMs[int], None],
    DType(Datetime("ms", time_zone="UTC")),
]

ATOD `instance-attribute` ¤

ATOD: Annotated[
    Union[TimestampMs[int], None],
    DType(Datetime("ms", time_zone="UTC")),
]

STOA `instance-attribute` ¤

STOA: Annotated[
    Union[TimestampMs[int], None],
    DType(Datetime("ms", time_zone="UTC")),
]

ETOA `instance-attribute` ¤

ETOA: Annotated[
    Union[TimestampMs[int], None],
    DType(Datetime("ms", time_zone="UTC")),
]

ATOA `instance-attribute` ¤

ATOA: Annotated[
    Union[TimestampMs[int], None],
    DType(Datetime("ms", time_zone="UTC")),
]

PlaybackTrackEMSRecord ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`timestamp`	`Annotated[TimestampS[int], DType(UInt32())]`
`ias`	`Annotated[Union[IndicatedAirSpeedKt[int], None], DType(Int16())]`
`tas`	`Annotated[Union[TrueAirSpeedKt[int], None], DType(Int16())]`
`mach`	`Annotated[Union[MachTimes1K[int], None], DType(Int16())]`
`mcp`	`Annotated[Union[AltitudeFt[int], None], DType(Int32())]`
`fms`	`Annotated[Union[AltitudeFt[int], None], DType(Int32())]`
`autopilot`	`Annotated[Union[int, None], DType(Int8())]`
`oat`	`Annotated[Union[StaticTemperatureC[int], None], DType(Int8())]`
`track`	`Annotated[Union[GroundTrackDeg[float], None], DType(Float32())]`
`roll`	`Annotated[Union[BankAngleDeg[float], None], DType(Float32())]`
`qnh`	`Annotated[Union[PressureAltimeterHpa[int], None], DType(UInt16())]`
`wind_dir`	`Annotated[Union[BearingDeg[int], None], DType(Int16())]`
`wind_speed`	`Annotated[Union[WindSpeedKt[int], None], DType(Int16())]`
`precision`	`Annotated[Union[int, None], DType(UInt8())]`
`altitude_gps`	`Annotated[Union[GeometricAltitudeM[int], None], DType(Int32())]`
`emergency`	`Annotated[Union[int, None], DType(UInt8())]`
`tcas_acas`	`Annotated[Union[int, None], DType(UInt8())]`
`heading`	`Annotated[Union[BearingDeg[int], None], DType(UInt16())]`

timestamp `instance-attribute` ¤

timestamp: Annotated[TimestampS[int], DType(UInt32())]

ias `instance-attribute` ¤

ias: Annotated[
    Union[IndicatedAirSpeedKt[int], None], DType(Int16())
]

tas `instance-attribute` ¤

tas: Annotated[
    Union[TrueAirSpeedKt[int], None], DType(Int16())
]

mach `instance-attribute` ¤

mach: Annotated[
    Union[MachTimes1K[int], None], DType(Int16())
]

mcp `instance-attribute` ¤

mcp: Annotated[Union[AltitudeFt[int], None], DType(Int32())]

fms `instance-attribute` ¤

fms: Annotated[Union[AltitudeFt[int], None], DType(Int32())]

autopilot `instance-attribute` ¤

autopilot: Annotated[Union[int, None], DType(Int8())]

oat `instance-attribute` ¤

oat: Annotated[
    Union[StaticTemperatureC[int], None], DType(Int8())
]

track `instance-attribute` ¤

track: Annotated[
    Union[GroundTrackDeg[float], None], DType(Float32())
]

roll `instance-attribute` ¤

roll: Annotated[
    Union[BankAngleDeg[float], None], DType(Float32())
]

qnh `instance-attribute` ¤

qnh: Annotated[
    Union[PressureAltimeterHpa[int], None], DType(UInt16())
]

wind_dir `instance-attribute` ¤

wind_dir: Annotated[
    Union[BearingDeg[int], None], DType(Int16())
]

wind_speed `instance-attribute` ¤

wind_speed: Annotated[
    Union[WindSpeedKt[int], None], DType(Int16())
]

precision `instance-attribute` ¤

precision: Annotated[Union[int, None], DType(UInt8())]

altitude_gps `instance-attribute` ¤

altitude_gps: Annotated[
    Union[GeometricAltitudeM[int], None], DType(Int32())
]

emergency `instance-attribute` ¤

emergency: Annotated[Union[int, None], DType(UInt8())]

tcas_acas `instance-attribute` ¤

tcas_acas: Annotated[Union[int, None], DType(UInt8())]

heading `instance-attribute` ¤

heading: Annotated[
    Union[BearingDeg[int], None], DType(UInt16())
]

PlaybackTrackRecord ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`timestamp`	`Annotated[TimestampS[int], DType(UInt32())]`
`latitude`	`Annotated[LatitudeDeg[float], DType(Float32())]`
`longitude`	`Annotated[LongitudeDeg[float], DType(Float32())]`
`altitude`	`Annotated[AltitudeFt[int], DType(Int32())]`
`ground_speed`	`Annotated[GroundSpeedKt[int], DType(Int16())]`
`vertical_speed`	`Annotated[Union[VerticalSpeedFpm[int], None], DType(Int16())]`
`track`	`Annotated[GroundTrackDeg[int], DType(Int16())]`
`squawk`	`Annotated[int, DType(UInt16())]`
`ems`	`Annotated[Union[None, PlaybackTrackEMSRecord], DType(Struct(playback_track_ems_schema))]`

timestamp `instance-attribute` ¤

timestamp: Annotated[TimestampS[int], DType(UInt32())]

latitude `instance-attribute` ¤

latitude: Annotated[LatitudeDeg[float], DType(Float32())]

longitude `instance-attribute` ¤

longitude: Annotated[LongitudeDeg[float], DType(Float32())]

altitude `instance-attribute` ¤

altitude: Annotated[AltitudeFt[int], DType(Int32())]

ground_speed `instance-attribute` ¤

ground_speed: Annotated[GroundSpeedKt[int], DType(Int16())]

vertical_speed `instance-attribute` ¤

vertical_speed: Annotated[
    Union[VerticalSpeedFpm[int], None], DType(Int16())
]

track `instance-attribute` ¤

track: Annotated[GroundTrackDeg[int], DType(Int16())]

squawk `instance-attribute` ¤

squawk: Annotated[int, DType(UInt16())]

ems `instance-attribute` ¤

ems: Annotated[
    Union[None, PlaybackTrackEMSRecord],
    DType(Struct(playback_track_ems_schema)),
]

RecentPositionRecord ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`delta_lat`	`Annotated[int, DType(Int32())]`
`delta_lon`	`Annotated[int, DType(Int32())]`
`delta_ms`	`Annotated[int, DType(UInt32())]`

delta_lat `instance-attribute` ¤

delta_lat: Annotated[int, DType(Int32())]

delta_lon `instance-attribute` ¤

delta_lon: Annotated[int, DType(Int32())]

delta_ms `instance-attribute` ¤

delta_ms: Annotated[int, DType(UInt32())]

FlightRecord ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`timestamp`	`Annotated[TimestampMs[int], DType(Datetime('ms', time_zone='UTC'))]`
`flightid`	`Annotated[IntFlightId, DType(UInt32())]`
`latitude`	`Annotated[LatitudeDeg[float], DType(Float32())]`
`longitude`	`Annotated[LongitudeDeg[float], DType(Float32())]`
`track`	`Annotated[GroundTrackDeg[int], DType(UInt16())]`
`altitude`	`Annotated[AltitudeFt[int], DType(Int32())]`
`ground_speed`	`Annotated[GroundSpeedKt[int], DType(Int16())]`
`on_ground`	`Annotated[bool, DType(Boolean())]`
`callsign`	`Annotated[str, DType(String())]`
`source`	`Annotated[int, DType(UInt8())]`
`registration`	`Annotated[str, DType(String())]`
`origin`	`Annotated[str, DType(String())]`
`destination`	`Annotated[str, DType(String())]`
`typecode`	`Annotated[str, DType(String())]`
`eta`	`Annotated[TimestampS[int], DType(UInt32())]`
`squawk`	`Annotated[int, DType(UInt16())]`
`vertical_speed`	`Annotated[Union[VerticalSpeedFpm[int], None], DType(Int16())]`
`position_buffer`	`Annotated[list[RecentPositionRecord], DType(List(Struct(position_buffer_struct_schema)))]`

timestamp `instance-attribute` ¤

timestamp: Annotated[
    TimestampMs[int], DType(Datetime("ms", time_zone="UTC"))
]

flightid `instance-attribute` ¤

flightid: Annotated[IntFlightId, DType(UInt32())]

latitude `instance-attribute` ¤

latitude: Annotated[LatitudeDeg[float], DType(Float32())]

longitude `instance-attribute` ¤

longitude: Annotated[LongitudeDeg[float], DType(Float32())]

track `instance-attribute` ¤

track: Annotated[GroundTrackDeg[int], DType(UInt16())]

altitude `instance-attribute` ¤

altitude: Annotated[AltitudeFt[int], DType(Int32())]

ground_speed `instance-attribute` ¤

ground_speed: Annotated[GroundSpeedKt[int], DType(Int16())]

on_ground `instance-attribute` ¤

on_ground: Annotated[bool, DType(Boolean())]

callsign `instance-attribute` ¤

callsign: Annotated[str, DType(String())]

source `instance-attribute` ¤

source: Annotated[int, DType(UInt8())]

registration `instance-attribute` ¤

registration: Annotated[str, DType(String())]

origin `instance-attribute` ¤

origin: Annotated[str, DType(String())]

destination `instance-attribute` ¤

destination: Annotated[str, DType(String())]

typecode `instance-attribute` ¤

typecode: Annotated[str, DType(String())]

eta `instance-attribute` ¤

eta: Annotated[TimestampS[int], DType(UInt32())]

squawk `instance-attribute` ¤

squawk: Annotated[int, DType(UInt16())]

vertical_speed `instance-attribute` ¤

vertical_speed: Annotated[
    Union[VerticalSpeedFpm[int], None], DType(Int16())
]

position_buffer `instance-attribute` ¤

position_buffer: Annotated[
    list[RecentPositionRecord],
    DType(List(Struct(position_buffer_struct_schema))),
]

NearbyFlightRecord ¤

Bases: FlightRecord

Attributes:

Name	Type	Description
`distance`	`Annotated[DistanceM[int], DType(UInt32())]`
`timestamp`	`Annotated[TimestampMs[int], DType(Datetime('ms', time_zone='UTC'))]`
`flightid`	`Annotated[IntFlightId, DType(UInt32())]`
`latitude`	`Annotated[LatitudeDeg[float], DType(Float32())]`
`longitude`	`Annotated[LongitudeDeg[float], DType(Float32())]`
`track`	`Annotated[GroundTrackDeg[int], DType(UInt16())]`
`altitude`	`Annotated[AltitudeFt[int], DType(Int32())]`
`ground_speed`	`Annotated[GroundSpeedKt[int], DType(Int16())]`
`on_ground`	`Annotated[bool, DType(Boolean())]`
`callsign`	`Annotated[str, DType(String())]`
`source`	`Annotated[int, DType(UInt8())]`
`registration`	`Annotated[str, DType(String())]`
`origin`	`Annotated[str, DType(String())]`
`destination`	`Annotated[str, DType(String())]`
`typecode`	`Annotated[str, DType(String())]`
`eta`	`Annotated[TimestampS[int], DType(UInt32())]`
`squawk`	`Annotated[int, DType(UInt16())]`
`vertical_speed`	`Annotated[Union[VerticalSpeedFpm[int], None], DType(Int16())]`
`position_buffer`	`Annotated[list[RecentPositionRecord], DType(List(Struct(position_buffer_struct_schema)))]`

distance `instance-attribute` ¤

distance: Annotated[DistanceM[int], DType(UInt32())]

timestamp `instance-attribute` ¤

timestamp: Annotated[
    TimestampMs[int], DType(Datetime("ms", time_zone="UTC"))
]

flightid `instance-attribute` ¤

flightid: Annotated[IntFlightId, DType(UInt32())]

latitude `instance-attribute` ¤

latitude: Annotated[LatitudeDeg[float], DType(Float32())]

longitude `instance-attribute` ¤

longitude: Annotated[LongitudeDeg[float], DType(Float32())]

track `instance-attribute` ¤

track: Annotated[GroundTrackDeg[int], DType(UInt16())]

altitude `instance-attribute` ¤

altitude: Annotated[AltitudeFt[int], DType(Int32())]

ground_speed `instance-attribute` ¤

ground_speed: Annotated[GroundSpeedKt[int], DType(Int16())]

on_ground `instance-attribute` ¤

on_ground: Annotated[bool, DType(Boolean())]

callsign `instance-attribute` ¤

callsign: Annotated[str, DType(String())]

source `instance-attribute` ¤

source: Annotated[int, DType(UInt8())]

registration `instance-attribute` ¤

registration: Annotated[str, DType(String())]

origin `instance-attribute` ¤

origin: Annotated[str, DType(String())]

destination `instance-attribute` ¤

destination: Annotated[str, DType(String())]

typecode `instance-attribute` ¤

typecode: Annotated[str, DType(String())]

eta `instance-attribute` ¤

eta: Annotated[TimestampS[int], DType(UInt32())]

squawk `instance-attribute` ¤

squawk: Annotated[int, DType(UInt16())]

vertical_speed `instance-attribute` ¤

vertical_speed: Annotated[
    Union[VerticalSpeedFpm[int], None], DType(Int16())
]

position_buffer `instance-attribute` ¤

position_buffer: Annotated[
    list[RecentPositionRecord],
    DType(List(Struct(position_buffer_struct_schema))),
]

LiveFlightStatusRecord ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`flight_id`	`Annotated[IntFlightId, DType(UInt32())]`
`latitude`	`Annotated[LatitudeDeg[float], DType(Float32())]`
`longitude`	`Annotated[LongitudeDeg[float], DType(Float32())]`
`status`	`Annotated[int, DType(UInt8())]`
`squawk`	`Annotated[int, DType(UInt16())]`

flight_id `instance-attribute` ¤

flight_id: Annotated[IntFlightId, DType(UInt32())]

latitude `instance-attribute` ¤

latitude: Annotated[LatitudeDeg[float], DType(Float32())]

longitude `instance-attribute` ¤

longitude: Annotated[LongitudeDeg[float], DType(Float32())]

status `instance-attribute` ¤

status: Annotated[int, DType(UInt8())]

squawk `instance-attribute` ¤

squawk: Annotated[int, DType(UInt16())]

TopFlightRecord ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`flight_id`	`Annotated[IntFlightId, DType(UInt32())]`
`live_clicks`	`Annotated[int, DType(UInt32())]`
`total_clicks`	`Annotated[int, DType(UInt32())]`
`flight_number`	`Annotated[str, DType(String())]`
`callsign`	`Annotated[str, DType(String())]`
`squawk`	`Annotated[int, DType(UInt16())]`
`from_iata`	`Annotated[str, DType(String())]`
`from_city`	`Annotated[str, DType(String())]`
`to_iata`	`Annotated[str, DType(String())]`
`to_city`	`Annotated[str, DType(String())]`
`type`	`Annotated[str, DType(String())]`
`full_description`	`Annotated[str, DType(String())]`

flight_id `instance-attribute` ¤

flight_id: Annotated[IntFlightId, DType(UInt32())]

live_clicks `instance-attribute` ¤

live_clicks: Annotated[int, DType(UInt32())]

total_clicks `instance-attribute` ¤

total_clicks: Annotated[int, DType(UInt32())]

flight_number `instance-attribute` ¤

flight_number: Annotated[str, DType(String())]

callsign `instance-attribute` ¤

callsign: Annotated[str, DType(String())]

squawk `instance-attribute` ¤

squawk: Annotated[int, DType(UInt16())]

from_iata `instance-attribute` ¤

from_iata: Annotated[str, DType(String())]

from_city `instance-attribute` ¤

from_city: Annotated[str, DType(String())]

to_iata `instance-attribute` ¤

to_iata: Annotated[str, DType(String())]

to_city `instance-attribute` ¤

to_city: Annotated[str, DType(String())]

type `instance-attribute` ¤

type: Annotated[str, DType(String())]

full_description `instance-attribute` ¤

full_description: Annotated[str, DType(String())]

EMSRecord ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`ias`	`Annotated[Union[IndicatedAirSpeedKt[int], None], DType(Int16())]`
`tas`	`Annotated[Union[TrueAirSpeedKt[int], None], DType(Int16())]`
`mach`	`Annotated[Union[MachTimes1K[int], None], DType(Int16())]`
`mcp`	`Annotated[Union[AltitudeFt[int], None], DType(Int32())]`
`fms`	`Annotated[Union[AltitudeFt[int], None], DType(Int32())]`
`oat`	`Annotated[Union[StaticTemperatureC[int], None], DType(Int8())]`
`qnh`	`Annotated[Union[PressureAltimeterHpa[int], None], DType(UInt16())]`
`wind_dir`	`Annotated[Union[BearingDeg[int], None], DType(Int16())]`
`wind_speed`	`Annotated[Union[WindSpeedKt[int], None], DType(Int16())]`
`altitude_gps`	`Annotated[Union[GeometricAltitudeM[int], None], DType(Int32())]`
`agpsdiff`	`Annotated[Union[int, None], DType(Int32())]`
`apflags`	`Annotated[Union[int, None], DType(Int32())]`
`rs`	`Annotated[Union[int, None], DType(Int32())]`

ias `instance-attribute` ¤

ias: Annotated[
    Union[IndicatedAirSpeedKt[int], None], DType(Int16())
]

tas `instance-attribute` ¤

tas: Annotated[
    Union[TrueAirSpeedKt[int], None], DType(Int16())
]

mach `instance-attribute` ¤

mach: Annotated[
    Union[MachTimes1K[int], None], DType(Int16())
]

mcp `instance-attribute` ¤

mcp: Annotated[Union[AltitudeFt[int], None], DType(Int32())]

fms `instance-attribute` ¤

fms: Annotated[Union[AltitudeFt[int], None], DType(Int32())]

oat `instance-attribute` ¤

oat: Annotated[
    Union[StaticTemperatureC[int], None], DType(Int8())
]

qnh `instance-attribute` ¤

qnh: Annotated[
    Union[PressureAltimeterHpa[int], None], DType(UInt16())
]

wind_dir `instance-attribute` ¤

wind_dir: Annotated[
    Union[BearingDeg[int], None], DType(Int16())
]

wind_speed `instance-attribute` ¤

wind_speed: Annotated[
    Union[WindSpeedKt[int], None], DType(Int16())
]

altitude_gps `instance-attribute` ¤

altitude_gps: Annotated[
    Union[GeometricAltitudeM[int], None], DType(Int32())
]

agpsdiff `instance-attribute` ¤

agpsdiff: Annotated[Union[int, None], DType(Int32())]

apflags `instance-attribute` ¤

apflags: Annotated[Union[int, None], DType(Int32())]

rs `instance-attribute` ¤

rs: Annotated[Union[int, None], DType(Int32())]

TrailPointRecord ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`timestamp`	`Annotated[TimestampS[int], DType(UInt32())]`
`latitude`	`Annotated[LatitudeDeg[float], DType(Float32())]`
`longitude`	`Annotated[LongitudeDeg[float], DType(Float32())]`
`altitude`	`Annotated[Union[AltitudeFt[int], None], DType(Int32())]`
`ground_speed`	`Annotated[Union[GroundSpeedKt[int], None], DType(Int16())]`
`track`	`Annotated[Union[GroundTrackDeg[int], None], DType(UInt16())]`
`vertical_speed`	`Annotated[Union[VerticalSpeedFpm[int], None], DType(Int16())]`
`source`	`Annotated[Union[int, None], DType(UInt8())]`

timestamp `instance-attribute` ¤

timestamp: Annotated[TimestampS[int], DType(UInt32())]

latitude `instance-attribute` ¤

latitude: Annotated[LatitudeDeg[float], DType(Float32())]

longitude `instance-attribute` ¤

longitude: Annotated[LongitudeDeg[float], DType(Float32())]

altitude `instance-attribute` ¤

altitude: Annotated[
    Union[AltitudeFt[int], None], DType(Int32())
]

ground_speed `instance-attribute` ¤

ground_speed: Annotated[
    Union[GroundSpeedKt[int], None], DType(Int16())
]

track `instance-attribute` ¤

track: Annotated[
    Union[GroundTrackDeg[int], None], DType(UInt16())
]

vertical_speed `instance-attribute` ¤

vertical_speed: Annotated[
    Union[VerticalSpeedFpm[int], None], DType(Int16())
]

source `instance-attribute` ¤

source: Annotated[Union[int, None], DType(UInt8())]

FlightDetailsRecord ¤

Bases: _AircraftRecord, _ScheduleRecord, _FlightProgressRecord, _FlightInfoRecord, _FlightTrailRecord

Attributes:

Name	Type	Description
`position_buffer`	`Annotated[list[RecentPositionRecord], DType(List(Struct(position_buffer_struct_schema)))]`
`flight_trail_list`	`Annotated[Union[None, list[TrailPointRecord]], DType(List(Struct(trail_point_schema)))]`
`timestamp_ms`	`Annotated[TimestampMs[int], DType(Datetime('ms', time_zone='UTC'))]`
`flightid`	`Annotated[IntFlightId, DType(UInt32())]`
`latitude`	`Annotated[LatitudeDeg[float], DType(Float32())]`
`longitude`	`Annotated[LongitudeDeg[float], DType(Float32())]`
`track`	`Annotated[Union[GroundTrackDeg[int], None], DType(UInt16())]`
`altitude`	`Annotated[AltitudeFt[int], DType(Int32())]`
`ground_speed`	`Annotated[GroundSpeedKt[int], DType(Int16())]`
`vertical_speed`	`Annotated[Union[VerticalSpeedFpm[int], None], DType(Int16())]`
`on_ground`	`Annotated[bool, DType(Boolean())]`
`callsign`	`Annotated[str, DType(String())]`
`squawk`	`Annotated[int, DType(UInt16())]`
`ems`	`Annotated[Union[None, EMSRecord], DType(Struct(ems_struct_schema))]`
`traversed_distance`	`Annotated[DistanceM[int], DType(UInt32())]`
`remaining_distance`	`Annotated[DistanceM[int], DType(UInt32())]`
`elapsed_time`	`Annotated[Union[DurationS[int], None], DType(UInt32())]`
`remaining_time`	`Annotated[Union[DurationS[int], None], DType(UInt32())]`
`eta`	`Annotated[TimestampS[int], DType(UInt32())]`
`great_circle_distance`	`Annotated[DistanceM[int], DType(UInt32())]`
`mean_flight_time`	`Annotated[DurationS[int], DType(UInt32())]`
`flight_number`	`Annotated[str, DType(String())]`
`origin_id`	`Annotated[int, DType(UInt32())]`
`destination_id`	`Annotated[int, DType(UInt32())]`
`diverted_id`	`Annotated[int, DType(UInt32())]`
`scheduled_departure`	`Annotated[TimestampS[int], DType(UInt32())]`
`scheduled_arrival`	`Annotated[TimestampS[int], DType(UInt32())]`
`actual_departure`	`Annotated[Union[TimestampS[int], None], DType(UInt32())]`
`actual_arrival`	`Annotated[Union[TimestampS[int], None], DType(UInt32())]`
`icao_address`	`Annotated[int, DType(UInt32())]`
`reg`	`Annotated[str, DType(String())]`
`typecode`	`Annotated[str, DType(String())]`

position_buffer `instance-attribute` ¤

position_buffer: Annotated[
    list[RecentPositionRecord],
    DType(List(Struct(position_buffer_struct_schema))),
]

flight_trail_list `instance-attribute` ¤

flight_trail_list: Annotated[
    Union[None, list[TrailPointRecord]],
    DType(List(Struct(trail_point_schema))),
]

timestamp_ms `instance-attribute` ¤

timestamp_ms: Annotated[
    TimestampMs[int], DType(Datetime("ms", time_zone="UTC"))
]

flightid `instance-attribute` ¤

flightid: Annotated[IntFlightId, DType(UInt32())]

latitude `instance-attribute` ¤

latitude: Annotated[LatitudeDeg[float], DType(Float32())]

longitude `instance-attribute` ¤

longitude: Annotated[LongitudeDeg[float], DType(Float32())]

track `instance-attribute` ¤

track: Annotated[
    Union[GroundTrackDeg[int], None], DType(UInt16())
]

altitude `instance-attribute` ¤

altitude: Annotated[AltitudeFt[int], DType(Int32())]

ground_speed `instance-attribute` ¤

ground_speed: Annotated[GroundSpeedKt[int], DType(Int16())]

vertical_speed `instance-attribute` ¤

vertical_speed: Annotated[
    Union[VerticalSpeedFpm[int], None], DType(Int16())
]

on_ground `instance-attribute` ¤

on_ground: Annotated[bool, DType(Boolean())]

callsign `instance-attribute` ¤

callsign: Annotated[str, DType(String())]

squawk `instance-attribute` ¤

squawk: Annotated[int, DType(UInt16())]

ems `instance-attribute` ¤

ems: Annotated[
    Union[None, EMSRecord], DType(Struct(ems_struct_schema))
]

traversed_distance `instance-attribute` ¤

traversed_distance: Annotated[
    DistanceM[int], DType(UInt32())
]

remaining_distance `instance-attribute` ¤

remaining_distance: Annotated[
    DistanceM[int], DType(UInt32())
]

elapsed_time `instance-attribute` ¤

elapsed_time: Annotated[
    Union[DurationS[int], None], DType(UInt32())
]

remaining_time `instance-attribute` ¤

remaining_time: Annotated[
    Union[DurationS[int], None], DType(UInt32())
]

eta `instance-attribute` ¤

eta: Annotated[TimestampS[int], DType(UInt32())]

great_circle_distance `instance-attribute` ¤

great_circle_distance: Annotated[
    DistanceM[int], DType(UInt32())
]

mean_flight_time `instance-attribute` ¤

mean_flight_time: Annotated[DurationS[int], DType(UInt32())]

flight_number `instance-attribute` ¤

flight_number: Annotated[str, DType(String())]

origin_id `instance-attribute` ¤

origin_id: Annotated[int, DType(UInt32())]

destination_id `instance-attribute` ¤

destination_id: Annotated[int, DType(UInt32())]

diverted_id `instance-attribute` ¤

diverted_id: Annotated[int, DType(UInt32())]

scheduled_departure `instance-attribute` ¤

scheduled_departure: Annotated[
    TimestampS[int], DType(UInt32())
]

scheduled_arrival `instance-attribute` ¤

scheduled_arrival: Annotated[
    TimestampS[int], DType(UInt32())
]

actual_departure `instance-attribute` ¤

actual_departure: Annotated[
    Union[TimestampS[int], None], DType(UInt32())
]

actual_arrival `instance-attribute` ¤

actual_arrival: Annotated[
    Union[TimestampS[int], None], DType(UInt32())
]

icao_address `instance-attribute` ¤

icao_address: Annotated[int, DType(UInt32())]

reg `instance-attribute` ¤

reg: Annotated[str, DType(String())]

typecode `instance-attribute` ¤

typecode: Annotated[str, DType(String())]

PlaybackFlightRecord ¤

Bases: _AircraftRecord, _ScheduleRecord, _FlightInfoRecord, _FlightTrailRecord

Attributes:

Name	Type	Description
`flight_trail_list`	`Annotated[Union[None, list[TrailPointRecord]], DType(List(Struct(trail_point_schema)))]`
`timestamp_ms`	`Annotated[TimestampMs[int], DType(Datetime('ms', time_zone='UTC'))]`
`flightid`	`Annotated[IntFlightId, DType(UInt32())]`
`latitude`	`Annotated[LatitudeDeg[float], DType(Float32())]`
`longitude`	`Annotated[LongitudeDeg[float], DType(Float32())]`
`track`	`Annotated[Union[GroundTrackDeg[int], None], DType(UInt16())]`
`altitude`	`Annotated[AltitudeFt[int], DType(Int32())]`
`ground_speed`	`Annotated[GroundSpeedKt[int], DType(Int16())]`
`vertical_speed`	`Annotated[Union[VerticalSpeedFpm[int], None], DType(Int16())]`
`on_ground`	`Annotated[bool, DType(Boolean())]`
`callsign`	`Annotated[str, DType(String())]`
`squawk`	`Annotated[int, DType(UInt16())]`
`ems`	`Annotated[Union[None, EMSRecord], DType(Struct(ems_struct_schema))]`
`flight_number`	`Annotated[str, DType(String())]`
`origin_id`	`Annotated[int, DType(UInt32())]`
`destination_id`	`Annotated[int, DType(UInt32())]`
`diverted_id`	`Annotated[int, DType(UInt32())]`
`scheduled_departure`	`Annotated[TimestampS[int], DType(UInt32())]`
`scheduled_arrival`	`Annotated[TimestampS[int], DType(UInt32())]`
`actual_departure`	`Annotated[Union[TimestampS[int], None], DType(UInt32())]`
`actual_arrival`	`Annotated[Union[TimestampS[int], None], DType(UInt32())]`
`icao_address`	`Annotated[int, DType(UInt32())]`
`reg`	`Annotated[str, DType(String())]`
`typecode`	`Annotated[str, DType(String())]`

flight_trail_list `instance-attribute` ¤

flight_trail_list: Annotated[
    Union[None, list[TrailPointRecord]],
    DType(List(Struct(trail_point_schema))),
]

timestamp_ms `instance-attribute` ¤

timestamp_ms: Annotated[
    TimestampMs[int], DType(Datetime("ms", time_zone="UTC"))
]

flightid `instance-attribute` ¤

flightid: Annotated[IntFlightId, DType(UInt32())]

latitude `instance-attribute` ¤

latitude: Annotated[LatitudeDeg[float], DType(Float32())]

longitude `instance-attribute` ¤

longitude: Annotated[LongitudeDeg[float], DType(Float32())]

track `instance-attribute` ¤

track: Annotated[
    Union[GroundTrackDeg[int], None], DType(UInt16())
]

altitude `instance-attribute` ¤

altitude: Annotated[AltitudeFt[int], DType(Int32())]

ground_speed `instance-attribute` ¤

ground_speed: Annotated[GroundSpeedKt[int], DType(Int16())]

vertical_speed `instance-attribute` ¤

vertical_speed: Annotated[
    Union[VerticalSpeedFpm[int], None], DType(Int16())
]

on_ground `instance-attribute` ¤

on_ground: Annotated[bool, DType(Boolean())]

callsign `instance-attribute` ¤

callsign: Annotated[str, DType(String())]

squawk `instance-attribute` ¤

squawk: Annotated[int, DType(UInt16())]

ems `instance-attribute` ¤

ems: Annotated[
    Union[None, EMSRecord], DType(Struct(ems_struct_schema))
]

flight_number `instance-attribute` ¤

flight_number: Annotated[str, DType(String())]

origin_id `instance-attribute` ¤

origin_id: Annotated[int, DType(UInt32())]

destination_id `instance-attribute` ¤

destination_id: Annotated[int, DType(UInt32())]

diverted_id `instance-attribute` ¤

diverted_id: Annotated[int, DType(UInt32())]

scheduled_departure `instance-attribute` ¤

scheduled_departure: Annotated[
    TimestampS[int], DType(UInt32())
]

scheduled_arrival `instance-attribute` ¤

scheduled_arrival: Annotated[
    TimestampS[int], DType(UInt32())
]

actual_departure `instance-attribute` ¤

actual_departure: Annotated[
    Union[TimestampS[int], None], DType(UInt32())
]

actual_arrival `instance-attribute` ¤

actual_arrival: Annotated[
    Union[TimestampS[int], None], DType(UInt32())
]

icao_address `instance-attribute` ¤

icao_address: Annotated[int, DType(UInt32())]

reg `instance-attribute` ¤

reg: Annotated[str, DType(String())]

typecode `instance-attribute` ¤

typecode: Annotated[str, DType(String())]

to_schema ¤

to_schema(obj: type[Any]) -> dict[str, DataType] | None

Generate a polars schema from a TypedDict.

Parameters:

Name	Type	Description	Default
`obj`	`type[Any]`	A TypedDict with types annotated with `DType`.	required

Returns:

Type	Description
`dict[str, DataType] \| None`	None if polars is not installed

grpc ¤

Attributes:

Name	Type	Description
`LiveFeedFieldAuthenticated`
`LiveFeedField`

LiveFeedFieldAuthenticated `module-attribute` ¤

LiveFeedFieldAuthenticated = Literal[
    "squawk", "vspeed", "airspace", "logo_id", "age"
]

LiveFeedField `module-attribute` ¤

LiveFeedField = Literal[
    "flight",
    "reg",
    "route",
    "type",
    LiveFeedFieldAuthenticated,
]

isqx ¤

Attributes:

Name	Type	Description
`TimestampS`	`TypeAlias`
`TimestampMs`	`TypeAlias`
`DurationS`	`TypeAlias`
`UtcOffsetS`	`TypeAlias`
`DistanceM`	`TypeAlias`
`LatitudeDeg`	`TypeAlias`
`LongitudeDeg`	`TypeAlias`
`BearingDeg`	`TypeAlias`
`GroundTrackDeg`	`TypeAlias`
`BankAngleDeg`	`TypeAlias`
`AltitudeM`	`TypeAlias`
`AltitudeFt`	`TypeAlias`
`GeometricAltitudeM`	`TypeAlias`
`PressureAltimeterHpa`	`TypeAlias`
`StaticTemperatureC`	`TypeAlias`
`GroundSpeedKmh`	`TypeAlias`
`GroundSpeedKt`	`TypeAlias`
`GroundSpeedMph`	`TypeAlias`
`IndicatedAirSpeedKt`	`TypeAlias`
`TrueAirSpeedKt`	`TypeAlias`
`WindSpeedKt`	`TypeAlias`
`VerticalSpeedFpm`	`TypeAlias`
`VerticalSpeedMps`	`TypeAlias`
`MachTimes1K`	`TypeAlias`

TimestampS `module-attribute` ¤

TimestampS: TypeAlias = Annotated[_T, TIME[S]]

TimestampMs `module-attribute` ¤

TimestampMs: TypeAlias = Annotated[_T, TIME[MILLI * S]]

DurationS `module-attribute` ¤

DurationS: TypeAlias = Annotated[_T, DURATION(S)]

UtcOffsetS `module-attribute` ¤

UtcOffsetS: TypeAlias = Annotated[
    _T, DURATION["utc_offset"](S)
]

DistanceM `module-attribute` ¤

DistanceM: TypeAlias = Annotated[_T, DISTANCE(M)]

LatitudeDeg `module-attribute` ¤

LatitudeDeg: TypeAlias = Annotated[_T, LATITUDE(DEG)]

LongitudeDeg `module-attribute` ¤

LongitudeDeg: TypeAlias = Annotated[_T, LONGITUDE(DEG)]

BearingDeg `module-attribute` ¤

BearingDeg: TypeAlias = Annotated[_T, HEADING(DEG)]

GroundTrackDeg `module-attribute` ¤

GroundTrackDeg: TypeAlias = Annotated[_T, GROUND_TRACK(DEG)]

BankAngleDeg `module-attribute` ¤

BankAngleDeg: TypeAlias = Annotated[_T, BANK_ANGLE(DEG)]

AltitudeM `module-attribute` ¤

AltitudeM: TypeAlias = Annotated[_T, PRESSURE_ALTITUDE(M)]

AltitudeFt `module-attribute` ¤

AltitudeFt: TypeAlias = Annotated[_T, PRESSURE_ALTITUDE(FT)]

GeometricAltitudeM `module-attribute` ¤

GeometricAltitudeM: TypeAlias = Annotated[
    _T, GEOMETRIC_ALTITUDE(M)
]

PressureAltimeterHpa `module-attribute` ¤

PressureAltimeterHpa: TypeAlias = Annotated[
    _T, PRESSURE_ALTIMETER(HECTO * PA)
]

StaticTemperatureC `module-attribute` ¤

StaticTemperatureC: TypeAlias = Annotated[
    _T, STATIC_TEMPERATURE(CELSIUS)
]

GroundSpeedKmh `module-attribute` ¤

GroundSpeedKmh: TypeAlias = Annotated[
    _T, GROUND_SPEED(KILO * M * HOUR**-1)
]

GroundSpeedKt `module-attribute` ¤

GroundSpeedKt: TypeAlias = Annotated[_T, GROUND_SPEED(KNOT)]

GroundSpeedMph `module-attribute` ¤

GroundSpeedMph: TypeAlias = Annotated[_T, GROUND_SPEED(MPH)]

IndicatedAirSpeedKt `module-attribute` ¤

IndicatedAirSpeedKt: TypeAlias = Annotated[
    _T, INDICATED_AIRSPEED(KNOT)
]

TrueAirSpeedKt `module-attribute` ¤

TrueAirSpeedKt: TypeAlias = Annotated[
    _T, TRUE_AIRSPEED(KNOT)
]

WindSpeedKt `module-attribute` ¤

WindSpeedKt: TypeAlias = Annotated[_T, WIND_SPEED(KNOT)]

VerticalSpeedFpm `module-attribute` ¤

VerticalSpeedFpm: TypeAlias = Annotated[
    _T, VERTICAL_RATE(FT * MIN**-1)
]

VerticalSpeedMps `module-attribute` ¤

VerticalSpeedMps: TypeAlias = Annotated[
    _T, VERTICAL_RATE(M * S**-1)
]

MachTimes1K `module-attribute` ¤

MachTimes1K: TypeAlias = Annotated[_T, MACH_NUMBER * 1000]

json ¤

Classes:

Name	Description
`User`
`Features`
`UserData`
`Authentication`
`UsernamePassword`
`TokenSubscriptionKey`
`APIResult`
`FlightNumber`
`AircraftModel`
`AircraftAge`
`AircraftAvailability`
`StatusData`
`OwnerData`
`AirlineData`
`CommonAirport`
`AirportPairData`
`ImageCollection`
`FlightListRequest`
`Item`
`Page`
`Identification`
`FlightListCountry`
`AircraftInfo`
`Interval`
`TimeOther`
`FlightListTime`
`FlightListItem`
`AircraftImage`
`FlightListResponse`
`FlightListResult`
`FlightList`
`PlaybackRequest`
`FlightIdentification`
`AircraftIdentification`
`AircraftData`
`Median`
`Altitude`
`Speed`
`VerticalSpeed`
`EMS`
`TrackData`
`FlightDataAvailability`
`FlightData`
`PlaybackData`
`PlaybackResponse`
`PlaybackResult`
`Playback`
`AirportListScheduleSetting`
`PluginSetting`
`AirportSchedule`
`AirportPluginData`
`AirportListData`
`AirportResponse`
`AirportResult`
`AirportList`
`Live`
`FindAirportDetail`
`Operator`
`FindScheduleDetail`
`Aircraft`
`EntryBase`
`AirportEntry`
`OperatorEntry`
`LiveEntry`
`ScheduleEntry`
`AircraftEntry`
`StatsEntry`
`Stats`
`Info`
`Find`

Functions:

Name	Description
`is_airport`
`is_operator`
`is_live`
`is_schedule`
`is_aircraft`

Attributes:

Name	Type	Description
`FLIGHT_LIST_EMPTY`	`FlightList`	An object with no flight list data, for use as a default value.
`Plugin`
`AirportRequest`
`Iata`
`Icao`
`Entry`

FLIGHT_LIST_EMPTY `module-attribute` ¤

FLIGHT_LIST_EMPTY: FlightList = {
    "result": {
        "request": {
            "fetchBy": "flight",
            "format": "json",
            "limit": 0,
            "page": 0,
            "query": "",
            "timestamp": 0,
        },
        "response": {
            "item": {
                "current": 0,
                "total": None,
                "limit": 0,
            },
            "page": {
                "current": 0,
                "more": False,
                "total": None,
            },
            "timestamp": 0,
            "data": None,
            "aircraftInfo": {
                "model": {"code": "", "text": ""},
                "registration": None,
                "country": None,
                "hex": None,
                "restricted": False,
                "serialNo": None,
                "age": {"availability": False},
                "availability": {
                    "serialNo": False,
                    "age": False,
                },
            },
            "aircraftImages": [],
        },
    },
    "_api": {"copyright": "", "legalNotice": ""},
}

An object with no flight list data, for use as a default value.

Plugin `module-attribute` ¤

Plugin = Literal[
    "details",
    "runways",
    "schedule",
    "satelliteImage",
    "scheduledRoutesStatistics",
    "weather",
]

AirportRequest `module-attribute` ¤

AirportRequest = TypedDict(
    "AirportRequest",
    {
        "callback": None,
        "code": str,
        "device": Union[str, None],
        "fleet": Union[str, None],
        "format": Literal["json"],
        "limit": int,
        "page": int,
        "pk": None,
        "plugin": list[Plugin],
        "plugin[]": list[Plugin],
        "plugin-setting": PluginSetting,
        "plugin-setting[schedule][mode]": str,
        "plugin-setting[schedule][timestamp]": TimestampS[
            int
        ],
        "token": Union[str, None],
    },
    total=False,
)

Iata `module-attribute` ¤

Iata = Annotated[str, 'IATA']

Icao `module-attribute` ¤

Icao = Annotated[str, 'ICAO']

Entry `module-attribute` ¤

Entry = Union[
    AirportEntry,
    OperatorEntry,
    LiveEntry,
    ScheduleEntry,
    AircraftEntry,
]

User ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`id`	`Required[int]`
`identity`	`str`
`locale`	`str`

id `instance-attribute` ¤

id: Required[int]

identity `instance-attribute` ¤

identity: str

locale `instance-attribute` ¤

locale: str

Features ¤

Bases: TypedDict

UserData ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`accessToken`	`None \| str`
`accountType`	`str`
`countryCode`	`None \| str`
`dateExpires`	`TimestampS[int]`
`dateLastLogin`	`str`
`features`	`Features`
`hasConsented`	`bool`
`hasPassword`	`bool`
`idUser`	`int`
`identity`	`str`
`isActive`	`bool`
`isAnonymousAccount`	`bool`
`isLoggedIn`	`bool`
`localeCode`	`str`
`name`	`None`
`oAuth`	`None`
`oAuthType`	`None`
`publicKey`	`None`
`subscriptionKey`	`None \| str`
`tokenLogin`	`str`
`typeSource`	`str`

accessToken `instance-attribute` ¤

accessToken: None | str

accountType `instance-attribute` ¤

accountType: str

countryCode `instance-attribute` ¤

countryCode: None | str

dateExpires `instance-attribute` ¤

dateExpires: TimestampS[int]

dateLastLogin `instance-attribute` ¤

dateLastLogin: str

features `instance-attribute` ¤

features: Features

hasConsented `instance-attribute` ¤

hasConsented: bool

hasPassword `instance-attribute` ¤

hasPassword: bool

idUser `instance-attribute` ¤

idUser: int

identity `instance-attribute` ¤

identity: str

isActive `instance-attribute` ¤

isActive: bool

isAnonymousAccount `instance-attribute` ¤

isAnonymousAccount: bool

isLoggedIn `instance-attribute` ¤

isLoggedIn: bool

localeCode `instance-attribute` ¤

localeCode: str

name `instance-attribute` ¤

name: None

oAuth `instance-attribute` ¤

oAuth: None

oAuthType `instance-attribute` ¤

oAuthType: None

publicKey `instance-attribute` ¤

publicKey: None

subscriptionKey `instance-attribute` ¤

subscriptionKey: None | str

tokenLogin `instance-attribute` ¤

tokenLogin: str

typeSource `instance-attribute` ¤

typeSource: str

Authentication ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`message`	`str`
`msg`	`str`
`response_code`	`int`
`responseCode`	`int`
`status`	`str`
`success`	`bool`
`token`	`str`
`user`	`User`
`features`	`Features`
`userData`	`Required[UserData]`

message `instance-attribute` ¤

message: str

msg `instance-attribute` ¤

msg: str

response_code `instance-attribute` ¤

response_code: int

responseCode `instance-attribute` ¤

responseCode: int

status `instance-attribute` ¤

status: str

success `instance-attribute` ¤

success: bool

token `instance-attribute` ¤

token: str

user `instance-attribute` ¤

user: User

features `instance-attribute` ¤

features: Features

userData `instance-attribute` ¤

userData: Required[UserData]

UsernamePassword ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`username`	`str`
`password`	`str`

username `instance-attribute` ¤

username: str

password `instance-attribute` ¤

password: str

TokenSubscriptionKey ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`subscriptionKey`	`str`
`token`	`str`

subscriptionKey `instance-attribute` ¤

subscriptionKey: str

token `instance-attribute` ¤

token: str

APIResult ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`copyright`	`str`
`legalNotice`	`str`

copyright `instance-attribute` ¤

copyright: str

legalNotice `instance-attribute` ¤

legalNotice: str

FlightNumber ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`default`	`str \| None`
`alternative`	`NotRequired[str \| None]`

default `instance-attribute` ¤

default: str | None

alternative `instance-attribute` ¤

alternative: NotRequired[str | None]

AircraftModel ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`code`	`str`
`text`	`None \| str`

code `instance-attribute` ¤

code: str

text `instance-attribute` ¤

text: None | str

AircraftAge ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`availability`	`bool`
`date`	`NotRequired[str]`

availability `instance-attribute` ¤

availability: bool

date `instance-attribute` ¤

date: NotRequired[str]

AircraftAvailability ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`serialNo`	`bool`
`age`	`bool`

serialNo `instance-attribute` ¤

serialNo: bool

age `instance-attribute` ¤

age: bool

StatusData ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`live`	`bool \| None`
`text`	`str \| None`
`icon`	`str \| None`
`estimated`	`None`
`ambiguous`	`bool`
`generic`	`_StatusGeneric`

live `instance-attribute` ¤

live: bool | None

text `instance-attribute` ¤

text: str | None

icon `instance-attribute` ¤

icon: str | None

estimated `instance-attribute` ¤

estimated: None

ambiguous `instance-attribute` ¤

ambiguous: bool

generic `instance-attribute` ¤

generic: _StatusGeneric

OwnerData ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`name`	`str`
`code`	`_Iata_Icao`

name `instance-attribute` ¤

name: str

code `instance-attribute` ¤

code: _Iata_Icao

AirlineData ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`name`	`str`
`code`	`_Iata_Icao`
`short`	`str`

name `instance-attribute` ¤

name: str

code `instance-attribute` ¤

code: _Iata_Icao

short `instance-attribute` ¤

short: str

CommonAirport ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`name`	`str`
`code`	`_AirportCode`
`position`	`_AirportPosition`
`timezone`	`_Timezone`
`visible`	`NotRequired[bool]`

name `instance-attribute` ¤

name: str

code `instance-attribute` ¤

code: _AirportCode

position `instance-attribute` ¤

position: _AirportPosition

timezone `instance-attribute` ¤

timezone: _Timezone

visible `instance-attribute` ¤

visible: NotRequired[bool]

AirportPairData ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`origin`	`None \| CommonAirport`
`destination`	`None \| CommonAirport`
`real`	`None \| CommonAirport`	Destination airport for diverted

origin `instance-attribute` ¤

origin: None | CommonAirport

destination `instance-attribute` ¤

destination: None | CommonAirport

real `instance-attribute` ¤

real: None | CommonAirport

Destination airport for diverted

ImageCollection ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`large`	`list[_Image]`
`medium`	`list[_Image]`
`thumbnails`	`list[_Image]`

large `instance-attribute` ¤

large: list[_Image]

medium `instance-attribute` ¤

medium: list[_Image]

thumbnails `instance-attribute` ¤

thumbnails: list[_Image]

FlightListRequest ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`callback`	`None`
`device`	`None \| str`
`fetchBy`	`Required[str]`
`filterBy`	`str \| None`
`format`	`Literal['json']`
`limit`	`Required[int]`
`olderThenFlightId`	`None`
`page`	`int`
`pk`	`None`
`query`	`Required[str]`
`timestamp`	`TimestampS[int]`
`token`	`None \| str`

callback `instance-attribute` ¤

callback: None

device `instance-attribute` ¤

device: None | str

fetchBy `instance-attribute` ¤

fetchBy: Required[str]

filterBy `instance-attribute` ¤

filterBy: str | None

format `instance-attribute` ¤

format: Literal['json']

limit `instance-attribute` ¤

limit: Required[int]

olderThenFlightId `instance-attribute` ¤

olderThenFlightId: None

page `instance-attribute` ¤

page: int

pk `instance-attribute` ¤

pk: None

query `instance-attribute` ¤

query: Required[str]

timestamp `instance-attribute` ¤

timestamp: TimestampS[int]

token `instance-attribute` ¤

token: None | str

Item ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`current`	`int`
`total`	`None \| int`
`limit`	`int`

current `instance-attribute` ¤

current: int

total `instance-attribute` ¤

total: None | int

limit `instance-attribute` ¤

limit: int

Page ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`current`	`int`
`more`	`bool`
`total`	`None \| int`

current `instance-attribute` ¤

current: int

more `instance-attribute` ¤

more: bool

total `instance-attribute` ¤

total: None | int

Identification ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`id`	`str \| None`	icao hex
`row`	`int`	internal row id
`number`	`FlightNumber`
`callsign`	`str \| None`
`codeshare`	`None`

id `instance-attribute` ¤

id: str | None

icao hex

row `instance-attribute` ¤

row: int

internal row id

number `instance-attribute` ¤

number: FlightNumber

callsign `instance-attribute` ¤

callsign: str | None

codeshare `instance-attribute` ¤

codeshare: None

FlightListCountry ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`id`	`int \| None`
`name`	`str \| None`
`alpha2`	`str \| None`
`alpha3`	`str \| None`

id `instance-attribute` ¤

id: int | None

name `instance-attribute` ¤

name: str | None

alpha2 `instance-attribute` ¤

alpha2: str | None

alpha3 `instance-attribute` ¤

alpha3: str | None

AircraftInfo ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`model`	`AircraftModel`
`registration`	`None \| str`
`owner`	`NotRequired[OwnerData]`
`airline`	`NotRequired[AirlineData]`
`country`	`None \| FlightListCountry`
`hex`	`None \| str`
`restricted`	`bool`
`serialNo`	`None \| str`
`age`	`AircraftAge`
`availability`	`AircraftAvailability`

model `instance-attribute` ¤

model: AircraftModel

registration `instance-attribute` ¤

registration: None | str

owner `instance-attribute` ¤

owner: NotRequired[OwnerData]

airline `instance-attribute` ¤

airline: NotRequired[AirlineData]

country `instance-attribute` ¤

country: None | FlightListCountry

hex `instance-attribute` ¤

hex: None | str

restricted `instance-attribute` ¤

restricted: bool

serialNo `instance-attribute` ¤

serialNo: None | str

age `instance-attribute` ¤

age: AircraftAge

availability `instance-attribute` ¤

availability: AircraftAvailability

Interval ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`departure`	`None \| TimestampS[int]`
`arrival`	`None \| TimestampS[int]`

departure `instance-attribute` ¤

departure: None | TimestampS[int]

arrival `instance-attribute` ¤

arrival: None | TimestampS[int]

TimeOther ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`eta`	`None \| TimestampS[int]`
`updated`	`None \| TimestampS[int]`
`duration`	`None \| DurationS[int]`

eta `instance-attribute` ¤

eta: None | TimestampS[int]

updated `instance-attribute` ¤

updated: None | TimestampS[int]

duration `instance-attribute` ¤

duration: None | DurationS[int]

FlightListTime ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`scheduled`	`Interval`
`real`	`Interval`
`estimated`	`Interval`
`other`	`TimeOther`

scheduled `instance-attribute` ¤

scheduled: Interval

real `instance-attribute` ¤

real: Interval

estimated `instance-attribute` ¤

estimated: Interval

other `instance-attribute` ¤

other: TimeOther

FlightListItem ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`identification`	`Identification`
`status`	`StatusData`
`aircraft`	`AircraftInfo`
`owner`	`OwnerData`
`airline`	`AirlineData`
`airport`	`AirportPairData`
`time`	`FlightListTime`

identification `instance-attribute` ¤

identification: Identification

status `instance-attribute` ¤

status: StatusData

aircraft `instance-attribute` ¤

aircraft: AircraftInfo

owner `instance-attribute` ¤

owner: OwnerData

airline `instance-attribute` ¤

airline: AirlineData

airport `instance-attribute` ¤

airport: AirportPairData

time `instance-attribute` ¤

time: FlightListTime

AircraftImage ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`registration`	`str`
`images`	`ImageCollection`

registration `instance-attribute` ¤

registration: str

images `instance-attribute` ¤

images: ImageCollection

FlightListResponse ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`item`	`Item`
`page`	`Page`
`timestamp`	`TimestampS[int]`
`data`	`list[FlightListItem] \| None`
`aircraftInfo`	`AircraftInfo`
`aircraftImages`	`list[AircraftImage]`

item `instance-attribute` ¤

item: Item

page `instance-attribute` ¤

page: Page

timestamp `instance-attribute` ¤

timestamp: TimestampS[int]

data `instance-attribute` ¤

data: list[FlightListItem] | None

aircraftInfo `instance-attribute` ¤

aircraftInfo: AircraftInfo

aircraftImages `instance-attribute` ¤

aircraftImages: list[AircraftImage]

FlightListResult ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`request`	`FlightListRequest`
`response`	`FlightListResponse`

request `instance-attribute` ¤

request: FlightListRequest

response `instance-attribute` ¤

response: FlightListResponse

FlightList ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`result`	`FlightListResult`

result `instance-attribute` ¤

result: FlightListResult

PlaybackRequest ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`callback`	`None`
`device`	`None \| str`
`flightId`	`Required[StrFlightIdHex]`
`format`	`Literal['json']`
`pk`	`None`
`timestamp`	`TimestampS[int] \| None`
`token`	`None \| str`

callback `instance-attribute` ¤

callback: None

device `instance-attribute` ¤

device: None | str

flightId `instance-attribute` ¤

flightId: Required[StrFlightIdHex]

format `instance-attribute` ¤

format: Literal['json']

pk `instance-attribute` ¤

pk: None

timestamp `instance-attribute` ¤

timestamp: TimestampS[int] | None

token `instance-attribute` ¤

token: None | str

FlightIdentification ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`id`	`StrFlightIdHex \| int`
`number`	`FlightNumber`
`callsign`	`str`

id `instance-attribute` ¤

id: StrFlightIdHex | int

number `instance-attribute` ¤

number: FlightNumber

callsign `instance-attribute` ¤

callsign: str

AircraftIdentification ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`modes`	`str`
`registration`	`str`
`serialNo`	`None \| str`
`age`	`NotRequired[AircraftAge]`
`availability`	`NotRequired[AircraftAvailability]`

modes `instance-attribute` ¤

modes: str

registration `instance-attribute` ¤

registration: str

serialNo `instance-attribute` ¤

serialNo: None | str

age `instance-attribute` ¤

age: NotRequired[AircraftAge]

availability `instance-attribute` ¤

availability: NotRequired[AircraftAvailability]

AircraftData ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`model`	`AircraftModel`
`identification`	`AircraftIdentification`
`availability`	`AircraftAvailability`

model `instance-attribute` ¤

model: AircraftModel

identification `instance-attribute` ¤

identification: AircraftIdentification

availability `instance-attribute` ¤

availability: AircraftAvailability

Median ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`time`	`int \| None`
`delay`	`int \| None`
`timestamp`	`TimestampS[int] \| None`

time `instance-attribute` ¤

time: int | None

delay `instance-attribute` ¤

delay: int | None

timestamp `instance-attribute` ¤

timestamp: TimestampS[int] | None

Altitude ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`feet`	`AltitudeFt[int]`
`meters`	`AltitudeM[int]`

feet `instance-attribute` ¤

feet: AltitudeFt[int]

meters `instance-attribute` ¤

meters: AltitudeM[int]

Speed ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`kmh`	`GroundSpeedKmh[float]`
`kts`	`GroundSpeedKt[int]`
`mph`	`GroundSpeedMph[float]`

kmh `instance-attribute` ¤

kmh: GroundSpeedKmh[float]

kts `instance-attribute` ¤

kts: GroundSpeedKt[int]

mph `instance-attribute` ¤

mph: GroundSpeedMph[float]

VerticalSpeed ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`fpm`	`VerticalSpeedFpm[int] \| None`
`ms`	`VerticalSpeedMps[int] \| None`

fpm `instance-attribute` ¤

fpm: VerticalSpeedFpm[int] | None

ms `instance-attribute` ¤

ms: VerticalSpeedMps[int] | None

EMS ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`ts`	`TimestampS[int]`
`ias`	`IndicatedAirSpeedKt[int] \| None`
`tas`	`TrueAirSpeedKt[int] \| None`
`mach`	`MachTimes1K[int] \| None`
`mcp`	`AltitudeFt[int] \| None`
`fms`	`AltitudeFt[int] \| None`
`autopilot`	`None`
`oat`	`StaticTemperatureC[int] \| None`
`trueTrack`	`GroundTrackDeg[float] \| None`
`rollAngle`	`BankAngleDeg[float] \| None`
`qnh`	`PressureAltimeterHpa[int] \| None`
`windDir`	`BearingDeg[int] \| None`
`windSpd`	`WindSpeedKt[int] \| None`
`precision`	`int \| None`
`altGPS`	`GeometricAltitudeM[int] \| None`
`emergencyStatus`	`int \| None`
`tcasAcasDtatus`	`int \| None`
`heading`	`BearingDeg[int] \| None`

ts `instance-attribute` ¤

ts: TimestampS[int]

ias `instance-attribute` ¤

ias: IndicatedAirSpeedKt[int] | None

tas `instance-attribute` ¤

tas: TrueAirSpeedKt[int] | None

mach `instance-attribute` ¤

mach: MachTimes1K[int] | None

mcp `instance-attribute` ¤

mcp: AltitudeFt[int] | None

fms `instance-attribute` ¤

fms: AltitudeFt[int] | None

autopilot `instance-attribute` ¤

autopilot: None

oat `instance-attribute` ¤

oat: StaticTemperatureC[int] | None

trueTrack `instance-attribute` ¤

trueTrack: GroundTrackDeg[float] | None

rollAngle `instance-attribute` ¤

rollAngle: BankAngleDeg[float] | None

qnh `instance-attribute` ¤

qnh: PressureAltimeterHpa[int] | None

windDir `instance-attribute` ¤

windDir: BearingDeg[int] | None

windSpd `instance-attribute` ¤

windSpd: WindSpeedKt[int] | None

precision `instance-attribute` ¤

precision: int | None

altGPS `instance-attribute` ¤

altGPS: GeometricAltitudeM[int] | None

emergencyStatus `instance-attribute` ¤

emergencyStatus: int | None

tcasAcasDtatus `instance-attribute` ¤

tcasAcasDtatus: int | None

heading `instance-attribute` ¤

heading: BearingDeg[int] | None

TrackData ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`latitude`	`LatitudeDeg[float]`
`longitude`	`LongitudeDeg[float]`
`altitude`	`Altitude`
`speed`	`Speed`
`verticalSpeed`	`VerticalSpeed`
`heading`	`GroundTrackDeg[int]`	Warning
`squawk`	`str`
`timestamp`	`TimestampS[int]`
`ems`	`None \| EMS`

latitude `instance-attribute` ¤

latitude: LatitudeDeg[float]

longitude `instance-attribute` ¤

longitude: LongitudeDeg[float]

altitude `instance-attribute` ¤

altitude: Altitude

speed `instance-attribute` ¤

speed: Speed

verticalSpeed `instance-attribute` ¤

verticalSpeed: VerticalSpeed

heading `instance-attribute` ¤

heading: GroundTrackDeg[int]

Warning

The JSON response claims that heading is available, but ADS-B only transmits the ground track. Heading is only available in EMS data.

This field is renamed to track to avoid confusion in fr24.json.playback_track_dict.

squawk `instance-attribute` ¤

squawk: str

timestamp `instance-attribute` ¤

timestamp: TimestampS[int]

ems `instance-attribute` ¤

ems: None | EMS

FlightDataAvailability ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`ems`	`bool`

ems `instance-attribute` ¤

ems: bool

FlightData ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`identification`	`FlightIdentification`
`status`	`StatusData`
`aircraft`	`AircraftData \| None`
`owner`	`OwnerData \| None`
`airline`	`AirlineData \| None`
`airport`	`AirportPairData`
`median`	`Median`
`track`	`list[TrackData]`
`aircraftImages`	`ImageCollection`
`availability`	`FlightDataAvailability`

identification `instance-attribute` ¤

identification: FlightIdentification

status `instance-attribute` ¤

status: StatusData

aircraft `instance-attribute` ¤

aircraft: AircraftData | None

owner `instance-attribute` ¤

owner: OwnerData | None

airline `instance-attribute` ¤

airline: AirlineData | None

airport `instance-attribute` ¤

airport: AirportPairData

median `instance-attribute` ¤

median: Median

track `instance-attribute` ¤

track: list[TrackData]

aircraftImages `instance-attribute` ¤

aircraftImages: ImageCollection

availability `instance-attribute` ¤

availability: FlightDataAvailability

PlaybackData ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`flight`	`FlightData`

flight `instance-attribute` ¤

flight: FlightData

PlaybackResponse ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`timestamp`	`TimestampS[int]`
`altitudeFiltered`	`bool`
`data`	`PlaybackData`

timestamp `instance-attribute` ¤

timestamp: TimestampS[int]

altitudeFiltered `instance-attribute` ¤

altitudeFiltered: bool

data `instance-attribute` ¤

data: PlaybackData

PlaybackResult ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`request`	`PlaybackRequest`
`response`	`PlaybackResponse`

request `instance-attribute` ¤

request: PlaybackRequest

response `instance-attribute` ¤

response: PlaybackResponse

Playback ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`result`	`PlaybackResult`

result `instance-attribute` ¤

result: PlaybackResult

AirportListScheduleSetting ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`mode`	`Literal['departures', 'arrivals'] \| None`
`timestamp`	`TimestampS[int]`

mode `instance-attribute` ¤

mode: Literal['departures', 'arrivals'] | None

timestamp `instance-attribute` ¤

timestamp: TimestampS[int]

PluginSetting ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`schedule`	`AirportListScheduleSetting`

schedule `instance-attribute` ¤

schedule: AirportListScheduleSetting

AirportSchedule ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`arrivals`	`FlightListResponse`
`departures`	`FlightListResponse`

arrivals `instance-attribute` ¤

arrivals: FlightListResponse

departures `instance-attribute` ¤

departures: FlightListResponse

AirportPluginData ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`schedule`	`AirportSchedule`

schedule `instance-attribute` ¤

schedule: AirportSchedule

AirportListData ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`pluginData`	`AirportPluginData`

pluginData `instance-attribute` ¤

pluginData: AirportPluginData

AirportResponse ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`airport`	`AirportListData`

airport `instance-attribute` ¤

airport: AirportListData

AirportResult ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`request`	`AirportRequest`
`response`	`AirportResponse`

request `instance-attribute` ¤

request: AirportRequest

response `instance-attribute` ¤

response: AirportResponse

AirportList ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`result`	`AirportResult`

result `instance-attribute` ¤

result: AirportResult

Live ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`operator_id`	`NotRequired[int]`
`lat`	`LatitudeDeg[float]`
`lon`	`LongitudeDeg[float]`
`schd_from`	`NotRequired[str]`
`schd_to`	`NotRequired[str]`
`ac_type`	`str`
`route`	`NotRequired[str]`
`logo`	`NotRequired[str]`
`reg`	`str`
`callsign`	`NotRequired[str]`
`flight`	`NotRequired[str]`
`operator`	`NotRequired[str]`

operator_id `instance-attribute` ¤

operator_id: NotRequired[int]

lat `instance-attribute` ¤

lat: LatitudeDeg[float]

lon `instance-attribute` ¤

lon: LongitudeDeg[float]

schd_from `instance-attribute` ¤

schd_from: NotRequired[str]

schd_to `instance-attribute` ¤

schd_to: NotRequired[str]

ac_type `instance-attribute` ¤

ac_type: str

route `instance-attribute` ¤

route: NotRequired[str]

logo `instance-attribute` ¤

logo: NotRequired[str]

reg `instance-attribute` ¤

reg: str

callsign `instance-attribute` ¤

callsign: NotRequired[str]

flight `instance-attribute` ¤

flight: NotRequired[str]

operator `instance-attribute` ¤

operator: NotRequired[str]

FindAirportDetail ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`lat`	`LatitudeDeg[float]`
`lon`	`LongitudeDeg[float]`
`size`	`float`

lat `instance-attribute` ¤

lat: LatitudeDeg[float]

lon `instance-attribute` ¤

lon: LongitudeDeg[float]

size `instance-attribute` ¤

size: float

Operator ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`operator_id`	`int`
`iata`	`NotRequired[str]`
`logo`	`NotRequired[str]`

operator_id `instance-attribute` ¤

operator_id: int

iata `instance-attribute` ¤

iata: NotRequired[str]

logo `instance-attribute` ¤

logo: NotRequired[str]

FindScheduleDetail ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`logo`	`NotRequired[str]`
`callsign`	`NotRequired[str]`
`flight`	`str`
`operator`	`NotRequired[str]`
`operator_id`	`NotRequired[int]`
`schd_from`	`NotRequired[str]`
`schd_to`	`NotRequired[str]`

logo `instance-attribute` ¤

logo: NotRequired[str]

callsign `instance-attribute` ¤

callsign: NotRequired[str]

flight `instance-attribute` ¤

flight: str

operator `instance-attribute` ¤

operator: NotRequired[str]

operator_id `instance-attribute` ¤

operator_id: NotRequired[int]

schd_from `instance-attribute` ¤

schd_from: NotRequired[str]

schd_to `instance-attribute` ¤

schd_to: NotRequired[str]

Aircraft ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`owner`	`str`
`equip`	`str`
`hex`	`str`
`operator_id`	`int`
`logo`	`str`

owner `instance-attribute` ¤

owner: str

equip `instance-attribute` ¤

equip: str

hex `instance-attribute` ¤

hex: str

operator_id `instance-attribute` ¤

operator_id: int

logo `instance-attribute` ¤

logo: str

EntryBase ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`label`	`str`
`name`	`NotRequired[str]`

label `instance-attribute` ¤

label: str

name `instance-attribute` ¤

name: NotRequired[str]

AirportEntry ¤

Bases: EntryBase

Attributes:

Name	Type	Description
`id`	`Iata \| Icao`
`detail`	`FindAirportDetail`
`type`	`Literal['airport']`
`match`	`Literal['icao', 'iata', 'begins', 'contains']`
`label`	`str`
`name`	`NotRequired[str]`

id `instance-attribute` ¤

id: Iata | Icao

detail `instance-attribute` ¤

detail: FindAirportDetail

type `instance-attribute` ¤

type: Literal['airport']

match `instance-attribute` ¤

match: Literal['icao', 'iata', 'begins', 'contains']

label `instance-attribute` ¤

label: str

name `instance-attribute` ¤

name: NotRequired[str]

OperatorEntry ¤

Bases: EntryBase

Attributes:

Name	Type	Description
`id`	`str`
`detail`	`Operator`
`type`	`Literal['operator']`
`match`	`Literal['begins', 'icao']`
`label`	`str`
`name`	`NotRequired[str]`

id `instance-attribute` ¤

id: str

detail `instance-attribute` ¤

detail: Operator

type `instance-attribute` ¤

type: Literal['operator']

match `instance-attribute` ¤

match: Literal['begins', 'icao']

label `instance-attribute` ¤

label: str

name `instance-attribute` ¤

name: NotRequired[str]

LiveEntry ¤

Bases: EntryBase

Attributes:

Name	Type	Description
`id`	`str`
`detail`	`Live`
`type`	`Literal['live']`
`match`	`Literal['route', 'begins']`
`label`	`str`
`name`	`NotRequired[str]`

id `instance-attribute` ¤

id: str

detail `instance-attribute` ¤

detail: Live

type `instance-attribute` ¤

type: Literal['live']

match `instance-attribute` ¤

match: Literal['route', 'begins']

label `instance-attribute` ¤

label: str

name `instance-attribute` ¤

name: NotRequired[str]

ScheduleEntry ¤

Bases: EntryBase

Attributes:

Name	Type	Description
`id`	`str`
`detail`	`FindScheduleDetail`
`type`	`Literal['schedule']`
`match`	`Literal['route', 'begins']`
`label`	`str`
`name`	`NotRequired[str]`

id `instance-attribute` ¤

id: str

detail `instance-attribute` ¤

detail: FindScheduleDetail

type `instance-attribute` ¤

type: Literal['schedule']

match `instance-attribute` ¤

match: Literal['route', 'begins']

label `instance-attribute` ¤

label: str

name `instance-attribute` ¤

name: NotRequired[str]

AircraftEntry ¤

Bases: EntryBase

Attributes:

Name	Type	Description
`id`	`str`
`detail`	`Aircraft`
`type`	`Literal['aircraft']`
`match`	`Literal['begins']`
`label`	`str`
`name`	`NotRequired[str]`

id `instance-attribute` ¤

id: str

detail `instance-attribute` ¤

detail: Aircraft

type `instance-attribute` ¤

type: Literal['aircraft']

match `instance-attribute` ¤

match: Literal['begins']

label `instance-attribute` ¤

label: str

name `instance-attribute` ¤

name: NotRequired[str]

StatsEntry ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`all`	`NotRequired[int]`
`airport`	`int`
`operator`	`int`
`live`	`int`
`schedule`	`int`
`aircraft`	`int`

all `instance-attribute` ¤

all: NotRequired[int]

airport `instance-attribute` ¤

airport: int

operator `instance-attribute` ¤

operator: int

live `instance-attribute` ¤

live: int

schedule `instance-attribute` ¤

schedule: int

aircraft `instance-attribute` ¤

aircraft: int

Stats ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`total`	`StatsEntry`
`count`	`StatsEntry`

total `instance-attribute` ¤

total: StatsEntry

count `instance-attribute` ¤

count: StatsEntry

Info ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`grpcEnabled`	`bool`

grpcEnabled `instance-attribute` ¤

grpcEnabled: bool

Find ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`results`	`list[Entry]`
`stats`	`Stats`
`info`	`Info`

results `instance-attribute` ¤

results: list[Entry]

stats `instance-attribute` ¤

stats: Stats

info `instance-attribute` ¤

info: Info

is_airport ¤

is_airport(entry: Entry) -> TypeGuard[AirportEntry]

is_operator ¤

is_operator(entry: Entry) -> TypeGuard[OperatorEntry]

is_live ¤

is_live(entry: Entry) -> TypeGuard[LiveEntry]

is_schedule ¤

is_schedule(entry: Entry) -> TypeGuard[ScheduleEntry]

is_aircraft ¤

is_aircraft(entry: Entry) -> TypeGuard[AircraftEntry]

static ¤

Classes:

Name	Description
`Model`
`AircraftFamilyRow`
`AircraftFamily`
`Airline`
`Airlines`
`Timezone`
`Airport`
`Airports`
`CountryName`
`CountryCode`
`Country`
`Metadata`
`Countries`

Attributes:

Name	Type	Description
`StaticData`

StaticData `module-attribute` ¤

StaticData = Union[
    AircraftFamily, Airlines, Airports, Countries
]

Model ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`Name`	`str`
`Code`	`str`

Name `instance-attribute` ¤

Name: str

Code `instance-attribute` ¤

Code: str

AircraftFamilyRow ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`description`	`str`
`models`	`list[Model]`

description `instance-attribute` ¤

description: str

models `instance-attribute` ¤

models: list[Model]

AircraftFamily ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`version`	`int`
`rows`	`list[AircraftFamilyRow]`

version `instance-attribute` ¤

version: int

rows `instance-attribute` ¤

rows: list[AircraftFamilyRow]

Airline ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`Name`	`str`
`Code`	`str`
`ICAO`	`str`

Name `instance-attribute` ¤

Name: str

Code `instance-attribute` ¤

Code: str

ICAO `instance-attribute` ¤

ICAO: str

Airlines ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`version`	`int`
`rows`	`list[Airline]`

version `instance-attribute` ¤

version: int

rows `instance-attribute` ¤

rows: list[Airline]

Timezone ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`name`	`str`
`offset`	`UtcOffsetS[int] \| None`
`offsetHours`	`str`
`abbr`	`str`
`abbrName`	`str \| None`
`isDst`	`bool`

name `instance-attribute` ¤

name: str

offset `instance-attribute` ¤

offset: UtcOffsetS[int] | None

offsetHours `instance-attribute` ¤

offsetHours: str

abbr `instance-attribute` ¤

abbr: str

abbrName `instance-attribute` ¤

abbrName: str | None

isDst `instance-attribute` ¤

isDst: bool

Airport ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`id`	`int`
`name`	`str`
`iata`	`str`
`icao`	`str`
`city`	`str`
`lat`	`LatitudeDeg[float]`
`lon`	`LongitudeDeg[float]`
`country`	`str`
`alt`	`AltitudeFt[int] \| Literal['-1']`
`size`	`int`
`timezone`	`Timezone`
`countryId`	`int`

id `instance-attribute` ¤

id: int

name `instance-attribute` ¤

name: str

iata `instance-attribute` ¤

iata: str

icao `instance-attribute` ¤

icao: str

city `instance-attribute` ¤

city: str

lat `instance-attribute` ¤

lat: LatitudeDeg[float]

lon `instance-attribute` ¤

lon: LongitudeDeg[float]

country `instance-attribute` ¤

country: str

alt `instance-attribute` ¤

alt: AltitudeFt[int] | Literal['-1']

size `instance-attribute` ¤

size: int

timezone `instance-attribute` ¤

timezone: Timezone

countryId `instance-attribute` ¤

countryId: int

Airports ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`version`	`str`
`rows`	`list[Airport]`

version `instance-attribute` ¤

version: str

rows `instance-attribute` ¤

rows: list[Airport]

CountryName ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`default`	`str`
`full`	`str`

default `instance-attribute` ¤

default: str

full `instance-attribute` ¤

full: str

CountryCode ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`alpha2`	`str`
`alpha3`	`str`

alpha2 `instance-attribute` ¤

alpha2: str

alpha3 `instance-attribute` ¤

alpha3: str

Country ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`id`	`int`
`name`	`CountryName`
`code`	`CountryCode`

id `instance-attribute` ¤

id: int

name `instance-attribute` ¤

name: CountryName

code `instance-attribute` ¤

code: CountryCode

Metadata ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`timestamp`	`TimestampS[int]`
`count`	`int`

timestamp `instance-attribute` ¤

timestamp: TimestampS[int]

count `instance-attribute` ¤

count: int

Countries ¤

Bases: TypedDict

Attributes:

Name	Type	Description
`metadata`	`Metadata`
`data`	`list[Country]`

metadata `instance-attribute` ¤

metadata: Metadata

data `instance-attribute` ¤

data: list[Country]

Types

types ¤

M module-attribute ¤

IntoTimestamp module-attribute ¤

IntFlightId module-attribute ¤

StrFlightIdHex module-attribute ¤

IntoFlightId module-attribute ¤

cache ¤

flight_list_schema module-attribute ¤

playback_track_ems_schema module-attribute ¤

playback_track_schema module-attribute ¤

position_buffer_struct_schema module-attribute ¤

live_feed_schema module-attribute ¤

nearest_flights_schema module-attribute ¤

live_flights_status_schema module-attribute ¤

top_flights_schema module-attribute ¤

ems_struct_schema module-attribute ¤

trail_point_schema module-attribute ¤

flight_details_schema module-attribute ¤

playback_flight_schema module-attribute ¤

TabularFileFmt module-attribute ¤

DType dataclass ¤

type_ instance-attribute ¤

__post_init__ ¤

FlightListRecord ¤

flight_id instance-attribute ¤

number instance-attribute ¤

callsign instance-attribute ¤

icao24 instance-attribute ¤

registration instance-attribute ¤

typecode instance-attribute ¤

origin instance-attribute ¤

destination instance-attribute ¤

status instance-attribute ¤

STOD instance-attribute ¤

ETOD instance-attribute ¤

ATOD instance-attribute ¤

STOA instance-attribute ¤

ETOA instance-attribute ¤

ATOA instance-attribute ¤

PlaybackTrackEMSRecord ¤

timestamp instance-attribute ¤

ias instance-attribute ¤

tas instance-attribute ¤

mach instance-attribute ¤

mcp instance-attribute ¤

fms instance-attribute ¤

autopilot instance-attribute ¤

oat instance-attribute ¤

track instance-attribute ¤

roll instance-attribute ¤

qnh instance-attribute ¤

wind_dir instance-attribute ¤

wind_speed instance-attribute ¤

precision instance-attribute ¤

altitude_gps instance-attribute ¤

emergency instance-attribute ¤

tcas_acas instance-attribute ¤

heading instance-attribute ¤

PlaybackTrackRecord ¤

timestamp instance-attribute ¤

latitude instance-attribute ¤

longitude instance-attribute ¤

altitude instance-attribute ¤

ground_speed instance-attribute ¤

vertical_speed instance-attribute ¤

track instance-attribute ¤

squawk instance-attribute ¤

ems instance-attribute ¤

RecentPositionRecord ¤

delta_lat instance-attribute ¤

delta_lon instance-attribute ¤

delta_ms instance-attribute ¤

FlightRecord ¤

timestamp instance-attribute ¤

flightid instance-attribute ¤

latitude instance-attribute ¤

longitude instance-attribute ¤

track instance-attribute ¤

altitude instance-attribute ¤

M `module-attribute` ¤

IntoTimestamp `module-attribute` ¤

IntFlightId `module-attribute` ¤

StrFlightIdHex `module-attribute` ¤

IntoFlightId `module-attribute` ¤

flight_list_schema `module-attribute` ¤

playback_track_ems_schema `module-attribute` ¤

playback_track_schema `module-attribute` ¤

position_buffer_struct_schema `module-attribute` ¤

live_feed_schema `module-attribute` ¤

nearest_flights_schema `module-attribute` ¤

live_flights_status_schema `module-attribute` ¤

top_flights_schema `module-attribute` ¤

ems_struct_schema `module-attribute` ¤

trail_point_schema `module-attribute` ¤

flight_details_schema `module-attribute` ¤

playback_flight_schema `module-attribute` ¤

TabularFileFmt `module-attribute` ¤

DType `dataclass` ¤

type_ `instance-attribute` ¤

flight_id `instance-attribute` ¤

number `instance-attribute` ¤

callsign `instance-attribute` ¤

icao24 `instance-attribute` ¤

registration `instance-attribute` ¤

typecode `instance-attribute` ¤

origin `instance-attribute` ¤

destination `instance-attribute` ¤

status `instance-attribute` ¤

STOD `instance-attribute` ¤

ETOD `instance-attribute` ¤

ATOD `instance-attribute` ¤

STOA `instance-attribute` ¤

ETOA `instance-attribute` ¤

ATOA `instance-attribute` ¤

timestamp `instance-attribute` ¤

ias `instance-attribute` ¤

tas `instance-attribute` ¤

mach `instance-attribute` ¤

mcp `instance-attribute` ¤

fms `instance-attribute` ¤

autopilot `instance-attribute` ¤

oat `instance-attribute` ¤

track `instance-attribute` ¤

roll `instance-attribute` ¤

qnh `instance-attribute` ¤

wind_dir `instance-attribute` ¤

wind_speed `instance-attribute` ¤

precision `instance-attribute` ¤

altitude_gps `instance-attribute` ¤

emergency `instance-attribute` ¤

tcas_acas `instance-attribute` ¤

heading `instance-attribute` ¤

timestamp `instance-attribute` ¤

latitude `instance-attribute` ¤

longitude `instance-attribute` ¤

altitude `instance-attribute` ¤

ground_speed `instance-attribute` ¤

vertical_speed `instance-attribute` ¤

track `instance-attribute` ¤

squawk `instance-attribute` ¤

ems `instance-attribute` ¤

delta_lat `instance-attribute` ¤

delta_lon `instance-attribute` ¤

delta_ms `instance-attribute` ¤

timestamp `instance-attribute` ¤

flightid `instance-attribute` ¤

latitude `instance-attribute` ¤

longitude `instance-attribute` ¤

track `instance-attribute` ¤

altitude `instance-attribute` ¤

ground_speed `instance-attribute` ¤

on_ground `instance-attribute` ¤

callsign `instance-attribute` ¤

source `instance-attribute` ¤

registration `instance-attribute` ¤

origin `instance-attribute` ¤

destination `instance-attribute` ¤

typecode `instance-attribute` ¤

eta `instance-attribute` ¤