Get an X (Twitter) profile

Try in Playground

Retrieve a public X profile by handle: the raw UserByScreenName user object with identity, bio, entities, counters, images, verification and affiliation labels, tip jar, highlights and business fields.

GET/v1/twitter/profilex-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

handlestringrequiredquery

X handle, 1–15 letters, digits or underscores; a leading @ is accepted. Case-insensitive.

max 16 chars

Exampleexample

Response fields

__typenamestring

Always included.

rest_idstring

Always included.

created_at, name and screen_name as X now serialises them.

core.created_atstring

Always included.

core.namestring

Always included.

core.screen_namestring

Always included.

min 1 chars

The account's counters, bio, entities, pinned tweets, banner and flags. created_at, name, screen_name, location and profile_image_url_https are restored into legacy from core, location and avatar (core keys first, location and image last).

legacy.screen_namestring

Always included.

min 1 chars

legacy.namestring

Always included.

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/profile?handle=example" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/twitter/profile?handle=example",
  {
    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/profile?handle=example",
  {
    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/profile",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "handle": "example"
    },
    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/profile?handle=example", 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/profile?handle=example"))
            .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": "User",
  "affiliates_highlighted_label": {},
  "avatar": {
    "image_url": "https://pbs.twimg.com/profile_images/1/example_normal.jpg"
  },
  "business_account": {},
  "core": {
    "created_at": "Mon Jan 02 03:04:05 +0000 2012",
    "name": "Example Person",
    "screen_name": "example"
  },
  "creator_subscriptions_count": 0,
  "dm_permissions": {
    "can_dm": false
  },
  "has_graduated_access": true,
  "has_hidden_subscriptions_on_profile": false,
  "highlights_info": {
    "can_highlight_tweets": true,
    "highlighted_tweets": "0"
  },
  "id": "VXNlcjoxMjM0NTY3ODkw",
  "is_blue_verified": true,
  "is_profile_translatable": false,
  "legacy": {
    "created_at": "Mon Jan 02 03:04:05 +0000 2012",
    "name": "Example Person",
    "screen_name": "example",
    "default_profile": false,
    "default_profile_image": false,
    "description": "Example bio https://t.co/example",
    "entities": {
      "description": {
        "urls": [
          {
            "display_url": "example.test",
            "expanded_url": "https://example.test",
            "url": "https://t.co/example",
            "indices": [
              12,
              35
            ]
          }
        ]
      }
    },
    "fast_followers_count": 0,
    "favourites_count": 10,
    "follow_request_sent": false,
    "followers_count": 120,
    "friends_count": 30,
    "has_custom_timelines": false,
    "is_translator": false,
    "listed_count": 1,
    "media_count": 4,
    "needs_phone_verification": false,
    "normal_followers_count": 120,
    "notifications": false,
    "pinned_tweet_ids_str": [
      "1000000000000000001"
    ],
    "possibly_sensitive": false,
    "profile_banner_url": "https://pbs.twimg.com/profile_banners/1234567890/1",
    "profile_interstitial_type": "",
    "statuses_count": 50,
    "time_zone": "",
    "translator_type": "none",
    "url": "https://t.co/example",
    "utc_offset": 0,
    "withheld_description": "",
    "withheld_scope": "",
    "location": "Example City",
    "profile_image_url_https": "https://pbs.twimg.com/profile_images/1/example_normal.jpg"
  },
  "legacy_extended_profile": {},
  "location": {
    "location": "Example City"
  },
  "media_permissions": {
    "can_media_tag": false
  },
  "parody_commentary_fan_label": "None",
  "privacy": {
    "protected": false
  },
  "profile_image_shape": "Circle",
  "relationship_perspectives": {
    "blocked_by": false,
    "blocking": false,
    "followed_by": false,
    "following": false,
    "muting": false
  },
  "rest_id": "1234567890",
  "super_follow_eligible": false,
  "super_followed_by": false,
  "super_following": false,
  "tipjar_settings": {
    "is_enabled": false
  },
  "user_seed_tweet_count": 0,
  "verification": {
    "verified": false
  },
  "verification_info": {
    "is_identity_verified": false
  },
  "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/example"
}

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."
  }
}