Chimu API
API V1
Resource Group ¶
Get beatmap ¶
Get beatmapGET/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
- map_id
number
(required) Example: 53Beatmap Id
200
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"
}
}
404
Headers
Content-Type: application/json
Body
null
Get beatmap set ¶
Get beatmap setGET/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
- set_id
number
(required) Example: 1Beatmap set Id
200
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
}
}
404
Headers
Content-Type: application/json
Body
null
Download beatmap set ¶
Download beatmap setGET/v1/download/{set_id}
Downloads a beatmap set using given set id NOTE: Chimu currently responses only with noVideo maps!
Example URI
- set_id
number
(required) Example: 1Beatmap set Id
200
Headers
Content-Type: application/octet-stream
400
Headers
Content-Type: text/plain
Body
// Different type of errors
"Malformed ID"
"Could not fetch set"
"Set not found"
"The beatmap could not be downloaded right now"
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}
Search for a beatmap set
Example URI
- query
string
(required) Example: peppySearch query
- amount
number
(required) Example: 100Amount of resulting beatmaps
- offset
number
(required) Example: 0Offset E.G amount + 100 would result in the next page
- status
number[]
(required) Example: 0Ranked statuses of the Beatmap Set
- mode
number[]
(required) Example: 0Required playmodes of the beatmap
- min_ar
number
(required) Example: 0Minimum AR
- max_ar
number
(required) Example: 0Maximum AR
- min_od
number
(required) Example: 0Minimum OD
- max_od
number
(required) Example: 0Maximum OD
- min_cs
number
(required) Example: 0Minimum CS
- max_cs
number
(required) Example: 0Maximum CS
- min_hp
number
(required) Example: 0Minimum HP
- max_hp
number
(required) Example: 0Maximum HP
- min_diff
number
(required) Example: 0Minimum Difficulty
- max_diff
number
(required) Example: 0Maximum Difficulty
- min_bpm
number
(required) Example: 0Minimum BPM
- max_bpm
number
(required) Example: 0Maximum BPM
- min_length
number
(required) Example: 0Minimum Beatmap length (in seconds)
- max_length
number
(required) Example: 0Maximum Beatmap length (in seconds)
- genre
number
(required) Example: 0Genre
- language
number
(required) Example: 0Language
500
Headers
Content-Type: application/json
Body
{
"code": 500,
"message": "Something bad happend",
"data": []
}
Cheesegull> Get beatmap ¶
Cheesegull> Get beatmapGET/api/b/{map_id}
Gets a beatmap.
Example URI
- map_id
number
(required) Example: 53Beatmap Id
200
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 beatmapGET/api/md5/{map_md5}
Gets a beatmap with specified md5 hash.
Example URI
- map_md5
string
(required) Example: 1d23c37a2fda439be752ae2bca06c0cdBeatmap md5
200
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 beatmapsetGET/api/s/{set_id}
Gets a beatmap set.
Example URI
- set_id
number
(required) Example: 1Beatmapset Id
200
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> SearchGET/cheesegull/search{?query,amount,offset,status,mode}
Search for a beatmap set
Example URI
- query
string
(required) Example: peppy discoSearch query
- amount
number
(required) Example: 1Amount of resulting beatmaps
- offset
number
(required) Example: 0Offset E.G amount + 100 would result in the next page
- status
number[]
(required) Example: 0Ranked statuses of the Beatmap Set
- mode
number[]
(required) Example: 0Required playmodes of the beatmap
200
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
}
]