api

README

Hypixel API

About

Hypixel api for Go programming language. If you want to learn how to use hypixel api then go to folder examples in this repository and to learn hypixel rest api click here.

Setup

To install hypixel api type this command to terminal:

go get github.com/MichalUSER/hypixelapi

Documentation

Index

• type Init
  • func (i Init) FindGuild(name string) map[string]interface{}
  • func (i Init) FloatToInt(number float64) int64
  • func (i Init) GetBoosters() map[string]interface{}
  • func (i Init) GetFriends(uuid string) map[string]interface{}
  • func (i Init) GetGameCounts() map[string]interface{}
  • func (i Init) GetGuild(name string) map[string]interface{}
  • func (i Init) GetKey(key string) map[string]interface{}
  • func (i Init) GetLeaderboards() map[string]interface{}
  • func (i Init) GetPlayerCount() float64
  • func (i Init) GetPlayerGuild(uuid string) map[string]interface{}
  • func (i Init) GetPlayerName(uuid string) string
  • func (i Init) GetPlayerStats(name string) map[string]interface{}
  • func (i Init) GetPlayerStatsUUID(uuid string) map[string]interface{}
  • func (i Init) GetPlayerUUID(name string) string
  • func (i Init) GetRecentGames(uuid string) map[string]interface{}
  • func (i Init) GetResources(resource string) map[string]interface{}
  • func (i Init) GetStatus(uuid string) map[string]interface{}
  • func (i Init) GetWatchdogStats() map[string]interface{}
  • func (i Init) InterfaceArray(in interface{}) []interface{}
  • func (i Init) InterfaceToMap(in interface{}) map[string]interface{}

Types

type Init

type Init struct {
	Key string
}

Init is a struct which contains player key.

func (Init) FindGuild

func (i Init) FindGuild(name string) map[string]interface{}

FindGuild returns the id of the requested guild.

func (Init) FloatToInt

func (i Init) FloatToInt(number float64) int64

FloatToInt takes float and convert it to int

func (Init) GetBoosters

func (i Init) GetBoosters() map[string]interface{}

GetBoosters returns list of boosters.

func (Init) GetFriends

func (i Init) GetFriends(uuid string) map[string]interface{}

GetFriends returns friendships for given player.

func (Init) GetGameCounts

func (i Init) GetGameCounts() map[string]interface{}

GetGameCounts returns the current player count along with the player count of each public game + mode on the server.

func (Init) GetGuild

func (i Init) GetGuild(name string) map[string]interface{}

GetGuild returns information about given guild name.

func (Init) GetKey

func (i Init) GetKey(key string) map[string]interface{}

GetKey returns information regarding given key.

func (Init) GetLeaderboards

func (i Init) GetLeaderboards() map[string]interface{}

GetLeaderboards returns a list of the official leaderboards and their current standings for games on the network.

func (Init) GetPlayerCount

func (i Init) GetPlayerCount() float64

GetPlayerCount returns current player count.

func (Init) GetPlayerGuild

func (i Init) GetPlayerGuild(uuid string) map[string]interface{}

GetPlayerGuild returns information about given player uuid guild.

func (Init) GetPlayerName

func (i Init) GetPlayerName(uuid string) string

GetPlayerName finds player name by uuid.

func (Init) GetPlayerStats

func (i Init) GetPlayerStats(name string) map[string]interface{}

GetPlayerStats returns a player's data, such as game stats.

func (Init) GetPlayerStatsUUID

func (i Init) GetPlayerStatsUUID(uuid string) map[string]interface{}

GetPlayerStatsUUID returns a player's data, such as game stats by uuid.

func (Init) GetPlayerUUID

func (i Init) GetPlayerUUID(name string) string

GetPlayerUUID finds player uuid by name.

func (Init) GetRecentGames

func (i Init) GetRecentGames(uuid string) map[string]interface{}

GetRecentGames returns recent games of a player. A maximum of 100 games are returned and recent games are only stored for up to 3 days at this time.

func (Init) GetResources

func (i Init) GetResources(resource string) map[string]interface{}

GetResources provides an endpoint to retrieve resources which don't change often. This does not require an API key.

func (Init) GetStatus

func (i Init) GetStatus(uuid string) map[string]interface{}

GetStatus returns online status information for given player, including game, mode and map when available.

func (Init) GetWatchdogStats

func (i Init) GetWatchdogStats() map[string]interface{}

GetWatchdogStats returns some statistics about Watchdog & bans.

func (Init) InterfaceArray

func (i Init) InterfaceArray(in interface{}) []interface{}

InterfaceArray is a function which returns []interface{}.

func (Init) InterfaceToMap

func (i Init) InterfaceToMap(in interface{}) map[string]interface{}

InterfaceToMap is a function which converts interface to map using type assertion.