完全なAPIリファレンス:Sorsaの全エンドポイント
Sorsa APIの全エンドポイントをカテゴリー別に紹介します。すべて同じベースURL(https://api.sorsa.io/v3)を使い、ApiKeyヘッダーで認証します。どのエンドポイントでも、1回の呼び出しで割り当て量から正確に1リクエストを消費します。新規アカウントには、すべての機能を試せる無料リクエスト100件が含まれ、カード登録は不要です。
パラメーターの詳細、レスポンススキーマ、対話的なテストについては、各エンドポイントの詳細リンクを開いてください。API Playgroundではコードを書かずに試せます。
ユーザーデータ
ユーザープロフィール、フォロワー・フォロー中ユーザーの一覧、アカウントのメタデータを取得します。
関連ガイド: フォロワーとフォロー中ユーザー | オーディエンスの地域分布 | 競合分析
ツイート
ツイートの内容、エンゲージメント指標、返信、引用、リツイートしたユーザー、長文記事、トレンドを取得します。
関連ガイド: ツイート検索 | ツイートのエンゲージメント | X記事 | 過去のデータ
検索
ツイート、メンション、ユーザープロフィールを検索し、Xスペースを調べます。
関連ガイド: ツイート検索 | メンションの追跡 | 検索演算子 | ターゲット層の発見
アクションの確認
ユーザーが特定のアクション(フォロー、リツイート、コメント、引用、コミュニティ参加)を行ったか確認します。キャンペーンやプレゼント企画の条件確認に利用できます。
関連ガイド: マーケティングキャンペーンの確認
コミュニティ
Xコミュニティのメンバー一覧、ツイートフィード、コミュニティ内検索を利用します。
関連ガイド: リストとコミュニティ
リスト
Xリストのメンバープロフィール、リストのフォロワー、メンバー全体のツイートフィードを取得します。
関連ガイド: リストとコミュニティ | リアルタイム監視
Sorsa Score(暗号資産分析)
Sorsaのデータベースにある暗号資産関連アカウントについて、影響力スコア、フォロワーの分類、最近のフォロー状況を分析します。username、user_id、user_linkに対応しています。
関連ガイド: Sorsa Scoreと暗号資産分析
技術ユーティリティ
IDの変換とAPIキーの使用量確認に利用します。
関連ガイド: ID変換 | 料金
データモデル
ほとんどのエンドポイントで、2つの主要なオブジェクトが使われます。各バリエーション、フィールドの型、例外的なケースを含む詳細は、レスポンス形式を参照してください。Userオブジェクト
/info、/info-batch、フォロワー・フォロー中ユーザー・ユーザー検索のエンドポイントから返され、すべてのツイートにもuserとして含まれます。一部の暗号資産分析エンドポイントにはfollowerDateが追加されますが、通常の/followersと/followsは標準のUserモデルです。違いはレスポンス形式を参照してください。
Tweetオブジェクト
/tweet-info、/search-tweets、/user-tweets、/comments、/quotes、/mentions、/list-tweets、およびコミュニティのツイートエンドポイントから返されます。
TweetEntityオブジェクト
共通の実装パターン
認証: すべてのリクエストにApiKeyヘッダーが必要です。認証を参照してください。
ページネーション: 対応エンドポイントはカーソル方式を使います。バッチ取得や/top-followersなどの暗号資産分析の一覧は、カーソルなしで結果を返します。次のページを取得するには、直前のレスポンスのnext_cursorを渡します。カーソルが存在しないかnullなら終端です。ページネーションを参照してください。
エラー形式: すべてのエンドポイントは、エラー(400、401、403、404、429、500)で{ "message": "..." }を返します。エラーコードを参照してください。
レート制限: すべての標準プランで毎秒20リクエストです。レート制限を参照してください。
柔軟な入力形式: ユーザー関連の多くのエンドポイントは、username、user_id、user_link(プロフィールURL)の3形式に対応します。必ずいずれか1つだけを指定してください。