メインコンテンツへスキップ
このendpointは、キーワードに基づいてコミュニティを検索・発見できます。 このendpointは、1つ以上のキーワードをqueryとして受け付けます。既定では、指定したqueryに一致する公開およびクローズドのコミュニティの両方を返します。
アカウント設定これらのendpointにアクセスするには、以下が必要です。X API v2 endpointへのアクセス方法の詳細は、はじめにをご覧ください。
はじめに

認証

You can authenticate this endpoint with either OAuth 1.0a User Context, [OAuth 2.0 App-Only](https://developer.x.com(/resources/fundamentals/authentication#app-only-authentication-and-oauth-2-0-bearer-token), or OAuth 2.0 Authorization Code with PKCE.  

リクエストの送信

次のように Search Communities endpoint を呼び出せます:
      curl --location 'https://api.x.com/2/communities/search?query=anime' --header 'Authorization: ••••••'
リクエストが成功すると、下記のとおりJSONレスポンスが表示されます。
{
   "data": [
       {
           "access": "Public",
           "description": "アニメコミュニティへようこそ!アニメファンが集まってお気に入りの作品を共有し、アニメに関するあらゆることについて語り合う場所です。",
           "join_policy": "Open",
           "name": "Anime Community"
       },
       {
           "access": "Public",
           "description": "参加してアニメについて語ろう 🥰",
           "join_policy": "Open",
           "name": "Anime World 🌸"
       },
       {
           "access": "Public",
           "description": "すべてのアニメ愛好家とクリエイターのために!",
           "join_policy": "Open",
           "name": "Anime"
       },
   ],
   "meta": {
       "next_token": "7140dibdnow9c7btw481s8m561gat797rboud5r80xvzm"
   }
}

コミュニティ fields

Community Fields を指定すると、コミュニティに関連付けられた追加の data を取得できます。 利用可能な Community Fields は次のとおりです:
Field valueTypeDescription
created_atdate (ISO 8601)コミュニティの作成日時。
idstringコミュニティの一意の識別子。
namestringコミュニティ名。
descriptionstring(指定されている場合)コミュニティの説明文。
accessstringコミュニティのアクセスレベル。

次のいずれか:

* Public
* Closed
join_policystringコミュニティの参加ポリシー。

次のいずれか:

* Open
* RestrictedJoinRequestsDisabled
* RestrictedJoinRequestsRequireAdminApproval
* RestrictedJoinRequestsRequireModeratorApproval
* SuperFollowRequired
member_countintegerコミュニティの参加メンバー数。

リクエスト例

以下のように、追加の community fields を指定して Search Communities endpoint を呼び出せます。
      curl --location 'https://api.x.com/2/communities/search?query=anime&community.fields=access,created_at,description,id,join_policy,member_count,name' --header 'Authorization: ••••••'
レスポンス例 リクエストが成功すると、次のような JSON レスポンスが返されます。
{
   "data": [
       {
           "id": "Q29tbXVuaXR5OjE3NTg3NDc4MTc2NDI3MDA5MjI=",
           "description": "アニメコミュニティへようこそ!アニメファンが集まって好きな作品を共有し、アニメに関するあらゆることを語り合う場所です。",
           "join_policy": "Open",
           "access": "Public",
           "member_count": 39915,
           "name": "アニメコミュニティ",
           "created_at": "2024-02-17T06:58:50.000Z"
       },
       {
           "id": "Q29tbXVuaXR5OjE1MDY3OTM5NTMxMDYwNDI4OTE=",
           "description": "参加してアニメについて語りましょう 🥰",
           "join_policy": "Open",
           "access": "Public",
           "member_count": 26019,
           "name": "アニメワールド 🌸",
           "created_at": "2022-03-24T00:44:07.000Z"
       },
       {
           "id": "Q29tbXVuaXR5OjE0OTY3NzYyMTU5Mzk1MzQ4NDk=",
           "description": "すべてのアニメ愛好家とクリエイターのために!",
           "join_policy": "Open",
           "access": "Public",
           "member_count": 5612,
           "name": "アニメ",
           "created_at": "2022-02-24T09:17:13.000Z"
       }
   ],
   "meta": {
       "next_token": "7140dibdnow9c7btw481s8m561gat797rboud5r80xvzm"
   }
}
I