American Football Match Events V1
- 1 Feed Match Event
- 2 Feed Match Action
- 3 Actions
- 3.1 Fumble
- 3.2 PassAttempt (called Pass in v1)
- 3.3 IncompletePass
- 3.4 CompletePass
- 3.5 Interception
- 3.6 FieldGoal
- 3.7 FieldGoalAttempt
- 3.8 TimeoutsRemaining
- 3.9 Timeout
- 3.10 Snap
- 3.11 Touchdown
- 3.12 Single
- 3.13 Run
- 3.14 Tackle
- 3.15 Comment
- 3.16 NextPlay
- 3.17 Safety
- 3.18 OnePointSafety
- 3.19 ClockSet
- 3.20 ClockStarted
- 3.21 ClockStopped
- 3.22 CoinToss
- 3.23 ConversionAttempt
- 3.24 OnePointConversion
- 3.25 TwoPointsConversion
- 3.26 OutOfBounds
- 3.27 Touchback
- 3.28 Penalty
- 3.29 Return
- 3.30 Down
- 3.31 Sack
- 3.32 KickOff
- 3.33 Possession
- 3.34 YardsToEndzone
- 3.35 MatchStatusChanged
- 3.36 PeriodChanged
- 3.37 Punt
- 3.38 Risks
- 3.39 FairCatch
- 3.40 Challenge
- 4 Other Match Events
- 4.1 Reliability
Feed Match Event
Example Ably LiveAccess URL: https://platform.matchstate.api.geniussports.com/api/v1/sources/GeniusPremium/sports/17/fixtures/10173048/liveaccess/matchevents?sportApiVersion=v1
{
"SportId": 17,
"FixtureId": "91143158",
"Source": "GeniusPremiumReplay",
"SequenceId": 1606,
"ActionId": 839,
"InsertedBeforeActionId": null,
"IsCancelled": false,
"IsConfirmed": false,
"IsModified": true,
"Action": {},
"MessageTimestampUtc": "2022-05-19T10:31:24.0121616Z"
}
Element | Type | Description |
---|---|---|
| Integer | Sport Identifier (17 for American Football) |
| String | Unique fixture identifier |
| String | Feed Provider information |
| Integer | Sequence Id of feed match events |
| Integer | Unique match action identifier |
| Integer | Identifier used to specify before which action Id this specific action was inserted (in case this insertion is done before previously published match events) |
| boolean | Indicates whether the action is cancelled |
| boolean | Indicates whether the action is confirmed |
| boolean | Indicates whether the action is modified |
| Match action array | Consists of Match Action data properties |
| String($date-time) | Timestamp of the message |
Feed Match Action
NOTE: All Feed Match Actions includes the following additional fields (hence it’s not copy-pasted to every action described below).
"Team": "Away",
"GameTime": "00:00:00",
"Period": {
"Number": 1,
"ProgressStatus": "NotStarted",
"Type": "Regular"
},
"UtcTimestamp": "2022-05-19T09:24:26.7008204Z"
Element | Type | Description |
---|---|---|
| string($x-extensible-enum) [ None, Home, Away ] | Team data |
| string($date-span) | Game time data |
| Period array | Period in the game data |
| integer($int32) | Period number |
| string($x-extensible-enum) [ NotStarted, InProgress, Complete ] | Period progress status |
| string($x-extensible-enum) [ Regular, Overtime ] | Period type data |
| string($date-time) | Timestamp of the message |
Actions
NOTE: All Feed Match Actions consist of Feed Match Event + Feed Match Action + Action data properties
Fumble
{
"Fumbler": {
"Id": "835822",
"Name": null
},
"Recoverer": null,
"Yards": 40,
"TeamInPossession": "None",
}
Element | Type | Description |
---|---|---|
| Fumbler Player array | Fumbler action data |
| integer($int32) | Unique player Id |
| string | Player name |
| integer($int32) | Unique player Id |
| 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 |
---|---|---|
| Passer data array | Passer data |
| integer($int32) | Unique player Id |
| string | Player name |
IncompletePass
No player or yards data. Just an event to record an incomplete pass fact.
CompletePass
Element | Type | Description |
---|---|---|
| Receiver data array | Receiver data |
| integer($int32) | Unique player Id |
| string | Player name |
| integer($int32) | Indicates Air Yards + Yards after catch |
Interception
Element | Type | Description |
---|---|---|
| Interception player data array | Interception player data |
| integer($int32) | Unique player Id |
| string | Player name |
FieldGoal
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 |
| FG player data array | FG player data |
| integer($int32) | Unique player Id |
| string | Player name |
FieldGoalAttempt
Element | Type | Description |
---|---|---|
| boolean | Indicates whether this action was nullified |
TimeoutsRemaining
Element | Type | Description |
---|---|---|
| integer($int32) | Number of timeouts remaining for away team |
| integer($int32) | Number of timeouts remaining for home team |
Timeout
No player or yards data. Just an event to record a timeout fact.
Snap
Element | Type | Description |
---|---|---|
| boolean | Indicates if it is confirmed or not |
Touchdown
Element | Type | Description |
---|---|---|
| boolean | Indicates whether this action was nullified |
| Player data array | Touchdown player data |
| integer($int32) | Unique player Id |
| string | Player name |
Single
Element | Type | Description |
---|---|---|
| boolean | Indicates whether this action was nullified |
| Player data array | Kicker player data |
| integer($int32) | Unique kicker Id |
| string | two possible values: “Kicker” or null |
Run
Element | Type | Description |
---|---|---|
| integer($int32) | Indicates how many yards a player rushed |
| Player data array | Run player data |
| integer($int32) | Unique player Id |
| string | Player name |
Tackle
Element | Type | Description |
---|---|---|
| Player data array | Tackle player data |
| integer($int32) | Unique player Id |
| string | Player name |
| integer($int32) | Unique player Id |
| integer($int32) | Indicates where the tackle happened |
Comment
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 |
| integer($int32) | Unique player Id |
OnePointSafety
Element | Type | Description |
---|---|---|
| boolean | Indicates whether this action was nullified |
| integer($int32) | Unique player Id |
ClockSet
No player or yards data. Just an event to record a clock set fact.
ClockStarted
No player or yards data. Just an event to record a clock start fact.
ClockStopped
No player or yards data. Just an event to record a clock stop fact.
CoinToss
Element | Type | Description |
---|---|---|
| integer($int32) | team Id |
| boolean | Indicates whether choice deferred or not |
| string($x-extensible-enum) [ Kick, Receive, EndZone, NorthEndZone, EastEndZone, SouthEndZone, WestEndZone ] | Indicates the away team choice from the available options. |
| string($x-extensible-enum) [ Kick, Receive, EndZone, NorthEndZone, EastEndZone, SouthEndZone, WestEndZone ] | Indicates the home team choice from the available options. |
ConversionAttempt
Element | Type | Description |
---|---|---|
| string($x-extensible-enum) [ Unknown, OnePoint, TwoPoints ] | Indicated the type of conversion attempt play |
| boolean | Indicates whether this action was nullified |
OnePointConversion
Element | Type | Description |
---|---|---|
| boolean | Indicates whether this action was made or not |
| boolean | Indicates whether this action was nullified |
| Player data array | Player data |
| integer($int32) | Unique player Id |
| string | Player name |
TwoPointsConversion
Element | Type | Description |
---|---|---|
| boolean | Indicates whether this action was made or not |
| integer($int32) | Unique player Id |
| integer($int32) | Unique player Id |
| boolean | Indicates whether this action was nullified |
OutOfBounds
Element | Type | Description |
---|---|---|
| integer($int32) | Indicates the yard line where out of bounds happened |
| Player data array | Player data |
| integer($int32) | Unique player Id |
| string | Player name |
Touchback
Element | Type | Description |
---|---|---|
| integer($int32) | Unique player Id |
Penalty
Element | Type | Description |
---|---|---|
| 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 |
| integer($int32) | Indicates the amount of yards team was penalized based on the penalty type |
| string($x-extensible-enum) Unknown, Accepted, Declined, Offsetting, Superseded | Outcome of the penalty |
| Player data array | Player data |
| integer($int32) | Unique player Id |
| string | Player name |
Return
Element | Type | Description |
---|---|---|
| integer($int32) | Indicates the yards gained |
| Player data array | Player data |
| integer($int32) | Unique player Id |
| string | Player name |
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 |
| Player data array | Player data |
| integer($int32) | Unique player Id |
| string | Player name |
| Player data array | Player data |
| integer($int32) | Unique player Id |
| string | Player name |
| Player data array | Player data |
KickOff
Element | Type | Description |
---|---|---|
| integer($int32) | Indicates how far (in terms of yards) the ball was kicked |
| Player data array | Player data |
| integer($int32) | Unique player Id |
| string | Player name |
Possession
No player or yards data. Just an event to record a possession of the ball fact.
YardsToEndzone
Element | Type | Description |
---|---|---|
| integer($int32) | Indicates yards to End Zone |
MatchStatusChanged
Element | Type | Description |
---|---|---|
| string($x-extensible-enum) [ Unknown, NotStarted, Warmup, InProgress, Postponed, Finished, Interrupted, CoverageStopped, Abandoned, Cancelled, Delayed ] | Indicates match status |
PeriodChanged
No player or yards data. Just an event to record a period change fact.
Punt
Element | Type | Description |
---|---|---|
| integer($int32) | yards gained |
| Player data array | Player data |
| integer($int32) | Unique player Id |
| string | Player name |
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 ] | Other risk |
FairCatch
Element | Type | Description |
---|---|---|
| integer($int32) | yard line |
| Player data array | Player data |
| integer($int32) | Unique player Id |
| string | Player name |
Challenge
Element | Type | Description |
---|---|---|
| string($x-extensible-enum) [ Unknown, Won, Lost ] | Result of the challenge |
Other Match Events
Reliability
Element | Type | Description |
---|---|---|
| boolean | Indicates whether the current match events are reliable or not |
| string | Reason |