lichess-api

:trophy: A NodeJS wrapper for the Lichess API

Installation

Using npm:

$ npm install --save lichess-api

If you don't have or don't want to use npm:

$ cd ~/.node_modules
$ git clone git://github.com/gmontalvoriv/lichess-api.git

Test

$ make test

Usage Examples

Fetch one user

const lichess = require('lichess-api');

lichess.user('thibault', function (err, user) {
  console.log(user);
}

Fetch many users

lichess.user({ team: 'coders' }, function (err, users) {
  console.log(users);
}

Fetch user games

lichess.user.games('thibault', { with_analysis: 1 }, function (err, games) {
  console.log(games);
}

Fetch one game by ID

lichess.game('hXI0wVeZ', function (err, game) {
  console.log(game);
}

Fetch one game PGN by ID

lichess.game.export('hXI0wVeZ', function (err, pgn) {
  console.log(pgn.pgn_url);
}

Methods

Note: All parameters are optional

user

Fetch one or multiple users.

.user(options, callback)

Parameters:

Name | Description | Type | -----|------------ |------| team| filter users by team | String | nb| maximum number of users to return | Integer |

user.games

Fetch user games.

.user.games(username, options, callback)

Parameters:

Name | Description | Type | -----|------------ |------| nb| maximum number of games to return per page | Integer | page| for pagination | Integer | No | with_analysis| include deep analysis data in the result | Integer | with_moves| include a list of PGN moves | Integer | with_opening| include opening information | Integer | with_movetimes| include move time information | Integer | rated| filter rated or casual games | Integer |

game

Fetch one game by ID.

.game(game_id, options, callback)

Parameters:

Name | Description | Type | -----|------------ |------| with_analysis| include deep analysis data in the result | Integer | with_moves| include a list of PGN moves | Integer | with_opening| include opening information | Integer | with_movetimes| include move time information | Integer | with_fens | include a list of FEN states | Integer |

game.export

Fetch one game PGN by ID.

.game.export(game_id, callback)

License

MIT © Gabriel Montalvo