# X / Twitter Community (`twitter.community`)

Public details of an X (Twitter) Community by URL: name, description, member count, join policy, creator and rules.

Docs: https://primaryapi.com/docs/api-reference/twitter/community

- Endpoint: `POST https://api.primaryapi.com/v1/run/twitter.community`
- Category: Social · Platform: `twitter` · Kind: lookup · Status: live
- Price: 1 credit per call; up to 3 credits if a call is retried elsewhere. A quote’s `maxCredits` is the most a given call can cost.
- Billing unit: per successful call
- Reliability: routed to a healthy upstream and retried automatically when an attempt fails; live 30-day status: `GET https://api.primaryapi.com/v1/status/apis?sku=twitter.community`
- Execution: synchronous (answers 202 only if it outlives the wait window)

## Input

| Field | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
| `url` | string | yes |  | max 2048 chars; pattern: ^\s*(?:\d{1,25}\|(?:https?:\/\/)?(?:[a-z0-9-]+\.)*(?:x\|twitter)\.com\/i\/communities\/\d{1,25}(?:[/?#][^\s]*)?)\s*$ | Community URL (e.g. https://x.com/i/communities/1493446837214187523) or the numeric community id. |

Unknown fields are rejected with `400 invalid_input`. The routing controls `preferLatencyUnderMs` and `maxCredits` may be sent in the same JSON body.

## Output

When `output.found` is `true`, `output.data` has this shape:

| Field | Type | Description |
|---|---|---|
| `id` | string | Numeric community id |
| `url` | string |  |
| `name` | string \| null |  |
| `description` | string \| null |  |
| `memberCount` | integer \| null |  |
| `joinPolicy` | string \| null | Open \| RestrictedJoinRequestsRequireModeratorApproval \| …, as X reports it |
| `nsfw` | boolean \| null |  |
| `creatorHandle` | string \| null |  |
| `createdUtc` | integer \| null | UTC epoch seconds |
| `rules` | object[] |  |
| `rules[].name` | string |  |
| `rules[].description` | string \| null |  |

When the thing you asked about does not exist (or a search matches nothing) the call still succeeds: `output.found` is `false`, `output.data` is `null` and `output.reason` says why (`not_found`, `private`, `no_results`, …). Misses are free unless the notes below say misses are billed.

## Example request

```bash
curl -sS -X POST "https://api.primaryapi.com/v1/run/twitter.community" \
  -H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://x.com/i/communities/1493446837214187523"}'
```

## Example response

_Values are placeholders that follow the output schema; `credits` is what this call would cost at the usual price._

```json
{
  "output": {
    "found": true,
    "data": {
      "id": "string",
      "url": "https://x.com/i/communities/1493446837214187523",
      "name": "string",
      "description": "string",
      "memberCount": 0,
      "joinPolicy": "string",
      "nsfw": true,
      "creatorHandle": "string",
      "createdUtc": 0,
      "rules": [
        {
          "name": "string",
          "description": "string"
        }
      ]
    }
  },
  "provider": "PrimaryAPI",
  "credits": 1,
  "items": 1,
  "requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z"
}
```

## Pricing and reliability

- Usual price: 1 credit per call
- Price ceiling: up to 3 credits if a call is retried elsewhere. A quote’s `maxCredits` is the most a given call can cost; the `maxCredits` routing control caps it per call
- Live 30-day status, success rate, uptime and latency: `GET https://api.primaryapi.com/v1/status/apis?sku=twitter.community`

## Errors to handle

`invalid_input`, `unauthorized`, `insufficient_balance`, `key_limit_reached`, `trial_cap_reached`, `forbidden`, `not_found`, `idempotency_conflict`, `rate_limited`, `all_sources_failed`, `service_unavailable`, `timeout`. See https://primaryapi.com/docs/errors.

## Notes

Unknown communities return found=false.

