Chimu API

NOTE: Some API Endpoints need a special API key which are only for patreon or given away
by @Mempler#6666 on Discord
or via E-Mail at [email protected]!

API V1

Resource Group ¶

Get beatmap ¶

Get beatmap
GET`/v1/map/{map_id}`

Gets a beatmap. if it fails it returns a simple JSON Serialized error including a message and error code.

Example URI

GET https://api.chimu.moe/v1/map/53

URI Parameters

HideShow

map_id: number (required) Example: 53
Beatmap Id

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "code": 0,
  "message": "",
  "data": {
    "BeatmapId": 53,
    "ParentSetId": 3,
    "DiffName": "-Crusin-",
    "FileMD5": "1d23c37a2fda439be752ae2bca06c0cd",
    "Mode": 0,
    "BPM": 172,
    "AR": 4,
    "OD": 4,
    "CS": 5,
    "HP": 3,
    "TotalLength": 83,
    "HitLength": 77,
    "Playcount": 101574,
    "Passcount": 47994,
    "MaxCombo": 124,
    "DifficultyRating": 1.86918,
    "OsuFile": "Ni-Ni - 1,2,3,4, 007 [Wipeout Series] (MCXD) [-Crusin-].osu",
    "DownloadPath": "/d/3"
  }
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
  "code": 104,
  "message": "Error: Beatmap not found!",
  "data": []
}

Get beatmap set ¶

Get beatmap set
GET`/v1/set/{set_id}`

Gets a beatmap set. if it fails it returns a simple JSON Serialized error including a message and error code.

Example URI

GET https://api.chimu.moe/v1/set/1

URI Parameters

HideShow

set_id: number (required) Example: 1
Beatmap set Id

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "code": 0,
  "message": "",
  "data": {
    "SetId": 1,
    "ChildrenBeatmaps": [
      {
        "BeatmapId": 75,
        "ParentSetId": 1,
        "DiffName": "Normal",
        "FileMD5": "a5b99395a42bd55bc5eb1d2411cbdf8b",
        "Mode": 0,
        "BPM": 119.999,
        "AR": 6,
        "OD": 6,
        "CS": 4,
        "HP": 6,
        "TotalLength": 142,
        "HitLength": 109,
        "Playcount": 467474,
        "Passcount": 57119,
        "MaxCombo": 314,
        "DifficultyRating": 2.40729,
        "OsuFile": "Kenji Ninuma - DISCO PRINCE (peppy) [Normal].osu",
        "DownloadPath": "/d/1"
      }
    ],
    "RankedStatus": 1,
    "ApprovedDate": "2007-10-06T17:46:31",
    "LastUpdate": "2007-10-06T17:46:31",
    "LastChecked": "2021-01-19T09:43:57",
    "Artist": "Kenji Ninuma",
    "Title": "DISCO PRINCE",
    "Creator": "peppy",
    "Source": "",
    "Tags": "katamari",
    "HasVideo": false,
    "Genre": 2,
    "Language": 3,
    "Favourites": 789,
    "Disabled": false
  }
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
  "code": 104,
  "message": "Error: Beatmap set not found!",
  "data": []
}

Download beatmap set ¶

Download beatmap set
GET`/v1/download/{set_id}{?n}`

Downloads a beatmap set using given set id

Example URI

GET https://api.chimu.moe/v1/download/1?n=1

URI Parameters

HideShow

set_id: number (required) Example: 1
Beatmap set Id
n: string (required) Example: 1
Download either with or without video.

Response 302

HideShow

Headers

https: //ipfs.chimu.moe/ipfs/QmbrVpStvVtznG5p8u5HebThepUaGgK7dmRbeUTXqrBEvK?filename=1 Kenji Ninuma - DISCO PRINCE.osz

Response 403

HideShow

Headers

Content-Type: application/json

Body

// if {k} is not set
{
    "code": 102,
    "message": "Error: key is not set!",
    "data": []
}

// if {s} is not set
{
    "code": 103,
    "message": "Error: state is not set!",
    "data": []
}

