API 参考

基础 URL 为 https://api.xsignalfeed.com。所有响应都是 JSON：失败时采用错误一节描述的信封，成功时携带速率限制一节列出的头部。标有 * 的字段为必填。

监控

选择此密钥关注哪些账号。每个账号你都会收到密钥允许的全部事件类型，或只收你挑选的类型。

端点名称权限范围额度
GET /v1/monitor/targets列出监控账号targets:read0
POST /v1/monitor/targets监控一个账号targets:write0
GET /v1/monitor/targets/{target}获取一个监控账号targets:read0
PATCH /v1/monitor/targets/{target}选择账号的事件类型targets:write0
DELETE /v1/monitor/targets/{target}停止监控账号targets:write0
POST /v1/monitor/targets:batch批量监控操作targets:write0

关键词

监视 X 搜索中的短语。查询接受 X 自己的语法：引号包裹的精确短语、OR、-exclusions、#hashtags、$cashtags、from:、to:、lang:、filter:media、-filter:replies、-filter:retweets。我们监视的是“最新”标签页，所以结果按时间排序，任何语言或文字都可以。

端点名称权限范围额度
GET /v1/keywords列出关键词keywords:read0
POST /v1/keywords监视关键词keywords:write0
DELETE /v1/keywords/{keyword_id}移除关键词keywords:write0

流 & 历史记录

WebSocket 在流式传输一节描述；这里是它用于补齐数据的 REST 搭档。

端点名称权限范围额度
GET /v1/events事件历史replay0

用户

资料、关注列表、媒体、提及、订阅和用户搜索，此刻从 X 读取。每次调用消耗所示额度。

端点名称权限范围额度
GET /v1/users/{screen_name}按用户名获取用户reads1
GET /v1/users/by-id/{user_id}按 id 获取用户reads1
GET /v1/users/batch按 id 批量获取用户reads1 per id
GET /v1/users/{screen_name}/about获取账号详情reads1
GET /v1/users/{screen_name}/tweets获取用户帖子reads2
GET /v1/users/{screen_name}/media获取用户媒体reads2
GET /v1/users/{screen_name}/mentions获取用户提及reads2
GET /v1/users/{screen_name}/following获取关注列表reads2
GET /v1/users/{screen_name}/followers获取粉丝reads2
GET /v1/users/{screen_name}/verified_followers获取认证粉丝reads2
GET /v1/users/{screen_name}/subscriptions获取订阅reads2
GET /v1/users/search搜索用户reads2
GET /v1/users/{screen_name}/relationship/{other_screen_name}检查关注关系reads1

帖子

按 id 读取帖子，连同其回复、引用、转推者、串帖和文章。每次调用消耗所示额度。

端点名称权限范围额度
GET /v1/tweets/{tweet_id}获取一条帖子reads1
GET /v1/tweets按 id 批量获取帖子reads1
GET /v1/tweets/{tweet_id}/replies获取回复reads2
GET /v1/tweets/{tweet_id}/quotes获取引用reads2
GET /v1/tweets/{tweet_id}/retweeters获取转推者reads2
GET /v1/tweets/{tweet_id}/thread获取串帖reads2
GET /v1/tweets/{tweet_id}/article获取文章reads1

以 X 自己的语法进行搜索，最新或热门结果，分页返回。

端点名称权限范围额度
GET /v1/search搜索帖子reads2
GET /v1/search/trends搜索趋势reads2

列表

任意公开列表的时间线和成员。

端点名称权限范围额度
GET /v1/lists/{list_id}/tweets获取列表帖子reads2
GET /v1/lists/{list_id}/members获取列表成员reads2

社区

X 社区的信息、成员、版主和帖子。

端点名称权限范围额度
GET /v1/communities/{community_id}获取社区reads1
GET /v1/communities/{community_id}/members获取社区成员reads2
GET /v1/communities/{community_id}/moderators获取社区版主reads2
GET /v1/communities/{community_id}/tweets获取社区帖子reads2

X 上此刻的热门趋势，按类别划分。

端点名称权限范围额度
GET /v1/trends获取趋势reads2

账户

此密钥能做什么、用了多少、Webhook 发往哪里。

端点名称权限范围额度
GET /v1/account获取账户—0
GET /v1/account/usage获取用量—0
GET /v1/account/webhook获取 Webhookwebhook0
PUT /v1/account/webhook设置 Webhookwebhook0

Meta & 状态

公开，缓存五分钟，无需密钥。请基于这些端点构建你的校验和 UI，而不是照抄本页。

端点名称权限范围额度
GET /v1/meta/event-types列出事件类型—0
GET /v1/meta/scopes列出权限范围—0
GET /v1/meta/plans列出套餐—0
GET /v1/meta/versions列出版本—0
GET /v1/health健康检查—0
GET /v1/status状态—0

上述全部内容的机器可读描述位于 /v1/openapi.json；/v1/docs 会重定向到这里。