Skip to main content
GET
/
v1
/
scrape
/
twitter
/
community
Community
curl --request GET \
  --url https://api.sociavault.com/v1/scrape/twitter/community \
  --header 'X-API-Key: <api-key>'
{
  "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="
}
💳 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

success
boolean
required
Example:

true

__typename
string
required
Example:

"Community"

is_member
boolean
required
Example:

false

name
string
required
Example:

"The First Thousand"

role
string
required
Example:

"NonMember"

rest_id
string
required
Example:

"1926186499399139650"

actions
object
required
description
string
required
Example:

"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
object
required
join_policy
string
required
Example:

"Open"

created_at
integer
required
Example:

1748073622931

rules
object[]
required
members_facepile_results
object[]
required
member_count
integer
required
Example:

1896

id
string
required
Example:

"Q29tbXVuaXR5OjE5MjYxODY0OTkzOTkxMzk2NTA="