Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Next »

Feed Match Event

Ably LiveAccess can be obtained via:

Pull APIs:

IMPORTANT: All enums should be considered extensible, meaning any additional values beyond the ones explicitly defined should be accepted.

Volleyball Match Events example:

{
  "sportId": 91189,
  "fixtureId": "123456789",
  "source": "SourceName",
  "sequenceId": 1,
  "actionId": 0,
  "insertedBeforeActionId": null,
  "isCancelled": false,
  "isConfirmed": true,
  "isModified": false,
  "action": {},
  "messageTimestampUtc": "2024-11-18T10:52:29.0262167Z"
}

Element

Type

Description

sportId

integer($int32)

Sport identifier.

fixtureId

string

Fixture identifier.

source

string

Feed provider identifier.

sequenceId

integer($int32)

Fixture-specific sequence identifier of the match event.

insertedBeforeActionId

integer($int32)

Specify the action ID that this action was inserted before.

actionId

integer($int32)

Match action identifier.

isCancelled

boolean

Indicates whether the action is canceled.

isConfirmed

boolean

Indicates whether the action is confirmed.

isModified

boolean

Indicates whether the action is modified.

action

{}

Consists of Match Action data properties.

messageTimestampUtc

string($date-time)

Timestamp of the message.

Every Match Event has a type inside the “action” field, named after the respective Action. An example of Point is below, where Point is replaced for different Actions.

"action": {
    "$type": "GeniusSports.MatchState.Platform.MatchEvents.Volleyball.Point, GeniusSports.MatchState.Platform.MatchEvents.Volleyball"
}

Feed Match Action

NOTE: Most actions include the following additional fields (hence they are not included in the description of every action).

"action": {
  "setNumber": 1,
  "isConfirmed": true,
  "utcTimestamp": "2024-11-14T18:02:46Z"
}

Element

Type

Description

setNumber

integer($int32)

The set number, where the action occurred.

isConfirmed

boolean

Indicates whether the action is confirmed.

utcTimestamp

string($date-time)

Timestamp of the message.

Actions 

NOTE: Feed Match Actions consist of Feed Match Event + Feed Match Action + Action data properties.

Challenge

  • Applicable to: Indoor, Beach, Snow

Element

Type

Description

CoinToss

"action": {
      "$type": "GeniusSports.MatchState.Platform.MatchEvents.Volleyball.CoinToss, GeniusSports.MatchState.Platform.MatchEvents.Volleyball",
      "winnerTeam": "Home",
      "winnerChoice": null,
      "loserChoice": null,
      "setNumber": 1,
      "isConfirmed": false,
      "utcTimestamp": "2024-11-08T12:34:39.527Z"
    },

Element

Type

Description

winnerTeam

string($x-extensible-enum)

Sports.Volleyball.Contracts.Common.Team

[ Home, Away]

Used to identify the coin-toss winner team.

winnerChoice

string($x-extensible-enum)

Sports.Volleyball.Contracts.Common.CoinTossChoice

[ Serve, Receive, LeftSide, RightSide ]

Used to identify the coin-toss winner team choice.

loserChoice

string($x-extensible-enum)

Sports.Volleyball.Contracts.Common.CoinTossChoice

[ Serve, Receive, LeftSide, RightSide ]

Used to identify the coin-toss loser team choice.

CourtState

"action": {
      "$type": "GeniusSports.MatchState.Platform.MatchEvents.Volleyball.CourtState, GeniusSports.MatchState.Platform.MatchEvents.Volleyball",
      "servingTeam": "Away",
      "servingPlayerId": 7554900,
      "teamOnLeft": "Home",
      "setNumber": 1,
      "isConfirmed": true,
      "utcTimestamp": "2024-11-18T15:52:19Z"
    },

Element

Type

Description

servingTeam

string($x-extensible-enum)

Sports.Volleyball.Contracts.Common.Team

[ Home, Away]

Used to identify the serving team.

servingPlayerId

integer($int32)

nullable: true

Used to identify the serving player.

teamOnLeft

string($x-extensible-enum)

Sports.Volleyball.Contracts.Common.Team

[ Home, Away]

Used to identify the team on the left.

Injury [TODO]

Element

Type

Description

Libero [TODO]

Element

Type

Description

LineUp

"action": {
      "$type": "GeniusSports.MatchState.Platform.MatchEvents.Volleyball.LineUp, GeniusSports.MatchState.Platform.MatchEvents.Volleyball",
      "homePlayers": [
        {
          "id": 90047127,
          "roles": [],
          "courtPosition": "Zone1"
        },
        {
          "id": 90047129,
          "roles": ["Captain"],
          "courtPosition": "Zone2"
        },
        {
          "id": 90047447,
          "roles": [],
          "courtPosition": "Zone3"
        }
      ],
      "awayPlayers": [
        {
          "id": 90047128,
          "roles": ["Captain"],
          "courtPosition": "Zone1"
        },
        {
          "id": 90047126,
          "roles": [],
          "courtPosition": "Zone2"
        },
        {
          "id": 90047120,
          "roles": [],
          "courtPosition": "Zone3"
        }
      ],
      "setNumber": 1,
      "isConfirmed": false,
      "utcTimestamp": "2024-11-08T12:35:00.557Z"
    },

