这是一个用 Python 编写的调用 TsuguBanGDreamBot 相关各种功能 API 的库，包括绝大部分 Tsugu 提供的功能。使用本 API 库提供的方法可以实现绝大部分功能，而搭配 bestdori-api 可以实现用户绑定等其他功能。
该 API 库同时提供了异步与同步版本，可自行选择使用。
一切数据获取等操作通过配置的后端服务器进行，该 API 库只提供前端所需的调用功能。若需要使用本地数据库，请自行操作。
所有方法都同时拥有异步与同步版本。
| 功能描述 | 方法名称 |
|---|---|
| 获取活动试炼舞台信息 | event_stage |
| 模拟指定卡池抽卡结果 | gacha_simulate |
| 获取卡面图片 | get_card_illustration |
| 查询指定活动指定档位相关的历史预测线 | lsycx |
| 获取指定车牌列表的图片形式 | room_list |
| 查询符合条件的卡牌 | search_card |
| 查询符合条件的角色信息 | search_character |
| 查询符合条件的活动信息 | search_event |
| 查询指定卡池信息 | search_gacha |
| 获取玩家状态信息 | search_player |
| 查询符合条件的歌曲信息 | search_song |
| 查询指定歌曲指定难度的谱面 | song_chart |
| 查询歌曲分数表 | song_meta |
| 查询指定活动的指定档位预测线 | ycx |
| 查询指定活动的全部档位预测线 | ycx_all |
| 功能描述 | 方法名称 |
|---|---|
| 提交房间信息到后端 | station_submit_room_number |
| 从后端获取最近的房间信息列表 | station_query_all_room |
若后端不支持用户数据库，以上功能可能无法使用，请以 车站功能 API 代替。
| 功能描述 | 方法名称 |
|---|---|
| 获取用户数据 | get_user_data |
| 修改用户数据 | change_user_data |
| 发送绑定用户请求 | bind_player_request |
| 验证绑定用户请求 | bind_player_verification |
以上功能都可使用本地用户数据库代替，本 API 不提供相关的配置方法。
| 功能描述 | 方法名称 |
|---|---|
| 从车站获取最近的房间信息列表 | query_room_number |
| 提交房间信息到车站 | submit_room_number |
以下将以获取歌曲 EXIST (id=325) 的信息为例。
使用以下指令安装本模块：
$ pip3 install tsugu-api-python使用如下代码，获取指定歌曲信息图片：
from tsugu_api import search_song
def main() -> None:
result = search_song([3, 0], "EXIST") # 这里也可以传入 "325" ，具体取决于用户输入信息
main()
[3, 0]指代用户的默认服务器列表，可从通过get_user_data()方法获取的返回值中获取。
获取到的 result 将是一个 _Response 对象，当获取到准确的信息时， result 的值如下：
[
{
"type": "base64",
"string": ... # 图片的 Base64 字符串
}
]若传入的查询参数不合法或查询过程中出错，获取到的 result 的值如下：
[
{
"type": "string",
"string": ... # 错误信息
}
]异步版本的调用方式相同，只是将
tsugu_api改为tsugu_api_async即可。