Class: SkyBlock


# Class: SkyBlock

# Hierarchy

  • Method

    SkyBlock

# API Properties

# 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

Defined in: methods/skyblock/index.ts:20 (opens new window)


# 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

Defined in: methods/skyblock/index.ts:30 (opens new window)


# 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

Defined in: methods/skyblock/index.ts:119 (opens new window)

# API Methods

# auctions_ended

auctions_ended(): Promise<ResultObject<SkyBlockAuctionsEndedResponse, [success]>>

Returns SkyBlock auctions which ended in the last 60 seconds (More precisely, whatever time is defined in the "Cache-Control" header of the response).

example

const { auctions } = await client.skyblock.auctions_ended();
1

Returns: Promise<ResultObject<SkyBlockAuctionsEndedResponse, [success]>>

Defined in: methods/skyblock/index.ts:40 (opens new window)


# bazaar

bazaar(): Promise<ResultObject<SkyBlockBazaarResponse, [products]>>

Returns the list of products (opens new window) along with their sell summary, buy summary and quick status.

example

const products = await client.skyblock.bazaar();
1

Returns: Promise<ResultObject<SkyBlockBazaarResponse, [products]>>

Defined in: methods/skyblock/index.ts:59 (opens new window)


# news

news(): Promise<ResultArray<NewsResponse, items>>

Returns SkyBlock news, including a title, description and a thread.

example

const news = await client.skyblock.news();
1

Returns: Promise<ResultArray<NewsResponse, items>>

Defined in: methods/skyblock/index.ts:78 (opens new window)


# profile

profile(profile: string): Promise<{ autodelete?: boolean ; banking?: SkyBlockProfileBanking ; community_upgrades?: SkyBlockProfileCommunityUpgrades ; game_mode?: string ; members: { [name: string]: SkyBlockProfileMember; } ; profile_id: string } & { meta: Omit<$200, profile> & DefaultMeta }>

Returns a SkyBlock profile's data, such as stats, objectives etc. The data returned can differ depending on the players in-game API settings.

example

const news = await client.skyblock.profile("20934ef9488c465180a78f861586b4cf");
1

# Parameters:

Name Type
profile string

Returns: Promise<{ autodelete?: boolean ; banking?: SkyBlockProfileBanking ; community_upgrades?: SkyBlockProfileCommunityUpgrades ; game_mode?: string ; members: { [name: string]: SkyBlockProfileMember; } ; profile_id: string } & { meta: Omit<$200, profile> & DefaultMeta }>

Defined in: methods/skyblock/index.ts:97 (opens new window)