---
title: "Twitter/X Community API"
method: GET
path: "/v1/twitter/community"
tags: ["Twitter / X"]
---

# Twitter/X Community API

`GET /v1/twitter/community`

## Request

- Base URL: `https://api.captapi.com`
- URL: `https://api.captapi.com/v1/twitter/community`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

X Community metadata — ISO createdAt, flat creator handle, isNsfw + bannerImage, rules[].

Paste an X community URL (x.com/i/communities/ID) or community ID — not a tweet URL — and get clean JSON: name, description, memberCount, ISO-8601 createdAt (.000Z), creator as a flat handle (not nested creator_results), joinPolicy, isNsfw, bannerImage, and rules[{name,description}]. Pair with Community Tweets to list posts. Flat 1 credit.

Docs: https://captapi.com/apis/twitter-community

## Query parameters

- `url` string, required
- `cache` boolean

## Response `200`

Success. The data object for this endpoint.

- object
  - `success` unknown, required
  - `data` object, required
    - `platform` string: Platform identifier for this response (matches the endpoint's platform).
    - `id` string: Stable platform ID for the item.
    - `url` string: Canonical URL of the item.
    - `name` string: Name of the item or account. On profile endpoints: deprecated alias of displayName (one release).
    - `description` string: Description text.
    - `memberCount` integer: How many members the community has.
    - `createdAt` string: When the community was created (ISO-8601 UTC, e.g. 2022-02-15T04:47:27.000Z).
    - `creator` string: X handle of the community founder (normalized from GraphQL creator_results).
    - `joinPolicy` string: Who can join (e.g. "Open").
    - `isNsfw` boolean: Whether X marks the community as NSFW.
    - `bannerImage` string: Community banner image URL when exposed.
    - `rules` object[]
      - `name` string: Name of this rules item.
      - `description` string: Description of this rules item.

## Other responses

- `400`: Bad request: wrong platform URL, unknown endpoint, or an invalid parameter value. Not billed.
- `401`: Missing, invalid or revoked API key. Not billed.
- `402`: Not enough credits for this request. Not billed.
- `404`: The resource does not exist or is not public. Not billed.
- `422`: A required parameter is missing or has the wrong type. Not billed.
- `429`: Rate limit reached. Wait for Retry-After seconds. Not billed.
- `502`: The platform could not be reached or returned nothing usable. Retryable, not billed. 503 and 504 use the same envelope.

---

[API](https://skmtc.dev/captapi/apis/captapi-api.md) · [All operations](https://skmtc.dev/captapi/apis/captapi-api/llms.txt) · [OpenAPI document](https://skmtc.dev/captapi/apis/captapi-api/revisions/c9b9ac5ff1bd?raw)