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

# Community

> Fetches a public X Community (`x.com/i/communities/<id>`) and returns its info, stats, rules, topic, creator, and a member facepile — NOT the community tweets (a separate endpoint).

<Info>
  **Cost: 1 credit** per successful request. Errors and cache hits (`cache_max_age`) are free.
</Info>

<Accordion title="Copy for AI assistant" icon="sparkles">
  Paste this into ChatGPT, Claude or your coding assistant to generate working code for this endpoint (use the copy button).

  ```text Prompt
  I want to make an API call to /v1/twitter/community. Here are the details:

  Endpoint: GET https://api.scraperize.com/v1/twitter/community
  Description: Fetches a public X Community (`x.com/i/communities/<id>`) and returns its info, stats, rules, topic, creator, and a member facepile — NOT the community tweets (a separate endpoint).

  Required Headers:
  - x-api-key: Your API key

  Parameters:
  - url (string) [required]: Community URL, e.g. https://x.com/i/communities/1433869915434278912
  - cache_max_age (select): Optional. Return a cached result if one this age or newer exists — served for **0 credits** with `meta.cached=true` and `meta.cachedAt`. Otherwise a fresh scrape runs (**1 credit**) and refreshes the cache. Omit to always scrape fresh.

  Example Response:
  {
    "data": {
      "community": {
        "id": "1433869915434278912",
        "url": "https://x.com/i/communities/1433869915434278912",
        "name": "X Communities Feedback",
        "description": "A place to discuss all things related to 𝕏 Communities! The team will share updates, request feedback, and answer any questions you may have.",
        "memberCount": 547779,
        "createdAtMs": 1630696202524,
        "createdAt": "2021-09-03T19:10:02.524Z",
        "isNsfw": false,
        "joinPolicy": "Open",
        "topic": "X Official",
        "banner": {
          "url": "https://pbs.twimg.com/community_banner_img/1846987838937878529/9NWOzlgp?format=jpg&name=orig",
          "width": 1198,
          "height": 479
        },
        "creator": {
          "id": "1433894099178774532",
          "name": "Communities",
          "screenName": "HiCommunities",
          "url": "https://x.com/HiCommunities",
          "bio": null,
          "avatarUrl": null,
          "avatarUrlHd": null,
          "followers": null,
          "following": null,
          "tweetCount": null,
          "verified": true,
          "verifiedType": null,
          "protected": null,
          "profileImageShape": null,
          "professionalCategory": null
        },
        "rules": [
          {
            "id": "1788316047352717315",
            "name": "Stay on topic.",
            "description": "This is a community for, well, Communities, so keep feedback, questions, and thoughts about that. For anything else, visit our Help Center or @Support ."
          }
        ],
        "membersFacepile": [
          {
            "id": "1433894099178774532",
            "name": null,
            "screenName": "HiCommunities",
            "url": "https://x.com/HiCommunities",
            "bio": null,
            "avatarUrl": "https://pbs.twimg.com/profile_images/1683508943228731394/Wyjsoi11_normal.jpg",
            "avatarUrlHd": "https://pbs.twimg.com/profile_images/1683508943228731394/Wyjsoi11_400x400.jpg",
            "followers": null,
            "following": null,
            "tweetCount": null,
            "verified": null,
            "verifiedType": null,
            "protected": null,
            "profileImageShape": "Square",
            "professionalCategory": null
          }
        ]
      },
      "fetchedAt": "2026-10-05T14:42:32.939Z"
    },
    "meta": {
      "requestId": "req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f",
      "creditsCharged": 1,
      "creditsRemaining": 4999,
      "cached": false
    }
  }

  Please help me write code in my preferred programming language to make this API call and handle the response appropriately. Include error handling and best practices.
  ```
</Accordion>


## OpenAPI