// if {k} is invalid
{
    "code": 102,
    "message": "Error: Invalid Key!",
    "data": []
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

// if {set_id} is not an int set
{
    "code": 101,
    "message": "Error: ABVC is not an int!",
    "data": []
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

// if we don't know about this beatmap.
{
    "code": 104,
    "message": "Error: Beatmap not found!",
    "data": []
}

// if we dont have this beatmap and cant download it.
{
    "code": 105,
    "message": "Error: Beatmap unavailable!",
    "data": []
}

Search ¶

Search
GET`/v1/search{?query,amount,offset,status,mode,min_ar,max_ar,min_od,max_od,min_cs,max_cs,min_hp,max_hp,min_diff,max_diff,min_bpm,max_bpm,min_length,max_length,genre,language}`

Search for a beatmap set

Example URI

GET https://api.chimu.moe/v1/search?query=peppy&amount=100&offset=0&status=0&mode=0&min_ar=0&max_ar=0&min_od=0&max_od=0&min_cs=0&max_cs=0&min_hp=0&max_hp=0&min_diff=0&max_diff=0&min_bpm=0&max_bpm=0&min_length=0&max_length=0&genre=0&language=0

URI Parameters

HideShow

query: string (required) Example: peppy
Search query
amount: number (required) Example: 100
Amount of resulting beatmaps
offset: number (required) Example: 0
Offset E.G amount + 100 would result in the next page
status: number (required) Example: 0
Ranked status of the Beatmap Set
mode: number (required) Example: 0
Required playmode of the beatmap
min_ar: number (required) Example: 0
Minimum AR
max_ar: number (required) Example: 0
Maximum AR
min_od: number (required) Example: 0
Minimum OD
max_od: number (required) Example: 0
Maximum OD
min_cs: number (required) Example: 0
Minimum CS
max_cs: number (required) Example: 0
Maximum CS
min_hp: number (required) Example: 0
Minimum HP
max_hp: number (required) Example: 0
Maximum HP
min_diff: number (required) Example: 0
Minimum Difficulty
max_diff: number (required) Example: 0
Maximum Difficulty
min_bpm: number (required) Example: 0
Minimum BPM
max_bpm: number (required) Example: 0
Maximum BPM
min_length: number (required) Example: 0
Minimum Beatmap length (in seconds)
max_length: number (required) Example: 0
Maximum Beatmap length (in seconds)
genre: number (required) Example: 0
Genre
language: number (required) Example: 0
Language

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
  "code": 101,
  "message": "Error: ABCD is not an int!",
  "data": []
}

Cheesegull> Get beatmap ¶

Cheesegull> Get beatmap
GET`/cheesegull/b/{map_id}`

Gets a beatmap.

Example URI

GET https://api.chimu.moe/cheesegull/b/53

URI Parameters

HideShow

map_id: number (required) Example: 53
Beatmap Id

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "BeatmapID": 53,
  "ParentSetID": 3,
  "DiffName": "-Crusin-",
  "FileMD5": "1d23c37a2fda439be752ae2bca06c0cd",
  "Mode": 0,
  "BPM": 172,
  "AR": 4,
  "OD": 4,
  "CS": 5,
  "HP": 3,
  "TotalLength": 83,
  "HitLength": 77,
  "Playcount": 101574,
  "Passcount": 47994,
  "MaxCombo": 124,
  "DifficultyRating": 1.86918
}

Cheesegull> Get beatmap ¶

Cheesegull> Get beatmap
GET`/cheesegull/md5/{map_md5}`

Gets a beatmap with specified md5 hash.

Example URI

GET https://api.chimu.moe/cheesegull/md5/1d23c37a2fda439be752ae2bca06c0cd

URI Parameters

HideShow

map_md5: string (required) Example: 1d23c37a2fda439be752ae2bca06c0cd
Beatmap md5

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "BeatmapID": 53,
  "ParentSetID": 3,
  "DiffName": "-Crusin-",
  "FileMD5": "1d23c37a2fda439be752ae2bca06c0cd",
  "Mode": 0,
  "BPM": 172,
  "AR": 4,
  "OD": 4,
  "CS": 5,
  "HP": 3,
  "TotalLength": 83,
  "HitLength": 77,
  "Playcount": 101574,
  "Passcount": 47994,
  "MaxCombo": 124,
  "DifficultyRating": 1.86918
}

Cheesegull> Get beatmapset ¶

Cheesegull> Get beatmapset
GET`/cheesegull/s/{set_id}`

Gets a beatmap set.

Example URI

GET https://api.chimu.moe/cheesegull/s/1

URI Parameters

HideShow

