Home

The following pages document the basic usage and response types of the datafeed-cache API. Note: All requests to the API are HTTP GET-Requests

Defined Types (as of 12.06.2023)

These types will be referenced in other parts of the documentation (e.g. in response data).

{
    general: DatafeedModelGeneral;
    pilots: Array<DatafeedModelPilot>;
    controllers: Array<DatafeedModelController>;
    atis: Array<DatafeedModelAtis>;
    servers: Array<DatafeedModelServer>;
    prefiles: Array<DatafeedModelPrefile>;
    facilities: Array<DatafeedModelFacility>;
    ratings: Array<DatafeedModelRating>;
    pilot_ratings: Array<DatafeedModelPilotRating>;
    military_ratings: Array<DatafeedModelMilitaryRating>;
}

---

type DatafeedModelGeneral =
{
    version: number,
    reload: number,
    update: string,
    update_timestamp: string,
    connected_clients: number,
    unique_users: number,
}

DatafeedModelController:
{
    cid: number;
    name: string;
    callsign: string;
    frequency: string;
    facility: number;
    rating: number;
    server: string;
    visual_range: number;
    text_atis?: Array<string>;
    last_updated: string;
    logon_time: string;
}

DatafeedModelPilot:
{
    cid: number;
    name: string;
    callsign: string;
    server: string;
    pilot_rating: number;
    military_rating: number;
    latitude: number;
    longitude: number;
    altitude: number;
    groundspeed: number;
    transponder: string;
    heading: number;
    qnh_i_hg: number;
    qnh_mb: number;
    flight_plan: DatafeedModelPilotFlightPlan;
    logon_time: string;
    last_updated: string;
}

DatafeedModelPilotFlightPlan:
{
    flight_rules: string;
    aircraft: string;
    aircraft_faa: string;
    aircraft_short: string;
    departure: string;
    arrival: string;
    alternate: string;
    cruise_tas: string;
    altitude: string;
    deptime: string;
    enroute_time: string;
    fuel_time: string;
    remarks: string;
    route: string;
    revision_id: number;
    assigned_transponder: string;
}

DatafeedModelPrefile:
{
    cid: number;
    name: string;
    callsign: string;
    flight_plan: DatafeedModelPilotFlightPlan;
    last_updated: string;
}

DatafeedModelAtis: 
{
    cid: number;
    name: string;
    callsign: string;
    frequency: string;
    facility: number;
    rating: number;
    server: string;
    visual_range: number;
    atis_code: string;
    text_atis: Array<string>;
    last_updated: string;
    logon_time: string;
}

DatafeedModelServer:
{
    ident: string;
    hostname_or_ip: string;
    location: string;
    name: string;
    clients_connection_allowed: number;
    client_connections_allowed: boolean;
    is_sweatbox: boolean;
}

DatafeedModelFacility:
{
    id: number;
    short: string;
    long: string;
}

DatafeedModelRating:
{
    id: number;
    short: string;
    long: string;
}

DatafeedModelPilotRating:
{
    id: number;
    short_name: string;
    long_name: string;
}

DatafeedModelMilitaryRating: 
{
    id: number;
    short_name: string;
    long_name: string;
}