Documentation ¶
Index ¶
- func New(devID, key, url, respType string) (hirezapi.HiRezAPI, error)
- func NewWithSession(devID, key, url, respType string) (hirezapi.HiRezAPI, error)
- type APIClient
- func (a *APIClient) ChangeBasePath(url string)
- func (a *APIClient) ChangeResponseType(respType string)
- func (a *APIClient) CreateSession() error
- func (a *APIClient) GetBountyItems() ([]models.BountyItem, error)
- func (a *APIClient) GetChampionCards(champID, langCode string) ([]models.ChampionCard, error)
- func (a *APIClient) GetChampionLeaderboard(champID string) ([]models.ChampionLeaderboardEntry, error)
- func (a *APIClient) GetChampionRanks(player string) ([]models.ChampionRank, error)
- func (a *APIClient) GetChampionSkins(champID, langCode string) ([]models.ChampionSkin, error)
- func (a *APIClient) GetChampions(langCode string) ([]models.Champion, error)
- func (a *APIClient) GetDataUsed() ([]models.DataUsed, error)
- func (a *APIClient) GetESportsProLeagueDetails() ([]models.ESportsProLeagueDetail, error)
- func (a *APIClient) GetFriends(player string) ([]models.Friend, error)
- func (a *APIClient) GetGodAltAbilities() ([]models.GodAltAbility, error)
- func (a *APIClient) GetGodLeaderboard(godID, queueID string) ([]models.GodLeaderboardEntry, error)
- func (a *APIClient) GetGodRanks(player string) ([]models.GodRank, error)
- func (a *APIClient) GetGodRecommendedItems(godID int64, langCode string) ([]models.GodRecommendedItem, error)
- func (a *APIClient) GetGodSkins(godID int64, langCode string) ([]models.GodSkin, error)
- func (a *APIClient) GetGods(langCode string) ([]models.God, error)
- func (a *APIClient) GetHiRezServerStatus() ([]models.HiRezServerStatus, error)
- func (a *APIClient) GetItems(langCode string) ([]models.Item, error)
- func (a *APIClient) GetLeagueLeaderboard(queueID, tier, round string) ([]models.LeagueLeaderboardEntry, error)
- func (a *APIClient) GetLeagueSeasons(queueID string) ([]models.Season, error)
- func (a *APIClient) GetMOTD() ([]models.MOTD, error)
- func (a *APIClient) GetMatchDetails(matchID string) ([]models.MatchPlayer, error)
- func (a *APIClient) GetMatchDetailsBatch(matchIDs []string) ([]models.MatchPlayer, error)
- func (a *APIClient) GetMatchHistory(player string) ([]models.Match, error)
- func (a *APIClient) GetMatchIDsByQueue(queueID, date, hour string) ([]models.Match, error)
- func (a *APIClient) GetMatchPlayerDetails(matchID string) ([]models.LiveMatchPlayer, error)
- func (a *APIClient) GetOrganizedMatchDetailsBatch(matchIDs []string) ([][]models.MatchPlayer, error)
- func (a *APIClient) GetPatchInfo() (*models.VersionInfo, error)
- func (a *APIClient) GetPlayer(player string) ([]models.Player, error)
- func (a *APIClient) GetPlayerAchievements(playerID string) (*models.PlayerAchievements, error)
- func (a *APIClient) GetPlayerBatch(playerIDs []string) ([]models.Player, error)
- func (a *APIClient) GetPlayerByPlatform(player, portalID string) ([]models.Player, error)
- func (a *APIClient) GetPlayerIDByName(player string) ([]models.PlayerIDInfo, error)
- func (a *APIClient) GetPlayerIDByPortalUserID(portalID, portalUserID string) ([]models.PlayerIDInfo, error)
- func (a *APIClient) GetPlayerIDInfoForXBOXAndSwitch(player string) ([]models.PlayerIDInfoForXBOXAndSwitch, error)
- func (a *APIClient) GetPlayerIDsByGamertag(portalID, gamerTag string) ([]models.PlayerIDInfo, error)
- func (a *APIClient) GetPlayerLoadouts(player, langCode string) ([]models.PlayerLoadout, error)
- func (a *APIClient) GetPlayerStatus(player string) ([]models.PlayerStatus, error)
- func (a *APIClient) GetQueueStats(player, queueID string) ([]models.PlayerGodQueueStat, error)
- func (a *APIClient) GetTeamDetails(clanID string) ([]models.TeamDetail, error)
- func (a *APIClient) GetTeamPlayers(clanID string) ([]models.TeamPlayer, error)
- func (a *APIClient) GetTopMatches() ([]models.TopMatch, error)
- func (a *APIClient) Ping() error
- func (a *APIClient) SearchPlayers(searchPlayer string) ([]models.PlayerIDInfo, error)
- func (a *APIClient) SearchTeams(searchTeam string) ([]models.TeamDetail, error)
- func (a *APIClient) TestSession() (string, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type APIClient ¶
type APIClient struct { DeveloperID string AuthKey string BasePath string RespType string SessionID string SessionStamp string }
APIClient stores data needed to interface with the HiRez API and implements the HiRezAPI interface methods.
func (*APIClient) ChangeBasePath ¶
ChangeBasePath modifies the base path if you want to query a different platform.
func (*APIClient) ChangeResponseType ¶
ChangeResponseType modifies the response type if you want to switch between JSON and XML
func (*APIClient) CreateSession ¶
CreateSession is a required step to Authenticate the developerId/signature for further API use.
func (*APIClient) GetBountyItems ¶
func (a *APIClient) GetBountyItems() ([]models.BountyItem, error)
GetBountyItems returns daily Bounty Item history for the past 6 months.
func (*APIClient) GetChampionCards ¶
func (a *APIClient) GetChampionCards(champID, langCode string) ([]models.ChampionCard, error)
GetChampionCards returns all Champion cards.
func (*APIClient) GetChampionLeaderboard ¶
func (a *APIClient) GetChampionLeaderboard(champID string) ([]models.ChampionLeaderboardEntry, error)
GetChampionLeaderboard returns the current season's leaderboard for a champion/queue. [ Only queue 428]
func (*APIClient) GetChampionRanks ¶
func (a *APIClient) GetChampionRanks(player string) ([]models.ChampionRank, error)
GetChampionRanks returns the rank and worshipper values for each Champion a player has played.
func (*APIClient) GetChampionSkins ¶
func (a *APIClient) GetChampionSkins(champID, langCode string) ([]models.ChampionSkin, error)
GetChampionSkins returns a list of skins for a particular champion.
func (*APIClient) GetChampions ¶
GetChampions returns all Champions and their various attributes.
func (*APIClient) GetDataUsed ¶
GetDataUsed returns API Developer daily usage limits and the current status against those limits.
func (*APIClient) GetESportsProLeagueDetails ¶
func (a *APIClient) GetESportsProLeagueDetails() ([]models.ESportsProLeagueDetail, error)
GetESportsProLeagueDetails returns matchup info for each matchup of the current season. match_status = 1 - scheduled, 2 - in progress, 3 - complete
func (*APIClient) GetFriends ¶
GetFriends returns Smite Usernames of each of the player's friends. [PC Only]
func (*APIClient) GetGodAltAbilities ¶
func (a *APIClient) GetGodAltAbilities() ([]models.GodAltAbility, error)
GetGodAltAbilities returns alt abilities for all Gods.
func (*APIClient) GetGodLeaderboard ¶
func (a *APIClient) GetGodLeaderboard(godID, queueID string) ([]models.GodLeaderboardEntry, error)
GetGodLeaderboard returns the current season's leaderboard for a god/queue. [SmiteAPI: only queues 440, 450, 451]
func (*APIClient) GetGodRanks ¶
GetGodRanks returns the rank and worshipper values for each God a player has played.
func (*APIClient) GetGodRecommendedItems ¶
func (a *APIClient) GetGodRecommendedItems(godID int64, langCode string) ([]models.GodRecommendedItem, error)
GetGodRecommendedItems returns the recommended items for a particular God.
func (*APIClient) GetGodSkins ¶
GetGodSkins returns all available skins for a particular God.
func (*APIClient) GetHiRezServerStatus ¶
func (a *APIClient) GetHiRezServerStatus() ([]models.HiRezServerStatus, error)
GetHiRezServerStatus returns UP/DOWN status for the primary game/platform environments. Data is cached once a minute.
func (*APIClient) GetLeagueLeaderboard ¶
func (a *APIClient) GetLeagueLeaderboard(queueID, tier, round string) ([]models.LeagueLeaderboardEntry, error)
GetLeagueLeaderboard returns the top players for a particular league.
func (*APIClient) GetLeagueSeasons ¶
GetLeagueSeasons returns a list of seasons for a match queue.
func (*APIClient) GetMatchDetails ¶
func (a *APIClient) GetMatchDetails(matchID string) ([]models.MatchPlayer, error)
GetMatchDetails returns the statistics for a particular completed match.
func (*APIClient) GetMatchDetailsBatch ¶
func (a *APIClient) GetMatchDetailsBatch(matchIDs []string) ([]models.MatchPlayer, error)
GetMatchDetailsBatch returns the statistics for a particular set of completed matches. (limit batch query to 5-10 matchIDs)
func (*APIClient) GetMatchHistory ¶
GetMatchHistory returns a list of recent matches and high level match statistics for a particular player
func (*APIClient) GetMatchIDsByQueue ¶
GetMatchIDsByQueue lists all MatchIDs for a particular match queue. - queueID can be referened by constants defined in this package (eg, hirezapi.ConquestRanked). - date must be formatted/formattable by hirezapi.DateFormat (yyyyMMdd). - hour may be "0" - "23" and optionally may contain a ten minute window separated by a comma (eg, "6,30"). - hour may also be "-1" to fetch the whole day, but may stall/fail due to the amount of data.
func (*APIClient) GetMatchPlayerDetails ¶
func (a *APIClient) GetMatchPlayerDetails(matchID string) ([]models.LiveMatchPlayer, error)
GetMatchPlayerDetails returns player information for a live match.
func (*APIClient) GetOrganizedMatchDetailsBatch ¶
func (a *APIClient) GetOrganizedMatchDetailsBatch(matchIDs []string) ([][]models.MatchPlayer, error)
GetOrganizedMatchDetailsBatch is the same as GetMatchDetailsBatch(), except it groups the players by match. (limit batch query to 5-10 matchIDs) NOTE: This method is currently unimplemented due to issues generating a slice of slice of structs
func (*APIClient) GetPatchInfo ¶
func (a *APIClient) GetPatchInfo() (*models.VersionInfo, error)
GetPatchInfo returns information about the currently deployed patch.
func (*APIClient) GetPlayer ¶
GetPlayer returns league and other high level data for a particular player.
func (*APIClient) GetPlayerAchievements ¶
func (a *APIClient) GetPlayerAchievements(playerID string) (*models.PlayerAchievements, error)
GetPlayerAchievements returns select achievement totals.
func (*APIClient) GetPlayerBatch ¶
GetPlayerBatch returns league and other high level data for a particular list of players. [20 max]
func (*APIClient) GetPlayerByPlatform ¶
GetPlayerByPlatform returns league and other high level data for a particular player.
func (*APIClient) GetPlayerIDByName ¶
func (a *APIClient) GetPlayerIDByName(player string) ([]models.PlayerIDInfo, error)
GetPlayerIDByName returns a list of Hi-Rez PlayerID values for the particular player
func (*APIClient) GetPlayerIDByPortalUserID ¶
func (a *APIClient) GetPlayerIDByPortalUserID(portalID, portalUserID string) ([]models.PlayerIDInfo, error)
GetPlayerIDByPortalUserID returns a list of Hi-Rez PlayerID values for portalID/portalUserID combo
func (*APIClient) GetPlayerIDInfoForXBOXAndSwitch ¶
func (a *APIClient) GetPlayerIDInfoForXBOXAndSwitch(player string) ([]models.PlayerIDInfoForXBOXAndSwitch, error)
GetPlayerIDInfoForXBOXAndSwitch returns all PlayerID data associated with the playerName
func (*APIClient) GetPlayerIDsByGamertag ¶
func (a *APIClient) GetPlayerIDsByGamertag(portalID, gamerTag string) ([]models.PlayerIDInfo, error)
GetPlayerIDsByGamertag returns a list of Hi-Rez PlayerID values for a portalID/gamerTag combo
func (*APIClient) GetPlayerLoadouts ¶
func (a *APIClient) GetPlayerLoadouts(player, langCode string) ([]models.PlayerLoadout, error)
GetPlayerLoadouts returns deck loadouts per Champion
func (*APIClient) GetPlayerStatus ¶
func (a *APIClient) GetPlayerStatus(player string) ([]models.PlayerStatus, error)
GetPlayerStatus returns a player status.
func (*APIClient) GetQueueStats ¶
func (a *APIClient) GetQueueStats(player, queueID string) ([]models.PlayerGodQueueStat, error)
GetQueueStats returns match summary stats for a player + queue, grouped by Gods played.
func (*APIClient) GetTeamDetails ¶
func (a *APIClient) GetTeamDetails(clanID string) ([]models.TeamDetail, error)
GetTeamDetails returns the number of players and other high level details for a particular Clan.
func (*APIClient) GetTeamPlayers ¶
func (a *APIClient) GetTeamPlayers(clanID string) ([]models.TeamPlayer, error)
GetTeamPlayers returns a list of players for a particular Clan.
func (*APIClient) GetTopMatches ¶
GetTopMatches returns the 50 most watched / recorded matches.
func (*APIClient) SearchPlayers ¶
func (a *APIClient) SearchPlayers(searchPlayer string) ([]models.PlayerIDInfo, error)
SearchPlayers returns playerID values for all names and/or gamerTags containing searchPlayer
func (*APIClient) SearchTeams ¶
func (a *APIClient) SearchTeams(searchTeam string) ([]models.TeamDetail, error)
SearchTeams returns high level info for Clan names containing search term.
func (*APIClient) TestSession ¶
TestSession is a means of validating that a session is established.