lol

package
v2.4.0 Latest Latest
Warning

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

Go to latest
Published: Dec 9, 2024 License: MIT Imports: 7 Imported by: 0

Documentation

Overview

This package is used to interact with all LOL endpoints.

  • ChampionMasteryV4
  • ChampionV3
  • ClashV1
  • LeagueExpV4
  • LeagueV4
  • ChallengesV1
  • RsoMatchV1
  • StatusV4
  • MatchV5
  • SpectatorV5
  • SummonerV4
  • TournamentStubV5
  • TournamentV5

Note: this package is automatically generated.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ChallengesApexPlayerInfoV1DTO

type ChallengesApexPlayerInfoV1DTO struct {
	PUUID    string  `json:"puuid,omitempty"`
	Position int32   `json:"position,omitempty"`
	Value    float64 `json:"value,omitempty"`
}

lol-challenges-v1.ApexPlayerInfoDto

type ChallengesChallengeConfigInfoV1DTO

type ChallengesChallengeConfigInfoV1DTO struct {
	LocalizedNames map[string]map[string]string `json:"localizedNames,omitempty"`
	Thresholds     map[string]float64           `json:"thresholds,omitempty"`
	// DISABLED - not visible and not calculated, HIDDEN - not visible, but calculated, ENABLED - visible and calculated, ARCHIVED - visible, but not calculated
	State string `json:"state,omitempty"`
	// LIFETIME - stats are incremented without reset, SEASON - stats are accumulated by season and reset at the beginning of new season
	Tracking       string `json:"tracking,omitempty"`
	EndTimestamp   int64  `json:"endTimestamp,omitempty"`
	ID             int64  `json:"id,omitempty"`
	StartTimestamp int64  `json:"startTimestamp,omitempty"`
	Leaderboard    bool   `json:"leaderboard,omitempty"`
}

lol-challenges-v1.ChallengeConfigInfoDto

type ChallengesChallengeInfoV1DTO

type ChallengesChallengeInfoV1DTO struct {
	Level          Tier    `json:"level,omitempty"`
	AchievedTime   int64   `json:"achievedTime,omitempty"`
	ChallengeID    int64   `json:"challengeId,omitempty"`
	Percentile     float64 `json:"percentile,omitempty"`
	PlayersInLevel int64   `json:"playersInLevel,omitempty"`
	Position       int64   `json:"position,omitempty"`
	Value          float64 `json:"value,omitempty"`
}

lol-challenges-v1.ChallengeInfo

type ChallengesChallengePointsV1DTO

type ChallengesChallengePointsV1DTO struct {
	Level      Tier    `json:"level,omitempty"`
	Current    int64   `json:"current,omitempty"`
	Max        int64   `json:"max,omitempty"`
	Percentile float64 `json:"percentile,omitempty"`
}

lol-challenges-v1.ChallengePoints

type ChallengesLevelV1DTO

type ChallengesLevelV1DTO struct {
}

lol-challenges-v1.Level

type ChallengesPlayerClientPreferencesV1DTO

type ChallengesPlayerClientPreferencesV1DTO struct {
	BannerAccent             string  `json:"bannerAccent,omitempty"`
	CrestBorder              string  `json:"crestBorder,omitempty"`
	Title                    string  `json:"title,omitempty"`
	ChallengeIDs             []int64 `json:"challengeIds,omitempty"`
	PrestigeCrestBorderLevel int32   `json:"prestigeCrestBorderLevel,omitempty"`
}

lol-challenges-v1.PlayerClientPreferences

type ChallengesPlayerInfoV1DTO

type ChallengesPlayerInfoV1DTO struct {
	CategoryPoints map[string]ChallengesChallengePointsV1DTO `json:"categoryPoints,omitempty"`
	Challenges     []ChallengesChallengeInfoV1DTO            `json:"challenges,omitempty"`
	Preferences    ChallengesPlayerClientPreferencesV1DTO    `json:"preferences,omitempty"`
	TotalPoints    ChallengesChallengePointsV1DTO            `json:"totalPoints,omitempty"`
}

lol-challenges-v1.PlayerInfoDto

type ChallengesStateV1DTO

type ChallengesStateV1DTO struct {
}

lol-challenges-v1.State

type ChallengesTrackingV1DTO

type ChallengesTrackingV1DTO struct {
}

lol-challenges-v1.Tracking

type ChallengesV1

type ChallengesV1 struct {
	// contains filtered or unexported fields
}

Riot API Reference

lol-challenges-v1

func (*ChallengesV1) AllConfigs

func (endpoint *ChallengesV1) AllConfigs(ctx context.Context, route PlatformRoute) ([]ChallengesChallengeConfigInfoV1DTO, error)

List of all basic challenge configuration information (includes all translations for names and descriptions)

Parameters

  • route: Route to query.

Riot API Reference

lol-challenges-v1.getAllChallengeConfigs

func (*ChallengesV1) AllPercentiles

func (endpoint *ChallengesV1) AllPercentiles(ctx context.Context, route PlatformRoute) (map[int64]map[Tier]float64, error)

Map of level to percentile of players who have achieved it - keys: ChallengeId -> Season -> Level -> percentile of players who achieved it

Parameters

  • route: Route to query.

Riot API Reference

lol-challenges-v1.getAllChallengePercentiles

func (*ChallengesV1) ByPUUID

func (endpoint *ChallengesV1) ByPUUID(ctx context.Context, route PlatformRoute, puuid string) (*ChallengesPlayerInfoV1DTO, error)

Returns player information with list of all progressed challenges (REST)

Parameters

  • route: Route to query.
  • puuid

Riot API Reference

lol-challenges-v1.getPlayerData

func (*ChallengesV1) Configs

func (endpoint *ChallengesV1) Configs(ctx context.Context, route PlatformRoute, challengeId int64) (*ChallengesChallengeConfigInfoV1DTO, error)

Get challenge configuration (REST)

Parameters

  • route: Route to query.
  • challengeId

Riot API Reference

lol-challenges-v1.getChallengeConfigs

func (*ChallengesV1) Leaderboards

func (endpoint *ChallengesV1) Leaderboards(ctx context.Context, route PlatformRoute, challengeId int64, level Tier, limit int32) ([]ChallengesApexPlayerInfoV1DTO, error)

Return top players for each level. Level must be MASTER, GRANDMASTER or CHALLENGER.

Parameters

  • route: Route to query.
  • level
  • challengeId
  • limit (optional)

Riot API Reference

lol-challenges-v1.getChallengeLeaderboards

func (*ChallengesV1) Percentiles

func (endpoint *ChallengesV1) Percentiles(ctx context.Context, route PlatformRoute, challengeId int64) (map[Tier]float64, error)

Map of level to percentile of players who have achieved it

Parameters

  • route: Route to query.
  • challengeId

Riot API Reference

lol-challenges-v1.getChallengePercentiles

type ChampionMasteryNextSeasonMilestonesV4DTO

type ChampionMasteryNextSeasonMilestonesV4DTO struct {
	RequireGradeCounts map[string]int32 `json:"requireGradeCounts,omitempty"`
	// Reward configuration.
	RewardConfig ChampionMasteryRewardConfigV4DTO `json:"rewardConfig,omitempty"`
	// Reward marks.
	RewardMarks        int32 `json:"rewardMarks,omitempty"`
	TotalGamesRequires int32 `json:"totalGamesRequires,omitempty"`
	// Bonus.
	Bonus bool `json:"bonus,omitempty"`
}

champion-mastery-v4.NextSeasonMilestonesDto

type ChampionMasteryRewardConfigV4DTO

type ChampionMasteryRewardConfigV4DTO struct {
	// Reward type
	RewardType string `json:"rewardType,omitempty"`
	// Reward value
	RewardValue string `json:"rewardValue,omitempty"`
	// Maximun reward
	MaximumReward int32 `json:"maximumReward,omitempty"`
}

champion-mastery-v4.RewardConfigDto

type ChampionMasteryV4

type ChampionMasteryV4 struct {
	// contains filtered or unexported fields
}

Riot API Reference

champion-mastery-v4

func (*ChampionMasteryV4) AllMasteriesByPUUID

func (endpoint *ChampionMasteryV4) AllMasteriesByPUUID(ctx context.Context, route PlatformRoute, encryptedPUUID string) ([]ChampionMasteryV4DTO, error)

Get all champion mastery entries sorted by number of champion points descending.

Parameters

  • route: Route to query.
  • encryptedPUUID

Riot API Reference

champion-mastery-v4.getAllChampionMasteriesByPUUID

func (*ChampionMasteryV4) MasteryByPUUID

func (endpoint *ChampionMasteryV4) MasteryByPUUID(ctx context.Context, route PlatformRoute, encryptedPUUID string, championId int32) (*ChampionMasteryV4DTO, error)

Get a champion mastery by puuid and champion ID.

Parameters

  • route: Route to query.
  • encryptedPUUID
  • championId: Champion ID to retrieve Champion Mastery.

Riot API Reference

champion-mastery-v4.getChampionMasteryByPUUID

func (*ChampionMasteryV4) MasteryScoreByPUUID

func (endpoint *ChampionMasteryV4) MasteryScoreByPUUID(ctx context.Context, route PlatformRoute, encryptedPUUID string) (int32, error)

Get a player's total champion mastery score, which is the sum of individual champion mastery levels.

Parameters

  • route: Route to query.
  • encryptedPUUID

Riot API Reference

champion-mastery-v4.getChampionMasteryScoreByPUUID

func (*ChampionMasteryV4) TopMasteriesByPUUID

func (endpoint *ChampionMasteryV4) TopMasteriesByPUUID(ctx context.Context, route PlatformRoute, encryptedPUUID string, count int32) ([]ChampionMasteryV4DTO, error)

Get specified number of top champion mastery entries sorted by number of champion points descending.

Parameters

  • route: Route to query.
  • encryptedPUUID
  • count (optional): Number of entries to retrieve, defaults to 3.

Riot API Reference

champion-mastery-v4.getTopChampionMasteriesByPUUID

type ChampionMasteryV4DTO

type ChampionMasteryV4DTO struct {
	// Player Universal Unique Identifier. Exact length of 78 characters. (Encrypted)
	PUUID               string                                   `json:"puuid,omitempty"`
	MilestoneGrades     []string                                 `json:"milestoneGrades,omitempty"`
	NextSeasonMilestone ChampionMasteryNextSeasonMilestonesV4DTO `json:"nextSeasonMilestone,omitempty"`
	// Champion ID for this entry.
	ChampionID int64 `json:"championId,omitempty"`
	// Number of points earned since current level has been achieved.
	ChampionPointsSinceLastLevel int64 `json:"championPointsSinceLastLevel,omitempty"`
	// Number of points needed to achieve next level. Zero if player reached maximum champion level for this champion.
	ChampionPointsUntilNextLevel int64 `json:"championPointsUntilNextLevel,omitempty"`
	// Last time this champion was played by this player - in Unix milliseconds time format.
	LastPlayTime int64 `json:"lastPlayTime,omitempty"`
	// Champion level for specified player and champion combination.
	ChampionLevel int32 `json:"championLevel,omitempty"`
	// Total number of champion points for this player and champion combination - they are used to determine championLevel.
	ChampionPoints           int32 `json:"championPoints,omitempty"`
	ChampionSeasonMilestone  int32 `json:"championSeasonMilestone,omitempty"`
	MarkRequiredForNextLevel int32 `json:"markRequiredForNextLevel,omitempty"`
	// The token earned for this champion at the current championLevel. When the championLevel is advanced the tokensEarned resets to 0.
	TokensEarned int32 `json:"tokensEarned,omitempty"`
	// Is chest granted for this champion or not in current season.
	ChestGranted bool `json:"chestGranted,omitempty"`
}

champion-mastery-v4.ChampionMasteryDto

type ChampionRotationV3DTO

type ChampionRotationV3DTO struct {
	FreeChampionIDs              []int32 `json:"freeChampionIds,omitempty"`
	FreeChampionIDsForNewPlayers []int32 `json:"freeChampionIdsForNewPlayers,omitempty"`
	MaxNewPlayerLevel            int32   `json:"maxNewPlayerLevel,omitempty"`
}

champion-v3.ChampionInfo

type ChampionV3

type ChampionV3 struct {
	// contains filtered or unexported fields
}

Riot API Reference

champion-v3

func (*ChampionV3) Rotation

func (endpoint *ChampionV3) Rotation(ctx context.Context, route PlatformRoute) (*ChampionRotationV3DTO, error)

Returns champion rotations, including free-to-play and low-level free-to-play rotations (REST)

Parameters

  • route: Route to query.

Riot API Reference

champion-v3.getChampionInfo

type ClashPlayerV1DTO

type ClashPlayerV1DTO struct {
	// (Legal values:  UNSELECTED,  FILL,  TOP,  JUNGLE,  MIDDLE,  BOTTOM,  UTILITY)
	Position string `json:"position,omitempty"`
	// (Legal values:  CAPTAIN,  MEMBER)
	Role       string `json:"role,omitempty"`
	SummonerID string `json:"summonerId,omitempty"`
	TeamID     string `json:"teamId,omitempty"`
}

clash-v1.PlayerDto

type ClashTeamV1DTO

type ClashTeamV1DTO struct {
	Abbreviation string `json:"abbreviation,omitempty"`
	// Summoner ID of the team captain.
	Captain string `json:"captain,omitempty"`
	ID      string `json:"id,omitempty"`
	Name    string `json:"name,omitempty"`
	// Team members.
	Players      []ClashPlayerV1DTO `json:"players,omitempty"`
	IconID       int32              `json:"iconId,omitempty"`
	Tier         int32              `json:"tier,omitempty"`
	TournamentID int32              `json:"tournamentId,omitempty"`
}

clash-v1.TeamDto

type ClashTournamentPhaseV1DTO

type ClashTournamentPhaseV1DTO struct {
	Cancelled        bool  `json:"cancelled,omitempty"`
	ID               int32 `json:"id,omitempty"`
	RegistrationTime int64 `json:"registrationTime,omitempty"`
	StartTime        int64 `json:"startTime,omitempty"`
}

clash-v1.TournamentPhaseDto

type ClashTournamentV1DTO

type ClashTournamentV1DTO struct {
	NameKey          string `json:"nameKey,omitempty"`
	NameKeySecondary string `json:"nameKeySecondary,omitempty"`
	// Tournament phase.
	Schedule []ClashTournamentPhaseV1DTO `json:"schedule,omitempty"`
	ID       int32                       `json:"id,omitempty"`
	ThemeID  int32                       `json:"themeId,omitempty"`
}

clash-v1.TournamentDto

type ClashV1

type ClashV1 struct {
	// contains filtered or unexported fields
}

Riot API Reference

clash-v1

func (*ClashV1) ByID

func (endpoint *ClashV1) ByID(ctx context.Context, route PlatformRoute, tournamentId int32) (*ClashTournamentV1DTO, error)

Get tournament by ID.

Parameters

  • route: Route to query.
  • tournamentId

Riot API Reference

clash-v1.getTournamentById

func (*ClashV1) ByTeamID

func (endpoint *ClashV1) ByTeamID(ctx context.Context, route PlatformRoute, teamId string) (*ClashTournamentV1DTO, error)

Get tournament by team ID.

Parameters

  • route: Route to query.
  • teamId

Riot API Reference

clash-v1.getTournamentByTeam

func (*ClashV1) SummonerEntriesBySummonerID

func (endpoint *ClashV1) SummonerEntriesBySummonerID(ctx context.Context, route PlatformRoute, summonerId string) ([]ClashPlayerV1DTO, error)

Get players by summoner ID.

Implementation Notes

This endpoint returns a list of active Clash players for a given summoner ID. If a summoner registers for multiple tournaments at the same time (e.g., Saturday and Sunday) then both registrations would appear in this list.

Parameters

  • route: Route to query.
  • summonerId

Riot API Reference

clash-v1.getPlayersBySummoner

func (*ClashV1) TeamByTeamID

func (endpoint *ClashV1) TeamByTeamID(ctx context.Context, route PlatformRoute, teamId string) (*ClashTeamV1DTO, error)

Get team by ID.

