BeatLeader.Players. Player

Interact with the BeatLeader Player API endpoints

Methods

(static) get(id, stats, keepOriginalId) → {Promise}

Get profile data for a specific user based on their ID

Parameters:
NameTypeDescription
idstring

ID of user to get data for

statsboolean

Include stats in the response. Default is true

keepOriginalIdboolean

Whether to keep original ID (for migrated players). Default is false

leaderboardContext.string

Leaderboard context, 'general' by default. Available values : "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup"

Returns:

Returns a promise with profile data on a specific user

Type: 
Promise

(static) getByBeatSaverId(beatsaverId) → {Promise}

Get profile data for a specific user based on their BeatSaver ID

Parameters:
NameTypeDescription
beatsaverIdstring

BeatSaver ID of user to get data for

Returns:

Returns a promise with profile data on a specific user

Type: 
Promise

(static) getByDiscordId(discordId) → {Promise}

Get profile data for a specific user based on their Discord ID

Parameters:
NameTypeDescription
discordIdstring

Discord ID of user to get data for

Returns:

Returns a promise with profile data on a specific user

Type: 
Promise

(static) getByPatreonId(patreonId) → {Promise}

Get profile data for a specific user based on their Patreon ID

Parameters:
NameTypeDescription
patreonIdstring

Patreon ID of user to get data for

Returns:

Returns a promise with profile data on a specific user

Type: 
Promise

(static) getFollowerInfoById(id) → {Promise}

Retrieves an info about player' followers such as count and 3 closest followers. Also 3 most followed players this player follows

Parameters:
NameTypeDescription
idstring

ID of user to get data for

Returns:

Returns a promise with follower data

Type: 
Promise

(static) getFollowersById(id, page, count, type) → {Promise}

Retrieves a full list of player' followers and players this player follow.

Parameters:
NameTypeDescription
idstring

ID of user to get data for

pagenumber

Page to get data from. Default is 1

countnumber

Number of players to return. Default is 10

typestring

Relationship type: followers or following Available values : "followers", "following"

Returns:

Returns a promise with followers

Type: 
Promise

(static) getFoundedClanById(id) → {Promise}

Retrieves an information about the clan this player created and manage.

Parameters:
NameTypeDescription
idstring

ID of user to get data for

Returns:

Returns a promise with info on a specific clan

Type: 
Promise

(static) getParticipatedEventsById(id) → {Promise}

Get events a user has participated in based on their ID

Parameters:
NameTypeDescription
idstring

ID of user to get data for

Returns:

Returns a promise with a list of events a user has participated in

Type: 
Promise

(static) getRankedMapsById(id) → {Promise}

Returns brief stats about maps this player ranked, like count, total PP gained, etc...

Parameters:
NameTypeDescription
idstring

ID of user to get data for

Returns:

Returns a promise with ranked map data

Type: 
Promise