Merge pull request #2 from DrAugus/main

fix: typo
This commit is contained in:
墨染月 2023-05-17 01:03:10 +08:00 committed by GitHub
commit 7b82d1d894
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 44 additions and 71 deletions

View File

@ -1,5 +1,4 @@
<p align="center">
<img src="https://raw.githubusercontent.com/Kamisato-Ayaka-233/mihoyo-api-collect/main/files/images/logo.png" height="200">
<br/><br/>
@ -14,7 +13,6 @@
<img alt="GitHub forks" src="https://img.shields.io/github/forks/Kamisato-Ayaka-233/mihoyo-api-collect?color=%23456789&style=flat-square">
</p>
<h1 align="center">米哈游API</h1>
<p align="center">米游社、原神、崩坏</p>
@ -103,7 +101,6 @@
- [ ] [其它](honkai_star_rail/other/)
- [ ] [公告](honkai_star_rail/other/announcement.md)
<!--
---
@ -117,17 +114,14 @@
## 相关项目
* [Star Rail Warp Export](https://github.com/biuuu/star-rail-warp-export) - 星穹铁道跃迁记录导出工具。
* [Genshin Wish Export](https://github.com/biuuu/genshin-wish-export/) - 原神析愿记录导出工具
* [Genshin Wish Analyzer](https://github.com/voderl/genshin-gacha-analyzer) - 原神析愿记录分析器
* [Genshin Kits for Node.js](https://github.com/genshin-kit/genshin-kit-node) - Node.js原神玩家信息查询库。
* [Genshin Helper](https://github.com/y1ndan/genshinhelper2) - Python米游社API封装库
* [Yunzai Bot](https://gitee.com/le-niao/Yunzai-Bot) - 原始云崽机器人QQ群原神信息查询机器人。
* [Miao Yunzai](https://github.com/yoimiya-kokomi/Miao-Yunzai) - “喵”版云崽机器人QQ群原神信息和原神角色面板查询机器人。
* [Genshin Player Query](https://github.com/Azure99/GenshinPlayerQuery) - 原神玩家信息查询
* [Snap Hu Tao](https://github.com/DGP-Studio/Snap.Hutao) - 原神工具箱。
* [Cocogoat](https://github.com/YuehaiTeam/cocogoat) - 原神成就记录与圣遗物管理。
* [UIGF API](https://github.com/UIGF-org/UIGF-API) -
- [Star Rail Warp Export](https://github.com/biuuu/star-rail-warp-export) - 星穹铁道跃迁记录导出工具。
- [Genshin Wish Export](https://github.com/biuuu/genshin-wish-export/) - 原神祈愿记录导出工具
- [Genshin Wish Analyzer](https://github.com/voderl/genshin-gacha-analyzer) - 原神祈愿记录分析器
- [Genshin Kits for Node.js](https://github.com/genshin-kit/genshin-kit-node) - Node.js原神玩家信息查询库。
- [Genshin Helper](https://github.com/y1ndan/genshinhelper2) - Python米游社API封装库
- [Yunzai Bot](https://gitee.com/le-niao/Yunzai-Bot) - 原始云崽机器人QQ群原神信息查询机器人。
- [Miao Yunzai](https://github.com/yoimiya-kokomi/Miao-Yunzai) - “喵”版云崽机器人QQ群原神信息和原神角色面板查询机器人。
- [Genshin Player Query](https://github.com/Azure99/GenshinPlayerQuery) - 原神玩家信息查询
- [Snap Hu Tao](https://github.com/DGP-Studio/Snap.Hutao) - 原神工具箱。
- [Cocogoat](https://github.com/YuehaiTeam/cocogoat) - 原神成就记录与圣遗物管理。
- [UIGF API](https://github.com/UIGF-org/UIGF-API) -

View File

@ -4,7 +4,7 @@
- [获取首页信息](#genshin-home)
- [获取角色信息](#genshin-characters)
- [获取深境螺旋信息](#genshin-spiral-abyss)
- [获取愿记录](#genshin-wish)
- [获取愿记录](#genshin-wish)
- [崩坏:星穹铁道](#崩坏星穹铁道)
- [获取首页信息](#star-rail-home)
- [获取角色信息](#star-rail-characters)
@ -139,7 +139,6 @@ _请求方式GET_
| comfort_level_name | str | 尘歌壶该岛的洞天仙力的称号 | |
| comfort_level_icon | str | 尘歌壶该岛的洞天仙力的图标 | |
<details>
<summary>查看示例</summary>
@ -227,8 +226,8 @@ _请求方式GET_
}
}
```
</details>
</details>
**国际服:**
@ -249,7 +248,6 @@ _请求方式GET_
| role_id | num | 原神UID | |
| server | str | 服务器名称 | |
<h3 id="genshin-characters">获取玩家角色信息</h3>
**国服:**
@ -262,7 +260,6 @@ _请求方式POST_
>
> _需要验证网页Cookie_
`https://api-takumi-record.mihoyo.com/game_record/app/genshin/api/character`
**参数:**
@ -351,7 +348,6 @@ _请求方式POST_
| activation_number | num | 需要装备多少该套装内的圣遗物才能激活该效果 | |
| effect | str | 该圣遗物套装效果的描述 | |
`data`对象→`avatars`数组→对象→`constellations`数组→对象:
| 字段 | 类型 | 内容 | 备注 |
@ -380,7 +376,6 @@ _请求方式POST_
| region | str | 该账号在的服务器的名称 | |
| level | num | 该账号的冒险等级 | |
<details>
<summary>查看示例</summary>
@ -460,6 +455,7 @@ _请求方式POST_
}
}
```
</details>
**国际服:**
@ -472,21 +468,16 @@ _请求方式POST_
>
> _需要验证网页Cookie_
`未知`
**参数:**
**JSON返回**
<h3 id="genshin-spiral-abyss">获取玩家深境螺旋信息</h3>
**国服:**
_请求方式GET_
> _需要验证请求头_
@ -505,7 +496,6 @@ _请求方式GET_
| role_id | num | 原神UID | |
| schedule_type | num | 要查询的是哪期深渊信息<br/>1 当期<br/>2 上期 | |
根对象:
| 字段 | 类型 | 内容 | 备注 |
@ -635,7 +625,6 @@ _请求方式GET_
| level | num | 该角色的等级 | |
| rarity | num | 该角色的稀有度 | |
<details>
<summary>查看示例</summary>
@ -1778,10 +1767,9 @@ _请求方式GET_
}
}
```
</details>
**国际服:**
_请求方式GET_
@ -1794,7 +1782,7 @@ _请求方式GET_
`未知`
<h3 id="genshin-wish">获取愿记录</h3>
<h3 id="genshin-wish">获取愿记录</h3>
**国服:**
@ -1807,12 +1795,12 @@ _请求方式GET_
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | ---- | ---- |
| authkey_ver | num | 1 | |
| authkey | str | 验证密钥,用于标识游戏账号 | 打开“游戏安装目录/GenshinImpact_Data或YuanShen_Data/webCaches/Cache/Cache_Data/data_2”寻找类似“https://webstatic.mihoyo.com/genshin/event/e20190909gacha-v2/index.html……”国服或“https://webstatic-sea.hoyoverse.com/genshin/event/e20190909gacha-v2/index.html……”国际服的链接该参数的值在其中 |
| authkey | str | 验证密钥,用于标识游戏账号 | 打开“游戏安装目录/GenshinImpact_Data或YuanShen_Data/webCaches/Cache/Cache_Data/data_2”寻找类似“<https://webstatic.mihoyo.com/genshin/event/e20190909gacha-v2/index.html国服https://webstatic-sea.hoyoverse.com/genshin/event/e20190909gacha-v2/index.html国际服的链接该参数的值在其中> |
| lang | str | 语言,即返回数据中抽到的项目名称<br>zh-cn zh 简体中文<br>zh-tw 繁体中文<br>en-us en 英语<br>ru-ru ru 俄语<br>ja-jp ja 日语<br>以及其它国际语言代码 | |
| size | num | 返回数据中的最大数据数量。最小为0最大为20。若小于0则返回0个数据若大于20则返回最大20个数据 | |
| end_id | num | 见下文的说明 | |
| page | num | 页数从1开始 | 若为负数返回则会是`-502`。若没有此参数默认为第1页。该参数实际上没有用处要实现翻页请使用`end_id`参数。见下文。 |
| gacha_type | num | 析愿池<br>100 初行者推荐析愿<br>200 常驻析愿<br>301 角色活动析愿<br>302 武器活动析愿 | |
| gacha_type | num | 祈愿池<br>100 初行者推荐祈愿<br>200 常驻祈愿<br>301 角色活动祈愿<br>302 武器活动祈愿 | |
<!--
以下参数目前似乎没有任何作用
init_type
@ -1825,10 +1813,9 @@ auth_appid
具体步骤:
1. 当`page`为`1`即第1页需要指定`end_id`为`0`。则会返回最新的参数`size`个愿记录。
1. 当`page`为`1`即第1页需要指定`end_id`为`0`。则会返回最新的参数`size`个愿记录。
1. 当需要翻页(增加`page`)时,需要指定`end_id`为上页的`data`对象→`list`数组→最后一个元素→`id`字符串。
1. 重复第2步直到获取完成想要获取的析愿记录数量。
1. 重复第2步直到获取完成想要获取的祈愿记录数量。
根对象:
@ -1836,7 +1823,7 @@ auth_appid
| ---- | ---- | ---- | ---- |
| retcode | num | 返回码<br>-100 请求参数`authkey`不正确<br>-108 未指定语言或不是支持的语言<br>-110 请求过快 | |
| message | str | 返回消息 | |
| data | obj | 该游戏账号的愿信息 | |
| data | obj | 该游戏账号的愿信息 | |
`data`对象:
@ -1845,7 +1832,7 @@ auth_appid
| page | num | 页数 | 与请求参数中的`page`参数的值相同 |
| size | num | 最大数据数量 | 与请求参数中的`size`参数的值相同 |
| total | num | 0 | |
| list | arr | 从新至旧排序的愿记录 | |
| list | arr | 从新至旧排序的愿记录 | |
| region | str | 该账号所属服务器的标识 | |
`data`对象→`list`数组→对象:
@ -1853,7 +1840,7 @@ auth_appid
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | ---- | ---- |
| uid | str | 该玩家的UID | |
| gacha_type | str | 愿池 | 与请求参数中的`gacha_type`参数的值相同 |
| gacha_type | str | 愿池 | 与请求参数中的`gacha_type`参数的值相同 |
| item_id | str | 似乎总是为空字符串 | |
| count | str | 1 | |
| time | str | 该玩家抽到该项目的日期 | |
@ -1861,8 +1848,7 @@ auth_appid
| lang | str | 语言 | 与请求参数中的`lang`参数的值相同 |
| item_type | str | 该项目的类别 | 文本语言通过参数`lang`指定 |
| rank_type | str | 该项目的稀有度 | |
| id | str | 该析愿记录的ID可用于翻页获取析愿记录。 | |
| id | str | 该祈愿记录的ID可用于翻页获取祈愿记录。 | |
<details>
<summary>查看示例</summary>
@ -1893,10 +1879,9 @@ auth_appid
}
}
```
</details>
**国际服:**
`未知`
@ -1923,7 +1908,6 @@ _请求方式GET_
| ---- | ---- | ---- | ---- |
| server | str |
根对象:
| 字段 | 类型 | 内容 | 备注 |
@ -1992,10 +1976,9 @@ _请求方式GET_
}
}
```
</details>
**国际服:**
`未知`
@ -2017,7 +2000,7 @@ _请求方式GET_
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | ---- | ---- |
| authkey_ver | num | 1 | |
| authkey | str | 验证密钥,用于标识游戏账号 | 打开“游戏安装目录/StarRail_Data/webCaches/Cache/Cache_Data/data_2”寻找类似“https://api-takumi.mihoyo.com/common/gacha_record/api/getGachaLog……”的链接该参数的值在其中 |
| authkey | str | 验证密钥,用于标识游戏账号 | 打开“游戏安装目录/StarRail_Data/webCaches/Cache/Cache_Data/data_2”寻找类似“<https://api-takumi.mihoyo.com/common/gacha_record/api/getGachaLog的链接该参数的值在其中> |
| lang | str | 语言,即返回数据中抽到的项目名称<br>zh-cn zh 简体中文<br>zh-tw 繁体中文<br>en-us en 英语<br>ru-ru ru 俄语<br>ja-jp ja 日语<br>以及其它国际语言代码 | |
| size | num | 返回数据中的最大数据数量。最小为0最大为20。若小于0则返回0个数据若大于20则返回最大20个数据 | |
| end_id | num | 见下文的说明 | |
@ -2025,7 +2008,6 @@ _请求方式GET_
| gacha_type | num | 跃迁池<br>1 常驻跃迁<br>2 新手跃迁<br>11 角色活动跃迁<br>12 光锥活动跃迁 | |
| game_biz | str | `authkey`对应账号所属服务器的服务器标识 | |
当需要获取超过20个记录时需要使用到`end_id`参数。
具体步骤:
@ -2034,14 +2016,13 @@ _请求方式GET_
1. 当需要翻页(增加`page`)时,需要指定`end_id`为上页的`data`对象→`list`数组→最后一个元素→`id`字符串。
1. 重复第2步直到获取完成想要获取的跃迁记录数量。
根对象:
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | ---- | ---- |
| retcode | num | 返回码<br>-100 请求参数`authkey`不正确<br>-111 请求参数`game_biz`不正确<br>-108 未指定语言或不是支持的语言<br>-110 请求过快 | |
| message | str | 返回消息 | |
| data | obj | 该游戏账号的愿信息 | |
| data | obj | 该游戏账号的愿信息 | |
`data`对象:
@ -2069,7 +2050,6 @@ _请求方式GET_
| rank_type | str | 3 | |
| id | str | 似乎前10位数字为接近于抽到该项目的时间的Unix时间戳后面的数字含义未知 | |
<details>
<summary>查看示例</summary>
@ -2100,10 +2080,9 @@ _请求方式GET_
}
}
```
</details>
**国际服:**
`未知`