bilibili-API-collect/README.md
2023-09-10 22:39:18 +08:00

349 lines
19 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.

<p align="center">
<img src="./assets/img/logo.png" width="250" height="200">
</p>
<h1 align="center">哔哩哔哩-API收集整理</h1>
<p align="center" class="shields">
<a href="https://github.com/SocialSisterYi/bilibili-API-collect/issues" style="text-decoration:none">
<img src="https://img.shields.io/github/issues/SocialSisterYi/bilibili-API-collect.svg" alt="GitHub issues"/>
</a>
<a href="https://github.com/SocialSisterYi/bilibili-API-collect/stargazers" style="text-decoration:none" >
<img src="https://img.shields.io/github/stars/SocialSisterYi/bilibili-API-collect.svg" alt="GitHub stars"/>
</a>
<a href="https://github.com/SocialSisterYi/bilibili-API-collect/network" style="text-decoration:none" >
<img src="https://img.shields.io/github/forks/SocialSisterYi/bilibili-API-collect.svg" alt="GitHub forks"/>
</a>
<a href="https://github.com/SocialSisterYi/bilibili-API-collect/actions">
<img src="https://img.shields.io/github/actions/workflow/status/SocialSisterYi/bilibili-API-collect/vuepress-deploy.yml">
</a>
<a href="https://github.com/SocialSisterYi/bilibili-API-collect/blob/master/LICENSE" style="text-decoration:none" >
<img src="https://img.shields.io/badge/License-CC%20BY--NC%204.0-lightgrey.svg" alt="GitHub license"/>
</a>
</p>
<h3 align="center">野生API文档</h3>
<h3 align="center">不断更新中....</h3>
本项目旨在对 B站 WEB、APP、TV 等客户端中,散落在世界各地的野生 API 进行收集整理,研究使用方法并对其进行说明,运用了黑箱法、控制变量法、代码逆向分析、拆包及反编译法、网络抓包法等研究办法
本文档探讨的对象是主站业务接口,[官方开放平台](https://openhome.bilibili.com/doc) 和 [直播开放平台](https://open-live.bilibili.com/document/) 均不属于本项目范畴,请移步
B站 API 采用 C/S 结构,大多数接口为 REST API 和 gRPC少部分接口为 WebSocketREST API 接口请求数据大多为 url query 表单或 JSON返回数据大多为 JSON 或 Protobuf强制使用 https 协议
📖阅读地址:[GithubPages](https://socialsisteryi.github.io/bilibili-API-collect/)
小小的 Demo~~av583785685~~ [视频失效原因](https://shakaianee.top/archives/56/) ([Youtube备链](https://www.youtube.com/watch?v=nfF91Z6fqGk))
::: warning ⚠️声明
1. 本项目遵守 CC-BY-NC 4.0 协议,禁止一切商业使用,如需转载请注明作者 ID
2. **请勿滥用,本项目仅用于学习和测试!请勿滥用,本项目仅用于学习和测试!请勿滥用,本项目仅用于学习和测试!**
3. 利用本项目提供的接口、文档等造成不良影响及后果与本人无关
4. 由于本项目的特殊性,可能随时停止开发或删档
5. 本项目为开源项目,不接受任何形式的催单和索取行为,更不容许存在付费内容
:::
## 🌱参与贡献
欢迎各位 dalao 对本项目做出贡献,也希望每个使用者都能提出宝贵的意见
目前本项目存在的问题包括但不限于:
1. 文档二级目录尚未完成
2. 部分文档较旧,修改与更新没有跟进
3. 目前文档使用 markdown 语法编写,不易生成编程语言的 SDK详见 [#604](https://github.com/SocialSisterYi/bilibili-API-collect/issues/604)
更多信息请浏览 [贡献指南](CONTRIBUTING.md)
## 🍴目录
计划整理分类 & 目录:(文档已完结请选中 checkbox)
- [ ] [接口签名与验证](docs/misc/sign)
- [x] [APP API 签名](docs/misc/sign/APP.md)`appkey`与`sign`
- [x] [已知的 APPKey](docs/misc/sign/APPKey.md)
- [x] [Wbi 签名](docs/misc/sign/wbi.md)`wts`与`w_rid`
- [x] [公共错误码](docs/misc/errcode.md)
- [x] [图片格式化](docs/misc/picture.md)
- [x] [bvid 说明](docs/misc/bvid_desc.md)
- [ ] [gRPC API 接口定义](grpc_api)
- [ ] [登录](docs/login)
- [x] [登录操作 (人机认证)](docs/login/login_action)
- [x] [短信登录](docs/login/login_action/SMS.md)
- [x] [密码登录](docs/login/login_action/password.md)
- [x] [二维码登录](docs/login/login_action/QR.md)
- [ ] SNS 登录 (QQ & 微信 & 微博)
- [x] [登录基本信息](docs/login/login_info.md)
- [ ] [个人中心](docs/login/member_center.md)
- [ ] [注销登录](docs/login/exit.md)
- [x] [登录记录](docs/login/login_notice.md)
- [x] [Web 端 Cookie 刷新](docs/login/cookie_refresh.md)
- [ ] [消息中心](docs/message)
- [ ] [通知类消息](docs/message/msg.md)
- [ ] [私信](docs/message/private_msg.md)
- [ ] 设置
- [ ] [用户](docs/user)
- [x] [基本信息](docs/user/info.md)
- [x] [状态数](docs/user/status_number.md)
- [x] [关系](docs/user/relation.md)
- [ ] [个人空间](docs/user/space.md)
- [x] [检查昵称是否可注册](docs/user/check_nickname.md)
- [x] [用户注册](docs/user/register.md)
- [x] [用户认证类型一览](docs/user/official_role.md)
- [ ] [大会员](docs/vip)
- [ ] [大会员基本信息](docs/vip/info.md)
- [ ] [大会员中心](docs/vip/center.md)
- [ ] [大会员签到](docs/vip/clockin.md)
- [ ] [大会员操作](docs/vip/action.md)
- [ ] [视频](docs/video)
- [x] [视频分区一览 (分区代码)](docs/video/video_zone.md)
- [x] [基本信息](docs/video/info.md)
- [x] [状态数](docs/video/status_number.md)
- [x] [快照](docs/video/snapshot.md)
- [x] [点赞 & 投币 & 收藏 & 分享](docs/video/action.md)
- [ ] [TAG](docs/video/tags.md)
- [x] [视频推荐](docs/video/recommend.md)
- [x] [播放&下载地址 (视频流)](docs/video/videostream_url.md)
- [ ] [互动视频](docs/video/interact_video.md)
- [x] [高能进度条](docs/video/pbp.md)
- [ ] [信息上报 (心跳及记录历史)](docs/video/report.md)
- [x] [视频属性数据](docs/video/attribute_data.md)
- [x] [视频在线人数](docs/video/online.md)
- [ ] [剧集 (番剧、影视)](docs/bangumi)
- [ ] [基本信息](docs/bangumi/info.md)
- [ ] [播放&下载地址(视频流)](docs/bangumi/videostream_url.md)
- [ ] [时间轴](docs/bangumi/timeline.md)
- [ ] 状态数
- [ ] 操作
- [ ] [视频弹幕](docs/danmaku)
- [x] [protobuf 实时弹幕](docs/danmaku/danmaku_proto.md)
- [x] [protobuf 弹幕元数据BAS 弹幕 / 互动弹幕)](docs/danmaku/danmaku_view_proto.md)
- [x] [xml 实时弹幕](docs/danmaku/danmaku_xml.md)
- [x] [历史弹幕](docs/danmaku/history.md)
- [x] [快照](docs/danmaku/snapshot.md)
- [ ] [弹幕操作](docs/danmaku/action.md)
- [ ] 高级弹幕
- [ ] 屏蔽管理
- [ ] 智能防挡弹幕
- [x] [弹幕个人配置修改](docs/danmaku/config.md)
- [x] [名词解释](docs/danmaku/buzzword.md)
- [x] [点赞查询](docs/danmaku/thumbup.md)
- [x] [视频笔记](docs/note)
- [x] [笔记列表](docs/note/list.md)
- [x] [笔记详细信息](docs/note/info.md)
- [x] [笔记操作](docs/note/action.md)
- [ ] [专栏](docs/article)
- [ ] 分区
- [X] [基本信息](docs/article/info.md)
- [X] [点赞 & 投币 & 收藏 & 分享](docs/article/action.md)
- [X] [文集基本信息](docs/article/articles.md)
- [X] [获取用户专栏文章列表](docs/article/list.md)
- [ ] [音频](docs/audio)
- [x] [歌曲基本信息](docs/audio/info.md)
- [ ] [歌单 & 音频收藏夹详细信息](docs/audio/music_list.md)
- [ ] [状态数](docs/audio/status_number.md)
- [ ] [投币 & 收藏](docs/audio/action.md)
- [x] [播放 & 下载地址(音频流)](docs/audio/musicstream_url.md)
- [x] [音频榜单](docs/audio/rank.md)
- [ ] [排行榜 & 最新视频](docs/video_ranking)
- [ ] [排行榜](docs/video_ranking/ranking.md)
- [ ] [热门视频](docs/video_ranking/popular.md)
- [ ] [最新视频](docs/video_ranking/dynamic.md)
- [x] [入站必刷视频](docs/video_ranking/precious_videos.md)
- [ ] [搜索](docs/search)
- [x] [搜索请求](docs/search/search_request.md)
- [x] [搜索结果](docs/search/search_response.md)
- [x] [默认搜索 & 热搜](docs/search/hot.md)
- [x] [搜索建议](docs/search/suggest.md)
- [ ] [小黑屋](docs/blackroom)
- [ ] 基本信息
- [x] [封禁公示](docs/blackroom/banlist.md)
- [x] [风纪委员及众裁案件相关](docs/blackroom/jury)
- [x] [风纪委员基本信息](docs/blackroom/jury/base_info.md)
- [x] [众裁案件基本信息](docs/blackroom/jury/judgement_info.md)
- [x] [裁决操作](docs/blackroom/jury/action.md)
- [x] [评论区](docs/comment)
- [x] [评论区明细](docs/comment/list.md)
- [x] [操作](docs/comment/action.md)
- [ ] [表情](docs/emoji)
- [x] [表情及表情包信息](docs/emoji/list.md)
- [x] [操作](docs/emoji/action.md)
- [ ] [创作中心](docs/creativecenter)
- [ ] [统计与数据](docs/creativecenter/statistics&data.md)
- [ ] 列表查询相关
- [x] [电磁力数据](docs/creativecenter/railgun.md)
- [x] [实时广播(通讯协议)](docs/broadcast)
- [x] [视频内广播](docs/broadcast/video_room.md)
- [ ] [充电](docs/electric)
- [ ] [包月充电操作](docs/electric/monthly.md)
- [x] [自定义充电B币方式](docs/electric/Bcoin.md)
- [x] [自定义充电(微信 & 支付宝方式)](docs/electric/WeChat&Alipay.md)
- [x] [充电留言](docs/electric/charge_msg.md)
- [x] [充电列表](docs/electric/charge_list.md)
- [ ] [动态](docs/dynamic)
- [ ] [动态基本信息](docs/dynamic/basicInfo.md)
- [ ] [发送 & 转载动态](docs/dynamic/publish.md)
- [ ] [根据关键字搜索用户at 别人时的填充列表)](docs/dynamic/atlist.md)
- [ ] [操作](docs/dynamic/action.md)
- [ ] 动态列表
- [x] [特定话题动态列表](docs/dynamic/tag_dynamics.md)
- [ ] [动态内容](docs/dynamic/get_dynamic_detail.md)
- [ ] [相簿](docs/album)
- [x] [基本信息](docs/album/info.md)
- [x] [相簿列表](docs/album/list.md)
- [x] [推荐作者](docs/album/recommend_author.md)
- [x] [活动列表](docs/album/activity_list.md)
- [x] [操作](docs/album/action.md)
- [ ] 投稿
- [ ] [历史记录 & 稍后再看](docs/history&toview)
- [x] [历史记录](docs/history&toview/history.md)
- [x] [稍后再看](docs/history&toview/toview.md)
- [ ] [收藏夹](docs/fav)
- [x] [基本信息](docs/fav/info.md)
- [x] [收藏夹内容](docs/fav/list.md)
- [ ] [收藏夹操作](docs/fav/action.md)
- [ ] [课程](docs/cheese)
- [x] [课程基本信息](docs/cheese/info.md)
- [ ] 已购课程
- [ ] 分区推荐列表
- [ ] 操作
- [x] [播放 & 下载地址(视频流)](docs/cheese/videostream_url.md)
- [ ] [直播](docs/live)
- [ ] [直播间基本信息](docs/live/info.md)
- [ ] [直播分区](docs/live/live_area.md)
- [ ] [直播间管理](docs/live/manage.md)
- [ ] 直播间操作
- [ ] [直播视频流](docs/live/live_stream.md)
- [ ] [直播信息流](docs/live/message_stream.md)
- [ ] [直播红包](docs/live/redpocket.md)
- [ ] [直播间用户实用 API](docs/live/user.md)
- [ ] [转正答题](docs/newbie_exam)
- [x] [查询信息](docs/newbie_exam/info.md)
- [x] [拉取题目](docs/newbie_exam/fetch.md)
- [x] [操作](docs/newbie_exam/action.md)
- [ ] B币钱包
- [ ] 基本信息
- [ ] B币充值
- [ ] 贝壳相关
- [ ] [哔哩哔哩漫画](docs/manga)
- [ ] [用户信息](docs/manga/user.md)
- [x] [签到](docs/manga/ClockIn.md)
- [x] [积分商城](docs/manga/point_shop.md)
- [x] [漫画操作](docs/manga/Comic.md)
- [x] [漫画赛季](docs/manga/Season.md)
- [x] [漫读券/已购相关](docs/manga/User.md)
- [x] [下载](docs/manga/Download.md)
- [x] [data.index解析](docs/manga/index_file.md)
- [ ] 哔哩哔哩游戏
- [ ] [终端网络查询](docs/clientinfo)
- [x] [基于 ip 的地理位置查询](docs/clientinfo/ip.md)
- [x] [终端信息查询](docs/clientinfo/client_info.md)
- [ ] [其他](docs/misc)
- [x] [获取当前时间戳](docs/misc/time_stamp.md)
- [ ] [web端组件](docs/web_widget)
- [x] [分区当日投稿数](docs/web_widget/zone_upload.md)
- [x] [404 页漫画收集](docs/web_widget/404_manga.md)
- [ ] [APP端组件](docs/APP_widget)
- [x] [开屏图片 + 恰饭珍贵录像](docs/APP_widget/splash.md)
- [ ] [个性装扮](docs/garb)
- [x] [APP 主题](docs/garb/skin.md)
- [x] [主题色](docs/garb/color.md)
## ✨鸣谢
你们的存在,让社区更美好
[![contributors](https://opencollective.com/bilibili-api-collect/contributors.svg?width=860&button=false)](https://github.com/SocialSisterYi/bilibili-API-collect/graphs/contributors)
## 📖相关协议基础
http 协议:[传送门](https://www.cnblogs.com/an-wen/p/11180076.html)
json 序列格式:[传送门](https://www.sojson.com/json/json_index.html)
xml 序列格式:[传送门](https://www.w3school.com.cn/xml/xml_intro.asp)
protobuf 序列格式:[传送门](https://www.jianshu.com/p/a24c88c0526a )
## 💦交流
<img src="https://avatars.githubusercontent.com/u/45892418" width="100" height="100">
⚠注意:开源社群欢迎交流探讨,**拒绝**咨询、**不支持**合作,**黑产号**一经发现立即拉黑并举报相关 SRC
- QQ 交流群:[邀请链接](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=2rRJXK3zgU5yi3e_4rNLeJYUjMLzw_Jj&authKey=L%2FN3EfZXo3QFjEuHq4ifTgh%2F384UmrYpjl7dbYPhYHtznhfJWxkymxQKObQunmEQ&noverify=0&group_code=560304737)
- Telegram 交流群:[@bilibili_API_collect_community](https://t.me/bilibili_API_collect_community)
## 🧋发电
欢迎来~~交♂易~~,大家的支持就是我继续开发的动力!
~~请可爱的易姐喝杯奶茶~~
WeChat & Alipay
<img src="./assets/img/sponsorQR.jpg" width="300" height="300">
OR Aifadian[https://afdian.net/@ShakaiAneE](https://afdian.net/@ShakaiAneE)
## 🔗相关项目推荐
### 库及文档
- [jingyuexing/bilibiliAPI](https://github.com/jingyuexing/bilibiliAPI)
- [fython/BilibiliAPIDocs](https://github.com/fython/BilibiliAPIDocs)
- [czp3009/bilibili-api](https://github.com/czp3009/bilibili-api)
- [Vespa314/bilibili-api](https://github.com/Vespa314/bilibili-api)
- [wnstar/bili-utils](https://github.com/wnstar/bili-utils)
- [lovelyyoshino/Bilibili-Live-API](https://github.com/lovelyyoshino/Bilibili-Live-API)
- [flaribbit/bilibili-manga-spider](https://github.com/flaribbit/bilibili-manga-spider)
- [simon300000/bili-api](https://github.com/simon300000/bili-api)
- [iyear/biligo](https://github.com/iyear/biligo) Bilibili API SDK in Golang
- [bilibili-openplatform/demo](https://github.com/bilibili-openplatform/demo): 哔哩哔哩开放平台示例代码库
- [ddiu8081/blive-message-listener](https://github.com/ddiu8081/blive-message-listener): Bilibili-live danmu listener with type. Bilibili 直播间弹幕监听库,支持类型输出。
- [Nemo2011/bilibili-api](https://github.com/Nemo2011/bilibili-api): 哔哩哔哩常用API调用。支持视频、番剧、用户、频道、音频等功能。工具齐全。
- [CuteReimu/bilibili](https://github.com/CuteReimu/bilibili): 哔哩哔哩API的Go版本SDK
### 成品
- [NullPointerException/AnimePipe](https://codeberg.org/NullPointerException/AnimePipe): 功能完善的Android流媒体综合客户端支持Bilibili, Youtube, NicoNico
- [3Shain/BiliChat](https://github.com/3Shain/BiliChat) : 基于h5的B站直播弹幕姬
- [AncientLysine/BiliLocal](https://github.com/AncientLysine/BiliLocal):本地弹幕播放器
- [zyzsdy/biliroku](https://github.com/zyzsdy/biliroku):bilibili 生放送(直播)录制
- [otakustay/danmaku-to-ass](https://github.com/otakustay/danmaku-to-ass):A站B站弹幕转字幕文件
- [bilibili-helper/bilibili-helper-o](https://github.com/bilibili-helper/bilibili-helper-o):哔哩哔哩 (bilibili.com) 辅助工具,可以下载视频,查询弹幕发送人以及一些十分实用的直播区功能。
- [apachecn/BiliDriveEx](https://github.com/apachecn/BiliDriveEx):基于B站相簿上传的文件分块索引存储器
- [apachecn/CDNDrive](https://github.com/apachecn/CDNDrive):基于B站相簿上传的文件分块索引存储器
- [Hsury/BiliDrive](https://github.com/Hsury/BiliDrive):基于B站相簿上传的文件分块索引存储器
- [Tsuk1ko/bilibili-live-chat](https://github.com/Tsuk1ko/bilibili-live-chat):无后端的仿 YouTube Live Chat 风格的简易 Bilibili 弹幕姬
- [ironmanic/crawler_target_users_good](https://github.com/ironmanic/crawler_target_users_good):搜索bilibili特定视频为评论 点赞,关注,私信,一体化服务
- [dd-center/DDatElectron](https://github.com/dd-center/DDatElectron):DD@Home 分布式项目, 桌面客户端
- [dd-center/vtbs.moe](https://github.com/dd-center/vtbs.moe):B站VTB数据中心
- [JunzhouLiu/BILIBILI-HELPER](https://github.com/JunzhouLiu/BILIBILI-HELPER):利用Linux Crontab定时任务,云函数Docker等方式实现B站哔哩哔哩Bilibili每日自动投币签到银瓜子兑换硬币领取大会员福利大会员月底给自己充电等。每天轻松获取65经验值。
- [the1812/Bilibili-Evolved](https://github.com/the1812/Bilibili-Evolved):强大的哔哩哔哩增强脚本: 下载视频, 音乐, 封面, 弹幕 / 简化直播间, 评论区, 首页 / 自定义顶栏, 删除广告, 夜间模式 / 触屏设备支持
- [xlzy520/bili-short-url](https://github.com/xlzy520/bili-short-url): 哔哩哔哩短链生成器
- [zjkwdy/bili_app_splash](https://github.com/zjkwdy/bili_app_splash): B站壁纸娘和开屏图自动下载每天使用Actions自动同步
- [Jannchie/BiliOB](https://github.com/Jannchie/BiliOB): BiliOB观测者是一个观测B站UP主及视频数据变化并予以分析的Web应用程序
- [biliob233/biliob233.github.io](https://github.com/biliob233/biliob233.github.io): ~~无可奉告~~
- [biliup/biliup](https://github.com/biliup/biliup): 全自动录播、投稿工具也支持twitch、ytb频道搬运。提供分p上传b站接口腾讯云内网免流+大幅提速
- [ddiu8081/bilicli](https://github.com/ddiu8081/bilicli): Bilibili-live danmu dashboard in your terminal.
- [MotooriKashin/Bilibili-Old](https://github.com/MotooriKashin/Bilibili-Old): 恢复旧版Bilibili页面为了那些念旧的人。
- [SocialSisterYi/bcut-asr](https://github.com/SocialSisterYi/bcut-asr): 使用必剪API的语音字幕识别
- [CzJam/Bili_Realtime_Data](https://github.com/CzJam/Bili_Realtime_Data): Bilibili粉丝与视频实时数据统计
### 其他
- [kuresaru/geetest-validator](https://github.com/kuresaru/geetest-validator):geetest调试器
- [uw-labs/bloomrpc](https://github.com/uw-labs/bloomrpc): GUI Client for GRPC Services
- [grpc/grpc](https://github.com/grpc/grpc): The C based gRPC (C++, Python, Ruby, Objective-C, PHP, C#)
- [quicktype](https://github.com/quicktype/quicktype) quicktype generates strongly-typed models and serializers from JSON, JSON Schema, TypeScript, and GraphQL queries, making it a breeze to work with JSON type-safely in many programming languages.一键生成多种语言的json反序列化所需类,以便于快速反序列化, 有网页版
<style scoped>
.shields a {
margin: auto .5em;
}
</style>