xAPIs.dev
API Reference · v2
Free Tools{ }OpenAPI YAMLGet API key
API Reference / Community / Get community info

Get community info

GET/twitter/community/info1 credit

Return details for a Twitter Community, including name, description, and member counts. The sample response below is captured from the live API. List endpoints paginate with `has_next_page` and `next_cursor`.

Authentication required
Send your key in the x-api-key header. Requests without a valid key return 401.

Query parameters

community_id
stringrequired
The numeric ID of the community.

Response fields

community_infoobject
Community details: name, description, counts and rules.
statusstring
Request status: "success" or "error".
msgstring
Status message from the upstream.
community_info.namestring
Community name.
community_info.descriptionstring
Community description.
Request
curl https://v2.xapis.dev/twitter/community/info \
  -G --data-urlencode "community_id=1493446837214187523" \
  -H "x-api-key: $XAPIS_KEY"
Response200 OK
application/json
{
  "community_info": {
    "id": "1493446837214187523",
    "name": "Build in Public",
    "description": "Share what you're working on. Get feedback. Help each other move forward. – Sponsored by bolt.new ⚡",
    "question": "What are you working on?",
    "member_count": 261970,
    "moderator_count": 6,
    "created_at": "Tue Feb 15 04:47:27 +0000 2022",
    "join_policy": "Open",
    "invites_policy": "MemberInvitesAllowed",
    "is_nsfw": false,
    "is_pinned": false,
    "role": "NonMember",
    "primary_topic": {
      "id": "603",
      "name": "Entrepreneurship"
    },
    "banner_url": "https://pbs.twimg.com/community_banner_img/1915033378811772928/KdaKUaRP?format=png&name=orig",
    "search_tags": [],
    "rules": [
      {
        "id": "1493447542045958144",
        "name": "Share what you're working on",
        "description": "Don't be scared to share unfinished work"
      }
    ],
    "creator": {
      "id": "641633",
      "name": "Marc Köhlbrugge",
      "screen_name": "marckohlbrugge",
      "location": "",
      "url": "https://t.co/QVn818Sinw",
      "description": "🚧 https://t.co/aMZ4K3azU0 🏠 https://t.co/1KH3Ex4L2r 🤑 https://t.co/z2G662Uvhl 👀 https://t.co/LtA…",
      "email": null,
      "protected": false,
      "verified": false,
      "followers_count": 84806,
      "following_count": 926,
      "friends_count": 926,
      "favourites_count": 36334,
      "statuses_count": 49226,
      "media_tweets_count": 4787,
      "created_at": "Mon Jan 15 23:55:33 +0000 2007",
      "profile_banner_url": "https://pbs.twimg.com/profile_banners/641633/1781378883",
      "profile_image_url_https": "https://pbs.twimg.com/profile_images/1857124042433572864/iMivVaYP_normal.jpg",
      "can_dm": false,
      "isBlueVerified": true
    },
    "admin": {
      "id": "641633",
      "name": "Marc Köhlbrugge",
      "screen_name": "marckohlbrugge",
      "location": "",
      "url": "https://t.co/QVn818Sinw",
      "description": "🚧 https://t.co/aMZ4K3azU0 🏠 https://t.co/1KH3Ex4L2r 🤑 https://t.co/z2G662Uvhl 👀 https://t.co/LtA…",
      "email": null,
      "protected": false,
      "verified": false,
      "followers_count": 84806,
      "following_count": 926,
      "friends_count": 926,
      "favourites_count": 36334,
      "statuses_count": 49226,
      "media_tweets_count": 4787,
      "created_at": "Mon Jan 15 23:55:33 +0000 2007",
      "profile_banner_url": "https://pbs.twimg.com/profile_banners/641633/1781378883",
      "profile_image_url_https": "https://pbs.twimg.com/profile_images/1857124042433572864/iMivVaYP_normal.jpg",
      "can_dm": false,
      "isBlueVerified": true
    },
    "members_preview": [
      {
        "id": "641633",
        "name": "Marc Köhlbrugge",
        "screen_name": "marckohlbrugge",
        "location": "",
        "url": "https://t.co/QVn818Sinw",
        "description": "🚧 https://t.co/aMZ4K3azU0 🏠 https://t.co/1KH3Ex4L2r 🤑 https://t.co/z2G662Uvhl 👀 https://t.co/LtA…",
        "email": null,
        "protected": false,
        "verified": false,
        "followers_count": 84806,
        "following_count": 926,
        "friends_count": 926,
        "favourites_count": 36334,
        "statuses_count": 49226,
        "media_tweets_count": 4787,
        "created_at": "Mon Jan 15 23:55:33 +0000 2007",
        "profile_banner_url": "https://pbs.twimg.com/profile_banners/641633/1781378883",
        "profile_image_url_https": "https://pbs.twimg.com/profile_images/1857124042433572864/iMivVaYP_normal.jpg",
        "can_dm": false,
        "isBlueVerified": true
      }
    ]
  },
  "status": "success",
  "msg": "success"
}
base url · https://v2.xapis.dev
Ready to call Get community info?