### GET /beasties/nominations/my Source: https://api.beatleader.com/swagger/blapi/swagger.json Authenticated player Beasties nominations. ```markdown ### Responses #### 200 - List of nominations retrieved successfully - Array of object - **id** (integer (int32)) - **playerId** (string) - **leaderboardId** (string) - **category** (string) - **timepost** (integer (int32)) #### 400 - Invalid request parameters Invalid request parameters #### 401 - Autorization failed Autorization failed ### Example Usage ```bash curl -X GET "https://api.beatleader.com/beasties/nominations/my" ``` ``` -------------------------------- ### GET /experience/prestige Source: https://api.beatleader.com/swagger/blapi/swagger.json Reset the current logged in player level and prestige ```markdown ### Responses #### 200 - Successful prestige Empty response body #### 400 - Player is already max prestige Player is already max prestige #### 404 - Player not found Player not found ### Example Usage ```bash curl -X GET "https://api.beatleader.com/experience/prestige" ``` ``` -------------------------------- ### GET /experience/levels Source: https://api.beatleader.com/swagger/blapi/swagger.json Reset the current logged in player level and prestige ```markdown ### Responses #### 200 - Successful prestige - Array of object - **id** (integer (int32)) - **level** (integer (int32)) - **bigIcon** (string) - **smallIcon** (string) #### 400 - Player is already max prestige Player is already max prestige #### 404 - Player not found Player not found ### Example Usage ```bash curl -X GET "https://api.beatleader.com/experience/levels" ``` ``` -------------------------------- ### GET /player/{id}/foundedClan Source: https://api.beatleader.com/swagger/blapi/swagger.json Retrieves an information about the clan this player created and manage. ```markdown ### Parameters - **id** (string, path, required): The ID of the player ### Responses #### 200 - Returns brief info about the clan **ClanBiggerResponse** - **id** (integer (int32)) - **tag** (string) - **color** (string) - **name** (string) - **icon** (string) - **rankedPoolPercentCaptured** (number (float)) - **playersCount** (integer (int32)) - **joined** (boolean) **ClanBiggerResponse** **ClanBiggerResponse** #### 404 - Player not found or player doesn't found any clans Player not found or player doesn't found any clans ### Example Usage ```bash curl -X GET "https://api.beatleader.com/player/{id}/foundedClan" ``` ``` -------------------------------- ### GET /beasties/nominations Source: https://api.beatleader.com/swagger/blapi/swagger.json Authenticated player Beasties nominations. ```markdown ### Parameters - **leaderboardId** (string, query, optional) ### Responses #### 200 - List of nominations retrieved successfully - Array of object - **id** (integer (int32)) - **playerId** (string) - **leaderboardId** (string) - **category** (string) - **timepost** (integer (int32)) #### 400 - Invalid request parameters Invalid request parameters #### 401 - Autorization failed Autorization failed ### Example Usage ```bash curl -X GET "https://api.beatleader.com/beasties/nominations?leaderboardId=string" ``` ``` -------------------------------- ### GET /player/{id}/history/compact Source: https://api.beatleader.com/swagger/blapi/swagger.json Fetches a list of player's performance metrics subset. Use the main history endpoint for a full. ```markdown ### Parameters - **id** (string, path, required): Player's unique identifier - **leaderboardContext** (string (none|general|noMods|noPause|golf|sCPM|speedrun|speedrunBackup|funny), query, optional): Filter scores by leaderboard context, default is 'General' (example: 510) - **count** (integer (int32), query, optional): Amount of days to include ### Responses #### 200 - History retrieved successfully - Array of object - **timestamp** (integer (int32)) - **pp** (number (float)) - **rank** (integer (int32)) - **countryRank** (integer (int32)) - **averageRankedAccuracy** (number (float)) - **averageUnrankedAccuracy** (number (float)) - **averageAccuracy** (number (float)) - **medianRankedAccuracy** (number (float)) - **medianAccuracy** (number (float)) - **rankedPlayCount** (integer (int32)) - **unrankedPlayCount** (integer (int32)) - **totalPlayCount** (integer (int32)) - **rankedImprovementsCount** (integer (int32)) - **unrankedImprovementsCount** (integer (int32)) - **totalImprovementsCount** (integer (int32)) #### 400 - Invalid request parameters Invalid request parameters #### 404 - No history saved for the given player ID No history saved for the given player ID ### Example Usage ```bash curl -X GET "https://api.beatleader.com/player/{id}/history/compact?leaderboardContext=510&count=50" ``` ``` -------------------------------- ### GET /beasties/nominations/my/finalists Source: https://api.beatleader.com/swagger/blapi/swagger.json Authenticated player Beasties nominations filtered to only finalists. ```markdown ### Responses #### 200 - List of finalist nominations retrieved successfully - Array of object - **id** (string) - **difficulties** (array (object)) Array items: - **id** (integer (int32)) - **value** (integer (int32)) - **mode** (integer (int32)) - **difficultyName** (string) - **modeName** (string) - **status** (integer) ("0"|"1"|"2"|"3"|"4"|"5"|"6"|"7") - **modifierValues** (object) - **modifierId** (integer (int32)) - **da** (number (float)) - **fs** (number (float)) - **sf** (number (float)) - **ss** (number (float)) - **gn** (number (float)) - **na** (number (float)) - **nb** (number (float)) - **nf** (number (float)) - **no** (number (float)) - **pm** (number (float)) - **sc** (number (float)) - **sa** (number (float)) - **op** (number (float)) - **ez** (number (float)) - **hd** (number (float)) - **smc** (number (float)) - **ohp** (number (float)) - **modifiersRating** (object) - **id** (integer (int32)) - **ssPredictedAcc** (number (float)) - **ssPassRating** (number (float)) - **ssAccRating** (number (float)) - **ssTechRating** (number (float)) - **ssStars** (number (float)) - **fsPredictedAcc** (number (float)) - **fsPassRating** (number (float)) - **fsAccRating** (number (float)) - **fsTechRating** (number (float)) - **fsStars** (number (float)) - **sfPredictedAcc** (number (float)) - **sfPassRating** (number (float)) - **sfAccRating** (number (float)) - **sfTechRating** (number (float)) - **sfStars** (number (float)) - **bfsPredictedAcc** (number (float)) - **bfsPassRating** (number (float)) - **bfsAccRating** (number (float)) - **bfsTechRating** (number (float)) - **bfsStars** (number (float)) - **bsfPredictedAcc** (number (float)) - **bsfPassRating** (number (float)) - **bsfAccRating** (number (float)) - **bsfTechRating** (number (float)) - **bsfStars** (number (float)) - **nominatedTime** (integer (int32)) - **qualifiedTime** (integer (int32)) - **rankedTime** (integer (int32)) - **speedTags** (integer (int32)) - **styleTags** (integer (int32)) - **featureTags** (integer (int32)) - **stars** (number (float)) - **predictedAcc** (number (float)) - **passRating** (number (float)) - **accRating** (number (float)) - **techRating** (number (float)) - **type** (integer) ("0"|"1"|"2"|"4"|"8") - **njs** (number (float)) - **nps** (number (float)) - **notes** (integer (int32)) - **chains** (integer (int32)) - **sliders** (integer (int32)) - **bombs** (integer (int32)) - **walls** (integer (int32)) - **maxScore** (integer (int32)) - **duration** (number (double)) - **requirements** (integer) ("0"|"2"|"4"|"8"|"16"|"32"|"64"|"128"|"256"|"512"|"1024"|"-1") - **leaderboardId** (string) - **plays** (integer (int32)) - **lastScoreTime** (integer (int32)) - **attempts** (integer (int32)) - **positiveVotes** (integer (int32)) - **starVotes** (integer (int32)) - **negativeVotes** (integer (int32)) - **myScore** (object) - **id** (integer (int32)) - **baseScore** (integer (int32)) - **modifiedScore** (integer (int32)) - **accuracy** (number (float)) - **playerId** (string) - **pp** (number (float)) - **bonusPp** (number (float)) - **passPP** (number (float)) - **accPP** (number (float)) - **techPP** (number (float)) - **rank** (integer (int32)) - **responseRank** (integer (int32)) - **country** (string) - **fcAccuracy** (number (float)) - **fcPp** (number (float)) - **weight** (number (float)) - **replay** (string) - **modifiers** (string) - **badCuts** (integer (int32)) - **missedNotes** (integer (int32)) - **bombCuts** (integer (int32)) - **wallsHit** (integer (int32)) - **pauses** (integer (int32)) - **fullCombo** (boolean) - **platform** (string) - **maxCombo** (integer (int32)) - **maxStreak** (integer (int32)) - **hmd** (integer) ("0"|"1"|"2"|"4"|"8"|"16"|"32"|"33"|"34"|"35"|"36"|"37"|"38"|"39"|"40"|"41"|"42"|"43"|"44"|"45"|"46"|"47"|"48"|"49"|"50"|"51"|"52"|"53"|"54"|"55"|"56"|"57"|"58"|"59"|"60"|"61"|"62"|"63"|"64"|"65"|"66"|"67"|"68"|"69"|"70"|"71"|"72"|"73"|"74"|"128"|"256"|"512"|"513") - **controller** (integer) ("0"|"1"|"2"|"4"|"8"|"9"|"10"|"16"|"33"|"34"|"35"|"37"|"44"|"61"|"62"|"63"|"64"|"65"|"66"|"67"|"68"|"69"|"70"|"71"|"72"|"73"|"74"|"75"|"76"|"77"|"78"|"79"|"80"|"81"|"128"|"256") - **leaderboardId** (string) - **timeset** (string) - **timepost** (integer (int32)) - **replaysWatched** (integer (int32)) - **playCount** (integer (int32)) - **lastTryTime** (integer (int32)) - **priority** (integer (int32)) - **originalId** (integer (int32)) - **player** (object) - **id** (string) - **name** (string) - **platform** (string) - **avatar** (string) - **country** (string) - **alias** (string) - **bot** (boolean) - **temporary** (boolean) - **pp** (number (float)) - **rank** (integer (int32)) - **countryRank** (integer (int32)) - **level** (integer (int32)) - **experience** (integer (int32)) - **prestige** (integer (int32)) - **role** (string) - **socials** (array (object)) Array items: - **id** (integer (int32)) - **service** (string) - **link** (string) - **user** (string) - **userId** (string) - **playerId** (string) - **hidden** (boolean) - **contextExtensions** (array (object)) Array items: - **id** (integer (int32)) - **context** (integer) ("0"|"2"|"4"|"8"|"16"|"32"|"64"|"128"|"256") - **pp** (number (float)) - **accPp** (number (float)) - **techPp** (number (float)) - **passPp** (number (float)) - **rank** (integer (int32)) - **country** (string) - **countryRank** (integer (int32)) - **level** (integer (int32)) - **experience** (integer (int32)) - **prestige** (integer (int32)) - **lastWeekPp** (number (float)) - **lastWeekRank** (integer (int32)) - **lastWeekCountryRank** (integer (int32)) - **playerId** (string) - **scoreStats** (object) - **id** (integer (int32)) - **totalScore** (integer (int64)) - **totalUnrankedScore** (integer (int64)) - **totalRankedScore** (integer (int64)) - **firstScoreTime** (integer (int32)) - **firstUnrankedScoreTime** (integer (int32)) - **firstRankedScoreTime** (integer (int32)) - **lastScoreTime** (integer (int32)) - **lastUnrankedScoreTime** (integer (int32)) - **lastRankedScoreTime** (integer (int32)) - **averageRankedAccuracy** (number (float)) - **averageWeightedRankedAccuracy** (number (float)) - **averageUnrankedAccuracy** (number (float)) - **averageAccuracy** (number (float)) - **medianRankedAccuracy** (number (float)) - **medianAccuracy** (number (float)) - **topRankedAccuracy** (number (float)) - **topUnrankedAccuracy** (number (float)) - **topAccuracy** (number (float)) - **topPp** (number (float)) - **topBonusPP** (number (float)) - **topPassPP** (number (float)) - **topAccPP** (number (float)) - **topTechPP** (number (float)) - **peakRank** (number (float)) - **rankedMaxStreak** (integer (int32)) - **unrankedMaxStreak** (integer (int32)) - **maxStreak** (integer (int32)) - **averageLeftTiming** (number (float)) - **averageRightTiming** (number (float)) - **steamPlaytime2Weeks** (integer (int32)) - **steamPlaytimeForever** (integer (int32)) - **scorePlaytime** (number (double)) - **rankedPlayCount** (integer (int32)) - **unrankedPlayCount** (integer (int32)) - **totalPlayCount** (integer (int32)) - **rankedImprovementsCount** (integer (int32)) - **unrankedImprovementsCount** (integer (int32)) - **totalImprovementsCount** (integer (int32)) - **rankedTop1Count** (integer (int32)) - **unrankedTop1Count** (integer (int32)) - **top1Count** (integer (int32)) - **rankedTop1Score** (integer (int32)) - **unrankedTop1Score** (integer (int32)) - **top1Score** (integer (int32)) - **averageRankedRank** (number (float)) - **averageWeightedRankedRank** (number (float)) - **averageUnrankedRank** (number (float)) - **averageRank** (number (float)) - **sspPlays** (integer (int32)) - **ssPlays** (integer (int32)) - **spPlays** (integer (int32)) - **sPlays** (integer (int32)) - **aPlays** (integer (int32)) - **topPlatform** (string) - **topHMD** (integer) ("0"|"1"|"2"|"4"|"8"|"16"|"32"|"33"|"34"|"35"|"36"|"37"|"38"|"39"|"40"|"41"|"42"|"43"|"44"|"45"|"46"|"47"|"48"|"49"|"50"|"51"|"52"|"53"|"54"|"55"|"56"|"57"|"58"|"59"|"60"|"61"|"62"|"63"|"64"|"65"|"66"|"67"|"68"|"69"|"70"|"71"|"72"|"73"|"74"|"128"|"256"|"512"|"513") - **allHMDs** (string) - **topPercentile** (number (float)) - **countryTopPercentile** (number (float)) - **dailyImprovements** (integer (int32)) - **authorizedReplayWatched** (integer (int32)) - **anonimusReplayWatched** (integer (int32)) - **watchedReplays** (integer (int32)) - **banned** (boolean) - **patreonFeatures** (object) - **id** (integer (int32)) - **bio** (string) - **message** (string) - **leftSaberColor** (string) - **rightSaberColor** (string) - **profileSettings** (object) - **id** (integer (int32)) - **bio** (string) - **message** (string) - **effectName** (string) - **profileAppearance** (string) - **hue** (number (float)) - **saturation** (number (float)) - **leftSaberColor** (string) - **rightSaberColor** (string) - **profileCover** (string) - **starredFriends** (string) - **horizontalRichBio** (boolean) - **rankedMapperSort** (string) - **showBots** (boolean) - **showAllRatings** (boolean) - **showExplicitCovers** (boolean) - **showStatsPublic** (boolean) - **showStatsPublicPinned** (boolean) - **clanOrder** (string) - **clans** (array (object)) Array items: - **id** (integer (int32)) - **tag** (string) - **color** (string) - **name** (string) - **scoreImprovement** (object) - **id** (integer (int32)) - **timeset** (string) - **score** (integer (int32)) - **accuracy** (number (float)) - **pp** (number (float)) - **bonusPp** (number (float)) - **rank** (integer (int32)) - **accRight** (number (float)) - **accLeft** (number (float)) - **averageRankedAccuracy** (number (float)) - **totalPp** (number (float)) - **totalRank** (integer (int32)) - **badCuts** (integer (int32)) - **missedNotes** (integer (int32)) - **bombCuts** (integer (int32)) - **wallsHit** (integer (int32)) - **pauses** (integer (int32)) - **modifiers** (string) - **rankVoting** (object) - **scoreId** (integer (int32)) - **playerId** (string) - **hash** (string) - **diff** (string) - **mode** (string) - **rankability** (number (float)) - **stars** (number (float)) - **type** (integer (int32)) - **timeset** (integer (int32)) - **feedbacks** (array (object)) Array items: - **id** (integer (int32)) - **rtMember** (string) - **value** (number (float)) - **metadata** (object) - **id** (integer (int32)) - **pinnedContexts** (integer) ("0"|"2"|"4"|"8"|"16"|"32"|"64"|"128"|"256") - **highlightedInfo** (integer) ("0"|"2"|"4") - **priority** (integer (int32)) - **description** (string) - **linkService** (string) - **linkServiceIcon** (string) - **link** (string) - **offsets** (object) - **id** (integer (int32)) - **frames** (integer (int32)) - **notes** (integer (int32)) - **walls** (integer (int32)) - **heights** (integer (int32)) - **pauses** (integer (int32)) - **saberOffsets** (integer (int32)) - **customData** (integer (int32)) - **sotwNominations** (integer (int32)) - **status** (integer) ("0"|"2") - **accLeft** (number (float)) - **accRight** (number (float)) - **applicable** (boolean) - **nominations** (array (object)) Array items: - **timepost** (integer (int32)) - **category** (string) - **hash** (string) - **name** (string) - **subName** (string) - **author** (string) - **mapper** (string) - **mappers** (array (object)) Array items: - **id** (integer (int32)) - **playerId** (string) - **name** (string) - **avatar** (string) - **curator** (boolean) - **verifiedMapper** (boolean) - **status** (integer) ("0"|"2"|"4"|"8"|"16") - **mapperId** (integer (int32)) - **collaboratorIds** (string) - **coverImage** (string) - **fullCoverImage** (string) - **downloadUrl** (string) - **bpm** (number (double)) - **duration** (number (double)) - **tags** (string) - **uploadTime** (integer (int32)) - **externalStatuses** (array (object)) Array items: - **id** (integer (int32)) - **status** (integer) ("0"|"2"|"4"|"8"|"16"|"32"|"64") - **timeset** (integer (int32)) - **link** (string) - **responsible** (string) - **details** (string) - **title** (string) - **titleColor** (string) #### 400 - Invalid request parameters Invalid request parameters #### 401 - Autorization failed Autorization failed ### Example Usage ```bash curl -X GET "https://api.beatleader.com/beasties/nominations/my/finalists" ``` ``` -------------------------------- ### POST /player/{id}/scores/compact Source: https://api.beatleader.com/swagger/blapi/swagger.json Fetches a paginated list of scores for a specified player ID. Returns less info to save bandwith or processing time ```markdown ### Parameters - **id** (string, path, required): Player's unique identifier - **playlistIds** (string, query, optional): Playlits Ids to filter, default is null - **sortBy** (string (date|pp|accPP|passPP|techPP|acc|pauses|playCount|lastTryTime|rank|maxStreak|timing|stars|mistakes|replaysWatched|sotwNominations|scoreValue), query, optional): Sorting criteria for scores, default is by 'date' - **order** (string (desc|asc), query, optional): Order of sorting, default is descending - **thenSortBy** (string (date|pp|accPP|passPP|techPP|acc|pauses|playCount|lastTryTime|rank|maxStreak|timing|stars|mistakes|replaysWatched|sotwNominations|scoreValue), query, optional): Additional sorting criteria for scores tied by the first sort - **thenOrder** (string (desc|asc), query, optional): Order of additional sorting, default is descending - **page** (integer (int32), query, optional): Page number for pagination, default is 1 - **count** (integer (int32), query, optional): Number of scores per page, default is 8 - **search** (string, query, optional): Filter scores by search term in song name, author or mapper. Default is null - **noSearchSort** (boolean, query, optional): Disabled scores sort by search relevance index - **diff** (string, query, optional): Filter scores by map difficulty(Easy, Expert, Expert+, etc), default is null - **mode** (string, query, optional): Filter scores by map characteristic(Standard, OneSaber, etc), default is null - **requirements** (string (none|chroma|noodles|mappingExtensions|cinema|v3|optionalProperties|vNJS|vivify|v3Pepega|groupLighting|ignore), query, optional): Filter scores by map requirements, default is 'None' (example: -1) - **scoreStatus** (string (none|suspicious), query, optional): Filter scores by score status, default is 'None' - **leaderboardContext** (string (none|general|noMods|noPause|golf|sCPM|speedrun|speedrunBackup|funny), query, optional): Filter scores by leaderboard context, default is 'General' (example: 510) - **type** (union, query, optional): Filter scores by map status, default is null - **hmd** (union, query, optional): Filter scores by headset, default is null - **modifiers** (string, query, optional): Filter scores by modifiers(GN, SF, etc), default is null - **stars_from** (number (float), query, optional): Filter scores on ranked maps with stars greater than, default is null - **stars_to** (number (float), query, optional): Filter scores on ranked maps with stars lower than, default is null - **acc_from** (number (float), query, optional): Filter scores on score accuracy greater than, default is null - **acc_to** (number (float), query, optional): Filter scores on score accuracy lower than, default is null - **time_from** (integer (int32), query, optional): Filter scores made after unix timestamp, default is null - **time_to** (integer (int32), query, optional): Filter scores made before unix timestamp, default is null - **eventId** (integer (int32), query, optional): Show only scores from the event with ID, default is null ### Request Body **Content-Type:** application/json - Array of object - **songs** (array (object)) Array items: - **hash** (string) - **key** (string) - **songName** (string) - **levelAuthorName** (string) - **difficulties** (array (object)) Array items: - **name** (string) - **characteristic** (string) **Content-Type:** text/json - Array of object - **songs** (array (object)) Array items: - **hash** (string) - **key** (string) - **songName** (string) - **levelAuthorName** (string) - **difficulties** (array (object)) Array items: - **name** (string) - **characteristic** (string) **Content-Type:** application/*+json - Array of object - **songs** (array (object)) Array items: - **hash** (string) - **key** (string) - **songName** (string) - **levelAuthorName** (string) - **difficulties** (array (object)) Array items: - **name** (string) - **characteristic** (string) ### Responses #### 200 - Scores retrieved successfully **CompactScoreResponseResponseWithMetadata** - **metadata** (object) - **itemsPerPage** (integer (int32)) - **page** (integer (int32)) - **total** (integer (int32)) - **data** (array (object)) Array items: - **score** (object) - **id** (integer (int32)) - **originalId** (integer (int32)) - **baseScore** (integer (int32)) - **modifiedScore** (integer (int32)) - **modifiers** (string) - **fullCombo** (boolean) - **maxCombo** (integer (int32)) - **missedNotes** (integer (int32)) - **badCuts** (integer (int32)) - **hmd** (integer) ("0"|"1"|"2"|"4"|"8"|"16"|"32"|"33"|"34"|"35"|"36"|"37"|"38"|"39"|"40"|"41"|"42"|"43"|"44"|"45"|"46"|"47"|"48"|"49"|"50"|"51"|"52"|"53"|"54"|"55"|"56"|"57"|"58"|"59"|"60"|"61"|"62"|"63"|"64"|"65"|"66"|"67"|"68"|"69"|"70"|"71"|"72"|"73"|"74"|"128"|"256"|"512"|"513") - **controller** (integer) ("0"|"1"|"2"|"4"|"8"|"9"|"10"|"16"|"33"|"34"|"35"|"37"|"44"|"61"|"62"|"63"|"64"|"65"|"66"|"67"|"68"|"69"|"70"|"71"|"72"|"73"|"74"|"75"|"76"|"77"|"78"|"79"|"80"|"81"|"128"|"256") - **accuracy** (number (float)) - **pp** (number (float)) - **epochTime** (integer (int32)) - **leaderboard** (object) - **id** (string) - **songHash** (string) - **modeName** (string) - **difficulty** (integer (int32)) **CompactScoreResponseResponseWithMetadata** **CompactScoreResponseResponseWithMetadata** #### 400 - Invalid request parameters Invalid request parameters #### 404 - Scores not found for the given player ID Scores not found for the given player ID ### Example Usage ```bash curl -X POST "https://api.beatleader.com/player/{id}/scores/compact?playlistIds=string&sortBy=0&order=0&thenSortBy=0&thenOrder=0&page=1&count=8&search=string&noSearchSort=false&diff=string&mode=string&requirements=-1&scoreStatus=0&leaderboardContext=510&type=value&hmd=value&modifiers=string&stars_from=0&stars_to=0&acc_from=0&acc_to=0&time_from=0&time_to=0&eventId=0" \ -H "Content-Type: application/json" \ -d '[ { "songs": [ { "hash": "string", "key": "string", "songName": "string", "levelAuthorName": "string", "difficulties": [ { "name": "string", "characteristic": "string" } ] } ] } ]' ``` ```