Docs
Coverage MatrixDocumentationChange LogLog InContact Us
Docs

Push Events

Provides real-time event updates for all live games.

Syntax

https://api.sportradar.com/handball/{access_level}/stream/events/subscribe

Parameters

ParameterDescription
access_levelDefines the access level of your API key

production, trial
🔐

Authorization

Place your API key in the header for each request (x-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 ParametersDescription
channelChannel type

Example: channel=handball
competition_idCompetition id

Example: competition_id=sr:competition:1398
event_idEvent type

Example: event_id=score_change
formatFormat type

json, xml

Example: format=json
season_idSeason id

Example: season_id=sr:season:70242
sport_event_idSport event id

Example: sport_event_id=sr:sport_event:19115812
sport_idSport 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")

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/handball/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/handball/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/handball/trial/stream/events/subscribe?&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)
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/handball/trial/stream/events/subscribe",
params = {'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 -X GET 'api.sportradar.com/handball/trial/stream/events/subscribe?&format=json&sport_event_id=sr:sport_event:19115812'
-H 'x-api-key: {your_api_key}'


Response Sample

The above commands return json like this.



Data Points

Metadata
AttributeParent ElementTypeDescription
channelmetadataStringSport of the stream connection

ex. handball
competition_idmetadataStringUnique Id of a competition

ex. sr:competition:149
event_idmetadataStringType 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
formatmetadataStringFormat type of the response

json, xml
season_idmetadataStringUnique Id of a season

ex. sr:season:106289
sport_event_idmetadataStringUnique Id of a sport event

ex. sr:sport_event_id:49324739
sport_idmetadataStringUnique Id of a sport

ex. sr:sport:6
fromheartbeatIntegerUnix timestamp of the beginning of a heartbeat message

ex. 1713804799
toheartbeatIntegerUnix timestamp of the end of a heartbeat message

ex. 1713804804
intervalheartbeatIntegerInterval of a heartbeat message in seconds
typeheartbeatStringType of heartbeat message

ex. events, statistics
packageheartbeatStringPackage of a heartbeat message

ex. handball-v2
Period Scores
AttributeParent ElementTypeDescription
away_scoresport_event_status - period_scores - period_scoreIntegerAway team inning score
home_scoresport_event_status - period_scores - period_scoreIntegerHome team inning score
numbersport_event_status - period_scores - period_scoreIntegerPeriod number
typesport_event_status - period_scores - period_scoreStringPeriod type

regular_period, overtime, penalties, awaiting_penalties, 1st_half, 2nd_half, pause, 1st_extra, 2nd_extra, awaiting_extra, extra_time_halftime, interrupted
Sport Event Status
AttributeParent ElementTypeDescription
aggregate_away_scoresport_event_statusIntegerAggregate score (of multiple sport events) for the away team
aggregate_home_scoresport_event_statusIntegerAggregate score (of multiple sport events) for the home team
aggregate_winner_idsport_event_statusStringUnique ID of the aggregate score winner

ex. sr:competitor:44
away_normaltime_scoresport_event_statusIntegerScore for the away team in normal time
away_overtime_scoresport_event_statusIntegerScore for the away team in overtime
away_scoresport_event_statusIntegerTotal score for the away team in the match
home_normaltime_scoresport_event_statusIntegerScore for the home team in normal time
home_overtime_scoresport_event_statusIntegerScore for the home team in overtime
home_scoresport_event_statusIntegerTotal score for the home team in the match
decided_by_fedsport_event_statusBooleanSignifies a match result was decided by the federation when true. For example, incomplete due to crowd disruption
match_statussport_event_statusStringStatus 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_tiesport_event_statusBooleanSignifies a match ended in a tie when true
scount_abandonedsport_event_statusBooleanSignifies a match was abandoned by a scout when true
statussport_event_statusStringStatus of a match

ex. not_started, live, ended, closed

See our FAQ for a complete list of statuses and their definitions.
winner_idsport_event_statusStringUnique ID of the match winner

ex. sr:competitor:7578
Game Timeline
AttributeParent ElementTypeDescription
away_scoreeventIntegerScore for the away team after a timeline event
break_nameeventStringBrief description of a break event

ex. 1st_pause
competitoreventStringDesignation of a competitor for a timeline event

home, away
home_scoreeventIntegerScore for the home team after a timeline event
ideventIntegerUnique ID for a timeline event

ex. 1309148117
match_clockeventStringClock value for a timeline event, in minutes and seconds

ex. 3:55
match_timeeventIntegerClock value of a timeline event, in minutes

ex. 4
methodtimeline - eventStringMethod of a scored goal

ex. penalty
periodeventIntegerPeriod number of a timeline event
period_nameeventStringPeriod name of a timeline event, appearing at the beginning of a period

ex. 2nd_half
period_typetimeline - eventStringPeriod type of a timeline event

ex. regular_period
suspension_minutestimeline - eventIntegerNumber of suspension minutes charged to a player in a timeline event
timeeventDate-timeTimestamp of a timeline event

ex. 2024-04-16T20:49:49+00:00
typeeventStringType 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
updatedeventBooleanSignifies this event has been updated since its original entry when true
updated_timeeventDate-timeTimestamp of an updated time entry

ex. 2024-04-22T17:17:24+00:00
zonetimeline - eventStringType 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
AttributeParent ElementTypeDescription
idevent - scorerStringUnique player Id associated with a scoring event

ex. sr:player:2300047
nameevent - scorerStringPlayer name associated with a scoring event

ex. Grupe, Magnus
idevent - players - playerStringUnique player Id associated with a timeline event

ex. sr:player:2300047
nameevent - players - playerStringPlayer name associated with a timeline event

ex. Grupe, Magnus
idevent - assists - playerStringUnique player Id credited with an assist for a timeline event

ex. sr:player:2300047
nameevent - assists - playerStringPlayer name credited with an assist for a timeline event

ex. Grupe, Magnus
typeevent - assists / players - playerStringPlayer 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