Parameters

  • route: Route to query.
  • teamId

Riot API Reference

clash-v1.getTeamById

func (*ClashV1) Tournaments

func (endpoint *ClashV1) Tournaments(ctx context.Context, route PlatformRoute) ([]ClashTournamentV1DTO, error)

Get all active or upcoming tournaments.

Parameters

  • route: Route to query.

Riot API Reference

clash-v1.getTournaments

type Client

type Client struct {
	ChampionMasteryV4 ChampionMasteryV4
	ChampionV3        ChampionV3
	ClashV1           ClashV1
	LeagueExpV4       LeagueExpV4
	LeagueV4          LeagueV4
	ChallengesV1      ChallengesV1
	RsoMatchV1        RsoMatchV1
	StatusV4          StatusV4
	MatchV5           MatchV5
	SpectatorV5       SpectatorV5
	SummonerV4        SummonerV4
	TournamentStubV5  TournamentStubV5
	TournamentV5      TournamentV5
}

func NewLOLClient

func NewLOLClient(client *internal.Client) *Client

Creates a new LOL Client using the internal.Client provided.

type Division

type Division string

League of Legends rank divisions, I, II, III, IV, and (deprecated) V.

const (
	I   Division = "I"
	II  Division = "II"
	III Division = "III"
	IV  Division = "IV"
	// # Deprecated
	V Division = "V"
)

func (Division) String

func (division Division) String() string

type GameMode

type GameMode string

League of Legends game modes, such as Classic, ARAM, URF, One For All, Ascension, etc.

const (
	// ARAM games
	ARAM_GAMEMODE GameMode = "ARAM"
	// All Random Summoner's Rift games
	ARSR_GAMEMODE GameMode = "ARSR"
	// Ascension games
	ASCENSION_GAMEMODE GameMode = "ASCENSION"
	// Blood Hunt Assassin games
	ASSASSINATE_GAMEMODE GameMode = "ASSASSINATE"
	// 2v2v2v2 Arena
	CHERRY_GAMEMODE GameMode = "CHERRY"
	// Classic Summoner's Rift and Twisted Treeline games
	CLASSIC_GAMEMODE GameMode = "CLASSIC"
	// Dark Star: Singularity games
	DARKSTAR_GAMEMODE GameMode = "DARKSTAR"
	// Doom Bot games
	DOOMBOTSTEEMO_GAMEMODE GameMode = "DOOMBOTSTEEMO"
	// Snowdown Showdown games
	FIRSTBLOOD_GAMEMODE GameMode = "FIRSTBLOOD"
	// Nexus Blitz games
	GAMEMODEX_GAMEMODE GameMode = "GAMEMODEX"
	// Legend of the Poro King games
	KINGPORO_GAMEMODE GameMode = "KINGPORO"
	// Nexus Blitz games
	NEXUSBLITZ_GAMEMODE GameMode = "NEXUSBLITZ"
	// Dominion/Crystal Scar games
	ODIN_GAMEMODE GameMode = "ODIN"
	// Odyssey: Extraction games
	ODYSSEY_GAMEMODE GameMode = "ODYSSEY"
	// One for All games
	ONEFORALL_GAMEMODE GameMode = "ONEFORALL"
	// Practice tool training games.
	PRACTICETOOL_GAMEMODE GameMode = "PRACTICETOOL"
	// PROJECT: Hunters games
	PROJECT_GAMEMODE GameMode = "PROJECT"
	// Nexus Siege games
	SIEGE_GAMEMODE GameMode = "SIEGE"
	// Star Guardian Invasion games
	STARGUARDIAN_GAMEMODE GameMode = "STARGUARDIAN"
	// Swarm
	STRAWBERRY_GAMEMODE GameMode = "STRAWBERRY"
	// Tutorial games
	TUTORIAL_GAMEMODE GameMode = "TUTORIAL"
	// Tutorial: Welcome to League.
	TUTORIAL_MODULE_1_GAMEMODE GameMode = "TUTORIAL_MODULE_1"
	// Tutorial: Power Up.
	TUTORIAL_MODULE_2_GAMEMODE GameMode = "TUTORIAL_MODULE_2"
	// Tutorial: Shop for Gear.
	TUTORIAL_MODULE_3_GAMEMODE GameMode = "TUTORIAL_MODULE_3"
	// Ultimate Spellbook games
	ULTBOOK_GAMEMODE GameMode = "ULTBOOK"
	// URF games
	URF_GAMEMODE GameMode = "URF"
)

func (GameMode) String

func (gameMode GameMode) String() string

type GameType

type GameType string

League of Legends game types: matched game, custom game, or tutorial game.

const (
	// Custom games
	CUSTOM_GAME_GAMETYPE GameType = "CUSTOM"
	// all other games
	MATCHED_GAME_GAMETYPE GameType = "MATCHED"
	// Tutorial games
	TUTORIAL_GAME_GAMETYPE GameType = "TUTORIAL"
)

func (GameType) String

func (gameType GameType) String() string

type LeagueEntryV4DTO

type LeagueEntryV4DTO struct {
	LeagueID  string    `json:"leagueId,omitempty"`
	QueueType QueueType `json:"queueType,omitempty"`
	// The player's division within a tier.
	Rank Division `json:"rank,omitempty"`
	// Player's encrypted summonerId.
	SummonerID   string                `json:"summonerId,omitempty"`
	Tier         Tier                  `json:"tier,omitempty"`
	MiniSeries   LeagueMiniSeriesV4DTO `json:"miniSeries,omitempty"`
	LeaguePoints int32                 `json:"leaguePoints,omitempty"`
	// Losing team on Summoners Rift.
	Losses int32 `json:"losses,omitempty"`
	// Winning team on Summoners Rift.
	Wins       int32 `json:"wins,omitempty"`
	FreshBlood bool  `json:"freshBlood,omitempty"`
	HotStreak  bool  `json:"hotStreak,omitempty"`
	Inactive   bool  `json:"inactive,omitempty"`
	Veteran    bool  `json:"veteran,omitempty"`
}

league-v4.LeagueEntryDTO

type LeagueExpLeagueEntryV4DTO

type LeagueExpLeagueEntryV4DTO struct {
	LeagueID  string    `json:"leagueId,omitempty"`
	QueueType QueueType `json:"queueType,omitempty"`
	// The player's division within a tier.
	Rank Division `json:"rank,omitempty"`
	// Player's summonerId (Encrypted)
	SummonerID   string                   `json:"summonerId,omitempty"`
	Tier         Tier                     `json:"tier,omitempty"`
	MiniSeries   LeagueExpMiniSeriesV4DTO `json:"miniSeries,omitempty"`
	LeaguePoints int32                    `json:"leaguePoints,omitempty"`
	// Losing team on Summoners Rift. Second through eighth placement in Teamfight Tactics.
	Losses int32 `json:"losses,omitempty"`
	// Winning team on Summoners Rift. First placement in Teamfight Tactics.
	Wins       int32 `json:"wins,omitempty"`
	FreshBlood bool  `json:"freshBlood,omitempty"`
	HotStreak  bool  `json:"hotStreak,omitempty"`
	Inactive   bool  `json:"inactive,omitempty"`
	Veteran    bool  `json:"veteran,omitempty"`
}

league-exp-v4.LeagueEntryDTO

type LeagueExpMiniSeriesV4DTO

type LeagueExpMiniSeriesV4DTO struct {
	Progress string `json:"progress,omitempty"`
	Losses   int32  `json:"losses,omitempty"`
	Target   int32  `json:"target,omitempty"`
	Wins     int32  `json:"wins,omitempty"`
}

league-exp-v4.MiniSeriesDTO

type LeagueExpV4

type LeagueExpV4 struct {
	// contains filtered or unexported fields
}

Riot API Reference

league-exp-v4

func (*LeagueExpV4) Entries

func (endpoint *LeagueExpV4) Entries(ctx context.Context, route PlatformRoute, queue QueueType, tier Tier, division Division, page int32) ([]LeagueExpLeagueEntryV4DTO, error)

Get all the league entries.

Parameters

  • route: Route to query.
  • queue: Note that the queue value must be a valid ranked queue.
  • tier
  • division
  • page (optional): Defaults to 1. Starts with page 1.

Riot API Reference

league-exp-v4.getLeagueEntries

type LeagueItemV4DTO

type LeagueItemV4DTO struct {
	Rank Division `json:"rank,omitempty"`
	// Player's encrypted summonerId.
	SummonerID   string                `json:"summonerId,omitempty"`
	MiniSeries   LeagueMiniSeriesV4DTO `json:"miniSeries,omitempty"`
	LeaguePoints int32                 `json:"leaguePoints,omitempty"`
	// Losing team on Summoners Rift.
	Losses int32 `json:"losses,omitempty"`
	// Winning team on Summoners Rift.
	Wins       int32 `json:"wins,omitempty"`
	FreshBlood bool  `json:"freshBlood,omitempty"`
	HotStreak  bool  `json:"hotStreak,omitempty"`
	Inactive   bool  `json:"inactive,omitempty"`
	Veteran    bool  `json:"veteran,omitempty"`
}

league-v4.LeagueItemDTO

type LeagueListV4DTO

type LeagueListV4DTO struct {
	LeagueID string            `json:"leagueId,omitempty"`
	Name     string            `json:"name,omitempty"`
	Queue    QueueType         `json:"queue,omitempty"`
	Tier     Tier              `json:"tier,omitempty"`
	Entries  []LeagueItemV4DTO `json:"entries,omitempty"`
}

league-v4.LeagueListDTO

type LeagueMiniSeriesV4DTO

type LeagueMiniSeriesV4DTO struct {
	Progress string `json:"progress,omitempty"`
	Losses   int32  `json:"losses,omitempty"`
	Target   int32  `json:"target,omitempty"`
	Wins     int32  `json:"wins,omitempty"`
}

league-v4.MiniSeriesDTO

type LeagueV4

type LeagueV4 struct {
	// contains filtered or unexported fields
}

Riot API Reference

league-v4

func (*LeagueV4) ByID

func (endpoint *LeagueV4) ByID(ctx context.Context, route PlatformRoute, leagueId string) (*LeagueListV4DTO, error)

Get league with given ID, including inactive entries.

Parameters

  • route: Route to query.
  • leagueId: The UUID of the league.

Riot API Reference

league-v4.getLeagueById

func (*LeagueV4) ChallengerByQueue

func (endpoint *LeagueV4) ChallengerByQueue(ctx context.Context, route PlatformRoute, queue QueueType) (*LeagueListV4DTO, error)

Get the challenger league for given queue.

Parameters

  • route: Route to query.
  • queue

Riot API Reference

league-v4.getChallengerLeague

func (*LeagueV4) Entries

func (endpoint *LeagueV4) Entries(ctx context.Context, route PlatformRoute, queue QueueType, tier Tier, division Division, page int32) ([]LeagueEntryV4DTO, error)

Get all the league entries.

Parameters

  • route: Route to query.
  • division
  • tier
  • queue: Note that the queue value must be a valid ranked queue.
  • page (optional): Defaults to 1. Starts with page 1.

Riot API Reference

league-v4.getLeagueEntries

func (*LeagueV4) GrandmasterByQueue

func (endpoint *LeagueV4) GrandmasterByQueue(ctx context.Context, route PlatformRoute, queue QueueType) (*LeagueListV4DTO, error)

Get the grandmaster league of a specific queue.

Parameters

  • route: Route to query.
  • queue

Riot API Reference

league-v4.getGrandmasterLeague

func (*LeagueV4) MasterByQueue

func (endpoint *LeagueV4) MasterByQueue(ctx context.Context, route PlatformRoute, queue QueueType) (*LeagueListV4DTO, error)

Get the master league for given queue.

Parameters

  • route: Route to query.
  • queue

Riot API Reference

league-v4.getMasterLeague

func (*LeagueV4) SummonerEntries

func (endpoint *LeagueV4) SummonerEntries(ctx context.Context, route PlatformRoute, encryptedSummonerId string) ([]LeagueEntryV4DTO, error)

Get league entries in all queues for a given summoner ID.

Parameters

  • route: Route to query.
  • encryptedSummonerId

Riot API Reference

league-v4.getLeagueEntriesForSummoner

type Map

type Map int64

League of Legends maps.

const (
	// Arena
	//
	// Map for 2v2v2v2 (`CHERRY`). Team up with a friend or venture solo in this new game mode. Face against multiple teams in chaotic battles across diverse arenas
	ARENA_MAP Map = 30
	// Butcher's Bridge
	//
	// Alternate ARAM map
	BUTCHERS_BRIDGE_MAP Map = 14
	// Cosmic Ruins
	//
	// Dark Star: Singularity map
	COSMIC_RUINS_MAP Map = 16
	// Crash Site
	//
	// Odyssey: Extraction map
	CRASH_SITE_MAP Map = 20
	// Howling Abyss
	//
	// ARAM map
	HOWLING_ABYSS_MAP Map = 12
	// Nexus Blitz
	//
	// Nexus Blitz map
	NEXUS_BLITZ_MAP Map = 21
	// Substructure 43
	//
	// PROJECT: Hunters map
	SUBSTRUCTURE_43_MAP Map = 19
	// Summoner's Rift
	//
	// Current Version
	SUMMONERS_RIFT_MAP Map = 11
	// # Deprecated
	//
	// Summoner's Rift
	//
	// Original Autumn variant
	SUMMONERS_RIFT_ORIGINAL_AUTUMN_VARIANT_MAP Map = 2
	// # Deprecated
	//
	// Summoner's Rift
	//
	// Original Summer variant
	SUMMONERS_RIFT_ORIGINAL_SUMMER_VARIANT_MAP Map = 1
	// Swarm
	//
	// Map for Swarm (`STRAWBERRY`). Team up with a friend or venture solo in this horde survival mode.
	SWARM_MAP Map = 33
	// The Crystal Scar
	//
	// Dominion map
	THE_CRYSTAL_SCAR_MAP Map = 8
	// The Proving Grounds
	//
	// Tutorial Map
	THE_PROVING_GROUNDS_MAP Map = 3
	// Twisted Treeline
	//
	// Last TT map
	TWISTED_TREELINE_MAP Map = 10
	// # Deprecated
	//
	// Twisted Treeline
	//
	// Original Version
	TWISTED_TREELINE_ORIGINAL_VERSION_MAP Map = 4
	// Valoran City Park
	//
	// Star Guardian Invasion map
	VALORAN_CITY_PARK_MAP Map = 18
)

func (Map) String

func (gameMap Map) String() string

type MatchBanV5DTO

type MatchBanV5DTO struct {
	ChampionID int32 `json:"championId,omitempty"`
	PickTurn   int32 `json:"pickTurn,omitempty"`
}

match-v5.BanDto

type MatchChallengesV5DTO

