API 使用指南

xgather 提供只读 REST API,用于查询已经采集入库的公开用户、原创帖子、媒体和关注关系。调用 API 不会触发采集,也不会修改数据库。

安全提示:当前 v1 API 无鉴权,仅建议在本地或受保护的内网中使用;公网部署请在反向代理层增加鉴权。

打开 FastAPI 交互文档 (在新标签页打开)

快速开始

当前公开根地址:https://mes-y.com

curl "https://mes-y.com/api/v1/tweets?limit=5"

常用接口

  • GET/api/v1/users

    分页浏览用户,可用 q 搜索用户名或名称,并通过 sort 按粉丝数、资料更新时间或用户名排序。

  • GET/api/v1/users/by-username/{username}

    按当前用户名查找用户,用户名可带或不带 @,且不区分大小写。

  • GET/api/v1/users/{user_id}/tweets

    获取指定用户的帖子;支持 has_mediamedia_typeinclude_media 等过滤与响应控制参数。

  • GET/api/v1/users/{user_id}/following

    分页获取指定用户直接关注的已收录用户,分页游标与关注关系资源绑定。

  • GET/api/v1/tweets

    全局帖子列表,也是批量读取的主要入口;支持按用户、用户名、媒体状态和媒体类型过滤,并可选择内嵌作者或媒体。

  • GET/api/v1/tweets/{tweet_id}

    读取单条帖子详情,响应包含媒体和简要作者资料;已明确移除的帖子返回 410

分页与响应约定

limit
默认 20,最大 100
next_cursor
使用响应中的游标继续读取;游标与资源及排序方式绑定,不要跨接口或跨 sort 复用。
include_media
设为 false 时省略 media 字段,而不是返回空数组。
HTTP 状态
404 不存在、410 已移除、422 参数或游标无效。