A JSON configuration object or a path to a valid YAML file.
The configuration for the module instance. Can only be set in the constructor.
Enum corresponding to ranked divisions in TFT and League of Legends.
Enum corresponding to games for the
/riot/account/v1/accounts/by-riot-id/{gameName}/{tagLine} endpoint.
Object containing enums corresponding to different game queue types.
Object containing enums corresponding to different API regions.
Enum corresponding to ranked tiers in TFT and League of Legends.
An object containing all of the DTO interfaces associated with API responses for all endpoints.
Object containing actions corresponding to the Game Client API specifications. This includes the Live Client Data and Replay endpoints, which are hosted locally during a League of Legends match at https://127.0.0.1:2999.
The Live Client Data API server is only active when playing a League of Legends match or watching a replay.
Action constructor corresponding to the following Live Client Data endpoints:
/swagger/v3/openapi.jsonRequests the OpenAPI v3 specs for the Game Client API.
Action constructor corresponding to the following Live Client Data endpoints:
/swagger/v2/swagger.jsonRequests the Swagger v2 specs for the Game Client API.
Object containing actions corresponding to the Live Client Data endpoints. The Live Client Data API is hosted locally during a League of Legends match at https://127.0.0.1:2999. (All endpoints can be found under the /liveclientdata path.)
The Live Client Data API server is only active when playing a League of Legends match or watching a replay.
Action constructor corresponding to the following Live Client Data endpoints:
/liveclientdata/allgamedataGet all available data. You can find a sample response here.
Action constructor corresponding to the following Live Client Data endpoints:
/liveclientdata/eventdataGet a list of events that have occurred in the game. You can find a list of sample events here.
Action constructor corresponding to the following Live Client Data endpoints:
/liveclientdata/gamestatsFetch basic data about the game.
Contains a list of endpoints that retrieve information about the active player.
Action constructor corresponding to the following Live Client Data endpoints:
/liveclientdata/activeplayerabilitiesGet the abilities for the active player.
Action constructor corresponding to the following Live Client Data endpoints:
/liveclientdata/activeplayernameReturns the player name.
Action constructor corresponding to the following Live Client Data endpoints:
/liveclientdata/activeplayerGet all data about the active player.
Action constructor corresponding to the following Live Client Data endpoints:
/liveclientdata/activeplayerrunesRetrieve the full list of runes for the active player.
Contains a list of endpoints that retrieve information about any player in the game.
Action constructor corresponding to the following Live Client Data endpoints:
/liveclientdata/playeritemsRetrieve the list of items for the player.
Action constructor corresponding to the following Live Client Data endpoints:
/liveclientdata/playerlistRetrieve the list of players in the game and their stats.
Action constructor corresponding to the following Live Client Data endpoints:
/liveclientdata/playermainrunesRetrieve the basic runes of any player.
Action constructor corresponding to the following Live Client Data endpoints:
/liveclientdata/playerscoresRetrieve the list of the current scores for the player.
Action constructor corresponding to the following Live Client Data endpoints:
/liveclientdata/playersummonerspellsRetrieve the list of the summoner spells for the player.
Object containing actions corresponding to the /lol set of endpoints.
Action constructor corresponding to the following endpoints:
/lol/status/v4/platform-dataAction constructor corresponding to the following endpoints:
/lol/summoner/v4/summoners/by-account/{encryptedAccountId}/lol/summoner/v4/summoners/by-name/{summonerName}/lol/summoner/v4/summoners/by-puuid/{encryptedPUUID}/lol/summoner/v4/summoners/{encryptedSummonerId}Object containing actions corresponding to the /lol/challenges set of endpoint.
Action constructor corresponding to the following endpoints:
/lol/challenges/v1/challenges/{challengeId}/configAction constructor corresponding to the following endpoints:
/lol/challenges/v1/challenges/configAction constructor corresponding to the following endpoints:
/lol/challenges/v1/challenges/{challengeId}/leaderboards/by-level/{level}Action constructor corresponding to the following endpoints:
/lol/challenges/v1/challenges/{challengeId}/percentilesAction constructor corresponding to the following endpoints:
/lol/challenges/v1/challenges/percentilesAction constructor corresponding to the following endpoints:
/lol/challenges/v1/player-data/{puuid}Object containing actions corresponding to the /lol/clash set of endpoints.
Action constructor corresponding to the following endpoints:
/lol/clash/v1/players/by-summoner/{summonerId}Action constructor corresponding to the following endpoints:
/lol/clash/v1/teams/{teamId}Action constructor corresponding to the following endpoints:
/lol/clash/v1/tournaments/by-team/{teamId}/lol/clash/v1/tournaments/{tournamentId}Action constructor corresponding to the following endpoints:
/lol/clash/v1/tournamentsObject containing actions corresponding to League of Legends Data Dragon endpoints. See the official Data Dragon documentation here.
Action constructor corresponding to a generic Data Dragon asset.
/cdn${assetPath}Returns the target file as a Buffer object.
Action constructor corresponding to the following Data Dragon files:
/cdn/languages.jsonReturns a list of languages supported by Data Dragon. See the official documentation for more information.
Action constructor corresponding to the following Data Dragon files:
/realms/{region}.jsonReturns the latest Data Dragon version for a given region (realm). Note that Data Dragon versions are not always equivalent to the League of Legends client version within a given region.
Action constructor corresponding to the following Data Dragon files:
/cdn/dragontail-{version}.tgzReturns a compressed tarball (.tgz) file containing all Data Dragon assets for a given patch. Note that Data Dragon is updated manually after each patch, so it may not always be updated immediately after a new patch is released to the live servers.
Swaps to a .zip file automatically when fetching data for patch 10.10.5.
Returns data as a Buffer object.
Action constructor corresponding to the following Data Dragon files:
/api/versions.jsonReturns a JSON file (an array) containing all valid Data Dragon versions. Most patches will only have one associated build, but occasionally multiple builds are necessary due to errors. As a result, use the latest version for a given patch whenever possible.
Action constructor corresponding to the following Data Dragon files:
/cdn/{version}/data/{locale}/champion/{champion}.jsonReturns detailed information and additional data about a single champion. See the official API documentation for more information about interpreting spell text.
Action constructor corresponding to the following Data Dragon files:
/cdn/{version}/data/{locale}/champion.jsonReturns a list of champions along with a brief summary for each champion. See the official API documentation for more information about interpreting spell text.
Action constructor corresponding to the following Data Dragon files:
/cdn/{version}/img/champion/{champion}.pngReturns the icon (square) art asset for a given champion.
Returns data as a Buffer object containing PNG data.
Action constructor corresponding to the following Data Dragon files:
/cdn/img/champion/loading/{champion}_{skin}.jpgReturns the loading art image for a given champion and skin. The number corresponding
to each skin can be found under the num field in the skins section of each champion's
detailed Data Dragon file. 0 is always the default splash art.
Returns data as a Buffer object containing JPG data.
Action constructor corresponding to the following Data Dragon files:
/cdn/{version}/img/passive/{spell}.pngReturns the icon art asset for a passive ability. The filename for each champion's passive can be
found in the passive field's image data (as the full field) within an individual champion's Data Dragon file.
Returns data as a Buffer object containing PNG data.
Action constructor corresponding to the following Data Dragon files:
/cdn/img/champion/splash/{champion}_{skin}.jpgReturns the splash art assets for a given champion and skin. The number corresponding
to each skin can be found under the num field in the skins section of each champion's
detailed Data Dragon file. 0 is always the default splash art.
Returns data as a Buffer object containing JPG data.
Action constructor corresponding to the following Data Dragon files:
/cdn/img/champion/tiles/{champion}_{skin}.jpgReturns the tile art image for a given champion and skin. The number corresponding
to each skin can be found under the num field in the skins section of each champion's
detailed Data Dragon file. 0 is always the default splash art.
Returns data as a Buffer object containing JPG data.
Action constructor corresponding to the following Data Dragon files:
/cdn/{version}/img/item/{assetId}.pngReturns the art asset for an item by item ID. A list of item IDs can be found in the item data file.
Returns data as a Buffer object containing PNG data.
Action constructor corresponding to the following Data Dragon files:
/cdn/{version}/data/{locale}/item.jsonReturns detailed information about all items in League of Legends, including purchase value, sell value, build path, stats, and descriptions. See the official Data Dragon API documentation for more information.
Action constructor corresponding to the following Data Dragon files:
/cdn/{version}/img/map/{assetId}.pngReturns the art asset for the minimap corresponding to a given map ID. Map IDs can be found under Game Constants > Map Names in the official Riot API documentation.
Returns data as a Buffer object containing PNG data.
Action constructor corresponding to the following Data Dragon files:
/cdn/{version}/img/profileicon/{assetId}.pngReturns the art asset for a profile icon by ID.
Returns data as a Buffer object containing PNG data.
Action constructor corresponding to the following Data Dragon files:
/cdn/{version}/data/{locale}/profileicon.jsonReturns a list of summoner icons/profile icons.
Action constructor corresponding to the following Data Dragon files:
/cdn/img/perk-images${assetPath}Returns art for Runes Reforged given a specified asset path.
Stat runes are found under the /StatMods folder, while rune tree icons, rune icons (including keystones),
and the runes logo are found under the /Styles folder.
Action constructor corresponding to the following Data Dragon files:
/cdn/{version}/data/{locale}/runesReforged.jsonReturns detailed information about all runes in League of Legends, including short and long descriptions of each rune. See the official Data Dragon API documentation for more information.
Object containing actions that retrieve legacy scoreboard art (from patch 5.5.1 and earlier).
Object containing actions that retrieve legacy scoreboard art (from patch 5.5.1 and earlier).
Action constructor corresponding to the following Data Dragon files:
/cdn/5.5.1/img/ui/champion.pngReturns data as a Buffer object.
Action constructor corresponding to the following Data Dragon files:
/cdn/5.5.1/img/ui/items.pngReturns data as a Buffer object.
Action constructor corresponding to the following Data Dragon files:
/cdn/5.5.1/img/ui/minion.pngReturns data as a Buffer object.
Action constructor corresponding to the following Data Dragon files:
/cdn/5.5.1/img/ui/score.pngReturns data as a Buffer object.
Action constructor corresponding to the following Data Dragon files:
/cdn/5.5.1/img/ui/spells.pngReturns data as a Buffer object.
Action constructor corresponding to the following Data Dragon files:
/cdn/{version}/img/spell/{spell}.pngReturns the art asset for a non-passive ability. The filename corresponding to a given ability can be
found in the full entry of the image data within the spells field of an individual champion's Data Dragon file.
Returns data as a Buffer object containing PNG data.
Action constructor corresponding to the following Data Dragon files:
/cdn/{version}/img/sprite/{assetId}.pngReturns the sprite art assets for a given asset ID.
Returns data as a Buffer object containing PNG data.
Action constructor corresponding to the following Data Dragon files:
/cdn/{version}/data/{locale}/summoner.jsonReturns a list of summoner spells. Art assets for each summoner spell can be retrieved using the
galeforce.ddragon.spell.art method.
Object containing actions corresponding to the /lol/league set of endpoints.
Action constructor corresponding to the following endpoints:
/lol/league/v4/entries/by-summoner/{encryptedSummonerId}/lol/league/v4/entries/{queue}/{tier}/{division}Action constructor corresponding to the following endpoints:
/lol/league/v4/challengerleagues/by-queue/{queue}/lol/league/v4/grandmasterleagues/by-queue/{queue}/lol/league/v4/masterleagues/by-queue/{queue}/lol/league/v4/entries/by-summoner/{encryptedSummonerId}Object containing actions corresponding to the /lol/champion-mastery set of endpoints.
Action constructor corresponding to the following endpoints:
/lol/champion-mastery/v4/champion-masteries/by-summoner/{encryptedSummonerId}/by-champion/{championId}Action constructor corresponding to the following endpoints:
/lol/champion-mastery/v4/champion-masteries/by-summoner/{encryptedSummonerId}Action constructor corresponding to the following endpoints:
/lol/champion-mastery/v4/scores/by-summoner/{encryptedSummonerId}Object containing actions corresponding to the /lol/match set of endpoints.
Action constructor corresponding to the following endpoints:
/lol/match/v5/matches/by-puuid/{puuid}/idsAction constructor corresponding to the following endpoints:
/lol/match/v5/matches/{matchId}Action constructor corresponding to the following endpoints:
/lol/match/v5/matches/{matchId}/timelineObject containing actions corresponding to the /lol/platform set of endpoints.
This includes the CHAMPION-V3 API section.
Action constructor corresponding to the following endpoints:
/lol/platform/v3/champion-rotationsObject containing actions corresponding to the /lol/spectator set of endpoints.
Action constructor corresponding to the following endpoints:
/lol/spectator/v4/active-games/by-summoner/{encryptedSummonerId}Action constructor corresponding to the following endpoints:
/lol/spectator/v4/featured-gamesObject containing actions corresponding to the /lol/tournament set of endpoints.
Note that these endpoints require a tournament-approved production key to use.
Please visit here for more information.
Action constructor corresponding to the following endpoints:
/lol/tournament/v4/lobby-events/by-code/{tournamentCode}/lol/tournament-stub/v4/lobby-events/by-code/{tournamentCode}Tournament stub endpoints can be accessed by passing in true.
Action constructor corresponding to the following endpoints:
/lol/tournament/v4/providers/lol/tournament-stub/v4/providersTournament stub endpoints can be accessed by passing in true.
Action constructor corresponding to the following endpoints:
/lol/tournament/v4/tournaments/lol/tournament-stub/v4/tournamentsTournament stub endpoints can be accessed by passing in true.
Object containing actions corresponding to the /lol/tournament/v4/codes set of endpoints.
Action constructor corresponding to the following endpoints:
/lol/tournament/v4/codes/lol/tournament-stub/v4/codesTournament stub endpoints can be accessed by passing in true.
Action constructor corresponding to the following endpoints:
/lol/tournament/v4/codes/{tournamentCode}Action constructor corresponding to the following endpoints:
/lol/tournament/v4/codes/{tournamentCode}Object containing actions corresponding to the /lor set of endpoints.
Action constructor corresponding to the following endpoints:
/lor/status/v1/platform-dataObject containing actions corresponding to Legends of Runeterra Data Dragon endpoints. See the official Data Dragon documentation here.
Object containing actions corresponding to the "core bundles," which contain data shared across all sets.
Action constructor corresponding to the following Data Dragon files:
/{version}/core-{locale}.zipReturns a .zip file containing all Data Dragon core assets for a given version.
Returns data as a Buffer object.
Action constructor corresponding to the following Data Dragon files:
/${version}/core/${locale}/data/globals-${locale}.jsonReturns the set of values shared across cards of all sets, including keywords, rarities, regions/factions, spell speeds, and card types.
Action constructor corresponding to the following Data Dragon files:
/${version}/core/${locale}/img/region/icon-${lorRegion}.pngReturns the art asset for a region's icon in Legends of Runeterra.
Returns data as a Buffer object containing PNG data.
Object containing actions that retrieve data corresponding to individual released sets.
Action constructor corresponding to the following Data Dragon files:
/${version}/set${lorSet}/${locale}/data/set${lorSet}-${locale}.jsonReturns data related to cards in the provided set, including assets, associated cards, in-game properties (attack, health, cost, etc.), description, flavor text, name, code, keywords, rarity, type, and subtype.
Object containing actions that return Data Dragon assets for a given set as a Buffer containing .zip data.
Action constructor corresponding to the following Data Dragon files:
/${version}/set${lorSet}-${locale}.zipReturns a .zip file containing the full Data Dragon assets for a given set, including all card art, alternative art, and full-size illustrations for each card.
Returns data as a Buffer object.
Action constructor corresponding to the following Data Dragon files:
/${version}/set${lorSet}-${locale}.zipReturns a .zip file containing the lite Data Dragon assets for a given set, which includes only the card art and alternative art (without the full-size illustrations).
Returns data as a Buffer object.
Object containing actions that return Data Dragon assets for a given Legends of Runeterra card, on a set-by-set basis.
Object containing actions that return Data Dragon art assets for a given Legends of Runeterra card.
Action constructor corresponding to the following Data Dragon files:
/${version}/set${lorSet}/${locale}/img/cards/${card}-alt.pngReturns the in-game alternative art asset for a card in Legends of Runeterra.
Returns data as a Buffer object containing PNG data.
Action constructor corresponding to the following Data Dragon files:
/${version}/set${lorSet}/${locale}/img/cards/${card}-alt-full.pngReturns the in-game alternative full art asset for a card in Legends of Runeterra.
Returns data as a Buffer object containing PNG data.
Action constructor corresponding to the following Data Dragon files:
/${version}/set${lorSet}/${locale}/img/cards/${card}-full.pngReturns the in-game full art asset for a card in Legends of Runeterra.
Returns data as a Buffer object containing PNG data.
Action constructor corresponding to the following Data Dragon files:
/${version}/set${lorSet}/${locale}/img/cards/${card}.pngReturns the in-game art asset for a card in Legends of Runeterra.
Returns data as a Buffer object containing PNG data.
Object containing actions corresponding to the /lor/match set of endpoints.
Action constructor corresponding to the following endpoints:
/lor/match/v1/matches/by-puuid/{puuid}/idsAction constructor corresponding to the following endpoints:
/lor/match/v1/matches/{matchId}Action constructor corresponding to the following endpoints:
/lor/ranked/v1/leaderboardsObject containing actions corresponding to the /riot set of endpoints.
Object containing actions corresponding to the /riot/account set of endpoints.
Action constructor corresponding to the following endpoints:
/riot/account/v1/accounts/by-puuid/{puuid}/riot/account/v1/accounts/by-riot-id/{gameName}/{tagLine}Action constructor corresponding to the following endpoints:
/riot/account/v1/active-shards/by-game/{game}/by-puuid/{puuid}Object containing actions corresponding to the /tft set of endpoints.
Action constructor corresponding to the following endpoints:
/lor/ranked/v1/leaderboardsObject containing actions corresponding to the /tft/league set of endpoints.
Action constructor corresponding to the following endpoints:
/tft/league/v1/entries/by-summoner/{encryptedSummonerId}/tft/league/v1/entries/{tier}/{division}Action constructor corresponding to the following endpoints:
/tft/league/v1/challenger/tft/league/v1/grandmaster/tft/league/v1/master/tft/league/v1/leagues/{leagueId} Object containing actions corresponding to the /tft/match set of endpoints.
Action constructor corresponding to the following endpoints:
/lor/ranked/v1/leaderboardsAction constructor corresponding to the following endpoints:
/lor/ranked/v1/leaderboardsObject containing actions corresponding to the /val set of endpoints.
Action constructor corresponding to the following endpoints:
/val/content/v1/contentsAction constructor corresponding to the following endpoints:
/val/status/v1/platform-dataObject containing actions corresponding to the /val/match set of endpoints.
Note that these endpoints require a Valorant-approved production key to use.
Please visit here for more information.
Action constructor corresponding to the following endpoints:
/val/match/v1/matchlists/by-puuid/{puuid}Action constructor corresponding to the following endpoints:
/val/match/v1/matches/{matchId}Action constructor corresponding to the following endpoints:
/val/match/v1/recent-matches/by-queue/{queue}Object containing actions corresponding to the /val/ranked set of endpoints.
Action constructor corresponding to the following endpoints:
/val/ranked/v1/leaderboards/by-act/{actId}
Initializes the Galeforce module with a provided configuration object. The configuration object is verified using a JSON schema generated from the ConfigInterface interface.
Will throw an Error if provided an invalid configuration file or object.