Docs - api_query

Querying the API

The OpenSplitTime API follows the JSON API standard, described in detail at jsonapi.org. You can query for a collection of records using the pluralized model name, and if you have an individual record id, you can query for an individual record.

Standard Index Queries

The models available for index queries are:

Organizations
Courses
Event Groups
Events
People

Query any of these models by passing a GET request to the applicable endpoint and including your API key as a bearer authorization in the request header. For example (you will need to replace your.api.key with your own API Key):

$ curl -H "Authorization: bearer your.api.key" https://www.opensplittime.org/api/v1/event_groups

Records are returned in batches of 25. Links are included in the response header to obtain additional batches.

Remember that individual records are generally more useful and response times will generally be faster for individual record queries than for index queries.

Index Queries Scoped to a Parent Record

In addition to standard index queries, you may query for records scoped to an individual parent record. Currently, this feature is available for Raw Times scoped to an event group.

Query for Raw Times by passing a GET request to the endpoint shown below and including your API key as a bearer authorization in the request header:

$ curl -H "Authorization: bearer your.api.key" https://www.opensplittime.org/api/v1/event_groups/hardrock-100-2024/raw_times

Records are returned in batches of 25. Links are included in the response header to obtain additional batches.