# X (Twitter) Community API

X

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`

## Example

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 for display; real responses are complete.

> [!NOTE]
>
> **Good to know**
>
> - 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.

## Authorizations

`x-api-key`stringheaderrequired

Your API key. [Authentication](https://socialtap.dev/docs/authentication/index.md)

## Query parameters

| Name | Type | Description | Example |
| --- | --- | --- | --- |
| `url` required | `string`<br>max 2,048 chars | 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. | `https://x.com/i/communities/1493446837214187523` |

`url` takes X community links; another kind of link, or another platform's, fails free with [`invalid_input`](https://socialtap.dev/docs/errors/index.md#invalid_input). Unknown parameters are rejected with a suggestion, never ignored ([Requests](https://socialtap.dev/docs/requests/index.md)).

**Parameters every endpoint accepts**

| Name | Type | Description | Example |
| --- | --- | --- | --- |
| `max_age` optional | `integer`<br>min 0 | Accept a cached response up to this many seconds old. Cache hits cost 0 credits. Omit to always fetch fresh. The Cache-Control: max-age=N request header is equivalent; max_age wins when both are sent. | — |
| `fields` optional | `string` | Return only these fields of each item: comma-separated paths in the schema's notation (id,text,metrics.view_count,segments\[\].text; a parent path keeps the whole object). Unknown paths are rejected. Applied after the cache, so it changes neither the price nor cache hits; page and meta are always returned whole. | — |

## Response

### 200

