摸鱼派 API 文档

注意事项

• 请一定要在请求时带上 UA，推荐使用 Chrome 的 UA，空 UA 将返回 500 状态码
• 对单个接口的访问频率必须控制在最低1次/30秒，否则IP可能进入小黑屋（WebSocket、发送消息接口除外）

摸鱼派与OpenAPI

为了方便大家调试 API，我们开通了摸鱼派 API 的 ApiFox 团队，团队内集合了摸鱼派 API 的集合样例（欢迎补全），如想加入请在评论区回复你的 ApiFox 注册邮箱，我们将进行邀请。

🌟 Swagger UI

摸鱼派内嵌 Swagger UI，可在线对摸鱼派 API 进行调试（如有疏漏请私信项目支持开摆 @8888 ）

使用地址：https://fishpi.cn/swagger/index.html

✨ OpenAPI

我们将采用 OpenAPI 标准的 API JSON 文件进行了公开，你可以将其直接导入到 ApiFox 使用，或者想怎么用都可以 😄

OpenAPI JSON 文件地址：https://fishpi.cn/swagger/swagger.json

鉴权

摸鱼派社区 API 引入了 apiKey 的概念，对 API 的请求不需要提供 Cookie，只需要在参数中带上申请的 apiKey 即可。

注意：凡是 POST 请求，请求体必须是 JSON 格式，例如：{ "nameOrEmail":"","userPassword":"" }

获取 apiKey

POST /api/getKey

用于 API 获取摸鱼派的通用密钥，Key 即身份，Key 长期有效，如果服务器重启，则需要重新获取，建议配合 /api/user 接口定期检测 Key 是否有效。

请求:

请求示例：

curl --location --request POST 'https://fishpi.cn/api/getKey' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/69.0.3497.100 Safari/537.36' \
--data-raw '{
 "nameOrEmail":"username",
 "userPassword":"e10adc3949ba59abbe56e057f20f883e",
 "mfaCode":"123456"
}'

^* 注意：这里不支持直接传递明文，必须是32位小写MD5加密后的密码

响应：

查询用户信息

GET /api/user?apiKey=<Key>

通过指定的 API Key 查询用户信息（可以用来定期验证 API Key 是否有效）

请求:

请求示例：

curl --location --request GET 'https://fishpi.cn/api/user?apiKey=oXTQTD4ljryXoIxa1lySgEl6aObrIhSS'
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/69.0.3497.100 Safari/537.36' \

响应：

^* 注意：若密钥无效，无 data 项目

注册用户

以下关于注册用户接口的内容我以提供注册思路为导向进行编写，方便大家对接。

第一步 获取一个图形验证码，要求用户识别并填写，带入到第二步的请求中

获取图形验证码可访问 GET /captcha

第二步 向摸鱼派请求获取短信验证码

POST /register

请求:

第三步 验证短信验证码是否正确

GET /verify?code=<code>

请求：

返回结果后请验证返回 JSON 中 code 的值是否为 0，如为 0 则验证码正确，并记录下返回的userId。

第四步 设定密码和邮箱

POST /register2?r=<r>

请注意！请将密码在本地MD5加密后再放到 userPassword 中！不接受明文密码！

code 返回 0 则注册成功！

通用

查询成员信息

GET /user/<username>?apiKey=<Key>

查询某个成员的信息

请求:

^* 选填，填写后 canFollow 返回值可以显示是否已经关注该用户

请求示例：

curl --location --request GET 'https://fishpi.cn/user/taozhiyu?apiKey=oXTQTD4ljryXoIxa1lySgEl6aObrIhSS'\
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/69.0.3497.100 Safari/537.36' \

响应：

用户名联想

POST /users/names

通过现有的字符串推断完整的用户名（列表）

请求:

请求示例：

curl --location --request POST 'https://fishpi.cn/users/names' \
--header 'Content-Type: application/json' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/69.0.3497.100 Safari/537.36' \
--data-raw '{
 "name":"ad"
}'

响应：

用户常用表情

GET /users/emotions?apiKey=<Key>

获取用户常用表情

请求:

请求示例：

curl --location --request GET 'https://fishpi.cn/users/emotions?apiKey=oXTQTD4ljryXoIxa1lySgEl6aObrIhSS' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/69.0.3497.100 Safari/537.36'

响应：

获取活跃度

GET /user/liveness?apiKey=<Key>

获取用户活跃度

