X (Twitter)コミュニティ検索API

POST

APIの稼働状況

24時間の稼働状況: 正常
24時間の平均応答時間: —

良好／正常
利用可能
制限あり
ほぼ停止

正常

過去24時間

過去30日間

keywordでX（Twitter）のコミュニティを検索します。各コミュニティには、ID、リンク、名前、トピック、メンバー数、NSFWフラグ、バナーが含まれます。1ページあたり約10件で、次のページはnext_page_tokenで取得します。

料金は1,000リクエストあたり$0.81（1回あたり$0.000806）です。失敗した呼び出しと空の結果には課金されません。同期処理です。時間のかかるジョブでは、ボディに"mode": "async"を追加し、job_idを取得してポーリングしてください。

AIプロンプト

EveryInfraのX (Twitter) コミュニティ検索エンドポイント（twitter/search_communities）を使ったデータ収集スクリプトの作成を手伝ってください。

エンドポイントの仕組み：
- リクエスト：ヘッダーにAuthorization: Bearer <API key>を指定して、https://api.everyinfra.com/api/v1/socialにPOSTします。APIキーは環境変数EVERYINFRA_API_KEYから読み込み、ハードコードしないでください。
- リクエストボディでplatformにtwitter、actionにsearch_communitiesを指定し、パラメータはparamsの中に入れます。
- 必須パラメータ：
  - keyword: コミュニティの名前やトピックを検索するキーワードです（例：crypto、photography）。
- 任意パラメータ：
  - page_token: user_media、user_replies、retweeters、search_communities、community_posts、search_usersで使用するページトークンです。最初のページでは省略し、以降は前のレスポンスのnext_page_tokenを受け取ったとおりそのまま渡します。最後のページには含まれません。
- レコードのリストを返します。各レコードの主なフィールド: id、url、name、topic、member_count、is_nsfw、banner_url、next_page_token.
- リクエストボディの例：
{
  "platform": "twitter",
  "action": "search_communities",
  "params": {
    "keyword": "coffee"
  }
}
- 料金：1,000リクエストあたり$0.81。失敗時および結果が空の場合は課金されません。
- 対象が数十〜数百件ある場合は、ボディに"mode": "async"を追加します。すぐにjob_idが返されるので、GET https://api.everyinfra.com/api/v1/jobs/{job_id}をポーリングして結果を取得します。
- 422の場合は、エラーに含まれる推奨パラメータ名と指定可能な値を使ってリクエストを修正します。429または503の場合は、Retry-Afterの指定に従って待ってから再試行します。

コードを書く前に、必要な対象とその件数、必要なフィールド、希望する出力形式を私に質問してください。そのうえで、計画と概算費用を私に確認してください。

リクエストパラメータ

名前	場所	型	必須	デフォルト	説明
`Authorization`	header	`string`	はい	-	Bearerの後にAPIキーを続けます。APIキーはコンソールで作成してください。URLやコードリポジトリには絶対に含めないでください。
`platform`	body	`string`	はい	`twitter`	プラットフォームの識別子です。値は固定です。
`action`	body	`string`	はい	`search_communities`	機能の識別子です。値は固定です。
`keyword`	body.params	`string`	はい	-	コミュニティの名前やトピックを検索するキーワードです（例：`crypto`、`photography`）。
`page_token`	body.params	`string`	いいえ	-	`user_media`、`user_replies`、`retweeters`、`search_communities`、`community_posts`、`search_users`で使用するページトークンです。最初のページでは省略し、以降は前のレスポンスの`next_page_token`を受け取ったとおりそのまま渡します。最後のページには含まれません。

コードサンプル

bash

curl -X POST 'https://api.everyinfra.com/api/v1/social' \
  -H "Authorization: Bearer $EVERYINFRA_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "platform": "twitter",
  "action": "search_communities",
  "params": {
    "keyword": "coffee"
  }
}'

OpenAPI定義（JSON）サンプルは環境変数EVERYINFRA_API_KEYからAPIキーを読み込みます。コピーしたコードにAPIキーが含まれることはありません。

レスポンス例

フィールドプレビュー

このパラメータのサンプルレスポンスはまだありません。このプレビューはAPI定義に基づくレスポンスの構造とフィールドを示したもので、値は…で表しています。実際の呼び出し結果ではありません。

json

{
  "id": "req_…",
  "platform": "twitter",
  "action": "search_communities",
  "results": [
    {
      "id": …,
      "url": …,
      "name": …,
      "topic": …,
      "member_count": …,
      "is_nsfw": …,
      "banner_url": …,
      "platform": …,
      "next_page_token": …
    }
  ],
  "next_page_token": …,
  "pagination": { … },
  "count": …,
  "billing": {
    "charged": …,
    "charged_usd": …,
    "balance_after_usd": …,
    …
  },
  "quota": { … }
}

レスポンスフィールド

業務データはresultsに含まれます。この表はレコードに含まれうるフィールドの一覧です。プラットフォームに表示されない値を作り出すことはありません。

フィールド	意味
`id`	プラットフォーム上でのレコードの一意なIDです。一意性は1つのプラットフォーム内に限られ、プラットフォームが異なるとIDが重複する場合があります。
`url`	プラットフォーム上のレコードへのリンクです。
`name`	対象そのものの名前です（アカウント・商品・ビジネス系の機能で使用）。
`topic`	プラットフォーム上の意味のまま
`member_count`	プラットフォーム上の意味のまま
`is_nsfw`	プラットフォーム上の意味のまま
`banner_url`	プラットフォーム上の意味のまま
`platform`	取得元プラットフォームの識別子で、リクエストのplatformと同じです（例：xiaohongshu、tiktok）。
`next_page_token`	プラットフォーム上の意味のまま

エラーと課金

401: キーが未指定か無効です。
402: 残高が不足しています。先にチャージしてください。
422: パラメータ名または値が無効です。エラーに含まれる候補を参考に修正してください。課金はされません。
429: 1分あたりのリクエスト上限に達しました。Retry-Afterの指定に従って待ってから再試行してください。
503: 処理を完了できませんでした。保留中の請求額は残高に戻されます。結果が不明な場合は、再試行する前に確認してください。
200（空）: データがありません。課金はされません。

エラー