type MatchChallengesV5DTO struct {
	LegendaryItemUsed                         []int32 `json:"legendaryItemUsed,omitempty"`
	AlliedJungleMonsterKills                  float64 `json:"alliedJungleMonsterKills,omitempty"`
	BaronBuffGoldAdvantageOverThreshold       float64 `json:"baronBuffGoldAdvantageOverThreshold,omitempty"`
	ControlWardTimeCoverageInRiverOrEnemyHalf float64 `json:"controlWardTimeCoverageInRiverOrEnemyHalf,omitempty"`
	DamagePerMinute                           float64 `json:"damagePerMinute,omitempty"`
	DamageTakenOnTeamPercentage               float64 `json:"damageTakenOnTeamPercentage,omitempty"`
	EarliestBaron                             float64 `json:"earliestBaron,omitempty"`
	EarliestDragonTakedown                    float64 `json:"earliestDragonTakedown,omitempty"`
	EarliestElderDragon                       float64 `json:"earliestElderDragon,omitempty"`
	EarlyLaningPhaseGoldExpAdvantage          float64 `json:"earlyLaningPhaseGoldExpAdvantage,omitempty"`
	EnemyJungleMonsterKills                   float64 `json:"enemyJungleMonsterKills,omitempty"`
	FasterSupportQuestCompletion              float64 `json:"fasterSupportQuestCompletion,omitempty"`
	FastestLegendary                          float64 `json:"fastestLegendary,omitempty"`
	FirstTurretKilled                         float64 `json:"firstTurretKilled,omitempty"`
	GameLength                                float64 `json:"gameLength,omitempty"`
	GoldPerMinute                             float64 `json:"goldPerMinute,omitempty"`
	HadAfkTeammate                            float64 `json:"hadAfkTeammate,omitempty"`
	HighestChampionDamage                     float64 `json:"highestChampionDamage,omitempty"`
	HighestCrowdControlScore                  float64 `json:"highestCrowdControlScore,omitempty"`
	HighestWardKills                          float64 `json:"highestWardKills,omitempty"`
	InfernalScalePickup                       float64 `json:"InfernalScalePickup,omitempty"`
	JungleCsBefore10Minutes                   float64 `json:"jungleCsBefore10Minutes,omitempty"`
	JunglerKillsEarlyJungle                   float64 `json:"junglerKillsEarlyJungle,omitempty"`
	Kda                                       float64 `json:"kda,omitempty"`
	KillParticipation                         float64 `json:"killParticipation,omitempty"`
	KillsOnLanersEarlyJungleAsJungler         float64 `json:"killsOnLanersEarlyJungleAsJungler,omitempty"`
	LaningPhaseGoldExpAdvantage               float64 `json:"laningPhaseGoldExpAdvantage,omitempty"`
	LegendaryCount                            float64 `json:"legendaryCount,omitempty"`
	MaxCsAdvantageOnLaneOpponent              float64 `json:"maxCsAdvantageOnLaneOpponent,omitempty"`
	MaxLevelLeadLaneOpponent                  float64 `json:"maxLevelLeadLaneOpponent,omitempty"`
	MoreEnemyJungleThanOpponent               float64 `json:"moreEnemyJungleThanOpponent,omitempty"`
	MostWardsDestroyedOneSweeper              float64 `json:"mostWardsDestroyedOneSweeper,omitempty"`
	MythicItemUsed                            float64 `json:"mythicItemUsed,omitempty"`
	PlayedChampSelectPosition                 float64 `json:"playedChampSelectPosition,omitempty"`
	SoloTurretsLategame                       float64 `json:"soloTurretsLategame,omitempty"`
	TakedownsFirst25Minutes                   float64 `json:"takedownsFirst25Minutes,omitempty"`
	TeamDamagePercentage                      float64 `json:"teamDamagePercentage,omitempty"`
	TeleportTakedowns                         float64 `json:"teleportTakedowns,omitempty"`
	ThirdInhibitorDestroyedTime               float64 `json:"thirdInhibitorDestroyedTime,omitempty"`
	ThreeWardsOneSweeperCount                 float64 `json:"threeWardsOneSweeperCount,omitempty"`
	VisionScoreAdvantageLaneOpponent          float64 `json:"visionScoreAdvantageLaneOpponent,omitempty"`
	VisionScorePerMinute                      float64 `json:"visionScorePerMinute,omitempty"`
	AbilityUses                               int32   `json:"abilityUses,omitempty"`
	AcesBefore15Minutes                       int32   `json:"acesBefore15Minutes,omitempty"`
	BaronTakedowns                            int32   `json:"baronTakedowns,omitempty"`
	BlastConeOppositeOpponentCount            int32   `json:"blastConeOppositeOpponentCount,omitempty"`
	BountyGold                                float32 `json:"bountyGold,omitempty"`
	BuffsStolen                               int32   `json:"buffsStolen,omitempty"`
	CompleteSupportQuestInTime                int32   `json:"completeSupportQuestInTime,omitempty"`
	ControlWardsPlaced                        int32   `json:"controlWardsPlaced,omitempty"`
	DancedWithRiftHerald                      int32   `json:"dancedWithRiftHerald,omitempty"`
	DeathsByEnemyChamps                       int32   `json:"deathsByEnemyChamps,omitempty"`
	DodgeSkillShotsSmallWindow                int32   `json:"dodgeSkillShotsSmallWindow,omitempty"`
	DoubleAces                                int32   `json:"doubleAces,omitempty"`
	DragonTakedowns                           int32   `json:"dragonTakedowns,omitempty"`
	EffectiveHealAndShielding                 float32 `json:"effectiveHealAndShielding,omitempty"`
	ElderDragonKillsWithOpposingSoul          int32   `json:"elderDragonKillsWithOpposingSoul,omitempty"`
	ElderDragonMultikills                     int32   `json:"elderDragonMultikills,omitempty"`
	EnemyChampionImmobilizations              int32   `json:"enemyChampionImmobilizations,omitempty"`
	EpicMonsterKillsNearEnemyJungler          int32   `json:"epicMonsterKillsNearEnemyJungler,omitempty"`
	EpicMonsterKillsWithin30SecondsOfSpawn    int32   `json:"epicMonsterKillsWithin30SecondsOfSpawn,omitempty"`
	EpicMonsterSteals                         int32   `json:"epicMonsterSteals,omitempty"`
	EpicMonsterStolenWithoutSmite             int32   `json:"epicMonsterStolenWithoutSmite,omitempty"`
	FirstTurretKilledTime                     float32 `json:"firstTurretKilledTime,omitempty"`
	FistBumpParticipation                     int32   `json:"fistBumpParticipation,omitempty"`
	FlawlessAces                              int32   `json:"flawlessAces,omitempty"`
	FullTeamTakedown                          int32   `json:"fullTeamTakedown,omitempty"`
	GetTakedownsInAllLanesEarlyJungleAsLaner  int32   `json:"getTakedownsInAllLanesEarlyJungleAsLaner,omitempty"`
	HadOpenNexus                              int32   `json:"hadOpenNexus,omitempty"`
	ImmobilizeAndKillWithAlly                 int32   `json:"immobilizeAndKillWithAlly,omitempty"`
	InitialBuffCount                          int32   `json:"initialBuffCount,omitempty"`
	InitialCrabCount                          int32   `json:"initialCrabCount,omitempty"`
	JunglerTakedownsNearDamagedEpicMonster    int32   `json:"junglerTakedownsNearDamagedEpicMonster,omitempty"`
	KTurretsDestroyedBeforePlatesFall         int32   `json:"kTurretsDestroyedBeforePlatesFall,omitempty"`
	KillAfterHiddenWithAlly                   int32   `json:"killAfterHiddenWithAlly,omitempty"`
	KilledChampTookFullTeamDamageSurvived     int32   `json:"killedChampTookFullTeamDamageSurvived,omitempty"`
	KillingSprees                             int32   `json:"killingSprees,omitempty"`
	KillsNearEnemyTurret                      int32   `json:"killsNearEnemyTurret,omitempty"`
	KillsOnOtherLanesEarlyJungleAsLaner       int32   `json:"killsOnOtherLanesEarlyJungleAsLaner,omitempty"`
	KillsOnRecentlyHealedByAramPack           int32   `json:"killsOnRecentlyHealedByAramPack,omitempty"`
	KillsUnderOwnTurret                       int32   `json:"killsUnderOwnTurret,omitempty"`
	KillsWithHelpFromEpicMonster              int32   `json:"killsWithHelpFromEpicMonster,omitempty"`
	KnockEnemyIntoTeamAndKill                 int32   `json:"knockEnemyIntoTeamAndKill,omitempty"`
	LandSkillShotsEarlyGame                   int32   `json:"landSkillShotsEarlyGame,omitempty"`
	LaneMinionsFirst10Minutes                 int32   `json:"laneMinionsFirst10Minutes,omitempty"`
	LostAnInhibitor                           int32   `json:"lostAnInhibitor,omitempty"`
	MaxKillDeficit                            int32   `json:"maxKillDeficit,omitempty"`
	MejaisFullStackInTime                     int32   `json:"mejaisFullStackInTime,omitempty"`
	// This is an offshoot of the OneStone challenge. The code checks if a spell with the same instance ID does the final point of damage to at least 2 Champions. It doesn't matter if they're enemies, but you cannot hurt your friends.
	MultiKillOneSpell                   int32   `json:"multiKillOneSpell,omitempty"`
	MultiTurretRiftHeraldCount          int32   `json:"multiTurretRiftHeraldCount,omitempty"`
	Multikills                          int32   `json:"multikills,omitempty"`
	MultikillsAfterAggressiveFlash      int32   `json:"multikillsAfterAggressiveFlash,omitempty"`
	OuterTurretExecutesBefore10Minutes  int32   `json:"outerTurretExecutesBefore10Minutes,omitempty"`
	OutnumberedKills                    int32   `json:"outnumberedKills,omitempty"`
	OutnumberedNexusKill                int32   `json:"outnumberedNexusKill,omitempty"`
	PerfectDragonSoulsTaken             int32   `json:"perfectDragonSoulsTaken,omitempty"`
	PerfectGame                         int32   `json:"perfectGame,omitempty"`
	PickKillWithAlly                    int32   `json:"pickKillWithAlly,omitempty"`
	PoroExplosions                      int32   `json:"poroExplosions,omitempty"`
	QuickCleanse                        int32   `json:"quickCleanse,omitempty"`
	QuickFirstTurret                    int32   `json:"quickFirstTurret,omitempty"`
	QuickSoloKills                      int32   `json:"quickSoloKills,omitempty"`
	RiftHeraldTakedowns                 int32   `json:"riftHeraldTakedowns,omitempty"`
	SaveAllyFromDeath                   int32   `json:"saveAllyFromDeath,omitempty"`
	ScuttleCrabKills                    int32   `json:"scuttleCrabKills,omitempty"`
	ShortestTimeToAceFromFirstTakedown  float32 `json:"shortestTimeToAceFromFirstTakedown,omitempty"`
	SkillshotsDodged                    int32   `json:"skillshotsDodged,omitempty"`
	SkillshotsHit                       int32   `json:"skillshotsHit,omitempty"`
	SnowballsHit                        int32   `json:"snowballsHit,omitempty"`
	SoloBaronKills                      int32   `json:"soloBaronKills,omitempty"`
	SoloKills                           int32   `json:"soloKills,omitempty"`
	StealthWardsPlaced                  int32   `json:"stealthWardsPlaced,omitempty"`
	SurvivedSingleDigitHpCount          int32   `json:"survivedSingleDigitHpCount,omitempty"`
	SurvivedThreeImmobilizesInFight     int32   `json:"survivedThreeImmobilizesInFight,omitempty"`
	SwarmDefeatAatrox                   int32   `json:"SWARM_DefeatAatrox,omitempty"`
	SwarmDefeatBriar                    int32   `json:"SWARM_DefeatBriar,omitempty"`
	SwarmDefeatMiniBosses               int32   `json:"SWARM_DefeatMiniBosses,omitempty"`
	SwarmEvolveWeapon                   int32   `json:"SWARM_EvolveWeapon,omitempty"`
	SwarmHave3Passives                  int32   `json:"SWARM_Have3Passives,omitempty"`
	SwarmKillEnemy                      int32   `json:"SWARM_KillEnemy,omitempty"`
	SwarmPickupGold                     int32   `json:"SWARM_PickupGold,omitempty"`
	SwarmReachLevel50                   int32   `json:"SWARM_ReachLevel50,omitempty"`
	SwarmSurvive15Min                   int32   `json:"SWARM_Survive15Min,omitempty"`
	SwarmWinWith5EvolvedWeapons         int32   `json:"SWARM_WinWith5EvolvedWeapons,omitempty"`
	TakedownOnFirstTurret               int32   `json:"takedownOnFirstTurret,omitempty"`
	Takedowns                           int32   `json:"takedowns,omitempty"`
	TakedownsAfterGainingLevelAdvantage int32   `json:"takedownsAfterGainingLevelAdvantage,omitempty"`
	TakedownsBeforeJungleMinionSpawn    int32   `json:"takedownsBeforeJungleMinionSpawn,omitempty"`
	TakedownsFirstXMinutes              int32   `json:"takedownsFirstXMinutes,omitempty"`
	TakedownsInAlcove                   int32   `json:"takedownsInAlcove,omitempty"`
	TakedownsInEnemyFountain            int32   `json:"takedownsInEnemyFountain,omitempty"`
	TeamBaronKills                      int32   `json:"teamBaronKills,omitempty"`
	TeamElderDragonKills                int32   `json:"teamElderDragonKills,omitempty"`
	TeamRiftHeraldKills                 int32   `json:"teamRiftHeraldKills,omitempty"`
	TookLargeDamageSurvived             int32   `json:"tookLargeDamageSurvived,omitempty"`
	TurretPlatesTaken                   int32   `json:"turretPlatesTaken,omitempty"`
	TurretTakedowns                     int32   `json:"turretTakedowns,omitempty"`
	// Any player who damages a tower that is destroyed within 30 seconds of a Rift Herald charge will receive credit. A player who does not damage the tower will not receive credit.
	TurretsTakenWithRiftHerald   int32 `json:"turretsTakenWithRiftHerald,omitempty"`
	TwentyMinionsIn3SecondsCount int32 `json:"twentyMinionsIn3SecondsCount,omitempty"`
	TwoWardsOneSweeperCount      int32 `json:"twoWardsOneSweeperCount,omitempty"`
	UnseenRecalls                int32 `json:"unseenRecalls,omitempty"`
	VoidMonsterKill              int32 `json:"voidMonsterKill,omitempty"`
	WardTakedowns                int32 `json:"wardTakedowns,omitempty"`
	WardTakedownsBefore20M       int32 `json:"wardTakedownsBefore20M,omitempty"`
	WardsGuarded                 int32 `json:"wardsGuarded,omitempty"`
	X12AssistStreakCount         int32 `json:"12AssistStreakCount,omitempty"`
}

match-v5.ChallengesDto

type MatchChampionStatsV5DTO

type MatchChampionStatsV5DTO struct {
	AbilityHaste         int32 `json:"abilityHaste,omitempty"`
	AbilityPower         int32 `json:"abilityPower,omitempty"`
	Armor                int32 `json:"armor,omitempty"`
	ArmorPen             int32 `json:"armorPen,omitempty"`
	ArmorPenPercent      int32 `json:"armorPenPercent,omitempty"`
	AttackDamage         int32 `json:"attackDamage,omitempty"`
	AttackSpeed          int32 `json:"attackSpeed,omitempty"`
	BonusArmorPenPercent int32 `json:"bonusArmorPenPercent,omitempty"`
	BonusMagicPenPercent int32 `json:"bonusMagicPenPercent,omitempty"`
	CcReduction          int32 `json:"ccReduction,omitempty"`
	CooldownReduction    int32 `json:"cooldownReduction,omitempty"`
	Health               int32 `json:"health,omitempty"`
	HealthMax            int32 `json:"healthMax,omitempty"`
	HealthRegen          int32 `json:"healthRegen,omitempty"`
	Lifesteal            int32 `json:"lifesteal,omitempty"`
	MagicPen             int32 `json:"magicPen,omitempty"`
	MagicPenPercent      int32 `json:"magicPenPercent,omitempty"`
	MagicResist          int32 `json:"magicResist,omitempty"`
	MovementSpeed        int32 `json:"movementSpeed,omitempty"`
	Omnivamp             int32 `json:"omnivamp,omitempty"`
	PhysicalVamp         int32 `json:"physicalVamp,omitempty"`
	Power                int32 `json:"power,omitempty"`
	PowerMax             int32 `json:"powerMax,omitempty"`
	PowerRegen           int32 `json:"powerRegen,omitempty"`
	SpellVamp            int32 `json:"spellVamp,omitempty"`
}

match-v5.ChampionStatsDto

type MatchDamageStatsV5DTO

type MatchDamageStatsV5DTO struct {
	MagicDamageDone               int32 `json:"magicDamageDone,omitempty"`
	MagicDamageDoneToChampions    int32 `json:"magicDamageDoneToChampions,omitempty"`
	MagicDamageTaken              int32 `json:"magicDamageTaken,omitempty"`
	PhysicalDamageDone            int32 `json:"physicalDamageDone,omitempty"`
	PhysicalDamageDoneToChampions int32 `json:"physicalDamageDoneToChampions,omitempty"`
	PhysicalDamageTaken           int32 `json:"physicalDamageTaken,omitempty"`
	TotalDamageDone               int32 `json:"totalDamageDone,omitempty"`
	TotalDamageDoneToChampions    int32 `json:"totalDamageDoneToChampions,omitempty"`
	TotalDamageTaken              int32 `json:"totalDamageTaken,omitempty"`
	TrueDamageDone                int32 `json:"trueDamageDone,omitempty"`
	TrueDamageDoneToChampions     int32 `json:"trueDamageDoneToChampions,omitempty"`
	TrueDamageTaken               int32 `json:"trueDamageTaken,omitempty"`
}

