公开 API
StarRailAssistant 提供了一套免费的公开 REST API,用于获取主流游戏的活动与公告数据。无需认证,直接调用即可。
API 端点
Section titled “API 端点”所有 API 的基础地址为:
https://starrailassistant.top/api/v1获取活动数据
Section titled “获取活动数据”GET /activity/{game}.json| 参数 | 类型 | 说明 |
|---|---|---|
game |
string | 游戏标识 |
GET https://starrailassistant.top/api/v1/activity/sr.jsonGET https://starrailassistant.top/api/v1/activity/ys.jsonGET https://starrailassistant.top/api/v1/activity/zzz.jsonGET https://starrailassistant.top/api/v1/activity/ww.jsonGET https://starrailassistant.top/api/v1/activity/nte.json{ "version": "4.4", "versionName": "鸣笛于归寂之时", "startTime": "2026-07-15T06:00:00", "endTime": "2026-08-26T06:00:00", "cover": "https://...", "activities": [ { "name": "反贪「砖」家", "description": "世上没有不落灰的角落...", "startTime": "2026-07-15T06:00:00", "endTime": "2026-08-26T03:59:59", "cover": "https://..." } ]}响应字段说明
Section titled “响应字段说明”| 字段 | 类型 | 说明 |
|---|---|---|
version |
string | 当前游戏版本号 |
versionName |
string | 版本名称 |
startTime |
string | 版本开始时间(ISO 8601) |
endTime |
string | 版本结束时间(ISO 8601) |
cover? |
string? | 版本封面图 URL |
activities |
array | 活动列表 |
activities[].name |
string | 活动名称 |
activities[].description |
string | 活动描述 |
activities[].startTime |
string | 活动开始时间(ISO 8601) |
activities[].endTime |
string | 活动结束时间(ISO 8601) |
activities[].cover? |
string? | 活动封面图 URL |
我们欢迎社区贡献活动数据!如果你发现活动信息有误或缺失,可以通过以下方式参与贡献。
- Fork 仓库:访问 StarRailAssistant 文档站仓库 并 Fork
- 修改数据:编辑
public/api/v1/目录下对应的 JSON 文件 - 提交 PR:创建 Pull Request 并说明修改内容
活动数据格式
Section titled “活动数据格式”添加新的游戏数据/更新活动数据时,请按照以下格式:
{ "version": "当前游戏版本号", "versionName": "当前游戏版本名称", "startTime": "2026-07-15T06:00:00", // 版本开始时间 "endTime": "2026-08-26T06:00:00", // 版本结束时间 "cover": "https://resource.starrailassistant.top/...", // 版本封面图 URL "activities": [ { "name": "活动名称", "description": "活动描述", "startTime": "2026-07-15T06:00:00", // 活动开始时间 "endTime": "2026-08-26T03:59:59", // 活动结束时间 "cover": "https://..." // 活动封面图 URL } // 其他活动... ]}