Element

Type

Description

homePlayers

array[] of Sports.Volleyball.Contracts.Common.Player

Collection of lineup players for the home team.

awayPlayers

string($x-extensible-enum)

Sports.Volleyball.Contracts.Common.Team

[ Home, Away]

Collection of lineup players for the away team.

Player

{
  "id": 90047120,
  "roles": [],
  "courtPosition": "Zone3"
}

Element

Type

Description

id

integer($int32)

The ID for the player.

roles

string($x-extensible-enum)

nullable: true

Sports.Volleyball.Contracts.Common.PlayerRole

[ Captain, Libero ]

Represents the possible roles that a player can have in the team.

courtPosition

string($x-extensible-enum)

Sports.Volleyball.Contracts.Common.CourtPosition

[ Zone1, Zone2, Zone3, Zone4, Zone5, Zone6 ]

Represents the court position that the player has in the team.

MatchEnd

"action": {
      "$type": "GeniusSports.MatchState.Platform.MatchEvents.Volleyball.MatchEnd, GeniusSports.MatchState.Platform.MatchEvents.Volleyball",
      "endTime": "2024-11-18T17:54:01Z",
      "endOutcome": "WinnerAway",
      "setNumber": 4,
      "isConfirmed": true,
      "utcTimestamp": "2024-11-18T17:54:01Z"
    },

Element

Type

Description

endTime

string($date-time)

Represents the end time of the match.

endOutcome

string($x-extensible-enum)

Sports.Volleyball.Contracts.Common.MatchEndOutcome

[ WinnerHomeByRetirementOrDefault, WinnerAwayByRetirementOrDefault, NoWinnerDueToRetirementOrDefault, WinnerHome, WinnerAway, Abandoned, Cancelled, Postponed ]

Represent the outcome of the match.

MatchScore [TODO]

Element

Type

Description

MatchStart

"action": {
      "$type": "GeniusSports.MatchState.Platform.MatchEvents.Volleyball.MatchStart, GeniusSports.MatchState.Platform.MatchEvents.Volleyball",
      "startTime": "2024-11-18T16:01:21Z",
      "setNumber": 1,
      "isConfirmed": true,
      "utcTimestamp": "2024-11-18T16:01:21Z"
    },

Element

Type

Description

startTime

string($date-time)

Represents the start time of the match.

Point

"action": {
      "$type": "GeniusSports.MatchState.Platform.MatchEvents.Volleyball.Point, GeniusSports.MatchState.Platform.MatchEvents.Volleyball",
      "linkedActionId": 13,
      "winnerTeam": "Home",
      "type": null,
      "reason": null,
      "setNumber": 1,
      "isConfirmed": false,
      "utcTimestamp": "2024-11-18T16:01:41Z"
    },

Element

Type

Description

linkedActionId

integer($int32)
nullable: true

The ID of the action that is the reason for or affects this point. For example, the ID of a Serve action that triggered this point.

winnerTeam

string($x-extensible-enum)

Sports.Volleyball.Contracts.Common.Team

[ Home, Away]

Represents the start time of the match.

type

Array[] of Sports.Volleyball.Contracts.Common.PointType

[ Block, Kill, Out, BlockOut, Ace, Error, ServeError, Penalty ]

Represents the start time of the match.

reason

Array[] of Sports.Volleyball.Contracts.Common.PointReason

[ Rally, Sanction, Challenge, MindChange, Replay, Protest ]

Represents the start time of the match.

Protest

"action": {
      "$type": "GeniusSports.MatchState.Platform.MatchEvents.Volleyball.Protest, GeniusSports.MatchState.Platform.MatchEvents.Volleyball",
      "team": "Home",
      "pointOutcome": null,
      "setNumber": 2,
      "isConfirmed": false,
      "utcTimestamp": "2024-11-13T11:27:47.555Z"
    },

Element

Type

Description

team

string($x-extensible-enum)

Sports.Volleyball.Contracts.Common.Team

[ Home, Away]

Represents the team requesting the protest.

pointOutcome

string($x-extensible-enum)

Sports.Volleyball.Contracts.Common.ProtestPointOutcome

[ ReversDecision, Resume, ReplayRally ]

Represents the outcome of the protest.

Recovery [TODO]

Element

Type

Description

RefereeMindChange [TODO]

Element

Type

Description

Replay [TODO]

Element

Type

Description

Sanction

 "action": {
      "$type": "GeniusSports.MatchState.Platform.MatchEvents.Volleyball.Sanction, GeniusSports.MatchState.Platform.MatchEvents.Volleyball",
      "team": "Home",
      "playerId": 7465848,
      "type": "Warning",
      "setNumber": 4,
      "isConfirmed": false,
      "utcTimestamp": "2024-11-18T17:32:30Z"
    },

Element

Type

Description

team

string($x-extensible-enum)

Sports.Volleyball.Contracts.Common.Team

[ Home, Away]

