Get User Highlights
tweetapi_user_highlightsFetches one page of posts a user added to their profile Highlights tab; paginate with the returned cursor. Use it to read X Premium highlights for a numeric user ID.
Instructions
Fetch one page of the posts a user has added to the Highlights tab of their profile. Highlights are an X Premium feature, so most accounts return an empty page. Read-only. Needs a TweetAPI API key and makes one TweetAPI request per call, usually costing 1 unit; each result includes a cost estimate. Returns one page: to get the next one, call again with cursor set to this result's completeness.nextCursor.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | completeness.nextCursor from the previous page. Omit it for the first page. | |
| userId | Yes | Numeric user ID. This tool does not look up usernames; call tweetapi_user_by_username first if you only have a username or profile link. | |
| responseFormat | No | full (default) returns TweetAPI's JSON unchanged. compact keeps full post text, IDs, links, original dates, counts, and cursors but drops bulky fields; output.fieldsOmitted lists what was dropped. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cost | Yes | ||
| mode | Yes | ||
| tool | Yes | ||
| notice | Yes | ||
| output | Yes | ||
| result | Yes | ||
| endpoint | Yes | ||
| usageDocs | No | ||
| pagination | No | Pagination exactly as TweetAPI returned it. | |
| statusCode | Yes | ||
| retrievedAt | Yes | When the MCP server received this response (ISO 8601). Not the post or profile date, and not a promise that X's data was fresh at that moment. | |
| completeness | Yes | ||
| resolvedInput | No | Identifiers the MCP server parsed from links or @handles before calling TweetAPI. |