Class Client

The base client for interacting with the MultiVersus API.

Hierarchy

  • Client

Constructors

  • Options for the client

    Parameters

    • Optional accessToken: string

      Access token of the account to log in with

    Returns Client

Methods

  • Fetch users Battlepass.

    Parameters

    • id: string

      The ID of the user.

    Returns Promise<any>

  • Fetch users clan(s).

    Parameters

    • id: string

      The ID of the user.

    • Optional page: number

      The match page to fetch.

    • Optional count: number

      The count to fetch.

    Returns Promise<any>

  • Fetch a match from an ID.

    Parameters

    • id: string

      The ID of the match to fetch

    Returns Promise<any>

  • Fetch a page of matches of a user.

    Parameters

    • id: string

      The ID of the user.

    • Optional page: number

      The match page to fetch.

    Returns Promise<any>

  • Fetch the leaderboard of a user.

    Parameters

    • id: string

      The ID of the user.

    • type: LeaderboardType

      The leaderboard type to fetch.

    Returns Promise<any>

  • Fetch the leaderboard of a user with a character.

    Parameters

    • id: string

      The ID of the user.

    • type: LeaderboardType

      The leaderboard type to fetch.

    • character: string

      The character to fetch.

    Returns Promise<any>

  • Fetch users quests.

    Parameters

    • id: string

      The ID of the user.

    Returns Promise<any>

  • Returns info about the current client, including account info, notifications, and WB network status.

    Returns

    Example

    client.info();
    

    Parameters

    • Optional steamTicket: string

      The Steam encrypted application ticket of the account, converted to hex.

    Returns Promise<any>

  • Creates an access token, allowing you to access the MultiVersus API.

    Returns

    Example

    client.login('username', 'password');
    

    Parameters

    • username: string

      Username of the account to log in with

    • password: string

      Password of the account to log in with

    Returns Promise<any>

  • Search for users from a username.

    Returns

    Example

    client.searchByUsername('ElijahPepe', 10);
    

    Parameters

    • username: string

      Username to search for

    • Optional limit: number

      Limit of users to return.

    Returns Promise<any>

Generated using TypeDoc