JSON API Commands

Budding tool builder? Curious how Flowbar and Nalym put their software together? It starts here...

This is a bit of a technical article, since I’ll cover the known JSON API calls available on jumpgate-tri.org. If you’re here to fly ships and don’t know what JSON, or API mean, this is probably not the article for you…

Disclaimer: I have no ownership of this API, and I will only discuss those I’m aware of. I do not pretend this is a complete list. Use at your own risk.

Pilot Profile API

http://jumpgate-tri.org/jossh-api/user-profile/XXX.json

Replace ‘XXX’ by a pilot name, so as an example, my pilot data is accessible here.

I presume this is used internally to generate the pilot profile pages. Note two timestamped fields, `date_recordset` and `updated_time`. The former should be a time within the last few minutes - it is given in Moscow time zone. This is useful to check if you have new data on hand, and is a common pattern in all of these calls. The later is an indicator of the last time a pilot was logged in.

There’s a few fields at the end of the data structure too, `pure_mined`, `artyfacts_found` (sic) and `beacons_captured` which I speculate are custom additions by the current admin team, to an existing pilot profile API that was built by NetDevil.

All Users API

http://jumpgate-tri.org/jossh-api/all-users.json

This returns a rather large dataset of all registered pilots. There doesn’t seem to be any parameters to filter it, and I would use it sparingly. I’m not aware that anyone got yelled at for abusing the API on offer, but I can conceive this may be a little taxxing on the backend of jg-tri. Therefore, I would personally avoid calling this on a very regular basis. There’s little reason in my opinion to make such a call more than once a day for anything - and the data can well be cached. This is just my opinion and I’m saying this to be mindful of available resources, but I also presume this call happens every time someone refreshes the “View All Pilots” page.

Now here’s a rundown of the data structure, with some of my observations about it…

Sorts by registry first: TRI Civilian, Military, TRI Rookie, Mercenary, Pirate.
Appears to sort by account ID 2nd, so oldest accounts are at the top of their registry’s list, newest at the bottom. `updated_time` is a proxy to when the account was last connected. MadamRed is the first listed Civilian account (user ID 1), and is believed to have founded a now-disused public establishment in Diluted Reaches bearing her name. TaSKeR is the first Pirate account, belonging to PoGBS squad and its only member. The first Mercenary account is a recruit, which is curious… Probably an admin test account with a single duty hour. The first Rookie account is named Darius. The first Military account is starr who is a member of STARS squad. This squad also hosts the 2nd mercenary account in the list.

MAP API

http://jumpgate-tri.org/jossh-api/map.json

This API call returns all sectors with attached information, namely coordinates in both the 2D and 3D maps, ruling faction, beacon state, presence of a station, and buildings in existence. This data is also returned for all sectors, including those in the Conflux Galaxy that are not visible on jg-tri’s map data.

Sectors are returned sorted by sector ID. All sectors have a three digits ID, with station sectors IDs starting with 1. Solrain Core is 101, followed by Wake and Cornea, then the other two main factions’ 3 stations from release. After this, we have Hyperial, Amananth, the 4 Unregulated stations, and finally the 3 Depot Stations taking contiguous IDs until Quantar Storage Depot at 118. Other sectors follow starting with Inner Lighthouse at 201. Once again, those are mostly ordered by faction with some exceptions, seemingly with sectors that changed regulation at some stage (such as The Gurge) but not only. Mokk’s Battlefield and Canis close the list of sectors before the conflux sectors, which start with Aman Leap.

Finally, the data has the list of all sectors connections, and this list is dynamically updated when infestation occurs. When that’s the case, the connection that’s impacted is simply omitted from the returned list. Conceivably, this could be used to detect the occurence of infestations in near real-time.

Station Inventory API

http://jumpgate-tri.org/jossh-api/stations-inventory.json

This is a massive data dump of the market situation, which blommaskog.net uses for data gathering. It is organised by station, then item group (i.e. commodities, missiles, modX…), then alphabetically by item name. Each entry will list the quantity, price, and also a `produce` field which is a boolean telling you if the station produces said item or not.

Missions API

http://jumpgate-tri.org/jossh-api/missions.json

This lists the faction and TRI missions and their status, as seen on jg-tri.org. The `complete` field is a float indicating the mission completion percentage.

Unfortunately, there is no political atmosphere meter data in the call, and I do not know if this can be obtained through a separate API call.