match-v5.DamageStatsDto

type MatchEventsTimeLineV5DTO

type MatchEventsTimeLineV5DTO struct {
	BuildingType            string                           `json:"buildingType,omitempty"`
	KillType                string                           `json:"killType,omitempty"`
	LaneType                string                           `json:"laneType,omitempty"`
	LevelUpType             string                           `json:"levelUpType,omitempty"`
	MonsterSubType          string                           `json:"monsterSubType,omitempty"`
	MonsterType             string                           `json:"monsterType,omitempty"`
	Name                    string                           `json:"name,omitempty"`
	TowerType               string                           `json:"towerType,omitempty"`
	TransformType           string                           `json:"transformType,omitempty"`
	Type                    string                           `json:"type,omitempty"`
	WardType                string                           `json:"wardType,omitempty"`
	AssistingParticipantIDs []int32                          `json:"assistingParticipantIds,omitempty"`
	VictimDamageDealt       []MatchTimelineVictimDamageV5DTO `json:"victimDamageDealt,omitempty"`
	VictimDamageReceived    []MatchTimelineVictimDamageV5DTO `json:"victimDamageReceived,omitempty"`
	ActualStartTime         int64                            `json:"actualStartTime,omitempty"`
	GameID                  int64                            `json:"gameId,omitempty"`
	RealTimestamp           int64                            `json:"realTimestamp,omitempty"`
	Timestamp               int64                            `json:"timestamp,omitempty"`
	Position                MatchPositionV5DTO               `json:"position,omitempty"`
	AfterID                 int32                            `json:"afterId,omitempty"`
	BeforeID                int32                            `json:"beforeId,omitempty"`
	Bounty                  float32                          `json:"bounty,omitempty"`
	CreatorID               int32                            `json:"creatorId,omitempty"`
	GoldGain                int32                            `json:"goldGain,omitempty"`
	ItemID                  int32                            `json:"itemId,omitempty"`
	KillStreakLength        int32                            `json:"killStreakLength,omitempty"`
	KillerID                int32                            `json:"killerId,omitempty"`
	KillerTeamID            Team                             `json:"killerTeamId,omitempty"`
	Level                   int32                            `json:"level,omitempty"`
	MultiKillLength         int32                            `json:"multiKillLength,omitempty"`
	ParticipantID           int32                            `json:"participantId,omitempty"`
	ShutdownBounty          float32                          `json:"shutdownBounty,omitempty"`
	SkillSlot               int32                            `json:"skillSlot,omitempty"`
	TeamID                  Team                             `json:"teamId,omitempty"`
	VictimID                int32                            `json:"victimId,omitempty"`
	WinningTeam             int32                            `json:"winningTeam,omitempty"`
}

match-v5.EventsTimeLineDto

type MatchFramesTimeLineV5DTO

type MatchFramesTimeLineV5DTO struct {
	ParticipantFrames map[int32]MatchParticipantFrameV5DTO `json:"participantFrames,omitempty"`
	Events            []MatchEventsTimeLineV5DTO           `json:"events,omitempty"`
	Timestamp         int32                                `json:"timestamp,omitempty"`
}

match-v5.FramesTimeLineDto

type MatchInfoTimeLineV5DTO

type MatchInfoTimeLineV5DTO struct {
	// Refer to indicate if the game ended in termination.
	EndOfGameResult string                          `json:"endOfGameResult,omitempty"`
	Frames          []MatchFramesTimeLineV5DTO      `json:"frames,omitempty"`
	Participants    []MatchParticipantTimeLineV5DTO `json:"participants,omitempty"`
	FrameInterval   int64                           `json:"frameInterval,omitempty"`
	GameID          int64                           `json:"gameId,omitempty"`
}

match-v5.InfoTimeLineDto

type MatchInfoV5DTO

type MatchInfoV5DTO struct {
	// Refer to indicate if the game ended in termination.
	EndOfGameResult string `json:"endOfGameResult,omitempty"`
	// Refer to the Game Constants documentation.
	GameMode GameMode `json:"gameMode,omitempty"`
	GameName string   `json:"gameName,omitempty"`
	GameType GameType `json:"gameType,omitempty"`
	// The first two parts can be used to determine the patch a game was played on.
	GameVersion string `json:"gameVersion,omitempty"`
	// Platform where the match was played.
	PlatformID string `json:"platformId,omitempty"`
	// Tournament code used to generate the match. This field was added to match-v5 in patch 11.13 on June 23rd, 2021.
	TournamentCode string                  `json:"tournamentCode,omitempty"`
	Participants   []MatchParticipantV5DTO `json:"participants,omitempty"`
	Teams          []MatchTeamV5DTO        `json:"teams,omitempty"`
	// Unix timestamp for when the game is created on the game server (i.e., the loading screen).
	GameCreation int64 `json:"gameCreation,omitempty"`
	// Prior to patch 11.20, this field returns the game length in milliseconds calculated from gameEndTimestamp - gameStartTimestamp. Post patch 11.20, this field returns the max timePlayed of any participant in the game in seconds, which makes the behavior of this field consistent with that of match-v4. The best way to handling the change in this field is to treat the value as milliseconds if the gameEndTimestamp field isn't in the response and to treat the value as seconds if gameEndTimestamp is in the response.
	GameDuration int64 `json:"gameDuration,omitempty"`
	// Unix timestamp for when match ends on the game server. This timestamp can occasionally be significantly longer than when the match "ends". The most reliable way of determining the timestamp for the end of the match would be to add the max time played of any participant to the gameStartTimestamp. This field was added to match-v5 in patch 11.20 on Oct 5th, 2021.
	GameEndTimestamp int64 `json:"gameEndTimestamp,omitempty"`
	GameID           int64 `json:"gameId,omitempty"`
	// Unix timestamp for when match starts on the game server.
	GameStartTimestamp int64 `json:"gameStartTimestamp,omitempty"`
	// Refer to the Game Constants documentation.
	MapID Map `json:"mapId,omitempty"`
	// Refer to the Game Constants documentation.
	QueueID Queue `json:"queueId,omitempty"`
}

match-v5.InfoDto

type MatchMetadataTimeLineV5DTO

type MatchMetadataTimeLineV5DTO struct {
	// Match data version.
	DataVersion string `json:"dataVersion,omitempty"`
	// Match id.
	MatchID string `json:"matchId,omitempty"`
	// A list of participant PUUIDs.
	Participants []string `json:"participants,omitempty"`
}

match-v5.MetadataTimeLineDto

type MatchMetadataV5DTO

type MatchMetadataV5DTO struct {
	// Match data version.
	DataVersion string `json:"dataVersion,omitempty"`
	// Match id.
	MatchID string `json:"matchId,omitempty"`
	// A list of participant PUUIDs.
	Participants []string `json:"participants,omitempty"`
}

match-v5.MetadataDto

type MatchMissionsV5DTO

type MatchMissionsV5DTO struct {
	PlayerScore0  int32 `json:"playerScore0,omitempty"`
	PlayerScore1  int32 `json:"playerScore1,omitempty"`
	PlayerScore10 int32 `json:"playerScore10,omitempty"`
	PlayerScore11 int32 `json:"playerScore11,omitempty"`
	PlayerScore2  int32 `json:"playerScore2,omitempty"`
	PlayerScore3  int32 `json:"playerScore3,omitempty"`
	PlayerScore4  int32 `json:"playerScore4,omitempty"`
	PlayerScore5  int32 `json:"playerScore5,omitempty"`
	PlayerScore6  int32 `json:"playerScore6,omitempty"`
	PlayerScore7  int32 `json:"playerScore7,omitempty"`
	PlayerScore8  int32 `json:"playerScore8,omitempty"`
	PlayerScore9  int32 `json:"playerScore9,omitempty"`
}

match-v5.MissionsDto

type MatchObjectiveV5DTO

type MatchObjectiveV5DTO struct {
	First bool  `json:"first,omitempty"`
	Kills int32 `json:"kills,omitempty"`
}

match-v5.ObjectiveDto

type MatchObjectivesV5DTO

type MatchObjectivesV5DTO struct {
	Baron      MatchObjectiveV5DTO `json:"baron,omitempty"`
	Champion   MatchObjectiveV5DTO `json:"champion,omitempty"`
	Dragon     MatchObjectiveV5DTO `json:"dragon,omitempty"`
	Horde      MatchObjectiveV5DTO `json:"horde,omitempty"`
	Inhibitor  MatchObjectiveV5DTO `json:"inhibitor,omitempty"`
	RiftHerald MatchObjectiveV5DTO `json:"riftHerald,omitempty"`
	Tower      MatchObjectiveV5DTO `json:"tower,omitempty"`
}

match-v5.ObjectivesDto

type MatchParticipantFrameV5DTO

type MatchParticipantFrameV5DTO struct {
	ChampionStats            MatchChampionStatsV5DTO `json:"championStats,omitempty"`
	CurrentGold              int32                   `json:"currentGold,omitempty"`
	DamageStats              MatchDamageStatsV5DTO   `json:"damageStats,omitempty"`
	GoldPerSecond            int32                   `json:"goldPerSecond,omitempty"`
	JungleMinionsKilled      int32                   `json:"jungleMinionsKilled,omitempty"`
	Level                    int32                   `json:"level,omitempty"`
	MinionsKilled            int32                   `json:"minionsKilled,omitempty"`
	ParticipantID            int32                   `json:"participantId,omitempty"`
	Position                 MatchPositionV5DTO      `json:"position,omitempty"`
	TimeEnemySpentControlled int32                   `json:"timeEnemySpentControlled,omitempty"`
	TotalGold                int32                   `json:"totalGold,omitempty"`
	XP                       int32                   `json:"xp,omitempty"`
}

match-v5.ParticipantFrameDto

type MatchParticipantFramesV5DTO

type MatchParticipantFramesV5DTO struct {
	// Key value mapping for each participant
	X19 MatchParticipantFrameV5DTO `json:"1-9,omitempty"`
}

match-v5.ParticipantFramesDto

type MatchParticipantTimeLineV5DTO

type MatchParticipantTimeLineV5DTO struct {
	PUUID         string `json:"puuid,omitempty"`
	ParticipantID int32  `json:"participantId,omitempty"`
}

match-v5.ParticipantTimeLineDto

type MatchParticipantV5DTO

