---
title: "Get current simuls"
method: GET
path: "/api/simul"
tags: ["Simuls"]
---

# Get current simuls

`GET /api/simul`

Get recently created, started, finished, simuls.
Created and finished simul lists are not exhaustives, only those with
strong enough host will be listed, the same filter is used to display simuls on https://lichess.org/simul.
When [authenticated with OAuth2](#description/authentication), the pending list will be populated with your created, but unstarted simuls.

## Response `200`

The list of simuls.

- object
  - `pending` Simul[]
    - `id` string, required
    - `host` object, required
      - `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
      - `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.
      - `rating` integer
      - `provisional` boolean
      - `gameId` string
      - `online` boolean
    - `name` string, required
    - `fullName` string, required
    - `variants` object[], required
      - `key` 'standard' | 'chess960' | 'crazyhouse' | 'antichess' | 'atomic' | 'horde' | 'kingOfTheHill' | 'racingKings' | 'threeCheck' | 'fromPosition'
      - `icon` string
      - `name` string
    - `isCreated` boolean, required
    - `isFinished` boolean, required
    - `isRunning` boolean, required
    - `text` string
    - `estimatedStartAt` integer
    - `startedAt` integer
    - `finishedAt` integer
    - `nbApplicants` integer, required
    - `nbPairings` integer, required
  - `created` Simul[]
    - `id` string, required
    - `host` object, required
      - `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
      - `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.
      - `rating` integer
      - `provisional` boolean
      - `gameId` string
      - `online` boolean
    - `name` string, required
    - `fullName` string, required
    - `variants` object[], required
      - `key` 'standard' | 'chess960' | 'crazyhouse' | 'antichess' | 'atomic' | 'horde' | 'kingOfTheHill' | 'racingKings' | 'threeCheck' | 'fromPosition'
      - `icon` string
      - `name` string
    - `isCreated` boolean, required
    - `isFinished` boolean, required
    - `isRunning` boolean, required
    - `text` string
    - `estimatedStartAt` integer
    - `startedAt` integer
    - `finishedAt` integer
    - `nbApplicants` integer, required
    - `nbPairings` integer, required
  - `started` Simul[]
    - `id` string, required
    - `host` object, required
      - `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
      - `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.
      - `rating` integer
      - `provisional` boolean
      - `gameId` string
      - `online` boolean
    - `name` string, required
    - `fullName` string, required
    - `variants` object[], required
      - `key` 'standard' | 'chess960' | 'crazyhouse' | 'antichess' | 'atomic' | 'horde' | 'kingOfTheHill' | 'racingKings' | 'threeCheck' | 'fromPosition'
      - `icon` string
      - `name` string
    - `isCreated` boolean, required
    - `isFinished` boolean, required
    - `isRunning` boolean, required
    - `text` string
    - `estimatedStartAt` integer
    - `startedAt` integer
    - `finishedAt` integer
    - `nbApplicants` integer, required
    - `nbPairings` integer, required
  - `finished` Simul[]
    - `id` string, required
    - `host` object, required
      - `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
      - `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.
      - `rating` integer
      - `provisional` boolean
      - `gameId` string
      - `online` boolean
    - `name` string, required
    - `fullName` string, required
    - `variants` object[], required
      - `key` 'standard' | 'chess960' | 'crazyhouse' | 'antichess' | 'atomic' | 'horde' | 'kingOfTheHill' | 'racingKings' | 'threeCheck' | 'fromPosition'
      - `icon` string
      - `name` string
    - `isCreated` boolean, required
    - `isFinished` boolean, required
    - `isRunning` boolean, required
    - `text` string
    - `estimatedStartAt` integer
    - `startedAt` integer
    - `finishedAt` integer
    - `nbApplicants` integer, required
    - `nbPairings` integer, required

---

[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/versions/1425db81eb3b/schema)