LIlichess
Studies

Export all studies of a user

Download all chapters of all studies of a user in PGN format. If authenticated, then all public, unlisted, and private studies are included. If not, only public (non-unlisted) studies are included.

get/api/study/by/{username}/export.pgn

Request

  • Base URL
    https://lichess.org
  • URL
    https://lichess.org/api/study/by/{username}/export.pgn
  • Auth
    OAuth 2
    Authorization code: https://lichess.org/oauth
    Token URL: https://lichess.org/api/token scopes: study:read

Path parameters

usernamestring required

The user whose studies we export

Query parameters

clocksboolean

Include clock comments in the PGN moves, when available. Example: 2. exd5 { [%clk 1:01:27] } e5 { [%clk 1:01:28] }

commentsboolean

Include analysis and annotator comments in the PGN moves, when available. Example: 12. Bxf6 { [%eval 0.23] } a3 { White is in a pickle. }

variationsboolean

Include non-mainline moves, when available. Example: 4. d4 Bb4+ (4... Nc6 5. Nf3 Bb4+ 6. Bd2 (6. Nbd2 O-O 7. O-O) 6... Bd6) 5. Nd2

orientationboolean

Add a Orientation PGN tag with the chapter predefined orientation. Example: [Orientation "white"]

Response

The studies of the user.

Changes

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