Overview
Communities: Read an X Community: its metadata and rules, its member and moderator rosters, its own post timeline including the pinned post, and the inverse relation, every community a given account belongs to. These are pooled reads served by our account pool, so the four fields that describe the CALLER's own relationship to a community (role, can_join, is_pinned, viewer_relationship_type) always come back null.
Read an X Community: its metadata and rules, its member and moderator rosters, its own post timeline including the pinned post, and the inverse relation, every community a given account belongs to. These are pooled reads served by our account pool, so the four fields that describe the CALLER's own relationship to a community (role, can_join, is_pinned, viewer_relationship_type) always come back null.
This category has 7 endpoints. Each is a pay-per-call REST endpoint with bearer auth, JSON in and out.
| Method | Path | Cost | Description |
|---|---|---|---|
GET | /community/info | $0.0008 | Metadata, rules and banners for one X Community. |
GET | /community/members | $0.0008 | Page through a community's member roster, each row carrying that member's role. |
GET | /community/moderators | $0.0008 | Page through a community's moderators and admins. |
GET | /community/tweets | $0.0008 | Page through a community's post timeline, with the pinned post returned separately. |
GET | /community/memberships | $0.0008 | List every community a given account belongs to. |
GET | /community/about | $0.0008 | A community's moderators and a members preview, as full profiles. |
GET | /community/search | $0.0008 | Search X Communities by keyword. |
Community Info
Metadata, rules and banners for one X Community.
Community Members
Page through a community's member roster, each row carrying that member's role.
Community Moderators
Page through a community's moderators and admins.
Community Tweets
Page through a community's post timeline, with the pinned post returned separately.
Community Memberships
List every community a given account belongs to.
Community About
A community's moderators and a members preview, as full profiles.
Community Search
Search X Communities by keyword.
Grok Config GET
Read the Grok settings for the account behind your session: whether X has enabled Grok for it, the reasons if not, and the model options it is allowed to choose between. Grok eligibility belongs to the X account rather than to us, so this runs as your session and not off our pool. Call it once before your first chat request. Billed at $0.0008 per call. Cost: $0.0008 per call.
Community Info GET
Look up a single X Community by its numeric id and get back its name, description, member count, join policy, primary topic, posted rules and both banners. This endpoint returns the REDUCED form of the Community object: eight of its 24 fields come back empty here and are populated by Community Memberships instead, which the response table marks field by field. Billed at $0.0008 per call. Cost: $0.0008 per call.