client.matchmaking.list(search: str | None = None, limit: int | None = None, rules_cls: type | None = None) -> MatchmakingListResponseLists all available matchmaking lobbies with optional search and typed rules.
client.matchmaking.create(
player_token: str,
matchmaking_name: str,
max_players: int = 4,
strict_full: bool = False,
host_switch: bool = False,
can_leave_room: bool = False,
realtime_room: bool = False,
password: str | None = None,
player_data: Any = None,
rules: Any = None,
) -> MatchmakingCreateResponseCreates a lobby that players can join directly. For approval-based joins use client.matchmaking_requests.create(..., join_by_requests=True).
client.matchmaking_requests.request_to_join(player_token: str, matchmaking_id: str, player_data: Any = None) -> MatchmakingJoinRequestResponseRequests to join a lobby that requires host approval.
client.matchmaking_requests.respond(player_token: str, request_id: str, action: MatchmakingRequestAction) -> MatchmakingPermissionResponseHost responds to a join request (MatchmakingRequestAction.APPROVE or REJECT).
client.matchmaking_requests.check_status(player_token: str, request_id: str) -> MatchmakingRequestStatusResponseChecks the status of a join request.
client.matchmaking.get_current(player_token: str, rules_cls: type | None = None) -> MatchmakingCurrentResponseGets the current lobby status including pending join requests.
client.matchmaking.join(player_token: str, matchmaking_id: str, player_data: Any = None) -> MatchmakingDirectJoinResponseJoins a matchmaking lobby directly (only if it doesn't require approval).
client.matchmaking.leave(player_token: str) -> MatchmakingLeaveResponseLeaves the current matchmaking lobby.
client.matchmaking.get_players(player_token: str, data_cls: type | None = None) -> MatchmakingPlayersResponseGets all players in the current lobby with typed player data.
client.matchmaking.heartbeat(player_token: str) -> MatchmakingHeartbeatResponseSends a heartbeat to maintain presence in the lobby.
client.matchmaking.remove(player_token: str) -> MatchmakingRemoveResponseRemoves the matchmaking lobby (host only).
client.matchmaking.start(player_token: str) -> MatchmakingStartResponseStarts the game: creates a game room and transfers all lobby players (host only).
client.matchmaking.stop(player_token: str) -> MatchmakingStopResponseStops the matchmaking lobby (host only, before the game has started).
client.matchmaking.kick(player_token: str, player_id: int) -> MatchmakingKickResponseKicks a player from the lobby (host only, before the game has started).
client.matchmaking.update_password(player_token: str, password: str | None = None) -> MatchmakingPasswordResponseUpdates the lobby password (host only, before the game has started). Pass None to remove it.