{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/osu.freedomdive.dev" } ], "info": { "name": "osu!web", "_postman_id": "9d4df1b0-545c-4d4b-baed-a858f7d99a18", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Account", "description": "", "item": [ { "name": "GET api\/v2\/me\/beatmapset-favourites", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/me\/beatmapset-favourites", "query": [], "raw": "{{baseUrl}}\/api\/v2\/me\/beatmapset-favourites" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Beatmap Packs", "description": "", "item": [ { "name": "Get Beatmap Packs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/beatmaps\/packs", "query": [ { "key": "type", "value": "similique", "description": "[BeatmapPackType](#beatmappacktype) of the beatmap packs to be returned. Defaults to `standard`.", "disabled": false }, { "key": "cursor_string", "value": "", "description": "[CursorString](#cursorstring) for pagination.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v2\/beatmaps\/packs?type=similique&cursor_string=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a list of beatmap packs.\n\n---\n\n### Response format\n\nField | Type\n------------- | -----------------------------\nbeatmap_packs | [BeatmapPack](#beatmappack)[]", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Get Beatmap Pack", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/beatmaps\/packs\/:pack", "query": [ { "key": "legacy_only", "value": "0", "description": "Whether or not to consider lazer scores for user completion data. Defaults to 0.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v2\/beatmaps\/packs\/:pack?legacy_only=0", "variable": [ { "id": "pack", "key": "pack", "value": "ex", "description": "The tag of the beatmap pack to be returned." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Gets the beatmap pack for the specified beatmap pack tag.\n\n---\n\n### Response format\n\nReturns [BeatmapPack](#beatmappack) object.\nThe following attributes are always included as well:\n\nAttribute |\n-------------------- |\nbeatmapsets |\nuser_completion_data |", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Beatmaps", "description": "", "item": [ { "name": "Lookup Beatmap", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/beatmaps\/lookup", "query": [ { "key": "checksum", "value": "aut", "description": "A beatmap checksum.", "disabled": false }, { "key": "filename", "value": "dolores", "description": "A filename to lookup.", "disabled": false }, { "key": "id", "value": "ut", "description": "A beatmap ID to lookup.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/beatmaps\/lookup?checksum=aut&filename=dolores&id=ut" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns beatmap.\n\n---\n\n### Response format\n\nSee [Get Beatmap](#get-beatmap)", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "\"See Beatmap object section\"", "name": "" } ] }, { "name": "Get a User Beatmap score", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/beatmaps\/:beatmap\/scores\/users\/:user", "query": [ { "key": "legacy_only", "value": "0", "description": "Whether or not to exclude lazer scores. Defaults to 0.", "disabled": true }, { "key": "mode", "value": "exercitationem", "description": "The [Ruleset](#ruleset) to get scores for.", "disabled": false }, { "key": "mods", "value": "molestiae", "description": "An array of matching Mods, or none \/\/ TODO.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/beatmaps\/:beatmap\/scores\/users\/:user?legacy_only=0&mode=exercitationem&mods=molestiae", "variable": [ { "id": "beatmap", "key": "beatmap", "value": 20, "description": "Id of the [Beatmap](#beatmap)." }, { "id": "user", "key": "user", "value": 20, "description": "Id of the [User](#user)." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return a [User](#user)'s score on a Beatmap\n\n---\n\n### Response Format\n\nReturns [BeatmapUserScore](#beatmapuserscore)\n\nThe position returned depends on the requested mode and mods.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Get a User Beatmap scores", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/beatmaps\/:beatmap\/scores\/users\/:user\/all", "query": [ { "key": "legacy_only", "value": "0", "description": "Whether or not to exclude lazer scores. Defaults to 0.", "disabled": true }, { "key": "mode", "value": "", "description": "(deprecated) The [Ruleset](#ruleset) to get scores for. Defaults to beatmap ruleset.", "disabled": true }, { "key": "ruleset", "value": "osu", "description": "The [Ruleset](#ruleset) to get scores for. Defaults to beatmap ruleset.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/beatmaps\/:beatmap\/scores\/users\/:user\/all?legacy_only=0&mode=&ruleset=osu", "variable": [ { "id": "beatmap", "key": "beatmap", "value": 17, "description": "Id of the [Beatmap](#beatmap)." }, { "id": "user", "key": "user", "value": 17, "description": "Id of the [User](#user)." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return a [User](#user)'s scores on a Beatmap\n\n---\n\n### Response Format\n\nField | Type\n------ | ----\nscores | [Score](#score)[]", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Get Beatmap scores", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/beatmaps\/:beatmap\/scores", "query": [ { "key": "legacy_only", "value": "0", "description": "Whether or not to exclude lazer scores. Defaults to 0.", "disabled": true }, { "key": "mode", "value": "quia", "description": "The [Ruleset](#ruleset) to get scores for.", "disabled": false }, { "key": "mods", "value": "delectus", "description": "An array of matching Mods, or none \/\/ TODO.", "disabled": false }, { "key": "type", "value": "velit", "description": "Beatmap score ranking type \/\/ TODO.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/beatmaps\/:beatmap\/scores?legacy_only=0&mode=quia&mods=delectus&type=velit", "variable": [ { "id": "beatmap", "key": "beatmap", "value": 4, "description": "Id of the [Beatmap](#beatmap)." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the top scores for a beatmap. Depending on user preferences, this may only show legacy scores.\n\n---\n\n### Response Format\n\nReturns [BeatmapScores](#beatmapscores). `Score` object inside includes `user` and the included `user` includes `country` and `cover`.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Get Beatmap scores (non-legacy)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/beatmaps\/:beatmap\/solo-scores", "query": [ { "key": "mode", "value": "quis", "description": "The [Ruleset](#ruleset) to get scores for.", "disabled": false }, { "key": "mods", "value": "in", "description": "An array of matching Mods, or none \/\/ TODO.", "disabled": false }, { "key": "type", "value": "labore", "description": "Beatmap score ranking type \/\/ TODO.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/beatmaps\/:beatmap\/solo-scores?mode=quis&mods=in&type=labore", "variable": [ { "id": "beatmap", "key": "beatmap", "value": 17, "description": "Id of the [Beatmap](#beatmap)." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the top scores for a beatmap.\n\nThis endpoint is deprecated. Use [Get Beatmap scores](#get-beatmap-scores) with appropriate api version header instead.\n\n---\n\n### Response Format\n\nReturns [BeatmapScores](#beatmapscores). `Score` object inside includes `user` and the included `user` includes `country` and `cover`.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Get Beatmaps", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/beatmaps", "query": [ { "key": "ids[]", "value": "1", "description": "Beatmap IDs to be returned. Specify once for each beatmap ID requested. Up to 50 beatmaps can be requested at once.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/beatmaps?ids%5B%5D=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a list of beatmaps.\n\n---\n\n### Response format\n\nField | Type | Description\n-------- | ------------------------------------- | -----------\nbeatmaps | [BeatmapExtended](#beatmapextended)[] | Includes `beatmapset` (with `ratings`), `failtimes`, `max_combo`, and `owners`.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"beatmaps\": [\n {\n \"id\": 1,\n \/\/ Other Beatmap attributes...\n }\n ]\n}", "name": "" } ] }, { "name": "Get Beatmap", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/beatmaps\/:beatmap", "query": [], "raw": "{{baseUrl}}\/api\/v2\/beatmaps\/:beatmap", "variable": [ { "id": "beatmap", "key": "beatmap", "value": 20, "description": "The ID of the beatmap." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Gets beatmap data for the specified beatmap ID.\n\n---\n\n### Response format\n\nReturns [BeatmapExtended](#beatmapextended) object.\nFollowing attributes are included in the response object when applicable,\n\nAttribute | Notes\n---------- | -----\nbeatmapset | Includes ratings property.\nfailtimes | |\nmax_combo | |", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "\"See Beatmap object section.\"", "name": "" } ] }, { "name": "Get Beatmap Attributes", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/beatmaps\/:beatmap\/attributes", "query": [], "raw": "{{baseUrl}}\/api\/v2\/beatmaps\/:beatmap\/attributes", "variable": [ { "id": "beatmap", "key": "beatmap", "value": 2, "description": "Beatmap id." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"mods\":1,\"ruleset\":\"osu\"}" }, "description": "Returns difficulty attributes of beatmap with specific mode and mods combination.\n\n---\n\n### Response format\n\nField | Type\n---------- | ----\nAttributes | [DifficultyAttributes](#beatmapdifficultyattributes)", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"attributes\": {\n \"max_combo\": 100,\n ...\n }\n}", "name": "" } ] } ] }, { "name": "Beatmapset Discussions", "description": "", "item": [ { "name": "Get Beatmapset Discussion Posts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/beatmapsets\/discussions\/posts", "query": [ { "key": "beatmapset_discussion_id", "value": "illum", "description": "`id` of the [BeatmapsetDiscussion](#beatmapsetdiscussion).", "disabled": false }, { "key": "limit", "value": "12", "description": "Maximum number of results.", "disabled": false }, { "key": "page", "value": "17", "description": "Search result page.", "disabled": false }, { "key": "sort", "value": "aut", "description": "`id_desc` for newest first; `id_asc` for oldest first. Defaults to `id_desc`.", "disabled": false }, { "key": "types[]", "value": "id", "description": "`first`, `reply`, `system` are the valid values. Defaults to `reply`.", "disabled": false }, { "key": "user", "value": "quis", "description": "The `id` of the [User](#user).", "disabled": false }, { "key": "with_deleted", "value": "placeat", "description": "This param has no effect as api calls do not currently receive group permissions.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v2\/beatmapsets\/discussions\/posts?beatmapset_discussion_id=illum&limit=12&page=17&sort=aut&types%5B%5D=id&user=quis&with_deleted=placeat" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the posts of beatmapset discussions.\n\n---\n\n### Response Format\n\n