Class TowerStatsClient

constructor

• new TowerStatsClient(
      apiKey: string,
      cacheConfig?: Partial<CacheConfig>,
      apiRoutes?: RoutesConstructor,
  ): TowerStatsClient

  Create a new TowerStats client.

  Parameters

  • apiKey: string

    Your TowerStats API key.

  • OptionalcacheConfig: Partial<CacheConfig>

    Cache config for this client.

  • apiRoutes: RoutesConstructor = routes

    The API routes to use. Defaults to the official TowerStats API routes.

  Returns TowerStatsClient

cache

checkBadges

• checkBadges(userId: number, badgeIds: number[]): Promise<CheckedBadges>

  Check a user's badges.

  Parameters

  • userId: number

    The Roblox user ID.

  • badgeIds: number[]

    An array of badge IDs to check if the user owns them.

  Returns Promise<CheckedBadges>

  An array of checked badge objects specifying whether the user owns that badge or not. (If they do, it includes the date of which they earned the badge.)

checkGameBadges

• checkGameBadges(userId: number, universeId: number): Promise<CheckedBadges>

  Check which badges a user owns for a specific universe. NOTE: This method is not cached due to the badge list being unknown.

  Parameters

  • userId: number

    The Roblox user ID.

  • universeId: number

    The Roblox universe ID.

  Returns Promise<CheckedBadges>

  An array of owned badges. Note that it does NOT include unowned badges.

getAPIKey

• getAPIKey(): string

  Get the TowerStats API key provided to the client.

  Returns string

  The API key.

getFollowers

• getFollowers(userId: number): Promise<UserIdsArray>

  Get a user's followers list.

  Parameters

  • userId: number

    The Roblox user ID.

  Returns Promise<UserIdsArray>

  An array of Roblox user IDs.

getFollowing

• getFollowing(userId: number): Promise<UserIdsArray>

  Get a user's following list.

  Parameters

  • userId: number

    The Roblox user ID.

  Returns Promise<UserIdsArray>

  An array of Roblox user IDs.

getRoutes

• getRoutes(): RoutesConstructor

  Get the routes of this client.

  Returns RoutesConstructor

  The routes.

swapAPIKey

• swapAPIKey(apiKey: string): void

  Swap the current API key with a different one.

  Parameters

  • apiKey: string

  Returns void