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

# Search Community

> Search community



## OpenAPI

````yaml /api-reference/openapi.json post /twitter/community/search
openapi: 3.1.0
info:
  title: Twitter API Service
  description: |2-

            A comprehensive Twitter API service that provides various Twitter operations including:
            
            * **Search Operations**: Advanced search, hashtags, cashtags
            * **Tweet Operations**: Post, like, retweet, quote, bookmark, delete
            * **User Operations**: Batch user information retrieval
            * **Influencer Operations**: Get tweets from top influencers
            
            All endpoints return standardized responses in the format:
            ```json
            {
                "code": 200,
                "msg": "success", 
                "data": {...}
            }
            ```
            
            ## Authentication
            
            This API uses Bearer token authentication. Include your token in the Authorization header:
            ```
            Authorization: Bearer your_token_here
            ```
            
  contact:
    name: API Support
    email: support@twitterxapi.com
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.twexapi.io
    description: Development server
security: []
paths:
  /twitter/community/search:
    post:
      tags:
        - Communities Endpoints
      summary: Search Community
      description: Search community
      operationId: search_community_endpoint_twitter_community_search_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchCommunityQuery'
        required: true
      responses:
        '200':
          description: A list of community objects.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchCommunityResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    SearchCommunityQuery:
      properties:
        query:
          type: string
          title: Query
          description: The query to search for.
        target_count:
          type: integer
          title: Target Count
          description: The number of communities to search.
      type: object
      required:
        - query
        - target_count
      title: SearchCommunityQuery
    SearchCommunityResponse:
      properties:
        code:
          type: integer
          title: Code
          description: The status code of the response.
        msg:
          type: string
          title: Msg
          description: The message of the response.
        data:
          items:
            $ref: '#/components/schemas/CommunityModel'
          type: array
          title: Data
          description: A list of community objects.
      type: object
      required:
        - code
        - msg
        - data
      title: SearchCommunityResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CommunityModel:
      properties:
        id:
          type: string
          title: Id
          description: The ID of the community
        name:
          type: string
          title: Name
          description: The name of the community
        description:
          type: string
          title: Description
          description: The description of the community
        member_count:
          type: integer
          title: Member Count
          description: The number of members in the community
        is_nsfw:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Nsfw
          description: Indicates if the community is NSFW.
        members_facepile_results:
          items:
            type: string
          type: array
          title: Members Facepile Results
          description: The profile image URLs of members.
        banner:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Banner
          description: The banner information of the community.
        is_member:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Member
          description: Indicates if the user is a member of the community.
        role:
          anyOf:
            - type: string
            - type: 'null'
          title: Role
          description: The role of the user in the community.
        admin:
          anyOf:
            - $ref: '#/components/schemas/UserModel'
            - type: 'null'
          description: The admin of the community.
        join_policy:
          anyOf:
            - type: string
            - type: 'null'
          title: Join Policy
          description: The join policy of the community.
        created_at:
          anyOf:
            - type: integer
            - type: 'null'
          title: Created At
          description: The timestamp of the community's creation.
        invites_policy:
          anyOf:
            - type: string
            - type: 'null'
          title: Invites Policy
          description: The invites policy of the community.
        is_pinned:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Pinned
          description: Indicates if the community is pinned.
      type: object
      required:
        - id
        - name
        - description
        - member_count
      title: CommunityModel
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    UserModel:
      properties:
        id:
          type: string
          title: Id
          description: User ID
          example: '1717001045992251392'
        name:
          type: string
          title: Name
          description: Display name
          example: Cryptoklepto
        screen_name:
          type: string
          title: Screen Name
          description: Twitter username
          example: CK_Cryptoklepto
        created_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Created At
          description: Account creation date
          example: Mon Oct 28 02:32:47 +0000 2024
        created_at_datetime:
          anyOf:
            - type: string
            - type: 'null'
          title: Created At Datetime
          description: Account creation datetime in ISO format
          example: '2024-10-28T02:32:47.000Z'
        can_dm:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Can Dm
          description: Whether the user can be direct messaged
          default: false
        can_media_tag:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Can Media Tag
          description: Whether the user can be tagged in media
          default: false
        default_profile:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Default Profile
          description: Whether the user has a default profile
          default: false
        default_profile_image:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Default Profile Image
          description: Whether the user has a default profile image
          default: false
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: User's bio description
          default: ''
        description_urls:
          items:
            type: string
          type: array
          title: Description Urls
          description: List of URLs found in the user's description
          default: []
        urls:
          anyOf:
            - items:
                $ref: '#/components/schemas/urlModel'
              type: array
            - type: 'null'
          title: Urls
          description: List of URLs found in the user's profile
        fast_followers_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Fast Followers Count
          description: Count of fast followers
          default: 0
        favourites_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Favourites Count
          description: Number of tweets the user has liked
          default: 0
        followers_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Followers Count
          description: Number of followers
          default: 0
        following_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Following Count
          description: Number of users this user is following
          default: 0
        has_custom_timelines:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Has Custom Timelines
          description: Whether the user has custom timelines
          default: false
        is_blue_verified:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Blue Verified
          description: Blue verification status
          default: false
        verified_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Verified Type
          description: >-
            Verification badge type when not blue-only: blue, business,
            government, etc.
          examples:
            - government
            - business
            - blue
        is_verified:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Verified
          description: >-
            True if the account has any verification badge (blue, business,
            government, or legacy verified)
          default: false
        profile_image_shape:
          anyOf:
            - type: string
            - type: 'null'
          title: Profile Image Shape
          description: >-
            Profile image shape (Circle or Square; Square often indicates
            business/government)
          examples:
            - Circle
            - Square
        is_translator:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Translator
          description: Whether the user is a translator
          default: false
        listed_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Listed Count
          description: Number of public lists the user is a member of
          default: 0
        location:
          anyOf:
            - type: string
            - type: 'null'
          title: Location
          description: User's location
          default: ''
          example: New York, USA
        media_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Media Count
          description: Number of media tweets posted by the user
          default: 0
        normal_followers_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Normal Followers Count
          description: Count of normal followers
          default: 0
        pinned_tweet_ids:
          items:
            type: string
          type: array
          title: Pinned Tweet Ids
          description: List of pinned tweet IDs
          default: []
        possibly_sensitive:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Possibly Sensitive
          description: Whether the user's profile may contain sensitive content
          default: false
        profile_banner_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Profile Banner Url
          description: URL of the user's profile banner
        profile_image_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Profile Image Url
          description: URL of the user's profile image
        protected:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Protected
          description: Whether the user's tweets are protected
          default: false
        statuses_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Statuses Count
          description: Number of tweets posted by the user
          default: 0
      type: object
      required:
        - id
        - name
        - screen_name
      title: UserModel
    urlModel:
      properties:
        url:
          type: string
          title: Url
          description: URL
          example: https://www.google.com
        expanded_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Expanded Url
          description: Expanded URL
          example: https://www.google.com
        display_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Display Url
          description: Display URL
          example: www.google.com
      type: object
      required:
        - url
      title: urlModel
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````