get https://api.sportradar.com/nhl//v7//games//pbp.
NHL Game Play-By-Play provides detailed, real-time information on every team possession and game event.
Update Frequency
TTL / Cache: This endpoint will update to a 2s TTL (time to live) upon a game moving to inprogress. Upon closed, it will transfer to 120s.
Data Updates: Realtime
Data Points
League:
Attribute | Parent Element | Type | Description |
---|---|---|---|
id | season | GUID | Unique ID of a game's season ex. 5d08ca09-ec49-4559-9c0f-257c0158e57f |
type | season | String | Season type for a gameREG (Regular Season), PST (Postseason), PRE (Preseason) |
year | season | Integer | Year of a game's season2022 = 2022-23 Season |
Boxscore:
Attribute | Parent Element | Type | Description |
---|---|---|---|
end_time | game | dateTime | Timestamp of the end of a game ex. 2022-12-06T06:09:52+00:00 |
start_time | game | dateTime | Timestamp of the start of a game ex. 2022-12-06T03:38:31+00:00 |
attendance | game | Integer | Attendance of a game ex. 18420 |
total_game_duration | game | String | Duration of a game (in game time) ex. 60:13 |
clock | game | String | Clock value of the game ex. 5:37 |
period | game | Integer | Current period of a game |
id | period | GUID | Unique ID of a period ex. 84d1303d-6493-4db9-a827-b4a83bdc656a |
number | period | Integer | Period number |
sequence | period | Integer | Period sequence number |
Game:
Attribute | Parent Element | Type | Description |
---|---|---|---|
id | away | GUID | Unique ID of the away team ex. 4416091c-0f24-11e2-8525-18a905767e44 |
away_team | game | GUID | Unique ID of the away team ex. 4416091c-0f24-11e2-8525-18a905767e44 |
name | away | String | Team name of the away team ex. Minnesota Wild |
away_points | game | Integer | Number of points for the away team |
reference | away | String | League reference ID of the away team ex. 30 |
sr_id | away | GUID | Unique Sportradar ID of the away team ex. sr:team:3689 |
strength | away | String | Current strength of the away teameven , shorthanded , powerplay |
coverage | game | String | Coverage level of a gamefull , boxscore |
entry_mode | game | String | Type of data entry for the gameINGEST (Ingested data from the league), LDE (Sportradar live data entry) |
id | game | GUID | Unique ID of a game ex. 10b9ce0f-fd31-4d1f-828b-4f20d628f14f |
parent_id | game | GUID | Standard parent ID of a game. Use this ID to group events (like the Stanley Cup) across seasons. |
reference | game | String | League reference ID of a game ex. 20393 |
scheduled | game | dateTime | Scheduled date and time of a game ex. 2022-12-04T20:00:00Z |
sr_id | game | GUID | Unique Sportradar ID of a game ex. sr:match:34542743 |
status | game | String | The status of a gamescheduled , created , inprogress , complete , closed , cancelled , delayed , postponed , time-tbd , if-necessary , unnecessary Please see our FAQ section for a list of game status definitions |
title | game | String | Title of a game ex. Game 3 |
alias | home | String | Abbreviation of the home team ex. DAL (Dallas) |
id | home | GUID | Unique ID of the home team ex. 44157522-0f24-11e2-8525-18a905767e44 |
home_team | game | GUID | Unique ID of the home team ex. 44157522-0f24-11e2-8525-18a905767e44 |
name | home | String | Team name of the home team ex. Dallas Stars |
home_points | game | Integer | Number of points for the home team |
reference | home | String | League reference ID of the home team ex. 25 |
sr_id | home | GUID | Unique Sportradar ID of the home team ex. sr:team:3684 |
strength | home | String | Current strength of the home teameven , shorthanded , powerplay |
channel | broadcast | String | Name of a game's broadcast channel ex. 215 |
locale | broadcast | String | Signifies the locale of a broadcast ex. Home , Away , National , International |
network | broadcast | String | Name of a game's broadcast network ex. NHL Network |
type | broadcast | String | Type of broadcast ex. TV |
url | broadcast | String | Website URL of a game |
away | game - time_zones | String | Time zone of the away team ex. US/Pacific |
home | game - time_zones | String | Time zone of the home team ex. US/Eastern |
venue | game - time_zones | String | Time zone of the venue ex. US/Eastern |
Play-by-Play - Event Attribution:
Attribute | Parent Element | Type | Description |
---|---|---|---|
team_goal | event - attribution | String | Side of the rink a team is defendingleft , right |
id | event - attribution | GUID | Unique ID of a team ex. 441713b7-0f24-11e2-8525-18a905767e44 |
market | event - attribution | String | Market name of a team ex. Minnesota |
name | event - attribution | String | Team name ex. Wild |
reference | event - attribution | String | League reference ID of a team ex. 30 |
sr_id | event - attribution | GUID | Unique Sportradar ID of a team ex. sr:team:3689 |
Play-by-Play - Event:
Attribute | Parent Element | Type | Description |
---|---|---|---|
away_points | event | Integer | Number of points for the away team after an event |
clock | event | String | Clock value of an event ex. 12:37 |
clock_decimal | event | String | Clock value of an event ex. 12:37 |
description | event | String | Text description of an event ex. Goal scored by Cole Caufield assisted by Jordan Harris |
event_type | event | String | Type of event ex. goal or shotsaved See our FAQ for a complete list of types |
home_points | event | Integer | Number of points for the home team after an event |
id | event | GUID | Unique ID of an event ex. d26ba273-2391-4248-be29-dea193092c5a |
id | deleted_events - event | GUID | Unique ID of a deleted event ex. d26ba273-2391-4248-be29-dea193092c5a |
official | event | Boolean | Signifies an event is official and will count towards the statistical record |
sequence | event | Decimal | Sequence number of an event or play as a UNIX timestamp. Use this value to help sequence play-by-play events (smallest to largest sequence number). ex. 1665336878436.0 |
updated | event | dateTime | Timestamp of the last update to an event ex. 2022-12-06T17:09:15Z |
wall_clock | event | dateTime | Timestamp of an event ex. 2022-12-06T05:04:22Z |
zone | event | String | Zone of an eventdefensive , offensive , neutral |
Play-by-Play - Event Details:
Attribute | Parent Element | Type | Description |
---|---|---|---|
goal_zone | event - details | String | Zone of a made goal (from the shooter's perspective)upper left , upper middle , upper right , lower left , lower middle , lower right |
penalty_code | event - details | String | League penalty reference ID/code ex. 55 , 80 |
duration | event - details | Integer | Duration of a penalty in minutes |
penalty_type | event - details | String | Type of penalty ex. Charging See our FAQ for a list of valid penalty types |
reason | event - details | String | Event detail description ex. wide of net , goalpost , TV timeout |
distance | event - details | Integer | Distance of a shot on goal in feet |
shot_type | event - details | Integer | Type of a shotwrist , slap , backhand , tip , snap , wrap-around , bat , cradle , poke , between_legs |
stoppage_type | event - details | Integer | Type of a stopp ex. Referee or Linesman , Puck Frozen , Icing |
Play-by-Play - Event Location:
Attribute | Parent Element | Type | Description |
---|---|---|---|
action_area | event - location | String | Rink area of action for an event ex. outsideleftcircle |
coord_x | event - location | Integer | X coordinate of an event. The rink we use is 2400 by 1020; the scale is in inches. |
coord_y | event - location | Integer | Y coordinate of an event. The rink we use is 2400 by 1020; the scale is in inches. |
Play-by-Play - Event Participants:
Players and teams will appear within each event in different contexts. This will include: substitutions, on ice info, faceoffs, and event statistics such as missed shots or goals.
Attribute | Parent Element | Type | Description |
---|---|---|---|
full_name | event - player | String | Full name of a player ex. Sidney Crosby |
id | event - player | GUID | Unique ID of a player ex. 433de553-0f24-11e2-8525-18a905767e44 |
jersey_number | event - player | Integer | Number of a player's jersey |
reference | event - player | String | League reference ID of a player ex. 8471675 |
sr_id | event - player | GUID | Unique Sportradar ID of a player ex. sr:player:31007 |
id | event - team | GUID | Unique ID of a team ex. bdc11650-6f74-49c4-875e-778aeb7632d9 |
market | event - team | String | Market name of a team ex. Minnesota |
name | event - team | String | Team name ex. Wild |
reference | event - team | String | League reference ID of a team ex. 30 |
sr_id | event - team | GUID | Unique Sportradar ID of a team ex. sr:team:3689 |
Play-by-Play - On Ice:
Attribute | Parent Element | Type | Description |
---|---|---|---|
full_name | event - on-ice - player | String | Full name of a player ex. Sidney Crosby |
id | event - on-ice - player | GUID | Unique ID of a player ex. 433de553-0f24-11e2-8525-18a905767e44 |
jersey_number | event - on-ice - player | Integer | Number of a player's jersey |
reference | event - on-ice - player | String | League reference ID of a player ex. 8471675 |
sr_id | event - on-ice - player | GUID | Unique Sportradar ID of a player ex. sr:player:31007 |
id | event - on-ice - team | GUID | Unique ID of a team ex. bdc11650-6f74-49c4-875e-778aeb7632d9 |
market | event - on-ice - team | String | Market name of a team ex. Minnesota |
name | event - on-ice - team | String | Team name ex. Wild |
reference | event - on-ice - team | String | League reference ID of a team ex. 30 |
sr_id | event - on-ice - team | GUID | Unique Sportradar ID of a team ex. sr:team:3689 |
Play Statistics:
Attribute | Parent Element | Type | Description |
---|---|---|---|
strength | event - statistics - assist | String | Strength for an assist eventeven , powerplay , shorthanded |
assist_type | event - statistics - assist | String | Type of assistprimary , secondary |
zone | event - statistics - assist | String | Zone of an assist eventdefensive , offensive , neutral |
strength | event - statistics - block | String | Strength for a block eventeven , powerplay , shorthanded |
zone | event - statistics - block | String | Zone of a block eventdefensive , offensive , neutral |
strength | event - statistics - faceoff | String | Strength for a faceoff eventeven , powerplay , shorthanded |
win | event - statistics - faceoff | Boolean | Signifies a won faceoff |
zone | event - statistics - blfaceoffock | String | Zone of a faceoff eventdefensive , offensive , neutral |
strength | event - statistics - giveaway | String | Strength for a giveaway eventeven , powerplay , shorthanded |
zone | event - statistics - giveaway | String | Zone of a giveaway eventdefensive , offensive , neutral |
goals_against | event - statistics - giveaway - player | Integer | Total goals against for a goalie in a game |
strength | event - statistics - hit | String | Strength for the hitter a hit eventeven , powerplay , shorthanded |
zone | event - statistics - hit | String | Zone of the hitter a hit eventdefensive , offensive , neutral |
strength | event - statistics - hittee | String | Strength for the player hit in a hit eventeven , powerplay , shorthanded |
zone | event - statistics - hittee | String | Zone of the player hit in a hit eventdefensive , offensive , neutral |
penalty | event - statistics - shotmissed | Boolean | Signifies a missed penalty shot |
shootout | event - statistics - shotmissed | Boolean | Signifies a missed shootout shot |
strength | event - statistics - shotmissed | String | Strength for a missed shot eventeven , powerplay , shorthanded |
zone | event - statistics - shotmissed | String | Zone for a missed shot eventdefensive , offensive , neutral |
minutes | event - statistics - penalty | Integer | Number of penalty minutes |
severity | event - statistics - penalty | String | Severity of a penaltyMinor , Major , Double Minor , Misconduct |
strength | event - statistics - penalty | String | Strength for a penalty eventeven , powerplay , shorthanded |
minutes | event - statistics - penaltydrawn | Integer | Number of penalty minutes for a player drawing a penalty |
severity | event - statistics - penaltydrawn | String | Severity of a penalty for a player drawing a penaltyMinor , Major , Double Minor , Misconduct |
strength | event - statistics - penaltydrawn | String | Strength of a penalty event for a player drawing a penaltyeven , powerplay , shorthanded |
minutes | event - statistics - penaltyserved | Integer | Number of penalty minutes served |
severity | event - statistics - penaltyserved | String | Severity of a penalty servedMinor , Major , Double Minor , Misconduct |
strength | event - statistics - penaltyserved | String | Strength of a penalty served eventeven , powerplay , shorthanded |
awarded | event - statistics - shot | Boolean | Signifies an awarded shot |
goal | event - statistics - shot | Boolean | Signifies a goal score |
penalty | event - statistics - shot | Boolean | Signifies a penalty shot |
shootout | event - statistics - shot | Boolean | Signifies a shootout shot |
strength | event - statistics - shot | String | Strength of a shot eventeven , powerplay , shorthanded |
zone | event - statistics - shot | String | Zone for a shot eventdefensive , offensive , neutral |
awarded | event - statistics - shotagainst | Boolean | Signifies an awarded shot against |
goal | event - statistics - shotagainst | Boolean | Signifies a goal score against |
penalty | event - statistics - shotagainst | Boolean | Signifies a penalty shot against |
shootout | event - statistics - shotagainst | Boolean | Signifies a shootout shot against |
strength | event - statistics - shotagainst | String | Strength of a shot event for the defenseeven , powerplay , shorthanded |
zone | event - statistics - shotagainst | String | Zone for a shot event for the defensedefensive , offensive , neutral |
strength | event - statistics - takeaway | String | Strength of a takeaway eventeven , powerplay , shorthanded |
zone | event - statistics - takeaway | String | Zone for a takeaway eventdefensive , offensive , neutral |
Player:
Attribute | Parent Element | Type | Description |
---|---|---|---|
full_name | player | String | Full name of a player ex. Sidney Crosby |
id | player | GUID | Unique ID of a player ex. 433de553-0f24-11e2-8525-18a905767e44 |
jersey_number | player | Integer | Number of a player's jersey |
position | player | String | Position of a playerNA , D , F , F-D , G |
reference | player | String | League reference ID of a player ex. 8471675 |
sr_id | player | GUID | Unique Sportradar ID of a player ex. sr:player:31007 |
Team:
Attribute | Parent Element | Type | Description |
---|---|---|---|
id | team | GUID | Unique ID of a team ex. bdc11650-6f74-49c4-875e-778aeb7632d9 |
market | team | String | Market name of a team ex. Minnesota |
name | team | String | Team name ex. Wild |
reference | team | String | League reference ID of a team ex. 30 |
sr_id | team | GUID | Unique Sportradar ID of a team ex. sr:team:3689 |
Venue:
Attribute | Parent Element | Type | Description |
---|---|---|---|
address | venue | String | Address of a venue ex. 2500 Victory Avenue |
capacity | venue | String | Capacity of a venue ex. 18532 |
city | venue | String | City of a venue ex. Dallas |
country | venue | String | Country of a venue ex. USA |
id | venue | GUID | Unique ID of a venue ex. adbd1acb-a053-4944-ba15-383eda91c12e |
name | venue | String | Name of a venue ex. American Airlines Center |
sr_id | venue | GUID | Unique Sportradar ID of a venue ex. sr:venue:5988 |
state | venue | String | State or province of a venue ex. TX |
time_zone | venue | String | Time zone of the venue ex. US/Central |
zip | venue | Integer | ZIP code of a venue ex. 75219 |