Docs
Coverage MatrixDocumentationRelease LogLog In

Push Events

NCAAFB Push Events provides detailed, real-time information on every live game event.

Syntax

https://api.sportradar.com/ncaafb/{access_level}/stream/{language_code}/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).
language_codeOptional code for supported languages: en (English).
your_api_keyYour API key.

Optional Query String Paramaters

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:

ParameterDescription
event_categoryEvent category expressed as: {event_category}.
Example: event_category=redzone
Valid event categories: redzone, two_minute, scoring_play, big_play, turnover
event_typeEvent type expressed as: {event_type}.
Example: event_type=timeout
Valid event types: setup, timeout, tv_timeout, two_minute_warning, comment, period_end, game_over
localeLocale expressed as 2 letter code: locale={language_code}
Example: locale:en
matchMatch id expressed as: sd:match:{match_id}.
Example: sd:match:0f23d300-5bec-4dc2-a7b0-1b8e05751d11
statusStatus type expressed as: inprogress or created.
Example: status=inprogress
teamTeam id expressed as: sd:team:{team_id}.
Example: sd:team:19775492-f1eb-4bc5-9e15-078ebd689c0f

Code Samples

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

url = URI("https://api.sportradar.us/ncaafb/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/ncaafb/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/ncaafb/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/ncaafb/trial/stream/en/events/subscribe?api_key={your_api_key}&status=inprogress")

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/ncaafb/trial/stream/en/events/subscribe",
    params = {'api_key': 'your_api_key', 'status': 'inprogress'},
    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/ncaafb/trial/stream/en/events/subscribe?api_key={your_api_key}&status=inprogress'

Response Sample

The above commands return json like this.



Data Points

Boxscore:
AttributeParent ElementTypeDescription
attendancegameIntegerAttendance of a game
ex. 73242
remaining_timeoutsawayIntegerAway team timeouts remaining
used_challengesawayIntegerAway team challenges used
used_timeoutsawayIntegerAway team timeouts used
pointsawayIntegerAway team total points
pointshomeIntegerHome team total points
clockgameStringClock value of the game
ex. 12:37
remaining_timeoutshomeIntegerHome team timeouts remaining
used_timeoutshomeIntegerHome team timeouts used
quartergameIntegerQuarter number of the game
idperiodGUIDUnique ID of a period
ex. 717f65f6-b44d-4ac4-9086-3810041066af
numberperiodIntegerNumber of a period
sequenceperiodIntegerSequential number of a period
idovertimeGUIDUnique ID of an overtime period
ex. 717f65f6-b44d-4ac4-9086-3810041066af
numberovertimeIntegerNumber of an overtime period
sequenceovertimeIntegerSequential number of an overtime period
Game:
AttributeParent ElementTypeDescription
aliasawayStringAway team alias
ex. MIN (Minnesota)
idawayGUIDUnique ID of the away team
ex. 768c92aa-75ff-4a43-bcc0-f2798c2e1724
marketawayStringAway team market name
ex. Minnesota
nameawayStringAway team name
ex. Vikings
durationgameStringDuration of the game
ex. 2:52
entry_modegameStringType of data entry for the game
LDE (Live Data Entry)
aliashomeStringHome team alias
ex. GB (Green Bay)
idhomeGUIDUnique ID of the home team
ex. 7b112545-38e6-483c-a55c-96cf6ee49cb8
markethomeStringHome team market name
ex. Green Bay
namehomeStringHome team name
ex. Packers
idgameGUIDUnique ID of a game
ex. 13025660-aa95-4885-b33e-3a3554d4c4c3
scheduledgameDate/TimeScheduled date and time of a game
ex. 2022-09-25T20:10:00+00:00
statusgameStringGame status
scheduled, created, inprogress, halftime, complete, closed, cancelled, postponed, delayed, suspended, flex-schedule, time-tbd

