返回文档首页

中二节奏 API 文档


API 返回的所有时间均为 UTC 时间,其格式形似 2024-01-01T00:00:00Z,代表北京时间上午 8 时。

API 类型

开发者 API

开发者 API 的所有请求均需要在请求头加入开发者 API 密钥,如果没有,请申请成为开发者获取。

请求头示例:

Authorization: 9sKKK47Ewi20OroB8mhr_0zOiHO3n7jwTaU9atcf2dc=

响应结构

结果将会以 JSON 格式响应:

字段名类型说明
successbool请求是否成功处理
codeintHTTP 状态码,通常为 200
messagestring值可空,请求失败理由
datadictlist值可空,请求结果

POST /api/v0/chunithm/player

创建或修改玩家信息。

权限

  • allow_third_party_write_data

请求体

Player

请求示例

{ "name": "ωγαp×", "level": 1, "rating": 0.18, "friend_code": 123456789000000, "class_emblem": { "base": 0, "medal": 0 }, "reborn_count": 0, "over_power": 13.2, "over_power_progress": 0.01, "currency": 4500, "total_currency": 5000, "total_play_count": 2, "trophy": { "id": 866 }, "character": { "id": 16620, "level": 1 }, "name_plate": { "id": 10131 }, "map_icon": { "id": 19 } }

GET /api/v0/chunithm/player/{friend_code}

获取玩家信息。

权限

  • allow_third_party_fetch_player

URL 参数

参数名类型说明
friend_codeint好友码

响应体

Player

GET /api/v0/chunithm/player/qq/{qq}

通过 QQ 号获取玩家信息。

权限

  • allow_third_party_fetch_player

URL 参数

参数名类型说明
qqint查分器用户绑定的 QQ 号

响应体

Player

GET /api/v0/chunithm/player/{friend_code}/best

获取玩家缓存谱面的最佳成绩。

权限

  • allow_third_party_fetch_scores

URL 参数

参数名类型说明
friend_codeint好友码

查询参数

参数名类型说明
song_idint曲目 ID,与 song_name 冲突
song_namestring曲名,与 song_id 冲突
level_indexLevelIndex难度

GET /api/v0/chunithm/player/{friend_code}/bests

获取玩家缓存的 Best 30、Selection 10 与 Recent 10。

权限

  • allow_third_party_fetch_scores

URL 参数

参数名类型说明
friend_codeint好友码

响应体

字段名类型说明
bestsScore[]Best 30 列表
selectionsScore[]Selection 10 列表
recentsScore[]Recent 10 列表

GET /api/v0/chunithm/player/{friend_code}/bests

获取玩家缓存单曲所有谱面的成绩。

权限

  • allow_third_party_fetch_scores

URL 参数

参数名类型说明
friend_codeint好友码

查询参数

参数名类型说明
song_idint曲目 ID,与 song_name 冲突
song_namestring曲名,与 song_id 冲突

POST /api/v0/chunithm/player/{friend_code}/scores

上传玩家成绩。

权限

  • allow_third_party_write_data

URL 参数

参数名类型说明
friend_codeint好友码

请求体

JSON 格式的玩家成绩:

字段名类型说明
scoresScore[]玩家成绩

请求示例

{ "scores": [ { "id": 3, "level_index": 4, "score": 1010000, "clear": "clear", "full_combo": "alljustice", "full_chain": "fullchain2", "play_time": "2024-01-09T16:00:00Z" } ] }

GET /api/v0/chunithm/player/{friend_code}/recents

获取玩家缓存的 Recent 50,按照 play_time 排序。

权限

  • allow_third_party_fetch_scores

URL 参数

参数名类型说明
friend_codeint好友码

响应体

Score[]

GET /api/v0/chunithm/player/{friend_code}/scores

获取玩家缓存的所有最佳成绩(简化后)。

权限

  • allow_third_party_fetch_scores

URL 参数

参数名类型说明
friend_codeint好友码

响应体

SimpleScore[]

GET /api/v0/chunithm/player/{friend_code}/trend

获取玩家 Rating 趋势。

权限

  • allow_third_party_fetch_history

查询参数

参数名类型说明
versionint值可空,游戏版本,默认值为 22000

URL 参数

参数名类型说明
friend_codeint好友码

响应体

RatingTrend[]

GET /api/v0/chunithm/player/{friend_code}/score/history

获取玩家成绩上传历史记录。

权限

  • allow_third_party_fetch_history
  • allow_third_party_fetch_scores

URL 参数

参数名类型说明
friend_codeint好友码

查询参数

参数名类型说明
song_idint曲目 ID
level_indexLevelIndex难度

响应体

Score[]

个人 API

个人 API 的所有请求均需要在请求头加入个人 API 密钥,如果没有,请前往账号详情生成。

请求头示例:

X-User-Token: KVV1nwdHG5LWl6Gm-5TNqhFukwjVCz4YxzBqgYiUkCM=

GET /api/v0/user/chunithm/player

获取玩家信息。

响应体

Player

GET /api/v0/user/chunithm/player/scores

获取玩家所有成绩。

响应体

Score[]

POST /api/v0/user/chunithm/player/scores

上传玩家成绩。

请求体

JSON 格式的玩家成绩:

字段名类型说明
scoresScore[]玩家成绩

公共 API

GET /api/v0/chunithm/song/list

获取曲目列表。

查询参数

参数名类型说明
versionint值可空,游戏版本,默认值为 22000
notesbool值可空,是否包含谱面物量,默认值为 false

