DataNavoAPI / APIS / X

X community profile

X community profile: inspect inputs, community fields, pagination and limits, then run a local simulated request.

LOCAL SIMULATIONAll displayed records are fictional fixtures. Live APIs, payments and external email are disabled.中文版 ↗
01

What this capability does

X community profile uses /v1/x/communities/get; GET returns data.item with community objects.

This is a local simulation. Program-generated samples are not live platform data and do not establish provider availability.

  • Capability: x.communities.get
  • Pagination: no cursor pagination; do not repeatedly request another page.
02

Input contract

Inspect meanings, examples and conditional rules for the selected method. view and fields control the response without changing the TEST unit price.

  • Only send fields defined for this method; unknown fields are rejected before execution.
MethodFieldTypeRequirementMeaningEnum or boundExample
GETidstringRequiredCommunity ID, a string of digits—"1493446837214187523"
GETviewstringOptional / conditionalHow much of each item: compact (the most used fields, long text cut short), standard, or full (adds `ext`).["compact","standard","full"]—
GETfieldsarrayOptional / conditionalReturn only these fields of each item, by path (`author.name`).maxItems: 64—
03

Try it locally

Use demo to inspect the fields, then explicitly select simulated with a customer test key to exercise settlement. Never put a customer key in a URL.

json
{
  "capability": "x.communities.get",
  "method": "GET",
  "params": {
    "id": "1493446837214187523"
  }
}
04

Output fields and interpretation

The community object permits missing or null values; do not replace missing measurements with zero. This table shows the main structure; the object reference covers nested fields.

FieldTypeMeaningSource scope
idstring | nullID; pass it unchanged to the endpoints that get the community and list its postsX (Twitter)
namestring | nullName of the communityX (Twitter)
urlstring | nullLink that opens the communityX (Twitter)
descriptionstring | nullWhat the community says it is aboutX (Twitter)
avatar_urlstring | nullThe community's icon (standard view and up)X (Twitter)
nsfwboolean | nullWhether it is marked not safe for work (standard view and up)X (Twitter)
created_atstring | nullWhen the community was created (standard view and up)X (Twitter)
metricsobject | nullCommunity countsX (Twitter)
metrics.membersinteger | nullMembersX (Twitter)
approximatearray | nullWhich numbers of this item are approximate or lower bounds; absent when all are exactX (Twitter)
approximate[].fieldstring | nullPath of the field, such as metrics.viewsX (Twitter)
approximate[].kindstring | nullApproximate, or a lower boundX (Twitter)
extobject—X (Twitter)
ext.moderatorsinteger | nullNumber of moderators (full view)X (Twitter)
ext.join_policystring | nullHow people join, as the platform words it (Open, for one) (full view)X (Twitter)
ext.topicstring | nullThe community's main topic; null when none is set (full view)X (Twitter)
ext.cover_urlstring | nullThe community's banner image (full view)X (Twitter)
05

Unavailable fields

These published contract notes describe the capability boundary; fixtures do not establish live availability.

FieldReason
avatar_urlplatform
06

Limits and checks

A successful request does not establish full coverage. Preserve the request ID, observation time, parameters and cursor, and inspect the returned items before analysis.

Local simulation uses TEST credits only. Real provider calls, real payments and external email are disabled. Historical reference-site prices are not DataNavoAPI prices.

  • Verify media URLs, counts and optional fields individually.
TRY THE CONTRACT

Clear inputs. Inspectable output.

Each click runs a local fixture. Advanced JSON inputs are checked against the selected method. Editing does not execute a request.

Copying does not execute. CLI quote is read-only and needs a local customer TEST key. Configure MCP in demo mode first. GET and POST batches both return only fictional local fixtures.

Download contract example (no execution) ↗

For TEST budgets, Key scopes or failure scenarios, open the account console. Customer sandbox ↗