Whazzup File Format

A whazzup file is divided in 4 sections.
Each section starts with an exclamation mark (!). Lines are terminated by LF (unix line ending).

The sections are:

!GENERAL
!CLIENTS
!SERVERS
!AIRPORTS

In the next sections each of these sections is discussed in details.

Never rely on the fact that a line has X fields at the current moment, IVAO can extend the number of fields at any time! Make your program/script failsafe by keeping this in mind!

General Section

The general section uses a configuration style way to include data, do not rely on a fixed order of these parameters. Always check the name of the entry you need.

VERSION = 5

This entry defines the version of the whazzup file.
You can use this to perform checks, however it will only be increment for major changes.

RELOAD = 2

This entry defines the time (in minutes) before the whazzup file is updated by the server.
There is no need to download the file at faster intervals than this time, the server would not have updated the file anyway.

UPDATE = YYYYMMDDHHNNSS

This entry defines the last date and time whazzup file has been updated.
Format is: yyyymmddhhnnss.
You should check that this data/time read is more recent that the last data/time read by your previous download, and you should consider data only if this data/time is more recent.
This is to avoid using data downloaded from not synchronized (outdated) servers. Eventually you can try to download data from a different server if this data/time is less recent than the last read. You should also use this time to calculate online time of a user.

CONNECTED CLIENTS = 1112

This entry defines the number of clients connected to the server at this moment.

CONNECTED SERVERS = 15

This entry defines the number of servers connected to the server at this moment.

CONNECTED AIRPORTS = 2

This entry defines the number of airports connected to the server at this moment.

Clients Section

In the clients section, each line represents an ATC, Pilot or Observer connection.
The line contains a number of fields which are colon (:) separated.
From left to right, the fields in a line are as follows:

Name Client Types Description Unit
Callsign All The callsign of the connection. n/a
VID All The VID of the client involved in the connection. n/a
Name All The name of the person. n/a
Client Type All The type of the client connection. Enumeration
Frequency ATC The frequency the client is currently using. n/a
Frequency Cont… ATC Multiple frequencies are joined with an ampersand &. n/a
Latitude All The latitude of the current position of the connection. Decimal Degrees
Longitude All The longitude of the current position of the connection. Decimal Degrees
Altitude All The altitude of the current position of the connection. Feet
Groundspeed Pilot The groundspeed of the pilot. Knots
Flightplan: Aircraft Pilot According to ICAO flightplan specifications. Example: 1/C172/L-CS/C n/a
Flightplan: Cruising Speed Pilot According to ICAO flightplan specifications. n/a
Flightplan: Departure Aerodrome Pilot According to ICAO flightplan specifications. n/a
Flightplan: Cruising Level Pilot According to ICAO flightplan specifications. n/a
Flightplan: Destination Aerodrome Pilot According to ICAO flightplan specifications. n/a
Server All The name of the server to which this client is connected. n/a
Protocol All The protocol revision the client is using. n/a
Combined Rating All Deprecated: use the separated rating fields instead. n/a
Transponder Code Pilot The transponder code set by the pilot. n/a
Facility Type ATC The facility provided by the ATC. Enumeration
Visual Range ATC The range of the ATC radar. NM
Flightplan: revision Pilot Sequence number of the flightplan. n/a
Flightplan: flight rules Pilot According to ICAO flightplan specifications. n/a
Flightplan: departure time Pilot According to ICAO flightplan specifications. n/a
Flightplan: actual departure time Pilot The actual departure time. Reserved for future use n/a
Flightplan: EET (hours) Pilot According to ICAO flightplan specifications. n/a
Flightplan: EET (minutes) Pilot According to ICAO flightplan specifications. n/a
Flightplan: endurance (hours) Pilot According to ICAO flightplan specifications. n/a
Flightplan: endurance (minutes) Pilot According to ICAO flightplan specifications. n/a
Flightplan: Alternate Aerodrome Pilot According to ICAO flightplan specifications. n/a
Flightplan: item 18 (other info) Pilot According to ICAO flightplan specifications. n/a
Flightplan: route Pilot According to ICAO flightplan specifications. n/a
unused - - -
unused - - -
ATIS ATC The ATIS set by the controller. Deprecated: will be replaced by Airport based ATIS n/a
ATIS Time ATC The time the ATIS was defined. Deprecated: will be replaced by Airport based ATIS n/a
Connection Time All The time the client connected to the network. n/a
Software Name All The name of the software product the client is using. n/a
Software Version All The version of the software product the client is using. n/a
Administrative Version All The administrative rating of the client. Enumeration
ATC/Pilot Version All The ATC or Pilot rating of the client. Enumeration
Flightplan: 2nd Alternate Aerodrome Pilot According to ICAO flightplan specifications. n/a
Flightplan: Type of Flight Pilot According to ICAO flightplan specifications. n/a
Flightplan: Persons on Board Pilot According to ICAO flightplan specifications. n/a
Heading Pilot The heading of the plane. Degrees
On ground Pilot A flag indicating if the plane is on ground or not. Boolean
Simulator Pilot The simulator used by the pilot. Enumeration
Plane Pilot The MTL identification of the plane with which the pilot is flying. n/a

