# X (Twitter) Community API. Send a community link or ID.

Rules, admin and exact member count. We handle the proxies, blocks and platform changes.

[Get API key](https://socialtap.dev/signup/?next=%2Fplayground%2F%3Fendpoint%3Dx.community)

## X (Twitter) Community API at a glance

Returns a public X (formerly Twitter) Community from its link or ID: title, description, rules, admin and exact member count. It also has the topic, banner, creation time, NSFW flag, creator, moderator count, how people join (open, by approval or by invitation) and the question X asks them, who can invite, the words it is found by, and the few members X shows on its page.

GET `/v1/x/community`

[Read the API reference](https://socialtap.dev/docs/reference/x/community/index.md)

- **1 credit** per request, $0.75–$1.97 per 1,000 requests
- **17 typed fields** null when unknown
- **`url`** is all it needs, e.g. `https://x.com/i/communities/1493446837214187523`
- **100 credits** free when you sign up, no card, so you can build before you spend

## Send one request. Get 17 fields back.

Copy the request in your language, or hand it to your agent. Sign up for an API key and your first 100 credits are free.

`$ npm install socialtap`

`url = https://x.com/i/communities/1493446837214187523`

[Open in playground](https://socialtap.dev/playground/?endpoint=x.community)

cURL:

```shell
curl -G 'https://socialtap.dev/v1/x/community' \
  --data-urlencode 'url=https://x.com/i/communities/1493446837214187523' \
  -H "x-api-key: $SOCIALTAP_API_KEY"
```

TypeScript SDK:

```typescript
import { SocialTap } from "socialtap";

const client = new SocialTap(); // apiKey defaults to process.env.SOCIALTAP_API_KEY

const res = await client.x.community.get({ url: "https://x.com/i/communities/1493446837214187523" });
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);
```

Node.js (fetch):

```javascript
const params = new URLSearchParams({
  url: "https://x.com/i/communities/1493446837214187523",
});
const res = await fetch(`https://socialtap.dev/v1/x/community?${params}`, {
  headers: { "x-api-key": process.env.SOCIALTAP_API_KEY ?? "" },
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
const { data, meta } = body;
console.log(data, meta.credits_charged);
```

Python (requests):

```python
import os

import requests

res = requests.get(
    "https://socialtap.dev/v1/x/community",
    params={"url": "https://x.com/i/communities/1493446837214187523"},
    headers={"x-api-key": os.environ["SOCIALTAP_API_KEY"]},
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
data, meta = body["data"], body["meta"]
print(data, meta["credits_charged"])
```

Go (net/http):

```go
package main

import (
	"encoding/json"
	"fmt"
	"log"
	"net/http"
	"net/url"
	"os"
)

func main() {
	q := url.Values{}
	q.Set("url", "https://x.com/i/communities/1493446837214187523")
	req, err := http.NewRequest("GET", "https://socialtap.dev/v1/x/community?"+q.Encode(), nil)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("x-api-key", os.Getenv("SOCIALTAP_API_KEY"))
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer res.Body.Close()
	var body struct {
		Data  json.RawMessage `json:"data"`
		Meta  map[string]any  `json:"meta"`
		Error *struct {
			Code    string `json:"code"`
			Message string `json:"message"`
		} `json:"error"`
	}
	if err := json.NewDecoder(res.Body).Decode(&body); err != nil {
		log.Fatal(err)
	}
	if body.Error != nil {
		log.Fatalf("%s: %s", body.Error.Code, body.Error.Message)
	}
	fmt.Println(string(body.Data), body.Meta["credits_charged"])
}
```

200 OK:

```json
{
  "data": {
    "approximate_fields": [],
    "avatar_url": null,
    "banner_url": "https://pbs.twimg.com/community_banner_img/1915033378811772928/KdaKUaRP?format=png&name=orig",
    "categories": [
      "Entrepreneurship"
    ],
    "created_at": "2022-02-15T04:47:27Z",
    "description": "Share what you're working on. Get feedback. Help each other move forward. – Sponsored by bolt.new ⚡",
    "id": "1493446837214187523",
    "is_nsfw": false,
    "metrics": {
      "member_count": 270227
    },
    "moderators": [
      {
        "avatar_url": "https://pbs.twimg.com/profile_images/1857124042433572864/iMivVaYP.jpg",
        "display_name": "Marc Köhlbrugge",
        "id": "641633",
        "is_verified": true,
        "url": "https://x.com/marckohlbrugge",
        "username": "marckohlbrugge"
      }
    ],
    "name": null,
    "platform": "x",
    "platform_specific": {
      "x": {
        "creator": {
          "avatar_url": "https://pbs.twimg.com/profile_images/1857124042433572864/iMivVaYP.jpg",
          "display_name": "Marc Köhlbrugge",
          "id": "641633",
          "is_verified": true,
          "url": "https://x.com/marckohlbrugge",
          "username": "marckohlbrugge"
        },
        "invite_policy": "members",
        "join_policy": "open",
        "join_question": "What are you working on?",
        "moderator_count": 6,
        "sample_members": [
          {
            "avatar_url": "https://pbs.twimg.com/profile_images/1857124042433572864/iMivVaYP.jpg",
            "display_name": "Marc Köhlbrugge",
            "id": "641633",
            "is_verified": true,
            "url": "https://x.com/marckohlbrugge",
            "username": "marckohlbrugge"
          },
          {
            "avatar_url": "https://pbs.twimg.com/profile_images/1142795908221952001/QdBqHhdn.jpg",
            "display_name": "🚧 WIP",
            "id": "11212692",
            "is_verified": false,
            "url": "https://x.com/wip",
            "username": "wip"
          },
          {
            "avatar_url": "https://pbs.twimg.com/profile_images/1416201794200477700/Kasb_zJv.jpg",
            "display_name": "Build in Public",
            "id": "2729705040",
            "is_verified": true,
            "url": "https://x.com/buildinpublic",
            "username": "buildinpublic"
          }
        ],
        "search_tags": [
          "buildinpublic",
          "buildinginpublic",
          "builtinpublic"
        ]
      }
    },
    "privacy": "public",
    "rules": [
      {
        "description": "Don't be scared to share unfinished work",
        "title": "Share what you're working on"
      },
      {
        "description": "Visual tweets tend to grab people's attention",
        "title": "Screenshots, screencasts, drafts, etc"
      },
      {
        "description": "Don't ask for upvotes or advertise your products/services.",
        "title": "No self-promotion"
      }
    ],
    "title": "Build in Public",
    "unknown_fields": [],
    "url": "https://x.com/i/communities/1493446837214187523"
  },
  "meta": {
    "request_id": "req_3f9c2a7d1e8b4c6a9f0e2d4b6a8c0e1f",
    "platform": "x",
    "source": "api",
    "is_cached": false,
    "credits_charged": 1,
    "latency_ms": 325,
    "fetched_at": "2026-10-25T12:00:00Z",
    "input": {
      "kind": "community",
      "id": "1493446837214187523",
      "url": "https://x.com/i/communities/1493446837214187523"
    },
    "credits_remaining": 9999,
    "client_request_id": null,
    "warnings": []
  }
}
```

Long arrays and strings are shortened here. Real responses are complete.

## One schema on 3 platforms.

The [response reference](https://socialtap.dev/docs/reference/x/community/index.md#response) lists every field, its type and when it is `null`. [See the full schema](https://socialtap.dev/resources/community/index.md).

- ### Null means unknown

  A field X doesn't show is null, never zero or an empty string, so a real zero always means zero.
- ### What it accepts

  The community: its link on x.com or twitter.com (x.com/i/communities/\<id>, any of its views such as /about, /media or /members included, mobile hosts and any query too) or its numeric ID.
- ### Write one parser

  X, Facebook and Reddit answer in these fields, so the code that reads one reads them all.

- **`platform`string**: Platform ID (reddit, facebook, …).
- **`id`string**: Platform-native community ID (string): Reddit's subreddit ID with its t5_ prefix, Facebook's numeric group ID.
- **`name`string**: The name its links use, without a prefix (golang for r/golang; a Facebook group's vanity name); null when it has none (a Facebook group known only by its number).
- **`title`string**: The community's title as its page shows it ("The Go Programming Language"; what Facebook calls a group's name); null when it has none.
- **`description`string**: Its short description as plain text; null when it has none.
- **`url`string**: Canonical community URL (https://www.reddit.com/r/golang/, https://www.facebook.com/groups/\<id>/).
- **`avatar_url`string**: The community's icon or picture; null when it has none. Platform CDN URLs can expire.
- **`banner_url`string**: Header or cover image URL; null when it has none.

Live data from 33 platforms.

[TikTok](https://socialtap.dev/apis/tiktok/index.md) · [Instagram](https://socialtap.dev/apis/instagram/index.md) · [Facebook](https://socialtap.dev/apis/facebook/index.md) · [YouTube](https://socialtap.dev/apis/youtube/index.md) · [Reddit](https://socialtap.dev/apis/reddit/index.md) · [Threads](https://socialtap.dev/apis/threads/index.md) · [Spotify](https://socialtap.dev/apis/spotify/index.md) · [Amazon](https://socialtap.dev/apis/amazon/index.md) · [Apple Music](https://socialtap.dev/apis/applemusic/index.md) · [Pinterest](https://socialtap.dev/apis/pinterest/index.md) · [Rumble](https://socialtap.dev/apis/rumble/index.md) · [X](https://socialtap.dev/apis/x/index.md) · [Bluesky](https://socialtap.dev/apis/bluesky/index.md) · [Twitch](https://socialtap.dev/apis/twitch/index.md) · [LinkedIn](https://socialtap.dev/apis/linkedin/index.md) · [Telegram](https://socialtap.dev/apis/telegram/index.md) · [TikTok Shop](https://socialtap.dev/apis/tiktokshop/index.md) · [Kwai](https://socialtap.dev/apis/kwai/index.md) · [Snapchat](https://socialtap.dev/apis/snapchat/index.md) · [SoundCloud](https://socialtap.dev/apis/soundcloud/index.md) · [Truth Social](https://socialtap.dev/apis/truthsocial/index.md) · [Kick](https://socialtap.dev/apis/kick/index.md) · [Komi](https://socialtap.dev/apis/komi/index.md) · [Lnk.Bio](https://socialtap.dev/apis/linkbio/index.md) · [Linkme](https://socialtap.dev/apis/linkme/index.md) · [Linktree](https://socialtap.dev/apis/linktree/index.md) · [Pillar](https://socialtap.dev/apis/pillar/index.md) · [TikTok Ad Library](https://socialtap.dev/apis/tiktok-ad-library/index.md) · [Facebook Ad Library](https://socialtap.dev/apis/facebook-ad-library/index.md) · [Facebook Events](https://socialtap.dev/apis/facebook-events/index.md) · [Facebook Marketplace](https://socialtap.dev/apis/facebook-marketplace/index.md) · [Google Ads Transparency Center](https://socialtap.dev/apis/google-ads-transparency/index.md) · [LinkedIn Ad Library](https://socialtap.dev/apis/linkedin-ad-library/index.md)

## What teams build with the X (Twitter) Community API.

- ### Vet a community's rules before posting
- ### Track a community's member count over time
- ### Find who runs a community
- ### Enrich community links with titles and topics

## Good to know before you build.

- privacy is public when anyone can join and restricted when joining takes a request or an invitation. Anyone can read the posts of both, and platform_specific.x.join_policy says which restriction applies.
- name and avatar_url are always null: X Communities have no vanity name (their links use the ID) and no icon, only a banner. banner_url is the community's own banner, or the stock image X gives it.
- moderators holds only the admin, because X lists the other moderators and the members to logged-in people alone. platform_specific.x.moderator_count counts them, and sample_members is the few members X picks for the page.
- When X's community API fails, the community comes from its page, which lacks the admin, invite policy, moderator count and search tags: those are then null or listed in unknown_fields.
- A community that never existed and one X removed look the same on X, and both return not_found. Every community X still serves is readable logged out, so none returns private_or_unavailable.

## 1 credit per request. Failed requests are free.

Buy credits once and spend them on any endpoint, on any platform.

[Plans and packs](https://socialtap.dev/pricing/index.md) · [How this endpoint is priced](https://socialtap.dev/docs/reference/x/community/index.md#pricing) · [How credits work](https://socialtap.dev/docs/credits/index.md)

| Source | Price per successful request | Per 1,000 requests |
| --- | --- | --- |
| Any source | 1 credit | $0.75–$1.97 |

- Cache hits are free.
- Credits from packs and top-ups never expire.
- A monthly plan's credits are spent first, and what is left of them ends at each renewal.
- Prices exclude tax: sales tax is added at checkout where it applies.
- Outside the US, plans and packs are sold to businesses: checkout asks for your VAT, GST or other business tax ID.

## Questions about the X (Twitter) Community API.

More in the [API reference](https://socialtap.dev/docs/reference/x/community/index.md).

**How much does the X (Twitter) Community API cost?**

A request costs 1 credit. SocialTap credits cost $0.75–$1.97 per 1,000, depending on the plan or pack.

Other platforms

## Communities on 2 more platforms.

- [Facebook Group API](https://socialtap.dev/apis/facebook/group/index.md) (1 credit · `GET /v1/facebook/group`)
- [Reddit Subreddit API](https://socialtap.dev/apis/reddit/subreddit/index.md) (1 credit · `GET /v1/reddit/subreddit`)

More X

## X API. 7 endpoints, one key.

- [X (Twitter) Post API](https://socialtap.dev/apis/x/post/index.md) (1 credit · `GET /v1/x/post`)
- [X (Twitter) Profile API](https://socialtap.dev/apis/x/profile/index.md) (1 credit · `GET /v1/x/profile`)
- [X (Twitter) Post Search API](https://socialtap.dev/apis/x/search_posts/index.md) (From 1 credit / page · `GET /v1/x/search_posts`)
- [X (Twitter) User Search API](https://socialtap.dev/apis/x/search_profiles/index.md) (From 1 credit / page · `GET /v1/x/search_profiles`)
- [X (Twitter) Hashtag Search API](https://socialtap.dev/apis/x/search_hashtags/index.md) (1 credit / page · `GET /v1/x/search_hashtags`)
- [X (Twitter) Community Search API](https://socialtap.dev/apis/x/search_communities/index.md) (From 1 credit / page · `GET /v1/x/search_communities`)

## Try it on a link you already have.

Paste it in the playground, or copy the request into your code.

100free credits

- No credit card
- Failed requests are free
- Works on all 218 endpoints

[Start for free](https://socialtap.dev/signup/) [Read the docs](https://socialtap.dev/docs/index.md)

---

[HTML version](https://socialtap.dev/apis/x/community/) · [Docs index for AI agents](https://socialtap.dev/llms.txt) · [All docs in one file](https://socialtap.dev/llms-full.txt)
