JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
    • 0
  • Score
    100M100P100Q27511F
  • License ISC

A NodeJS wrapper for Hypixel's API

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (hywrapper) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    npm version

    hywrapper

    A NodeJS wrapper for Hypixel's API

    Table of Contents

    Installation

    To install the library, run:

    $ npm install hywrapper

    or with JSDelivr:

    <script src="https://cdn.jsdelivr.net/npm/hywrapper@latest/file"></script>

    Importing

    With require:

    const API = require("hywrapper");

    With import:

    import API from "hywrapper";

    Usage

    Initiating the wrapper

    import API from "hywrapper";
const key = process.env["apikey"] // Your Hypixel API key; visit developer.hypixel.net to get one if you don't have one already

const api = new API(key, cache) // Whether or not to cache fetched data

    Using the API

    Many of the wrapper's functions are very similar to how they are organized in the Hypixel API docs, but are organized in categories like skyblock, players, guilds, and static. A few examples are below.

    import API from "hywrapper";
const api = new API(key)

// .players - Information about players on Hypixel //
await api.players.status(uuid) // Gets a user's current online status on Hypixel by UUID
await api.players.punishments() // Gets punishment statistics for Hypixel staff and watchdog

// .guilds - Information about guilds on Hypixel //
await api.guilds.fetch(data) // Gets a guild from a player, id, or name
await api.guilds.achievements() //Gets a list of guild achievements

// .static - Information about Hypixel itself that rarely changes //
await api.static.quests() // Gets a list of Hypixel quests
await api.static.pets() // Gets Hypixel pet information

// .skyblock - All of Hypixel's SkyBlock API //
await api.skyblock.static.items() // Gets information regarding items in SkyBlock
await api.skyblock.auctions.fetch('auction'|'player'|'profile', id) // Gets an auction from its id, a player, or a profile
await api.skyblock.mayor() // Gets SkyBlock mayor and election data

    Other API functions

    Get a user's UUID from their username

    await api.getUUID(username)

    Make an unaltered API request

    await api.request('/skyblock/auctions', { page: 10 })

    Get cached data

    api.cache.static.games // Synchronous equivalent to await api.static.games() if nothing has changed since the request was first issued