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:
Parameter | Description |
---|---|
access_level | Defines the access level of your API key as Production (production) or Trial (trial). |
version | Version number of the API you are accessing (v3). |
your_api_key | Your 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 Parameters | Description |
---|---|
channel | Channel type expressed as: {channel_type}. Example: channel=australianrules |
competition_id | Competition Id expressed as: {competition_id}. Example: sr:competition:656 |
event_id | Event type expressed as: {event_type}. Example: event_id=score_change |
format | Format type expressed as: {format}. Example: format=json |
season_id | Season id expressed as: {season_id}. Example: season_id=sr:season:79676 |
sport_event_id | Sport event id expressed as: {sport_event_id}. Example: sport_event_id=sr:sport_event:16144572 |
sport_id | Sport 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:
Attribute | Parent Element | Type | Description |
---|---|---|---|
channel | metadata | String | Sport of the stream connection ex. aussierules |
competition_id | metadata | String | Unique Id of a competition ex. sr:competition:656 |
event_id | metadata | String | Type of timeline eventmatch_started , match_ended , score_change , period_score , period_start , break_start |
format | metadata | String | Format type of the responsejson , xml |
season_id | metadata | String | Unique Id of a season ex. sr:season:111244 |
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:1 |
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. aussierules-v3 |
Game Timeline:
Attribute | Parent Element | Type | Description |
---|---|---|---|
away_score | event | Integer | Score for the away team after a timeline event |
away_display_score | event | String | Display score for the away team after a timeline event ('Number of Goals'.'Number of Points'.'Total') ex. 5.5.35 |
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 |
home_display_score | event | String | Display score for the home team after a timeline event ('Number of Goals'.'Number of Points'.'Total') ex. 5.5.35 |
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. 80:00 |
match_time | event | Integer | Clock value of a timeline event, in minutes ex. 66 |
method | event | String | Type of score for a timeline eventgoal , behind |
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_quarter |
time | event | Date-time | Timestamp of a timeline event ex. 2024-04-16T20:49:49+00:00 |
type | event | String | Type of timeline eventmatch_started , match_ended , score_change , period_score , period_start , break_start |
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 - players | String | Unique player Id associated with a timeline event ex. sr:player:1153060 |
name | event - players | String | Player name associated with a timeline event ex. Russell, Mercedes |
type | event - players | String | Type of event associated with a player ex. scorer , assist , substituted_in , substituted_out |
Sport Event Status:
Attribute | Parent Element | Type | Description |
---|---|---|---|
away_normaltime_score | sport_event_status | Integer | Score for the away team in normal time |
away_score | sport_event_status | Integer | Total score for the away team in the game |
home_normaltime_score | sport_event_status | Integer | Score for the home team in normal time |
home_score | sport_event_status | Integer | Total score for the home team in the game |
match_status | sport_event_status | String | Status 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_abandoned | sport_event_status | Boolean | Signifies a game was abandoned by a scout when true |
status | sport_event_status | String | Status of a game ex. not_started , 2nd_half , ended , awaiting_penalties See our FAQ for a complete list of statuses and their definitions. |
winner_id | sport_event_status | String | Unique ID of the game winner ex. sr:competitor:44 |
Period Scores:
Attribute | Parent Element | Type | Description |
---|---|---|---|
away_score | sport_event_status - period_scores | Integer | Away team period score |
away_display_score | sport_event_status - period_scores | String | Away team period display score ('Number of Goals'.'Number of Points'.'Total') ex. 5.5.35 |
home_score | sport_event_status - period_scores | Integer | Home team period score |
home_display_score | sport_event_status - period_scores | String | Home team period display score ('Number of Goals'.'Number of Points'.'Total') ex. 5.5.35 |
number | sport_event_status - period_scores | Integer | Period number |
type | sport_event_status - period_scores | String | Period typeregular_period , overtime , 1st_period , 2nd_period , 3rd_period , 4th_period , 1st_pause , 2nd_pause , 3rd_pause , interrupted |