Skip to main content
GET
/
v1
/
leaderboard
/
live
Live channels
curl --request GET \
  --url http://localhost:8787/v1/leaderboard/live \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "stream_id": "<string>",
      "streamer_id": "<string>",
      "display_name": "<string>",
      "profile_image": "<string>",
      "type": "<string>",
      "description": "<string>",
      "title": "<string>",
      "game_name": "<string>",
      "started_at": "2023-11-07T05:31:56Z",
      "current_viewers": 123
    }
  ],
  "hasMore": true,
  "nextCursor": 123
}

Authorizations

Authorization
string
header
required

Optional bearer token enforced when the Worker is configured with an API token.

Query Parameters

limit
integer
default:50
Required range: 1 <= x <= 200
offset
integer
default:0
Required range: x >= 0

Response

Successful response

items
object[]
required
hasMore
boolean
required
nextCursor
integer | null