See our NCAAFB FAQ for game status descriptions
weathergameStringWeather description for a game
ex. Sunny Temp: 69 F, Humidity: 70%, Wind: WSW 9 mph
wx_conditiongameStringWeather conditions for a game
ex. Partly cloudy
wx_humiditygameByteHumidity conditions for a game
ex. 44
wx_tempgameByteTemperature of a game in Fahrenheit
ex. 57
wx_wind_directiongameStringWind direction for a game
ex. N
wx_wind_speedgameByteWind speed for a game in MPH
Metadata:
AttributeParent ElementTypeDescription
event_categorymetadataStringCategory of an event
ex. scoring_play
event_typemetadataStringType of an event
ex. pass or field_goal
leaguemetadataStringAlias of a league
ex. ncaafb
localemetadataStringLanguage code
ex. en (English)
matchmetadataGUIDUnique ID(s) of a game
ex. sd:match:42f7d659-23aa-4260-b6be-0c5f9fd0eb53,sr:match:27653180
operationmetadataStringOperation of an update
update, delete
statusmetadataStringThe status of a game
scheduled, created, inprogress, halftime, complete, closed, cancelled, postponed, delayed, flex-schedule, time-tbd
See our NCAAFB FAQ for game status descriptions
teammetadataGUIDUnique ID(s) of a team
ex. sd:team:397830a6-c9c2-4c76-bcbc-cb1cdba768f0
versionmetadataStringVersion of the API
ex. v6
Play-by-Play Details:
AttributeParent ElementTypeDescription
categorydetailsStringPlay detail category
ex. kick_off,'kick_off_return','tackle'
description-StringText description of a play
directiondetailsStringDirection of action for a play

Rush: short left, short right, short middle, deep right, deep left, deep middle, left, right, middle