type MatchParticipantV5DTO struct {
	ChampionName string `json:"championName,omitempty"`
	// Both individualPosition and teamPosition are computed by the game server and are different versions of the most likely position played by a player. The individualPosition is the best guess for which position the player actually played in isolation of anything else. The teamPosition is the best guess for which position the player actually played if we add the constraint that each team must have one top player, one jungle, one middle, etc. Generally the recommendation is to use the teamPosition field over the individualPosition field.
	IndividualPosition string `json:"individualPosition,omitempty"`
	Lane               string `json:"lane,omitempty"`
	PUUID              string `json:"puuid,omitempty"`
	RiotIDGameName     string `json:"riotIdGameName,omitempty"`
	RiotIDName         string `json:"riotIdName,omitempty"`
	RiotIDTagline      string `json:"riotIdTagline,omitempty"`
	Role               string `json:"role,omitempty"`
	SummonerID         string `json:"summonerId,omitempty"`
	SummonerName       string `json:"summonerName,omitempty"`
	// Both individualPosition and teamPosition are computed by the game server and are different versions of the most likely position played by a player. The individualPosition is the best guess for which position the player actually played in isolation of anything else. The teamPosition is the best guess for which position the player actually played if we add the constraint that each team must have one top player, one jungle, one middle, etc. Generally the recommendation is to use the teamPosition field over the individualPosition field.
	TeamPosition string               `json:"teamPosition,omitempty"`
	Perks        MatchPerksV5DTO      `json:"perks,omitempty"`
	Challenges   MatchChallengesV5DTO `json:"challenges,omitempty"`
	Missions     MatchMissionsV5DTO   `json:"missions,omitempty"`
	// Yellow crossed swords
	AllInPings int32 `json:"allInPings,omitempty"`
	// Green flag
	AssistMePings int32 `json:"assistMePings,omitempty"`
	Assists       int32 `json:"assists,omitempty"`
	BaitPings     int32 `json:"baitPings,omitempty"`
	BaronKills    int32 `json:"baronKills,omitempty"`
	// https://github.com/RiotGames/developer-relations/issues/814
	BasicPings      int32 `json:"basicPings,omitempty"`
	BountyLevel     int32 `json:"bountyLevel,omitempty"`
	ChampExperience int32 `json:"champExperience,omitempty"`
	ChampLevel      int32 `json:"champLevel,omitempty"`
	// Prior to patch 11.4, on Feb 18th, 2021, this field returned invalid championIds. We recommend determining the champion based on the championName field for matches played prior to patch 11.4.
	ChampionID int32 `json:"championId,omitempty"`
	// This field is currently only utilized for Kayn's transformations. (Legal values: 0 - None, 1 - Slayer, 2 - Assassin)
	ChampionTransform int32 `json:"championTransform,omitempty"`
	// Blue generic ping (ALT+click)
	CommandPings            int32 `json:"commandPings,omitempty"`
	ConsumablesPurchased    int32 `json:"consumablesPurchased,omitempty"`
	DamageDealtToBuildings  int32 `json:"damageDealtToBuildings,omitempty"`
	DamageDealtToObjectives int32 `json:"damageDealtToObjectives,omitempty"`
	DamageDealtToTurrets    int32 `json:"damageDealtToTurrets,omitempty"`
	DamageSelfMitigated     int32 `json:"damageSelfMitigated,omitempty"`
	// https://github.com/RiotGames/developer-relations/issues/870
	DangerPings         int32 `json:"dangerPings,omitempty"`
	Deaths              int32 `json:"deaths,omitempty"`
	DetectorWardsPlaced int32 `json:"detectorWardsPlaced,omitempty"`
	DoubleKills         int32 `json:"doubleKills,omitempty"`
	DragonKills         int32 `json:"dragonKills,omitempty"`
	// Yellow questionmark
	EnemyMissingPings int32 `json:"enemyMissingPings,omitempty"`
	// Red eyeball
	EnemyVisionPings int32 `json:"enemyVisionPings,omitempty"`
	// Yellow circle with horizontal line
	GetBackPings                int32 `json:"getBackPings,omitempty"`
	GoldEarned                  int32 `json:"goldEarned,omitempty"`
	GoldSpent                   int32 `json:"goldSpent,omitempty"`
	HoldPings                   int32 `json:"holdPings,omitempty"`
	InhibitorKills              int32 `json:"inhibitorKills,omitempty"`
	InhibitorTakedowns          int32 `json:"inhibitorTakedowns,omitempty"`
	InhibitorsLost              int32 `json:"inhibitorsLost,omitempty"`
	Item0                       int32 `json:"item0,omitempty"`
	Item1                       int32 `json:"item1,omitempty"`
	Item2                       int32 `json:"item2,omitempty"`
	Item3                       int32 `json:"item3,omitempty"`
	Item4                       int32 `json:"item4,omitempty"`
	Item5                       int32 `json:"item5,omitempty"`
	Item6                       int32 `json:"item6,omitempty"`
	ItemsPurchased              int32 `json:"itemsPurchased,omitempty"`
	KillingSprees               int32 `json:"killingSprees,omitempty"`
	Kills                       int32 `json:"kills,omitempty"`
	LargestCriticalStrike       int32 `json:"largestCriticalStrike,omitempty"`
	LargestKillingSpree         int32 `json:"largestKillingSpree,omitempty"`
	LargestMultiKill            int32 `json:"largestMultiKill,omitempty"`
	LongestTimeSpentLiving      int32 `json:"longestTimeSpentLiving,omitempty"`
	MagicDamageDealt            int32 `json:"magicDamageDealt,omitempty"`
	MagicDamageDealtToChampions int32 `json:"magicDamageDealtToChampions,omitempty"`
	MagicDamageTaken            int32 `json:"magicDamageTaken,omitempty"`
	// Green ward
	NeedVisionPings int32 `json:"needVisionPings,omitempty"`
	// neutralMinionsKilled = mNeutralMinionsKilled, which is incremented on kills of kPet and kJungleMonster
	NeutralMinionsKilled    int32 `json:"neutralMinionsKilled,omitempty"`
	NexusKills              int32 `json:"nexusKills,omitempty"`
	NexusLost               int32 `json:"nexusLost,omitempty"`
	NexusTakedowns          int32 `json:"nexusTakedowns,omitempty"`
	ObjectivesStolen        int32 `json:"objectivesStolen,omitempty"`
	ObjectivesStolenAssists int32 `json:"objectivesStolenAssists,omitempty"`
	// Blue arrow pointing at ground
	OnMyWayPings                   int32 `json:"onMyWayPings,omitempty"`
	ParticipantID                  int32 `json:"participantId,omitempty"`
	PentaKills                     int32 `json:"pentaKills,omitempty"`
	PhysicalDamageDealt            int32 `json:"physicalDamageDealt,omitempty"`
	PhysicalDamageDealtToChampions int32 `json:"physicalDamageDealtToChampions,omitempty"`
	PhysicalDamageTaken            int32 `json:"physicalDamageTaken,omitempty"`
	Placement                      int32 `json:"placement,omitempty"`
	PlayerAugment1                 int32 `json:"playerAugment1,omitempty"`
	PlayerAugment2                 int32 `json:"playerAugment2,omitempty"`
	PlayerAugment3                 int32 `json:"playerAugment3,omitempty"`
	PlayerAugment4                 int32 `json:"playerAugment4,omitempty"`
	PlayerAugment5                 int32 `json:"playerAugment5,omitempty"`
	PlayerAugment6                 int32 `json:"playerAugment6,omitempty"`
	PlayerScore0                   int32 `json:"playerScore0,omitempty"`
	PlayerScore1                   int32 `json:"playerScore1,omitempty"`
	PlayerScore10                  int32 `json:"playerScore10,omitempty"`
	PlayerScore11                  int32 `json:"playerScore11,omitempty"`
	PlayerScore2                   int32 `json:"playerScore2,omitempty"`
	PlayerScore3                   int32 `json:"playerScore3,omitempty"`
	PlayerScore4                   int32 `json:"playerScore4,omitempty"`
	PlayerScore5                   int32 `json:"playerScore5,omitempty"`
	PlayerScore6                   int32 `json:"playerScore6,omitempty"`
	PlayerScore7                   int32 `json:"playerScore7,omitempty"`
	PlayerScore8                   int32 `json:"playerScore8,omitempty"`
	PlayerScore9                   int32 `json:"playerScore9,omitempty"`
	PlayerSubteamID                int32 `json:"playerSubteamId,omitempty"`
	ProfileIcon                    int32 `json:"profileIcon,omitempty"`
	// Green minion
	PushPings                      int32 `json:"pushPings,omitempty"`
	QuadraKills                    int32 `json:"quadraKills,omitempty"`
	SightWardsBoughtInGame         int32 `json:"sightWardsBoughtInGame,omitempty"`
	Spell1Casts                    int32 `json:"spell1Casts,omitempty"`
	Spell2Casts                    int32 `json:"spell2Casts,omitempty"`
	Spell3Casts                    int32 `json:"spell3Casts,omitempty"`
	Spell4Casts                    int32 `json:"spell4Casts,omitempty"`
	SubteamPlacement               int32 `json:"subteamPlacement,omitempty"`
	Summoner1Casts                 int32 `json:"summoner1Casts,omitempty"`
	Summoner1ID                    int32 `json:"summoner1Id,omitempty"`
	Summoner2Casts                 int32 `json:"summoner2Casts,omitempty"`
	Summoner2ID                    int32 `json:"summoner2Id,omitempty"`
	SummonerLevel                  int32 `json:"summonerLevel,omitempty"`
	TeamID                         Team  `json:"teamId,omitempty"`
	TimeCCingOthers                int32 `json:"timeCCingOthers,omitempty"`
	TimePlayed                     int32 `json:"timePlayed,omitempty"`
	TotalAllyJungleMinionsKilled   int32 `json:"totalAllyJungleMinionsKilled,omitempty"`
	TotalDamageDealt               int32 `json:"totalDamageDealt,omitempty"`
	TotalDamageDealtToChampions    int32 `json:"totalDamageDealtToChampions,omitempty"`
	TotalDamageShieldedOnTeammates int32 `json:"totalDamageShieldedOnTeammates,omitempty"`
	TotalDamageTaken               int32 `json:"totalDamageTaken,omitempty"`
	TotalEnemyJungleMinionsKilled  int32 `json:"totalEnemyJungleMinionsKilled,omitempty"`
	// Whenever positive health is applied (which translates to all heals in the game but not things like regeneration), totalHeal is incremented by the amount of health received. This includes healing enemies, jungle monsters, yourself, etc
	TotalHeal int32 `json:"totalHeal,omitempty"`
	// Whenever positive health is applied (which translates to all heals in the game but not things like regeneration), totalHealsOnTeammates is incremented by the amount of health received.  This is post modified, so if you heal someone missing 5 health for 100 you will get +5 totalHealsOnTeammates
	TotalHealsOnTeammates int32 `json:"totalHealsOnTeammates,omitempty"`
	// totalMillionsKilled = mMinionsKilled, which is only incremented on kills of kTeamMinion, kMeleeLaneMinion, kSuperLaneMinion, kRangedLaneMinion and kSiegeLaneMinion
	TotalMinionsKilled         int32 `json:"totalMinionsKilled,omitempty"`
	TotalTimeCcdealt           int32 `json:"totalTimeCCDealt,omitempty"`
	TotalTimeSpentDead         int32 `json:"totalTimeSpentDead,omitempty"`
	TotalUnitsHealed           int32 `json:"totalUnitsHealed,omitempty"`
	TripleKills                int32 `json:"tripleKills,omitempty"`
	TrueDamageDealt            int32 `json:"trueDamageDealt,omitempty"`
	TrueDamageDealtToChampions int32 `json:"trueDamageDealtToChampions,omitempty"`
	TrueDamageTaken            int32 `json:"trueDamageTaken,omitempty"`
	TurretKills                int32 `json:"turretKills,omitempty"`
	TurretTakedowns            int32 `json:"turretTakedowns,omitempty"`
	TurretsLost                int32 `json:"turretsLost,omitempty"`
	UnrealKills                int32 `json:"unrealKills,omitempty"`
	VisionClearedPings         int32 `json:"visionClearedPings,omitempty"`
	VisionScore                int32 `json:"visionScore,omitempty"`
	VisionWardsBoughtInGame    int32 `json:"visionWardsBoughtInGame,omitempty"`
	WardsKilled                int32 `json:"wardsKilled,omitempty"`
	WardsPlaced                int32 `json:"wardsPlaced,omitempty"`
	EligibleForProgression     bool  `json:"eligibleForProgression,omitempty"`
	FirstBloodAssist           bool  `json:"firstBloodAssist,omitempty"`
	FirstBloodKill             bool  `json:"firstBloodKill,omitempty"`
	FirstTowerAssist           bool  `json:"firstTowerAssist,omitempty"`
	FirstTowerKill             bool  `json:"firstTowerKill,omitempty"`
	// This is an offshoot of the OneStone challenge. The code checks if a spell with the same instance ID does the final point of damage to at least 2 Champions. It doesn't matter if they're enemies, but you cannot hurt your friends.
	GameEndedInEarlySurrender bool `json:"gameEndedInEarlySurrender,omitempty"`
	GameEndedInSurrender      bool `json:"gameEndedInSurrender,omitempty"`
	TeamEarlySurrendered      bool `json:"teamEarlySurrendered,omitempty"`
	Win                       bool `json:"win,omitempty"`
}

match-v5.ParticipantDto

type MatchPerkStatsV5DTO

type MatchPerkStatsV5DTO struct {
	Defense int32 `json:"defense,omitempty"`
	Flex    int32 `json:"flex,omitempty"`
	Offense int32 `json:"offense,omitempty"`
}

match-v5.PerkStatsDto

type MatchPerkStyleSelectionV5DTO

type MatchPerkStyleSelectionV5DTO struct {
	Perk int32 `json:"perk,omitempty"`
	Var1 int32 `json:"var1,omitempty"`
	Var2 int32 `json:"var2,omitempty"`
	Var3 int32 `json:"var3,omitempty"`
}

match-v5.PerkStyleSelectionDto

type MatchPerkStyleV5DTO

type MatchPerkStyleV5DTO struct {
	Description string                         `json:"description,omitempty"`
	Selections  []MatchPerkStyleSelectionV5DTO `json:"selections,omitempty"`
	Style       int32                          `json:"style,omitempty"`
}

match-v5.PerkStyleDto

type MatchPerksV5DTO

type MatchPerksV5DTO struct {
	Styles    []MatchPerkStyleV5DTO `json:"styles,omitempty"`
	StatPerks MatchPerkStatsV5DTO   `json:"statPerks,omitempty"`
}

match-v5.PerksDto

type MatchPositionV5DTO

type MatchPositionV5DTO struct {
	X int32 `json:"x,omitempty"`
	Y int32 `json:"y,omitempty"`
}

match-v5.PositionDto

type MatchTeamV5DTO

type MatchTeamV5DTO struct {
	Bans       []MatchBanV5DTO      `json:"bans,omitempty"`
	Objectives MatchObjectivesV5DTO `json:"objectives,omitempty"`
	TeamID     Team                 `json:"teamId,omitempty"`
	Win        bool                 `json:"win,omitempty"`
}

match-v5.TeamDto

type MatchTimelineV5DTO

type MatchTimelineV5DTO struct {
	// Match metadata.
	Metadata MatchMetadataTimeLineV5DTO `json:"metadata,omitempty"`
	// Match info.
	Info MatchInfoTimeLineV5DTO `json:"info,omitempty"`
}

match-v5.TimelineDto

type MatchTimelineVictimDamageV5DTO

type MatchTimelineVictimDamageV5DTO struct {
	Name           string `json:"name,omitempty"`
	SpellName      string `json:"spellName,omitempty"`
	Type           string `json:"type,omitempty"`
	MagicDamage    int32  `json:"magicDamage,omitempty"`
	ParticipantID  int32  `json:"participantId,omitempty"`
	PhysicalDamage int32  `json:"physicalDamage,omitempty"`
	SpellSlot      int32  `json:"spellSlot,omitempty"`
	TrueDamage     int32  `json:"trueDamage,omitempty"`
	Basic          bool   `json:"basic,omitempty"`
}

match-v5.MatchTimelineVictimDamage

type MatchV5

type MatchV5 struct {
	// contains filtered or unexported fields
}

Riot API Reference

match-v5

func (*MatchV5) ByID

func (endpoint *MatchV5) ByID(ctx context.Context, route api.RegionalRoute, matchId string) (*MatchV5DTO, error)

Get a match by match id

Parameters

  • route: Route to query.
  • matchId

Riot API Reference

match-v5.getMatch

func (*MatchV5) ListByPUUID

func (endpoint *MatchV5) ListByPUUID(ctx context.Context, route api.RegionalRoute, puuid string, startTime int64, endTime int64, queue Queue, matchType string, start int32, count int32) ([]string, error)

Get a list of match ids by puuid

Parameters

  • route: Route to query.
  • puuid
  • startTime (optional): Epoch timestamp in seconds. The matchlist started storing timestamps on June 16th, 2021. Any matches played before June 16th, 2021 won't be included in the results if the startTime filter is set.
  • endTime (optional): Epoch timestamp in seconds.
  • queue (optional): Filter the list of match ids by a specific queue id. This filter is mutually inclusive of the type filter meaning any match ids returned must match both the queue and type filters.
  • type (optional): Filter the list of match ids by the type of match. This filter is mutually inclusive of the queue filter meaning any match ids returned must match both the queue and type filters.
  • start (optional): Defaults to 0. Start index.
  • count (optional): Defaults to 20. Valid values: 0 to 100. Number of match ids to return.

Riot API Reference

match-v5.getMatchIdsByPUUID

func (*MatchV5) Timeline

func (endpoint *MatchV5) Timeline(ctx context.Context, route api.RegionalRoute, matchId string) (*MatchTimelineV5DTO, error)

Get a match timeline by match id

Parameters

  • route: Route to query.
  • matchId

Riot API Reference

match-v5.getTimeline

type MatchV5DTO

type MatchV5DTO struct {
	// Match metadata.
	Metadata MatchMetadataV5DTO `json:"metadata,omitempty"`
	// Match info.
	Info MatchInfoV5DTO `json:"info,omitempty"`
}

match-v5.MatchDto

type PlatformRoute

type PlatformRoute string

Platform routes for League of Legends.

const (
	// Brazil.
	BR1 PlatformRoute = "br1"
	// Europe, Northeast.
	EUN1 PlatformRoute = "eun1"
	// Europe, West.
	EUW1 PlatformRoute = "euw1"
	// Japan.
	JP1 PlatformRoute = "jp1"
	// Korea.
	KR PlatformRoute = "kr"
	// Latin America, North.
	LA1 PlatformRoute = "la1"
	// Latin America, South.
	LA2 PlatformRoute = "la2"
	// Middle East and North Africa.
	ME1 PlatformRoute = "me1"
	// North America.
	NA1 PlatformRoute = "na1"
	// Oceania.
	OC1 PlatformRoute = "oc1"
	// Public Beta Environment, special beta testing platform. Located in North America.
	PBE1 PlatformRoute = "pbe1"
	// Philippines
	PH2 PlatformRoute = "ph2"
	// Russia
	RU PlatformRoute = "ru"
	// Singapore
	SG2 PlatformRoute = "sg2"
	// Thailand
	TH2 PlatformRoute = "th2"
	// Turkey
	TR1 PlatformRoute = "tr1"
	// Taiwan
	TW2 PlatformRoute = "tw2"
	// Vietnam
	VN2 PlatformRoute = "vn2"
)

func (PlatformRoute) String

func (route PlatformRoute) String() string

type Queue

type Queue int32

League of Legends queues.

