> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). The sections below mirror the orientation block in [`/llms.txt`](https://www.socialfetch.dev/llms.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need a structured operation inventory. The catalog covers documented operations with on-site reference pages.

## This page

- **On-site (HTML):** [https://www.socialfetch.dev/docs/api/v1/twitter/communities/get](https://www.socialfetch.dev/docs/api/v1/twitter/communities/get)
- **Markdown (.mdx) URL:** [https://www.socialfetch.dev/docs/api/v1/twitter/communities/get.mdx](https://www.socialfetch.dev/docs/api/v1/twitter/communities/get.mdx)

## API base URL and authentication

- **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev`
- **Authentication:** send `x-api-key: sfk_...` on `/v1/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route).
- **OpenAPI JSON:** [https://www.socialfetch.dev/openapi.json](https://www.socialfetch.dev/openapi.json)

## Recommended docs entrypoints (this site)

- [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown).
- [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope.
- [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`.
- [SDK reference](https://www.socialfetch.dev/docs/sdk-reference.mdx) — exhaustive SDK method inventory and route mapping for agents, tooling, and power users.
- [Choose the right endpoint](https://www.socialfetch.dev/docs/choose-endpoint.mdx) — task-oriented route selection for smoke tests, profiles, list endpoints, and single-item lookups.
- [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — fast comparison of identifiers, pagination, outcomes, media download, and SDK coverage.
- [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping.
- [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages.
- [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance.
- [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs.
- Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract.

## Markdown docs convention

- Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`).
- Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`).

---
# Get Twitter community (https://www.socialfetch.dev/docs/api/v1/twitter/communities/get)

## Summary

Returns metadata for a single X community by URL.

**Tags:** `Twitter`

## HTTP

- **Method:** GET
- **Path:** `/v1/twitter/communities`
- **Base URL:** `https://api.socialfetch.dev`

## Capability summary

- **SDK mapping:** `client.twitter.getCommunity({ url })`
- **Accepted identifiers:** `url` (query)
- **Pagination:** none
- **Business outcome field:** `data.lookupStatus` with values `found`, `not_found`

## Credits

- **Base:** 1 credit per successful lookup.
- **Maximum on success (200):** 1 credit.
- **Normalization failure (502):** 1 credit charged.
- **Authoritative field:** `meta.creditsCharged`.

## Authentication

- **`x-api-key`**: API key (`sfk_...`)

## Parameters

### `url` (query)

- **Required:** yes
- **Constraints:** type `string`; minLength: 1; maxLength: 4096
- **Description:** Community URL to look up.

## Responses (status codes)

- **200**: Community details when available. Check `data.lookupStatus` for `found` vs `not_found`.
- **400**: Invalid request
- **401**: Missing or invalid API key
- **402**: Insufficient credits
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed from the response (unexpected or invalid data).
- **503**: Service temporarily unavailable; safe to retry with backoff.

## Response body (200)

Community details when available. Check `data.lookupStatus` for `found` vs `not_found`.

### Field outline

- **data** (required) — type `object`. Endpoint-specific response payload.
  - **lookupStatus** (required) — type `string`; enum: found, not_found. Whether the community was found or not found.
  - **community** (required) — type `object`; nullable. Community details when available.
    - **platform** (required) — type `string`; enum: twitter. Social platform for this community.
    - **id** (required) — type `string`; minLength: 1. Numeric community identifier as a string.
    - **url** (required) — type `string`; minLength: 1. Canonical public community URL on x.com.
    - **name** (required) — type `string`; minLength: 1. Community display name.
    - **description** (required) — type `string`; nullable. Short description text when available.
    - **createdAt** (required) — type `integer`; minimum: 0. Creation time as Unix epoch milliseconds.
    - **memberCount** (required) — type `integer`; minimum: 0. Approximate member count.
    - **isNsfw** (required) — type `boolean`. Whether the community is marked as sensitive.
    - **joinPolicy** (required) — type `string`; enum: open, restricted. Who can join this community.
    - **primaryTopic** (required) — type `string`; nullable. Primary topic label when available.
    - **bannerImageUrl** (required) — type `string`; nullable. Banner image URL when available.
    - **creator** (required) — type `object`; nullable. Creator handle and verification flags when available.
      - **handle** (required) — type `string`; minLength: 1. Creator screen name without the leading @.
      - **verified** (required) — type `boolean`. Whether X marks the creator with legacy verification.
      - **blueVerified** (required) — type `boolean`. Whether the creator has X blue (paid) verification.
    - **rules** (required) — type `array`. Published community rules.
      - _items:_
        - **id** (required) — type `string`; minLength: 1. Stable rule identifier.
        - **name** (required) — type `string`; minLength: 1. Short rule title.
        - **description** (required) — type `string`; nullable. Longer rule explanation when provided.
    - **memberFacepileAvatarUrls** (required) — type `array`. Recent member avatar image URLs shown in the community preview.
      - _items:_
        - type `string`; minLength: 1
    - **trendingHashtags** (required) — type `array`. Trending hashtags associated with this community when available.
      - _items:_
        - type `string`; minLength: 1
- **meta** (required) — type `object`. Metadata describing the request and billing outcome.
  - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call.
  - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request.
  - **version** (required) — type `string`; enum: v1. Public API version that served the response.

### Example JSON (found)

```json
{
  "data": {
    "lookupStatus": "found",
    "community": {
      "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.",
      "createdAt": 1644900447551,
      "memberCount": 254959,
      "isNsfw": false,
      "joinPolicy": "open",
      "primaryTopic": "Entrepreneurship",
      "bannerImageUrl": "https://pbs.twimg.com/community_banner_img/example.png",
      "creator": {
        "handle": "marckohlbrugge",
        "verified": false,
        "blueVerified": true
      },
      "rules": [
        {
          "id": "1493447542045958144",
          "name": "Share what you're working on",
          "description": "Don't be scared to share unfinished work"
        }
      ],
      "memberFacepileAvatarUrls": [
        "https://pbs.twimg.com/profile_images/example_normal.jpg"
      ],
      "trendingHashtags": [
        "#design",
        "#code"
      ]
    }
  },
  "meta": {
    "requestId": "req_01example",
    "creditsCharged": 1,
    "version": "v1"
  }
}
```

### Example JSON (found_restricted)

```json
{
  "data": {
    "lookupStatus": "found",
    "community": {
      "platform": "twitter",
      "id": "1453811010935001090",
      "url": "https://x.com/i/communities/1453811010935001090",
      "name": "The Entrepreneurship Community",
      "description": "A community for both aspiring and current entrepreneurs.",
      "createdAt": 1635450530170,
      "memberCount": 430,
      "isNsfw": false,
      "joinPolicy": "restricted",
      "primaryTopic": null,
      "bannerImageUrl": "https://pbs.twimg.com/list_banner_img/example.png",
      "creator": {
        "handle": "harleyf",
        "verified": false,
        "blueVerified": true
      },
      "rules": [
        {
          "id": "1453811497495248897",
          "name": "Be kind.",
          "description": "It's simple. No discrimination, no hate, no put-downs. Be kind."
        }
      ],
      "memberFacepileAvatarUrls": [
        "https://pbs.twimg.com/profile_images/example2_normal.jpg"
      ],
      "trendingHashtags": []
    }
  },
  "meta": {
    "requestId": "req_01example_r",
    "creditsCharged": 1,
    "version": "v1"
  }
}
```

### Example JSON (not_found)

```json
{
  "data": {
    "lookupStatus": "not_found",
    "community": null
  },
  "meta": {
    "requestId": "req_01example_nf",
    "creditsCharged": 1,
    "version": "v1"
  }
}
```

### Machine-readable error codes

When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime):

- `bad_request`

## Error handling & retries

Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status.

- **400**: Invalid request **Retry:** Fix the request; retrying the same invalid payload will not help.
- **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help.
- **402**: Insufficient credits **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help).
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed from the response (unexpected or invalid data). **Retry:** May be transient; a few retries with backoff are reasonable.
- **503**: Service temporarily unavailable; safe to retry with backoff. **Retry:** Usually safe to retry with exponential backoff and jitter.

### Suggested client defaults

- Send the API key using the `x-api-key` header on every request.
- On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user.
- On `402`, surface an actionable billing message rather than blind retries.

## Examples

### TypeScript SDK

```typescript
import { SocialFetchClient } from "@socialfetch/sdk";

const client = new SocialFetchClient({
  apiKey: process.env.SOCIALFETCH_API_KEY!,
});

const result = await client.twitter.getCommunity({
  url: "https://x.com/elonmusk/status/2044990537145753894",
});

if (!result.ok) {
  console.error(result.error);
} else {
  console.log(result.value.data);
}
```

### Node.js

```javascript
const response = await fetch(
  "https://api.socialfetch.dev/v1/twitter/communities?url=https://x.com/elonmusk/status/2044990537145753894",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY",
    }
  }
);

const data = await response.json();
console.log(data);
```

### cURL

```bash
curl "https://api.socialfetch.dev/v1/twitter/communities?url=https://x.com/elonmusk/status/2044990537145753894" \
  -H "x-api-key: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.get(
    "https://api.socialfetch.dev/v1/twitter/communities?url=https://x.com/elonmusk/status/2044990537145753894",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()
print(data)
```