lichess-org / lichess-org/api

API for Studies

Open
#157 6 comments 13 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
597
Forks
176
Avg merge
1d 4h
Merged PRs (30d)
6

Description

I would like an API that,

  • Allows creation of a New Study
  • Has study settings, as params, in the request call.
  • Allows for adding of new chapters (specifically the PGN upload)
  • Allows for auto-enabling"analyze each chapter"

I've built a system that pulls all games for a particular player (OTB games) from tournament sites and consolidates them into a single PGN. I then want a way of creating a study, uploading the PGN, and auto run the engine against each game (chapter), returning a link to that study.

Thank you!

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the repository's API documentation and examples, then identify how existing study, chapter, and PGN operations are represented. Define the requested creation, settings, upload, and analysis behavior, including the returned study link; done means the API supports and documents the complete workflow.

Written by the indexing model from the issue text.

Assessment

Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.