Skip to content

Community

GET /v1/twitter/community

Retrieves details about a Twitter/X Community by URL. Returns the community name, description, rest_id, join_policy, created_at, member_count, rules, and creator_results with the creator's profile. Also includes members_facepile_results with avatar images of recent members.

Authentication

All requests require the x-api-key header. Get your key at scrapecreators.com.

Query Parameters

NameTypeRequiredDescriptionExample
urlstringyesCommunity URLhttps://x.com/i/communities/1926186499399139650

Example Request

curl

bash
curl 'https://api.scrapecreators.com/v1/twitter/community?url=https://x.com/i/communities/1926186499399139650' \
  -H 'x-api-key: $SCRAPECREATORS_API_KEY'

Node / TypeScript

js
const params = new URLSearchParams({ url: 'https://x.com/i/communities/1926186499399139650' });
const res = await fetch(`https://api.scrapecreators.com/v1/twitter/community?${params}`, {
  headers: { 'x-api-key': process.env.SCRAPECREATORS_API_KEY }
});
const data = await res.json();
console.log(data);

Python

python
import os, requests
r = requests.get(
    'https://api.scrapecreators.com/v1/twitter/community',
    headers={'x-api-key': os.environ['SCRAPECREATORS_API_KEY']},
    params={'url': 'https://x.com/i/communities/1926186499399139650'},
)
r.raise_for_status()
print(r.json())

CLI

bash
scrapecreators twitter community --help

Example Response

json
{
  "success": true,
  "__typename": "Community",
  "is_member": false,
  "name": "The First Thousand",
  "role": "NonMember",
  "rest_id": "1926186499399139650",
  "actions": {
    "join_action_result": {
      "__typename": "CommunityJoinActionUnavailable"
    },
    "id": "Q29tbXVuaXR5QWN0aW9uczoxOTI2MTg2NDk5Mzk5MTM5NjUw"
  },
  "description": "This community is for creators and builders who are growing to their first 1,000 followers. Give insights, build your brand, and grow a loyal audience.",
  "creator_results": {
    "result": {
      "__typename": "User",
      "id": "VXNlcjoxOTIxMzY4NDU0NDQ5MjAxMTUy",
      "is_blue_verified": true,
      "core": {
        "screen_name": "CanaCarson"
      },
      "verification": {
        "verified": false
      }
    },
    "id": "VXNlclJlc3VsdHM6MTkyMTM2ODQ1NDQ0OTIwMTE1Mg=="
  },
  "join_policy": "Open",
  "created_at": 1748073622931,
  "rules": [
    {
      "rest_id": "1926189963793609186",
      "description": "This isn’t the space to drop ChatGPT engineered empty platitudes",
      "name": "No Empty Platitudes",
      "id": "Q29tbXVuaXR5UnVsZToxOTI2MTg5OTYzNzkzNjA5MTg2"
    }
  ],
  "members_facepile_results": [
    {
      "result": {
        "__typename": "User",
        "avatar": {
          "image_url": "https://pbs.twimg.com/profile_images/1944871269775601664/Ho7tiGd2_normal.jpg"
        },
        "id": "VXNlcjoxOTIxMzY4NDU0NDQ5MjAxMTUy"
      },
      "id": "VXNlclJlc3VsdHM6MTkyMTM2ODQ1NDQ0OTIwMTE1Mg=="
    }
  ],
  "member_count": 1896,
  "id": "Q29tbXVuaXR5OjE5MjYxODY0OTkzOTkxMzk2NTA="
}

Credits

Most ScrapeCreators endpoints consume 1 credit per successful response. Some heavier endpoints (transcripts, AI-driven enrichment, ad detail lookups) may cost more. Check GET /v1/credit-balance for your remaining balance.

Errors

StatusMeaningAction
200Success.Use the JSON payload.
400Invalid or missing parameter.Verify required parameters and value format.
401Missing or invalid x-api-key.Pass a valid API key in the header.
402Out of credits.Top up at scrapecreators.com or wait for plan reset.
404Resource not found or private.Confirm the handle, URL, or id and that the resource is public.
429Rate limited.Backoff and retry with exponential delay.
500Server error or upstream platform failure.Retry with backoff; report persistent errors to support.