`{data, meta}`. `data` is a [community](https://socialtap.dev/resources/community/index.md) object; `meta` describes the request ([meta](https://socialtap.dev/docs/reference/index.md#meta)). Fields only X has are under `platform_specific.x`.

| Field | Type | Description |
| --- | --- | --- |
| `data.platform` | `string` | Platform ID (reddit, facebook, …). |
| `data.id` | `string` | Platform-native community ID (string): Reddit's subreddit ID with its t5_ prefix, Facebook's numeric group ID. |
| `data.name` | `string` or `null` | 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). |
| `data.title` | `string` or `null` | 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. |
| `data.description` | `string` or `null` | Its short description as plain text; null when it has none. |
| `data.url` | `string` (uri) | Canonical community URL (https://www.reddit.com/r/golang/, https://www.facebook.com/groups/\<id>/). |
| `data.avatar_url` | `string` (uri) or `null` | The community's icon or picture; null when it has none. Platform CDN URLs can expire. |
| `data.banner_url` | `string` (uri) or `null` | Header or cover image URL; null when it has none. |
| `data.privacy` | `string` or `null` | public: anyone can see its posts and any member can post; restricted: anyone can see its posts, only approved members can post; private: only members can see its posts (a private community answers private_or_unavailable unless its page shows these fields logged out). New values may be added; treat unknown values as restricted.<br>One of `public`, `restricted`, `private` |
| `data.is_nsfw` | `boolean` or `null` | Marked adult (NSFW) by the platform; null where the platform has no such mark. |
| `data.categories` | `string[]` | Topics or categories the platform files it under, as shown (not normalized); \[\] when none. |
| `data.rules` | `object[]` | Its published rules, in the platform's order; \[\] when it has none (listed in unknown_fields when the source cannot see them). |
| `data.rules[].title` | `string` | The rule's short title (Reddit short_name, Facebook rule_title). |
| `data.rules[].description` | `string` or `null` | Its explanation as plain text; null when it has none. |
| `data.moderators` | `object[]` | Accounts that run it (admins and moderators) the platform shows; \[\] when none are shown (listed in unknown_fields when the source cannot see them). |
| `data.moderators[].id` | `string` or `null` | Platform-native account ID; null when only the handle is known. |
| `data.moderators[].username` | `string` or `null` | Handle without the @; null when the account has none. |
| `data.moderators[].display_name` | `string` or `null` | Display name shown on the profile. |
| `data.moderators[].url` | `string` (uri) or `null` | Canonical profile URL. |
| `data.moderators[].avatar_url` | `string` (uri) or `null` | Profile picture URL. Platform CDN URLs can expire within hours. |
| `data.moderators[].is_verified` | `boolean` or `null` | Platform verification badge; null where the platform has no badge. |
| `data.created_at` | `string` (date-time) or `null` | When it was created, RFC 3339 UTC. |
| `data.metrics` | `object` | Counts at fetch time; null = hidden or not exposed, 0 = zero. |
| `data.metrics.member_count` | `integer` or `null` | Members (on Reddit, subscribers) as the platform counts them. |
| `data.platform_specific` | `object` | Fields only this platform has, under its ID (platform_specific.\<platform>); each null when unknown. |
| `data.platform_specific.x` | `object` or `null` | An X Community's own fields. |
| `data.platform_specific.x.join_policy` | `string` or `null` | How people join: open (anyone), moderator_approval or admin_approval (a request someone approves), invite_only (by invitation). New values may be added.<br>One of `open`, `moderator_approval`, `admin_approval`, `invite_only` |
| `data.platform_specific.x.join_question` | `string` or `null` | The question X asks people who ask to join, as its moderators wrote it; null when it asks none. |
| `data.platform_specific.x.invite_policy` | `string` or `null` | Who can invite people in: members, moderators, admins or none. New values may be added.<br>One of `members`, `moderators`, `admins`, `none` |
| `data.platform_specific.x.creator` | `object` or `null` | The account that created it (it may have passed to another admin since). |
| `data.platform_specific.x.creator.id` | `string` or `null` | Platform-native account ID; null when only the handle is known. |
| `data.platform_specific.x.creator.username` | `string` or `null` | Handle without the @; null when the account has none. |
| `data.platform_specific.x.creator.display_name` | `string` or `null` | Display name shown on the profile. |
| `data.platform_specific.x.creator.url` | `string` (uri) or `null` | Canonical profile URL. |
| `data.platform_specific.x.creator.avatar_url` | `string` (uri) or `null` | Profile picture URL. Platform CDN URLs can expire within hours. |
| `data.platform_specific.x.creator.is_verified` | `boolean` or `null` | Platform verification badge; null where the platform has no badge. |
| `data.platform_specific.x.moderator_count` | `integer` or `null` | People who run it, its admin included, as X counts them. |
| `data.platform_specific.x.search_tags` | `string[]` | Words its moderators chose for people to find it by; \[\] when none (listed in unknown_fields when the source cannot see them). |
| `data.platform_specific.x.sample_members` | `object[]` | The few members X shows on the community's page: a sample chosen by X, not its member list. |
| `data.platform_specific.x.sample_members[].id` | `string` or `null` | Platform-native account ID; null when only the handle is known. |
| `data.platform_specific.x.sample_members[].username` | `string` or `null` | Handle without the @; null when the account has none. |
| `data.platform_specific.x.sample_members[].display_name` | `string` or `null` | Display name shown on the profile. |
| `data.platform_specific.x.sample_members[].url` | `string` (uri) or `null` | Canonical profile URL. |
| `data.platform_specific.x.sample_members[].avatar_url` | `string` (uri) or `null` | Profile picture URL. Platform CDN URLs can expire within hours. |
| `data.platform_specific.x.sample_members[].is_verified` | `boolean` or `null` | Platform verification badge; null where the platform has no badge. |
| `data.approximate_fields` | `string[]` | JSON paths of values rounded by the platform or parsed from display text ("762.0K members": metrics.member_count). \[\] when all exact. |
| `data.unknown_fields` | `string[]` | JSON paths of lists whose \[\] means unknown rather than none (a source that cannot see them); null already means unknown for every other field. \[\] when every list is known. |

not_found and private_or_unavailable are item-level: the request was fine, the item can't be returned.

### 400

400 Bad Request: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `invalid_input` | 400 | No | A parameter is missing or malformed, or the link is not one this endpoint takes. | Fix the parameter named in param as the message says. For a link of the wrong kind, call an endpoint listed in details.endpoints, when there is one. |

### 401

401 Unauthorized: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `unauthorized` | 401 | No | The x-api-key header is missing, or its key is unknown or revoked. On the dashboard's routes: the session cookie is missing or expired. | Send a valid API key in the x-api-key header. No key yet? A person gets one at details.signup_url; an AI agent follows details.agent_auth_url. |

### 402

402 Payment Required: 2 error codes. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `insufficient_credits` | 402 | No | The account does not have enough credits for this request. | Have a person buy credits at details.purchase_url (or make them a checkout link with details.checkout), then repeat the request. Do not retry automatically. |
| `spend_limit_reached` | 402 | No | The API key reached its spend limit for this period. The account may still have credits. | Wait until details.resets_at, or raise the key's spend limit (PATCH /v1/api_keys/{id}). Do not retry automatically. |

### 403

403 Forbidden: 2 error codes. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `forbidden` | 403 | No | The API key is valid but may not make this request, and details.reason says why: the account is suspended, the key lacks the route's scope, waits for its owner to confirm it by email, has expired, or was used from an IP outside its allowlist, or a rotated key's previous secret was used for a call that needs the admin scope. A running job stops with it too when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item: a private item is private_or_unavailable, also 403, so branch on the code. | Act on details.reason. suspended: contact [support](mailto:support@socialtap.dev). scope: use a key with details.required_scope. previous_secret: use the new secret. key_pending: have the owner open the emailed link. key_expired or key_revoked: create a new key. ip_not_allowed: call from an allowed IP. |
| `private_or_unavailable` | 403 | No | The item exists but is not public: it is private, age- or region-restricted, or needs a login to view. It shares 403 with forbidden (which is about the key), so branch on the code. | Only public items can be fetched. Do not retry. |

### 404

404 Not Found: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `not_found` | 404 | No | The item does not exist or was deleted. On GET /v1/requests/{id}/response: the response was not kept (details.reason says why). | Check the link or ID. Do not retry. |

### 429

429 Too Many Requests: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `rate_limited` | 429 | Yes, later | The account passed its runaway-protection ceiling: a high per-account limit that stops a broken client loop (plans have no rate limit). Requests without an API key (signup, the MCP server's tool listing and find_endpoint) are limited per IP address instead. It also stops an account whose failed requests in the last hour cost far more than its successful ones paid for: failures are free within a limit (the message says so), and successes raise it. | Wait the seconds in the retry-after header, then retry. If your steady traffic needs more, ask [support](mailto:support@socialtap.dev) to raise the ceiling; without an API key, send one. |

### 500

500 Internal Error: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `internal` | 500 | Yes, later | An unexpected error on SocialTap's side. | Retry with backoff. If it keeps happening, contact [support](mailto:support@socialtap.dev) with the request_id. |

### 502

502 Bad Gateway: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `upstream_error` | 502 | Yes, later | The platform failed, or answered with something we could not read. | Retry with backoff. Failed requests are free. |

### 503

503 Unavailable: 2 error codes. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `upstream_blocked` | 503 | Yes, later | The platform refused every attempt, our own retries included. | Retry later with backoff. Failed requests are free. |
| `overloaded` | 503 | Yes, later | SocialTap was at capacity, or paused by its operators, and did not start the request. Nothing was fetched or charged. | Retry after the seconds in the retry-after header. Failed requests are free. |

## Pricing

From **1 credit** per request. Charged only for successful requests. Errors are free. The price depends on the source that produced the result, reported as `meta.source`; sources are tried cheapest first: Platform API → Public page.

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

**Balance, sources and what you were charged**

Your balance must be at least **1 credit** to start a request; with less, it is refused with [`insufficient_credits`](https://socialtap.dev/docs/errors/index.md#insufficient_credits) (HTTP 402) and costs nothing. Only that minimum is set aside when the request starts.

| meta.source | Source | What it means |
| --- | --- | --- |
| `api` | Platform API | The platform's public, logged-out API. |
| `page` | Public page | Data embedded in the platform's public web page. |

`meta.credits_charged` and the `x-credits-charged` header show what you paid. [How credits work](https://socialtap.dev/docs/credits/index.md) · [Packs](https://socialtap.dev/pricing/index.md)

Endpoint ID `x.community` · operationId `x.community.get` · [Product overview](https://socialtap.dev/apis/x/community/index.md)

---

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