This is an old revision of the document!
API
General
When on the same local network as the master timing computer, the built-in web server can be used to access results data live from the software.
This can for instance be usedful for TV production, custom big screen displays etc.
The basic endpoint is the same as the regular web interface/commentator display (for example http://localhost). All requests are made using GET requests to the specific endpoints, with any parameters added as query string parameters. The response will be given in JSON format.
Endpoints
All endpoints should be prefixed with /api/1.1. Example: http://localhost/api/1.1/event/races
| Endpoint | Parameters | Description |
|---|---|---|
| /event/races | None | List all races |
| /timing/locations | None | List all timing locations |
| /timing/points | None | List all timing points |
| /timing/raceclock | race_id (required) | Get the current race clock and gun start time of a given race |
| /results/toplist | race_id (required), page, page_size | List all finishers of the given race, in position order |
| /results/latest | point_id, location_id, page, page_size | List the most recent passes of either a specific timing point or timing location (one of the is required ) |
| /results/list | race_id, racenum, search, page, page_size | List all results in the event, regardless of finish status. Optional filtering on race, race number or text search |
| /results/leaders | race_id, gender (optional) page_size | Show the leaderboard of a specific race, optionally split by gender |
Default values if not set: page =1, page_size = 50.