FAQs

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

What game statuses I can expect to see in the feeds and what are their definitions?

Here is a list of the valid game statuses you can expect to see, and their definitions.

scheduled - The game is scheduled to occur.
created - The game has been created and we have begun logging information for the game.
inprogress – The game is in progress.
complete – The game is over, but stat validation is not complete.
closed – The game is over and the stats have been validated.
cancelled – The game has been cancelled. No makeup game will be played as a result.
delayed – The start of the game is currently delayed or the game has gone from in progress to delayed for some reason.
postponed – The game has been postponed, to be made up at another day and time. Once the makeup game is announced, a new game and ID will be created and scheduled on the announced makeup date. You should request the scheduled feed(s) regularly to identify the re-scheduled makeup game(s).
time-tbd – The game has been scheduled, but a time has yet to be announced.
if necessary – The game will be scheduled if it is required.
unnecessary – The series game was scheduled to occur, but will not take place due to one team clinching the series early.

What are the valid events types tracked in the play by play feed?

Here is a list of the valid event types you can expect to see.

awardedgoal
awardedemptynetgoal
challenge
emptynetgoal
endperiod
endshootoutperiod
evenstrength
faceoff
gamesetup
giveaway
goal
goaliechange
hit
owngoal
penalty
penaltygoal
penaltyshotmissed
penaltyshotsaved
powerplay
shootoutgoal
shootoutshotmissed
shootoutshotsaved
shotmissed
shotsaved
startshootoutperiod
stoppage
substitutions
takeaway

The following event types can be classified as stoppage, but will be classified in the event description:

teamtimeout
tvtimeout

Why do certain play-by-play events have a higher latency?

Beginning in the 2024 season, hit, giveaway, and takeaway event types have a higher delivery latency in the Play-by-Play compared to previous years. This is due to a new stat audit process, and is expected to reduce over time.

When an event is received, the timestamp is adjusted to fit into that specific time frame in the game (game clock and wall_clock). This means that the UTC value for the event is always accurate.

<event id="502c99a3-3638-4a85-b344-6d6f6e720834" clock="16:42" official="true" updated="2024-05-28T14:34:53Z" 
       wall_clock="2024-05-28T00:46:08Z" clock_decimal="16:42" sequence="1716857168855" zone="offensive" 
       event_type="takeaway">
  <description>Takeaway by Tyler Seguin in offensive zone</description>
  <attribution id="44157522-0f24-11e2-8525-18a905767e44" name="Stars" market="Dallas" team_goal="right" 
               sr_id="sr:team:3684" reference="25"/>
  <location coord_x="12" coord_y="636" action_area="downlow"/>

What are the Series statuses I can expect to see in the feeds and their definitions?

Here is a list of the valid series statuses you can expect to see, and their definitions.

scheduled - The series is scheduled to occur.
inprogress – The series is in progress.
closed – The series is over.

What are the player positions I can expect to see in the feeds?

Here is a list of the valid player positions you can expect to see.

What are the player primary positions I can expect to see in the feeds?

Here is a list of the valid player primary positions you can expect to see.

What are the valid player statuses?

ACT – Active
DUP – Duplicate
FA – Free Agent
IR – Injured reserve
M-LEAGUE – Sent to minor league team
NWT – Not with team
RET – Retired
SUS – Suspended
UDP – Unsigned Draft Pick

What are the player injury statuses I can expect to see in the feeds?

Here is a list of the valid player injury statuses you can expect to see.

Unknown
Day To Day
Out
Out For Season
Out Indefinitely

What are the valid `clinched` playoff values for a team in the Rankings endpoint?

Here is a list of the clinched values and their definitions:

conference – The team has clinched the conference.
division – The team has clinched the division.
playoff_spot – The team has clinched a playoff berth.
presidents_trophy – The team has clinched the best record and home ice advantage.

