Class Client

constructor

• new Client(key, options?): Client

• Parameters

  • key: string
  • Optionaloptions: ClientOptions

  Returns Client

cacheHandler

errors

functions

interval

Readonlykey

options

rateLimit

requestHandler

updater

destroy

• destroy(): void

• Returns void

getAchievements

• getAchievements(options?): Promise<Achievements | RequestData>

• Parameters

  • Optionaloptions: RequestOptions

  Returns Promise<Achievements | RequestData>

getActiveHouses

• getActiveHouses(options?): Promise<RequestData | House[]>

• Parameters

  • Optionaloptions: RequestOptions

  Returns Promise<RequestData | House[]>

getBoosters

• getBoosters(options?): Promise<RequestData | Booster[]>

• Parameters

  • Optionaloptions: RequestOptions

  Returns Promise<RequestData | Booster[]>

getChallenges

• getChallenges(options?): Promise<RequestData | Challenges>

• Parameters

  • Optionaloptions: RequestOptions

  Returns Promise<RequestData | Challenges>

getGameCounts

• getGameCounts(options?): Promise<RequestData | GameCounts>

• Parameters

  • Optionaloptions: RequestOptions

  Returns Promise<RequestData | GameCounts>

getGuild

• getGuild(searchParameter, query, options?): Promise<null | RequestData | Guild>

• Parameters

  • searchParameter: GuildFetchOptions
  • query: string
  • Optionaloptions: RequestOptions

  Returns Promise<null | RequestData | Guild>

getGuildAchievements

• getGuildAchievements(options?): Promise<RequestData | GuildAchievements>

• Parameters

  • Optionaloptions: RequestOptions

  Returns Promise<RequestData | GuildAchievements>

getHouse

• getHouse(query, options?): Promise<RequestData | House>

• Parameters

  • query: string
  • Optionaloptions: RequestOptions

  Returns Promise<RequestData | House>

getLeaderboards

• getLeaderboards(options?): Promise<RequestData | Record<string, Leaderboard[]>>

• Parameters

  • Optionaloptions: RequestOptions

  Returns Promise<RequestData | Record<string, Leaderboard[]>>

getPlayer

• getPlayer(query, options?): Promise<RequestData | Player>

• Parameters

  • query: string
  • Optionaloptions: PlayerRequestOptions

  Returns Promise<RequestData | Player>

getPlayerHouses

• getPlayerHouses(query, options?): Promise<RequestData | House[]>

• Parameters

  • query: string
  • Optionaloptions: RequestOptions

  Returns Promise<RequestData | House[]>

getQuests

• getQuests(options?): Promise<RequestData | Quests>

• Parameters

  • Optionaloptions: RequestOptions

  Returns Promise<RequestData | Quests>

getRecentGames

• getRecentGames(query, options?): Promise<RequestData | RecentGame[]>

• Parameters

  • query: string
  • Optionaloptions: RequestOptions

  Returns Promise<RequestData | RecentGame[]>

getSkyblockAuction

• getSkyblockAuction(type, query, options?): Promise<RequestData | Auction[]>

• Parameters

  • type: AuctionFetchOptions
  • query: string
  • Optionaloptions: AuctionRequestOptions

  Returns Promise<RequestData | Auction[]>

getSkyblockAuctions

• getSkyblockAuctions(query, options?): Promise<SkyblockAuctionsResult>

• Parameters

  • query: number | "*"
  • Optionaloptions: AuctionRequestOptions

  Returns Promise<SkyblockAuctionsResult>

getSkyblockAuctionsByPlayer

• getSkyblockAuctionsByPlayer(query, options?): Promise<RequestData | Auction[]>

• Parameters

  • query: string
  • Optionaloptions: AuctionRequestOptions

  Returns Promise<RequestData | Auction[]>

getSkyblockBazaar

• getSkyblockBazaar(options?): Promise<RequestData | Product[]>

• Parameters

  • Optionaloptions: RequestOptions

  Returns Promise<RequestData | Product[]>

getSkyblockBingo

• getSkyblockBingo(options?): Promise<RequestData | BingoData>

• Parameters

  • Optionaloptions: RequestOptions

  Returns Promise<RequestData | BingoData>

getSkyblockFireSales

• getSkyblockFireSales(options?): Promise<RequestData | FireSale[]>

• Parameters

  • Optionaloptions: RequestOptions

  Returns Promise<RequestData | FireSale[]>

getSkyblockGarden

• getSkyblockGarden(profileId, options?): Promise<RequestData | SkyblockGarden>

• Parameters

  • profileId: string
  • Optionaloptions: RequestOptions

  Returns Promise<RequestData | SkyblockGarden>

getSkyblockGovernment

• getSkyblockGovernment(options?): Promise<RequestData | GovernmentData>

• Parameters

  • Optionaloptions: RequestOptions

  Returns Promise<RequestData | GovernmentData>

getSkyblockMember

• getSkyblockMember(query, options?): Promise<RequestData | Map<string, SkyblockMember>>

• Parameters

  • query: string
  • Optionaloptions: SkyblockRequestOptions

  Returns Promise<RequestData | Map<string, SkyblockMember>>

getSkyblockMuseum

• getSkyblockMuseum(query, profileId, options?): Promise<RequestData | SkyblockMuseum>

• Parameters

  • query: string
  • profileId: string
  • Optionaloptions: RequestOptions

  Returns Promise<RequestData | SkyblockMuseum>

getSkyblockNews

• getSkyblockNews(options?): Promise<RequestData | SkyblockNews[]>

• Parameters

  • Optionaloptions: RequestOptions

  Returns Promise<RequestData | SkyblockNews[]>

getSkyblockProfiles

• getSkyblockProfiles(query, options?): Promise<RequestData | SkyblockProfile[]>

• Parameters

  • query: string
  • Optionaloptions: SkyblockRequestOptions

  Returns Promise<RequestData | SkyblockProfile[]>

getStatus

• getStatus(query, options?): Promise<RequestData | Status>

• Parameters

  • query: string
  • Optionaloptions: RequestOptions

  Returns Promise<RequestData | Status>

getWatchdogStats

• getWatchdogStats(options?): Promise<RequestData | WatchdogStats>

• Parameters

  • Optionaloptions: RequestOptions

  Returns Promise<RequestData | WatchdogStats>