响应体

字段名类型说明
songsSong[]曲目列表
genresGenre[]乐曲分类列表
versionsVersion[]曲目版本列表

GET /api/v0/chunithm/song/{song_id}

获取曲目信息。

查询参数

参数名类型说明
versionint值可空,游戏版本,默认值为 22000

URL 参数

参数名类型说明
song_idint曲目 ID

响应体

Song

GET /api/v0/chunithm/alias/list

获取曲目别名列表。

响应体

字段名类型说明
aliasesAlias[]曲目别名列表

游戏资源

基础 URL:https://assets2.lxns.net/chunithm

路径:

  • 角色:/character/{character_id}.png
  • 曲绘:/jacket/{song_id}.png
  • 音频:/music/{song_id}.mp3

结构体

Player

玩家

字段名类型说明
namestring游戏内名称
levelint玩家等级,最大值为 99
ratingint玩家 Rating
rating_possessionstring玩家 Rating 领域颜色
friend_codeint好友码
class_emblemClassEmblemCLASS 勋章
reborn_countint玩家等级突破次数
over_powerfloat总 OVER POWER
over_power_progressfloatOVER POWER 总进度
currencyint当前金币数
total_currencyint总金币数
total_play_countint总游玩次数
trophyTrophy称号
characterCharacter值可空,角色
name_plateNamePlate值可空,名牌版
map_iconMapIcon值可空,地图头像
upload_timestring获取玩家信息返回,玩家被同步时的 UTC 时间

ClassEmblem

CLASS 勋章

字段名类型说明
baseint缎带(通关该组别全部课题组),默认值为 0
medalint勋章(通关任意一组),默认值为 0

Score

游玩成绩

字段名类型说明
idint曲目 ID
song_namestring仅获取 Score 时返回,曲名
levelstring仅获取 Score 时返回,难度标级,如 14+
level_indexLevelIndex难度
scoreint分数
ratingfloat仅获取 Score 时返回,Rating
over_powerfloat仅获取 Score 时返回,OVER POWER
clearClearTypeCLEAR 类型
full_comboFullComboType值可空,FULL COMBO 类型
full_chainFullChainType值可空,FULL CHAIN 类型
rankRankType仅获取 Score 时返回,评级类型
play_timestring值可空,游玩的 UTC 时间,精确到分钟
upload_timestring仅获取 Score 时返回,成绩被同步时的 UTC 时间

SimpleScore

游玩成绩(简化)

字段名类型说明
idint曲目 ID
song_namestring曲名
levelstring难度标级,如 14+
level_indexLevelIndex难度
clearClearTypeCLEAR 类型
full_comboFullComboType值可空,FULL COMBO 类型
full_chainFullChainType值可空,FULL CHAIN 类型
rankRankType评级类型

RatingTrend

Rating 趋势

字段名类型说明
ratingfloat总平均 Rating
bests_ratingfloatBest 30 平均 Rating
selections_ratingfloatSelection 10 平均 Rating
recents_ratingfloatRecent 10(MAX)平均 Rating
datestring日期

Song

曲目

字段名类型说明
idint曲目 ID
titlestring曲名
artiststring艺术家
genrestring曲目分类
bpmint曲目 BPM
mapstring值可空,曲目所属地图
versionint曲目首次出现版本
disabledbool值可空,是否被禁用,默认值为 false
difficultiesSongDifficulty[]谱面难度

SongDifficulty

谱面难度

字段名类型说明
difficultyLevelIndex难度
levelstring难度标级
level_valuefloat谱面定数
note_designerstring谱师
versionint谱面首次出现版本
notesNotes值可空,谱面物量
kanjistring仅 WORLD'S END 难度,谱面属性
starint仅 WORLD'S END 难度,谱面星级

Notes

谱面物量

字段名类型说明
totalint总物量
tapintTAP 物量
holdintHOLD 物量
slideintSLIDE 物量
airintAIR 物量
flickintFLICK 物量

Genre

乐曲分类

字段名类型说明
idint内部 ID
genrestring分类标题(日文)

Version

曲目版本

字段名类型说明
idint内部 ID
titlestring版本标题
versionint主要版本 ID

Alias

曲目别名

字段名类型说明
song_idint曲目 ID
aliasesstring[]曲目所有别名

Collection

收藏品

字段名类型说明
idint收藏品 ID
namestring收藏品名称
colorstring值可空,仅玩家称号,称号颜色
levelint值可空,仅玩家角色,角色等级

枚举类型

LevelIndex

难度

类型说明
0intBASIC
1intADVANCED
2intEXPERT
3intMASTER
4intULTIMA
5intWORLD'S END

ClearType

CLEAR 类型

类型说明
catastrophystringCATASTROPHY
absolutepstringABSOLUTE+
absolutestringABSOLUTE
hardstringHARD
clearstringCLEAR
failedstringFAILED

FullComboType

FULL COMBO 类型

类型说明
alljusticecriticalstringAJC
alljusticestringALL JUSTICE
fullcombostringFULL COMBO

FullChainType

FULL CHAIN 类型

类型说明
fullchainstring铂 FULL CHAIN
fullchain2string金 FULL CHAIN

RankType

评级类型

类型说明
ssspstringSSS+
sssstringSSS
sspstringSS+
ssstringSS
spstringS+
sstringS
aaastringAAA
aastringAA
astringA
bbbstringBBB
bbstringBB
bstringB
cstringC
dstringD

目录