Library referenceClasses
Krunker
the three krunker apis behind one object:
- the documented developer api on the root (
krunker.player,krunker.market, ...), needsapiKey krunker.game.*, what the game itself reads without any authkrunker.as(token).*, what the game reads with the player's own frvr token
Extends
Constructors
Constructor
new Krunker(options?): Krunker;Parameters
| Parameter | Type |
|---|---|
options? | KrunkerOptions |
Returns
Krunker
Overrides
KrunkerDeveloperApi.constructor
Properties
| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
clan | readonly | ClanApi | - | KrunkerDeveloperApi.clan |
events | readonly | EventsApi | needs an events scope on the key | KrunkerDeveloperApi.events |
game | readonly | KrunkerGameApi | - | - |
kpd | readonly | KpdApi | needs the kpd scope on the key | KrunkerDeveloperApi.kpd |
leaderboard | readonly | LeaderboardApi | - | KrunkerDeveloperApi.leaderboard |
map | readonly | MapApi | - | KrunkerDeveloperApi.map |
market | readonly | MarketApi | - | KrunkerDeveloperApi.market |
match | readonly | MatchApi | - | KrunkerDeveloperApi.match |
mods | readonly | ModsApi | - | KrunkerDeveloperApi.mods |
player | readonly | PlayerApi | - | KrunkerDeveloperApi.player |
skins | readonly | SkinsApi | - | KrunkerDeveloperApi.skins |
Accessors
configured
Get Signature
get configured(): boolean;false without an api key, every call throws KrunkerConfigError then
Returns
boolean
Inherited from
KrunkerDeveloperApi.configured
Methods
as()
as(token): TokenSession;the endpoints bound to a player's token; throws KrunkerTokenError before any request when it is not a live jwt
Parameters
| Parameter | Type |
|---|---|
token | string |
Returns
rateLimit()
rateLimit(): RateLimitState;what the last replies said about the key's window, for a health or admin view