Users
Lichess API Docs - Users (opens in a new tab)
Equine supports the Users
API as users
and user
.
users
Get users by IDs
lichess.users.info({ ids: string | string[] })
// ids: 'alpha' | 'alpha,bravo' | 'alpha, bravo' | ['alpha', 'bravo']
Get real-time users status
lichess.users.status({ ids: string | string[] })
// ids: 'alpha' | 'alpha,bravo' | 'alpha, bravo' | ['alpha', 'bravo']
Get crosstable
lichess.users.crosstable({ user1: string; user2: string; matchup?: boolean })
Get live streamers
lichess.users.streaming()
user
Get user public data
lichess.user.info({ username: string })
Get rating history of a user
lichess.user.history({ username: string })
Get performance statistics of a user
lichess.user.performance({ username: string, perfType: string })
Get user activity
lichess.user.activity({ username: string })
Autocomplete usernames
lichess.user.autocomplete({ term: string; details?: boolean; friendPrior?: boolean })
Add a note for a user
lichess.user.note({ username: string, text: string })
Get notes for a user
lichess.user.note({ username: string })
Follow a player
This feature is under the Relations (opens in a new tab) part.
lichess.user.follow({ username: string })
Unfollow a player
This feature is under the Relations (opens in a new tab) part.
lichess.user.unfollow({ username: string })