返回提交历史
Modified
README.md
+3
-3
Modified
note/action.md
+1
-1
Added
note/info.md
+195
-0
Added
note/list.md
+135
-0
Modified
note/readme.md
+90
-4
Modified
user/relation.md
+1
-1
XFEstudio/bilibili-API-collect
完善note下所有api，包括列表以及内容查询 (#142)
* 增加笔记列表（note/list.md） 链接加了，但是现在是打×的，如果确认没问题就改成√ * Update list.md * note最后一环施工 note\info.md (55%) user\relation.md 纠错 * 更新 note\action.md (补充) note\info.md (65%) * 修改纠错 感谢线程（bushi）程序撕裂者 @ProgramRipper * 更新info.md 更新note\info.md (75%) * note最后更新 note\info.md 完成 note系列存疑： http://api.bilibili.com/x/note/is_gray * 修改【视频笔记】相关api * 漏写了一个对号，加上(QAQ) Co-authored-by: SocialSisterYi <45892418+SocialSisterYi@users.noreply.github.com>
dba7650
代码差异
6 个文件
+425
-9
@@ -84,9 +84,9 @@ PS：所有http协议地址均可使用https，文档中为了统一写作`http`
84
84
- 屏蔽管理
85
85
- 智能防挡弹幕
86
86
- [弹幕个人配置修改](danmaku/config.md)√
87
- [视频笔记](note)×
88
- 笔记列表
89
- 笔记详细信息
87
- [视频笔记](note)√
88
- [笔记列表](note/list.md)√
89
- [笔记详细信息](note/info.md)√
90
90
- [笔记操作](note/action.md)√
91
91
- [专栏](article)
92
92
- 分区
@@ -22,7 +22,7 @@
22
22
| title | str | 笔记标题 | 必要 | |
23
23
| summary | str | 笔记预览文本 | 必要 | |
24
24
| content | str | 笔记正文json序列 | 必要 | 格式见[附表](readme.md#附表-笔记正文序列格式) |
25
| tags | str | | 非必要 | 作用尚不明确 |
25
| tags | str | 笔记跳转标签列表 | 非必要 | |
26
26
| cls | num | 1 | 非必要 | 作用尚不明确 |
27
27
| from | str | 提交类型 | 非必要 | auto：自动提交<br />save：手动提交<br />close：关闭时自动提交 |
28
28
| csrf | str | CSRF Token（位于cookie） | 必要 | |
@@ -0,0 +1,195 @@
1
# 笔记详细信息
2
3
- [查询视频笔记](#查询视频笔记)
4
- [查询笔记内容](#查询笔记内容)
5
6
---
7
8
## 查询视频笔记
9
10
> http://api.bilibili.com/x/note/list/archive
11
12
*请求方式：GET*
13
14
认证方式：Cookie（SESSDATA）
15
16
**url参数：**
17
18
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
19
| ------- | ---- | ------------ | ----------- | -------- |
20
| aid | num | 稿件avID | 必要（可选） | avID与bvID任选一个 |
21
| bvid | str | 稿件bvID | 必要（可选） | avID与bvID任选一个 |
22
| csrf | str | CSRF Token（位于cookie） | 非必要 | |
23
24
**json回复：**
25
26
根对象：
27
28
| 字段 | 类型 | 内容 | 备注 |
29
| ------- | ---- | -------- | --------------------------------------------------- |
30
| code | num | 返回值 | 0：成功<br />-400：请求错误<br />-101：账号未登录 |
31
| message | str | 错误信息 | 默认为0 |
32
| ttl | num | 1 | |
33
| data | obj | 信息本体 | |
34
35
`data`对象：
36
37
| 字段 | 类型 | 内容 | 备注 |
38
| ------- | ----- | -------- | -------------------------------------------------- |
39
| noteIds | array | 笔记列表 | 无笔记则无此项<br />可能后续会允许视频添加多个笔记 |
40
41
`data`中的`noteIds`数组：
42
43
| 项 | 类型 | 内容 | 备注 |
44
| ---- | ---- | ----------- | ---------------- |
45
| 0 | num | 笔记ID | |
46
47
**示例：**
48
49
查询视频`av970322090`/`BV1op4y167Uo`的笔记ID
50
51
avID方式：
52
53
```shell
54
curl 'http://api.bilibili.com/x/note/list/archive' \
55
--data-urlencode 'aid=970322090' \
56
-b 'SESSDATA=xxx'
57
```
58
59
bvID方式：
60
61
```shell
62
curl 'http://api.bilibili.com/x/note/list/archive' \
63
--data-urlencode 'bvid=BV1op4y167Uo' \
64
-b 'SESSDATA=xxx'
65
```
66
67
<details>
68
<summary>查看响应示例：</summary>
69
70
```json
71
{
72
"code":0,
73
"message":"0",
74
"ttl":1,
75
"data":{
76
"noteIds":[
77
3809605586518023
78
]
79
}
80
}
81
```
82
83
</details>
84
85
## 查询笔记内容
86
87
> http://api.bilibili.com/x/note/info
88
89
*请求方式：GET*
90
91
认证方式：Cookie（SESSDATA）
92
93
**url参数：**
94
95
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
96
| ------- | ---- | ---------- | ----------- | -------- |
97
| aid | num | 稿件avID | 必要（可选）| avID与bvID任选一个，不与笔记所属稿件avID相同不影响返回 |
98
| bvid | str | 稿件bvID | 必要（可选）| avID与bvID任选一个，不与笔记所属稿件bvID相同不影响返回 |
99
| note_id | num | 笔记ID | 必要 | |
100
101
**json回复：**
102
103
根对象：
104
105
| 字段 | 类型 | 内容 | 备注 |
106
| ------- | ---- | -------- | --------------------------------------------------- |
107
| code | num | 返回值 | 0：成功<br />-400：请求错误<br />-101：账号未登录<br />79502：笔记详情未找到|
108
| message | str | 错误信息 | 默认为0 |
109
| ttl | num | 1 | |
110
| data | obj | 信息本体 | |
111
112
`data`对象：
113
114
| 字段 | 类型 | 内容 | 备注 |
115
| ------------ | ----- | ---------------- | -------------- |
116
| title | str | 笔记标题 | |
117
| summary | str | 笔记预览文本 | |
118
| content | str | 笔记正文json序列 | 格式见[附表](readme.md#附表-笔记正文序列格式) |
119
| tags | array | 笔记跳转标签列表 | |
120
| cid_count | num | 视频分P数 | |
121
| audit_status | num | 0 | 作用暂不明确 |
122
| aid | num | 稿件avID | |
123
124
`data`中的`tags`数组：
125
126
| 项 | 类型 | 内容 | 备注 |
127
| ---- | ---- | ----------- | ---------------- |
128
| 0 | obj | 标签1 | |
129
| n | obj | 标签（n+1） | 按照笔记中位置排列 |
130
| …… | obj | …… | …… |
131
132
`tags`中的对象：
133
134
| 字段 | 类型 | 内容 | 备注 |
135
| -------- | ---- | ----------------- | ------------ |
136
| cid | num | 视频cid | |
137
| status | num | 0 | 作用尚不明确 |
138
| index | num | 在稿件中的分P索引 | |
139
| seconds | num | 视频进度 | |
140
| pos | num | 笔记中位置 | |
141
142
**示例：**
143
144
查询视频`av583785685`/`BV1kz4y1X7XP`中笔记`7165769906913287`的内容
145
146
avID方式：
147
148
```shell
149
curl 'http://api.bilibili.com/x/note/info' \
150
--data-urlencode 'aid=583785685' \
151
--data-urlencode 'note_id=7165769906913287' \
152
-b 'SESSDATA=xxx'
153
```
154
155
bvID方式：
156
157
```shell
158
curl 'http://api.bilibili.com/x/note/info' \
159
--data-urlencode 'bvid=BV1kz4y1X7XP' \
160
--data-urlencode 'note_id=7165769906913287' \
161
-b 'SESSDATA=xxx'
162
```
163
164
<details>
165
<summary>查看响应示例：</summary>
166
167
```json
168
{
169
"code":0,
170
"message":"0",
171
"ttl":1,
172
"data":{
173
"title":"【cmd】访问api 命令行也能上B站",
174
"summary":"项目介绍 才324个star？哦7月4日没事了 二维码登录流程介绍 正式开",
175
"content":"{
176
"insert":{
177
"tag":{
178
"cid":209620774,
179
"status":0,
180
"index":1,
181
"seconds":5,
182
"cidCount":1,
183
"key":"1611921905204",
184
"title":"【cmd】访问api 命令行也能上B站_x264"
185
}
186
}
187
}..."
188
"cid_count":1,
189
"audit_status":0,
190
"aid":583785685
191
}
192
}
193
```
194
195
</details>
@@ -0,0 +1,135 @@
1
# 笔记列表
2
3
- [查询所有笔记列表](#查询笔记列表)
4
5
## 查询所有笔记列表
6
7
> http://api.bilibili.com/x/note/list
8
9
*请求方式：GET*
10
11
认证方式：Cookie（SESSDATA）
12
13
**url参数：**
14
15
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
16
| ------- | ---- | ------------ | ----------- | ------------------------------------------------------- |
17
| ps | num | 每页项数 | 必要 | |
18
| pn | num | 页码 | 必要 | |
19
| csrf | str | CSRF Token（位于cookie） | 非必要 | |
20
21
**json回复：**
22
23
根对象：
24
25
| 字段 | 类型 | 内容 | 备注 |
26
| ------- | ---- | -------- | --------------------------------------------------- |
27
| code | num | 返回值 | 0：成功<br />-400：请求错误<br />-101：账号未登录 |
28
| message | str | 错误信息 | 默认为0 |
29
| ttl | num | 1 | |
30
| data | obj | 信息本体 | |
31
32
`data`对象：
33
34
| 字段 | 类型 | 内容 | 备注 |
35
| ---------- | ----- | -------- | ------------ |
36
| list | array | 明细列表 | |
37
| page | obj | 页面信息 | |
38
39
`data`中的`list`数组：
40
41
| 项 | 类型 | 内容 | 备注 |
42
| ---- | ---- | ----------- | ---------------- |
43
| 0 | obj | 笔记1 | |
44
| n | obj | 笔记（n+1） | 按照创建顺序排列 |
45
| …… | obj | …… | …… |
46
47
`list`中的对象：
48
49
| 字段 | 类型 | 内容 | 备注 |
50
| --------------- | ---- | ------------ | ---------------------- |
51
| title | str | 笔记标题 | |
52
| summary | str | 笔记预览文本 | |
53
| mtime | str | 提交时间 | |
54
| arc | obj | 视频信息 | |
55
| note_id | num | 笔记ID | |
56
| audit_status | num | 0 | 作用尚不明确 |
57
58
`list`中的`arc`中的对象：
59
60
| 字段 | 类型 | 内容 | 备注 |
61
| ------ | ---- | ------------ | ---------------------- |
62
| aid | num | 稿件avID | |
63
| bvid | str | 稿件bvID | |
64
| pic | str | 稿件封面图片url | |
65
| desc | str | 视频简介 | |
66
| status | num | 0 | |
67
68
`data`中的`page`对象：
69
70
| 字段 | 类型 | 内容 | 备注 |
71
| ------ | ---- | ------------ | -------------------- |
72
| total | num | 笔记总数 | |
73
| size | num | 每页项数 | |
74
| num | num | 页码 | |
75
76
**示例：**
77
78
获取笔记列表
79
80
```shell
81
curl 'http://api.bilibili.com/x/note/list' \
82
--data-urlencode 'ps=10' \
83
--data-urlencode 'pn=1'
84
-b 'SESSDATA=xxx'
85
```
86
87
<details>
88
<summary>查看响应示例：</summary>
89
90
```json
91
{
92
"code":0,
93
"message":"0",
94
"ttl":1,
95
"data":{
96
"list":[
97
{
98
"title":"周刊哔哩哔哩排行榜#543",
99
"summary":"test",
100
"mtime":"2020-11-23 17:45",
101
"arc":{
102
"aid":970322090,
103
"bvid":"BV1op4y167Uo",
104
"pic":"http://i1.hdslb.com/bfs/archive/cc67f9c9b70d6eb97f00e726517c8c3da540ee05.jpg",
105
"desc":"20年11月第3周 | 【PICK UP】栏目欢迎继续推荐，私信@周刊娘 ，附上推荐投稿的av/bv号与理由。请勿刷屏、引战",
106
"status":0
107
},
108
"note_id":3809605586518023,
109
"audit_status":0
110
},
111
{
112
"title":"【MV】保加利亚妖王AZIS视频合辑",
113
"summary":"test2",
114
"mtime":"2020-11-20 16:44",
115
"arc":{
116
"aid":170001,
117
"bvid":"BV17x411w7KC",
118
"pic":"http://i2.hdslb.com/bfs/archive/1ada8c32a9d168e4b2ee3e010f24789ba3353785.jpg",
119
"desc":"sina 保加利亚超级天王 Azis1999年出道。他的音乐融合保加利亚名族曲风chalga和pop、rap等元素，不过他惊艳的易装秀与浮夸的角色诠释才是他最为出名的地方 Azis与众多保加利亚天王天后级歌手都有过合作.06年，他作为Mariana Popova的伴唱，在欧洲半决赛上演唱了他们的参赛曲Let Me Cry 06年他被Velikite Balgari评为保加利亚有史以来最伟大的名人之一",
120
"status":0
121
},
122
"note_id":3988570796195843,
123
"audit_status":0
124
}
125
],
126
"page":{
127
"total":2,
128
"size":10,
129
"num":1
130
}
131
}
132
}
133
```
134
135
</details>
@@ -2,13 +2,15 @@
2
2
3
3
2020-11-16 B站推出了测试版的功能——"视频笔记"，与视频稿件关联，为富文本模式，可供记录观看视频时的感悟以及视频中的重要内容，目前只可在web端操作
4
4
5
目前单个稿件只能添加一篇笔记（与分P无关）
6
5
7
---
6
8
7
继续查看：
9
**继续查看：**
8
10
9
- 笔记列表
10
- 笔记详细信息
11
- [笔记操作](action.md)√
11
- [笔记列表](list.md)
12
- [笔记详细信息](info.md)
13
- [笔记操作](action.md)
12
14
13
15
---
14
16
@@ -69,3 +71,87 @@
69
71
| status | str | done | 作用尚不明确 |
70
72
| width | num | 图片宽度-2 | |
71
73
74
示例：
75
76
以下笔记正文序列包含`字号`、`加粗`、`高亮`、`普通文本`格式
77
78
```json
79
[
80
{
81
"attributes": {
82
"size": "24px",
83
"bold": true
84
},
85
"insert": "关掉"
86
},
87
{
88
"attributes": {
89
"size": "24px"
90
},
91
"insert": "，"
92
},
93
{
94
"attributes": {
95
"size": "24px",
96
"bold": true
97
},
98
"insert": "关掉"
99
},
100
{
101
"insert": "，"
102
},
103
{
104
"attributes": {
105
"background": "#fff359"
106
},
107
"insert": "一定要"
108
},
109
{
110
"attributes": {
111
"background": "#fff359",
112
"bold": true
113
},
114
"insert": "关掉"
115
},
116
{
117
"insert": "\n再不关掉那些"
118
},
119
{
120
"attributes": {
121
"bold": true
122
},
123
"insert": "网络游戏"
124
},
125
{
126
"insert": "，小孩哪有"
127
},
128
{
129
"attributes": {
130
"bold": true
131
},
132
"insert": "美好的未来"
133
},
134
{
135
"insert": "，哪有"
136
},
137
{
138
"attributes": {
139
"bold": true
140
},
141
"insert": "美好的前程"
142
},
143
{
144
"insert": "，祖国哪有"
145
},
146
{
147
"attributes": {
148
"bold": true
149
},
150
"insert": "栋梁之才"
151
},
152
{
153
"insert": "\n"
154
}
155
]
156
```
157
@@ -34,7 +34,7 @@
34
34
35
35
认证方式：Cookie（SESSDATA）或APP
36
36
37
登录可看自己全部，其他用户仅可查看前5页
37
登录可看自己前1000名，其他用户仅可查看前100名
38
38
39
39
**url参数：**
40
40