Public API

Getting a Key

Keys can be generated on the main website under the account area. You can track usage of keys from the dashboard there. Additional functionality (limiting key scope) will be added shortly. Keys generated before implementation of scope will be assigned as read only.

Endpoints

All calls to the API are over HTTPS and should start with the following URL.

https://api.simtoolkitpro.co.uk/api/v1

All endpoints return a JSON object containing 2 parts. Type and Data. As a general rule if Type doesn't equal "OK", then Data will contain the error message unless stated otherwise in route specific documentation. The Data object will return empty for routes not requiring a return.

Below is an example output from the live flight data API (anonymised).

{
   "Type":"OK",
   "Data":{
      "id":"577463113",
      "flight":"EZS1019",
      "phase":"Cruise",
      "lat":"41.8289741116852",
      "lon":"-1.64369984144848",
      "head":"23",
      "speed":"463",
      "alt":"33520",
      "dep":"GMMX",
      "dest":"LFSB",
      "nick":"....",
      "ident":"a13e6a1f7d9a260b25b70291cd401543",
      "updated":"2020-12-28 01:02:15",
      "af":"A320",
      "uid":"....",
      "ete_mins":"67",
      "route":"GMMX\/28 OBOG4D OBOGA UG850 VALBA UZ801 TOLSI UG5 KORIS UL27 MAR UN871 KINNI UZ67 KORED UN871 KONOL Z59 LUMEL LUME8K LFSB\/15",
      "progress_pct":"57",
      "sim":null
   }
}

Rate Limiting

Certain routes will rate limiting applied. Where enforced the documents will list the rates for each endpoint.

Getting Help

Please use the Discord to get help with the API or request new endpoints!