const (
	// 2v2v2v2 `CHERRY` games on Arena
	ARENA_2V2V2V2_CHERRY_QUEUE Queue = 1700
	// 5v5 ARAM games on Butcher's Bridge
	BUTCHERS_BRIDGE_5V5_ARAM_QUEUE Queue = 100
	// Dark Star: Singularity games on Cosmic Ruins
	COSMIC_RUINS_DARK_STAR_SINGULARITY_QUEUE Queue = 610
	// Odyssey Extraction: Cadet games on Crash Site
	CRASH_SITE_ODYSSEY_EXTRACTION_CADET_QUEUE Queue = 1040
	// Odyssey Extraction: Captain games on Crash Site
	CRASH_SITE_ODYSSEY_EXTRACTION_CAPTAIN_QUEUE Queue = 1060
	// Odyssey Extraction: Crewmember games on Crash Site
	CRASH_SITE_ODYSSEY_EXTRACTION_CREWMEMBER_QUEUE Queue = 1050
	// Odyssey Extraction: Intro games on Crash Site
	CRASH_SITE_ODYSSEY_EXTRACTION_INTRO_QUEUE Queue = 1030
	// Odyssey Extraction: Onslaught games on Crash Site
	CRASH_SITE_ODYSSEY_EXTRACTION_ONSLAUGHT_QUEUE Queue = 1070
	// # Deprecated
	//
	// 5v5 Dominion Blind Pick games on Crystal Scar
	CRYSTAL_SCAR_5V5_DOMINION_BLIND_PICK_QUEUE Queue = 16
	// # Deprecated
	//
	// 5v5 Dominion Draft Pick games on Crystal Scar
	CRYSTAL_SCAR_5V5_DOMINION_DRAFT_PICK_QUEUE Queue = 17
	// # Deprecated
	//
	// Ascension games on Crystal Scar
	CRYSTAL_SCAR_ASCENSION_96_QUEUE Queue = 96
	// Ascension games on Crystal Scar
	CRYSTAL_SCAR_ASCENSION_QUEUE Queue = 910
	// Definitely Not Dominion games on Crystal Scar
	CRYSTAL_SCAR_DEFINITELY_NOT_DOMINION_QUEUE Queue = 317
	// # Deprecated
	//
	// Dominion Co-op vs AI games on Crystal Scar
	CRYSTAL_SCAR_DOMINION_CO_OP_VS_AI_QUEUE Queue = 25
	// Games on Custom games
	CUSTOM_QUEUE Queue = 0
	// 1v1 Snowdown Showdown games on Howling Abyss
	HOWLING_ABYSS_1V1_SNOWDOWN_SHOWDOWN_QUEUE Queue = 72
	// 2v2 Snowdown Showdown games on Howling Abyss
	HOWLING_ABYSS_2V2_SNOWDOWN_SHOWDOWN_QUEUE Queue = 73
	// # Deprecated
	//
	// 5v5 ARAM games on Howling Abyss
	HOWLING_ABYSS_5V5_ARAM_65_QUEUE Queue = 65
	// 5v5 ARAM games on Howling Abyss
	HOWLING_ABYSS_5V5_ARAM_QUEUE Queue = 450
	// ARAM Clash games on Howling Abyss
	HOWLING_ABYSS_ARAM_CLASH_QUEUE Queue = 720
	// # Deprecated
	//
	// ARAM Co-op vs AI games on Howling Abyss
	HOWLING_ABYSS_ARAM_CO_OP_VS_AI_QUEUE Queue = 67
	// # Deprecated
	//
	// Legend of the Poro King games on Howling Abyss
	HOWLING_ABYSS_LEGEND_OF_THE_PORO_KING_300_QUEUE Queue = 300
	// Legend of the Poro King games on Howling Abyss
	HOWLING_ABYSS_LEGEND_OF_THE_PORO_KING_QUEUE Queue = 920
	// One For All: Mirror Mode games on Howling Abyss
	HOWLING_ABYSS_ONE_FOR_ALL_MIRROR_MODE_QUEUE Queue = 78
	// # Deprecated
	//
	// Nexus Blitz games on Nexus Blitz
	NEXUS_BLITZ_1200_QUEUE Queue = 1200
	// Nexus Blitz games on Nexus Blitz
	NEXUS_BLITZ_QUEUE Queue = 1300
	// PROJECT: Hunters games on Overcharge
	OVERCHARGE_PROJECT_HUNTERS_QUEUE Queue = 1000
	// Arena (`CHERRY` games) games on Rings of Wrath
	RINGS_OF_WRATH_ARENA_CHERRY_GAMES_QUEUE Queue = 1710
	// # Deprecated
	//
	// 5v5 Blind Pick games on Summoner's Rift
	SUMMONERS_RIFT_5V5_BLIND_PICK_2_QUEUE Queue = 2
	// 5v5 Blind Pick games on Summoner's Rift
	SUMMONERS_RIFT_5V5_BLIND_PICK_QUEUE Queue = 430
	// # Deprecated
	//
	// 5v5 Draft Pick games on Summoner's Rift
	SUMMONERS_RIFT_5V5_DRAFT_PICK_14_QUEUE Queue = 14
	// 5v5 Draft Pick games on Summoner's Rift
	SUMMONERS_RIFT_5V5_DRAFT_PICK_QUEUE Queue = 400
	// # Deprecated
	//
	// 5v5 Ranked Dynamic games on Summoner's Rift
	SUMMONERS_RIFT_5V5_RANKED_DYNAMIC_QUEUE Queue = 410
	// 5v5 Ranked Flex games on Summoner's Rift
	SUMMONERS_RIFT_5V5_RANKED_FLEX_QUEUE Queue = 440
	// # Deprecated
	//
	// 5v5 Ranked Premade games on Summoner's Rift
	SUMMONERS_RIFT_5V5_RANKED_PREMADE_QUEUE Queue = 6
	// # Deprecated
	//
	// 5v5 Ranked Solo games on Summoner's Rift
	SUMMONERS_RIFT_5V5_RANKED_SOLO_4_QUEUE Queue = 4
	// 5v5 Ranked Solo games on Summoner's Rift
	SUMMONERS_RIFT_5V5_RANKED_SOLO_QUEUE Queue = 420
	// # Deprecated
	//
	// 5v5 Ranked Team games on Summoner's Rift
	SUMMONERS_RIFT_5V5_RANKED_TEAM_QUEUE Queue = 42
	// # Deprecated
	//
	// 5v5 Team Builder games on Summoner's Rift
	SUMMONERS_RIFT_5V5_TEAM_BUILDER_QUEUE Queue = 61
	// 6v6 Hexakill games on Summoner's Rift
	SUMMONERS_RIFT_6V6_HEXAKILL_QUEUE Queue = 75
	// All Random games on Summoner's Rift
	SUMMONERS_RIFT_ALL_RANDOM_QUEUE Queue = 325
	// # Deprecated
	//
	// ARURF games on Summoner's Rift
	SUMMONERS_RIFT_ARURF_318_QUEUE Queue = 318
	// ARURF games on Summoner's Rift
	SUMMONERS_RIFT_ARURF_QUEUE Queue = 900
	// Black Market Brawlers games on Summoner's Rift
	SUMMONERS_RIFT_BLACK_MARKET_BRAWLERS_QUEUE Queue = 313
	// Blood Hunt Assassin games on Summoner's Rift
	SUMMONERS_RIFT_BLOOD_HUNT_ASSASSIN_QUEUE Queue = 600
	// Summoner's Rift Clash games on Summoner's Rift
	SUMMONERS_RIFT_CLASH_QUEUE Queue = 700
	// # Deprecated
	//
	// Co-op vs AI Beginner Bot games on Summoner's Rift
	SUMMONERS_RIFT_CO_OP_VS_AI_BEGINNER_BOT_32_QUEUE Queue = 32
	// # Deprecated
	//
	// Co-op vs. AI Beginner Bot games on Summoner's Rift
	SUMMONERS_RIFT_CO_OP_VS_AI_BEGINNER_BOT_840_QUEUE Queue = 840
	// Co-op vs. AI Beginner Bot games on Summoner's Rift
	SUMMONERS_RIFT_CO_OP_VS_AI_BEGINNER_BOT_QUEUE Queue = 880
	// # Deprecated
	//
	// Co-op vs AI Intermediate Bot games on Summoner's Rift
	SUMMONERS_RIFT_CO_OP_VS_AI_INTERMEDIATE_BOT_33_QUEUE Queue = 33
	// # Deprecated
	//
	// Co-op vs. AI Intermediate Bot games on Summoner's Rift
	SUMMONERS_RIFT_CO_OP_VS_AI_INTERMEDIATE_BOT_850_QUEUE Queue = 850
	// Co-op vs. AI Intermediate Bot games on Summoner's Rift
	SUMMONERS_RIFT_CO_OP_VS_AI_INTERMEDIATE_BOT_QUEUE Queue = 890
	// # Deprecated
	//
	// Co-op vs AI Intro Bot games on Summoner's Rift
	SUMMONERS_RIFT_CO_OP_VS_AI_INTRO_BOT_31_QUEUE Queue = 31
	// # Deprecated
	//
	// Co-op vs. AI Intro Bot games on Summoner's Rift
	SUMMONERS_RIFT_CO_OP_VS_AI_INTRO_BOT_830_QUEUE Queue = 830
	// Co-op vs. AI Intro Bot games on Summoner's Rift
	SUMMONERS_RIFT_CO_OP_VS_AI_INTRO_BOT_QUEUE Queue = 870
	// # Deprecated
	//
	// Co-op vs AI games on Summoner's Rift
	SUMMONERS_RIFT_CO_OP_VS_AI_QUEUE Queue = 7
	// Co-op vs AI Ultra Rapid Fire games on Summoner's Rift
	SUMMONERS_RIFT_CO_OP_VS_AI_ULTRA_RAPID_FIRE_QUEUE Queue = 83
	// # Deprecated
	//
	// Doom Bots Rank 1 games on Summoner's Rift
	SUMMONERS_RIFT_DOOM_BOTS_RANK_1_QUEUE Queue = 91
	// # Deprecated
	//
	// Doom Bots Rank 2 games on Summoner's Rift
	SUMMONERS_RIFT_DOOM_BOTS_RANK_2_QUEUE Queue = 92
	// # Deprecated
	//
	// Doom Bots Rank 5 games on Summoner's Rift
	SUMMONERS_RIFT_DOOM_BOTS_RANK_5_QUEUE Queue = 93
	// Doom Bots Standard games on Summoner's Rift
	SUMMONERS_RIFT_DOOM_BOTS_STANDARD_QUEUE Queue = 960
	// Doom Bots Voting games on Summoner's Rift
	SUMMONERS_RIFT_DOOM_BOTS_VOTING_QUEUE Queue = 950
	// Nemesis games on Summoner's Rift
	SUMMONERS_RIFT_NEMESIS_QUEUE Queue = 310
	// # Deprecated
	//
	// Nexus Siege games on Summoner's Rift
	SUMMONERS_RIFT_NEXUS_SIEGE_315_QUEUE Queue = 315
	// Nexus Siege games on Summoner's Rift
	SUMMONERS_RIFT_NEXUS_SIEGE_QUEUE Queue = 940
	// Normal (Quickplay) games on Summoner's Rift
	SUMMONERS_RIFT_NORMAL_QUICKPLAY_QUEUE Queue = 490
	// # Deprecated
	//
	// One for All games on Summoner's Rift
	SUMMONERS_RIFT_ONE_FOR_ALL_70_QUEUE Queue = 70
	// One for All games on Summoner's Rift
	SUMMONERS_RIFT_ONE_FOR_ALL_QUEUE Queue = 1020
	// Pick URF games on Summoner's Rift
	SUMMONERS_RIFT_PICK_URF_QUEUE Queue = 1900
	// Snow ARURF games on Summoner's Rift
	SUMMONERS_RIFT_SNOW_ARURF_QUEUE Queue = 1010
	// Tutorial 1 games on Summoner's Rift
	SUMMONERS_RIFT_TUTORIAL_1_QUEUE Queue = 2000
	// Tutorial 2 games on Summoner's Rift
	SUMMONERS_RIFT_TUTORIAL_2_QUEUE Queue = 2010
	// Tutorial 3 games on Summoner's Rift
	SUMMONERS_RIFT_TUTORIAL_3_QUEUE Queue = 2020
	// Ultimate Spellbook games on Summoner's Rift
	SUMMONERS_RIFT_ULTIMATE_SPELLBOOK_QUEUE Queue = 1400
	// Ultra Rapid Fire games on Summoner's Rift
	SUMMONERS_RIFT_ULTRA_RAPID_FIRE_QUEUE Queue = 76
	// Swarm duo (`STRAWBERRY` games) games on Swarm
	SWARM_DUO_STRAWBERRY_GAMES_QUEUE Queue = 1820
	// Swarm quad (`STRAWBERRY` games) games on Swarm
	SWARM_QUAD_STRAWBERRY_GAMES_QUEUE Queue = 1840
	// Swarm solo (`STRAWBERRY` games) games on Swarm
	SWARM_SOLO_STRAWBERRY_GAMES_QUEUE Queue = 1810
	// Swarm trio (`STRAWBERRY` games) games on Swarm
	SWARM_TRIO_STRAWBERRY_GAMES_QUEUE Queue = 1830
	// # Deprecated
	//
	// 3v3 Blind Pick games on Twisted Treeline
	TWISTED_TREELINE_3V3_BLIND_PICK_QUEUE Queue = 460
	// # Deprecated
	//
	// 3v3 Normal games on Twisted Treeline
	TWISTED_TREELINE_3V3_NORMAL_QUEUE Queue = 8
	// # Deprecated
	//
	// 3v3 Ranked Flex games on Twisted Treeline
	TWISTED_TREELINE_3V3_RANKED_FLEX_470_QUEUE Queue = 470
	// # Deprecated
	//
	// 3v3 Ranked Flex games on Twisted Treeline
	TWISTED_TREELINE_3V3_RANKED_FLEX_9_QUEUE Queue = 9
	// # Deprecated
	//
	// 3v3 Ranked Team games on Twisted Treeline
	TWISTED_TREELINE_3V3_RANKED_TEAM_QUEUE Queue = 41
	// 6v6 Hexakill games on Twisted Treeline
	TWISTED_TREELINE_6V6_HEXAKILL_QUEUE Queue = 98
	// Co-op vs. AI Beginner Bot games on Twisted Treeline
	TWISTED_TREELINE_CO_OP_VS_AI_BEGINNER_BOT_QUEUE Queue = 820
	// # Deprecated
	//
	// Co-op vs. AI Intermediate Bot games on Twisted Treeline
	TWISTED_TREELINE_CO_OP_VS_AI_INTERMEDIATE_BOT_QUEUE Queue = 800
	// # Deprecated
	//
	// Co-op vs. AI Intro Bot games on Twisted Treeline
	TWISTED_TREELINE_CO_OP_VS_AI_INTRO_BOT_QUEUE Queue = 810
	// # Deprecated
	//
	// Co-op vs AI games on Twisted Treeline
	TWISTED_TREELINE_CO_OP_VS_AI_QUEUE Queue = 52
	// Star Guardian Invasion: Normal games on Valoran City Park
	VALORAN_CITY_PARK_STAR_GUARDIAN_INVASION_NORMAL_QUEUE Queue = 980
	// Star Guardian Invasion: Onslaught games on Valoran City Park
	VALORAN_CITY_PARK_STAR_GUARDIAN_INVASION_ONSLAUGHT_QUEUE Queue = 990
)

func (Queue) String

func (queue Queue) String() string

type QueueType

type QueueType string

League of Legends ranked queue types.

const (
	// "Arena" games
	CHERRY_QUEUETYPE QueueType = "CHERRY"
	// 5v5 Ranked Flex games
	RANKED_FLEX_SR_QUEUETYPE QueueType = "RANKED_FLEX_SR"
	// # Deprecated
	//
	// 3v3 Ranked Flex games
	RANKED_FLEX_TT_QUEUETYPE QueueType = "RANKED_FLEX_TT"
	// 5v5 Ranked Solo games
	RANKED_SOLO_5X5_QUEUETYPE QueueType = "RANKED_SOLO_5X5"
)

func (QueueType) String

func (queueType QueueType) String() string

type RsoMatchMatchV1DTO

type RsoMatchMatchV1DTO struct {
}

lol-rso-match-v1.MatchDto

type RsoMatchTimelineV1DTO

type RsoMatchTimelineV1DTO struct {
}

lol-rso-match-v1.TimelineDto

type RsoMatchV1

type RsoMatchV1 struct {
	// contains filtered or unexported fields
}

Riot API Reference

lol-rso-match-v1

func (*RsoMatchV1) ByID

func (endpoint *RsoMatchV1) ByID(ctx context.Context, route api.RegionalRoute, accessToken string, matchId string) (*RsoMatchMatchV1DTO, error)

Get a match by match id

Parameters

  • route: Route to query.
  • accessToken: RSO access token.
  • matchId

Riot API Reference

lol-rso-match-v1.getMatch

func (*RsoMatchV1) MatchIds

func (endpoint *RsoMatchV1) MatchIds(ctx context.Context, route api.RegionalRoute, accessToken string, count int32, start int32, matchType string, queue int32, endTime int64, startTime int64) ([]string, error)

Get a list of match ids by player access token - Includes custom matches

Parameters

  • route: Route to query.
  • accessToken: RSO access token.
  • count (optional): Defaults to 20. Valid values: 0 to 100. Number of match ids to return.
  • start (optional): Defaults to 0. Start index.
  • type (optional): Filter the list of match ids by the type of match. This filter is mutually inclusive of the queue filter meaning any match ids returned must match both the queue and type filters.
  • queue (optional): Filter the list of match ids by a specific queue id. This filter is mutually inclusive of the type filter meaning any match ids returned must match both the queue and type filters.
  • endTime (optional): Epoch timestamp in seconds.
  • startTime (optional): Epoch timestamp in seconds. The matchlist started storing timestamps on June 16th, 2021. Any matches played before June 16th, 2021 won't be included in the results if the startTime filter is set.

