Element | Type | Description |
---|---|---|
| Player array | Player data |
| integer($int32) | Unique player Id |
| string | Type of action perfomed by the player |
| integer($int32) | Yards where the ball was recovered/fumbled |
| string($x-extensible-enum) [ None, Home, Away ] | Team in possession |
PassAttempt (called Pass in v1)
Element | Type | Description |
---|---|---|
| Players array | Player data |
IncompletePass
CompletePass
Interception
Yards
integer($int32)
Indicates Air Yards + Yards after catch
Element | Type | Description |
---|---|---|
| boolean | Indicates whether FG was made |
| boolean | Indicates whether this action was nullified |
| integer($int32) | Indicates yards from there the FG was taken |
| Players array | Player data |
FieldGoalAttempt
Element | Type | Description |
---|---|---|
| Players array | Player data |
| boolean | Indicates whether this action was nullified |
FieldGoalBlocked
Element
Type
IsNullified
Element | Type | Description |
---|---|---|
| integer($int32) | Number of timeouts remaining for away team |
| integer($int32) | Number of timeouts remaining for home team |
Timeout
Code Block |
---|
{
} |
No player or yards data. Just an event to record a timeout fact.
Snap
Code Block |
---|
{
"IsConfirmed": false
} |
Element | Type | Description |
---|---|---|
| boolean | Indicates if it is confirmed or not |
Touchdown
Element
Type
Description
IsNullified
boolean
Yards
Players
Players array
Player data
Indicates how many yards a player rushed
Element | Type | Description |
---|---|---|
| integer($int32) | Indicates how many yards a player rushed |
| Players array | Player data |
Kneel
Element | Type | Description |
---|---|---|
| Players array | Player data |
| integer($int32) | Indicates where the tackle happened |
Comment
Code Block |
---|
{
"Text": "2-Minute Warning"
} |
Element | Type | Description |
---|---|---|
| string | Comments provided by Feed Prodiver |
NextPlay
Element | Type | Description |
---|---|---|
| string($x-extensible-enum) [ Snap, Kickoff, Pat ] | Next Play Type |
| LOS data array | LOS data |
| integer($int32) | Scrimmage Yard Line |
| string($x-extensible-enum) [ None, Home, Away ] | Indicates the side of the pitch if it’s home or away |
| integer($int32) | Number of the next Down |
| integer($int32) | Yards to go for successful |
| boolean | Indicates if it is confirmed or not |
Safety
Element | Type | Description |
---|---|---|
| boolean | Indicates whether this action was nullified |
| Players array | Player data |
OnePointSafety
IsNullified
boolean
Indicates whether this action was nullified
No player or yards data. Just an event to record a clock set fact.
ClockStarted
Code Block |
---|
{
} |
No player or yards data. Just an event to record a clock start fact.
ClockStopped
Code Block |
---|
{
} |
No player or yards data. Just an event to record a clock stop fact.
CoinToss
WinnerTeam
AwayChoice
integer($int32)
team Id
WasDeferred
boolean
Indicates whether choice deferred or not
HomeChoice
Kick Receive, EndZone, NorthEndZone, EastEndZone, SouthEndZone, WestEndZone ]Indicates the home team choice from the available options.
Type
string($x-extensible-enum)
[ Unknown, OnePoint, TwoPoints ]
Indicated the type of conversion attempt play
IsMade
boolean
IsMade
this action was made OutOfBoundsPlayers
Players array
Player data
IsNullified
boolean
Indicates whether this action was nullified
Yards
Players
Players array
Player data
integer($int32)
Indicates the yard line where out of bounds happened
Element | Type | Description |
---|---|---|
| Players array | Player data |
Penalty
Return
Type
string($x-extensible-enum)
Unknown, OffensiveHolding, FalseStart, DefensivePassInterference, OffensivePassInterference, DefensiveHolding, UnnecessaryRoughness, DefensiveOffside, DelayOfGame, IllegalBlockAboveTheWaist, NeutralZoneInfraction, FaceMask, IllegalUseOfHands, RoughingThePasser, UnsportsmanlikeConduct, IllegalFormation, Encroachment, IllegalContact, Defensive12OnField, IllegalShift, IntentionalGrounding, Taunting, OffsideOnFreeKick, IneligibleDownfieldPass, HorseCollarTackle, Leverage, RoughingTheKicker, IllegalMotion, ChopBlock, IllegalTouchKick, RunningIntoTheKicker, Disqualification, InterferenceWithOpportunityToCatch, Offensive12OnField, PlayerOutOfBoundsOnPunt, IllegalSubstitution, OffensiveOffside, IllegalTouchPass, FairCatchInterference, Clipping, IllegalForwardPass, IllegalBlindsideBlock, Tripping, Leaping, IneligibleDownfieldKick, InvalidFairCatchSignal, IllegalCrackback, LowBlock, DelayOfKickoff, DefensiveDelayOfGame, IllegalBat, IllegallyKickingBall, KickoffOutOfBounds, IllegalCut
Penalty type
Yards
integer($int32)
Indicates the amount of yards team was penalized based on the penalty type
Outcome
string($x-extensible-enum)
Unknown, Accepted, Declined, Offsetting, Superseded
Outcome of the penalty
Players
Players array
Player data
Element | Type | Description |
---|---|---|
| integer($int32) | Indicates the yards gained |
| Players array | Player data |
Down
Element | Type | Description |
---|---|---|
| integer($int32) | Number of the Down in a Play |
| integer($int32) | Indicates yards to go for a successful down |
| integer($int32) | Scrimmage Yard line |
| string($date-span) | game clock data |
| string($date-span) | time of the day |
| string | Description by Feed Provider |
Sack
Element | Type | Description |
---|---|---|
| integer($int32) | Indicates yards behind the Scrimmage Line |
| Players array | Player data |
KickOff
Yards
Players
Players array
Player data
Possession
Code Block |
---|
{
} |
No player or yards data. Just an event to record a possession of the ball fact.
YardsToEndzone
Code Block |
---|
{
"Value": 76
} |
Element | Type | Description |
---|---|---|
| integer($int32) | Indicates yards to End Zone |
MatchStatusChanged
Code Block |
---|
{
"MatchStatus": "Finished"
} |
Element | Type | Description |
---|---|---|
| string($x-extensible-enum) [ Unknown, NotStarted, Warmup, InProgress, Postponed, Finished, Interrupted, CoverageStopped, Abandoned, Cancelled, Delayed ] | Indicates match status |
PeriodChanged
Code Block |
---|
{
} |
No player or yards data. Just an event to record a period change fact.
Punt
integer($int32)
Indicates how far (in terms of yards) the ball was kicked
Element | Type | Description |
---|---|---|
| integer($int32) | yards gained |
| Players array | Player data |
Risks
Element | Type | Description |
---|---|---|
| string($x-extensible-enum) [ Unknown, Active, NonActive ] | Touchdown risk |
| string($x-extensible-enum) [ Unknown, Active, NonActive ] | Onside Kick risk |
| string($x-extensible-enum) [ Unknown, Active, NonActive ] | Field Goal risk |
| string($x-extensible-enum) [ Unknown, Active, NonActive ] | Fourth Down risk |
| string($x-extensible-enum) [ Unknown, Active, NonActive ] | Safety risk |
| string($x-extensible-enum) [ Unknown, Active, NonActive ] | Challenge risk |
| string($x-extensible-enum) [ Unknown, Active, NonActive ] | Penalty risk |
| string($x-extensible-enum) [ Unknown, Active, NonActive ] | VideoReview risk |
| string($x-extensible-enum) [ Unknown, Active, NonActive ] | Turnover risk |
| string($x-extensible-enum) [ Unknown, Active, NonActive ] | Indicates that the play is about to start (teams are lining up to begin the play). |
| string($x-extensible-enum) [ Unknown, Active, NonActive ] | Other risk |
FairCatch
Code Block |
---|
{
"Yards": null,
"Players": [
{
"Id": "835822",
"Type": "Receiver"
}
],
} |
Element | Type | Description |
---|---|---|
| integer($int32) | yard line |
| Players array | Player data |
Challenge
Code Block |
---|
{
"Result": "Won"
} |
Element | Type | Description |
---|---|---|
| string($x-extensible-enum) [ Unknown, Won, Lost ] | Result of the challenge |
Other Match Events
Reliability
CurrentLineup
Code Block |
---|
{
"TeamType": null,
"Players": {}
} |
Element | Type | Description |
---|---|---|
| string | Type of the team players are assigned to |
| Array Of Lineup Player | Lineup players array |
IsReliable
boolean
Indicates whether the current match events are reliable or not
Reason
string
Reason
Penalty
CompletePass
TwoPointsConversion
pass attempted CompletePass
TwoPointsConversion
pass attemptedFumbler
Fumble
The player/s who forced the fumble
FieldGoal
FieldGoalBlocked
OnePointConversion
TwoPointsConversion
OnePointConversion
CompletePass