Page Comparison

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
`SportId`	Integer	Sport Identifier (17 for American Football)
`FixtureId`	String	Unique fixture identifier
`Source`	String	Feed Provider information
`SequenceId`	Integer	Sequence Id of feed match events
`ActionId`	Integer	Unique match action identifier
`InsertedBeforeActionId`	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)
`IsCancelled`	boolean	Indicates whether the action is cancelled
`IsConfirmed`	boolean	Indicates whether the action is confirmed
`IsModified`	boolean	Indicates whether the action is modified
`Action`	Match action array	Consists of Match Action data properties
`MessageTimestampUtc`	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": "Away", "GameTime": "00:00:00", "Period": { "Number": 1, "ProgressStatus": "NotStarted", "Type": "Regular" }, "UtcTimestamp": "2022-05-19T09:24:26.7008204Z"

Element	Type	Description
`Team`	string($x-extensible-enum) [ None, Home, Away ]	Team data
`GameTime`	string($date-span)	Game time data
`Period`	Period array	Period in the game data
`Number`	integer($int32)	Period number
`ProgressStatus`	string($x-extensible-enum) [ NotStarted, InProgress,

Finished

Complete ]

Period progress status

Type

string($x-extensible-enum)

[ Regular, Overtime ]

Period type data

UtcTimestamp

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

{

Players

subtype":

[ { "Id": "835822", "Type": "Tackler" } ], "Yards": 40, "TeamInPossession

null,
            "yards": 33,
            "yardLine": {
                "yards": 33,
                "sideOfPitch": "Home"
            },
            "teamInPossession": "None",

}

Element	Type	Description
`Players`	Player array	Player data
`Id`	integer($int32)	Unique player Id
`Type`	string	Type of action perfomed by the player
`Yards`	integer($int32)	Yards where the ball was recovered/fumbled
`TeamInPossession`	string($x-extensible-enum) [ None, Home, Away ]	Team in possession

PassAttempt (called Pass in v1)

Code Block

{

       "isNullified": false,

"Players

        "players": [
                {
                    "

Id

id": "

493258

1014921",
                    "

Name

type": "

Passer

Fumbled"
                }
            ]

}

Element	Type	Description
`Players`	Players array	Player data

IncompletePass

Code Block

      "team": "Home",

