Profiles

One of the basic things that you're most likely to use is to get certain user's information (name, brawlers, club, etc.). How to do this and some information related to it you will learn on this page.

Pre-conditions

Basic usage

Here's basic usage:

val player: Player = client.getPlayer(PlayerTag.createUnsafe("..."))
    .getOrElse { throw it } // just rethrow error for our case
    ?: error("No such player found")

To handle Brawl Stars specific errors, please refer to Brawl Stars API Errors.

There you may get the following information:

tag: Player's unique tag, consisting of 7 to 12 symbols.
name: Player's in-game name, which is publicly visible in matches, lobbies, club, etc.
nameColor: The color of the player's name, displayed in hexadecimal format.
In Brawl Stars API it's represented in the following way: 0xffcb5aff (for Brawlify API it's different). You may check the original formatting via HexColor.isHexLiteral (whether it starts with 0x) or HexColor.isHexText (whether it starts with '#').
You may refer to the HexColor class for more information.
icon: The player's profile icon, representing their account visually (you may retrieve actual image via Brawlify API).
trophies: The total number of trophies the player currently holds.
highestTrophies: The highest trophy count the player has ever achieved (before trophies reset or loosing trophies).
expLevel: The player's experience level, representing their overall progress in the game.
expPoints: The number of experience points accumulated by the player.
isQualifiedFromChampionshipChallenge: Indicates if the player has qualified for the Championship Challenge.
threeVsThreeVictories: The total number of victories the player has achieved in 3v3 game modes.
soloVictories: The total number of victories the player has achieved in Solo Showdown mode.
duoVictories: The total number of victories the player has achieved in Duo Showdown mode.
bestRoboRumbleTime: The player's best survival time in Robo Rumble.
bestTimeAsBigBrawler: The player's best survival time as the Big Brawler in Big Game.
club: Information about the player's club, or null if the player is not part of a club.
- tag: Club's unique tag.
- name: Club's name.
brawlers: The list of brawlers owned by the player, each with their stats and details.

Retrieving image of a profile

Pre-conditions

When using Brawlify API for icons you can get the player's icon image url:

suspend fun getImageUrl(
  client: BrawlifyClient, 
  iconId: IconId
): BrawlifyUrl? {
  // retrieves all icons available on the brawlify
  // it's good idea to cache it on your side, because
  // brawlify does not provide alternative way of getting single icon.
  return client.getIcons()
    // return null on failure
    .getOrElse { return null }
    .playersIcons
    // if it's a very-very new icon it might not be available
    .firstOrNull { id == iconId }
    ?.imageUrl
}

Then you may download image in any way (library does not include this functionality, because it's not needed for everyone).

Last modified: 02 January 2025