Felo API PlatformFelo API Platform
v0.1.0-beta
OpenAPI 3.1.0

Get Community Info By Id

Server:https://openapi.felo.ai
Client Libraries

Twitter / X

​

Query public users, posts, communities and trends.

Get Community Info By Id

​

Get metadata for an X Community by its numeric community ID — name, description, member count, and access rules. Use this to qualify a community before pulling its members or posts. Returns the object under community_info. To discover communities by topic, search their posts with get_twitter_community_tweets_all.

Query Parameters
  • community_id
    Type: string
    required

    ID of the community

Responses
  • 200
    Type: object · CommunityInfoResponse

    Community info response

    • community_info
      Type: object · CommunityInfo
      • admin
        Type: object · User
        • automatedBy
          Type: string
        • canDm
          Type: boolean
        • coverPicture
          Type: string
        • createdAt
          Type: string
        • description
          Type: string
        • favouritesCount
          Type: integer

          Integer numbers.

        • followers
          Type: integer

          Integer numbers.

        • following
          Type: integer

          Integer numbers.

        • hasCustomTimelines
          Type: boolean
        • id
          Type: string
        • isAutomated
          Type: boolean
        • isBlueVerified
          Type: boolean
        • isTranslator
          Type: boolean
        • location
          Type: string
        • mediaCount
          Type: integer

          Integer numbers.

        • message
          Type: string
        • name
          Type: string
        • pinnedTweetIds
          Type: array string[]
        • possiblySensitive
          Type: boolean
        • profile_bio
          Type: object
          • description
            Type: string
          • entities
            Type: object
            • description
              Type: object
              • urls
                Type: array object[]
                • display_url
                  Type: string
                • expanded_url
                  Type: string
                • indices
                  Type: array integer[]
                • url
                  Type: string
            • url
              Type: object
              • urls
                Type: array object[]
                • display_url
                  Type: string
                • expanded_url
                  Type: string
                • indices
                  Type: array integer[]
                • url
                  Type: string
        • profilePicture
          Type: string
        • statusesCount
          Type: integer

          Integer numbers.

        • type
          Type: string
        • unavailable
          Type: boolean
        • unavailableReason
          Type: string
        • url
          Type: string
        • userName
          Type: string
        • verifiedType
          Type: string
        • withheldInCountries
          Type: array string[]
      • banner_url
        Type: string nullable
      • created_at
        Type: string nullable
      • creator
        Type: object · User
        • automatedBy
          Type: string
        • canDm
          Type: boolean
        • coverPicture
          Type: string
        • createdAt
          Type: string
        • description
          Type: string
        • favouritesCount
          Type: integer

          Integer numbers.

        • followers
          Type: integer

          Integer numbers.

        • following
          Type: integer

          Integer numbers.

        • hasCustomTimelines
          Type: boolean
        • id
          Type: string
        • isAutomated
          Type: boolean
        • isBlueVerified
          Type: boolean
        • isTranslator
          Type: boolean
        • location
          Type: string
        • mediaCount
          Type: integer

          Integer numbers.

        • message
          Type: string
        • name
          Type: string
        • pinnedTweetIds
          Type: array string[]
        • possiblySensitive
          Type: boolean
        • profile_bio
          Type: object
          • description
            Type: string
          • entities
            Type: object
            • description
              Type: object
              • urls
                Type: array object[]
                • display_url
                  Type: string
                • expanded_url
                  Type: string
                • indices
                  Type: array integer[]
                • url
                  Type: string
            • url
              Type: object
              • urls
                Type: array object[]
                • display_url
                  Type: string
                • expanded_url
                  Type: string
                • indices
                  Type: array integer[]
                • url
                  Type: string
        • profilePicture
          Type: string
        • statusesCount
          Type: integer

          Integer numbers.

        • type
          Type: string
        • unavailable
          Type: boolean
        • unavailableReason
          Type: string
        • url
          Type: string
        • userName
          Type: string
        • verifiedType
          Type: string
        • withheldInCountries
          Type: array string[]
      • description
        Type: string nullable
      • id
        Type: string nullable
      • invites_policy
        Type: string nullable
      • is_nsfw
        Type: boolean
      • is_pinned
        Type: boolean
      • join_policy
        Type: string nullable
      • member_count
        Type: integer

        Integer numbers.

      • members_preview
        Type: array object[]
        Empty object
      • moderator_count
        Type: integer

        Integer numbers.

      • name
        Type: string nullable
      • primary_topic
        Type: object
        • id
          Type: string nullable
        • name
          Type: string nullable
      • question
        Type: string nullable
      • role
        Type: string nullable
      • rules
        Type: array object[]
        • description
          Type: string
        • id
          Type: string
        • name
          Type: string
      • search_tags
        Type: array string[]
    • msg
      Type: string
    • status
      Type: string enum
      values
      • success
      • error
    application/json
  • 400

    The request could not be processed. Check the request parameters.

  • 401

    A valid Felo API key is required.

  • 402

    The request cannot proceed because a billing requirement is not met.

  • 403

    The account is not permitted to perform this operation.

  • 429

    A request or spending limit has been reached.

  • 502

    The service could not complete the request.

  • 503

    The API or billing service is temporarily unavailable.

  • 504

    The service timed out while processing the request.

  • default

    The operation failed. Keep the response request ID when contacting Felo support.