{

Players

gameTime":

[

"00:00:00",

{

"period": null,

"Id

"utcTimestamp": "

493258", "Name": "Passer" } ] }

Element

2023-10-23T00:45:16.9535449Z"

Element	Type	Description
`Players`

Players

Player array

Player data

CompletePass

Code Block { "Players": [

`subtype`	string($x-extensible-enum) [FumbledSnap, FumbledHandOff],	Indicates second level of action description
`yardline`		Indicates where fumble action on the field happened
`Id`	integer($int32)	Unique player Id
`Type`	string	Type of action performed by the player
`Yards`	integer($int32)	Yards where the ball was recovered/fumbled
`TeamInPossession`	string($x-extensible-enum) [ None, Home, Away ]	Team in possession

PassAttempt (called Pass in v1)

Code Block
{

{

"Players": [
                {
                    "Id": "493258",
                    "Name": "Passer"
                }
            ]

,

"Yards": 11

Interception

Code Block

Element	Type	Description
`Players`	Players array	Player data

Yards

integer($int32)

Indicates Air Yards + Yards after catch

IncompletePass

Code Block
{ "Players": [ { "Id": "493258", "Name": "Passer" } ] }

Element	Type	Description
`Players`	Players array	Player data

FieldGoal

CompletePass

Code Block
{ "Players": [

"IsMade":

true,

"IsNullified":

false,

Yards

Id":

23

"493258",

"Players":

[

       "Name": "Passer"

{

        }
            ],
            "

Id

Yards":

"493258",

11
		}

Element	Type	Description
`Players`	Players array	Player data
`Yards`	integer($int32)	Indicates Air Yards + Yards after catch

Interception

Code Block
{ "Players": [

"Name":

"Kicker"

}

] }

Element	Type	Description
`IsMade`	boolean	Indicates whether FG was made
`IsNullified`	boolean	Indicates whether this action was nullified
`Yards`	integer($int32)	Indicates yards from there the FG was taken
`Players`	Players array	Player data

FieldGoalAttempt

Code Block { "Players": [

 "Id": "493258",

{

"Id

"Name": "

493258

Passer"

,

"Name":

"Kicker"

        ]
        }

Element	Type	Description
`Players`	Players array	Player data

FieldGoal

Code Block
{ "IsMade":

]

true,
            "IsNullified": false,

}

Element	Type	Description
`Players`	Players array	Player data
`IsNullified`	boolean	Indicates whether this action was nullified

FieldGoalBlocked

Code Block {

    "Yards": 23,
            "Players": [
                {
                    "Id": "493258",
                    "Name": "Kicker"
                }
            ]

, "IsNullified": false }

Element

Type

Description

Element	Type	Description
`IsMade`	boolean	Indicates whether FG was made
`IsNullified`	boolean	Indicates whether this action was nullified
`Yards`	integer($int32)	Indicates yards from there the FG was taken
`Players`	Players array	Player data

IsNullified

FieldGoalAttempt

TimeoutsRemaining

Code Block
{ "Players": [

"Away": 2,

"Home":

3

}

Element	Type	Description
`Away`	integer($int32)	Number of timeouts remaining for away team
`Home`	integer($int32)	Number of timeouts remaining for home team

Timeout

Code Block
{ }

No player or yards data. Just an event to record a timeout fact.

Snap

Code Block
{ "IsConfirmed": false }

Element	Type	Description
`IsConfirmed`	boolean	Indicates if it is confirmed or not

Touchdown

Code Block {

 "Id": "493258",
                    "Name": "Kicker"
                }
            ],
            "IsNullified": false

,

Element	Type	Description
`Players`	Players array	Player data
`IsNullified`	boolean	Indicates whether this action was nullified

FieldGoalBlocked

Code Block
{ "Players": [ { "Id": "493258", "Name": "

Scorer

Kicker"
                }
            ],

}

    "IsNullified": false
        }

Element	Type	Description

IsNullified

boolean

Indicates whether this action was nullified

Players

Players array

Player data

Single

IsNullified

TimeoutsRemaining

Code Block
{ "

IsNullified

Away":

false

2,
            "

Players

Home":

[

{

Element	Type	Description
`Away`	integer($int32)	Number of timeouts remaining for away team
`Home`	integer($int32)	Number of timeouts remaining for home team

Timeout

Code Block
{ }

No player or yards data. Just an event to record a timeout fact.

Snap

Code Block
{ "IsConfirmed": false }

Element	Type	Description
`IsConfirmed`	boolean	Indicates if it is confirmed or not

Touchdown

Code Block
{ "

Id

IsNullified":

"493258",

false,
            "Players": [

"Name": "Kicker"

}

        "Id": "493258",

]

}

Element

Type

        "Name": "Scorer"
                }
            ]
        }

Element	Type	Description
`IsNullified`	boolean	Indicates whether this action was nullified
`Players`

Player data

Players array

Kicker player

Run

Player data

Id

integer($int32)

Unique kicker Id

Name

string

two possible values: “Kicker” or null

Single

Code Block
{ "

Yards

IsNullified":

2

false,
            "Players": [

{ "Id": "835822", "Type": "Runner" } ] }

Element	Type	Description
`Yards`	integer($int32)	Indicates how many yards a player rushed
`Players`	Players array	Player data

RunAfterCatch

Code Block {

"Yards":

2,

Players

Id": "493258",

[ { "Id

                   "Name": "

835822

Kicker"

,

"Type":

"Runner"

}

]

}

Element	Type	Description
`Yards`	integer($int32)	Indicates how many yards a player rushed
`Players`	Players array	Player data

Kneel

Code Block {

"Players":

[ { "Id": "835822", "Type": "Runner" } ],

           ]
        }

Element	Type	Description
`IsNullified`	boolean	Indicates whether this action was nullified
`Players`

Players

Player data array

Player

Kicker player data

Tackle


`Id`	integer($int32)	Unique kicker Id
`Name`	string	two possible values: “Kicker” or null

Run

Code Block
{ "

Players

Yards":

[

2,
            "Players": [
				{
					"Id": "835822",
					"Type": "

Tackler

Runner"
				}
			]

,

"Yards": null

Element	Type	Description

Players

Players array

Player data


`Yards`	integer($int32)	Indicates

where the tackle happenedComment

how many yards a player rushed
`Players`	Players array	Player data

RunAfterCatch

Code Block
{

"Text


            "Yards":

"2-Minute Warning" }

Element	Type	Description
`Text`	string	Comments provided by Feed Prodiver

NextPlay

Code Block

2,
            "Players": [
				{
					"

Type

Id": "

Snap

835822",

"LineOfScrimmage": { "ScrimmageYard": 40,

					"Type": "Runner"
				}
			]
		}

Element	Type	Description
`Yards`	integer($int32)	Indicates how many yards a player rushed
`Players`	Players array	Player data

Kneel

Code Block
{ "

SideOfPitch

Players": [
				{
					"

Away

Id"

}, "DownNumber": 1,

: "835822",
					"Type": "Runner"
				}
			],
		}

Element	Type	Description
`Players`	Players array	Player data

Tackle

Code Block
{

"YardsToGo": 10

  "Players": [
				{
					"Id": "835822",
					"Type": "Tackler"
				}
			],
            "

IsConfirmed

Yards":

trueScrimmageYard

null
		}

Element	Type	Description
`Players`

Type

string($x-extensible-enum)

[ Snap, Kickoff, Pat ]

Next Play Type

LineOfScrimmage

LOS data array

LOS data

Safety

Code Block
{ IsNullified: false, "Players": [], }

Element	Type	Description
`IsNullified`	boolean	Indicates whether this action was nullified
`Players`	Players array	Player data

OnePointSafety

Code Block { IsNullified: false, "Players": [],

Players array	Player data
`Yards`	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

ClockSet

Code Block
{ }

No player or yards data. Just an event to record a clock set fact.

ClockStarted

Code Block
{ }

No player or yards data. Just an event to record a clock start fact.

ClockStopped

Code Block
{ }

No player or yards data. Just an event to record a clock stop fact.

CoinToss

Indicates where the tackle happened

Comment

Code Block
{ "Text": "2-Minute Warning" }

Element	Type	Description
`Text`	string	Comments provided by Feed Prodiver

NextPlay

Code Block
{ "Type": "Snap", "LineOfScrimmage": { "ScrimmageYard": 40, "SideOfPitch": "Away" }, "DownNumber": 1, "YardsToGo": 10, "IsConfirmed": true "Team": "Home" }

Element	Type	Description

IsNullified

boolean

Indicates whether this action was nullified

Players

Players array

Player data

`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

Code Block
{

"WinnerTeam"

IsNullified:

null

false,
			"Players": [],

"WasDeferred"

Element	Type	Description
`IsNullified`	boolean	Indicates whether this action was nullified
`Players`	Players array	Player data

OnePointSafety

Code Block
{ IsNullified: false,

"AwayChoice": "Receive", "HomeChoice": "EastEndZone"ConversionAttempt

			"Players": [],
		}

Element	Type	Description

WinnerTeam

integer($int32)

team Id

WasDeferred

boolean

Indicates whether choice deferred or not

AwayChoice

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.

`IsNullified`	boolean	Indicates whether this action was nullified
`Players`	Players array	Player data

ClockSet

Code Block
{ }

No player or yards data. Just an event to record a clock set fact.

ClockStarted

Code Block
{ }

No player or yards data. Just an event to record a clock start fact.

ClockStopped

Code Block
{ }

No player or yards data. Just an event to record a clock stop fact.

CoinToss

Code Block
{ "

Type

WinnerTeam": null,

"TwoPoints"

      "WasDeferred": false,
            "

IsNullified

AwayChoice":

false }

 "Receive",
            "HomeChoice": "EastEndZone",
		}

Element	Type	Description

Type

WinnerTeam

integer($int32)

team Id

WasDeferred

boolean

Indicates whether choice deferred or not

AwayChoice

string($x-extensible-enum)

[

Unknown, OnePoint, TwoPoints ]

Indicated the type of conversion attempt play

IsNullified

boolean

Indicates whether this action was nullified

OnePointConversion

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
{ "

IsMade

Type":

true

"TwoPoints",
            "IsNullified": false
		}

Element

Type

Description

Type

string($x-extensible-enum)

[ Unknown, OnePoint, TwoPoints ]

Indicated the type of conversion attempt play

IsNullified

boolean

Indicates whether this action was nullified

OnePointConversion

Code Block
{ "IsMade": true, "

Players

IsNullified":

[

false,
            "Players": [
				{
					"Id": "835822",
					"Type": "Tackler"
				}
			]
		}

Element	Type	Description
`IsMade`	boolean	Indicates whether this action was made or not
`IsNullified`	boolean	Indicates whether this action was nullified
`Players`	Players array	Player data

TwoPointsConversion

Code Block
{ "IsMade": false, "Players": [ { "Id": "835822", "Type": "Tackler" } ], "IsNullified": false }

Element	Type	Description
`IsMade`	boolean	Indicates whether this action was made or not
`Players`	Players array	Player data
`IsNullified`	boolean	Indicates whether this action was nullified

OutOfBounds

Code Block
{ "Yards": null, "Players": [], }

Element	Type	Description
`Yards`	integer($int32)	Indicates the yard line where out of bounds happened
`Players`	Players array	Player data

Touchback

Code Block
{ "Players": [], }

Element	Type	Description
`Players`	Players array	Player data

Penalty

Code Block
{

Type

type": "

OffensiveHolding

DefensiveOffside",
            "

Yards

yards":

10

5,
            "

Outcome

outcome": "Accepted",
            "

Players

yardLines": [

{ "Id


                {
                    "type": "

835822

Placement",

"Type": "Unknown" } ], }

Element	Type	Description
`Type`	string($x-extensible-enum) Unknown, BlockBelowWaist, BlockingDownfield, BlockingOutOfBounds, ChopBlock, Clipping, ContactingTheKicker, CutBlocking, Defensive12OnField, DefensiveDelayOfGame, DefensiveHolding, DefensiveOffside, DefensivePassInterference, DefensiveTooManyMenOnField, DelayOfGame, DelayOfKickoff, DisconcertingSignals, Disqualification, Encroachment, EquipmentViolation, EquipmentViolationHazardou, FaceMask, FairCatchInterference, FalseStart, Fighting, Holding, HoldingReturn, HorseCollarTackle, Hurdling, IllegalBat, IllegalBlindsideBlock, IllegalBlock, IllegalBlockAboveTheWaist, IllegalBlockAboveWaist, IllegalBlockAfterFcSignal, IllegalBlockInBack, IllegalBlockOnReturn, IllegalContact, IllegalContactOnReceiver, IllegalContactWithSnapper, IllegalCrackback, IllegalCut, IllegalDeploymentOfDesignatedQbOrImport, IllegalDoubleTeamBlock, IllegalDownfieldOnKick, IllegalFormation, IllegalForwardPass, IllegalHandoffPass, IllegalInterferenceCover, IllegalInterferenceOnLooseBall, IllegalKickoffOutOfBounds, IllegalMotion, IllegalParticipation, IllegalPeelback, IllegalShift, IllegalSnap, IllegalSubstitution, IllegalTouch, IllegalTouchKick, IllegalTouchOfKick, IllegalTouchPass, IllegalUseOfHands, IllegalWedge, IllegallyKickingBall, IneligibleDownfieldKick, IneligibleDownfieldOnPass, IneligibleDownfieldPass, IneligibleReceiver, IntentionalGrounding, InterferenceWithOpportunityToCatch, InvalidFairCatchSignal, KickCatchInterference, KickoffOutOfBounds, LateStart, Leaping, LegWhips, Leverage, LowBlock, LoweringHeadToInitiateContact, NeutralZoneInfraction, NoYards15, NoYards5, ObjectionableConduct, Offensive12OnField, OffensiveHolding, OffensiveOffside, OffensivePassInterference, OffensiveTooManyMenOnField, Offside, OffsideOnFreeKick, OffsideOnFreekick, PassInterference, PersonalFoul, PhysicalAbuseOnOfficial, PilingOn, PlayerOutOfBoundsOnKick, PlayerOutOfBoundsOnPunt, ProcedureGeneral, ProcedureIllegalFormation, ProcedureNoEnd, PuntOutOfBoundsInFlight, PushBlocking, Pyramiding, ReturnFromOutOfBounds, RoughPlay, RoughingHolder, RoughingTheKicker, RoughingThePasser, RoughingThePasserGrade2, RunningIntoHolder, RunningIntoTheKicker, ShortFreeKick, SidelineInterference, Spearing, SpearingGrade2, Spitting, Targeting, Taunting, TimeViolationAfter3MinuteWarning, TimeViolationAfter3MinuteWarningIntentional, TimeViolationAfter3MinuteWarningUnintentional, TimeViolationBefore3MinuteWarning, TooManyPlayers, TooManyPlayersInTheFormation, Tripping, UnauthorizedPersonOnField, UnnecessaryRoughness, UnnecessaryRoughnessMajor, UnnecessaryRoughnessMajorGrad, UnsportsmanlikeConduct	Penalty type
`Yards`	integer($int32)	Indicates the amount of yards team was penalized based on the penalty type
`Outcome`	string($x-extensible-enum) Unknown, Accepted, Declined, Offsetting, Superseded	Outcome of the penalty
`Players`	Players array	Player data

Return

Code Block { "Yards": 28,


                    "yards": 39,
                    "sideOfPitch": "Home"
                }
            ],
            "enforcementSpot": "PreviousSpot",
            "nextDown": "Repeats",
            "players": [
                {
                    "id": "1006731",
                    "type": "Unknown"
                }
		}

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, 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
`Yards`	integer($int32)	Indicates the amount of yards team was penalized based on the penalty type
`Outcome`	string($x-extensible-enum) Unknown, Accepted, Declined, Offsetting, Superseded	Outcome of the penalty
`YardLines`	Yardlines array	Indicates enforcement and placement yardlines of the penalty if both available.
`EnforcementSpot`	string($x-extensible-enum) Unknown, Accepted, Declined, Offsetting, Superseded	Indicates where the penalty is enforced from. Available options: [Unknown, DeadBall, OtherSpot, PreviousSpot, SuccedingSpot]
`NextDown`	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`	Players array	Player data

Return

Code Block
{ "Yards": 28, "Players": [ { "Id": "835822", "Type": "Returner" } ], }

Element	Type	Description
`Yards`	integer($int32)	Indicates the yards gained
`Players`	Players array	Player data

Down

Code Block
{ "Number": 2, "YardsToGo": 8, "ScrimmageYard": 22, "EndedAtGameTime": null, "EndedAtUtc": null, "Description": "(14:23) (No Huddle) D.Dallas right guard to SEA 25 for 3 yards (Jon.Allen)." }

Element	Type	Description
`Number`	integer($int32)	Number of the Down in a Play
`YardsToGo`	integer($int32)	Indicates yards to go for a successful down
`ScrimmageYard`	integer($int32)	Scrimmage Yard line
`EndedAtGameTime`	string($date-span)	game clock data
`EndedAtUtc`	string($date-span)	time of the day
`Description`	string	Description by Feed Provider

Sack

Code Block
{ "Yards": -4, "Players": [ { "Id": "835822", "Type": "Tackled" } ] }

Element	Type	Description
`Yards`	integer($int32)	Indicates yards behind the Scrimmage Line
`Players`	Players array	Player data

KickOff

Code Block
"subtype": null, "yards": 65, "isNullified": false, "players": [ { "id": "998755", "type": "Kicker" } ],

Element	Type	Description
`Yards`	integer($int32)	Indicates how far (in terms of yards) the ball was kicked
`Players`	Players array	Player data

Possession

Code Block
{ }

No player or yards data. Just an event to record a possession of the ball fact.

YardsToEndzone

Code Block
{ "Value": 76 }

Element	Type	Description
`Value`	integer($int32)	Indicates yards to End Zone

MatchStatusChanged

Code Block
{ "MatchStatus": "Finished" }

Element

Type

Description

MatchStatus

string($x-extensible-enum)

[ Unknown, NotStarted, Warmup, InProgress, Postponed, Finished, Interrupted, CoverageStopped, Abandoned, Cancelled, Delayed ]

Indicates match status

PeriodChanged

Code Block
{ }

No player or yards data. Just an event to record a period change fact.

Punt

Code Block
{ "Yards": 53, "Players": [ { "Id": "835822", "Type": "Kicker" } ] }

Element	Type	Description
`Yards`	integer($int32)	yards gained
`Players`	Players array	Player data

Risks

Code Block

		{
			"Touchdown": "NonActive",
            "OnsideKick": "NonActive",
            "FieldGoal": "NonActive",
            "FourthDown": "NonActive",
            "Safety": "NonActive",
            "Challenge": "NonActive",
            "Penalty": "NonActive",
            "VideoReview": "NonActive",
            "Turnover": "NonActive",
            "PlayAboutToStart": "NonActive",
            "injury": "Active",
            "bigPlay": "Active",
            "statDelay": "Active"
            "Other": "Active"		
		}

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`	string($x-extensible-enum) [ Unknown, Active, NonActive ]	Other risk

FairCatch

Code Block
{ "Yards": null, "Players": [ { "Id": "835822", "Type": "Receiver" } ], }

Element	Type	Description
`Yards`	integer($int32)	yard line
`Players`	Players array	Player data

Challenge

Code Block
{ "Result": "Won" }

Element

Type

Description

Result

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
`Yards`	integer($int32)	Indicates how many yards was the lateral.
`Players`	Players array	Player data
`IsNullified`	boolean	Indicates whether this action was nullified

Other Match Events

Reliability

Code Block
{ "IsReliable": false, "Reason": "Unreliable score" }

Element	Type	Description
`IsReliable`	boolean	Indicates whether the current match events are reliable or not
`Reason`	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"
                },
                {

"Players":

[

{

Id

position": "

835822

RunningBack",

"Type":

"Returner"

}

], }

Element	Type	Description
`Yards`	integer($int32)	Indicates the yards gained
`Players`	Players array	Player data

Down

Code Block { "Number": 2,

YardsToGo

side":

8,

"Middle",
                    "

ScrimmageYard

id":

22

"999394",

"EndedAtGameTime

        "name": null,
                    "

EndedAtUtc

status":

null,

"Started"

"Description": "(14:23) (No Huddle) D.Dallas right guard to SEA 25 for 3 yards (Jon.Allen)." }

Element	Type	Description
`Number`	integer($int32)	Number of the Down in a Play
`YardsToGo`	integer($int32)	Indicates yards to go for a successful down
`ScrimmageYard`	integer($int32)	Scrimmage Yard line
`EndedAtGameTime`	string($date-span)	game clock data
`EndedAtUtc`	string($date-span)	time of the day
`Description`	string	Description by Feed Provider

Sack

Code Block { "Yards": -4,

},
                {

"Players":

[

{

Id

position": "

835822

Guard",

"Type": "Tackled" } ] }

Element	Type	Description
`Yards`	integer($int32)	Indicates yards behind the Scrimmage Line
`Players`	Players array	Player data

KickOff

Code Block { "Yards": 9


                    "side": "Middle",

"Players": [ { "Id

        "id": "

835822

998896",

"Type": "Kicker" } ] }

Element	Type	Description
`Yards`	integer($int32)	Indicates how far (in terms of yards) the ball was kicked
`Players`	Players array	Player data

Possession

Code Block
{ }

No player or yards data. Just an event to record a possession of the ball fact.

YardsToEndzone

Code Block
{ "Value": 76 }

Element	Type	Description
`Value`	integer($int32)	Indicates yards to End Zone

MatchStatusChanged

Code Block
{ "MatchStatus": "Finished" }

Element

Type

Description

MatchStatus

string($x-extensible-enum)

[ Unknown, NotStarted, Warmup, InProgress, Postponed, Finished, Interrupted, CoverageStopped, Abandoned, Cancelled, Delayed ]

Indicates match status

PeriodChanged

Code Block
{ }

No player or yards data. Just an event to record a period change fact.

Punt

Code Block { "Yards": 53

                    "name": null,
                    "status": "Unknown"
                },

"Players": [ { "Id": "835822", "Type": "Kicker" } ] }

Element	Type	Description
`Yards`	integer($int32)	yards gained
`Players`	Players array	Player data

Risks

Code Block { "Touchdown": "NonActive",

    {
                    "

OnsideKick

position": "

NonActive

WideReceiver",

"FieldGoal

      "side": "

NonActive

Unknown",
                    "

FourthDown

id": "

NonActive

998934",
                    "

Safety

name":

"NonActive"

null,

"Challenge

       "status": "

NonActive

Unknown"

,

"Penalty":

"NonActive",

},

"VideoReview":

"NonActive",

"Turnover":

"NonActive",

PlayAboutToStart

position":

"NonActive",

"Guard",

"Other": "Active" }

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`	string($x-extensible-enum) [ Unknown, Active, NonActive ]	Other risk

FairCatch

Code Block
{ "Yards": null, "Players": [ { "Id": "835822", "Type": "Receiver" } ], }

Element	Type	Description
`Yards`	integer($int32)	yard line
`Players`	Players array	Player data

Challenge

Code Block
{ "Result": "Won" }

Element

Type

Description

Result

string($x-extensible-enum)

[ Unknown, Won, Lost ]

Result of the challenge

Other Match Events

Reliability

Code Block { "IsReliable": false,

 "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"
            },
            "

Reason

messageTimestampUtc": "

Unreliable score" }

Players

Array Of Lineup Player

Lineup players array

2023-04-05T05:01:19.6152104Z"

Element	Type	Description

IsReliable

boolean

Indicates whether the current match events are reliable or not

Reason

string

Reason

CurrentLineup

Code Block
{ "TeamType": null, "Players": {} }

Element

Type

Description

TeamType

string
[Unknown, Offensive, Defensive, Special]

Type of the team players are assigned to

`TeamType`	string [Unknown, Offensive, Defensive, Special]	Type of the team players are assigned to
`Players`	Array Of Lineup Player	Lineup players array
`id`	string	Indicates an Unique id of the player
`position`	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] For CFL there is also available options: [Kickreturner, Nosetackle, Slotback, Puntreturner]
`side`	string	Indicates the side of the player. Available options: [Unknown, Right, Middle, Left]
`status`	string	Indicates the status of the player during the game. Available options: Started - Player was in the starting 11 Substituted - Player took part for at least one play during the match and was not in the Starting 11 ActiveNotPlayed - Player was dressed up for the game but did not play NotActive - Player was not dressed up for the game Unknown - Player status in not known

Muff

Code Block
{ "IsNullified": false "Players": [ { "Id": "835822", "Type": "Muffed" } ] }

Element	Type	Description
`IsNullified`	boolean	Indicates whether this action was nullified
`Players`	Players array	Player data

Recovery

Code Block
{ "Yards": 15 "IsNullified": false "Players": [ { "Id": "835822", "Type": "Recoverer" } ], }

Element	Type	Description
`Yards`	integer($int32)	Indicates the amount of yards from the point where opponents recovered the ball to the point where the play finished
`IsNullified`	boolean	Indicates whether this action was nullified
`Players`	Players array	Player data

Players

Player type	Valid action types	Explanation
`Unknown`

Penalty

This action type is currently used in penalties

-	Not used
`Tackled`	`Tackle` `Sack` `Fumble`	The player that was tackled
`Tackler`	`Tackle` `Sack` `Fumble`	The player who tackled, in case of `Tackle` - primary tackler
`TackleAssister`	`Tackle`	The player who assisted tackling in the tackle (secondary tackler). Tackle can have two tackle assisters and no tackler
`Scorer`	`Touchdown`	The player who scored the points
`Receiver`	`PassAttempt`

CompletePass

CompletedPass IncompletePass Interception FairCatch

TwoPointsConversion

ConversionAttempt ConversionMade ConversionMissed Lateral

The player who is the intended receiver for a pass or fair catch. In case of conversions, only for two point conversion when

pass

it is

attempted

passed
`Passer`	`PassAttempt`

CompletePass

CompletedPass IncompletePass Interception

TwoPointsConversion

ConversionAttempt ConversionMade ConversionMissed

The player who passed the ball. In case of conversions, only for two point conversion when

pass

it is

attempted

passed
`Fumbled`	`Fumble`	The player who fumbled the ball

Fumbler

Fumble

The player/s who forced the fumble

`Recoverer`	`Recovery` `Fumble`	The player who recovered the ball
`Kicker`	`KickOff` `Punt` `FieldGoalAttempt`

FieldGoal FieldGoalBlocked OnePointConversion

`FieldGoalMade` `FieldGoalBlocked` `FieldGoalMissed` `ConversionAttempt` `ConversionMade` `ConversionMissed` `ConversionBlocked`	The play who kicked the ball. In case of conversions, only for one point conversion
`Runner`	`Run` `RunAfterCatch` `Kneel`

TwoPointsConversion

`ConversionAttempt` `ConversionMade` `ConversionMissed` `Fumble`	The player who runs with the ball. In case of conversions, only for two point conversion when it is rushed
`Returner`	`Return`	The player who attempts to make a return with the ball
`Interceptor`	`Interception`	The player who intercepts the pass
`Blocker`	`FieldGoalAttempt` `FieldGoalBlocked`

OnePointConversion

ConversionAttempt ConversionBlocked Punt

PuntBlocked

The player who blocks the kick

QbHitter

PassAttempt

CompletePass

`CompletedPass` `IncompletePass` `Sack`	The player/s who hit the quarterback to the ground
`PassDefender`	`PassAttempt` `IncompletePass`	The player/s who earn pass defended on incomplete pass
`Muffed`	`Muff`	The player who muffs the catch

Version	Old Version 5	New Version Current
Changes made by	Martin Kuks	Iryna Antonova
Saved on	Mar 21, 2023	Dec 05, 2024

Page Comparison

Versions Compared

Key

Feed Match Event

Feed Match Action

Actions

Fumble

PassAttempt (called Pass in v1)

IncompletePass

CompletePass

PassAttempt (called Pass in v1)

Interception

IncompletePass

CompletePass

Interception

FieldGoalAttempt

FieldGoal

FieldGoalBlocked

FieldGoalAttempt

TimeoutsRemaining

Timeout

Snap

Touchdown

FieldGoalBlocked

TimeoutsRemaining

Timeout

Snap

Touchdown

Run

Single

RunAfterCatch

Kneel

Run

RunAfterCatch

NextPlay

Kneel

Tackle

Safety

OnePointSafety

ClockSet

ClockStarted

ClockStopped

Comment

NextPlay

Safety

OnePointSafety

ClockSet

ClockStarted

ClockStopped

CoinToss

ConversionAttempt

OnePointConversion

TwoPointsConversion

OutOfBounds

Touchback

Penalty

Return

Return

Down

Sack

KickOff

Possession

YardsToEndzone

MatchStatusChanged

PeriodChanged

Punt

Risks

FairCatch

Challenge

Lateral

Other Match Events

Reliability

CurrentLineup

Down

Sack

KickOff

Possession

YardsToEndzone

MatchStatusChanged

PeriodChanged