smitego

package module
v0.0.0-...-a83041a Latest Latest
Warning

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

 Go to latest Published: Apr 26, 2016 License: Apache-2.0 Imports: 11 Imported by: 0

README

smitego Circle CI

Smitego is a go library for interacting with the Smite Hi-Rez API. All documented public functions are implemented.

Example

package main

import (
  "fmt"
  "github.com/cep21/smitego"
  "golang.org/x/net/context"
)

func main() {
  // First make a client to describe how you want to connect.  Each client
  // returns a session and primary function calls are done on the
  // session.  Concurrent sessions are limited by HiRez
  client := smitego.Client{
    DevID:   123,
    AuthKey: "AuthKey123",
  }

  // A context is how you can time out function calls
  ctx := context.Background()

  // Some functions don't require a session first and can be called on the
  // client directly
  _ = client.Ping(ctx)

  // Most functions require a session

  session, _ := client.CreateSession(ctx)
  gods, _ := session.GetGods(ctx, English)
  fmt.Printf("Got %d gods\n", len(gods))
}

Integration tests

You can test all the library functions by creating a file named info.json and put it at the root of your project. That file should have your devId and authKey. The file should be inside .gitignore and not checked into git. Then run with the tag integration.

File info.json

{
  "devId": 123,
  "authKey": "abcd"
}

go test -v --tags=integration .

Documentation

Index

Examples

Constants

View Source 
const (
	English    LanguageCode = 1
	German                  = 2
	French                  = 3
	Spanish                 = 4
	SpanishLA               = 5
	Portuguese              = 10
	Russian                 = 11
	Polish                  = 12
	Turkish                 = 13
)

Smite API supported languages

View Source 
const (
	Conquest5v5              Queue = 423
	NoviceQueue                    = 424
	Conquest                       = 426
	Practice                       = 427
	ConquestChallenge              = 429
	ConquestRanked                 = 430
	Domination                     = 433
	MOTD                           = 434 // (use with 465 to get all MOTD matches),
	Arena                          = 435
	ArenaChallenge                 = 438
	DominationChallenge            = 439
	JoustRanked1v1RankedDuel       = 440
	JoustChallenge                 = 441
	Assault                        = 445
	AssaultChallenge               = 446
	Joust3v3                       = 448
	JoustRanked3v3                 = 450
	ConquestRanked2                = 451
	ArenaRanked                    = 452
	MOTD2                          = 465 // (Supports “closing” the Queue by our platform; use with 434)
	Clash                          = 466
	ClashChallenge                 = 467
)

Smite queue types

View Source 
const (
	BronzeV     Tier = 1
	BronzeIV         = 2
	BronzeIII        = 3
	BronzeII         = 4
	BronzeI          = 5
	SilverV          = 6
	SilverIV         = 7
	SilverIII        = 8
	SilverII         = 9
	SilverI          = 10
	GoldV            = 11
	GoldIV           = 12
	GoldIII          = 13
	GoldII           = 14
	GoldI            = 15
	PlatinumV        = 16
	PlatinumIV       = 17
	PlatinumIII      = 18
	PlatinumII       = 19
	PlatinumI        = 20
	DiamondV         = 21
	DiamondIV        = 22
	DiamondIII       = 23
	DiamondII        = 24
	DiamondI         = 25
	MastersI         = 26
)

Various tier rankings

View Source 
const DefaultBaseURL = "http://api.smitegame.com/smiteapi.svc"

DefaultBaseURL is where smite expects API calls. Why the frick is this HTTP and not HTTPS. (?????)

View Source 
const DefaultXboxURL = "http://api.xbox.smitegame.com/smiteapi.svc"

DefaultXboxURL is used for smite's XBox API

View Source 
const Version = "0.1"

Version is the current library's version: sent with User-Agent

Variables

View Source 
var ErrUnexpectedSize = errors.New("unexpected data usage size")

ErrUnexpectedSize is returned by GetDataUsed when the response doesn't look correct

Functions

This section is empty.

Types

type Ability 

type Ability struct {
	Description AbilityDescription `json:"Description"`
	ID          int                `json:"Id"`
	Summary     string             `json:"summary"`
	URL         string             `json:"URL"`
}

Ability is a god ability

type AbilityDescription 

type AbilityDescription struct {
	ItemDescription ItemDescription `json:"itemDescription"`
}

AbilityDescription is ... honestly a useless abstraction for them

type Client 

type Client struct {
	DevID      int64
	AuthKey    string
	HTTPClient http.Client
	BaseURL    string
	CurTime    func() time.Time
	VerboseLog Log
}

Client can create smite session objects and interact with the smite API

func (*Client) CreateSession 

func (c *Client) CreateSession(ctx context.Context) (*Session, error)

CreateSession is a required step to Authenticate the developerId/signature for further API use.

func (*Client) Ping 

func (c *Client) Ping(ctx context.Context) error

Ping is a quick way of validating access to the Hi-Rez API

type DataUsed 

