X (Twitter)Social mediaX Communities API
X community profile API
A community by ID: name, description, member count, when it was created, and under ext its moderators, how people join and its topic.
GEThttps://api.okdata.online/v1/x/communities/get
Also calledtwitter communityx community info
- Price
- $0.0004
- per call · bad parameters are free
- Returns
- One Community
- as data.item
- If a call fails
- Charged once
- When a data source fails, the next one is tried. A call that reached a source is charged once even if it fails; bad parameters are free.
- Status
- preview
- It may still change; any change is announced beforehand.
Parameters
| Name | Type | Description |
|---|---|---|
idrequired | string | The community ID (the digits after /i/communities/ in its link). |
view | stringbriefcompactstandardfull | How much of each object comes back. brief: IDs, title, the first 100 characters of the text, link, time and the main counts, for scanning a list (then get what you need by ID). compact leaves out empty fields and cuts long text at 500 characters. full adds platform-specific fields under ext. |
fields | string[] | Fields to keep, by path (author.name), to save tokens. In a query string: comma-separated. |
cursor, view and fields work the same on every endpoint: how requests work.
Request
cURL
curl -G "https://api.okdata.online/v1/x/communities/get" \
-H "Authorization: Bearer $OKDATA_API_KEY" \
--data-urlencode 'id=1493446837214187523'Python
import os
import requests
resp = requests.get(
"https://api.okdata.online/v1/x/communities/get",
headers={"Authorization": f"Bearer {os.environ['OKDATA_API_KEY']}"},
params={"id": "1493446837214187523"},
timeout=60,
)
body = resp.json()
if body["code"] != "ok":
raise RuntimeError(f"{body['code']}: {body['message']} (charged: {body['charged']})")
row = body["data"]["item"]
print(row)
print("cost: $" + body["meta"]["billing"]["amount"])TypeScript
const url = new URL('https://api.okdata.online/v1/x/communities/get');
url.searchParams.set('id', "1493446837214187523");
const res = await fetch(url, {
headers: {
Authorization: `Bearer ${process.env.OKDATA_API_KEY}`,
},
});
const body = await res.json();
if (body.code !== 'ok') throw new Error(`${body.code}: ${body.message}`);
const row = body.data.item;
console.log(row);
console.log('cost: $' + body.meta.billing.amount);MCPtools/call
{
"name": "call",
"arguments": {
"capability": "x.communities.get",
"id": "1493446837214187523"
}
}Response
{
"code": "ok",
"request_id": "0f6c2a8e-4b1d-4e0a-9a51-3c7d2b9e1f20",
"data": {
"item": {
"id": null,
"name": null,
"url": null,
"description": null,
"avatar_url": null,
"nsfw": null,
"created_at": null,
"metrics": {
"members": null
}
}
},
"warnings": [],
"meta": {
"capability": "x.communities.get",
"result_status": "complete",
"billing": {
"amount": "0.0004",
"currency": "USD",
"balance_after": "9.9996"
},
"unavailable": {},
"cached": false,
"replayed": false,
"fetched_at": "2026-11-11T08:00:00Z"
}
}Try it
New accounts get $0.10 of credit, no card needed: 250 calls to this endpoint.Start free
This sends a real call to https://api.okdata.online and is billed as usual: at most $0.0004, also when the data source comes back empty, not found or failed. Bad parameters are never charged. Your key goes only to that address and is never stored on this site.
Returned fields
data.item is one Community.
| Field | Type | View | Description |
|---|---|---|---|
id | string | compact | ID; pass it as is to the endpoints that take one. |
name | string | compact | Name of the community. |
url | string | null | compact | Link to the community. |
description | string | null | compact | What the community says it is about.Long text: view=compact may shorten it. |
avatar_url | string | null | standard | Icon of the community. |
nsfw | boolean | null | standard | Whether it is marked as adult content. |
Show all 9 fieldsHide the other 3
| Field | Type | View | Description |
|---|---|---|---|
created_at | string | null | standard | When the community was created. |
metrics | CommunityMetrics | compact | Counts at fetch time. |
ext | object | full | Platform-specific extras. Only returned with view=full. |
The view column is the smallest view a field comes back in: compact returns only compact fields, standard adds the standard ones, full returns everything. The default is standard.
When it is charged
One call costs $0.0004 and returns one community. 1,000 lookups cost $0.40. A lookup that reached the data source is charged even when it is not found or the source fails; calls stopped before reaching a source are free.
Data comes back$0.0004 per call
Bad parameters, too little balance, a paused endpointFree
| When | Charge |
|---|---|
| Most one call costs | $0.0004 |
| An empty answer | $0.0004 |
| Not found (the platform has no such item) | $0.0004 |
| The data source fails or times out | $0.0004 |
| Bad parameters, too little balance, a paused endpoint | Free |
| Resent with the same Idempotency-Key within 24 hours | Free when the kept result comes back |
A call that reached the data source costs $0.0004 even when the answer is empty, not found or a failure of the source; a call stopped before that, such as for bad parameters, is free.
Prices from price book 53dd8ce13c359590. Every price on this platform →
Common errors
Every error has the same shape and says whether it was charged. The ones this endpoint can return:
| HTTP | Code | Meaning | Charged |
|---|---|---|---|
| 400 | invalid_params | A parameter is missing, has the wrong type or value, or the method is wrong. problems lists each one; param names the first.Retry: after a fix | no |
| 401 | unauthorized | The key is missing, malformed, revoked, disabled or expired (reason says which when known).Retry: no | no |
| 402 | insufficient_balance | The balance (available) cannot cover the most this call could cost (required).Retry: after a fix | no |
| 404 | not_found | The post, account or page does not exist or is not public. When the data source billed the lookup, or the endpoint's charge_when_not_found is above 0, this answer is charged: the body then says charged: true and amount.Retry: no | once, if it reached a data source |
| 429 | rate_limited | The account sent too many requests this minute (reason: rate) or has too many calls running (reason: concurrency).Retry: yes | no |
| 500 | settlement_unknown | The data came back, but the charge could not be confirmed.Retry: with the same Idempotency-Key | unknown until looked up |
| 502 | upstream_failed | Every data source for this endpoint failed on this request. If a source billed the attempt, it is charged once at the endpoint's price (charged: true and amount); otherwise nothing is charged.Retry: yes | once, if it reached a data source |
| 503 | capability_paused | This endpoint is paused right now; nothing ran.Retry: yes | no |
| 504 | timeout | The data did not come back in time. If the request had reached a data source that bills it, it is charged once at the endpoint's price (charged: true and amount); otherwise the hold is released.Retry: yes | once, if it reached a data source |
Questions
How much does the X community profile API cost?
One call costs $0.0004 and returns one community. 1,000 lookups cost $0.40. A lookup that reached the data source is charged even when it is not found or the source fails; calls stopped before reaching a source are free.
Do I need a X (Twitter) account, cookies or a QR login?
No. You send only your okdata API key. The data is public data from X (Twitter); nothing is fetched with your own X (Twitter) account.
Am I charged when a call fails?
Yes, once, when the call reached the data source: an empty answer, a not_found, a failure or a timeout of the source costs one call (one item for per-item endpoints), and the error says charged: true with amount. Calls refused before reaching a source, such as bad parameters or a low balance, cost nothing.
What if X (Twitter) does not show a field?
The field is null, and meta.unavailable names it with the reason: platform (the platform never shows it) or capability (we cannot fetch it yet).
Use it in your AI
Paste this into Claude, ChatGPT, Cursor or any agent that can open a web page. It reads this endpoint’s page and calls it with your key.
Read https://okdata.online/apis/x/communities/get.md, then call this endpoint for me through okdata; my key is in the OKDATA_API_KEY environment variable. Use X community profile and sum up what comes back.
With the MCP server connected, just ask: Use X community profile and sum up what comes back.
Same data on other platforms
The same kind of data from other platforms, in the same Community shape:
All 20 X (Twitter) endpoints
Main X (Twitter) endpoints
- X post detail$0.0003/call
- X post search$0.002/call
- X account profile$0.0004/item
- X account posts$0.002/call
- X trending topics$0.009/call
- X post replies$0.002/call
- X post quotes$0.0003/item
- X post retweeters$0.002/call
- X article$0.002/call
- X thread$0.0003/item
- X account search$0.0004/item
- X account followers$0.0001/item
- X account following$0.0001/item
- X account mentions$0.0003/item
Names and ID
- Name
- X community profile API
- Short name
- X community profile
- ID
x.communities.get- Endpoint
GET /v1/x/communities/get- Category
- Social media
- Group
- X Communities API
- Also called
- twitter community, x community info
- Data type
- Community profile API
- Returns
- Community: 9 fields