Twitter/X Community API
X Community metadata — ISO createdAt, flat creator handle, isNsfw + bannerImage (SC gaps), rules[].
GET request to /v1/twitter/community that responds with clean JSON and costs 1 credit. Pass cache=true for a free 24h cache hit; default is always fresh. Start with 100 free credits — no credit card.What is the Twitter/X Community API?
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}]. isNsfw and bannerImage are Captapi extras vs ScrapeCreators. Pair with Community Tweets to list posts. Flat 1 credit.
What you get
- ISO createdAt + flat creator handle
- isNsfw + bannerImage (not in SC)
- rules[{name, description}] without GraphQL noise
- Flat 1 credit per call
Try it
Fill in the parameters below and copy a ready-to-run request, or open the live Playground to run it against your account (no API key paste).
Parameters
curl "https://api.captapi.com/v1/twitter/community?url=https%3A%2F%2Fx.com%2Fi%2Fcommunities%2F1493446837214187523" \
-H "Authorization: Bearer capt_live_..."
# or: -H "x-api-key: capt_live_..."Edit the parameters and the code updates instantly. Switch languages and hit copy.
Example response
{
"success": true,
"data": {
"platform": "twitter",
"id": "1493446837214187523",
"url": "https://x.com/i/communities/1493446837214187523",
"name": "Build in Public",
"description": "Share what you're working on. Get feedback. Help each other move forward. – Sponsored by bolt.new ⚡",
"memberCount": 264138,
"createdAt": "2022-02-15T04:47:27.000Z",
"creator": "marckohlbrugge",
"joinPolicy": "Open",
"isNsfw": false,
"bannerImage": "https://pbs.twimg.com/community_banner_img/1915033378811772928/KdaKUaRP?format=png&name=orig",
"rules": [
{
"name": "Share what you're working on",
"description": "Don't be scared to share unfinished work"
},
{
"name": "Screenshots, screencasts, drafts, etc",
"description": "Visual tweets tend to grab people's attention"
}
]
}
}Billing metadata is returned in response headers: X-Captapi-Credits (credits charged), X-Captapi-Cache (hit or miss), and X-Captapi-Source. Failed requests (4xx/5xx) are never charged. See the full list of error codes in the error reference.
Response structure
A successful call returns success, cached, creditsUsed, and a data object with the following fields:
Top-level fields
platformPlatform identifier for this response (matches the endpoint's platform).idStable platform ID for the item.urlCanonical URL of the item.nameName of the item or account. On profile endpoints: deprecated alias of displayName (one release).descriptionDescription text.memberCountHow many members the community has.createdAtWhen the community was created (ISO-8601 UTC, e.g. 2022-02-15T04:47:27.000Z).creatorX handle of the community founder (normalized from GraphQL creator_results).joinPolicyWho can join (e.g. "Open").isNsfwWhether X marks the community as NSFW.bannerImageCommunity banner image URL when exposed.
Rules
Each item in rules contains:
nameName of the item or account. On profile endpoints: deprecated alias of displayName (one release).descriptionDescription text.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| url | string | Yes | X community URL (x.com/i/communities/ID) or community ID — not a tweet/status URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | No | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. Envelope includes cached + cachedAt on hits. |
Authentication: send your key as Authorization: Bearer capt_live_.... A typical call costs 1 credit. Pass cache=true for a free 24h cache hit; default is always fresh.
How it works
- 1. Sign up — get 100 free credits, no card required.
- 2. Create a key from your dashboard.
- 3. Send one request to
/v1/twitter/communityand parse the JSON response.
Use cases
Community Enrichment
Resolve a X/Twitter Community to name and metadata.
Monitoring
Track community identity for listening workflows.
Frequently asked questions
What does the Twitter/X Community API do?+
The Twitter/X Community API lets you fetch full metadata and key stats from a public Twitter / X post using one GET request to /v1/twitter/community. It returns clean JSON — no OAuth or infrastructure setup required.
How many credits does the Twitter/X Community API cost?+
Each successful call costs 1 credit. Pass cache=true to serve from the 24h cache (0 credits on hit); default is always fresh. Hits include cached + cachedAt. Selected profile endpoints also accept cacheMaxAge=1d|3d|7d|14d|30d. Failed or empty results are never charged.
Do I need a Twitter / X API key or OAuth?+
No. A single Captapi key works across every platform Captapi supports — YouTube, TikTok, Instagram, Facebook, Twitter/X, Reddit, Threads, Bluesky, Pinterest, LinkedIn, Rumble, Spotify, Kwai, and more. We handle proxies, rate limits, retries, and authentication for you.
Is the Twitter/X Community API suitable for production use?+
Yes. It is a stable REST endpoint with predictable JSON and automatic retries. Pass cache=true to serve from the 24h cache (0 credits on hit); default is always fresh. Hits include cached + cachedAt. Selected profile endpoints also accept cacheMaxAge=1d|3d|7d|14d|30d. Use it for analytics, monitoring, and content automation.
More Twitter / X APIs
Ready to use the Twitter/X Community API?
Sign up, grab your key, and make your first call in 60 seconds.