https://github.com/lichess-org/api

Lichess API documentation and examples
https://github.com/lichess-org/api

lichess

Last synced: 7 days ago
JSON representation

Lichess API documentation and examples

• Host: GitHub
• URL: https://github.com/lichess-org/api
• Owner: lichess-org
• License: agpl-3.0
• Created: 2018-04-01T21:24:19.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-12-06T07:31:28.000Z (16 days ago)
• Last Synced: 2024-12-08T22:03:36.281Z (14 days ago)
• Topics: lichess
• Language: TypeScript
• Homepage: https://lichess.org/api
• Size: 6.51 MB
• Stars: 451
• Watchers: 23
• Forks: 152
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Lichess API doc & examples

- [API documentation](https://lichess.org/api)

- [Example code](https://github.com/lichess-org/api/tree/master/example/)

- [Which authentication is right for me](https://github.com/lichess-org/api/tree/master/example/README.md)

## Run locally

```shell

cd doc

pnpm install

pnpm serve

```

Now open . 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:

```shell

pnpm spectral

pnpm lint

```