Skip to main content
Module

x/hypixel/index.ts>SkyBlockProfileCollection

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
interface SkyBlockProfileCollection
import { type SkyBlockProfileCollection } from "https://deno.land/x/hypixel@v3.1.1/index.ts";

Interface describing an individual collection.

Properties

id: string

The ID of this collection, e.g. "LOG:2"

name: string

The name of this collection, e.g. "Birch Wood"

tier: number

The tier the profile has reached.

optional
nextTier: number

The next tier the profile can reach. If the profile has reached the max tier, this value is omitted.

maxTier: number

The maximum tier of this collection.

amount: number

The amount of resources in this collection the profile has collected toward tiers.

Note: If the profile is a coop and all players do not have their collection API enabled, this will only account for the amounts collected by members with their collection API enabled.

optional
nextTierAmountRequired: number

The amount required to reach the next collection tier. If the profile has reached the max tier, this value is omitted.

progress: number

The progress the profile is toward maxing this collection.