Hypixel PHP

A PHP class for fetching Player/Guild information from the Public HypixelAPI

Requirements

• PHP 5.4+
• Hypixel API key

Usage

To interact with the API you need an API key, you can get a key by doing "/api" on the Hypixel Network.

$HypixelAPI = new HypixelAPI(array(
    'api_key' => '',
    'cache_time' => 600,
    'cache_uuid_time' => 864000,
    'timeout' => 2,
    'cache_folder_player' => $_SERVER['DOCUMENT_ROOT'] . '/cache/HypixelAPI/player',
    'cache_folder_guild' => $_SERVER['DOCUMENT_ROOT'] . '/cache/HypixelAPI/guild',
    'cache_folder_friends' => $_SERVER['DOCUMENT_ROOT'] . '/cache/HypixelAPI/friends',
    'cache_folder_sessions' => $_SERVER['DOCUMENT_ROOT'] . '/cache/HypixelAPI/sessions',
    'cache_boosters' => $_SERVER['DOCUMENT_ROOT'] . '/cache/HypixelAPI/boosters.json',
    'cache_leaderboards' => $_SERVER['DOCUMENT_ROOT'] . '/cache/HypixelAPI/leaderboards.json',
    'cache_keyInfo' => $_SERVER['DOCUMENT_ROOT'] . '/cache/HypixelAPI/keyInfo.json',
    'log_folder' => $_SERVER['DOCUMENT_ROOT'] . '/logs/HypixelAPI',
    'logging' => true,
    'debug' => true,
    'use_curl' => true
 ));

All of these options are optional. They are provided above with their default values.

Once you have the API Object you can call the getter functions

$player = $HypixelAPI->getPlayer([
    'name'    => null,
    'uuid'    => null,
    'unknown' => null
]);

$guild = $HypixelAPI->getGuild([
    'player'   => null,
    'byPlayer' => null,
    'byUuid'   => null,
    'byName'   => null,
    'id'       => null
]);
$HypixelAPI->getPlayer($input)->getGuild();

$session = $HypixelAPI->getSession([
    'player' => null,
    'name' => null,
    'uuid' => null
]);
$session = $HypixelAPI->getPlayer($input)->getSession();

$friends = $HypixelAPI->getFriends([
    'player' => null,
    'name' => null,
    'uuid' => null
]);
$friends = $HypixelAPI->getPlayer($input)->getFriends();