Skip to main content

Player

The player class

@see

https://api.hypixel.net/#tag/Player-Data/paths/~1player/get

Hierarchy

Index

Constructors

Properties

Methods

Constructors

publicconstructor

  • Parameters

    • client: Client

      Instantiated (and started) hypixel.ts client

    • data: APIPlayer

      Player data received from API

    Returns Player

Properties

optionalachievementPoints

achievementPoints?: number

optionalachievementRewardsNew

achievementRewardsNew?: Record<string, any>

optionalachievementSync

achievementSync?: Record<string, any>

optionalachievementTotem

achievementTotem?: Record<string, any>

optionalachievements

achievements?: Record<string, any>

optionalachievementsOneTime

achievementsOneTime?: string[]

optionaladsense_tokens

adsense_tokens?: number

optionalchallenges

challenges?: Record<string, any>

optionalchannel

channel?: string

optionalcurrentClickEffect

currentClickEffect?: string

optionalcurrentGadget

currentGadget?: string

optionalcurrentPet

currentPet?: string

optionaldisabledProjectileTrails

disabledProjectileTrails?: boolean

displayName

displayName: null | string

The display name of the player.

optionaleugene

eugene?: Record<string, any>

firstLogin

firstLogin: null | number

First login time of player (in milliseconds)

optionalgiftingMeta

giftingMeta?: Record<string, any>

optionalhousingMeta

housingMeta?: Record<string, any>

optionalkarma

karma?: number

optionalknownAliases

knownAliases?: string[]

Undocumented fields (observed in API response)

optionalknownAliasesLower

knownAliasesLower?: string[]

optionallastAdsenseGenerateTime

lastAdsenseGenerateTime?: number

optionallastClaimedReward

lastClaimedReward?: number

lastLogin

lastLogin: null | number

Last login time of player (in milliseconds)

lastLogout

lastLogout: null | number

Last logout time of player (in milliseconds)

optionallevelUp_MVP_PLUS

levelUp_MVP_PLUS?: number

optionallevelUp_VIP

levelUp_VIP?: number

monthlyPackageRank

monthlyPackageRank: null | NONE | SUPERSTAR

The monthly package rank of the player

optionalmonthlyRankColor

monthlyRankColor?: string

optionalmonthlycrates

monthlycrates?: Record<string, any>

optionalmostRecentGameType

mostRecentGameType?: string

optionalmostRecentMonthlyPackageRank

mostRecentMonthlyPackageRank?: string

optionalnetworkExp

networkExp?: number

newPackageRank

newPackageRank: string

packageRank

packageRank: null | MVP_PLUS | MVP | VIP_PLUS | VIP | NONE

The package rank of the player

optionalparkourCheckpointBests

parkourCheckpointBests?: Record<string, any>

optionalparkourCompletions

parkourCompletions?: Record<string, any>

optionalparticlePack

particlePack?: string

optionalpetConsumables

petConsumables?: Record<string, any>

optionalpetJourneyTimestamp

petJourneyTimestamp?: number

optionalpetStats

petStats?: Record<string, any>

optionalplayername

playername?: string

optionalquestSettings

questSettings?: Record<string, any>

optionalquests

quests?: Record<string, any>

rank

rank: null | ADMIN | MODERATOR | HELPER | NORMAL

The rank of the player

optionalrankPlusColor

rankPlusColor?: string

optionalrewardHighScore

rewardHighScore?: number

optionalrewardScore

rewardScore?: number

optionalrewardStreak

rewardStreak?: number

optionalseasonal

seasonal?: Record<string, any>

optionalsocialMedia

socialMedia?: Record<string, any>

stats

stats: Record<string, any>

optionaltotalDailyRewards

totalDailyRewards?: number

optionaltotalRewards

totalRewards?: number

optionaltourney

tourney?: Record<string, any>

uuid

uuid: string

The uuid of the player.

optionalvanityMeta

vanityMeta?: Record<string, any>

Methods

publicfetchSkyBlockProfiles