Struct FlightRadarClient 

pub struct FlightRadarClient { /* private fields */ }

Main structure for storing API internal data

Implementations

impl FlightRadarClient

pub fn new(api_key: String) -> Self

Creates a new instance of the client.

Arguments

• api_key - Your Flightradar24 API key.

pub fn update_base_url(&mut self, base_url: String)

pub fn check_live_parameters(query_in: &FullLiveFlightQuery) -> bool

Check to ensure one API query is provided for endpoint

Arguments

• query_in - FullLiveFlightQuery to check

Returns

A bool based on check

pub fn check_historic_parameters(query_in: &FullLiveFlightQuery) -> bool

pub fn query_endpoint(&self, url: String) -> Result<String, FlightRadarError>

Issue the GET command to API Endpoint

Arguments

• url - API URL to send GET request to

Returns

A String on success and FlightRadarError on failure.

pub fn get_airline_by_icao( &self, icao: &str, ) -> Result<Airline, FlightRadarError>

Fetches airline information by ICAO.

Arguments

• icao - The identifier for the airline.

Returns

A Airline struct on success or a FlightRadarError on failure.

pub fn get_airport_by_code( &self, code: &str, ) -> Result<Airport, FlightRadarError>

Fetches airport information by code.

Arguments

• code - The identifier for the airport.

Returns

A Airport struct on success or a FlightRadarError on failure.

pub fn get_airport_lite_by_code( &self, code: &str, ) -> Result<AirportLite, FlightRadarError>

Fetches airport information by code.

Arguments

• code - The identifier for the airport.

Returns

A Airport struct on success or a FlightRadarError on failure.

pub fn get_live_flight( &self, other_queries: Option<&FullLiveFlightQuery>, ) -> Result<FullLiveFlightResponse, FlightRadarError>

Fetches live flight information by location (or other parameters).

Arguments

• other_queries - Optional parameters to narrow down data

Returns

A FullLiveFlightResponse struct on success or a FlightRadarError on failure.

pub fn get_live_flight_light( &self, other_queries: Option<&FullLiveFlightQuery>, ) -> Result<LightLiveFlightResponse, FlightRadarError>

Fetches light live flight information by location (or other parameters).

Arguments

• other_queries - Optional parameters to narrow down data

Returns

A LightLiveFlightResponse struct on success or a FlightRadarError on failure.

pub fn get_historic_flight( &self, timestamp: &u64, other_queries: Option<&FullLiveFlightQuery>, ) -> Result<FullLiveFlightResponse, FlightRadarError>

Fetches historic flight information by timestamp (or other parameters).

Arguments

• timestamp - Timestamp to gather information from
• other_queries - Optional parameters to narrow down data

Returns

A FullLiveFlightResponse struct on success or a FlightRadarError on failure.

pub fn get_historic_flight_light( &self, timestamp: &u64, other_queries: Option<&FullLiveFlightQuery>, ) -> Result<LightLiveFlightResponse, FlightRadarError>

Fetches light historic flight information by timestamp (or other parameters).

Arguments

• timestamp - Timestamp to gather information from
• other_queries - Optional parameters to narrow down data

Returns

A LightLiveFlightResponse struct on success or a FlightRadarError on failure.

pub fn get_flight_tracks_by_id( &self, flight_id: &str, ) -> Result<Vec<Flight>, FlightRadarError>

Fetches flight information by flight ID.

Arguments

• flight_id - The identifier for the flight.

Returns

A Flight struct on success or a FlightRadarError on failure.

pub fn get_api_usage( &self, period: &str, ) -> Result<ApiUsageResponse, FlightRadarError>

Fetches API usage details over period

Arguments

• period - Backwards time to gather usage (Allowed: 24h | 7d | 30d | 1y)

Returns

A ApiUsageResponse struct on success or a FlightRadarError on failure.