type DataUsed struct {
	ActiveSessions     int    `json:"Active_Session"`
	ConcurrentSessions int    `json:"Concurrent_Sessions"`
	RequestLimitDaily  int    `json:"Request_Limit_Daily"`
	SessionCap         int    `json:"Session_Cap"`
	SessionTimeLimit   int    `json:"Session_Time_Limit"`
	TotalRequestsToday int    `json:"Total_Requests_Today"`
	TotalSessionsToday int    `json:"Total_Sessions_Today"`
	RetMsg             string `json:"ret_msg"`
}

DataUsed is the JSON object returned by GetDataUsed

func (*DataUsed) String 

func (d *DataUsed) String() string

String returns all the DataUsed info

type ErrBadStatusCode 

type ErrBadStatusCode struct {
	OriginalBody string
	Code         int
}

ErrBadStatusCode is returned when the API returns a non 200 error code

func (*ErrBadStatusCode) Error 

func (e *ErrBadStatusCode) Error() string

type ErrNotExpectedJSON 

type ErrNotExpectedJSON struct {
	OriginalBody string
	Err          error
}

ErrNotExpectedJSON is returned by API calls when the response isn't expected JSON

func (*ErrNotExpectedJSON) Error 

func (e *ErrNotExpectedJSON) Error() string

type GetPlayerResponse 

type GetPlayerResponse struct {
	AvatarURL         string     `json:"Avatar_URL"`
	CreatedDatetime   string     `json:"Created_Datetime"`
	ID                int        `json:"Id"`
	LastLoginDatetime string     `json:"Last_Login_Datetime"`
	Leaves            int        `json:"Leaves"`
	Level             int        `json:"Level"`
	Losses            int        `json:"Losses"`
	MasteryLevel      int        `json:"MasteryLevel"`
	Name              string     `json:"Name"`
	RankStatConquest  int        `json:"Rank_Stat_Conquest"`
	RankStatDuel      int        `json:"Rank_Stat_Duel"`
	RankStatJoust     int        `json:"Rank_Stat_Joust"`
	RankedConquest    RankedInfo `json:"RankedConquest"`
	RankedDuel        RankedInfo `json:"RankedDuel"`
	RankedJoust       RankedInfo `json:"RankedJoust"`
	TeamID            int        `json:"TeamId"`
	TeamName          string     `json:"TeamName"`
	TierConquest      int        `json:"Tier_Conquest"`
	TierDuel          int        `json:"Tier_Duel"`
	TierJoust         int        `json:"Tier_Joust"`
	TotalAchievements int        `json:"Total_Achievements"`
	TotalWorshippers  int        `json:"Total_Worshippers"`
	Wins              int        `json:"Wins"`
	RetMsg            int        `json:"ret_msg"`
}

GetPlayerResponse is high level info about a player

type God 

type God struct {
	Ability1                   string             `json:"Ability1"`
	Ability2                   string             `json:"Ability2"`
	Ability3                   string             `json:"Ability3"`
	Ability4                   string             `json:"Ability4"`
	Ability5                   string             `json:"Ability5"`
	AbilityID1                 int                `json:"AbilityId1"`
	AbilityID2                 int                `json:"AbilityId2"`
	AbilityID3                 int                `json:"AbilityId3"`
	AbilityID4                 int                `json:"AbilityId4"`
	AbilityID5                 int                `json:"AbilityId5"`
	AbilityInfo1               Ability            `json:"Ability_1"`
	AbilityInfo2               Ability            `json:"Ability_2"`
	AbilityInfo3               Ability            `json:"Ability_3"`
	AbilityInfo4               Ability            `json:"Ability_4"`
	AbilityInfo5               Ability            `json:"Ability_5"`
	AttackSpeed                float64            `json:"AttackSpeed"`
	AttackSpeedPerLevel        float64            `json:"AttackSpeedPerLevel"`
	Cons                       string             `json:"Cons"`
	HP5PerLevel                float64            `json:"HP5PerLevel"`
	Health                     int                `json:"Health"`
	HealthPerFive              int                `json:"HealthPerFive"`
	HealthPerLevel             int                `json:"HealthPerLevel"`
	Lore                       string             `json:"Lore"`
	MP5PerLevel                float64            `json:"MP5PerLevel"`
	MagicProtection            int                `json:"MagicProtection"`
	MagicProtectionPerLevel    float64            `json:"MagicProtectionPerLevel"`
	MagicalPower               int                `json:"MagicalPower"`
	MagicalPowerPerLevel       float64            `json:"MagicalPowerPerLevel"`
	Mana                       int                `json:"Mana"`
	ManaPerFive                float64            `json:"ManaPerFive"`
	ManaPerLevel               float64            `json:"ManaPerLevel"`
	Name                       string             `json:"Name"`
	OnFreeRotation             string             `json:"OnFreeRotation"`
	Pantheon                   string             `json:"Pantheon"`
	PhysicalPower              int                `json:"PhysicalPower"`
	PhysicalPowerPerLevel      float64            `json:"PhysicalPowerPerLevel"`
	PhysicalProtection         int                `json:"PhysicalProtection"`
	PhysicalProtectionPerLevel float64            `json:"PhysicalProtectionPerLevel"`
	Pros                       string             `json:"Pros"`
	Roles                      string             `json:"Roles"`
	Speed                      int                `json:"Speed"`
	Title                      string             `json:"Title"`
	Type                       string             `json:"Type"`
	AbilityDescription1        AbilityDescription `json:"abilityDescription1"`
	AbilityDescription2        AbilityDescription `json:"abilityDescription2"`
	AbilityDescription3        AbilityDescription `json:"abilityDescription3"`
	AbilityDescription4        AbilityDescription `json:"abilityDescription4"`
	AbilityDescription5        AbilityDescription `json:"abilityDescription5"`
	BasicAttack                AbilityDescription `json:"basicAttack"`
	GodAbilityURL1             string             `json:"godAbility1_URL"`
	GodAbilityURL2             string             `json:"godAbility1_URL"`
	GodAbilityURL3             string             `json:"godAbility1_URL"`
	GodAbilityURL4             string             `json:"godAbility1_URL"`
	GodAbilityURL5             string             `json:"godAbility1_URL"`
	GodCardURL                 string             `json:"godCard_URL"`
	GodIconURL                 string             `json:"godIcon_URL"`
	ID                         int                `json:"id"`
	LatestGod                  string             `json:"latestGod"`
	RetMsg                     string             `json:"ret_msg"`
}

