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).

struct DatafeedResponse {
    pub data: Option<Datafeed>,
    pub failed: bool,
}

struct Datafeed {
    pub general: DatafeedGeneral,
    pub pilots: Vec<DatafeedPilot>,
    pub controllers: Vec<DatafeedController>,
    pub atis: Vec<DatafeedAtis>,
    pub servers: Vec<DatafeedServer>,
    pub prefiles: Vec<DatafeedPrefile>,
    pub facilities: Vec<DatafeedFacility>,
    pub ratings: Vec<DatafeedRating>,
    pub pilot_ratings: Vec<DatafeedPilotRating>,
    pub military_ratings: Vec<DatafeedMilitaryRating>,
}

---

struct DatafeedGeneral {
    pub version: u32,
    pub reload: u32,
    pub update: String,
    pub update_timestamp: DateTime<Utc>, // ISO 8601
    pub connected_clients: u32,
    pub unique_users: u32,
}

struct DatafeedController {
    pub cid: u32,
    pub name: String,
    pub callsign: String,
    pub frequency: String,
    pub facility: i32,
    pub rating: i32,
    pub server: String,
    pub visual_range: u32,
    pub text_atis: Option<Vec<String>>,
    pub last_updated: DateTime<Utc>, // ISO 8601
    pub logon_time: DateTime<Utc>,   // ISO 8601
}

struct DatafeedPilot {
    pub cid: u32,
    pub name: String,
    pub callsign: String,
    pub server: String,
    pub pilot_rating: i32,
    pub military_rating: i32,
    pub latitude: f32,
    pub longitude: f32,
    pub altitude: i32,
    pub groundspeed: i32,
    pub transponder: String,
    pub heading: u16,
    pub qnh_i_hg: f32,
    pub qnh_mb: i32,
    pub flight_plan: Option<DatafeedFlightPlan>,
    pub logon_time: DateTime<Utc>,   // ISO 8601
    pub last_updated: DateTime<Utc>, // ISO 8601
}

struct DatafeedFlightPlan {
    pub flight_rules: String,
    pub aircraft: String,
    pub aircraft_faa: String,
    pub aircraft_short: String,
    pub departure: String,
    pub arrival: String,
    pub alternate: String,
    pub cruise_tas: String,
    pub altitude: String,
    pub deptime: String,
    pub enroute_time: String,
    pub fuel_time: String,
    pub remarks: String,
    pub route: String,
    pub revision_id: u32,
    pub assigned_transponder: String,
}

struct DatafeedPrefile {
    pub cid: u32,
    pub name: String,
    pub callsign: String,
    pub flight_plan: DatafeedFlightPlan,
    pub last_updated: DateTime<Utc>, // ISO 8601
}

struct DatafeedAtis {
    pub cid: u32,
    pub name: String,
    pub callsign: String,
    pub frequency: String,
    pub facility: i32,
    pub rating: i32,
    pub server: String,
    pub visual_range: u32,
    pub atis_code: Option<String>,
    pub text_atis: Option<Vec<String>>,
    pub last_updated: DateTime<Utc>, // ISO 8601
    pub logon_time: DateTime<Utc>,   // ISO 8601
}

struct DatafeedServer {
    pub ident: String,
    pub hostname_or_ip: String,
    pub location: String,
    pub name: String,
    pub clients_connection_allowed: i32,
    pub client_connections_allowed: bool,
    pub is_sweatbox: bool,
}

struct DatafeedFacility {
    pub id: i32,
    pub short: String,
    pub long: String,
}

struct DatafeedRating {
    pub id: i32,
    pub short: String,
    pub long: String,
}

pub struct DatafeedPilotRating {
    pub id: i32,
    pub short_name: String,
    pub long_name: String,
}

pub struct DatafeedMilitaryRating {
    pub id: i32,
    pub short_name: String,
    pub long_name: String,
}