Flight Position Models¶
- pydantic model flight_radar.models.flight_position.CountResponse¶
Bases:
BaseModelShow JSON schema
{ "title": "CountResponse", "type": "object", "properties": { "record_count": { "description": "Total number of records matching the query.", "title": "Record Count", "type": "integer" } }, "required": [ "record_count" ] }
- Fields:
-
field record_count:
int[Required]¶ Total number of records matching the query.
- static from_dto(dto)¶
- Return type:
- Parameters:
dto (CountResponseDto)
- pydantic model flight_radar.models.flight_position.FlightPosition¶
Bases:
FlightPositionLightShow JSON schema
{ "title": "FlightPosition", "type": "object", "properties": { "fr24_id": { "description": "Unique identifier assigned by Flightradar24 to the flight leg.", "title": "Fr24 Id", "type": "string" }, "hex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "24 bit Mode-S identifier expressed in hexadecimal format.", "title": "Hex" }, "callsign": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Callsign used by Air Traffic Control to denote\n a specific flight (as sent by aircraft transponder).", "title": "Callsign" }, "lat": { "description": "Latest latitude expressed in decimal degrees.", "title": "Lat", "type": "number" }, "lon": { "description": "Latest longitude expressed in decimal degrees.", "title": "Lon", "type": "number" }, "track": { "description": "True track (over ground) expressed in integer degrees as 0-360.\n Please note that 0 can in some cases mean unknown.", "title": "Track", "type": "integer" }, "alt": { "description": "Barometric pressure altitude above mean sea level (AMSL)\n reported at a standard atmospheric pressure (1013.25 hPa / 29.92 in. Hg.)\n expressed in feet.", "title": "Alt", "type": "integer" }, "gspeed": { "description": "Speed relative to the ground expressed in knots.", "title": "Gspeed", "type": "integer" }, "vspeed": { "description": "The rate at which the aircraft is ascending or descending in feet per minute.", "title": "Vspeed", "type": "integer" }, "squawk": { "description": "4 digit unique identifying code for ATC expressed in octal format.", "title": "Squawk", "type": "string" }, "timestamp": { "description": "Timestamp of the flight position in UTC.", "format": "date-time", "title": "Timestamp", "type": "string" }, "source": { "description": "Data source of the provided flight position.", "title": "Source", "type": "string" }, "flight": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Commercial flight number.", "title": "Flight" }, "painted_as": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ICAO code of the carrier mapped from FR24's internal database.", "title": "Painted As" }, "operating_as": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ICAO code of the airline carrier as derived from flight callsign.", "title": "Operating As" }, "orig_iata": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "IATA code for the origin airport.", "title": "Orig Iata" }, "orig_icao": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ICAO code for the origin airport.", "title": "Orig Icao" }, "dest_iata": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "IATA code for the destination airport.", "title": "Dest Iata" }, "dest_icao": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "ICAO code for the destination airport.", "title": "Dest Icao" }, "eta": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "description": "Estimated time of arrival", "title": "Eta" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Aircraft ICAO type code.", "title": "Type" }, "reg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Aircraft registration as matched from Mode-S identifier.", "title": "Reg" } }, "required": [ "fr24_id", "lat", "lon", "track", "alt", "gspeed", "vspeed", "squawk", "timestamp", "source" ] }
- Fields:
-
field dest_iata:
str|None= None¶ IATA code for the destination airport.
-
field dest_icao:
str|None= None¶ ICAO code for the destination airport.
-
field eta:
datetime|None= None¶ Estimated time of arrival
-
field flight:
str|None= None¶ Commercial flight number.
-
field operating_as:
str|None= None¶ ICAO code of the airline carrier as derived from flight callsign.
-
field orig_iata:
str|None= None¶ IATA code for the origin airport.
-
field orig_icao:
str|None= None¶ ICAO code for the origin airport.
-
field painted_as:
str|None= None¶ ICAO code of the carrier mapped from FR24’s internal database.
-
field reg:
str|None= None¶ Aircraft registration as matched from Mode-S identifier.
-
field type:
str|None= None¶ Aircraft ICAO type code.
- static from_dto(dto)¶
- Return type:
- Parameters:
dto (FlightPositionResponseDto)
- pydantic model flight_radar.models.flight_position.FlightPositionBaseRequest¶
Bases:
BaseModelShow JSON schema
{ "title": "FlightPositionBaseRequest", "type": "object", "properties": { "bounds": { "anyOf": [ { "maxItems": 4, "minItems": 4, "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array" }, { "type": "null" } ], "default": null, "title": "Bounds" }, "flights": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Flights" }, "callsigns": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Callsigns" }, "registrations": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Registrations" }, "painted_as": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Painted As" }, "operating_as": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Operating As" }, "airports": { "anyOf": [ { "items": { "$ref": "#/$defs/AirportWithDirection" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Airports" }, "routes": { "anyOf": [ { "items": { "$ref": "#/$defs/Route" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Routes" }, "aircraft": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Aircraft" }, "altitude_ranges": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "integer" }, { "type": "integer" } ], "type": "array" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Altitude Ranges" }, "squawks": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Squawks" }, "categories": { "anyOf": [ { "items": { "$ref": "#/$defs/FlightCategory" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Categories" }, "data_sources": { "anyOf": [ { "items": { "$ref": "#/$defs/DataSources" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Data Sources" }, "airspaces": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Airspaces" }, "gspeed": { "anyOf": [ { "type": "integer" }, { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "integer" }, { "type": "integer" } ], "type": "array" }, { "type": "null" } ], "default": null, "title": "Gspeed" } }, "$defs": { "AirportWithDirection": { "properties": { "airport": { "description": "Airport IATA or ICAO code.", "title": "Airport", "type": "string" }, "direction": { "anyOf": [ { "$ref": "#/$defs/Direction" }, { "type": "null" } ], "default": null, "description": "Direction of the flight (inbound or outbound or both)." } }, "required": [ "airport" ], "title": "AirportWithDirection", "type": "object" }, "DataSources": { "enum": [ "ADSB", "MLAT", "ESTIMATED", null ], "title": "DataSources" }, "Direction": { "enum": [ "both", "inbound", "outbound" ], "title": "Direction", "type": "string" }, "FlightCategory": { "enum": [ "P", "C", "M", "J", "T", "H", "B", "G", "D", "V", "O", "N" ], "title": "FlightCategory", "type": "string" }, "Route": { "properties": { "origin": { "description": "Origin airport IATA or ICAO code.", "title": "Origin", "type": "string" }, "destination": { "description": "Destination airport IATA or ICAO code.", "title": "Destination", "type": "string" } }, "required": [ "origin", "destination" ], "title": "Route", "type": "object" } } }
- Fields:
- Validators:
validate»all fields
-
field airports:
Optional[Annotated[List[AirportWithDirection]]] = None¶ - Validated by:
- to_dto()¶
- Return type:
FlightPositionBaseRequestDto
- validator validate » all fields¶
Validate that at least one filter parameter is provided.
- pydantic model flight_radar.models.flight_position.FlightPositionLight¶
Bases:
BaseModelShow JSON schema
{ "title": "FlightPositionLight", "type": "object", "properties": { "fr24_id": { "description": "Unique identifier assigned by Flightradar24 to the flight leg.", "title": "Fr24 Id", "type": "string" }, "hex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "24 bit Mode-S identifier expressed in hexadecimal format.", "title": "Hex" }, "callsign": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Callsign used by Air Traffic Control to denote\n a specific flight (as sent by aircraft transponder).", "title": "Callsign" }, "lat": { "description": "Latest latitude expressed in decimal degrees.", "title": "Lat", "type": "number" }, "lon": { "description": "Latest longitude expressed in decimal degrees.", "title": "Lon", "type": "number" }, "track": { "description": "True track (over ground) expressed in integer degrees as 0-360.\n Please note that 0 can in some cases mean unknown.", "title": "Track", "type": "integer" }, "alt": { "description": "Barometric pressure altitude above mean sea level (AMSL)\n reported at a standard atmospheric pressure (1013.25 hPa / 29.92 in. Hg.)\n expressed in feet.", "title": "Alt", "type": "integer" }, "gspeed": { "description": "Speed relative to the ground expressed in knots.", "title": "Gspeed", "type": "integer" }, "vspeed": { "description": "The rate at which the aircraft is ascending or descending in feet per minute.", "title": "Vspeed", "type": "integer" }, "squawk": { "description": "4 digit unique identifying code for ATC expressed in octal format.", "title": "Squawk", "type": "string" }, "timestamp": { "description": "Timestamp of the flight position in UTC.", "format": "date-time", "title": "Timestamp", "type": "string" }, "source": { "description": "Data source of the provided flight position.", "title": "Source", "type": "string" } }, "required": [ "fr24_id", "lat", "lon", "track", "alt", "gspeed", "vspeed", "squawk", "timestamp", "source" ] }
- Fields:
-
field alt:
int[Required]¶ Barometric pressure altitude above mean sea level (AMSL) reported at a standard atmospheric pressure (1013.25 hPa / 29.92 in. Hg.) expressed in feet.
-
field callsign:
str|None= None¶ Callsign used by Air Traffic Control to denote a specific flight (as sent by aircraft transponder).
-
field fr24_id:
str[Required]¶ Unique identifier assigned by Flightradar24 to the flight leg.
-
field gspeed:
int[Required]¶ Speed relative to the ground expressed in knots.
-
field hex:
str|None= None¶ 24 bit Mode-S identifier expressed in hexadecimal format.
-
field lat:
float[Required]¶ Latest latitude expressed in decimal degrees.
-
field lon:
float[Required]¶ Latest longitude expressed in decimal degrees.
-
field source:
str[Required]¶ Data source of the provided flight position.
-
field squawk:
str[Required]¶ 4 digit unique identifying code for ATC expressed in octal format.
-
field timestamp:
datetime[Required]¶ Timestamp of the flight position in UTC.
-
field track:
int[Required]¶ True track (over ground) expressed in integer degrees as 0-360. Please note that 0 can in some cases mean unknown.
-
field vspeed:
int[Required]¶ The rate at which the aircraft is ascending or descending in feet per minute.
- static from_dto(dto)¶
- Return type:
- Parameters:
dto (FlightPositionLightDto)
- pydantic model flight_radar.models.flight_position.HistoricFlightPositionCountRequest¶
Bases:
FlightPositionBaseRequestShow JSON schema
{ "title": "HistoricFlightPositionCountRequest", "type": "object", "properties": { "bounds": { "anyOf": [ { "maxItems": 4, "minItems": 4, "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array" }, { "type": "null" } ], "default": null, "title": "Bounds" }, "flights": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Flights" }, "callsigns": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Callsigns" }, "registrations": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Registrations" }, "painted_as": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Painted As" }, "operating_as": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Operating As" }, "airports": { "anyOf": [ { "items": { "$ref": "#/$defs/AirportWithDirection" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Airports" }, "routes": { "anyOf": [ { "items": { "$ref": "#/$defs/Route" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Routes" }, "aircraft": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Aircraft" }, "altitude_ranges": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "integer" }, { "type": "integer" } ], "type": "array" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Altitude Ranges" }, "squawks": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Squawks" }, "categories": { "anyOf": [ { "items": { "$ref": "#/$defs/FlightCategory" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Categories" }, "data_sources": { "anyOf": [ { "items": { "$ref": "#/$defs/DataSources" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Data Sources" }, "airspaces": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Airspaces" }, "gspeed": { "anyOf": [ { "type": "integer" }, { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "integer" }, { "type": "integer" } ], "type": "array" }, { "type": "null" } ], "default": null, "title": "Gspeed" }, "timestamp": { "description": "Unix timestamp representing the exact point in time for which you want to fetch flight positions.\n The timestamp must be later than May 11, 2016, subject to your subscription plan's limitations.\n Only one timestamp value is accepted; time ranges not supported", "format": "date-time", "title": "Timestamp", "type": "string" } }, "$defs": { "AirportWithDirection": { "properties": { "airport": { "description": "Airport IATA or ICAO code.", "title": "Airport", "type": "string" }, "direction": { "anyOf": [ { "$ref": "#/$defs/Direction" }, { "type": "null" } ], "default": null, "description": "Direction of the flight (inbound or outbound or both)." } }, "required": [ "airport" ], "title": "AirportWithDirection", "type": "object" }, "DataSources": { "enum": [ "ADSB", "MLAT", "ESTIMATED", null ], "title": "DataSources" }, "Direction": { "enum": [ "both", "inbound", "outbound" ], "title": "Direction", "type": "string" }, "FlightCategory": { "enum": [ "P", "C", "M", "J", "T", "H", "B", "G", "D", "V", "O", "N" ], "title": "FlightCategory", "type": "string" }, "Route": { "properties": { "origin": { "description": "Origin airport IATA or ICAO code.", "title": "Origin", "type": "string" }, "destination": { "description": "Destination airport IATA or ICAO code.", "title": "Destination", "type": "string" } }, "required": [ "origin", "destination" ], "title": "Route", "type": "object" } }, "required": [ "timestamp" ] }
- Fields:
- Validators:
-
field timestamp:
datetime[Required]¶ Unix timestamp representing the exact point in time for which you want to fetch flight positions. The timestamp must be later than May 11, 2016, subject to your subscription plan’s limitations. Only one timestamp value is accepted; time ranges not supported
- Validated by:
- to_dto()¶
- Return type:
GetHistoricFlightPositionCountRequestDto
- pydantic model flight_radar.models.flight_position.HistoricFlightPositionRequest¶
Bases:
FlightPositionBaseRequestShow JSON schema
{ "title": "HistoricFlightPositionRequest", "type": "object", "properties": { "bounds": { "anyOf": [ { "maxItems": 4, "minItems": 4, "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array" }, { "type": "null" } ], "default": null, "title": "Bounds" }, "flights": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Flights" }, "callsigns": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Callsigns" }, "registrations": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Registrations" }, "painted_as": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Painted As" }, "operating_as": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Operating As" }, "airports": { "anyOf": [ { "items": { "$ref": "#/$defs/AirportWithDirection" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Airports" }, "routes": { "anyOf": [ { "items": { "$ref": "#/$defs/Route" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Routes" }, "aircraft": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Aircraft" }, "altitude_ranges": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "integer" }, { "type": "integer" } ], "type": "array" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Altitude Ranges" }, "squawks": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Squawks" }, "categories": { "anyOf": [ { "items": { "$ref": "#/$defs/FlightCategory" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Categories" }, "data_sources": { "anyOf": [ { "items": { "$ref": "#/$defs/DataSources" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Data Sources" }, "airspaces": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Airspaces" }, "gspeed": { "anyOf": [ { "type": "integer" }, { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "integer" }, { "type": "integer" } ], "type": "array" }, { "type": "null" } ], "default": null, "title": "Gspeed" }, "timestamp": { "format": "date-time", "title": "Timestamp", "type": "string" }, "limit": { "anyOf": [ { "maximum": 30000, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Limit" } }, "$defs": { "AirportWithDirection": { "properties": { "airport": { "description": "Airport IATA or ICAO code.", "title": "Airport", "type": "string" }, "direction": { "anyOf": [ { "$ref": "#/$defs/Direction" }, { "type": "null" } ], "default": null, "description": "Direction of the flight (inbound or outbound or both)." } }, "required": [ "airport" ], "title": "AirportWithDirection", "type": "object" }, "DataSources": { "enum": [ "ADSB", "MLAT", "ESTIMATED", null ], "title": "DataSources" }, "Direction": { "enum": [ "both", "inbound", "outbound" ], "title": "Direction", "type": "string" }, "FlightCategory": { "enum": [ "P", "C", "M", "J", "T", "H", "B", "G", "D", "V", "O", "N" ], "title": "FlightCategory", "type": "string" }, "Route": { "properties": { "origin": { "description": "Origin airport IATA or ICAO code.", "title": "Origin", "type": "string" }, "destination": { "description": "Destination airport IATA or ICAO code.", "title": "Destination", "type": "string" } }, "required": [ "origin", "destination" ], "title": "Route", "type": "object" } }, "required": [ "timestamp" ] }
- Fields:
- Validators:
- to_dto()¶
- Return type:
GetHistoricFlightPositionRequestDto
- pydantic model flight_radar.models.flight_position.LiveFlightPositionCountRequest¶
Bases:
FlightPositionBaseRequestShow JSON schema
{ "title": "LiveFlightPositionCountRequest", "type": "object", "properties": { "bounds": { "anyOf": [ { "maxItems": 4, "minItems": 4, "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array" }, { "type": "null" } ], "default": null, "title": "Bounds" }, "flights": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Flights" }, "callsigns": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Callsigns" }, "registrations": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Registrations" }, "painted_as": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Painted As" }, "operating_as": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Operating As" }, "airports": { "anyOf": [ { "items": { "$ref": "#/$defs/AirportWithDirection" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Airports" }, "routes": { "anyOf": [ { "items": { "$ref": "#/$defs/Route" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Routes" }, "aircraft": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Aircraft" }, "altitude_ranges": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "integer" }, { "type": "integer" } ], "type": "array" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Altitude Ranges" }, "squawks": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Squawks" }, "categories": { "anyOf": [ { "items": { "$ref": "#/$defs/FlightCategory" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Categories" }, "data_sources": { "anyOf": [ { "items": { "$ref": "#/$defs/DataSources" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Data Sources" }, "airspaces": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Airspaces" }, "gspeed": { "anyOf": [ { "type": "integer" }, { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "integer" }, { "type": "integer" } ], "type": "array" }, { "type": "null" } ], "default": null, "title": "Gspeed" } }, "$defs": { "AirportWithDirection": { "properties": { "airport": { "description": "Airport IATA or ICAO code.", "title": "Airport", "type": "string" }, "direction": { "anyOf": [ { "$ref": "#/$defs/Direction" }, { "type": "null" } ], "default": null, "description": "Direction of the flight (inbound or outbound or both)." } }, "required": [ "airport" ], "title": "AirportWithDirection", "type": "object" }, "DataSources": { "enum": [ "ADSB", "MLAT", "ESTIMATED", null ], "title": "DataSources" }, "Direction": { "enum": [ "both", "inbound", "outbound" ], "title": "Direction", "type": "string" }, "FlightCategory": { "enum": [ "P", "C", "M", "J", "T", "H", "B", "G", "D", "V", "O", "N" ], "title": "FlightCategory", "type": "string" }, "Route": { "properties": { "origin": { "description": "Origin airport IATA or ICAO code.", "title": "Origin", "type": "string" }, "destination": { "description": "Destination airport IATA or ICAO code.", "title": "Destination", "type": "string" } }, "required": [ "origin", "destination" ], "title": "Route", "type": "object" } } }
- Fields:
- Validators:
- pydantic model flight_radar.models.flight_position.LiveFlightPositionRequest¶
Bases:
FlightPositionBaseRequestShow JSON schema
{ "title": "LiveFlightPositionRequest", "type": "object", "properties": { "bounds": { "anyOf": [ { "maxItems": 4, "minItems": 4, "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array" }, { "type": "null" } ], "default": null, "title": "Bounds" }, "flights": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Flights" }, "callsigns": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Callsigns" }, "registrations": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Registrations" }, "painted_as": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Painted As" }, "operating_as": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Operating As" }, "airports": { "anyOf": [ { "items": { "$ref": "#/$defs/AirportWithDirection" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Airports" }, "routes": { "anyOf": [ { "items": { "$ref": "#/$defs/Route" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Routes" }, "aircraft": { "anyOf": [ { "items": { "type": "string" }, "maxItems": 15, "type": "array" }, { "type": "null" } ], "default": null, "title": "Aircraft" }, "altitude_ranges": { "anyOf": [ { "items": { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "integer" }, { "type": "integer" } ], "type": "array" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Altitude Ranges" }, "squawks": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Squawks" }, "categories": { "anyOf": [ { "items": { "$ref": "#/$defs/FlightCategory" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Categories" }, "data_sources": { "anyOf": [ { "items": { "$ref": "#/$defs/DataSources" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Data Sources" }, "airspaces": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Airspaces" }, "gspeed": { "anyOf": [ { "type": "integer" }, { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "integer" }, { "type": "integer" } ], "type": "array" }, { "type": "null" } ], "default": null, "title": "Gspeed" }, "limit": { "anyOf": [ { "maximum": 30000, "minimum": 1, "type": "integer" }, { "type": "null" } ], "default": null, "title": "Limit" } }, "$defs": { "AirportWithDirection": { "properties": { "airport": { "description": "Airport IATA or ICAO code.", "title": "Airport", "type": "string" }, "direction": { "anyOf": [ { "$ref": "#/$defs/Direction" }, { "type": "null" } ], "default": null, "description": "Direction of the flight (inbound or outbound or both)." } }, "required": [ "airport" ], "title": "AirportWithDirection", "type": "object" }, "DataSources": { "enum": [ "ADSB", "MLAT", "ESTIMATED", null ], "title": "DataSources" }, "Direction": { "enum": [ "both", "inbound", "outbound" ], "title": "Direction", "type": "string" }, "FlightCategory": { "enum": [ "P", "C", "M", "J", "T", "H", "B", "G", "D", "V", "O", "N" ], "title": "FlightCategory", "type": "string" }, "Route": { "properties": { "origin": { "description": "Origin airport IATA or ICAO code.", "title": "Origin", "type": "string" }, "destination": { "description": "Destination airport IATA or ICAO code.", "title": "Destination", "type": "string" } }, "required": [ "origin", "destination" ], "title": "Route", "type": "object" } } }
- Fields:
- Validators:
- to_dto()¶
- Return type:
GetLiveFlightPositionRequestDto
- class flight_radar.models.flight_position.FlightPositionBaseRequest(**data)¶
- Parameters:
bounds (tuple[float, float, float, float] | None)
flights (Annotated[List[str], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
callsigns (Annotated[List[str], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
registrations (Annotated[List[str], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
painted_as (Annotated[List[str], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
operating_as (Annotated[List[str], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
airports (Annotated[List[AirportWithDirection], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
routes (Annotated[List[Route], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
aircraft (Annotated[List[str], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
altitude_ranges (List[tuple[int, int]] | None)
squawks (List[str] | None)
categories (List[FlightCategory] | None)
data_sources (List[DataSources] | None)
airspaces (List[str] | None)
gspeed (int | tuple[int, int] | None)
- model_config: ClassVar[ConfigDict] = {}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- validator validate » all fields¶
Validate that at least one filter parameter is provided.
- class flight_radar.models.flight_position.LiveFlightPositionCountRequest(**data)¶
- Parameters:
bounds (tuple[float, float, float, float] | None)
flights (Annotated[List[str], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
callsigns (Annotated[List[str], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
registrations (Annotated[List[str], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
painted_as (Annotated[List[str], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
operating_as (Annotated[List[str], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
airports (Annotated[List[AirportWithDirection], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
routes (Annotated[List[Route], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
aircraft (Annotated[List[str], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
altitude_ranges (List[tuple[int, int]] | None)
squawks (List[str] | None)
categories (List[FlightCategory] | None)
data_sources (List[DataSources] | None)
airspaces (List[str] | None)
gspeed (int | tuple[int, int] | None)
- model_config: ClassVar[ConfigDict] = {}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class flight_radar.models.flight_position.LiveFlightPositionRequest(**data)¶
- Parameters:
bounds (tuple[float, float, float, float] | None)
flights (Annotated[List[str], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
callsigns (Annotated[List[str], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
registrations (Annotated[List[str], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
painted_as (Annotated[List[str], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
operating_as (Annotated[List[str], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
airports (Annotated[List[AirportWithDirection], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
routes (Annotated[List[Route], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
aircraft (Annotated[List[str], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
altitude_ranges (List[tuple[int, int]] | None)
squawks (List[str] | None)
categories (List[FlightCategory] | None)
data_sources (List[DataSources] | None)
airspaces (List[str] | None)
gspeed (int | tuple[int, int] | None)
limit (Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=1), Le(le=30000)])] | None)
- model_config: ClassVar[ConfigDict] = {}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class flight_radar.models.flight_position.HistoricFlightPositionRequest(**data)¶
- Parameters:
bounds (tuple[float, float, float, float] | None)
flights (Annotated[List[str], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
callsigns (Annotated[List[str], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
registrations (Annotated[List[str], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
painted_as (Annotated[List[str], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
operating_as (Annotated[List[str], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
airports (Annotated[List[AirportWithDirection], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
routes (Annotated[List[Route], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
aircraft (Annotated[List[str], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
altitude_ranges (List[tuple[int, int]] | None)
squawks (List[str] | None)
categories (List[FlightCategory] | None)
data_sources (List[DataSources] | None)
airspaces (List[str] | None)
gspeed (int | tuple[int, int] | None)
timestamp (datetime)
limit (Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Ge(ge=1), Le(le=30000)])] | None)
- model_config: ClassVar[ConfigDict] = {}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class flight_radar.models.flight_position.HistoricFlightPositionCountRequest(**data)¶
- Parameters:
bounds (tuple[float, float, float, float] | None)
flights (Annotated[List[str], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
callsigns (Annotated[List[str], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
registrations (Annotated[List[str], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
painted_as (Annotated[List[str], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
operating_as (Annotated[List[str], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
airports (Annotated[List[AirportWithDirection], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
routes (Annotated[List[Route], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
aircraft (Annotated[List[str], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=15)])] | None)
altitude_ranges (List[tuple[int, int]] | None)
squawks (List[str] | None)
categories (List[FlightCategory] | None)
data_sources (List[DataSources] | None)
airspaces (List[str] | None)
gspeed (int | tuple[int, int] | None)
timestamp (datetime)
- model_config: ClassVar[ConfigDict] = {}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class flight_radar.models.flight_position.FlightPositionLight(**data)¶
- Parameters:
fr24_id (str)
hex (str | None)
callsign (str | None)
lat (float)
lon (float)
track (int)
alt (int)
gspeed (int)
vspeed (int)
squawk (str)
timestamp (datetime)
source (str)
- model_config: ClassVar[ConfigDict] = {}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class flight_radar.models.flight_position.FlightPosition(**data)¶
- Parameters:
fr24_id (str)
hex (str | None)
callsign (str | None)
lat (float)
lon (float)
track (int)
alt (int)
gspeed (int)
vspeed (int)
squawk (str)
timestamp (datetime)
source (str)
flight (str | None)
painted_as (str | None)
operating_as (str | None)
orig_iata (str | None)
orig_icao (str | None)
dest_iata (str | None)
dest_icao (str | None)
eta (datetime | None)
type (str | None)
reg (str | None)
- model_config: ClassVar[ConfigDict] = {}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].