set_id: number (required) Example: 1
Beatmapset Id

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "SetID": 1,
  "ChildrenBeatmaps": [
    {
      "BeatmapID": 75,
      "ParentSetID": 1,
      "DiffName": "Normal",
      "FileMD5": "a5b99395a42bd55bc5eb1d2411cbdf8b",
      "Mode": 0,
      "BPM": 119.999,
      "AR": 6,
      "OD": 6,
      "CS": 4,
      "HP": 6,
      "TotalLength": 142,
      "HitLength": 109,
      "Playcount": 467474,
      "Passcount": 57119,
      "MaxCombo": 314,
      "DifficultyRating": 2.40729
    }
  ],
  "RankedStatus": 1,
  "ApprovedDate": "2007-10-06T17:46:31Z",
  "LastUpdate": "2007-10-06T17:46:31Z",
  "LastChecked": "2021-01-19T09:43:57Z",
  "Artist": "Kenji Ninuma",
  "Title": "DISCO PRINCE",
  "Creator": "peppy",
  "Source": "",
  "Tags": "katamari",
  "HasVideo": false,
  "Genre": 2,
  "Language": 3,
  "Favourites": 789
}

Cheesegull> Search ¶

Cheesegull> Search
GET`/cheesegull/search{?query,amount,offset,status,mode}`

Search for a beatmap set

Example URI

GET https://api.chimu.moe/cheesegull/search?query=peppy disco&amount=1&offset=0&status=0&mode=0

URI Parameters

HideShow

query: string (required) Example: peppy disco
Search query
amount: number (required) Example: 1
Amount of resulting beatmaps
offset: number (required) Example: 0
Offset E.G amount + 100 would result in the next page
status: number (required) Example: 0
Ranked status of the Beatmap Set
mode: number (required) Example: 0
Required playmode of the beatmap

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "SetID": 1,
    "ChildrenBeatmaps": [
      {
        "BeatmapID": 75,
        "ParentSetID": 1,
        "DiffName": "Normal",
        "FileMD5": "a5b99395a42bd55bc5eb1d2411cbdf8b",
        "Mode": 0,
        "BPM": 119.999,
        "AR": 6,
        "OD": 6,
        "CS": 4,
        "HP": 6,
        "TotalLength": 142,
        "HitLength": 109,
        "Playcount": 467474,
        "Passcount": 57119,
        "MaxCombo": 314,
        "DifficultyRating": 2.40729
      }
    ],
    "RankedStatus": 1,
    "ApprovedDate": "2007-10-06T17:46:31Z",
    "LastUpdate": "2007-10-06T17:46:31Z",
    "LastChecked": "2021-01-19T09:43:57Z",
    "Artist": "Kenji Ninuma",
    "Title": "DISCO PRINCE",
    "Creator": "peppy",
    "Source": "",
    "Tags": "katamari",
    "HasVideo": false,
    "Genre": 2,
    "Language": 3,
    "Favourites": 789
  }
]

API V1 ¶

Resource Group ¶

Get beatmap ¶

Get beatmapGET/v1/map/{map_id}

Example URI

Headers

Body

Headers

Body

Get beatmap set ¶

Get beatmap setGET/v1/set/{set_id}

Example URI

Headers

Body

Headers

Body

Download beatmap set ¶

Download beatmap setGET/v1/download/{set_id}{?n}

Example URI

Headers

Headers

Body

Headers

Body

Headers

Body

Search ¶

SearchGET/v1/search{?query,amount,offset,status,mode,min_ar,max_ar,min_od,max_od,min_cs,max_cs,min_hp,max_hp,min_diff,max_diff,min_bpm,max_bpm,min_length,max_length,genre,language}

Example URI

Headers

Body

Cheesegull> Get beatmap ¶

Cheesegull> Get beatmapGET/cheesegull/b/{map_id}

Example URI

Headers

Body

Cheesegull> Get beatmap ¶

Cheesegull> Get beatmapGET/cheesegull/md5/{map_md5}

Example URI

Headers

Body

Cheesegull> Get beatmapset ¶

Cheesegull> Get beatmapsetGET/cheesegull/s/{set_id}

Example URI

Headers

Body

Cheesegull> Search ¶

Cheesegull> SearchGET/cheesegull/search{?query,amount,offset,status,mode}

Example URI

Headers

Body

API V1

Get beatmap
GET`/v1/map/{map_id}`

Get beatmap set
GET`/v1/set/{set_id}`

Download beatmap set
GET`/v1/download/{set_id}{?n}`

Search
GET`/v1/search{?query,amount,offset,status,mode,min_ar,max_ar,min_od,max_od,min_cs,max_cs,min_hp,max_hp,min_diff,max_diff,min_bpm,max_bpm,min_length,max_length,genre,language}`

Cheesegull> Get beatmap
GET`/cheesegull/b/{map_id}`

Cheesegull> Get beatmap
GET`/cheesegull/md5/{map_md5}`

Cheesegull> Get beatmapset
GET`/cheesegull/s/{set_id}`

Cheesegull> Search
GET`/cheesegull/search{?query,amount,offset,status,mode}`