Categories

Coverage
Stage Types

Integration
Results & Stats

.

Coverage

What sports and competitions do you cover for Winter Sports v1?

A list of the competitions covered in this API can be found below. Note that this list is subject to change at any time. For the most accurate list of competitions, please see the Competitions endpoint in the API.

Sport	Competitions
Alpine Skiing	Alpine Skiing
	Alpine Skiing World Championship
	Alpine Skiing Mixed World Championship
	Alpine Skiing Women
	Alpine Skiing Women World Championship
Biathlon	Biathlon
	Biathlon World Championship
	Biathlon Mixed
	Biathlon Mixed World Championship
	Biathlon Women
	Biathlon Women World Championship
Bobsleigh	Bobsleigh
	Bobsleigh Women
Cross Country Cross Country
	Cross Country World Championship
	Cross Country Women
	Cross Country Women World Championship
Figure Skating	Figure Skating
	Figure Skating Mixed
	Figure Skating Women
Luge	Luge
	Luge Women
Nordic Combined	Nordic Combined
	Nordic Combined World Championship
Ski Jumping	Ski Jumping
	Ski Jumping World Championship
	Ski Jumping Women
	Ski Jumping Women World Championship
Snowboard	Snowboard
	Snowboard World Championship
	Snowboard Women
	Snowboard Women World Championship
Speed Skating	Speed Skating
	Speed Skating Women

How far back does the data go?

Only current and the previous seasons.

Are events covered live?

All events have results entered after all heats are completed.

When are the competitor lists available?

Up to a few minutes before the event is run.

Integration

How do I know which endpoints to hit?

There are only three endpoint "types": Profiles, season-based, and sport event-based.

If the variable ID is stage based, you need to check the stage node to see what type it is. If type="season" that id is only designed to be placed in the season based endpoints. However, if you place a season ID in the Sport Event Summary endpoint it will return the results at a season level (meaning the standings).

Every other stage ID including individual runs, heats, or entire events can be used on the Sport Event Summary to get the results.

What format are date fields presented in?

Date values are presented in the ISO 8601 standard format.

Timestamp fields are in UTC. These could include scheduled start times or play-by-play event timestamps. Examples: scheduled="2024-02-11T23:30:00+00:00", created_at="2024-02-11T23:43:20+00:00"

Date-only fields reflect local league convention and are not UTC-adjusted. These could include season start dates and birth dates. Examples: start_date="2024-08-16", date_of_birth="1984-09-22"

How do I locate the TTL (Time to Live)/cache on an API endpoint?

The cache (in seconds) can be accessed in the returned header information on each RESTful API call, under cache-control.

ex. cache-control: max-age=1, public, s-maxage=1 or
cache-control: public, must-revalidate, max-age=120

Stage Types

What are the possible stage types?

season
sport
run
discipline
event
eight_final
quarter_final
semi_final
small_final
final
qualifying
consolation
placement

Results & Stats

How do I see the results of a specific run or heat in a given sport/discipline?

The Sport Event Summary takes any sport event ID parameter. Find the sport event ID for the event in question, and call the Sport Event Summary endpoint with that sport event ID. Within that endpoint, if the event consists of runs or heats you will find the sport event IDs for each heat. You can use that ID as a parameter in the URL of the same endpoint.

Do you have results for the heats/runs?

While some events may have limited results for heats or runs, typically there are only results for the overall event.

What statistics are in the API?

Only points, positions, medals, and times where applicable.