gopixel

package module
v0.2.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 16, 2022 License: MIT Imports: 7 Imported by: 0

README

Gopixel

GoDoc GitHub code size in bytes Go Report Card GitHub GitHub go.mod Go version

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>, <Amount of retries (0 is default value)>)

func main() {
	// example
	bazaar := client.Bazaar()
  	fmt.Println(bazaar.Products.BrownMushroom.QuickStatus.SellPrice)
Supported endpoints

If you have any questions, DM me on discord (comblock#5184) [^1]: as of 30/10/2021

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

type Client struct {
	Key     string
	Retries uint
}

func NewClient 

func NewClient(key string, retries uint) *Client

Returns a client object

func (*Client) Achievements 

func (client *Client) Achievements() (*structs.Achievements, error)

Method to get the global achievements

func (*Client) Bazaar added in v0.0.2 

func (client *Client) Bazaar() (*structs.Bazaar, error)

Method to get the bazaar data

func (*Client) Boosters 

func (client *Client) Boosters() (*structs.Boosters, error)

Method to get the active boosters

func (*Client) Challenges 

func (client *Client) Challenges() (*structs.Challenges, error)

Method to get a list of all challenges

func (*Client) Friends 

func (client *Client) Friends(name string) (*structs.Friends, error)

Method to get the friends of a player

func (*Client) Games 

func (client *Client) Games() (*structs.Games, error)

Method to get a list of the games

func (*Client) GuildAchievements 

func (client *Client) GuildAchievements() (*structs.GuildAchievements, error)

Method to get a list of guild achievements

func (*Client) GuildById 

func (client *Client) GuildById(id string) (*structs.Guild, error)

Method to get a guild by its id

func (*Client) GuildByName 

func (client *Client) GuildByName(name string) (*structs.Guild, error)

Method to get a guild by its name

func (*Client) GuildByPlayer 

func (client *Client) GuildByPlayer(player string) (*structs.Guild, error)

Method to get a guild by a player

func (*Client) KeyData added in v0.0.2 

func (client *Client) KeyData() (*structs.Key, error)

Method to check if a key is valid and

func (*Client) Leaderboards 

func (client *Client) Leaderboards() (*structs.Leaderboards, error)

Method to get the current leaderboards

func (*Client) PlayerCounts 

func (client *Client) PlayerCounts() (*structs.PlayerCounts, error)

Method to get the current player counts

func (*Client) PlayerData 

func (client *Client) PlayerData(name string) (*structs.Player, error)

Method to get the data of a player

func (*Client) PlayerStatus 

func (client *Client) PlayerStatus(name string) (*structs.PlayerStatus, error)

Method to get a player's status

func (*Client) PunishmentStats 

func (client *Client) PunishmentStats() (*structs.PunishmentStats, error)

Method to get the punishment statistics

func (*Client) Quests 

func (client *Client) Quests() (*structs.Quests, error)

Method to get the quests

func (*Client) RankedSkywars 

func (client *Client) RankedSkywars(name string) (*structs.RankedSkywars, error)

Method to get the ranked skywars data of a player. Will return an error if no data is found

func (*Client) RecentGames 

func (client *Client) RecentGames(name string) (*structs.RecentGames, error)

Method to get the recently played games of a player

func (*Client) SkyblockActiveAuctions 

func (client *Client) SkyblockActiveAuctions() (*structs.SkyblockActiveAuctions, error)
Method to get the active skyblock auctions

! DO NOT USE THIS WITHOUT CACHING, it will send out a lot of requests (50 or so) and this can rate limit your api key very quickly

func (*Client) SkyblockActiveAuctionsPage added in v0.1.0 

func (client *Client) SkyblockActiveAuctionsPage(page int) (*structs.SkyblockActiveAuctionsPage, error)

func (*Client) SkyblockAuctionByPlayer 

func (client *Client) SkyblockAuctionByPlayer(player string) (*structs.SkyblockAuctions, error)

Method to get the auctions of a player

func (*Client) SkyblockAuctionByProfileUuid 

func (client *Client) SkyblockAuctionByProfileUuid(uuid string) (*structs.SkyblockAuctions, error)

Method to get an auction by a profile uuid

func (*Client) SkyblockAuctionByUuid 

func (client *Client) SkyblockAuctionByUuid(uuid string) (*structs.SkyblockAuctions, error)

Method to get an auction by its uuid

func (*Client) SkyblockCollections 

func (client *Client) SkyblockCollections() (*structs.SkyblockCollections, error)

Method to get a list of the skyblock collections

func (*Client) SkyblockEndedAuctions 

func (client *Client) SkyblockEndedAuctions() (*structs.SkyblockEndedAuctions, error)

Method to get the ended auctions

func (*Client) SkyblockItems 

func (client *Client) SkyblockItems() (*structs.SkyblockItems, error)

Method to get a list of the skyblock items

func (*Client) SkyblockNews 

func (client *Client) SkyblockNews() (*structs.SkyblockNews, error)

Method to get the skyblock news

func (*Client) SkyblockProfile 

func (client *Client) SkyblockProfile(profile string) (*structs.SkyblockProfile, error)

Method to get a skyblock profile by its uuid

func (*Client) SkyblockProfiles 

func (client *Client) SkyblockProfiles(name string) (*structs.SkyblockProfiles, error)

Method to get the skyblock profiles of a player

func (*Client) SkyblockSkills 

func (client *Client) SkyblockSkills() (*structs.SkyblockSkills, error)

Method to get a list of the skills in skyblock

func (*Client) Uuid added in v0.0.4 

func (client *Client) Uuid(name string) (string, error)

Function to convert a player name to uuid using the mojang api

func (*Client) VanityCompanions added in v0.2.0 

func (client *Client) VanityCompanions() (*structs.Vanity, error)

func (*Client) VanityPets added in v0.2.0 

func (client *Client) VanityPets() (*structs.Vanity, error)

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.