Versions Compared
Version | Old Version 9 | 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. Example for 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
Code Block |
---|
"action": {
"$type": "GeniusSports.MatchState.Platform.MatchEvents.Volleyball.Challenge, GeniusSports.MatchState.Platform.MatchEvents.Volleyball",
"requestor": "Referee",
"reason": "Point",
"outcome": "Successful",
"pointOutcome": "ReversDecision",
"setNumber": 1,
"isConfirmed": true,
"utcTimestamp": "2024-11-20T14:01:07.391Z"
}, |
Element | Type | Description |
---|---|---|
| string($x-extensible-enum) Sports.Volleyball.Contracts.Common.Requestor [ Referee, Home, Away ] | 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 ] | Represents the outcome of the challenge. |
| string($x-extensible-enum) Sports.Volleyball.Contracts.Common.ChallengePointOutcome [ ReversDecision, Resume, ReplayRally, PointHome, PointAway ] | Represents the point outcome of the challenge. |
CoinToss
Applicable to: Indoor, Beach, Snow
Code Block | ||
---|---|---|
| ||
"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 |
---|---|---|
| string($x-extensible-enum) Sports.Volleyball.Contracts.Common.Team [ Home, Away ] | Used to identify the coin-toss winner team. |
| string($x-extensible-enum) Sports.Volleyball.Contracts.Common.CoinTossChoice [ Serve, Receive, LeftSide, RightSide ] | Used to identify the 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.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 |
---|---|---|
| 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 |
---|
Libero
Element
Type
Description
LineUp
Element
Type
Description
MatchEnd
Element
Type
Description
MatchScore
Element
Type
Description
MatchStart
Element
Type
Description
Point
Element
Type
Description
Protest
Element
Type
Description
Recovery
Element
Type
Description
RefereeMindChange
Element
Type
Description
Replay
Element
Type
Description
Sanction
Element
Type
Description
Serve
Element
Type
Description
SetEnd
Element
Type
Description
SetScore
Element
Type
Description
SetStart
Element
Type
Description
Substitution
Element
Type
Description
TimeOut
Element
Type
Description
Other Match Events
Reliability
| 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.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 |
---|---|---|
| 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 [ 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.Protest, GeniusSports.MatchState.Platform.MatchEvents.Volleyball",
"team": "Home",
"pointOutcome": null,
"setNumber": 2,
"isConfirmed": false,
"utcTimestamp": "2024-11-13T11:27:47.555Z"
}, |
Element | Type | Description |
---|---|---|
| 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.RefereeMindChange, GeniusSports.MatchState.Platform.MatchEvents.Volleyball",
"pointOutcome": "ReplayRally",
"setNumber": 3,
"isConfirmed": false,
"utcTimestamp": "2024-11-18T17:12:07Z"
}, |
Element | Type | Description |
---|---|---|
| string($x-extensible-enum) Sports.Volleyball.Contracts.Common.ProtestPointOutcome [ ReversDecision, 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.Replay, GeniusSports.MatchState.Platform.MatchEvents.Volleyball",
"pointOutcome": "Resume",
"setNumber": 1,
"isConfirmed": true,
"utcTimestamp": "2024-11-20T14:18:59.905Z"
}, |
Element | Type | Description |
---|---|---|
| string($x-extensible-enum) Sports.Volleyball.Contracts.Common.ReplayPointOutcome [ Resume, ReplayRally ] | Represents the outcome of the replay request. |
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. |
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 |