跳转到主要内容
此端点可根据关键词搜索和发现 Communities。 该端点接受一个或多个关键词作为查询。默认情况下,请求将返回与指定查询匹配的公开和封闭的 Communities。
账户设置要访问这些端点,你需要:在我们的入门指南中了解更多关于获取 X API v2 端点访问权限的信息。
入门

认证

你可以使用 OAuth 1.0a 用户上下文、[OAuth 2.0 App-Only](https://developer.x.com(/resources/fundamentals/authentication#app-only-authentication-and-oauth-2-0-bearer-token)OAuth 2.0 授权码(PKCE) 对此端点进行认证。  

发起请求

您可以按以下方式调用 Search Communities 端点:
      curl --location 'https://api.x.com/2/communities/search?query=anime' --header 'Authorization: ••••••'
如果请求成功,您将会看到如下所示的 JSON 响应:
{
   "data": [
       {
           "access": "Public",
           "description": "欢迎来到动漫社区!这里是动漫爱好者聚集分享喜爱作品、畅聊动漫话题的地方。",
           "join_policy": "Open",
           "name": "动漫社区"
       },
       {
           "access": "Public",
           "description": "加入我们,一起聊动漫 🥰",
           "join_policy": "Open",
           "name": "动漫世界 🌸"
       },
       {
           "access": "Public",
           "description": "为所有动漫爱好者和创作者打造!",
           "join_policy": "Open",
           "name": "动漫"
       },
   ],
   "meta": {
       "next_token": "7140dibdnow9c7btw481s8m561gat797rboud5r80xvzm"
   }
}

社区字段

通过指定社区字段,您可以获取与某个社区关联的更多数据。 可用的社区字段如下:
字段值类型说明
created_at日期(ISO 8601)社群的创建时间。
id字符串社群的唯一标识符。
name字符串社群的名称。
description字符串社群的描述文本(如提供)。
access字符串社群的访问级别。

可能为以下之一:

* Public
* Closed
join_policy字符串社群的加入策略。

可能为以下之一:

* Open
* RestrictedJoinRequestsDisabled
* RestrictedJoinRequestsRequireAdminApproval
* RestrictedJoinRequestsRequireModeratorApproval
* SuperFollowRequired
member_count整数已加入该社群的成员数量。

示例请求

您可以按如下方式在调用 Search Communities 端点时包含额外的 community fields:
      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": "开放",
           "access": "公开",
           "member_count": 39915,
           "name": "动漫社区",
           "created_at": "2024-02-17T06:58:50.000Z"
       },
       {
           "id": "Q29tbXVuaXR5OjE1MDY3OTM5NTMxMDYwNDI4OTE=",
           "description": "加入我们,一起聊动漫 🥰",
           "join_policy": "开放",
           "access": "公开",
           "member_count": 26019,
           "name": "动漫世界 🌸",
           "created_at": "2022-03-24T00:44:07.000Z"
       },
       {
           "id": "Q29tbXVuaXR5OjE0OTY3NzYyMTU5Mzk1MzQ4NDk=",
           "description": "献给所有动漫爱好者和创作者!",
           "join_policy": "开放",
           "access": "公开",
           "member_count": 5612,
           "name": "动漫",
           "created_at": "2022-02-24T09:17:13.000Z"
       }
   ],
   "meta": {
       "next_token": "7140dibdnow9c7btw481s8m561gat797rboud5r80xvzm"
   }
}