📝
TypeScript Support
Complete with typed interfaces for all API responses and IntelliSense support
@zikeji/hypixelHypixel API Wrapper
Unopinionated async/await API wrapper for Hypixel's Public API with TypeScript support
Skip to content
Quick Start
Installation
bash
npm install @zikeji/hypixelBasic Usage
javascript
const { Client } = require("@zikeji/hypixel");
const client = new Client("YOUR_API_KEY");
(async () => {
// Get player status
const status = await client.status.uuid("20934ef9488c465180a78f861586b4cf");
console.log(status);
// Get punishment stats
const stats = await client.punishmentstats();
console.log(stats);
})();Features
- Full TypeScript Support: Get autocomplete and type checking out of the box
- Rate Limiting: Automatic rate limit handling with queue management
- Caching: Flexible cache support with custom implementations
- Helpers: Various helper functions for common tasks
- Modern: Built with async/await and ES modules support
Documentation
- Guide - Learn how to use the library
- API Reference - Complete API documentation
- GitHub - Source code and issues
License
MIT License - see LICENSE for details.