跳到文档正文
文档

TweetStream 开发者文档

TweetStream 通过 WebSocket 将选定的 X 动态和支持的 Truth Social 通知流入交易系统,并提供用于历史回放和监控列表操作的 REST 端点。

Feed 会发送什么

实时 feed 使用统一 JSON envelope 承载推文内容、富化元数据、生命周期事件、账号事件和 handle 管理回执。

  • 被监控账号的 X 发帖、回复、引用和转推内容。
  • 已启用来源的 Truth Social 通知。
  • 代币、OCR、价格、CEX 和预测市场富化会作为独立 meta 事件发送。
  • 观察到的删除、置顶、取消置顶、资料更新、关注和取消关注事件。

基础 URL

接口URL用途
WebSocket(美国)wss://ws-iad.tweetstream.io/ws美国连接推荐
WebSocket(全球)wss://ws-global.tweetstream.io/ws美国以外连接推荐
RESThttps://api.tweetstream.io/api/history、/api/me 和账号管理的基础域名
Dashboardhttps://tweetstream.io/dashboardAPI key、监控列表、账单和 Discord 路由

认证

实时客户端推荐使用 WebSocket subprotocol 认证,REST 使用 Bearer 认证。美国客户端应连接 `wss://ws-iad.tweetstream.io/ws`;美国以外的客户端应连接 `wss://ws-global.tweetstream.io/ws`。API key 应保存在服务端进程,不要放进公开浏览器代码。

上下文Header 或协议说明
WebSockettweetstream.v1 + tweetstream.auth.token.<API_KEY>推荐的实时认证形态
WebSocket fallbackAuthorization: Bearer <API_KEY> or ?apiKey=<API_KEY>尽量优先使用 Authorization;query auth 仅作为受限运行时的最后选择
RESTAuthorization: Bearer <API_KEY>History 与账号管理必须使用标准 key;/api/me 可使用标准或 Ultra key
服务端 WebSocket 认证typescript
const socket = new WebSocket("wss://ws-global.tweetstream.io/ws", [
  "tweetstream.v1",
  `tweetstream.auth.token.${process.env.TWEETSTREAM_API_KEY}`,
]);
 
socket.addEventListener("message", (event) => {
  const message = JSON.parse(event.data);
  console.log(message.t, message.op, message.d);
});
 

推荐接入路径

  • 注册后在 dashboard 创建 API key。
  • 打开 WebSocket 前先添加监控账号。
  • 先消费 content 和 meta 事件;路由稳定后再接入生命周期和账号事件。
  • 在 Pro 或 Scale 上使用 /api/history 回补停机期间的已存内容、资料和关注事件。
  • 美国连接使用 wss://ws-iad.tweetstream.io/ws;美国以外的连接使用 wss://ws-global.tweetstream.io/ws。