返回文档首页

舞萌 DX API 文档


在本查分器中,同一首曲目的标准、DX 谱面的曲目 ID 一致,不存在大于 10000 的曲目 ID(如有,均会对 10000 取余处理)。宴会场曲目为例外,不分标准、DX 谱面,曲目 ID 大于 100000。

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

API 类型

开发者 API

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

请求头示例:

Authorization: 9sKKK47Ewi20OroB8mhr_0zOiHO3n7jwTaU9atcf2dc=

响应结构

结果将会以 JSON 格式响应:

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

POST /api/v0/maimai/player

创建或修改玩家信息。

权限

  • allow_third_party_write_data

请求体

Player

请求示例

{ "name": "Lxns", "rating": 11307, "friend_code": 123456789000000, "trophy_name": "つあメン覚醒電鉄 準急", "course_rank": 0, "class_rank": 0, "star": 82, "icon": { "id": 200201 }, "name_plate": { "id": 200201 }, "frame": { "id": 300101 } }

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

获取玩家信息。

权限

  • allow_third_party_fetch_player

URL 参数

参数名类型说明
friend_codeint好友码

响应体

Player

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

通过 QQ 号获取玩家信息。

权限

  • allow_third_party_fetch_player

URL 参数

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

响应体

Player

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

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

权限

  • allow_third_party_fetch_scores

URL 参数

参数名类型说明
friend_codeint好友码

查询参数

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

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

获取玩家缓存的 Best 50。

权限

  • allow_third_party_fetch_scores

URL 参数

参数名类型说明
friend_codeint好友码

响应体

字段名类型说明
standard_totalint旧版本谱面 Best 35 总分
dx_totalint现版本谱面 Best 15 总分
standardScore[]旧版本谱面 Best 35 列表
dxScore[]现版本谱面 Best 15 列表

GET /api/v0/maimai/player/{friend_code}/bests/ap

获取玩家缓存的 All Perfect 50。

权限

  • allow_third_party_fetch_scores

URL 参数

参数名类型说明
friend_codeint好友码

响应体

Best 50

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

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

权限

  • allow_third_party_fetch_scores

URL 参数

参数名类型说明
friend_codeint好友码

查询参数

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

响应体

Score[]

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

上传玩家成绩。

权限

  • allow_third_party_write_data

URL 参数

参数名类型说明
friend_codeint好友码

请求体

JSON 格式的玩家成绩:

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

请求示例

{ "scores": [ { "id": 834, "type": "standard", "level_index": 4, "achievements": 101, "fc": null, "fs": null, "dx_score": 0, "play_time": "2023-12-31T16:00:00Z" } ] }

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

获取玩家缓存的 Recent 50(仅增量爬取可用),按照 play_time 排序。

权限

  • allow_third_party_fetch_scores

URL 参数

参数名类型说明
friend_codeint好友码

响应体

Score[]

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

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

权限

  • allow_third_party_fetch_scores

URL 参数

参数名类型说明
friend_codeint好友码

响应体

SimpleScore[]

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

获取玩家 DX Rating 趋势。

权限

  • allow_third_party_fetch_history

查询参数

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

URL 参数

参数名类型说明
friend_codeint好友码

响应体

RatingTrend[]

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

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

权限

  • allow_third_party_fetch_history
  • allow_third_party_fetch_scores

URL 参数

参数名类型说明
friend_codeint好友码

查询参数

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

响应体

Score[]

GET /api/v0/maimai/player/{friend_code}/plate/{plate_id}

获取玩家姓名框进度。

权限

  • allow_third_party_fetch_scores

URL 参数

参数名类型说明
friend_codeint好友码
plate_idint姓名框 ID

响应体

Plate

个人 API

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

请求头示例:

X-User-Token: KVV1nwdHG5LWl6Gm-5TNqhFukwjVCz4YxzBqgYiUkCM=

GET /api/v0/user/maimai/player

获取玩家信息。

响应体

Player

GET /api/v0/user/maimai/player/scores

获取玩家所有成绩。

响应体

Score[]

POST /api/v0/user/maimai/player/scores

上传玩家成绩。

请求体

JSON 格式的玩家成绩:

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

公共 API

GET /api/v0/maimai/song/list

获取曲目列表。

查询参数

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

响应体

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

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

获取曲目信息。

查询参数

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

URL 参数

参数名类型说明
song_idint曲目 ID

响应体

Song

GET /api/v0/maimai/alias/list

获取曲目别名列表。

响应体

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

GET /api/v0/maimai/icon/list

获取头像列表。

查询参数

参数名类型说明
versionint值可空,游戏版本,默认值为 24000
requiredbool值可空,是否包含曲目需求,默认值为 false

响应体

字段名类型说明
iconsIcon[]头像列表

GET /api/v0/maimai/icon/{icon_id}

获取头像信息。

查询参数

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

URL 参数

参数名类型说明
icon_idint头像 ID

响应体

Icon

GET /api/v0/maimai/plate/list

获取姓名框列表。

查询参数

参数名类型说明
versionint值可空,游戏版本,默认值为 24000
requiredbool值可空,是否包含曲目需求,默认值为 false

响应体

字段名类型说明
platesPlate[]姓名框列表

GET /api/v0/maimai/plate/{plate_id}

获取姓名框信息。

查询参数

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

URL 参数

参数名类型说明
plate_idint姓名框 ID

响应体

Plate

GET /api/v0/maimai/frame/list

获取背景列表。

查询参数

参数名类型说明
versionint值可空,游戏版本,默认值为 24000
requiredbool值可空,是否包含曲目需求,默认值为 false

响应体

