node-hypixel.zikeji.com
Open in
urlscan Pro
2606:50c0:8003::153
Public Scan
URL:
http://node-hypixel.zikeji.com/
Submission Tags: phish.gg anti.fish automated Search All
Submission: On June 05 via api from DE — Scanned from DE
Submission Tags: phish.gg anti.fish automated Search All
Submission: On June 05 via api from DE — Scanned from DE
Form analysis 1 forms found in the DOM
<form id="search-form" role="search" class="algolia-search-wrapper search-box"><label for="algolia-search-input" class="sr-only">Algolia search</label> <span class="algolia-autocomplete"
style="position: relative; display: inline-block; direction: ltr;"><input id="algolia-search-input" placeholder="" class="search-query ds-input" autocomplete="off" spellcheck="false" role="combobox" aria-autocomplete="list" aria-expanded="false"
aria-label="search input" aria-owns="algolia-autocomplete-listbox-0" dir="auto" style="position: relative; vertical-align: top;">
<pre aria-hidden="true"
style="position: absolute; visibility: hidden; white-space: pre; font-family: Arial; font-size: 14.4px; font-style: normal; font-variant: normal; font-weight: 400; word-spacing: 0px; letter-spacing: normal; text-indent: 0px; text-rendering: auto; text-transform: none;"></pre>
<span class="ds-dropdown-menu" role="listbox" id="algolia-autocomplete-listbox-0" style="position: absolute; top: 100%; z-index: 100; display: none; left: 0px; right: auto;">
<div class="ds-dataset-1"></div>
</span>
</span></form>Text Content
@zikeji/hypixel
Theme Color:
*
*
*
Theme Mode:
Algolia search
Home
Guide
API
Typescript API
Info
* Changelog
* Discord Server (opens new window)
* NPM Package (opens new window)
* GitHub Repo (opens new window)
Home
Guide
API
Typescript API
Info
* Changelog
* Discord Server (opens new window)
* NPM Package (opens new window)
* GitHub Repo (opens new window)
@ZIKEJI/HYPIXEL
NodeJS API wrapper for Hypixel's Public API
Get Started →
RATE LIMITING QUEUE
Built in async rate limiting queue prevents prevents requests from failing by
queueing and waiting for the queue to clear.
OPENAPI 3.0 DEFINITION
I've painstakingly recreated Hypixel's API methods and responses in the OpenAPI
3.0 specification.
TYPESCRIPT SUPPORT
Full Typescript definitions for explored API methods provides intellisense in
popular IDEs.
# @ZIKEJI/HYPIXEL
(opens new window) (opens new window) (opens new window) (opens new window)
(opens new window) (opens new window) (opens new window) (opens new window)
(opens new window) (opens new window) (opens new window) (opens new window)
(opens new window)
With thorough IntelliSense (opens new window) support & 100% test coverage
(opens new window), this is an unopinionated async/await API wrapper for
Hypixel's Public API (opens new window). It is developed in TypeScript complete
with documentation (opens new window), typed interfaces (opens new window) for
all API responses (and an OpenAPI.yaml (opens new window)!), built-in rate-limit
handling, flexible cache support (opens new window), helper functions (opens new
window), and support for undocumented endpoints.
This library aims to replicate the API paths in it's method usage. As such, the
general scheme would be to change the path of an API call by simply replacing
the / with a ., and if the endpoint takes multiple parameters, those are added
on the end. For example, api.hypixel.net/skyblock/profiles?uuid=1234 would
simply become client.skyblock.profiles.uuid('1234'). Of course, with everything
being fully typed if you are using an IDE that supports IntelliSense (opens new
window) you should rarely need to reference documentation.
# 2.0 TO 3.0 MIGRATION
This library follows semver. As backwards incompatible changes were introduced
while making this Deno compatible. Most likely nothing you use has changed, and
you should be able to update without issue. The only breaking change is that the
Client class no longer accepts agent as a parameter, as Deno does not support
this.
# INSTALLATION
# NODEJS
Use npm (opens new window) to install this library.
npm i --save @zikeji/hypixel
1
# DENO
As Deno does not require installation, you would simply follow their convention
for imports.
import { Client as HypixelClient } from "https://deno.land/x/hypixel/v3.1.0/mod.ts";
1
# USAGE
const { Client } = require("@zikeji/hypixel");
const client = new Client("API_KEY");
(async () => {
const status = await client.status.uuid("20934ef9488c465180a78f861586b4cf"); // Minikloon
console.log(status);
// {"online": false}
const stats = await client.watchdogstats();
console.log(stats);
// {watchdog_lastMinute: 1, staff_rollingDaily: 2609, watchdog_total: 5591714, watchdog_rollingDaily: 4213, …}
})();
1
2
3
4
5
6
7
8
9
10
# HELPERS
This library adds multiple helpers to facilitate using the Hypixel API. You can
find documentation on each helper here (opens new window). If you would like to
request a helper that doesn't exist, please open an issue. Otherwise if you
would like to contribute one refer to the below section.
# CONTRIBUTING
If some API result isn't documented / typed out fully, please open an issue and
I can see about adding it. However some data is too exhaustive to provide
typings to in a reasonable manner, as exhibited here (opens new window), where
it isn't reasonable to add 19.5 thousand lines of code to document the entire
dataset.
Otherwise, pull requests are welcome. For major changes, please open an issue
first to discuss what you would like to change. All changes must ensure they
pass eslint, tests, and that testing is updated to meet or exceed the previous
coverage.
# LICENSES
This projected is licensed under the MIT license. For additional details see
LICENSE.
This library contains derivative work based on classes from the hypixel-php
(opens new window) library. Code that is derivative work of hypixel-php (opens
new window) will be marked as such with a header comment. See
LICENSE-HYPIXEL-PHP.md for additional details on the original license.
MIT Licensed | Copyright © 2020-present Zikeji
@ZIKEJI/HYPIXEL
This app can be installed on your PC or mobile device. This will allow this web
app to look and behave like any other installed app. You will find it in your
app lists and be able to pin it to your home screen, start menus or task bars.
This installed web app will also be able to safely interact with other apps and
your operating system.
DESCRIPTION
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.
Install @zikeji/hypixel Cancel