Private constructorPrivate apiplayer name
gateway properties
player rankings
Returns "full" account information, more time consuming API call.
Corresponds to the bw api endpoint auroraProfileByToon with the property mask scr_profile.
FullAccount for fields returned.
EntityNotFoundError if no such account could be found
player name
gateway properties
"full" account information
Returns "full" account information except for their game history. More performant than fullAccount.
Corresponds to the bw api endpoint auroraProfileByToon with the property mask scr_tooninfo.
FullAccountMinusGameHistory for fields returned.
player name
gateway properties
"full" account information except for their game history
Returns the gateway with the given id or region.
EntityNotFoundError if no such gateway could be found
The gateway with the given id or region
Returns all known gateways. This is just a static list of gateways, since they're expected to be
non-changing. The only dynamic data is the number of online users, which is accessible via the
onlineUsers method on the returned gateway objects.
All known gateways
Returns the leaderboard with the given id or game mode, gateway, and season combination.
The default lookup properties (if leaderboard id is not used) are the current season, 1v1, and the global gateway.
EntityNotFoundError if no such leaderboard could be found
The id or game mode, gateway, and season combination
The selected leaderboard
Returns the leaderboards.
Leaderboards are the combination of game mode, gateway, and season. Each leaderboard has a unique id, which is used for making other queries. For example, when fetching player rankings, you must specify the leaderboard.
The leaderboards
Returns the map stats with the given toon and gateway.
Resultant structure is a nested map of GameMode -> SeasonNumber -> MapId -> Race -> MapStats
player name
gateway properties
map stats
Returns a generator that yields the match history for the given player.
The player's in-game id
The gateway the player plays on
The leaderboard to query
Optional limit: numberThe maximum number of matches to return
A generator that yields the match history for the given player
Returns a "minimal" account profile for the given toon and gateway.
This corresponds to the bw api endpoint auroraProfileByToon with the property mask scr_mmgameloading.
MinimalAccount for fields returned.
EntityNotFoundError if no such account could be found
A "minimal" account profile for the given toon and gateway
Returns a "minimal" account profile for the given toon and gateway, with the number of games played in the last week accessible on the account's profiles.
This corresponds to the bw api endpoint auroraProfileByToon with the property mask scr_mmtooninfo.
MinimalAccountWithGamesPlayedLastWeek for fields returned.
EntityNotFoundError if no such account could be found
A "minimal" account profile for the given toon and gateway, with the number of games played in the last week
Returns the number of online users on the given gateway.
EntityNotFoundError if no such gateway could be found
The number of online users on the given gateway
Given a leaderboardProps and an index (0-indexed rank), returns the player ranking at that index.
The index of the ranking to query
The leaderboard to query
The player ranking at the given index
Returns a generator that yields the rankings for the given leaderboard.
The index of the first ranking to return (0-indexed)
Optional limit: numberThe maximum number of rankings to return
Static createOptional api: ISCApiGenerated using TypeDoc
Returns the player rankings for the given toon and gateway. Note that this returns all rankings for all toons for the given player, not just the requested toon.