Skip to main content
GET https://xquik.com/api/v1/x/communities/{id}/info Use the X communities API to resolve one community. Then read its members, moderators, rules, or tweets. Keep its numeric ID for later requests.

Validate an X community before extraction

Check community details for every numeric community ID. Confirm the community name, description, creator, join policy, rules, and banner. Do this before requesting members or tweets. An export then cannot use the wrong X community. Keep the returned community ID as a string. Store the creator and moderator details separately from the member count. Membership totals can change while the community identity remains stable. Use the rules and join policy to give analysts the correct context. They describe how the X (Twitter) community operates. They do not replace member rows, moderator profiles, or community tweets. After validation, choose the smallest matching route. Fetch member profiles for audience review. Fetch moderators to review who runs the community. Fetch recent tweets to review posts and engagement. Use saved extraction jobs to produce CSV, JSON, or XLSX output.

Choose the right X (Twitter) community API

Start with community details when the numeric ID needs validation. Then choose the route that matches the records you need.

Community details

Get the name, description, creator, rules, policies, and banner. Keep member and moderator counts with the record.

Community members

Retrieve member profiles with usernames, bios, verification, follower counts, and cursor pagination.

Community tweets

Retrieve recent tweets, authors, replies, reposts, likes, quotes, media, and cursor pages.

Keyword search

Search one community for matching tweets. Keep the query and cursor with each page.

Moderator profiles

Retrieve the moderator list, which is smaller than the member list.

Saved exports

Run a community extraction to save CSV, JSON, or XLSX output.
Use member routes for profile rows. Use tweet routes for posts and engagement counts. Use extraction jobs to save CSV, JSON, or XLSX output.

When to read community metadata

Use this route for community metadata, rules, policies, and counts. It returns one community record, not member profiles or tweet rows. Use member and tweet routes for those collections.
1 credit per call · All plans from $0.00012/creditDirect MPP at USD 0.00015 per call
Use GET /x/communities/{id}/info when a workflow needs one community profile row. Fetch it before member exports, moderator review, content routing, or CRM enrichment. Store community_id, community_name, description, member_count, moderator_count, policy fields, creator, banner_url, created_at, primary_topic_name, and rule_count.

Qualify a community before collecting profiles or tweets

Read community metadata before starting a member or tweet export. A mistyped community ID would otherwise send results into the wrong project. Confirm community.id and community.name first. Save both values with the planned member or tweet export. Names can change. The numeric ID stays the same across later member and tweet pages. Review description and primary_topic for research relevance. Keep this classification separate from tweet text. Community metadata describes the space, while tweet routes return individual posts. Check join_policy and invites_policy before planning member collection. Do not infer either policy from member counts. Store the returned values exactly, including missing values. Use member_count to estimate roster size. Use moderator_count only to see how many people moderate. Neither count replaces the paginated member or moderator routes. Review is_nsfw before sharing banners, descriptions, or tweets. Follow the receiving system’s content rules. Keep API responses unchanged. Capture every community rule with its ID, name, and description. Keep the returned order. Do not merge several rules into one undocumented summary. Finish the qualification record with these decisions.
  • Continue to member profiles, moderator profiles, tweets, or keyword search.
  • Stop because the community ID or subject is incorrect.
  • Require a reviewer before handling sensitive community content.
  • Refresh metadata later because a required field is unavailable.
This route qualifies the community. Collection routes return member profiles and community tweets.

Create a community qualification manifest

Create one manifest before starting member, moderator, or tweet collection. Use the returned community ID as its stable key. Record these community facts.
  • Record the community name and description.
  • Record member and moderator counts.
  • Record join and invitation policies.
  • Record primary topic and content-sensitivity state.
  • Record the creator profile and banner URL when returned.
  • Record every rule ID, name, and description.
Add a retrieval timestamp in UTC. Expect community names, counts, rules, and policies to change. The timestamp explains which metadata guided later collection. Keep planned collection work in a separate manifest section. Name the exact routes for members, moderators, unfiltered tweets, or keyword matches. Include the intended page size, search query, and output format when applicable. Keep member profiles and tweets in their own exports. Link those exports by community ID and manifest ID. Stop when the returned community ID differs. Require a review when the name or topic conflicts with the project brief. Record the decision. Do not pick another community without a record.

Use community metadata to choose the next route

The member route returns paginated profile rows. See Community Members. The member count only estimates the expected roster size. Use Community Moderators for moderator profiles. The moderator count does not expose those usernames or user IDs. Use Community Tweets for the unfiltered community timeline. Keep community ID and cursor with every page. Use Community Search for matching tweets. Keep the exact keyword expression and sort mode with every result. Keep the creator object to show who owns the community. Export that profile as a member only when the member route returns it. Export it as a moderator only when the moderator route returns it.

Detect community metadata changes

Compare manifests by stable community ID. Never join them by community name. Report name, description, topic, policy, rule, and sensitivity changes separately. A member-count change does not prove a policy change. Track community rules and tweets independently. Store both retrieval times and both returned values. Keep absent fields. Never invent policy or count defaults. Refresh this endpoint before long-running exports. Attach the newest manifest ID to every new collection job. Do not edit earlier manifests. Audits need them.

Path parameters

Query parameters

Headers

Response

200 OK

400 Invalid community ID

{ "error": "invalid_community_id" } The community ID is empty or invalid.

401 Unauthenticated

Missing or invalid API key.

402 Payment required

Account keys get account options. Guest keys get guest top-up only. Anonymous calls get a direct MPP WWW-Authenticate: Payment challenge. They also get a guest wallet creation action. No checkout starts automatically. Confirm any payment action.

404 Community not found

Xquik could not resolve the community. Check the community ID.

502 X API unavailable

The read service returned an error. Retry after a short delay.

429 Rate limit exceeded

You exceeded your tier rate limit. Wait for the Retry-After header before retrying.

424 Dependency failed

Opted-in normalized v1 calls return 424 when the read service fails.
Next steps. Community Members to list members, or Community Tweets to browse posts.

Response examples

  • 400 { "error": "invalid_input", "message": "Invalid input. Check the request body." }
  • 401 { "error": "unauthenticated", "message": "Authentication required. Provide a valid API key or bearer token." }
  • 402 { "error": "insufficient_credits", "message": "Insufficient credits. Top up or subscribe to continue." }
  • 403 { "error": "api_key_paused", "message": "This API key is paused. Resume it at dashboard.xquik.com/api-keys to use it again." }
  • 404 { "error": "not_found", "message": "Resource not found." }
  • 424 { "error": "x_api_unavailable", "message": "X data source temporarily unavailable. Try again later." }
  • 429 { "error": "rate_limit_exceeded", "message": "Too many requests. Try again later.", "retryAfter": 60 }
  • 502 { "error": "x_api_unavailable", "message": "X data source temporarily unavailable. Try again later." }
  • 503 { "error": "x_api_unavailable", "message": "Xquik is busy right now. Retry shortly." }