---
title: "Get real-time users status"
method: GET
path: "/api/users/status"
tags: ["Users"]
---

# Get real-time users status

`GET /api/users/status`

Read the `online`, `playing` and `streaming` flags of several users.
This API is very fast and cheap on lichess side.
So you can call it quite often (like once every 5 seconds).
Use it to track players and know when they're connected on lichess and playing games.

## Query parameters

- `ids` string, required
- `withSignal` boolean
- `withGameIds` boolean
- `withGameMetas` boolean

## Response `200`

The list of users and their respective statuses.

- object[]
  - `id` string, required
  - `name` string, required
  - `flair` string — See [available flair list and images](https://github.com/lichess-org/lila/tree/master/public/flair)
  - `title` 'GM' | 'WGM' | 'IM' | 'WIM' | 'FM' | 'WFM' | 'NM' | 'CM' | 'WCM' | 'WNM' | 'LM' | 'BOT' — only appears if the user is a titled player or a bot user
  - `online` boolean
  - `playing` boolean
  - `streaming` boolean
  - `patron` boolean — Use patronColor value instead to determine if player is a patron.
  - `patronColor` integer — Players can choose a color for their Patron wings. See [here for the color mappings](https://github.com/lichess-org/lila/blob/master/ui/lib/css/abstract/_patron-colors.scss). The presence of this field indicates the player is an active Patron.

---

[API](https://skmtc.net/lichess/apis/lichess-org-api-reference.md) · [All operations](https://skmtc.net/lichess/apis/lichess-org-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lichess/lichess-org-api-reference/revisions/f16676f55a94/schema)