字段名类型说明
framesFrame[]背景列表

GET /api/v0/maimai/frame/{frame_id}

获取背景信息。

查询参数

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

URL 参数

参数名类型说明
frame_idint背景 ID

响应体

Frame

GET /api/v0/maimai/collection-genre/list

获取收藏品分类列表。

查询参数

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

响应体

字段名类型说明
collectionGenresCollectionGenre[]背景列表

GET /api/v0/maimai/collection-genre/{collection_genre_id}

获取收藏品分类信息。

查询参数

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

URL 参数

参数名类型说明
collection_genre_idint收藏品分类 ID

响应体

CollectionGenre

游戏资源

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

路径:

  • 头像:/icon/{icon_id}.png
  • 姓名框:/plate/{plate_id}.png
  • 曲绘:/jacket/{song_id}.png
  • 音频:/music/{song_id}.mp3

结构体

Player

玩家

字段名类型说明
namestring游戏内名称
ratingint玩家 DX Rating
friend_codeint好友码
trophyTrophy获取玩家信息返回,称号
trophy_namestring创建玩家信息必选,称号
course_rankint段位 ID
class_rankint阶级 ID
starint搭档觉醒数
iconIcon值可空,头像
name_plateNamePlate值可空,姓名框
frameFrame值可空,背景
upload_timestring获取玩家信息返回,玩家被同步时的 UTC 时间

Score

游玩成绩

字段名类型说明
idint曲目 ID
song_namestring仅获取 Score 时返回,曲名
levelstring仅获取 Score 时返回,难度标级,如 14+
level_indexLevelIndex难度
achievementsfloat达成率
fcFCType值可空,FULL COMBO 类型
fsFSType值可空,FULL SYNC 类型
dx_scoreintDX 分数
dx_ratingfloat仅获取 Score 时返回,DX Rating,计算时需要向下取整
rateRateType仅获取 Score 时返回,评级类型
typeSongType谱面类型
play_timestring值可空,游玩的 UTC 时间,精确到分钟
upload_timestring仅获取 Score 时返回,成绩被同步时的 UTC 时间

SimpleScore

游玩成绩(简化)

字段名类型说明
idint曲目 ID
song_namestring曲名
levelstring难度标级,如 14+
level_indexLevelIndex难度
fcFCType值可空,FULL COMBO 类型
fsFSType值可空,FULL SYNC 类型
rateRateType评级类型
typeSongType谱面类型

RatingTrend

DX Rating 趋势

字段名类型说明
totalint总 DX Rating
standardint旧版本谱面总 DX Rating
dxint现版本谱面总 DX Rating
datestring日期

Song

曲目

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

SongDifficulties

谱面难度

字段名类型说明
standardSongDifficulty[]曲目标准谱面难度列表
dxSongDifficulty[]曲目 DX 谱面难度列表
utageSongDifficultyUtage[]可选,宴会场曲目谱面难度列表

SongDifficulty

谱面难度

字段名类型说明
typeSongType谱面类型
difficultyLevelIndex难度
levelstring难度标级
level_valuefloat谱面定数
note_designerstring谱师
versionint谱面首次出现版本
notesNotes值可空,谱面物量

SongDifficultyUtage

宴会场曲目谱面难度

字段名类型说明
kanjistring谱面属性
descriptionstring谱面描述
is_buddybool是否为 BUDDY 谱面
notesNotesBuddyNotes值可空,谱面物量

Notes

谱面物量

字段名类型说明
totalint总物量
tapintTAP 物量
holdintHOLD 物量
slideintSLIDE 物量
touchintTOUCH 物量
breakintBREAK 物量

BuddyNotes

仅宴会场曲目,BUDDY 谱面物量

字段名类型说明
leftNotes1P 谱面物量
rightNotes2P 谱面物量

Genre

乐曲分类

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

Version

曲目版本

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

Alias

曲目别名

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

Collection

收藏品

字段名类型说明
idint收藏品 ID
namestring收藏品名称
colorstring值可空,仅玩家称号,称号颜色
descriptionstring值可空,收藏品说明
genrestring值可空,除玩家称号,收藏品分类(日文)
requiredCollectionRequired[]值可空,收藏品要求

CollectionRequired

收藏品要求

字段名类型说明
difficultiesLevelIndex[]值可空,要求的谱面难度,长度为 0 时代表任意难度
rateRateType值可空,要求的评级类型
fcFCType值可空,要求的 FULL COMBO 类型
fsFSType值可空,要求的 FULL SYNC 类型
songsCollectionRequiredSong[]值可空,要求的曲目列表
completedbool值可空,要求是否全部完成

CollectionRequiredSong

收藏品要求曲目

字段名类型说明
idint曲目 ID
titlestring曲名
typeSongType谱面类型
completedbool值可空,要求的曲目是否完成
completed_difficultiesLevelIndex[]值可空,已完成的难度

CollectionGenre

收藏品分类

字段名类型说明
idint收藏品分类 ID
titlestring分类标题
genrestring分类标题(日文)

枚举类型

LevelIndex

难度

类型说明
0intBASIC
1intADVANCED
2intEXPERT
3intMASTER
4intRe:MASTER

FCType

FULL COMBO 类型

类型说明
appstringAP+
apstringAP
fcpstringFC+
fcstringFC

FSType

FULL SYNC 类型

类型说明
fsdpstringFDX+
fsdstringFDX
fspstringFS+
fsstringFS
syncstringSYNC PLAY

RateType

评级类型

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

SongType

谱面类型

类型说明
standardstring标准谱面
dxstringDX 谱面
utagestring宴会场谱面

目录