````yaml /api-reference/openapi.json get /v1/twitter/community
openapi: 3.0.3
info:
  title: Scraperize API
  version: 1.0.0
  description: >-
    Extract public data from social media platforms as clean JSON. Endpoints are
    split by platform and by what they return, e.g. `GET /v1/twitter/tweet`.


    ## Authentication

    Send your API key in the `x-api-key` header (or `Authorization: Bearer
    <key>`). Create keys in your dashboard.


    ## Credits

    Each successful live scrape costs **1 credit**. Credits are prepaid and
    never expire.


    ## Caching

    Every endpoint accepts an optional `cache_max_age`
    (`1d`|`3d`|`7d`|`14d`|`30d`). A cache hit within that window is returned for
    **0 credits**.


    ## Responses

    Success returns `{ "data": …, "meta": { "requestId", … } }`. Errors return
    `{ "error": { "code", "message", "requestId" } }` with a matching HTTP
    status. `meta` on a scrape carries `creditsCharged`, `creditsRemaining`,
    `cached`, and (on a hit) `cachedAt`.


    ## Rate limits

    Requests are limited per team per minute; over the limit returns `429` with
    a `Retry-After` header.
servers:
  - url: https://api.scraperize.com
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Twitter
    description: Twitter / X scraping endpoints
  - name: Facebook
    description: Facebook scraping endpoints
  - name: Linkme
    description: Linkme (link.me) scraping endpoints
  - name: Amazon
    description: Amazon (creator shop / storefront) scraping endpoints
  - name: Linkbio
    description: Linkbio (lnk.bio) scraping endpoints
  - name: Pillar
    description: Pillar (pillar.io) scraping endpoints
  - name: Komi
    description: Komi (komi.io) scraping endpoints
  - name: Linktree
    description: Linktree (linktr.ee) scraping endpoints
  - name: Kick
    description: Kick (kick.com) scraping endpoints
  - name: Snapchat
    description: Snapchat (snapchat.com) scraping endpoints
  - name: Telegram
    description: Telegram (t.me) scraping endpoints
  - name: LinkedIn
    description: LinkedIn scraping endpoints
  - name: Twitch
    description: Twitch scraping endpoints
  - name: TikTok
    description: TikTok (tiktok.com) scraping endpoints
