Versions Compared
Version | Old Version 13 | New Version Current |
---|---|---|
Changes made by | ||
Saved on |
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Table of Contents | ||
---|---|---|
|
Feed Match Event
Ably LiveAccess can be obtained via:
Pull APIs:
https://platform.matchstate.api.geniussports.com/swagger/volleyball/index.html
https://platform.matchstate.api.geniussports.com/swagger/beachvolleyball/index.html
https://platform.matchstate.api.geniussports.com/swagger/snowvolleyball/index.html
IMPORTANT: All enums
should be considered extensible, meaning any additional values beyond the ones explicitly defined should be accepted.
Volleyball Match Events example:
View file | ||
---|---|---|
|
Code Block | ||
---|---|---|
| ||
{ "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 |
---|---|---|
| integer($int32) | Sport identifier. |
| string | Fixture identifier. |
| string | Feed provider identifier. |
| integer($int32) | Fixture-specific sequence identifier of the match event. |
| integer($int32) | Specify the action ID that this action was inserted before. |
| integer($int32) | Match action identifier. |
| boolean | Indicates whether the action is canceled. |
| boolean | Indicates whether the action is confirmed. |
| boolean | Indicates whether the action is modified. |
| {} | Consists of Match Action data properties. |
| 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.
Code Block | ||
---|---|---|
| ||
"action": { "$type": "GeniusSports.MatchState.Platform.MatchEvents.Volleyball.Point, GeniusSports.MatchState.Platform.MatchEvents.Volleyball" } |
Feed Match Action
Info |
---|
NOTE: Most actions include the following additional fields (hence they are not included in the description of every action). |
Code Block | ||
---|---|---|
| ||
"action": { "setNumber": 1, "isConfirmed": true, "utcTimestamp": "2024-11-14T18:02:46Z" } |
Element | Type | Description |
---|---|---|
| integer($int32) | The set number, where the action occurred. |
| boolean | Indicates whether the action is confirmed. |
| string($date-time) | Timestamp of the message. |
Actions
Info |
---|
NOTE: Feed Match Actions consist of Feed Match Event + Feed Match Action + Action data properties. |
Challenge
Applicable to: Indoor, Beach, Snow
Code Block |
---|
Element
Type
Description
CoinToss
Code Block | ||
---|---|---|
| ||
"action": { "$type": "GeniusSports.MatchState.Platform.MatchEvents.Volleyball.CoinTossChallenge, GeniusSports.MatchState.Platform.MatchEvents.Volleyball", "requestor": "Referee", "winnerTeamreason": "HomePoint", "winnerChoiceoutcome": null"Successful", "loserChoicepointOutcome": null"ReversDecision", "setNumber": 1, "isConfirmed": falsetrue, "utcTimestamp": "2024-11-08T1220T14:3401:3907.527Z391Z" }, |
Element | Type | Description |
---|
winnerTeam
| string($x-extensible-enum) Sports.Volleyball.Contracts.Common. |
Requestor [ Referee, Home, Away ] |
Used to identify the coin-toss winner team.
winnerChoice
Represents the requestor of the challenge. | ||
| string nullable: true | The reason for the challenge |
| string($x-extensible-enum) Sports.Volleyball.Contracts.Common. |
ChallengeOutcome [ |
Successful, |
Unsuccessful, |
PictureUnavailable ] |
Used to identify the coin-toss winner team choice.
loserChoice
Represents the outcome of the challenge. | |
| string($x-extensible-enum) Sports.Volleyball.Contracts.Common. |
ChallengePointOutcome [ |
ReversDecision, Resume, |
ReplayRally, |
PointHome, |
PointAway ] |
Used to identify the coin-toss loser team choice.
Represents the point outcome of the challenge. |
CoinToss
Applicable to: Indoor, Beach, Snow
Code Block | ||
---|---|---|
| ||
"action": { "$type": "GeniusSports.MatchState.Platform.MatchEvents.Volleyball.CourtStateCoinToss, GeniusSports.MatchState.Platform.MatchEvents.Volleyball", "servingTeamwinnerTeam": "AwayHome", "servingPlayerIdwinnerChoice": 7554900null, "teamOnLeftloserChoice": "Home"null, "setNumber": 1, "isConfirmed": truefalse, "utcTimestamp": "2024-11-18T1508T12:5234:19Z39.527Z" }, |
Element | Type | Description |
---|
servingTeam
| string($x-extensible-enum) Sports.Volleyball.Contracts.Common.Team [ Home, Away ] | Used to identify the |
coin-toss winner team. |
servingPlayerId
integer($int32)
nullable: true
Used to identify the serving player.
teamOnLeft
| string($x-extensible-enum) Sports.Volleyball.Contracts.Common. |
CoinTossChoice [ |
Serve, Receive, LeftSide, RightSide ] | Used to identify the |
Injury [TODO]
language | json |
---|
Element
Type
Description
Libero [TODO]
language | json |
---|
Element
Type
Description
LineUp
coin-toss winner team choice. | ||
| string($x-extensible-enum) Sports.Volleyball.Contracts.Common.CoinTossChoice [ Serve, Receive, LeftSide, RightSide ] | Used to identify the coin-toss loser team choice. |
CourtState
Applicable to: Indoor, Beach, Snow
Code Block | ||
---|---|---|
| ||
"action": { "$type": "GeniusSports.MatchState.Platform.MatchEvents.Volleyball.LineUpCourtState, GeniusSports.MatchState.Platform.MatchEvents.Volleyball", "homePlayersservingTeam": ["Away", "servingPlayerId": 7554900, { "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
Code Block | ||
---|---|---|
| ||
{
"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.
"teamOnLeft": "Home",
"setNumber": 1,
"isConfirmed": true,
"utcTimestamp": "2024-11-18T15:52:19Z"
}, |
Element | Type | Description |
---|---|---|
| string($x-extensible-enum) Sports.Volleyball.Contracts.Common.Team [ Home, Away ] | Used to identify the serving team. |
| integer($int32) nullable: true | Used to identify the serving player. |
| string($x-extensible-enum) Sports.Volleyball.Contracts.Common.Team [ Home, Away] | Used to identify the team on the left. |
Injury
Applicable to: Indoor, Beach, Snow
Code Block | ||
---|---|---|
| ||
"action": {
"$type": "GeniusSports.MatchState.Platform.MatchEvents.Volleyball.Injury, GeniusSports.MatchState.Platform.MatchEvents.Volleyball",
"team": "Home",
"playerId": 12345678,
"setNumber": 1,
"isConfirmed": true,
"utcTimestamp": "2024-11-20T14:11:34.14Z"
}, |
Element | Type | Description |
---|---|---|
| string($x-extensible-enum) Sports.Volleyball.Contracts.Common.Team [ Home, Away ] | Represents the team with injured player. |
| integer($int32) nullable: true | The ID of the injured player. |
LineUp
Applicable to: Indoor, Beach, Snow
Code Block | ||
---|---|---|
| ||
"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 |
---|---|---|
| array[] of Sports.Volleyball.Contracts.Common.Player | Collection of lineup players for the home team. |
| string($x-extensible-enum) Sports.Volleyball.Contracts.Common.Team [ Home, Away ] | Collection of lineup players for the away team. |
Player
Code Block | ||
---|---|---|
| ||
{
"id": 90047120,
"roles": [],
"courtPosition": "Zone3"
} |
Element | Type | Description |
---|---|---|
| integer($int32) | The ID for the player. |
| 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. |
| 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
Applicable to: Indoor, Beach, Snow
Code Block | ||
---|---|---|
| ||
"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 |
---|---|---|
| string($date-time) | Represents the end time of the match. |
| string($x-extensible-enum) Sports.Volleyball.Contracts.Common.MatchEndOutcome [ WinnerHomeByRetirementOrDefault, WinnerAwayByRetirementOrDefault, NoWinnerDueToRetirementOrDefault, WinnerHome, WinnerAway, Abandoned, Cancelled, Postponed ] | Represent the outcome of the match. |
MatchStart
Applicable to: Indoor, Beach, Snow
Code Block | ||
---|---|---|
| ||
"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 |
---|---|---|
| string($date-time) | Represents the start time of the match. |
Point
Applicable to: Indoor, Beach, Snow
Code Block | ||
---|---|---|
| ||
"action": { "$type": "GeniusSports.MatchState.Platform.MatchEvents.Volleyball.MatchEndPoint, GeniusSports.MatchState.Platform.MatchEvents.Volleyball", "endTimelinkedActionId": 13, "2024-11-18T17:54:01Z "winnerTeam": "Home", "endOutcometype": null, "WinnerAway" "reason": null, "setNumber": 41, "isConfirmed": truefalse, "utcTimestamp": "2024-11-18T1718T16:5401:01Z41Z" }, |
Element | Type | Description |
---|
endTime
string($date-time)
Represents the end time of the match.
endOutcome
string($x-extensible-enum)
| integer($int32) | The ID of the action that is the reason for or affects this point. For example, the ID of a |
| string($x-extensible-enum) Sports.Volleyball.Contracts.Common.Team [ Home, Away ] | Represents the winner of the point. |
| Array[] of Sports.Volleyball.Contracts.Common. |
PointType [ |
Represent the outcome of the match.
MatchScore [TODO]
Element
Type
Description
MatchStart
Block, Kill, Out, BlockOut, Ace, Error, ServeError, Penalty ] | Represents method of winning the point. | |
| Array[] of Sports.Volleyball.Contracts.Common.PointReason [ Rally, Sanction, Challenge, MindChange, Replay, Protest ] | Represents the reason time of winning the point. |
Protest
Applicable to: Indoor, Beach, Snow
Code Block | ||
---|---|---|
| ||
"action": { "$type": "GeniusSports.MatchState.Platform.MatchEvents.Volleyball.MatchStartProtest, GeniusSports.MatchState.Platform.MatchEvents.Volleyball", "startTimeteam": "Home", "2024-11-18T16:01:21Z" "pointOutcome": null, "setNumber": 12, "isConfirmed": truefalse, "utcTimestamp": "2024-11-18T1613T11:0127:21Z47.555Z" }, |
Element | Type | Description |
---|
startTime
string($date-time)
Represents the start time of the match.
| string($x-extensible-enum) Sports.Volleyball.Contracts.Common.Team [ Home, Away ] | Represents the team requesting the protest. |
| string($x-extensible-enum) Sports.Volleyball.Contracts.Common.ProtestPointOutcome [ ReversDecision, Resume, ReplayRally ] | Represents the outcome of the protest. |
RefereeMindChange
Applicable to: Indoor
Code Block | ||
---|---|---|
| ||
"action": { "$type": "GeniusSports.MatchState.Platform.MatchEvents.Volleyball.PointRefereeMindChange, GeniusSports.MatchState.Platform.MatchEvents.Volleyball", "linkedActionId": 13, "winnerTeampointOutcome": "Home", "type": null, "reason": nullReplayRally", "setNumber": 13, "isConfirmed": false, "utcTimestamp": "2024-11-18T1618T17:0112:41Z07Z" }, |
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
}, |
Element | Type | Description |
---|---|---|
| string($x-extensible-enum) Sports.Volleyball.Contracts.Common. |
ProtestPointOutcome [ |
ReversDecision, |
Represents the start time of the match.
Resume, ReplayRally ] | The referee may decide to repeat the rally or to check the awarding of the last point. This represents the outcome of the Referee decision. |
Replay
Applicable to: Indoor
Code Block | ||
---|---|---|
| ||
"action": { "$type": "GeniusSports.MatchState.Platform.MatchEvents.Volleyball.Protest, GeniusSports.MatchState.Platform.MatchEvents.Volleyball", "team": "Home"Replay, GeniusSports.MatchState.Platform.MatchEvents.Volleyball", "pointOutcome": null"Resume", "setNumber": 21, "isConfirmed": falsetrue, "utcTimestamp": "2024-11-13T1120T14:2718:4759.555Z905Z" }, |
Element | Type |
---|
Description
team
string($x-extensible-enum)
Sports.Volleyball.Contracts.Common.Team
[ Home, Away]
Description | |
---|---|
| string($x-extensible-enum) Sports.Volleyball.Contracts.Common. |
ReplayPointOutcome [ |
Resume, ReplayRally ] | Represents the outcome of the |
replay request. |
Recovery [TODO]
language | json |
---|
Element
Type
Description
RefereeMindChange [TODO]
language | json |
---|
Element
Type
Description
Replay [TODO]
language | json |
---|
Element
Type
Description
Sanction
Applicable to: Indoor, Beach, Snow
Code Block | ||
---|---|---|
| ||
"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 |
---|---|---|
| string($x-extensible-enum) Sports.Volleyball.Contracts.Common.Team [ Home, Away ] | Represents the sanctioned team. |
| integer($int32) nullable: true | The ID of the player that is sanctioned. |
| string($x-extensible-enum) Sports.Volleyball.Contracts.Common.SanctionType [ ImproperRequest, DelayWarning, DelaySanction, Warning, Penalty, Expulsion, Disqualification ] ] | Represents the type of sanction. |
Serve
Applicable to: Indoor, Beach, Snow
Code Block | ||
---|---|---|
| ||
"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 |
---|---|---|
| string($x-extensible-enum) Sports.Volleyball.Contracts.Common.Team [ Home, Away ] | Represents the serving team. |
| integer($int32) nullable: true | The ID of the player that is serving. |
SetEnd
Applicable to: Indoor, Beach, Snow
Code Block | ||
---|---|---|
| ||
"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 |
---|---|---|
| string($x-extensible-enum) Sports.Volleyball.Contracts.Common.SetEndType [ WinnerHome, WinnerHomeByRetirementOrDefault, WinnerAway, WinnerAwayByRetirementOrDefault, Draw ] | Represent how the set ended. |
| string($date-time) nullable: true | Represents the end time for the set. |
| boolean | Indicates if the set end event is confirmed. |
SetScore [TODO]
language | json |
---|
Element
Type
Description
SetStart
Applicable to: Indoor, Beach, Snow
Code Block | ||
---|---|---|
| ||
"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 |
---|---|---|
| string($date-time) nullable: true | Represents the start time for the set. |
| boolean | Indicates if is a golden set. |
Substitution
Applicable to: Indoor, Beach, Snow
Code Block | ||
---|---|---|
| ||
"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 |
---|---|---|
| integer($int32) | The ID of the action that is the reason for or affects this substitution. |
| string($x-extensible-enum) Sports.Volleyball.Contracts.Common.Team [ Home, Away ] | Represents the substituting team. |
| integer($int32) nullable: true | The ID of the outgoing player or substituted player. |
| integer($int32) nullable: true | The ID of the incoming player or substitute player. |
| string($x-extensible-enum) Sports.Volleyball.Contracts.Common.SubstitutionType [ Regular, Exceptional, Libero ] | Represents the type of substitution. |
TimeOut
Applicable to: Indoor, Beach, Snow
Code Block | ||
---|---|---|
| ||
"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 |
---|---|---|
| string($x-extensible-enum) Sports.Volleyball.Contracts.Common.Team [ Home, Away ] | Represents the substituting team. |
| string($date-time) nullable: true | Represents the start time of the timeout. |
| string($date-time) nullable: true | Represents the end time of the timeout. |
| string($x-extensible-enum) Sports.Volleyball.Contracts.Common.SubstitutionType [ Regular, Exceptional, Libero ] | Represents the type of substitution. |
Other Match Events
Reliability
Applicable to: Indoor, Beach, Snow
Code Block | ||
---|---|---|
| ||
"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 |
---|---|---|
| boolean | Indicates whether the feed data is considered reliable |
| string | Reason for reliable/unreliable feed state |