chessdotcom.endpoints.team_match_board

Get details about a team match board. Only in-progress or finished games will be included, so there may be one or two games in this list.

API doc: https://www.chess.com/news/view/published-data-api#pubapi-endpoint-match-board

chessdotcom.endpoints.team_match_board.get_team_match_board(match_id: int, board_num: int, tts=0, **request_options) → GetTeamMatchBoardResponse
Parameters:

  • match_id – the id of the match.

  • board_num – the number of the board.

  • tts – the time the client will wait before making the first request.

Returns:

GetTeamMatchBoardResponse object containing details about a team match board.

class chessdotcom.endpoints.team_match_board.GetTeamMatchBoardResponse(json, text, match_board)
Variables:

  • match_board – Holds the MatchBoard object.

  • json – The JSON response from the API.

  • text – The raw text response from the API.

class chessdotcom.endpoints.team_match_board.MatchBoard(games: list[Game], board_scores: dict | None)
Variables:

  • board_scores – The board scores as a dictionary.

  • games – List of Game objects.

class chessdotcom.endpoints.team_match_board.Game(url: str | None, pgn: str | None, time_control: str | None, end_time: int | None, start_time: int | None, rated: bool | None, fen: str | None, time_class: str | None, rules: str | None, match: str | None, white: GamePlayer | None, black: GamePlayer | None)
Variables:

  • url – URL for the game.

  • pgn – The PGN of the game.

  • time_control – The time control of the game.

  • end_time – The end time of the game.

  • start_time – The start time of the game.

  • rated – Whether the game is rated.

  • fen – The FEN of the game.

  • time_class – The time class of the game.

  • rules – The rules of the game.

  • match – The match of the game.

  • end_datetime – The end time as a datetime object.

  • start_datetime – The start time as a datetime object.

  • white – The white player of the game. Holds the GamePlayer object.

  • black – The black player of the game. Holds the GamePlayer object.

class chessdotcom.endpoints.team_match_board.GamePlayer(rating: int | None, result: str | None, id: str | None, username: str | None, uuid: str | None)
Variables:

  • rating – The rating of the player.

  • result – The result of the player.

  • id – The ID of the player.

  • username – The username of the player.

  • uuid – The UUID of the player