Page Comparison

Volleyball Match State V1

Introduction

The document describes the Volleyball Match state V1 contract and provides examples of using it.

Ably LiveAccess can be obtained via the :

• AccessControl API

Pull APIs:

1. https://platform.matchstate.api.geniussports.com/swagger/volleyball/index.html

2. https://platform.matchstate.api.geniussports.com/swagger/beachvolleyball/index.html

3. https://platform.matchstate.api.geniussports.com/swagger/snowvolleyball/index.html

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

Volleyball Match State example:

Section Explanations

match

An object that describes events within the match.

sets

A collection of objects detailing actions in a set.

{
  "SetNumber": 1,
  "Points": [],
  "scoreInPoints": {
    "teamA": 0,
    "teamB": 0
  },
  "requestedTimeOuts": {
    "teamA": 0,
    "teamB": 0
  },
  "setWinner": "TeamA",
  "isGoldenSet": false,
  "startedAtUtc": "2024-11-13T19:31:57Z",
  "finishedAtUtc": "2024-11-13T19:58:37Z",
  "isConfirmedComplete": true
}

setNumber

The set described this Set object.

points

Collection of point objects detailing the points played so far in this set.

"points": [
  {
    "pointNumber": 1,
    "server": "TeamB",
    "winner": "TeamA",
    "startedAt": "00:00:00",
    "wonAt": "00:00:07",
    "scoreWhenPointStarted": {
      "scoreInSets": {
        "teamA": 0,
        "teamB": 0
      },
      "scoreInPoints": {
        "teamA": 0,
        "teamB": 0
      }
    },
    "startedAtUtc": "2024-11-13T19:31:57Z",
    "finishedAtUtc": "2024-11-13T19:32:04Z",
    "isConfirmedComplete": true,
    "pointType": "Unknown"
  },
  {
    "pointNumber": 2,
    "server": "TeamA",
    "winner": "TeamA",
    "startedAt": "00:00:21",
    "wonAt": "00:00:36",
    "scoreWhenPointStarted": {
      "scoreInSets": {
        "teamA": 0,
        "teamB": 0
      },
      "scoreInPoints": {
        "teamA": 1,
        "teamB": 0
      }
    },
    "startedAtUtc": "2024-11-13T19:32:18Z",
    "finishedAtUtc": "2024-11-13T19:32:33Z",
    "isConfirmedComplete": true,
    "pointType": "Unknown"
  }
]

point

Set of fields describing a point.

"scoreWhenPointStarted": {
      "scoreInSets": {
        "teamA": 0,
        "teamB": 0
      },
      "scoreInPoints": {
        "teamA": 1,
        "teamB": 0
      }
    },

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

scoreInPoints

An object that describes the score of the current set in points.

"scoreInPoints": {
  "teamA": 25,
  "teamB": 20
}

requestedTimeOuts

An object that describes the number of timeouts requested by each team.

"requestedTimeOuts": {
  "teamA": 0,
  "teamB": 2
}

setWinner

Indicates which team won the set if the set is complete, Null otherwise.

isGoldenSet

True if this set is a golden set, False otherwise (Not currently covered, always sent false).

startedAtUtc

The time that the match started if the match has started, Null otherwise.

finishedAtUtc

The time that the match finished if the match has finished, Null otherwise

isConfirmedComplete

True if the set is complete, false otherwise

scoreInSets

The current score in sets

"scoreInSets": {
  "teamA": 3,
  "teamB": 0
}

kills

The number of kills by each team

"kills": {
  "teamA": 0,
  "teamB": 0
}

blocks

The number of blocks by each team.

"blocks": {
  "teamA": 0,
  "teamB": 0
}

outs

The number of outs by each team.

"outs": {
  "teamA": 0,
  "teamB": 0
}

aces

The number of aces by each team.

"aces": {
  "teamA": 0,
  "teamB": 0
}

errors

The number of errors by each team.

"errors": {
  "teamA": 0,
  "teamB": 0
}

serviceErrors

The number of points won due to the opponent's service errors for each team.

"serviceErrors": {
  "teamA": 0,
  "teamB": 0
}

penalties

The number of penalties by each team.

"penalties": {
  "teamA": 0,
  "teamB": 0
}

blockOuts

The number of blockouts by each team.

"blockOuts": {
  "teamA": 0,
  "teamB": 0
}

expulsions

An array of objects describing expulsions.

explulsion

{
  "setNumber": 0,
  "occurredAt": "string",
  "team": "TeamA"
}

disqualifications

An object that describes disqualification events

disqualification

{
  "setNumber": 0,
  "occurredAt": "string",
  "team": "TeamA"
}

matchWinner

The team that won the match if the match has ended.

startedAtUtc

The time that the match started if the match has started, Null otherwise.

finishedAtUtc

The time that the match finished if the match has finished, Null otherwise.

isConfirmedComplete

True if the match is complete, False otherwise.

matchStatus

An enum that describes the current state of the match.

[ PreMatch, WarmUp, PointInProgress, TimeOut, BetweenSets, BetweenPoints, PlaySuspended, PointUnderInvestigation, MatchComplete, MatchAbandoned ]

sanctionStatus

An enum describing the current sanction status.

[ Safe, TeamAPenaltyCommitted, TeamBPenaltyCommitted, TeamAExpulsion, TeamBExpulsion, PossibleDisqualification, TeamADisqualification, TeamBDisqualification ]

other

source

The source property describes the source that is providing the feed for Match State.

fixtureId

The fixtureId property indicates the ID of the mapped source fixture to the Genius Sports fixture.

Use case: Id of this fixture (match).

sequence

The sequence property indicates the sequence number of the feed match events

"sequence": 189

Use case: Sequence of the latest feed match event.

messageTimestampUtc

The messageTimestampUtc property indicates the exact time of this match state message.

Use case: Time when the match state was last updated.

isReliable

The isReliable property is used to note whether the given match state is reliable or not. This property is a result of the reliability reasons statuses.

Reliability is used to indicate that some of the information within the message may be inaccurate and it should not be relied on for purposes where message accuracy is critical.

Use case: The current match state is reliable.

isCoverageCancelled

The isCoverageCancelled property is used to note whether the coverage of this match has been canceled or not.

Use case: Coverage for this match has not been canceled.

reliabilityReasons

The reliabilityReasons section contains a list of items considered to make an automatic decision about whether the match state is reliable or not.

"reliabilityReasons": {
    "coverage": "Coverage Available",
    "heartbeat": "Heartbeat Lost",
    "feedReliability": "Feed Reliable"
  }

Use case: The heartbeat for the current match state has been lost, the feed is considered reliable and the coverage is unknown.