Stream Leaderboards API Docs

Returns leaderboard entries for a given leaderboard owned by the API key's account.

  • name (string) — Leaderboard name (case-insensitive)
  • count (int) — Entries to return (1–100). Default: 10
  • offset (int) — Start index. Optional

Returns leaderboard settings for a given leaderboard owned by the API key's account.

  • name (string) — Leaderboard name (case-insensitive)

Returns a viewer’s score and info in a specific leaderboard.

  • id (string) — Viewer/channel ID
  • name (string) — Leaderboard name (case-insensitive)

Returns all leaderboard-related data for a given viewer across all linked leaderboards.

  • id (string) — Viewer/channel ID

Adds points to a viewer’s score in a specific leaderboard. Score must be a positive number.

  • name (string) — Leaderboard name
  • id (string) — Viewer/channel ID
  • score (int) — Score to add (must be > 0)

Directly sets a viewer’s score in the leaderboard. Negative scores allowed only when strict = false.

  • name (string) — Leaderboard name
  • id (string) — Viewer/channel ID
  • score (int) — Score to set
  • strict (bool) — If true, score must be ≥ 0. Default: true

Subtracts points from a viewer’s score. If strict = true, score will not drop below 0.

  • name (string) — Leaderboard name
  • id (string) — Viewer/channel ID
  • score (int) — Score to subtract (must be > 0)
  • strict (bool) — Prevent negative score if true. Default: true

Removes a viewer’s score entry from a leaderboard. This does not delete the viewer account.

  • name (string) — Leaderboard name
  • id (string) — Viewer/channel ID