User Highlights
/tw-v2/user/highlights1 API unit per call · How billing works
Description
Retrieve the posts a user has added to the Highlights tab of their profile. Returns a paginated timeline of posts.
Usage notes
Highlights are an X Premium feature, so most accounts return an empty page. Pages hold up to 20 posts, and a short page does not mean the end: keep passing nextCursor until it is null. Set sortBy to MostLiked for X's "Sort by: Most liked" order, and send the same sortBy on every page. A user with only a few Highlights can get them all on one page, with both cursors null.
A request costs one API unit. 400, 401, 403, 409, 422, 429 and 5xx errors are free; a 404 is billed.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| user | string | required | Unique Twitter user ID (e.g., '10017528') |
| cursorstringoptional | string | optional | Pagination cursor from the previous response's nextCursor. Omit for the first page. |
| sort | string | optional | Order of the posts: Recent (default) or MostLiked (X's Sort by: Most liked). Send the same value on every page. |
Code Examples
const params = new URLSearchParams({
userId: '10017528'
});
const response = await fetch(`https://api.tweetapi.com/tw-v2/user/highlights?${params}`, {
method: 'GET',
headers: {
'X-API-Key': 'YOUR_API_KEY'
}
});
const data = await response.json();
console.log(data);
Response
Success Response (200 OK)
The example shows the main fields. The Tweet Object reference describes every field of a tweet, including fullText, entities and the raw card values.
Synthetic example:
{
"data": [
{
"id": "2000000000000000021",
"conversationId": "2000000000000000021",
"text": "Sample highlighted post",
"displayTextRange": [
0,
23
],
"author": {
"id": "1000000000000000902",
"username": "sample_user_00002",
"name": "Sample User",
"bio": "Sample bio",
"location": "Sample City",
"website": null,
"pinnedTweetIds": [],
"avatar": "https://example.com/images/sample-avatar.jpg",
"banner": "https://example.com/images/sample-banner.jpg",
"profileImageShape": null,
"verified": false,
"isBlueVerified": false,
"verifiedType": null,
"verifiedSince": null,
"isIdentityVerified": false,
"isProtected": false,
"possiblySensitive": false,
"profileInterstitialType": null,
"withheldInCountries": [],
"professional": null,
"businessAccount": null,
"creatorSubscriptionsCount": 0,
"hasHiddenSubscriptions": false,
"highlightsInfo": null,
"hasGraduatedAccess": false,
"isProfileTranslatable": false,
"hasCustomTimelines": false,
"isTranslator": false,
"affiliatesHighlightedLabel": null,
"defaultProfile": false,
"defaultProfileImage": false,
"followerCount": 1200,
"followingCount": 34,
"tweetCount": 560,
"listedCount": 0,
"mediaCount": 78,
"favoritesCount": 90,
"createdAt": "2023-01-02T00:00:00.000Z"
},
"source": null,
"type": "tweet",
"replyTo": null,
"quotedTweet": null,
"reactionContext": null,
"retweetedTweet": null,
"likeCount": 1,
"retweetCount": 0,
"replyCount": 0,
"quoteCount": 0,
"bookmarkCount": 0,
"viewCount": 0,
"media": null,
"poll": null,
"card": null,
"article": null,
"hashtags": [],
"mentions": [],
"urls": [],
"symbols": [],
"possiblySensitive": false,
"limitedActions": null,
"hasAIGeneratedMedia": false,
"isPaidPromotion": false,
"isEdited": false,
"editControl": null,
"isTranslatable": false,
"lang": "en",
"translatedText": null,
"hasBirdwatchNotes": false,
"birdwatchPivot": null,
"conversationControl": null,
"isPromoted": false,
"promotedMetadata": null,
"createdAt": "2026-11-02T12:00:00.000Z",
"place": null,
"communityId": null,
"communityResults": null
}
],
"pagination": {
"nextCursor": "NEXT_CURSOR",
"prevCursor": null
}
}Each item is a full post object.
Most accounts have no Highlights, so the page is often empty:
{
"data": [],
"pagination": {
"nextCursor": null,
"prevCursor": null
}
}Errors
Errors return { statusCode, message } with a non-2xx HTTP status.
An unknown user returns 404 and a suspended user returns 403. An invalid userId or sortBy returns 400.
{
"statusCode": 400,
"message": "Request validation failed"
}TweetAPI is a third-party API and is not affiliated with X Corp.