God is a smite God

func (*God) String 

func (g *God) String() string

type Item 

type Item struct {
	ChildItemID     int             `json:"ChildItemId"`
	DeviceName      string          `json:"DeviceName"`
	IconID          int             `json:"IconId"`
	ItemDescription ItemDescription `json:"ItemDescription"`
	ItemID          int             `json:"ItemId"`
	ItemTier        int             `json:"ItemTier"`
	Price           int             `json:"Price"`
	RootItemID      int             `json:"RootItemId"`
	ShortDesc       string          `json:"ShortDesc"`
	StartingItem    bool            `json:"StartingItem"`
	Type            string          `json:"Type"`
	ItemIconURL     string          `json:"itemIcon_URL"`
	RetMsg          string          `json:"ret_msg"`
}

Item describes a smite item

func (*Item) String 

func (i *Item) String() string

type ItemDescription 

type ItemDescription struct {
	Cooldown             string     `json:"cooldown"`
	Cost                 string     `json:"cost"`
	Description          string     `json:"description"`
	MenuItems            []MenuItem `json:"menuitems"`
	RankItems            []MenuItem `json:"rankitems"`
	SecondaryDescription string     `json:"secondaryDescription"`
}

ItemDescription gives specifics about ability or item info

type LanguageCode 

type LanguageCode int

LanguageCode controls what language a response is in

type LeaderboardPlayer 

type LeaderboardPlayer struct {
	Leaves           int    `json:"Leaves"`
	Losses           int    `json:"Losses"`
	Name             string `json:"Name"`
	Points           int    `json:"Points"`
	PrevRank         int    `json:"PrevRank"`
	Rank             int    `json:"Rank"`
	RankStatConquest string `json:"Rank_Stat_Conquest"`
	RankStatDuel     string `json:"Rank_Stat_Duel"`
	RankStatJoust    string `json:"Rank_Stat_Joust"`
	Season           int    `json:"Season"`
	Tier             int    `json:"Tier"`
	Trend            int    `json:"Trend"`
	Wins             int    `json:"Wins"`
	PlayerID         string `json:"player_id"`
	RetMsg           string `json:"ret_msg"`
}

LeaderboardPlayer is a result from getting tier leader boards

type LeagueSeason 

type LeagueSeason struct {
	Complete bool   `json:"complete"`
	ID       int    `json:"id"`
	Name     string `json:"name"`
	RetMsg   string `json:"ret_msg"`
}

LeagueSeason is season info about a specific queue

type Log 

type Log func(...interface{})

Log is a function that Client can take to optionally verbose log what it does internally

type MOTDResponse 

type MOTDResponse struct {
	Description   string `json:"description"`
	GameMode      string `json:"gameMode"`
	MaxPlayers    string `json:"maxPlayers"`
	Name          string `json:"name"`
	RetMsg        string `json:"ret_msg"`
	StartDateTime string `json:"startDateTime"`
	Team1GodsCSV  string `json:"team1GodsCSV"`
	Team2GodsCSV  string `json:"team2GodsCSV"`
	Title         string `json:"title"`
}

MOTDResponse is recent match info for a paticular player

type Match 

type Match struct {
	AwayTeamClanID  int    `json:"away_team_clan_id"`
	AwayTeamName    string `json:"away_team_name"`
	AwayTeamTagName string `json:"away_team_tagname"`

	HomeTeamClanID  int    `json:"home_team_clan_id"`
	HomeTeamName    string `json:"home_team_name"`
	HomeTeamTagName string `json:"home_team_tagname"`

	MapInstanceID string `json:"map_instance_id"`
	MatchDate     string `json:"match_date"`
	MatchNumber   string `json:"match_number"`
	MatchStatus   string `json:"match_status"`

	MatchupID string `json:"matchup_id"`

	Region            string `json:"region"`
	RetMsg            string `json:"ret_msg"`
	TournamentName    string `json:"tournament_name"`
	WinningTeamClanID int    `json:"winning_team_clan_id"`
}

