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/batchID で複数のユーザーを取得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/tweetsID で複数の投稿を取得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 自身の構文による 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/webhookWebhook を取得webhook0
PUT /v1/account/webhookWebhook を設定webhook0

メタ & ステータス

公開情報で、5 分間キャッシュされ、キー不要です。このページをコピーする代わりに、これらからバリデーションと 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 はここにリダイレクトされます。