LeaderboardEndpoint#

class corkus.endpoints.LeaderboardEndpoint#
async guild(timeout=None)#

Returns a leaderboard of guilds with a length of 100. Sorted by territories currently owned, then level.

Parameters:

timeout (Optional[int]) – Optionally override default timeout.

Return type:

List[LeaderboardGuild]

async combat(timeout=None)#

Returns a leaderboard of players with a length of 100. Sorted by player combat level/xp.

Parameters:

timeout (Optional[int]) – Optionally override default timeout.

Return type:

List[LeaderboardPlayer]

async pvp(*, timeframe=Timeframe.ALL_TIME, timeout=None)#

Returns a leaderboard of players with a length of 100. Sorted by LeaderboardPlayer.pvp_kills.

Caution

Since The Nether is disabled changing timeframe doesn’t do anything.

Parameters:
  • timeframe (Optional[Timeframe]) – Timeframe for results will be returned.

  • timeout (Optional[int]) – Optionally override default timeout.

Return type:

List[LeaderboardPlayer]