Match describes a ranked match

func (*Match) String 

func (m *Match) String() string

type MatchPlayerDetails 

type MatchPlayerDetails struct {
	AccountLevel  int    `json:"Account_Level"`
	GodID         int    `json:"GodId"`
	GodName       string `json:"GodName"`
	MasteryLevel  int    `json:"Mastery_Level"`
	Match         int    `json:"Match"`
	Queue         string `json:"Queue"`
	SkinID        int    `json:"SkinId"`
	Tier          int    `json:"Tier"`
	PlayerCreated string `json:"playerCreated"`
	PlayerID      string `json:"playerId"`
	PlayerName    string `json:"playerName"`
	RetMsg        string `json:"ret_msg"`
	TaskForce     int    `json:"taskForce"`
	TierLosses    int    `json:"tierLosses"`
	TierWins      int    `json:"tierWins"`
}

MatchPlayerDetails are limited information about a currently live match.

type MatchPlayerInfo 

type MatchPlayerInfo struct {
	AccountLevel int `json:"Account_Level"`
	ActiveID1    int `json:"ActiveId1"`
	ActiveID2    int `json:"ActiveId2"`
	Assists      int `json:"Assists"`

	Ban1   string `json:"Ban1"`
	Ban1Id int    `json:"Ban1Id"`

	Ban10   string `json:"Ban10"`
	Ban10Id int    `json:"Ban10Id"`

	Ban2   string `json:"Ban2"`
	Ban2Id int    `json:"Ban2Id"`

	Ban3   string `json:"Ban3"`
	Ban3Id int    `json:"Ban3Id"`

	Ban4   string `json:"Ban4"`
	Ban4Id int    `json:"Ban4Id"`

	Ban5   string `json:"Ban5"`
	Ban5Id int    `json:"Ban5Id"`

	Ban6   string `json:"Ban6"`
	Ban6Id int    `json:"Ban6Id"`

	Ban7   string `json:"Ban7"`
	Ban7Id int    `json:"Ban7Id"`

	Ban8   string `json:"Ban8"`
	Ban8Id int    `json:"Ban8Id"`

	Ban9   string `json:"Ban9"`
	Ban9Id int    `json:"Ban9Id"`

	CampsCleared int `json:"Camps_Cleared"`

	ConquestLosses int `json:"Conquest_Losses"`
	ConquestPoints int `json:"Conquest_Points"`
	ConquestTier   int `json:"Conquest_Tier"`
	ConquestWins   int `json:"Conquest_Wins"`

	DamageBot          int `json:"Damage_Bot"`
	DamageDoneMagical  int `json:"Damage_Done_Magical"`
	DamageDonePhysical int `json:"Damage_Done_Physical"`
	DamageMitigated    int `json:"Damage_Mitigated"`
	DamagePlayer       int `json:"Damage_Player"`
	DamageTaken        int `json:"Damage_Taken"`
	Deaths             int `json:"Deaths"`

	DuelLosses int `json:"Duel_Losses"`
	DuelPoints int `json:"Duel_Points"`
	DuelTier   int `json:"Duel_Tier"`
	DuelWins   int `json:"Duel_Wins"`

	EntryDatetime string `json:"Entry_Datetime"`

	FinalMatchLevel int `json:"Final_Match_Level"`

	FirstBanSide  string `json:"First_Ban_Side"`
	GodID         int    `json:"GodId"`
	GoldEarned    int    `json:"Gold_Earned"`
	GoldPerMinute int    `json:"Gold_Per_Minute"`

	Healing int `json:"Healing"`
	ItemID1 int `json:"ItemId1"`
	ItemID2 int `json:"ItemId2"`
	ItemID3 int `json:"ItemId3"`
	ItemID4 int `json:"ItemId4"`
	ItemID5 int `json:"ItemId5"`
	ItemID6 int `json:"ItemId6"`

	ItemActive1 string `json:"Item_Active_1"`
	ItemActive2 string `json:"Item_Active_2"`
	ItemActive3 string `json:"Item_Active_3"`

	ItemPurch1 string `json:"Item_Purch_1"`
	ItemPurch2 string `json:"Item_Purch_2"`
	ItemPurch3 string `json:"Item_Purch_3"`
	ItemPurch4 string `json:"Item_Purch_4"`
	ItemPurch5 string `json:"Item_Purch_5"`
	ItemPurch6 string `json:"Item_Purch_6"`

	JoustLosses int `json:"Joust_Losses"`
	JoustPoints int `json:"Joust_Points"`
	JoustTier   int `json:"Joust_Tier"`
	JoustWins   int `json:"Joust_Wins"`

	KillingSpree int `json:"Killing_Spree"`

	KillsBot int `json:"Kills_Bot"`

	KillsDouble int `json:"Kills_Double"`

	KillsFireGiant int `json:"Kills_Fire_Giant"`

	KillsFirstBlood int `json:"Kills_First_Blood"`

	KillsGoldFury int `json:"Kills_Gold_Fury"`

	KillsPenta           int    `json:"Kills_Penta"`
	KillsPhoenix         int    `json:"Kills_Phoenix"`
	KillsPlayer          int    `json:"Kills_Player"`
	KillsQuadra          int    `json:"Kills_Quadra"`
	KillsSiegeJuggernaut int    `json:"Kills_Siege_Juggernaut"`
	KillsSingle          int    `json:"Kills_Single"`
	KillsTriple          int    `json:"Kills_Triple"`
	KillsWildJuggernaut  int    `json:"Kills_Wild_Juggernaut"`
	MasteryLevel         int    `json:"Mastery_Level"`
	Match                int    `json:"Match"`
	Minutes              int    `json:"Minutes"`
	MultikillMax         int    `json:"Multi_kill_Max"`
	PartyID              int    `json:"PartyId"`
	RankStatConquest     int    `json:"Rank_Stat_Conquest"`
	RankStatDuel         int    `json:"Rank_Stat_Duel"`
	RankStatJoust        int    `json:"Rank_Stat_Joust"`
	ReferenceName        string `json:"Reference_Name"`
	Skin                 string `json:"Skin"`
	SkinID               int    `json:"SkinId"`
	StructureDamage      int    `json:"Structure_Damage"`
	Surrendered          int    `json:"Surrendered"`
	Team1Score           int    `json:"Team1Score"`
	Team2Score           int    `json:"Team2Score"`
	TeamID               int    `json:"TeamId"`
	TeamName             string `json:"Team_Name"`
	TowersDestroyed      int    `json:"Towers_Destroyed"`
	WardsPlaced          int    `json:"Wards_Placed"`
	WinStatus            string `json:"Win_Status"`
	HasReplay            string `json:"hasReplay"`
	Name                 string `json:"name"`
	PlayerID             string `json:"playerId"`
	PlayerName           string `json:"playerName"`
	RetMsg               string `json:"ret_msg"`
}

