Frequently asked questions for Global Ice Hockey v2
Click on the categories below or browse questions on the right panel.
Categories
.
Coverage
What leagues or tournaments do you cover for hockey?
You can find all the leagues we cover, as well as a breakdown of data offered, at our Coverage Matrix.
How do I find out the coverage for a particular match?
Find the node for coverage
within the Summaries and Timeline endpoints. Coverage nodes have two types: season
level and sport_event
level.
The season
level describes data coverage you can expect for matches involved in that given season.
The sport_event
level describes the data depth of a specific match within the group and season.
Note: There are occasions when the sport_event
coverage can vary from the anticipated season
coverage. This node exists to highlight that instance and assist in handling any discrepancies.
Why do different groups have coverage information for a tournament?
The notion of “groups” is versatile and is used to distinguish between playoffs, and our competition structures and is therefore necessary to describe coverage at a group level for consistency. Generally, however, within a competition in Ice Hockey, there will be no difference between competition coverage between conferences.
How are “Live” endpoints handled in the API?
Sport Events appear in the feed 10 minutes before the scheduled start time and are removed 10 minutes after the Sport Event is ended. Live endpoints include: Live Summaries, Live Timelines, and Live Timelines Delta.
How will a sport event behave when it is not covered with live scores?
When a sport_event
is not covered live, the status
and match_status
will remain as not_started
until results are entered post-match.
<sport_event_status status="not_started" match_status="not_started"/>
What level of coverage is offered for friendly competitions?
Friendly competitions are handled uniquely, with coverage being set on a case-by-case basis. Selected matches will be scouted and will therefore have live coverage. We would suggest checking sport_event_properties
within each sport_event
to understand the coverage set for a particular match.
Integration
How can I find the values for various enum data points within the API?
Many enum values are listed in the FAQ below. For the most up-to-date values, please see the Schema
section of the OpenAPI specification here: here.
What format are date fields presented in?
When we present date only values we present these in the ISO 8601 standard format.
ex: 2013-04-03
We use these for attributes that have date and no time (such as birthdate). For more information: https://en.wikipedia.org/wiki/ISO_8601
What format are the date/time fields presented in?
All of our Date/Time attributes are in UTC, presented in the ISO 8601 standard format.
ex: 2013-04-03T18:15:00+00:00
For more information: https://en.wikipedia.org/wiki/ISO_8601
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
Sport Event Statuses
What are the valid sport event status (sport_event_status
– status
) values?
sport_event_status
– status
) values?not_started
– The match is scheduled to be playedlive
– The match is currently in progresspostponed
– The match has been postponed to a future datedelayed
– The match has been temporarily delayed and will be continuedinterrupted
- The match began, but coverage has stopped for a short time. Note that match scores may not be updated during this period, the last recorded match score will be displayed insteadcancelled
– The match has been cancelled and will not be playedended
– The match is overclosed
– The match results have been confirmed.
What are the valid match status (sport_event_status
– match_status
) values?
sport_event_status
– match_status
) values?not_started
– The match is scheduled to be playedlive
– The match is currently in progress1st_period
– The match is in the first period2nd_period
– The match is in the second period3rd_period
– The match is in the third periodovertime
– The match is in overtime1st_extra
– The match is in the first extra period2nd_extra
– The match is in the second extra period3rd_extra
– The match is in the third extra periodawaiting_penalties
– Waiting for announcement of penaltiespenalties
– Penalties are ongoingpause
– The match is pausedawaiting_extra_time
– Waiting on referee to announce extra timeinterrupted
– The match has been interruptedabandoned
– The match has been abandonedpostponed
– The match has been postponed to a future datedelayed
– The match has been temporarily delayed and will be continuedcancelled
– The match has been cancelled and will not be playedended
– The match is overaet
– The match is after extra timeap
– The match is in after penalties
What are the possible values for break_name
?
break_name
?1st_pause
2nd_pause
awaiting_extra
awaiting_penalties
Event Types
What are the possible event types logged?
match_started
period_started
period_score
score_change
(goal_scorer
,primary_assist
,secondary_assist
)suspension
break_start
match_ended
Player Positions
What are the possible player positions in the feeds?
F
- ForwardD
- DefensemanG
– GoalieF-D
– Forward/DefensemanLW
– Left WingRW
– Right WingC
- Center
What are the possible values for player type?
scorer
assist
secondary_assist
Why does starter
always list as true
in the Lineups endpoints?
starter
always list as true
in the Lineups endpoints?We do not currently differentiate between starter
and played
in the Global Ice Hockey API.
Pagination
Why can't I find a particular match in the Daily Summaries, Season Summaries or Sport Events Updated endpoints?
These endpoints support pagination and return 200 entries by default. To return more matches, an additional query string parameter must be used after your API key. For example, appending &start=200
will return the next 200 entries per page, &start=400
will return the next 200, and so on.
Probabilities
What is the probabilities package?
The probabilities package is an add-on set of feeds that are an extension of the Season Probabilities feed in the main package (which already provides pre-match probabilities for the sport event winner market).
The main features of the Probabilities extension are: Live Probabilities that update throughout game, Season Outright Probabilities for the Tournament Winner market, and Live Probabilities Coverage indicator for the next 24 hours.
What are markets and what are the different markets?
Markets are something you can bet on, for which we provide probabilities. Over time we intend to provide more and more markets in the API.
Currently we provide 3-way (home win, away win, or draw) and Next Goal (which team will score the next goal) markets.
What are the valid outcomes for probabilities?
home_team_winner
away_team_winner
draw
none
Is there Live Probability coverage for every game you cover in the Global Ice Hockey API?
Live Probability coverage depends on a number of factors and we can’t guarantee that every game will be covered for any given league, however, Sportradar aims to cover close to 100% of games from the following Tier 1 league: National Hockey League (NHL) – USA
Can I utilize the Probabilities extension if I license the Sportradar NHL API?
If you have a license for our NHL API you can also integrate Live Probabilities by utilizing the ID Mapping feeds available in Global Ice Hockey v2 to connect games between the two products.
Past Season Data
How do I access past seasons results and stats?
Use the Competition Seasons endpoint to locate the season_id
for the season you want to access. Use that season_id
to interrogate the various seasons endpoints.
Standings / Tournaments
What are the possible standings types I can observe in the Standings endpoint?
total
home
away
first_half_total
first_half_home
first_half_away
second_half_total
second_half_home
second_half_away
What are the possible values for cup_round
– state
in the Season Links feed?
cup_round
– state
in the Season Links feed?Listed below are the values and definitions for cup_round
- state
. These can be leveraged to determine the status of a cup round.
empty
- A matchup has been created but neither the match details nor the competitors are known.unseeded_fixture
- Match details are known but competitors are unknown.partial_seeded
- One competitor is known.partial_seeded_fixture
- Match details and one competitor are known.seeded
- Both competitors are known.seeded_fixture
- Match details and both competitors are known.unstarted
- Match(es) have been added.on_going
- The first match has started.decided
- The last match has ended.winner
- The winner is known.cancelled
– The matchup has been cancelled.
How are group IDs delivered in the stage array with the various types?
With the type of "league" they will have a sr:league
prefix.
With the type of "cup" they will have a sr:cup
prefix.
Statistics
Why are the shots_on_target
incorrect for Finland Liiga?
shots_on_target
incorrect for Finland Liiga?At this time, the league does not provide shots on target (for Finland Liiga only). Instead, we provide this data point as a total number of shots.
More questions?
Reach out to [email protected] for further assistance.