LIlichess
Tournaments (Arena)

Join an Arena tournament

Join an Arena tournament, possibly with a password and/or a team. Also unpauses if you had previously paused the tournament.

post/api/tournament/{id}/join

Request

  • Base URL
    https://lichess.org
  • URL
    https://lichess.org/api/tournament/{id}/join
  • Auth
    OAuth 2
    Authorization code: https://lichess.org/oauth
    Token URL: https://lichess.org/api/token scopes: tournament:write

Path parameters

idstring required
Example:hL7vMrFQ

The tournament ID.

Request body application/x-www-form-urlencoded

passwordstring

The tournament password, if one is required. Can also be a user-specific entry code generated and shared by the organizer.

teamstring

The team to join the tournament with, for team battle tournaments

pairMeAsapboolean

If the tournament is started, attempt to pair the user, even if they are not connected to the tournament page. This expires after one minute, to avoid pairing a user who is long gone. You may call "join" again to extend the waiting.

Response

The tournament was successfully joined.

okboolean required

Changes

No recorded changes to this operation across all 16 revisions of this API.