Versions Compared
Version | Old Version 16 | New Version Current |
---|---|---|
Changes made by | ||
Saved on |
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Table of Contents | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Feed Match Event
American Football Match Events
View file | ||
---|---|---|
|
Example Ably LiveAccess URL: https://platform.matchstate.api.geniussports.com/api/v1/sources/GeniusPremium/sports/17/fixtures/10173048/liveaccess/matchevents?sportApiVersion=v2
Code Block |
---|
{ "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
Info |
---|
NOTE: All Feed Match Actions includes the following additional fields (hence it’s not copy-pasted to every action described below). |
Code Block |
---|
{ "team": "Home", "gameTime": "00:10:00", "period": { "number": 1, "progressStatus": "NotStarted", "type": "Regular" }, "utcTimestamp": "2023-09-24T18:19:09.5924521Z" } |
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
Info |
---|
NOTE: All Feed Match Actions consist of Feed Match Event + Feed Match Action + Action data properties |
Fumble
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.Fumble, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "subtype": "FumbledHandoff", "yards": 45, "yardLine": { "yards": 45, "sideOfPitch": "Away" }, "teamInPossession": "None", "isNullified": false, "players": [ { "id": "999739", "type": "Fumbled" } ] } |
Element | Type | Description |
---|---|---|
| string | |
| Player array | Player data |
| string($x-extensible-enum) | Indicates second level of action description |
| Yardlines array | Indicates where fumble action on the field happenedenforcement and placement yardlines of the penalty if both available |
| integer($int32) | Unique player Id |
| string | Type of action performed by the player |
| integer($int32) | Yards where the ball was recovered/fumbled |
| string($x-extensible-enum) | Team in possession |
| string($x-extensible-enum) [ None, Home, Away ] | Indicates the side of the pitch if it’s home or away |
| boolean | Indicates whether this action is nullified |
PassAttempt (called Pass in v1)
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.PassAttempt, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "isNullified": false, "players": [ { "id": "1072633", "type": "Passer" }, { "id": "999739", "type": "Receiver" } ] } |
Element | Type | Description |
---|---|---|
| string | |
| Players array | Player data |
| boolean | Indicates whether this action is nullified |
| integer($int32) | Unique player Id |
| string | Type of the player? |
IncompletePass
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.IncompletePass, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "isNullified": false, "yardLine": null, "subtype": null, "players": [ { "id": "1016285", "type": "Passer" } ] } |
Element | Type | Description | ||
---|---|---|---|---|
| Players array | Player data | string | |
| Players array | Player data | ||
| boolean | Indicates whether this action is nullified | ||
| Yardlines array | Indicates enforcement and placement yardlines of the penalty if both available | ||
| ||||
| integer($int32) | Unique player Id | ||
| string | Type of the player? |
CompletePass
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.CompletePass, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "yards": 0, "isNullified": false, "yardLine": null, "players": [ { "id": "998871", "type": "Passer" }, { "id": "758163", "type": "Receiver" } ] } |
Element | Type | Description | ||||
---|---|---|---|---|---|---|
| Players array | Player data |
| integer($int32) | Indicates string | |
| Players array | Player data | ||||
| boolean | Indicates whether this action is nullified | ||||
| Yardlines array | |||||
| integer($int32) | Indicates Air Yards + Yards after catch | ||||
| integer($int32) | Unique player Id | ||||
| string | Type of the player? |
Interception
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.Interception, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "isNullified": false, "yardLine": null, "players": [ { "id": "1072679", "type": "Passer" } ] } |
Element | Type | Description |
---|---|---|
| Players array | Player data |
FieldGoal
string |
Interception, |
GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents |
] | ||
| boolean | Indicates whether this action is nullified |
| Yardlines array | |
| Players array | Player data |
| integer($int32) | Unique player Id |
| string | Type of the player? |
FieldGoal
Code Block |
---|
{
"$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.FieldGoal, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents",
"isMade": true,
"isNullified": false,
"yards": 57,
"yardLine": null,
"players": [
{
"id": "998755",
"type": "Kicker"
}
]
} |
Element | Type | Description | ||||
---|---|---|---|---|---|---|
| boolean | Indicates whether FG was made |
| boolean | string | |
| boolean | Indicates whether FG was made | ||||
| boolean | Indicates whether this action is nullified | ||||
| integer($int32) | Indicates yards from there the FG was taken | ||||
| Yardlines array | |||||
| Players array | Player data | ||||
| integer($int32) | Unique player Id | ||||
| string | Type of the player? |
FieldGoalAttempt
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.FieldGoalAttempt, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "isNullified": false, "yardLine": null, "players": [ { "id": "998755", "type": "Kicker" } ] } |
Element | Type | Description |
---|---|---|
| string | |
| Players array | Player data |
| integer($int32) | Unique player Id |
| string | Type of the player? |
| boolean | Indicates whether this action was nullified |
| Yardlines array |
FieldGoalBlocked
Code Block |
---|
{ "players": [ { "id": "493258", "name": "Kicker" } ], "isNullified": false } |
Element | Type | Description |
---|---|---|
| Players array | Player data |
| boolean | Indicates whether this action was nullified |
TimeoutsRemaining
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.TimeoutsRemaining, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "away": 3, "home": 3 } |
Element | Type | Description |
---|---|---|
| string | |
| integer($int32) | Number of timeouts remaining for away team |
| integer($int32) | Number of timeouts remaining for home team |
Timeout
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.Timeout, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents" } |
No player or yards data. Just an event to record a timeout fact.
Element | Type | Description |
---|---|---|
| string |
Snap
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.Snap, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "isConfirmed": false } |
Element | Type | Description |
---|---|---|
| string | |
| boolean | Indicates if it is confirmed or not |
Touchdown
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.Touchdown, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "isNullified": false, "players": [ { "id": "998787", "type": "Scorer" } ] } |
Element | Type | Description | |
---|---|---|---|
| boolean | string | |
| boolean | Indicates whether this action was nullified | |
| Players array | Player data | |
| integer($int32) | Unique player Id | |
| string | Type of the player? |
Single
Code Block |
---|
{ "isNullified": false, "players": [ { "id": "493258", "name": "Kicker" } ] } |
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
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.Run, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "yards": null, "isNullified": false, "players": [ { "id": "998871", "type": "Runner" } ] } |
Element | Type | Description |
---|---|---|
| integer($int32) | Indicates how many yards a player rushed |
| Players array | Player data |
RunAfterCatch
| string |
Run, |
GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents |
] | ||
| integer($int32) | Indicates how many yards a player rushed |
| boolean | Indicates whether this action was nullified |
| Players array | Player data |
| integer($int32) | Unique player Id |
| string | Type of the player? |
RunAfterCatch
Code Block |
---|
{
"$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.RunAfterCatch, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents",
"yards": 26,
"isNullified": false,
"players": [
{
"id": "998787",
"type": "Runner"
}
]
} |
Element | Type | Description |
| integer($int32) |
---|---|---|---|---|
Indicates | string | |||
| integer($int32) | Indicates how many yards a player rushed | ||
| boolean | Indicates whether this action was nullified | ||
| Players array | Player data | ||
| integer($int32) | Unique player Id | ||
| string | Type of the player? |
Kneel
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.Kneel, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "yards": null, "isNullified": false, "yardLine": null, "players": [ { "id": "1072679", "type": "Runner" } ] } |
Element | Type | Description |
---|---|---|
| Players array | Player data |
Tackle
string |
Kneel, |
GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents |
] | ||
| integer($int32) | Indicates how many yards a player rushed |
| boolean | Indicates whether this action was nullified |
| Yardlines array | |
| Players array | Player data |
| integer($int32) | Unique player Id |
| string | Type of the player? |
Tackle
Code Block |
---|
{
"$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.Tackle, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents",
"yards": null,
"yardLine": {
"yards": 22,
"sideOfPitch": "Away"
},
"isNullified": false,
"players": [
{
"id": "941270",
"type": "Tackler"
}
]
} |
Element | Type | Description | ||
---|---|---|---|---|
| Players array | Player data | string | |
| Yardlines array | |||
| string($x-extensible-enum) [ None, Home, Away ] | Indicates the side of the pitch if it’s home or away | ||
| boolean | Indicates whether this action was nullified | ||
| Players array | Player data | ||
| integer($int32) | Unique player Id | ||
| string | Type of the player? | ||
| integer($int32) | Indicates where the tackle happened |
Comment
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.Comment, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "text": "2-Minute Warning" } |
Element | Type | Description |
---|---|---|
| string | |
| string | Comments provided by Feed Prodiver |
NextPlay
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.NextPlay, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "type": null, "lineOfScrimmage": { "scrimmageYard": 24, "sideOfPitch": "Home" }, "downNumber": 2, "yardsToGo": 13, "isConfirmed": false, "team": "Home" } |
Element | Type | Description |
---|---|---|
| string | |
| 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 |
| string($x-extensible-enum) [ None, Home, Away ] | Team data |
Safety
Code Block |
---|
{ "isNullified": false, "players": [] } |
Element | Type | Description |
---|---|---|
| boolean | Indicates whether this action was nullified |
| Players array | Player data |
OnePointSafety
Code Block |
---|
{ "isNullified": false, "players": [] } |
Element | Type | Description |
---|---|---|
| boolean | Indicates whether this action was nullified |
| Players array | Player data |
ClockSet
Code Block |
---|
{ } |
No player or yards data. Just an event to record a clock set fact.
ClockStarted
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.ClockStarted, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents" } |
No player or yards data. Just an event to record a clock start fact.
Element |
---|
Type |
---|
Description |
---|
| string |
ClockStarted, |
GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents |
No player or yards data. Just an event to record a clock stop fact.
CoinToss] |
ClockStopped
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.CoinTossClockStopped, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", " } |
No player or yards data. Just an event to record a clock stop fact.
Element | Type | Description |
---|---|---|
| string |
CoinToss
Code Block |
---|
{
"$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.CoinToss, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents",
"winnerTeam": "Away",
"wasDeferred": false,
"awayChoice": "Receive",
"homeChoice": null
} |
Element | Type | Description |
| integer($int32) |
---|---|---|---|---|
team Id | string | |||
| 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
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.ConversionAttempt, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "type": "OnePoint", "isNullified": false, "yardLine": null, "players": [ { "id": "1080636", "type": "Kicker" } ] } |
Element | Type | Description |
---|---|---|
| string | |
| string($x-extensible-enum) [ Unknown, OnePoint, TwoPoints ] | Indicated the type of conversion attempt play |
| boolean | Indicates whether this action was nullified |
| Yardlines array | |
| Players array | Player data |
| integer($int32) | Unique player Id |
| string | Type of the player? |
OnePointConversion
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.OnePointConversion, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "isMade": true, "isNullified": false, "players": [ { "id": "1080636", "type": "Kicker" } ] } |
Element | Type | Description | |
---|---|---|---|
| boolean | Indicates whether this string | |
| boolean | Indicates whether this action was made or not | |
| boolean | Indicates whether this action was nullified | |
| Players array | Player data | |
| integer($int32) | Unique player Id | |
| string | Type of the player? |
TwoPointsConversion
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.TwoPointsConversion, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "isMade": false, "isNullified": false, "players": [ { "id": "1075217", "type": "Recoverer" } ] } |
Element | Type | Description |
---|---|---|
| string | |
| boolean | Indicates whether this action was made or not |
| Players array | Player data |
| boolean | Indicates whether this action was nullified |
| integer($int32) | Unique player Id |
| string | Type of the player? |
OutOfBounds
Code Block |
---|
"action": { "yards": null, "players": [] } |
Element | Type | Description |
---|---|---|
| integer($int32) | Indicates the yard line where out of bounds happened |
| Players array | Player data |
Touchback
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.TouchbackOutOfBounds, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "isNullified "yards": false,null, "playersyardLine": null } |
Element | Type | Description |
---|---|---|
| Players array | Player data |
Penalty
Code Block |
---|
{{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.Penalty, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "type": "DefensiveOffside", "yards": 5, "outcomeyards": "Accepted"21, "yardLines": [ { "typesideOfPitch": "PlacementHome", "yards": 22, }, "sideOfPitch": "Away" } ], "enforcementSpotisNullified": "PreviousSpot"false, "nextDown": "Repeats", "players": [], { "idteam": "1014528Home", "type": "Unknown" } ] }"gameTime": "00:00:00", "period": null, "utcTimestamp": "2024-08-02T01:04:29.5609949Z" }, "messageTimestampUtc": "2024-08-02T01:04:30.1486946Z" }, |
Element | Type | Description |
---|
type
string($x-extensible-enum)
Unknown, BlockBelowWaist, BlockingOutOfBounds, ChopBlock, Clipping, ContactingTheKicker, CutBlocking, Defensive12OnField, DefensiveDelayOfGame, DefensiveHolding, DefensiveOffside, DefensivePassInterference, DefensiveTooManyMenOnField, DelayOfGame, DelayOfKickoff, DisconcertingSignals, Disqualification, Encroachment, EquipmentViolation, FaceMask, FairCatchInterference, FalseStart, Fighting,
| string [GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.OutOfBounds, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents] | |
| integer($int32) | Indicates the yard line where out of bounds happened |
| Players array | Player data |
Touchback
Code Block |
---|
{
"$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.Touchback, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents",
"isNullified": false,
"players": null
} |
Element | Type | Description |
---|---|---|
| string | |
| boolean | Indicates whether this action was nullified |
| Players array | Player data |
Penalty
Code Block |
---|
{
"$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.Penalty, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents",
"type": "DefensiveOffside",
"yards": 5,
"outcome": "Accepted",
"yardLines": [
{
"type": "Placement",
"yards": 22,
"sideOfPitch": "Away"
}
],
"enforcementSpot": "PreviousSpot",
"nextDown": "Repeats",
"players": [
{
"id": "1014528",
"type": "Unknown"
}
]
} |
Element | Type | Description |
---|---|---|
| string | |
| string($x-extensible-enum) Unknown, BlockBelowWaist, BlockingOutOfBounds, ChopBlock, Clipping, ContactingTheKicker, CutBlocking, Defensive12OnField, DefensiveDelayOfGame, DefensiveHolding, DefensiveOffside, DefensivePassInterference, DefensiveTooManyMenOnField, DelayOfGame, DelayOfKickoff, DisconcertingSignals, Disqualification, Encroachment, EquipmentViolation, FaceMask, FairCatchInterference, FalseStart, Fighting, Holding, HoldingReturn, HorseCollarTackle, Hurdling, IllegalBat, IllegalBlindsideBlock, IllegalBlock, IllegalBlockAboveTheWaist, IllegalBlockAboveWaist, IllegalBlockAfterFcSignal, IllegalBlockInBack, IllegalBlockOnReturn, IllegalContact, IllegalContactWithSnapper, IllegalCrackback, IllegalCut, IllegalDoubleTeamBlock, IllegalDownfieldOnKick, IllegalFormation, IllegalForwardPass, IllegalInterferenceCover, IllegalInterferenceOnLooseBall, IllegalKickoff, IllegallyKickingBall, IllegalMotion, IllegalParticipation, IllegalPeelback, IllegalPunt, IllegalShift, IllegalSnap, IllegalSubstitution, IllegalTouchKick, IllegalTouchOfKick, IllegalTouchPass, IllegalUseOfHands, IllegalWedge, IneligibleDownfieldKick, IneligibleDownfieldOnPass, IneligibleDownfieldPass, IneligibleReceiver, IntentionalGrounding, InterferenceWithOpportunityToCatch, InvalidFairCatchSignal, KickCatchInterference, KickoffOutOfBounds, Leaping, Leverage, LowBlock, LoweringHeadToInitiateContact, NeutralZoneInfraction, NoYards15, NoYards5, ObjectionableConduct, Offensive12OnField, OffensiveHolding, OffensiveOffside, OffensivePassInterference, OffensiveTooManyMenOnField, Offside, OffsideOnFreeKick, PassInterference, PersonalFoul, PhysicalAbuseOnOfficial, PilingOn, PlayerOutOfBoundsOnKick, PlayerOutOfBoundsOnPunt, ProcedureGeneral, ProcedureIllegalFormation, ProcedureNoEnd, PushBlocking, Pyramiding, ReturnFromOutOfBounds, RoughingHolder, RoughingTheKicker, RoughingThePasser, RoughPlay, RunningIntoHolder, RunningIntoTheKicker, ShortFreeKick, SidelineInterference, Spearing, Targeting, Taunting, TimeCountAfter3MinuteWarningIntentional, TimeCountAfter3MinuteWarningLoss10Yards, TimeCountAfter3MinuteWarningLossDown, TimeCountAfter3MinuteWarningUnintentional, TimeCountBefore3MinuteWarning, TooManyPlayers, Tripping, UnnecessaryRoughness, UnnecessaryRoughnessMajorGrade2, UnsportsmanlikeConduct | 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 |
| Yardlines array | Indicates enforcement and placement yardlines of the penalty if both available. |
| string($x-extensible-enum) Unknown, Accepted, Declined, Offsetting, Superseded | Indicates where the penalty is enforced from. Available options: [Unknown, DeadBall, OtherSpot, PreviousSpot, SuccedingSpot] |
| string($x-extensible-enum) Unknown, Accepted, Declined, Offsetting, Superseded | Indicates if penalty results in firstDown, LossOfDown or down Repeats. Available options: [Unknown, First, Repeats, LossOfDown] |
| Players array | Player data |
, UnnecessaryRoughness, UnnecessaryRoughnessMajorGrade2, UnsportsmanlikeConduct | 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 |
| Yardlines array | Indicates enforcement and placement yardlines of the penalty if both available |
| ||
| string($x-extensible-enum) [ None, Home, Away ] | Indicates the side of the pitch if it’s home or away |
| string($x-extensible-enum) Unknown, Accepted, Declined, Offsetting, Superseded | Indicates where the penalty is enforced from. Available options: [Unknown, DeadBall, OtherSpot, PreviousSpot, SuccedingSpot] |
| string($x-extensible-enum) Unknown, Accepted, Declined, Offsetting, Superseded | Indicates if penalty results in firstDown, LossOfDown or down Repeats. Available options: [Unknown, First, Repeats, LossOfDown] |
| Players array | Player data |
| integer($int32) | Unique player Id |
| string | Type of the player? |
Return
Code Block |
---|
{
"$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.Return, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents",
"yards": null,
"yardLine": {
"yards": 1,
"sideOfPitch": "Home"
},
"isNullified": false,
"subtype": null,
"players": [
{
"id": "1013138",
"type": "Returner"
}
]
} |
Element | Type | Description |
---|---|---|
| string | |
| integer($int32) | Indicates the yards gained |
| Yardlines array | |
| string($x-extensible-enum) [ None, Home, Away ] | Indicates the side of the pitch if it’s home or away |
| ||
| boolean | Indicates whether this action was nullified |
| Players array | Player data |
| integer($int32) | Unique player Id |
| string | Type of the player? |
Down
Code Block |
---|
{
"$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.Down, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents",
"number": 2,
"yardsToGo": 1,
"scrimmageYard": 34,
"endedAtGameTime": null,
"endedAtUtc": null,
"description": "(1:37) (No Huddle, Shotgun) 15-P.Mahomes scrambles ran ob at KC 37 for 3 yards (54-F.Warner)."
} |
Element | Type | Description |
---|---|---|
| string | |
| 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
Code Block |
---|
{
"$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.Sack, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents",
"subtype": "Tackled",
"yards": 0,
"isNullified": false,
"yardLine": null,
"players": [
{
"id": "998871",
"type": "Tackled"
}
]
} |
Element | Type | Description |
---|---|---|
| string | |
| ||
| integer($int32) | Indicates yards behind the Scrimmage Line |
| boolean | Indicates whether this action was nullified |
| Yardlines array | |
| Players array | Player data |
| integer($int32) | Unique player Id |
| string | Type of the player? |
KickOff
Code Block |
---|
{
"$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.KickOff, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents",
"subtype": null,
"yards": 65,
"isNullified": false,
"players": [
{
"id": "1080636",
"type": "Kicker"
}
]
} |
Element | Type | Description |
---|---|---|
| string | |
| ||
| integer($int32) | Indicates yards behind the Scrimmage Line |
| boolean | Indicates whether this action was nullified |
| Players array | Player data |
| integer($int32) | Unique player Id |
| string | Type of the player? |
Possession
Code Block |
---|
{
"$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.Possession, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents"
} |
No player or yards data. Just an event to record a possession of the ball fact.
Element | Type | Description |
---|---|---|
| string |
YardsToEndzone
Code Block |
---|
{
"$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.YardsToEndzone, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents",
"value": 65
} |
Element | Type | Description |
---|---|---|
| string | |
| integer($int32) | Indicates yards to End Zone |
MatchStatusChanged
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.Return, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "yards": null, "yardLine": { "yards": 1, "sideOfPitch": "Home" }, "isNullified": false, "subtype": null, "players": [ { "id": "1013138", "type": "Returner" } ]MatchStatusChanged, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "matchStatus": "InProgress" } |
Element | Type | Description |
---|
yards
integer($int32)
Indicates the yards gained
players
Players array
Player data
| string | |
| string($x-extensible-enum) [ Unknown, NotStarted, Warmup, InProgress, Postponed, Finished, Interrupted, CoverageStopped, Abandoned, Cancelled, Delayed ] | Indicates match status |
PeriodChanged
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.DownPeriodChanged, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "number": 2, "yardsToGo": 1, "scrimmageYard": 34, "endedAtGameTime": null, "endedAtUtc": null, "description": "(1:37) (No Huddle, Shotgun) 15-P.Mahomes scrambles ran ob at KC 37 for 3 yards (54-F.Warner)." } |
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 |
.Sports.AmericanFootball.Contracts.V2.MatchEvents"
} |
No player or yards data. Just an event to record a period change fact.
Element | Type | Description |
---|---|---|
| string |
Punt
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.SackPunt, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "subtype": "Tackled", "yards": 0null, "isNullified": false, "yardLine": null, "players": [ { "id": "9988711017141", "type": "TackledKicker" } ] } |
Element |
---|
Type
Description
yards
Type | Description | |
---|---|---|
| string | |
| integer($int32) | yards gained |
| boolean | Indicates whether this action was nullified |
| Players array | Player data |
| integer($int32) |
Indicates yards behind the Scrimmage Line
players
Players array
Player data
Unique player Id | ||
| string | Type of the player? |
Risks
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.KickOffRisks, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "touchdown": "NonActive", "subtypeonsideKick": null"NonActive", "yardsfieldGoal": 65"NonActive", "isNullifiedfourthDown": false"NonActive", "playerssafety": "NonActive", [ "challenge": "NonActive", {"penalty": "NonActive", "videoReview": "NonActive", "idturnover": "1080636NonActive", "other": "Active", "typeplayAboutToStart": "Kicker" } ] } |
Element | Type | Description |
---|---|---|
| integer($int32) | Indicates how far (in terms of yards) the ball was kicked |
| Players array | Player data |
Possession
Code Block |
---|
{
"$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.Possession, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents"
} |
No player or yards data. Just an event to record a possession of the ball fact.
YardsToEndzone
Code Block |
---|
{ "$type": "NonActive", "injury": "NonActive", "bigPlay": "Active", "statDelay": "NonActive" } |
Element | Type | Description |
---|---|---|
| string |
Risks, |
GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents |
Element | Type | Description |
---|---|---|
| integer($int32) | Indicates yards to End Zone |
MatchStatusChanged
Code Block |
---|
{
"$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.MatchStatusChanged, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents",
"matchStatus": "InProgress"
} |
Element
Type
Description
matchStatus
] | ||
| 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, |
Indicates match status
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 |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.PeriodChangedFairCatch, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents" } |
No player or yards data. Just an event to record a period change fact.
Punt
Code Block |
---|
{, "yards": null, "$typeisNullified": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.Punt, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents",false, "yardLine": { "yards": null1, "isNullifiedsideOfPitch": false"Away" }, "players": [ { "id": "10171411006701", "type": "KickerReceiver" } ] } |
Element | Type | Description |
---|---|---|
| string | |
| integer($int32) |
yard line | ||
| boolean | Indicates whether this action was nullified |
| Yardlines array | |
| string($x-extensible-enum) [ None, Home, Away ] | Indicates the side of the pitch if it’s home or away |
| Players array | Player data |
Risks
| integer($int32) | Unique player Id |
| string | Type of the player? |
Challenge
Code Block |
---|
"action": { "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.RisksChallenge, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "touchdown": "NonActive", "onsideKick": "NonActive", "fieldGoalplayId": "NonActive782", "fourthDown": "NonActive", "safety": "NonActive", "challengerulingOnField": "NonActive"null, "penalty": "NonActive", "videoReview": "NonActive", "turnovertype": "NonActiveTeamChallenge", "other": "Active", "playAboutToStart": "NonActive", "injuryresult": "NonActiveUnknown", "bigPlay": "Active", "statDelay": "NonActive" } |
Element
Type
Description
touchdown
string($x-extensible-enum)
[ Unknown, Active, NonActive ]
Touchdown risk
onsideKick
string($x-extensible-enum)
[ Unknown, Active, NonActive ]
Onside Kick risk
fieldGoal
string($x-extensible-enum)
[ Unknown, Active, NonActive ]
Field Goal risk
fourthDown
string($x-extensible-enum)
[ Unknown, Active, NonActive ]
Fourth Down risk
safety
string($x-extensible-enum)
[ Unknown, Active, NonActive ]
Safety risk
challenge
string($x-extensible-enum)
[ Unknown, Active, NonActive ]
Challenge risk
penalty
string($x-extensible-enum)
[ Unknown, Active, NonActive ]
Penalty risk
videoReview
string($x-extensible-enum)
[ Unknown, Active, NonActive ]
VideoReview risk
turnover
string($x-extensible-enum)
[ Unknown, Active, NonActive ]
Turnover risk
playAboutToStart
string($x-extensible-enum)
[ Unknown, Active, NonActive ]
Indicates that the play is about to start (teams are lining up to begin the play).
other
"outcome": "Unknown",
"team": "None",
"gameTime": "00:06:40",
"period": null,
"utcTimestamp": "2024-08-10T00:20:04.4691164Z"
},
"messageTimestampUtc": "2024-08-10T00:20:08.1573096Z"
}, |
Element | Type | Description |
---|---|---|
| string($x-extensible-enum) [ Unknown, |
Won, |
Lost ] |
Other risk
Result of the challenge |
Lateral
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.FairCatchLateral, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "yards": null10, "isNullified": false, "yardLine": { "yards": 1, "sideOfPitch": "Away" }, "players": [ { 1, "idsideOfPitch": "1006701Away", }, "typeplayers": "Receiver"[ }{ ] } |
Element | Type | Description |
---|---|---|
| integer($int32) | yard line |
| Players array | Player data |
Challenge
Code Block |
---|
{ "resultid": "Won" } |
Element | Type | Description |
---|---|---|
| string($x-extensible-enum) [ Unknown, Won, Lost ] | Result of the challenge |
Lateral
Code Block |
---|
{1006701", "isNullified": false, "yardstype": 5,"Passer" "players": [}, { "id": "4932581006702", "nametype": "Receiver" } ] } |
Element | Type | Description |
---|---|---|
| integer($int32) | Indicates how many yards was the lateral. |
| Players array | Player data, indicates who lateraled (passer) and who received the lateral (receiver) |
| boolean | Indicates whether this action was nullified |
| integer($int32) | |
| string |
Other Match Events
Reliability
Code Block |
---|
{ "$type": "Betgenius.Sports.Contracts.Common.MatchEvents.Reliability, Betgenius.Sports.Contracts.Common.MatchEvents", "utcTimestamp": "2024-07-16T08:26:01.350808Z", "isReliable": false, "reason": "Unreliable score" } |
Element | Type | Description |
---|---|---|
| string | |
| string($date-time) | Timestamp of the message |
| boolean | Indicates whether the current match events are reliable or not |
| string | Reason |
CurrentLineup
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.CurrentLineup, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "teamType": "Offensive", "players": [ { "position": "RunningBack", "side": "Middle", "id": "796796", "name": null, "status": "Unknown" }, { "position": "RunningBack", "side": "Middle", "id": "1076107", "name": null, "status": "Started" }, { "position": "WideReceiver", "side": "Unknown", "id": "1003947", "name": null, "status": "Started" }, { "position": "WideReceiver", "side": "Unknown", "id": "1014515", "name": null, "status": "Unknown" }, { "position": "Quarterback", "side": "Middle", "id": "998871", "name": null, "status": "Started" }, { "position": "WideReceiver", "side": "Unknown", "id": "1013138", "name": null, "status": "Unknown" }, { "position": "Quarterback", "side": "Middle", "id": "578165", "name": null, "status": "Unknown" }, { "position": "Tackle", "side": "Unknown", "id": "835944", "name": null, "status": "Started" }, { "position": "WideReceiver", "side": "Unknown", "id": "1072641", "name": null, "status": "Unknown" }, { "position": "TightEnd", "side": "Middle", "id": "835966", "name": null, "status": "Unknown" }, { "position": "TightEnd", "side": "Middle", "id": "1014058", "name": null, "status": "Unknown" }, { "position": "WideReceiver", "side": "Unknown", "id": "1072035", "name": null, "status": "Started" }, { "position": "TightEnd", "side": "Middle", "id": "758163", "name": null, "status": "Started" }, { "position": "OffensiveLineman", "side": "Unknown", "id": "1011755", "name": null, "status": "Unknown" }, { "position": "Guard", "side": "Middle", "id": "1007857", "name": null, "status": "Started" }, { "position": "Tackle", "side": "Unknown", "id": "1007535", "name": null, "status": "Started" }, { "position": "Tackle", "side": "Unknown", "id": "1017075", "name": null, "status": "Unknown" }, { "position": "OffensiveLineman", "side": "Unknown", "id": "1399022", "name": null, "status": "Unknown" }, { "position": "Guard", "side": "Middle", "id": "1016344", "name": null, "status": "Started" }, { "position": "Center", "side": "Middle", "id": "1013930", "name": null, "status": "Started" }, { "position": "WideReceiver", "side": "Unknown", "id": "1398981", "name": null, "status": "Started" }, { "position": "WideReceiver", "side": "Unknown", "id": "1343378", "name": null, "status": "Unknown" }, { "position": "RunningBack", "side": "Middle", "id": "1016897", "name": null, "status": "Unknown" }, { "position": "RunningBack", "side": "Middle", "id": "1007482", "name": null, "status": "Unknown" }, { "position": "WideReceiver", "side": "Unknown", "id": "1007477", "name": null, "status": "Unknown" } ] ] } |
Element
Type
} |
Element | Type | Description |
---|---|---|
| string | |
| string | Type of the team players are assigned to |
| Array Of Lineup Player | Lineup players array |
| ||
| string | Indicates an Unique id of the player |
| string | Indicates the position of the player. Available options: [Unknown, Kicker, Punter, Returner, RunningBack, Fullback, WideReceiver, TightEnd, Tackle, Guard, Quarterback, Center, End, Linebacker, Cornerback, Safety, Holder, LongSnapper, DefensiveBack, OffensiveLineman, DefensiveLineman] |
| string | Indicates the side of the player. Available options: [Unknown, Right, Middle, Left] |
| string | Indicates the status of the player during the game. Available options: |
Muff
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.Muff, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "yardLine": { "yards": 1, "sideOfPitch": "Home" }, "isNullified": false, "players": [ { "id": "1013138", "type": "Muffed" } ] } |
Element | Type | Description | |||||
---|---|---|---|---|---|---|---|
| string | ||||||
| Players array | Player data | |||||
| integer($int32) | yard line | |||||
| boolean | Indicates whether this action was nullified |
| Players array | Player data | boolean | Indicates whether this action was nullified |
| Yardlines array | ||||||
| string($x-extensible-enum) [ None, Home, Away ] | Indicates the side of the pitch if it’s home or away | |||||
| integer($int32) | Unique player Id | |||||
| string | Type of the player? |
Recovery
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.Recovery, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "yards": 0, "yardLine": { "yards": 20, "sideOfPitch": "Home" }, "isNullified": false, "players": [ { "id": "1013138", "type": "Recoverer" } ] } |
Element | Type | Description |
---|---|---|
| string | |
| integer($int32) | Indicates the amount of yards from the point where opponents recovered the ball to the point where the play finished |
| Yardlines array | |
| string($x-extensible-enum) [ None, Home, Away ] | Indicates the side of the pitch if it’s home or away |
| boolean | Indicates whether this action was nullified |
| Players array | Player data |
| integer($int32) | Unique player Id |
| string | Type of the player? |
Players
Player type | Valid action types | Explanation |
---|---|---|
|
| This action type is currently used in penalties |
|
| The player that was tackled |
|
| The player who tackled, in case of |
|
| The player who assisted tackling in the tackle (secondary tackler). Tackle can have two tackle assisters and no tackler |
|
| The player who scored the points |
|
| The player who is the intended receiver for a pass or fair catch. In case of conversions, only when pass is attempted |
|
| The player who passed the ball. In case of conversions, only when pass is attempted |
|
| The player who fumbled the ball |
|
| The player who recovered the ball |
|
| The play who kicked the ball. |
|
| The player who runs with the ball. In case of conversions, only when it is rushed |
|
| The player who attempts to make a return with the ball |
|
| The player who intercepts the pass |
|
| The player who blocks the kick |
|
| The player/s who hit the quarterback to the ground |
|
| The player/s who earn pass defended on incomplete pass |
|
| The player who muffs the catch |