SkyBlockManager

Skyblock related endpoints

@see

https://api.hypixel.net/#tag/SkyBlock

Hierarchy

• BaseManager
  • SkyBlockManager

Index

Constructors

• constructor

Methods

• fetchActiveAuctions
• fetchActiveBingoGoals
• fetchAuction
• fetchBazaar
• fetchBingoData
• fetchCollections
• fetchElectionAndMayor
• fetchFireSales
• fetchItems
• fetchNews
• fetchPlayerSkyBlockProfiles
• fetchProfile
• fetchRecentlyEndedAuctions
• fetchSkills

Constructors

publicconstructor

• new SkyBlockManager(client: Client): SkyBlockManager

• Overrides BaseManager.constructor

  Parameters

  • client: Client

  Returns SkyBlockManager

Methods

publicfetchActiveAuctions

• fetchActiveAuctions(page?: number, resolveAuctions?: boolean): Promise<{ auctions: APISkyBlockAuction[]; lastUpdated: number; page: number; totalAuctions: number; totalPages: number }>

• Fetch the currently active auctions (sorted by last updated first and paginated)

  @see

  SkyBlockAuction class. Defaults to true.

  ---

  Parameters

  • optionalpage: number

    The page number

  • resolveAuctions: boolean = true

    Whether to resolve the auctions returned, to a

  Returns Promise<{ auctions: APISkyBlockAuction[]; lastUpdated: number; page: number; totalAuctions: number; totalPages: number }>

publicfetchActiveBingoGoals

• fetchActiveBingoGoals(): Promise<FetchActiveBingoGoalsResponse>

• Fetch information regarding the current bingo event and its goals

  ---

  Returns Promise<FetchActiveBingoGoalsResponse>

publicfetchAuction

• fetchAuction(identifier: string, type: player | uuid | profile, raw?: boolean): Promise<SkyBlockAuction[] | APISkyBlockAuction[]>

• Fetch a SkyBlock auction.

  ---

  Parameters

  • identifier: string

    The idenitifer you're using to fetch the auction

  • type: player | uuid | profile

    The type of identifier you're passing (either auction uuid, uuid of the player, uuid of the profile)

  • raw: boolean = false

    Whether to return the raw response, without converting each auction to an @seeSkyBlockAuction class. Defaults to false.

  Returns Promise<SkyBlockAuction[] | APISkyBlockAuction[]>

publicfetchBazaar

• fetchBazaar(): Promise<FetchBazaarResponse>

• Fetch bazaar items

  ---

  Returns Promise<FetchBazaarResponse>

publicfetchBingoData

• fetchBingoData(playerUuid: string): Promise<FetchBingoDataResponse>

• Fetch bingo data of a player

  ---

  Parameters

  • playerUuid: string

    The uuid of the player

  Returns Promise<FetchBingoDataResponse>

publicfetchCollections

• fetchCollections(): Promise<FetchCollectionsResponse>

• Fetch information regarding collections in the SkyBlock game

  ---

  Returns Promise<FetchCollectionsResponse>

publicfetchElectionAndMayor

• fetchElectionAndMayor(): Promise<FetchElectionAndMayorResponse>

• Fetch information regarding the current mayor and ongoing election in SkyBlock

  ---

  Returns Promise<FetchElectionAndMayorResponse>

publicfetchFireSales

• fetchFireSales(): Promise<FetchFireSalesResponseFireSale[]>

• Fetch the currently active or upcoming Fire Sales for SkyBlock

  ---

  Returns Promise<FetchFireSalesResponseFireSale[]>

publicfetchItems

• fetchItems(): Promise<FetchItemsResponse>

• Fetch information regarding items in the SkyBlock game

  ---

  Returns Promise<FetchItemsResponse>

publicfetchNews

• fetchNews(): Promise<{ items: FetchNewsResponseItem[] }>

• Fetch SkyBlock news

  ---

  Returns Promise<{ items: FetchNewsResponseItem[] }>

publicfetchPlayerSkyBlockProfiles

• fetchPlayerSkyBlockProfiles(playerUuid: string): Promise<SkyBlockProfile[]>

• Fetch a SkyBlock profiles of a player

  ---

  Parameters

  • playerUuid: string

    The uuid of the player

  Returns Promise<SkyBlockProfile[]>

publicfetchProfile

• fetchProfile(profileUuid: string): Promise<SkyBlockProfile>

• Fetch a SkyBlock profile (using a SkyBlock profile uuid). The data returned can differ depending on the players in-game API settings.

  ---

  Parameters

  • profileUuid: string

    The uuid of the SkyBlock profile

  Returns Promise<SkyBlockProfile>

publicfetchRecentlyEndedAuctions

• fetchRecentlyEndedAuctions(): Promise<RecentlyEndedAuctionsResponse>

• Fetch recently ended auctions (auctions which ended in the last 60 seconds).

  ---

  Returns Promise<RecentlyEndedAuctionsResponse>

publicfetchSkills

• fetchSkills(): Promise<FetchSkillsResponse>

• Fetch information regarding skills in the SkyBlock game

  ---

  Returns Promise<FetchSkillsResponse>