API リファレンス · v1
X アカウントのあらゆる動きを、ひとつの接続で
xSignalFeed は指定した X (旧 Twitter) アカウントを監視し、その動きが起きた瞬間にお届けします。新規投稿、返信、リポスト、引用、削除、プロフィール編集、フォロー、新しい認証済みフォロワーが対象です。X 検索で特定のフレーズを監視したり、プロフィール、投稿、フォロワー、リスト、コミュニティ、トレンドをオンデマンドで読み取ったりすることもできます。イベントは 1 本の WebSocket で届き、待つのではなく問い合わせたいときのために REST も用意しています。
概要
サービスの使い方は 3 通りです。監視: アカウントとキーワードを指定し、動きが起きるたびに WebSocket または Webhook でイベントを受け取ります。履歴: このキーが受け取ったイベントを読み返します。読み取り: プロフィール、投稿、検索、リスト、コミュニティ、トレンドを、いま X に問い合わせます。
イベントは 4 つのファミリーに分かれます。それぞれに 1 つのペイロード形式があり、イベントでフィールドごとに説明しています。
| カテゴリー | 種類 | 意味 |
|---|---|---|
| 投稿 | tweet.create, tweet.reply, tweet.retweet, tweet.quote, tweet.edit, tweet.delete | アカウントが公開するもの: 新規投稿、返信、リポスト、引用、編集、およびそれらの削除 |
| プロフィール | profile.name, profile.screen_name, profile.bio, profile.location, profile.url, profile.avatar, profile.banner, profile.pinned, profile.verified | アカウントが自身について表示する内容のあらゆる変更。変更前と変更後の値を伴います |
| フォローグラフ | follow.add, follow.remove, followers.verified.add | アカウントが誰をフォローし始めたか・やめたか、どの認証済みアカウントがそのアカウントをフォローし始めたか |
| アカウント | account.status | アカウントがそもそも見えるかどうか: 非公開、凍結、閲覧不可、または通常に戻った |
| 検索 | search.match | 監視しているキーワードにマッチする、X 上の誰かの投稿 |
アクセスには API キーを使います。キーはプランに由来するスコープと上限を持ち、GET /v1/account でお手持ちのキーに何ができるかが分かります。イベントの量で課金されるものは何もありません。ストリーミングは料金に含まれ、クレジットを消費するのはオンデマンドの読み取りだけです。
xSignalFeed は独立した第三者のサービスです。X Corp との提携、承認、後援関係はありません。読み取るのは公開データのみです。