PublicTurfApi
GET /territorial-wars/*: Turf Wars status, clans, players and leaderboards
Constructors
Constructor
new PublicTurfApi(gapi): PublicTurfApi;Parameters
| Parameter | Type |
|---|---|
gapi | KrunkerClient |
Returns
PublicTurfApi
Methods
clan()
clan(clanId): Promise<TurfClan>;GET /territorial-wars/clan/:id
Parameters
| Parameter | Type |
|---|---|
clanId | number |
Returns
Promise<TurfClan>
clanEarnings()
clanEarnings(clanId): Promise<TurfClanEarning[]>;GET /territorial-wars/clan/:id/earnings
Parameters
| Parameter | Type |
|---|---|
clanId | number |
Returns
Promise<TurfClanEarning[]>
clanPayouts()
clanPayouts(clanId, day?): Promise<TurfPayouts>;GET /territorial-wars/clan/:id/payouts, season totals without a day
Parameters
| Parameter | Type |
|---|---|
clanId | number |
day? | number |
Returns
Promise<TurfPayouts>
clanPlayers()
clanPlayers(clanId, query?): Promise<TurfPlayerRow[]>;GET /territorial-wars/clan/:id/players, today without a day
Parameters
| Parameter | Type |
|---|---|
clanId | number |
query? | DayMapQuery |
Returns
Promise<TurfPlayerRow[]>
player()
player(playerId): Promise<TurfPlayer>;GET /territorial-wars/player/:id, also resolves a stored id to the current name
Parameters
| Parameter | Type |
|---|---|
playerId | number |
Returns
Promise<TurfPlayer>
playerContributions()
playerContributions(playerId, day?): Promise<TurfContribution[]>;GET /territorial-wars/player/:id/contributions, every day and map of the season
Parameters
| Parameter | Type |
|---|---|
playerId | number |
day? | number |
Returns
Promise<TurfContribution[]>
playerEarnings()
playerEarnings(playerId): Promise<TurfPlayerEarning[]>;GET /territorial-wars/player/:id/earnings
Parameters
| Parameter | Type |
|---|---|
playerId | number |
Returns
Promise<TurfPlayerEarning[]>
status()
status(): Promise<TurfStatus[]>;GET /territorial-wars/status, every turf map with its owner and top 5
Returns
Promise<TurfStatus[]>
topClans()
topClans(query?): Promise<TurfTopClan[]>;GET /territorial-wars/leaderboards/top-performing-clans, 100 rows, clan_name is an exact match filter
Parameters
| Parameter | Type |
|---|---|
query? | DayMapQuery & { clan_name?: string; } |
Returns
Promise<TurfTopClan[]>
topGrossing()
topGrossing(clanName?): Promise<TurfTopGrossingClan[]>;GET /territorial-wars/leaderboards/top-grossing-clans
Parameters
| Parameter | Type |
|---|---|
clanName? | string |
Returns
Promise<TurfTopGrossingClan[]>
topPlayers()
topPlayers(query?): Promise<TurfTopPlayer[]>;GET /territorial-wars/leaderboards/top-performing-players, slow (seconds)
Parameters
| Parameter | Type |
|---|---|
query? | { map_id?: number; player_name?: string; } |
query.map_id? | number |
query.player_name? | string |
Returns
Promise<TurfTopPlayer[]>