Pass: backward pass, handoff, lateral, reverse, left tackle, left guard, up the middle, right guard, right tackle, right end, left end, kneels
aliasend_location'StringTeam alias of the location of the ball at the conclusion of a play
ex. MIN (Minnesota)
yardlineend_location'IntegerYardline location of the ball at the conclusion of a play
ex. 45
descriptionpenaltyStringText description of a penalty
ex. Personal Foul / Defense
resultpenaltyStringResult of a penalty
accepted, declined, offset
safetypenaltyBooleanSignifies a play ending in a safety
yardspenaltyIntegerNumber of yards penalized on the play
resultdetailsStringResult of the play
sequencedetailsIntegerSequence number of the play detail
aliasstart_location'StringTeam alias of the location of the ball at the beginning of a play
ex. MIN (Minnesota)
yardlinestart_location'IntegerYardline location of the ball at the beginning of a play
ex. 45
yardsdetailsIntegerYards gained or lost on the play
Play-by-Play Drive:
AttributeParent ElementTypeDescription
created_atdriveDate/TimeTimestamp of the start of a drive
ex. 2022-10-09T17:03:16+00:00
durationdriveStringDuration of a drive in MM:SS format
end_reasondriveStringEnd result of a drive
ex. Touchdown
first_downsdriveIntegerNumber of first downs in a drive
gaindriveIntegerNumber of yards gained in a drive
iddriveGUIDUnique ID a drive
ex. 4b4e0d76-65ed-46f2-a894-14bacb5fe909
inside_20driveBooleanSignifies a drive which ends inside the opponent's 20 yardline
penalty_yardsdriveIntegerNumber of penalty yards
play_countdriveIntegerNumber of plays in a drive
scoring_drivedriveBooleanSignifies a drive which ends in a score
sequencedriveIntegerSequential number of the drive within a game
start_reasondriveStringStart reason of a drive
updated_atdriveDate/TimeTimestamp of the last update of a drive
ex. 2022-10-09T17:11:59+00:00
Play-by-Play Ending Situation:
AttributeParent ElementTypeDescription
clockend_situationStringGame clock value at the end of a play
ex. 14:55
downend_situationIntegerDown at the end of a play
aliasend_situation-locationStringTeam alias of the location of the ball at the end of a play
ex. MIN (Minnesota)
idend_situation-locationGUIDUnique ID of a team of the team with possession at the end of a play
ex. 7b112545-38e6-483c-a55c-96cf6ee49cb8
marketend_situation-locationStringTeam market name
ex. Minnesota
nameend_situation-locationStringTeam name
ex. Gophers
yardlineend_situation-locationIntegerYardline of the ball at the end of a play
aliasend_situation-possessionStringTeam alias of the possession of the ball at the end of a play
ex. MIN (Minnesota)
idend_situation-possessionGUIDUnique ID of a team of the team with possession at the end of a play
ex. 7b112545-38e6-483c-a55c-96cf6ee49cb8
marketend_situation-possessionStringTeam market name
ex. Minnesota
nameend_situation-possessionStringTeam name
ex. Gophers
yfdend_situationIntegerYards to gain a first down at the end of a play
Play-by-Play Event:
AttributeParent ElementTypeDescription
clockeventStringClock value for an event
ex. 12:37
created_ateventDate/TimeTimestamp of the creation of an event
ex. 2022-09-20T00:54:16+00:00
description-StringText description of an event
ideventStringUnique ID of an event
ex. fd790d30-4e81-11ed-b357-5954f3d7fdac
sequenceeventDecimalSequence number of an event or play. Used to sequence events properly
ex. 1665336878436.0
typeeventStringType of an event
setup, timeout, tv_timeout, two_minute_timeout, comment, period_end, game_over
updated_ateventDate/TimeTimestamp of the last update of an event
ex. 2022-09-20T00:54:16+00:00
wall_clockeventDate/TimeTimestamp of the start of the play/event entry
ex. 2022-10-09T17:12:08+00:00
Play-by-Play Play:
AttributeParent ElementTypeDescription
away_pointseventIntegerAway points at the end of a play
clockplayStringClock value for a play
ex. 12:37
created_ateventDate/TimeTimestamp of the creation of a play
ex. 2022-09-20T00:54:16+00:00
description-StringText description of a play
fake_field_goaleventBooleanSignifies whether the a play was a fake field goal
fake_punteventBooleanSignifies whether the a play was a fake punt
home_pointseventIntegerHome points at the end of a play
idplayGUIDUnique ID of a play
play_typeeventStringType of a play
ex. pass
scoring_playeventBooleanSignifies whether a play resulted in a score
sequenceeventDecimalSequence number of an event or play. Used to sequence events properly
ex. 1665336878436.0
typeeventStringType of play
pass, rush, faircatch_kick, extra_point, conversion, free_kick, kickoff, punt, field_goal, penalty
updated_ateventDate/TimeTimestamp of the last update of a play
ex. 2022-09-20T00:54:16+00:00
wall_clockeventDate/TimeTimestamp of the start of the play/event entry
ex. 2022-10-09T17:12:08+00:00
Play-by-Play Points After:
AttributeParent ElementTypeDescription
idpoints-after-playGUIDUnique ID of a point after attempt
ex. a397a7c0-47f8-11ed-972d-8539f16b8bbf
typepoints-after-playStringType of a point after attempt
extra_point, conversion, penalty
sequencepoints-after-playDecimalSequence number of an event or play. Used to sequence events properly
ex. 1665336878436.0
Play-by-Play Quarter:
AttributeParent ElementTypeDescription
idquarterGUIDUnique ID of a quarter
ex. 47091cc4-08c2-4f83-9d8d-59c3c85e1725
numberquarterIntegerNumber of a quarter
sequencequarterIntegerSequential number of a quarter
Play-by-Play Scoring:
AttributeParent ElementTypeDescription
away_pointsscoreIntegerNumber of away team points
clockscoreBooleanClock value for a score
ex. 12:37
home_pointsscoreIntegerNumber of home team points
pointsscoreIntegerNumber of points for a score
sequencescoreIntegerSequence number of an event or play. Used to sequence events properly
ex. 1665336878436.0
Play-by-Play Starting Situation:
AttributeParent ElementTypeDescription
clockstart_situationStringClock value at the start of a play
ex. 12:37
downstart_situationIntegerDown at the start of a play
aliaslocationStringTeam alias of the location of the ball at the start of a play
ex. MIN (Minnesota)
idstart_situation-locationGUIDUnique ID of a team of the team with possession at the start of a play
ex. 33405046-04ee-4058-a950-d606f8c30852
marketstart_situation-locationStringTeam market name
ex. Minnesota
namestart_situation-locationStringTeam name
ex. Vikings
sr_idstart_situation-locationGUIDUnique Sportradar ID of the team with possession at the start of a play
ex. sr:competitor:4423
yardlinestart_situation-locationIntegerYardline of the ball at the start of a play
aliasstart_situation-possessionStringTeam alias of the possession of the ball at the start of a play
ex. MIN (Minnesota)
idstart_situation-possessionGUIDUnique ID of a team of the team with possession at the start of a play
ex. 33405046-04ee-4058-a950-d606f8c30852
marketstart_situation-possessionStringTeam market name
ex. Minnesota
namestart_situation-possessionStringTeam name
ex. Vikings
sr_idstart_situation-possessionGUIDUnique Sportradar ID of the team with possession at the start of a play
ex. sr:competitor:4423
yfdend_situationIntegerYards to gain a first down at the start of a play
Kick & Punt Block Play Statistics:
AttributeParent ElementTypeDescription
blockblockIntegerNumber kick blocks
categoryblockStringType of blocked kick
field_goal, extra_point, punt
Conversion Play Statistics:
AttributeParent ElementTypeDescription
attemptconversionIntegerNumber of conversion attempts
categoryconversionStringCategory of conversion
pass, receive, rush, turnover
completeconversionIntegerNumber of conversion completions
Defensive Play Statistics:
AttributeParent ElementTypeDescription
ast_sackdefenseIntegerNumber of assisted sacks
ast_tackledefenseIntegerNumber of assisted tackles
ast_tlostdefenseIntegerNumber of assisted tackles for a loss
blockdefenseIntegerNumber of blocked kicks/punts
categorydefenseStringCategory of defensive statistic
defense, special_team, misc
forced_fumbledefenseIntegerNumber of forced fumbles
interceptiondefenseIntegerNumber of interceptions
int_touchdowndefenseIntegerNumber of interceptions for a touchdown
int_yardsdefenseIntegerNumber of interception yards
nullifieddefenseBooleanNullified play flag
pass_defendeddefenseIntegerNumber of passes defended
primarydefenseIntegerIndicates whether the assist tackler was the primary tackler on a play