MatchPlayerInfo describes detailed information about a single player in a match

type MatchQueueID 

type MatchQueueID struct {
	ActiveFlag string `json:"Active_Flag"`
	Match      string `json:"Match"`
	RetMsg     string `json:"ret_msg"`
}

MatchQueueID is limited information about a running (or ran) match. 

type MenuItem struct {
	Description string `json:"description"`
	Value       string `json:"value"`
}

MenuItem describes a strength of an ability

type OldMatchDetails 

type OldMatchDetails struct {
	Ban1               string `json:"Ban1"`
	Ban2               string `json:"Ban2"`
	EntryDatetime      string `json:"Entry_Datetime"`
	Match              int    `json:"Match"`
	MatchTime          int    `json:"Match_Time"`
	OfflineSpectators  int    `json:"Offline_Spectators"`
	RealtimeSpectators int    `json:"Realtime_Spectators"`
	RecordingEnded     string `json:"Recording_Ended"`
	RecordingStarted   string `json:"Recording_Started"`
	Team1AvgLevel      int    `json:"Team1_AvgLevel"`
	Team1Gold          int    `json:"Team1_Gold"`
	Team1Kills         int    `json:"Team1_Kills"`
	Team1Score         int    `json:"Team1_Score"`
	Team2AvgLevel      int    `json:"Team2_AvgLevel"`
	Team2Gold          int    `json:"Team2_Gold"`
	Team2Kills         int    `json:"Team2_Kills"`
	Team2Score         int    `json:"Team2_Score"`
	WinningTeam        int    `json:"Winning_Team"`
	RetMsg             string `json:"ret_msg"`
}

OldMatchDetails is no longer needed, but returns a limited set of match info

type Player 

type Player struct {
	AccountID string `json:"account_id"`
	AvatarURL string `json:"avatar_url"`
	Name      string `json:"name"`
	PlayerID  string `json:"player_id"`
	RetMsg    string `json:"ret_msg"`
}

Player is a smite player/account

func (*Player) String 

func (s *Player) String() string

type PlayerAchievements 

type PlayerAchievements struct {
	AssistedKills        int    `json:"AssistedKills"`
	CampsCleared         int    `json:"CampsCleared"`
	DivineSpree          int    `json:"DivineSpree"`
	DoubleKills          int    `json:"DoubleKills"`
	FireGiantKills       int    `json:"FireGiantKills"`
	FirstBloods          int    `json:"FirstBloods"`
	GodLikeSpree         int    `json:"GodLikeSpree"`
	GoldFuryKills        int    `json:"GoldFuryKills"`
	ID                   int    `json:"Id"`
	ImmortalSpree        int    `json:"ImmortalSpree"`
	KillingSpree         int    `json:"KillingSpree"`
	MinionKills          int    `json:"MinionKills"`
	Name                 string `json:"Name"`
	PentaKills           int    `json:"PentaKills"`
	PhoenixKills         int    `json:"PhoenixKills"`
	PlayerKills          int    `json:"PlayerKills"`
	QuadraKills          int    `json:"QuadraKills"`
	RampageSpree         int    `json:"RampageSpree"`
	ShutdownSpree        int    `json:"ShutdownSpree"`
	SiegeJuggernautKills int    `json:"SiegeJuggernautKills"`
	TowerKills           int    `json:"TowerKills"`
	TripleKills          int    `json:"TripleKills"`
	UnstoppableSpree     int    `json:"UnstoppableSpree"`
	WildJuggernautKills  int    `json:"WildJuggernautKills"`
	RetMsg               string `json:"ret_msg"`
}