<division id="1fad71d8-5b9e-4159-921b-9b98d0573f51" name="Atlantic" alias="ATLANTIC">
  <team id="4418464d-0f24-11e2-8525-18a905767e44" name="Panthers" market="Florida" sr_id="sr:team:3687" reference="13">
    <rank division="1" conference="3" clinched="division"/>
  </team>
  <team id="4416ba1a-0f24-11e2-8525-18a905767e44" name="Bruins" market="Boston" sr_id="sr:team:3677" reference="6">
    <rank division="2" conference="4" clinched="playoff_spot"/>
  </team>
  <team id="441730a9-0f24-11e2-8525-18a905767e44" name="Maple Leafs" market="Toronto" sr_id="sr:team:3693" reference="10">
    <rank division="3" conference="5" clinched="playoff_spot"/>
  </team>
  <team id="4417d3cb-0f24-11e2-8525-18a905767e44" name="Lightning" market="Tampa Bay" sr_id="sr:team:3694" reference="14">
    <rank division="4" conference="6" clinched="playoff_spot" wildcard="1"/>
  </team>
  <team id="44169bb9-0f24-11e2-8525-18a905767e44" name="Red Wings" market="Detroit" sr_id="sr:team:3685" reference="17">
    <rank division="5" conference="9" clinched="eliminated" wildcard="3"/>
  </team>
  <team id="4416d559-0f24-11e2-8525-18a905767e44" name="Sabres" market="Buffalo" sr_id="sr:team:3678" reference="7">
    <rank division="6" conference="12" clinched="eliminated" wildcard="6"/>
  </team>
  <team id="4416f5e2-0f24-11e2-8525-18a905767e44" name="Senators" market="Ottawa" sr_id="sr:team:3700" reference="9">
    <rank division="7" conference="14" clinched="eliminated" wildcard="8"/>
  </team>
  <team id="441713b7-0f24-11e2-8525-18a905767e44" name="Canadiens" market="Montreal" sr_id="sr:team:3690" reference="8">
    <rank division="8" conference="15" clinched="eliminated" wildcard="9"/>
  </team>
</division>

