Skip to main content
GET
/
v1
/
leaderboard
Monthly leaderboard
curl --request GET \
  --url http://localhost:8787/v1/leaderboard \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "display_name": "<string>",
      "followers": 123,
      "watchtime": 123,
      "averageviewers": 123,
      "peakviewers": 123,
      "followergain": 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

orderBy
enum<string>
default:watchtime

Metric used for sorting results.

Available options:
watchtime,
averageviewers,
followers,
followergain,
peakviewers
limit
integer
default:100
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