메인 콘텐츠로 건너뛰기
이 엔드포인트를 사용하면 키워드를 기반으로 커뮤니티를 검색하고 탐색할 수 있습니다. 이 엔드포인트는 하나 이상의 키워드를 쿼리로 받습니다. 기본적으로 요청은 지정한 쿼리와 일치하는 공개 및 비공개 커뮤니티를 모두 반환합니다.
계정 설정이 엔드포인트에 접근하려면 다음이 필요합니다:X API v2 엔드포인트에 대한 액세스 방법은 시작 가이드에서 자세히 알아보세요.
시작하기

인증

이 엔드포인트는 OAuth 1.0a 사용자 컨텍스트, OAuth 2.0 App-Only, 또는 OAuth 2.0 Authorization Code with PKCE 중 하나로 인증할 수 있습니다.  

요청 보내기

아래와 같이 Search Communities 엔드포인트를 호출할 수 있습니다.
      curl --location 'https://api.x.com/2/communities/search?query=anime' --header 'Authorization: ••••••'
요청이 성공하면 아래와 같은 JSON 응답이 표시됩니다.
{
   "data": [
       {
           "access": "공개",
           "description": "Anime 커뮤니티에 오신 것을 환영합니다! 애니메이션 팬들이 모여 좋아하는 작품을 공유하고 애니 관련 모든 주제를 함께 이야기하는 곳입니다.",
           "join_policy": "자유 가입",
           "name": "Anime 커뮤니티"
       },
       {
           "access": "공개",
           "description": "애니에 대해 함께 이야기해요 🥰",
           "join_policy": "자유 가입",
           "name": "Anime World 🌸"
       },
       {
           "access": "공개",
           "description": "모든 애니 팬과 창작자를 위해!",
           "join_policy": "자유 가입",
           "name": "Anime"
       },
   ],
   "meta": {
       "next_token": "7140dibdnow9c7btw481s8m561gat797rboud5r80xvzm"
   }
}

커뮤니티 필드

Community Fields를 지정하면 커뮤니티와 연관된 추가 데이터를 가져올 수 있습니다. 사용 가능한 Community Fields는 다음과 같습니다:
필드 값유형설명
created_at날짜 (ISO 8601)커뮤니티가 생성된 시각.
id문자열커뮤니티의 고유 식별자.
name문자열커뮤니티의 이름.
description문자열제공된 경우 커뮤니티 설명의 텍스트.
access문자열커뮤니티의 액세스 수준.

다음 중 하나일 수 있습니다:

* Public
* Closed
join_policy문자열커뮤니티의 가입 정책.

다음 중 하나일 수 있습니다:

* Open
* RestrictedJoinRequestsDisabled
* RestrictedJoinRequestsRequireAdminApproval
* RestrictedJoinRequestsRequireModeratorApproval
* SuperFollowRequired
member_count정수커뮤니티에 가입한 멤버 수.

예시 요청

아래와 같이 추가 커뮤니티 필드를 포함해 Search Communities 엔드포인트를 호출할 수 있습니다.
      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"
   }
}