Riot API Reference

lol-rso-match-v1.getMatchIds

func (*RsoMatchV1) Timeline

func (endpoint *RsoMatchV1) Timeline(ctx context.Context, route api.RegionalRoute, accessToken string, matchId string) (*RsoMatchTimelineV1DTO, error)

Get a match timeline by match id

Parameters

  • route: Route to query.
  • accessToken: RSO access token.
  • matchId

Riot API Reference

lol-rso-match-v1.getTimeline

type SpectatorBannedChampionV5DTO

type SpectatorBannedChampionV5DTO struct {
	// The ID of the banned champion
	ChampionID int64 `json:"championId,omitempty"`
	// The turn during which the champion was banned
	PickTurn int32 `json:"pickTurn,omitempty"`
	// The ID of the team that banned the champion
	TeamID Team `json:"teamId,omitempty"`
}

spectator-v5.BannedChampion

type SpectatorCurrentGameInfoV5DTO

type SpectatorCurrentGameInfoV5DTO struct {
	// The game mode
	GameMode GameMode `json:"gameMode,omitempty"`
	// The game type
	GameType GameType `json:"gameType,omitempty"`
	// The observer information
	Observers SpectatorObserverV5DTO `json:"observers,omitempty"`
	// The ID of the platform on which the game is being played
	PlatformID string `json:"platformId,omitempty"`
	// Banned champion information
	BannedChampions []SpectatorBannedChampionV5DTO `json:"bannedChampions,omitempty"`
	// The participant information
	Participants []SpectatorCurrentGameParticipantV5DTO `json:"participants,omitempty"`
	// The ID of the game
	GameID int64 `json:"gameId,omitempty"`
	// The amount of time in seconds that has passed since the game started
	GameLength int64 `json:"gameLength,omitempty"`
	// The game start time represented in epoch milliseconds
	GameStartTime int64 `json:"gameStartTime,omitempty"`
	// The ID of the map
	MapID Map `json:"mapId,omitempty"`
	// The queue type (queue types are documented on the Game Constants page)
	GameQueueConfigID Queue `json:"gameQueueConfigId,omitempty"`
}

spectator-v5.CurrentGameInfo

type SpectatorCurrentGameParticipantV5DTO

type SpectatorCurrentGameParticipantV5DTO struct {
	// The encrypted puuid of this participant
	PUUID  string `json:"puuid,omitempty"`
	RiotID string `json:"riotId,omitempty"`
	// The encrypted summoner ID of this participant
	SummonerID string `json:"summonerId,omitempty"`
	// List of Game Customizations
	GameCustomizationObjects []SpectatorGameCustomizationObjectV5DTO `json:"gameCustomizationObjects,omitempty"`
	// Perks/Runes Reforged Information
	Perks SpectatorPerksV5DTO `json:"perks,omitempty"`
	// The ID of the champion played by this participant
	ChampionID int64 `json:"championId,omitempty"`
	// The ID of the profile icon used by this participant
	ProfileIconID int64 `json:"profileIconId,omitempty"`
	// The ID of the first summoner spell used by this participant
	Spell1ID int64 `json:"spell1Id,omitempty"`
	// The ID of the second summoner spell used by this participant
	Spell2ID int64 `json:"spell2Id,omitempty"`
	// The team ID of this participant, indicating the participant's team
	TeamID Team `json:"teamId,omitempty"`
	// Flag indicating whether or not this participant is a bot
	Bot bool `json:"bot,omitempty"`
}

spectator-v5.CurrentGameParticipant

type SpectatorFeaturedGameInfoV5DTO

type SpectatorFeaturedGameInfoV5DTO struct {
	// The game mode
	//
	// (Legal values:  CLASSIC,  ODIN,  ARAM,  TUTORIAL,  ONEFORALL,  ASCENSION,  FIRSTBLOOD,  KINGPORO)
	GameMode GameMode `json:"gameMode,omitempty"`
	// The game type
	//
	// (Legal values:  CUSTOM_GAME,  MATCHED_GAME,  TUTORIAL_GAME)
	GameType GameType `json:"gameType,omitempty"`
	// The observer information
	Observers SpectatorObserverV5DTO `json:"observers,omitempty"`
	// The ID of the platform on which the game is being played
	PlatformID string `json:"platformId,omitempty"`
	// Banned champion information
	BannedChampions []SpectatorBannedChampionV5DTO `json:"bannedChampions,omitempty"`
	// The participant information
	Participants []SpectatorParticipantV5DTO `json:"participants,omitempty"`
	// The ID of the game
	GameID int64 `json:"gameId,omitempty"`
	// The amount of time in seconds that has passed since the game started
	GameLength int64 `json:"gameLength,omitempty"`
	// The ID of the map
	MapID Map `json:"mapId,omitempty"`
	// The queue type (queue types are documented on the Game Constants page)
	GameQueueConfigID Queue `json:"gameQueueConfigId,omitempty"`
}

spectator-v5.FeaturedGameInfo

type SpectatorFeaturedGamesV5DTO

type SpectatorFeaturedGamesV5DTO struct {
	// The list of featured games
	GameList []SpectatorFeaturedGameInfoV5DTO `json:"gameList,omitempty"`
	// The suggested interval to wait before requesting FeaturedGames again
	ClientRefreshInterval int64 `json:"clientRefreshInterval,omitempty"`
}

spectator-v5.FeaturedGames

type SpectatorGameCustomizationObjectV5DTO

type SpectatorGameCustomizationObjectV5DTO struct {
	// Category identifier for Game Customization
	Category string `json:"category,omitempty"`
	// Game Customization content
	Content string `json:"content,omitempty"`
}

spectator-v5.GameCustomizationObject

type SpectatorObserverV5DTO

type SpectatorObserverV5DTO struct {
	// Key used to decrypt the spectator grid game data for playback
	EncryptionKey string `json:"encryptionKey,omitempty"`
}

spectator-v5.Observer

type SpectatorParticipantV5DTO

type SpectatorParticipantV5DTO struct {
	// Encrypted puuid of this participant
	PUUID  string `json:"puuid,omitempty"`
	RiotID string `json:"riotId,omitempty"`
	// Encrypted summoner ID of this participant
	SummonerID string `json:"summonerId,omitempty"`
	// The ID of the champion played by this participant
	ChampionID int64 `json:"championId,omitempty"`
	// The ID of the profile icon used by this participant
	ProfileIconID int64 `json:"profileIconId,omitempty"`
	// The ID of the first summoner spell used by this participant
	Spell1ID int64 `json:"spell1Id,omitempty"`
	// The ID of the second summoner spell used by this participant
	Spell2ID int64 `json:"spell2Id,omitempty"`
	// The team ID of this participant, indicating the participant's team
	TeamID Team `json:"teamId,omitempty"`
	// Flag indicating whether or not this participant is a bot
	Bot bool `json:"bot,omitempty"`
}

spectator-v5.Participant

type SpectatorPerksV5DTO

type SpectatorPerksV5DTO struct {
	// IDs of the perks/runes assigned.
	PerkIDs []int64 `json:"perkIds,omitempty"`
	// Primary runes path
	PerkStyle int64 `json:"perkStyle,omitempty"`
	// Secondary runes path
	PerkSubStyle int64 `json:"perkSubStyle,omitempty"`
}

spectator-v5.Perks

type SpectatorV5

type SpectatorV5 struct {
	// contains filtered or unexported fields
}

Riot API Reference

spectator-v5

func (*SpectatorV5) CurrentGameInfoByPUUID

func (endpoint *SpectatorV5) CurrentGameInfoByPUUID(ctx context.Context, route PlatformRoute, encryptedPUUID string) (*SpectatorCurrentGameInfoV5DTO, error)

Get current game information for the given puuid.

Parameters

  • route: Route to query.
  • encryptedPUUID: The puuid of the summoner.

Riot API Reference

spectator-v5.getCurrentGameInfoByPuuid

func (*SpectatorV5) Featured

func (endpoint *SpectatorV5) Featured(ctx context.Context, route PlatformRoute) (*SpectatorFeaturedGamesV5DTO, error)

Get list of featured games.

  • route: Route to query.

spectator-v5.getFeaturedGames

type StatusContentV4DTO

type StatusContentV4DTO struct {
	Content string `json:"content,omitempty"`
	Locale  string `json:"locale,omitempty"`
}

lol-status-v4.ContentDto

type StatusPlatformDataV4DTO

type StatusPlatformDataV4DTO struct {
	ID           string        `json:"id,omitempty"`
	Name         string        `json:"name,omitempty"`
	Incidents    []StatusV4DTO `json:"incidents,omitempty"`
	Locales      []string      `json:"locales,omitempty"`
	Maintenances []StatusV4DTO `json:"maintenances,omitempty"`
}

lol-status-v4.PlatformDataDto

type StatusUpdateV4DTO

type StatusUpdateV4DTO struct {
	Author    string `json:"author,omitempty"`
	CreatedAt string `json:"created_at,omitempty"`
	UpdatedAt string `json:"updated_at,omitempty"`
	// (Legal values: riotclient, riotstatus, game)
	PublishLocations []string             `json:"publish_locations,omitempty"`
	Translations     []StatusContentV4DTO `json:"translations,omitempty"`
	ID               int32                `json:"id,omitempty"`
	Publish          bool                 `json:"publish,omitempty"`
}

lol-status-v4.UpdateDto

type StatusV4

type StatusV4 struct {
	// contains filtered or unexported fields
}

Riot API Reference

lol-status-v4

func (*StatusV4) Platform

func (endpoint *StatusV4) Platform(ctx context.Context, route PlatformRoute) (*StatusPlatformDataV4DTO, error)

Get League of Legends status for the given platform.

Parameters

  • route: Route to query.

Riot API Reference

lol-status-v4.getPlatformData

type StatusV4DTO

type StatusV4DTO struct {
	ArchiveAt string `json:"archive_at,omitempty"`
	CreatedAt string `json:"created_at,omitempty"`
	// (Legal values:  info,  warning,  critical)
	IncidentSeverity string `json:"incident_severity,omitempty"`
	// (Legal values:  scheduled,  in_progress,  complete)
	MaintenanceStatus string `json:"maintenance_status,omitempty"`
	UpdatedAt         string `json:"updated_at,omitempty"`
	// (Legal values: windows, macos, android, ios, ps4, xbone, switch)
	Platforms []string             `json:"platforms,omitempty"`
	Titles    []StatusContentV4DTO `json:"titles,omitempty"`
	Updates   []StatusUpdateV4DTO  `json:"updates,omitempty"`
	ID        int32                `json:"id,omitempty"`
}

lol-status-v4.StatusDto

type SummonerV4

type SummonerV4 struct {
	// contains filtered or unexported fields
}

Riot API Reference

summoner-v4

func (*SummonerV4) ByAccessToken

func (endpoint *SummonerV4) ByAccessToken(ctx context.Context, route PlatformRoute, accessToken string) (*SummonerV4DTO, error)

Get a summoner by access token.

Parameters

  • route: Route to query.
  • accessToken: RSO access token.

Riot API Reference

summoner-v4.getByAccessToken

func (*SummonerV4) ByAccountID

func (endpoint *SummonerV4) ByAccountID(ctx context.Context, route PlatformRoute, encryptedAccountId string) (*SummonerV4DTO, error)

Get a summoner by account ID.

Parameters

  • route: Route to query.
  • encryptedAccountId

Riot API Reference

summoner-v4.getByAccountId

func (*SummonerV4) ByPUUID

func (endpoint *SummonerV4) ByPUUID(ctx context.Context, route PlatformRoute, encryptedPUUID string) (*SummonerV4DTO, error)

Get a summoner by PUUID.

Parameters

  • route: Route to query.
  • encryptedPUUID: Summoner ID

Riot API Reference

summoner-v4.getByPUUID

func (*SummonerV4) ByRSOPUUID

func (endpoint *SummonerV4) ByRSOPUUID(ctx context.Context, route PlatformRoute, rsoPUUID string) (*SummonerV4DTO, error)

Get a summoner by its RSO encrypted PUUID.

Parameters

  • route: Route to query.
  • rsoPUUID: Summoner ID

Riot API Reference

summoner-v4.getByRSOPUUID

func (*SummonerV4) BySummonerID

func (endpoint *SummonerV4) BySummonerID(ctx context.Context, route PlatformRoute, encryptedSummonerId string) (*SummonerV4DTO, error)

Get a summoner by summoner ID.

Parameters

  • route: Route to query.
  • encryptedSummonerId: Summoner ID

Riot API Reference

summoner-v4.getBySummonerId

type SummonerV4DTO

type SummonerV4DTO struct {
	// Encrypted account ID. Max length 56 characters.
	AccountID string `json:"accountId,omitempty"`
	// Encrypted summoner ID. Max length 63 characters.
	ID string `json:"id,omitempty"`
	// Encrypted PUUID. Exact length of 78 characters.
	PUUID string `json:"puuid,omitempty"`
	// ID of the summoner icon associated with the summoner.
	ProfileIconID int32 `json:"profileIconId,omitempty"`
	// Date summoner was last modified specified as epoch milliseconds. The following events will update this timestamp: profile icon change, playing the tutorial or advanced tutorial, finishing a game, summoner name change
	RevisionDate int64 `json:"revisionDate,omitempty"`
	// Summoner level associated with the summoner.
	SummonerLevel int64 `json:"summonerLevel,omitempty"`
}

summoner-v4.SummonerDTO

type Team

type Team int32

Team IDs for League of Legends.

const (
	// Team ID zero for 2v2v2v2 Arena `CHERRY` game mode. (TODO: SUBJECT TO CHANGE?)
	ZERO Team = 0
	// Blue team (bottom left on Summoner's Rift).
	BLUE Team = 100
	// Red team (top right on Summoner's Rift).
	RED Team = 200
	// "killerTeamId" when Baron Nashor spawns and kills Rift Herald.
	OTHER Team = 300
)

func (Team) String

func (team Team) String() string

type Tier

type Tier string

League of Legends ranked tiers, such as gold, diamond, challenger, etc.

const (
	IRON        Tier = "IRON"
	BRONZE      Tier = "BRONZE"
	SILVER      Tier = "SILVER"
	GOLD        Tier = "GOLD"
	PLATINUM    Tier = "PLATINUM"
	EMERALD     Tier = "EMERALD"
	DIAMOND     Tier = "DIAMOND"
	MASTER      Tier = "MASTER"
	GRANDMASTER Tier = "GRANDMASTER"
	CHALLENGER  Tier = "CHALLENGER"
)

func (Tier) String

func (tier Tier) String() string

type TournamentCodeParametersV5DTO

type TournamentCodeParametersV5DTO struct {
	// The map type of the game.
	//
	// (Legal values:  SUMMONERS_RIFT,  HOWLING_ABYSS)
	MapType string `json:"mapType,omitempty"`
	// Optional string that may contain any data in any format, if specified at all. Used to denote any custom information about the game.
	Metadata string `json:"metadata,omitempty"`
	// The pick type of the game.
	//
	// (Legal values:  BLIND_PICK,  DRAFT_MODE,  ALL_RANDOM,  TOURNAMENT_DRAFT)
	PickType string `json:"pickType,omitempty"`
	// The spectator type of the game.
	//
	// (Legal values:  NONE,  LOBBYONLY,  ALL)
	SpectatorType string `json:"spectatorType,omitempty"`
	// Optional list of encrypted puuids in order to validate the players eligible to join the lobby. NOTE: We currently do not enforce participants at the team level, but rather the aggregate of teamOne and teamTwo. We may add the ability to enforce at the team level in the future.
	AllowedParticipants []string `json:"allowedParticipants,omitempty"`
	// The team size of the game. Valid values are 1-5.
	TeamSize int32 `json:"teamSize,omitempty"`
	// Checks if allowed participants are enough to make full teams.
	EnoughPlayers bool `json:"enoughPlayers,omitempty"`
}

