krapio
Library referenceClasses

KrunkerDeveloperApi

the documented developer api; one key is one rate limit window, so keep one instance per key

Extended by

Constructors

Constructor

new KrunkerDeveloperApi(options?): KrunkerDeveloperApi;

Parameters

ParameterType
options?ClientOptions

Returns

KrunkerDeveloperApi

Properties

PropertyModifierTypeDescription
clanreadonlyClanApi-
eventsreadonlyEventsApineeds an events scope on the key
kpdreadonlyKpdApineeds the kpd scope on the key
leaderboardreadonlyLeaderboardApi-
mapreadonlyMapApi-
marketreadonlyMarketApi-
matchreadonlyMatchApi-
modsreadonlyModsApi-
playerreadonlyPlayerApi-
skinsreadonlySkinsApi-

Accessors

configured

Get Signature

get configured(): boolean;

false without an api key, every call throws KrunkerConfigError then

Returns

boolean

Methods

rateLimit()

rateLimit(): RateLimitState;

what the last replies said about the key's window, for a health or admin view

Returns

RateLimitState

On this page