Skip to main content

​
What it does

Returns a paginated list of active stories for a TikTok user. Stories expire after 24 hours and include both images and videos with engagement data.

​
Tool details

FieldValue
Tool nametiktok.get_user_stories
PlatformTikTok
REST endpointGET /v1/tiktok/users/{username}/stories
Result typeCollection tool

​
Parameters

ParameterSourceTypeRequiredDescription
usernamepathstringYesTikTok username (with or without @ symbol)
countqueryintegerNoNumber of stories to fetch (maximum: 35) Default: 4.
cursorquerystringNoPagination cursor Default: 0.
projection_presetsharedstringNoOptional. Defaults to minimal. Allowed values: full, minimal, identity, engagement, content.
data_fieldssharedstring[]NoOptional. Adds top-level keys from data on top of the selected projection_preset.
item_fieldssharedstring[]NoOptional. Adds keys from data.orderedItems[] on top of the selected projection_preset.

​
Example

{
  "name": "tiktok.get_user_stories",
  "arguments": {
    "username": "khaby.lame",
    "count": 4,
    "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",
  "endTime",
  "viewCount",
  "likeCount",
  "commentCount",
  "repostCount",
  "shareCount",
  "saveCount",
  "attributedTo",
  "duration",
  "attachment",
  "image",
  "preview",
  "audio"
]

​
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.