Versions Compared

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/matchevents

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 ]

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
		{
			"Fumbler": {
				"Id": "835822",
				"Name": null
			},
			"Recoverer": null,
			"Yards": 40,
			"TeamInPossession": "None",
		}

Element

Type

Description

Fumbler

Fumbler Player array

Fumbler action data

Id

integer($int32)

Unique player Id

Name

string

Player name

Recoverer

integer($int32)

Unique player Id

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
	    {
            "Passer": {
                "Id": "493258",
                "Name": null
            },
        }

Element

Type

Description

Passer

Passer data array

Passer data

Id

integer($int32)

Unique player Id

Name

string

Player name

IncompletePass

Code Block
{
}

No player or yards data. Just an event to record an incomplete pass fact.

CompletePass

Code Block
		{
			"Receiver": {
                "Id": "1005455",
                "Name": null
            },
            "Yards": 11
		}

Element

Type

Description

Receiver

Receiver data array

Receiver data

Id

integer($int32)

Unique player Id

Name

string

Player name

Yards

integer($int32)

Indicates Air Yards + Yards after catch

Interception

Code Block
		{
            "Player": {
                "Id": "796218",
                "Name": null
        }

Element

Type

Description

Player

Interception player data array

Interception player data

Id

integer($int32)

Unique player Id

Name

string

Player name

FieldGoal

Code Block
		{
            "IsMade": true,
            "IsNullified": false,
            "Yards": 23,
            "Player": {
                "Id": "1014731",
                "Name": null
		}

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

Player

FG player data array

FG player data

Id

integer($int32)

Unique player Id

Name

string

Player name

FieldGoalAttempt

Code Block
		{
            "IsNullified": false
        }

Element

Type

Description

IsNullified

boolean

Indicates whether this action was nullified

TimeoutsRemaining

Code Block
		{
            "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
		{
            "IsNullified": false,
            "Player": {
                "Id": "935576",
                "Name": null
        }	

Element

Type

Description

IsNullified

boolean

Indicates whether this action was nullified

Player

Player data array

Touchdown player data

Id

integer($int32)

Unique player Id

Name

string

Player name

Single

Code Block
		{
            "IsNullified": false,
            "Players": [
                {
                    "Id": "493258",
                    "Name": "Kicker"
                }
            ]
        }

Element

Type

Description

IsNullified

boolean

Indicates whether this action was nullified

Players

Player data array

Kicker player data

Id

integer($int32)

Unique kicker Id

Name

string

two possible values: “Kicker” or null

Run

Code Block
		{
            "Yards": 2,
            "Player": {
                "Id": "1085742",
                "Name": null
		}

Element

Type

Description

Yards

integer($int32)

Indicates how many yards a player rushed

Player

Player data array

Run player data

Id

integer($int32)

Unique player Id

Name

string

Player name

Tackle

Code Block
		{
            "Tackler": {
                "Id": "1014275",
                "Name": null
            },
            "Tackled": null,
            "Yards": null
		}

Element

Type

Description

Tackler

Player data array

Tackle player data

Id

integer($int32)

Unique player Id

Name

string

Player name

Tackled

integer($int32)

Unique player Id

Yards

integer($int32)

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
		}

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

Safety

Code Block
		{
			IsNullified: false,
			"Player": null
		}

Element

Type

Description

IsNullified

boolean

Indicates whether this action was nullified

Player

integer($int32)

Unique player Id

OnePointSafety

Code Block
		{
			IsNullified: false,
			"Player": null
		}

Element

Type

Description

IsNullified

boolean

Indicates whether this action was nullified

Player

integer($int32)

Unique player Id

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
		{
			"WinnerTeam": null,
            "WasDeferred": false,
            "AwayChoice": "Receive",
            "HomeChoice": "EastEndZone",
		}

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.

ConversionAttempt

Code Block
		{
			"Type": "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,
            "IsNullified": false,
            "Player": {
                "Id": "835715",
                "Name": null
            }
		}

Element

Type

Description

IsMade

boolean

Indicates whether this action was made or not

IsNullified

boolean

Indicates whether this action was nullified

Player

Player data array

Player data

Id

integer($int32)

Unique player Id

Name

string

Player name

TwoPointsConversion

Code Block
		{
			"IsMade": false,
            "Passer": null,
            "Receiver": null,
            "IsNullified": false
		}

Element

Type

Description

IsMade

boolean

Indicates whether this action was made or not

Passer

integer($int32)

Unique player Id

Receiver

integer($int32)

Unique player Id

IsNullified

boolean

Indicates whether this action was nullified

OutOfBounds

Code Block
		{
			"Yards": null,
            "Player": {
                "Id": "835822",
                "Name": null
            }
		}

Element

Type

Description

Yards

integer($int32)

Indicates the yard line where out of bounds happened

Player

Player data array

Player data

Id

integer($int32)

Unique player Id

Name

string

Player name

Touchback

Code Block
		{
			"Player": null
		}

Element

Type

Description

Player

integer($int32)

Unique player Id

Penalty

Code Block
		{
			"Type": "OffensiveHolding",
            "Yards": 10,
            "Outcome": "Accepted",
            "Player": {
                "Id": "1239286",
                "Name": null
            }
		}

Element

Type

Description

Type

string($x-extensible-enum)

Unknown, OffensiveHolding, FalseStart, DefensivePassInterference, OffensivePassInterference, DefensiveHolding, UnnecessaryRoughness, DefensiveOffside, DelayOfGame, IllegalBlockAboveTheWaist, NeutralZoneInfraction, FaceMask, IllegalUseOfHands, RoughingThePasser, UnsportsmanlikeConduct, IllegalFormation, Encroachment, IllegalContact, Defensive12OnField, IllegalShift, IntentionalGrounding, Taunting, OffsideOnFreeKick, IneligibleDownfieldPass, HorseCollarTackle, Leverage, RoughingTheKicker, IllegalMotion, ChopBlock, IllegalTouchKick, RunningIntoTheKicker, Disqualification, InterferenceWithOpportunityToCatch, Offensive12OnField, PlayerOutOfBoundsOnPunt, IllegalSubstitution, OffensiveOffside, IllegalTouchPass, FairCatchInterference, Clipping, IllegalForwardPass, IllegalBlindsideBlock, Tripping, Leaping, IneligibleDownfieldKick, InvalidFairCatchSignal, IllegalCrackback, LowBlock, DelayOfKickoff, DefensiveDelayOfGame, IllegalBat, IllegallyKickingBall, KickoffOutOfBounds, IllegalCut

Penalty type

Yards

integer($int32)

Indicates the amount of yards team was penalized based on the penalty type

Outcome

string($x-extensible-enum)

Unknown, Accepted, Declined, Offsetting, Superseded

Outcome of the penalty

Player

Player data array

Player data

Id

integer($int32)

Unique player Id

Name

string

Player name

Return

Code Block
		{
			"Yards": 28,
            "Player": {
                "Id": "1011264",
                "Name": null
            }		
		}

Element

Type

Description

Yards

integer($int32)

Indicates the yards gained

Player

Player data array

Player data

Id

integer($int32)

Unique player Id

Name

string

Player name

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,
            "QuarterBack": {
                "Id": "493258",
                "Name": null
            },
            "SackerOne": {
                "Id": "1005288",
                "Name": null
            },
            "SackerTwo": null		
		}

Element

Type

Description

Yards

integer($int32)

Indicates yards behind the Scrimmage Line

QuarterBack

Player data array

Player data

Id

integer($int32)

Unique player Id

Name

string

Player name

SackerOne

Player data array

Player data

Id

integer($int32)

Unique player Id

Name

string

Player name

SackerTwo

Player data array

Player data

KickOff

Code Block
		{
			"Yards": 9,
            "Player": {
                "Id": "835715",
                "Name": null
            }		
		}

Element

Type

Description

Yards

integer($int32)

Indicates how far (in terms of yards) the ball was kicked

Player

Player data array

Player data

Id

integer($int32)

Unique player Id

Name

string

Player name

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,
            "Player": {
                "Id": "1007198",
                "Name": null
            }
		}

Element

Type

Description

Yards

integer($int32)

yards gained

Player

Player data array

Player data

Id

integer($int32)

Unique player Id

Name

string

Player name

Risks

Code Block
		{
			"Touchdown": "NonActive",
            "OnsideKick": "NonActive",
            "FieldGoal": "NonActive",
            "FourthDown": "NonActive",
            "Safety": "NonActive",
            "Challenge": "NonActive",
            "Penalty": "NonActive",
            "VideoReview": "NonActive",
            "Turnover": "NonActive",
            "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

Other

string($x-extensible-enum)

[ Unknown, Active, NonActive ]

Other risk

FairCatch

Code Block
		{
			"Yards": null,
			"Player": {
				"Id": "100",
				"Name": null
			}
		}

Element

Type

Description

Yards

integer($int32)

yard line

Player

Player data array

Player data

Id

integer($int32)

Unique player Id

Name

string

Player name

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,
        "Reason": "Unreliable score"		
	}

Element

Type

Description

IsReliable

boolean

Indicates whether the current match events are reliable or not

Reason

string

Reason