Full Events Streams schema

Please find a breakdown of the full schema for /events endpoint

Match Status Update:


    },
    "matchTime": {
      "type": "string",
      "format": "time"
    },
    "seqNum": {
      "type": "integer"
    },    
    "matchStatus": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "umpireCountry": {
          "type": "string"
        },
        "umpire": {
          "type": "string"
        },
        "teamAPlayer1": {
          "type": "string"
        },
        "tossChooser": {
          "type": "string"
        },
        "teamBPlayer2": {
          "type": "string"
        },
        "teamAPlayer2": {
          "type": "string"
        },
        "matchState": {
          "type": "object",
          "oneOf": [
            {
              "additionalProperties": false,
              "properties": {
                "locationTimestamp": {
                  "type": "string",
                  "format": "date-time"
                },
                "suspensionType": {
                  "type": "string"
                }
              }
            },
            {
              "additionalProperties": false,
              "properties": {
                "locationTimestamp": {
                  "type": "string",
                  "format": "date-time"
                },
                "team": {
                  "type": "string",
                  "enum": [
                    "TeamA",
                    "TeamB",
                    "UnknownTeam"
                  ]
                },
                "won": {
                  "type": "string",
                  "enum": [
                    "TeamA",
                    "TeamB",
                    "UnknownTeam"
                  ]
                },
                "challengeEnded": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            },
            {
              "additionalProperties": false,
              "properties": {
                "treatmentLocation": {
                  "type": "string"
                },
                "treatmentStarted": {
                  "type": "string",
                  "format": "date-time"
                },
                "treatmentEnded": {
                  "type": "string",
                  "format": "date-time"
                },
                "evaluationStarted": {
                  "type": "string",
                  "format": "date-time"
                },
                "team": {
                  "type": "string"
                },
                "playerId": {
                  "type": "integer"
                },
                "locationTimestamp": {
                  "type": "string",
                  "format": "date-time"
                }
              },
              "required": [
                "team"
              ]
            },
            {
              "additionalProperties": false,
              "properties": {
                "locationTimestamp": {
                  "type": "string",
                  "format": "date-time"
                },
                "team": {
                  "type": "string",
                  "enum": [
                    "TeamA",
                    "TeamB",
                    "UnknownTeam"
                  ]
                },
                "playerId": {
                  "type": "integer"
                },
                "reason": {
                  "type": "string"
                }
              },
              "required": [
                "team",
                "playerId",
                "reason"
              ]
            },
            {
              "additionalProperties": false,
              "properties": {
                "locationTimestamp": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            },
            {
              "additionalProperties": false,
              "properties": {
                "locationTimestamp": {
                  "type": "string",
                  "format": "date-time"
                },
                "suspensionType": {
                  "type": "string"
                },
                "suspensionEnded": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            },
            {
              "additionalProperties": false,
              "properties": {
                "locationTimestamp": {
                  "type": "string",
                  "format": "date-time"
                },
                "team": {
                  "type": "string",
                  "enum": [
                    "TeamA",
                    "TeamB",
                    "UnknownTeam"
                  ]
                },
                "toiletBreakEnded": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          ]
        },
        "teamBPlayer1": {
          "type": "string"
        },
        "numSets": {
          "type": "integer"
        },
        "scoringType": {
          "type": "string",
          "enum": [
            "StandardWithNoAdvScoringType",
            "ProSetScoringType",
            "LastSetTiebreak12ScoringType",
            "StandardScoringType",
            "MatchTieBreakScoringType",
            "ShortSetsScoringType",
            "ModernSetLongScoringType",
            "ModernSetShortScoringType",
            "SuddenDeathScoringType",
            "UnknownScoringType",
            "ATPShortSetScoringType",
            "ShortSetsNoAdvScoringType",
            "ATPShortSetNoAdvScoringType",
            "ModernSetWithNoAdvScoringType"
          ]
        },
        "firstServer": {
          "type": "string",
          "enum": [
            "TeamA",
            "TeamB",
            "UnknownTeam"
          ]
        },
        "tossWinner": {
          "type": "string",
          "enum": [
            "TeamA",
            "TeamB",
            "UnknownTeam"
          ]
        },
        "courtNum": {
          "type": "integer"
        },
        "teamAPlayersDetails": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "player1Id": {
              "type": "string"
            },
            "player2Id": {
              "type": "string"
            },
            "player1Country": {
              "type": "string"
            },
            "player2Country": {
              "type": "string"
            }
          },
          "required": [
            "player1Id",
            "player1Country"
          ]
        },
        "teamBPlayersDetails": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "player1Id": {
              "type": "string"
            },
            "player2Id": {
              "type": "string"
            },
            "player1Country": {
              "type": "string"
            },
            "player2Country": {
              "type": "string"
            }
          },
          "required": [
            "player1Id",
            "player1Country"
          ]
        },
        "umpireCode": {
          "type": "string"
        },
        "tieBreakType": {
          "type": "string"
        }
      },
      "required": [
        "teamAPlayer1",
        "scoringType",
        "teamBPlayer1",
        "matchState"
      ]
    }
  },
  "required": [
    "seqNum",
    "timestamp",
    "matchStatus"
  ]
}

Team Player Details:

Team Player Details:

Match State:

Server:

Points Scored Packet:

Score:

Current Game Score:

Current Set Score:

Previous Set Score:

Tie Break Score:

Point Score Details:

Overall Set Score Details:

Point Started Packet:

Point Fault Packet:

Point Replayed Packet:

Point Let Packet:

CodePenaltyPacket:

Time Penalty Packet:

Game Penalty Packet:

Undo Packet:

Overrule Packet:

Code Violation Packet:

Time Violation:

Physio Called Packet:

Physio Cancelled Packet:

Swap Server Packet (Doubles Only):

Swap Receiver Packet (Doubles Only):

On Court Coaching Packet:

Time Announcement Packet:

Move Umpires Chair Packet:

Match Finished Packet:

Alarm Packet:

Last updated

Was this helpful?