NHL Push Clock provides a game clock feed with high level scoring and strength information, including the most recent game event.
Syntax
https://api.sportradar.com/nhl/{access_level}/stream/{language_code}/clock/subscribe?api_key={your_api_key} |
Parameters
Parameter | Description |
---|---|
access_level | Defines the access level of your API keyproduction , trial |
language_code | Optional code for supported languagesen (English) |
your_api_key | Your API key |
Optional Query String Parameters
By default, a Push feed will provide all data available for all in progress games. If needed, you can filter the data returned by including query strings.
Optional query string parameters must be added after your API key with an ampersand (&
). If you are filtering for more than one result, separate the results with a comma (,
) and no spaces.
Parameter | Description |
---|---|
locale | Language returned expressed as a 2-letter codeen (English)Example: locale=en |
match | Match id Example: match=sd:match:4d1c4eb9-69d4-46fc-a42b-12be98227964 |
status | Game statusinprogress , created Example: status=inprogress |
Code Samples
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.sportradar.us/nhl/trial/stream/en/clock/subscribe?api_key={your_api_key}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
import requests
import json
r = requests.get("https://api.sportradar.com/nhl/trial/stream/en/clock/subscribe",
params = {'api_key': 'your_api_key'},
allow_redirects=False)
redirect_url = r.headers['Location']
r = requests.get(redirect_url, stream=True)
for line in r.iter_lines():
# filter out keep-alive new lines
if line:
decoded_line = line.decode('utf-8')
print(json.loads(decoded_line))
curl -L GET 'api.sportradar.us/nhl/trial/stream/en/clock/subscribe?api_key={your_api_key}'
Samples with Query String Params
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.sportradar.us/nhl/trial/stream/en/clock/subscribe?api_key={your_api_key}&status=inprogress&match=sd:match:4d1c4eb9-69d4-46fc-a42b-12be98227964")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
import requests
import json
r = requests.get("https://api.sportradar.com/nhl/trial/stream/en/clock/subscribe",
params = {'api_key': 'your_api_key', 'status': 'inprogress', 'match': 'sd:match:4d1c4eb9-69d4-46fc-a42b-12be98227964'},
allow_redirects=False)
redirect_url = r.headers['Location']
r = requests.get(redirect_url, stream=True)
for line in r.iter_lines():
# filter out keep-alive new lines
if line:
decoded_line = line.decode('utf-8')
print(json.loads(decoded_line))
curl -L GET 'api.sportradar.us/nhl/trial/stream/en/clock/subscribe?api_key={your_api_key}&status=inprogress&match=sd:match:4d1c4eb9-69d4-46fc-a42b-12be98227964'
Response Sample
{
"payload":{
"clocks":{
"game":"01:40.000",
"wall":"2023-10-31T00:38:09+00:00",
"running":false,
"game_decimal":"01:40.000"
},
"game":{
"id":"4c2c22af-6755-42c8-adb5-0058da782d02",
"status":"inprogress",
"coverage":"full",
"reference":"20132",
"scheduled":"2023-10-30T23:00:00+00:00",
"period":2,
"sr_id":"sr:match:41971169",
"home":{
"name":"Penguins",
"market":"Pittsburgh",
"reference":"5",
"id":"4417b7d7-0f24-11e2-8525-18a905767e44",
"points":1,
"sr_id":"sr:team:3697",
"scoring":[
{
"number":1,
"sequence":1,
"points":1,
"type":"period"
},
{
"number":2,
"sequence":2,
"points":0,
"type":"period"
}
]
},
"away":{
"name":"Ducks",
"market":"Anaheim",
"reference":"24",
"id":"441862de-0f24-11e2-8525-18a905767e44",
"points":2,
"sr_id":"sr:team:3675",
"scoring":[
{
"number":1,
"sequence":1,
"points":1,
"type":"period"
},
{
"number":2,
"sequence":2,
"points":1,
"type":"period"
}
]
}
},
"event":{
"id":"9e88e94a-07d7-47e6-b12f-f6972fc5db1d",
"event_type":"substitution",
"sequence":1698712595315,
"clock":"1:40",
"clock_decimal":"1:40",
"official":true,
"wall_clock":"2023-10-31T00:36:35Z",
"updated":"2023-10-31T00:38:08Z",
"description":"Ducks substitution (Frank Vatrano,Ryan Strome,Cam Fowler,Sam Carrick,Jackson LaCombe)",
"attribution":{
"name":"Ducks",
"market":"Anaheim",
"reference":"24",
"id":"441862de-0f24-11e2-8525-18a905767e44",
"team_goal":"left",
"sr_id":"sr:team:3675"
},
"period":{
"id":"372ab8ba-e48e-4026-b740-18371b445dea",
"number":2,
"sequence":2,
"type":"Period"
},
"players":[
{
"full_name":"Sam Carrick",
"jersey_number":"39",
"reference":"8475842",
"id":"e448f557-fb48-4816-ab7a-dd32b92f7d5c",
"sr_id":"sr:player:608376"
},
{
"full_name":"Jackson LaCombe",
"jersey_number":"60",
"reference":"8481605",
"id":"7dc4b5ce-2ab4-499e-a117-2ee6685476a8",
"sr_id":"sr:player:1770268"
},
{
"full_name":"Ryan Strome",
"jersey_number":"16",
"reference":"8476458",
"id":"4325c36b-0f24-11e2-8525-18a905767e44",
"sr_id":"sr:player:185265"
},
{
"full_name":"Cam Fowler",
"jersey_number":"4",
"reference":"8475764",
"id":"4279f848-0f24-11e2-8525-18a905767e44",
"sr_id":"sr:player:137878"
},
{
"full_name":"Frank Vatrano",
"jersey_number":"77",
"reference":"8478366",
"id":"20695dc0-765f-4208-b2c4-8bf1df4bf88a",
"sr_id":"sr:player:865064"
}
]
}
},
"locale":"en",
"metadata":{
"league":"NHL",
"match":"sd:match:4c2c22af-6755-42c8-adb5-0058da782d02,sr:match:41971169",
"status":"inprogress",
"locale":"en",
"operation":"update",
"version":"v5"
}
}{
"payload":{
"clocks":{
"game":"18:38.000",
"wall":"2023-10-31T00:38:12+00:00",
"running":true,
"strength":"01:44",
"game_decimal":"18:38.000"
},
"game":{
"id":"b6a16ac2-4348-4139-9a21-1b99bb443dfa",
"status":"inprogress",
"coverage":"full",
"reference":"20135",
"scheduled":"2023-10-30T23:30:00+00:00",
"period":2,
"sr_id":"sr:match:41971173",
"home":{
"name":"Jets",
"market":"Winnipeg",
"reference":"52",
"id":"44180e55-0f24-11e2-8525-18a905767e44",
"points":1,
"sr_id":"sr:team:3676",
"scoring":[
{
"number":1,
"sequence":1,
"points":1,
"type":"period"
},
{
"number":2,
"sequence":2,
"points":0,
"type":"period"
}
]
},
"away":{
"name":"Rangers",
"market":"New York",
"reference":"3",
"id":"441781b9-0f24-11e2-8525-18a905767e44",
"points":1,
"sr_id":"sr:team:3701",
"scoring":[
{
"number":1,
"sequence":1,
"points":1,
"type":"period"
},
{
"number":2,
"sequence":2,
"points":0,
"type":"period"
}
]
}
},
"event":{
"id":"21e80bc1-b45f-4dec-91fc-2d81c71bb371",
"event_type":"faceoff",
"zone":"neutral",
"sequence":1698712687196,
"clock":"18:43",
"clock_decimal":"18:43",
"official":true,
"wall_clock":"2023-10-31T00:38:07Z",
"updated":"2023-10-31T00:38:12Z",
"description":"Mika Zibanejad won faceoff against Adam Lowry in neutral zone",
"attribution":{
"name":"Rangers",
"market":"New York",
"reference":"3",
"id":"441781b9-0f24-11e2-8525-18a905767e44",
"team_goal":"right",
"sr_id":"sr:team:3701"
},
"location":{
"coord_x":948,
"coord_y":240,
"action_area":"neutralzone"
},
"period":{
"id":"891b0ecd-56bd-4696-ad4e-85263d4ce28a",
"number":2,
"sequence":2,
"type":"Period"
},
"statistics":[
{
"type":"faceoff",
"zone":"neutral",
"team":{
"name":"Jets",
"market":"Winnipeg",
"reference":"52",
"id":"44180e55-0f24-11e2-8525-18a905767e44",
"sr_id":"sr:team:3676"
},
"player":{
"full_name":"Adam Lowry",
"jersey_number":"17",
"reference":"8476392",
"id":"f2d03d98-f350-42c3-bbd3-cd6d704a0401",
"sr_id":"sr:player:610322"
}
},
{
"type":"faceoff",
"win":true,
"zone":"neutral",
"team":{
"name":"Rangers",
"market":"New York",
"reference":"3",
"id":"441781b9-0f24-11e2-8525-18a905767e44",
"sr_id":"sr:team:3701"
},
"player":{
"full_name":"Mika Zibanejad",
"jersey_number":"93",
"reference":"8476459",
"id":"42f5f2cc-0f24-11e2-8525-18a905767e44",
"sr_id":"sr:player:145201"
}
}
],
"on_ice":[
{
"team":{
"name":"Rangers",
"market":"New York",
"reference":"3",
"id":"441781b9-0f24-11e2-8525-18a905767e44",
"sr_id":"sr:team:3701",
"players":[
{
"full_name":"Chris Kreider",
"jersey_number":"20",
"reference":"8475184",
"position":"F",
"primary_position":"LW",
"id":"43700779-0f24-11e2-8525-18a905767e44",
"sr_id":"sr:player:115645"
},
{
"full_name":"Adam Fox",
"jersey_number":"23",
"reference":"8479323",
"position":"D",
"primary_position":"D",
"id":"9309562d-2fde-4678-8e5a-3ed1cad45d2a",
"sr_id":"sr:player:984105"
},
{
"full_name":"Igor Shesterkin",
"jersey_number":"31",
"reference":"8478048",
"position":"G",
"primary_position":"G",
"id":"30d3b91d-c0d2-40e0-ba17-2a21882c43af",
"sr_id":"sr:player:884434"
},
{
"full_name":"Artemi Panarin",
"jersey_number":"10",
"reference":"8478550",
"position":"F",
"primary_position":"LW",
"id":"019e74ad-95fb-478a-bff7-b549fceadabf",
"sr_id":"sr:player:104807"
},
{
"full_name":"Mika Zibanejad",
"jersey_number":"93",
"reference":"8476459",
"position":"F",
"primary_position":"C",
"id":"42f5f2cc-0f24-11e2-8525-18a905767e44",
"sr_id":"sr:player:145201"
},
{
"full_name":"Vincent Trocheck",
"jersey_number":"16",
"reference":"8476389",
"position":"F",
"primary_position":"C",
"id":"16bf9f68-95f9-4789-a811-80fe6838e632",
"sr_id":"sr:player:352050"
}
]
}
},
{
"team":{
"name":"Jets",
"market":"Winnipeg",
"reference":"52",
"id":"44180e55-0f24-11e2-8525-18a905767e44",
"sr_id":"sr:team:3676",
"players":[
{
"full_name":"Dylan DeMelo",
"jersey_number":"2",
"reference":"8476331",
"position":"D",
"primary_position":"D",
"id":"ae16bfdc-77e0-4465-973f-7eba0214c882",
"sr_id":"sr:player:794662"
},
{
"full_name":"Morgan Barron",
"jersey_number":"36",
"reference":"8480289",
"position":"F",
"primary_position":"C",
"id":"7cd24817-f89e-49c0-9f77-364098df5c18",
"sr_id":"sr:player:1120109"
},
{
"full_name":"Adam Lowry",
"jersey_number":"17",
"reference":"8476392",
"position":"F",
"primary_position":"C",
"id":"f2d03d98-f350-42c3-bbd3-cd6d704a0401",
"sr_id":"sr:player:610322"
},
{
"full_name":"Connor Hellebuyck",
"jersey_number":"37",
"reference":"8476945",
"position":"G",
"primary_position":"G",
"id":"416485a7-f978-4189-8d7e-c2a55b823d3c",
"sr_id":"sr:player:556426"
},
{
"full_name":"Brenden Dillon",
"jersey_number":"5",
"reference":"8475455",
"position":"D",
"primary_position":"D",
"id":"42976da2-0f24-11e2-8525-18a905767e44",
"sr_id":"sr:player:308052"
}
]
}
}
],
"in_penalty":[
{
"team":{
"name":"Jets",
"market":"Winnipeg",
"reference":"52",
"id":"44180e55-0f24-11e2-8525-18a905767e44",
"sr_id":"sr:team:3676",
"players":[
{
"full_name":"Nino Niederreiter",
"jersey_number":"62",
"reference":"8475799",
"position":"F",
"primary_position":"RW",
"id":"4327f191-0f24-11e2-8525-18a905767e44",
"sr_id":"sr:player:115750"
}
]
}
}
]
}
},
"locale":"en",
"metadata":{
"league":"NHL",
"match":"sd:match:b6a16ac2-4348-4139-9a21-1b99bb443dfa,sr:match:41971173",
"status":"inprogress",
"locale":"en",
"operation":"update",
"version":"v5"
}
}{
"payload":{
"clocks":{
"game":"03:41.000",
"wall":"2023-10-31T00:38:13+00:00",
"running":false,
"game_decimal":"03:41.000"
},
"game":{
"id":"8fc62fdb-962c-4999-9885-ac63c95d8080",
"status":"inprogress",
"coverage":"full",
"reference":"20130",
"scheduled":"2023-10-30T23:00:00+00:00",
"period":2,
"sr_id":"sr:match:41971165",
"home":{
"name":"Bruins",
"market":"Boston",
"reference":"6",
"id":"4416ba1a-0f24-11e2-8525-18a905767e44",
"points":1,
"sr_id":"sr:team:3677",
"scoring":[
{
"number":1,
"sequence":1,
"points":0,
"type":"period"
},
{
"number":2,
"sequence":2,
"points":1,
"type":"period"
}
]
},
"away":{
"name":"Panthers",
"market":"Florida",
"reference":"13",
"id":"4418464d-0f24-11e2-8525-18a905767e44",
"points":2,
"sr_id":"sr:team:3687",
"scoring":[
{
"number":1,
"sequence":1,
"points":2,
"type":"period"
},
{
"number":2,
"sequence":2,
"points":0,
"type":"period"
}
]
}
},
"event":{
"id":"9c3fe4d0-e7a3-445a-bfd2-c7728371e757",
"event_type":"stoppage",
"stoppage_type":"Goalie Stopped (after SOG)",
"sequence":1698712676665,
"clock":"3:41",
"clock_decimal":"3:41",
"official":true,
"wall_clock":"2023-10-31T00:37:56Z",
"updated":"2023-10-31T00:38:14Z",
"description":"Stoppage - Goalie Stopped (after SOG)",
"period":{
"id":"5806749e-75ce-496e-9264-f819f8c99d1f",
"number":2,
"sequence":2,
"type":"Period"
},
"details":{
"stoppage_type":"Goalie Stopped (after SOG)"
},
"on_ice":[
{
"team":{
"name":"Panthers",
"market":"Florida",
"reference":"13",
"id":"4418464d-0f24-11e2-8525-18a905767e44",
"sr_id":"sr:team:3687",
"players":[
{
"full_name":"Sam Reinhart",
"jersey_number":"13",
"reference":"8477933",
"position":"F",
"primary_position":"C",
"id":"d4fb4274-a59f-4705-821e-dba04967570f",
"sr_id":"sr:player:610972"
},
{
"full_name":"Gustav Forsling",
"jersey_number":"42",
"reference":"8478055",
"position":"D",
"primary_position":"D",
"id":"a24e0f46-9cad-49dd-b07f-7835e0848d99",
"sr_id":"sr:player:600624"
},
{
"full_name":"Aleksander Barkov",
"jersey_number":"16",
"reference":"8477493",
"position":"F",
"primary_position":"C",
"id":"0cd5158e-f92b-11e2-a133-f4ce4684ea4c",
"sr_id":"sr:player:184453"
},
{
"full_name":"Nick Cousins",
"jersey_number":"21",
"reference":"8476393",
"position":"F",
"primary_position":"C",
"id":"195e4587-4f5e-47b0-bffc-88f0106561b9",
"sr_id":"sr:player:351830"
},
{
"full_name":"Oliver Ekman-Larsson",
"jersey_number":"91",
"reference":"8475171",
"position":"D",
"primary_position":"D",
"id":"4289ec26-0f24-11e2-8525-18a905767e44",
"sr_id":"sr:player:47945"
},
{
"full_name":"Sergei Bobrovsky",
"jersey_number":"72",
"reference":"8475683",
"position":"G",
"primary_position":"G",
"id":"433d0416-0f24-11e2-8525-18a905767e44",
"sr_id":"sr:player:88027"
}
]
}
},
{
"team":{
"name":"Bruins",
"market":"Boston",
"reference":"6",
"id":"4416ba1a-0f24-11e2-8525-18a905767e44",
"sr_id":"sr:team:3677",
"players":[
{
"full_name":"James van Riemsdyk",
"jersey_number":"21",
"reference":"8474037",
"position":"F",
"primary_position":"LW",
"id":"4337ce91-0f24-11e2-8525-18a905767e44",
"sr_id":"sr:player:93491"
},
{
"full_name":"Hampus Lindholm",
"jersey_number":"27",
"reference":"8476854",
"position":"D",
"primary_position":"D",
"id":"671bbc9e-99ea-4c1f-b871-f8efd53b0d8f",
"sr_id":"sr:player:215040"
},
{
"full_name":"Brandon Carlo",
"jersey_number":"25",
"reference":"8478443",
"position":"D",
"primary_position":"D",
"id":"a78b4782-c5d4-4bad-a765-3e4b95a7fb90",
"sr_id":"sr:player:852958"
},
{
"full_name":"Pavel Zacha",
"jersey_number":"18",
"reference":"8478401",
"position":"F",
"primary_position":"C",
"id":"aafb1b09-91ab-49b6-a1ff-a171a480c5c1",
"sr_id":"sr:player:350310"
},
{
"full_name":"Trent Frederic",
"jersey_number":"11",
"reference":"8479365",
"position":"F",
"primary_position":"C",
"id":"41acc046-28ad-430f-94e5-604d7f35daff",
"sr_id":"sr:player:984013"
},
{
"full_name":"Linus Ullmark",
"jersey_number":"35",
"reference":"8476999",
"position":"G",
"primary_position":"G",
"id":"d4dd5956-5c99-4e69-b21f-713b64327eca",
"sr_id":"sr:player:350972"
}
]
}
}
]
}
},
"locale":"en",
"metadata":{
"league":"NHL",
"match":"sd:match:8fc62fdb-962c-4999-9885-ac63c95d8080,sr:match:41971165",
"status":"inprogress",
"locale":"en",
"operation":"update",
"version":"v5"
}
}{
"payload":{
"clocks":{
"game":"03:41.000",
"wall":"2023-10-31T00:38:16+00:00",
"running":false,
"game_decimal":"03:41.000"
},
"game":{
"id":"8fc62fdb-962c-4999-9885-ac63c95d8080",
"status":"inprogress",
"coverage":"full",
"reference":"20130",
"scheduled":"2023-10-30T23:00:00+00:00",
"period":2,
"sr_id":"sr:match:41971165",
"home":{
"name":"Bruins",
"market":"Boston",
"reference":"6",
"id":"4416ba1a-0f24-11e2-8525-18a905767e44",
"points":1,
"sr_id":"sr:team:3677",
"scoring":[
{
"number":1,
"sequence":1,
"points":0,
"type":"period"
},
{
"number":2,
"sequence":2,
"points":1,
"type":"period"
}
]
},
"away":{
"name":"Panthers",
"market":"Florida",
"reference":"13",
"id":"4418464d-0f24-11e2-8525-18a905767e44",
"points":2,
"sr_id":"sr:team:3687",
"scoring":[
{
"number":1,
"sequence":1,
"points":2,
"type":"period"
},
{
"number":2,
"sequence":2,
"points":0,
"type":"period"
}
]
}
},
"event":{
"id":"9c3fe4d0-e7a3-445a-bfd2-c7728371e757",
"event_type":"stoppage",
"stoppage_type":"Goalie Stopped (after SOG)",
"sequence":1698712676665,
"clock":"3:41",
"clock_decimal":"3:41",
"official":true,
"wall_clock":"2023-10-31T00:37:56Z",
"updated":"2023-10-31T00:38:14Z",
"description":"Stoppage - Goalie Stopped (after SOG)",
"period":{
"id":"5806749e-75ce-496e-9264-f819f8c99d1f",
"number":2,
"sequence":2,
"type":"Period"
},
"details":{
"stoppage_type":"Goalie Stopped (after SOG)"
},
"on_ice":[
{
"team":{
"name":"Panthers",
"market":"Florida",
"reference":"13",
"id":"4418464d-0f24-11e2-8525-18a905767e44",
"sr_id":"sr:team:3687",
"players":[
{
"full_name":"Sam Reinhart",
"jersey_number":"13",
"reference":"8477933",
"position":"F",
"primary_position":"C",
"id":"d4fb4274-a59f-4705-821e-dba04967570f",
"sr_id":"sr:player:610972"
},
{
"full_name":"Gustav Forsling",
"jersey_number":"42",
"reference":"8478055",
"position":"D",
"primary_position":"D",
"id":"a24e0f46-9cad-49dd-b07f-7835e0848d99",
"sr_id":"sr:player:600624"
},
{
"full_name":"Aleksander Barkov",
"jersey_number":"16",
"reference":"8477493",
"position":"F",
"primary_position":"C",
"id":"0cd5158e-f92b-11e2-a133-f4ce4684ea4c",
"sr_id":"sr:player:184453"
},
{
"full_name":"Nick Cousins",
"jersey_number":"21",
"reference":"8476393",
"position":"F",
"primary_position":"C",
"id":"195e4587-4f5e-47b0-bffc-88f0106561b9",
"sr_id":"sr:player:351830"
},
{
"full_name":"Oliver Ekman-Larsson",
"jersey_number":"91",
"reference":"8475171",
"position":"D",
"primary_position":"D",
"id":"4289ec26-0f24-11e2-8525-18a905767e44",
"sr_id":"sr:player:47945"
},
{
"full_name":"Sergei Bobrovsky",
"jersey_number":"72",
"reference":"8475683",
"position":"G",
"primary_position":"G",
"id":"433d0416-0f24-11e2-8525-18a905767e44",
"sr_id":"sr:player:88027"
}
]
}
},
{
"team":{
"name":"Bruins",
"market":"Boston",
"reference":"6",
"id":"4416ba1a-0f24-11e2-8525-18a905767e44",
"sr_id":"sr:team:3677",
"players":[
{
"full_name":"James van Riemsdyk",
"jersey_number":"21",
"reference":"8474037",
"position":"F",
"primary_position":"LW",
"id":"4337ce91-0f24-11e2-8525-18a905767e44",
"sr_id":"sr:player:93491"
},
{
"full_name":"Hampus Lindholm",
"jersey_number":"27",
"reference":"8476854",
"position":"D",
"primary_position":"D",
"id":"671bbc9e-99ea-4c1f-b871-f8efd53b0d8f",
"sr_id":"sr:player:215040"
},
{
"full_name":"Brandon Carlo",
"jersey_number":"25",
"reference":"8478443",
"position":"D",
"primary_position":"D",
"id":"a78b4782-c5d4-4bad-a765-3e4b95a7fb90",
"sr_id":"sr:player:852958"
},
{
"full_name":"Pavel Zacha",
"jersey_number":"18",
"reference":"8478401",
"position":"F",
"primary_position":"C",
"id":"aafb1b09-91ab-49b6-a1ff-a171a480c5c1",
"sr_id":"sr:player:350310"
},
{
"full_name":"Trent Frederic",
"jersey_number":"11",
"reference":"8479365",
"position":"F",
"primary_position":"C",
"id":"41acc046-28ad-430f-94e5-604d7f35daff",
"sr_id":"sr:player:984013"
},
{
"full_name":"Linus Ullmark",
"jersey_number":"35",
"reference":"8476999",
"position":"G",
"primary_position":"G",
"id":"d4dd5956-5c99-4e69-b21f-713b64327eca",
"sr_id":"sr:player:350972"
}
]
}
}
]
}
},
"locale":"en",
"metadata":{
"league":"NHL",
"match":"sd:match:8fc62fdb-962c-4999-9885-ac63c95d8080,sr:match:41971165",
"status":"inprogress",
"locale":"en",
"operation":"update",
"version":"v5"
}
}{
"payload":{
"clocks":{
"game":"01:08.000",
"wall":"2023-10-31T00:38:18+00:00",
"running":true,
"game_decimal":"01:08.000"
},
"game":{
"id":"065f948d-471b-47b4-a971-001dc9004371",
"status":"inprogress",
"coverage":"full",
"reference":"20133",
"scheduled":"2023-10-30T23:00:00+00:00",
"period":2,
"sr_id":"sr:match:41971171",
"home":{
"name":"Lightning",
"market":"Tampa Bay",
"reference":"14",
"id":"4417d3cb-0f24-11e2-8525-18a905767e44",
"points":2,
"sr_id":"sr:team:3694",
"scoring":[
{
"number":1,
"sequence":1,
"points":1,
"type":"period"
},
{
"number":2,
"sequence":2,
"points":1,
"type":"period"
}
]
},
"away":{
"name":"Kraken",
"market":"Seattle",
"reference":"55",
"id":"1fb48e65-9688-4084-8868-02173525c3e1",
"points":3,
"sr_id":"sr:team:794340",
"scoring":[
{
"number":1,
"sequence":1,
"points":3,
"type":"period"
},
{
"number":2,
"sequence":2,
"points":0,
"type":"period"
}
]
}
},
"event":{
"id":"4b735927-73cf-479c-9186-c4de3880d8f0",
"event_type":"substitution",
"sequence":1698712688493,
"clock":"1:18",
"clock_decimal":"1:18",
"official":true,
"wall_clock":"2023-10-31T00:38:08Z",
"updated":"2023-10-31T00:38:18Z",
"description":"Kraken substitution (Eeli Tolvanen,Matty Beniers,Will Borgen,Oliver Bjorkstrand,Jamie Oleksiak)",
"attribution":{
"name":"Kraken",
"market":"Seattle",
"reference":"55",
"id":"1fb48e65-9688-4084-8868-02173525c3e1",
"team_goal":"left",
"sr_id":"sr:team:794340"
},
"period":{
"id":"fb2b2506-ddb1-47c5-b928-e5a8ce8fabd2",
"number":2,
"sequence":2,
"type":"Period"
},
"players":[
{
"full_name":"Will Borgen",
"jersey_number":"3",
"reference":"8478840",
"id":"e198a0bf-fcb3-4638-8f7c-955a55532cbd",
"sr_id":"sr:player:1215232"
},
{
"full_name":"Eeli Tolvanen",
"jersey_number":"20",
"reference":"8480009",
"id":"c8ab94f6-42f3-47d6-99c7-d2445fe2abf9",
"sr_id":"sr:player:1088330"
},
{
"full_name":"Jamie Oleksiak",
"jersey_number":"24",
"reference":"8476467",
"id":"22620d9f-c834-41d2-8898-6c62a6c868fb",
"sr_id":"sr:player:312224"
},
{
"full_name":"Oliver Bjorkstrand",
"jersey_number":"22",
"reference":"8477416",
"id":"404beff3-3b28-4a47-b60e-89349c572eff",
"sr_id":"sr:player:895840"
},
{
"full_name":"Matty Beniers",
"jersey_number":"10",
"reference":"8482665",
"id":"a84cbaed-fc8d-42a3-9f1b-b231d8dc426d",
"sr_id":"sr:player:2056459"
}
]
}
},
"locale":"en",
"metadata":{
"league":"NHL",
"match":"sd:match:065f948d-471b-47b4-a971-001dc9004371,sr:match:41971171",
"status":"inprogress",
"locale":"en",
"operation":"update",
"version":"v5"
}
}{
"payload":{
"clocks":{
"game":"18:29.000",
"wall":"2023-10-31T00:38:21+00:00",
"running":true,
"strength":"01:35",
"game_decimal":"18:29.000"
},
"game":{
"id":"b6a16ac2-4348-4139-9a21-1b99bb443dfa",
"status":"inprogress",
"coverage":"full",
"reference":"20135",
"scheduled":"2023-10-30T23:30:00+00:00",
"period":2,
"sr_id":"sr:match:41971173",
"home":{
"name":"Jets",
"market":"Winnipeg",
"reference":"52",
"id":"44180e55-0f24-11e2-8525-18a905767e44",
"points":1,
"sr_id":"sr:team:3676",
"scoring":[
{
"number":1,
"sequence":1,
"points":1,
"type":"period"
},
{
"number":2,
"sequence":2,
"points":0,
"type":"period"
}
]
},
"away":{
"name":"Rangers",
"market":"New York",
"reference":"3",
"id":"441781b9-0f24-11e2-8525-18a905767e44",
"points":1,
"sr_id":"sr:team:3701",
"scoring":[
{
"number":1,
"sequence":1,
"points":1,
"type":"period"
},
{
"number":2,
"sequence":2,
"points":0,
"type":"period"
}
]
}
},
"event":{
"id":"21e80bc1-b45f-4dec-91fc-2d81c71bb371",
"event_type":"faceoff",
"zone":"neutral",
"strength":"powerplay",
"sequence":1698712687196,
"clock":"18:43",
"clock_decimal":"18:43",
"official":true,
"wall_clock":"2023-10-31T00:38:07Z",
"updated":"2023-10-31T00:38:20Z",
"description":"Power play - Mika Zibanejad won faceoff against Adam Lowry in neutral zone",
"attribution":{
"name":"Rangers",
"market":"New York",
"reference":"3",
"id":"441781b9-0f24-11e2-8525-18a905767e44",
"team_goal":"right",
"sr_id":"sr:team:3701"
},
"location":{
"coord_x":948,
"coord_y":240,
"action_area":"neutralzone"
},
"period":{
"id":"891b0ecd-56bd-4696-ad4e-85263d4ce28a",
"number":2,
"sequence":2,
"type":"Period"
},
"statistics":[
{
"type":"faceoff",
"win":true,
"strength":"powerplay",
"zone":"neutral",
"team":{
"name":"Rangers",
"market":"New York",
"reference":"3",
"id":"441781b9-0f24-11e2-8525-18a905767e44",
"sr_id":"sr:team:3701"
},
"player":{
"full_name":"Mika Zibanejad",
"jersey_number":"93",
"reference":"8476459",
"id":"42f5f2cc-0f24-11e2-8525-18a905767e44",
"sr_id":"sr:player:145201"
}
},
{
"type":"faceoff",
"strength":"shorthanded",
"zone":"neutral",
"team":{
"name":"Jets",
"market":"Winnipeg",
"reference":"52",
"id":"44180e55-0f24-11e2-8525-18a905767e44",
"sr_id":"sr:team:3676"
},
"player":{
"full_name":"Adam Lowry",
"jersey_number":"17",
"reference":"8476392",
"id":"f2d03d98-f350-42c3-bbd3-cd6d704a0401",
"sr_id":"sr:player:610322"
}
}
],
"on_ice":[
{
"team":{
"name":"Rangers",
"market":"New York",
"reference":"3",
"id":"441781b9-0f24-11e2-8525-18a905767e44",
"sr_id":"sr:team:3701",
"players":[
{
"full_name":"Chris Kreider",
"jersey_number":"20",
"reference":"8475184",
"position":"F",
"primary_position":"LW",
"id":"43700779-0f24-11e2-8525-18a905767e44",
"sr_id":"sr:player:115645"
},
{
"full_name":"Adam Fox",
"jersey_number":"23",
"reference":"8479323",
"position":"D",
"primary_position":"D",
"id":"9309562d-2fde-4678-8e5a-3ed1cad45d2a",
"sr_id":"sr:player:984105"
},
{
"full_name":"Igor Shesterkin",
"jersey_number":"31",
"reference":"8478048",
"position":"G",
"primary_position":"G",
"id":"30d3b91d-c0d2-40e0-ba17-2a21882c43af",
"sr_id":"sr:player:884434"
},
{
"full_name":"Artemi Panarin",
"jersey_number":"10",
"reference":"8478550",
"position":"F",
"primary_position":"LW",
"id":"019e74ad-95fb-478a-bff7-b549fceadabf",
"sr_id":"sr:player:104807"
},
{
"full_name":"Mika Zibanejad",
"jersey_number":"93",
"reference":"8476459",
"position":"F",
"primary_position":"C",
"id":"42f5f2cc-0f24-11e2-8525-18a905767e44",
"sr_id":"sr:player:145201"
},
{
"full_name":"Vincent Trocheck",
"jersey_number":"16",
"reference":"8476389",
"position":"F",
"primary_position":"C",
"id":"16bf9f68-95f9-4789-a811-80fe6838e632",
"sr_id":"sr:player:352050"
}
]
}
},
{
"team":{
"name":"Jets",
"market":"Winnipeg",
"reference":"52",
"id":"44180e55-0f24-11e2-8525-18a905767e44",
"sr_id":"sr:team:3676",
"players":[
{
"full_name":"Dylan DeMelo",
"jersey_number":"2",
"reference":"8476331",
"position":"D",
"primary_position":"D",
"id":"ae16bfdc-77e0-4465-973f-7eba0214c882",
"sr_id":"sr:player:794662"
},
{
"full_name":"Morgan Barron",
"jersey_number":"36",
"reference":"8480289",
"position":"F",
"primary_position":"C",
"id":"7cd24817-f89e-49c0-9f77-364098df5c18",
"sr_id":"sr:player:1120109"
},
{
"full_name":"Adam Lowry",
"jersey_number":"17",
"reference":"8476392",
"position":"F",
"primary_position":"C",
"id":"f2d03d98-f350-42c3-bbd3-cd6d704a0401",
"sr_id":"sr:player:610322"
},
{
"full_name":"Connor Hellebuyck",
"jersey_number":"37",
"reference":"8476945",
"position":"G",
"primary_position":"G",
"id":"416485a7-f978-4189-8d7e-c2a55b823d3c",
"sr_id":"sr:player:556426"
},
{
"full_name":"Brenden Dillon",
"jersey_number":"5",
"reference":"8475455",
"position":"D",
"primary_position":"D",
"id":"42976da2-0f24-11e2-8525-18a905767e44",
"sr_id":"sr:player:308052"
}
]
}
}
],
"in_penalty":[
{
"team":{
"name":"Jets",
"market":"Winnipeg",
"reference":"52",
"id":"44180e55-0f24-11e2-8525-18a905767e44",
"sr_id":"sr:team:3676",
"players":[
{
"full_name":"Nino Niederreiter",
"jersey_number":"62",
"reference":"8475799",
"position":"F",
"primary_position":"RW",
"id":"4327f191-0f24-11e2-8525-18a905767e44",
"sr_id":"sr:player:115750"
}
]
}
}
]
}
},
"locale":"en",
"metadata":{
"league":"NHL",
"match":"sd:match:b6a16ac2-4348-4139-9a21-1b99bb443dfa,sr:match:41971173",
"status":"inprogress",
"locale":"en",
"operation":"update",
"version":"v5"
}
}
Data Points
Boxscore:
Attribute | Parent Element | Type | Description |
---|---|---|---|
points | game - home / away | Integer | Number of points for a team |
points | game - home / away - scoring | Integer | Number of points in a period for a team |
period | game | Integer | Current period of a game |
id | event - period | GUID | Unique ID of a period ex. 65c87f65-47a8-4341-a34f-a9036582aa79 |
number | event - period | Integer | Period number |
sequence | event - period | Integer | Period sequence number |
type | event - period | String | Type of a period ex. Period |
Clock:
Attribute | Parent Element | Type | Description |
---|---|---|---|
game | clocks | Time | Game clock value for a payload/event ex. 18:38.000 |
game_decimal | clocks | String | Game clock value for a payload/event ex. 18:38.000 |
running | clocks | Boolean | Signifies the game clock is currently running |
strength | clocks | String | Time remaining of a strength event ex. 00:51 |
wall | clocks | dateTime | Timestamp of an event ex. 2022-12-14T02:12:41+00:00 |
Game:
Attribute | Parent Element | Type | Description |
---|---|---|---|
id | game | GUID | Unique ID of a game ex. 10b9ce0f-fd31-4d1f-828b-4f20d628f14f |
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 |
id | game - away | GUID | Unique ID of the away team ex. 4416091c-0f24-11e2-8525-18a905767e44 |
name | game - away | String | Team name of the away team ex. Wild |
market | game - away | String | Market of the away team ex. Minnesota |
reference | game - away | String | League reference ID of the away team ex. 30 |
sr_id | game - away | GUID | Unique Sportradar ID of the away team ex. sr:team:3689 |
coverage | game | String | Coverage level of a gamefull , boxscore |
id | game - home | GUID | Unique ID of the home team ex. 4416091c-0f24-11e2-8525-18a905767e44 |
name | game - home | String | Team name of the home team ex. Wild |
market | game - home | String | Market of the home team ex. Minnesota |
reference | game - home | String | League reference ID of the home team ex. 30 |
sr_id | game - home | GUID | Unique Sportradar ID of the home team ex. sr:team:3689 |
Metadata:
Attribute | Parent Element | Type | Description |
---|---|---|---|
league | metadata | String | Alias of a league ex. NHL |
locale | metadata | String | Language code ex. en (English) |
match | metadata | GUID | Unique ID(s) of a game ex. sd:match:2de3fad5-a527-4c49-9093-9243d2135352,sr:match:34542877 |
operation | metadata | String | Operation of an updateupdate , delete |
status | metadata | String | The status of a gamescheduled , created , inprogress , halftime , complete , closed , cancelled , delayed , postponed , time-tbd , if-necessary , unnecessary Please see our FAQ section for a list of game status definitions |
version | metadata | String | Version of the API ex. v5 |
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 - players | String | Full name of a player ex. Sidney Crosby |
id | event - players | GUID | Unique ID of a player ex. 433de553-0f24-11e2-8525-18a905767e44 |
jersey_number | event - players | Integer | Number of a player's jersey |
reference | event - players | String | League reference ID of a player ex. 8471675 |
sr_id | event - players | 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 - team - players | String | Full name of a player ex. Sidney Crosby |
id | event - on-ice - team - players | GUID | Unique ID of a player ex. 433de553-0f24-11e2-8525-18a905767e44 |
jersey_number | event - on-ice - team - players | Integer | Number of a player's jersey |
reference | event - on-ice - team - players | String | League reference ID of a player ex. 8471675 |
sr_id | event - on-ice - team - players | 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 |
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 |
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 |