Skip to content
All X APIs
Posts & videosX (Twitter / 推特)Community · Detail

X community detail

Read the public profile, size, topic, and rules snapshot for one X Community.

POST/v1/x/communities/detail

Chinese name: X Community 详情 · 社区 · 详情 读取一个公开 X Community 的资料、规模、主题与规则快照。
x.communities.detail@v1

Price per call

¥0.01/ call

Complete and confirmed empty results are charged; partial results and failures are not.

Current statusAvailableChecking live status
Checking live status

Try it

Sign in and run one real call. The result and charge appear right here.

Security check

Loading the security check…

Checking live execution status…

Execution result

// Result

Request parameters

community_idstringrequired

pattern: "^[0-9]{1,20}$"

Example: "1992144505747931156"

Request JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "community_id": {
      "type": "string",
      "pattern": "^[0-9]{1,20}$"
    }
  },
  "required": [
    "community_id"
  ],
  "additionalProperties": false
}

Code samples

Install the SDK with npm i @dataxapi/sdk or pip install dataxapi, and put your API key in the DATAXAPI_API_KEY environment variable.

curl -X POST https://api.dataxapi.com/v1/x/communities/detail \
  -H "Authorization: Bearer $DATAXAPI_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"community_id":"1992144505747931156"}'

Response example