Request Example for get/v1/beta/twitter/community/info
curl 'https://openapi.felo.ai/v1/beta/twitter/community/info?community_id=' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "community_info": {
    "id": "string",
    "name": "string",
    "description": "string",
    "question": "string",
    "member_count": 1,
    "moderator_count": 1,
    "created_at": "string",
    "join_policy": "string",
    "invites_policy": "string",
    "is_nsfw": true,
    "is_pinned": true,
    "role": "string",
    "primary_topic": {
      "id": "string",
      "name": "string"
    },
    "banner_url": "string",
    "search_tags": [
      "string"
    ],
    "rules": [
      {
        "id": "string",
        "name": "string",
        "description": "string"
      }
    ],
    "creator": {
      "type": "string",
      "userName": "string",
      "url": "string",
      "id": "string",
      "name": "string",
      "isBlueVerified": true,
      "verifiedType": "string",
      "profilePicture": "string",
      "coverPicture": "string",
      "description": "string",
      "location": "string",
      "followers": 1,
      "following": 1,
      "canDm": true,
      "createdAt": "string",
      "favouritesCount": 1,
      "hasCustomTimelines": true,
      "isTranslator": true,
      "mediaCount": 1,
      "statusesCount": 1,
      "withheldInCountries": [
        "string"
      ],
      "possiblySensitive": true,
      "pinnedTweetIds": [
        "string"
      ],
      "isAutomated": true,
      "automatedBy": "string",
      "unavailable": true,
      "message": "string",
      "unavailableReason": "string",
      "profile_bio": {
        "description": "string",
        "entities": {
          "description": {
            "urls": [
              {
                "display_url": "string",
                "expanded_url": "string",
                "indices": [
                  1
                ],
                "url": "string"
              }
            ]
          },
          "url": {
            "urls": [
              {
                "display_url": "string",
                "expanded_url": "string",
                "indices": [
                  1
                ],
                "url": "string"
              }
            ]
          }
        }
      }
    },
    "admin": {
      "type": "string",
      "userName": "string",
      "url": "string",
      "id": "string",
      "name": "string",
      "isBlueVerified": true,
      "verifiedType": "string",
      "profilePicture": "string",
      "coverPicture": "string",
      "description": "string",
      "location": "string",
      "followers": 1,
      "following": 1,
      "canDm": true,
      "createdAt": "string",
      "favouritesCount": 1,
      "hasCustomTimelines": true,
      "isTranslator": true,
      "mediaCount": 1,
      "statusesCount": 1,
      "withheldInCountries": [
        "string"
      ],
      "possiblySensitive": true,
      "pinnedTweetIds": [
        "string"
      ],
      "isAutomated": true,
      "automatedBy": "string",
      "unavailable": true,
      "message": "string",
      "unavailableReason": "string",
      "profile_bio": {
        "description": "string",
        "entities": {
          "description": {
            "urls": [
              {
                "display_url": "string",
                "expanded_url": "string",
                "indices": [
                  1
                ],
                "url": "string"
              }
            ]
          },
          "url": {
            "urls": [
              {
                "display_url": "string",
                "expanded_url": "string",
                "indices": [
                  1
                ],
                "url": "string"
              }
            ]
          }
        }
      }
    },
    "members_preview": [
      {}
    ]
  },
  "status": "success",
  "msg": "string"
}
Get Community Info By Id