Docs
Coverage MatrixDocumentationChange LogLog InContact Us
Docs

Provides real-time event updates for all live matches.

Syntax

https://api.sportradar.com/australianrules/{access_level}/{version}/stream/events/subscribe?api_key={your_api_key}

Replace placeholders with the following query parameters:

ParameterDescription
access_levelDefines the access level of your API key as Production (production) or Trial (trial).
versionVersion number of the API you are accessing (v3).
your_api_keyYour API key.

Optional Query String Parameters

In addition to the URL parameters listed above, you can filter the Events information with one or more of the following optional query string parameters.

📘

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.

Replace placeholders with the following query parameters:

URL ParametersDescription
channelChannel type expressed as: {channel_type}.
Example: channel=australianrules
competition_idCompetition Id expressed as: {competition_id}.
Example: sr:competition:656
event_idEvent type expressed as: {event_type}.
Example: event_id=score_change
formatFormat type expressed as: {format}.
Example: format=json
season_idSeason id expressed as: {season_id}.
Example: season_id=sr:season:79676
sport_event_idSport event id expressed as: {sport_event_id}.
Example: sport_event_id=sr:sport_event:16144572
sport_idSport id expressed as: {sport_id}.
Example: sport_id=sr:sport:13


Code Samples

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.sportradar.com/australianrules/trial/v3/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/australianrules/trial/v3/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/australianrules/trial/v3/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/australianrules/trial/v3/stream/events/subscribe?api_key={your_api_key}&format=json&sport_event_id=sr:sport_event:16144572")

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/australianrules/trial/v3/stream/events/subscribe",
    params = {'api_key': 'your_api_key', 'format': 'json', 'sport_event_id': 'sr:sport_event:16144572'},
    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/australianrules/trial/v3/stream/events/subscribe?api_key={your_api_key}&format=json&sport_event_id=sr:sport_event:16144572'


Response Sample

The above commands return json like this.



Data Points

Metadata:
AttributeParent ElementTypeDescription
channelmetadataStringSport of the stream connection
ex. aussierules
competition_idmetadataStringUnique Id of a competition
ex. sr:competition:656
event_idmetadataStringType of timeline event
match_started, match_ended, score_change, period_score, period_start, break_start
formatmetadataStringFormat type of the response
json, xml
season_idmetadataStringUnique Id of a season
ex. sr:season:111244
sport_event_idmetadataStringUnique Id of a sport event
ex. sr:sport_event_id:49324739
sport_idmetadataStringUnique Id of a sport
ex. sr:sport:1
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. aussierules-v3
Game Timeline:
AttributeParent ElementTypeDescription
away_scoreeventIntegerScore for the away team after a timeline event
away_display_scoreeventStringDisplay score for the away team after a timeline event ('Number of Goals'.'Number of Points'.'Total')
ex. 5.5.35
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
home_display_scoreeventStringDisplay score for the home team after a timeline event ('Number of Goals'.'Number of Points'.'Total')
ex. 5.5.35
ideventIntegerUnique ID for a timeline event
ex. 1721786685
match_clockeventStringClock value for a timeline event, in minutes and seconds
ex. 80:00
match_timeeventIntegerClock value of a timeline event, in minutes
ex. 66
methodeventStringType of score for a timeline event
goal, behind
periodeventIntegerPeriod number of a timeline event
period_nameeventStringPeriod name of a timeline event, appearing at the beginning of a period
ex. 2nd_quarter
timeeventDate-timeTimestamp of a timeline event
ex. 2024-04-16T20:49:49+00:00
typeeventStringType of timeline event
match_started, match_ended, score_change, period_score, period_start, break_start
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
Player Event Details:
AttributeParent ElementTypeDescription
idevent - playersStringUnique player Id associated with a timeline event
ex. sr:player:1153060
nameevent - playersStringPlayer name associated with a timeline event
ex. Russell, Mercedes
typeevent - playersStringType of event associated with a player
ex. scorer, assist, substituted_in, substituted_out
Sport Event Status:
AttributeParent ElementTypeDescription
away_normaltime_scoresport_event_statusIntegerScore for the away team in normal time
away_scoresport_event_statusIntegerTotal score for the away team in the game
home_normaltime_scoresport_event_statusIntegerScore for the home team in normal time
home_scoresport_event_statusIntegerTotal score for the home team in the game
match_statussport_event_statusStringStatus within a game (sport event). Provides more detail on the state of a sport event when live than status
ex. not_started, 1st_quarter, ended, cancelled

See our FAQ for a complete list of statuses and their definitions.
scount_abandonedsport_event_statusBooleanSignifies a game was abandoned by a scout when true
statussport_event_statusStringStatus of a game
ex. not_started, 2nd_half, ended, awaiting_penalties

See our FAQ for a complete list of statuses and their definitions.
winner_idsport_event_statusStringUnique ID of the game winner
ex. sr:competitor:44
Period Scores:
AttributeParent ElementTypeDescription
away_scoresport_event_status - period_scoresIntegerAway team period score
away_display_scoresport_event_status - period_scoresStringAway team period display score ('Number of Goals'.'Number of Points'.'Total')
ex. 5.5.35
home_scoresport_event_status - period_scoresIntegerHome team period score
home_display_scoresport_event_status - period_scoresStringHome team period display score ('Number of Goals'.'Number of Points'.'Total')
ex. 5.5.35
numbersport_event_status - period_scoresIntegerPeriod number
typesport_event_status - period_scoresStringPeriod type
regular_period, overtime, 1st_period, 2nd_period, 3rd_period, 4th_period, 1st_pause, 2nd_pause, 3rd_pause, interrupted