"divisions": [
  {
    "id": "1fad71d8-5b9e-4159-921b-9b98d0573f51",
    "name": "Atlantic",
    "alias": "ATLANTIC",
    "teams": [
      {
        "id": "4418464d-0f24-11e2-8525-18a905767e44",
        "name": "Panthers",
        "market": "Florida",
        "sr_id": "sr:team:3687",
        "reference": "13",
        "rank": {
          "division": 1,
          "conference": 3,
          "clinched": "division"
        }
      },
      {
        "id": "4416ba1a-0f24-11e2-8525-18a905767e44",
        "name": "Bruins",
        "market": "Boston",
        "sr_id": "sr:team:3677",
        "reference": "6",
        "rank": {
          "division": 2,
          "conference": 4,
          "clinched": "playoff_spot"
        }
      },
      {
        "id": "441730a9-0f24-11e2-8525-18a905767e44",
        "name": "Maple Leafs",
        "market": "Toronto",
        "sr_id": "sr:team:3693",
        "reference": "10",
        "rank": {
          "division": 3,
          "conference": 5,
          "clinched": "playoff_spot"
        }
      },
      {
        "id": "4417d3cb-0f24-11e2-8525-18a905767e44",
        "name": "Lightning",
        "market": "Tampa Bay",
        "sr_id": "sr:team:3694",
        "reference": "14",
        "rank": {
          "division": 4,
          "conference": 6,
          "clinched": "playoff_spot",
          "wildcard": 1
        }
      },
      {
        "id": "44169bb9-0f24-11e2-8525-18a905767e44",
        "name": "Red Wings",
        "market": "Detroit",
        "sr_id": "sr:team:3685",
        "reference": "17",
        "rank": {
          "division": 5,
          "conference": 9,
          "clinched": "eliminated",
          "wildcard": 3
        }
      },
      {
        "id": "4416d559-0f24-11e2-8525-18a905767e44",
        "name": "Sabres",
        "market": "Buffalo",
        "sr_id": "sr:team:3678",
        "reference": "7",
        "rank": {
          "division": 6,
          "conference": 12,
          "clinched": "eliminated",
          "wildcard": 6
        }
      },
      {
        "id": "4416f5e2-0f24-11e2-8525-18a905767e44",
        "name": "Senators",
        "market": "Ottawa",
        "sr_id": "sr:team:3700",
        "reference": "9",
        "rank": {
          "division": 7,
          "conference": 14,
          "clinched": "eliminated",
          "wildcard": 8
        }
      },
      {
        "id": "441713b7-0f24-11e2-8525-18a905767e44",
        "name": "Canadiens",
        "market": "Montreal",
        "sr_id": "sr:team:3690",
        "reference": "8",
        "rank": {
          "division": 8,
          "conference": 15,
          "clinched": "eliminated",
          "wildcard": 9
        }
      }
    ]
  },

Do you provide your feeds in any languages other than English?

Currently, we provide our feeds in 3 languages: English, Russian, and Simplified Chinese. The codes are as follows:

Brazilian Portuguese = br
English = eu
Spanish = es
French = fr
Russian = ru
Simplified Chinese = zh

Please note, our translated feeds include translated teams, players, play-by-play descriptions. The feeds themselves are in English, but the content of the attributes has been translated.

What is the scale of the X/Y coordinates?

The rink we use is 2400 by 1020. The scale is in inches.

How is the on_ice data handled in the Game Play-by-Play feed?

Most events contain on_ice team and player information. Though, this data is not guaranteed for every event within the Play-by-Play feed.

What are the valid stoppage types and reasons?

Valid stoppage types (stoppage_type):

Offside
Icing
Clock Problem
Puck Frozen
Puck in Crowd
Goalie Stopped (after SOG)
Referee or Linesperson
High Stick
Objects on Ice
Hand Pass
Premature Substitution
Puck in Netting
Puck in Benches
Net Dislodged Offensive Skater
Puck Frzn-Goalie-Bynd Ctr
Skater Puck Frozen

Valid stoppage type reasons (reason):

TV timeout
Home Timeout
Visitor Timeout
Player Injury
Official Injury
Rink Repair
Ice problem
Player Equipment
Video Review
Chlg Hm - off-side
Chlg Vis - off-side
Chlg Hm - goal interference
Chlg Vis - goal interference
Chlg League - off-side
Chlg League - goal interference
Switch sides
Chlg Hm - Missed stoppage
Chlg Vis - Missed stoppage
Chlg League - Missed stoppage
Chlg Hm - puck over glass
Chlg Vis - puck over glass
Chlg League - puck over glass

<event id="efeb60bb-a4ef-47f9-bcc9-8ba9509a5341" clock="5:05" official="true" updated="2024-02-27T16:02:45Z" wall_clock="2024-02-13T01:28:19Z" clock_decimal="5:05" sequence="1707787699495" event_type="stoppage">
    <description>Stoppage - Puck Frozen - TV timeout</description>
    <details stoppage_type="Puck Frozen" reason="TV timeout"/>

<event id="4032e5a1-1bcf-440c-9aaa-b8ab8604980c" clock="18:53" official="true" updated="2024-02-27T16:02:07Z" wall_clock="2024-02-13T00:09:23Z" clock_decimal="18:53" sequence="1707782963576" event_type="stoppage">
    <description>Stoppage - Goalie Stopped (after SOG)</description>
    <details stoppage_type="Goalie Stopped (after SOG)"/>

<event id="29827936-b9aa-42fe-9c5b-371072ccb427" clock="7:29" official="true" updated="2024-02-28T02:57:37Z" wall_clock="2024-02-28T01:26:58Z" clock_decimal="7:29" sequence="1709083618325" event_type="stoppage">
    <description>Stoppage - Goalie Stopped (after SOG) - Rink Repair</description>
    <details stoppage_type="Goalie Stopped (after SOG)" reason="Rink Repair"/>