get-danmu：多平台弹幕获取与服务工具

1. 文件名匹配接口

测试中使用该接口的媒体播放客户端有Hills

POST /api/v2/match

接口说明

此接口用于当用户打开某视频文件时，可以通过文件名称、Hash等信息查找此视频可能对应的节目信息。

此接口首先会使用Hash信息进行搜寻，如果有相应的记录，会返回“精确关联”的结果（即isMatched属性为true，此时列表中只包含一个搜索结果）。

如果Hash信息匹配失败，则会继续通过文件名进行模糊搜寻。

返回值说明

一个包含节目信息的列表，节目在列表中排名越靠前，这个节目越有可能是视频文件的内容。当列表中只有一个节目时（isMatched属性为true），视为“精确关联”——说明此视频已被人工关联了某一节目。客户端应自动选择这个唯一的结果，不必再让用户做出选择。

请求体

{
  "fileName": "string",
  "fileHash": "string",
  "fileSize": 0,
  "videoDuration": 0,
  "matchMode": "hashAndFileName"
}复制

其中以fileName参数最为重要，本工具就是使用fileName参数进行匹配的。

返回数据

{
  "errorCode": 0,
  "success": true,
  "errorMessage": "string",
  "isMatched": true,
  "matches": [
    {
      "episodeId": 0,
      "animeId": 0,
      "animeTitle": "string",
      "episodeTitle": "string",
      "type": "tvseries",
      "typeDescription": "string",
      "shift": 0,
      "imageUrl": "string"
    }
  ]
}复制

2. 搜索接口

对于打开视频直接使用搜索接口进行查询的媒体客户端有Yamby

GET /api/v2/search/anime?keyword=

接口说明

根据用户提供的关键词，在数据库中搜索对应的作品信息，搜索结果中不包含剧集信息。

关键词说明

关键词长度至少为2。关键词中的空格将被认定为%匹配，其他字符将被作为原始字符去搜索。

请求方式

get,在url中传递keyword或请求体中传递keyword即可。

返回数据

{
  "errorCode": 0,
  "success": true,
  "errorMessage": "string",
  "animes": [
    {
      "animeId": 0,
      "bangumiId": "string",
      "animeTitle": "string",
      "type": "tvseries",
      "typeDescription": "string",
      "imageUrl": "string",
      "startDate": "2025-10-31T14:22:44.592Z",
      "episodeCount": 0,
      "rating": 0,
      "isFavorited": true
    }
  ]
}复制

3. 剧集搜索接口

此接口用于获取指定编号的作品的详细数据，包括简介、评分、详细剧集等。

GET /api/v2/bangumi/bangumiId

参数说明

bangumiId：支持传入数字形式的 animeId（如 18319）或字符串形式的 bangumiId（如 "tmdb-movie-21832"）。

请求方式

get,在url中传递bangumiId即可。

返回数据

{
    "errorCode": 0,
    "success": true,
    "errorMessage": "error",
    "bangumi": {
        "episodes": [
            {
                "seasonId": "string",
                "episodeId": 0,
                "episodeTitle": "string",
                "episodeNumber": "string",
                "lastWatched": "2025-10-31T14:27:24.947Z",
            }
        ]
    }
}复制

4. 弹幕获取接口

此接口用于获取本工具数据库中记载的指定弹幕库的弹幕数据

GET /api/v2/comment/episodeId

参数说明

episodeId：只支持传入数字形式的 episodeId，episodeId的值可参考第三步的剧集搜索的结果也可参考第一步的搜索结果。

请求方式

get,在url中传递episodeId即可。

返回数据

{
  "count": 0,
  "comments": [
    {
      "cid": 0,
      "p": "string",
      "m": "string"
    }
  ]
}复制

返回值说明

字段p的说明：格式为出现时间,模式,颜色,用户ID，各个值之间使用英文逗号分隔

• 弹幕出现时间：格式为 0.00，单位为秒，精确到小数点后两位，例如12.34、445.6、789.01
• 弹幕模式：1-普通弹幕，4-底部弹幕，5-顶部弹幕
• 颜色：32位整数表示的颜色，算法为 Rx256x256+Gx256+B，R/G/B的范围应是0-255
• 用户ID：字符串形式表示的用户ID，通常为数字，不会包含特殊字符