Versions Compared
Version | Old Version 12 | New Version 13 |
---|---|---|
Changes made by | ||
Saved on |
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Table of Contents | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Feed Match Event
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 |
| Indicates where fumble action on the field happened | |
| 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 |
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 |
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 |
CompletePass
Code Block |
---|
{ "players$type": [ "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.CompletePass, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "yards": 0, "isNullified": false, "yardLine": null, "players": {[ { "id": "493258998871", "name"type": "Passer" }, { } "id": "758163", "type": "Receiver" ], } "yards": 11 } |
]
} |
Element | Type | Description |
---|---|---|
| Players array | Player data |
| integer($int32) | Indicates Air Yards + Yards after catch |
Interception
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.Interception, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "isNullified": false, "playersyardLine": [null, "players": [ { "id": "4932581072679", "name"type": "Passer" } } ] } |
]
} |
Element | Type | Description |
---|---|---|
| Players array | Player data |
FieldGoal
Code Block |
---|
"action": { "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.FieldGoal, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "isMade": true, "isNullified": false, "yards": 57, "yardLine": null, "yardsplayers": 55,[ { "yardLineid": null"998755", "type": "Kicker" "players":} [ { "id": "1080636", "type": "Kicker" } ] ] } |
Element | Type | Description |
---|---|---|
| boolean | Indicates whether FG was made |
| boolean | Indicates whether this action is nullified |
| integer($int32) | Indicates yards from there the FG was taken |
| Players array | Player data |
FieldGoalAttempt
Code Block |
---|
{ "action$type": { "$type": ""GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.FieldGoalAttempt, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "isNullified": false, "yardLine": null, "players": [ { "id": "1080636998755", "type": "Kicker" } } ] |
]
} |
Element | Type | Description |
---|---|---|
| Players array | Player data |
| boolean | Indicates whether this action was nullified |
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 |
---|
"action": { "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.TimeoutsRemaining, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "away": 3, "home": 23 ...} |
Element | Type | Description |
---|---|---|
| integer($int32) | Number of timeouts remaining for away team |
| integer($int32) | Number of timeouts remaining for home team |
Timeout
Code Block |
---|
{ "action$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.
Snap
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.Timeout, Snap, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "isConfirmed": false } |
Element | Type | Description |
---|---|---|
| boolean | Indicates if it is confirmed or not |
Touchdown
Code Block |
---|
{ "team$type": "Home", GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.Touchdown, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "isNullified": false, "gameTimeplayers": "00:01:03",[ { "periodid": {"998787", "type": "Scorer" } "number": 2,] } |
Element | Type | Description |
---|---|---|
| boolean | Indicates whether this action was nullified |
| Players array | Player data |
Single
Code Block |
---|
{ "progressStatusisNullified": "NotStarted", false, "typeplayers": "Regular"[ }, { "utcTimestamp": "2024-07-16T08:32:39.3504345Z" }, "messageTimestampUtcid": "2024-07-16T08:32:42.0264411Z" } |
No player or yards data. Just an event to record a timeout fact.
Snap
Code Block |
---|
493258", "action": { "$typename": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.Snap,"Kicker" } GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", ] "isConfirmed": false, ...} |
Element | Type | Description |
---|
isConfirmed
| boolean | Indicates |
Touchdown
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.TouchdownRun, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "yards": null, "isNullified": false, "players": [ { "id": "998787998871", "type": "ScorerRunner" } ] }, "messageTimestampUtc": "2024-07-16T08:26:17.6969013Z" } |
Element | Type | Description |
---|
isNullified
boolean
| integer($int32) | Indicates how many yards a player rushed |
| Players array | Player data |
RunAfterCatch
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.RunAfterCatch, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "yards": 26, "isNullified": false, "players": [ { "id": "493258998787", "name"type": "Kicker" Runner" } ] }} |
Element | Type | Description |
---|
isNullified
boolean
| integer($int32) | Indicates how many yards a player rushed |
|
Players array |
Player data |
id
integer($int32)
Unique kicker Id
name
string
two possible values: “Kicker” or null
Run
Kneel
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.Run, Kneel, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "yards": null, "isNullified": false, "yardLine": null, "players": [ { { ""id": "9988711072679", "type": "Runner" } ] } |
Element | Type | Description |
---|
yards
Indicates how many yards a player rushed
| Players array | Player data |
Tackle
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.RunAfterCatch, Tackle, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "yards": null, "yardLine": { "yards": 2622, "sideOfPitch": "Away" }, "isNullified": false, "players": [ { "id": "998787941270", "type": "RunnerTackler" } ] } |
Element | Type | Description |
---|---|---|
| Players array | Player data |
| integer($int32) | Indicates |
players
Players array
Player data
Kneel
where the tackle happened |
Comment
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.KneelComment, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "text": "2-Minute Warning" } |
Element | Type | Description |
---|---|---|
| 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": { "yardsscrimmageYard": null24, "sideOfPitch": "Home" }, "isNullifieddownNumber": false, 2, "yardLineyardsToGo": null13, "players": [ { "id": "1072679", "type"isConfirmed": false, "team": "Runner" } ] }Home" } |
Element | Type | Description |
---|
players
Players array
Player data
Tackle
| 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.
ClockStopped
Code Block |
---|
{
"$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.ClockStopped, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents"
} |
No player or yards data. Just an event to record a clock stop fact.
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
} |
yards
Element | Type | Description |
---|
players
Players array
Player data
| integer($int32) | team Id |
|
Indicates where the tackle happened
Comment
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.CommentConversionAttempt, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "type": "OnePoint", "isNullified": false, "yardLine": null, "players": [ { GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "text "id": "2-Minute Warning" "1080636", "type": "Kicker" } ] } |
Element | Type | Description |
---|
text
| string |
Comments provided by Feed Prodiver
($x-extensible-enum) [ Unknown, OnePoint, TwoPoints ] | Indicated the type of conversion attempt play | |
| boolean | Indicates whether this action was nullified |
OnePointConversion
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.NextPlay, OnePointConversion, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "isMade": true, "typeisNullified": nullfalse, "lineOfScrimmage"players": {[ { "scrimmageYardid": 24, "1080636", "sideOfPitchtype": "HomeKicker" } ] }, } |
Element | Type | Description |
---|---|---|
| boolean | Indicates whether this action was made or not |
| boolean | Indicates whether this action was nullified |
| Players array | Player data |
TwoPointsConversion
Code Block |
---|
{ "downNumber$type": 2, "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.TwoPointsConversion, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "isMade": false, "isNullified": false, "yardsToGoplayers": 13,[ { "isConfirmedid": false"1075217", "type": "Recoverer" "team": "Home"} ] } |
Element | Type | Description |
---|
type
string($x-extensible-enum)
[ Snap, Kickoff, Pat ]
Next Play Type
lineOfScrimmage
LOS data array
LOS data
scrimmageYard
integer($int32)
Scrimmage Yard Line
sideOfPitch
string($x-extensible-enum)
[ None, Home, Away ]
Indicates the side of the pitch if it’s home or away
downNumber
integer($int32)
Number of the next Down
yardsToGo
integer($int32)
Yards to go for successful
isConfirmed
boolean
Indicates if it is confirmed or not
team
string($x-extensible-enum)
[ None, Home, Away ]
Team data
Safety
| boolean | Indicates whether this action was made or not |
| Players array | Player data |
| boolean | Indicates whether this action was nullified |
OutOfBounds
Code Block |
---|
{ isNullified"yards": false, null, "players": [], } |
Element | Type | Description |
---|
isNullified
boolean
| integer($int32) | Indicates the yard line where out of bounds happened |
| Players array | Player data |
Touchback
Code Block |
---|
{ isNullified{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.Touchback, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "isNullified": false, "players": [],null } |
Element | Type | Description |
---|
isNullified
Indicates whether this action was nullified
| Players array | Player data |
Penalty
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.ClockStartedPenalty, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "type": "DefensiveOffside", "yards": 5, "outcome": "Accepted", "yardLines": [ GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents" } |
No player or yards data. Just an event to record a clock start fact.
ClockStopped
Code Block |
---|
{{ "type": "Placement", "$typeyards": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.ClockStopped22, "sideOfPitch": "Away" } ], "enforcementSpot": "PreviousSpot", GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents" } |
No player or yards data. Just an event to record a clock stop fact.
CoinToss
Code Block |
---|
{ "nextDown": "Repeats", "$typeplayers": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.CoinToss,[ { GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "id": "1014528", "winnerTeamtype": "AwayUnknown", } "wasDeferred": false, "awayChoice": "Receive", "homeChoice": null, } |
Element
Type
Description
winnerTeam
integer($int32)
team Id
wasDeferred
boolean
Indicates whether choice deferred or not
awayChoice
]
} |
Element | Type | Description |
---|---|---|
| string($x-extensible-enum) |
[ Kick, Receive, EndZone, NorthEndZone, EastEndZone, SouthEndZone, WestEndZone ]
Indicates the away team choice from the available options.
homeChoice
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($x-extensible-enum) [ Unknown, OnePoint, TwoPoints ] | Indicated the type of conversion attempt play |
| boolean | Indicates whether this action was nullified |
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 action was made or not |
| boolean | Indicates whether this action was nullified |
| Players array | Player data |
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 |
---|---|---|
| boolean | Indicates whether this action was made or not |
| Players array | Player data |
| boolean | Indicates whether this action was nullified |
OutOfBounds
Code Block |
---|
{
"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.Touchback,
GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents",
"isNullified": false,
"players": 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,
"outcome": "Accepted",
"yardLines": [
{
"type": "Placement",
"yards": 22,
"sideOfPitch": "Away"
}
],
"enforcementSpot": "PreviousSpot",
"nextDown": "Repeats",
"players": [
{
"id": "1014528",
"type": "Unknown"
}
],
} |
Element | Type | Description |
---|---|---|
| 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 |
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 |
---|---|---|
| integer($int32) | Indicates the yards gained |
| Players array | Player data |
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 |
---|---|---|
| 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
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 |
Return
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.SackReturn, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "subtype": "Tackled", "yards": 0, "isNullified": false, "yardLine": null, null, "playersyardLine": [{ "yards": 1, "sideOfPitch": "Home" }, { "isNullified": false, "subtype": null, "players": [ { "id": "9988711013138", "type": "Returner" } ] } |
Element | Type | Description |
---|---|---|
| integer($int32) | Indicates the yards gained |
| Players array | Player data |
Down
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.Down, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "typenumber": "Tackled"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) | Indicates yards behind the Scrimmage Line |
| Players array | Player data |
KickOff
Code Block |
---|
{
|
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
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.KickOff, Sack, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "subtype": null, "yardsTackled": 65, "yards": 0, "isNullified": false, "yardLine": null, "players": [ { "id": "998871", { "type": "Tackled" } ] } |
Element | Type | Description |
---|---|---|
| integer($int32) | Indicates yards behind the Scrimmage Line |
| Players array | Player data |
KickOff
Code Block |
---|
{ "id$type": "1080636GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.KickOff, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "subtype": null, "yards": 65, "typeisNullified": false, "Kickerplayers": [ { "id": "1080636", } "type": "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": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.YardsToEndzone, "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.YardsToEndzone, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "value": 65 } |
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 |
---|---|---|
| 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.PeriodChanged, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", } |
No player or yards data. Just an event to record a period change fact.
Punt
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.Punt, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "yards": null, "isNullified": false, "players": [ { "id": "1017141", "type": "Kicker" } "Kicker" } ], } |
Element | Type | Description |
---|---|---|
| integer($int32) | yards gained |
| Players array | Player data |
Risks
Code Block |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.Risks, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "touchdown": "NonActive", "onsideKick": "NonActive", "fieldGoal": "NonActive", "fourthDown": "NonActive", "safety": "NonActive", "challenge": "NonActive", "penalty": "NonActive", , "videoReview": "NonActive", "turnover": "NonActive", "other": "Active", "playAboutToStart": "NonActive", "injury": "NonActive", "bigPlay": "Active", "statDelay": "NonActive", } |
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 |
---|
{ "$type": "GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents.FairCatch, GeniusSports.Sports.AmericanFootball.Contracts.V2.MatchEvents", "yards": null, "isNullified": false, "yardLine": { "yards": 1, "sideOfPitch": "Away" }, "players": [ { "id": "1006701", "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 |
Lateral
Code Block |
---|
{ "IsNullified": false, "Yards": 5, "Players": [ { "Id": "493258", "Name": "Receiver" } ] } |
Element | Type | Description |
---|---|---|
| integer($int32) | Indicates how many yards was the lateral. |
| Players array | Player data |
| boolean | Indicates whether this action was nullified |
Other Match Events
Reliability
Code Block |
---|
{ "IsReliable": false, "Reason": "Unreliable score" } |
Element | Type | Description |
---|---|---|
| boolean | Indicates whether the current match events are reliable or not |
| string | Reason |
CurrentLineup
Code Block |
---|
"teamType": "Offensive", "players": [ { "position": "Quarterback", "side": "Middle", "id": "165525", "name": null, "status": "Started" }, { "position": "TightEnd", "side": "Middle", "id": "99040", "name": null, "status": "Started" }, { "position": "Tackle", "side": "Unknown", "id": "719357", "name": null, "status": "Started" }, { "position": "Tackle", "side": "Unknown", "id": "757902", "name": null, "status": "Unknown" }, { "position": "WideReceiver", "side": "Unknown", "id": "796224", "name": null, "status": "Started" }, { "position": "Tackle", "side": "Unknown", "id": "1017511", "name": null, "status": "Unknown" }, { "position": "RunningBack", "side": "Middle", "id": "1015480", "name": null, "status": "Unknown" }, { "position": "Center", "side": "Middle", "id": "1018160", "name": null, "status": "Unknown" }, { "position": "TightEnd", "side": "Middle", "id": "1011409", "name": null, "status": "Unknown" }, { "position": "TightEnd", "side": "Middle", "id": "1006903", "name": null, "status": "Unknown" }, { "position": "Tackle", "side": "Unknown", "id": "1014143", "name": null, "status": "Started" }, { "position": "Guard", "side": "Middle", "id": "1008250", "name": null, "status": "Started" }, { "position": "TightEnd", "side": "Middle", "id": "1008026", "name": null, "status": "Unknown" }, { "position": "Quarterback", "side": "Middle", "id": "1005917", "name": null, "status": "Unknown" }, { "position": "Tackle", "side": "Unknown", "id": "1014804", "name": null, "status": "Started" }, { "position": "WideReceiver", "side": "Unknown", "id": "1017215", "name": null, "status": "Unknown" }, { "position": "RunningBack", "side": "Middle", "id": "1028378", "name": null, "status": "Unknown" }, { "position": "WideReceiver", "side": "Unknown", "id": "1003947", "name": null, "status": "Unknown" }, { "position": "WideReceiver", "side": "Unknown", "id": "1009826", "name": null, "status": "Started" }, { "position": "WideReceiver", "side": "Unknown", "id": "1016007", "name": null, "status": "Started" }, { "position": "RunningBack", "side": "Middle", "id": "999394", "name": null, "status": "Started" }, { "position": "Guard", "side": "Middle", "id": "998896", "name": null, "status": "Unknown" }, { "position": "WideReceiver", "side": "Unknown", "id": "998934", "name": null, "status": "Unknown" }, { "position": "Guard", "side": "Middle", "id": "796929", "name": null, "status": "Unknown" }, { "position": "Guard", "side": "Middle", "id": "999405", "name": null, "status": "Started" } ], "team": "Home", "gameTime": "00:00:00", "period": null, "utcTimestamp": "2023-04-05T05:01:11.8805131Z" }, "messageTimestampUtc": "2023-04-05T05:01:19.6152104Z" |
Element | Type | Description |
---|---|---|
| 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 |
---|
{ "IsNullified": false "Players": [ { "Id": "835822", "Type": "Muffed" } ] } |
Element | Type | Description |
---|---|---|
| boolean | Indicates whether this action was nullified |
| Players array | Player data |
Recovery
Code Block |
---|
{ "Yards": 15 "IsNullified": false "Players": [ { "Id": "835822", "Type": "Recoverer" } ], } |
Element | Type | Description |
---|---|---|
| integer($int32) | Indicates the amount of yards from the point where opponents recovered the ball to the point where the play finished |
| boolean | Indicates whether this action was nullified |
| Players array | Player data |
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 |