API Documentation

NetherAPI is a drop-in replacement for the Hypixel API. All endpoints work identically — just change the base URL and use your NetherAPI key.

Authentication

All requests require an API key. Include it in the API-Key header:

Bash

curl -X GET "https://netherapi.com/api/v2/player?uuid=..." \
     -H "API-Key: your-api-key"

You can also use the Authorization header with a Bearer token:

HTTP Header

Authorization: Bearer your-api-key

Rate Limits

Each API key has a rate limit (requests per 5 minutes). Check response headers:

X-RateLimit-LimitYour total limit per 5-minute window

X-RateLimit-RemainingRequests remaining in current window

X-RateLimit-ResetUnix timestamp when the window resets

X-RateLimit-Reset-AfterSeconds until the window resets

If you exceed your rate limit, you'll receive a 429 Too Many Requests response. Wait for the window to reset before making more requests.

Error Handling

All error responses follow this format:

JSON

{
  "success": false,
  "error": "Error message description"
}

401Invalid or missing API key

403API key is disabled

429Rate limit exceeded

502Failed to reach Hypixel API

Endpoints

Base URL: https://netherapi.com/api

Player Data

GET/v2/player

Get player data including game stats

Parameters:uuid

GET/v2/recentgames

Get recently played games

Parameters:uuid

GET/v2/status

Get online status

Parameters:uuid

GET/v2/guild

Get guild information

Parameters:id, player, or name

Resources

GET/v2/resources/games

Game information

GET/v2/resources/achievements

Achievements

GET/v2/resources/challenges

Challenges

GET/v2/resources/quests

Quests

GET/v2/resources/guilds/achievements

Guild achievements

GET/v2/resources/vanity/pets

Vanity pets

GET/v2/resources/vanity/companions

Vanity companions

SkyBlock

GET/v2/skyblock/collections

Collections data

GET/v2/skyblock/skills

Skills data

GET/v2/skyblock/items

Items data

GET/v2/skyblock/election

Election and Mayor

GET/v2/skyblock/bingo

Current Bingo event

GET/v2/skyblock/news

News

GET/v2/skyblock/auction

Specific auctions

Parameters:uuid, player, or profile

GET/v2/skyblock/auctions

Active auctions

Parameters:page

GET/v2/skyblock/auctions_ended

Recently ended auctions

GET/v2/skyblock/bazaar

Bazaar data

GET/v2/skyblock/profile

Profile by UUID

Parameters:profile

GET/v2/skyblock/profiles

All profiles for player

Parameters:uuid

GET/v2/skyblock/museum

Museum data

Parameters:profile

GET/v2/skyblock/garden

Garden data

Parameters:profile

GET/v2/skyblock/firesales

Active/upcoming fire sales

Housing

GET/v2/housing/active

Active public houses

GET/v2/housing/house

Specific house info

Parameters:house

GET/v2/housing/houses

Player houses

Parameters:player

Other

GET/v2/boosters

Active network boosters

GET/v2/counts

Current player counts

GET/v2/leaderboards

Current leaderboards

GET/v2/punishmentstats

Punishment statistics

Code Examples

JavaScript / Node.js

JavaScript

const API_KEY = 'your-nether-api-key';
const BASE_URL = 'https://netherapi.com/api';

async function getPlayer(uuid) {
  const response = await fetch(
    `${BASE_URL}/v2/player?uuid=${uuid}`,
    { headers: { 'API-Key': API_KEY } }
  );

  if (!response.ok) {
    throw new Error(`HTTP ${response.status}`);
  }

  return response.json();
}

// Usage
const data = await getPlayer('069a79f4-44e9-4726-a5be-fca90e38aaf5');
console.log(data.player.displayname);

Python

import requests

API_KEY = 'your-nether-api-key'
BASE_URL = 'https://netherapi.com/api'

def get_player(uuid):
    response = requests.get(
        f'{BASE_URL}/v2/player',
        params={'uuid': uuid},
        headers={'API-Key': API_KEY}
    )
    response.raise_for_status()
    return response.json()

# Usage
data = get_player('069a79f4-44e9-4726-a5be-fca90e38aaf5')
print(data['player']['displayname'])