1. 谱面 (Charts)
Milracle-v2
  • 认证 (Auth)
    • 重定向认证操作 (OIDC / GitHub OAuth 回调)
      GET
    • 认证操作
      POST
  • 谱面 (Charts)
    • 获取谱面列表或详情
      GET
    • 删除谱面
      DELETE
    • 删除谱面 (兼容旧客户端,使用 POST 代替 DELETE)
      POST
    • Studio 管理:获取审核队列(支持待审核 / 上架申请 / 已通过 / 已上架 / 已拒绝等)
      GET
    • Studio 操作:投票 / 申请上架 / 处理上架
      POST
  • 成绩 (Scores)
    • 获取成绩
      GET
    • 上传成绩
      POST
  • 游玩记录 (Records)
    • 获取游玩记录
      GET
    • 上传游玩记录
      POST
  • 资源包 (Resource Packs)
    • 获取资源包列表/详情或下载资源包
      GET
    • 上传资源包或审核资源包
      POST
  • 用户 (User)
    • 获取用户信息或用户列表
      GET
    • 用户操作(某些操作需管理员权限,例如修改其他用户)
      POST
  • 管理员 (Admin)
    • 管理员查询
      GET
    • 管理员更新
      PUT
  • 内容 (Content)
    • 获取内容
      GET
    • 创建内容
      POST
    • 更新内容
      PUT
    • 删除内容
      DELETE
  • 上传 (Upload)
    • 获取 presigned 上传地址 / 头像代理
    • 文件上传
  • 工具 (Utils)
    • 获取谱面元数据(不再服务端打包 zip)
  • 工单 (Tickets)
    • 工单: 列表 / 详情 / 统计
    • 工单: 创建 / 回复 / 认领 / 结案 / 驳回
  • 数据模型
    • User
    • Chart
    • ChartAsset
    • Error
    • Score
    • Record
    • ResourcePack
    • RecordProperties
  1. 谱面 (Charts)

获取谱面列表或详情

GET
/api/v2/charts
支持多种 action:list(获取列表),detail(获取详情),history(获取谱面历史事件,返回 data: [ { type, ts, actor_id, actor_name?, detail? } ];type='audit' 为管理操作审计:delete/hide/reject/restore/re-review/vote/publish_approved/publish_rejected,携带 actor_name/action/detail)。moderate / like 仅 POST / DELETE 支持,GET 不支持。list/detail/history 响应均可能命中 Redis 与进程内短期缓存;上传、删除、审核投票、发布审批、管理员状态更新会主动失效对应的列表/详情/历史缓存。history 响应的远端缓存 TTL 约 300 秒。

请求参数

Query 参数

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location 'https://api.xhsr.org.cn/api/v2/charts?action=&id=chart1&sort=newest&page=1&limit=20&status=&q=&published=&uploader_id='

返回响应

🟢200
application/json
成功。action=list 时 data 为下述对象数组(列表行含 meta_url、extra_url(null)、assets_manifest([]));action=detail 时 data 为单个谱面详情对象(Chart 字段 + detail 专属字段:file_url、description、play_count、like_count、published、offset_val、uploader_avatar、is_liked);action=history 时 data 为事件行数组。
Bodyapplication/json

示例
{
    "data": [
        {
            "id": 3,
            "title": "エゴイスト",
            "artist": "大沼パセリ feat. flower",
            "charter": "LPI -\"EGOIST\"-",
            "difficulty": "Cloudburst",
            "level": "11.5",
            "bpm": "180",
            "cover_url": "https://file.starsriverorg.cn/charts/1765342698163-image.png",
            "chart_url": "https://file.starsriverorg.cn/charts/1765342698163-chart.json",
            "meta_url": "https://file.starsriverorg.cn/charts/pkg_1765342698163/meta.json",
            "audio_url": "https://file.starsriverorg.cn/charts/1765342696394-audio.mp3",
            "allow_ai_learning": false,
            "created_at": "2025-12-10T04:58:22.476Z",
            "status": "approved",
            "uploader_id": 2,
            "uploader_name": "SeRazon_test"
        },
        {
            "id": 2,
            "title": "エゴイスト",
            "artist": "大沼パセリ feat. flower",
            "charter": "LPI -\"EGOIST\"-",
            "difficulty": "Cloudburst",
            "level": "11.5",
            "bpm": "180",
            "cover_url": "https://file.starsriverorg.cn/charts/1765295953923-image.png",
            "chart_url": null,
            "meta_url": "https://file.starsriverorg.cn/charts/recovered/2/meta.json",
            "audio_url": "https://file.starsriverorg.cn/charts/1765295948409-audio.mp3",
            "allow_ai_learning": false,
            "created_at": "2025-12-09T15:59:22.170Z",
            "status": "approved",
            "uploader_id": 1,
            "uploader_name": "SeRazon"
        }
    ]
}
🟠400
🟠401
🟠403
🟠404
🔴500
修改于 2026-10-07 10:19:10
上一页
认证操作
下一页
删除谱面
Built with