tournament-v5.TournamentCodeParametersV5

type TournamentCodeUpdateParametersV5DTO

type TournamentCodeUpdateParametersV5DTO struct {
	// The map type
	//
	// (Legal values:  SUMMONERS_RIFT,  HOWLING_ABYSS)
	MapType string `json:"mapType,omitempty"`
	// The pick type
	//
	// (Legal values:  BLIND_PICK,  DRAFT_MODE,  ALL_RANDOM,  TOURNAMENT_DRAFT)
	PickType string `json:"pickType,omitempty"`
	// The spectator type
	//
	// (Legal values:  NONE,  LOBBYONLY,  ALL)
	SpectatorType string `json:"spectatorType,omitempty"`
	// Optional list of encrypted puuids in order to validate the players eligible to join the lobby. NOTE: We currently do not enforce participants at the team level, but rather the aggregate of teamOne and teamTwo. We may add the ability to enforce at the team level in the future.
	AllowedParticipants []string `json:"allowedParticipants,omitempty"`
}

tournament-v5.TournamentCodeUpdateParametersV5

type TournamentCodeV5DTO

type TournamentCodeV5DTO struct {
	// The tournament code.
	Code string `json:"code,omitempty"`
	// The lobby name for the tournament code game.
	LobbyName string `json:"lobbyName,omitempty"`
	// The game map for the tournament code game
	Map string `json:"map,omitempty"`
	// The metadata for tournament code.
	MetaData string `json:"metaData,omitempty"`
	// The password for the tournament code game.
	Password string `json:"password,omitempty"`
	// The pick mode for tournament code game.
	PickType string `json:"pickType,omitempty"`
	// The tournament code's region.
	//
	// (Legal values:  BR,  EUNE,  EUW,  JP,  LAN,  LAS,  NA,  OCE,  PBE,  RU,  TR,  KR,  PH,  SG,  TH,  TW,  VN)
	Region string `json:"region,omitempty"`
	// The spectator mode for the tournament code game.
	Spectators string `json:"spectators,omitempty"`
	// The puuids of the participants (Encrypted)
	Participants []string `json:"participants,omitempty"`
	// The tournament code's ID.
	ID int32 `json:"id,omitempty"`
	// The provider's ID.
	ProviderID int32 `json:"providerId,omitempty"`
	// The team size for the tournament code game.
	TeamSize int32 `json:"teamSize,omitempty"`
	// The tournament's ID.
	TournamentID int32 `json:"tournamentId,omitempty"`
}

tournament-v5.TournamentCodeV5DTO

type TournamentGamesV5DTO

type TournamentGamesV5DTO struct {
	GameMode string `json:"gameMode,omitempty"`
	GameName string `json:"gameName,omitempty"`
	GameType string `json:"gameType,omitempty"`
	// Metadata for the TournamentCode
	MetaData string `json:"metaData,omitempty"`
	// Region of the game
	Region string `json:"region,omitempty"`
	// Tournament Code
	ShortCode   string                `json:"shortCode,omitempty"`
	LosingTeam  []TournamentTeamV5DTO `json:"losingTeam,omitempty"`
	WinningTeam []TournamentTeamV5DTO `json:"winningTeam,omitempty"`
	GameID      int64                 `json:"gameId,omitempty"`
	// Game Map ID
	GameMap int32 `json:"gameMap,omitempty"`
}

tournament-v5.TournamentGamesV5

type TournamentLobbyEventV5DTO

type TournamentLobbyEventV5DTO struct {
	// The type of event that was triggered
	EventType string `json:"eventType,omitempty"`
	// The puuid that triggered the event (Encrypted)
	PUUID string `json:"puuid,omitempty"`
	// Timestamp from the event
	Timestamp string `json:"timestamp,omitempty"`
}

tournament-v5.LobbyEventV5DTO

type TournamentLobbyEventWrapperV5DTO

type TournamentLobbyEventWrapperV5DTO struct {
	EventList []TournamentLobbyEventV5DTO `json:"eventList,omitempty"`
}

tournament-v5.LobbyEventV5DTOWrapper

type TournamentProviderRegistrationParametersV5DTO

type TournamentProviderRegistrationParametersV5DTO struct {
	// The region in which the provider will be running tournaments.
	//
	// (Legal values:  BR,  EUNE,  EUW,  JP,  LAN,  LAS,  NA,  OCE,  PBE,  RU,  TR,  KR,  PH,  SG,  TH,  TW,  VN)
	Region string `json:"region,omitempty"`
	// The provider's callback URL to which tournament game results in this region should be posted. The URL must be well-formed, use the http or https protocol, and use the default port for the protocol (http URLs must use port 80, https URLs must use port 443).
	URL string `json:"url,omitempty"`
}

tournament-v5.ProviderRegistrationParametersV5

type TournamentRegion

type TournamentRegion string

Tournament regions for League of Legends.

const (
	// Brazil.
	BR TournamentRegion = "br"
	// Europe, Northeast.
	EUNE TournamentRegion = "eune"
	// Europe, West.
	EUW TournamentRegion = "euw"
	// Japan.
	JP TournamentRegion = "jp"
	// Latin America, North.
	LAN TournamentRegion = "lan"
	// Latin America, South.
	LAS TournamentRegion = "las"
	// North America.
	NA TournamentRegion = "na"
	// Oceania.
	OCE TournamentRegion = "oce"
	// Public Beta Environment, special beta testing platform. Located in North America.
	PBE TournamentRegion = "pbe"
	// Turkey
	TR TournamentRegion = "tr"
)

func (TournamentRegion) String

func (route TournamentRegion) String() string

type TournamentRegistrationParametersV5DTO

type TournamentRegistrationParametersV5DTO struct {
	// The optional name of the tournament.
	Name string `json:"name,omitempty"`
	// The provider ID to specify the regional registered provider data to associate this tournament.
	ProviderID int32 `json:"providerId,omitempty"`
}

tournament-v5.TournamentRegistrationParametersV5

type TournamentStubCodeParametersV5DTO

type TournamentStubCodeParametersV5DTO struct {
	// The map type of the game.
	//
	// (Legal values:  SUMMONERS_RIFT,  HOWLING_ABYSS)
	MapType string `json:"mapType,omitempty"`
	// Optional string that may contain any data in any format, if specified at all. Used to denote any custom information about the game.
	Metadata string `json:"metadata,omitempty"`
	// The pick type of the game.
	//
	// (Legal values:  BLIND_PICK,  DRAFT_MODE,  ALL_RANDOM,  TOURNAMENT_DRAFT)
	PickType string `json:"pickType,omitempty"`
	// The spectator type of the game.
	//
	// (Legal values:  NONE,  LOBBYONLY,  ALL)
	SpectatorType string `json:"spectatorType,omitempty"`
	// Optional list of encrypted puuids in order to validate the players eligible to join the lobby. NOTE: We currently do not enforce participants at the team level, but rather the aggregate of teamOne and teamTwo. We may add the ability to enforce at the team level in the future.
	AllowedParticipants []string `json:"allowedParticipants,omitempty"`
	// The team size of the game. Valid values are 1-5.
	TeamSize int32 `json:"teamSize,omitempty"`
	// Checks if allowed participants are enough to make full teams.
	EnoughPlayers bool `json:"enoughPlayers,omitempty"`
}

tournament-stub-v5.TournamentCodeParametersV5

type TournamentStubCodeV5DTO

type TournamentStubCodeV5DTO struct {
	// The tournament code.
	Code string `json:"code,omitempty"`
	// The lobby name for the tournament code game.
	LobbyName string `json:"lobbyName,omitempty"`
	// The game map for the tournament code game
	Map string `json:"map,omitempty"`
	// The metadata for tournament code.
	MetaData string `json:"metaData,omitempty"`
	// The password for the tournament code game.
	Password string `json:"password,omitempty"`
	// The pick mode for tournament code game.
	PickType string `json:"pickType,omitempty"`
	// The tournament code's region.
	//
	// (Legal values:  BR,  EUNE,  EUW,  JP,  LAN,  LAS,  NA,  OCE,  PBE,  RU,  TR,  KR)
	Region string `json:"region,omitempty"`
	// The spectator mode for the tournament code game.
	Spectators string `json:"spectators,omitempty"`
	// The puuids of the participants (Encrypted)
	Participants []string `json:"participants,omitempty"`
	// The tournament code's ID.
	ID int32 `json:"id,omitempty"`
	// The provider's ID.
	ProviderID int32 `json:"providerId,omitempty"`
	// The team size for the tournament code game.
	TeamSize int32 `json:"teamSize,omitempty"`
	// The tournament's ID.
	TournamentID int32 `json:"tournamentId,omitempty"`
}

tournament-stub-v5.TournamentCodeV5DTO

type TournamentStubLobbyEventV5DTO

type TournamentStubLobbyEventV5DTO struct {
	// The type of event that was triggered
	EventType string `json:"eventType,omitempty"`
	// The puuid that triggered the event (Encrypted)
	PUUID string `json:"puuid,omitempty"`
	// Timestamp from the event
	Timestamp string `json:"timestamp,omitempty"`
}

tournament-stub-v5.LobbyEventV5DTO

type TournamentStubLobbyEventWrapperV5DTO

type TournamentStubLobbyEventWrapperV5DTO struct {
	EventList []TournamentStubLobbyEventV5DTO `json:"eventList,omitempty"`
}

tournament-stub-v5.LobbyEventV5DTOWrapper

type TournamentStubProviderRegistrationParametersV5DTO

type TournamentStubProviderRegistrationParametersV5DTO struct {
	// The region in which the provider will be running tournaments.
	//
	// (Legal values:  BR,  EUNE,  EUW,  JP,  LAN,  LAS,  NA,  OCE,  PBE,  RU,  TR,  KR)
	Region string `json:"region,omitempty"`
	// The provider's callback URL to which tournament game results in this region should be posted. The URL must be well-formed, use the http or https protocol, and use the default port for the protocol (http URLs must use port 80, https URLs must use port 443).
	URL string `json:"url,omitempty"`
}

tournament-stub-v5.ProviderRegistrationParametersV5

type TournamentStubRegistrationParametersV5DTO

type TournamentStubRegistrationParametersV5DTO struct {
	// The optional name of the tournament.
	Name string `json:"name,omitempty"`
	// The provider ID to specify the regional registered provider data to associate this tournament.
	ProviderID int32 `json:"providerId,omitempty"`
}

tournament-stub-v5.TournamentRegistrationParametersV5

type TournamentStubV5

type TournamentStubV5 struct {
	// contains filtered or unexported fields
}

Riot API Reference

tournament-stub-v5

func (*TournamentStubV5) CreateTournamentCode

func (endpoint *TournamentStubV5) CreateTournamentCode(ctx context.Context, route api.RegionalRoute, body *TournamentStubCodeParametersV5DTO, count int32, tournamentId int64) ([]string, error)

Create a tournament code for the given tournament - Stub method

Parameters

  • route: Route to query.
  • count (optional): The number of codes to create (max 1000)
  • tournamentId: The tournament ID

Riot API Reference

tournament-stub-v5.createTournamentCode

func (*TournamentStubV5) LobbyEventsByCode

func (endpoint *TournamentStubV5) LobbyEventsByCode(ctx context.Context, route api.RegionalRoute, tournamentCode string) (*TournamentStubLobbyEventWrapperV5DTO, error)

Gets a list of lobby events by tournament code - Stub method

Parameters

  • route: Route to query.
  • tournamentCode: The short code to look up lobby events for

Riot API Reference

tournament-stub-v5.getLobbyEventsByCode

func (*TournamentStubV5) RegisterProviderData

Creates a tournament provider and returns its ID - Stub method

Implementation Notes

Providers will need to call this endpoint first to register their callback URL and their API key with the tournament system before any other tournament provider endpoints will work.

Parameters

  • route: Route to query.

Riot API Reference

tournament-stub-v5.registerProviderData

func (*TournamentStubV5) RegisterTournament

func (endpoint *TournamentStubV5) RegisterTournament(ctx context.Context, route api.RegionalRoute, body *TournamentStubRegistrationParametersV5DTO) (int32, error)

Creates a tournament and returns its ID - Stub method

Parameters

  • route: Route to query.

Riot API Reference

tournament-stub-v5.registerTournament

func (*TournamentStubV5) TournamentCode

func (endpoint *TournamentStubV5) TournamentCode(ctx context.Context, route api.RegionalRoute, tournamentCode string) (*TournamentStubCodeV5DTO, error)

Returns the tournament code DTO associated with a tournament code string - Stub Method

Parameters

  • route: Route to query.
  • tournamentCode: The tournament code string.

Riot API Reference

tournament-stub-v5.getTournamentCode

type TournamentTeamV5DTO

type TournamentTeamV5DTO struct {
	// Player Unique UUID (Encrypted)
	PUUID string `json:"puuid,omitempty"`
}

tournament-v5.TournamentTeamV5

type TournamentV5

type TournamentV5 struct {
	// contains filtered or unexported fields
}

Riot API Reference

tournament-v5

func (*TournamentV5) CreateTournamentCode

func (endpoint *TournamentV5) CreateTournamentCode(ctx context.Context, route api.RegionalRoute, body *TournamentCodeParametersV5DTO, tournamentId int64, count int32) ([]string, error)

Create a tournament code for the given tournament.

Parameters

  • route: Route to query.
  • tournamentId: The tournament ID
  • count (optional): The number of codes to create (max 1000)

Riot API Reference

tournament-v5.createTournamentCode

func (*TournamentV5) Games

func (endpoint *TournamentV5) Games(ctx context.Context, route api.RegionalRoute, tournamentCode string) ([]TournamentGamesV5DTO, error)

Get games details

Implementation Notes

Additional endpoint to get tournament games. From this endpoint, you are able to get participants PUUID (the callback doesn't contain this info).

You can also use it to check if the game was recorded and validate callbacks. If the endpoint returns the game, it means a callback was attempted.

This will only work for tournament codes created after November 10, 2023.

Parameters

  • route: Route to query.
  • tournamentCode

Riot API Reference

tournament-v5.getGames

func (*TournamentV5) LobbyEventsByCode

func (endpoint *TournamentV5) LobbyEventsByCode(ctx context.Context, route api.RegionalRoute, tournamentCode string) (*TournamentLobbyEventWrapperV5DTO, error)

Gets a list of lobby events by tournament code.

Parameters

  • route: Route to query.
  • tournamentCode: The short code to look up lobby events for

Riot API Reference

tournament-v5.getLobbyEventsByCode

func (*TournamentV5) RegisterProviderData

func (endpoint *TournamentV5) RegisterProviderData(ctx context.Context, route api.RegionalRoute, body *TournamentProviderRegistrationParametersV5DTO) (int32, error)

Creates a tournament provider and returns its ID.

Implementation Notes

Providers will need to call this endpoint first to register their callback URL and their API key with the tournament system before any other tournament provider endpoints will work.

Parameters

  • route: Route to query.

Riot API Reference

tournament-v5.registerProviderData

func (*TournamentV5) RegisterTournament

func (endpoint *TournamentV5) RegisterTournament(ctx context.Context, route api.RegionalRoute, body *TournamentRegistrationParametersV5DTO) (int32, error)

Creates a tournament and returns its ID.

Parameters

  • route: Route to query.

Riot API Reference

tournament-v5.registerTournament

func (*TournamentV5) TournamentCode

func (endpoint *TournamentV5) TournamentCode(ctx context.Context, route api.RegionalRoute, tournamentCode string) (*TournamentCodeV5DTO, error)

Returns the tournament code DTO associated with a tournament code string.

Parameters

  • route: Route to query.
  • tournamentCode: The tournament code string.

Riot API Reference

tournament-v5.getTournamentCode

func (*TournamentV5) UpdateCode

func (endpoint *TournamentV5) UpdateCode(ctx context.Context, route api.RegionalRoute, body *TournamentCodeUpdateParametersV5DTO, tournamentCode string) error

Update the pick type, map, spectator type, or allowed puuids for a code.

Parameters

  • route: Route to query.
  • tournamentCode: The tournament code to update

Riot API Reference

tournament-v5.updateCode

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL