UNPKG

@zikeji/hypixel

Version:

With IntelliSense support & 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, built-in rate-limit handling, flexible

23 lines (22 loc) 767 B
import { Paths } from "../../types/api"; import { Method } from "../../util/Method"; import { ResultObject } from "../../util/ResultObject"; import type { SkyblockAuctionsResponse } from "../../types/AugmentedTypes"; /** * @example * ```typescript * const {auctions} = await client.skyblock.auctions.page(0); * ``` * @category Client */ export declare class SkyBlockAuctions extends Method { /** * Returns SkyBlock auctions that are currently active in the in-game Auction House. * @example * ```typescript * const { auctions } = await client.skyblock.auctions.page(0); * ``` * @category API */ page(page?: Paths.V2SkyblockAuctions.Get.Parameters.Page): Promise<ResultObject<SkyblockAuctionsResponse, ["success"]>>; }