x/
community

コミュニティのリンクから、説明、メンバー数、ルールなど公開Xコミュニティの詳細を取得します。複数のコミュニティをまとめて照会することもできます。

X Community API

コミュニティの詳細
メンバー数とモデレーター数
ルールと参加ポリシー
結果1件あたり0.5クレジット
準備完了
準備完了

パラメータを入力してリクエストを送信してください。タスクのステータスと正規化された結果がここに表示されます。

README

SocQ 編集 · 更新

X Community

Xコミュニティは、名前、説明、メンバー数、参加ルールを持つトピック別のディスカッションスペースです。これらの詳細から、ディスカッションを読む前にコミュニティのテーマを把握し、規模を他のコミュニティと比較し、参加ポリシーを確認できます。

X Community API の主な機能

  • コミュニティのテーマを把握コミュニティ名、公開されている説明、リンク、カバー画像、作成者の情報をまとめて取得できるため、ポストを探す前にスペースを特定し、掲げられたテーマを確認できます。
  • メンバー規模と参加ポリシーを確認メンバー数とモデレーター数に加え、参加とメンバー招待の扱いを示す join_policy と invites_policy を受け取れます。
  • コミュニティ独自のルールを確認rules リストにはルール名と説明が含まれるため、参加要件をコミュニティの基本情報とあわせて保持できます。

X Community API のパラメータ

パラメータ必須説明
urls必須必須。https://x.com/i/communities/1493446837214187523 のように数値のコミュニティIDを含む、公開Xコミュニティのリンクのリストです。Playgroundでは1行に1つずつリンクを入力し、コードではJSONの urls 配列を使用してください。プロフィール、検索、個別ポストのリンクは使用できません。

X Community API の使い方

リクエストはバックグラウンドの取得タスクを開始するため、最初のレスポンスでは完成したデータではなくタスクIDが返されます。そのIDを使って進行状況を確認し、結果を取得します。

  1. 公開コミュニティのページを開いて /i/communities/ のリンクをコピーします。照会したいコミュニティごとにリンクを1つずつ用意してください。
  2. 例を実行する前に、$SOCQ_API_KEY をご自身のAPIキーに置き換えるか、その環境変数を設定してください。下記の Authorization ヘッダーを付けてJSON入力を POST /v1/x/community に送信し、レスポンスの task_id を保存します。
  3. 保存したIDで GET /v1/tasks/{task_id} を呼び出して進行状況を確認します。queued は待機中、running は取得中、retrying は再試行中を意味します。結果を読み取る前に succeeded になるまで待ってください。タスクが failed になった場合は、error_message で理由を確認してください。
  4. タスクが成功したら data.results.items を読み取ります。このリストの各項目が1つのコミュニティの詳細を表します。リストが空の場合は、タスクがレコードを返さずに完了したことを意味します。
  5. data.results.has_more が true の場合、next_cursor の値は保存済み結果の次のページを示すマーカーです。その値をそのまま GET /v1/tasks/{task_id}?cursor=... の cursor パラメータにコピーし、has_more が false になるまで続けてください。
curl -X POST "https://api.socq.ai/v1/x/community" \
  -H "Authorization: Bearer $SOCQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"urls":["https://x.com/i/communities/1493446837214187523"]}'

X Community API の主なユースケース

  • 調査対象コミュニティのディレクトリ作成: コミュニティ名、説明、リンク、メンバー数を表にまとめ、どのディスカッションを読むか決める前に、指定したコミュニティをテーマと規模で比較できるようにします。
  • ディスカッションのレビューに参加ルールを添える: ルールとメンバーシップのポリシーをコミュニティIDごとに保存し、別途 X Community Posts を使って、レビューしたいポストをそのコミュニティの背景情報と結び付けます。

X Community API 活用のヒント

  • コミュニティページではなくポストから始める場合は、まず公開コミュニティのリンクを見つけてください。この照会では、ポストのURLからそのポストが属するコミュニティを特定しません。
  • 同じコミュニティが x.com と twitter.com の両方のリンクで現れる場合は、/i/communities/ の後の数値IDを照合キーにして、ディレクトリの重複登録を防いでください。
  • コミュニティを比較する際、メンバー数は規模の指標として使い、メンバーの投稿の活発さを示すものとは考えないでください。この結果には活動履歴や個々のメンバーの一覧は含まれません。

X Community API 以外に別の種類の公開Xデータが必要な場合は、これらのAPIをご利用ください。

  • Twitter Profile Scraper API — ユーザー名から、公開アカウントの情報、プロフィール文、アバター、カバー画像、アカウントの状態、表示中のオーディエンス統計を取得します。
  • X Followers List API — 1つ以上のXユーザー名について、公開フォロワーのアカウント情報と表示中のプロフィール指標を取得します。
  • X Following List API — 公開Xアカウントがフォローしているプロフィールを、アカウント情報、プロフィール文、アカウントシグナル、表示中のカウント、元のユーザー名とともに取得します。
  • X Community Posts API — コミュニティで共有された公開ポストを、テキスト、投稿者、インタラクション数とともに取得します。
  • X Community Members API — コミュニティのメンバーを、自己紹介とフォロワー数を含むプロフィールとして書き出します。
  • X Community Moderators API — コミュニティを運営する管理者とモデレーターのプロフィールを取得します。

他のプラットフォームを見る

Xのデータを、対応する他のソーシャルプラットフォームの公開データと組み合わせられます。

X Community API — よくある質問

X Community APIは、コミュニティのリンクのリストから公開Xコミュニティの情報を取得するためのプログラムインターフェースです。コミュニティ名、説明、メンバー数とモデレーター数、ルール、参加ポリシーを返すため、ポストを調べる前に各コミュニティを把握できます。

コミュニティのリンクには、/i/communities/ の後に数値IDが続きます。プロフィールのリンクはアカウントを、/status/ のリンクはポストを指すため、いずれもこの照会の入力にはなりません。

いいえ。カウントはコミュニティのメンバー数を示すもので、メンバーが誰であるかは示しません。レスポンスにメンバー一覧は含まれません。

いいえ。この照会では、コミュニティの説明、ルール、その他のメタデータを返します。ディスカッションそのものが必要な場合は、同じコミュニティのリンクで X Community Posts を使用してください。

いいえ。Xコミュニティは共通のテーマについて話し合うためのスペースです。コミュニティノートはポストに付けられる注釈であり、ここで返されるオブジェクトではありません。

返されたコミュニティレコード1件につき0.5クレジットで、基本料金はありません。たとえば、コミュニティのリンクを4件送信すると見積もりは2クレジットとなり、コミュニティレコードが4件返された場合の料金は2クレジットです。