Hypixel SkyBlock API
Created by nom
yes.
I'm an idiot I think
Available Endpoints
Explore the available API endpoints for accessing SkyBlock player data
URL Builder
https://your-domain.com/v1/profile/{uuid}/{profile}?key={your-api-key}
// Using fetch API
const apiKey = 'your-api-key';
const uuid = '1277d71f338046e298d90c9fe4055f00';
const profile = 'Strawberry';
const url = `https://your-domain.com/v1/profile/${uuid}/${profile}?key=${apiKey}`;
try {
const response = await fetch(url);
const data = await response.json();
console.log(data);
} catch (error) {
console.error('Error:', error);
}
/v1/profile/:user/:profile
Get detailed information about a specific player's profile including skills, networth, dungeons, and more.
Example:
/v1/profile/1277d71f338046e298d90c9fe4055f00/Strawberry
/v1/profiles/:user
Get the selected profile for a player with comprehensive data for each profile including stats and items.
Example:
/v1/profiles/1277d71f338046e298d90c9fe4055f00
Setup Guide
How to set up and run the Hypixel SkyBlock API wrapper locally
Prerequisites
- Node.js (version 16 or higher)
- npm or pnpm package manager
- A valid Hypixel API key
Installation Steps
1. Clone the repository
git clone https://github.com/noemtdotdev/skyblock-wrapper.git
2. Navigate to the project directory
cd skyblock-wrapper
3. Install dependencies
pnpm install
4. Configure environment variables
cp .env.example .env
Edit the .env file with your Hypixel API key and other configuration
5. Start the development server
pnpm start
Configuration
Make sure to configure your Hypixel API key in the .env file. You can obtain one from the Hypixel Developer Portal.
Parameters
Required parameters for API endpoints
| Parameter | Description | Example |
|---|---|---|
user |
Player UUID | 1277d71f338046e298d90c9fe4055f00 |
profile |
Profile ID or cute name | Strawberry, Zucchini, Banana, Tomato or Raspberry |
key |
API authentication key | Your Hypixel API key |
Available Features
Comprehensive data points available through the API
Skills
Combat, Mining, Foraging, Enchanting, and more
Networth
Complete networth calculation with item breakdown
Dungeons
Catacombs levels, master mode, and class stats
Equipment
Armor, weapons, accessories, and pets
Collections
All collection levels and progress
Slayer
Zombie, Spider, Wolf, Enderman, and Blaze slayer