Skip to main content
Module

x/hypixel/index.ts>default#call

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
method default.prototype.call
import { default } from "https://deno.land/x/hypixel@v3.1.1/index.ts";

The raw query method used by this library. You may use this if you need to use an undocumented method with this library.

Examples

Getting the ID of a guild using the findGuild method.

const response = await client.call("findGuild", { byName: "Mini Squid" });
console.log(response);
// { success: true, guild: '553490650cf26f12ae5bac8f' }

Type Parameters

T extends Components.Schemas.ApiSuccess

Parameters

path: string

The path on the method you want to query.

optional
parameters: Parameters = [UNSUPPORTED]

Any search parameters you want to use.

Returns

Promise<T & { cached?: boolean; }>