Get an X (Twitter) user’s highlights

Try in Playground

Retrieve the posts an X account selected for its Highlights tab, with each tweet’s author, text, media, engagement counters and original URL. Use trim=true for compact tweet records.

GET/v1/twitter/user-highlightsx-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.

max 16 chars

Exampleexample

trimenumquery

true returns each tweet as rest_id, views, source, legacy, quoted_status_result (when present) and url.

one of: true, false

Response fields

requestIdstring

Request correlation identifier.

HTTP attempts (guest activation, profile lookup, highlights read and 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 highlights URL for the requested profile.

absolute HTTPS URL

fetchedAtstring

UTC retrieval time.

The source is public_api and the result order is source_order; inspect status and warnings for the returned selection.

coverage.sourcestring

Always included.

coverage.completeboolean

Always included.

coverage.warningsstring[]

Always included.

coverage.orderstring

Always included.

The posts an account selected for its Highlights tab, with the author, text, media, engagement counters and original URL for each tweet.

up to 200 items

tweets.__typenamestringoptional

Optional.

tweets.rest_idstring

Always included.

Optional.

Always included.

tweets.core.user_results.resultobject

Always included.

tweets.legacy.full_textstring

Always included.

tweets.legacy.id_strstring

Always included.

tweets.legacy.created_atstring

Always included.

tweets.legacy.user_id_strstring

Always included.

tweets.urlstring

Always included.

absolute HTTPS URL

tweets.viewsobjectoptional

Optional.

tweets.sourcestringoptional

Optional.

tweets.quoted_status_resultobjectoptional

Optional.

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 operation’s response byte budget was exceeded.
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, HTTP 5xx after the single retry, or X returned the post without its author and text.
503	`busy`	All retrieval slots are busy.
504	`timeout`	The operation’s deadline elapsed.

Code example

curl "https://api.scrapeatlas.com/v1/twitter/user-highlights?handle=example" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/twitter/user-highlights?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/user-highlights?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/user-highlights",
    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/user-highlights?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/user-highlights?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,
  "tweets": [
    {
      "__typename": "Tweet",
      "core": {
        "user_results": {
          "result": {
            "__typename": "User",
            "id": "VXNlcjoxMjM0NTY3ODkw",
            "rest_id": "1234567890",
            "affiliates_highlighted_label": {},
            "has_graduated_access": true,
            "is_blue_verified": true,
            "legacy": {
              "can_dm": false,
              "created_at": "Mon Jan 02 03:04:05 +0000 2012",
              "description": "Example bio",
              "followers_count": 120,
              "friends_count": 30,
              "name": "Example Person",
              "profile_image_url_https": "https://pbs.twimg.com/profile_images/1/example_normal.jpg",
              "screen_name": "example",
              "statuses_count": 50,
              "verified": false
            },
            "profile_image_shape": "Circle",
            "tipjar_settings": {}
          }
        }
      },
      "edit_control": {
        "edit_tweet_ids": [
          "1000000000000000001"
        ],
        "editable_until_msecs": "1700000000000",
        "is_edit_eligible": false,
        "edits_remaining": "5"
      },
      "is_translatable": false,
      "legacy": {
        "bookmark_count": 1,
        "bookmarked": false,
        "created_at": "Tue Feb 03 04:05:06 +0000 2026",
        "conversation_id_str": "1000000000000000001",
        "display_text_range": [
          0,
          12
        ],
        "entities": {
          "hashtags": [],
          "symbols": [],
          "timestamps": [],
          "urls": [],
          "user_mentions": []
        },
        "favorite_count": 2,
        "favorited": false,
        "full_text": "Example text",
        "is_quote_status": false,
        "lang": "en",
        "possibly_sensitive": false,
        "possibly_sensitive_editable": true,
        "quote_count": 0,
        "reply_count": 0,
        "retweet_count": 0,
        "retweeted": false,
        "user_id_str": "1234567890",
        "id_str": "1000000000000000001"
      },
      "quick_promote_eligibility": {
        "eligibility": "IneligibleNotProfessional"
      },
      "rest_id": "1000000000000000001",
      "source": "<a href=\"https://mobile.twitter.com\" rel=\"nofollow\">Twitter Web App</a>",
      "unmention_data": {},
      "views": {
        "count": "321",
        "state": "EnabledWithCount"
      },
      "url": "https://x.com/example/status/1000000000000000001"
    }
  ],
  "status": "success",
  "requestId": "00000000-0000-4000-8000-000000000001",
  "fetchedAt": "2026-10-06T12:00:00.000Z",
  "coverage": {
    "source": "public_api",
    "order": "source_order",
    "complete": true,
    "warnings": []
  },
  "accounting": {
    "upstreamRequests": 3,
    "responseBytes": 5400,
    "durationMs": 900
  },
  "sourceUrl": "https://x.com/example/highlights"
}

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