---
title: "Stream incoming events"
method: GET
path: "/api/stream/event"
tags: ["Board", "Bot"]
---

# Stream incoming events

`GET /api/stream/event`

Stream the events reaching a lichess user in real time as [ndjson](#description/streaming-with-nd-json).

An empty line is sent every 7 seconds for keep alive purposes.

Each non-empty line is a JSON object containing a `type` field. Possible values are:
- `gameStart` Start of a game
- `gameFinish` Completion of a game
- `challenge` A player sends you a challenge or you challenge someone
- `challengeCanceled` A player cancels their challenge to you
- `challengeDeclined` The opponent declines your challenge

When the stream opens, all current challenges and games are sent.

Only one global event stream can be active at a time. When the stream opens, the previous one with the same access token is closed.

## Response `200`

The stream of events reaching the logged in user.

## Changes

- **2026-09-02** `9b0422af5084` — 9 info
  - the response property `oneOf[#/components/schemas/ChallengeCanceledEvent]/challenge/timeControl/oneOf[subschema #1: Real-time]/type` became required for the status `200`
  - the response property `oneOf[#/components/schemas/ChallengeCanceledEvent]/challenge/timeControl/oneOf[subschema #2: Correspondence]/type` became required for the status `200`
  - the response property `oneOf[#/components/schemas/ChallengeCanceledEvent]/challenge/timeControl/oneOf[subschema #3: Unlimited]/type` became required for the status `200`
  - the response property `oneOf[#/components/schemas/ChallengeDeclinedEvent]/challenge/allOf[#/components/schemas/ChallengeJson]/timeControl/oneOf[subschema #1: Real-time]/type` became required for the status `200`
  - …5 more

[Change history](https://skmtc.dev/lichess/apis/lichess-org-api-reference/changes/api/stream/event/get.md)

---

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