Interface LeaderboardListResponse

GET /api/leaderboard/list response

See

ScreepsHttpClient.leaderboardList

interface LeaderboardListResponse {
    count: number;
    list: LeaderboardResult[];
    ok: 1;
    users: Users;
}

Hierarchy (View Summary)

ScreepsResponse
- LeaderboardListResponse

Index

Properties

count list ok users

Properties

count

count: number

Total number of results in this season

list

list: LeaderboardResult[]

ok

ok: 1

An API success response always contains { ok: 1 }

users

users: Users