警告⚠️️️️️️️️️️️️:
本接口负载较大，请至少将请求间隔延长至30秒，建议每次循环取 (30,60] 秒的随机数，如间隔小于30秒，登录状态会被直接注销！

请求：

请求示例：

curl --location --request GET 'https://fishpi.cn/user/liveness?apiKey=oXTQTD4ljryXoIxa1lySgEl6aObrIhSS' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/69.0.3497.100 Safari/537.36'

响应：

获取签到状态

GET /user/checkedIn?apiKey=<Key>

获取用户是否签到

请求:

请求示例:

curl --location --request GET 'https://fishpi.cn/user/checkedIn?apiKey=oXTQTD4ljryXoIxa1lySgEl6aObrIhSS' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/69.0.3497.100 Safari/537.36'

响应：

领取昨日活跃奖励

GET /activity/yesterday-liveness-reward-api?apiKey=<Key>

领取昨日活跃奖励

请求示例:

请求示例:

curl --location --request GET 'https://fishpi.cn/activity/yesterday-liveness-reward-api?apiKey=oXTQTD4ljryXoIxa1lySgEl6aObrIhSS' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/69.0.3497.100 Safari/537.36'

响应：

查询昨日奖励领取状态

GET /api/activity/is-collected-liveness

查询昨日活跃奖励是否已被领取

请求示例:

请求示例:

curl --location --request GET 'https://fishpi.cn/api/activity/is-collected-liveness?apiKey=oXTQTD4ljryXoIxa1lySgEl6aObrIhSS' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/69.0.3497.100 Safari/537.36'

响应：

举报

POST /report

举报内容接口
请注意！ 该接口为复用接口，请确保 Content-Type 为 application/x-www-form-urlencoded 而非JSON，否则将无法请求成功

请求：

请求示例：

curl --location --request POST 'https://fishpi.cn/report' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/69.0.3497.100 Safari/537.36' \
--header 'Content-Type: application/json' \
--data-raw '{
 "apiKey":"oXTQTD4ljryXoIxa1lySgEl6aObrIhSS",
 "reportDataId":"1651126540998",
 "reportDataType":3,
 "reportType":49,
 "reportMemo":""，
}'

响应：

查询最近注册的20个用户

GET /api/user/recentReg

转账

POST /point/transfer

请求：

关注用户

POST /follow/user

请求：

取关用户

POST /unfollow/user

请求：

通知

通知计数

GET /notifications/unread/count

获取用户未阅读的通知计数

请求：

请求示例:

curl --location --request GET 'https://fishpi.cn/notifications/unread/count?apiKey=oXTQTD4ljryXoIxa1lySgEl6aObrIhSS' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/69.0.3497.100 Safari/537.36'

响应：

通知详情

GET /api/getNotifications?apiKey=<Key>&type=<type>[&page=<page>]

获取详细通知列表

请求：

通知类型：

请求示例:

curl --location --request GET 'https://fishpi.cn/api/getNotifications?apiKey=oXTQTD4ljryXoIxa1lySgEl6aObrIhSS&type=point' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/69.0.3497.100 Safari/537.36'

积分(point)通知响应：

收到的回帖/回复(commented/reply)通知响应：

收到的 @ (at) 通知响应：

我关注的(following) 通知响应：

| 系统(sys-announce)通知响应： | | |

批量已读类型的通知

GET /notifications/make-read/<type>?apiKey=<Key>

将制定类型的通知标记为已读

请求：

| 通知类型： | |

请求示例:

curl --location --request GET 'https://fishpi.cn/notifications/make-read/point?apiKey=oXTQTD4ljryXoIxa1lySgEl6aObrIhSS' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/69.0.3497.100 Safari/537.36'

已读所有消息

GET /notifications/all-read?apiKey=<Key>

将全部通知标记为已读

请求：

请求示例:

curl --location --request GET 'https://fishpi.cn/notifications/all-read?apiKey=oXTQTD4ljryXoIxa1lySgEl6aObrIhSS' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/69.0.3497.100 Safari/537.36'

聊天室

连接聊天室

WSS /chat-room-channel?apiKey=<Key>

聊天室接收消息的WebSocket

请求：

事件处理：

消息结构：

聊天历史消息

GET /chat-room/more?apiKey=<Key>&page=<page>

获取更多聊天信息

请求：

请求示例：

curl --location --request GET 'https://fishpi.cn/chat-room/more?page=1&apiKey=5r1qeYe4tDx0No9uEpXA4rK2peczjZ40' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/69.0.3497.100 Safari/537.36'

响应：

GET /chat-room/getMessage

通过聊天消息的oId获取前后消息，避免重复的问题，也可以用于快捷跳转至某条消息

注意：使用本接口必须已经登录或填写正确的apiKey，否则将返回401

请求：

响应：

发送消息

POST /chat-room/send

发送聊天室消息

请求：

^* 如果是发送红包，则需要发送 [redpacket]{...}[/redpacket]的格式

响应：

撤回消息

DELETE /chat-room/revoke/<oId>

撤回聊天室消息（限制用户每24小时一次，管理员无限次）

请求：

请求示例：

curl --location --request DELETE 'https://fishpi.cn/chat-room/revoke/1640078407444' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/69.0.3497.100 Safari/537.36' \
--header 'Content-Type: application/json' \
--data-raw '{
 "apiKey":"oXTQTD4ljryXoIxa1lySgEl6aObrIhSS"
}'

响应：

获取消息 Markdown

GET /cr/raw/<oId>

查看聊天室消息的 Markdown 原文，引用时使用。

请求：

请求示例：

curl --location --request GET 'https://fishpi.cn/cr/raw/1641290717190' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/69.0.3497.100 Safari/537.36' \

响应示例：

<img alt="trollface" class="emoji" src="https://file.fishpi.cn/vditor/dist/images/emoji/trollface.png" title="trollface" />

