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

身份验证

您可以使用 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 授权码模式(Authorization Code)配合 PKCE 来对该 endpoint 进行身份验证。  

发起请求

您可以按以下方式调用 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"
   }
}

社群字段

通过指定 Community Fields,您可以获取与某个社群关联的更多数据。 可用的 Community Fields 如下:
字段值类型说明
created_atdate (ISO 8601)社群的创建时间。
idstring社群的唯一标识符。
namestring社群名称。
descriptionstring社群的描述文本(如有)。
accessstring社群的访问级别。

可能为以下之一:

* Public
* Closed
join_policystring社群的加入策略。

可能为以下之一:

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

示例请求

您可以按照下方所示,调用 Search Communities endpoint,并包含额外的 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": "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