Get an X (Twitter) community

Try in Playground

Retrieve a public X community by URL: the raw CommunityQuery object with name, description, member count, join policy, rules, creator, banners, member face pile and trending hashtags.

GET/v1/twitter/communityx-api-key

Headers

Get your API key

x-api-keystringrequiredheader

Your ScrapeAtlas customer key. Create one on /account/ and set SCRAPEATLAS_API_KEY.

Query parameters

urlstringrequiredquery

Community URL in the form https://x.com/i/communities/{id} (twitter.com accepted).

max 2048 chars

Examplehttps://x.com/i/communities/2000000000000000001

Response fields

__typenamestring

Always included.

rest_idstring

Always included.

namestring

Always included.

descriptionstring

Always included.

member_countinteger

Always included.

≥ 0

requestIdstring

Request correlation identifier.

HTTP attempts (guest activation plus GraphQL reads, including the shared retry), decoded bytes and duration for the operation.

accounting.upstreamRequestsinteger

Always included.

≥ 0

accounting.responseBytesinteger

Always included.

≥ 0

accounting.durationMsnumber

Always included.

≥ 0

successboolean

True when usable data is returned; inspect status and coverage for omissions.

statusenum

success, partial, failed, or challenged. HTTP 200 can be partial.

one of: success, partial

sourceUrlstring

Canonical x.com URL of the profile, tweet or community.

absolute HTTPS URL

fetchedAtstring

UTC retrieval time.

Complete means the pinned GraphQL document was returned without omitted entries; warnings name every skipped entry kind or cap.

coverage.sourcestring

Always included.

coverage.completeboolean

Always included.

coverage.warningsstring[]

Always included.

HTTP 200 returns the success variant. Check status: partial means usable data with warnings, and failed or challenged requests carry a failure object described in Errors & responses.

Error codes

HTTP	failure.code	Meaning
400	`invalid_request`	Missing, duplicate, malformed or unsupported parameters, handles or URLs.
401	`unauthorized`	Invalid API key.
404	`not_found`	Unknown handle, tweet or community.
403	`restricted_page`	The account is suspended or unavailable, or the tweet is withheld, protected or age-restricted for logged-out visitors.
429	`upstream_rate_limited`	X rate limited guest activation or the GraphQL read.
502	`upstream_challenged`	X refused the guest token or the request (status challenged).
502	`operation_unavailable`	X no longer serves the pinned persisted query for this operation.
502	`unsafe_redirect`	X answered the API request with a redirect.
502	`unsupported_page`	The GraphQL result is missing, mismatched or structurally unsupported.
502	`response_too_large`	The response exceeded 4 MiB.
502	`payload_too_complex`	The response exceeded the JSON depth or node limits.
502	`request_limit`	The upstream request budget was exhausted.
502	`upstream_error`	Network failure or HTTP 5xx after the single retry.
503	`busy`	All retrieval slots are busy.
504	`timeout`	The 20-second deadline elapsed.

Code example

curl "https://api.scrapeatlas.com/v1/twitter/community?url=https%3A%2F%2Fx.com%2Fi%2Fcommunities%2F2000000000000000001" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/twitter/community?url=https%3A%2F%2Fx.com%2Fi%2Fcommunities%2F2000000000000000001",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data.status, data);

type Result = {
  status: "success" | "partial" | "failed" | "challenged";
  requestId: string;
  [field: string]: unknown;
};

const response = await fetch(
  "https://api.scrapeatlas.com/v1/twitter/community?url=https%3A%2F%2Fx.com%2Fi%2Fcommunities%2F2000000000000000001",
  {
    headers: {
      "x-api-key": process.env.SCRAPEATLAS_API_KEY!
    }
  }
);

const data = (await response.json()) as Result;
if (data.status === "failed" || data.status === "challenged") {
  throw new Error(`X (Twitter) request failed: ${data.requestId}`);
}
console.log(data);

import requests

response = requests.get(
    "https://api.scrapeatlas.com/v1/twitter/community",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "url": "https://x.com/i/communities/2000000000000000001"
    },
    timeout=60,
)
data = response.json()
print(data["status"], data)

package main

import (
	"encoding/json"
	"fmt"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.scrapeatlas.com/v1/twitter/community?url=https%3A%2F%2Fx.com%2Fi%2Fcommunities%2F2000000000000000001", nil)
	req.Header.Set("x-api-key", "YOUR_API_KEY")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
	fmt.Println(data["status"], data)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var client = HttpClient.newHttpClient();
        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.scrapeatlas.com/v1/twitter/community?url=https%3A%2F%2Fx.com%2Fi%2Fcommunities%2F2000000000000000001"))
            .GET()
            .header("x-api-key", "YOUR_API_KEY")
            .build();
        var response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Use your sa_live_… customer key at https://api.scrapeatlas.com.

Responses

Successful result. Synthetic example validated against the runtime contract.

{
  "success": true,
  "__typename": "Community",
  "actions": {
    "join_action_result": {
      "__typename": "CommunityJoinAction"
    }
  },
  "created_at": 1700000000000,
  "creator_results": {
    "result": {
      "__typename": "User",
      "id": "VXNlcjoxMjM0NTY3ODkw",
      "rest_id": "1234567890",
      "core": {
        "screen_name": "example"
      },
      "verification": {
        "verified": false
      }
    }
  },
  "custom_banner_media": {},
  "default_banner_media": {
    "media_info": {
      "original_img_url": "https://pbs.twimg.com/community_banner_img/1/example?format=jpg&name=orig"
    }
  },
  "description": "An example community",
  "id": "Q29tbXVuaXR5OjIwMDAwMDAwMDAwMDAwMDAwMDE=",
  "invites_result": {
    "__typename": "CommunityInvitesUnavailable",
    "reason": "ViewerNotMember"
  },
  "is_member": false,
  "is_nsfw": false,
  "join_policy": "Open",
  "join_requests_result": {
    "__typename": "CommunityJoinRequestsUnavailable",
    "reason": "ViewerNotMember"
  },
  "member_count": 42,
  "members_facepile_results": [],
  "name": "Example Community",
  "rest_id": "2000000000000000001",
  "role": "NonMember",
  "rules": [
    {
      "id": "Q29tbXVuaXR5UnVsZTox",
      "rest_id": "1",
      "name": "Be kind",
      "description": "Example rule"
    }
  ],
  "trending_hashtags_slice": {
    "items": []
  },
  "status": "success",
  "requestId": "00000000-0000-4000-8000-000000000001",
  "fetchedAt": "2026-09-12T12:00:00.000Z",
  "coverage": {
    "source": "public_api",
    "complete": true,
    "warnings": []
  },
  "accounting": {
    "upstreamRequests": 2,
    "responseBytes": 3600,
    "durationMs": 520
  },
  "sourceUrl": "https://x.com/i/communities/2000000000000000001"
}

Missing, duplicate, malformed or unsupported parameters, handles or URLs.

{
  "requestId": "9d2f1c0a-6b1e-4c7d-9a8e-2f3b4c5d6e7f",
  "accounting": {
    "upstreamRequests": 0,
    "responseBytes": 0,
    "durationMs": 0
  },
  "success": false,
  "status": "failed",
  "failure": {
    "code": "invalid_request",
    "message": "Invalid request: missing, duplicate, unsupported or malformed parameters."
  }
}