Docs
Coverage MatrixDocumentationRelease LogLog In

Push Pulse

NFL Push Pulse provides real-time messages about on-field activity before, during, and after a play.

Messages will include: players approaching the line of scrimmage, ball snap (play start), end of play, game clock status (start and stop), play event outcome, and updated game state info (possession, down, distance, and location).

πŸ”

Access

Our NFL Push Pulse feed is available exclusively for Realtime plans with Pulse enabled. Reach out to our sales team for more information.

Syntax

https://api.sportradar.com/nfl/official/{access_level}/stream/{language_code}/pulse/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) or translations (Any other language translations. See optional query string parameters for locale.)
your_api_keyYour API key.

Optional Query String Parameters

In addition to the URL parameters listed above, you can filter the Pulse 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=pass
localeLocale expressed as 2 letter code: locale={language_code}
Example: locale=en
matchMatch id expressed as: sd:match:{match_id}.
Example: sd:match:489b0cb2-117a-4118-98cc-1992ffbb056e
statusStatus type expressed as: inprogress or created.
Example: status=inprogress
teamTeam id expressed as: sd:team:{team_id}.
Example: team_id=sd:team:4415b0a7-0f24-11e2-8525-18a905767e44

Code Samples

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

url = URI("https://api.sportradar.us/nfl/official/trial/stream/en/pulse/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/nfl/official/trial/stream/en/pulse/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/nfl/official/trial/stream/en/pulse/subscribe?api_key={your_api_key}'

Samples with Query String Params

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

url = URI("https://api.sportradar.us/nfl/official/trial/stream/en/pulse/subscribe?api_key={your_api_key}&status=inprogress&match=sd:match:489b0cb2-117a-4118-98cc-1992ffbb056e")

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/nfl/official/trial/stream/en/pulse/subscribe",
    params = {'api_key': 'your_api_key', 'status': 'inprogress', 'match': 'sd:match:489b0cb2-117a-4118-98cc-1992ffbb056e'},
    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/nfl/official/trial/stream/en/pulse/subscribe?api_key={your_api_key}&status=inprogress&match=sd:match:489b0cb2-117a-4118-98cc-1992ffbb056e'

Response Sample

The above commands return json like this.

Full Game Sample

Click here for Push samples (Events, Pulse, Statistics) of a complete game.



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
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
sr_idawayStringUnique Sportradar ID of the away team
ex. sr:competitor:4376
durationgameStringDuration of the game
ex. 2:52
entry_modegameStringType of data entry for the game
LDE (Live Data Entry)
game_typegameStringType of game
regular, playoff
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
sr_idhomeStringUnique Sportradar ID of the home team
ex. sr:competitor:4391
idgameGUIDUnique ID of a game
ex. 13025660-aa95-4885-b33e-3a3554d4c4c3
numbergameIntegerGame number
scheduledgameDate/TimeScheduled date and time of a game
ex. 2022-09-25T20:10:00+00:00
sr_idgameStringUnique Sportradar ID of a game
ex. sr:match:33623305
statusgameStringGame status
scheduled, created, inprogress, complete, closed, cancelled, delayed, suspended, postponed, time-tbd, if necessary, unnecessary

See our NFL 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. pulse, pass or field_goal
leaguemetadataStringAlias of a league
ex. nfl
localemetadataStringLanguage code
ex. en (English)
matchmetadataGUIDUnique ID(s) of a game
ex. sd:match:1a57777c-7c57-43fa-bf08-66bffc204fd1,sr:match:33623353
operationmetadataStringOperation of an update
update, delete
statusmetadataStringThe status of a game
scheduled, inprogress, complete, closed, wdelay, fdelay, odelay, canceled, unnecessary, if-necessary, postponed, suspended, maintenance
teammetadataGUIDUnique ID(s) of a team
ex. sd:team:1f6dcffb-9823-43cd-9ff4-e7a8466749b5,sr:competitor:4429
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
first_touchdetailsStringIndicates the yard line where the ball was first touched, after the fumble, but before the ball was recovered (ingested games only)
no_attemptdetailsStringIndicates if the player should receive a statistical attempt for the process. Generally used on laterals (ingested games only)
onsidedetailsStringSignifies an onside kick
descriptionpenaltyStringText description of a penalty
no_playpenaltyStringSignifies a nullified play due to a penalty
resultpenaltyStringResult of a penalty
accepted, declined, offset
safetypenaltyBooleanSignifies a play ending in a safety
yardspenaltyIntegerNumber of yards penalized on the play
reason_misseddetailsStringIndicates how the kicker missed a field goal attempt: Blocked, Hit Crossbar, Hit Left Upright, Hit Right Upright, Short, Wide Left, Wide Right

(ingested games only)
resultdetailsStringResult of the play
sack_splitdetailsStringIndicates if the sack was split by the two defenders (ingested games only)
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
See our FAQ for a list of valid end reasons and their definitions
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. Vikings
sr_idend_situation - locationGUIDUnique Sportradar ID of the team with possession at the end of a play
ex. sr:competitor:4423
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. Vikings
sr_idend_situation - possessionGUIDUnique Sportradar ID of the team with possession at the end of a play
ex. sr:competitor:4423
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
Play-by-Play Play:
AttributeParent ElementTypeDescription
away_pointsplayIntegerAway points at the end of a play
blitzplayBooleanSignifies whether the defense blitzed on a play
clockplayStringClock value for a play
ex. 12:37
created_atplayDate/TimeTimestamp of the creation of a play
ex. 2022-09-20T00:54:16+00:00
description-StringText description of a play
fake_field_goalplayBooleanSignifies whether the a play was a fake field goal
fake_puntplayBooleanSignifies whether the a play was a fake punt
hash_markplayStringThe hash mark of the ball at the beginning of a play
Right Hash, Left Hash
home_pointsplayIntegerHome points at the end of a play
huddleplayStringSignifies whether there was a huddle prior to a play
idplayGUIDUnique ID of a play
left_tightendsplayIntegerNumber of tight ends lined up on the left side for a play
men_in_boxplayIntegerNumber of defensive men in the box for a play
pass_routeplayStringType of pass route on a passing play
play_actionplayBooleanSignifies whether there was a play action for a play
play_directionplayStringDirection 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
players_rushedplayIntegerNumber of defensive players rushing for a play
pocket_locationplayStringLocation of the quarterback pocket for a play
Scramble Left, Scramble Right, Boot Left, Boot Right, Rollout Left, Rollout Right, Middle
qb_at_snapplayStringLocation of the quarterback at the snap for a play
Shotgun, Under Center, Pistol
right_tightendsplayIntegerNumber of tight ends lined up on the right side for a play
run_pass_optionplayBooleanSignifies whether a play is a run/pass option
running_laneplayIntegerSignifies which hole the running back ran through on a rush play (1-8)
scoring_playplayBooleanSignifies whether a play resulted in a score
screen_passplayBooleanSignifies whether a play is a screen pass
sequenceplayDecimalSequence number of an event or play. Used to sequence events properly
ex. 1665336878436.0
typeplayStringType of play
pass, rush, faircatch_kick, extra_point, conversion, free_kick, kickoff, punt, field_goal, penalty
updated_atplayDate/TimeTimestamp of the last update of a play
ex. 2022-09-20T00:54:16+00:00
wall_clockplayDate/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
safetyconversionIntegerNumber of conversion safeties
Defensive Play Statistics:
AttributeParent ElementTypeDescription
ast_sackdefenseIntegerNumber of assisted sacks
ast_tackledefenseIntegerNumber of assisted tackles
ast_tlostdefenseIntegerNumber of assisted tackles for a loss
batted_passdefenseIntegerNumber of batted passes
blitzdefenseIntegerNumber of blitzes
blockdefenseIntegerNumber of blocked kicks/punts
categorydefenseStringCategory of defensive statistic
defense, special_team, misc
def_compdefenseStringNumber of completed passes with a defensive player covering on the play
def_targetdefenseIntegerNumber of defensive targets
forced_fumbledefenseIntegerNumber of forced fumbles
hurrydefenseIntegerNumber of hurries
interceptiondefenseIntegerNumber of interceptions
int_touchdowndefenseIntegerNumber of interceptions for a touchdown
int_yardsdefenseIntegerNumber of interception yards
knockdowndefenseIntegerNumber of knockdowns
missed_tackledefenseIntegerNumber of missed tackles
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
abortedextra_pointIntegerNumber of aborted extra points
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
onside_attemptkickIntegerNumber of onside kickoff attempts
onside_successkickIntegerNumber of onside kickoff successes
own_reckickIntegerNumber of own recoveries on a kickoff
own_rec_tdkickIntegerNumber of own recovery touchdowns on a kickoff
squib_kickkickIntegerNumber of squib kicks
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
batted_passpassIntegerNumber of batted pass attempts
blitzpassIntegerNumber of blitzes
completepassIntegerNumber of pass completions
firstdownpassIntegerNumber of passing first downs
goaltogopassIntegerNumber of plays in a goal-to-go situation
hurrypassIntegerNumber of pass hurries
incompletion_typepassStringType of incomplete pass
Thrown Away, Pass Defended, Dropped Pass, Spike, Poorly Thrown
inside_20passIntegerNumber of passes inside the 20 yardline
interceptionpassIntegerNumber of interceptions thrown
int_touchdownpassIntegerNumber of interception touchdowns thrown
knockdownpassIntegerNumber of knockdowns
nullifiedpassBooleanSignifies a nullified play due to a penalty
on_target_throwpassIntegerNumber of on target throws
pocket_timepassDoubleTime spent in the pocket
ex. 1.153
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
downedpuntIntegerNumber of downed punts
endzonepuntIntegerNumber of punts into the endzone
faircatchpuntIntegerNumber of fair catch punts
hang_timepuntDoubleHang time of a punt in seconds ex.3.166
inside_20puntIntegerNumber of punts inside the 20 yardline
net_yardspuntIntegerNet yardage of a punt
nullifiedpuntBooleanSignifies a nullified play due to a penalty
out_of_boundspuntIntegerNumber of punts out of bounds
touchbackpuntIntegerNumber of touchback punts
yardspuntIntegerYardage of punt
Receiving Play Statistics:
AttributeParent ElementTypeDescription
broken_tacklesreceiveIntegerNumber of receiving broken tackles
catchablereceiveIntegerNumber of receiving catchable passes
droppedreceiveIntegerNumber of receiving drops
firstdownreceiveIntegerNumber of receiving first downs
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_contactreceiveIntegerNumber of receiving yards after contact
Return Play Statistics:
AttributeParent ElementTypeDescription
categoryreturnStringType of return
punt_return, kick_return
downedreturnIntegerNumber of returns downed
faircatchreturnIntegerNumber of return fair catches
firstdownreturnIntegerNumber of return first downs
lateralreturnIntegerNumber of return laterals
nullifiedreturnBooleanSignifies a nullified play due to a penalty
out_of_boundsreturnIntegerNumber of returns out of bounds
play_categoryreturnStringType of return play
punt_return, kick_return
returnreturnIntegerNumber of returns
touchbackreturnIntegerNumber of return touchbacks
touchdownreturnIntegerNumber of return touchdowns
yardsreturnIntegerNumber of return yardage
Rushing Play Statistics:
AttributeParent ElementTypeDescription
attemptrushIntegerNumber of rushing attempts
broken_tacklesrushIntegerNumber of rushing broken tackles
firstdownrushIntegerNumber of rushing first downs
goaltogorushIntegerNumber of rushes in goal-to-go
inside_20rushIntegerNumber of rushes inside the 20 yardline
kneel_downrushIntegerNumber of rushing kneel downs
lateralrushIntegerNumber of rushing laterals
nullifiedrushBooleanSignifies a nullified play due to a penalty
safetyrushIntegerNumber of rushing safeties
scramblerushIntegerNumber of rushing scrambles
tlostrushIntegerNumber of rushing tackles for a loss
tlost_yardsrushIntegerNumber of rushing tackles for a loss yardage
touchdownrushIntegerNumber of rushing touchdowns
yardsrushIntegerNumber of rushing yards
yards_after_contactrushIntegerNumber of rushing yards after contact
Play Pulse:
AttributeParent ElementTypeDescription
away_pointspulseIntegerAway points at the end of a pulse update
clockpulseStringClock value for a pulse update
ex. 12:37
descriptionpulseStringDescription of a pulse update
ex. Time started. or Players Lining Up.
downpulseIntegerDown associated with a pulse update
event_typepulseStringType of event associated with a pulse update. See our NFL FAQ for a full list of valid events
ex. players_lining_up
idpulseGUIDUnique ID of a pulse update
ex. 7ac3e820-2017-11ee-b805-31ec1e396dc4
play_idpulseGUIDUnique ID of a play
ex. 0557c980-2017-11ee-b805-31ec1e396dc4
sourcepulseStringSource of data for a pulse update
ex. SRUS (Sportradar US Data Entry)
typepulseStringType of a pulse update
ex. event
wall_clockpulseStringTimestamp value of when the ball was snapped from the previous play. Updated once the event message is sent for the play.
ex. 2023-07-11T18:20:48+00:00
yfdpulseIntegerYards to a first down for a pulse update
created_atpulseStringTimestamp value of when the pulse message was created
ex. 2023-07-11T18:20:58+00:00
updated_atpulseStringTimestamp value of when the pulse message was last updated
ex 2023-07-11T18:20:58+00:00
Play Pulse - Details:
AttributeParent ElementTypeDescription
categorypulse - detailsStringCategory of a pulse details payload
ex. pass_completion, pass_reception, or third_down_conversion
conversion_typepulse - detailsStringType of conversion
ex. two_point_rush, two_point_pass, kneel, defensive_conversion_fumble_recovery, defensive_conversion_interception_recovery
penalty_typepulse - detailsStringType of penaly associated with a pulse update
ex. regular or no_play
idpulse - details - playersGUIDUnique player ID of a player associated with a pulse update
ex. 659bcb6d-877d-49af-8cd3-2f5f40ea4200
jerseypulse - details - playersStringJersey number of a player associated with a pulse update
namepulse - details - playersStringName of a player associated with a pulse update
ex. Jalen Hurts
namepulse - details - playersStringPosition of a player associated with a pulse update
ex. QB
sr_idpulse - details - playersGUIDUnique Sportradar player ID of a player associated with a pulse update
ex. sr:player:2040065
resultpulse - detailsStringResult of a pulse details message. See our [NFL FAQ]https://developer.sportradar.com/football/reference/nfl-faq#what-are-the-play-results-detailsresult-or-pulsedetailsresult-i-can-expect-to-see-returned-in-push-events-and-push-pulse for a complete list of valid result values.
ex. pushed out of bounds, pass or tackled
review_typepulse - detailsStringType of video review
ex. runner broke the plane or pass completion
yardspulse - detailsIntegerNumber of yards enforced on a penalty.
Play Pulse - Start/End Location:
AttributeParent ElementTypeDescription
aliaspulse - details - end_locationStringTeam alias of the location of the ball at the conclusion of a pulse update
ex. PHI (Philadelphia)
idpulse - details - end_locationGUIDUnique team ID of the location of the ball at the conclusion of a pulse update
ex. d5c76f6f-3e6d-4ea3-856c-34f28fe0665d
marketpulse - details - end_locationStringTeam market name of the location of the ball at the conclusion of a pulse update
ex. Philadelphia
namepulse - details - end_locationStringTeam name of the location of the ball at the conclusion of a pulse update
ex. Eagles
sr_idpulse - details - end_locationGUIDUnique Sportradar team ID of the location of the ball at the conclusion of a pulse update
ex. sr:competitor:4428
yardlinepulse - details - end_locationIntegerYardline of the location of the ball at the conclusion of a pulse update
ex. 42
aliaspulse - details - start_locationStringTeam alias of the location of the ball at the start of a pulse update
ex. PHI (Philadelphia)
idpulse - details - start_locationGUIDUnique team ID of the location of the ball at the start of a pulse update
ex. d5c76f6f-3e6d-4ea3-856c-34f28fe0665d
marketpulse - details - start_locationStringTeam market name of the location of the ball at the start of a pulse update
ex. Philadelphia
namepulse - details - start_locationStringTeam name of the location of the ball at the start of a pulse update
ex. Eagles
sr_idpulse - details - start_locationGUIDUnique Sportradar team ID of the location of the ball at the start of a pulse update
ex. sr:competitor:4428
yardlinepulse - details - start_locationIntegerYardline of the location of the ball at the start of a pulse update
ex. 42
Play Pulse - End Situtation:
AttributeParent ElementTypeDescription
clockpulse - end_situtationStringGame clock value at the end of a pulse update
ex. 14:55
downpulse - end_situtationIntegerDown at the end of a pulse update
aliaspulse - end_situtation - locationStringTeam alias of the location of the ball at the end of a pulse update
ex. PHI (Philadelphia)
idpulse - end_situtation - locationGUIDUnique team ID of the location of the ball at the end of a pulse update
ex. d5c76f6f-3e6d-4ea3-856c-34f28fe0665d
marketpulse - end_situtation - locationStringTeam market name of the location of the ball at the end of a pulse update
ex. Philadelphia
namepulse - end_situtation - locationStringTeam name of the location of the ball at the end of a pulse update
ex. Eagles
sr_idpulse - end_situtation - locationGUIDUnique Sportradar team ID of the location of the ball at the end of a pulse update
ex. sr:competitor:4428
yardlinepulse - end_situtation - locationIntegerYardline of the location of the ball at the end of a pulse update
ex. 42
play_countpulse - end_situtation - locationIntegerPlay number within a drive at the end of a pulse update
aliaspulse - end_situtation - possessionStringTeam alias of the team with the ball at the end of a pulse update
ex. PHI (Philadelphia)
idpulse - end_situtation - possessionGUIDUnique team ID of the team with the ball at the end of a pulse update
ex. d5c76f6f-3e6d-4ea3-856c-34f28fe0665d
marketpulse - end_situtation - possessionStringTeam market name of team with the ball at the end of a pulse update
ex. Philadelphia
namepulse - end_situtation - possessionStringTeam name of the team with the ball at the end of a pulse update
ex. Eagles
sr_idpulse - end_situtation - possessionGUIDUnique Sportradar team ID of the team with the ball at the end of a pulse update
ex. sr:competitor:4428
yfdpulse - end_situtationIntegerYards to a first down at the end of a pulse update
Play Pulse - Event Context:
AttributeParent ElementTypeDescription
idpulse - event_contextGUIDReference to the Pulse message ID that has been deleted. Used when event_type="delete"
ex. b5b12980-2016-11ee-b805-31ec1e396dc4
play_idpulse - event_contextGUIDUnique ID of a play
ex. 0557c980-2017-11ee-b805-31ec1e396dc4
outcomepulse - event_contextStringDescription of an outcome of a pulse event
ex. time_stopped or time_started
secondspulse - event_contextIntegerNumber representing the amount of time (in seconds) adjusted to the game time
ex. -2
aliaspulse - event_context - teamStringTeam alias of a pulse update
ex. PHI (Philadelphia)
idpulse - event_context - teamGUIDUnique team ID of a pulse update
ex. d5c76f6f-3e6d-4ea3-856c-34f28fe0665d
marketpulse - event_context - teamStringTeam market name of a pulse update
ex. Philadelphia
namepulse - event_context - teamStringTeam name of a pulse update
ex. Eagles
sr_idpulse - event_context - teamGUIDUnique Sportradar team ID of a pulse update
ex. sr:competitor:4428
Play Pulse - Location & Possession:
AttributeParent ElementTypeDescription
aliaspulse - locationStringTeam alias of the location of the ball for a pulse update
ex. PHI (Philadelphia)
idpulse - locationGUIDUnique team ID of the location of the ball for a pulse update
ex. d5c76f6f-3e6d-4ea3-856c-34f28fe0665d
marketpulse - locationStringTeam market name of the location of the ball for a pulse update
ex. Philadelphia
namepulse - locationStringTeam name of the location of the ball for a pulse update
ex. Eagles
sr_idpulse - locationGUIDUnique Sportradar team ID of the location of the ball for a pulse update
ex. sr:competitor:4428
yardlinepulse - locationIntegerYardline of the location of the ball for a pulse update
ex. 42
aliaspulse - possessionStringTeam alias of the team with the ball for a pulse update
ex. PHI (Philadelphia)
idpulse - possessionGUIDUnique team ID of the team with the ball for a pulse update
ex. d5c76f6f-3e6d-4ea3-856c-34f28fe0665d
marketpulse - possessionStringTeam market name of the team with the ball for a pulse update
ex. Philadelphia
namepulse - possessionStringTeam name of the team with the ball for a pulse update
ex. Eagles
sr_idpulse - possessionGUIDUnique Sportradar team ID of the team with the ball for a pulse update
ex. sr:competitor:4428
Play Pulse - Game Clock & Period:
AttributeParent ElementTypeDescription
runningpulse - game_clockBooleanSignifies the game clock is running when 'true'
timepulse - game_clockStringGame clock at the time of a pulse update
ex. 5:00
idpulse - periodGUIDUnique team ID of a period/quarter for a pulse update
ex. b6e771d6-ee48-420e-a524-e4740b07d3f0
numberpulse - periodIntegerPeriod/quarter number for a pulse update
ex. b6e771d6-ee48-420e-a524-e4740b07d3f0
sequencepulse - periodIntegerPeriod/quarter sequence number for a pulse update (The first overtime sequence would be 5)
ex. b6e771d6-ee48-420e-a524-e4740b07d3f0
Play Pulse - Start Situation:
AttributeParent ElementTypeDescription
clockpulse - start_situtationStringGame clock value at the start of a pulse update
ex. 14:55
downpulse - start_situtationIntegerDown at the start of a pulse update
aliaspulse - start_situtation - locationStringTeam alias of the location of the ball at the start of a pulse update
ex. PHI (Philadelphia)
idpulse - start_situtation - locationGUIDUnique team ID of the location of the ball at the start of a pulse update
ex. d5c76f6f-3e6d-4ea3-856c-34f28fe0665d
marketpulse - start_situtation - locationStringTeam market name of the location of the ball at the start of a pulse update
ex. Philadelphia
namepulse - start_situtation - locationStringTeam name of the location of the ball at the start of a pulse update
ex. Eagles
sr_idpulse - start_situtation - locationGUIDUnique Sportradar team ID of the location of the ball at the start of a pulse update
ex. sr:competitor:4428
yardlinepulse - start_situtation - locationIntegerYardline of the location of the ball at the start of a pulse update
ex. 42
play_countpulse - start_situtation - locationIntegerPlay number within a drive at the start of a pulse update
aliaspulse - start_situtation - possessionStringTeam alias of the team with the ball at the start of a pulse update
ex. PHI (Philadelphia)
idpulse - start_situtation - possessionGUIDUnique team ID of the team with the ball at the start of a pulse update
ex. d5c76f6f-3e6d-4ea3-856c-34f28fe0665d
marketpulse - start_situtation - possessionStringTeam market name of team with the ball at the start of a pulse update
ex. Philadelphia
namepulse - start_situtation - possessionStringTeam name of the team with the ball at the start of a pulse update
ex. Eagles
sr_idpulse - start_situtation - possessionGUIDUnique Sportradar team ID of the team with the ball at the start of a pulse update
ex. sr:competitor:4428
yfdpulse - start_situtationIntegerYards to a first down at the start of a pulse update
Player:
AttributeParent ElementTypeDescription
nameplayerStringFull name of a player
ex. George Kittle
idplayerGUIDUnique ID of a player
ex. 7e648a0b-fdc8-4661-a587-5826f2cac11b
jerseyplayerStringJersey number of a player
positionplayerStringPosition of an NFL player
roleplayerStringRole of a player during a specific play
sr_idplayerStringUnique Sportradar player ID
ex. sr:player:828235
Team:
AttributeParent ElementTypeDescription
aliasteamStringTeam alias
ex. MIN (Minnesota)
idteamGUIDUnique ID of a team
ex. 82d2d380-3834-4938-835f-aec541e5ece7
marketteamStringTeam market name
ex. Minnesota
nameteamStringTeam name
ex. Vikings
sr_idteamStringUnique Sportradar ID of a team
ex. sr:competitor:4324