/twitter/communities

POST /api/twitter/communities

Price: 1 credit

Twitter Get Community

How to use it

Entry point for a single Twitter community. Accepts a community ID or a community URL.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• community string required — Community ID or community URL (examples: "1471580197908586507", "https://x.com/i/communities/1471580197908586507")

Response

• @type string (default: "TwitterCommunity")
• id string required
• name string required
• url string required
• description string nullable
• member_count integer nullable
• created_at integer nullable
• image string nullable
• topic string nullable
• join_policy string nullable
• role string nullable
• is_nsfw boolean (default: false)
• is_member boolean (default: false)
• facepile_urls array (default: [])
• trending_hashtags array (default: [])
• rules array (default: [])
  • @type string (default: "TwitterCommunityRule")
  • id string required
  • name string required
  • description string nullable
• creator object nullable
  • @type string (default: "TwitterUser")
  • internal_id string required
  • rest_id string required
  • name string required
  • alias string required
  • url string required
  • description string nullable
  • location string nullable
  • follower_count integer nullable
  • following_count integer nullable
  • tweet_count integer nullable
  • listed_count integer nullable
  • favorites_count integer nullable
  • media_count integer nullable
  • image string nullable
  • banner_url string nullable
  • verified boolean (default: false)
  • verified_type string nullable
  • is_blue_verified boolean (default: false)
  • created_at integer nullable
  • professional object nullable
    • @type string (default: "TwitterUserProfessional")
    • rest_id string required
    • professional_type string required
    • categories array nullable
  • verification_info object nullable
    • @type string (default: "TwitterUserVerification")
    • is_identity_verified boolean (default: false)
    • verified_since string nullable
    • reason_description string nullable
  • profile_urls array (default: [])
    • @type string (default: "TwitterUrl")
    • display_url string required
    • expanded_url string required
    • url string required
    • indices array nullable
  • mentions array (default: [])
    • @type string (default: "TwitterUserMention")
    • screen_name string required
    • url string required
  • birthdate object nullable
    • @type string (default: "TwitterUserBirthdate")
    • day integer required
    • month integer required
    • year integer nullable
    • visibility string (default: "")
    • year_visibility string (default: "")
    • timestamp integer nullable
  • is_profile_translatable boolean (default: false)
  • has_hidden_subscriptions boolean (default: false)
  • can_highlight_tweets boolean (default: false)
  • highlighted_tweets_count integer (default: 0)
  • user_seed_tweet_count integer (default: 0)
  • premium_gifting_eligible boolean (default: false)
  • creator_subscriptions_count integer (default: 0)

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Community not found. Verify the community ID or URL. Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.