TEteambattles
Streaming

Get a user's live-stream status

Changed on

Returns whether a user is live, the platforms they are live on, and their primary (highest-viewer) stream details. The {identifier} may be a username or a Convex user ID. Visible for public or limited profiles, plus self; a private non-self profile returns 403. Unknown or currently-banned users return 404 (a banned user's existence is not leaked). When offline, isLive is false, platforms is empty, and primaryStream is null. Requires stream.read.

get/users/{identifier}/stream

Request

  • Base URL
    https://teambattles.gg/api/v1
  • URL
    https://teambattles.gg/api/v1/users/{identifier}/stream
  • Auth
    HTTP bearer

Path parameters

identifierstring required

Username or Convex user ID.

Response

The user's live-stream status.

timestampstring required

ISO 8601 timestamp.

Changes