> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sorsa.io/llms.txt
> Use this file to discover all available pages before exploring further.

# APIリファレンスガイド

# 完全なAPIリファレンス：Sorsaの全エンドポイント

Sorsa APIの全エンドポイントをカテゴリー別に紹介します。すべて同じベースURL（`https://api.sorsa.io/v3`）を使い、`ApiKey`ヘッダーで認証します。どのエンドポイントでも、1回の呼び出しで割り当て量から正確に1リクエストを消費します。新規アカウントには、すべての機能を試せる無料リクエスト100件が含まれ、カード登録は不要です。

パラメーターの詳細、レスポンススキーマ、対話的なテストについては、各エンドポイントの**詳細**リンクを開いてください。[API Playground](https://api.sorsa.io/playground)ではコードを書かずに試せます。

***

## ユーザーデータ

ユーザープロフィール、フォロワー・フォロー中ユーザーの一覧、アカウントのメタデータを取得します。

| エンドポイント               | メソッド | 説明                                                                         | 詳細                                                                         |
| :-------------------- | :--- | :------------------------------------------------------------------------- | :------------------------------------------------------------------------- |
| `/info`               | GET  | 1アカウントの完全なプロフィール（自己紹介、各種件数、認証状態、アバター）。`username`、`user_id`、`user_link`に対応。 | [詳細](https://docs.sorsa.io/ja/api-reference/users-data/user-profile)       |
| `/info-batch`         | GET  | 1リクエストで最大100アカウントのプロフィールを取得。`usernames[]`または`user_ids[]`に対応。               | [詳細](https://docs.sorsa.io/ja/api-reference/users-data/user-profile-batch) |
| `/about`              | GET  | 国、ユーザー名の変更回数と日付、X Premium（Blue）の状態と開始日、アカウントの利用元、関連アカウント名などのメタデータ。         | [詳細](https://docs.sorsa.io/ja/api-reference/users-data/account-about-info) |
| `/followers`          | GET  | 完全なプロフィールを含むフォロワー一覧。ページネーション対応で、1ページ最大200人。                                | [詳細](https://docs.sorsa.io/ja/api-reference/users-data/followers)          |
| `/follows`            | GET  | 完全なプロフィールを含むフォロー中ユーザー一覧。ページネーション対応で、1ページ最大200人。                            | [詳細](https://docs.sorsa.io/ja/api-reference/users-data/following)          |
| `/verified-followers` | GET  | 認証済みフォロワーのみを返す一覧。ページネーション対応。                                               | [詳細](https://docs.sorsa.io/ja/api-reference/users-data/verified-followers) |

**関連ガイド：** [フォロワーとフォロー中ユーザー](https://docs.sorsa.io/ja/followers-and-following) | [オーディエンスの地域分布](https://docs.sorsa.io/ja/Audience-Geography) | [競合分析](https://docs.sorsa.io/ja/Competitor-Analysis)

***

## ツイート

ツイートの内容、エンゲージメント指標、返信、引用、リツイートしたユーザー、長文記事、トレンドを取得します。

| エンドポイント            | メソッド | 説明                                                                       | 詳細                                                                   |
| :----------------- | :--- | :----------------------------------------------------------------------- | :------------------------------------------------------------------- |
| `/tweet-info`      | POST | 1ツイートの全データ（本文、指標、投稿者プロフィール）。本文：`tweet_link`。                             | [詳細](https://docs.sorsa.io/ja/api-reference/tweets/tweet-data)       |
| `/tweet-info-bulk` | POST | 1リクエストで最大100ツイートの全データを取得。本文：`tweet_links[]`。                             | [詳細](https://docs.sorsa.io/ja/api-reference/tweets/tweet-data-batch) |
| `/user-tweets`     | POST | ユーザーのツイートのタイムライン。ページネーション対応。本文：`user_link`、`username`、`user_id`のいずれか。    | [詳細](https://docs.sorsa.io/ja/api-reference/tweets/user-tweets)      |
| `/comments`        | POST | 特定のツイートへの返信。本文：`tweet_link`。任意の`order_by`は`Relevance`、`Recency`、`Likes`。 | [詳細](https://docs.sorsa.io/ja/api-reference/tweets/tweet-comments)   |
| `/quotes`          | POST | 特定のツイートの引用ツイート。本文：`tweet_link`。                                          | [詳細](https://docs.sorsa.io/ja/api-reference/tweets/quote-tweets)     |
| `/retweeters`      | POST | リツイートしたユーザー（ツイートではなくプロフィールを返す）。本文：`tweet_link`。                          | [詳細](https://docs.sorsa.io/ja/api-reference/tweets/retweeters-list)  |
| `/article`         | POST | X記事（長文投稿）の全文。本文：`tweet_link`。                                            | [詳細](https://docs.sorsa.io/ja/api-reference/tweets/article-data)     |
| `/trends`          | GET  | 指定地域のトレンド。クエリ：`woeid`（Where On Earth IDentifier）。                        | [詳細](https://docs.sorsa.io/ja/api-reference/tweets/trends-list)      |

**関連ガイド：** [ツイート検索](https://docs.sorsa.io/ja/search-tweets) | [ツイートのエンゲージメント](https://docs.sorsa.io/ja/tweet-engagement) | [X記事](https://docs.sorsa.io/ja/x-articles) | [過去のデータ](https://docs.sorsa.io/ja/historical-data)

***

## 検索

ツイート、メンション、ユーザープロフィールを検索し、Xスペースを調べます。

| エンドポイント          | メソッド | 説明                                                                                                                       | 詳細                                                                     |
| :--------------- | :--- | :----------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------- |
| `/search-tweets` | POST | Xの検索演算子に全面対応したキーワード検索。本文：`query`、`order`、`next_cursor`。                                                                  | [詳細](https://docs.sorsa.io/ja/api-reference/search/search-tweets)      |
| `/mentions`      | POST | 指定アカウントへのメンション。エンゲージメント・日付で絞り込み可能。本文：`query`、`order`、`min_likes`、`min_retweets`、`min_replies`、`since_date`、`until_date`。 | [詳細](https://docs.sorsa.io/ja/api-reference/search/search-mentions)    |
| `/search-users`  | POST | キーワードでプロフィールを検索（自己紹介、表示名、ユーザー名が対象）。本文：`query`。                                                                           | [詳細](https://docs.sorsa.io/ja/api-reference/search/search-users)       |
| `/spaces`        | GET  | Xスペースの全データ：メタデータ、作成者プロフィール、参加者、設定、統計。クエリ：`id`または`link`。                                                                  | [詳細](https://docs.sorsa.io/ja/api-reference/search/spaces-information) |

**関連ガイド：** [ツイート検索](https://docs.sorsa.io/ja/search-tweets) | [メンションの追跡](https://docs.sorsa.io/ja/search-mentions) | [検索演算子](https://docs.sorsa.io/ja/search-operators) | [ターゲット層の発見](https://docs.sorsa.io/ja/target-audiences-Discovery)

***

## アクションの確認

ユーザーが特定のアクション（フォロー、リツイート、コメント、引用、コミュニティ参加）を行ったか確認します。キャンペーンやプレゼント企画の条件確認に利用できます。

| エンドポイント                   | メソッド | 説明                                                                                                                                                                      | 詳細                                                                                   |
| :------------------------ | :--- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------- |
| `/check-follow`           | POST | `user_2`が`user_1`をフォローしているか確認（user\_1＝フォロー対象、user\_2＝フォローしているか調べるユーザー）。本文：両者の識別子をそれぞれ1つ（`username_1`/`user_id_1`/`user_link_1`と`username_2`/`user_id_2`/`user_link_2`）。 | [詳細](https://docs.sorsa.io/ja/api-reference/verification/check-follow)               |
| `/check-comment`          | GET  | ユーザーが特定のツイートにコメントしたか確認。見つかればコメントのツイートを返す。クエリ：`tweet_link`と`username`/`user_id`/`user_link`。                                                                             | [詳細](https://docs.sorsa.io/ja/api-reference/verification/check-comment)              |
| `/check-retweet`          | POST | ユーザーが特定のツイートをリツイートしたか確認。1リクエストで最大100件を調査。本文：`tweet_link`とユーザー識別子。                                                                                                       | [詳細](https://docs.sorsa.io/ja/api-reference/verification/check-retweet)              |
| `/check-quoted`           | POST | ユーザーが特定のツイートを引用またはリツイートしたか確認。`status`は`quoted`、`retweet`、`not_found`。本文：`tweet_link`とユーザー識別子。                                                                           | [詳細](https://docs.sorsa.io/ja/api-reference/verification/check-quote-or-retweet)     |
| `/check-community-member` | POST | ユーザーが指定のXコミュニティのメンバーか確認。本文：`community_id`とユーザー識別子。                                                                                                                      | [詳細](https://docs.sorsa.io/ja/api-reference/verification/check-community-membership) |
| `/check-shadowban`        | GET  | 投稿の表示状況を確認。結果は`clean`、`banned`、`unknown`。クエリ：`username`。キャッシュの経過時間は`checked_at`で確認。                                                                                     | [詳細](https://docs.sorsa.io/ja/api-reference/verification/check-shadowban)            |

**関連ガイド：** [マーケティングキャンペーンの確認](https://docs.sorsa.io/ja/Marketing-Campaign-Verification)

***

## コミュニティ

Xコミュニティのメンバー一覧、ツイートフィード、コミュニティ内検索を利用します。

| エンドポイント                    | メソッド | 説明                                                               | 詳細                                                                             |
| :------------------------- | :--- | :--------------------------------------------------------------- | :----------------------------------------------------------------------------- |
| `/community-tweets`        | POST | コミュニティのツイートフィード。本文：`community_id`、`order`（`popular`または`latest`）。 | [詳細](https://docs.sorsa.io/ja/api-reference/community/community-tweets)        |
| `/community-search-tweets` | POST | コミュニティ内でツイートをキーワード検索。本文：`community_link`、`query`、`order`。        | [詳細](https://docs.sorsa.io/ja/api-reference/community/search-community-tweets) |
| `/community-members`       | POST | プロフィール付きのコミュニティメンバー一覧。本文：`community_link`。                       | [詳細](https://docs.sorsa.io/ja/api-reference/community/community-members)       |

**関連ガイド：** [リストとコミュニティ](https://docs.sorsa.io/ja/lists-and-communities)

***

## リスト

Xリストのメンバープロフィール、リストのフォロワー、メンバー全体のツイートフィードを取得します。

| エンドポイント           | メソッド | 説明                                       | 詳細                                                                |
| :---------------- | :--- | :--------------------------------------- | :---------------------------------------------------------------- |
| `/list-members`   | GET  | リスト内のアカウントのプロフィール。クエリ：`list_id`。         | [詳細](https://docs.sorsa.io/ja/api-reference/lists/list-members)   |
| `/list-followers` | GET  | リストをフォローしているユーザーのプロフィール。クエリ：`list_link`。 | [詳細](https://docs.sorsa.io/ja/api-reference/lists/list-followers) |
| `/list-tweets`    | GET  | リストの全メンバーの最近のツイート。クエリ：`list_id`。         | [詳細](https://docs.sorsa.io/ja/api-reference/lists/list-tweets)    |

**関連ガイド：** [リストとコミュニティ](https://docs.sorsa.io/ja/lists-and-communities) | [リアルタイム監視](https://docs.sorsa.io/ja/real-time-monitoring)

***

## Sorsa Score（暗号資産分析）

Sorsaのデータベースにある暗号資産関連アカウントについて、影響力スコア、フォロワーの分類、最近のフォロー状況を分析します。`username`、`user_id`、`user_link`に対応しています。

| エンドポイント             | メソッド | 説明                                          | 詳細                                                                                               |
| :------------------ | :--- | :------------------------------------------ | :----------------------------------------------------------------------------------------------- |
| `/score`            | GET  | 現在のSorsa Score（暗号資産分野での影響力指標）。              | [詳細](https://docs.sorsa.io/ja/api-reference/sorsa-info-crypto-related/sorsa-score)               |
| `/score-changes`    | GET  | 過去1週間・1か月のスコア変化量。                           | [詳細](https://docs.sorsa.io/ja/api-reference/sorsa-info-crypto-related/sorsa-score-changes)       |
| `/followers-stats`  | GET  | フォロワーの内訳：インフルエンサー、プロジェクト、VC。                | [詳細](https://docs.sorsa.io/ja/api-reference/sorsa-info-crypto-related/follower-category-stats)   |
| `/top-followers`    | GET  | Sorsa Score上位20人のフォロワー（各項目にそのフォロワーのスコアを含む）。 | [詳細](https://docs.sorsa.io/ja/api-reference/sorsa-info-crypto-related/top-20-followers-by-score) |
| `/top-following`    | GET  | フォロー中アカウントのスコア上位20件。                        | [詳細](https://docs.sorsa.io/ja/api-reference/sorsa-info-crypto-related/top-20-following-by-score) |
| `/new-followers-7d` | GET  | 過去7日間にフォローしてきた暗号資産関連アカウント。                  | [詳細](https://docs.sorsa.io/ja/api-reference/sorsa-info-crypto-related/new-followers-7-days)      |
| `/new-following-7d` | GET  | 過去7日間にユーザーが新しくフォローした暗号資産関連アカウント。            | [詳細](https://docs.sorsa.io/ja/api-reference/sorsa-info-crypto-related/new-following-7-days)      |

**関連ガイド：** [Sorsa Scoreと暗号資産分析](https://docs.sorsa.io/ja/sorsa-score-and-crypto-analytics)

***

## 技術ユーティリティ

IDの変換とAPIキーの使用量確認に利用します。

| エンドポイント                         | メソッド | 説明                                     | 詳細                                                                                               |
| :------------------------------ | :--- | :------------------------------------- | :----------------------------------------------------------------------------------------------- |
| `/username-to-id/{user_handle}` | GET  | ユーザー名を永続的なユーザーIDに変換。                   | [詳細](https://docs.sorsa.io/ja/api-reference/technical-endpoints/convert-username-to-user-id)     |
| `/id-to-username/{user_id}`     | GET  | ユーザーIDを現在のユーザー名に変換。                    | [詳細](https://docs.sorsa.io/ja/api-reference/technical-endpoints/convert-user-id-to-username)     |
| `/link-to-id`                   | GET  | プロフィールURLからユーザーIDを取得。クエリ：`link`。       | [詳細](https://docs.sorsa.io/ja/api-reference/technical-endpoints/convert-profile-link-to-user-id) |
| `/key-usage-info`               | GET  | 現在のリクエスト使用量、残りの割り当て量、残高の有効期限。パラメーター不要。 | [詳細](https://docs.sorsa.io/ja/api-reference/technical-endpoints/api-key-usage)                   |

**関連ガイド：** [ID変換](https://docs.sorsa.io/ja/ID-Conversion) | [料金](https://docs.sorsa.io/ja/pricing)

***

## データモデル

ほとんどのエンドポイントで、2つの主要なオブジェクトが使われます。各バリエーション、フィールドの型、例外的なケースを含む詳細は、[レスポンス形式](https://docs.sorsa.io/ja/response-format)を参照してください。

### Userオブジェクト

`/info`、`/info-batch`、フォロワー・フォロー中ユーザー・ユーザー検索のエンドポイントから返され、すべてのツイートにも`user`として含まれます。一部の暗号資産分析エンドポイントには`followerDate`が追加されますが、通常の`/followers`と`/follows`は標準のUserモデルです。違いは[レスポンス形式](https://docs.sorsa.io/ja/response-format)を参照してください。

| フィールド                          | 型         | 説明                    |
| :----------------------------- | :-------- | :-------------------- |
| `id`                           | string    | 永続的なユーザーID（Snowflake） |
| `username`                     | string    | 現在のユーザー名              |
| `display_name`                 | string    | 表示名                   |
| `description`                  | string    | 自己紹介の本文               |
| `location`                     | string    | ユーザーが申告した所在地          |
| `created_at`                   | string    | アカウント作成日時（ISO 8601）   |
| `followers_count`              | integer   | フォロワー数                |
| `followings_count`             | integer   | フォロー中アカウント数           |
| `favourites_count`             | integer   | 付けた「いいね」の総数           |
| `tweets_count`                 | integer   | 投稿したツイートの総数           |
| `media_count`                  | integer   | メディア投稿数               |
| `verified`                     | boolean   | 認証状態                  |
| `protected`                    | boolean   | 非公開（保護された）アカウントか      |
| `can_dm`                       | boolean   | DMを受け付けているか           |
| `possibly_sensitive`           | boolean   | センシティブな内容のフラグ         |
| `profile_image_url`            | string    | アバターのURL              |
| `profile_background_image_url` | string    | バナー画像のURL             |
| `bio_urls`                     | string\[] | 自己紹介から抽出されたURL        |
| `pinned_tweet_ids`             | string\[] | 固定ツイートのID             |

### Tweetオブジェクト

`/tweet-info`、`/search-tweets`、`/user-tweets`、`/comments`、`/quotes`、`/mentions`、`/list-tweets`、およびコミュニティのツイートエンドポイントから返されます。

| フィールド                  | 型              | 説明                       |
| :--------------------- | :------------- | :----------------------- |
| `id`                   | string         | ツイートID（Snowflake）        |
| `full_text`            | string         | ツイートの全文                  |
| `created_at`           | string         | 投稿日時（ISO 8601）           |
| `lang`                 | string         | 言語コード                    |
| `likes_count`          | integer        | 「いいね」の数                  |
| `retweet_count`        | integer        | リツイート数                   |
| `reply_count`          | integer        | 返信数                      |
| `quote_count`          | integer        | 引用数                      |
| `bookmark_count`       | integer        | ブックマーク数                  |
| `view_count`           | integer        | 表示回数                     |
| `conversation_id_str`  | string         | スレッド・会話のID               |
| `in_reply_to_tweet_id` | string         | 返信先のツイートID（返信の場合）        |
| `in_reply_to_username` | string         | 返信先の投稿者（返信の場合）           |
| `is_reply`             | boolean        | 返信か                      |
| `is_quote_status`      | boolean        | 引用ツイートか                  |
| `is_replies_limited`   | boolean        | 投稿者が返信を制限しているか           |
| `made_with_ai`         | boolean        | AIで作成されたとラベル付けされているか     |
| `paid_partnership`     | boolean        | 有料パートナーシップ（ブランドコンテンツ）    |
| `user`                 | User           | 投稿者の完全なプロフィール            |
| `entities`             | TweetEntity\[] | 添付メディア・リンクのエンティティ        |
| `quoted_status`        | Tweet          | 引用元ツイートのネスト（引用の場合）       |
| `retweeted_status`     | Tweet          | リツイート元ツイートのネスト（リツイートの場合） |

### TweetEntityオブジェクト

| フィールド     | 型      | 説明                              |
| :-------- | :----- | :------------------------------ |
| `type`    | string | エンティティの種類：`photo`、`video`、`url` |
| `link`    | string | 直接リンク（t.co URL）                 |
| `preview` | string | プレビュー・サムネイル画像のURL               |

***

## 共通の実装パターン

**認証：** すべてのリクエストに`ApiKey`ヘッダーが必要です。[認証](https://docs.sorsa.io/ja/authentication)を参照してください。

**ページネーション：** 対応エンドポイントはカーソル方式を使います。バッチ取得や`/top-followers`などの暗号資産分析の一覧は、カーソルなしで結果を返します。次のページを取得するには、直前のレスポンスの`next_cursor`を渡します。カーソルが存在しないかnullなら終端です。[ページネーション](https://docs.sorsa.io/ja/pagination)を参照してください。

**エラー形式：** すべてのエンドポイントは、エラー（`400`、`401`、`403`、`404`、`429`、`500`）で`{ "message": "..." }`を返します。[エラーコード](https://docs.sorsa.io/ja/error-codes)を参照してください。

**レート制限：** すべての標準プランで毎秒20リクエストです。[レート制限](https://docs.sorsa.io/ja/rate-limits)を参照してください。

**柔軟な入力形式：** ユーザー関連の多くのエンドポイントは、`username`、`user_id`、`user_link`（プロフィールURL）の3形式に対応します。必ずいずれか1つだけを指定してください。

***

## 次のステップ

* [クイックスタート](https://docs.sorsa.io/ja/quickstart)：1分以内に最初のAPIリクエストを送信する
* [レスポンス形式](https://docs.sorsa.io/ja/response-format)：フィールドの型、nullの扱い、オブジェクトスキーマの詳細
* [検索演算子](https://docs.sorsa.io/ja/search-operators)：`/search-tweets`の高度な検索条件を作成する
* [API利用の最適化](https://docs.sorsa.io/ja/optimizing-api-usage)：バッチ処理、重複排除、キャッシュでリクエスト数を減らす
