Global Hockey Push Events provides real-time event updates for all live matches.
Syntax
https://api.sportradar.com/icehockey/{access_level}/stream/events/subscribe |
Parameters
Parameter | Description |
---|---|
| Defines the access level of 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.
Each query string parameter can be added with a preceding ampersand (&
).
URL Parameters | Description |
---|---|
| Channel type |
| Competition id |
| Event type |
| Format type |
| Season id |
| Sport event id |
| Sport id |
Code Samples
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.sportradar.com/icehockey/trial/stream/events/subscribe")
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)
request["x-api-key"] = "{your_api_key}" # Replace with your actual key
response = http.request(request)
puts response.read_body
import requests
import json
headers = {
'x-api-key': 'your_api_key' # Replace with your actual key
}
r = requests.get(
"https://api.sportradar.com/icehockey/trial/stream/events/subscribe",
headers=headers,
allow_redirects=False
)
redirect_url = r.headers['Location']
r = requests.get(redirect_url, stream=True, headers=headers)
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 -X GET 'https://api.sportradar.com/icehockey/trial/stream/events/subscribe' \
-H 'x-api-key: {your_api_key}'
Samples with Query String Params
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.sportradar.com/icehockey/trial/stream/events/subscribe?&format=json&sport_event_id=sr:sport_event_id:18449748")
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)
request["x-api-key"] = "{your_api_key}" # Replace with your actual key
response = http.request(request)
puts response.read_body
import requests
import json
headers = {
'x-api-key': 'your_api_key' # Replace with your actual key
}
r = requests.get("https://api.sportradar.com/icehockey/trial/stream/events/subscribe",
params = {'format': 'json', 'sport_event_id': 'sr:sport_event_id:18449748'},
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 -X GET 'api.sportradar.com/icehockey/trial/stream/events/subscribe?&format=json&sport_event_id=sr:sport_event_id:18449748'
-H 'x-api-key: {your_api_key}'
Response Sample
The above commands return json like this.
Data Points
Metadata:
Attribute | Parent Element | Type | Description |
---|---|---|---|
channel | metadata | String | Sport of the stream connection ex. icehockey |
competition_id | metadata | String | Unique Id of a competition ex. sr:competition:268 |
event_id | metadata | String | Type of timeline event. Reference enum_event_type in our Global Ice Hockey OpenAPI Spec for a complete list of event types ex. match_started , score_change , suspension |
format | metadata | String | Format type of the responsejson , xml |
season_id | metadata | String | Unique Id of a season ex. sr:season:119485 |
sport_event_id | metadata | String | Unique Id of a sport event ex. sr:sport_event_id:50708029 |
sport_id | metadata | String | Unique Id of a sport ex. sr:sport:4 |
from | heartbeat | Integer | Unix timestamp of the beginning of a heartbeat message ex. 1713804799 |
to | heartbeat | Integer | Unix timestamp of the end of a heartbeat message ex. 1713804804 |
interval | heartbeat | Integer | Interval of a heartbeat message in seconds |
type | heartbeat | String | Type of heartbeat message ex. events , statistics |
package | heartbeat | String | Package of a heartbeat message ex. icehockey-v2 |
Game Timeline:
Attribute | Parent Element | Type | Description |
---|---|---|---|
away_score | event | Integer | Score for the away team after a timeline event |
break_name | event | String | Brief description of a break event ex. 1st_pause |
competitor | event | String | Designation of a competitor for a timeline eventhome , away |
home_score | event | Integer | Score for the home team after a timeline event |
id | event | Integer | Unique ID for a timeline event ex. 1721786685 |
match_clock | event | String | Clock value for a timeline event, in minutes and seconds ex. 47:04 |
match_time | event | Integer | Clock value of a timeline event, in minutes ex. 48 |
period | event | Integer | Period number of a timeline event |
period_name | event | String | Period name of a timeline event, appearing at the beginning of a period ex. 1st_period |
suspension_minutes | event | Integer | Number of suspension minutes for a suspension event |
time | event | Date-time | Timestamp of a timeline event ex. 2024-04-16T20:49:49+00:00 |
type | event | String | Type of timeline event. Reference enum_event_type in our Global Ice Hockey OpenAPI Spec for a complete list of event types ex. match_started , suspension , penalty_missed |
updated | event | Boolean | Signifies this event has been updated since its original entry when true |
updated_time | event | Date-time | Timestamp of an updated time entry ex. 2024-04-22T17:17:24+00:00 |
Player Event Details:
Attribute | Parent Element | Type | Description |
---|---|---|---|
id | event - player | String | Unique player Id associated with a timeline event ex. sr:player:1306498 |
name | event - player | String | Player name associated with a timeline event ex. Marcinek, Patrik |
type | event - player | String | Type of timeline event associated with a player ex. scorer , assist , secondary_assist |
Sport Event Status:
Attribute | Parent Element | Type | Description |
---|---|---|---|
|
| Integer | Aggregate score (of multiple sport events) for the away team |
|
| Integer | Aggregate score (of multiple sport events) for the home team |
|
| String | Unique ID of the aggregate score winner |
|
| Integer | Score for the away team in normal time |
|
| Integer | Total score for the away team in the game |
|
| Integer | Score for the home team in normal time |
|
| Integer | Total score for the home team in the game |
|
| Boolean | Signifies a match result was decided by the federation when |
|
| String | Status within a match. Provides more detail on the state of a match when live than |
|
| Boolean | Signifies a match was abandoned by a scout when |
|
| String | Status of a match |
|
| String | Unique ID of the match winner |
Sport Event Situation:
Attribute | Parent Element | Type | Description |
---|---|---|---|
away_score | sport_event_status - period_scores | Integer | Away team period score |
home_score | sport_event_status - period_scores | Integer | Home team period score |
number | sport_event_status - period_scores | Integer | Period number |
type | sport_event_status - period_scores | String | Period typeregular_period , overtime , 1st_period , 1st_pause , 2nd_period , 2nd_pause , 3rd_period , awaiting_extra , awaiting_penalties , penalties , interrupted |