getAirportArrivals: Retrieve flight arrivals into a specified airport

Description Usage Arguments Value References Examples

View source: R/openSkies_getFlightsFunctions.R

Description

Retrieves the list of flights that landed into a specified airport during a certain time interval. The aiport must be specified using its ICAO identified. Beginning and end times must be specified as date-time strings in any format that can be unambiguously converted to POSIXct (such as YYYY-MM-DD HH:MM:SS).

Usage

1
2
3
4
getAirportArrivals(airport, startTime, endTime, timeZone=Sys.timezone(), 
                   username=NULL, password=NULL, includeStateVectors=FALSE, 
                   timeResolution=NULL, useImpalaShell=FALSE, 
                   includeAirportsMetadata=FALSE, timeOut=60, maxQueryAttempts=1)

Arguments

airport

string with the ICAO identifier of an airport (for example, \"EDDF\" for Frankfurt International Airport.

startTime

date-time string indicating the starting time of the interval for which arrivals should be retrieved. Must be in a format that can be unambiguously converted into POSIXct time. Valid examples are \"2011-03-27 01:30:00\" and \"2011/03/27 01:30:00\".

endTime

date-time string indicating the ending time of the interval for which arrivals should be retrieved. Must be in a format that can be unambiguously converted into POSIXct time. Valid examples are \"2011-03-28 01:30:00\" and \"2011/03/28 01:30:00\".

timeZone

string with the name of the time zone for startTime and endTime. For details on supported time zones, see help(timezones). By default, the system time zone is used.

username

optional string with the username to use for authentication for the OpenSky API. By default, no authentication is performed.

password

optional string with the password to use for authentication for the OpenSky API. By default, no authentication is performed.

includeStateVectors

logical indicating if the set of state vectors for each flight should also be retrieved. By default, state vectors are not retrieved.

timeResolution

time resolution in seconds with which state vectors should be retrieved if includeStateVectors=TRUE.

useImpalaShell

logical indicating whether or not to use the OpenSky impala shell instead of the API to retrieve state vectors if includeStateVectors=TRUE. If used, the provided username and password are used for the ssh connection. By default, the impala shell is not used.

includeAirportsMetadata

logical indicating if the data about the origin and destination airports of each flight should also be retrieved. If not, only the ICAO24 code of the airports will be included.

timeOut

number of seconds after which the query will time out and return a NULL result. In the default behavior, timeout will be reached after 60 seconds.

maxQueryAttempts

On rare occassions, queries to the OpenSky Network live API can return malformed responses. This is the maximum number of attempts to obtain a properly formatted response when carrying out the requested query. It should be noted that the query will still terminate if a timeout is reached. In the default behavior, a single attempt will be performed. It is not recommended to change this to a very large number, since it can lead to long running times.

Value

A list of objects of class openSkiesFlight, where each object represents a flight that that landed at the specified airport during the specified time interval. See the openSkiesFlight documentation for details on the fields for the class.

References

https://opensky-network.org/apidoc/rest.html

Examples

1
2
3
4
5
6
7
8
# Obtain a list with information for all the flights that landed at Frankfurt
# International Airport on the 29th of January, 2018 between 12 PM and 1 PM,
# local time.

if(interactive()){
getAirportArrivals(airport="EDDF", startTime="2018-01-29 12:00:00", 
endTime="2018-01-29 13:00:00", timeZone="Europe/Berlin")
}

openSkies documentation built on Dec. 19, 2021, 5:10 p.m.