PlayerAchievements is info about a player

type PlayerMatchHistory 

type PlayerMatchHistory struct {
	ActiveID1 int    `json:"ActiveId1"`
	ActiveID2 int    `json:"ActiveId2"`
	Active1   string `json:"Active_1"`
	Active2   string `json:"Active_2"`
	Active3   string `json:"Active_3"`
	Assists   int    `json:"Assists"`
	Ban1      string `json:"Ban1"`
	Ban1ID    int    `json:"Ban1Id"`

	Ban10   string `json:"Ban10"`
	Ban10ID int    `json:"Ban10Id"`

	Ban2   string `json:"Ban2"`
	Ban2ID int    `json:"Ban2Id"`

	Ban3   string `json:"Ban3"`
	Ban3ID int    `json:"Ban3Id"`

	Ban4   string `json:"Ban4"`
	Ban4ID int    `json:"Ban4Id"`

	Ban5   string `json:"Ban5"`
	Ban5ID int    `json:"Ban5Id"`

	Ban6   string `json:"Ban6"`
	Ban6ID int    `json:"Ban6Id"`

	Ban7   string `json:"Ban7"`
	Ban7ID int    `json:"Ban7Id"`

	Ban8   string `json:"Ban8"`
	Ban8ID int    `json:"Ban8Id"`

	Ban9   string `json:"Ban9"`
	Ban9ID int    `json:"Ban9Id"`

	Creeps          int    `json:"Creeps"`
	Damage          int    `json:"Damage"`
	DamageBot       int    `json:"Damage_Bot"`
	DamageMitigated int    `json:"Damage_Mitigated"`
	DamageStructure int    `json:"Damage_Structure"`
	DamageTaken     int    `json:"Damage_Taken"`
	Deaths          int    `json:"Deaths"`
	FirstBanSide    string `json:"First_Ban_Side"`
	God             string `json:"God"`
	GodID           int    `json:"GodId"`
	Gold            int    `json:"Gold"`
	Healing         int    `json:"Healing"`
	ItemID1         int    `json:"ItemId1"`
	ItemID2         int    `json:"ItemId2"`
	ItemID3         int    `json:"ItemId3"`
	ItemID4         int    `json:"ItemId4"`
	ItemID5         int    `json:"ItemId5"`
	ItemID6         int    `json:"ItemId6"`

	Item1 string `json:"Item_1"`
	Item2 string `json:"Item_2"`
	Item3 string `json:"Item_3"`
	Item4 string `json:"Item_4"`
	Item5 string `json:"Item_5"`
	Item6 string `json:"Item_6"`

	KillingSpree int    `json:"Killing_Spree"`
	Kills        int    `json:"Kills"`
	Level        int    `json:"Level"`
	Match        int    `json:"Match"`
	MatchTime    string `json:"Match_Time"`
	Minutes      int    `json:"Minutes"`

	MultikillMax int    `json:"Multi_kill_Max"`
	Queue        string `json:"Queue"`
	Skin         string `json:"Skin"`
	SkinID       int    `json:"SkinId"`

	Surrendered int    `json:"Surrendered"`
	Team1Score  int    `json:"Team1Score"`
	Team2Score  int    `json:"Team2Score"`
	WardsPlaced int    `json:"Wards_Placed"`
	WinStatus   string `json:"Win_Status"`
	PlayerName  string `json:"playerName"`
	RetMsg      string `json:"ret_msg"`
}

PlayerMatchHistory is high level stats about a specific player

type PlayerStatus 

type PlayerStatus struct {
	Match                 int    `json:"Match"`
	PersonalStatusMessage string `json:"personal_status_message"`
	RetMsg                string `json:"ret_msg"`
	Status                int    `json:"Status"`
	StatusString          string `json:"status_string"`
}

PlayerStatus is returned by /getplayerstatus

type Queue 

type Queue int

Queue describes a type of smite match

type QueueStat 

type QueueStat struct {
	Assists    int    `json:"Assists"`
	Deaths     int    `json:"Deaths"`
	God        string `json:"God"`
	GodID      int    `json:"GodId"`
	Gold       int    `json:"Gold"`
	Kills      int    `json:"Kills"`
	LastPlayed string `json:"LastPlayed"`
	Losses     int    `json:"Losses"`
	Matches    int    `json:"Matches"`
	Minutes    int    `json:"Minutes"`
	Queue      string `json:"Queue"`
	Wins       int    `json:"Wins"`
	PlayerID   string `json:"player_id"`
	RetMsg     string `json:"ret_msg"`
}

QueueStat is god/player stats from a queue/player combination

type RankedInfo 

