Board index FlightGear Development Documentation

Public HTTP API documentation

Discussion of the FlightGear documentation, how it can be improved and coordination of people working on it.

Public HTTP API documentation

Postby _kito_ » Tue Nov 05, 2019 1:13 pm

Hi there

I searched for a while the page where is documented the FlightGear HTTP API.
Particularly where are listed the different properties and their path ("/sim/time/gmt", "/position/latitude-deg"...).

Before jumping into FG source code, could you point me the correct page (if it exists) ?

Many thanks! :)
Posts: 2
Joined: Tue Nov 05, 2019 1:03 pm

Re: Public HTTP API documentation

Postby Necolatis » Tue Nov 05, 2019 2:27 pm

I might be wrong, but I think HTTP API is only used for PHI:

Else you can interface using: or ... /README.IO or

A list of all default properties probably do not exist in one wiki page. They are kinda spread out all over the wiki. (and default properties also depends on which FDM the aircraft is running)
Plus most aircraft have custom properties, in some cases many hundreds of them.

In the sim in the menu under Debug-Browse Internal Properties, you can browse all properties.
"Airplane travel is nature's way of making you look like your passport photo."
— Al Gore
User avatar
Posts: 2108
Joined: Mon Oct 29, 2012 12:40 am
Location: EKOD
Callsign: Leto
IRC name: Neco
Version: 2019.1.2
OS: Windows 10

Re: Public HTTP API documentation

Postby _kito_ » Tue Nov 05, 2019 3:24 pm

Many thanks for your answer :)

Indeed the whole prop tree is available directly within the simulation.
If that's relevant, later I will write a wiki page listing theses properties. It seems easier than starting the simulation... ;)

Actually I found that writing a FG addon is easier when using this HTTP/Websocket API and JSON data format.
Probably I have to look more into Generic Protocol, but it seems really COM port oriented.
Posts: 2
Joined: Tue Nov 05, 2019 1:03 pm

Return to Documentation

Who is online

Users browsing this forum: No registered users and 1 guest