Read Only REST API documentation

All api requests require an api_key parameter. This api_key must be listed in the config.yml file to allow access to the api.

GET /api/v1/readonly/tracks - Returns the total number of tracks as well as a list of all track command names.

GET /api/v3/readonly/tracks - Returns the total number of tracks as well as an object with details on each track.

GET /api/v2/readonly/tracks/:trackname - Returns extensive details about the given :trackname

GET /api/v2/readonly/tracks/:trackname/withusernames - Returns extensive details about the given :trackname with minecraft usernames. These usernames may be out of date if the players name has changed since they last played on the server running TimingSystem. For the most accurate usernames, /api/v1/readonly/tracks/:trackname should be used and the given uuid converted to usernames with another api.

GET /api/v1/readonly/players/:uuid - Returns the TPlayer data for the given UUID.

GET /api/v1/readonly/players/:username - Returns the TPlayer data for the given username.

GET /api/v1/readonly/events/running-heats - Returns an array of running heats. Each heat contains the live scoreboard information for that heat.

GET /api/v1/readonly/events/results/:eventname - Returns event results for the given :eventname.