Skip to main content
GET
Community
💳 1 credit per request

Authorizations

X-API-Key
string
header
required

API key for authentication. Format: sk_live_xxxxxxxxxxxxx

Get your API key from the Dashboard.

Query Parameters

url
string
required

Community URL

Example:

"https://x.com/i/communities/1926186499399139650"

Response

Successful response

Key Response Fields:

  • rest_id: Unique community ID
  • name: Community display name
  • description: Community description text
  • join_policy: Membership policy (Open, RestrictedJoin, etc.)
  • created_at: Unix timestamp (ms) of community creation
  • member_count: Total number of community members
  • role: Your role in the community (e.g. NonMember)
  • is_member: Boolean indicating membership status
  • creator_results.result.core.screen_name: @handle of the community creator
  • rules[0].name / description: Community rules
  • custom_banner_media.media_info.original_img_url: Banner image URL
  • is_nsfw: Whether the community is marked NSFW