brawlhalla-api-ts/api.d.ts

TypeScript wrapper for the Brawlhalla API.

import { Clan as IClan, PlayerBySteamID as IPlayerBySteamID, PlayerRankedStats as IPlayerRankedStats, PlayerRanking as IPlayerRanking, PlayerStats as IPlayerStats, RankingOptions as IRankingOptions } from './types';
import { Legend } from './models/legend';
export declare class BrawlhallaApi {
    private static readonly apiUrl;
    private readonly bhRequest;
    private steamApi?;
    private _brawlhallaApiKey;
    set brawlhallaApiKey(apiKey: string);
    get brawlhallaApiKey(): string;
    constructor(brawlhallaApiKey: string, steamApiKey?: string);
    getPlayerStats(brawlhallaID: number): Promise<IPlayerStats>;
    getPlayerRankedStats(brawlhallaID: number): Promise<IPlayerRankedStats | undefined>;
    getClanInfo(clanID: number): Promise<IClan>;
    getBrawlhallaIdFromSteamId(steamID: string): Promise<IPlayerBySteamID>;
    getRankings(options: IRankingOptions): Promise<IPlayerRanking[]>;
    getLegendInfo(legendIdOrName: number | string): Legend;
    getBhidFromSteamProfile(profileUrl: string): Promise<number>;
}