Class: SkyBlock
# Class: SkyBlock
# Example
const products = await client.skyblock.bazaar();
1
# Extends
Method
# API
# auction
auction:
SkyBlockAuction
Returns SkyBlock auctions by either player, profile or auction uuid. Only "active" auctions are returned, these are auctions that are still open or that have not had all bids/items claimed.
# Example
let auctions = await client.skyblock.auction.player("347ef6c1daac45ed9d1fa02818cf0fb6");
auctions = await client.skyblock.auction.profile("347ef6c1daac45ed9d1fa02818cf0fb6");
auctions = await client.skyblock.auction.uuid("409a1e0f261a49849493278d6cd9305a");
1
2
3
2
3
# auctions
auctions:
SkyBlockAuctions
Returns SkyBlock auctions that are currently active in the in-game Auction House.
# Example
const { auctions } = await client.skyblock.auctions.page(0);
1
# bingo
bingo:
SkyBlockBingo
Bingo data for participated events of the provided player.
# Example
const bingoEvents = await client.skyblock.bingo.uuid("20934ef9488c465180a78f861586b4cf");
1
# garden
garden:
SkyBlockGarden
Get SkyBlock garden data.
# Example
const garden = await client.skyblock.garden.profile('347ef6c1daac45ed9d1fa02818cf0fb6');
1
# museum
museum:
SkyBlockMuseum
Get SkyBlock museum data.
# Example
const museum = await client.skyblock.museum.profile('347ef6c1daac45ed9d1fa02818cf0fb6');
1
# profiles
profiles:
SkyBlockProfiles
Returns an array SkyBlock profile's data, such as stats, objectives etc. The data returned can differ depending on the players in-game API settings. The request takes a player UUID.
# Example
const profiles = await client.skyblock.profiles.uuid("20934ef9488c465180a78f861586b4cf");
1
# auctions_ended()
auctions_ended():
Promise<ResultArray<SkyblockAuctionsEndedResponse,"auctions">>
Returns SkyBlock auctions which ended in the last 60 seconds (More precisely, whatever time is defined in the "Cache-Control" header of the response).
# Returns
Promise<ResultArray<SkyblockAuctionsEndedResponse, "auctions">>
# Example
const { auctions } = await client.skyblock.auctions_ended();
1
# bazaar()
bazaar():
Promise<ResultObject<SkyblockBazaarResponse, ["products"]>>
Returns the list of products (opens new window) along with their sell summary, buy summary and quick status.
# Returns
Promise<ResultObject<SkyblockBazaarResponse, ["products"]>>
# Example
const products = await client.skyblock.bazaar();
1
# firesales()
firesales():
Promise<SkyBlockFireSale[] &object>
Retrieve the currently active or upcoming Fire Sales for SkyBlock.
# Returns
Promise<SkyBlockFireSale[] & object>
# Example
const sales = await client.skyblock.firesales();
1
# news()
news():
Promise<ResultArray<SkyblockNewsResponse,"items">>
Returns SkyBlock news, including a title, description and a thread.
# Returns
Promise<ResultArray<SkyblockNewsResponse, "items">>
# Example
const news = await client.skyblock.news();
1
# profile()
profile(
profile):Promise<ResultObject<SkyblockProfileResponse, ["profile"]>>
Returns a SkyBlock profile's data, such as stats, objectives etc. The data returned can differ depending on the players in-game API settings.
# Parameters
• profile: string
# Returns
Promise<ResultObject<SkyblockProfileResponse, ["profile"]>>
# Example
const news = await client.skyblock.profile("20934ef9488c465180a78f861586b4cf");
1