Skip to main content

Get real-time user data

This endpoint reads public data of a user. If the request is authenticated with OAuth2, the user’s private data (like email) is also returned.
If the user is not online, the response may be cached for up to 1 minute.

Endpoint

Path Parameters

string
required
The username of the user to fetch

Query Parameters

boolean
default:"false"
Include user trophies in the response
boolean
default:"true"
Include the user’s profile information (like bio, country, links)
boolean
default:"false"
Include the user’s rating rank in each performance type
boolean
default:"false"
Include information about whether the user can be challenged (requires OAuth)
boolean
default:"false"
Include the user’s FIDE ID if available

Example Request

Response

string
The user’s ID (lowercase username)
string
The user’s display name
object
Performance statistics for each game variant/time control
integer
Account creation timestamp in milliseconds
boolean
Whether the account is disabled (only present if true)
boolean
Whether the user violated the Terms of Service (only present if true)
object
User profile information (if profile=true and user has filled it)
integer
Last seen timestamp in milliseconds
object
Time spent playing
string
Chess title (GM, IM, FM, WGM, WIM, etc.)
boolean
Whether the user is a Lichess Patron
boolean
Whether the user is verified (official accounts)
string
Full URL to the user’s profile
string
URL to the game currently being played (if any)
object
Game statistics
boolean
Whether the user is currently streaming
boolean
Whether the user can be followed by the requester (requires OAuth)
boolean
Whether the requester follows the user (requires OAuth)
boolean
Whether the requester blocks the user (requires OAuth)

Example Response

Rate Limiting

This endpoint is rate-limited based on:
  • Whether the user is online (offline users have cached responses)
  • Whether the request is authenticated
  • The user’s verification status
Authenticated and verified users have higher rate limits.