Hypicle v1.1.4

Hypicle on NPM

How to get the API Key?

1. Visit the Hypixel Developer Dashboard.
2. Log in.
3. Generate and Copy a new Development Key.

Quick Start

import { Hypicle } from 'hypicle';

const client = new Hypicle('YOUR_API_KEY');

Hypicle Structure

• api/

  • api/boosters - Currently active boosters
  • api/counts - Active players count
  • api/guild - Guild information
  • api/key - API Key information (deprecated)
  • api/leaderboards - Global Leaderboards information
  • api/player - Player information & statistics
  • api/punishments - Punishment statistics
  • api/recentgames - Recent games of a player
  • api/status - Status of a player

• client.ts - The Hypicle Client

• utils.ts - The Hypicle Utils