Represents the sanctioned team.

playerId

integer($int32)

nullable: true

The ID of the player that is sanctioned.

type

string($x-extensible-enum)

Sports.Volleyball.Contracts.Common.SanctionType

[ ImproperRequest, DelayWarning, DelaySanction, Warning, Penalty, Expulsion, Disqualification ]]

Represents the type of sanction.

Serve

"action": {
      "$type": "GeniusSports.MatchState.Platform.MatchEvents.Volleyball.Serve, GeniusSports.MatchState.Platform.MatchEvents.Volleyball",
      "team": "Away",
      "playerId": 7556825,
      "setNumber": 4,
      "isConfirmed": true,
      "utcTimestamp": "2024-11-18T17:32:36Z"
    },

Element

Type

Description

team

string($x-extensible-enum)

Sports.Volleyball.Contracts.Common.Team

[ Home, Away]

Represents the serving team.

playerId

integer($int32)

nullable: true

The ID of the player that is serving.

SetEnd

"action": {
      "$type": "GeniusSports.MatchState.Platform.MatchEvents.Volleyball.SetEnd, GeniusSports.MatchState.Platform.MatchEvents.Volleyball",
      "endType": "WinnerAway",
      "endTime": "2024-11-18T17:51:14Z",
      "setEndConfirmed": true,
      "setNumber": 4,
      "isConfirmed": true,
      "utcTimestamp": "2024-11-18T17:51:14Z"
    },

Element

Type

Description

endType

string($x-extensible-enum)

Sports.Volleyball.Contracts.Common.SetEndType

[ WinnerHome, WinnerHomeByRetirementOrDefault, WinnerAway, WinnerAwayByRetirementOrDefault, Draw ]

Represent how the set ended.

endTime

string($date-time)

nullable: true

Represents the end time for the set.

setEndConfirmed

boolean

Indicates if the set end event is confirmed.

SetScore [TODO]

Element

Type

Description

SetStart

"action": {
      "$type": "GeniusSports.MatchState.Platform.MatchEvents.Volleyball.SetStart, GeniusSports.MatchState.Platform.MatchEvents.Volleyball",
      "startTime": "2024-11-18T16:01:21Z",
      "isGoldenSet": false,
      "setNumber": 1,
      "isConfirmed": true,
      "utcTimestamp": "2024-11-18T16:01:21Z"
    },

Element

Type

Description

startTime

string($date-time)

nullable: true

Represents the start time for the set.

isGoldenSet

boolean

Indicates if is a golden set.

Substitution

"action": {
      "$type": "GeniusSports.MatchState.Platform.MatchEvents.Volleyball.Substitution, GeniusSports.MatchState.Platform.MatchEvents.Volleyball",
      "linkedActionId": null,
      "team": "Home",
      "playerOutId": 7471100,
      "playerInId": 7465828,
      "type": "Libero",
      "setNumber": 1,
      "isConfirmed": false,
      "utcTimestamp": "2024-11-18T16:01:41Z"
    },

Element

Type

Description

linkedActionId

integer($int32)
nullable: true

The ID of the action that is the reason for or affects this substitution.

team

string($x-extensible-enum)

Sports.Volleyball.Contracts.Common.Team

[ Home, Away]

Represents the substituting team.

playerOutId

integer($int32)

nullable: true

The ID of the outgoing player or substituted player.

playerInId

integer($int32)

nullable: true

The ID of the incoming player or substitute player.

type

string($x-extensible-enum)

Sports.Volleyball.Contracts.Common.SubstitutionType

[ Regular, Exceptional, Libero ]

Represents the type of substitution.

TimeOut

"action": {
      "$type": "GeniusSports.MatchState.Platform.MatchEvents.Volleyball.TimeOut, GeniusSports.MatchState.Platform.MatchEvents.Volleyball",
      "team": "Away",
      "startTime": "2024-11-18T16:10:45Z",
      "endTime": "2024-11-18T16:11:16Z",
      "type": "Facultative",
      "setNumber": 1,
      "isConfirmed": true,
      "utcTimestamp": "2024-11-18T16:11:16Z"
    },

Element

Type

Description

team

string($x-extensible-enum)

Sports.Volleyball.Contracts.Common.Team

[ Home, Away]

Represents the substituting team.

startTime

string($date-time)

nullable: true

Represents the start time of the timeout.

endTime

string($date-time)

nullable: true

Represents the end time of the timeout.

type

string($x-extensible-enum)

Sports.Volleyball.Contracts.Common.SubstitutionType

[ Regular, Exceptional, Libero ]

Represents the type of substitution.

Other Match Events

Reliability

"action": {
  "$type": "Betgenius.Sports.Contracts.Common.MatchEvents.Reliability, Betgenius.Sports.Contracts.Common.MatchEvents",
  "utcTimestamp": "2024-11-18T10:52:29.0039281Z",
  "isReliable": false,
  "reason": "Heartbeat Lost"
}

Element

Type

Description

isReliable

boolean

Indicates whether the feed data is considered reliable

reason

string

Reason for reliable/unreliable feed state

  • No labels