GameRoMan/api

Lichess API documentation and examples

Lichess API doc & examples

• API documentation
• Example code
• Which authentication is right for me

Run locally

cd doc
pnpm install
pnpm serve

Now open http://localhost:8089/. You should see the generated API doc.

Make modifications to doc/specs/lichess-api.yaml, and reload the page to see your changes.

Check the yaml files for syntax errors:

pnpm spectral
pnpm lint

Format the yaml files

pnpm format

Publish (for maintainers)

The docs + npm package will be published automatically each day if there are changes, but if you want to publish changes immediately, you can trigger the publish workflow.

Option 1: In the Github UI, manually dispatch the publish workflow

Option 2: From the command line:

gh workflow run publish