*This stat is unsupported since 2021
qb_hitdefenseIntegerNumber of hits on the quarterback
sackdefenseIntegerNumber of sacks
sack_yardsdefenseIntegerNumber of sack yards
safetydefenseIntegerNumber of safeties
tlostdefenseIntegerNumber of tackles for a loss
tlost_yardsdefenseIntegerNumber of tackles for a loss yardage
tackledefenseIntegerNumber of tackles
Defensive Conversion Play Statistics:
AttributeParent ElementTypeDescription
attemptdefense_conversionIntegerNumber of defensive conversion attempts
categorydefense_conversionStringCategory of defensive conversion
conversion, extra_point
completedefense_conversionIntegerNumber of defensive conversion completions
Down Conversion Play Statistics:
AttributeParent ElementTypeDescription
attemptdown_conversionIntegerNumber of down conversion attempts
completedown_conversionStringCategory of down conversion
conversion, extra_point
downdown_conversionIntegerNumber of the down at play start
categoryfirst_downStringType of first down
pass, rush, penalty
Extra Point Play Statistics:
AttributeParent ElementTypeDescription
attemptextra_pointIntegerNumber of attempted extra points
blockedextra_pointIntegerNumber of blocked extra points
madeextra_pointIntegerNumber of made extra points
missedextra_pointIntegerNumber of missed extra points
returnedextra_pointIntegerNumber of returned extra points
safetyextra_pointIntegerNumber of extra point safeties
Field Goal Play Statistics:
AttributeParent ElementTypeDescription
attemptfield_goalIntegerNumber of attempted field goals
att_yardsfield_goalIntegerYardage of attempted field goal
blockedfield_goalIntegerNumber of blocked field goals
madefield_goalIntegerNumber of made field goals
missedfield_goalIntegerNumber of missed field goals
nullifiedfield_goalBooleanSignifies a nullified field goal attempt
returnedfield_goalIntegerNumber of returned field goals
yardsfield_goalIntegerYardage of made field goal
Fumbles Play Statistics:
AttributeParent ElementTypeDescription
forcedfumbleIntegerNumber of forced fumbles
fumblefumbleIntegerNumber of fumbles
lostfumbleIntegerNumber of lost fumbles
nullifiedfumbleBooleanSignifies a nullified play due to a penalty
opp_recfumbleIntegerNumber of opponent fumble recoveries
opp_rec_tdfumbleIntegerNumber of opponent fumble recovery touchdowns
opp_rec_yardsfumbleIntegerNumber of opponent fumble recovery yards
out_of_boundsfumbleIntegerNumber of fumbles out of bounds
own_recfumbleIntegerNumber of own fumble recoveries
own_rec_tdfumbleIntegerNumber of own fumble recovery touchdowns
own_rec_yardsfumbleIntegerNumber of own fumble recovery yards
play_categoryfumbleStringType of fumble
ex. misc
Kickoff Play Statistics:
AttributeParent ElementTypeDescription
attemptkickIntegerNumber of kickoff attempts
endzonekickIntegerNumber of kickoffs into the endzone
inside_20kickIntegerNumber of kickoffs inside the 20 yardline
net_yardskickIntegerNumber of net yards on the kickoff
nullifiedkickBooleanSignifies a nullified play due to a penalty
touchbackkickIntegerNumber of touchbacks
yardskickIntegerNumber of kickoff yards
Passing Play Statistics:
AttributeParent ElementTypeDescription
attemptpassIntegerNumber of pass attempts
att_yardspassIntegerNumber of pass attempt (air) yards, measured from the line of scrimmage to the yardline of the receiving target
completepassIntegerNumber of pass completions
firstdownpassIntegerNumber of passing first downs
goaltogopassIntegerNumber of plays in a goal-to-go situation
inside_20passIntegerNumber of passes inside the 20 yardline
interceptionpassIntegerNumber of interceptions thrown
int_touchdownpassIntegerNumber of interception touchdowns thrown
nullifiedpassBooleanSignifies a nullified play due to a penalty
sackpassIntegerNumber of sacks
sack_yardspassIntegerNumber of sack yards
safetypassIntegerNumber of safeties
touchdownpassIntegerNumber of passing touchdowns
yardspassIntegerNumber of passing yards
Penalty Play Statistics:
AttributeParent ElementTypeDescription
penaltypenaltyIntegerNumber of penalties
yardspenaltyIntegerNumber of penalty yardage
Punting Play Statistics:
AttributeParent ElementTypeDescription
attemptpuntIntegerNumber of attempted punts
blockedpuntIntegerNumber of blocked punts
endzonepuntIntegerNumber of punts into the endzone
inside_20puntIntegerNumber of punts inside the 20 yardline
net_yardspuntIntegerNet yardage of a punt
nullifiedpuntBooleanSignifies a nullified play due to a penalty
touchbackpuntIntegerNumber of touchback punts
yardspuntIntegerYardage of punt
Receiving Play Statistics:
AttributeParent ElementTypeDescription
firstdownreceiveIntegerNumber of receiving first downs
fumblereceiveIntegerNumber of receiving fumbles
goaltogoreceiveIntegerNumber of receptions in goal-to-go
inside_20receiveIntegerNumber of receptions inside the 20 yardline
nullifiedreceiveBooleanSignifies a nullified play due to a penalty
receptionreceiveIntegerNumber of receptions
safetyreceiveIntegerNumber of receiving safeties
targetsreceiveIntegerNumber of receiving targets
touchdownreceiveIntegerNumber of receiving touchdowns
yardsreceiveIntegerNumber of receiving yards
yards_after_catchreceiveIntegerNumber of receiving yards after the catch

