Push Events

Syntax

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

Parameters

Parameter	Description
`access_level`	Defines the access level of your API key `production`, `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=badminton`
`competition_id`	Competition Id Example: `competition_id=sr:competition:20316`
`event_id`	Event type Example: `event_id=623021635`
`format`	Format type `json`, `xml` Example: `format=json`
`season_id`	Season id Example: `season_id=sr:season:72917`
`sport_event_id`	Sport event id Example: `sport_event_id=sr:sport_event:19951590`
`sport_id`	Sport id Example: `sport_id=sr:sport:31`

Response Sample

The above commands return json like this.

Code Samples

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

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

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

Data Points

Metadata:

Attribute	Parent Element	Type	Description
`channel`	`metadata`	String	Sport of the stream connection ex. `badminton`
`competition_id`	`metadata`	String	Unique Id of a competition ex. `sr:competition:27016`
`event_id`	`metadata`	String	Description of a push timeline event ex. `point`, `period_score`, `score_change`
`format`	`metadata`	String	Format type of the response `json`, `xml`
`season_id`	`metadata`	String	Unique Id of a season ex. `sr:season:124059`
`sport_event_id`	`metadata`	String	Unique Id of a sport event ex. `sr:sport_event_id:53976867`
`sport_id`	`metadata`	String	Unique Id of a sport ex. `sr:sport:31`
`from`	`heartbeat`	Integer	Unix timestamp of the beginning of a heartbeat message ex. `1722267631`
`to`	`heartbeat`	Integer	Unix timestamp of the end of a heartbeat message ex. `1722267636`
`interval`	`heartbeat`	Integer	Interval of a heartbeat message in seconds
`type`	`heartbeat`	String	Type of heartbeat message ex. `events`
`package`	`heartbeat`	String	Package of a heartbeat message ex. `badminton-v2`

Sport Event Status:

Attribute	Parent Element	Type	Description
`away_score`	`sport_event_status`	Integer	Total score for the away competitor in a match
`home_score`	`sport_event_status`	Integer	Total score for the home competitor in a match
`match_status`	`sport_event_status`	String	Status within a match (sport event). Provides more detail on the state of a match when live than `status` ex. `not_started`, `interrupted`, `1st_set`, `walkover` See our Badminton OAS for a complete list of statuses.
`scount_abandoned`	`sport_event_status`	Boolean	Signifies a match 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:174268`
`winning_reason`	`sport_event_status`	String	Winning reason description for a match ex. `walkover`

Period Scores:

Attribute	Parent Element	Type	Description
`away_score`	`sport_event_status` - `period_scores`	Integer	Away competitor set score
`home_score`	`sport_event_status` - `period_scores`	Integer	Home competitor set score
`number`	`sport_event_status` - `period_scores`	Integer	Set number
`type`	`sport_event_status` - `period_scores`	String	Period type ex. `set`

Match Timeline:

Attribute	Parent Element	Type	Description
`away_score`	`event`	Integer	Away competitor point score
`break_name`	`event`	String	Brief description of a break event ex. `break`
`competitor`	`event`	String	Designation of a competitor for a timeline event `home`, `away`
`home_score`	`event`	Integer	Home competitor point score
`id`	`event`	Integer	Unique ID for a timeline event ex. `1811218561`
`match_clock`	`event`	String	Clock value for a timeline event, in minutes and seconds ex. `70:17`
`period`	`event`	Integer	Set number of a timeline event. Populates for each `period_score` event.
`period_name`	`event`	String	Period name of a timeline event, appearing at the beginning of a period ex. `2nd_set`
`time`	`event`	Date-time	Timestamp of a timeline event ex. `2024-04-16T20:49:49+00:00`
`type`	`event`	String	Type of timeline event ex. `match_started`, `match_ended`, `period_start`, `break_start`, `score_change`, `period_score`