paths:
  /v1/twitter/community:
    get:
      tags:
        - Twitter
      summary: Community
      description: >-
        Fetches a public X Community (`x.com/i/communities/<id>`) and returns
        its info, stats, rules, topic, creator, and a member facepile — NOT the
        community tweets (a separate endpoint).
      parameters:
        - name: url
          in: query
          required: true
          description: Community URL, e.g. https://x.com/i/communities/1433869915434278912
          schema:
            type: string
          example: https://x.com/i/communities/1433869915434278912
        - name: cache_max_age
          in: query
          required: false
          description: >-
            Optional. Return a cached result if one this age or newer exists —
            served for **0 credits** with `meta.cached=true` and
            `meta.cachedAt`. Otherwise a fresh scrape runs (**1 credit**) and
            refreshes the cache. Omit to always scrape fresh.
          schema:
            type: string
            enum:
              - 1d
              - 3d
              - 7d
              - 14d
              - 30d
          example: 7d
      responses:
        '200':
          description: The community.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      community:
                        type: object
                        nullable: true
                      fetchedAt:
                        type: string
                        format: date-time
                  meta:
                    type: object
                    description: >-
                      requestId + credit/caching metadata (creditsCharged,
                      creditsRemaining, cached, cachedAt).
                required:
                  - data
                  - meta
              example:
                data:
                  community:
                    id: '1433869915434278912'
                    url: https://x.com/i/communities/1433869915434278912
                    name: X Communities Feedback
                    description: >-
                      A place to discuss all things related to 𝕏 Communities!
                      The team will share updates, request feedback, and answer
                      any questions you may have.
                    memberCount: 547779
                    createdAtMs: 1630696202524
                    createdAt: '2021-09-03T19:10:02.524Z'
                    isNsfw: false
                    joinPolicy: Open
                    topic: X Official
                    banner:
                      url: >-
                        https://pbs.twimg.com/community_banner_img/1846987838937878529/9NWOzlgp?format=jpg&name=orig
                      width: 1198
                      height: 479
                    creator:
                      id: '1433894099178774532'
                      name: Communities
                      screenName: HiCommunities
                      url: https://x.com/HiCommunities
                      bio: null
                      avatarUrl: null
                      avatarUrlHd: null
                      followers: null
                      following: null
                      tweetCount: null
                      verified: true
                      verifiedType: null
                      protected: null
                      profileImageShape: null
                      professionalCategory: null
                    rules:
                      - id: '1788316047352717315'
                        name: Stay on topic.
                        description: >-
                          This is a community for, well, Communities, so keep
                          feedback, questions, and thoughts about that. For
                          anything else, visit our Help Center or @Support .
                      - id: '1435329143667761155'
                        name: Be kind.
                        description: >-
                          This will all be way more fun if everyone is nice to
                          each other. You can disagree on something while not
                          making it personal.
                      - id: '1435329143667712003'
                        name: No spam.
                        description: >-
                          No one likes seeing the same message posted over and
                          over.
                    membersFacepile:
                      - id: '1433894099178774532'
                        name: null
                        screenName: HiCommunities
                        url: https://x.com/HiCommunities
                        bio: null
                        avatarUrl: >-
                          https://pbs.twimg.com/profile_images/1683508943228731394/Wyjsoi11_normal.jpg
                        avatarUrlHd: >-
                          https://pbs.twimg.com/profile_images/1683508943228731394/Wyjsoi11_400x400.jpg
                        followers: null
                        following: null
                        tweetCount: null
                        verified: null
                        verifiedType: null
                        protected: null
                        profileImageShape: Square
                        professionalCategory: null
                      - id: '1372635343544025088'
                        name: null
                        screenName: Dongwook
                        url: https://x.com/Dongwook
                        bio: null
                        avatarUrl: >-
                          https://pbs.twimg.com/profile_images/1821625188829544448/r86n-JVS_normal.jpg
                        avatarUrlHd: >-
                          https://pbs.twimg.com/profile_images/1821625188829544448/r86n-JVS_400x400.jpg
                        followers: null
                        following: null
                        tweetCount: null
                        verified: null
                        verifiedType: null
                        protected: null
                        profileImageShape: Circle
                        professionalCategory: null
                      - id: '1173276871'
                        name: null
                        screenName: ishanrc
                        url: https://x.com/ishanrc
                        bio: null
                        avatarUrl: >-
                          https://pbs.twimg.com/profile_images/1641831032725856259/lyUEmUP6_normal.jpg
                        avatarUrlHd: >-
                          https://pbs.twimg.com/profile_images/1641831032725856259/lyUEmUP6_400x400.jpg
                        followers: null
                        following: null
                        tweetCount: null
                        verified: null
                        verifiedType: null
                        protected: null
                        profileImageShape: Circle
                        professionalCategory: null
                  fetchedAt: '2026-10-05T14:42:32.939Z'
                meta:
                  requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
                  creditsCharged: 1
                  creditsRemaining: 4999
                  cached: false
        '401':
          description: Missing, invalid, or revoked API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: UNAUTHORIZED
                  message: API key required — pass it in the `x-api-key` header.
                  requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
        '402':
          description: Not enough credits for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: INSUFFICIENT_CREDITS
                  message: >-
                    This request costs 1 credit, but your balance is 0. Top up
                    to continue.
                  requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
        '404':
          description: Community not found / suspended.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: NOT_FOUND
                  message: >-
                    The requested content was not found (it may not exist, be
                    deleted, or be private).
                  requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
        '422':
          description: Invalid query parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: VALIDATION_ERROR
                  message: Request validation failed
                  requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
                  details:
                    - path: url
                      message: Required
        '429':
          description: Over the per-minute rate limit — honour `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: RATE_LIMITED
                  message: >-
                    Rate limit exceeded — max 100 requests per 60s. Retry in
                    ~30s.
                  requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
        '503':
          description: >-
            Temporarily unavailable — retry after `Retry-After`. `error.code`
            tells you why: `UPSTREAM_BLOCKED` (the source blocked this request),
            `EXTRACTION_FAILED` (the source returned unexpected data),
            `PLATFORM_UNAVAILABLE` (the source is down), or
            `SERVICE_UNAVAILABLE` (we are at capacity).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: UPSTREAM_BLOCKED
                  message: >-
                    The source is temporarily unavailable. Please try again
                    shortly.
                  requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: NOT_FOUND
            message:
              type: string
              example: The requested content was not found.
            requestId:
              type: string
              example: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
            details:
              type: array
              items:
                type: object
              description: Present on validation errors.
          required:
            - code
            - message
            - requestId
      required:
        - error
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Your API key. Send it in the `x-api-key` header (or `Authorization:
        Bearer <key>`). Create and manage keys from your dashboard.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.