Class Client

constructor

• new Client(key: string, options?: ClientOptions): Client

  Parameters

  • key: string
  • Optionaloptions: ClientOptions

  Returns Client

ReadonlycacheHandler

Optionalinterval

Readonlykey

Readonlymowojang

Readonlyoptions

ReadonlyrequestHandler

Readonlyupdater

destroy

• destroy(): void

  Returns void

getAchievements

• getAchievements(
      options?: RequestOptions,
  ): Promise<RequestData<Achievements, any>>

  Parameters

  • Optionaloptions: RequestOptions

  Returns Promise<RequestData<Achievements, any>>

getActiveHouses

• getActiveHouses(options?: RequestOptions): Promise<RequestData<House[], any>>

  Parameters

  • Optionaloptions: RequestOptions

  Returns Promise<RequestData<House[], any>>

getBoosters

• getBoosters(options?: RequestOptions): Promise<RequestData<Booster[], any>>

  Parameters

  • Optionaloptions: RequestOptions

  Returns Promise<RequestData<Booster[], any>>

getChallenges

• getChallenges(options?: RequestOptions): Promise<RequestData<Challenges, any>>

  Parameters

  • Optionaloptions: RequestOptions

  Returns Promise<RequestData<Challenges, any>>

getGameCounts

• getGameCounts(options?: RequestOptions): Promise<RequestData<GameCounts, any>>

  Parameters

  • Optionaloptions: RequestOptions

  Returns Promise<RequestData<GameCounts, any>>

getGuild

• getGuild(
      searchParameter: "name" | "id" | "player",
      query: string,
      options?: RequestOptions,
  ): Promise<RequestData<null | Guild, any>>

  Parameters

  • searchParameter: "name" | "id" | "player"
  • query: string
  • Optionaloptions: RequestOptions

  Returns Promise<RequestData<null | Guild, any>>

getGuildAchievements

• getGuildAchievements(
      options?: RequestOptions,
  ): Promise<RequestData<GuildAchievements, any>>

  Parameters

  • Optionaloptions: RequestOptions

  Returns Promise<RequestData<GuildAchievements, any>>

getHouse

• getHouse(
      query: string,
      options?: RequestOptions,
  ): Promise<RequestData<House, any>>

  Parameters

  • query: string
  • Optionaloptions: RequestOptions

  Returns Promise<RequestData<House, any>>

getLeaderboards

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

  Parameters

  • Optionaloptions: RequestOptions

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

getPlayer

• getPlayer(
      query: string,
      options?: PlayerRequestOptions,
  ): Promise<RequestData<Player, any>>

  Parameters

  • query: string
  • Optionaloptions: PlayerRequestOptions

  Returns Promise<RequestData<Player, any>>

getPlayerHouses

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

  Parameters

  • query: string
  • Optionaloptions: RequestOptions

  Returns Promise<RequestData<House[], any>>

getQuests

• getQuests(options?: RequestOptions): Promise<RequestData<Quests, any>>

  Parameters

  • Optionaloptions: RequestOptions

  Returns Promise<RequestData<Quests, any>>

getRecentGames

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

  Parameters

  • query: string
  • Optionaloptions: RequestOptions

  Returns Promise<RequestData<RecentGame[], any>>

getSkyBlockAuction

• getSkyBlockAuction(
      type: "PROFILE" | "PLAYER" | "AUCTION_ID",
      query: string,
      options?: AuctionRequestOptions,
  ): Promise<RequestData<SkyBlockAuctionResult, any>>

  Parameters

  • type: "PROFILE" | "PLAYER" | "AUCTION_ID"
  • query: string
  • Optionaloptions: AuctionRequestOptions

  Returns Promise<RequestData<SkyBlockAuctionResult, any>>

getSkyBlockAuctions

• getSkyBlockAuctions(
      query: number | "*",
      options?: AuctionRequestOptions,
  ): Promise<RequestData<SkyBlockAuctionsResult, any>>

  Parameters

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

  Returns Promise<RequestData<SkyBlockAuctionsResult, any>>

getSkyBlockBazaar

• getSkyBlockBazaar(
      options?: RequestOptions,
  ): Promise<RequestData<SkyBlockBazaar, any>>

  Parameters

  • Optionaloptions: RequestOptions

  Returns Promise<RequestData<SkyBlockBazaar, any>>

getSkyBlockBingo

• getSkyBlockBingo(
      options?: RequestOptions,
  ): Promise<RequestData<SkyBlockBingo, any>>

  Parameters

  • Optionaloptions: RequestOptions

  Returns Promise<RequestData<SkyBlockBingo, any>>

getSkyBlockCollections

• getSkyBlockCollections(
      options?: RequestOptions,
  ): Promise<RequestData<SkyBlockCollections, any>>

  Parameters

  • Optionaloptions: RequestOptions

  Returns Promise<RequestData<SkyBlockCollections, any>>

getSkyBlockElection

• getSkyBlockElection(
      options?: RequestOptions,
  ): Promise<RequestData<SkyBlockElectionData, any>>

  Parameters

  • Optionaloptions: RequestOptions

  Returns Promise<RequestData<SkyBlockElectionData, any>>

