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

# Get community

> Returns public metadata for an X community, including description, member count, topic, creator, and banner image.



## OpenAPI

````yaml /openapi.json get /v1/x/communities/{communityId}
openapi: 3.1.0
info:
  title: KonbiniAPI
  version: 1.0.0
  description: >-
    Social media API that normalizes Instagram, TikTok, X, Reddit, and LinkedIn
    data into a consistent ActivityStreams 2.0 format.


    Every authenticated response includes `X-Credits-Remaining` and
    `X-Credits-Used` headers. Each successful request costs 1 credit. Requests
    that fail with 400, 5xx, or upstream errors are refunded (X-Credits-Used:
    0).
  contact:
    name: KonbiniAPI
    email: hello@konbiniapi.com
    url: https://konbiniapi.com
servers:
  - url: https://api.konbiniapi.com
    description: Production
security:
  - apiKey: []
tags:
  - name: Instagram
    description: Instagram data endpoints
  - name: TikTok
    description: TikTok data endpoints
  - name: X
    description: X data endpoints
  - name: Reddit
    description: Reddit data endpoints
  - name: LinkedIn
    description: LinkedIn data endpoints
paths:
  /v1/x/communities/{communityId}:
    get:
      tags:
        - X
      summary: Get community
      description: >-
        Returns public metadata for an X community, including description,
        member count, topic, creator, and banner image.
      operationId: xGetCommunity
      parameters:
        - schema:
            type: string
            description: X community ID
            example: '1669501013441806336'
          required: true
          description: X community ID
          name: communityId
          in: path
      responses:
        '200':
          description: Returns the X community detail
          headers:
            X-Credits-Remaining:
              schema:
                type: integer
              description: Credits remaining after this request
            X-Credits-Used:
              schema:
                type: integer
              description: Credits consumed (1 if charged, 0 if refunded on error)
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      '@context':
                        type: array
                        prefixItems:
                          - type: string
                            enum:
                              - https://www.w3.org/ns/activitystreams#
                          - type: string
                            enum:
                              - https://konbiniapi.com/ns/social#
                        description: ActivityStreams JSON-LD context
                        example:
                          - https://www.w3.org/ns/activitystreams#
                          - https://konbiniapi.com/ns/social#
                      type:
                        type: string
                        description: ActivityStreams object type
                        example: Group
                      id:
                        type: string
                        format: uri
                        description: Community URL
                        example: https://x.com/i/communities/1669501013441806336
                      url:
                        type: string
                        format: uri
                        description: Community URL
                        example: https://x.com/i/communities/1669501013441806336
                      entityId:
                        type: string
                        description: X community ID
                        example: '1669501013441806336'
                      name:
                        type: string
                        description: Community name
                        example: Memes
                      summary:
                        type: string
                        description: Community description
                        example: Post the funniest memes you can find!
                      published:
                        type: string
                        format: date-time
                        description: Community creation date in ISO 8601 format
                        example: '2023-06-16T00:23:54.093Z'
                      memberCount:
                        type: integer
                        description: Number of community members
                        example: 515319
                      category:
                        type: string
                        description: Primary community topic
                        example: Entertainment
                      tag:
                        type: array
                        items:
                          $ref: '#/components/schemas/XTag'
                        description: Trending hashtags associated with the community
                      rule:
                        type: array
                        items:
                          $ref: '#/components/schemas/XCommunityRule'
                        description: Community rules
                      attributedTo:
                        allOf:
                          - $ref: '#/components/schemas/XEmbeddedUser'
                          - description: Compact X profile for embedded contexts
                        description: Community creator
                      image:
                        type: array
                        items:
                          allOf:
                            - $ref: '#/components/schemas/XImage'
                            - description: Image resource with optional dimensions
                        description: Community banner images
                    required:
                      - '@context'
                      - type
                      - id
                      - url
                      - entityId
                      - name
                required:
                  - data
        '400':
          description: Bad Request — Invalid parameters
          headers:
            X-Credits-Remaining:
              schema:
                type: integer
              description: Credits remaining after this request
            X-Credits-Used:
              schema:
                type: integer
              description: Credits consumed (1 if charged, 0 if refunded on error)
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                          enum:
                            - validation_error
                          description: Machine-readable error code
                        message:
                          type: string
                          example: Validation error
                          description: Human-readable error message
                      required:
                        - code
                        - message
                    description: List of errors
                  data:
                    type: 'null'
                    description: Always null for error responses
                required:
                  - errors
                  - data
        '401':
          description: Unauthorized — Missing or invalid API key
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                          enum:
                            - missing_api_key
                            - invalid_api_key
                          description: Machine-readable error code
                        message:
                          type: string
                          example: Invalid API key
                          description: Human-readable error message
                      required:
                        - code
                        - message
                    description: List of errors
                  data:
                    type: 'null'
                    description: Always null for error responses
                required:
                  - errors
                  - data
        '402':
          description: Payment Required — Credits exhausted
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                          enum:
                            - credits_exhausted
                          description: Machine-readable error code
                        message:
                          type: string
                          example: >-
                            Credits exhausted. Upgrade your plan at
                            konbiniapi.com
                          description: Human-readable error message
                      required:
                        - code
                        - message
                    description: List of errors
                  data:
                    type: 'null'
                    description: Always null for error responses
                required:
                  - errors
                  - data
        '403':
          description: Forbidden — API key disabled or expired
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                          enum:
                            - api_key_disabled
                            - api_key_expired
                          description: Machine-readable error code
                        message:
                          type: string
                          example: API key is disabled
                          description: Human-readable error message
                      required:
                        - code
                        - message
                    description: List of errors
                  data:
                    type: 'null'
                    description: Always null for error responses
                required:
                  - errors
                  - data
        '404':
          description: Not Found
          headers:
            X-Credits-Remaining:
              schema:
                type: integer
              description: Credits remaining after this request
            X-Credits-Used:
              schema:
                type: integer
              description: Credits consumed (1 if charged, 0 if refunded on error)
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                          enum:
                            - not_found
                            - route_not_found
                          description: Machine-readable error code
                        message:
                          type: string
                          example: Not found
                          description: Human-readable error message
                      required:
                        - code
                        - message
                    description: List of errors
                  data:
                    type: 'null'
                    description: Always null for error responses
                required:
                  - errors
                  - data
        '413':
          description: Content Too Large — Request body exceeds 1 MB
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                          enum:
                            - validation_error
                          description: Machine-readable error code
                        message:
                          type: string
                          example: Request body too large
                          description: Human-readable error message
                      required:
                        - code
                        - message
                    description: List of errors
                  data:
                    type: 'null'
                    description: Always null for error responses
                required:
                  - errors
                  - data
        '500':
          description: Internal Server Error
          headers:
            X-Credits-Remaining:
              schema:
                type: integer
              description: Credits remaining after this request
            X-Credits-Used:
              schema:
                type: integer
              description: Credits consumed (1 if charged, 0 if refunded on error)
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                          enum:
                            - internal_error
                          description: Machine-readable error code
                        message:
                          type: string
                          example: Internal error
                          description: Human-readable error message
                      required:
                        - code
                        - message
                    description: List of errors
                  data:
                    type: 'null'
                    description: Always null for error responses
                required:
                  - errors
                  - data
        '502':
          description: Bad Gateway — Upstream platform error
          headers:
            X-Credits-Remaining:
              schema:
                type: integer
              description: Credits remaining after this request
            X-Credits-Used:
              schema:
                type: integer
              description: Credits consumed (1 if charged, 0 if refunded on error)
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                          enum:
                            - platform_error
                          description: Machine-readable error code
                        message:
                          type: string
                          example: Platform error
                          description: Human-readable error message
                      required:
                        - code
                        - message
                    description: List of errors
                  data:
                    type: 'null'
                    description: Always null for error responses
                required:
                  - errors
                  - data
        '503':
          description: Service Unavailable
          headers:
            X-Credits-Remaining:
              schema:
                type: integer
              description: Credits remaining after this request
            X-Credits-Used:
              schema:
                type: integer
              description: Credits consumed (1 if charged, 0 if refunded on error)
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                          enum:
                            - service_unavailable
                          description: Machine-readable error code
                        message:
                          type: string
                          example: Service unavailable
                          description: Human-readable error message
                      required:
                        - code
                        - message
                    description: List of errors
                  data:
                    type: 'null'
                    description: Always null for error responses
                required:
                  - errors
                  - data
        '504':
          description: Gateway Timeout — Upstream platform timed out
          headers:
            X-Credits-Remaining:
              schema:
                type: integer
              description: Credits remaining after this request
            X-Credits-Used:
              schema:
                type: integer
              description: Credits consumed (1 if charged, 0 if refunded on error)
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                          enum:
                            - platform_error
                          description: Machine-readable error code
                        message:
                          type: string
                          example: Platform error
                          description: Human-readable error message
                      required:
                        - code
                        - message
                    description: List of errors
                  data:
                    type: 'null'
                    description: Always null for error responses
                required:
                  - errors
                  - data
