NCAAMB Push Events retrieves detailed, real-time information on every game event.
Syntax
https://api.sportradar.us/ncaamb/{access_level}/stream/{language_code}/events/subscribe?api_key={your_api_key} |
Parameters
Parameter | Description |
---|---|
access_level | Defines the access level of your API keyproduction , trial |
language_code | Optional code for supported languagesen (English) |
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.
Parameter | Description |
---|---|
event_category | Event category Example: event_category=shot |
event_type | Event type Example: event_type=stoppage |
locale | Language returned expressed as a 2-letter codeen (English)Example: locale=en |
match | Match id Example: match=sd:match:d613a22d-91aa-451a-8148-fcff2a5970cc |
status | Game statusinprogress , created Example: status=inprogress |
team | Team id Example: team=sd:team:2ed86226-3fff-4083-90fa-6b02307e6f73 |
Code Samples
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.sportradar.us/ncaamb/trial/stream/en/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/ncaamb/trial/stream/en/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.us/ncaamb/trial/stream/en/events/subscribe?api_key={your_api_key}'
Samples with Query String Params
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.sportradar.us/ncaamb/trial/stream/en/events/subscribe?api_key={your_api_key}&status=inprogress&match=sd:match:d613a22d-91aa-451a-8148-fcff2a5970cc")
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/ncaamb/trial/stream/en/events/subscribe",
params = {'api_key': 'your_api_key', 'status': 'inprogress', 'match': 'sd:match:d613a22d-91aa-451a-8148-fcff2a5970cc'},
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.us/ncaamb/trial/stream/en/events/subscribe?api_key={your_api_key}&status=inprogress&match=sd:match:d613a22d-91aa-451a-8148-fcff2a5970cc'
Response Sample
The above commands return json like this.
Data Points
Game:
Attribute | Parent Element | Type | Description |
---|---|---|---|
coverage | game | String | Coverage level of a gamefull , extended_boxscore |
id | game | GUID | Unique ID of a game ex. 1f730a9a-8221-48ff-a259-ac2103fb58b0 |
status | game | String | The status of a gamescheduled , created , inprogress , halftime , complete , closed , cancelled , delayed , postponed , time-tbd , if-necessary , unnecessary Please see our FAQ section for a list of game status definitions |
title | game | String | Title of a game ex. South Regional - Elite Eight - Game 1 |
scheduled | game | dateTime | Scheduled date and time of a game ex. 2024-02-14T05:00:00Z |
away | game - time_zones | String | Time zone of the away team ex. US/Pacific |
home | game - time_zones | String | Time zone of the home team ex. US/Eastern |
venue | game - time_zones | String | Time zone of the venue ex. US/Eastern |
Metadata:
Attribute | Parent Element | Type | Description |
---|---|---|---|
event_category | metadata | String | Category of an event ex. lineupchange or shot |
event_type | metadata | String | Type of an event ex. threepointmiss or rebound |
league | metadata | String | Alias of a league ex. NCAAM |
locale | metadata | String | Language code ex. en (English) |
match | metadata | GUID | Unique ID of a game ex. sd:match:0db78438-9663-470f-b3ae-1f9106298e47 |
operation | metadata | String | Operation of an updatecreate , update , delete |
players | metadata | GUID | Unique ID(s) of players associated with an event ex. sd:player:6897db83-b25f-4c54-832a-0ff0c3cb86ff,sd:player:481ffe40-392b-4a1b-89ec-0d9453495639 |
status | metadata | String | The status of a gamescheduled , created , inprogress , halftime , complete , closed , cancelled , delayed , postponed , time-tbd , if-necessary , unnecessary Please see our FAQ section for a list of game status definitions |
team | metadata | GUID | Unique ID(s) of team(s) associated with an event ex. sd:team:bdc2561d-f603-4fab-a262-f1d2af462277 |
version | metadata | String | Version of the API ex. v7 |
Play-by-Play - Attribution & Possession:
Attribution is the team associated with the play-by-play event (i.e. the statistic associated with it). Possession is the team who currently has the possession of the ball as a result of that play-by-play event.
Attribute | Parent Element | Type | Description |
---|---|---|---|
id | event - attribution | GUID | Unique ID of a team ex. bdc2561d-f603-4fab-a262-f1d2af462277 |
market | event - attribution | String | Market name of a team ex. Michigan |
name | event - attribution | String | Team name ex. Wolverines |
team_basket | event - attribution | String | The basket the offensive team is shooting at in the arena. Direction is based on the TV broadcast's perspective.left , right |
id | event - possession | GUID | Unique ID of a team ex. bdc2561d-f603-4fab-a262-f1d2af462277 |
market | event - possession | String | Market name of a team ex. Michigan |
name | event - possession | String | Team name ex. Wolverines |
Play-by-Play - Home/Away Teams:
Attribute | Parent Element | Type | Description |
---|---|---|---|
bonus | game - away | Boolean | Signifies the away team is in the bonus (available for full coverage games only) |
double_bonus | game - away | Boolean | Signifies the away team is in the double bonus (available for full coverage games only) |
points | game - away | Integer | Total points for the away team |
id | game - away | GUID | Unique ID of the away team ex. bdc2561d-f603-4fab-a262-f1d2af462277 |
market | game - away | String | Market name of the away team ex. Michigan |
name | game - away | String | Away team name ex. Wolverines |
remaining_timeouts | game - away | Integer | Remaining timeouts for the away team |
bonus | game - home | Boolean | Signifies the home team is in the bonus (available for full coverage games only) |
double_bonus | game - home | Boolean | Signifies the home team is in the double bonus (available for full coverage games only) |
points | game - home | Integer | Total points for the home team |
id | game - home | GUID | Unique ID of the home team ex. bdc2561d-f603-4fab-a262-f1d2af462277 |
market | game - home | String | Market name of the home team ex. Michigan |
name | game - home | String | Home team name ex. Wolverines |
remaining_timeouts | game - home | Integer | Remaining timeouts for the home team |
Play-by-Play - Event:
Attribute | Parent Element | Type | Description |
---|---|---|---|
clock_decimal | event | String | Clock value in decimal form when the game clock is under 1:00. Otherwise it displays the same value as clock ex. 00:21.70 |
created | event | dateTime | Timestamp of the creation of an event ex. 2024-02-14T05:00:00Z |
attempt | event | String | Text description of a free throw attempt ex. 1 of 2 or 2 of 2 |
away_points | event | Integer | Total points for the away team after an event |
clock | event | String | Clock value of an event ex. 12:37 |
description | event | String | Text description of an event ex. Hunter Dickinson makes two point jump shot (Isaiah Livers assists) |
event_type | event | String | Type of event ex. turnover or rebound See our FAQ for a complete list of types |
home_points | event | Integer | Total points for the home team after an event |
id | event | GUID | Unique ID of an event ex. a2b43bd2-1b79-4823-b76c-21a09eb1adea |
action_area | event - location | String | Action area of an eventunderbasket , inthepaint , insiderightwing , insideright , insidecenter , insideleft , insideleftwing , outsideright , outsidecenter , outsideleft , outsideleftwing , backcourt |
coord_x | event - location | Integer | X coordinate of an event. The court we use is 1128 by 600; the scale is in inches. |
coord_y | event - location | Integer | Y coordinate of an event. The court we use is 1128 by 600; the scale is in inches. |
sequence | event | Integer | UNIX timestamp of the wall clock value. Use this value to help sequence play-by-play events (smallest to largest sequence number}. ex. 1678835426293 |
turnover_type | event | String | Type of turnover ex. Traveling or Lane Violation |
created | event | dateTime | Timestamp of the creation of an event ex. 2024-02-14T05:00:00Z |
updated | event | dateTime | Timestamp of the last update to an event ex. 2024-02-14T05:00:00Z |
wall_clock | event | dateTime | Timestamp in UTC when the on-venue statistician began entry of a play-by-play event. ex. 2024-02-14T05:00:00Z |
Play-by-Play - Play Participants & Stats:
Attribute | Parent Element | Type | Description |
---|---|---|---|
id | event - statistics - team | GUID | Unique ID of a team ex. bdc2561d-f603-4fab-a262-f1d2af462277 |
market | event - statistics - team | String | Market name of a team ex. Michigan |
name | event - statistics - team | String | Team name ex. Wolverines |
full_name | event - statistics - player | String | Full name of a player ex. Stephen Curry |
id | event - statistics - player | GUID | Unique player ID ex. 8ec91366-faea-4196-bbfd-b8fab7434795 |
jersey_number | event - statistics - player | Integer | Number of a player's jersey |
made | event - statistics | Boolean | Signifies a made basket |
points | event - statistics | Integer | Number of points scored for an event |
rebound_type | event - statistics - rebound | String | Rebound typedefensive , offensive |
shot_distance | event - statistics | Decimal | Shot distance in feet from the basket ex. 2.37 |
shot_type | event - statistics | String | Shot typejump shot , layup , dunk , hook , tip |
shot_type_desc | event - statistics | String | Text description of a shot type ex. driving or alley-oop See our FAQ for a complete list of descriptions |
three_point_shot | event - statistics | Boolean | Signifies a 3-point attempt |
made | event - statistics - freethrow | Boolean | Signifies a made free throw |
free_throw_type | event - statistics - freethrow | String | Type of free throw ex. regular , technical , flagrant , clear path |
Play-by-Play - On Court Participants:
On Court Participants is available for full coverage games only
Attribute | Parent Element | Type | Description |
---|---|---|---|
full_name | event - on_court - home / away - players | String | Full name of a player ex. Isaiah Livers |
id | event - on_court - home / away - players | GUID | Unique player ID ex. 34736ed7-c86a-472c-8c1c-683002de6487 |
jersey_number | event - on_court - home / away - players | Integer | Number of a player's jersey |
id | event - on_court - home / away | GUID | Unique ID of a team ex. bdc2561d-f603-4fab-a262-f1d2af462277 |
market | event - on_court - home / away | String | Market name of a team ex. Michigan |
name | event - on_court - home / away | String | Team name ex. Wolverines |
Half:
Attribute | Parent Element | Type | Description |
---|---|---|---|
id | period | GUID | Unique ID of a half ex. 1f18ca8c-6a96-43f7-b68c-4d1b333e059c |
number | period | Integer | Number of a half |
sequence | period | Integer | Sequential number of a half |
type | period | GUID | Type of period ex. half |
Player:
Attribute | Parent Element | Type | Description |
---|---|---|---|
full_name | player | String | Full name of a player ex. Isaiah Livers |
id | player | GUID | Unique player ID ex. 34736ed7-c86a-472c-8c1c-683002de6487 |
jersey_number | player | Integer | Number of a player's jersey |
Team:
Attribute | Parent Element | Type | Description |
---|---|---|---|
id | team | GUID | Unique ID of a team ex. bdc2561d-f603-4fab-a262-f1d2af462277 |
market | team | String | Market name of a team ex. Michigan |
name | team | String | Team name ex. Wolverines |