README
¶
Gopixel
A simple and complete[^1] wrapper for the hypixel API
Key features
- Full API coverage[^1]
- Autocomplete for fields
- Near complete structs
- MIT license
Installation
go get github.com/comblock/gopixel
Usage
import "github.com/comblock/gopixel"
var client *gopixel.Client = gopixel.NewClient(<your API key>)
Supported endpoints
- https://api.hypixel.net/player
- https://api.hypixel.net/friends
- https://api.hypixel.net/recentgames
- https://api.hypixel.net/status
- https://api.hypixel.net/guild
- https://api.hypixel.net/player/ranked/skywars
- https://api.hypixel.net/resources/games
- https://api.hypixel.net/resources/achievements
- https://api.hypixel.net/resources/challenges
- https://api.hypixel.net/resources/quests
- https://api.hypixel.net/resources/guilds/achievements
- https://api.hypixel.net/resources/guilds/permissions
- https://api.hypixel.net/resources/skyblock/collections
- https://api.hypixel.net/resources/skyblock/skills
- https://api.hypixel.net/resources/skyblock/items
- https://api.hypixel.net/skyblock/news
- https://api.hypixel.net/skyblock/auction
- https://api.hypixel.net/skyblock/auctions
- https://api.hypixel.net/skyblock/auctions_ended
- https://api.hypixel.net/skyblock/bazaar
- https://api.hypixel.net/skyblock/profile
- https://api.hypixel.net/skyblock/profiles
- https://api.hypixel.net/boosters
- https://api.hypixel.net/counts
- https://api.hypixel.net/leaderboards
- https://api.hypixel.net/punishmentstats
[^1]: as of 30/10/2021
Documentation
¶
Index ¶
- func Uuid(name string) (string, error)
- type Client
- func (client *Client) Achievements() (structs.Achievements, error)
- func (client *Client) Bazaar() (structs.Bazaar, error)
- func (client *Client) Boosters() (structs.Boosters, error)
- func (client *Client) Challenges() (structs.Challenges, error)
- func (client *Client) Friends(name string) (structs.Friends, error)
- func (client *Client) Games() (structs.Games, error)
- func (c *Client) GuildAchievements() (structs.GuildAchievements, error)
- func (client *Client) GuildById(id string) (structs.Guild, error)
- func (client *Client) GuildByName(name string) (structs.Guild, error)
- func (client *Client) GuildByPlayer(player string) (structs.Guild, error)
- func (client *Client) GuildPermissions() (structs.GuildPermissions, error)
- func (client *Client) KeyData() (structs.Key, error)
- func (client *Client) Leaderboards() (structs.Leaderboards, error)
- func (client *Client) PlayerCounts() (structs.PlayerCounts, error)
- func (client *Client) PlayerData(name string) (structs.Player, error)
- func (client *Client) PlayerStatus(name string) (structs.PlayerStatus, error)
- func (client *Client) PunishmentStats() (structs.PunishmentStats, error)
- func (client *Client) Quests() (structs.Quests, error)
- func (client *Client) RankedSkywars(name string) (structs.RankedSkywars, error)
- func (client *Client) RecentGames(name string) (structs.RecentGames, error)
- func (client *Client) SkyblockActiveAuctions() (structs.SkyblockActiveAuctions, error)
- func (client *Client) SkyblockAuctionByPlayer(player string) (structs.SkyblockAuctions, error)
- func (client *Client) SkyblockAuctionByProfileUuid(uuid string) (structs.SkyblockAuctions, error)
- func (client *Client) SkyblockAuctionByUuid(uuid string) (structs.SkyblockAuctions, error)
- func (client *Client) SkyblockCollections() (structs.SkyblockCollections, error)
- func (client *Client) SkyblockEndedAuctions() (structs.SkyblockEndedAuctions, error)
- func (client *Client) SkyblockItems() (structs.SkyblockItems, error)
- func (c *Client) SkyblockNews() (structs.SkyblockNews, error)
- func (client *Client) SkyblockProfile(profile string) (structs.SkyblockProfile, error)
- func (client *Client) SkyblockProfiles(name string) (structs.SkyblockProfiles, error)
- func (client *Client) SkyblockSkills() (structs.SkyblockSkills, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Client ¶
type Client struct {
Key string
}
func (*Client) Achievements ¶
func (client *Client) Achievements() (structs.Achievements, error)
func (*Client) Challenges ¶
func (client *Client) Challenges() (structs.Challenges, error)
func (*Client) GuildAchievements ¶
func (c *Client) GuildAchievements() (structs.GuildAchievements, error)
func (*Client) GuildByPlayer ¶
func (*Client) GuildPermissions ¶
func (client *Client) GuildPermissions() (structs.GuildPermissions, error)
func (*Client) Leaderboards ¶
func (client *Client) Leaderboards() (structs.Leaderboards, error)
func (*Client) PlayerCounts ¶
func (client *Client) PlayerCounts() (structs.PlayerCounts, error)
func (*Client) PlayerStatus ¶
func (client *Client) PlayerStatus(name string) (structs.PlayerStatus, error)
func (*Client) PunishmentStats ¶
func (client *Client) PunishmentStats() (structs.PunishmentStats, error)
func (*Client) RankedSkywars ¶
func (client *Client) RankedSkywars(name string) (structs.RankedSkywars, error)
func (*Client) RecentGames ¶
func (client *Client) RecentGames(name string) (structs.RecentGames, error)
func (*Client) SkyblockActiveAuctions ¶
func (client *Client) SkyblockActiveAuctions() (structs.SkyblockActiveAuctions, error)
func (*Client) SkyblockAuctionByPlayer ¶
func (client *Client) SkyblockAuctionByPlayer(player string) (structs.SkyblockAuctions, error)
func (*Client) SkyblockAuctionByProfileUuid ¶
func (client *Client) SkyblockAuctionByProfileUuid(uuid string) (structs.SkyblockAuctions, error)
func (*Client) SkyblockAuctionByUuid ¶
func (client *Client) SkyblockAuctionByUuid(uuid string) (structs.SkyblockAuctions, error)
func (*Client) SkyblockCollections ¶
func (client *Client) SkyblockCollections() (structs.SkyblockCollections, error)
func (*Client) SkyblockEndedAuctions ¶
func (client *Client) SkyblockEndedAuctions() (structs.SkyblockEndedAuctions, error)
func (*Client) SkyblockItems ¶
func (client *Client) SkyblockItems() (structs.SkyblockItems, error)
func (*Client) SkyblockNews ¶
func (c *Client) SkyblockNews() (structs.SkyblockNews, error)
func (*Client) SkyblockProfile ¶
func (client *Client) SkyblockProfile(profile string) (structs.SkyblockProfile, error)
func (*Client) SkyblockProfiles ¶
func (client *Client) SkyblockProfiles(name string) (structs.SkyblockProfiles, error)
func (*Client) SkyblockSkills ¶
func (client *Client) SkyblockSkills() (structs.SkyblockSkills, error)
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.