components:
  schemas:
    XTag:
      type: object
      properties:
        type:
          type: string
          description: ActivityStreams object type
          example: Tag
        name:
          type: string
          description: Tag name
          example: learnfromkhaby
        href:
          type: string
          format: uri
          description: Tag or mention URL
          example: https://x.com/hashtag/learnfromkhaby
      required:
        - type
        - name
      description: Hashtag or user mention
    XCommunityRule:
      type: object
      properties:
        type:
          type: string
          description: ActivityStreams object type
          example: Document
        entityId:
          type: string
          description: Platform-specific rule ID
          example: '1848458992051159411'
        name:
          type: string
          description: Rule title
          example: Post memes only
        content:
          type: string
          description: Rule description
          example: Posts should be memes. No unrelated content or spam.
      required:
        - type
        - name
      description: Community rule
    XEmbeddedUser:
      type: object
      properties:
        type:
          type: string
          description: ActivityStreams object type
          example: Person
        id:
          type: string
          format: uri
          description: Profile URL
          example: https://x.com/KhabyLame
        url:
          type: string
          format: uri
          description: Profile URL
          example: https://x.com/KhabyLame
        entityId:
          type: string
          description: X user ID
          example: '221838349'
        preferredUsername:
          type: string
          description: Username or handle
          example: KhabyLame
        name:
          type: string
          description: Display name
          example: Khabane Lame
        icon:
          $ref: '#/components/schemas/XImage'
        isPrivate:
          type: boolean
          description: Whether account is protected
          example: false
        isVerified:
          type: boolean
          description: Whether account has legacy verification
          example: false
        isPaidVerified:
          type: boolean
          description: Whether account has X Premium verification
          example: true
        summary:
          type: string
          description: Bio text
          example: Let's Go
        attachment:
          type: array
          items:
            $ref: '#/components/schemas/XLink'
          description: Profile links
        followerCount:
          type: integer
          description: Number of followers
          example: 372131
        followingCount:
          type: integer
          description: Number of accounts followed
          example: 8
        likeCount:
          type: integer
          description: Number of likes made by the user
          example: 60
        postCount:
          type: integer
          description: Number of public posts
          example: 267
        mediaCount:
          type: integer
          description: Number of media posts
          example: 242
        listedCount:
          type: integer
          description: Number of public X Lists the account appears in
          example: 215
        location:
          type: string
          description: User location
          example: Milan, Italy
      required:
        - type
        - id
        - url
      description: Post author
    XImage:
      type: object
      properties:
        type:
          type: string
          description: ActivityStreams object type
          example: Image
        url:
          type: string
          format: uri
          description: Image URL
          example: >-
            https://pbs.twimg.com/amplify_video_thumb/2024515147692195840/img/t8ePmit3Wst1hxAM.jpg
        width:
          type: integer
          description: Width in pixels
          example: 1536
        height:
          type: integer
          description: Height in pixels
          example: 2048
      required:
        - type
        - url
      description: Profile picture
    XLink:
      type: object
      properties:
        type:
          type: string
          description: ActivityStreams object type
          example: Link
        href:
          type: string
          format: uri
          description: Link URL
          example: https://t.co/examplelink
        rel:
          type: string
          description: Link relation hint
          example: preferred
      required:
        - type
        - href
      description: External link
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: |-
        Send your API key in the Authorization header as a Bearer token.
        Example: `Authorization: Bearer <your-api-key>`

````