Class OpenSkyApi

Constructors

constructor

Properties

_axios authenticated lastRequestTime API_ROOT FLIGHTS_BY_AIRCRAFT_URI FLIGHTS_BY_ARRIVAL_URI FLIGHTS_BY_DEPARTURE_URI FLIGHTS_URI HOST MY_STATES_URI STATES_URI

Methods

checkRateLimit getFlights getFlightsByAircraft getFlightsByArrivalAirport getFlightsByDepartureAirport getMyStates getOpenSkyFlights getOpenSkyStates getStates

Constructors

constructor

Properties

Private _axios

_axios: Axios

Private authenticated

authenticated: boolean = false

Private lastRequestTime

lastRequestTime: Record<RequestType, null | number> = ...

Static Private API_ROOT

API_ROOT: string = ...

Static Private FLIGHTS_BY_AIRCRAFT_URI

FLIGHTS_BY_AIRCRAFT_URI: string = ...

Static Private FLIGHTS_BY_ARRIVAL_URI

FLIGHTS_BY_ARRIVAL_URI: string = ...

Static Private FLIGHTS_BY_DEPARTURE_URI

FLIGHTS_BY_DEPARTURE_URI: string = ...

Static Private FLIGHTS_URI

FLIGHTS_URI: string = ...

Static Private HOST

HOST: string = 'opensky-network.org'

Static Private MY_STATES_URI

MY_STATES_URI: string = ...

Static Private STATES_URI

STATES_URI: string = ...

Methods

Private checkRateLimit

  • checkRateLimit(type, timeDiffAuth, timeDiffNoAuth): boolean

  • Parameters

    • type: RequestType
    • timeDiffAuth: number
    • timeDiffNoAuth: number

    Returns boolean

getFlights

  • getFlights(beginTime, endTime): Promise<Flight[]>

  • Parameters

    • beginTime: number
    • endTime: number

    Returns Promise<Flight[]>

getFlightsByAircraft

  • getFlightsByAircraft(icao24, beginTime, endTime): Promise<Flight[]>

  • Parameters

    • icao24: string
    • beginTime: number
    • endTime: number

    Returns Promise<Flight[]>

getFlightsByArrivalAirport

  • getFlightsByArrivalAirport(airport, beginTime, endTime): Promise<Flight[]>

  • Parameters

    • airport: string
    • beginTime: number
    • endTime: number

    Returns Promise<Flight[]>

getFlightsByDepartureAirport

  • getFlightsByDepartureAirport(airport, beginTime, endTime): Promise<Flight[]>

  • Parameters

    • airport: string
    • beginTime: number
    • endTime: number

    Returns Promise<Flight[]>

getMyStates

  • getMyStates(time, icao24, serials): null | Promise<{
        states: StateVector[];
        time: number;
    }>

  • Parameters

    • time: null | number
    • icao24: null | string[]
    • serials: number[]

    Returns null | Promise<{
        states: StateVector[];
        time: number;
    }>

Private getOpenSkyFlights

  • getOpenSkyFlights(url, nvps): Promise<Flight[]>

  • Parameters

    • url: string
    • nvps: Record<string, string>[]

    Returns Promise<Flight[]>

Private getOpenSkyStates

  • getOpenSkyStates(url, nvps): Promise<{
        states: StateVector[];
        time: number;
    }>

  • Parameters

    • url: string
    • nvps: Record<string, string>[]

    Returns Promise<{
        states: StateVector[];
        time: number;
    }>

getStates

  • getStates(time, icao24, bbox?): null | Promise<{
        states: StateVector[];
        time: number;
    }>

  • Parameters

    • time: null | number
    • icao24: null | string[]
    • Optional bbox: null | BoundingBox

    Returns null | Promise<{
        states: StateVector[];
        time: number;
    }>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc