Push Events

Syntax

https://api.sportradar.com/rugby-{package}/{access_level}/stream/events/subscribe?api_key={your_api_key}

Replace placeholders with the following query parameters:

Parameter	Description
`package`	Defines the Rugby package to access as Rugby League (league), Rugby Union (union), or Rugby Sevens (sevens).
`access_level`	Defines the access level of your API key as Production (production) or Trial (trial).
`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=rugby
`competition_id`	Competition Id expressed as: {competition_id}. Example: sr:competition:421
`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:59616
`sport_event_id`	Sport event id expressed as: {sport_event_id}. Example: sport_event_id=sr:sport_event_id:16166956
`sport_id`	Sport id expressed as: {sport_id}. Example: sport_id=sr:sport:12

Code Samples

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

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

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

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. `rugby-union`
`competition_id`	`metadata`	String	Unique Id of a competition ex. `sr:competition:421`
`event_id`	`metadata`	String	Type of timeline event ex. `match_started`, `score_change`, `ball_kicked`, `turnover`, `substitution` See our FAQ for a complete list of timeline event values
`format`	`metadata`	String	Format type of the response `json`, `xml`
`season_id`	`metadata`	String	Unique Id of a season ex. `sr:season:59616`
`sport_event_id`	`metadata`	String	Unique Id of a sport event ex. `sr:sport_event_id:16166956`
`sport_id`	`metadata`	String	Unique Id of a sport ex. `sr:sport:12`
`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. `rugby-v3`

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. `pause`
`competitor`	`event`	String	Designation of a competitor for a timeline event `home`, `away`
`home_score`	`event`	Integer	Score for the home team after a timeline event
`id`	`event`	Integer	Unique ID for a timeline event ex. `1856337905`
`match_clock`	`event`	String	Clock value for a timeline event, in minutes and seconds ex. `39:41`
`match_time`	`event`	Integer	Clock value of a timeline event, in minutes ex. `40`
`method`	`event`	String	Type of score for a timeline event `try`, `penalty`, `penalty_try`, `conversion`, `drop_goal`
`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_half`
`time`	`event`	Date-time	Timestamp of a timeline event ex. `2024-09-28T15:02:11+00:00`
`type`	`event`	String	Type of timeline event ex. `match_started`, `score_change`, `ball_kicked`, `turnover`, `substitution` See our FAQ for a complete list of timeline event values
`x`	`event`	Integer	Horizontal X coordinate of a timeline event. `x` is a number between `0` and `100`.
`y`	`event`	Integer	Vertical Y coordinate of a timeline event. `y` is a number between `0` and `100`.
`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:474906`
`name`	`event` - `players`	String	Player name associated with a timeline event ex. `Gallo, Thomas`
`type`	`event` - `players`	String	Type of event associated with a player ex. `scorer`, `substituted_in`, `substituted_out`

Sport Event Status:

Attribute	Parent Element	Type	Description
`away_score`	`sport_event_status`	Integer	Total score for the away team in the match
`away_normaltime_score`	`sport_event_status`	Integer	Score for the away team in normal time
`home_score`	`sport_event_status`	Integer	Total score for the home team in the match
`home_normaltime_score`	`sport_event_status`	Integer	Score for the home team in normal time
`match_status`	`sport_event_status`	String	Status within a match (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.
`match_tie`	`sport_event_status`	Boolean	Signifies a matched ended in a tie when `true`
`scount_abandoned`	`sport_event_status`	Boolean	Signifies a sport event was abandoned by a scout when `true`
`status`	`sport_event_status`	String	Status of a sport event 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:4231`

Period Scores:

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 type ex. `1st_half`, `2nd_half`, `pause`, `1st_extra`, `2nd_extra`, `extra_time_halftime`, `awaiting_extra`, `interrupted`, `overtime`, `regular_period`