Module: staticdata

Wrapper for Riot's static data v3 api
NOTE: calls to this API will NOT count towards your rate limit

Source:
See:

Methods


<static> getChampionById(champId, dataType, byId, locale, version, region)

gets a champion specific information from a specified champion's id

Parameters:
Name Type Argument Default Description
champId number

ID of the champion to retrieve data for

dataType string | Array.<string>
byId boolean <nullable>
false

if true, keys will be champ ids and not champ names

locale string <nullable>

local code to use for returned data

version string <nullable>

data version

region module:serverdata.REGION <optional>
<nullable>

if no region is specified the configured region will be used

Source:
See:

<static> getChampionList(dataType, byId, locale, version, region)

gets a list of champions

Parameters:
Name Type Argument Default Description
dataType string | Array.<string>
byId boolean <nullable>
false

if true, keys will be champ ids and not champ names

locale string <nullable>

local code to use for returned data

version string <nullable>

data version

region module:serverdata.REGION <optional>
<nullable>

if no region is specified the configured region will be used

Source:
See:

<static> getItemById(itemId, dataType, locale, version, region)

gets item specific information from a specified item's id

Parameters:
Name Type Argument Description
itemId number

the item's ID which to retrieve

dataType string | Array.<string>
locale string <nullable>

local code to use for returned data

version string <nullable>

data version

region module:serverdata.REGION <optional>
<nullable>

if no region is specified the configured region will be used

Source:
See:

<static> getItemList(dataType, locale, version, region)

gets a full list of items

Parameters:
Name Type Argument Description
dataType string | Array.<string>
locale string <nullable>

local code to use for returned data

version string <nullable>

data version

region module:serverdata.REGION <optional>
<nullable>

if no region is specified the configured region will be used

Source:
See:

<static> getLanguages(region)

gets array of languages(locales) supported in region

Parameters:
Name Type Argument Description
region module:serverdata.REGION <optional>
<nullable>

if no region is specified the configured region will be used

Source:
See:

<static> getLanguageStrings(locale, version, region)

gets display strings for specified language(locale)

Parameters:
Name Type Argument Description
locale string <nullable>

local code to use for returned data

version string <nullable>

data version

region module:serverdata.REGION <optional>
<nullable>

if no region is specified the configured region will be used

Source:
See:

<static> getMaps(locale, version, region)

gets map information for specified language(locale)

Parameters:
Name Type Argument Description
locale string <nullable>

local code to use for returned data

version string <nullable>

data version

region module:serverdata.REGION <optional>
<nullable>

if no region is specified the configured region will be used

Source:
See:

<static> getMasteryById(masteryId, dataType, locale, version, region)

gets a specific mastery object pertaining to the supplied id

Parameters:
Name Type Argument Description
masteryId number

ID of mastery to get data for

dataType string | Array.<string>
locale string <nullable>

local code to use for returned data

version string <nullable>

data version

region module:serverdata.REGION <optional>
<nullable>

if no region is specified the configured region will be used

Source:
See:

<static> getMasteryList(dataType, locale, version, region)

gets a list of all the masteries available

Parameters:
Name Type Argument Description
dataType string | Array.<string>
locale string <nullable>

local code to use for returned data

version string <nullable>

data version

region module:serverdata.REGION <optional>
<nullable>

if no region is specified the configured region will be used

Source:
See:

<static> getProfileIcons(locale, version, region)

gets a list of all profile icons

Parameters:
Name Type Argument Description
locale string <nullable>

local code to use for returned data

version string <nullable>

data version

region module:serverdata.REGION <optional>
<nullable>

if no region is specified the configured region will be used

Source:
See:

<static> getRealmData(region)

gets data about a realm

Parameters:
Name Type Argument Description
region module:serverdata.REGION <optional>
<nullable>

if no region is specified the configured region will be used

Source:
See:

<static> getRuneById(runeId, dataType, locale, version, region)

gets a rune object from a supplied rune id

Parameters:
Name Type Argument Description
runeId number

ID of the rune to retrieve

dataType string | Array.<string>
locale string <nullable>

local code to use for returned data

version string <nullable>

data version

region module:serverdata.REGION <optional>
<nullable>

if no region is specified the configured region will be used

Source:
See:

<static> getRuneList(dataType, locale, version, region)

gets a list of all available runes

Parameters:
Name Type Argument Description
dataType string | Array.<string>
locale string <nullable>

local code to use for returned data

version string <nullable>

data version

region module:serverdata.REGION <optional>
<nullable>

if no region is specified the configured region will be used

Source:
See:

<static> getSummonerSpellById(summonerSpellId, dataType, byId, locale, version, region)

gets a summoner spell object from a supplied summoner spell id

Parameters:
Name Type Argument Default Description
summonerSpellId number
dataType string | Array.<string>
byId boolean false

if true, keys will be spell ids and not spell names

locale string <nullable>

local code to use for returned data

version string <nullable>

data version

region module:serverdata.REGION <optional>
<nullable>

if no region is specified the configured region will be used

Source:
See:

<static> getSummonerSpellList(dataType, byId, locale, version, region)

gets all summoner spell objects

Parameters:
Name Type Argument Default Description
dataType string | Array.<string>
byId boolean false

if true, keys will be spell ids and not spell names

locale string <nullable>

local code to use for returned data

version string <nullable>

data version

region module:serverdata.REGION <optional>
<nullable>

if no region is specified the configured region will be used

Source:
See:

<static> getVersions(region)

gets array of versions

Parameters:
Name Type Argument Description
region module:serverdata.REGION <optional>
<nullable>

if no region is specified the configured region will be used

Source:
See:

<inner> getAllChampData(championId)

Gets all data for all champions

Parameters:
Name Type Argument Default Description
championId number <optional>
<nullable>
null

ID of champion to get (null or do not supply for all champs)

Source:

<inner> getAllItemData(itemId)

Gets all data for all items

Parameters:
Name Type Argument Default Description
itemId number <optional>
<nullable>
null

ID of item to get (null or do not supply for all items)

Source:

<inner> getAllMasteryData(masteryId)

Gets all data for all masteries

Parameters:
Name Type Argument Default Description
masteryId number <optional>
<nullable>
null

ID of item to get (null or do not supply for all masteries)

Source:

<inner> getAllRuneData(runeId)

Gets all data for all runes

Parameters:
Name Type Argument Default Description
runeId number <optional>
<nullable>
null

ID of item to get (null or do not supply for all runes)

Source:

<inner> getAllSummonerSpellData(summonerSpellId)

Gets all data for all summoner spells

Parameters:
Name Type Argument Default Description
summonerSpellId number <optional>
<nullable>
null

ID of item to get (null or do not supply for all summoner spells)

Source: