客户端

如何使用

aiotieba.Client是aiotieba的核心入口点 (Entry Point)，其中封装了大量操作百度贴吧核心API的简便方法，你可以把它理解成一个“客户端”

我们推荐通过异步上下文管理器来使用Client，例如：

async with aiotieba.Client() as client:
    ...

Client

贴吧客户端

参数：

名称	类型	描述	默认
BDUSS	str	BDUSS. Defaults to ''.	''
STOKEN	str	STOKEN. Defaults to ''.	''
account	Account	Account实例 该字段会覆盖前两个参数. Defaults to None.	None
try_ws	bool	尝试使用websocket接口. Defaults to False.	False
proxy	bool | ProxyConfig	True则使用环境变量代理 False则禁用代理 输入ProxyConfig实例以手动配置代理. Defaults to False.	False
timeout	TimeoutConfig	超时配置. Defaults to None.	None

init_websocket async

init_websocket() -> BoolResponse

初始化websocket

返回：

名称	类型	描述
BoolResponse	BoolResponse	True无须执行 False失败

get_self_info async

get_self_info(require: ReqUInfo = ALL) -> UserInfo

获取本账号信息

参数：

名称	类型	描述	默认
require	ReqUInfo	指示需要获取的字段	ALL

返回：

名称	类型	描述
UserInfo	UserInfo	用户信息

get_forum async

get_forum(fname_or_fid: str | int) -> Forum

获取贴吧信息 此接口较get_forum_detail更强大

参数：

名称	类型	描述	默认
fname_or_fid	str | int	目标贴吧名或fid 优先贴吧名	必需

返回：

名称	类型	描述
Forum	Forum	贴吧信息

get_forum_detail async

get_forum_detail(fname_or_fid: str | int) -> Forum_detail

获取贴吧信息

参数：

名称	类型	描述	默认
fname_or_fid	str | int	目标贴吧名或fid 优先fid	必需

返回：

名称	类型	描述
Forum_detail	Forum_detail	贴吧信息

get_fid async

get_fid(fname: str) -> IntResponse

通过贴吧名获取forum_id

参数：

名称	类型	描述	默认
fname	str	贴吧名	必需

返回：

名称	类型	描述
IntResponse	IntResponse	forum_id

get_fname async

get_fname(fid: int) -> StrResponse

通过forum_id获取贴吧名

参数：

名称	类型	描述	默认
fid	int	forum_id	必需

返回：

名称	类型	描述
StrResponse	StrResponse	贴吧名

get_threads async

get_threads(fname_or_fid: str | int, /, pn: int = 1, *, rn: int = 30, sort: ThreadSortType = REPLY, is_good: bool = False) -> Threads

获取首页帖子

参数：

名称	类型	描述	默认
fname_or_fid	str | int	贴吧名或fid 优先贴吧名	必需
pn	int	页码. Defaults to 1.	1
rn	int	请求的条目数. Range [1, 100]. Defaults to 30.	30
sort	ThreadSortType	HOT热门排序 REPLY按回复时间 CREATE按发布时间 FOLLOW关注的人. Defaults to ThreadSortType.REPLY.	REPLY
is_good	bool	True则获取精品区帖子 False则获取普通区帖子. Defaults to False.	False

返回：

名称	类型	描述
Threads	Threads	帖子列表

get_posts async

get_posts(tid: int, /, pn: int = 1, *, rn: int = 30, sort: PostSortType = ASC, only_thread_author: bool = False, with_comments: bool = False, comment_sort_by_agree: bool = True, comment_rn: int = 4) -> Posts

获取主题帖内回复

参数：

名称	类型	描述	默认
tid	int	所在主题帖tid	必需
pn	int	页码. Defaults to 1.	1
rn	int	请求的条目数. Range [2, 30]. Defaults to 30.	30
sort	PostSortType	ASC时间顺序 DESC时间倒序 HOT热门序. Defaults to PostSortType.ASC.	ASC
only_thread_author	bool	True则只看楼主 False则请求全部. Defaults to False.	False
with_comments	bool	True则同时请求高赞楼中楼 False则返回的Post.comments字段为空. Defaults to False.	False
comment_sort_by_agree	bool	True则楼中楼按点赞数顺序 False则楼中楼按时间顺序. Defaults to True.	True
comment_rn	int	请求的楼中楼数量. Range [1, 50]. Defaults to 4. 仅在with_comments为True时生效.	4

返回：

名称	类型	描述
Posts	Posts	回复列表

get_comments async

get_comments(tid: int, pid: int, /, pn: int = 1, *, is_comment: bool = False, sort: CommentSortType = ASC) -> Comments

获取楼中楼回复

参数：

名称	类型	描述	默认
tid	int	所在主题帖tid	必需
pid	int	所在楼层的pid或楼中楼的pid	必需
pn	int	页码. Defaults to 1.	1
is_comment	bool	pid是否指向楼中楼 若指向楼中楼则获取其附近的楼中楼列表. Defaults to False.	False
sort	CommentSortType	楼中楼排序 ASC时间顺序 DESC时间倒序 HOT热门序. Defaults to CommentSortType.ASC.	ASC

返回：

名称	类型	描述
Comments	Comments	楼中楼列表

get_last_replyers async

get_last_replyers(fname_or_fid: str | int, /, pn: int = 1, *, rn: int = 30, sort: ThreadSortType = REPLY, is_good: bool = False) -> Threads_lp

通过旧版接口获取带最后回复人的首页帖子

参数：

名称	类型	描述	默认
fname_or_fid	str | int	贴吧名或fid 优先贴吧名	必需
pn	int	页码. Defaults to 1.	1
rn	int	请求的条目数. Range [1, 100]. Defaults to 30.	30
sort	ThreadSortType	HOT热门排序 REPLY按回复时间 CREATE按发布时间 FOLLOW关注的人. Defaults to ThreadSortType.REPLY.	REPLY
is_good	bool	True则获取精品区帖子 False则获取普通区帖子. Defaults to False.	False

返回：

名称	类型	描述
Threads_lp	Threads_lp	带最后回复人的帖子列表

Note

该接口主要用于反挖坟 目前未封装完整的返回信息

search_in_forum async

search_in_forum(fname_or_fid: str | int, query: str, /, pn: int = 1, *, rn: int = 30, search_type: SearchInForumType = ALL, only_thread: bool = False) -> SearchInForums

吧内搜索 在指定贴吧内搜索特定内容

参数：

名称	类型	描述	默认
fname_or_fid	str | int	查询的贴吧名或fid 优先贴吧名	必需
query	str	查询文本	必需
pn	int	页码. Defaults to 1.	1
rn	int	请求的条目数. Range [1, 50]. Defaults to 30. 大于50时服务端会退化为10条.	30
search_type	SearchInForumType	查询模式 默认查询全部. Defaults to SearchInForumType.ALL.	ALL
only_thread	bool	是否仅查询主题帖. Defaults to False.	False

返回：

名称	类型	描述
SearchInForums	SearchInForums	搜索结果列表

search_global async

search_global(query: str, /, pn: int = 1, *, rn: int = 20, sort: SearchGlobalType = DESC) -> SearchGlobals

全吧搜索

参数：

名称	类型	描述	默认
query	str	查询文本	必需
pn	int	页码. Defaults to 1.	1
rn	int	请求的条目数. Range [1, 50]. Defaults to 20. 大于50时服务端会退化为10条.	20
sort	SearchGlobalType	排序方式. Defaults to SearchGlobalType.DESC.	DESC

返回：

名称	类型	描述
SearchGlobals	SearchGlobals	全吧搜索结果列表

Note

仅支持搜索主题帖 实测该接口的评论/楼中楼搜索(tt=3)不会生效 服务端会原样返回主题帖结果

若需要某个主题帖下的评论 请在拿到tid后使用get_posts单独查询

get_user_info async

get_user_info(id_: str | int, /, require: ReqUInfo = ALL) -> UserInfo

获取用户信息

参数：

名称	类型	描述	默认
id_	str | int	用户id user_id / portrait / user_name	必需
require	ReqUInfo	指示需要获取的字段	ALL

返回：

名称	类型	描述
UserInfo	UserInfo	用户信息

tieba_uid2user_info async

tieba_uid2user_info(tieba_uid: int) -> UserInfo_TUid

通过tieba_uid获取用户信息

参数：

名称	类型	描述	默认
tieba_uid	int	用户id tieba_uid	必需

返回：

名称	类型	描述
UserInfo_TUid	UserInfo_TUid	包含 user_id / portrait / user_name / nick_name_new

Note

请注意tieba_uid与旧版user_id的区别

get_homepage async

get_homepage(id_: str | int, /, pn: int = 1) -> Homepage

获取用户个人页信息

参数：

名称	类型	描述	默认
id_	str | int	用户id user_id / user_name / portrait 优先user_id	必需
pn	int	页码. Defaults to 1.	1

返回：

名称	类型	描述
Homepage	Homepage	用户个人页信息

get_follows async

get_follows(id_: str | int | None = None, /, pn: int = 1) -> Follows

获取关注列表

参数：

名称	类型	描述	默认
id_	str | int | None	用户id user_id / user_name / portrait 优先user_id 默认为None即获取本账号信息. Defaults to None.	None
pn	int	页码. Defaults to 1.	1

返回：

名称	类型	描述
Follows	Follows	关注列表

get_fans async

get_fans(id_: str | int | None = None, /, pn: int = 1) -> Fans

获取粉丝列表

参数：

名称	类型	描述	默认
id_	str | int | None	用户id user_id / user_name / portrait 优先user_id 默认为None即获取本账号信息. Defaults to None.	None
pn	int	页码. Defaults to 1.	1

返回：

名称	类型	描述
Fans	Fans	粉丝列表

get_blacklist async

get_blacklist() -> BlacklistUsers

获取完整的新版用户黑名单列表

返回：

名称	类型	描述
BlacklistUsers	BlacklistUsers	新版用户黑名单列表

get_blacklist_old async

get_blacklist_old(pn: int = 1, /, *, rn: int = 10) -> BlacklistOldUsers

获取旧版用户黑名单列表

参数：

名称	类型	描述	默认
pn	int	页码. Defaults to 1.	1
rn	int	请求的条目数. Range [1, Inf]. Defaults to 10.	10

返回：

名称	类型	描述
BlacklistOldUsers	BlacklistOldUsers	旧版用户黑名单列表

get_follow_forums async

get_follow_forums(id_: str | int, /, pn: int = 1, *, rn: int = 50) -> FollowForums

获取用户关注贴吧列表

参数：

名称	类型	描述	默认
id_	str | int	用户id user_id / user_name / portrait 优先user_id	必需
pn	int	页码. Defaults to 1.	1
rn	int	请求的条目数. Range [1, 200]. Defaults to 50.	50

返回：

名称	类型	描述
FollowForums	FollowForums	用户关注贴吧列表

get_follow_forums_pc async

get_follow_forums_pc(id_: str | int, /, pn: int = 1, *, rn: int = 50) -> PcFollowForums

获取用户关注贴吧列表

参数：

名称	类型	描述	默认
id_	str | int	用户id user_id / user_name / portrait 优先portrait	必需
pn	int	页码. Defaults to 1.	1
rn	int	请求的条目数. Range [1, 200]. Defaults to 50.	50

返回：

名称	类型	描述
PcFollowForums	PcFollowForums	用户关注贴吧列表

get_user_forum_info async

get_user_forum_info(fname_or_fid: str | int, id_: str | int) -> UserForumInfo

获取用户在某吧内的信息

参数：

名称	类型	描述	默认
fname_or_fid	str | int	目标贴吧名或fid 优先fid	必需
id_	str | int	用户id user_id / user_name / portrait 优先portrait	必需

返回：

名称	类型	描述
UserForumInfo	UserForumInfo	用户在吧内的信息

get_self_follow_forums async

get_self_follow_forums() -> SelfFollowForums

获取本账号关注贴吧列表

Note

该接口不分页 服务端单次最多下发200个吧 关注数超过200时请改用get_follow_forums

返回：

名称	类型	描述
SelfFollowForums	SelfFollowForums	本账号关注贴吧列表

get_dislike_forums async

get_dislike_forums(pn: int = 1, /, *, rn: int = 20) -> DislikeForums

获取首页推荐屏蔽的贴吧列表

参数：

名称	类型	描述	默认
pn	int	页码. Defaults to 1.	1
rn	int	请求的条目数. Range [1, 50]. Defaults to 20.	20

返回：

名称	类型	描述
DislikeForums	DislikeForums	首页推荐屏蔽的贴吧列表

get_self_posts async

get_self_posts(pn: int = 1, *, rn: int = 20) -> UserPostss

获取当前用户发布的回复列表

参数：

名称	类型	描述	默认
pn	int	页码. Defaults to 1.	1
rn	int	请求的条目数. Range [1, 74]. Defaults to 20.	20

返回：

名称	类型	描述
UserPostss	UserPostss	回复列表

get_user_posts_pc async

get_user_posts_pc(id_: str | int, pn: int = 1, *, rn: int = 20) -> PcUserPosts

获取用户发布的回复列表

参数：

名称	类型	描述	默认
id_	str | int	用户id user_id / user_name / portrait 优先portrait	必需
pn	int	页码. Defaults to 1.	1
rn	int	请求的条目数. Range [1, 74]. Defaults to 20.	20

返回：

名称	类型	描述
PcUserPosts	PcUserPosts	回复列表

get_user_posts async

get_user_posts(id_: str | int, pn: int = 1, *, rn: int = 20) -> UserPostss

获取用户发布的回复列表

参数：

名称	类型	描述	默认
id_	str | int	用户id user_id / user_name / portrait 优先user_id	必需
pn	int	页码. Defaults to 1.	1
rn	int	请求的条目数. Range [1, 74]. Defaults to 20.	20

返回：

名称	类型	描述
UserPostss	UserPostss	回复列表

get_self_threads async

get_self_threads(pn: int = 1, *, public_only: bool = False) -> UserThreads

获取当前用户发布的主题帖列表

参数：

名称	类型	描述	默认
pn	int	页码. Defaults to 1.	1
public_only	bool	是否仅获取公开主题帖 该选项在获取他人主题帖时无效. Defaults to False.	False

返回：

名称	类型	描述
UserThreads	UserThreads	主题帖列表

get_user_threads async

get_user_threads(id_: str | int, pn: int = 1) -> UserThreads

获取用户发布的主题帖列表

参数：

名称	类型	描述	默认
id_	str | int	用户id user_id / user_name / portrait 优先user_id	必需
pn	int	页码. Defaults to 1.	1

返回：

名称	类型	描述
UserThreads	UserThreads	主题帖列表

get_replys async

get_replys(pn: int = 1) -> Replys

获取回复信息

参数：

名称	类型	描述	默认
pn	int	页码. Defaults to 1.	1

返回：

名称	类型	描述
Replys	Replys	回复列表

get_ats async

get_ats(pn: int = 1) -> Ats

获取@信息

参数：

名称	类型	描述	默认
pn	int	页码. Defaults to 1.	1

返回：

名称	类型	描述
Ats	Ats	at列表

get_image_bytes async

get_image_bytes(img_url: str) -> ImageBytes

从链接获取静态图像的原始字节流

参数：

名称	类型	描述	默认
img_url	str	图像链接	必需

返回：

名称	类型	描述
ImageBytes	ImageBytes	未解码的原始字节流

get_image async

get_image(img_url: str) -> Image

从链接获取静态图像

参数：

名称	类型	描述	默认
img_url	str	图像链接	必需

返回：

名称	类型	描述
Image	Image	图像

hash2image async

hash2image(raw_hash: str, /, size: Literal['s', 'm', 'l'] = 's') -> Image

通过百度图库hash获取静态图像

参数：

名称	类型	描述	默认
raw_hash	str	百度图库hash	必需
size	Literal['s', 'm', 'l']	获取图像的大小 s为宽720 m为宽960 l为原图. Defaults to 's'.	's'

返回：

名称	类型	描述
Image	Image	图像

get_portrait async

get_portrait(id_: str | int, /, size: Literal['s', 'm', 'l'] = 's') -> Image

获取用户头像

参数：

名称	类型	描述	默认
id_	str | int	用户id user_id / user_name / portrait 优先portrait	必需
size	Literal['s', 'm', 'l']	获取头像的大小 s为55x55 m为110x110 l为原图. Defaults to 's'.	's'

返回：

名称	类型	描述
Image	Image	头像

__init_selfinfo_initNickname async

__init_selfinfo_initNickname() -> None

填充 user_name / nick_name_old / tieba_uid

__init_selfinfo_moindex async

__init_selfinfo_moindex() -> None

填充 user_id / portrait / user_name

get_square_forums async

get_square_forums(cname: str, /, pn: int = 1, *, rn: int = 20) -> SquareForums

获取吧广场列表

参数：

名称	类型	描述	默认
cname	str	类别名	必需
pn	int	页码. Defaults to 1.	1
rn	int	请求的条目数. Range [1, 1000]. Defaults to 20.	20

返回：

名称	类型	描述
SquareForums	SquareForums	吧广场列表

get_bawu_info async

get_bawu_info(fname_or_fid: str | int) -> BawuInfo

获取吧务团队信息

参数：

名称	类型	描述	默认
fname_or_fid	str | int	目标贴吧名或fid 优先fid	必需

返回：

名称	类型	描述
BawuInfo	BawuInfo	吧务团队信息

add_bawu async

add_bawu(fname_or_fid: str | int, /, id_: str | int, *, bawu_type: BawuType = MANAGER) -> BoolResponse

添加吧务

参数：

名称	类型	描述	默认
fname_or_fid	str | int	目标贴吧名或fid 优先fid	必需
id_	str | int	用户id user_id / user_name / portrait 优先user_name	必需
bawu_type	BawuType	吧务类型. Defaults to BawuType.MANAGER.	MANAGER

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

del_bawu async

del_bawu(fname_or_fid: str | int, /, id_: str | int, *, bawu_type: BawuType = MANAGER) -> BoolResponse

删除吧务

参数：

名称	类型	描述	默认
fname_or_fid	str | int	目标贴吧名或fid 优先fid	必需
id_	str | int	用户id user_id / user_name / portrait 优先portrait	必需
bawu_type	BawuType	吧务类型. Defaults to BawuType.MANAGER.	MANAGER

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

get_bawu_perm async

get_bawu_perm(fname_or_fid: str | int, /, id_: str | int) -> BawuPerm

获取指定吧务已分配的权限

参数：

名称	类型	描述	默认
fname_or_fid	str | int	目标贴吧名或fid 优先fid	必需
id_	str | int	用户id user_id / user_name / portrait 优先portrait	必需

返回：

名称	类型	描述
BawuPerm	BawuPerm	吧务已分配的权限

set_bawu_perm async

set_bawu_perm(fname_or_fid: str | int, /, id_: str | int, *, perms: BawuPermType = NULL) -> BoolResponse

为指定吧务分配权限

参数：

名称	类型	描述	默认
fname_or_fid	str | int	目标贴吧名或fid 优先fid	必需
id_	str | int	用户id user_id / user_name / portrait 优先portrait	必需
perms	BawuPermType	待分配的权限. Defaults to BawuPermType.NULL.	NULL

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

get_tab_map async

get_tab_map(fname_or_fid: str | int) -> TabMap

获取分区名到分区id的映射

参数：

名称	类型	描述	默认
fname_or_fid	str | int	目标贴吧名或fid 优先贴吧名	必需

返回：

名称	类型	描述
TabMap	TabMap	分区名到分区id的映射

get_rank_users async

get_rank_users(fname_or_fid: str | int, /, pn: int = 1) -> RankUsers

获取等级排行榜用户列表

参数：

名称	类型	描述	默认
fname_or_fid	str | int	目标贴吧名或fid 优先贴吧名	必需
pn	int	页码. Defaults to 1.	1

返回：

名称	类型	描述
RankUsers	RankUsers	等级排行榜用户列表

Note

本接口需要STOKEN

get_member_users async

get_member_users(fname_or_fid: str | int, /, pn: int = 1) -> MemberUsers

获取最新关注用户列表

参数：

名称	类型	描述	默认
fname_or_fid	str | int	目标贴吧名或fid 优先贴吧名	必需
pn	int	页码. Defaults to 1.	1

返回：

名称	类型	描述
MemberUsers	MemberUsers	最新关注用户列表

Note

本接口需要STOKEN

get_rank_forums async

get_rank_forums(fname_or_fid: str | int, /, pn: int = 1, *, rank_type: RankForumType = WEEKLY) -> RankForums

获取吧签到排行表

参数：

名称	类型	描述	默认
fname_or_fid	str | int	目标贴吧名或fid 优先贴吧名	必需
pn	int	页码. Defaults to 1.	1
rank_type	RankForumType	榜单类型 默认为周榜. Defaults to RankForumType.WEEKLY.	WEEKLY

返回：

名称	类型	描述
RankForums	RankForums	吧签到排行表

get_blocks async

get_blocks(fname_or_fid: str | int, /, name: str = '', pn: int = 1) -> Blocks

获获取吧务后台待解封用户列表

参数：

名称	类型	描述	默认
fname_or_fid	str | int	目标贴吧的贴吧名或fid 优先fid	必需
name	str	通过被封禁用户的用户名/昵称查询 默认为空即查询全部. Defaults to ''.	''
pn	int	页码. Defaults to 1.	1

返回：

名称	类型	描述
Blocks	Blocks	待解封用户列表

get_recovers async

get_recovers(fname_or_fid: str | int, /, pn: int = 1, *, rn: int = 10, id_: str | int | None = None) -> Recovers

获取吧务后台待恢复帖子列表

参数：

名称	类型	描述	默认
fname_or_fid	str | int	目标贴吧的贴吧名或fid 优先fid	必需
pn	int	页码. Defaults to 1.	1
rn	int	请求的条目数. Range [1, 50]. Defaults to 10.	10
id_	str | int | None	用于查询的被删帖用户的id user_id / user_name / portrait 优先user_id. Defaults to None.	None

返回：

名称	类型	描述
Recovers	Recovers	待恢复帖子列表

get_recover_info async

get_recover_info(fname_or_fid: str | int, /, tid: int, pid: int = 0) -> RecoverInfo

获取待恢复帖子的详细信息

参数：

名称	类型	描述	默认
fname_or_fid	str | int	目标贴吧的贴吧名或fid 优先fid	必需
tid	int	所在主题帖tid	必需
pid	int	待恢复的回复pid. Defaults to 0即获取主题帖正文.	0

返回：

名称	类型	描述
RecoverInfo	RecoverInfo	待恢复帖子信息

get_bawu_memberlist async

get_bawu_memberlist(fname_or_fid: str | int, /, pn: int = 1, *, search_value: str = '') -> BawuListMemberUsers

获取吧务后台吧会员列表

参数：

名称	类型	描述	默认
fname_or_fid	str | int	目标贴吧名或fid 优先贴吧名	必需
pn	int	页码. Defaults to 1.	1
search_value	str	搜索用户名. Defaults to ''.	''

返回：

名称	类型	描述
BawuListMemberUsers	BawuListMemberUsers	吧会员列表

Note

本接口需要STOKEN

get_bawu_userlogs async

get_bawu_userlogs(fname_or_fid: str | int, /, pn: int = 1, *, search_value: str = '', search_type: BawuSearchType = USER, start_dt: datetime | None = None, end_dt: datetime | None = None, op_type: int = 0) -> BawuUserLogs

获取吧务用户管理日志表

参数：

名称	类型	描述	默认
fname_or_fid	str | int	目标贴吧名或fid 优先贴吧名	必需
pn	int	页码. Defaults to 1.	1
search_value	str	搜索关键字. Defaults to ''.	''
search_type	BawuSearchType	搜索类型. Defaults to BawuSearchType.USER.	USER
start_dt	datetime | None	搜索的起始时间(含). Defaults to None.	None
end_dt	datetime | None	搜索的结束时间(含). Defaults to None.	None
op_type	int	搜索操作类型. Defaults to 0.	0

返回：

名称	类型	描述
BawuUserLogs	BawuUserLogs	吧务用户管理日志表

Note

本接口需要STOKEN

get_bawu_postlogs async

get_bawu_postlogs(fname_or_fid: str | int, /, pn: int = 1, *, search_value: str = '', search_type: BawuSearchType = USER, start_dt: datetime | None = None, end_dt: datetime | None = None, op_type: int = 0) -> BawuPostLogs

获取吧务后台帖子管理日志表

参数：

名称	类型	描述	默认
fname_or_fid	str | int	目标贴吧名或fid 优先贴吧名	必需
pn	int	页码. Defaults to 1.	1
search_value	str	搜索关键字. Defaults to ''.	''
search_type	BawuSearchType	搜索类型. Defaults to BawuSearchType.USER.	USER
start_dt	datetime | None	搜索的起始时间(含). Defaults to None.	None
end_dt	datetime | None	搜索的结束时间(含). Defaults to None.	None
op_type	int	搜索操作类型. Defaults to 0.	0

返回：

名称	类型	描述
BawuPostLogs	BawuPostLogs	吧务帖子管理日志表

Note

本接口需要STOKEN

get_unblock_appeals async

get_unblock_appeals(fname_or_fid: str | int, /, pn: int = 1, *, rn: int = 5) -> Appeals

获取吧务后台申诉请求列表

参数：

名称	类型	描述	默认
fname_or_fid	str | int	目标贴吧的贴吧名或fid 优先fid	必需
pn	int	页码. Defaults to 1.	1
rn	int	请求的条目数. Range [1, 50]. Defaults to 5.	5

返回：

名称	类型	描述
Appeals	Appeals	申诉请求列表

get_bawu_blacklist async

get_bawu_blacklist(fname_or_fid: str | int, /, pn: int = 1) -> BawuBlacklistUsers

获取吧务后台黑名单列表

参数：

名称	类型	描述	默认
fname_or_fid	str | int	目标贴吧的贴吧名或fid 优先贴吧名	必需
pn	int	页码. Defaults to 1.	1

返回：

名称	类型	描述
BawuBlacklistUsers	BawuBlacklistUsers	吧务黑名单列表

Note

本接口需要STOKEN

get_statistics async

get_statistics(fname_or_fid: str | int) -> Statistics

获取吧务后台中最近24天的统计数据

参数：

名称	类型	描述	默认
fname_or_fid	str | int	目标贴吧名或fid 优先fid	必需

返回：

名称	类型	描述
Statistics	Statistics	吧务后台统计信息

get_recom_status async

get_recom_status(fname_or_fid: str | int) -> RecomStatus

获取大吧主推荐功能的月度配额状态

参数：

名称	类型	描述	默认
fname_or_fid	str | int	目标贴吧名或fid 优先fid	必需

返回：

名称	类型	描述
RecomStatus	RecomStatus	大吧主推荐功能的月度配额状态

block async

block(fname_or_fid: str | int, /, id_: str | int, *, day: int = 1, reason: str = '') -> BoolResponse

封禁用户

参数：

名称	类型	描述	默认
fname_or_fid	str | int	所在贴吧的贴吧名或fid 优先fid	必需
id_	str | int	用户id user_id / user_name / portrait 优先portrait	必需
day	int	封禁天数. Defaults to 1.	1
reason	str	封禁理由. Defaults to ''.	''

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

unblock async

unblock(fname_or_fid: str | int, /, id_: str | int) -> BoolResponse

解封用户

参数：

名称	类型	描述	默认
fname_or_fid	str | int	所在贴吧的贴吧名或fid 优先fid	必需
id_	str | int	用户id user_id / user_name / portrait 优先user_id	必需

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

add_bawu_blacklist async

add_bawu_blacklist(fname_or_fid: str | int, /, id_: str | int) -> BoolResponse

添加贴吧黑名单

参数：

名称	类型	描述	默认
fname_or_fid	str | int	目标贴吧的贴吧名或fid 优先贴吧名	必需
id_	str | int	用户id user_id / user_name / portrait 优先user_id	必需

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

del_bawu_blacklist async

del_bawu_blacklist(fname_or_fid: str | int, /, id_: str | int) -> BoolResponse

移出贴吧黑名单

参数：

名称	类型	描述	默认
fname_or_fid	str | int	目标贴吧的贴吧名或fid 优先贴吧名	必需
id_	str | int	用户id user_id / user_name / portrait 优先user_id	必需

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

hide_thread async

hide_thread(fname_or_fid: str | int, /, tid: int) -> BoolResponse

屏蔽主题帖

参数：

名称	类型	描述	默认
fname_or_fid	str | int	帖子所在贴吧的贴吧名或fid 优先fid	必需
tid	int	待屏蔽的主题帖tid	必需

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

del_thread async

del_thread(fname_or_fid: str | int, /, tid: int) -> BoolResponse

删除主题帖

参数：

名称	类型	描述	默认
fname_or_fid	str | int	帖子所在贴吧的贴吧名或fid 优先fid	必需
tid	int	待删除的主题帖tid	必需

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

del_threads async

del_threads(fname_or_fid: str | int, /, tids: Iterable[int], *, block: bool = False) -> BoolResponse

批量删除主题帖

参数：

名称	类型	描述	默认
fname_or_fid	str | int	帖子所在贴吧的贴吧名或fid 优先fid	必需
tids	Iterable[int]	待删除的主题帖tid列表. Length Max to 30.	必需
block	bool	是否同时封一天. Defaults to False.	False

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败 部分成功返回True

del_post async

del_post(fname_or_fid: str | int, /, tid: int, pid: int) -> BoolResponse

删除回复

参数：

名称	类型	描述	默认
fname_or_fid	str | int	帖子所在贴吧的贴吧名或fid 优先fid	必需
tid	int	所在主题帖tid	必需
pid	int	待删除的回复pid	必需

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

del_posts async

del_posts(fname_or_fid: str | int, /, tid: int, pids: Iterable[int], *, block: bool = False) -> BoolResponse

批量删除回复

参数：

名称	类型	描述	默认
fname_or_fid	str | int	帖子所在贴吧的贴吧名或fid 优先fid	必需
tid	int	所在主题帖tid	必需
pids	Iterable[int]	待删除的回复pid列表. Length Max to 30.	必需
block	bool	是否同时封一天. Defaults to False.	False

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败 部分成功返回True

unhide_thread async

unhide_thread(fname_or_fid: str | int, /, tid: int) -> BoolResponse

解除主题帖屏蔽

参数：

名称	类型	描述	默认
fname_or_fid	str | int	帖子所在贴吧的贴吧名或fid 优先fid	必需
tid	int	待解除屏蔽的主题帖tid	必需

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

recover_thread async

recover_thread(fname_or_fid: str | int, /, tid: int) -> BoolResponse

恢复主题帖

参数：

名称	类型	描述	默认
fname_or_fid	str | int	帖子所在贴吧的贴吧名或fid 优先fid	必需
tid	int	待恢复的主题帖tid	必需

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

recover_post async

recover_post(fname_or_fid: str | int, /, pid: int) -> BoolResponse

恢复回复

参数：

名称	类型	描述	默认
fname_or_fid	str | int	帖子所在贴吧的贴吧名或fid 优先fid	必需
pid	int	待恢复的回复pid	必需

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

recover async

recover(fname_or_fid: str | int, /, tid: int = 0, pid: int = 0, *, is_hide: bool = False) -> BoolResponse

帖子恢复相关操作

参数：

名称	类型	描述	默认
fname_or_fid	str | int	帖子所在贴吧的贴吧名或fid 优先fid	必需
tid	int	待恢复的主题帖tid. Defaults to 0.	0
pid	int	待恢复的回复pid. Defaults to 0.	0
is_hide	bool	True则取消屏蔽主题帖 False则恢复删帖. Defaults to False.	False

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

good async

good(fname_or_fid: str | int, /, tid: int, *, cname: str = '') -> BoolResponse

加精主题帖

参数：

名称	类型	描述	默认
fname_or_fid	str | int	帖子所在贴吧的贴吧名或fid	必需
tid	int	待加精的主题帖tid	必需
cname	str	待添加的精华分区名称 默认为''即不分区. Defaults to ''.	''

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

ungood async

ungood(fname_or_fid: str | int, /, tid: int) -> BoolResponse

撤精主题帖

参数：

名称	类型	描述	默认
fname_or_fid	str | int	帖子所在贴吧的贴吧名或fid	必需
tid	int	待撤精的主题帖tid	必需

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

get_cid async

get_cid(fname_or_fid: str | int, /, cname: str = '') -> IntResponse

通过精华分区名获取精华分区id

参数：

名称	类型	描述	默认
fname_or_fid	str | int	帖子所在贴吧的贴吧名或fid	必需
cname	str	精华分区名. Defaults to ''.	''

返回：

名称	类型	描述
IntResponse	IntResponse	精华分区id

top async

top(fname_or_fid: str | int, /, tid: int, *, is_vip: bool = False) -> BoolResponse

置顶主题帖

参数：

名称	类型	描述	默认
fname_or_fid	str | int	帖子所在贴吧的贴吧名或fid	必需
tid	int	待置顶的主题帖tid	必需
is_vip	bool	是否会员置顶. Defaults to False.	False

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

untop async

untop(fname_or_fid: str | int, /, tid: int, *, is_vip: bool = False) -> BoolResponse

撤销置顶主题帖

参数：

名称	类型	描述	默认
fname_or_fid	str | int	帖子所在贴吧的贴吧名或fid	必需
tid	int	待撤销置顶的主题帖tid	必需
is_vip	bool	是否会员置顶. Defaults to False.	False

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

move async

move(fname_or_fid: str | int, /, tid: int, *, to_tab_id: int, from_tab_id: int = 0) -> BoolResponse

将主题帖移动至另一分区

参数：

名称	类型	描述	默认
fname_or_fid	str | int	帖子所在贴吧的贴吧名或fid 优先fid	必需
tid	int	待移动的主题帖tid	必需
to_tab_id	int	目标分区id	必需
from_tab_id	int	来源分区id 默认为0即无分区. Defaults to 0.	0

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

recommend async

recommend(fname_or_fid: str | int, /, tid: int) -> BoolResponse

大吧主首页推荐

参数：

名称	类型	描述	默认
fname_or_fid	str | int	帖子所在贴吧的贴吧名或fid 优先fid	必需
tid	int	待推荐的主题帖tid	必需

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

handle_unblock_appeals async

handle_unblock_appeals(fname_or_fid: str | int, /, appeal_ids: Iterable[int], *, refuse: bool = True) -> BoolResponse

拒绝或通过解封申诉

参数：

名称	类型	描述	默认
fname_or_fid	str | int	申诉所在贴吧的贴吧名或fid 优先fid	必需
appeal_ids	Iterable[int]	申诉请求的appeal_id列表. Length Max to 30.	必需
refuse	bool	True则拒绝申诉 False则接受申诉. Defaults to True.	True

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

agree async

agree(tid: int, pid: int = 0, is_comment: bool = False) -> BoolResponse

点赞主题帖或回复

参数：

名称	类型	描述	默认
tid	int	待点赞的主题帖或回复所在的主题帖的tid	必需
pid	int	待点赞的回复pid. Defaults to 0.	0
is_comment	bool	pid是否指向楼中楼. Defaults to False.	False

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

Note

本接口仍处于测试阶段

高频率调用会导致<发帖秒删>! 请谨慎使用!

unagree async

unagree(tid: int, pid: int = 0, is_comment: bool = False) -> BoolResponse

取消点赞主题帖或回复

参数：

名称	类型	描述	默认
tid	int	待取消点赞的主题帖或回复所在的主题帖的tid	必需
pid	int	待取消点赞的回复pid. Defaults to 0.	0
is_comment	bool	pid是否指向楼中楼. Defaults to False.	False

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

disagree async

disagree(tid: int, pid: int = 0, is_comment: bool = False) -> BoolResponse

点踩主题帖或回复

参数：

名称	类型	描述	默认
tid	int	待点踩的主题帖或回复所在的主题帖的tid	必需
pid	int	待点踩的回复pid. Defaults to 0.	0
is_comment	bool	pid是否指向楼中楼. Defaults to False.	False

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

undisagree async

undisagree(tid: int, pid: int = 0, is_comment: bool = False) -> BoolResponse

取消点踩主题帖或回复

参数：

名称	类型	描述	默认
tid	int	待取消点踩的主题帖或回复所在的主题帖的tid	必需
pid	int	待取消点踩的回复pid. Defaults to 0.	0
is_comment	bool	pid是否指向楼中楼. Defaults to False.	False

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

follow_user async

follow_user(id_: str | int) -> BoolResponse

关注用户

参数：

名称	类型	描述	默认
id_	str | int	用户id user_id / user_name / portrait 优先portrait	必需

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

unfollow_user async

unfollow_user(id_: str | int) -> BoolResponse

取关用户

参数：

名称	类型	描述	默认
id_	str | int	用户id user_id / user_name / portrait 优先portrait	必需

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

remove_fan async

remove_fan(id_: str | int) -> BoolResponse

移除粉丝

参数：

名称	类型	描述	默认
id_	str | int	待移除粉丝的id user_id / user_name / portrait 优先user_id	必需

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

set_blacklist async

set_blacklist(id_: str | int, *, btype: BlacklistType = ALL) -> BoolResponse

设置新版用户黑名单

参数：

名称	类型	描述	默认
id_	str | int	待设置黑名单的用户id user_id / user_name / portrait 优先user_id	必需
btype	BlacklistType	黑名单类型. 默认全屏蔽. Defaults to BlacklistType.ALL.	ALL

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

add_blacklist_old async

add_blacklist_old(id_: str | int) -> BoolResponse

添加旧版用户黑名单

参数：

名称	类型	描述	默认
id_	str | int	待添加黑名单的用户id user_id / user_name / portrait 优先user_id	必需

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

del_blacklist_old async

del_blacklist_old(id_: str | int) -> BoolResponse

移除旧版用户黑名单

参数：

名称	类型	描述	默认
id_	str | int	待移除黑名单的用户id user_id / user_name / portrait 优先user_id	必需

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

follow_forum async

follow_forum(fname_or_fid: str | int) -> BoolResponse

关注贴吧

参数：

名称	类型	描述	默认
fname_or_fid	str | int	要关注贴吧的贴吧名或fid 优先fid	必需

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

unfollow_forum async

unfollow_forum(fname_or_fid: str | int) -> BoolResponse

取关贴吧

参数：

名称	类型	描述	默认
fname_or_fid	str | int	要取关贴吧的贴吧名或fid 优先fid	必需

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

dislike_forum async

dislike_forum(fname_or_fid: str | int) -> BoolResponse

屏蔽贴吧 使其不再出现在首页推荐列表中

参数：

名称	类型	描述	默认
fname_or_fid	str | int	待屏蔽贴吧的贴吧名或fid 优先fid	必需

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

undislike_forum async

undislike_forum(fname_or_fid: str | int) -> BoolResponse

解除贴吧的首页推荐屏蔽

参数：

名称	类型	描述	默认
fname_or_fid	str | int	待屏蔽贴吧的贴吧名或fid 优先fid	必需

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

set_thread_private async

set_thread_private(fname_or_fid: str | int, /, tid: int, pid: int) -> BoolResponse

隐藏主题帖

参数：

名称	类型	描述	默认
fname_or_fid	str | int	主题帖所在贴吧的贴吧名或fid 优先fid	必需
tid	int	主题帖tid	必需
pid	int	主题帖pid	必需

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

set_thread_public async

set_thread_public(fname_or_fid: str | int, /, tid: int, pid: int) -> BoolResponse

公开主题帖

参数：

名称	类型	描述	默认
fname_or_fid	str | int	主题帖所在贴吧的贴吧名或fid 优先fid	必需
tid	int	主题帖tid	必需
pid	int	主题帖pid	必需

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

set_profile async

set_profile(nick_name: str, sign: str = '', gender: Gender = UNKNOWN) -> BoolResponse

设置主页信息

参数：

名称	类型	描述	默认
nick_name	str	昵称	必需
sign	str	个性签名. Defaults to ''.	''
gender	Gender	性别. Defaults to Gender.UNKNOWN.	UNKNOWN

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

set_nickname_old async

set_nickname_old(nick_name: str) -> BoolResponse

设置旧版昵称

参数：

名称	类型	描述	默认
nick_name	str	昵称	必需

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

sign_forum async

sign_forum(fname_or_fid: str | int) -> BoolResponse

单个贴吧签到

参数：

名称	类型	描述	默认
fname_or_fid	str | int	要签到贴吧的贴吧名或fid 优先贴吧名	必需

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

sign_forums async

sign_forums() -> BoolResponse

一键签到

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

sign_growth async

sign_growth() -> BoolResponse

用户成长等级任务: 签到

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

add_poll async

add_poll(tid: int, /, options: Iterable[int]) -> BoolResponse

投票

参数：

名称	类型	描述	默认
tid	int	投票帖的id	必需
options	Iterable[int]	投票选项集合 (1,)对应第一个选项	必需

返回：

名称	类型	描述
BoolResponse	BoolResponse	投票是否成功

send_msg async

send_msg(id_: str | int, content: str) -> BoolResponse

发送私信

参数：

名称	类型	描述	默认
id_	str | int	用户id user_id / user_name / portrait 优先user_id	必需
content	str	发送内容	必需

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

set_msg_readed async

set_msg_readed(message: WsMessage) -> BoolResponse

将一条私信设为已读

参数：

名称	类型	描述	默认
message	WsMessage	websocket私信消息	必需

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

get_group_msg async

get_group_msg(group_ids: Iterable[int], *, get_type: int = 1) -> WsMsgGroups

获取分组信息

参数：

名称	类型	描述	默认
group_ids	Iterable[int]	待获取分组的group_id	必需
get_type	int	获取类型. Defaults to 1.	1

返回：

名称	类型	描述
WsMsgGroups	WsMsgGroups	websocket消息组列表

send_chatroom_msg async

send_chatroom_msg(chatroom_id: int, fid: int, text: str, atuser_ids: Iterable[int] | None = None, robot: int = -1) -> BoolResponse

向吧群发送信息，仅限简单文本。如需要@他人需要指定atuser_ids，如需与bot交互需要指定atuser_ids和robot

参数：

名称	类型	描述	默认
chatroom_id	int	聊天室id	必需
fid	int	吧id	必需
text	str	待发送内容	必需
atuser_ids	Iterable[int]	需要@的人的user_id列表	None
robot	int	机器人指令id。机器人靠此分辨指令，而非text内容。	-1

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败

get_roomlist_by_fid async

get_roomlist_by_fid(fid: int) -> RoomList

获取某吧所有群聊

参数：

名称	类型	描述	默认
fid	int	吧id.	必需

返回：

名称	类型	描述
RoomList	RoomList	群信息

get_chat_message_queue

get_chat_message_queue() -> Queue

获取消息队列（全局共用），该队列仅包含通知（Notify）类型消息

返回：

名称	类型	描述
Queue	Queue	消息队列

join_chatroom async

join_chatroom(chatroom_id: int) -> BoolResponse

加入聊天室

参数：

名称	类型	描述	默认
chatroom_id	int	聊天室id	必需

返回：

名称	类型	描述
BoolResponse	BoolResponse	True成功 False失败