SRA Public API
StarRailAssistant (SRA) provides a set of free public REST APIs — no signup, no API key required — returning the current game version, version name, and in-game event times as JSON, with English and Chinese data available.
Currently supported games: Honkai: Star Rail, Genshin Impact, Zenless Zone Zero, Wuthering Waves, NTE, Blue Archive (CN / JP / Global), Arknights, Arknights: Endfield, and Stella Sora. Great for event calendars, Discord / QQ bots, daily reminder tools, and more.
API Endpoints
Section titled “API Endpoints”The base URL for all APIs is:
https://starrailassistant.top/api/v1Get Activity Data
Section titled “Get Activity Data”GET /activity/{game}.jsonGET /activity/{game}-{locale}.json| Parameter | Type | Description |
|---|---|---|
game |
string | Game identifier |
locale |
string | Optional, language tag (e.g. en-US); omitted for the default language data |
Supported Games
Section titled “Supported Games”GET https://starrailassistant.top/api/v1/activity/sr.jsonGET https://starrailassistant.top/api/v1/activity/sr-en-US.jsonGET https://starrailassistant.top/api/v1/activity/ys.jsonGET https://starrailassistant.top/api/v1/activity/ys-en-US.jsonGET https://starrailassistant.top/api/v1/activity/zzz.jsonGET https://starrailassistant.top/api/v1/activity/zzz-en-US.jsonGET https://starrailassistant.top/api/v1/activity/ww.jsonGET https://starrailassistant.top/api/v1/activity/ww-en-US.jsonGET https://starrailassistant.top/api/v1/activity/nte.jsonGET https://starrailassistant.top/api/v1/activity/nte-en-US.jsonGET https://starrailassistant.top/api/v1/activity/ba-cn.jsonGET https://starrailassistant.top/api/v1/activity/ba-jp.jsonGET https://starrailassistant.top/api/v1/activity/ba-global.jsonGET https://starrailassistant.top/api/v1/activity/ak.jsonGET https://starrailassistant.top/api/v1/activity/end.jsonGET https://starrailassistant.top/api/v1/activity/end-en-US.jsonGET https://starrailassistant.top/api/v1/activity/xtlr.jsonGET https://starrailassistant.top/api/v1/activity/infinitynikki.jsonGET https://starrailassistant.top/api/v1/activity/gf2.jsonGET https://starrailassistant.top/api/v1/activity/pgr.jsonGET https://starrailassistant.top/api/v1/activity/czn.jsonGET https://starrailassistant.top/api/v1/activity/bd2.jsonGET https://starrailassistant.top/api/v1/activity/nikke.jsonGET https://starrailassistant.top/api/v1/activity/hyrz.jsonResponse Example
Section titled “Response Example”{ "version": "4.4", "versionName": "鸣笛于归寂之时", "startTime": "2026-07-15T06:00:00", "endTime": "2026-08-26T06:00:00", "cover": "https://...", "activities": [ { "name": "反贪「砖」家", "kind": "其他活动", "description": "世上没有不落灰的角落...", "startTime": "2026-07-15T06:00:00", "endTime": "2026-08-26T03:59:59", "cover": "https://..." } ]}Response Fields
Section titled “Response Fields”| Field | Type | Description |
|---|---|---|
version |
string | Current game version number |
versionName |
string | Version name |
startTime |
string | Version start time (ISO 8601) |
endTime |
string | Version end time (ISO 8601) |
cover? |
string? | Version cover image URL |
activities |
array | List of activities |
activities[].name |
string | Activity name |
activities[].kind? |
string? | Activity category (empty string when the source has none, e.g. 叙事活动, 登录活动) |
activities[].description |
string | Activity description |
activities[].startTime |
string | Activity start time (ISO 8601) |
activities[].endTime |
string | Activity end time (ISO 8601) |
activities[].cover? |
string? | Activity cover image URL |
Is this API free? Do I need an API key?
Section titled “Is this API free? Do I need an API key?”It is completely free. No account or API key is needed — just send a GET request to the API endpoints.
Which games are supported?
Section titled “Which games are supported?”Honkai: Star Rail (sr), Genshin Impact (ys), Zenless Zone Zero (zzz), Wuthering Waves (ww), NTE (nte), Blue Archive (ba-cn / ba-jp / ba-global), Arknights (ak), Arknights: Endfield (end), and Stella Sora (xtlr). See Supported Games.
How often is the data updated?
Section titled “How often is the data updated?”Data is updated by community maintainers after each game’s version announcement, usually before the version goes live. It is extracted from official announcements and manually verified.
What does the data look like?
Section titled “What does the data look like?”Standard JSON containing the current version number, version name, version start/end times, and a list of activities (name, category, description, start/end times, cover image). All times are ISO 8601. See Response Fields.
Found incorrect data?
Section titled “Found incorrect data?”Please report it in GitHub Issues, or submit a PR directly following the Contributing guide below.
Contributing
Section titled “Contributing”Community contributions of activity data are welcome! If you want to add support for more games, or find activity information that is incorrect or missing, you can contribute in the following ways.
Adding Support for a New Game
Section titled “Adding Support for a New Game”- Fork the repository: visit the StarRailAssistant docs site repository and fork it.
- Add the game entry: add a new game entry to the
gamesarray insrc/data/games.ts, filling in the game identifier, name, language list, and data sources (see format below). - Generate activity data (or wait for the PR to be merged, then the maintainers will generate it): generate the activity JSON under
public/api/v1/activity/from the data sources (for the AI extraction workflow, see.agents/skills/game-activity-extractor/SKILL.mdin the repository). - Submit a PR: create a Pull Request describing the newly added game support.
Game Entry Format
Section titled “Game Entry Format”{ id: "sr", // Game identifier, base of the output filename name: { "zh-CN": "可读游戏名称", en: "English Name" }, locales: [ "zh-CN", // Supported language list "en-US", ], defaultLocale: "zh-CN", // Default locale; its generated file omits the locale suffix dataSources: { // Data sources, keyed by locale; the "all" key applies to every locale // Each locale can list multiple data sources, tried in order "zh-CN": [{ type: "html", url: "https://..." }], },}dataSources describes how the game’s activity data is fetched, mainly for the AI extraction workflow. Each data source is distinguished by its type:
| type | Applicable fields | Description |
|---|---|---|
html |
url |
Announcement listing page (HTML); the AI locates the version announcement from the listing and parses activity information |
script |
script |
Generator script path (relative to the repository root, run with node scripts/...); the script fetches and converts the data itself |
pageData |
url, articleUrl? |
Paginated JSON API; articleUrl is an article path template whose {field} placeholders are replaced with the entry’s same-named field values |
All types support the optional field userAgent: "none": marks that the source rejects browser User-Agents, so do not send a browser UA when fetching.
Script Conventions for script Type
Section titled “Script Conventions for script Type”- Data is output to a temporary file in the
tmp/directory and does not directly overwrite the official data underpublic/api/v1/activity/ - After the script finishes, it prints the output location and usage instructions to stdout, so humans or AI can verify before updating the official JSON
- Join/filter/format-conversion logic inside the script is documented in the script’s header comments
Manual Maintenance
Section titled “Manual Maintenance”The following approach applies to simple content changes (such as fixing an activity’s time, name, or description, or adding a cover image):
- Fork the repository: visit the StarRailAssistant docs site repository and fork it.
- Edit the data: edit the corresponding JSON file under the
public/api/v1/activity/directory. Default-language data lives in/{game}.json(Chinese); other languages live in/{game}-{locale}.json(e.g.sr-en-US.json). - Submit a PR: create a Pull Request describing your changes.
Activity Data Format
Section titled “Activity Data Format”When adding or updating activity data, please follow this format:
{ "version": "Current game version number", "versionName": "Current game version name", "startTime": "2026-07-15T06:00:00", // Version start time "endTime": "2026-08-26T06:00:00", // Version end time "cover": "https://...", // Version cover image URL "activities": [ { "name": "Activity name", "description": "Activity description", "startTime": "2026-07-15T06:00:00", // Activity start time "endTime": "2026-08-26T03:59:59", // Activity end time "cover": "https://..." // Activity cover image URL } // More activities... ]}