Provides real-time event updates for all live games.
Syntax
https://api.sportradar.com/handball/{access_level}/stream/events/subscribe?api_key={your_api_key} |
Parameters
Parameter | Description |
---|---|
access_level | Defines the access level of your API keyproduction , trial |
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.
URL Parameters | Description |
---|---|
channel | Channel type Example: channel=handball |
competition_id | Competition id Example: competition_id=sr:competition:1398 |
event_id | Event type Example: event_id=score_change |
format | Format typejson , xml Example: format=json |
season_id | Season id Example: season_id=sr:season:70242 |
sport_event_id | Sport event id Example: sport_event_id=sr:sport_event:19115812 |
sport_id | Sport id Example: sport_id=sr:sport:6 |
Code Samples
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.sportradar.com/handball/trial/stream/events/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/handball/trial/stream/events/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.com/handball/trial/stream/events/subscribe?api_key={your_api_key}"
Samples with Query String Params
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.sportradar.com/handball/trial/stream/events/subscribe?api_key={your_api_key}&format=json&sport_event_id=sr:sport_event:19115812")
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/handball/trial/stream/events/subscribe",
params = {'api_key': 'your_api_key', 'format': 'json', 'sport_event_id': 'sr:sport_event:19115812'},
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 'https://api.sportradar.com/handball/trial/stream/events/subscribe?api_key={your_api_key}&format=json&sport_event_id=sr:sport_event:19115812'
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. handball |
competition_id | metadata | String | Unique Id of a competition ex. sr:competition:149 |
event_id | metadata | String | Type of timeline event. Reference enum_event_type in our Handball OpenAPI Spec for a complete list of event types ex. match_started , score_change , shot_off_target |
format | metadata | String | Format type of the responsejson , xml |
season_id | metadata | String | Unique Id of a season ex. sr:season:106289 |
sport_event_id | metadata | String | Unique Id of a sport event ex. sr:sport_event_id:49324739 |
sport_id | metadata | String | Unique Id of a sport ex. sr:sport:6 |
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. handball-v2 |
Period Scores:
Attribute | Parent Element | Type | Description |
---|---|---|---|
away_score | sport_event_status - period_scores - period_score | Integer | Away team inning score |
home_score | sport_event_status - period_scores - period_score | Integer | Home team inning score |
number | sport_event_status - period_scores - period_score | Integer | Period number |
type | sport_event_status - period_scores - period_score | String | Period typeregular_period , overtime , penalties , awaiting_penalties , 1st_half , 2nd_half , pause , 1st_extra , 2nd_extra , awaiting_extra , extra_time_halftime , interrupted |
Sport Event Status:
Attribute | Parent Element | Type | Description |
---|---|---|---|
aggregate_away_score | sport_event_status | Integer | Aggregate score (of multiple sport events) for the away team |
aggregate_home_score | sport_event_status | Integer | Aggregate score (of multiple sport events) for the home team |
aggregate_winner_id | sport_event_status | String | Unique ID of the aggregate score winner ex. sr:competitor:44 |
away_normaltime_score | sport_event_status | Integer | Score for the away team in normal time |
away_overtime_score | sport_event_status | Integer | Score for the away team in overtime |
away_score | sport_event_status | Integer | Total score for the away team in the match |
home_normaltime_score | sport_event_status | Integer | Score for the home team in normal time |
home_overtime_score | sport_event_status | Integer | Score for the home team in overtime |
home_score | sport_event_status | Integer | Total score for the home team in the match |
decided_by_fed | sport_event_status | Boolean | Signifies a match result was decided by the federation when true . For example, incomplete due to crowd disruption |
match_status | sport_event_status | String | Status within a match. Provides more detail on the state of a match when live than status ex. not_started , 2nd_half , ended , awaiting_penalties See our Handball OpenAPI under enum_sport_event_match_status for a complete list of statuses |
match_tie | sport_event_status | Boolean | Signifies a match ended in a tie when true |
scount_abandoned | sport_event_status | Boolean | Signifies a match was abandoned by a scout when true |
status | sport_event_status | String | Status of a match ex. not_started , live , ended , closed See our FAQ for a complete list of statuses and their definitions. |
winner_id | sport_event_status | String | Unique ID of the match winner ex. sr:competitor:7578 |
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. 1309148117 |
match_clock | event | String | Clock value for a timeline event, in minutes and seconds ex. 3:55 |
match_time | event | Integer | Clock value of a timeline event, in minutes ex. 4 |
method | timeline - event | String | Method of a scored goal ex. penalty |
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. 2nd_half |
period_type | timeline - event | String | Period type of a timeline event ex. regular_period |
suspension_minutes | timeline - event | Integer | Number of suspension minutes charged to a player in a timeline 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 Basketball OpenAPI Spec for a complete list of event types ex. score_change , turnover , won_jump_ball |
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 |
zone | timeline - event | String | Type of timeline event. See our Handball OpenAPI under enum_zone_type for a complete list of event types. ex. wing_left , nine_meter_centre , back_court |
Player Event Details:
Attribute | Parent Element | Type | Description |
---|---|---|---|
id | event - scorer | String | Unique player Id associated with a scoring event ex. sr:player:2300047 |
name | event - scorer | String | Player name associated with a scoring event ex. Grupe, Magnus |
id | event - players - player | String | Unique player Id associated with a timeline event ex. sr:player:2300047 |
name | event - players - player | String | Player name associated with a timeline event ex. Grupe, Magnus |
id | event - assists - player | String | Unique player Id credited with an assist for a timeline event ex. sr:player:2300047 |
name | event - assists - player | String | Player name credited with an assist for a timeline event ex. Grupe, Magnus |
type | event - assists / players - player | String | Player activity type associated with a timeline event. Signifies if a player scored a goal, surrendered a goal, recorded an assist, or participated in a substitution. ex. shot , saved , goalkeeper , primary (assist), substituted_out , substituted_in |