> ## Documentation Index
> Fetch the complete documentation index at: https://generaltranslation.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# CommunitiesClient

<div id="submodules">
  ## 하위 모듈
</div>

* [xdk.communities.client 모듈](/ko/xdks/python/reference/xdk.communities.client)
  * [`CommunitiesClient`](/ko/xdks/python/reference/xdk.communities.client#xdk.communities.client.CommunitiesClient)
    * [`CommunitiesClient.__init__()`](/ko/xdks/python/reference/xdk.communities.client#xdk.communities.client.CommunitiesClient.__init__)
    * [`CommunitiesClient.get_by_id()`](/ko/xdks/python/reference/xdk.communities.client#xdk.communities.client.CommunitiesClient.get_by_id)
    * [`CommunitiesClient.search()`](/ko/xdks/python/reference/xdk.communities.client#xdk.communities.client.CommunitiesClient.search)
* [xdk.communities.models 모듈](/ko/xdks/python/reference/xdk.communities.models)
  * [`GetByIdResponse`](/ko/xdks/python/reference/xdk.communities.models#xdk.communities.models.GetByIdResponse)
    * [`GetByIdResponse.model_config`](/ko/xdks/python/reference/xdk.communities.models#xdk.communities.models.GetByIdResponse.model_config)
  * [`SearchResponse`](/ko/xdks/python/reference/xdk.communities.models#xdk.communities.models.SearchResponse)
    * [`SearchResponse.model_config`](/ko/xdks/python/reference/xdk.communities.models#xdk.communities.models.SearchResponse.model_config)

<div id="module-contents">
  ## 모듈 내용
</div>

이 모듈은 X API의 커뮤니티 관련 엔드포인트에 대한 접근을 제공하며,
커뮤니티 관련 모든 기능을 위한 주요 진입점 역할을 합니다.

<div id="class-xdkcommunitiescommunitiesclient">
  ### `class xdk.communities.CommunitiesClient`
</div>

커뮤니티 관련 작업을 위한 Client

#### 매개변수

<ParamField path="path.client" type="Client" />

<div id="__init__">
  ### `__init__`
</div>

#### 매개변수

<ParamField path="path.client" type="Client" />

<div id="get_by_id">
  ### `get_by_id`
</div>

id로 Community 가져오기
지정된 id를 사용하여 특정 Community의 세부 정보를 조회합니다.

#### 매개변수

<ParamField path="path.id" type="Any">
  커뮤니티의 ID입니다.
</ParamField>

<ParamField path="path.community_fields" type="List or None" default="None">
  표시할 커뮤니티 필드를 쉼표로 구분한 목록입니다.
</ParamField>

<div id="returns">
  #### 반환값
</div>

`GetByIdResponse` - 응답 데이터

<div id="search">
  ### `search`
</div>

커뮤니티 검색
지정된 검색 쿼리와 일치하는 커뮤니티 목록을 가져옵니다.

<div id="parameters">
  #### Parameters
</div>

<ParamField path="path.query" type="str">
  커뮤니티를 검색하기 위한 쿼리입니다.
</ParamField>

<ParamField path="path.max_results" type="int or None" default="None">
  요청에서 반환할 검색 결과의 최대 개수입니다.
</ParamField>

<ParamField path="path.next_token" type="Any or None" default="None">
  다음 ‘페이지’의 결과를 가져올 때 사용하는 파라미터입니다. 이 파라미터에 사용되는 값은 API가 제공한 응답에서 그대로 가져오며, 수정해서는 안 됩니다.
</ParamField>

<ParamField path="path.pagination_token" type="Any or None" default="None">
  다음 ‘페이지’의 결과를 가져올 때 사용하는 파라미터입니다. 이 파라미터에 사용되는 값은 API가 제공한 응답에서 그대로 가져오며, 수정해서는 안 됩니다.
</ParamField>

<ParamField path="path.community_fields" type="List or None" default="None">
  표시할 커뮤니티 필드를 쉼표로 구분한 리스트입니다.
</ParamField>

#### 반환

`IteratorSearchResponse`