bilibili-API-collect/electric/charge_list.md
wuziqian211 c3515d825e
添加“查询互相关注明细”、“查询历史充电数据”API (#587)
* Update relation.md

* Update relation.md

* Update info.md

* Update relation.md

* Update relation.md

* Update charge_list.md

* Update charge_list.md
2023-01-19 17:15:04 +08:00

531 lines
16 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 充电列表
- [获取空间充电公示列表](#获取空间充电公示列表)
- [获取视频充电鸣谢名单](#获取视频充电鸣谢名单)
- [查询我收到的充电列表](#查询我收到的充电列表)
- [查询历史充电数据](#查询历史充电数据)
---
## 获取空间充电公示列表
> https://elec.bilibili.com/api/query.rank.do
*请求方式:GET*
**url参数**
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
| ------ | ---- | ----------- | ------ | ---- |
| mid | num | 目标用户mid | 必要 | |
**json回复**
根对象:
| 字段 | 类型 | 内容 | 备注 |
| ---- | ---- | -------- | ----------------------------- |
| code | num | 返回值 | 0成功 <br />500011mid错误 |
| msg | str | 错误信息 | 正确时无此项 |
| data | obj | 数据本体 | |
`data`对象:
| 字段 | 类型 | 内容 | 备注 |
| ----------- | ------ | ---------------- | ------------ |
| display_num | num | 0 | 作用尚不明确 |
| count | num | 本月充电人数 | |
| total_count | num | 总计充电人数 | |
| list | array | 本月充电用户列表 | |
| user | null | | 作用尚不明确 |
`data`中的`list`数组:
| 项 | 类型 | 内容 | 备注 |
| ---- | ---- | ------------- | ---------------- |
| 0 | obj | 充电用户1 | |
| n | obj | 充电用户(n+1) | 按照充电排名排列 |
| …… | obj | …… | …… |
| 29 | obj | 充电用户30 | 最后一项 |
`data`中的`list`数组中的对象:
| 字段 | 类型 | 内容 | 备注 |
| ----------- | ---- | ---------------- | ---------------- |
| mid | num | 充电对象mid | |
| pay_mid | num | 充电用户mid | |
| rank | num | 充电用户排名 | 取决于充电的多少 |
| uname | str | 充电用户昵称 | |
| avatar | str | 充电用户头像url | |
| message | str | 充电留言 | 无为空 |
| msg_deleted | num | 0 | 作用尚不明确 |
| vip_info | obj | 充电用户会员信息 | |
| trend_type | num | 0 | 作用尚不明确 |
`data`中的`list`数组中的对象中的`vip_info`对象:
| 字段 | 类型 | 内容 | 备注 |
| ---------- | ---- | ---------- | ----------------------------------- |
| vipType | num | 大会员类型 | 0<br />1月会员<br />2年会员 |
| vipDueMsec | num | 0 | 作用尚不明确 |
| vipStatus | num | 大会员状态 | 0<br />1有 |
**示例:**
查询用户`mid=53456`的充电公示列表
```shell
curl -G 'https://elec.bilibili.com/api/query.rank.do' \
--data-urlencode 'mid=53456'
```
<details>
<summary>查看响应示例:</summary>
```json
{
"code": 0,
"data": {
"display_num": 0,
"count": 226,
"total_count": 11528,
"list": [
{
"mid": 53456,
"pay_mid": 346545025,
"rank": 1,
"uname": "还有什么名字没人用",
"avatar": "http://i1.hdslb.com/bfs/face/76d4b1ecd13e992a6c7303d77bf716dd922ab234.jpg",
"message": "早日康复,五月快乐",
"msg_deleted": 0,
"vip_info": {
"vipType": 2,
"vipDueMsec": 0,
"vipStatus": 1
},
"trend_type": 0
},
{
"mid": 53456,
"pay_mid": 8826056,
"rank": 2,
"uname": "煋痕",
"avatar": "http://i2.hdslb.com/bfs/face/35b7c752d0eb1bb7a924804f240b9bfd9199625f.jpg",
"message": "",
"msg_deleted": 0,
"vip_info": {
"vipType": 2,
"vipDueMsec": 0,
"vipStatus": 1
},
"trend_type": 0
},
{
"mid": 53456,
"pay_mid": 356668487,
"rank": 3,
"uname": "舞象祥",
"avatar": "http://i1.hdslb.com/bfs/face/574f6203ef5bd0d56b95ded6a2736676d9cc5307.jpg",
"message": "warma hayo",
"msg_deleted": 0,
"vip_info": {
"vipType": 1,
"vipDueMsec": 0,
"vipStatus": 1
},
"trend_type": 0
},
…………
],
"user": null
}
}
```
</details>
## 获取视频充电鸣谢名单
> https://api.bilibili.com/x/web-interface/elec/show
*请求方式:GET*
**url参数**
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
| ------ | ---- | ------------ | ------------ | ------------------ |
| mid | num | 目标用户mid | 必要 | |
| aid | num | 目标稿件avid | 必要(可选) | avid与bvid任选一个 |
| bvid | str | 目标稿件bvid | 必要(可选) | avid与bvid任选一个 |
**json回复**
根对象:
| 字段 | 类型 | 内容 | 备注 |
| ------- | ---- | -------- | ------------------------------------------------------------ |
| code | num | 返回值 | 0成功<br />-400请求错误<br />-404无视频<br />62001不需要展示充电信息 |
| message | str | 错误信息 | 默认为0 |
| ttl | num | 1 | |
| data | obj | 信息本体 | |
`data`对象:
| 字段 | 类型 | 内容 | 备注 |
| ----------- | ------ | ---------------- | ------------ |
| show_info | obj | 展示选项 | |
| av_count | num | 目标视频充电人数 | |
| count | num | 本月充电人数 | |
| total_count | num | 总计充电人数 | |
| special_day | num | 0 | 作用尚不明确 |
| display_num | num | 0 | 作用尚不明确 |
| list | array | 本月充电用户列表 | |
`data`中的`show_info`对象:
| 字段 | 类型 | 内容 | 备注 |
| ----- | ---- | ------------------------ | ----------------------------- |
| show | bool | 是否展示视频充电鸣谢名单 | false不展示<br />true展示 |
| state | num | 0 | |
`data`中的`list`数组:
| 项 | 类型 | 内容 | 备注 |
| ---- | ---- | ------------- | ---------------- |
| 0 | obj | 充电用户1 | |
| n | obj | 充电用户(n+1) | 按照充电排名排列 |
| …… | obj | …… | …… |
| 29 | obj | 充电用户30 | 最后一项 |
`data`中的`list`数组中的对象:
| 字段 | 类型 | 内容 | 备注 |
| ----------- | ---- | ---------------- | ---------------- |
| mid | num | 充电对象mid | |
| pay_mid | num | 充电用户mid | |
| rank | num | 充电用户排名 | 取决于充电的多少 |
| uname | str | 充电用户昵称 | |
| avatar | str | 充电用户头像url | |
| message | str | 充电留言 | 无为空 |
| msg_deleted | num | 0 | 作用尚不明确 |
| vip_info | obj | 充电用户会员信息 | |
| trend_type | num | 0 | 作用尚不明确 |
`data`中的`list`数组中的`vip_info`对象:
| 字段 | 类型 | 内容 | 备注 |
| ---------- | ---- | ---------- | ----------------------------------- |
| vipType | num | 大会员类型 | 0<br />1月会员<br />2年会员 |
| vipDueMsec | num | 0 | 作用尚不明确 |
| vipStatus | num | 大会员状态 | 0<br />1有 |
**示例:**
获取视频`av967773538`/` BV1up4y1y77i `,用户`mid=53456`的视频充电鸣谢名单
avid方式
```shell
curl -G 'https://api.bilibili.com/x/web-interface/elec/show' \
--data-urlencode 'mid=53456' \
--data-urlencode 'aid=967773538'
```
bvid方式
```shell
curl -G 'https://api.bilibili.com/x/web-interface/elec/show' \
--data-urlencode 'mid=53456' \
--data-urlencode 'bvid=BV1up4y1y77i '
```
<details>
<summary>查看响应示例:</summary>
```json
{
"code": 0,
"message": "0",
"ttl": 1,
"data": {
"show_info": {
"show": true,
"state": 0
},
"av_count": 0,
"count": 0,
"total_count": 19422,
"special_day": 0,
"display_num": 0,
"list": [
{
"mid": 53456,
"pay_mid": 1216085164,
"rank": 1,
"uname": "JZ72",
"avatar": "http://i1.hdslb.com/bfs/face/3d741682fafc286999b5e8089a844ae4f46651fe.jpg",
"message": "Warma YYDS ",
"msg_deleted": 0,
"vip_info": {
"vipType": 2,
"vipDueMsec": 0,
"vipStatus": 1
},
"trend_type": 0
},
{
"mid": 53456,
"pay_mid": 305858373,
"rank": 2,
"uname": "适应性神经系统",
"avatar": "http://i0.hdslb.com/bfs/face/2ad38dec879f66c32b5e5cb1750cb3f3e446bf91.jpg",
"message": "",
"msg_deleted": 0,
"vip_info": {
"vipType": 1,
"vipDueMsec": 0,
"vipStatus": 0
},
"trend_type": 0
},
......
]
}
}
```
</details>
## 查询我收到的充电列表
> https://pay.bilibili.com/bk/brokerage/listForCustomerRechargeRecord
*请求方式GET*
认证方式CookieSESSDATA
**url参数**
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
| -------- | ---- | -------- | ------ | -------------------------------- |
| currentPage | num | 页数 | 必要 | |
| pageSize | num | 分页大小 | 必要 | 取值范围[1,50] |
| customerId | num | (?) | 必要 | 目前为固定值10026 |
| beginTime | str | 开始日期 | | yyyy-MM-dd |
| endTime | str | 结束日期 | | yyyy-MM-dd |
**json回复**
根对象:
| 字段 | 类型 | 内容 | 备注 |
| ------- | ---- | -------- | --------------------------- |
| code | num | 返回值 | 0成功<br />800501007user not login<br />800501008内部错误<br /> 800501011请求参数有误|
| errno | num | | |
| msg | str | | |
| showMsg | str | | |
| success | bool | | |
| data | obj | 信息本体 | |
`data`对象:
| 字段 | 类型 | 内容 | 备注 |
| -------- | ----- | ------ | ---- |
| page | obj | 分页信息 | |
| result | array | 充电信息本体 | |
| config | array | (?) | |
`page`对象:
| 字段 | 类型 | 内容 | 备注 |
| -------- | ----- | ------ | ---- |
| currentPage | num | 当前页数 | |
| pageSize | num | 当前分页大小 | |
| totalCount | num | 记录总数 | |
| totalPage | num | 总页数 | |
`config`数组中的对象:
| 字段 | 类型 | 内容 | 备注 |
| -------- | ----- | ------ | ---- |
| mid | num | | 总是为null |
| name | str | | 总是为null |
| avatar | str | | 总是为null |
| originalThirdCoin | num | | 总是为null |
| brokerage | num | | 总是为null |
| remark | str | | 总是为null |
| ctime | str | | 总是为null |
`result`数组中的对象:
| 字段 | 类型 | 内容 | 备注 |
| -------- | ----- | ------ | ---- |
| mid | num | 充电人mid | |
| name | str | 充电人昵称 | |
| avatar | str | 充电人头像 | |
| originalThirdCoin | num | 原始B币数 | |
| brokerage | num | 实际收到的贝壳数 | |
| remark | str | 充电渠道 | Web/安卓/iOS |
| ctime | str | 充电时间 | yyyy-MM-dd HH:mm:ss |
**示例:**
```shell
curl -L -X GET 'https://pay.bilibili.com/bk/brokerage/listForCustomerRechargeRecord?currentPage=1&pageSize=2&customerId=10026' \
-H 'Cookie: SESSDATA=xxx'
```
<details>
<summary>查看响应示例:</summary>
```json
{
"code": 0,
"errno": 0,
"msg": "SUCCESS",
"showMsg": "交易成功",
"data": {
"page": {
"currentPage": 1,
"pageSize": 2,
"totalCount": 311,
"totalPage": 156
},
"result": [
{
"mid": 2233,
"name": "2233",
"avatar": "http://i2.hdslb.com/bfs/face/f42b7f47c80648d2ee1231f2435b527c60302289.jpg",
"originalThirdCoin": 2,
"brokerage": 1.34,
"remark": "Web",
"ctime": "2022-04-12 17:34:47"
},
{
"mid": 2233,
"name": "2233",
"avatar": "http://i0.hdslb.com/bfs/face/member/noface.jpg",
"originalThirdCoin": 2,
"brokerage": 0.68,
"remark": "iOS",
"ctime": "2022-04-10 03:41:10"
}
],
"config": [
{
"mid": null,
"name": null,
"avatar": null,
"originalThirdCoin": null,
"brokerage": null,
"remark": null,
"ctime": null
}
]
},
"success": true
}
```
</details>
## 查询历史充电数据
> https://member.bilibili.com/x/h5/elec/rank/recent
*请求方式GET*
认证方式CookieSESSDATA
**url参数**
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
| -------- | ---- | -------- | ------ | -------------------------------- |
| pn | num | 页数 | 必要 | |
| ps | num | 分页大小 | 必要 | 取值范围[1,20] |
**json回复**
根对象:
| 字段 | 类型 | 内容 | 备注 |
| ------- | ---- | -------- | ------- |
| code | num | 返回值 | 0成功 |
| message | str | 错误信息 | |
| ttl | num | 1 | |
| data | obj | 信息本体 | |
`data`对象:
| 字段 | 类型 | 内容 | 备注 |
| ----- | ----- | ------------ | ---- |
| list | array | 充电信息本体 | |
| pager | obj | 分页信息 | |
`list`数组中的对象:
| 字段 | 类型 | 内容 | 备注 |
| -------- | ---- | ---------- | ------------------- |
| aid | num | 0 | |
| bvid | str | 空 | |
| elec_num | num | 充电电池数 | |
| title | str | 空 | |
| uname | str | 空 | |
| avatar | str | 空 | |
| ctime | str | 充电时间 | yyyy-MM-dd HH:mm:ss |
`pager`对象:
| 字段 | 类型 | 内容 | 备注 |
| ------- | ---- | ------------ | ---- |
| current | num | 当前页数 | |
| size | num | 当前分页大小 | |
| total | num | 记录总数 | |
**示例:**
```shell
curl -L -X GET 'https://member.bilibili.com/x/h5/elec/rank/recent' \
-H 'Cookie: SESSDATA=xxx'
```
<details>
<summary>查看响应示例:</summary>
```json
{
"code": 0,
"message": "0",
"ttl": 1,
"data": {
"list": [
{
"aid": 0,
"bvid": "",
"elec_num": 50,
"title": "",
"uname": "",
"avatar": "",
"ctime": "2020-04-02 03:12:22"
},
{
"aid": 0,
"bvid": "",
"elec_num": 20,
"title": "",
"uname": "",
"avatar": "",
"ctime": "2020-04-02 03:12:00"
}
],
"pager": {
"current": 1,
"size": 20,
"total": 38
}
}
}
```
</details>