DocumentationFunctionsStat FunctionsGet User Rank

Get user rank

Returns statistics for different gamemodes

FieldTypeRequiredoptions
userIdidyes
platformstringyesuplay, xbl, psn
index.ts
await api.getUserRank(player.userId, platfrom);
{
  casual: {
    profile_board_id: 'casual',
    id: 'casual',
    max_rank: 0,
    max_rank_points: 0,
    platform_family: 'pc',
    rank: 0,
    rank_points: 0,
    rank_name: 'Unranked',
    season_id: 34,
    top_rank_position: 0,
    deaths: 69,
    kills: 164,
    abandons: 0,
    losses: 4,
    wins: 29,
    rankImage: 'https://github.com/CalumW1/R6StatAPI/blob/main/assests/images/ranks/unranked.png'
  },
  event: {
    profile_board_id: 'event',
    id: 'event',
    max_rank: 0,
    max_rank_points: 0,
    platform_family: 'pc',
    rank: 0,
    rank_points: 0,
    rank_name: 'Unranked',
    season_id: 34,
    top_rank_position: 0,
    deaths: 117,
    kills: 241,
    abandons: 0,
    losses: 2,
    wins: 17,
    rankImage: 'https://github.com/CalumW1/R6StatAPI/blob/main/assests/images/ranks/unranked.png'
  },
  warmup: {
    profile_board_id: 'warmup',
    id: 'warmup',
    max_rank: 0,
    max_rank_points: 0,
    platform_family: 'pc',
    rank: 0,
    rank_points: 0,
    rank_name: 'Unranked',
    season_id: 34,
    top_rank_position: 0,
    deaths: 359,
    kills: 1309,
    abandons: 3,
    losses: 4,
    wins: 73,
    rankImage: 'https://github.com/CalumW1/R6StatAPI/blob/main/assests/images/ranks/unranked.png'
  },
  standard: {
    profile_board_id: 'standard',
    id: 'standard',
    max_rank: 0,
    max_rank_points: 0,
    platform_family: 'pc',
    rank: 0,
    rank_points: 0,
    rank_name: 'Unranked',
    season_id: 34,
    top_rank_position: 0,
    deaths: 604,
    kills: 1588,
    abandons: 0,
    losses: 20,
    wins: 239,
    rankImage: 'https://github.com/CalumW1/R6StatAPI/blob/main/assests/images/ranks/unranked.png'
  },
  ranked: {
    profile_board_id: 'ranked',
    id: 'ranked',
    max_rank: 36,
    max_rank_points: 5934,
    platform_family: 'pc',
    rank: 36,
    rank_points: 5912,
    rank_name: 'Champions',
    season_id: 34,
    top_rank_position: 2,
    deaths: 1219,
    kills: 2821,
    abandons: 0,
    losses: 38,
    wins: 544,
    rankImage: 'https://github.com/CalumW1/R6StatAPI/blob/main/assests/images/ranks/champion.png'
  }
}