Skip to main content
Module

x/hypixel/index.ts>SkyBlock

With thorough IntelliSense support & 100% test coverage, this is an unopinionated async/await API wrapper for Hypixel's Public API. It is developed in TypeScript complete with documentation, typed interfaces for all API responses (and an OpenAPI 3.0 schema!), built-in rate-limit handling, flexible cache support, helper functions, and support for undocumented endpoints.
zikeji/node-hypixel
Latest
class SkyBlock
extends Method
Re-export
import { SkyBlock } from "https://deno.land/x/hypixel@v3.1.1/index.ts";

Properties

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.

auctions: SkyBlockAuctions

Returns SkyBlock auctions that are currently active in the in-game Auction House.

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.

Methods

auctions_ended(): Promise<ResultObject<Paths.SkyblockAuctionsEnded.Get.Responses.$200, ["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).

bazaar(): Promise<ResultObject<Paths.SkyblockBazaar.Get.Responses.$200, ["products"]>>

Returns the list of products along with their sell summary, buy summary and quick status.

news(): Promise<ResultArray<Paths.SkyblockNews.Get.Responses.$200, "items">>

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

profile(profile: Paths.SkyblockProfile.Get.Parameters.Profile): Promise<ResultObject<Paths.SkyblockProfile.Get.Responses.$200, ["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.