Studies
Export all chapters
Download all chapters of a study in PGN format. If authenticated, then all public, unlisted, and private study chapters are read. If not, only public (non-unlisted) study chapters are read.
get/api/study/{studyId}.pgn
Path parameters
studyIdstring required
The study ID
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 PGN representation of the study.