type RankedInfo struct {
	Leaves           int    `json:"Leaves"`
	Losses           int    `json:"Losses"`
	Name             string `json:"Conquest"`
	Points           int    `json:"Points"`
	PrevRank         int    `json:"PrevRank"`
	Rank             int    `json:"Rank"`
	RankStatConquest string `json:"Rank_Stat_Conquest"`
	RankStatDuel     string `json:"Rank_Stat_Duel"`
	RankStatJoust    string `json:"Rank_Stat_Joust"`
	Season           int    `json:"Season"`
	Tier             int    `json:"Tier"`
	Trend            int    `json:"Trend"`
	Wins             int    `json:"Wins"`
	PlayerID         int    `json:"player_id"`
	RetMsg           string `json:"ret_msg"`
}

RankedInfo is used by GetPlayerResponse for joust/conquest/etc info

type RecommendedItem 

type RecommendedItem struct {
	Category        string `json:"Category"`
	Item            string `json:"Item"`
	Role            string `json:"Role"`
	CategoryValueID int    `json:"category_value_id"`
	GodID           int    `json:"god_id"`
	GodName         string `json:"god_name"`
	IconID          int    `json:"icon_id"`
	ItemID          int    `json:"item_id"`
	RetMsg          string `json:"ret_msg"`
	RoleValueID     int    `json:"role_value_id"`
}

RecommendedItem is item stats

type Session 

type Session struct {
	SessionID string
	// contains filtered or unexported fields
}

Session is an authenticated smite token that can take future actions

Example

Example of creating a session and making a function call. 

// First make a client to describe how you want to connect.  Each client returns a session
// and primary function calls are done on the session.  Concurrent sessions are limited
// by HiRez
client := Client{
	DevID:   123,
	AuthKey: "AuthKey123",
}

// A context is how you can time out function calls
ctx := context.Background()

// Some functions don't require a session first and can be called on the client directly
_ = client.Ping(ctx)

// Most functions require a session

session, _ := client.CreateSession(ctx)
gods, _ := session.GetGods(ctx, English)
fmt.Printf("Got %d gods\n", len(gods))

Output:

func (*Session) GetDataUsed 

func (s *Session) GetDataUsed(ctx context.Context) (*DataUsed, error)

GetDataUsed returns API Developer daily usage limits and the current status against those limits

func (*Session) GetDemoDetails 

func (s *Session) GetDemoDetails(ctx context.Context, matchID int) ([]OldMatchDetails, error)

GetDemoDetails returns information regarding a particular match. Rarely used in lieu of getmatchdetails().

func (*Session) GetEsportsproleaguedetails 

func (s *Session) GetEsportsproleaguedetails(ctx context.Context) ([]Match, error)

GetEsportsproleaguedetails returns the matchup information for each matchup for the current eSports Pro League season. An important return value is “match_status” which represents a match being scheduled (1), in-progress (2), or complete (3)

func (*Session) GetFriends 

func (s *Session) GetFriends(ctx context.Context, player string) ([]Player, error)

GetFriends returns the Smite User names of each of the player’s friends.

func (*Session) GetGodRecommendedItems 

func (s *Session) GetGodRecommendedItems(ctx context.Context, godID int, lang LanguageCode) ([]RecommendedItem, error)

GetGodRecommendedItems Returns the Recommended Items for a particular God. .

func (*Session) GetGods 

func (s *Session) GetGods(ctx context.Context, lang LanguageCode) ([]God, error)

GetGods returns all Gods and their various attributes

func (*Session) GetItems 

func (s *Session) GetItems(ctx context.Context, lang LanguageCode) ([]Item, error)

GetItems returns all Items and their various attributes.

func (*Session) GetLeagueLeaderboard 

func (s *Session) GetLeagueLeaderboard(ctx context.Context, queue Queue, tier Tier, season int) ([]LeaderboardPlayer, error)

GetLeagueLeaderboard returns the top players for a particular league (as indicated by the queue/tier/season parameters).

func (*Session) GetLeagueSeasons 

func (s *Session) GetLeagueSeasons(ctx context.Context, queue Queue) ([]LeagueSeason, error)

GetLeagueSeasons provides a list of seasons (including the single active season) for a match queue.

func (*Session) GetMatchDetails 

func (s *Session) GetMatchDetails(ctx context.Context, matchID int) ([]MatchPlayerInfo, error)

GetMatchDetails returns the statistics for a particular completed match.

func (*Session) GetMatchHistory 

func (s *Session) GetMatchHistory(ctx context.Context, player string) ([]PlayerMatchHistory, error)

GetMatchHistory gets recent matches and high level match statistics for a particular player

func (*Session) GetMatchPlayerDetails 

func (s *Session) GetMatchPlayerDetails(ctx context.Context, matchID int) ([]MatchPlayerDetails, error)

GetMatchPlayerDetails returns player information for a live match.

func (*Session) GetMatchidsByQueue 

func (s *Session) GetMatchidsByQueue(ctx context.Context, queue Queue, year int, month int, day int, hour int) ([]MatchQueueID, error)