Yards after catch is not currently a collected statistic for NCAA Football
Return Play Statistics:
AttributeParent ElementTypeDescription
categoryreturnStringType of return
punt_return, kick_return
faircatchreturnIntegerNumber of return fair catches
nullifiedreturnBooleanSignifies a nullified play due to a penalty
returnreturnIntegerNumber of returns
touchbackreturnIntegerNumber of return touchbacks
touchdownreturnIntegerNumber of return touchdowns
yardsreturnIntegerNumber of return yardage
Rushing Play Statistics:
AttributeParent ElementTypeDescription
attemptrushIntegerNumber of rushing attempts
firstdownrushIntegerNumber of rushing first downs
fumblerushIntegerNumber of rushing fumbles
goaltogorushIntegerNumber of rushes in goal-to-go
inside_20rushIntegerNumber of rushes inside the 20 yardline
nullifiedrushBooleanSignifies a nullified play due to a penalty
safetyrushIntegerNumber of rushing safeties
tlostrushIntegerNumber of rushing tackles for a loss
tlost_yardsrushIntegerNumber of rushing tackles for a loss yardage
touchdownrushIntegerNumber of rushing touchdowns
yardsrushIntegerNumber of rushing yards
Player:
AttributeParent ElementTypeDescription
idplayerGUIDUnique ID of a player
ex. 4be48c57-4b7c-46ad-8535-445c195feda6
jerseyplayerStringJersey number of a player
nameplayerStringFull name of a player
ex. Stetson Bennett
positionplayerStringPosition of a player

See our FAQ for a list of valid positions
Team:
AttributeParent ElementTypeDescription
aliasteamStringTeam alias
ex. IOW (University of Iowa)
idteamGUIDUnique ID of a team
ex. a2ee495d-37c7-45ac-ac3d-d3a492a219c1
marketteamStringTeam market name
ex. Iowa
nameteamStringTeam name
ex. Hawkeyes