<!-- Generated by Rhythm (https://github.com/csfwff/rhythm) in 1ms, 2022/01/04 18:07:36 -->

打开红包

POST /chat-room/red-packet/open

拆开聊天室红包

请求：

请求示例：

curl --location --request POST 'https://fishpi.cn/chat-room/red-packet/open' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/69.0.3497.100 Safari/537.36' \
--header 'Content-Type: application/json' \
--data-raw '{
 "apiKey":"5r1qeYe4tDx0No9uEpXA4rK2peczjZ40",
 "oId":"1640075201124"
}'

响应：

获取表情包

POST /api/cloud/get

从云获取指定 Key 内容，这里用于获取用户表情包

请求：

请求示例：

curl --location --request POST 'https://fishpi.cn/api/cloud/get' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/69.0.3497.100 Safari/537.36' \
--header 'Content-Type: application/json' \
--data-raw '{
 "apiKey":"oXTQTD4ljryXoIxa1lySgEl6aObrIhSS",
 "gameId":"emojis"
}'

响应：

同步表情包

POST /api/cloud/sync

同步指定 Key 数据到云，这里用于同步用户表情包

请求：

*此处数据需确保符合格式，否则会影响其他客户端正常解析数据。
*列表为覆盖式上传，请自行获取旧表情包列表，追加提交。

请求示例：

curl --location --request POST 'https://fishpi.cn/api/cloud/get' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/69.0.3497.100 Safari/537.36' \
--header 'Content-Type: application/json' \
--data-raw '{
 "apiKey":"oXTQTD4ljryXoIxa1lySgEl6aObrIhSS",
 "gameId":"emojis",
 "data":"[\"url1\", \"url2\"]"
}'

响应：

获取禁言中成员列表（思过崖）

GET /chat-room/si-guo-list

图床

上传图片

POST /upload

上传图片或视频

限制

• 大小：<=20M，
• 文件格式：jpg, jpeg, png, gif, mp4
• 请求类型：multipart/form-data

请求：

响应：

帖子

发贴

POST /article

发表帖子

请求：

更新贴子

PUT /article/<id>

更新帖子

请求：

帖子列表

特别注意

所有帖子列表API都支持翻页功能，可在请求后加入参数 ?p=<Page>自定义页码。

所有帖子列表APi都支持定义每页显示文章数量，可在请求后加入参数 ?size=<Size>自定义数量。

最近

• 最近帖子列表：GET /api/articles/recent
• 热门帖子列表：GET /api/articles/recent/hot
• 点赞帖子列表：GET /api/articles/recent/good
• 最近回复帖子列表：GET /api/articles/recent/reply

按标签

• 列出帖子：GET /api/articles/tag/<标签URI>
• 按热门程度列出帖子：GET /api/articles/tag/<标签URI>/hot
• 按点赞列出帖子：GET /api/articles/tag/<标签URI>/good
• 按最近回复列出帖子：GET /api/articles/tag/<标签URI>/reply
• 按优选列出帖子：GET /api/articles/tag/<标签URI>/perfect

注：标签URI可在点开某个标签的页面后，在URL中提取，例如系统公告的标签URI为 announcement。

按领域

• 列出帖子：GET /api/articles/domain/<领域URI>

注：领域URI与标签URI同理，都可以从领域的页面的URL中提取。

响应（帖子列表通用）：

获取指定帖子

获取指定帖子的评论、文章内容、目录、点赞数量等。

GET /api/article/<文章ID>?apiKey=<Key>

请求:

请求示例：

curl --location --request GET 'https://fishpi.cn/api/article/1636516552191?apiKey=oXTQTD4ljryXoIxa1lySgEl6aObrIhSS'
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/69.0.3497.100 Safari/537.36' \

响应：

标签信息

评论与作者用户信息

评论信息

获取指定用户的帖子列表

GET /api/user/{userName}/articles

请求：

给文章点赞

POST /vote/up/article

请求：

响应：

感谢文章

POST /article/thank?articleId={文章oId}

注意：文章oId在URL上传参，apiKey还是通过POST进行哦。

请求：

响应：

获取帖子的评论列表

获取指定帖子的评论列表。

获取第一页时，data中会有articleNiceComment，即优质回帖。

GET /api/comment/<文章ID>?apiKey=<Key>&p=<页数>

请求:

评论/回复

POST /comment

请求：

更新评论

PUT /comment/{评论oId}

请求：

给评论点赞

POST /vote/up/comment

请求：

响应：

感谢评论

POST /comment/thank

注意：不能给自己点感谢！会报错，记得做处理哦。

另外，感谢是不能取消的，会扣除15积分送给对方。

请求：

响应：

删除评论

POST /comment/{评论的oId}/remove

请求：

响应：

获取帖子当前正在阅读的人数

POST /api/article/heat/{articleId}

注意：如果你注意到了 /article-channel 频道中有 {"articleId":"1631779202219","type":"articleHeat","operation":"+"} 这种消息的时候，operation是加号代表又来了一个阅读的人，减号代表走了一个阅读的人，可以和本API进行结合，实时展示共同阅读人数

请求：

响应：

清风明月

获取清风明月列表

GET /api/breezemoons

请求：

请求示例：

curl --location --request GET 'https://fishpi.cn/api/breezemoons?p=1&size=20' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/69.0.3497.100 Safari/537.36' \

响应：

发布清风明月

POST /breezemoon

请求：

请求示例：

curl --location --request POST 'https://fishpi.cn/breezemoon' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/69.0.3497.100 Safari/537.36' \
--header 'Content-Type: application/json' \
--data-raw '{
 "apiKey":"oXTQTD4ljryXoIxa1lySgEl6aObrIhSS",
 "breezemoonContent":"helloworld"
}'

响应：

获取指定用户的清风明月列表

GET /api/user/{userName}/breezemoons

请求：

私信

私信部分已重构

新版私信系统全部采用摸鱼派开放 API 进行请求，全动态（包括 Web 端），API 已全部开发完毕，但是 API 文档还得等等（没时间写），如果你需要重构私信系统，请先自行抓包哦～

敏感cāo作

永久注销删除用户

注意！使用本接口将抹除该用户在社区中的数据（部分关联数据保留）无法恢复。

该接口需要重复请求2次，第1次请求不会进行任何cāo作，仅进行提醒。

POST /settings/deactivate

请求：

金手指

注意注意注意注意注意⚠️️️️️️️️️️️️️️️️️️

金手指接口用于将摸鱼派某些敏感接口提供给第三方接入，主要用于向摸鱼派上传游戏成绩、验证用户数据、给用户颁发勋章等功能。

这些接口普通用户无法使用！必须有专用的密钥才可以使用！如没有金手指使用权限，请跳过阅读此部分内容（申请金手指密钥请联系 @adlered ）。

上传摸鱼大闯关关卡数据

POST /api/games/mofish/score

请求：

查询用户最近登录的IP地址

POST /user/query/latest-login-ip

请求：

添加勋章

POST /user/edit/give-metal

请求：

移除勋章

POST /user/edit/remove-metal

请求：

移除勋章（通过userId）

POST /user/edit/remove-metal-by-user-id

请求：

查询用户背包

POST /user/query/items

请求：

调整用户背包

POST /user/edit/items

请求：

调整用户积分

POST /user/edit/points

请求：

获取用户活跃度

POST /user/liveness

获取指定用户的活跃度

请求：

响应：

领取指定用户的昨日活跃奖励

POST /activity/yesterday-liveness-reward-api

为指定用户领取他的昨日活跃奖励

请求：

响应：