GetMatchidsByQueue lists all Match IDs for a particular Match Queue; useful for API developers interested in constructing data by Queue. To limit the data returned, an {hour} parameter was added (valid values: 0 - 23). An {hour} parameter of -1 represents the entire day, but be warned that this may be more data than we can return for certain queues. Also, a returned “active_flag” means that there is no match information/stats for the corresponding match. Usually due to a match being in-progress, though there could be other reasons..

func (*Session) GetMotd 

func (s *Session) GetMotd(ctx context.Context) ([]MOTDResponse, error)

GetMotd returns information about the 20 most recent Match-of-the-Days.

func (*Session) GetPlayer 

func (s *Session) GetPlayer(ctx context.Context, player string) ([]GetPlayerResponse, error)

GetPlayer returns league and other high level data for a particular player

func (*Session) GetPlayerAchievements 

func (s *Session) GetPlayerAchievements(ctx context.Context, playerID int) (PlayerAchievements, error)

GetPlayerAchievements returns select achievement totals (Double kills, Tower Kills, First Bloods, etc) for the specified playerId.

func (*Session) GetPlayerStatus 

func (s *Session) GetPlayerStatus(ctx context.Context, player string) ([]PlayerStatus, error)

GetPlayerStatus returns player status

func (*Session) GetQueueStats 

func (s *Session) GetQueueStats(ctx context.Context, player string, queue Queue) ([]QueueStat, error)

GetQueueStats returns match summary statistics for a (player, queue) combination grouped by gods played.

func (*Session) GetTeamDetails 

func (s *Session) GetTeamDetails(ctx context.Context, teamid int) ([]TeamDetails, error)

GetTeamDetails lists the number of players and other high level details for a particular clan.

func (*Session) GetTeamPlayers 

func (s *Session) GetTeamPlayers(ctx context.Context, clanid int) ([]TeamPlayer, error)

GetTeamPlayers lists the players for a particular clan

func (*Session) GetTopMatches 

func (s *Session) GetTopMatches(ctx context.Context) ([]TopWatch, error)

GetTopMatches Lists the 50 most watched / most recent recorded matches.

func (*Session) SearchTeams 

func (s *Session) SearchTeams(ctx context.Context, searchTeam string) ([]TeamSearchRes, error)

SearchTeams returns high level information for Team names containing the “searchTeam” string.

func (*Session) TestSession 

func (s *Session) TestSession(ctx context.Context) (string, error)

TestSession is a means of validating that a session is established

type TeamDetails 

type TeamDetails struct {
	Founder   string `json:"Founder"`
	FounderID string `json:"FounderId"`
	Losses    int    `json:"Losses"`
	Name      string `json:"Name"`
	Players   int    `json:"Players"`
	Rating    int    `json:"Rating"`
	Tag       string `json:"Tag"`
	TeamID    int    `json:"TeamId"`
	Wins      int    `json:"Wins"`
	RetMsg    string `json:"ret_msg"`
}

TeamDetails is clan info for a player

type TeamPlayer 

type TeamPlayer struct {
	AccountLevel      int    `json:"AccountLevel"`
	JoinedDatetime    string `json:"JoinedDatetime"`
	LastLoginDatetime string `json:"LastLoginDatetime"`
	Name              string `json:"Name"`
	RetMsg            string `json:"ret_msg"`
}

TeamPlayer is player info inside a clan

type TeamSearchRes 

type TeamSearchRes struct {
	Founder string `json:"Founder"`
	Name    string `json:"Name"`
	Players int    `json:"Players"`
	Tag     string `json:"Tag"`
	TeamID  int    `json:"TeamId"`
	RetMsg  string `json:"ret_msg"`
}

TeamSearchRes is a clan search result

type Tier 

type Tier int

Tier is a player/queue ranking

type TopWatch 

type TopWatch struct {
	Ban1              string `json:"Ban1"`
	Ban1Id            int    `json:"Ban1Id"`
	Ban2              string `json:"Ban2"`
	Ban2Id            int    `json:"Ban2Id"`
	EntryDatetime     string `json:"Entry_Datetime"`
	LiveSpectators    int    `json:"LiveSpectators"`
	Match             int    `json:"Match"`
	MatchTime         int    `json:"Match_Time"`
	OfflineSpectators int    `json:"OfflineSpectators"`
	Queue             string `json:"Queue"`
	RecordingFinished string `json:"RecordingFinished"`
	RecordingStarted  string `json:"RecordingStarted"`
	Team1AvgLevel     int    `json:"Team1_AvgLevel"`
	Team1Gold         int    `json:"Team1_Gold"`
	Team1Kills        int    `json:"Team1_Kills"`
	Team1Score        int    `json:"Team1_Score"`
	Team2AvgLevel     int    `json:"Team2_AvgLevel"`
	Team2Gold         int    `json:"Team2_Gold"`
	Team2Kills        int    `json:"Team2_Kills"`
	Team2Score        int    `json:"Team2_Score"`
	WinningTeam       int    `json:"WinningTeam"`
	RetMsg            string `json:"ret_msg"`
}

TopWatch is a recent most watched match

Source Files

View all Source files

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.