getSkyBlockEndedAuctions

• getSkyBlockEndedAuctions(
      options?: AuctionRequestOptions,
  ): Promise<RequestData<SkyBlockAuctionResult, any>>

  Parameters

  • Optionaloptions: AuctionRequestOptions

  Returns Promise<RequestData<SkyBlockAuctionResult, any>>

getSkyBlockFireSales

• getSkyBlockFireSales(
      options?: RequestOptions,
  ): Promise<RequestData<SkyBlockFireSale[], any>>

  Parameters

  • Optionaloptions: RequestOptions

  Returns Promise<RequestData<SkyBlockFireSale[], any>>

getSkyBlockGarden

• getSkyBlockGarden(
      profileId: string,
      options?: RequestOptions,
  ): Promise<RequestData<SkyBlockGarden, any>>

  Parameters

  • profileId: string
  • Optionaloptions: RequestOptions

  Returns Promise<RequestData<SkyBlockGarden, any>>

getSkyBlockItems

• getSkyBlockItems(
      options?: RequestOptions,
  ): Promise<RequestData<SkyBlockItem[], any>>

  Parameters

  • Optionaloptions: RequestOptions

  Returns Promise<RequestData<SkyBlockItem[], any>>

getSkyBlockMuseum

• getSkyBlockMuseum(
      profileId: string,
      options?: RequestOptions,
  ): Promise<RequestData<SkyBlockMuseum, any>>

  Parameters

  • profileId: string
  • Optionaloptions: RequestOptions

  Returns Promise<RequestData<SkyBlockMuseum, any>>

getSkyBlockNews

• getSkyBlockNews(
      options?: RequestOptions,
  ): Promise<RequestData<SkyBlockNews[], any>>

  Parameters

  • Optionaloptions: RequestOptions

  Returns Promise<RequestData<SkyBlockNews[], any>>

getSkyBlockProfile

• getSkyBlockProfile(
      profileId: string,
      options?: SkyBlockRequestOptions,
  ): Promise<RequestData<SkyBlockProfile, any>>

  Parameters

  • profileId: string
  • Optionaloptions: SkyBlockRequestOptions

  Returns Promise<RequestData<SkyBlockProfile, any>>

getSkyBlockProfiles

• getSkyBlockProfiles(
      query: string,
      options?: SkyBlockRequestOptions,
  ): Promise<
      RequestData<
          WithSelectedProfile<
              Map<
                  | "UNKNOWN"
                  | "Blueberry"
                  | "Apple"
                  | "Banana"
                  | "Coconut"
                  | "Cucumber"
                  | "Grapes"
                  | "Kiwi"
                  | "Lemon"
                  | "Lime"
                  | "Mango"
                  | "Orange"
                  | "Papaya"
                  | "Pear"
                  | "Peach"
                  | "Pineapple"
                  | "Pomegranate"
                  | "Raspberry"
                  | "Strawberry"
                  | "Tomato"
                  | "Watermelon"
                  | "Zucchini"
                  | "Not Allowed To Quit SkyBlock Ever Again"
                  | "Complain Everyday"
                  | "Restored"
                  | "TEST",
                  SkyBlockProfile,
              >,
          >,
          any,
      >,
  >

  Parameters

  • query: string
  • Optionaloptions: SkyBlockRequestOptions

  Returns Promise<
      RequestData<
          WithSelectedProfile<
              Map<
                  | "UNKNOWN"
                  | "Blueberry"
                  | "Apple"
                  | "Banana"
                  | "Coconut"
                  | "Cucumber"
                  | "Grapes"
                  | "Kiwi"
                  | "Lemon"
                  | "Lime"
                  | "Mango"
                  | "Orange"
                  | "Papaya"
                  | "Pear"
                  | "Peach"
                  | "Pineapple"
                  | "Pomegranate"
                  | "Raspberry"
                  | "Strawberry"
                  | "Tomato"
                  | "Watermelon"
                  | "Zucchini"
                  | "Not Allowed To Quit SkyBlock Ever Again"
                  | "Complain Everyday"
                  | "Restored"
                  | "TEST",
                  SkyBlockProfile,
              >,
          >,
          any,
      >,
  >

getSkyBlockSkills

• getSkyBlockSkills(
      options?: RequestOptions,
  ): Promise<RequestData<SkyBlockSkills, any>>

  Parameters

  • Optionaloptions: RequestOptions

  Returns Promise<RequestData<SkyBlockSkills, any>>

getStatus

• getStatus(
      query: string,
      options?: RequestOptions,
  ): Promise<RequestData<Status, any>>

  Parameters

  • query: string
  • Optionaloptions: RequestOptions

  Returns Promise<RequestData<Status, any>>

getWatchdogStats

• getWatchdogStats(
      options?: RequestOptions,
  ): Promise<RequestData<WatchdogStats, any>>

  Parameters

  • Optionaloptions: RequestOptions

  Returns Promise<RequestData<WatchdogStats, any>>