Servers Section

In the servers section, each line represents an server.
The line contains a number of fields which are colon (:) separated.
From left to right, the fields in a line are as follows:

Ident The identification of the server (unique). n/a
Host name / IP The host name or IP address of the server n/a
Location The physical location of the server. n/a
Name The descriptive name of the server. n/a
Client Connections Allowed. A flag indicating if connections to this server are allowed or not. Boolean
Maximum Connection The maximum number of connections to this server. n/a

Airports Section

In the airports section, each line represents an airport.
The line contains a number of fields which are colon (:) separated.
From left to right, the fields in a line are as follows:

Name Description Unit
ICAO The ICAO code of the airport. n/a
ATIS The ATIS of the airport. n/a

Enumerations

Client Type
Value Description
ATC ATC or Observer connections
PILOT Pilot connections
FOLME Follow Me Car connections

Facility Type

ValueDescription
0 Observer
1 Flight Information
2 Delivery
3 Ground
4 Tower
5 Approach
6 ACC
7 Departure

Administrative Rating

Value Description
0 Suspended
1 Observer
2 User
11 Supervisor
12 Administrator

ATC Rating

Value Description
1 Observer
2 ATC Applicant (AS1)
3 ATC Trainee (AS2)
4 Advanced ATC Trainee (AS3)
5 Aerodrome Controller (ADC)
6 Approach Controller (APC)
7 Center Controller (ACC)
8 Senior Controller (SEC)
9 Senior ATC Instructor (SAI)
10 Chief ATC Instructor (CAI)

Pilot Rating

Value Description
1 Observer
2 Basic Flight Student (FS1)
3 Flight Student (FS2)
4 Advanced Flight Student (FS3)
5 Private Pilot (PP)
6 Senior Private Pilot (SPP)
7 Commercial Pilot (CP)
8 Airline Transport Pilot (ATP)
9 Senior Flight Instructor (SFI)
10 Chief Flight Instructor (CFI)

Flight Simulators

Value Description
0 Unknown
1 Microsoft Flight Simulator 95
2 Microsoft Flight Simulator 98
3 Microsoft Combat Flight Simulator
4 Microsoft Flight Simulator 2000
5 Microsoft Combat Flight Simulator 2
6 Microsoft Flight Simulator 2002
7 Microsoft Combat Flight Simulator 3
8 Microsoft Flight Simulator 2004
9 Microsoft Flight Simulator X
11 X-Plane (unknown version)
12 X-Plane 8.x
13 X-Plane 9.x
14 X-Plane 10.x
15 PS1
16 X-Plane 11.x
17 X-Plane 12.x
20 Fly!
21 Fly! 2
25 FlightGear
30 Prepar3D 1.x

←- Back To Whazzup Documentation

←– Return to API Documentation