200 · application/json
{
  "code": 200,
  "request_id": "req_example_x_communities_detail",
  "message": "success",
  "data": {
    "item": {
      "id": "1992144505747931156",
      "name": "Life AI Community",
      "description": "A public AI community.",
      "question": "",
      "member_count": 26937,
      "moderator_count": 1,
      "created_at": "Sat Nov 22 08:13:57 +0000 2025",
      "join_policy": "Open",
      "invites_policy": "MemberInvitesAllowed",
      "is_nsfw": false,
      "primary_topic": {
        "id": "302",
        "name": "Artificial Intelligence"
      },
      "banner_url": "https://pbs.twimg.com/community_banner_img/example?format=jpg&name=orig",
      "search_tags": [
        "AI"
      ],
      "rules": [
        {
          "id": "1992144505794068841",
          "name": "Be kind and respectful.",
          "description": null
        }
      ],
      "creator": {
        "id": "1767861355951112192",
        "username": "LifeNetwork_AI",
        "name": "LIFE AI",
        "description": "Public community profile",
        "location": "",
        "avatar_url": "https://pbs.twimg.com/profile_images/life-ai.jpg",
        "header_url": "https://pbs.twimg.com/profile_banners/life-ai.jpg",
        "created_at": "Wed Mar 13 10:34:21 +0000 2024",
        "verified": false,
        "verified_type": null,
        "followers_count": 63420,
        "following_count": 355,
        "posts_count": 994,
        "media_count": 489
      }
    }
  },
  "page": {
    "next_cursor": null
  },
  "warnings": [],
  "meta": {
    "listing_id": "x.communities.detail",
    "version": "v1",
    "catalog_release_id": "catalog-production-2026-09-19.b069be57",
    "price_book_version": "pricebook-production-2026-09-19.4487e352",
    "result_status": "complete",
    "charged_amount": "0.01",
    "balance_after": "1.00",
    "currency": "CNY"
  }
}
Response fields
codenumber
const: 200
request_idstring
messagestring
const: "success"
dataobject
pageobject
warningsarray
metaobject
Response JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "const": 200
    },
    "request_id": {
      "type": "string"
    },
    "message": {
      "type": "string",
      "const": "success"
    },
    "data": {
      "type": "object",
      "properties": {
        "item": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "pattern": "^[0-9]{1,20}$"
                },
                "name": {
                  "type": "string"
                },
                "description": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "question": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "member_count": {
                  "anyOf": [
                    {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 9007199254740991
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "moderator_count": {
                  "anyOf": [
                    {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 9007199254740991
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "created_at": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "join_policy": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "invites_policy": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "is_nsfw": {
                  "anyOf": [
                    {
                      "type": "boolean"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "primary_topic": {
                  "anyOf": [
                    {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string"
                        },
                        "name": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "id",
                        "name"
                      ],
                      "additionalProperties": false
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "banner_url": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "search_tags": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "rules": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "pattern": "^[0-9]{1,20}$"
                      },
                      "name": {
                        "type": "string"
                      },
                      "description": {
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {
                            "type": "null"
                          }
                        ]
                      }
                    },
                    "required": [
                      "id",
                      "name",
                      "description"
                    ],
                    "additionalProperties": false
                  }
                },
                "creator": {
                  "anyOf": [
                    {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string"
                        },
                        "username": {
                          "type": "string"
                        },
                        "name": {
                          "anyOf": [
                            {
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ]
                        },
                        "description": {
                          "anyOf": [
                            {
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ]
                        },
                        "location": {
                          "anyOf": [
                            {
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ]
                        },
                        "avatar_url": {
                          "anyOf": [
                            {
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ]
                        },
                        "header_url": {
                          "anyOf": [
                            {
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ]
                        },
                        "created_at": {
                          "anyOf": [
                            {
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ]
                        },
                        "verified": {
                          "anyOf": [
                            {
                              "type": "boolean"
                            },
                            {
                              "type": "null"
                            }
                          ]
                        },
                        "verified_type": {
                          "anyOf": [
                            {
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ]
                        },
                        "followers_count": {
                          "anyOf": [
                            {
                              "type": "integer",
                              "minimum": 0,
                              "maximum": 9007199254740991
                            },
                            {
                              "type": "null"
                            }
                          ]
                        },
                        "following_count": {
                          "anyOf": [
                            {
                              "type": "integer",
                              "minimum": 0,
                              "maximum": 9007199254740991
                            },
                            {
                              "type": "null"
                            }
                          ]
                        },
                        "posts_count": {
                          "anyOf": [
                            {
                              "type": "integer",
                              "minimum": 0,
                              "maximum": 9007199254740991
                            },
                            {
                              "type": "null"
                            }
                          ]
                        },
                        "media_count": {
                          "anyOf": [
                            {
                              "type": "integer",
                              "minimum": 0,
                              "maximum": 9007199254740991
                            },
                            {
                              "type": "null"
                            }
                          ]
                        }
                      },
                      "required": [
                        "id",
                        "username",
                        "name",
                        "description",
                        "location",
                        "avatar_url",
                        "header_url",
                        "created_at",
                        "verified",
                        "verified_type",
                        "followers_count",
                        "following_count",
                        "posts_count",
                        "media_count"
                      ],
                      "additionalProperties": false
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              },
              "required": [
                "id",
                "name",
                "description",
                "question",
                "member_count",
                "moderator_count",
                "created_at",
                "join_policy",
                "invites_policy",
                "is_nsfw",
                "primary_topic",
                "banner_url",
                "search_tags",
                "rules",
                "creator"
              ],
              "additionalProperties": false
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "item"
      ],
      "additionalProperties": false
    },
    "page": {
      "type": "object",
      "properties": {
        "next_cursor": {
          "type": "null"
        }
      },
      "required": [
        "next_cursor"
      ],
      "additionalProperties": false
    },
    "warnings": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "listing_id": {
          "type": "string",
          "const": "x.communities.detail"
        },
        "version": {
          "type": "string",
          "const": "v1"
        },
        "catalog_release_id": {
          "type": "string",
          "minLength": 1
        },
        "price_book_version": {
          "type": "string",
          "minLength": 1
        },
        "result_status": {
          "type": "string",
          "enum": [
            "complete",
            "empty",
            "partial"
          ]
        },
        "charged_amount": {
          "type": "string"
        },
        "balance_after": {
          "type": "string"
        },
        "currency": {
          "type": "string",
          "const": "CNY"
        }
      },
      "required": [
        "listing_id",
        "version",
        "catalog_release_id",
        "price_book_version",
        "result_status",
        "charged_amount",
        "balance_after",
        "currency"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "code",
    "request_id",
    "message",
    "data",
    "page",
    "warnings",
    "meta"
  ],
  "additionalProperties": false
}

Usage notes

Good for

  • Use it when you have a Community ID and need its public topic, size, join policy, and rules.

Not for

  • Do not use it for viewer membership, private content, governance quality, or activity causality.

Known limitations

  • Viewer-relative role and membership fields are intentionally excluded.
  • A mismatched returned Community ID fails closed.
  • Each call reads one Community's public profile snapshot; members and Tweets are separate APIs.

Billing

¥0.01 per call. Complete and confirmed empty results are charged; partial results and failures are not.

See all pricing →