Skip to content

@valoranchi/riot-client / index / OfficialApi

Interface: OfficialApi ​

Defined in: src/client/api.ts:301

Methods ​

account() ​

account(riotId): Promise<OfficialAccount>

Defined in: src/client/api.ts:302

Parameters ​

riotId ​

string

Returns ​

Promise<OfficialAccount>


leaderboard() ​

leaderboard(options): Promise<Leaderboard>

Defined in: src/client/api.ts:305

Parameters ​

options ​
act? ​

string

shard ​

string

size? ​

number

start? ​

number

Returns ​

Promise<Leaderboard>


match() ​

match(matchId, options): Promise<Match>

Defined in: src/client/api.ts:304

Parameters ​

matchId ​

string

options ​
self? ​

string

shard ​

string

Returns ​

Promise<Match>


matches() ​

matches(riotId, options?): Promise<MatchSummary[]>

Defined in: src/client/api.ts:303

Parameters ​

riotId ​

string

options? ​
count? ​

number

queue? ​

string

Returns ​

Promise<MatchSummary[]>


profile() ​

profile(riotId, options?): Promise<OfficialProfile>

Defined in: src/client/api.ts:316

Parameters ​

riotId ​

string

options? ​
count? ​

number

Returns ​

Promise<OfficialProfile>


status() ​

status(shard): Promise<OfficialPlatformData>

Defined in: src/client/api.ts:311

Parameters ​

shard ​

string

Returns ​

Promise<OfficialPlatformData>


summary() ​

summary(riotId, options?): Promise<PerformanceSummary>

Defined in: src/client/api.ts:312

Parameters ​

riotId ​

string

options? ​
count? ​

number

queue? ​

string

Returns ​

Promise<PerformanceSummary>

Not affiliated with Riot Games