Get user highlights

What it does

Returns the public Highlights tab selection as visible to not logged in users. This feed is not guaranteed to be chronological.

Tool details

Field	Value
Tool name	`x_get_user_highlights`
Platform	X
REST endpoint	`GET /v1/x/users/{username}/highlights`
Result type	Collection tool

Parameters

Parameter	Type	Required	Description
`username`	`string`	Yes	X username (with or without @ symbol)
`count`	`integer`	No	Maximum number of highlighted posts to return from the public profile selection (maximum: 100) Default: `40`.
`projection_preset`	`string`	No	Defaults to `minimal`. Allowed values: `full`, `minimal`, `identity`, `engagement`, `content`.
`data_fields`	`string[]`	No	Adds top-level keys from `data` on top of the selected `projection_preset`.
`item_fields`	`string[]`	No	Adds keys from `data.orderedItems[]` on top of the selected `projection_preset`.

Example

{
  "name": "x_get_user_highlights",
  "arguments": {
    "username": "khaby.lame",
    "count": 40,
    "projection_preset": "minimal",
    "data_fields": [
      "orderedItems",
      "nextCursor",
      "cursor",
      "itemCount"
    ],
    "item_fields": [
      "entityId",
      "published",
      "content",
      "url",
      "viewCount"
    ]
  }
}

Available data fields

@context
type
partOf
totalItems
cursor
nextCursor
next
itemCount
orderedItems

Available item fields

type
id
url
entityId
content
published
likeCount
replyCount
viewCount
repostCount
quoteCount
saveCount
contentFormat
isEdited
attributedTo
inReplyTo
quote
image
attachment
tag

Response notes

Successful calls return a JSON object with a top-level data field and, when available, metadata.creditsUsed and metadata.creditsRemaining. See response format, pagination, and credits.

MCP

Tools

Chat

Automation

Code

What it does

Tool details

Parameters

Example

Available data fields

Available item fields

Response notes

​What it does

​Tool details

​Parameters

​Example

​Available data fields

​Available item fields

​Response notes

What it does

Tool details

Parameters

Example

Available data fields

Available item fields

Response notes