Skip to content

Latest commit

 

History

History
151 lines (125 loc) · 5.44 KB

ENDPOINTS.md

File metadata and controls

151 lines (125 loc) · 5.44 KB
Raw

Methods

/* CHAMPION-V3 */
Champion.Rotation.list()

/* CHAMPION-MASTERY-V4 */
ChampionMastery.list(summonerID: string)
ChampionMastery.get(summonerID: string)(championID: int)
ChampionMastery.totalScore(summonerID: string)

/* LEAGUE-V4 */
Challenger.list(queueName: string)
League.Entries.by.summonerID(summonerID: string)
League.Entries.list(queue: string, tier: string, division: string)
Grandmaster.list(queueName: string)
League.by.uuid(leagueUUID: string)
Master.list(queueName: string)
League.PositionalRankQueue.list() // deprecated June 17th and in `v0.9.10`
LeaguePositions.by.summonerID(summonerID: string) // deprecated June 17th and in `v0.9.10`
LeaguePositions.list(
    positionalQueue: queueName | string,
    tier: tierName | string,
    division: divisionName | string,
    position: positionName | string,
    page: int,
) // deprecated June 17th and in 'v0.9.10`

/* DDRAGON
    At its core, DDragonRequest uses `version()` and `locale()`.

    DDragonRequest as of v0.8.22 now also uses `region()` to automatically grab the correct version for the current request (only for data requests like champion lists). DDragonRequest does not use `query()`.

    Both `version()` and `locale()` are optional.
*/
DDragon.Champion.get(championName: string)
DDragon.Champion.list()
DDragon.Champion.listFull()

DDragon.Champion.getDataById(championName: string)
DDragon.Champion.getDataByIdWithParentAsId(championName: string)
DDragon.Champion.listDataById()
DDragon.Champion.listDataByIdWithParentAsId()
DDragon.Champion.listFullDataById()
DDragon.Champion.listFullDataByIdWithParentAsId()

DDragon.Item.list()
DDragon.Language.list()
DDragon.LanguageString.list()
DDragon.Map.list()
DDragon.ProfileIcon.list()
DDragon.Realm.list(region: region)
DDragon.RunesReforged.list()
DDragon.SummonerSpell.list()
DDragon.Version.list()

/* LOL-STATUS-V3 */
Status.get()

/* MATCH-V4 */
Match.get(matchID: int)
Matchlist.by.accountID(accountID: string)
Matchlist.Recent.by.accountID(accountID: string) /* April 27th deprecation by Riot, but will still work via the above endpoint */
Match.timeline(matchID: int)
Match.Tournament.listMatchIDs(tournamentCode: string)
Match.Tournament.get(matchID: int, tournamentCode: string)

/* SPECTATOR-V4 */
CurrentGame.by.summonerID(summonerID: string)
FeaturedGames.list()

/* SUMMONER-V4 */
Summoner.by.name(summonerName: string)
Summoner.by.id(summonerID: string)
Summoner.by.accountID(accountID: string)

/* THIRD-PARTY-CODE-V4 */
ThirdPartyCode.by.summonerID(summonerID: string)

/* TOURNAMENT-STUB-V4 */
TournamentStub.create(tournamentID: number, body: object?)
TournamentStub.lobbyEvents(tournamentCode: string)
TournamentStub.registerProviderData(region: string, callbackURL: string)
TournamentStub.register(providerID: number, name: string?)

/* TOURNAMENT-V4 */
Tournament.create(tournamentID: number, body: object?)
Tournament.update(tournamentCode: string, body: object)
Tournament.get(tournamentCode: string)
Tournament.lobbyEvents(tournamentCode: string)
Tournament.registerProviderData(region: string, callbackURL: string)
Tournament.register(providerID: number, name: string?)

Endpoints

Everything should be in the same order as in the official docs.

CHAMPION-MASTERY-V4

  • Get all champion mastery entries sorted by number of champion points descending.
  • Get a champion mastery by player ID and champion ID.
  • Get a player's total champion mastery score, which is the sum of individual champion mastery levels.

CHAMPION-V3

  • Retrieve all champions.
  • Retrieve champion by ID.

LEAGUE-V4

  • Get the challenger league for given queue.
  • Get league entries in all queues for a given summoner ID.
  • Get all the league entries.
  • Get the grandmaster league of a specific queue.
  • Get league with given ID, including inactive entries.
  • Get the master league for given queue.
  • Get the queues that have positional ranks enabled. (deprecated June 17th and in v0.9.10)
  • Get league positions in all queues for a given summoner ID. (deprecated June 17th and in v0.9.10)
  • Get all the positional league entries. (deprecated June 17th and in v0.9.10)

LOL-STATUS-V3

  • Get League of Legends status for the given shard.
  • Get matchlist for games played on given account ID and platform ID and filtered using given filter parameters, if any.
  • Get match timeline by match ID.
  • Get match IDs by tournament code.
  • Get match by match ID and tournament code.

SPECTATOR-V4

  • Get current game information for the given summoner ID.
  • Get list of featured games.

SUMMONER-V4

  • Get a summoner by account ID.
  • Get a summoner by summoner name.
  • Get a summoner by PUUID.
  • Get a summoner by summoner ID.

TOURNAMENT-STUB-V4

  • Create a mock tournament code for the given tournament.
  • Gets a mock list of lobby events by tournament code.
  • Creates a mock tournament provider and returns its ID.
  • Creates a mock tournament and returns its ID.

TOURNAMENT-V4

  • Create a tournament code for the given tournament.
  • Returns the tournament code DTO associated with a tournament code string.
  • Update the pick type, map, spectator type, or allowed summoners for a code.
  • Gets a list of lobby events by tournament code.
  • Creates a tournament provider and returns its ID.
  • Creates a tournament and returns its ID.