{ "openapi": "3.0.4", "info": { "title": "BeatLeader API. Get various Beat Saber information.", "description": "Retrieves players, scores, rankings, maps, leaderboards and much more for Beat Saber.", "version": "v1" }, "servers": [ { "url": "https://api.beatleader.com" } ], "paths": { "/beasties/nominations": { "get": { "tags": [ "BeastSaber" ], "summary": "Retrieve a list of nominations for particular leaderboard", "description": "Authenticated player Beasties nominations.", "operationId": "BeastSaber_GetAll", "parameters": [ { "name": "leaderboardId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of nominations retrieved successfully", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BeastiesNomination" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BeastiesNomination" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BeastiesNomination" } } } } }, "400": { "description": "Invalid request parameters" }, "401": { "description": "Autorization failed" } } } }, "/beasties/nominations/my": { "get": { "tags": [ "BeastSaber" ], "summary": "Retrieve a list of nominations for particular leaderboard", "description": "Authenticated player Beasties nominations.", "operationId": "BeastSaber_PlayerNominations", "responses": { "200": { "description": "List of nominations retrieved successfully", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BeastiesNomination" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BeastiesNomination" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BeastiesNomination" } } } } }, "400": { "description": "Invalid request parameters" }, "401": { "description": "Autorization failed" } } } }, "/beasties/nominations/my/finalists": { "get": { "tags": [ "BeastSaber" ], "summary": "Retrieve a list of player nominations that became finalists", "description": "Authenticated player Beasties nominations filtered to only finalists.", "operationId": "BeastSaber_PlayerFinalistNominations", "responses": { "200": { "description": "List of finalist nominations retrieved successfully", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MapInfoResponseBeasties" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MapInfoResponseBeasties" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MapInfoResponseBeasties" } } } } }, "400": { "description": "Invalid request parameters" }, "401": { "description": "Autorization failed" } } } }, "/beasties/nominate": { "post": { "tags": [ "BeastSaber" ], "summary": "Nominate a map for Besties Awards", "description": "Nominates provided leaderboard map for mapping awards in selected category", "operationId": "BeastSaber_Nominate", "parameters": [ { "name": "leaderboardId", "in": "query", "schema": { "type": "string" } }, { "name": "category", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Map was nominated", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BestiesNominationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BestiesNominationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BestiesNominationResponse" } } } }, "400": { "description": "Invalid request parameters" }, "401": { "description": "Autorization failed" } } } }, "/clans": { "get": { "tags": [ "Clan" ], "summary": "Retrieve a list of clans", "description": "Fetches a paginated and optionally filtered list of clans (group of players). Filters include sorting by performance points, search, name, rank, and more.", "operationId": "Clan_GetAll", "parameters": [ { "name": "page", "in": "query", "description": "Page number for pagination, default is 1", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "count", "in": "query", "description": "Number of players per page, default is 10", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "sort", "in": "query", "schema": { "enum": [ "name", "pp", "acc", "rank", "count", "captures" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ClanSortBy" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, { "enum": [ "name", "pp", "acc", "rank", "count", "captures" ], "type": "string" } ], "default": 5 } }, { "name": "order", "in": "query", "description": "Represents the order in which values will be sorted.", "schema": { "enum": [ "desc", "asc" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/Order" } ], "oneOf": [ { "enum": [ 0, 1 ], "type": "integer" }, { "enum": [ "desc", "asc" ], "type": "string" } ], "description": "Represents the order in which values will be sorted.", "default": 0 } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/ClanSortBy" } ] } } ], "responses": { "200": { "description": "List of clans retrieved successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClanResponseFullResponseWithMetadata" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClanResponseFullResponseWithMetadata" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClanResponseFullResponseWithMetadata" } } } }, "400": { "description": "Invalid request parameters" }, "404": { "description": "Clans not found" } } } }, "/clan/{tag}": { "get": { "tags": [ "Clan" ], "summary": "Retrieve details of a specific clan by tag", "description": "Fetches details of a specific clan identified by its tag.", "operationId": "Clan_GetClan", "parameters": [ { "name": "tag", "in": "path", "description": "Tag of the clan to retrieve details for", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number for pagination, default is 1", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "count", "in": "query", "description": "Number of players per page, default is 10", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "sortBy", "in": "query", "description": "Field to sort players by, default is Pp", "schema": { "enum": [ "pp", "topPp", "name", "rank", "acc", "weightedAcc", "top1Count", "top1Score", "weightedRank", "topAcc", "hmd", "playCount", "score", "lastplay", "maxStreak", "replaysWatched", "dailyImprovements", "timing", "allContextsPp", "level", "prestige", "experience", "scorePlaytime", "steamPlaytime", "steamPlaytime2Weeks" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/PlayerSortBy" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24 ], "type": "integer" }, { "enum": [ "pp", "topPp", "name", "rank", "acc", "weightedAcc", "top1Count", "top1Score", "weightedRank", "topAcc", "hmd", "playCount", "score", "lastplay", "maxStreak", "replaysWatched", "dailyImprovements", "timing", "allContextsPp", "level", "prestige", "experience", "scorePlaytime", "steamPlaytime", "steamPlaytime2Weeks" ], "type": "string" } ], "default": 0 } }, { "name": "order", "in": "query", "description": "Order of sorting, default is Desc", "schema": { "enum": [ "desc", "asc" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/Order" } ], "oneOf": [ { "enum": [ 0, 1 ], "type": "integer" }, { "enum": [ "desc", "asc" ], "type": "string" } ], "description": "Represents the order in which values will be sorted.", "default": 0 } }, { "name": "primary", "in": "query", "description": "Whether to include only players for whom this clan is primary, default is false", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Clan details retrieved successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlayerResponseClanResponseFullResponseWithMetadataAndContainer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PlayerResponseClanResponseFullResponseWithMetadataAndContainer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlayerResponseClanResponseFullResponseWithMetadataAndContainer" } } } }, "404": { "description": "Clan not found" } } } }, "/clan/id/{id}": { "get": { "tags": [ "Clan" ], "summary": "Retrieve details of a specific clan by ID", "description": "Fetches details of a specific clan identified by its ID.", "operationId": "Clan_GetClanById", "parameters": [ { "name": "id", "in": "path", "description": "ID of the clan to retrieve details for", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "description": "Page number for pagination, default is 1", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "count", "in": "query", "description": "Number of players per page, default is 10", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "sortBy", "in": "query", "description": "Field to sort players by, default is Pp", "schema": { "enum": [ "pp", "topPp", "name", "rank", "acc", "weightedAcc", "top1Count", "top1Score", "weightedRank", "topAcc", "hmd", "playCount", "score", "lastplay", "maxStreak", "replaysWatched", "dailyImprovements", "timing", "allContextsPp", "level", "prestige", "experience", "scorePlaytime", "steamPlaytime", "steamPlaytime2Weeks" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/PlayerSortBy" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24 ], "type": "integer" }, { "enum": [ "pp", "topPp", "name", "rank", "acc", "weightedAcc", "top1Count", "top1Score", "weightedRank", "topAcc", "hmd", "playCount", "score", "lastplay", "maxStreak", "replaysWatched", "dailyImprovements", "timing", "allContextsPp", "level", "prestige", "experience", "scorePlaytime", "steamPlaytime", "steamPlaytime2Weeks" ], "type": "string" } ], "default": 0 } }, { "name": "order", "in": "query", "description": "Order of sorting, default is Desc", "schema": { "enum": [ "desc", "asc" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/Order" } ], "oneOf": [ { "enum": [ 0, 1 ], "type": "integer" }, { "enum": [ "desc", "asc" ], "type": "string" } ], "description": "Represents the order in which values will be sorted.", "default": 0 } }, { "name": "primary", "in": "query", "description": "Whether to include only players for whom this clan is primary, default is false", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Clan details retrieved successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlayerResponseClanResponseFullResponseWithMetadataAndContainer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PlayerResponseClanResponseFullResponseWithMetadataAndContainer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlayerResponseClanResponseFullResponseWithMetadataAndContainer" } } } }, "404": { "description": "Clan not found" } } } }, "/clan/{tag}/maps": { "get": { "tags": [ "Clan" ], "summary": "Retrieve clan maps by tag", "description": "Fetches ranked maps(maps that can be captured on the global map) for where players of clan made scores identified by its tag, with optional sorting and filtering.", "operationId": "Clan_GetClanWithMaps", "parameters": [ { "name": "tag", "in": "path", "description": "Tag of the clan to retrieve maps for", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number for pagination, default is 1", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "count", "in": "query", "description": "Number of maps per page, default is 10", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "sortBy", "in": "query", "description": "Field to sort maps by, default is Pp", "schema": { "enum": [ "pp", "acc", "rank", "date", "tohold", "toconquer" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ClanMapsSortBy" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, { "enum": [ "pp", "acc", "rank", "date", "tohold", "toconquer" ], "type": "string" } ], "default": 0 } }, { "name": "leaderboardContext", "in": "query", "description": "Context of the leaderboard, default is General", "schema": { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/LeaderboardContexts" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 ], "type": "integer" }, { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "default": 2, "example": 2046 } }, { "name": "order", "in": "query", "description": "Order of sorting, default is Desc", "schema": { "enum": [ "desc", "asc" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/Order" } ], "oneOf": [ { "enum": [ 0, 1 ], "type": "integer" }, { "enum": [ "desc", "asc" ], "type": "string" } ], "description": "Represents the order in which values will be sorted.", "default": 0 } }, { "name": "playedStatus", "in": "query", "description": "Filter by played status of current player", "schema": { "enum": [ "any", "played", "unplayed" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/PlayedStatus" } ], "oneOf": [ { "enum": [ 0, 1, 2 ], "type": "integer" }, { "enum": [ "any", "played", "unplayed" ], "type": "string" } ], "default": 0 } } ], "responses": { "200": { "description": "Clan maps retrieved successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClanRankingResponseClanResponseFullResponseWithMetadataAndContainer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClanRankingResponseClanResponseFullResponseWithMetadataAndContainer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClanRankingResponseClanResponseFullResponseWithMetadataAndContainer" } } } }, "404": { "description": "Clan not found" } } } }, "/clan/id/{id}/maps": { "get": { "tags": [ "Clan" ], "summary": "Retrieve clan maps by ID", "description": "Fetches ranked maps(maps that can be captured on the global map) for where players of clan made scores identified by its ID, with optional sorting and filtering.", "operationId": "Clan_GetClanWithMapsById", "parameters": [ { "name": "id", "in": "path", "description": "ID of the clan to retrieve maps for", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "description": "Page number for pagination, default is 1", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "count", "in": "query", "description": "Number of maps per page, default is 10", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "sortBy", "in": "query", "description": "Field to sort maps by, default is Pp", "schema": { "enum": [ "pp", "acc", "rank", "date", "tohold", "toconquer" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ClanMapsSortBy" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, { "enum": [ "pp", "acc", "rank", "date", "tohold", "toconquer" ], "type": "string" } ], "default": 0 } }, { "name": "leaderboardContext", "in": "query", "description": "Context of the leaderboard, default is General", "schema": { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/LeaderboardContexts" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 ], "type": "integer" }, { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "default": 2, "example": 2046 } }, { "name": "order", "in": "query", "description": "Order of sorting, default is Desc", "schema": { "enum": [ "desc", "asc" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/Order" } ], "oneOf": [ { "enum": [ 0, 1 ], "type": "integer" }, { "enum": [ "desc", "asc" ], "type": "string" } ], "description": "Represents the order in which values will be sorted.", "default": 0 } }, { "name": "playedStatus", "in": "query", "description": "Filter by played status of current player", "schema": { "enum": [ "any", "played", "unplayed" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/PlayedStatus" } ], "oneOf": [ { "enum": [ 0, 1, 2 ], "type": "integer" }, { "enum": [ "any", "played", "unplayed" ], "type": "string" } ], "default": 0 } } ], "responses": { "200": { "description": "Clan maps retrieved successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClanRankingResponseClanResponseFullResponseWithMetadataAndContainer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClanRankingResponseClanResponseFullResponseWithMetadataAndContainer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClanRankingResponseClanResponseFullResponseWithMetadataAndContainer" } } } }, "404": { "description": "Clan not found" } } } }, "/clan/{id}/history": { "get": { "tags": [ "Clan" ], "summary": "Retrieve clan's statistic history", "description": "Fetches a list of player's performance metrics and various stats saved daily", "operationId": "Clan_GetHistory", "parameters": [ { "name": "id", "in": "path", "description": "Clan's unique identifier", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "count", "in": "query", "description": "Amount of days to include", "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "History retrieved successfully", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GlobalMapHistory" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GlobalMapHistory" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GlobalMapHistory" } } } } }, "400": { "description": "Invalid request parameters" }, "404": { "description": "No history saved for the given clan ID" } } } }, "/clan/id/{id}/triangle": { "get": { "tags": [ "Clan" ], "summary": "Retrieve clan details for the skill triangle", "description": "Fetches ranked maps(maps that can be captured on the global map) for where players of clan made scores identified by its tag, with optional sorting and filtering.", "operationId": "Clan_GetClanTriangleData", "parameters": [ { "name": "id", "in": "path", "description": "Id of the clan to retrieve maps for", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Clan triangle retrieved successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClanTriangleResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClanTriangleResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClanTriangleResponse" } } } }, "404": { "description": "Clan not found" } } } }, "/clans/globalmap": { "get": { "tags": [ "Clan" ], "summary": "Retrieve the global clan map", "description": "Fetches a global map showing clan captured maps and rankings.", "operationId": "Clan_GlobalMap", "responses": { "200": { "description": "Global map retrieved successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClanGlobalMap" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClanGlobalMap" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClanGlobalMap" } } } }, "404": { "description": "Global map not found" } } } }, "/experience/prestige": { "get": { "tags": [ "Experience" ], "summary": "Reset the current player level and prestige", "description": "Reset the current logged in player level and prestige", "operationId": "Experience_PrestigePlayer", "responses": { "200": { "description": "Successful prestige" }, "400": { "description": "Player is already max prestige" }, "404": { "description": "Player not found" } } } }, "/experience/levels": { "get": { "tags": [ "Experience" ], "summary": "Reset the current player level and prestige", "description": "Reset the current logged in player level and prestige", "operationId": "Experience_PrestiegeLevels", "responses": { "200": { "description": "Successful prestige", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PrestiegeLevel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PrestiegeLevel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PrestiegeLevel" } } } } }, "400": { "description": "Player is already max prestige" }, "404": { "description": "Player not found" } } } }, "/leaderboard/{id}": { "get": { "tags": [ "Leaderboard" ], "summary": "Retrieve leaderboard details", "description": "Fetches details of a leaderboard identified by its ID, with optional sorting and filtering for scores.", "operationId": "Leaderboard_Get", "parameters": [ { "name": "id", "in": "path", "description": "ID of the leaderboard to retrieve details for", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Scores page number for pagination, default is 1", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "count", "in": "query", "description": "Number of scores per page, default is 10", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "sortBy", "in": "query", "description": "Field to sort scores by, default is Rank", "schema": { "enum": [ "date", "pp", "acc", "pauses", "rank", "maxStreak", "mistakes", "weight", "weightedPp" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/LeaderboardSortBy" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8 ], "type": "integer" }, { "enum": [ "date", "pp", "acc", "pauses", "rank", "maxStreak", "mistakes", "weight", "weightedPp" ], "type": "string" } ], "default": 4 } }, { "name": "order", "in": "query", "description": "Order of sorting, default is Desc", "schema": { "enum": [ "desc", "asc" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/Order" } ], "oneOf": [ { "enum": [ 0, 1 ], "type": "integer" }, { "enum": [ "desc", "asc" ], "type": "string" } ], "description": "Represents the order in which values will be sorted.", "default": 0 } }, { "name": "scoreStatus", "in": "query", "description": "Filter for score status, default is None", "schema": { "enum": [ "none", "suspicious" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ScoreFilterStatus" } ], "oneOf": [ { "enum": [ 0, 1 ], "type": "integer" }, { "enum": [ "none", "suspicious" ], "type": "string" } ], "default": 0 } }, { "name": "leaderboardContext", "in": "query", "description": "Context of the leaderboard, default is General", "schema": { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/LeaderboardContexts" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 ], "type": "integer" }, { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "default": 2, "example": 2046 } }, { "name": "countries", "in": "query", "description": "Filter for specific countries (country code, comma separated)", "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "Search term to filter scores by player name or clan", "schema": { "type": "string" } }, { "name": "modifiers", "in": "query", "description": "Modifiers to filter scores by (comma separated)", "schema": { "type": "string" } }, { "name": "friends", "in": "query", "description": "Whether to include only scores from friends, default is false", "schema": { "type": "boolean", "default": false } }, { "name": "voters", "in": "query", "description": "Whether to include only scores from voters, default is false", "schema": { "type": "boolean", "default": false } }, { "name": "clanTag", "in": "query", "description": "Whether to include only scores from clan, default is false", "schema": { "type": "string" } }, { "name": "hmds", "in": "query", "description": "Comma-separated range to filter by hmd (headset), default is null", "schema": { "type": "string" } }, { "name": "prediction", "in": "query", "description": "Whether to include predicted scores, default is false", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Leaderboard details retrieved successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LeaderboardResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LeaderboardResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LeaderboardResponse" } } } }, "404": { "description": "Leaderboard not found" } } } }, "/leaderboard/clanRankings/{id}": { "get": { "tags": [ "Leaderboard" ], "summary": "Retrieve clan rankings for a leaderboard", "description": "Fetches clan rankings for a leaderboard identified by its ID.", "operationId": "Leaderboard_GetClanRankings", "parameters": [ { "name": "id", "in": "path", "description": "ID of the leaderboard to retrieve clan rankings for", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number for pagination, default is 1", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "count", "in": "query", "description": "Number of rankings per page, default is 10", "schema": { "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "Clan rankings retrieved successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LeaderboardClanRankingResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LeaderboardClanRankingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LeaderboardClanRankingResponse" } } } }, "404": { "description": "Leaderboard not found" } } } }, "/leaderboards": { "get": { "tags": [ "Leaderboard" ], "summary": "Retrieve a list of leaderboards (maps)", "description": "Fetches a paginated and optionally filtered list of leaderboards (Beat Saber maps).", "operationId": "Leaderboard_GetAll", "parameters": [ { "name": "page", "in": "query", "description": "Page number for pagination, default is 1", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "count", "in": "query", "description": "Number of leaderboards per page, default is 10", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "sortBy", "in": "query", "description": "Field to sort leaderboards by, default is None", "schema": { "enum": [ "none", "timestamp", "name", "stars", "passRating", "accRating", "techRating", "scoreTime", "playCount", "voting", "voteCount", "voteRatio", "duration", "attempts", "nJS", "nPS", "bPM", "multiRating", "eBPM", "linearPercentage" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/MapSortBy" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19 ], "type": "integer" }, { "enum": [ "none", "timestamp", "name", "stars", "passRating", "accRating", "techRating", "scoreTime", "playCount", "voting", "voteCount", "voteRatio", "duration", "attempts", "nJS", "nPS", "bPM", "multiRating", "eBPM", "linearPercentage" ], "type": "string" } ], "default": 0 } }, { "name": "order", "in": "query", "description": "Order of sorting, default is Desc", "schema": { "enum": [ "desc", "asc" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/Order" } ], "oneOf": [ { "enum": [ 0, 1 ], "type": "integer" }, { "enum": [ "desc", "asc" ], "type": "string" } ], "description": "Represents the order in which values will be sorted.", "default": 0 } }, { "name": "search", "in": "query", "description": "Search term to filter leaderboards by song, author or mapper name", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Type of leaderboards to filter, default is All", "schema": { "enum": [ "all", "ranked", "ranking", "nominated", "qualified", "staff", "reweighting", "reweighted", "unranked", "ost" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/Type" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "type": "integer" }, { "enum": [ "all", "ranked", "ranking", "nominated", "qualified", "staff", "reweighting", "reweighted", "unranked", "ost" ], "type": "string" } ], "default": 0 } }, { "name": "mode", "in": "query", "description": "Mode to filter leaderboards by (Standard, OneSaber, etc...)", "schema": { "type": "string" } }, { "name": "difficulty", "in": "query", "description": "Difficulty to filter leaderboards by (Easy, Normal, Hard, Expert, ExpertPlus)", "schema": { "type": "string" } }, { "name": "mapType", "in": "query", "description": "Map type to filter leaderboards by", "schema": { "enum": [ "none", "acc", "tech", "midspeed", "speed", "fitbeat", "linear", "bombReset" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/MapTypes" } ], "oneOf": [ { "enum": [ 0, 1, 2, 4, 8, 16, 32, 64 ], "type": "integer" }, { "enum": [ "none", "acc", "tech", "midspeed", "speed", "fitbeat", "linear", "bombReset" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "default": 0, "example": 127 } }, { "name": "allTypes", "in": "query", "description": "Operation to filter all types, default is Any", "schema": { "enum": [ "any", "all", "not" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/Operation" } ], "oneOf": [ { "enum": [ 0, 1, 2 ], "type": "integer" }, { "enum": [ "any", "all", "not" ], "type": "string" } ], "default": 0 } }, { "name": "mapRequirements", "in": "query", "description": "Requirements to filter leaderboards by, default is Ignore", "schema": { "enum": [ "none", "chroma", "noodles", "mappingExtensions", "cinema", "v3", "optionalProperties", "vNJS", "vivify", "v3Pepega", "groupLighting", "audioLink", "ignore" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/Requirements" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, -1 ], "type": "integer" }, { "enum": [ "none", "chroma", "noodles", "mappingExtensions", "cinema", "v3", "optionalProperties", "vNJS", "vivify", "v3Pepega", "groupLighting", "audioLink", "ignore" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "default": -1, "example": -1 } }, { "name": "allRequirements", "in": "query", "description": "Operation to filter all requirements, default is Any", "schema": { "enum": [ "any", "all", "not" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/Operation" } ], "oneOf": [ { "enum": [ 0, 1, 2 ], "type": "integer" }, { "enum": [ "any", "all", "not" ], "type": "string" } ], "default": 0 } }, { "name": "songStatus", "in": "query", "description": "Song status to filter leaderboards by, default is None", "schema": { "enum": [ "none", "curated", "mapOfTheWeek", "noodleMonday", "featuredOnCC", "beastSaberAwarded", "buildingBlocksAwarded" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/SongStatus" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64 ], "type": "integer" }, { "enum": [ "none", "curated", "mapOfTheWeek", "noodleMonday", "featuredOnCC", "beastSaberAwarded", "buildingBlocksAwarded" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "default": 0, "example": 126 } }, { "name": "leaderboardContext", "in": "query", "description": "Context of the leaderboard, default is General", "schema": { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/LeaderboardContexts" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 ], "type": "integer" }, { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "default": 2, "example": 2046 } }, { "name": "mapCreator", "in": "query", "description": "Map creator, human by default", "schema": { "enum": [ "human", "genericBot", "beatSage", "topMapper" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/SongCreator" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3 ], "type": "integer" }, { "enum": [ "human", "genericBot", "beatSage", "topMapper" ], "type": "string" } ], "default": 0 } }, { "name": "mytype", "in": "query", "description": "My type to filter leaderboards by, default is None", "schema": { "enum": [ "none", "played", "unplayed", "myNominated", "othersNominated", "myMaps" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/MyType" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, { "enum": [ "none", "played", "unplayed", "myNominated", "othersNominated", "myMaps" ], "type": "string" } ], "default": 0 } }, { "name": "stars_from", "in": "query", "description": "Minimum stars to filter leaderboards by", "schema": { "type": "number", "format": "float" } }, { "name": "stars_to", "in": "query", "description": "Maximum stars to filter leaderboards by", "schema": { "type": "number", "format": "float" } }, { "name": "accrating_from", "in": "query", "description": "Minimum accuracy rating to filter leaderboards by", "schema": { "type": "number", "format": "float" } }, { "name": "accrating_to", "in": "query", "description": "Maximum accuracy rating to filter leaderboards by", "schema": { "type": "number", "format": "float" } }, { "name": "passrating_from", "in": "query", "description": "Minimum pass rating to filter leaderboards by", "schema": { "type": "number", "format": "float" } }, { "name": "passrating_to", "in": "query", "description": "Maximum pass rating to filter leaderboards by", "schema": { "type": "number", "format": "float" } }, { "name": "techrating_from", "in": "query", "description": "Minimum tech rating to filter leaderboards by", "schema": { "type": "number", "format": "float" } }, { "name": "techrating_to", "in": "query", "description": "Maximum tech rating to filter leaderboards by", "schema": { "type": "number", "format": "float" } }, { "name": "date_from", "in": "query", "description": "Start date to filter leaderboards by (timestamp)", "schema": { "type": "integer", "format": "int32" } }, { "name": "date_to", "in": "query", "description": "End date to filter leaderboards by (timestamp)", "schema": { "type": "integer", "format": "int32" } }, { "name": "date_range", "in": "query", "description": "Type of the date filter, default by map upload date", "schema": { "enum": [ "upload", "ranked", "score" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/DateRangeType" } ], "oneOf": [ { "enum": [ 0, 1, 2 ], "type": "integer" }, { "enum": [ "upload", "ranked", "score" ], "type": "string" } ], "default": 0 } }, { "name": "types", "in": "query", "description": "Types of leaderboards to filter, default is null(All). Same as type but multiple", "schema": { "type": "string" } }, { "name": "playlistIds", "in": "query", "description": "Playlits Ids to filter, default is null", "schema": { "type": "string" } }, { "name": "mappers", "in": "query", "description": "Filter maps from a specific mappers. BeatSaver profile ID list, comma separated, default is null", "schema": { "type": "string" } }, { "name": "overrideCurrentId", "in": "query", "schema": { "type": "string" } }, { "name": "uploadTreshold", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlaylistResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlaylistResponse" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlaylistResponse" } } } } }, "responses": { "200": { "description": "Leaderboards retrieved successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LeaderboardInfoResponseResponseWithMetadata" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LeaderboardInfoResponseResponseWithMetadata" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LeaderboardInfoResponseResponseWithMetadata" } } } }, "404": { "description": "Leaderboards not found" } } } }, "/leaderboard/{id}/scoregraph": { "get": { "tags": [ "Leaderboard" ], "summary": "Retrieve scores graph for a leaderboard", "description": "Fetches the scores graph for a leaderboard identified by its ID. Compact endpoint to use in the leaderboard data visualizations.", "operationId": "Leaderboard_GetScoregraph", "parameters": [ { "name": "id", "in": "path", "description": "ID of the leaderboard to retrieve score graph for", "required": true, "schema": { "type": "string" } }, { "name": "leaderboardContext", "in": "query", "description": "Leaderboard context, general by default.", "schema": { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/LeaderboardContexts" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 ], "type": "integer" }, { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "default": 2, "example": 2046 } } ], "responses": { "200": { "description": "Score graph retrieved successfully", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreGraphEntry" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreGraphEntry" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreGraphEntry" } } } } }, "404": { "description": "Leaderboard not found" } } } }, "/mappers": { "get": { "tags": [ "Mapper" ], "summary": "Retrieve a list of known mappers", "description": "Fetches a paginated and optionally filtered list of mappers.", "operationId": "Mapper_GetAll", "parameters": [ { "name": "page", "in": "query", "description": "Page number for pagination, default is 1", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "count", "in": "query", "description": "Number of mappers per page, default is 10", "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "sort", "in": "query", "schema": { "enum": [ "name", "maps", "rankedMaps" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/MapperSortBy" } ], "oneOf": [ { "enum": [ 0, 1, 2 ], "type": "integer" }, { "enum": [ "name", "maps", "rankedMaps" ], "type": "string" } ], "default": 2 } }, { "name": "order", "in": "query", "description": "Represents the order in which values will be sorted.", "schema": { "enum": [ "desc", "asc" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/Order" } ], "oneOf": [ { "enum": [ 0, 1 ], "type": "integer" }, { "enum": [ "desc", "asc" ], "type": "string" } ], "description": "Represents the order in which values will be sorted.", "default": 0 } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "ids", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of mappers retrieved successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClanResponseFullResponseWithMetadata" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClanResponseFullResponseWithMetadata" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClanResponseFullResponseWithMetadata" } } } }, "400": { "description": "Invalid request parameters" }, "404": { "description": "Mappers not found" } } } }, "/modifiers": { "get": { "tags": [ "Modifiers" ], "summary": "Retrieve Legacy Modifiers", "description": "Provides a list of Beat Saber modifiers and their associated score multiplier values. This is legacy support, for the recent values please use `modifierValues` and `modifierRatings` on leaderboards.", "operationId": "Modifiers_GetModifiers", "responses": { "200": { "description": "Modifiers retrieved successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LegacyModifiers" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LegacyModifiers" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LegacyModifiers" } } } } } } }, "/refreshmypatreon": { "get": { "tags": [ "Patreon" ], "summary": "Refresh Patreon Link", "description": "Refreshes the Patreon link for the current user, updating their Patreon tier and roles based on the latest information.", "operationId": "Patreon_RefreshMyPatreon", "responses": { "200": { "description": "Patreon link refreshed successfully" }, "400": { "description": "Bad request, no existing Patreon link" }, "401": { "description": "Unauthorized, user not found or not logged in" } } } }, "/player/{id}/pinnedScores": { "get": { "tags": [ "PinnedScore" ], "summary": "Retrieve player's pinned scores", "description": "Fetches a paginated list of scores pinned by player for their ID.", "operationId": "PinnedScore_GetPinnedScores", "parameters": [ { "name": "id", "in": "path", "description": "Player's unique identifier", "required": true, "schema": { "type": "string" } }, { "name": "leaderboardContext", "in": "query", "description": "Filter scores by leaderboard context, default is 'General'", "schema": { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/LeaderboardContexts" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 ], "type": "integer" }, { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "default": 2, "example": 2046 } } ], "responses": { "200": { "description": "Scores retrieved successfully", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AttemptResponseWithMyScore" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AttemptResponseWithMyScore" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AttemptResponseWithMyScore" } } } } }, "400": { "description": "Invalid request parameters" }, "404": { "description": "Scores not found for the given player ID" } } } }, "/player/{id}/favoriteMaps": { "get": { "tags": [ "PinnedScore" ], "summary": "Retrieve player's favorite maps", "description": "Fetches a paginated list of maps selected by player for their ID.", "operationId": "PinnedScore_GetFavoriteMaps", "parameters": [ { "name": "id", "in": "path", "description": "Player's unique identifier", "required": true, "schema": { "type": "string" } }, { "name": "count", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 5 } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "Maps retrieved successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FavoriteMapResponseWithMetadata" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FavoriteMapResponseWithMetadata" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FavoriteMapResponseWithMetadata" } } } }, "400": { "description": "Invalid request parameters" }, "404": { "description": "Maps not found for the given player ID" } } } }, "/player/{id}/exists": { "get": { "tags": [ "Player" ], "summary": "Check if player with such ID or alias exists", "description": "Retrieves a status of potential Beat Saber profile for a specific player ID.", "operationId": "Player_Exists", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the player", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Player exists" }, "404": { "description": "Player not found" } } } }, "/player/{id}": { "get": { "tags": [ "Player" ], "summary": "Get player profile", "description": "Retrieves a Beat Saber profile data for a specific player ID.", "operationId": "Player_Get", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the player", "required": true, "schema": { "type": "string" } }, { "name": "stats", "in": "query", "description": "Include stats in the response", "schema": { "type": "boolean", "default": true } }, { "name": "keepOriginalId", "in": "query", "description": "Whether to keep original ID (for migrated players)", "schema": { "type": "boolean", "default": false } }, { "name": "leaderboardContext", "in": "query", "description": "Leaderboard context, 'general' by default", "schema": { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/LeaderboardContexts" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 ], "type": "integer" }, { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "default": 2, "example": 2046 } } ], "responses": { "200": { "description": "Returns the player's full profile", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlayerResponseFull" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PlayerResponseFull" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlayerResponseFull" } } } }, "404": { "description": "Player not found" } } } }, "/player/discord/{id}": { "get": { "tags": [ "Player" ], "summary": "Get player with Discord", "description": "Retrieves a BeatLeader profile data with linked Discord profile.", "operationId": "Player_GetDiscord", "parameters": [ { "name": "id", "in": "path", "description": "Discord profile ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the player's full profile", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlayerResponseFull" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PlayerResponseFull" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlayerResponseFull" } } } }, "404": { "description": "Player not found" } } } }, "/player/beatsaver/{id}": { "get": { "tags": [ "Player" ], "summary": "Get player with BeatSaver", "description": "Retrieves a BeatLeader profile data with linked BeatSaver profile.", "operationId": "Player_GetBeatSaver", "parameters": [ { "name": "id", "in": "path", "description": "BeatSaver profile ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the player's full profile", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlayerResponseFull" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PlayerResponseFull" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlayerResponseFull" } } } }, "404": { "description": "Player not found" } } } }, "/player/patreon/{id}": { "get": { "tags": [ "Player" ], "summary": "Get player with Patreon", "description": "Retrieves a BeatLeader profile data with linked Patreon profile.", "operationId": "Player_GetPatreon", "parameters": [ { "name": "id", "in": "path", "description": "Patreon profile ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the player's full profile", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlayerResponseFull" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PlayerResponseFull" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlayerResponseFull" } } } }, "404": { "description": "Player not found" } } } }, "/players": { "get": { "tags": [ "Player" ], "summary": "Retrieve a list of players (ranking)", "description": "Fetches a paginated and optionally filtered list of players. Filters include sorting by performance points, search, country, maps type, platform, and more.", "operationId": "Player_GetPlayers", "parameters": [ { "name": "sortBy", "in": "query", "description": "Sorting criteria, default is 'pp' (performance points)", "schema": { "enum": [ "pp", "topPp", "name", "rank", "acc", "weightedAcc", "top1Count", "top1Score", "weightedRank", "topAcc", "hmd", "playCount", "score", "lastplay", "maxStreak", "replaysWatched", "dailyImprovements", "timing", "allContextsPp", "level", "prestige", "experience", "scorePlaytime", "steamPlaytime", "steamPlaytime2Weeks" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/PlayerSortBy" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24 ], "type": "integer" }, { "enum": [ "pp", "topPp", "name", "rank", "acc", "weightedAcc", "top1Count", "top1Score", "weightedRank", "topAcc", "hmd", "playCount", "score", "lastplay", "maxStreak", "replaysWatched", "dailyImprovements", "timing", "allContextsPp", "level", "prestige", "experience", "scorePlaytime", "steamPlaytime", "steamPlaytime2Weeks" ], "type": "string" } ], "default": 0 } }, { "name": "page", "in": "query", "description": "Page number for pagination, default is 1", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "count", "in": "query", "description": "Number of players per page, default is 50", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "search", "in": "query", "description": "Search term for filtering players by username", "schema": { "type": "string", "default": "" } }, { "name": "order", "in": "query", "description": "Order of sorting, default is descending", "schema": { "enum": [ "desc", "asc" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/Order" } ], "oneOf": [ { "enum": [ 0, 1 ], "type": "integer" }, { "enum": [ "desc", "asc" ], "type": "string" } ], "description": "Represents the order in which values will be sorted.", "default": 0 } }, { "name": "countries", "in": "query", "description": "Comma-separated list of countries for filtering", "schema": { "type": "string", "default": "" } }, { "name": "mapsType", "in": "query", "description": "Type of maps to consider, default is 'ranked'", "schema": { "enum": [ "ranked", "unranked", "all" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/MapsType" } ], "oneOf": [ { "enum": [ 0, 1, 2 ], "type": "integer" }, { "enum": [ "ranked", "unranked", "all" ], "type": "string" } ], "default": 0 } }, { "name": "ppType", "in": "query", "description": "Type of performance points, default is 'general'", "schema": { "enum": [ "general", "acc", "pass", "tech" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/PpType" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3 ], "type": "integer" }, { "enum": [ "general", "acc", "pass", "tech" ], "type": "string" } ], "default": 0 } }, { "name": "leaderboardContext", "in": "query", "description": "Context of the leaderboard, default is 'General'", "schema": { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/LeaderboardContexts" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 ], "type": "integer" }, { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "default": 2, "example": 2046 } }, { "name": "friends", "in": "query", "description": "Flag to filter only friends, default is false", "schema": { "type": "boolean", "default": false } }, { "name": "pp_range", "in": "query", "description": "Comma-separated range to filter by amount of pp, default is null", "schema": { "type": "string" } }, { "name": "acc_pp_range", "in": "query", "description": "Comma-separated range to filter by amount of acc pp, default is null", "schema": { "type": "string" } }, { "name": "pass_pp_range", "in": "query", "description": "Comma-separated range to filter by amount of pass pp, default is null", "schema": { "type": "string" } }, { "name": "tech_pp_range", "in": "query", "description": "Comma-separated range to filter by amount of tech pp, default is null", "schema": { "type": "string" } }, { "name": "score_range", "in": "query", "description": "Comma-separated range to filter by total score count, default is null", "schema": { "type": "string" } }, { "name": "ranked_score_range", "in": "query", "description": "Comma-separated range to filter by ranked score count, default is null", "schema": { "type": "string" } }, { "name": "platform", "in": "query", "description": "Comma-separated range to filter by platform value, default is null", "schema": { "type": "string" } }, { "name": "role", "in": "query", "description": "Comma-separated range to filter by role, default is null", "schema": { "type": "string" } }, { "name": "hmd", "in": "query", "description": "Comma-separated range to filter by hmd (headset), default is null", "schema": { "type": "string" } }, { "name": "activityPeriod", "in": "query", "description": "Value in seconds to filter by the last score time, default is null", "schema": { "type": "integer", "format": "int32" } }, { "name": "firstScoreTime", "in": "query", "description": "Unix timestamp to filter by the first score time, default is null", "schema": { "type": "integer", "format": "int32" } }, { "name": "recentScoreTime", "in": "query", "description": "Unix timestamp to filter by the first score time, default is null", "schema": { "type": "integer", "format": "int32" } }, { "name": "mapperStatus", "in": "query", "description": "Mapper status filter, default is null", "schema": { "allOf": [ { "$ref": "#/components/schemas/MapperStatus" } ] } }, { "name": "banned", "in": "query", "description": "Flag to filter only banned players, default is null", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "List of players retrieved successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlayerResponseWithStatsResponseWithMetadata" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PlayerResponseWithStatsResponseWithMetadata" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlayerResponseWithStatsResponseWithMetadata" } } } }, "400": { "description": "Invalid request parameters" }, "404": { "description": "Players not found" } } } }, "/player/{id}/eventsparticipating": { "get": { "tags": [ "Player" ], "summary": "Get events where player participated", "description": "Retrieves a chronological list of events player with such ID took part of.", "operationId": "Player_GetParticipatingEvents", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the player", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns list of events player took part", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ParticipatingEventResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ParticipatingEventResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ParticipatingEventResponse" } } } }, "404": { "description": "Player not found" } } } }, "/player/{id}/followersInfo": { "get": { "tags": [ "Player" ], "summary": "Get player' followers and players they follow", "description": "Retrieves an info about player' followers such as count and 3 closest followers. Also 3 most followed players this player follows", "operationId": "Player_GetFollowersInfo", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the player", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns brief info about player followers.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlayerFollowersInfoResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PlayerFollowersInfoResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlayerFollowersInfoResponse" } } } }, "404": { "description": "Player not found" } } } }, "/player/{id}/followers": { "get": { "tags": [ "Player" ], "summary": "Get player's full follower list", "description": "Retrieves a full list of player' followers and players this player follow.", "operationId": "Player_GetFollowers", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the player", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number for pagination, default is 1", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "count", "in": "query", "description": "Number of players per page, default is 10", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "type", "in": "query", "description": "Relationship type: followers or following", "schema": { "enum": [ "following", "followers" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/FollowerType" } ], "oneOf": [ { "enum": [ 0, 1 ], "type": "integer" }, { "enum": [ "following", "followers" ], "type": "string" } ], "default": 1 } } ], "responses": { "200": { "description": "Returns list of players", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlayerFollower" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlayerFollower" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlayerFollower" } } } } }, "404": { "description": "Player not found" } } } }, "/player/{id}/foundedClan": { "get": { "tags": [ "Player" ], "summary": "Get info about the clan this player founded", "description": "Retrieves an information about the clan this player created and manage.", "operationId": "Player_GetFoundedClan", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the player", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns brief info about the clan", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClanBiggerResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClanBiggerResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClanBiggerResponse" } } } }, "404": { "description": "Player not found or player doesn't found any clans" } } } }, "/player/{id}/rankedMaps": { "get": { "tags": [ "Player" ], "summary": "Get ranked maps this player mapped", "description": "Retrieves a list of maps this player created that later became ranked and give PP now.", "operationId": "Player_GetRankedMaps", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the player", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "leaderboardContext", "in": "query", "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "schema": { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/LeaderboardContexts" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 ], "type": "integer" }, { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "default": 2, "example": 2046 } }, { "name": "sortBy", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns brief stats about maps this player ranked, like count, total PP gained, etc...", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RankedMapperResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RankedMapperResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RankedMapperResponse" } } } }, "404": { "description": "Player not found" } } } }, "/player/{id}/officialmaps": { "get": { "tags": [ "Player" ], "summary": "Get ranked maps this player mapped", "description": "Retrieves a list of maps this player created that later became ranked and give PP now.", "operationId": "Player_GetOfficialMaps", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the player", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "leaderboardContext", "in": "query", "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "schema": { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/LeaderboardContexts" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 ], "type": "integer" }, { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "default": 2, "example": 2046 } }, { "name": "sortBy", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns brief stats about maps this player ranked, like count, total PP gained, etc...", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RankedMapperResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RankedMapperResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RankedMapperResponse" } } } }, "404": { "description": "Player not found" } } } }, "/player/{id}/scores": { "get": { "tags": [ "PlayerScores" ], "summary": "Retrieve player's scores", "description": "Fetches a paginated list of scores for a specified player ID. Allows filtering by various criteria like date, difficulty, mode, and more.", "operationId": "PlayerScores_GetScores", "parameters": [ { "name": "id", "in": "path", "description": "Player's unique identifier", "required": true, "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Sorting criteria for scores, default is by 'pp'", "schema": { "enum": [ "date", "pp", "accPP", "passPP", "techPP", "acc", "pauses", "playCount", "lastTryTime", "rank", "maxStreak", "timing", "stars", "mistakes", "replaysWatched", "sotwNominations", "scoreValue" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ScoresSortBy" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ], "type": "integer" }, { "enum": [ "date", "pp", "accPP", "passPP", "techPP", "acc", "pauses", "playCount", "lastTryTime", "rank", "maxStreak", "timing", "stars", "mistakes", "replaysWatched", "sotwNominations", "scoreValue" ], "type": "string" } ], "default": 1 } }, { "name": "order", "in": "query", "description": "Order of sorting, default is descending", "schema": { "enum": [ "desc", "asc" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/Order" } ], "oneOf": [ { "enum": [ 0, 1 ], "type": "integer" }, { "enum": [ "desc", "asc" ], "type": "string" } ], "description": "Represents the order in which values will be sorted.", "default": 0 } }, { "name": "thenSortBy", "in": "query", "description": "Additional sorting criteria for scores tied by the first sort, default is by 'date'", "schema": { "enum": [ "date", "pp", "accPP", "passPP", "techPP", "acc", "pauses", "playCount", "lastTryTime", "rank", "maxStreak", "timing", "stars", "mistakes", "replaysWatched", "sotwNominations", "scoreValue" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ScoresSortBy" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ], "type": "integer" }, { "enum": [ "date", "pp", "accPP", "passPP", "techPP", "acc", "pauses", "playCount", "lastTryTime", "rank", "maxStreak", "timing", "stars", "mistakes", "replaysWatched", "sotwNominations", "scoreValue" ], "type": "string" } ], "default": 0 } }, { "name": "thenOrder", "in": "query", "description": "Order of additional sorting, default is descending", "schema": { "enum": [ "desc", "asc" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/Order" } ], "oneOf": [ { "enum": [ 0, 1 ], "type": "integer" }, { "enum": [ "desc", "asc" ], "type": "string" } ], "description": "Represents the order in which values will be sorted.", "default": 0 } }, { "name": "page", "in": "query", "description": "Page number for pagination, default is 1", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "count", "in": "query", "description": "Number of scores per page, default is 8", "schema": { "type": "integer", "format": "int32", "default": 8 } }, { "name": "search", "in": "query", "description": "Filter scores by search term in song name, author or mapper. Default is null", "schema": { "type": "string" } }, { "name": "noSearchSort", "in": "query", "description": "Disabled scores sort by search relevance index", "schema": { "type": "boolean", "default": false } }, { "name": "diff", "in": "query", "description": "Filter scores by map difficulty(Easy, Expert, Expert+, etc), default is null", "schema": { "type": "string" } }, { "name": "mode", "in": "query", "description": "Filter scores by map characteristic(Standard, OneSaber, etc), default is null", "schema": { "type": "string" } }, { "name": "requirements", "in": "query", "description": "Filter scores by map requirements, default is 'None'", "schema": { "enum": [ "none", "chroma", "noodles", "mappingExtensions", "cinema", "v3", "optionalProperties", "vNJS", "vivify", "v3Pepega", "groupLighting", "audioLink", "ignore" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/Requirements" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, -1 ], "type": "integer" }, { "enum": [ "none", "chroma", "noodles", "mappingExtensions", "cinema", "v3", "optionalProperties", "vNJS", "vivify", "v3Pepega", "groupLighting", "audioLink", "ignore" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "default": 0, "example": -1 } }, { "name": "scoreStatus", "in": "query", "description": "Filter scores by score status, default is 'None'", "schema": { "enum": [ "none", "suspicious" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ScoreFilterStatus" } ], "oneOf": [ { "enum": [ 0, 1 ], "type": "integer" }, { "enum": [ "none", "suspicious" ], "type": "string" } ], "default": 0 } }, { "name": "leaderboardContext", "in": "query", "description": "Filter scores by leaderboard context, default is 'General'", "schema": { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/LeaderboardContexts" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 ], "type": "integer" }, { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "default": 2, "example": 2046 } }, { "name": "type", "in": "query", "description": "Filter scores by map status, default is null", "schema": { "allOf": [ { "$ref": "#/components/schemas/DifficultyStatus" } ] } }, { "name": "hmd", "in": "query", "description": "Filter scores by headset, default is null", "schema": { "allOf": [ { "$ref": "#/components/schemas/HMD" } ] } }, { "name": "modifiers", "in": "query", "description": "Filter scores by modifiers(GN, SF, etc), default is null", "schema": { "type": "string" } }, { "name": "stars_from", "in": "query", "description": "Filter scores on ranked maps with stars greater than, default is null", "schema": { "type": "number", "format": "float" } }, { "name": "stars_to", "in": "query", "description": "Filter scores on ranked maps with stars lower than, default is null", "schema": { "type": "number", "format": "float" } }, { "name": "acc_from", "in": "query", "description": "Filter scores on score accuracy greater than, default is null", "schema": { "type": "number", "format": "float" } }, { "name": "acc_to", "in": "query", "description": "Filter scores on score accuracy lower than, default is null", "schema": { "type": "number", "format": "float" } }, { "name": "time_from", "in": "query", "description": "Filter scores made after unix timestamp, default is null", "schema": { "type": "integer", "format": "int32" } }, { "name": "time_to", "in": "query", "description": "Filter scores made before unix timestamp, default is null", "schema": { "type": "integer", "format": "int32" } }, { "name": "eventId", "in": "query", "description": "Show only scores from the event with ID, default is null", "schema": { "type": "integer", "format": "int32" } }, { "name": "includeIO", "in": "query", "description": "Include score improvement and offsets, default is false", "schema": { "type": "boolean", "default": false } }, { "name": "playlistIds", "in": "query", "description": "Playlits Ids to filter, default is null", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlaylistResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlaylistResponse" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlaylistResponse" } } } } }, "responses": { "200": { "description": "Scores retrieved successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScoreResponseWithMyScoreResponseWithMetadata" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScoreResponseWithMyScoreResponseWithMetadata" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScoreResponseWithMyScoreResponseWithMetadata" } } } }, "400": { "description": "Invalid request parameters" }, "404": { "description": "Scores not found for the given player ID" } } } }, "/player/{id}/scores/compact": { "post": { "tags": [ "PlayerScores" ], "summary": "Retrieve player's scores in a compact form", "description": "Fetches a paginated list of scores for a specified player ID. Returns less info to save bandwith or processing time", "operationId": "PlayerScores_GetCompactScores", "parameters": [ { "name": "id", "in": "path", "description": "Player's unique identifier", "required": true, "schema": { "type": "string" } }, { "name": "playlistIds", "in": "query", "description": "Playlits Ids to filter, default is null", "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Sorting criteria for scores, default is by 'date'", "schema": { "enum": [ "date", "pp", "accPP", "passPP", "techPP", "acc", "pauses", "playCount", "lastTryTime", "rank", "maxStreak", "timing", "stars", "mistakes", "replaysWatched", "sotwNominations", "scoreValue" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ScoresSortBy" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ], "type": "integer" }, { "enum": [ "date", "pp", "accPP", "passPP", "techPP", "acc", "pauses", "playCount", "lastTryTime", "rank", "maxStreak", "timing", "stars", "mistakes", "replaysWatched", "sotwNominations", "scoreValue" ], "type": "string" } ], "default": 0 } }, { "name": "order", "in": "query", "description": "Order of sorting, default is descending", "schema": { "enum": [ "desc", "asc" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/Order" } ], "oneOf": [ { "enum": [ 0, 1 ], "type": "integer" }, { "enum": [ "desc", "asc" ], "type": "string" } ], "description": "Represents the order in which values will be sorted.", "default": 0 } }, { "name": "thenSortBy", "in": "query", "description": "Additional sorting criteria for scores tied by the first sort", "schema": { "enum": [ "date", "pp", "accPP", "passPP", "techPP", "acc", "pauses", "playCount", "lastTryTime", "rank", "maxStreak", "timing", "stars", "mistakes", "replaysWatched", "sotwNominations", "scoreValue" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ScoresSortBy" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ], "type": "integer" }, { "enum": [ "date", "pp", "accPP", "passPP", "techPP", "acc", "pauses", "playCount", "lastTryTime", "rank", "maxStreak", "timing", "stars", "mistakes", "replaysWatched", "sotwNominations", "scoreValue" ], "type": "string" } ], "default": 0 } }, { "name": "thenOrder", "in": "query", "description": "Order of additional sorting, default is descending", "schema": { "enum": [ "desc", "asc" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/Order" } ], "oneOf": [ { "enum": [ 0, 1 ], "type": "integer" }, { "enum": [ "desc", "asc" ], "type": "string" } ], "description": "Represents the order in which values will be sorted.", "default": 0 } }, { "name": "page", "in": "query", "description": "Page number for pagination, default is 1", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "count", "in": "query", "description": "Number of scores per page, default is 8", "schema": { "type": "integer", "format": "int32", "default": 8 } }, { "name": "search", "in": "query", "description": "Filter scores by search term in song name, author or mapper. Default is null", "schema": { "type": "string" } }, { "name": "noSearchSort", "in": "query", "description": "Disabled scores sort by search relevance index", "schema": { "type": "boolean", "default": false } }, { "name": "diff", "in": "query", "description": "Filter scores by map difficulty(Easy, Expert, Expert+, etc), default is null", "schema": { "type": "string" } }, { "name": "mode", "in": "query", "description": "Filter scores by map characteristic(Standard, OneSaber, etc), default is null", "schema": { "type": "string" } }, { "name": "requirements", "in": "query", "description": "Filter scores by map requirements, default is 'None'", "schema": { "enum": [ "none", "chroma", "noodles", "mappingExtensions", "cinema", "v3", "optionalProperties", "vNJS", "vivify", "v3Pepega", "groupLighting", "audioLink", "ignore" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/Requirements" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, -1 ], "type": "integer" }, { "enum": [ "none", "chroma", "noodles", "mappingExtensions", "cinema", "v3", "optionalProperties", "vNJS", "vivify", "v3Pepega", "groupLighting", "audioLink", "ignore" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "default": 0, "example": -1 } }, { "name": "scoreStatus", "in": "query", "description": "Filter scores by score status, default is 'None'", "schema": { "enum": [ "none", "suspicious" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ScoreFilterStatus" } ], "oneOf": [ { "enum": [ 0, 1 ], "type": "integer" }, { "enum": [ "none", "suspicious" ], "type": "string" } ], "default": 0 } }, { "name": "leaderboardContext", "in": "query", "description": "Filter scores by leaderboard context, default is 'General'", "schema": { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/LeaderboardContexts" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 ], "type": "integer" }, { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "default": 2, "example": 2046 } }, { "name": "type", "in": "query", "description": "Filter scores by map status, default is null", "schema": { "allOf": [ { "$ref": "#/components/schemas/DifficultyStatus" } ] } }, { "name": "hmd", "in": "query", "description": "Filter scores by headset, default is null", "schema": { "allOf": [ { "$ref": "#/components/schemas/HMD" } ] } }, { "name": "modifiers", "in": "query", "description": "Filter scores by modifiers(GN, SF, etc), default is null", "schema": { "type": "string" } }, { "name": "stars_from", "in": "query", "description": "Filter scores on ranked maps with stars greater than, default is null", "schema": { "type": "number", "format": "float" } }, { "name": "stars_to", "in": "query", "description": "Filter scores on ranked maps with stars lower than, default is null", "schema": { "type": "number", "format": "float" } }, { "name": "acc_from", "in": "query", "description": "Filter scores on score accuracy greater than, default is null", "schema": { "type": "number", "format": "float" } }, { "name": "acc_to", "in": "query", "description": "Filter scores on score accuracy lower than, default is null", "schema": { "type": "number", "format": "float" } }, { "name": "time_from", "in": "query", "description": "Filter scores made after unix timestamp, default is null", "schema": { "type": "integer", "format": "int32" } }, { "name": "time_to", "in": "query", "description": "Filter scores made before unix timestamp, default is null", "schema": { "type": "integer", "format": "int32" } }, { "name": "eventId", "in": "query", "description": "Show only scores from the event with ID, default is null", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlaylistResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlaylistResponse" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlaylistResponse" } } } } }, "responses": { "200": { "description": "Scores retrieved successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CompactScoreResponseResponseWithMetadata" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CompactScoreResponseResponseWithMetadata" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompactScoreResponseResponseWithMetadata" } } } }, "400": { "description": "Invalid request parameters" }, "404": { "description": "Scores not found for the given player ID" } } }, "get": { "tags": [ "PlayerScores" ], "summary": "Retrieve player's scores in a compact form", "description": "Fetches a paginated list of scores for a specified player ID. Returns less info to save bandwith or processing time", "operationId": "PlayerScores_GetCompactScores", "parameters": [ { "name": "id", "in": "path", "description": "Player's unique identifier", "required": true, "schema": { "type": "string" } }, { "name": "playlistIds", "in": "query", "description": "Playlits Ids to filter, default is null", "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Sorting criteria for scores, default is by 'date'", "schema": { "enum": [ "date", "pp", "accPP", "passPP", "techPP", "acc", "pauses", "playCount", "lastTryTime", "rank", "maxStreak", "timing", "stars", "mistakes", "replaysWatched", "sotwNominations", "scoreValue" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ScoresSortBy" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ], "type": "integer" }, { "enum": [ "date", "pp", "accPP", "passPP", "techPP", "acc", "pauses", "playCount", "lastTryTime", "rank", "maxStreak", "timing", "stars", "mistakes", "replaysWatched", "sotwNominations", "scoreValue" ], "type": "string" } ], "default": 0 } }, { "name": "order", "in": "query", "description": "Order of sorting, default is descending", "schema": { "enum": [ "desc", "asc" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/Order" } ], "oneOf": [ { "enum": [ 0, 1 ], "type": "integer" }, { "enum": [ "desc", "asc" ], "type": "string" } ], "description": "Represents the order in which values will be sorted.", "default": 0 } }, { "name": "thenSortBy", "in": "query", "description": "Additional sorting criteria for scores tied by the first sort", "schema": { "enum": [ "date", "pp", "accPP", "passPP", "techPP", "acc", "pauses", "playCount", "lastTryTime", "rank", "maxStreak", "timing", "stars", "mistakes", "replaysWatched", "sotwNominations", "scoreValue" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ScoresSortBy" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ], "type": "integer" }, { "enum": [ "date", "pp", "accPP", "passPP", "techPP", "acc", "pauses", "playCount", "lastTryTime", "rank", "maxStreak", "timing", "stars", "mistakes", "replaysWatched", "sotwNominations", "scoreValue" ], "type": "string" } ], "default": 0 } }, { "name": "thenOrder", "in": "query", "description": "Order of additional sorting, default is descending", "schema": { "enum": [ "desc", "asc" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/Order" } ], "oneOf": [ { "enum": [ 0, 1 ], "type": "integer" }, { "enum": [ "desc", "asc" ], "type": "string" } ], "description": "Represents the order in which values will be sorted.", "default": 0 } }, { "name": "page", "in": "query", "description": "Page number for pagination, default is 1", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "count", "in": "query", "description": "Number of scores per page, default is 8", "schema": { "type": "integer", "format": "int32", "default": 8 } }, { "name": "search", "in": "query", "description": "Filter scores by search term in song name, author or mapper. Default is null", "schema": { "type": "string" } }, { "name": "noSearchSort", "in": "query", "description": "Disabled scores sort by search relevance index", "schema": { "type": "boolean", "default": false } }, { "name": "diff", "in": "query", "description": "Filter scores by map difficulty(Easy, Expert, Expert+, etc), default is null", "schema": { "type": "string" } }, { "name": "mode", "in": "query", "description": "Filter scores by map characteristic(Standard, OneSaber, etc), default is null", "schema": { "type": "string" } }, { "name": "requirements", "in": "query", "description": "Filter scores by map requirements, default is 'None'", "schema": { "enum": [ "none", "chroma", "noodles", "mappingExtensions", "cinema", "v3", "optionalProperties", "vNJS", "vivify", "v3Pepega", "groupLighting", "audioLink", "ignore" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/Requirements" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, -1 ], "type": "integer" }, { "enum": [ "none", "chroma", "noodles", "mappingExtensions", "cinema", "v3", "optionalProperties", "vNJS", "vivify", "v3Pepega", "groupLighting", "audioLink", "ignore" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "default": 0, "example": -1 } }, { "name": "scoreStatus", "in": "query", "description": "Filter scores by score status, default is 'None'", "schema": { "enum": [ "none", "suspicious" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ScoreFilterStatus" } ], "oneOf": [ { "enum": [ 0, 1 ], "type": "integer" }, { "enum": [ "none", "suspicious" ], "type": "string" } ], "default": 0 } }, { "name": "leaderboardContext", "in": "query", "description": "Filter scores by leaderboard context, default is 'General'", "schema": { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/LeaderboardContexts" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 ], "type": "integer" }, { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "default": 2, "example": 2046 } }, { "name": "type", "in": "query", "description": "Filter scores by map status, default is null", "schema": { "allOf": [ { "$ref": "#/components/schemas/DifficultyStatus" } ] } }, { "name": "hmd", "in": "query", "description": "Filter scores by headset, default is null", "schema": { "allOf": [ { "$ref": "#/components/schemas/HMD" } ] } }, { "name": "modifiers", "in": "query", "description": "Filter scores by modifiers(GN, SF, etc), default is null", "schema": { "type": "string" } }, { "name": "stars_from", "in": "query", "description": "Filter scores on ranked maps with stars greater than, default is null", "schema": { "type": "number", "format": "float" } }, { "name": "stars_to", "in": "query", "description": "Filter scores on ranked maps with stars lower than, default is null", "schema": { "type": "number", "format": "float" } }, { "name": "acc_from", "in": "query", "description": "Filter scores on score accuracy greater than, default is null", "schema": { "type": "number", "format": "float" } }, { "name": "acc_to", "in": "query", "description": "Filter scores on score accuracy lower than, default is null", "schema": { "type": "number", "format": "float" } }, { "name": "time_from", "in": "query", "description": "Filter scores made after unix timestamp, default is null", "schema": { "type": "integer", "format": "int32" } }, { "name": "time_to", "in": "query", "description": "Filter scores made before unix timestamp, default is null", "schema": { "type": "integer", "format": "int32" } }, { "name": "eventId", "in": "query", "description": "Show only scores from the event with ID, default is null", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlaylistResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlaylistResponse" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlaylistResponse" } } } } }, "responses": { "200": { "description": "Scores retrieved successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CompactScoreResponseResponseWithMetadata" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CompactScoreResponseResponseWithMetadata" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompactScoreResponseResponseWithMetadata" } } } }, "400": { "description": "Invalid request parameters" }, "404": { "description": "Scores not found for the given player ID" } } } }, "/player/{id}/accgraph": { "get": { "tags": [ "PlayerScores" ], "summary": "Retrieve player's accuracy graph", "description": "Usefull to visualise player's performance relative to map's complexity", "operationId": "PlayerScores_AccGraph", "parameters": [ { "name": "id", "in": "path", "description": "Player's unique identifier", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Type of the graph: acc, rank, weight or pp", "schema": { "type": "string", "default": "acc" } }, { "name": "leaderboardContext", "in": "query", "description": "Filter scores by leaderboard context, default is 'General'", "schema": { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/LeaderboardContexts" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 ], "type": "integer" }, { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "default": 2, "example": 2046 } }, { "name": "no_unranked_stars", "in": "query", "description": "Exclude unranked scores", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Accuracy graph retrieved successfully" }, "400": { "description": "Invalid request parameters" }, "404": { "description": "No accuracy graph available for the given player ID" } } } }, "/player/{id}/history": { "get": { "tags": [ "PlayerScores" ], "summary": "Retrieve player's statistic history", "description": "Fetches a list of player's performance metrics and various stats saved daily", "operationId": "PlayerScores_GetHistory", "parameters": [ { "name": "id", "in": "path", "description": "Player's unique identifier", "required": true, "schema": { "type": "string" } }, { "name": "leaderboardContext", "in": "query", "description": "Filter scores by leaderboard context, default is 'General'", "schema": { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/LeaderboardContexts" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 ], "type": "integer" }, { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "default": 2, "example": 2046 } }, { "name": "count", "in": "query", "description": "Amount of days to include", "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "History retrieved successfully", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlayerScoreStatsHistory" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlayerScoreStatsHistory" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlayerScoreStatsHistory" } } } } }, "400": { "description": "Invalid request parameters" }, "404": { "description": "No history saved for the given player ID" } } } }, "/player/{id}/history/compact": { "get": { "tags": [ "PlayerScores" ], "summary": "Retrieve player's statistic history in a compact form", "description": "Fetches a list of player's performance metrics subset. Use the main history endpoint for a full.", "operationId": "PlayerScores_GetCompactHistory", "parameters": [ { "name": "id", "in": "path", "description": "Player's unique identifier", "required": true, "schema": { "type": "string" } }, { "name": "leaderboardContext", "in": "query", "description": "Filter scores by leaderboard context, default is 'General'", "schema": { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/LeaderboardContexts" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 ], "type": "integer" }, { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "default": 2, "example": 2046 } }, { "name": "count", "in": "query", "description": "Amount of days to include", "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "History retrieved successfully", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryCompactResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryCompactResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryCompactResponse" } } } } }, "400": { "description": "Invalid request parameters" }, "404": { "description": "No history saved for the given player ID" } } } }, "/player/{id}/history/triangle": { "get": { "tags": [ "PlayerScores" ], "summary": "Retrieve player's triangle history in a compact form", "description": "Fetches a list of player's performance metrics subset. Use the main history endpoint for a full.", "operationId": "PlayerScores_GetTriangleHistory", "parameters": [ { "name": "id", "in": "path", "description": "Player's unique identifier", "required": true, "schema": { "type": "string" } }, { "name": "leaderboardContext", "in": "query", "description": "Filter scores by leaderboard context, default is 'General'", "schema": { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/LeaderboardContexts" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 ], "type": "integer" }, { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "default": 2, "example": 2046 } } ], "responses": { "200": { "description": "History retrieved successfully", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryTriangleResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryTriangleResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryTriangleResponse" } } } } }, "400": { "description": "Invalid request parameters" }, "404": { "description": "No history saved for the given player ID" } } } }, "/maps": { "get": { "tags": [ "Song" ], "summary": "Retrieve a list of maps", "description": "Fetches a paginated and optionally filtered list of Beat Saber maps.", "operationId": "Song_GetAll", "parameters": [ { "name": "page", "in": "query", "description": "Page number for pagination, default is 1", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "count", "in": "query", "description": "Number of leaderboards per page, default is 10", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "sortBy", "in": "query", "description": "Field to sort leaderboards by, default is None", "schema": { "enum": [ "none", "timestamp", "name", "stars", "passRating", "accRating", "techRating", "scoreTime", "playCount", "voting", "voteCount", "voteRatio", "duration", "attempts", "nJS", "nPS", "bPM", "multiRating", "eBPM", "linearPercentage" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/MapSortBy" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19 ], "type": "integer" }, { "enum": [ "none", "timestamp", "name", "stars", "passRating", "accRating", "techRating", "scoreTime", "playCount", "voting", "voteCount", "voteRatio", "duration", "attempts", "nJS", "nPS", "bPM", "multiRating", "eBPM", "linearPercentage" ], "type": "string" } ], "default": 0 } }, { "name": "order", "in": "query", "description": "Order of sorting, default is Desc", "schema": { "enum": [ "desc", "asc" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/Order" } ], "oneOf": [ { "enum": [ 0, 1 ], "type": "integer" }, { "enum": [ "desc", "asc" ], "type": "string" } ], "description": "Represents the order in which values will be sorted.", "default": 0 } }, { "name": "thenSortBy", "in": "query", "description": "Secondary sorting criteria for maps with the same value for the first sorting", "schema": { "enum": [ "none", "timestamp", "name", "stars", "passRating", "accRating", "techRating", "scoreTime", "playCount", "voting", "voteCount", "voteRatio", "duration", "attempts", "nJS", "nPS", "bPM", "multiRating", "eBPM", "linearPercentage" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/MapSortBy" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19 ], "type": "integer" }, { "enum": [ "none", "timestamp", "name", "stars", "passRating", "accRating", "techRating", "scoreTime", "playCount", "voting", "voteCount", "voteRatio", "duration", "attempts", "nJS", "nPS", "bPM", "multiRating", "eBPM", "linearPercentage" ], "type": "string" } ], "default": 1 } }, { "name": "thenOrder", "in": "query", "description": "Secondary order of sorting for maps with the same value for the first sorting", "schema": { "enum": [ "desc", "asc" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/Order" } ], "oneOf": [ { "enum": [ 0, 1 ], "type": "integer" }, { "enum": [ "desc", "asc" ], "type": "string" } ], "description": "Represents the order in which values will be sorted.", "default": 0 } }, { "name": "search", "in": "query", "description": "Search term to filter leaderboards by song, author or mapper name", "schema": { "type": "string" } }, { "name": "noSearchSort", "in": "query", "description": "Disabled maps sort by search relevance index", "schema": { "type": "boolean", "default": false } }, { "name": "type", "in": "query", "description": "Type of leaderboards to filter, default is All", "schema": { "enum": [ "all", "ranked", "ranking", "nominated", "qualified", "staff", "reweighting", "reweighted", "unranked", "ost" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/Type" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "type": "integer" }, { "enum": [ "all", "ranked", "ranking", "nominated", "qualified", "staff", "reweighting", "reweighted", "unranked", "ost" ], "type": "string" } ], "default": 0 } }, { "name": "mode", "in": "query", "description": "Mode to filter leaderboards by (Standard, OneSaber, etc...)", "schema": { "type": "string" } }, { "name": "difficulty", "in": "query", "description": "Difficulty to filter leaderboards by (Easy, Normal, Hard, Expert, ExpertPlus)", "schema": { "type": "string" } }, { "name": "mapType", "in": "query", "description": "Map type to filter leaderboards by", "schema": { "enum": [ "none", "acc", "tech", "midspeed", "speed", "fitbeat", "linear", "bombReset" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/MapTypes" } ], "oneOf": [ { "enum": [ 0, 1, 2, 4, 8, 16, 32, 64 ], "type": "integer" }, { "enum": [ "none", "acc", "tech", "midspeed", "speed", "fitbeat", "linear", "bombReset" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "default": 0, "example": 127 } }, { "name": "allTypes", "in": "query", "description": "Operation to filter all types, default is Any", "schema": { "enum": [ "any", "all", "not" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/Operation" } ], "oneOf": [ { "enum": [ 0, 1, 2 ], "type": "integer" }, { "enum": [ "any", "all", "not" ], "type": "string" } ], "default": 0 } }, { "name": "mapRequirements", "in": "query", "description": "Requirements to filter leaderboards by, default is Ignore", "schema": { "enum": [ "none", "chroma", "noodles", "mappingExtensions", "cinema", "v3", "optionalProperties", "vNJS", "vivify", "v3Pepega", "groupLighting", "audioLink", "ignore" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/Requirements" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, -1 ], "type": "integer" }, { "enum": [ "none", "chroma", "noodles", "mappingExtensions", "cinema", "v3", "optionalProperties", "vNJS", "vivify", "v3Pepega", "groupLighting", "audioLink", "ignore" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "default": -1, "example": -1 } }, { "name": "allRequirements", "in": "query", "description": "Operation to filter all requirements, default is Any", "schema": { "enum": [ "any", "all", "not" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/Operation" } ], "oneOf": [ { "enum": [ 0, 1, 2 ], "type": "integer" }, { "enum": [ "any", "all", "not" ], "type": "string" } ], "default": 0 } }, { "name": "songStatus", "in": "query", "description": "Song status to filter leaderboards by, default is None", "schema": { "enum": [ "none", "curated", "mapOfTheWeek", "noodleMonday", "featuredOnCC", "beastSaberAwarded", "buildingBlocksAwarded" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/SongStatus" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64 ], "type": "integer" }, { "enum": [ "none", "curated", "mapOfTheWeek", "noodleMonday", "featuredOnCC", "beastSaberAwarded", "buildingBlocksAwarded" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "default": 0, "example": 126 } }, { "name": "leaderboardContext", "in": "query", "description": "Context of the leaderboard, default is General", "schema": { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/LeaderboardContexts" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 ], "type": "integer" }, { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "default": 2, "example": 2046 } }, { "name": "mapCreator", "in": "query", "description": "Map creator, human by default", "schema": { "enum": [ "human", "genericBot", "beatSage", "topMapper" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/SongCreator" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3 ], "type": "integer" }, { "enum": [ "human", "genericBot", "beatSage", "topMapper" ], "type": "string" } ], "default": 0 } }, { "name": "mytype", "in": "query", "description": "My type to filter leaderboards by, default is None", "schema": { "enum": [ "none", "played", "unplayed", "friendsPlayed" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/MyTypeMaps" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3 ], "type": "integer" }, { "enum": [ "none", "played", "unplayed", "friendsPlayed" ], "type": "string" } ], "default": 0 } }, { "name": "stars_from", "in": "query", "description": "Minimum stars to filter leaderboards by", "schema": { "type": "number", "format": "float" } }, { "name": "stars_to", "in": "query", "description": "Maximum stars to filter leaderboards by", "schema": { "type": "number", "format": "float" } }, { "name": "accrating_from", "in": "query", "description": "Minimum accuracy rating to filter leaderboards by", "schema": { "type": "number", "format": "float" } }, { "name": "accrating_to", "in": "query", "description": "Maximum accuracy rating to filter leaderboards by", "schema": { "type": "number", "format": "float" } }, { "name": "passrating_from", "in": "query", "description": "Minimum pass rating to filter leaderboards by", "schema": { "type": "number", "format": "float" } }, { "name": "passrating_to", "in": "query", "description": "Maximum pass rating to filter leaderboards by", "schema": { "type": "number", "format": "float" } }, { "name": "techrating_from", "in": "query", "description": "Minimum tech rating to filter leaderboards by", "schema": { "type": "number", "format": "float" } }, { "name": "techrating_to", "in": "query", "description": "Maximum tech rating to filter leaderboards by", "schema": { "type": "number", "format": "float" } }, { "name": "duration_from", "in": "query", "description": "Minimum duration to filter leaderboards by in seconds", "schema": { "type": "number", "format": "float" } }, { "name": "duration_to", "in": "query", "description": "Maximum duration to filter leaderboards by in seconds", "schema": { "type": "number", "format": "float" } }, { "name": "date_from", "in": "query", "description": "Start date to filter leaderboards by (timestamp)", "schema": { "type": "integer", "format": "int32" } }, { "name": "date_to", "in": "query", "description": "End date to filter leaderboards by (timestamp)", "schema": { "type": "integer", "format": "int32" } }, { "name": "date_range", "in": "query", "description": "Type of the date filter, default by map upload date", "schema": { "enum": [ "upload", "ranked", "score" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/DateRangeType" } ], "oneOf": [ { "enum": [ 0, 1, 2 ], "type": "integer" }, { "enum": [ "upload", "ranked", "score" ], "type": "string" } ], "default": 0 } }, { "name": "types", "in": "query", "description": "Types of leaderboards to filter, default is null(All). Same as type but multiple", "schema": { "type": "string" } }, { "name": "playlistIds", "in": "query", "description": "Types of leaderboards to filter, default is null(All). Same as type but multiple", "schema": { "type": "string" } }, { "name": "mappers", "in": "query", "description": "Filter maps from a specific mappers. BeatSaver profile ID list, comma separated, default is null", "schema": { "type": "string" } }, { "name": "overrideCurrentId", "in": "query", "description": "Override current user ID", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlaylistResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlaylistResponse" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlaylistResponse" } } } } }, "responses": { "200": { "description": "Maps retrieved successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MapInfoResponseResponseWithMetadata" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MapInfoResponseResponseWithMetadata" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MapInfoResponseResponseWithMetadata" } } } }, "404": { "description": "Maps not found" } } } }, "/maps/trending/beatsaver": { "get": { "tags": [ "Song" ], "summary": "Retrieve a list of maps", "description": "Fetches a paginated and optionally filtered list of Beat Saber maps.", "operationId": "Song_GetBeatSaverTrending", "parameters": [ { "name": "leaderboardContext", "in": "query", "description": "Context of the leaderboard, default is General", "schema": { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/LeaderboardContexts" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 ], "type": "integer" }, { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "default": 2, "example": 2046 } } ], "responses": { "200": { "description": "Maps retrieved successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MapInfoResponseWithUpvotesResponseWithMetadata" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MapInfoResponseWithUpvotesResponseWithMetadata" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MapInfoResponseWithUpvotesResponseWithMetadata" } } } }, "404": { "description": "Maps not found" } } } }, "/work/statuses": { "get": { "tags": [ "WorkManagement" ], "summary": "Get all task statuses", "description": "Retrieves all available task statuses", "operationId": "WorkManagement_GetStatuses", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkTaskStatusResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkTaskStatusResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkTaskStatusResponse" } } } } } } } }, "/work/status": { "post": { "tags": [ "WorkManagement" ], "summary": "Create a new status", "description": "Creates a new task status (admin only)", "operationId": "WorkManagement_CreateStatus", "parameters": [ { "name": "title", "in": "query", "schema": { "type": "string" } }, { "name": "description", "in": "query", "schema": { "type": "string" } }, { "name": "icon", "in": "query", "schema": { "type": "string" } }, { "name": "color", "in": "query", "schema": { "type": "string" } }, { "name": "order", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "isClosedStatus", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "isDefault", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WorkTaskStatusResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkTaskStatusResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkTaskStatusResponse" } } } } } } }, "/work/status/{id}": { "put": { "tags": [ "WorkManagement" ], "summary": "Update a status", "description": "Updates an existing task status (admin only)", "operationId": "WorkManagement_UpdateStatus", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "title", "in": "query", "schema": { "type": "string" } }, { "name": "description", "in": "query", "schema": { "type": "string" } }, { "name": "icon", "in": "query", "schema": { "type": "string" } }, { "name": "color", "in": "query", "schema": { "type": "string" } }, { "name": "order", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "isClosedStatus", "in": "query", "schema": { "type": "boolean" } }, { "name": "isDefault", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WorkTaskStatusResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkTaskStatusResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkTaskStatusResponse" } } } } } }, "delete": { "tags": [ "WorkManagement" ], "summary": "Delete a status", "description": "Deletes a task status (admin only)", "operationId": "WorkManagement_DeleteStatus", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/work/tags": { "get": { "tags": [ "WorkManagement" ], "summary": "Get all tags", "description": "Retrieves all available task tags", "operationId": "WorkManagement_GetTags", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkTaskTagResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkTaskTagResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkTaskTagResponse" } } } } } } } }, "/work/tag": { "post": { "tags": [ "WorkManagement" ], "summary": "Create a new tag", "description": "Creates a new task tag (admin only)", "operationId": "WorkManagement_CreateTag", "parameters": [ { "name": "title", "in": "query", "schema": { "type": "string" } }, { "name": "description", "in": "query", "schema": { "type": "string" } }, { "name": "icon", "in": "query", "schema": { "type": "string" } }, { "name": "link", "in": "query", "schema": { "type": "string" } }, { "name": "color", "in": "query", "schema": { "type": "string" } }, { "name": "adminOnly", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WorkTaskTagResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkTaskTagResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkTaskTagResponse" } } } } } } }, "/work/tag/{id}": { "put": { "tags": [ "WorkManagement" ], "summary": "Update a tag", "description": "Updates an existing task tag (admin only)", "operationId": "WorkManagement_UpdateTag", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "title", "in": "query", "schema": { "type": "string" } }, { "name": "description", "in": "query", "schema": { "type": "string" } }, { "name": "icon", "in": "query", "schema": { "type": "string" } }, { "name": "link", "in": "query", "schema": { "type": "string" } }, { "name": "color", "in": "query", "schema": { "type": "string" } }, { "name": "adminOnly", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WorkTaskTagResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkTaskTagResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkTaskTagResponse" } } } } } }, "delete": { "tags": [ "WorkManagement" ], "summary": "Delete a tag", "description": "Deletes a task tag (admin only)", "operationId": "WorkManagement_DeleteTag", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/work/tasks": { "get": { "tags": [ "WorkManagement" ], "summary": "Get list of tasks", "description": "Retrieves a paginated list of work tasks with filtering options", "operationId": "WorkManagement_GetTasks", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "count", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "type", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/WorkTaskType" } ] } }, { "name": "statusId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "tagId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "assigneeId", "in": "query", "schema": { "type": "string" } }, { "name": "creatorId", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "includeArchived", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "sortBy", "in": "query", "schema": { "type": "string", "default": "createdAt" } }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WorkTaskListResponseResponseWithMetadata" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkTaskListResponseResponseWithMetadata" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkTaskListResponseResponseWithMetadata" } } } } } } }, "/work/task/{id}": { "get": { "tags": [ "WorkManagement" ], "summary": "Get task details", "description": "Retrieves full details of a specific task", "operationId": "WorkManagement_GetTask", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WorkTaskDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkTaskDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkTaskDetailResponse" } } } } } }, "put": { "tags": [ "WorkManagement" ], "summary": "Update a task", "description": "Updates an existing task (creator or admin only)", "operationId": "WorkManagement_UpdateTask", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "title", "in": "query", "schema": { "type": "string" } }, { "name": "description", "in": "query", "schema": { "type": "string" } }, { "name": "statusId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "priority", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "isPublic", "in": "query", "schema": { "type": "boolean" } }, { "name": "isArchived", "in": "query", "schema": { "type": "boolean" } }, { "name": "isLocked", "in": "query", "schema": { "type": "boolean" } }, { "name": "dueDate", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WorkTaskDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkTaskDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkTaskDetailResponse" } } } } } }, "delete": { "tags": [ "WorkManagement" ], "summary": "Delete a task", "description": "Deletes a task (admin only)", "operationId": "WorkManagement_DeleteTask", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/work/task": { "post": { "tags": [ "WorkManagement" ], "summary": "Create a generic task", "description": "Creates a new generic work task", "operationId": "WorkManagement_CreateTask", "parameters": [ { "name": "title", "in": "query", "schema": { "type": "string" } }, { "name": "description", "in": "query", "schema": { "type": "string" } }, { "name": "statusId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "priority", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 3 } }, { "name": "isPublic", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WorkTaskDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkTaskDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkTaskDetailResponse" } } } } } } }, "/work/bugreport": { "post": { "tags": [ "WorkManagement" ], "summary": "Create a bug report", "description": "Creates a new bug report task", "operationId": "WorkManagement_CreateBugReport", "parameters": [ { "name": "title", "in": "query", "schema": { "type": "string" } }, { "name": "description", "in": "query", "schema": { "type": "string" } }, { "name": "severity", "in": "query", "description": "Severity level for bug reports", "schema": { "enum": [ "low", "medium", "high", "critical" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/BugSeverity" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3 ], "type": "integer" }, { "enum": [ "low", "medium", "high", "critical" ], "type": "string" } ], "description": "Severity level for bug reports", "default": 1 } }, { "name": "stepsToReproduce", "in": "query", "schema": { "type": "string" } }, { "name": "expectedBehavior", "in": "query", "schema": { "type": "string" } }, { "name": "actualBehavior", "in": "query", "schema": { "type": "string" } }, { "name": "version", "in": "query", "schema": { "type": "string" } }, { "name": "platform", "in": "query", "schema": { "type": "string" } }, { "name": "isReproducible", "in": "query", "schema": { "type": "boolean" } }, { "name": "statusId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "priority", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 3 } }, { "name": "isPublic", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BugReportResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BugReportResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BugReportResponse" } } } } } } }, "/work/suggestion": { "post": { "tags": [ "WorkManagement" ], "summary": "Create a suggestion", "description": "Creates a new suggestion/feature request", "operationId": "WorkManagement_CreateSuggestion", "parameters": [ { "name": "title", "in": "query", "schema": { "type": "string" } }, { "name": "description", "in": "query", "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Category of suggestion", "schema": { "enum": [ "feature", "improvement", "uX", "performance", "accessibility", "other" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/SuggestionCategory" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, { "enum": [ "feature", "improvement", "uX", "performance", "accessibility", "other" ], "type": "string" } ], "description": "Category of suggestion", "default": 0 } }, { "name": "useCase", "in": "query", "schema": { "type": "string" } }, { "name": "proposedSolution", "in": "query", "schema": { "type": "string" } }, { "name": "alternatives", "in": "query", "schema": { "type": "string" } }, { "name": "impact", "in": "query", "schema": { "type": "string" } }, { "name": "targetArea", "in": "query", "schema": { "type": "string" } }, { "name": "statusId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "priority", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 3 } }, { "name": "isPublic", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SuggestionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SuggestionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SuggestionResponse" } } } } } } }, "/work/helprequest": { "post": { "tags": [ "WorkManagement" ], "summary": "Create a help request", "description": "Creates a new help request", "operationId": "WorkManagement_CreateHelpRequest", "parameters": [ { "name": "title", "in": "query", "schema": { "type": "string" } }, { "name": "description", "in": "query", "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Category of help request", "schema": { "enum": [ "installation", "configuration", "usage", "account", "technical", "other" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/HelpCategory" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, { "enum": [ "installation", "configuration", "usage", "account", "technical", "other" ], "type": "string" } ], "description": "Category of help request", "default": 5 } }, { "name": "urgency", "in": "query", "description": "Urgency level for help requests", "schema": { "enum": [ "low", "normal", "high", "urgent" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/HelpUrgency" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3 ], "type": "integer" }, { "enum": [ "low", "normal", "high", "urgent" ], "type": "string" } ], "description": "Urgency level for help requests", "default": 1 } }, { "name": "alreadyTried", "in": "query", "schema": { "type": "string" } }, { "name": "errorMessage", "in": "query", "schema": { "type": "string" } }, { "name": "version", "in": "query", "schema": { "type": "string" } }, { "name": "platform", "in": "query", "schema": { "type": "string" } }, { "name": "statusId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "priority", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 3 } }, { "name": "isPublic", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/HelpRequestResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HelpRequestResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HelpRequestResponse" } } } } } } }, "/work/task/{id}/vote": { "post": { "tags": [ "WorkManagement" ], "summary": "Vote on a task", "description": "Upvote (+1) or downvote (-1) a task", "operationId": "WorkManagement_VoteOnTask", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "value", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/work/task/{taskId}/vote/{playerId}": { "delete": { "tags": [ "WorkManagement" ], "summary": "Remove a vote (admin)", "description": "Removes a player's vote from a task (admin only)", "operationId": "WorkManagement_RemoveVote", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "playerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "reason", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/work/task/{id}/comments": { "get": { "tags": [ "WorkManagement" ], "summary": "Get task comments", "description": "Retrieves paginated comments for a task", "operationId": "WorkManagement_GetComments", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "count", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "parentId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "sortBy", "in": "query", "schema": { "type": "string", "default": "createdAt" } }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "asc" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WorkTaskCommentResponseResponseWithMetadata" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkTaskCommentResponseResponseWithMetadata" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkTaskCommentResponseResponseWithMetadata" } } } } } } }, "/work/task/{id}/comment": { "post": { "tags": [ "WorkManagement" ], "summary": "Add a comment", "description": "Adds a comment to a task", "operationId": "WorkManagement_AddComment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "content", "in": "query", "schema": { "type": "string" } }, { "name": "parentCommentId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WorkTaskCommentResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkTaskCommentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkTaskCommentResponse" } } } } } } }, "/work/comment/{id}": { "put": { "tags": [ "WorkManagement" ], "summary": "Edit a comment", "description": "Edits a comment (author or admin only)", "operationId": "WorkManagement_EditComment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "content", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WorkTaskCommentResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkTaskCommentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkTaskCommentResponse" } } } } } }, "delete": { "tags": [ "WorkManagement" ], "summary": "Delete a comment", "description": "Deletes a comment (author or admin only)", "operationId": "WorkManagement_DeleteComment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/work/comment/{id}/vote": { "post": { "tags": [ "WorkManagement" ], "summary": "Vote on a comment", "description": "Upvote (+1) or downvote (-1) a comment", "operationId": "WorkManagement_VoteOnComment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "value", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/work/task/{taskId}/tag/{tagId}": { "post": { "tags": [ "WorkManagement" ], "summary": "Add tag to task", "description": "Adds a tag to a task", "operationId": "WorkManagement_AddTagToTask", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "tagId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "WorkManagement" ], "summary": "Remove tag from task", "description": "Removes a tag from a task", "operationId": "WorkManagement_RemoveTagFromTask", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "tagId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/work/task/{taskId}/assign/{playerId}": { "post": { "tags": [ "WorkManagement" ], "summary": "Assign player to task", "description": "Assigns a player to work on a task (admin only)", "operationId": "WorkManagement_AssignPlayer", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "playerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "role", "in": "query", "schema": { "type": "string" } }, { "name": "isPrimary", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "WorkManagement" ], "summary": "Remove player assignment", "description": "Removes a player from a task (admin only)", "operationId": "WorkManagement_RemoveAssignment", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "playerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/work/my-assignments": { "get": { "tags": [ "WorkManagement" ], "summary": "Get my assignments", "description": "Gets all tasks assigned to the current user", "operationId": "WorkManagement_GetMyAssignments", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "count", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "includeCompleted", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WorkTaskListResponseResponseWithMetadata" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkTaskListResponseResponseWithMetadata" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkTaskListResponseResponseWithMetadata" } } } } } } }, "/work/task/{id}/history": { "get": { "tags": [ "WorkManagement" ], "summary": "Get task history", "description": "Retrieves the change history for a task", "operationId": "WorkManagement_GetHistory", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "count", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WorkTaskHistoryResponseResponseWithMetadata" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkTaskHistoryResponseResponseWithMetadata" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkTaskHistoryResponseResponseWithMetadata" } } } } } } }, "/work/task/{id}/attachment": { "post": { "tags": [ "WorkManagement" ], "summary": "Upload attachment", "description": "Uploads a file attachment to a task", "operationId": "WorkManagement_UploadAttachment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fileName", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WorkTaskAttachmentResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkTaskAttachmentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkTaskAttachmentResponse" } } } } } } }, "/work/attachment/{id}": { "delete": { "tags": [ "WorkManagement" ], "summary": "Delete attachment", "description": "Deletes an attachment (creator or admin only)", "operationId": "WorkManagement_DeleteAttachment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "Achievement": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "playerId": { "type": "string" }, "achievementDescriptionId": { "type": "integer", "format": "int32" }, "achievementDescription": { "allOf": [ { "$ref": "#/components/schemas/AchievementDescription" } ] }, "levelId": { "type": "integer", "format": "int32", "nullable": true }, "level": { "allOf": [ { "$ref": "#/components/schemas/AchievementLevel" } ], "nullable": true }, "additionalLevels": { "type": "string", "nullable": true }, "timeset": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AchievementDescription": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string" }, "link": { "type": "string", "nullable": true }, "levels": { "type": "array", "items": { "$ref": "#/components/schemas/AchievementLevel" }, "nullable": true } }, "additionalProperties": false }, "AchievementLevel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "image": { "type": "string" }, "smallImage": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "detailedDescription": { "type": "string", "nullable": true }, "color": { "type": "string", "nullable": true }, "value": { "type": "number", "format": "float", "nullable": true }, "level": { "type": "integer", "format": "int32" }, "achievementDescriptionId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AttemptResponseWithMyScore": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "baseScore": { "type": "integer", "format": "int32" }, "modifiedScore": { "type": "integer", "format": "int32" }, "accuracy": { "type": "number", "format": "float" }, "playerId": { "type": "string" }, "pp": { "type": "number", "format": "float" }, "withPp": { "type": "boolean" }, "bonusPp": { "type": "number", "format": "float" }, "passPP": { "type": "number", "format": "float" }, "accPP": { "type": "number", "format": "float" }, "techPP": { "type": "number", "format": "float" }, "rank": { "type": "integer", "format": "int32" }, "responseRank": { "type": "integer", "format": "int32" }, "country": { "type": "string", "nullable": true }, "fcAccuracy": { "type": "number", "format": "float" }, "fcPp": { "type": "number", "format": "float" }, "weight": { "type": "number", "format": "float" }, "replay": { "type": "string" }, "modifiers": { "type": "string" }, "badCuts": { "type": "integer", "format": "int32" }, "missedNotes": { "type": "integer", "format": "int32" }, "bombCuts": { "type": "integer", "format": "int32" }, "wallsHit": { "type": "integer", "format": "int32" }, "pauses": { "type": "integer", "format": "int32" }, "fullCombo": { "type": "boolean" }, "platform": { "type": "string" }, "maxCombo": { "type": "integer", "format": "int32" }, "maxStreak": { "type": "integer", "format": "int32", "nullable": true }, "hmd": { "enum": [ "unknown", "rift", "vive", "vivePro", "wmr", "riftS", "quest", "picoNeo3", "picoNeo2", "vivePro2", "viveElite", "miramar", "pimax8k", "pimax5k", "pimaxArtisan", "hpReverb", "samsungWmr", "qiyuDream", "disco", "lenovoExplorer", "acerWmr", "viveFocus", "arpara", "dellVisor", "e3", "viveDvt", "glasses20", "hedy", "vaporeon", "huaweivr", "asusWmr", "cloudxr", "vridge", "medion", "picoNeo4", "questPro", "pimaxCrystal", "e4", "index", "controllable", "bigscreenbeyond", "nolosonic", "hypereal", "varjoaero", "psvr2", "megane1", "varjoxr3", "meganexsuperlight", "somniumvr1", "viveCosmos", "quest2", "quest3", "quest3s" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/HMD" } ], "oneOf": [ { "enum": [ 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 ], "type": "integer" }, { "enum": [ "unknown", "rift", "vive", "vivePro", "wmr", "riftS", "quest", "picoNeo3", "picoNeo2", "vivePro2", "viveElite", "miramar", "pimax8k", "pimax5k", "pimaxArtisan", "hpReverb", "samsungWmr", "qiyuDream", "disco", "lenovoExplorer", "acerWmr", "viveFocus", "arpara", "dellVisor", "e3", "viveDvt", "glasses20", "hedy", "vaporeon", "huaweivr", "asusWmr", "cloudxr", "vridge", "medion", "picoNeo4", "questPro", "pimaxCrystal", "e4", "index", "controllable", "bigscreenbeyond", "nolosonic", "hypereal", "varjoaero", "psvr2", "megane1", "varjoxr3", "meganexsuperlight", "somniumvr1", "viveCosmos", "quest2", "quest3", "quest3s" ], "type": "string" } ] }, "controller": { "enum": [ "unknown", "oculustouch", "vive", "vivePro", "wmr", "odyssey", "hpMotion", "oculustouch2", "picoNeo3", "picoNeo2", "vivePro2", "miramar", "disco", "questPro", "viveTracker", "viveTracker2", "knuckles", "nolo", "picophoenix", "hands", "viveTracker3", "pimax", "huawei", "polaris", "tundra", "cry", "e4", "gamepad", "joycon", "steamdeck", "etee", "quest3", "contactglove", "playstationSense", "viveCosmos", "quest2" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ControllerEnum" } ], "oneOf": [ { "enum": [ 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 ], "type": "integer" }, { "enum": [ "unknown", "oculustouch", "vive", "vivePro", "wmr", "odyssey", "hpMotion", "oculustouch2", "picoNeo3", "picoNeo2", "vivePro2", "miramar", "disco", "questPro", "viveTracker", "viveTracker2", "knuckles", "nolo", "picophoenix", "hands", "viveTracker3", "pimax", "huawei", "polaris", "tundra", "cry", "e4", "gamepad", "joycon", "steamdeck", "etee", "quest3", "contactglove", "playstationSense", "viveCosmos", "quest2" ], "type": "string" } ] }, "leaderboardId": { "type": "string" }, "timeset": { "type": "string" }, "timepost": { "type": "integer", "format": "int32" }, "replaysWatched": { "type": "integer", "format": "int32" }, "playCount": { "type": "integer", "format": "int32" }, "lastTryTime": { "type": "integer", "format": "int32" }, "priority": { "type": "integer", "format": "int32" }, "originalId": { "type": "integer", "format": "int32" }, "player": { "allOf": [ { "$ref": "#/components/schemas/PlayerResponse" } ], "nullable": true }, "scoreImprovement": { "allOf": [ { "$ref": "#/components/schemas/ScoreImprovement" } ], "nullable": true }, "rankVoting": { "allOf": [ { "$ref": "#/components/schemas/RankVoting" } ], "nullable": true }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/ScoreMetadata" } ], "nullable": true }, "offsets": { "allOf": [ { "$ref": "#/components/schemas/ReplayOffsets" } ], "nullable": true }, "sotwNominations": { "type": "integer", "format": "int32" }, "status": { "enum": [ "none", "playOfTheWeek" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ScoreStatus" } ], "oneOf": [ { "enum": [ 0, 2 ], "type": "integer" }, { "enum": [ "none", "playOfTheWeek" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "example": 2 }, "accLeft": { "type": "number", "format": "float" }, "accRight": { "type": "number", "format": "float" }, "myScore": { "allOf": [ { "$ref": "#/components/schemas/ScoreResponseWithAcc" } ], "nullable": true }, "endType": { "enum": [ "unknown", "clear", "fail", "restart", "quit", "practice" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/EndType" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, { "enum": [ "unknown", "clear", "fail", "restart", "quit", "practice" ], "type": "string" } ] }, "attemptsCount": { "type": "integer", "format": "int32" }, "time": { "type": "number", "format": "float" }, "startTime": { "type": "number", "format": "float" }, "experience": { "type": "number", "format": "float" }, "speed": { "type": "number", "format": "float" }, "leaderboard": { "allOf": [ { "$ref": "#/components/schemas/CompactLeaderboardResponse" } ] } }, "additionalProperties": false }, "Badge": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "details": { "type": "string", "nullable": true }, "image": { "type": "string" }, "link": { "type": "string", "nullable": true }, "timeset": { "type": "integer", "format": "int32" }, "hidden": { "type": "boolean" }, "priority": { "type": "integer", "format": "int32" }, "player": { "allOf": [ { "$ref": "#/components/schemas/Player" } ], "nullable": true }, "playerId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Ban": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "playerId": { "type": "string" }, "bannedBy": { "type": "string" }, "banReason": { "type": "string" }, "timeset": { "type": "integer", "format": "int32" }, "duration": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BeastiesNomination": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "playerId": { "maxLength": 25, "minLength": 0, "type": "string" }, "leaderboardId": { "maxLength": 25, "minLength": 0, "type": "string" }, "category": { "maxLength": 50, "minLength": 0, "type": "string" }, "timepost": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BestiesNominationResponse": { "type": "object", "properties": { "message": { "type": "string" } }, "additionalProperties": false }, "BugReportResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "enum": [ "task", "bugReport", "suggestion", "helpRequest" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/WorkTaskType" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3 ], "type": "integer" }, { "enum": [ "task", "bugReport", "suggestion", "helpRequest" ], "type": "string" } ], "description": "Defines the type of work task" }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "creator": { "allOf": [ { "$ref": "#/components/schemas/WorkTaskPlayerResponse" } ], "nullable": true }, "createdAt": { "type": "integer", "format": "int32" }, "lastEditedAt": { "type": "integer", "format": "int32", "nullable": true }, "lastEditedBy": { "allOf": [ { "$ref": "#/components/schemas/WorkTaskPlayerResponse" } ], "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/WorkTaskStatusResponse" } ], "nullable": true }, "priority": { "type": "integer", "format": "int32" }, "voteScore": { "type": "integer", "format": "int32" }, "commentCount": { "type": "integer", "format": "int32" }, "isPublic": { "type": "boolean" }, "isArchived": { "type": "boolean" }, "isLocked": { "type": "boolean" }, "dueDate": { "type": "integer", "format": "int32", "nullable": true }, "resolvedAt": { "type": "integer", "format": "int32", "nullable": true }, "resolvedBy": { "allOf": [ { "$ref": "#/components/schemas/WorkTaskPlayerResponse" } ], "nullable": true }, "currentUserVote": { "type": "integer", "format": "int32", "nullable": true }, "tagAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/WorkTaskTagAssignmentResponse" }, "nullable": true }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/WorkTaskAttachmentResponse" }, "nullable": true }, "assignments": { "type": "array", "items": { "$ref": "#/components/schemas/WorkTaskAssignmentResponse" }, "nullable": true }, "severity": { "enum": [ "low", "medium", "high", "critical" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/BugSeverity" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3 ], "type": "integer" }, { "enum": [ "low", "medium", "high", "critical" ], "type": "string" } ], "description": "Severity level for bug reports" }, "stepsToReproduce": { "type": "string", "nullable": true }, "expectedBehavior": { "type": "string", "nullable": true }, "actualBehavior": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true }, "platform": { "type": "string", "nullable": true }, "isReproducible": { "type": "boolean", "nullable": true }, "logContent": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BugSeverity": { "enum": [ "low", "medium", "high", "critical" ], "type": "string", "oneOf": [ { "enum": [ 0, 1, 2, 3 ], "type": "integer" }, { "enum": [ "low", "medium", "high", "critical" ], "type": "string" } ], "description": "Severity level for bug reports", "format": "int32" }, "Clan": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "color": { "maxLength": 10, "minLength": 0, "type": "string" }, "icon": { "type": "string" }, "tag": { "maxLength": 6, "minLength": 0, "type": "string" }, "leaderID": { "maxLength": 25, "minLength": 0, "type": "string" }, "description": { "type": "string" }, "bio": { "type": "string" }, "richBioTimeset": { "type": "integer", "format": "int32" }, "playersCount": { "type": "integer", "format": "int32" }, "mainPlayersCount": { "type": "integer", "format": "int32" }, "pp": { "type": "number", "format": "float" }, "rank": { "type": "integer", "format": "int32" }, "averageRank": { "type": "number", "format": "float" }, "averageAccuracy": { "type": "number", "format": "float" }, "featuredPlaylists": { "type": "array", "items": { "$ref": "#/components/schemas/FeaturedPlaylist" }, "nullable": true }, "rankedPoolPercentCaptured": { "type": "number", "format": "float" }, "captureLeaderboardsCount": { "type": "integer", "format": "int32" }, "capturedLeaderboards": { "type": "array", "items": { "$ref": "#/components/schemas/Leaderboard" }, "nullable": true }, "globalMapX": { "type": "number", "format": "float" }, "globalMapY": { "type": "number", "format": "float" } }, "additionalProperties": false }, "ClanBiggerResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "tag": { "type": "string" }, "color": { "type": "string" }, "name": { "type": "string" }, "icon": { "type": "string" }, "rankedPoolPercentCaptured": { "type": "number", "format": "float" }, "playersCount": { "type": "integer", "format": "int32" }, "joined": { "type": "boolean" } }, "additionalProperties": false }, "ClanGlobalMap": { "type": "object", "properties": { "points": { "type": "array", "items": { "$ref": "#/components/schemas/ClanGlobalMapPoint" } }, "clans": { "type": "array", "items": { "$ref": "#/components/schemas/ClanPoint" } } }, "additionalProperties": false }, "ClanGlobalMapPoint": { "type": "object", "properties": { "leaderboardId": { "type": "string" }, "coverImage": { "type": "string" }, "stars": { "type": "number", "format": "float", "nullable": true }, "tie": { "type": "boolean" }, "clans": { "type": "array", "items": { "$ref": "#/components/schemas/ClanMapConnection" } } }, "additionalProperties": false }, "ClanMapConnection": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "pp": { "type": "number", "format": "float" } }, "additionalProperties": false }, "ClanMapsSortBy": { "enum": [ "pp", "acc", "rank", "date", "tohold", "toconquer" ], "type": "string", "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, { "enum": [ "pp", "acc", "rank", "date", "tohold", "toconquer" ], "type": "string" } ], "format": "int32" }, "ClanPoint": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "tag": { "type": "string" }, "color": { "type": "string" }, "x": { "type": "number", "format": "float" }, "y": { "type": "number", "format": "float" } }, "additionalProperties": false }, "ClanRankingResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "clan": { "allOf": [ { "$ref": "#/components/schemas/ClanResponseFull" } ], "nullable": true }, "lastUpdateTime": { "type": "integer", "format": "int32" }, "averageRank": { "type": "number", "format": "float" }, "rank": { "type": "integer", "format": "int32" }, "pp": { "type": "number", "format": "float" }, "averageAccuracy": { "type": "number", "format": "float" }, "totalScore": { "type": "number", "format": "float" }, "leaderboardId": { "type": "string" }, "leaderboard": { "allOf": [ { "$ref": "#/components/schemas/LeaderboardResponse" } ] }, "associatedScores": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreResponse" }, "nullable": true }, "associatedScoresCount": { "type": "integer", "format": "int32" }, "myScore": { "allOf": [ { "$ref": "#/components/schemas/ScoreResponseWithAcc" } ], "nullable": true } }, "additionalProperties": false }, "ClanRankingResponseClanResponseFullResponseWithMetadataAndContainer": { "type": "object", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ClanRankingResponse" } }, "container": { "allOf": [ { "$ref": "#/components/schemas/ClanResponseFull" } ], "nullable": true } }, "additionalProperties": false }, "ClanResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "tag": { "type": "string" }, "color": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false }, "ClanResponseFull": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "color": { "type": "string" }, "icon": { "type": "string" }, "tag": { "type": "string" }, "leaderID": { "type": "string" }, "description": { "type": "string" }, "bio": { "type": "string" }, "richBioTimeset": { "type": "integer", "format": "int32" }, "discordInvite": { "type": "string" }, "playersCount": { "type": "integer", "format": "int32" }, "pp": { "type": "number", "format": "float" }, "rank": { "type": "integer", "format": "int32" }, "averageRank": { "type": "number", "format": "float" }, "averageAccuracy": { "type": "number", "format": "float" }, "rankedPoolPercentCaptured": { "type": "number", "format": "float" }, "captureLeaderboardsCount": { "type": "integer", "format": "int32" }, "playerChangesCallback": { "type": "string", "nullable": true }, "clanRankingDiscordHook": { "type": "string", "nullable": true }, "featuredPlaylists": { "type": "array", "items": { "$ref": "#/components/schemas/FeaturedPlaylistResponse" }, "nullable": true } }, "additionalProperties": false }, "ClanResponseFullResponseWithMetadata": { "type": "object", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ClanResponseFull" } } }, "additionalProperties": false }, "ClanSortBy": { "enum": [ "name", "pp", "acc", "rank", "count", "captures" ], "type": "string", "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, { "enum": [ "name", "pp", "acc", "rank", "count", "captures" ], "type": "string" } ], "format": "int32" }, "ClanTrianglePlayer": { "type": "object", "properties": { "id": { "type": "string" }, "avatar": { "type": "string" }, "accPp": { "type": "number", "format": "float" }, "techPp": { "type": "number", "format": "float" }, "passPp": { "type": "number", "format": "float" } }, "additionalProperties": false }, "ClanTriangleResponse": { "type": "object", "properties": { "accPp": { "type": "number", "format": "float" }, "techPp": { "type": "number", "format": "float" }, "passPp": { "type": "number", "format": "float" }, "players": { "type": "array", "items": { "$ref": "#/components/schemas/ClanTrianglePlayer" } } }, "additionalProperties": false }, "CompactLeaderboard": { "type": "object", "properties": { "id": { "type": "string" }, "songHash": { "type": "string" }, "modeName": { "type": "string" }, "difficulty": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CompactLeaderboardResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "song": { "allOf": [ { "$ref": "#/components/schemas/CompactSongResponse" } ], "nullable": true }, "difficulty": { "allOf": [ { "$ref": "#/components/schemas/DifficultyResponse" } ], "nullable": true } }, "additionalProperties": false }, "CompactScore": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "originalId": { "type": "integer", "format": "int32" }, "baseScore": { "type": "integer", "format": "int32" }, "modifiedScore": { "type": "integer", "format": "int32" }, "modifiers": { "type": "string" }, "fullCombo": { "type": "boolean" }, "maxCombo": { "type": "integer", "format": "int32" }, "missedNotes": { "type": "integer", "format": "int32" }, "badCuts": { "type": "integer", "format": "int32" }, "hmd": { "enum": [ "unknown", "rift", "vive", "vivePro", "wmr", "riftS", "quest", "picoNeo3", "picoNeo2", "vivePro2", "viveElite", "miramar", "pimax8k", "pimax5k", "pimaxArtisan", "hpReverb", "samsungWmr", "qiyuDream", "disco", "lenovoExplorer", "acerWmr", "viveFocus", "arpara", "dellVisor", "e3", "viveDvt", "glasses20", "hedy", "vaporeon", "huaweivr", "asusWmr", "cloudxr", "vridge", "medion", "picoNeo4", "questPro", "pimaxCrystal", "e4", "index", "controllable", "bigscreenbeyond", "nolosonic", "hypereal", "varjoaero", "psvr2", "megane1", "varjoxr3", "meganexsuperlight", "somniumvr1", "viveCosmos", "quest2", "quest3", "quest3s" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/HMD" } ], "oneOf": [ { "enum": [ 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 ], "type": "integer" }, { "enum": [ "unknown", "rift", "vive", "vivePro", "wmr", "riftS", "quest", "picoNeo3", "picoNeo2", "vivePro2", "viveElite", "miramar", "pimax8k", "pimax5k", "pimaxArtisan", "hpReverb", "samsungWmr", "qiyuDream", "disco", "lenovoExplorer", "acerWmr", "viveFocus", "arpara", "dellVisor", "e3", "viveDvt", "glasses20", "hedy", "vaporeon", "huaweivr", "asusWmr", "cloudxr", "vridge", "medion", "picoNeo4", "questPro", "pimaxCrystal", "e4", "index", "controllable", "bigscreenbeyond", "nolosonic", "hypereal", "varjoaero", "psvr2", "megane1", "varjoxr3", "meganexsuperlight", "somniumvr1", "viveCosmos", "quest2", "quest3", "quest3s" ], "type": "string" } ] }, "controller": { "enum": [ "unknown", "oculustouch", "vive", "vivePro", "wmr", "odyssey", "hpMotion", "oculustouch2", "picoNeo3", "picoNeo2", "vivePro2", "miramar", "disco", "questPro", "viveTracker", "viveTracker2", "knuckles", "nolo", "picophoenix", "hands", "viveTracker3", "pimax", "huawei", "polaris", "tundra", "cry", "e4", "gamepad", "joycon", "steamdeck", "etee", "quest3", "contactglove", "playstationSense", "viveCosmos", "quest2" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ControllerEnum" } ], "oneOf": [ { "enum": [ 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 ], "type": "integer" }, { "enum": [ "unknown", "oculustouch", "vive", "vivePro", "wmr", "odyssey", "hpMotion", "oculustouch2", "picoNeo3", "picoNeo2", "vivePro2", "miramar", "disco", "questPro", "viveTracker", "viveTracker2", "knuckles", "nolo", "picophoenix", "hands", "viveTracker3", "pimax", "huawei", "polaris", "tundra", "cry", "e4", "gamepad", "joycon", "steamdeck", "etee", "quest3", "contactglove", "playstationSense", "viveCosmos", "quest2" ], "type": "string" } ] }, "accuracy": { "type": "number", "format": "float" }, "pp": { "type": "number", "format": "float", "nullable": true }, "epochTime": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CompactScoreResponse": { "type": "object", "properties": { "score": { "allOf": [ { "$ref": "#/components/schemas/CompactScore" } ] }, "leaderboard": { "allOf": [ { "$ref": "#/components/schemas/CompactLeaderboard" } ] } }, "additionalProperties": false }, "CompactScoreResponseResponseWithMetadata": { "type": "object", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CompactScoreResponse" } } }, "additionalProperties": false }, "CompactSongResponse": { "type": "object", "properties": { "id": { "type": "string" }, "hash": { "type": "string" }, "name": { "type": "string" }, "subName": { "type": "string", "nullable": true }, "author": { "type": "string" }, "mapper": { "type": "string" }, "mapperId": { "type": "integer", "format": "int32" }, "collaboratorIds": { "type": "string", "nullable": true }, "coverImage": { "type": "string" }, "bpm": { "type": "number", "format": "double" }, "duration": { "type": "number", "format": "double" }, "fullCoverImage": { "type": "string", "nullable": true }, "explicity": { "enum": [ "none", "cover", "lyrics", "name", "author", "map" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/SongExplicitStatus" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32 ], "type": "integer" }, { "enum": [ "none", "cover", "lyrics", "name", "author", "map" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "example": 62 } }, "additionalProperties": false }, "ControllerEnum": { "enum": [ "unknown", "oculustouch", "vive", "vivePro", "wmr", "odyssey", "hpMotion", "oculustouch2", "picoNeo3", "picoNeo2", "vivePro2", "miramar", "disco", "questPro", "viveTracker", "viveTracker2", "knuckles", "nolo", "picophoenix", "hands", "viveTracker3", "pimax", "huawei", "polaris", "tundra", "cry", "e4", "gamepad", "joycon", "steamdeck", "etee", "quest3", "contactglove", "playstationSense", "viveCosmos", "quest2" ], "type": "string", "oneOf": [ { "enum": [ 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 ], "type": "integer" }, { "enum": [ "unknown", "oculustouch", "vive", "vivePro", "wmr", "odyssey", "hpMotion", "oculustouch2", "picoNeo3", "picoNeo2", "vivePro2", "miramar", "disco", "questPro", "viveTracker", "viveTracker2", "knuckles", "nolo", "picophoenix", "hands", "viveTracker3", "pimax", "huawei", "polaris", "tundra", "cry", "e4", "gamepad", "joycon", "steamdeck", "etee", "quest3", "contactglove", "playstationSense", "viveCosmos", "quest2" ], "type": "string" } ], "format": "int32" }, "CriteriaCommentary": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "playerId": { "type": "string" }, "timeset": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "editTimeset": { "type": "integer", "format": "int32", "nullable": true }, "edited": { "type": "boolean" }, "rankQualificationId": { "type": "integer", "format": "int32", "nullable": true }, "discordMessageId": { "type": "string" } }, "additionalProperties": false }, "DateRangeType": { "enum": [ "upload", "ranked", "score" ], "type": "string", "oneOf": [ { "enum": [ 0, 1, 2 ], "type": "integer" }, { "enum": [ "upload", "ranked", "score" ], "type": "string" } ], "format": "int32" }, "DifficultyDescription": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "value": { "type": "integer", "format": "int32" }, "mode": { "type": "integer", "format": "int32" }, "difficultyName": { "maxLength": 25, "minLength": 0, "type": "string" }, "modeName": { "maxLength": 100, "minLength": 0, "type": "string" }, "status": { "enum": [ "unranked", "nominated", "qualified", "ranked", "unrankable", "outdated", "inevent", "oST" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/DifficultyStatus" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7 ], "type": "integer" }, { "enum": [ "unranked", "nominated", "qualified", "ranked", "unrankable", "outdated", "inevent", "oST" ], "type": "string" } ], "description": "Represents the difficulty status of a map." }, "modifierValues": { "allOf": [ { "$ref": "#/components/schemas/ModifiersMap" } ], "nullable": true }, "modifiersRating": { "allOf": [ { "$ref": "#/components/schemas/ModifiersRating" } ], "nullable": true }, "nominatedTime": { "type": "integer", "format": "int32" }, "qualifiedTime": { "type": "integer", "format": "int32" }, "rankedTime": { "type": "integer", "format": "int32" }, "hash": { "maxLength": 80, "minLength": 0, "type": "string" }, "songId": { "type": "string", "nullable": true }, "customDifficultyName": { "type": "string", "nullable": true }, "speedTags": { "type": "integer", "format": "int32" }, "styleTags": { "type": "integer", "format": "int32" }, "featureTags": { "type": "integer", "format": "int32" }, "stars": { "type": "number", "format": "float", "nullable": true }, "predictedAcc": { "type": "number", "format": "float", "nullable": true }, "passRating": { "type": "number", "format": "float", "nullable": true }, "accRating": { "type": "number", "format": "float", "nullable": true }, "techRating": { "type": "number", "format": "float", "nullable": true }, "multiRating": { "type": "number", "format": "float", "nullable": true }, "linearPercentage": { "type": "number", "format": "float", "nullable": true }, "peakSustainedEBPM": { "type": "number", "format": "float", "nullable": true }, "njs": { "type": "number", "format": "float" }, "nps": { "type": "number", "format": "float" }, "notes": { "type": "integer", "format": "int32" }, "chains": { "type": "integer", "format": "int32" }, "sliders": { "type": "integer", "format": "int32" }, "bombs": { "type": "integer", "format": "int32" }, "walls": { "type": "integer", "format": "int32" }, "maxScore": { "type": "integer", "format": "int32" }, "duration": { "type": "number", "format": "double" }, "noteJumpStartBeatOffset": { "type": "number", "format": "double" }, "mapVersion": { "maxLength": 25, "minLength": 0, "type": "string", "nullable": true }, "requirements": { "enum": [ "none", "chroma", "noodles", "mappingExtensions", "cinema", "v3", "optionalProperties", "vNJS", "vivify", "v3Pepega", "groupLighting", "audioLink", "ignore" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/Requirements" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, -1 ], "type": "integer" }, { "enum": [ "none", "chroma", "noodles", "mappingExtensions", "cinema", "v3", "optionalProperties", "vNJS", "vivify", "v3Pepega", "groupLighting", "audioLink", "ignore" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "example": -1 }, "type": { "enum": [ "none", "acc", "tech", "midspeed", "speed", "fitbeat", "linear", "bombReset" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/MapTypes" } ], "oneOf": [ { "enum": [ 0, 1, 2, 4, 8, 16, 32, 64 ], "type": "integer" }, { "enum": [ "none", "acc", "tech", "midspeed", "speed", "fitbeat", "linear", "bombReset" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "example": 127 }, "difficultyStatisticsId": { "type": "integer", "format": "int32", "nullable": true }, "extensions": { "type": "array", "items": { "$ref": "#/components/schemas/DifficultyDescriptionExtension" } } }, "additionalProperties": false }, "DifficultyDescriptionExtension": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "context": { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/LeaderboardContexts" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 ], "type": "integer" }, { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "example": 2046 }, "maxScoreRight": { "type": "integer", "format": "int32" }, "maxScoreLeft": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DifficultyResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "value": { "type": "integer", "format": "int32" }, "mode": { "type": "integer", "format": "int32" }, "difficultyName": { "type": "string" }, "customDifficultyName": { "type": "string", "nullable": true }, "mapVersion": { "type": "string", "nullable": true }, "modeName": { "type": "string" }, "status": { "enum": [ "unranked", "nominated", "qualified", "ranked", "unrankable", "outdated", "inevent", "oST" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/DifficultyStatus" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7 ], "type": "integer" }, { "enum": [ "unranked", "nominated", "qualified", "ranked", "unrankable", "outdated", "inevent", "oST" ], "type": "string" } ], "description": "Represents the difficulty status of a map." }, "modifierValues": { "allOf": [ { "$ref": "#/components/schemas/ModifiersMap" } ], "nullable": true }, "modifiersRating": { "allOf": [ { "$ref": "#/components/schemas/ModifiersRating" } ], "nullable": true }, "nominatedTime": { "type": "integer", "format": "int32" }, "qualifiedTime": { "type": "integer", "format": "int32" }, "rankedTime": { "type": "integer", "format": "int32" }, "speedTags": { "type": "integer", "format": "int32" }, "styleTags": { "type": "integer", "format": "int32" }, "featureTags": { "type": "integer", "format": "int32" }, "stars": { "type": "number", "format": "float", "nullable": true }, "predictedAcc": { "type": "number", "format": "float", "nullable": true }, "passRating": { "type": "number", "format": "float", "nullable": true }, "accRating": { "type": "number", "format": "float", "nullable": true }, "techRating": { "type": "number", "format": "float", "nullable": true }, "multiRating": { "type": "number", "format": "float", "nullable": true }, "type": { "enum": [ "none", "acc", "tech", "midspeed", "speed", "fitbeat", "linear", "bombReset" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/MapTypes" } ], "oneOf": [ { "enum": [ 0, 1, 2, 4, 8, 16, 32, 64 ], "type": "integer" }, { "enum": [ "none", "acc", "tech", "midspeed", "speed", "fitbeat", "linear", "bombReset" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "example": 127 }, "njs": { "type": "number", "format": "float" }, "nps": { "type": "number", "format": "float" }, "linearPercentage": { "type": "number", "format": "float", "nullable": true }, "peakSustainedEBPM": { "type": "number", "format": "float", "nullable": true }, "noteJumpStartBeatOffset": { "type": "number", "format": "float" }, "notes": { "type": "integer", "format": "int32" }, "chains": { "type": "integer", "format": "int32" }, "sliders": { "type": "integer", "format": "int32" }, "bombs": { "type": "integer", "format": "int32" }, "walls": { "type": "integer", "format": "int32" }, "maxScore": { "type": "integer", "format": "int32" }, "duration": { "type": "number", "format": "double" }, "requirements": { "enum": [ "none", "chroma", "noodles", "mappingExtensions", "cinema", "v3", "optionalProperties", "vNJS", "vivify", "v3Pepega", "groupLighting", "audioLink", "ignore" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/Requirements" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, -1 ], "type": "integer" }, { "enum": [ "none", "chroma", "noodles", "mappingExtensions", "cinema", "v3", "optionalProperties", "vNJS", "vivify", "v3Pepega", "groupLighting", "audioLink", "ignore" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "example": -1 }, "difficultyStatistics": { "allOf": [ { "$ref": "#/components/schemas/DifficultyStatisticsResponse" } ], "nullable": true } }, "additionalProperties": false }, "DifficultyStatisticsResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "stacks": { "type": "integer", "format": "int32" }, "towers": { "type": "integer", "format": "int32" }, "sliders": { "type": "integer", "format": "int32" }, "curvedSliders": { "type": "integer", "format": "int32" }, "windows": { "type": "integer", "format": "int32" }, "slantedWindows": { "type": "integer", "format": "int32" }, "dodgeWalls": { "type": "integer", "format": "int32" }, "crouchWalls": { "type": "integer", "format": "int32" }, "parityErrors": { "type": "integer", "format": "int32" }, "bombAvoidances": { "type": "integer", "format": "int32" }, "linearSwings": { "type": "integer", "format": "int32" }, "swingData": { "type": "array", "items": { "$ref": "#/components/schemas/MapSwingData" } } }, "additionalProperties": false }, "DifficultyStatus": { "enum": [ "unranked", "nominated", "qualified", "ranked", "unrankable", "outdated", "inevent", "oST" ], "type": "string", "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7 ], "type": "integer" }, { "enum": [ "unranked", "nominated", "qualified", "ranked", "unrankable", "outdated", "inevent", "oST" ], "type": "string" } ], "description": "Represents the difficulty status of a map.", "format": "int32" }, "EarthDayMap": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "hash": { "type": "string" }, "timeset": { "type": "integer", "format": "int32" }, "playerId": { "type": "string" } }, "additionalProperties": false }, "EndType": { "enum": [ "unknown", "clear", "fail", "restart", "quit", "practice" ], "type": "string", "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, { "enum": [ "unknown", "clear", "fail", "restart", "quit", "practice" ], "type": "string" } ], "format": "int32" }, "EventPlayer": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "eventRankingId": { "type": "integer", "format": "int32", "nullable": true }, "event": { "allOf": [ { "$ref": "#/components/schemas/EventRanking" } ] }, "eventName": { "type": "string" }, "playerName": { "type": "string" }, "playerId": { "type": "string" }, "country": { "type": "string" }, "rank": { "type": "integer", "format": "int32" }, "countryRank": { "type": "integer", "format": "int32" }, "pp": { "type": "number", "format": "float" }, "mapOfTheDays": { "type": "array", "items": { "$ref": "#/components/schemas/MapOfTheDay" } }, "mapOfTheDayPoints": { "type": "array", "items": { "$ref": "#/components/schemas/MapOfTheDayPoints" } } }, "additionalProperties": false }, "EventRanking": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "endDate": { "type": "integer", "format": "int32" }, "playlistId": { "type": "integer", "format": "int32" }, "image": { "type": "string" }, "description": { "type": "string", "nullable": true }, "animatedImage": { "type": "string", "nullable": true }, "mainColor": { "type": "string" }, "secondaryColor": { "type": "string" }, "pageAlias": { "type": "string", "nullable": true }, "eventType": { "enum": [ "playlist", "mapOfTheDay" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/EventRankingType" } ], "oneOf": [ { "enum": [ 0, 1 ], "type": "integer" }, { "enum": [ "playlist", "mapOfTheDay" ], "type": "string" } ] } }, "additionalProperties": false }, "EventRankingType": { "enum": [ "playlist", "mapOfTheDay" ], "type": "string", "oneOf": [ { "enum": [ 0, 1 ], "type": "integer" }, { "enum": [ "playlist", "mapOfTheDay" ], "type": "string" } ], "format": "int32" }, "ExternalStatus": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "enum": [ "none", "curated", "mapOfTheWeek", "noodleMonday", "featuredOnCC", "beastSaberAwarded", "buildingBlocksAwarded" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/SongStatus" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64 ], "type": "integer" }, { "enum": [ "none", "curated", "mapOfTheWeek", "noodleMonday", "featuredOnCC", "beastSaberAwarded", "buildingBlocksAwarded" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "example": 126 }, "timeset": { "type": "integer", "format": "int32" }, "link": { "type": "string", "nullable": true }, "responsible": { "type": "string", "nullable": true }, "details": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "titleColor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FavoriteMap": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "timeset": { "type": "integer", "format": "int32" }, "leaderboardId": { "type": "string", "nullable": true }, "leaderboard": { "allOf": [ { "$ref": "#/components/schemas/Leaderboard" } ], "nullable": true }, "playerId": { "type": "string", "nullable": true }, "player": { "allOf": [ { "$ref": "#/components/schemas/Player" } ], "nullable": true }, "rankVotingId": { "type": "integer", "format": "int32", "nullable": true }, "rankVoting": { "allOf": [ { "$ref": "#/components/schemas/RankVoting" } ], "nullable": true }, "aspect": { "enum": [ "none", "map", "music" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/FavoriteMapAspect" } ], "oneOf": [ { "enum": [ 0, 2, 4 ], "type": "integer" }, { "enum": [ "none", "map", "music" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "example": 6 }, "comment": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FavoriteMapAspect": { "enum": [ "none", "map", "music" ], "type": "string", "oneOf": [ { "enum": [ 0, 2, 4 ], "type": "integer" }, { "enum": [ "none", "map", "music" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "format": "int32", "example": 6 }, "FavoriteMapResponseWithMetadata": { "type": "object", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FavoriteMap" } } }, "additionalProperties": false }, "FeaturedPlaylist": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "playlistLink": { "type": "string" }, "cover": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "mapCount": { "type": "integer", "format": "int32" }, "owner": { "type": "string", "nullable": true }, "ownerCover": { "type": "string", "nullable": true }, "ownerLink": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FeaturedPlaylistResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "playlistLink": { "type": "string" }, "cover": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "mapCount": { "type": "integer", "format": "int32", "nullable": true }, "owner": { "type": "string", "nullable": true }, "ownerCover": { "type": "string", "nullable": true }, "ownerLink": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FollowerType": { "enum": [ "following", "followers" ], "type": "string", "oneOf": [ { "enum": [ 0, 1 ], "type": "integer" }, { "enum": [ "following", "followers" ], "type": "string" } ], "format": "int32" }, "GlobalMapHistory": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "timestamp": { "type": "integer", "format": "int32" }, "clanId": { "type": "integer", "format": "int32" }, "clan": { "allOf": [ { "$ref": "#/components/schemas/Clan" } ] }, "globalMapCaptured": { "type": "number", "format": "float" }, "playersCount": { "type": "integer", "format": "int32" }, "mainPlayersCount": { "type": "integer", "format": "int32" }, "pp": { "type": "number", "format": "float" }, "rank": { "type": "integer", "format": "int32" }, "averageRank": { "type": "number", "format": "float" }, "averageAccuracy": { "type": "number", "format": "float" }, "captureLeaderboardsCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "HMD": { "enum": [ "unknown", "rift", "vive", "vivePro", "wmr", "riftS", "quest", "picoNeo3", "picoNeo2", "vivePro2", "viveElite", "miramar", "pimax8k", "pimax5k", "pimaxArtisan", "hpReverb", "samsungWmr", "qiyuDream", "disco", "lenovoExplorer", "acerWmr", "viveFocus", "arpara", "dellVisor", "e3", "viveDvt", "glasses20", "hedy", "vaporeon", "huaweivr", "asusWmr", "cloudxr", "vridge", "medion", "picoNeo4", "questPro", "pimaxCrystal", "e4", "index", "controllable", "bigscreenbeyond", "nolosonic", "hypereal", "varjoaero", "psvr2", "megane1", "varjoxr3", "meganexsuperlight", "somniumvr1", "viveCosmos", "quest2", "quest3", "quest3s" ], "type": "string", "oneOf": [ { "enum": [ 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 ], "type": "integer" }, { "enum": [ "unknown", "rift", "vive", "vivePro", "wmr", "riftS", "quest", "picoNeo3", "picoNeo2", "vivePro2", "viveElite", "miramar", "pimax8k", "pimax5k", "pimaxArtisan", "hpReverb", "samsungWmr", "qiyuDream", "disco", "lenovoExplorer", "acerWmr", "viveFocus", "arpara", "dellVisor", "e3", "viveDvt", "glasses20", "hedy", "vaporeon", "huaweivr", "asusWmr", "cloudxr", "vridge", "medion", "picoNeo4", "questPro", "pimaxCrystal", "e4", "index", "controllable", "bigscreenbeyond", "nolosonic", "hypereal", "varjoaero", "psvr2", "megane1", "varjoxr3", "meganexsuperlight", "somniumvr1", "viveCosmos", "quest2", "quest3", "quest3s" ], "type": "string" } ], "format": "int32" }, "HelpCategory": { "enum": [ "installation", "configuration", "usage", "account", "technical", "other" ], "type": "string", "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, { "enum": [ "installation", "configuration", "usage", "account", "technical", "other" ], "type": "string" } ], "description": "Category of help request", "format": "int32" }, "HelpRequestResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "enum": [ "task", "bugReport", "suggestion", "helpRequest" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/WorkTaskType" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3 ], "type": "integer" }, { "enum": [ "task", "bugReport", "suggestion", "helpRequest" ], "type": "string" } ], "description": "Defines the type of work task" }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "creator": { "allOf": [ { "$ref": "#/components/schemas/WorkTaskPlayerResponse" } ], "nullable": true }, "createdAt": { "type": "integer", "format": "int32" }, "lastEditedAt": { "type": "integer", "format": "int32", "nullable": true }, "lastEditedBy": { "allOf": [ { "$ref": "#/components/schemas/WorkTaskPlayerResponse" } ], "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/WorkTaskStatusResponse" } ], "nullable": true }, "priority": { "type": "integer", "format": "int32" }, "voteScore": { "type": "integer", "format": "int32" }, "commentCount": { "type": "integer", "format": "int32" }, "isPublic": { "type": "boolean" }, "isArchived": { "type": "boolean" }, "isLocked": { "type": "boolean" }, "dueDate": { "type": "integer", "format": "int32", "nullable": true }, "resolvedAt": { "type": "integer", "format": "int32", "nullable": true }, "resolvedBy": { "allOf": [ { "$ref": "#/components/schemas/WorkTaskPlayerResponse" } ], "nullable": true }, "currentUserVote": { "type": "integer", "format": "int32", "nullable": true }, "tagAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/WorkTaskTagAssignmentResponse" }, "nullable": true }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/WorkTaskAttachmentResponse" }, "nullable": true }, "assignments": { "type": "array", "items": { "$ref": "#/components/schemas/WorkTaskAssignmentResponse" }, "nullable": true }, "category": { "enum": [ "installation", "configuration", "usage", "account", "technical", "other" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/HelpCategory" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, { "enum": [ "installation", "configuration", "usage", "account", "technical", "other" ], "type": "string" } ], "description": "Category of help request" }, "urgency": { "enum": [ "low", "normal", "high", "urgent" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/HelpUrgency" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3 ], "type": "integer" }, { "enum": [ "low", "normal", "high", "urgent" ], "type": "string" } ], "description": "Urgency level for help requests" }, "alreadyTried": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true }, "platform": { "type": "string", "nullable": true }, "resolution": { "type": "string", "nullable": true }, "isResolved": { "type": "boolean" }, "userResolvedAt": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "HelpUrgency": { "enum": [ "low", "normal", "high", "urgent" ], "type": "string", "oneOf": [ { "enum": [ 0, 1, 2, 3 ], "type": "integer" }, { "enum": [ "low", "normal", "high", "urgent" ], "type": "string" } ], "description": "Urgency level for help requests", "format": "int32" }, "HistoryCompactResponse": { "type": "object", "properties": { "timestamp": { "type": "integer", "format": "int32" }, "pp": { "type": "number", "format": "float" }, "rank": { "type": "integer", "format": "int32" }, "countryRank": { "type": "integer", "format": "int32" }, "averageRankedAccuracy": { "type": "number", "format": "float" }, "averageUnrankedAccuracy": { "type": "number", "format": "float" }, "averageAccuracy": { "type": "number", "format": "float" }, "medianRankedAccuracy": { "type": "number", "format": "float" }, "medianAccuracy": { "type": "number", "format": "float" }, "rankedPlayCount": { "type": "integer", "format": "int32" }, "unrankedPlayCount": { "type": "integer", "format": "int32" }, "totalPlayCount": { "type": "integer", "format": "int32" }, "rankedImprovementsCount": { "type": "integer", "format": "int32" }, "unrankedImprovementsCount": { "type": "integer", "format": "int32" }, "totalImprovementsCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "HistoryTriangleResponse": { "type": "object", "properties": { "timestamp": { "type": "integer", "format": "int32" }, "pp": { "type": "number", "format": "float" }, "accPp": { "type": "number", "format": "float" }, "passPp": { "type": "number", "format": "float" }, "techPp": { "type": "number", "format": "float" }, "improvements": { "type": "integer", "format": "int32" }, "newScores": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "IdolCanvas": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "playerId": { "type": "string", "nullable": true }, "player": { "allOf": [ { "$ref": "#/components/schemas/Player" } ], "nullable": true }, "canvasState": { "type": "string" }, "backgroundId": { "type": "integer", "format": "int32" }, "seenIdolIds": { "type": "string", "nullable": true }, "lastUpdated": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "IdolDecoration": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "globallyAvailable": { "type": "boolean" }, "smallPictureRegular": { "type": "string" }, "bigPictureRegular": { "type": "string" }, "smallPicturePro": { "type": "string" }, "bigPicturePro": { "type": "string" }, "description": { "type": "string" }, "songId": { "type": "string", "nullable": true }, "song": { "allOf": [ { "$ref": "#/components/schemas/Song" } ], "nullable": true } }, "additionalProperties": false }, "IdolDescription": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "bonus": { "type": "boolean" }, "globallyAvailable": { "type": "boolean" }, "birthday": { "type": "integer", "format": "int32" }, "smallPictureRegular": { "type": "string" }, "bigPictureRegular": { "type": "string" }, "smallPicturePro": { "type": "string" }, "bigPicturePro": { "type": "string" }, "description": { "type": "string" }, "rewardGif": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InfoToHighlight": { "enum": [ "none", "watchCount", "playCount" ], "type": "string", "oneOf": [ { "enum": [ 0, 2, 4 ], "type": "integer" }, { "enum": [ "none", "watchCount", "playCount" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "format": "int32", "example": 6 }, "Leaderboard": { "type": "object", "properties": { "id": { "type": "string" }, "songId": { "type": "string", "nullable": true }, "song": { "allOf": [ { "$ref": "#/components/schemas/Song" } ] }, "difficulty": { "allOf": [ { "$ref": "#/components/schemas/DifficultyDescription" } ] }, "qualification": { "allOf": [ { "$ref": "#/components/schemas/RankQualification" } ], "nullable": true }, "reweight": { "allOf": [ { "$ref": "#/components/schemas/RankUpdate" } ], "nullable": true }, "timestamp": { "type": "integer", "format": "int64" }, "changes": { "type": "array", "items": { "$ref": "#/components/schemas/LeaderboardChange" }, "nullable": true }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/EventRanking" }, "nullable": true }, "plays": { "type": "integer", "format": "int32" }, "playCount": { "type": "integer", "format": "int32" }, "lastScoreTime": { "type": "integer", "format": "int32" }, "todayPlays": { "type": "integer", "format": "int32" }, "thisWeekPlays": { "type": "integer", "format": "int32" }, "positiveVotes": { "type": "integer", "format": "int32" }, "starVotes": { "type": "integer", "format": "int32" }, "negativeVotes": { "type": "integer", "format": "int32" }, "voteStars": { "type": "number", "format": "float" }, "fansCount": { "type": "integer", "format": "int32" }, "clanId": { "type": "integer", "format": "int32", "nullable": true }, "capturedTime": { "type": "integer", "format": "int32", "nullable": true }, "clanRankingContested": { "type": "boolean" } }, "additionalProperties": false }, "LeaderboardChange": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "timeset": { "type": "integer", "format": "int32" }, "playerId": { "type": "string" }, "oldRankability": { "type": "number", "format": "float" }, "oldStars": { "type": "number", "format": "float" }, "oldAccRating": { "type": "number", "format": "float" }, "oldPassRating": { "type": "number", "format": "float" }, "oldTechRating": { "type": "number", "format": "float" }, "oldType": { "enum": [ "none", "acc", "tech", "midspeed", "speed", "fitbeat", "linear", "bombReset" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/MapTypes" } ], "oneOf": [ { "enum": [ 0, 1, 2, 4, 8, 16, 32, 64 ], "type": "integer" }, { "enum": [ "none", "acc", "tech", "midspeed", "speed", "fitbeat", "linear", "bombReset" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "example": 127 }, "oldCriteriaMet": { "type": "integer", "format": "int32" }, "oldModifiers": { "allOf": [ { "$ref": "#/components/schemas/ModifiersMap" } ], "nullable": true }, "oldModifiersRating": { "allOf": [ { "$ref": "#/components/schemas/ModifiersRating" } ], "nullable": true }, "newRankability": { "type": "number", "format": "float" }, "newStars": { "type": "number", "format": "float" }, "newAccRating": { "type": "number", "format": "float" }, "newPassRating": { "type": "number", "format": "float" }, "newTechRating": { "type": "number", "format": "float" }, "newType": { "enum": [ "none", "acc", "tech", "midspeed", "speed", "fitbeat", "linear", "bombReset" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/MapTypes" } ], "oneOf": [ { "enum": [ 0, 1, 2, 4, 8, 16, 32, 64 ], "type": "integer" }, { "enum": [ "none", "acc", "tech", "midspeed", "speed", "fitbeat", "linear", "bombReset" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "example": 127 }, "newCriteriaMet": { "type": "integer", "format": "int32" }, "newModifiers": { "allOf": [ { "$ref": "#/components/schemas/ModifiersMap" } ], "nullable": true }, "newModifiersRating": { "allOf": [ { "$ref": "#/components/schemas/ModifiersRating" } ], "nullable": true } }, "additionalProperties": false }, "LeaderboardClanRankingResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "song": { "allOf": [ { "$ref": "#/components/schemas/SongResponse" } ], "nullable": true }, "difficulty": { "allOf": [ { "$ref": "#/components/schemas/DifficultyResponse" } ], "nullable": true }, "scores": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreResponse" }, "nullable": true }, "changes": { "type": "array", "items": { "$ref": "#/components/schemas/LeaderboardChange" }, "nullable": true }, "featuredPlaylists": { "type": "array", "items": { "$ref": "#/components/schemas/FeaturedPlaylist" }, "nullable": true }, "qualification": { "allOf": [ { "$ref": "#/components/schemas/RankQualification" } ], "nullable": true }, "reweight": { "allOf": [ { "$ref": "#/components/schemas/RankUpdate" } ], "nullable": true }, "leaderboardGroup": { "type": "array", "items": { "$ref": "#/components/schemas/LeaderboardGroupEntry" }, "nullable": true }, "plays": { "type": "integer", "format": "int32" }, "clan": { "allOf": [ { "$ref": "#/components/schemas/ClanResponseFull" } ], "nullable": true }, "clanRankingContested": { "type": "boolean" }, "clanRanking": { "type": "array", "items": { "$ref": "#/components/schemas/ClanRankingResponse" }, "nullable": true } }, "additionalProperties": false }, "LeaderboardContexts": { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string", "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 ], "type": "integer" }, { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "format": "int32", "example": 2046 }, "LeaderboardGroupEntry": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "enum": [ "unranked", "nominated", "qualified", "ranked", "unrankable", "outdated", "inevent", "oST" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/DifficultyStatus" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7 ], "type": "integer" }, { "enum": [ "unranked", "nominated", "qualified", "ranked", "unrankable", "outdated", "inevent", "oST" ], "type": "string" } ], "description": "Represents the difficulty status of a map." }, "timestamp": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "LeaderboardInfoResponse": { "type": "object", "properties": { "id": { "type": "string" }, "song": { "allOf": [ { "$ref": "#/components/schemas/SongResponse" } ] }, "difficulty": { "allOf": [ { "$ref": "#/components/schemas/DifficultyResponse" } ] }, "plays": { "type": "integer", "format": "int32" }, "attempts": { "type": "integer", "format": "int32" }, "positiveVotes": { "type": "integer", "format": "int32" }, "starVotes": { "type": "integer", "format": "int32" }, "negativeVotes": { "type": "integer", "format": "int32" }, "voteStars": { "type": "number", "format": "float" }, "clan": { "allOf": [ { "$ref": "#/components/schemas/ClanResponseFull" } ], "nullable": true }, "clanRankingContested": { "type": "boolean" }, "myScore": { "allOf": [ { "$ref": "#/components/schemas/ScoreResponseWithAcc" } ], "nullable": true }, "qualification": { "allOf": [ { "$ref": "#/components/schemas/RankQualification" } ], "nullable": true }, "reweight": { "allOf": [ { "$ref": "#/components/schemas/RankUpdate" } ], "nullable": true } }, "additionalProperties": false }, "LeaderboardInfoResponseResponseWithMetadata": { "type": "object", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/LeaderboardInfoResponse" } } }, "additionalProperties": false }, "LeaderboardResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "song": { "allOf": [ { "$ref": "#/components/schemas/SongResponse" } ], "nullable": true }, "difficulty": { "allOf": [ { "$ref": "#/components/schemas/DifficultyResponse" } ], "nullable": true }, "scores": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreResponse" }, "nullable": true }, "changes": { "type": "array", "items": { "$ref": "#/components/schemas/LeaderboardChange" }, "nullable": true }, "featuredPlaylists": { "type": "array", "items": { "$ref": "#/components/schemas/FeaturedPlaylist" }, "nullable": true }, "qualification": { "allOf": [ { "$ref": "#/components/schemas/RankQualification" } ], "nullable": true }, "reweight": { "allOf": [ { "$ref": "#/components/schemas/RankUpdate" } ], "nullable": true }, "leaderboardGroup": { "type": "array", "items": { "$ref": "#/components/schemas/LeaderboardGroupEntry" }, "nullable": true }, "plays": { "type": "integer", "format": "int32" }, "clan": { "allOf": [ { "$ref": "#/components/schemas/ClanResponseFull" } ], "nullable": true }, "clanRankingContested": { "type": "boolean" } }, "additionalProperties": false }, "LeaderboardSortBy": { "enum": [ "date", "pp", "acc", "pauses", "rank", "maxStreak", "mistakes", "weight", "weightedPp" ], "type": "string", "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8 ], "type": "integer" }, { "enum": [ "date", "pp", "acc", "pauses", "rank", "maxStreak", "mistakes", "weight", "weightedPp" ], "type": "string" } ], "format": "int32" }, "LegacyModifiers": { "type": "object", "properties": { "da": { "type": "number", "description": "Dissapearing arrows", "format": "float" }, "fs": { "type": "number", "description": "Faster song", "format": "float" }, "ss": { "type": "number", "description": "Slower song", "format": "float" }, "sf": { "type": "number", "description": "Super fast song", "format": "float" }, "gn": { "type": "number", "description": "Ghost notes", "format": "float" }, "na": { "type": "number", "description": "No arrows", "format": "float" }, "nb": { "type": "number", "description": "No bombs", "format": "float" }, "nf": { "type": "number", "description": "No fail", "format": "float" }, "no": { "type": "number", "description": "No walls", "format": "float" }, "pm": { "type": "number", "description": "Pro mode", "format": "float" }, "sc": { "type": "number", "description": "Smaller notes", "format": "float" } }, "additionalProperties": false }, "LinkResponse": { "type": "object", "properties": { "questId": { "type": "integer", "format": "int32", "nullable": true }, "steamId": { "type": "string", "nullable": true }, "oculusPCId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MapDiffResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "value": { "type": "integer", "format": "int32" }, "mode": { "type": "integer", "format": "int32" }, "difficultyName": { "type": "string" }, "customDifficultyName": { "type": "string", "nullable": true }, "mapVersion": { "type": "string", "nullable": true }, "modeName": { "type": "string" }, "status": { "enum": [ "unranked", "nominated", "qualified", "ranked", "unrankable", "outdated", "inevent", "oST" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/DifficultyStatus" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7 ], "type": "integer" }, { "enum": [ "unranked", "nominated", "qualified", "ranked", "unrankable", "outdated", "inevent", "oST" ], "type": "string" } ], "description": "Represents the difficulty status of a map." }, "modifierValues": { "allOf": [ { "$ref": "#/components/schemas/ModifiersMap" } ], "nullable": true }, "modifiersRating": { "allOf": [ { "$ref": "#/components/schemas/ModifiersRating" } ], "nullable": true }, "nominatedTime": { "type": "integer", "format": "int32" }, "qualifiedTime": { "type": "integer", "format": "int32" }, "rankedTime": { "type": "integer", "format": "int32" }, "speedTags": { "type": "integer", "format": "int32" }, "styleTags": { "type": "integer", "format": "int32" }, "featureTags": { "type": "integer", "format": "int32" }, "stars": { "type": "number", "format": "float", "nullable": true }, "predictedAcc": { "type": "number", "format": "float", "nullable": true }, "passRating": { "type": "number", "format": "float", "nullable": true }, "accRating": { "type": "number", "format": "float", "nullable": true }, "techRating": { "type": "number", "format": "float", "nullable": true }, "multiRating": { "type": "number", "format": "float", "nullable": true }, "type": { "enum": [ "none", "acc", "tech", "midspeed", "speed", "fitbeat", "linear", "bombReset" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/MapTypes" } ], "oneOf": [ { "enum": [ 0, 1, 2, 4, 8, 16, 32, 64 ], "type": "integer" }, { "enum": [ "none", "acc", "tech", "midspeed", "speed", "fitbeat", "linear", "bombReset" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "example": 127 }, "njs": { "type": "number", "format": "float" }, "nps": { "type": "number", "format": "float" }, "linearPercentage": { "type": "number", "format": "float", "nullable": true }, "peakSustainedEBPM": { "type": "number", "format": "float", "nullable": true }, "noteJumpStartBeatOffset": { "type": "number", "format": "float" }, "notes": { "type": "integer", "format": "int32" }, "chains": { "type": "integer", "format": "int32" }, "sliders": { "type": "integer", "format": "int32" }, "bombs": { "type": "integer", "format": "int32" }, "walls": { "type": "integer", "format": "int32" }, "maxScore": { "type": "integer", "format": "int32" }, "duration": { "type": "number", "format": "double" }, "requirements": { "enum": [ "none", "chroma", "noodles", "mappingExtensions", "cinema", "v3", "optionalProperties", "vNJS", "vivify", "v3Pepega", "groupLighting", "audioLink", "ignore" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/Requirements" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, -1 ], "type": "integer" }, { "enum": [ "none", "chroma", "noodles", "mappingExtensions", "cinema", "v3", "optionalProperties", "vNJS", "vivify", "v3Pepega", "groupLighting", "audioLink", "ignore" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "example": -1 }, "difficultyStatistics": { "allOf": [ { "$ref": "#/components/schemas/DifficultyStatisticsResponse" } ], "nullable": true }, "leaderboardId": { "type": "string" }, "plays": { "type": "integer", "format": "int32" }, "lastScoreTime": { "type": "integer", "format": "int32" }, "attempts": { "type": "integer", "format": "int32" }, "positiveVotes": { "type": "integer", "format": "int32" }, "starVotes": { "type": "integer", "format": "int32" }, "negativeVotes": { "type": "integer", "format": "int32" }, "myScore": { "allOf": [ { "$ref": "#/components/schemas/ScoreResponseWithAcc" } ], "nullable": true }, "applicable": { "type": "boolean" } }, "additionalProperties": false }, "MapDiffResponseBeasties": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "value": { "type": "integer", "format": "int32" }, "mode": { "type": "integer", "format": "int32" }, "difficultyName": { "type": "string" }, "customDifficultyName": { "type": "string", "nullable": true }, "mapVersion": { "type": "string", "nullable": true }, "modeName": { "type": "string" }, "status": { "enum": [ "unranked", "nominated", "qualified", "ranked", "unrankable", "outdated", "inevent", "oST" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/DifficultyStatus" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7 ], "type": "integer" }, { "enum": [ "unranked", "nominated", "qualified", "ranked", "unrankable", "outdated", "inevent", "oST" ], "type": "string" } ], "description": "Represents the difficulty status of a map." }, "modifierValues": { "allOf": [ { "$ref": "#/components/schemas/ModifiersMap" } ], "nullable": true }, "modifiersRating": { "allOf": [ { "$ref": "#/components/schemas/ModifiersRating" } ], "nullable": true }, "nominatedTime": { "type": "integer", "format": "int32" }, "qualifiedTime": { "type": "integer", "format": "int32" }, "rankedTime": { "type": "integer", "format": "int32" }, "speedTags": { "type": "integer", "format": "int32" }, "styleTags": { "type": "integer", "format": "int32" }, "featureTags": { "type": "integer", "format": "int32" }, "stars": { "type": "number", "format": "float", "nullable": true }, "predictedAcc": { "type": "number", "format": "float", "nullable": true }, "passRating": { "type": "number", "format": "float", "nullable": true }, "accRating": { "type": "number", "format": "float", "nullable": true }, "techRating": { "type": "number", "format": "float", "nullable": true }, "multiRating": { "type": "number", "format": "float", "nullable": true }, "type": { "enum": [ "none", "acc", "tech", "midspeed", "speed", "fitbeat", "linear", "bombReset" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/MapTypes" } ], "oneOf": [ { "enum": [ 0, 1, 2, 4, 8, 16, 32, 64 ], "type": "integer" }, { "enum": [ "none", "acc", "tech", "midspeed", "speed", "fitbeat", "linear", "bombReset" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "example": 127 }, "njs": { "type": "number", "format": "float" }, "nps": { "type": "number", "format": "float" }, "linearPercentage": { "type": "number", "format": "float", "nullable": true }, "peakSustainedEBPM": { "type": "number", "format": "float", "nullable": true }, "noteJumpStartBeatOffset": { "type": "number", "format": "float" }, "notes": { "type": "integer", "format": "int32" }, "chains": { "type": "integer", "format": "int32" }, "sliders": { "type": "integer", "format": "int32" }, "bombs": { "type": "integer", "format": "int32" }, "walls": { "type": "integer", "format": "int32" }, "maxScore": { "type": "integer", "format": "int32" }, "duration": { "type": "number", "format": "double" }, "requirements": { "enum": [ "none", "chroma", "noodles", "mappingExtensions", "cinema", "v3", "optionalProperties", "vNJS", "vivify", "v3Pepega", "groupLighting", "audioLink", "ignore" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/Requirements" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, -1 ], "type": "integer" }, { "enum": [ "none", "chroma", "noodles", "mappingExtensions", "cinema", "v3", "optionalProperties", "vNJS", "vivify", "v3Pepega", "groupLighting", "audioLink", "ignore" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "example": -1 }, "difficultyStatistics": { "allOf": [ { "$ref": "#/components/schemas/DifficultyStatisticsResponse" } ], "nullable": true }, "leaderboardId": { "type": "string" }, "plays": { "type": "integer", "format": "int32" }, "lastScoreTime": { "type": "integer", "format": "int32" }, "attempts": { "type": "integer", "format": "int32" }, "positiveVotes": { "type": "integer", "format": "int32" }, "starVotes": { "type": "integer", "format": "int32" }, "negativeVotes": { "type": "integer", "format": "int32" }, "myScore": { "allOf": [ { "$ref": "#/components/schemas/ScoreResponseWithAcc" } ], "nullable": true }, "applicable": { "type": "boolean" }, "nominations": { "type": "array", "items": { "$ref": "#/components/schemas/MapDiffResponseNomination" } } }, "additionalProperties": false }, "MapDiffResponseNomination": { "type": "object", "properties": { "timepost": { "type": "integer", "format": "int32" }, "category": { "type": "string" } }, "additionalProperties": false }, "MapInfoResponse": { "type": "object", "properties": { "id": { "type": "string" }, "difficulties": { "type": "array", "items": { "$ref": "#/components/schemas/MapDiffResponse" } }, "hash": { "type": "string" }, "name": { "type": "string" }, "subName": { "type": "string", "nullable": true }, "author": { "type": "string" }, "mapper": { "type": "string" }, "mappers": { "type": "array", "items": { "$ref": "#/components/schemas/MapperResponse" }, "nullable": true }, "mapperId": { "type": "integer", "format": "int32" }, "collaboratorIds": { "type": "string", "nullable": true }, "coverImage": { "type": "string" }, "fullCoverImage": { "type": "string", "nullable": true }, "downloadUrl": { "type": "string" }, "bpm": { "type": "number", "format": "double" }, "duration": { "type": "number", "format": "double" }, "tags": { "type": "string", "nullable": true }, "uploadTime": { "type": "integer", "format": "int32" }, "externalStatuses": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalStatus" }, "nullable": true } }, "additionalProperties": false }, "MapInfoResponseBeasties": { "type": "object", "properties": { "id": { "type": "string" }, "difficulties": { "type": "array", "items": { "$ref": "#/components/schemas/MapDiffResponseBeasties" } }, "hash": { "type": "string" }, "name": { "type": "string" }, "subName": { "type": "string", "nullable": true }, "author": { "type": "string" }, "mapper": { "type": "string" }, "mappers": { "type": "array", "items": { "$ref": "#/components/schemas/MapperResponse" }, "nullable": true }, "mapperId": { "type": "integer", "format": "int32" }, "collaboratorIds": { "type": "string", "nullable": true }, "coverImage": { "type": "string" }, "fullCoverImage": { "type": "string", "nullable": true }, "downloadUrl": { "type": "string" }, "bpm": { "type": "number", "format": "double" }, "duration": { "type": "number", "format": "double" }, "tags": { "type": "string", "nullable": true }, "uploadTime": { "type": "integer", "format": "int32" }, "externalStatuses": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalStatus" }, "nullable": true } }, "additionalProperties": false }, "MapInfoResponseResponseWithMetadata": { "type": "object", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MapInfoResponse" } } }, "additionalProperties": false }, "MapInfoResponseWithUpvotes": { "type": "object", "properties": { "id": { "type": "string" }, "difficulties": { "type": "array", "items": { "$ref": "#/components/schemas/MapDiffResponse" } }, "hash": { "type": "string" }, "name": { "type": "string" }, "subName": { "type": "string", "nullable": true }, "author": { "type": "string" }, "mapper": { "type": "string" }, "mappers": { "type": "array", "items": { "$ref": "#/components/schemas/MapperResponse" }, "nullable": true }, "mapperId": { "type": "integer", "format": "int32" }, "collaboratorIds": { "type": "string", "nullable": true }, "coverImage": { "type": "string" }, "fullCoverImage": { "type": "string", "nullable": true }, "downloadUrl": { "type": "string" }, "bpm": { "type": "number", "format": "double" }, "duration": { "type": "number", "format": "double" }, "tags": { "type": "string", "nullable": true }, "uploadTime": { "type": "integer", "format": "int32" }, "externalStatuses": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalStatus" }, "nullable": true }, "upvotes": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "MapInfoResponseWithUpvotesResponseWithMetadata": { "type": "object", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MapInfoResponseWithUpvotes" } } }, "additionalProperties": false }, "MapOfTheDay": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "songId": { "type": "string", "nullable": true }, "song": { "allOf": [ { "$ref": "#/components/schemas/Song" } ], "nullable": true }, "leaderboards": { "type": "array", "items": { "$ref": "#/components/schemas/Leaderboard" } }, "timestart": { "type": "integer", "format": "int32" }, "timeend": { "type": "integer", "format": "int32" }, "description": { "type": "string", "nullable": true }, "champions": { "type": "array", "items": { "$ref": "#/components/schemas/EventPlayer" } }, "eventRanking": { "allOf": [ { "$ref": "#/components/schemas/EventRanking" } ], "nullable": true } }, "additionalProperties": false }, "MapOfTheDayPoints": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "points": { "type": "integer", "format": "int32" }, "rank": { "type": "integer", "format": "int32" }, "mapOfTheDay": { "allOf": [ { "$ref": "#/components/schemas/MapOfTheDay" } ] } }, "additionalProperties": false }, "MapQuality": { "enum": [ "good", "ok", "bad" ], "type": "string", "oneOf": [ { "enum": [ 1, 2, 3 ], "type": "integer" }, { "enum": [ "good", "ok", "bad" ], "type": "string" } ], "format": "int32" }, "MapSortBy": { "enum": [ "none", "timestamp", "name", "stars", "passRating", "accRating", "techRating", "scoreTime", "playCount", "voting", "voteCount", "voteRatio", "duration", "attempts", "nJS", "nPS", "bPM", "multiRating", "eBPM", "linearPercentage" ], "type": "string", "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19 ], "type": "integer" }, { "enum": [ "none", "timestamp", "name", "stars", "passRating", "accRating", "techRating", "scoreTime", "playCount", "voting", "voteCount", "voteRatio", "duration", "attempts", "nJS", "nPS", "bPM", "multiRating", "eBPM", "linearPercentage" ], "type": "string" } ], "format": "int32" }, "MapSwingData": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "bpmTime": { "type": "number", "format": "double" }, "direction": { "type": "number", "format": "double" }, "forehand": { "type": "boolean" }, "parityErrors": { "type": "boolean" }, "bombAvoidance": { "type": "boolean" }, "isLinear": { "type": "boolean" }, "angleStrain": { "type": "number", "format": "double" }, "repositioningDistance": { "type": "number", "format": "double" }, "rotationAmount": { "type": "number", "format": "double" }, "swingFrequency": { "type": "number", "format": "double" }, "distanceDiff": { "type": "number", "format": "double" }, "swingSpeed": { "type": "number", "format": "double" }, "hitDistance": { "type": "number", "format": "double" }, "stress": { "type": "number", "format": "double" }, "lowSpeedFalloff": { "type": "number", "format": "double" }, "stressMultiplier": { "type": "number", "format": "double" }, "njsBuff": { "type": "number", "format": "double" }, "wallBuff": { "type": "number", "format": "double" }, "isStream": { "type": "boolean" }, "swingDiff": { "type": "number", "format": "double" }, "swingTech": { "type": "number", "format": "double" }, "difficultyStatisticsId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "MapTypes": { "enum": [ "none", "acc", "tech", "midspeed", "speed", "fitbeat", "linear", "bombReset" ], "type": "string", "oneOf": [ { "enum": [ 0, 1, 2, 4, 8, 16, 32, 64 ], "type": "integer" }, { "enum": [ "none", "acc", "tech", "midspeed", "speed", "fitbeat", "linear", "bombReset" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "format": "int32", "example": 127 }, "Mapper": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 100, "minLength": 0, "type": "string" }, "avatar": { "maxLength": 200, "minLength": 0, "type": "string" }, "curator": { "type": "boolean", "nullable": true }, "verifiedMapper": { "type": "boolean" }, "playlistUrl": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "songs": { "type": "array", "items": { "$ref": "#/components/schemas/Song" }, "nullable": true }, "status": { "enum": [ "none", "verified", "curator", "ranked", "team" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/MapperStatus" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16 ], "type": "integer" }, { "enum": [ "none", "verified", "curator", "ranked", "team" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "example": 30 }, "player": { "allOf": [ { "$ref": "#/components/schemas/Player" } ], "nullable": true } }, "additionalProperties": false }, "MapperResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "playerId": { "type": "string", "nullable": true }, "name": { "type": "string" }, "avatar": { "type": "string" }, "curator": { "type": "boolean", "nullable": true }, "verifiedMapper": { "type": "boolean" }, "status": { "enum": [ "none", "verified", "curator", "ranked", "team" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/MapperStatus" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16 ], "type": "integer" }, { "enum": [ "none", "verified", "curator", "ranked", "team" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "example": 30 } }, "additionalProperties": false }, "MapperSortBy": { "enum": [ "name", "maps", "rankedMaps" ], "type": "string", "oneOf": [ { "enum": [ 0, 1, 2 ], "type": "integer" }, { "enum": [ "name", "maps", "rankedMaps" ], "type": "string" } ], "format": "int32" }, "MapperStatus": { "enum": [ "none", "verified", "curator", "ranked", "team" ], "type": "string", "oneOf": [ { "enum": [ 0, 2, 4, 8, 16 ], "type": "integer" }, { "enum": [ "none", "verified", "curator", "ranked", "team" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "format": "int32", "example": 30 }, "MapsType": { "enum": [ "ranked", "unranked", "all" ], "type": "string", "oneOf": [ { "enum": [ 0, 1, 2 ], "type": "integer" }, { "enum": [ "ranked", "unranked", "all" ], "type": "string" } ], "format": "int32" }, "Metadata": { "type": "object", "properties": { "itemsPerPage": { "type": "integer", "format": "int32" }, "page": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ModifiersMap": { "type": "object", "properties": { "modifierId": { "type": "integer", "format": "int32" }, "da": { "type": "number", "format": "float" }, "fs": { "type": "number", "format": "float" }, "sf": { "type": "number", "format": "float" }, "ss": { "type": "number", "format": "float" }, "gn": { "type": "number", "format": "float" }, "na": { "type": "number", "format": "float" }, "nb": { "type": "number", "format": "float" }, "nf": { "type": "number", "format": "float" }, "no": { "type": "number", "format": "float" }, "pm": { "type": "number", "format": "float" }, "sc": { "type": "number", "format": "float" }, "sa": { "type": "number", "format": "float" }, "op": { "type": "number", "format": "float" }, "ez": { "type": "number", "format": "float" }, "hd": { "type": "number", "format": "float" }, "smc": { "type": "number", "format": "float" }, "ohp": { "type": "number", "format": "float" } }, "additionalProperties": false }, "ModifiersRating": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "ssPeakSustainedEBPM": { "type": "number", "format": "float" }, "ssPredictedAcc": { "type": "number", "format": "float" }, "ssPassRating": { "type": "number", "format": "float" }, "ssAccRating": { "type": "number", "format": "float" }, "ssTechRating": { "type": "number", "format": "float" }, "ssStars": { "type": "number", "format": "float" }, "fsPeakSustainedEBPM": { "type": "number", "format": "float" }, "fsPredictedAcc": { "type": "number", "format": "float" }, "fsPassRating": { "type": "number", "format": "float" }, "fsAccRating": { "type": "number", "format": "float" }, "fsTechRating": { "type": "number", "format": "float" }, "fsStars": { "type": "number", "format": "float" }, "sfPeakSustainedEBPM": { "type": "number", "format": "float" }, "sfPredictedAcc": { "type": "number", "format": "float" }, "sfPassRating": { "type": "number", "format": "float" }, "sfAccRating": { "type": "number", "format": "float" }, "sfTechRating": { "type": "number", "format": "float" }, "sfStars": { "type": "number", "format": "float" }, "bfsPeakSustainedEBPM": { "type": "number", "format": "float" }, "bfsPredictedAcc": { "type": "number", "format": "float" }, "bfsPassRating": { "type": "number", "format": "float" }, "bfsAccRating": { "type": "number", "format": "float" }, "bfsTechRating": { "type": "number", "format": "float" }, "bfsStars": { "type": "number", "format": "float" }, "bsfPeakSustainedEBPM": { "type": "number", "format": "float" }, "bsfPredictedAcc": { "type": "number", "format": "float" }, "bsfPassRating": { "type": "number", "format": "float" }, "bsfAccRating": { "type": "number", "format": "float" }, "bsfTechRating": { "type": "number", "format": "float" }, "bsfStars": { "type": "number", "format": "float" } }, "additionalProperties": false }, "MyType": { "enum": [ "none", "played", "unplayed", "myNominated", "othersNominated", "myMaps" ], "type": "string", "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, { "enum": [ "none", "played", "unplayed", "myNominated", "othersNominated", "myMaps" ], "type": "string" } ], "format": "int32" }, "MyTypeMaps": { "enum": [ "none", "played", "unplayed", "friendsPlayed" ], "type": "string", "oneOf": [ { "enum": [ 0, 1, 2, 3 ], "type": "integer" }, { "enum": [ "none", "played", "unplayed", "friendsPlayed" ], "type": "string" } ], "format": "int32" }, "Operation": { "enum": [ "any", "all", "not" ], "type": "string", "oneOf": [ { "enum": [ 0, 1, 2 ], "type": "integer" }, { "enum": [ "any", "all", "not" ], "type": "string" } ], "format": "int32" }, "Order": { "enum": [ "desc", "asc" ], "type": "string", "oneOf": [ { "enum": [ 0, 1 ], "type": "integer" }, { "enum": [ "desc", "asc" ], "type": "string" } ], "description": "Represents the order in which values will be sorted.", "format": "int32" }, "ParticipatingEventResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" } }, "additionalProperties": false }, "PatreonFeatures": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "bio": { "type": "string" }, "message": { "type": "string" }, "leftSaberColor": { "type": "string" }, "rightSaberColor": { "type": "string" } }, "additionalProperties": false }, "PlayedStatus": { "enum": [ "any", "played", "unplayed" ], "type": "string", "oneOf": [ { "enum": [ 0, 1, 2 ], "type": "integer" }, { "enum": [ "any", "played", "unplayed" ], "type": "string" } ], "format": "int32" }, "Player": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "maxLength": 80, "minLength": 0, "type": "string" }, "platform": { "type": "string" }, "avatar": { "type": "string" }, "webAvatar": { "type": "string" }, "country": { "maxLength": 7, "minLength": 0, "type": "string" }, "alias": { "maxLength": 40, "minLength": 0, "type": "string", "nullable": true }, "oldAlias": { "maxLength": 40, "minLength": 0, "type": "string", "nullable": true }, "role": { "type": "string" }, "mapperId": { "type": "integer", "format": "int32", "nullable": true }, "mapper": { "allOf": [ { "$ref": "#/components/schemas/Mapper" } ], "nullable": true }, "pp": { "type": "number", "format": "float" }, "accPp": { "type": "number", "format": "float" }, "techPp": { "type": "number", "format": "float" }, "passPp": { "type": "number", "format": "float" }, "allContextsPp": { "type": "number", "format": "float" }, "rank": { "type": "integer", "format": "int32" }, "countryRank": { "type": "integer", "format": "int32" }, "level": { "type": "integer", "format": "int32" }, "experience": { "type": "integer", "format": "int32" }, "prestige": { "type": "integer", "format": "int32" }, "lastWeekPp": { "type": "number", "format": "float" }, "lastWeekRank": { "type": "integer", "format": "int32" }, "lastWeekCountryRank": { "type": "integer", "format": "int32" }, "banned": { "type": "boolean" }, "bot": { "type": "boolean" }, "temporary": { "type": "boolean" }, "inactive": { "type": "boolean" }, "externalProfileUrl": { "type": "string" }, "richBioTimeset": { "type": "integer", "format": "int32" }, "createdAt": { "type": "integer", "format": "int32" }, "speedrunStart": { "type": "integer", "format": "int32" }, "scoreStatsId": { "type": "integer", "format": "int32", "nullable": true }, "scoreStats": { "allOf": [ { "$ref": "#/components/schemas/PlayerScoreStats" } ], "nullable": true }, "clanOrder": { "type": "string" }, "badges": { "type": "array", "items": { "$ref": "#/components/schemas/Badge" }, "nullable": true }, "patreonFeatures": { "allOf": [ { "$ref": "#/components/schemas/PatreonFeatures" } ], "nullable": true }, "profileSettings": { "allOf": [ { "$ref": "#/components/schemas/ProfileSettings" } ], "nullable": true }, "changes": { "type": "array", "items": { "$ref": "#/components/schemas/PlayerChange" }, "nullable": true }, "eventsParticipating": { "type": "array", "items": { "$ref": "#/components/schemas/EventPlayer" }, "nullable": true }, "socials": { "type": "array", "items": { "$ref": "#/components/schemas/PlayerSocial" }, "nullable": true }, "achievements": { "type": "array", "items": { "$ref": "#/components/schemas/Achievement" }, "nullable": true }, "earthDayMap": { "allOf": [ { "$ref": "#/components/schemas/EarthDayMap" } ], "nullable": true }, "idolCanvas": { "allOf": [ { "$ref": "#/components/schemas/IdolCanvas" } ], "nullable": true }, "richPresence": { "allOf": [ { "$ref": "#/components/schemas/RichPresence" } ], "nullable": true }, "playerIdolDecorations": { "type": "array", "items": { "$ref": "#/components/schemas/PlayerIdolDecoration" } }, "playerBonusIdols": { "type": "array", "items": { "$ref": "#/components/schemas/PlayerBonusIdol" } } }, "additionalProperties": false }, "PlayerBonusIdol": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "playerId": { "type": "string", "nullable": true }, "player": { "allOf": [ { "$ref": "#/components/schemas/Player" } ], "nullable": true }, "idolDescriptionId": { "type": "integer", "format": "int32" }, "idolDescription": { "allOf": [ { "$ref": "#/components/schemas/IdolDescription" } ] }, "reason": { "type": "string" } }, "additionalProperties": false }, "PlayerChange": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "timestamp": { "type": "integer", "format": "int32" }, "playerId": { "type": "string", "nullable": true }, "oldName": { "type": "string", "nullable": true }, "newName": { "type": "string", "nullable": true }, "oldCountry": { "type": "string", "nullable": true }, "newCountry": { "type": "string", "nullable": true }, "changer": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PlayerContextExtension": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "context": { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/LeaderboardContexts" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 ], "type": "integer" }, { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "example": 2046 }, "pp": { "type": "number", "format": "float" }, "accPp": { "type": "number", "format": "float" }, "techPp": { "type": "number", "format": "float" }, "passPp": { "type": "number", "format": "float" }, "rank": { "type": "integer", "format": "int32" }, "country": { "maxLength": 7, "minLength": 0, "type": "string" }, "countryRank": { "type": "integer", "format": "int32" }, "level": { "type": "integer", "format": "int32" }, "experience": { "type": "integer", "format": "int32" }, "prestige": { "type": "integer", "format": "int32" }, "lastWeekPp": { "type": "number", "format": "float" }, "lastWeekRank": { "type": "integer", "format": "int32" }, "lastWeekCountryRank": { "type": "integer", "format": "int32" }, "name": { "maxLength": 80, "minLength": 0, "type": "string" }, "alias": { "maxLength": 40, "minLength": 0, "type": "string", "nullable": true }, "playerId": { "type": "string" }, "scoreStats": { "allOf": [ { "$ref": "#/components/schemas/PlayerScoreStats" } ], "nullable": true }, "banned": { "type": "boolean" } }, "additionalProperties": false }, "PlayerFollower": { "type": "object", "properties": { "id": { "type": "string" }, "alias": { "type": "string", "nullable": true }, "name": { "type": "string" }, "avatar": { "type": "string" }, "count": { "type": "integer", "format": "int32", "nullable": true }, "mutual": { "type": "boolean" } }, "additionalProperties": false }, "PlayerFollowersInfoResponse": { "type": "object", "properties": { "followingCount": { "type": "integer", "format": "int32", "nullable": true }, "meFollowing": { "type": "boolean" }, "following": { "type": "array", "items": { "type": "string" }, "nullable": true }, "followersCount": { "type": "integer", "format": "int32", "nullable": true }, "iFollow": { "type": "boolean" }, "followers": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "PlayerIdolDecoration": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "playerId": { "type": "string", "nullable": true }, "player": { "allOf": [ { "$ref": "#/components/schemas/Player" } ], "nullable": true }, "idolDecorationId": { "type": "integer", "format": "int32" }, "idolDecoration": { "allOf": [ { "$ref": "#/components/schemas/IdolDecoration" } ] }, "reason": { "type": "string" } }, "additionalProperties": false }, "PlayerResponse": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string" }, "avatar": { "type": "string" }, "country": { "type": "string" }, "alias": { "type": "string", "nullable": true }, "bot": { "type": "boolean" }, "temporary": { "type": "boolean" }, "pp": { "type": "number", "format": "float" }, "rank": { "type": "integer", "format": "int32" }, "countryRank": { "type": "integer", "format": "int32" }, "level": { "type": "integer", "format": "int32" }, "experience": { "type": "integer", "format": "int32" }, "prestige": { "type": "integer", "format": "int32" }, "role": { "type": "string" }, "socials": { "type": "array", "items": { "$ref": "#/components/schemas/PlayerSocial" }, "nullable": true }, "contextExtensions": { "type": "array", "items": { "$ref": "#/components/schemas/PlayerContextExtension" }, "nullable": true }, "patreonFeatures": { "allOf": [ { "$ref": "#/components/schemas/PatreonFeatures" } ], "nullable": true }, "profileSettings": { "allOf": [ { "$ref": "#/components/schemas/ProfileSettings" } ], "nullable": true }, "richPresence": { "allOf": [ { "$ref": "#/components/schemas/RichPresence" } ], "nullable": true }, "clanOrder": { "type": "string" }, "clans": { "type": "array", "items": { "$ref": "#/components/schemas/ClanResponse" }, "nullable": true } }, "additionalProperties": false }, "PlayerResponseClanResponseFullResponseWithMetadataAndContainer": { "type": "object", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PlayerResponse" } }, "container": { "allOf": [ { "$ref": "#/components/schemas/ClanResponseFull" } ], "nullable": true } }, "additionalProperties": false }, "PlayerResponseFull": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string" }, "avatar": { "type": "string" }, "country": { "type": "string" }, "alias": { "type": "string", "nullable": true }, "bot": { "type": "boolean" }, "temporary": { "type": "boolean" }, "pp": { "type": "number", "format": "float" }, "rank": { "type": "integer", "format": "int32" }, "countryRank": { "type": "integer", "format": "int32" }, "level": { "type": "integer", "format": "int32" }, "experience": { "type": "integer", "format": "int32" }, "prestige": { "type": "integer", "format": "int32" }, "role": { "type": "string" }, "socials": { "type": "array", "items": { "$ref": "#/components/schemas/PlayerSocial" }, "nullable": true }, "contextExtensions": { "type": "array", "items": { "$ref": "#/components/schemas/PlayerContextExtension" }, "nullable": true }, "patreonFeatures": { "allOf": [ { "$ref": "#/components/schemas/PatreonFeatures" } ], "nullable": true }, "profileSettings": { "allOf": [ { "$ref": "#/components/schemas/ProfileSettings" } ], "nullable": true }, "richPresence": { "allOf": [ { "$ref": "#/components/schemas/RichPresence" } ], "nullable": true }, "clanOrder": { "type": "string" }, "clans": { "type": "array", "items": { "$ref": "#/components/schemas/ClanResponse" }, "nullable": true }, "accPp": { "type": "number", "format": "float" }, "passPp": { "type": "number", "format": "float" }, "techPp": { "type": "number", "format": "float" }, "allContextsPp": { "type": "number", "format": "float" }, "scoreStats": { "allOf": [ { "$ref": "#/components/schemas/PlayerScoreStats" } ], "nullable": true }, "lastWeekPp": { "type": "number", "format": "float" }, "lastWeekRank": { "type": "integer", "format": "int32" }, "lastWeekCountryRank": { "type": "integer", "format": "int32" }, "extensionId": { "type": "integer", "format": "int32" }, "mapperId": { "type": "integer", "format": "int32" }, "banned": { "type": "boolean" }, "inactive": { "type": "boolean" }, "banDescription": { "allOf": [ { "$ref": "#/components/schemas/Ban" } ], "nullable": true }, "externalProfileUrl": { "type": "string" }, "richBioTimeset": { "type": "integer", "format": "int32" }, "speedrunStart": { "type": "integer", "format": "int32" }, "linkedIds": { "allOf": [ { "$ref": "#/components/schemas/LinkResponse" } ], "nullable": true }, "history": { "type": "array", "items": { "$ref": "#/components/schemas/PlayerScoreStatsHistory" }, "nullable": true }, "badges": { "type": "array", "items": { "$ref": "#/components/schemas/Badge" }, "nullable": true }, "pinnedScores": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreResponseWithMyScore" }, "nullable": true }, "changes": { "type": "array", "items": { "$ref": "#/components/schemas/PlayerChange" }, "nullable": true } }, "additionalProperties": false }, "PlayerResponseWithStats": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string" }, "avatar": { "type": "string" }, "country": { "type": "string" }, "alias": { "type": "string", "nullable": true }, "bot": { "type": "boolean" }, "temporary": { "type": "boolean" }, "pp": { "type": "number", "format": "float" }, "rank": { "type": "integer", "format": "int32" }, "countryRank": { "type": "integer", "format": "int32" }, "level": { "type": "integer", "format": "int32" }, "experience": { "type": "integer", "format": "int32" }, "prestige": { "type": "integer", "format": "int32" }, "role": { "type": "string" }, "socials": { "type": "array", "items": { "$ref": "#/components/schemas/PlayerSocial" }, "nullable": true }, "contextExtensions": { "type": "array", "items": { "$ref": "#/components/schemas/PlayerContextExtension" }, "nullable": true }, "patreonFeatures": { "allOf": [ { "$ref": "#/components/schemas/PatreonFeatures" } ], "nullable": true }, "profileSettings": { "allOf": [ { "$ref": "#/components/schemas/ProfileSettings" } ], "nullable": true }, "richPresence": { "allOf": [ { "$ref": "#/components/schemas/RichPresence" } ], "nullable": true }, "clanOrder": { "type": "string" }, "clans": { "type": "array", "items": { "$ref": "#/components/schemas/ClanResponse" }, "nullable": true }, "accPp": { "type": "number", "format": "float" }, "passPp": { "type": "number", "format": "float" }, "techPp": { "type": "number", "format": "float" }, "allContextsPp": { "type": "number", "format": "float" }, "scoreStats": { "allOf": [ { "$ref": "#/components/schemas/PlayerScoreStats" } ], "nullable": true }, "lastWeekPp": { "type": "number", "format": "float" }, "lastWeekRank": { "type": "integer", "format": "int32" }, "lastWeekCountryRank": { "type": "integer", "format": "int32" }, "extensionId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PlayerResponseWithStatsResponseWithMetadata": { "type": "object", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PlayerResponseWithStats" } } }, "additionalProperties": false }, "PlayerScoreStats": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "totalScore": { "type": "integer", "format": "int64" }, "totalUnrankedScore": { "type": "integer", "format": "int64" }, "totalRankedScore": { "type": "integer", "format": "int64" }, "firstScoreTime": { "type": "integer", "format": "int32" }, "firstUnrankedScoreTime": { "type": "integer", "format": "int32" }, "firstRankedScoreTime": { "type": "integer", "format": "int32" }, "lastScoreTime": { "type": "integer", "format": "int32" }, "lastUnrankedScoreTime": { "type": "integer", "format": "int32" }, "lastRankedScoreTime": { "type": "integer", "format": "int32" }, "averageRankedAccuracy": { "type": "number", "format": "float" }, "averageWeightedRankedAccuracy": { "type": "number", "format": "float" }, "averageUnrankedAccuracy": { "type": "number", "format": "float" }, "averageAccuracy": { "type": "number", "format": "float" }, "medianRankedAccuracy": { "type": "number", "format": "float" }, "medianAccuracy": { "type": "number", "format": "float" }, "topRankedAccuracy": { "type": "number", "format": "float" }, "topUnrankedAccuracy": { "type": "number", "format": "float" }, "topAccuracy": { "type": "number", "format": "float" }, "topPp": { "type": "number", "format": "float" }, "topBonusPP": { "type": "number", "format": "float" }, "topPassPP": { "type": "number", "format": "float" }, "topAccPP": { "type": "number", "format": "float" }, "topTechPP": { "type": "number", "format": "float" }, "peakRank": { "type": "number", "format": "float" }, "rankedMaxStreak": { "type": "integer", "format": "int32" }, "unrankedMaxStreak": { "type": "integer", "format": "int32" }, "maxStreak": { "type": "integer", "format": "int32" }, "averageLeftTiming": { "type": "number", "format": "float" }, "averageRightTiming": { "type": "number", "format": "float" }, "steamPlaytime2Weeks": { "type": "integer", "format": "int32" }, "steamPlaytimeForever": { "type": "integer", "format": "int32" }, "scorePlaytime": { "type": "number", "format": "double" }, "rankedPlayCount": { "type": "integer", "format": "int32" }, "unrankedPlayCount": { "type": "integer", "format": "int32" }, "totalPlayCount": { "type": "integer", "format": "int32" }, "rankedImprovementsCount": { "type": "integer", "format": "int32" }, "unrankedImprovementsCount": { "type": "integer", "format": "int32" }, "totalImprovementsCount": { "type": "integer", "format": "int32" }, "rankedTop1Count": { "type": "integer", "format": "int32" }, "unrankedTop1Count": { "type": "integer", "format": "int32" }, "top1Count": { "type": "integer", "format": "int32" }, "rankedTop1Score": { "type": "integer", "format": "int32" }, "unrankedTop1Score": { "type": "integer", "format": "int32" }, "top1Score": { "type": "integer", "format": "int32" }, "averageRankedRank": { "type": "number", "format": "float" }, "averageWeightedRankedRank": { "type": "number", "format": "float" }, "averageUnrankedRank": { "type": "number", "format": "float" }, "averageRank": { "type": "number", "format": "float" }, "sspPlays": { "type": "integer", "format": "int32" }, "ssPlays": { "type": "integer", "format": "int32" }, "spPlays": { "type": "integer", "format": "int32" }, "sPlays": { "type": "integer", "format": "int32" }, "aPlays": { "type": "integer", "format": "int32" }, "topPlatform": { "type": "string" }, "topHMD": { "enum": [ "unknown", "rift", "vive", "vivePro", "wmr", "riftS", "quest", "picoNeo3", "picoNeo2", "vivePro2", "viveElite", "miramar", "pimax8k", "pimax5k", "pimaxArtisan", "hpReverb", "samsungWmr", "qiyuDream", "disco", "lenovoExplorer", "acerWmr", "viveFocus", "arpara", "dellVisor", "e3", "viveDvt", "glasses20", "hedy", "vaporeon", "huaweivr", "asusWmr", "cloudxr", "vridge", "medion", "picoNeo4", "questPro", "pimaxCrystal", "e4", "index", "controllable", "bigscreenbeyond", "nolosonic", "hypereal", "varjoaero", "psvr2", "megane1", "varjoxr3", "meganexsuperlight", "somniumvr1", "viveCosmos", "quest2", "quest3", "quest3s" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/HMD" } ], "oneOf": [ { "enum": [ 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 ], "type": "integer" }, { "enum": [ "unknown", "rift", "vive", "vivePro", "wmr", "riftS", "quest", "picoNeo3", "picoNeo2", "vivePro2", "viveElite", "miramar", "pimax8k", "pimax5k", "pimaxArtisan", "hpReverb", "samsungWmr", "qiyuDream", "disco", "lenovoExplorer", "acerWmr", "viveFocus", "arpara", "dellVisor", "e3", "viveDvt", "glasses20", "hedy", "vaporeon", "huaweivr", "asusWmr", "cloudxr", "vridge", "medion", "picoNeo4", "questPro", "pimaxCrystal", "e4", "index", "controllable", "bigscreenbeyond", "nolosonic", "hypereal", "varjoaero", "psvr2", "megane1", "varjoxr3", "meganexsuperlight", "somniumvr1", "viveCosmos", "quest2", "quest3", "quest3s" ], "type": "string" } ] }, "allHMDs": { "maxLength": 50, "minLength": 0, "type": "string" }, "topPercentile": { "type": "number", "format": "float" }, "countryTopPercentile": { "type": "number", "format": "float" }, "dailyImprovements": { "type": "integer", "format": "int32" }, "authorizedReplayWatched": { "type": "integer", "format": "int32" }, "anonimusReplayWatched": { "type": "integer", "format": "int32" }, "replaysWatched": { "type": "integer", "format": "int32" }, "watchedReplays": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PlayerScoreStatsHistory": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "context": { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/LeaderboardContexts" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 ], "type": "integer" }, { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "example": 2046 }, "timestamp": { "type": "integer", "format": "int32" }, "playerId": { "maxLength": 25, "minLength": 0, "type": "string" }, "pp": { "type": "number", "format": "float" }, "accPp": { "type": "number", "format": "float" }, "passPp": { "type": "number", "format": "float" }, "techPp": { "type": "number", "format": "float" }, "rank": { "type": "integer", "format": "int32" }, "countryRank": { "type": "integer", "format": "int32" }, "totalScore": { "type": "integer", "format": "int64" }, "totalUnrankedScore": { "type": "integer", "format": "int64" }, "totalRankedScore": { "type": "integer", "format": "int64" }, "lastScoreTime": { "type": "integer", "format": "int32" }, "lastUnrankedScoreTime": { "type": "integer", "format": "int32" }, "lastRankedScoreTime": { "type": "integer", "format": "int32" }, "averageRankedAccuracy": { "type": "number", "format": "float" }, "averageWeightedRankedAccuracy": { "type": "number", "format": "float" }, "averageUnrankedAccuracy": { "type": "number", "format": "float" }, "averageAccuracy": { "type": "number", "format": "float" }, "medianRankedAccuracy": { "type": "number", "format": "float" }, "medianAccuracy": { "type": "number", "format": "float" }, "topRankedAccuracy": { "type": "number", "format": "float" }, "topUnrankedAccuracy": { "type": "number", "format": "float" }, "topAccuracy": { "type": "number", "format": "float" }, "topPp": { "type": "number", "format": "float" }, "topBonusPP": { "type": "number", "format": "float" }, "peakRank": { "type": "number", "format": "float" }, "maxStreak": { "type": "integer", "format": "int32" }, "averageLeftTiming": { "type": "number", "format": "float" }, "averageRightTiming": { "type": "number", "format": "float" }, "steamPlaytime2Weeks": { "type": "integer", "format": "int32" }, "steamPlaytimeForever": { "type": "integer", "format": "int32" }, "scorePlaytime": { "type": "number", "format": "double" }, "rankedPlayCount": { "type": "integer", "format": "int32" }, "unrankedPlayCount": { "type": "integer", "format": "int32" }, "totalPlayCount": { "type": "integer", "format": "int32" }, "rankedImprovementsCount": { "type": "integer", "format": "int32" }, "unrankedImprovementsCount": { "type": "integer", "format": "int32" }, "totalImprovementsCount": { "type": "integer", "format": "int32" }, "averageRankedRank": { "type": "number", "format": "float" }, "averageWeightedRankedRank": { "type": "number", "format": "float" }, "averageUnrankedRank": { "type": "number", "format": "float" }, "averageRank": { "type": "number", "format": "float" }, "sspPlays": { "type": "integer", "format": "int32" }, "ssPlays": { "type": "integer", "format": "int32" }, "spPlays": { "type": "integer", "format": "int32" }, "sPlays": { "type": "integer", "format": "int32" }, "aPlays": { "type": "integer", "format": "int32" }, "topPlatform": { "maxLength": 50, "minLength": 0, "type": "string" }, "topHMD": { "enum": [ "unknown", "rift", "vive", "vivePro", "wmr", "riftS", "quest", "picoNeo3", "picoNeo2", "vivePro2", "viveElite", "miramar", "pimax8k", "pimax5k", "pimaxArtisan", "hpReverb", "samsungWmr", "qiyuDream", "disco", "lenovoExplorer", "acerWmr", "viveFocus", "arpara", "dellVisor", "e3", "viveDvt", "glasses20", "hedy", "vaporeon", "huaweivr", "asusWmr", "cloudxr", "vridge", "medion", "picoNeo4", "questPro", "pimaxCrystal", "e4", "index", "controllable", "bigscreenbeyond", "nolosonic", "hypereal", "varjoaero", "psvr2", "megane1", "varjoxr3", "meganexsuperlight", "somniumvr1", "viveCosmos", "quest2", "quest3", "quest3s" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/HMD" } ], "oneOf": [ { "enum": [ 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 ], "type": "integer" }, { "enum": [ "unknown", "rift", "vive", "vivePro", "wmr", "riftS", "quest", "picoNeo3", "picoNeo2", "vivePro2", "viveElite", "miramar", "pimax8k", "pimax5k", "pimaxArtisan", "hpReverb", "samsungWmr", "qiyuDream", "disco", "lenovoExplorer", "acerWmr", "viveFocus", "arpara", "dellVisor", "e3", "viveDvt", "glasses20", "hedy", "vaporeon", "huaweivr", "asusWmr", "cloudxr", "vridge", "medion", "picoNeo4", "questPro", "pimaxCrystal", "e4", "index", "controllable", "bigscreenbeyond", "nolosonic", "hypereal", "varjoaero", "psvr2", "megane1", "varjoxr3", "meganexsuperlight", "somniumvr1", "viveCosmos", "quest2", "quest3", "quest3s" ], "type": "string" } ] }, "dailyImprovements": { "type": "integer", "format": "int32" }, "replaysWatched": { "type": "integer", "format": "int32" }, "watchedReplays": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PlayerSocial": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "service": { "type": "string" }, "link": { "type": "string" }, "user": { "type": "string" }, "userId": { "type": "string" }, "playerId": { "type": "string", "nullable": true }, "hidden": { "type": "boolean" } }, "additionalProperties": false }, "PlayerSortBy": { "enum": [ "pp", "topPp", "name", "rank", "acc", "weightedAcc", "top1Count", "top1Score", "weightedRank", "topAcc", "hmd", "playCount", "score", "lastplay", "maxStreak", "replaysWatched", "dailyImprovements", "timing", "allContextsPp", "level", "prestige", "experience", "scorePlaytime", "steamPlaytime", "steamPlaytime2Weeks" ], "type": "string", "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24 ], "type": "integer" }, { "enum": [ "pp", "topPp", "name", "rank", "acc", "weightedAcc", "top1Count", "top1Score", "weightedRank", "topAcc", "hmd", "playCount", "score", "lastplay", "maxStreak", "replaysWatched", "dailyImprovements", "timing", "allContextsPp", "level", "prestige", "experience", "scorePlaytime", "steamPlaytime", "steamPlaytime2Weeks" ], "type": "string" } ], "format": "int32" }, "PlaylistDifficulty": { "type": "object", "properties": { "name": { "type": "string" }, "characteristic": { "type": "string" } }, "additionalProperties": false }, "PlaylistResponse": { "type": "object", "properties": { "songs": { "type": "array", "items": { "$ref": "#/components/schemas/PlaylistSong" } } }, "additionalProperties": false }, "PlaylistSong": { "type": "object", "properties": { "hash": { "type": "string", "nullable": true }, "key": { "type": "string", "nullable": true }, "songName": { "type": "string", "nullable": true }, "levelAuthorName": { "type": "string", "nullable": true }, "difficulties": { "type": "array", "items": { "$ref": "#/components/schemas/PlaylistDifficulty" }, "nullable": true } }, "additionalProperties": false }, "PpType": { "enum": [ "general", "acc", "pass", "tech" ], "type": "string", "oneOf": [ { "enum": [ 0, 1, 2, 3 ], "type": "integer" }, { "enum": [ "general", "acc", "pass", "tech" ], "type": "string" } ], "format": "int32" }, "PrestiegeLevel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "level": { "type": "integer", "format": "int32" }, "bigIcon": { "type": "string" }, "smallIcon": { "type": "string" }, "color": { "type": "string" }, "prestigeAnimationLink": { "type": "string" } }, "additionalProperties": false }, "ProfileSettings": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "bio": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "effectName": { "type": "string", "nullable": true }, "profileAppearance": { "type": "string", "nullable": true }, "hue": { "type": "number", "format": "float", "nullable": true }, "saturation": { "type": "number", "format": "float", "nullable": true }, "leftSaberColor": { "type": "string", "nullable": true }, "rightSaberColor": { "type": "string", "nullable": true }, "profileCover": { "type": "string", "nullable": true }, "starredFriends": { "type": "string", "nullable": true }, "horizontalRichBio": { "type": "boolean" }, "rankedMapperSort": { "type": "string", "nullable": true }, "showBots": { "type": "boolean" }, "showAllRatings": { "type": "boolean" }, "showExplicitCovers": { "type": "boolean" }, "showStatsPublic": { "type": "boolean" }, "showStatsPublicPinned": { "type": "boolean" }, "richPresenceEnabled": { "type": "boolean" }, "streamingViewPermissions": { "enum": [ "private", "friends", "public" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ReplayStreaming" } ], "oneOf": [ { "enum": [ 0, 1, 2 ], "type": "integer" }, { "enum": [ "private", "friends", "public" ], "type": "string" } ] }, "streamingCommentPermissions": { "enum": [ "private", "friends", "public" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ReplayStreaming" } ], "oneOf": [ { "enum": [ 0, 1, 2 ], "type": "integer" }, { "enum": [ "private", "friends", "public" ], "type": "string" } ] } }, "additionalProperties": false }, "QualificationChange": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "timeset": { "type": "integer", "format": "int32" }, "playerId": { "type": "string" }, "oldRankability": { "type": "number", "format": "float" }, "oldStars": { "type": "number", "format": "float" }, "oldAccRating": { "type": "number", "format": "float" }, "oldPassRating": { "type": "number", "format": "float" }, "oldTechRating": { "type": "number", "format": "float" }, "oldType": { "type": "integer", "format": "int32" }, "oldCriteriaMet": { "type": "integer", "format": "int32" }, "oldCriteriaCommentary": { "type": "string", "nullable": true }, "oldModifiers": { "allOf": [ { "$ref": "#/components/schemas/ModifiersMap" } ], "nullable": true }, "newRankability": { "type": "number", "format": "float" }, "newStars": { "type": "number", "format": "float" }, "newAccRating": { "type": "number", "format": "float" }, "newPassRating": { "type": "number", "format": "float" }, "newTechRating": { "type": "number", "format": "float" }, "newType": { "type": "integer", "format": "int32" }, "newCriteriaMet": { "type": "integer", "format": "int32" }, "newCriteriaCommentary": { "type": "string", "nullable": true }, "newModifiers": { "allOf": [ { "$ref": "#/components/schemas/ModifiersMap" } ], "nullable": true } }, "additionalProperties": false }, "QualificationCommentary": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "playerId": { "type": "string" }, "timeset": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "editTimeset": { "type": "integer", "format": "int32", "nullable": true }, "edited": { "type": "boolean" }, "rankQualificationId": { "type": "integer", "format": "int32", "nullable": true }, "discordMessageId": { "type": "string" } }, "additionalProperties": false }, "QualificationVote": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "playerId": { "type": "string" }, "timeset": { "type": "integer", "format": "int32" }, "value": { "enum": [ "good", "ok", "bad" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/MapQuality" } ], "oneOf": [ { "enum": [ 1, 2, 3 ], "type": "integer" }, { "enum": [ "good", "ok", "bad" ], "type": "string" } ] }, "editTimeset": { "type": "integer", "format": "int32", "nullable": true }, "edited": { "type": "boolean" }, "rankQualificationId": { "type": "integer", "format": "int32", "nullable": true }, "discordRTMessageId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RankQualification": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "timeset": { "type": "integer", "format": "int32" }, "rtMember": { "type": "string" }, "criteriaTimeset": { "type": "integer", "format": "int32" }, "criteriaMet": { "type": "integer", "format": "int32" }, "criteriaChecker": { "type": "string", "nullable": true }, "criteriaCommentary": { "type": "string", "nullable": true }, "mapperAllowed": { "type": "boolean" }, "mapperId": { "type": "string", "nullable": true }, "mapperQualification": { "type": "boolean" }, "approvalTimeset": { "type": "integer", "format": "int32" }, "approved": { "type": "boolean" }, "approvers": { "type": "string", "nullable": true }, "criteriaCheck": { "type": "string", "nullable": true }, "modifiers": { "allOf": [ { "$ref": "#/components/schemas/ModifiersMap" } ], "nullable": true }, "modifiersRating": { "allOf": [ { "$ref": "#/components/schemas/ModifiersRating" } ], "nullable": true }, "changes": { "type": "array", "items": { "$ref": "#/components/schemas/QualificationChange" }, "nullable": true }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/QualificationCommentary" }, "nullable": true }, "criteriaComments": { "type": "array", "items": { "$ref": "#/components/schemas/CriteriaCommentary" }, "nullable": true }, "qualityVote": { "type": "integer", "format": "int32" }, "votes": { "type": "array", "items": { "$ref": "#/components/schemas/QualificationVote" }, "nullable": true }, "discordChannelId": { "type": "string" }, "discordRTChannelId": { "type": "string" } }, "additionalProperties": false }, "RankUpdate": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "timeset": { "type": "integer", "format": "int32" }, "rtMember": { "type": "string" }, "keep": { "type": "boolean" }, "stars": { "type": "number", "format": "float" }, "passRating": { "type": "number", "format": "float" }, "techRating": { "type": "number", "format": "float" }, "predictedAcc": { "type": "number", "format": "float" }, "type": { "enum": [ "none", "acc", "tech", "midspeed", "speed", "fitbeat", "linear", "bombReset" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/MapTypes" } ], "oneOf": [ { "enum": [ 0, 1, 2, 4, 8, 16, 32, 64 ], "type": "integer" }, { "enum": [ "none", "acc", "tech", "midspeed", "speed", "fitbeat", "linear", "bombReset" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "example": 127 }, "criteriaMet": { "type": "integer", "format": "int32" }, "criteriaCommentary": { "type": "string", "nullable": true }, "finished": { "type": "boolean" }, "modifiers": { "allOf": [ { "$ref": "#/components/schemas/ModifiersMap" } ] }, "modifiersRating": { "allOf": [ { "$ref": "#/components/schemas/ModifiersRating" } ], "nullable": true }, "changes": { "type": "array", "items": { "$ref": "#/components/schemas/RankUpdateChange" }, "nullable": true } }, "additionalProperties": false }, "RankUpdateChange": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "timeset": { "type": "integer", "format": "int32" }, "playerId": { "type": "string" }, "oldKeep": { "type": "boolean" }, "oldStars": { "type": "number", "format": "float" }, "oldType": { "enum": [ "none", "acc", "tech", "midspeed", "speed", "fitbeat", "linear", "bombReset" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/MapTypes" } ], "oneOf": [ { "enum": [ 0, 1, 2, 4, 8, 16, 32, 64 ], "type": "integer" }, { "enum": [ "none", "acc", "tech", "midspeed", "speed", "fitbeat", "linear", "bombReset" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "example": 127 }, "oldCriteriaMet": { "type": "integer", "format": "int32" }, "oldCriteriaCommentary": { "type": "string", "nullable": true }, "oldModifiers": { "allOf": [ { "$ref": "#/components/schemas/ModifiersMap" } ], "nullable": true }, "newKeep": { "type": "boolean" }, "newStars": { "type": "number", "format": "float" }, "newType": { "enum": [ "none", "acc", "tech", "midspeed", "speed", "fitbeat", "linear", "bombReset" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/MapTypes" } ], "oneOf": [ { "enum": [ 0, 1, 2, 4, 8, 16, 32, 64 ], "type": "integer" }, { "enum": [ "none", "acc", "tech", "midspeed", "speed", "fitbeat", "linear", "bombReset" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "example": 127 }, "newCriteriaMet": { "type": "integer", "format": "int32" }, "newCriteriaCommentary": { "type": "string", "nullable": true }, "newModifiers": { "allOf": [ { "$ref": "#/components/schemas/ModifiersMap" } ], "nullable": true } }, "additionalProperties": false }, "RankVoting": { "type": "object", "properties": { "scoreId": { "type": "integer", "format": "int32" }, "playerId": { "type": "string" }, "hash": { "type": "string" }, "diff": { "type": "string" }, "mode": { "type": "string" }, "rankability": { "type": "number", "format": "float" }, "stars": { "type": "number", "format": "float" }, "type": { "type": "integer", "format": "int32" }, "timeset": { "type": "integer", "format": "int32" }, "leaderboardId": { "type": "string", "nullable": true }, "favoriteMap": { "allOf": [ { "$ref": "#/components/schemas/FavoriteMap" } ], "nullable": true }, "feedbacks": { "type": "array", "items": { "$ref": "#/components/schemas/VoterFeedback" }, "nullable": true } }, "additionalProperties": false }, "RankedMap": { "type": "object", "properties": { "name": { "type": "string" }, "songId": { "type": "string" }, "cover": { "type": "string" }, "stars": { "type": "number", "format": "float", "nullable": true } }, "additionalProperties": false }, "RankedMapperResponse": { "type": "object", "properties": { "playersCount": { "type": "integer", "format": "int32" }, "totalPp": { "type": "number", "format": "float" }, "maps": { "type": "array", "items": { "$ref": "#/components/schemas/RankedMap" } }, "totalMapCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ReplayOffsets": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "frames": { "type": "integer", "format": "int32" }, "notes": { "type": "integer", "format": "int32" }, "walls": { "type": "integer", "format": "int32" }, "heights": { "type": "integer", "format": "int32" }, "pauses": { "type": "integer", "format": "int32" }, "saberOffsets": { "type": "integer", "format": "int32" }, "customData": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ReplayStreaming": { "enum": [ "private", "friends", "public" ], "type": "string", "oneOf": [ { "enum": [ 0, 1, 2 ], "type": "integer" }, { "enum": [ "private", "friends", "public" ], "type": "string" } ], "format": "int32" }, "Requirements": { "enum": [ "none", "chroma", "noodles", "mappingExtensions", "cinema", "v3", "optionalProperties", "vNJS", "vivify", "v3Pepega", "groupLighting", "audioLink", "ignore" ], "type": "string", "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, -1 ], "type": "integer" }, { "enum": [ "none", "chroma", "noodles", "mappingExtensions", "cinema", "v3", "optionalProperties", "vNJS", "vivify", "v3Pepega", "groupLighting", "audioLink", "ignore" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "format": "int32", "example": -1 }, "RichPresence": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "activityStatus": { "enum": [ "offline", "online", "playing" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/RichPresenceActivityStatus" } ], "oneOf": [ { "enum": [ 0, 1, 2 ], "type": "integer" }, { "enum": [ "offline", "online", "playing" ], "type": "string" } ] } }, "additionalProperties": false }, "RichPresenceActivityStatus": { "enum": [ "offline", "online", "playing" ], "type": "string", "oneOf": [ { "enum": [ 0, 1, 2 ], "type": "integer" }, { "enum": [ "offline", "online", "playing" ], "type": "string" } ], "format": "int32" }, "ScoreFilterStatus": { "enum": [ "none", "suspicious" ], "type": "string", "oneOf": [ { "enum": [ 0, 1 ], "type": "integer" }, { "enum": [ "none", "suspicious" ], "type": "string" } ], "format": "int32" }, "ScoreGraphEntry": { "type": "object", "properties": { "playerId": { "type": "string" }, "weight": { "type": "number", "format": "float" }, "rank": { "type": "integer", "format": "int32" }, "timepost": { "type": "integer", "format": "int32" }, "pauses": { "type": "integer", "format": "int32" }, "maxStreak": { "type": "integer", "format": "int32", "nullable": true }, "mistakes": { "type": "integer", "format": "int32" }, "modifiers": { "type": "string" }, "playerRank": { "type": "integer", "format": "int32" }, "playerName": { "type": "string" }, "playerAvatar": { "type": "string" }, "playerAlias": { "type": "string" }, "accuracy": { "type": "number", "format": "float" }, "pp": { "type": "number", "format": "float" } }, "additionalProperties": false }, "ScoreImprovement": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "timeset": { "type": "string" }, "score": { "type": "integer", "format": "int32" }, "accuracy": { "type": "number", "format": "float" }, "pp": { "type": "number", "format": "float" }, "bonusPp": { "type": "number", "format": "float" }, "rank": { "type": "integer", "format": "int32" }, "accRight": { "type": "number", "format": "float" }, "accLeft": { "type": "number", "format": "float" }, "averageRankedAccuracy": { "type": "number", "format": "float" }, "totalPp": { "type": "number", "format": "float" }, "totalRank": { "type": "integer", "format": "int32" }, "badCuts": { "type": "integer", "format": "int32" }, "missedNotes": { "type": "integer", "format": "int32" }, "bombCuts": { "type": "integer", "format": "int32" }, "wallsHit": { "type": "integer", "format": "int32" }, "pauses": { "type": "integer", "format": "int32" }, "modifiers": { "maxLength": 50, "minLength": 0, "type": "string" } }, "additionalProperties": false }, "ScoreMetadata": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "pinnedContexts": { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/LeaderboardContexts" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 ], "type": "integer" }, { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "example": 2046 }, "highlightedInfo": { "enum": [ "none", "watchCount", "playCount" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/InfoToHighlight" } ], "oneOf": [ { "enum": [ 0, 2, 4 ], "type": "integer" }, { "enum": [ "none", "watchCount", "playCount" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "example": 6 }, "priority": { "type": "integer", "format": "int32" }, "description": { "type": "string", "nullable": true }, "linkService": { "type": "string", "nullable": true }, "linkServiceIcon": { "type": "string", "nullable": true }, "link": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ScoreResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "baseScore": { "type": "integer", "format": "int32" }, "modifiedScore": { "type": "integer", "format": "int32" }, "accuracy": { "type": "number", "format": "float" }, "playerId": { "type": "string" }, "pp": { "type": "number", "format": "float" }, "withPp": { "type": "boolean" }, "bonusPp": { "type": "number", "format": "float" }, "passPP": { "type": "number", "format": "float" }, "accPP": { "type": "number", "format": "float" }, "techPP": { "type": "number", "format": "float" }, "rank": { "type": "integer", "format": "int32" }, "responseRank": { "type": "integer", "format": "int32" }, "country": { "type": "string", "nullable": true }, "fcAccuracy": { "type": "number", "format": "float" }, "fcPp": { "type": "number", "format": "float" }, "weight": { "type": "number", "format": "float" }, "replay": { "type": "string" }, "modifiers": { "type": "string" }, "badCuts": { "type": "integer", "format": "int32" }, "missedNotes": { "type": "integer", "format": "int32" }, "bombCuts": { "type": "integer", "format": "int32" }, "wallsHit": { "type": "integer", "format": "int32" }, "pauses": { "type": "integer", "format": "int32" }, "fullCombo": { "type": "boolean" }, "platform": { "type": "string" }, "maxCombo": { "type": "integer", "format": "int32" }, "maxStreak": { "type": "integer", "format": "int32", "nullable": true }, "hmd": { "enum": [ "unknown", "rift", "vive", "vivePro", "wmr", "riftS", "quest", "picoNeo3", "picoNeo2", "vivePro2", "viveElite", "miramar", "pimax8k", "pimax5k", "pimaxArtisan", "hpReverb", "samsungWmr", "qiyuDream", "disco", "lenovoExplorer", "acerWmr", "viveFocus", "arpara", "dellVisor", "e3", "viveDvt", "glasses20", "hedy", "vaporeon", "huaweivr", "asusWmr", "cloudxr", "vridge", "medion", "picoNeo4", "questPro", "pimaxCrystal", "e4", "index", "controllable", "bigscreenbeyond", "nolosonic", "hypereal", "varjoaero", "psvr2", "megane1", "varjoxr3", "meganexsuperlight", "somniumvr1", "viveCosmos", "quest2", "quest3", "quest3s" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/HMD" } ], "oneOf": [ { "enum": [ 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 ], "type": "integer" }, { "enum": [ "unknown", "rift", "vive", "vivePro", "wmr", "riftS", "quest", "picoNeo3", "picoNeo2", "vivePro2", "viveElite", "miramar", "pimax8k", "pimax5k", "pimaxArtisan", "hpReverb", "samsungWmr", "qiyuDream", "disco", "lenovoExplorer", "acerWmr", "viveFocus", "arpara", "dellVisor", "e3", "viveDvt", "glasses20", "hedy", "vaporeon", "huaweivr", "asusWmr", "cloudxr", "vridge", "medion", "picoNeo4", "questPro", "pimaxCrystal", "e4", "index", "controllable", "bigscreenbeyond", "nolosonic", "hypereal", "varjoaero", "psvr2", "megane1", "varjoxr3", "meganexsuperlight", "somniumvr1", "viveCosmos", "quest2", "quest3", "quest3s" ], "type": "string" } ] }, "controller": { "enum": [ "unknown", "oculustouch", "vive", "vivePro", "wmr", "odyssey", "hpMotion", "oculustouch2", "picoNeo3", "picoNeo2", "vivePro2", "miramar", "disco", "questPro", "viveTracker", "viveTracker2", "knuckles", "nolo", "picophoenix", "hands", "viveTracker3", "pimax", "huawei", "polaris", "tundra", "cry", "e4", "gamepad", "joycon", "steamdeck", "etee", "quest3", "contactglove", "playstationSense", "viveCosmos", "quest2" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ControllerEnum" } ], "oneOf": [ { "enum": [ 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 ], "type": "integer" }, { "enum": [ "unknown", "oculustouch", "vive", "vivePro", "wmr", "odyssey", "hpMotion", "oculustouch2", "picoNeo3", "picoNeo2", "vivePro2", "miramar", "disco", "questPro", "viveTracker", "viveTracker2", "knuckles", "nolo", "picophoenix", "hands", "viveTracker3", "pimax", "huawei", "polaris", "tundra", "cry", "e4", "gamepad", "joycon", "steamdeck", "etee", "quest3", "contactglove", "playstationSense", "viveCosmos", "quest2" ], "type": "string" } ] }, "leaderboardId": { "type": "string" }, "timeset": { "type": "string" }, "timepost": { "type": "integer", "format": "int32" }, "replaysWatched": { "type": "integer", "format": "int32" }, "playCount": { "type": "integer", "format": "int32" }, "lastTryTime": { "type": "integer", "format": "int32" }, "priority": { "type": "integer", "format": "int32" }, "originalId": { "type": "integer", "format": "int32" }, "player": { "allOf": [ { "$ref": "#/components/schemas/PlayerResponse" } ], "nullable": true }, "scoreImprovement": { "allOf": [ { "$ref": "#/components/schemas/ScoreImprovement" } ], "nullable": true }, "rankVoting": { "allOf": [ { "$ref": "#/components/schemas/RankVoting" } ], "nullable": true }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/ScoreMetadata" } ], "nullable": true }, "offsets": { "allOf": [ { "$ref": "#/components/schemas/ReplayOffsets" } ], "nullable": true }, "sotwNominations": { "type": "integer", "format": "int32" }, "status": { "enum": [ "none", "playOfTheWeek" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ScoreStatus" } ], "oneOf": [ { "enum": [ 0, 2 ], "type": "integer" }, { "enum": [ "none", "playOfTheWeek" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "example": 2 } }, "additionalProperties": false }, "ScoreResponseWithAcc": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "baseScore": { "type": "integer", "format": "int32" }, "modifiedScore": { "type": "integer", "format": "int32" }, "accuracy": { "type": "number", "format": "float" }, "playerId": { "type": "string" }, "pp": { "type": "number", "format": "float" }, "withPp": { "type": "boolean" }, "bonusPp": { "type": "number", "format": "float" }, "passPP": { "type": "number", "format": "float" }, "accPP": { "type": "number", "format": "float" }, "techPP": { "type": "number", "format": "float" }, "rank": { "type": "integer", "format": "int32" }, "responseRank": { "type": "integer", "format": "int32" }, "country": { "type": "string", "nullable": true }, "fcAccuracy": { "type": "number", "format": "float" }, "fcPp": { "type": "number", "format": "float" }, "weight": { "type": "number", "format": "float" }, "replay": { "type": "string" }, "modifiers": { "type": "string" }, "badCuts": { "type": "integer", "format": "int32" }, "missedNotes": { "type": "integer", "format": "int32" }, "bombCuts": { "type": "integer", "format": "int32" }, "wallsHit": { "type": "integer", "format": "int32" }, "pauses": { "type": "integer", "format": "int32" }, "fullCombo": { "type": "boolean" }, "platform": { "type": "string" }, "maxCombo": { "type": "integer", "format": "int32" }, "maxStreak": { "type": "integer", "format": "int32", "nullable": true }, "hmd": { "enum": [ "unknown", "rift", "vive", "vivePro", "wmr", "riftS", "quest", "picoNeo3", "picoNeo2", "vivePro2", "viveElite", "miramar", "pimax8k", "pimax5k", "pimaxArtisan", "hpReverb", "samsungWmr", "qiyuDream", "disco", "lenovoExplorer", "acerWmr", "viveFocus", "arpara", "dellVisor", "e3", "viveDvt", "glasses20", "hedy", "vaporeon", "huaweivr", "asusWmr", "cloudxr", "vridge", "medion", "picoNeo4", "questPro", "pimaxCrystal", "e4", "index", "controllable", "bigscreenbeyond", "nolosonic", "hypereal", "varjoaero", "psvr2", "megane1", "varjoxr3", "meganexsuperlight", "somniumvr1", "viveCosmos", "quest2", "quest3", "quest3s" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/HMD" } ], "oneOf": [ { "enum": [ 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 ], "type": "integer" }, { "enum": [ "unknown", "rift", "vive", "vivePro", "wmr", "riftS", "quest", "picoNeo3", "picoNeo2", "vivePro2", "viveElite", "miramar", "pimax8k", "pimax5k", "pimaxArtisan", "hpReverb", "samsungWmr", "qiyuDream", "disco", "lenovoExplorer", "acerWmr", "viveFocus", "arpara", "dellVisor", "e3", "viveDvt", "glasses20", "hedy", "vaporeon", "huaweivr", "asusWmr", "cloudxr", "vridge", "medion", "picoNeo4", "questPro", "pimaxCrystal", "e4", "index", "controllable", "bigscreenbeyond", "nolosonic", "hypereal", "varjoaero", "psvr2", "megane1", "varjoxr3", "meganexsuperlight", "somniumvr1", "viveCosmos", "quest2", "quest3", "quest3s" ], "type": "string" } ] }, "controller": { "enum": [ "unknown", "oculustouch", "vive", "vivePro", "wmr", "odyssey", "hpMotion", "oculustouch2", "picoNeo3", "picoNeo2", "vivePro2", "miramar", "disco", "questPro", "viveTracker", "viveTracker2", "knuckles", "nolo", "picophoenix", "hands", "viveTracker3", "pimax", "huawei", "polaris", "tundra", "cry", "e4", "gamepad", "joycon", "steamdeck", "etee", "quest3", "contactglove", "playstationSense", "viveCosmos", "quest2" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ControllerEnum" } ], "oneOf": [ { "enum": [ 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 ], "type": "integer" }, { "enum": [ "unknown", "oculustouch", "vive", "vivePro", "wmr", "odyssey", "hpMotion", "oculustouch2", "picoNeo3", "picoNeo2", "vivePro2", "miramar", "disco", "questPro", "viveTracker", "viveTracker2", "knuckles", "nolo", "picophoenix", "hands", "viveTracker3", "pimax", "huawei", "polaris", "tundra", "cry", "e4", "gamepad", "joycon", "steamdeck", "etee", "quest3", "contactglove", "playstationSense", "viveCosmos", "quest2" ], "type": "string" } ] }, "leaderboardId": { "type": "string" }, "timeset": { "type": "string" }, "timepost": { "type": "integer", "format": "int32" }, "replaysWatched": { "type": "integer", "format": "int32" }, "playCount": { "type": "integer", "format": "int32" }, "lastTryTime": { "type": "integer", "format": "int32" }, "priority": { "type": "integer", "format": "int32" }, "originalId": { "type": "integer", "format": "int32" }, "player": { "allOf": [ { "$ref": "#/components/schemas/PlayerResponse" } ], "nullable": true }, "scoreImprovement": { "allOf": [ { "$ref": "#/components/schemas/ScoreImprovement" } ], "nullable": true }, "rankVoting": { "allOf": [ { "$ref": "#/components/schemas/RankVoting" } ], "nullable": true }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/ScoreMetadata" } ], "nullable": true }, "offsets": { "allOf": [ { "$ref": "#/components/schemas/ReplayOffsets" } ], "nullable": true }, "sotwNominations": { "type": "integer", "format": "int32" }, "status": { "enum": [ "none", "playOfTheWeek" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ScoreStatus" } ], "oneOf": [ { "enum": [ 0, 2 ], "type": "integer" }, { "enum": [ "none", "playOfTheWeek" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "example": 2 }, "accLeft": { "type": "number", "format": "float" }, "accRight": { "type": "number", "format": "float" } }, "additionalProperties": false }, "ScoreResponseWithMyScore": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "baseScore": { "type": "integer", "format": "int32" }, "modifiedScore": { "type": "integer", "format": "int32" }, "accuracy": { "type": "number", "format": "float" }, "playerId": { "type": "string" }, "pp": { "type": "number", "format": "float" }, "withPp": { "type": "boolean" }, "bonusPp": { "type": "number", "format": "float" }, "passPP": { "type": "number", "format": "float" }, "accPP": { "type": "number", "format": "float" }, "techPP": { "type": "number", "format": "float" }, "rank": { "type": "integer", "format": "int32" }, "responseRank": { "type": "integer", "format": "int32" }, "country": { "type": "string", "nullable": true }, "fcAccuracy": { "type": "number", "format": "float" }, "fcPp": { "type": "number", "format": "float" }, "weight": { "type": "number", "format": "float" }, "replay": { "type": "string" }, "modifiers": { "type": "string" }, "badCuts": { "type": "integer", "format": "int32" }, "missedNotes": { "type": "integer", "format": "int32" }, "bombCuts": { "type": "integer", "format": "int32" }, "wallsHit": { "type": "integer", "format": "int32" }, "pauses": { "type": "integer", "format": "int32" }, "fullCombo": { "type": "boolean" }, "platform": { "type": "string" }, "maxCombo": { "type": "integer", "format": "int32" }, "maxStreak": { "type": "integer", "format": "int32", "nullable": true }, "hmd": { "enum": [ "unknown", "rift", "vive", "vivePro", "wmr", "riftS", "quest", "picoNeo3", "picoNeo2", "vivePro2", "viveElite", "miramar", "pimax8k", "pimax5k", "pimaxArtisan", "hpReverb", "samsungWmr", "qiyuDream", "disco", "lenovoExplorer", "acerWmr", "viveFocus", "arpara", "dellVisor", "e3", "viveDvt", "glasses20", "hedy", "vaporeon", "huaweivr", "asusWmr", "cloudxr", "vridge", "medion", "picoNeo4", "questPro", "pimaxCrystal", "e4", "index", "controllable", "bigscreenbeyond", "nolosonic", "hypereal", "varjoaero", "psvr2", "megane1", "varjoxr3", "meganexsuperlight", "somniumvr1", "viveCosmos", "quest2", "quest3", "quest3s" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/HMD" } ], "oneOf": [ { "enum": [ 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 ], "type": "integer" }, { "enum": [ "unknown", "rift", "vive", "vivePro", "wmr", "riftS", "quest", "picoNeo3", "picoNeo2", "vivePro2", "viveElite", "miramar", "pimax8k", "pimax5k", "pimaxArtisan", "hpReverb", "samsungWmr", "qiyuDream", "disco", "lenovoExplorer", "acerWmr", "viveFocus", "arpara", "dellVisor", "e3", "viveDvt", "glasses20", "hedy", "vaporeon", "huaweivr", "asusWmr", "cloudxr", "vridge", "medion", "picoNeo4", "questPro", "pimaxCrystal", "e4", "index", "controllable", "bigscreenbeyond", "nolosonic", "hypereal", "varjoaero", "psvr2", "megane1", "varjoxr3", "meganexsuperlight", "somniumvr1", "viveCosmos", "quest2", "quest3", "quest3s" ], "type": "string" } ] }, "controller": { "enum": [ "unknown", "oculustouch", "vive", "vivePro", "wmr", "odyssey", "hpMotion", "oculustouch2", "picoNeo3", "picoNeo2", "vivePro2", "miramar", "disco", "questPro", "viveTracker", "viveTracker2", "knuckles", "nolo", "picophoenix", "hands", "viveTracker3", "pimax", "huawei", "polaris", "tundra", "cry", "e4", "gamepad", "joycon", "steamdeck", "etee", "quest3", "contactglove", "playstationSense", "viveCosmos", "quest2" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ControllerEnum" } ], "oneOf": [ { "enum": [ 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 ], "type": "integer" }, { "enum": [ "unknown", "oculustouch", "vive", "vivePro", "wmr", "odyssey", "hpMotion", "oculustouch2", "picoNeo3", "picoNeo2", "vivePro2", "miramar", "disco", "questPro", "viveTracker", "viveTracker2", "knuckles", "nolo", "picophoenix", "hands", "viveTracker3", "pimax", "huawei", "polaris", "tundra", "cry", "e4", "gamepad", "joycon", "steamdeck", "etee", "quest3", "contactglove", "playstationSense", "viveCosmos", "quest2" ], "type": "string" } ] }, "leaderboardId": { "type": "string" }, "timeset": { "type": "string" }, "timepost": { "type": "integer", "format": "int32" }, "replaysWatched": { "type": "integer", "format": "int32" }, "playCount": { "type": "integer", "format": "int32" }, "lastTryTime": { "type": "integer", "format": "int32" }, "priority": { "type": "integer", "format": "int32" }, "originalId": { "type": "integer", "format": "int32" }, "player": { "allOf": [ { "$ref": "#/components/schemas/PlayerResponse" } ], "nullable": true }, "scoreImprovement": { "allOf": [ { "$ref": "#/components/schemas/ScoreImprovement" } ], "nullable": true }, "rankVoting": { "allOf": [ { "$ref": "#/components/schemas/RankVoting" } ], "nullable": true }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/ScoreMetadata" } ], "nullable": true }, "offsets": { "allOf": [ { "$ref": "#/components/schemas/ReplayOffsets" } ], "nullable": true }, "sotwNominations": { "type": "integer", "format": "int32" }, "status": { "enum": [ "none", "playOfTheWeek" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ScoreStatus" } ], "oneOf": [ { "enum": [ 0, 2 ], "type": "integer" }, { "enum": [ "none", "playOfTheWeek" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "example": 2 }, "accLeft": { "type": "number", "format": "float" }, "accRight": { "type": "number", "format": "float" }, "myScore": { "allOf": [ { "$ref": "#/components/schemas/ScoreResponseWithAcc" } ], "nullable": true }, "validContexts": { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/LeaderboardContexts" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 ], "type": "integer" }, { "enum": [ "none", "general", "noMods", "noPause", "golf", "sCPM", "speedrun", "speedrunBackup", "funny", "backUp", "leftLeader" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "example": 2046 }, "experience": { "type": "integer", "format": "int32" }, "leaderboard": { "allOf": [ { "$ref": "#/components/schemas/CompactLeaderboardResponse" } ] } }, "additionalProperties": false }, "ScoreResponseWithMyScoreResponseWithMetadata": { "type": "object", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreResponseWithMyScore" } } }, "additionalProperties": false }, "ScoreStatus": { "enum": [ "none", "playOfTheWeek" ], "type": "string", "oneOf": [ { "enum": [ 0, 2 ], "type": "integer" }, { "enum": [ "none", "playOfTheWeek" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "format": "int32", "example": 2 }, "ScoresSortBy": { "enum": [ "date", "pp", "accPP", "passPP", "techPP", "acc", "pauses", "playCount", "lastTryTime", "rank", "maxStreak", "timing", "stars", "mistakes", "replaysWatched", "sotwNominations", "scoreValue" ], "type": "string", "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ], "type": "integer" }, { "enum": [ "date", "pp", "accPP", "passPP", "techPP", "acc", "pauses", "playCount", "lastTryTime", "rank", "maxStreak", "timing", "stars", "mistakes", "replaysWatched", "sotwNominations", "scoreValue" ], "type": "string" } ], "format": "int32" }, "Song": { "type": "object", "properties": { "id": { "type": "string" }, "hash": { "type": "string" }, "lowerHash": { "maxLength": 80, "minLength": 0, "type": "string" }, "name": { "type": "string" }, "subName": { "type": "string", "nullable": true }, "author": { "type": "string" }, "mapper": { "type": "string" }, "mappers": { "type": "array", "items": { "$ref": "#/components/schemas/Mapper" }, "nullable": true }, "mapperId": { "type": "integer", "format": "int32" }, "collaboratorIds": { "type": "string", "nullable": true }, "coverImage": { "type": "string" }, "fullCoverImage": { "type": "string", "nullable": true }, "downloadUrl": { "type": "string" }, "bpm": { "type": "number", "format": "double" }, "duration": { "type": "number", "format": "double" }, "tags": { "type": "string", "nullable": true }, "mapCreator": { "enum": [ "human", "genericBot", "beatSage", "topMapper" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/SongCreator" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3 ], "type": "integer" }, { "enum": [ "human", "genericBot", "beatSage", "topMapper" ], "type": "string" } ] }, "uploadTime": { "type": "integer", "format": "int32" }, "status": { "enum": [ "none", "curated", "mapOfTheWeek", "noodleMonday", "featuredOnCC", "beastSaberAwarded", "buildingBlocksAwarded" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/SongStatus" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64 ], "type": "integer" }, { "enum": [ "none", "curated", "mapOfTheWeek", "noodleMonday", "featuredOnCC", "beastSaberAwarded", "buildingBlocksAwarded" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "example": 126 }, "explicity": { "enum": [ "none", "cover", "lyrics", "name", "author", "map" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/SongExplicitStatus" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32 ], "type": "integer" }, { "enum": [ "none", "cover", "lyrics", "name", "author", "map" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "example": 62 }, "difficulties": { "type": "array", "items": { "$ref": "#/components/schemas/DifficultyDescription" } }, "leaderboards": { "type": "array", "items": { "$ref": "#/components/schemas/Leaderboard" } }, "externalStatuses": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalStatus" }, "nullable": true }, "videoPreviewUrl": { "type": "string", "nullable": true }, "idolDescriptionId": { "type": "integer", "format": "int32", "nullable": true }, "idolDescription": { "allOf": [ { "$ref": "#/components/schemas/IdolDescription" } ], "nullable": true }, "mapVersion": { "maxLength": 25, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "SongCreator": { "enum": [ "human", "genericBot", "beatSage", "topMapper" ], "type": "string", "oneOf": [ { "enum": [ 0, 1, 2, 3 ], "type": "integer" }, { "enum": [ "human", "genericBot", "beatSage", "topMapper" ], "type": "string" } ], "format": "int32" }, "SongExplicitStatus": { "enum": [ "none", "cover", "lyrics", "name", "author", "map" ], "type": "string", "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32 ], "type": "integer" }, { "enum": [ "none", "cover", "lyrics", "name", "author", "map" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "format": "int32", "example": 62 }, "SongResponse": { "type": "object", "properties": { "id": { "type": "string" }, "hash": { "type": "string" }, "name": { "type": "string" }, "subName": { "type": "string", "nullable": true }, "author": { "type": "string" }, "mapper": { "type": "string" }, "mappers": { "type": "array", "items": { "$ref": "#/components/schemas/MapperResponse" }, "nullable": true }, "mapperId": { "type": "integer", "format": "int32" }, "coverImage": { "type": "string" }, "fullCoverImage": { "type": "string", "nullable": true }, "downloadUrl": { "type": "string" }, "videoPreviewUrl": { "type": "string", "nullable": true }, "bpm": { "type": "number", "format": "double" }, "duration": { "type": "number", "format": "double" }, "uploadTime": { "type": "integer", "format": "int32" }, "explicity": { "enum": [ "none", "cover", "lyrics", "name", "author", "map" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/SongExplicitStatus" } ], "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32 ], "type": "integer" }, { "enum": [ "none", "cover", "lyrics", "name", "author", "map" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "example": 62 }, "difficulties": { "type": "array", "items": { "$ref": "#/components/schemas/DifficultyDescription" } }, "externalStatuses": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalStatus" }, "nullable": true }, "idolDescription": { "allOf": [ { "$ref": "#/components/schemas/IdolDescription" } ], "nullable": true } }, "additionalProperties": false }, "SongStatus": { "enum": [ "none", "curated", "mapOfTheWeek", "noodleMonday", "featuredOnCC", "beastSaberAwarded", "buildingBlocksAwarded" ], "type": "string", "oneOf": [ { "enum": [ 0, 2, 4, 8, 16, 32, 64 ], "type": "integer" }, { "enum": [ "none", "curated", "mapOfTheWeek", "noodleMonday", "featuredOnCC", "beastSaberAwarded", "buildingBlocksAwarded" ], "type": "string" } ], "description": "Bitmask enum. Values can be combined using bitwise OR operator.", "format": "int32", "example": 126 }, "SuggestionCategory": { "enum": [ "feature", "improvement", "uX", "performance", "accessibility", "other" ], "type": "string", "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, { "enum": [ "feature", "improvement", "uX", "performance", "accessibility", "other" ], "type": "string" } ], "description": "Category of suggestion", "format": "int32" }, "SuggestionResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "enum": [ "task", "bugReport", "suggestion", "helpRequest" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/WorkTaskType" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3 ], "type": "integer" }, { "enum": [ "task", "bugReport", "suggestion", "helpRequest" ], "type": "string" } ], "description": "Defines the type of work task" }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "creator": { "allOf": [ { "$ref": "#/components/schemas/WorkTaskPlayerResponse" } ], "nullable": true }, "createdAt": { "type": "integer", "format": "int32" }, "lastEditedAt": { "type": "integer", "format": "int32", "nullable": true }, "lastEditedBy": { "allOf": [ { "$ref": "#/components/schemas/WorkTaskPlayerResponse" } ], "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/WorkTaskStatusResponse" } ], "nullable": true }, "priority": { "type": "integer", "format": "int32" }, "voteScore": { "type": "integer", "format": "int32" }, "commentCount": { "type": "integer", "format": "int32" }, "isPublic": { "type": "boolean" }, "isArchived": { "type": "boolean" }, "isLocked": { "type": "boolean" }, "dueDate": { "type": "integer", "format": "int32", "nullable": true }, "resolvedAt": { "type": "integer", "format": "int32", "nullable": true }, "resolvedBy": { "allOf": [ { "$ref": "#/components/schemas/WorkTaskPlayerResponse" } ], "nullable": true }, "currentUserVote": { "type": "integer", "format": "int32", "nullable": true }, "tagAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/WorkTaskTagAssignmentResponse" }, "nullable": true }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/WorkTaskAttachmentResponse" }, "nullable": true }, "assignments": { "type": "array", "items": { "$ref": "#/components/schemas/WorkTaskAssignmentResponse" }, "nullable": true }, "category": { "enum": [ "feature", "improvement", "uX", "performance", "accessibility", "other" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/SuggestionCategory" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, { "enum": [ "feature", "improvement", "uX", "performance", "accessibility", "other" ], "type": "string" } ], "description": "Category of suggestion" }, "useCase": { "type": "string", "nullable": true }, "proposedSolution": { "type": "string", "nullable": true }, "alternatives": { "type": "string", "nullable": true }, "impact": { "type": "string", "nullable": true }, "targetArea": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Type": { "enum": [ "all", "ranked", "ranking", "nominated", "qualified", "staff", "reweighting", "reweighted", "unranked", "ost" ], "type": "string", "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "type": "integer" }, { "enum": [ "all", "ranked", "ranking", "nominated", "qualified", "staff", "reweighting", "reweighted", "unranked", "ost" ], "type": "string" } ], "format": "int32" }, "VoterFeedback": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "rtMember": { "type": "string" }, "value": { "type": "number", "format": "float" } }, "additionalProperties": false }, "WorkTaskAssignmentResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "player": { "allOf": [ { "$ref": "#/components/schemas/WorkTaskPlayerResponse" } ], "nullable": true }, "assignedBy": { "allOf": [ { "$ref": "#/components/schemas/WorkTaskPlayerResponse" } ], "nullable": true }, "assignedAt": { "type": "integer", "format": "int32" }, "role": { "type": "string", "nullable": true }, "isPrimary": { "type": "boolean" } }, "additionalProperties": false }, "WorkTaskAttachmentResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "enum": [ "file", "image", "video", "link" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/WorkTaskAttachmentType" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3 ], "type": "integer" }, { "enum": [ "file", "image", "video", "link" ], "type": "string" } ], "description": "Type of attachment" }, "fileName": { "type": "string" }, "url": { "type": "string" }, "mimeType": { "type": "string", "nullable": true }, "fileSize": { "type": "integer", "format": "int64", "nullable": true }, "uploadedBy": { "allOf": [ { "$ref": "#/components/schemas/WorkTaskPlayerResponse" } ], "nullable": true }, "uploadedAt": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "WorkTaskAttachmentType": { "enum": [ "file", "image", "video", "link" ], "type": "string", "oneOf": [ { "enum": [ 0, 1, 2, 3 ], "type": "integer" }, { "enum": [ "file", "image", "video", "link" ], "type": "string" } ], "description": "Type of attachment", "format": "int32" }, "WorkTaskCommentAttachmentResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "enum": [ "file", "image", "video", "link" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/WorkTaskAttachmentType" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3 ], "type": "integer" }, { "enum": [ "file", "image", "video", "link" ], "type": "string" } ], "description": "Type of attachment" }, "fileName": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "WorkTaskCommentResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "content": { "type": "string" }, "author": { "allOf": [ { "$ref": "#/components/schemas/WorkTaskPlayerResponse" } ], "nullable": true }, "createdAt": { "type": "integer", "format": "int32" }, "editedAt": { "type": "integer", "format": "int32", "nullable": true }, "isEdited": { "type": "boolean" }, "voteScore": { "type": "integer", "format": "int32" }, "isDeleted": { "type": "boolean" }, "parentCommentId": { "type": "integer", "format": "int32", "nullable": true }, "replyCount": { "type": "integer", "format": "int32" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/WorkTaskCommentAttachmentResponse" }, "nullable": true }, "currentUserVote": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "WorkTaskCommentResponseResponseWithMetadata": { "type": "object", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/WorkTaskCommentResponse" } } }, "additionalProperties": false }, "WorkTaskDetailResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "enum": [ "task", "bugReport", "suggestion", "helpRequest" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/WorkTaskType" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3 ], "type": "integer" }, { "enum": [ "task", "bugReport", "suggestion", "helpRequest" ], "type": "string" } ], "description": "Defines the type of work task" }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "creator": { "allOf": [ { "$ref": "#/components/schemas/WorkTaskPlayerResponse" } ], "nullable": true }, "createdAt": { "type": "integer", "format": "int32" }, "lastEditedAt": { "type": "integer", "format": "int32", "nullable": true }, "lastEditedBy": { "allOf": [ { "$ref": "#/components/schemas/WorkTaskPlayerResponse" } ], "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/WorkTaskStatusResponse" } ], "nullable": true }, "priority": { "type": "integer", "format": "int32" }, "voteScore": { "type": "integer", "format": "int32" }, "commentCount": { "type": "integer", "format": "int32" }, "isPublic": { "type": "boolean" }, "isArchived": { "type": "boolean" }, "isLocked": { "type": "boolean" }, "dueDate": { "type": "integer", "format": "int32", "nullable": true }, "resolvedAt": { "type": "integer", "format": "int32", "nullable": true }, "resolvedBy": { "allOf": [ { "$ref": "#/components/schemas/WorkTaskPlayerResponse" } ], "nullable": true }, "currentUserVote": { "type": "integer", "format": "int32", "nullable": true }, "tagAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/WorkTaskTagAssignmentResponse" }, "nullable": true }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/WorkTaskAttachmentResponse" }, "nullable": true }, "assignments": { "type": "array", "items": { "$ref": "#/components/schemas/WorkTaskAssignmentResponse" }, "nullable": true } }, "additionalProperties": false }, "WorkTaskHistoryAction": { "enum": [ "created", "titleChanged", "descriptionChanged", "statusChanged", "priorityChanged", "tagAdded", "tagRemoved", "assigneeAdded", "assigneeRemoved", "attachmentAdded", "attachmentRemoved", "commentAdded", "commentEdited", "commentDeleted", "voteAdded", "voteRemoved", "taskLocked", "taskUnlocked", "taskArchived", "taskUnarchived", "dueDateChanged", "resolved", "reopened", "visibilityChanged" ], "type": "string", "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23 ], "type": "integer" }, { "enum": [ "created", "titleChanged", "descriptionChanged", "statusChanged", "priorityChanged", "tagAdded", "tagRemoved", "assigneeAdded", "assigneeRemoved", "attachmentAdded", "attachmentRemoved", "commentAdded", "commentEdited", "commentDeleted", "voteAdded", "voteRemoved", "taskLocked", "taskUnlocked", "taskArchived", "taskUnarchived", "dueDateChanged", "resolved", "reopened", "visibilityChanged" ], "type": "string" } ], "description": "Type of change recorded in history", "format": "int32" }, "WorkTaskHistoryResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "action": { "enum": [ "created", "titleChanged", "descriptionChanged", "statusChanged", "priorityChanged", "tagAdded", "tagRemoved", "assigneeAdded", "assigneeRemoved", "attachmentAdded", "attachmentRemoved", "commentAdded", "commentEdited", "commentDeleted", "voteAdded", "voteRemoved", "taskLocked", "taskUnlocked", "taskArchived", "taskUnarchived", "dueDateChanged", "resolved", "reopened", "visibilityChanged" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/WorkTaskHistoryAction" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23 ], "type": "integer" }, { "enum": [ "created", "titleChanged", "descriptionChanged", "statusChanged", "priorityChanged", "tagAdded", "tagRemoved", "assigneeAdded", "assigneeRemoved", "attachmentAdded", "attachmentRemoved", "commentAdded", "commentEdited", "commentDeleted", "voteAdded", "voteRemoved", "taskLocked", "taskUnlocked", "taskArchived", "taskUnarchived", "dueDateChanged", "resolved", "reopened", "visibilityChanged" ], "type": "string" } ], "description": "Type of change recorded in history" }, "player": { "allOf": [ { "$ref": "#/components/schemas/WorkTaskPlayerResponse" } ], "nullable": true }, "timestamp": { "type": "integer", "format": "int32" }, "fieldName": { "type": "string", "nullable": true }, "oldValue": { "type": "string", "nullable": true }, "newValue": { "type": "string", "nullable": true }, "details": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WorkTaskHistoryResponseResponseWithMetadata": { "type": "object", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/WorkTaskHistoryResponse" } } }, "additionalProperties": false }, "WorkTaskListResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "enum": [ "task", "bugReport", "suggestion", "helpRequest" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/WorkTaskType" } ], "oneOf": [ { "enum": [ 0, 1, 2, 3 ], "type": "integer" }, { "enum": [ "task", "bugReport", "suggestion", "helpRequest" ], "type": "string" } ], "description": "Defines the type of work task" }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "creator": { "allOf": [ { "$ref": "#/components/schemas/WorkTaskPlayerResponse" } ], "nullable": true }, "createdAt": { "type": "integer", "format": "int32" }, "lastEditedAt": { "type": "integer", "format": "int32", "nullable": true }, "lastEditedBy": { "allOf": [ { "$ref": "#/components/schemas/WorkTaskPlayerResponse" } ], "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/WorkTaskStatusResponse" } ], "nullable": true }, "priority": { "type": "integer", "format": "int32" }, "voteScore": { "type": "integer", "format": "int32" }, "commentCount": { "type": "integer", "format": "int32" }, "isPublic": { "type": "boolean" }, "isArchived": { "type": "boolean" }, "isLocked": { "type": "boolean" }, "dueDate": { "type": "integer", "format": "int32", "nullable": true }, "resolvedAt": { "type": "integer", "format": "int32", "nullable": true }, "resolvedBy": { "allOf": [ { "$ref": "#/components/schemas/WorkTaskPlayerResponse" } ], "nullable": true }, "currentUserVote": { "type": "integer", "format": "int32", "nullable": true }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/WorkTaskTagResponse" }, "nullable": true }, "assignees": { "type": "array", "items": { "$ref": "#/components/schemas/WorkTaskPlayerResponse" }, "nullable": true }, "attachmentCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "WorkTaskListResponseResponseWithMetadata": { "type": "object", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/Metadata" } ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/WorkTaskListResponse" } } }, "additionalProperties": false }, "WorkTaskPlayerResponse": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "avatar": { "type": "string" }, "alias": { "type": "string", "nullable": true }, "country": { "type": "string" }, "role": { "type": "string" } }, "additionalProperties": false }, "WorkTaskStatusResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "icon": { "type": "string", "nullable": true }, "color": { "type": "string", "nullable": true }, "order": { "type": "integer", "format": "int32" }, "isClosedStatus": { "type": "boolean" }, "isDefault": { "type": "boolean" } }, "additionalProperties": false }, "WorkTaskTagAssignmentResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "tag": { "allOf": [ { "$ref": "#/components/schemas/WorkTaskTagResponse" } ], "nullable": true }, "addedBy": { "allOf": [ { "$ref": "#/components/schemas/WorkTaskPlayerResponse" } ], "nullable": true }, "addedAt": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "WorkTaskTagResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "icon": { "type": "string", "nullable": true }, "link": { "type": "string", "nullable": true }, "color": { "type": "string", "nullable": true }, "adminOnly": { "type": "boolean" } }, "additionalProperties": false }, "WorkTaskType": { "enum": [ "task", "bugReport", "suggestion", "helpRequest" ], "type": "string", "oneOf": [ { "enum": [ 0, 1, 2, 3 ], "type": "integer" }, { "enum": [ "task", "bugReport", "suggestion", "helpRequest" ], "type": "string" } ], "description": "Defines the type of work task", "format": "int32" } } }, "tags": [ { "name": "BeastSaber" }, { "name": "Clan" }, { "name": "Experience" }, { "name": "Leaderboard" }, { "name": "Mapper" }, { "name": "Modifiers" }, { "name": "Patreon" }, { "name": "PinnedScore" }, { "name": "Player" }, { "name": "PlayerScores" }, { "name": "Song" }, { "name": "WorkManagement" } ] }