> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# TikHub

> Read supported social and TikHub metadata routes with one TikHub API key. Routes requiring platform cookies, proxies, logins, sessions, device identities, fingerprints, or signatures are excluded.

![TikHub logo](https://mintcdn.com/composio-preview/IA0_SoMcsWt17HEC/images/toolkits/tik_hub.svg?fit=max\&auto=format\&n=IA0_SoMcsWt17HEC\&q=85\&s=82cf04ff69faaf2de1f2263201f164a7)

* **Category:** social & creator data
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 515
* **Triggers:** 0
* **Slug:** `TIK_HUB`
* **Version:** 20261103\_00
* **Instant:** Supported on the latest version. Support varies by tool.

## Tools

> [accordion] Get Bilibili bangumi tab
>
> **Slug:** `TIK_HUB_BILIBILI_APP_FETCH_BANGUMI_TAB`
>
> Get the Bilibili app's bangumi (anime series) tab layout, including the hot entry (title, description), content modules (id, title, style) and region shortcuts (title, icon, url). Takes no input.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bilibili comment reply thread
>
> **Slug:** `TIK_HUB_BILIBILI_APP_FETCH_REPLY_DETAIL`
>
> Get the details of a Bilibili comment thread from its root comment ID plus the video's AV or BV ID, with optional page size and next-offset cursor. Returns the root comment, cursor, uploader info and vote/config data.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **av\_id** `string`
>
> AV ID
>
> **bv\_id** `string`
>
> BV ID
>
> **page\_size** `integer`
>
> Page size
>
> **next\_offset** `integer`
>
> Next page cursor
>
> **root\_comment\_id** `string` *required*
>
> Bilibili root comment ID returned by a video-comments result.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Bilibili all content
>
> **Slug:** `TIK_HUB_BILIBILI_APP_FETCH_SEARCH_ALL`
>
> Search Bilibili (app) across all content types by keyword, with optional sort order and page size. Returns matching result items plus a pagination cursor to pass back as the cursor for the next page.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **order** `integer`
>
> Sort order (0 = overall ranking).
>
> **cursor** `string`
>
> Pagination cursor, leave empty for the first page; for the next page pass back data.pagination.next from the previous response
>
> **keyword** `string` *required*
>
> Search keyword
>
> **page\_size** `integer`
>
> Page size
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert Bilibili BV ID to AV ID
>
> **Slug:** `TIK_HUB_BILIBILI_WEB_BV_TO_AID`
>
> Convert a Bilibili video's BV ID (the BV... string in video URLs) into its numeric AV ID (aid). Returns the AV ID as an integer.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **bv\_id** `string` *required*
>
> Video id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Bilibili user favorite folders
>
> **Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_COLLECT_FOLDERS`
>
> List the public favorite (collection) folders of a Bilibili user by UID. Returns the folder count and a list of folders, whose IDs can be used to list the videos in each folder.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **uid** `string` *required*
>
> User UID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bilibili comment replies
>
> **Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_COMMENT_REPLY`
>
> Get the replies under a specific Bilibili comment, given the video BV ID, the comment's reply ID and a page number. Returns the replies, root comment, uploader info and page details.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **bv\_id** `string` *required*
>
> Video id
>
> **reply\_id** `string` *required*
>
> Bilibili reply ID returned by a comment or reply result.
>
> **page\_number** `integer`
>
> Page number
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bilibili popular videos
>
> **Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_COM_POPULAR`
>
> Get Bilibili's popular (trending) video list, one page at a time via page number. Returns the list of popular videos and a no\_more flag that signals the last page.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **page\_number** `integer`
>
> Page number
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Bilibili videos by keyword
>
> **Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_GENERAL_SEARCH`
>
> Search Bilibili videos by keyword with optional sort order, duration filter, publish-date range (10-digit timestamps), page and page size. Returns result items with total result and page counts.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **page** `integer` *required*
>
> Page number
>
> **order** `string` *required*
>
> Order method
>
> **keyword** `string` *required*
>
> Search keyword
>
> **duration** `integer`
>
> Duration filter
>
> **page\_size** `integer` *required*
>
> Number per page
>
> **pubtime\_end\_s** `integer`
>
> End date (10-digit timestamp)
>
> **pubtime\_begin\_s** `integer`
>
> Start date (10-digit timestamp)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bilibili user ID from share link
>
> **Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_GET_USER_ID`
>
> Resolve a Bilibili user's share link into the numeric user ID (UID). Returns the user ID, which other Bilibili user tools accept as uid.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **share\_link** `string` *required*
>
> User share link
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bilibili trending searches
>
> **Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_HOT_SEARCH`
>
> Get Bilibili's current hot (trending) search keywords, with an optional limit on how many to return. Returns the trending keyword list.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **limit** `integer` *required*
>
> Return number
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bilibili live room details
>
> **Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_LIVE_ROOM_DETAIL`
>
> Get details of a Bilibili live-stream room by room ID, such as its title, description, area (category), live status, start time, online count and attention (follower) count.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **room\_id** `string` *required*
>
> Live room ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bilibili live stream URLs
>
> **Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_LIVE_VIDEOS`
>
> Get the playback stream URLs (durl) of a Bilibili live room by room ID, along with the available and current quality options.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **room\_id** `string` *required*
>
> Live room ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List videos in Bilibili favorite folder
>
> **Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_USER_COLLECTION_VIDEOS`
>
> List the videos in a Bilibili favorite folder by folder ID, one page at a time via page number. Returns the folder info, the video entries (medias) and a has\_more flag.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **folder\_id** `string` *required*
>
> collection folder id
>
> **page\_number** `integer`
>
> Page number
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bilibili user dynamic feed
>
> **Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_USER_DYNAMIC`
>
> Get a Bilibili user's dynamic (activity/post feed) by UID, paged with an optional offset. Returns the feed items, a has\_more flag and the offset to pass for the next page.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **uid** `string` *required*
>
> User UID.
>
> **offset** `string`
>
> offset
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Fetch Bilibili user post videos
>
> **Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_USER_POST_VIDEOS`
>
> Fetch published Bilibili videos with order controls and rich video summaries. Use V2 instead when keyword filtering or page sizes up to 100 are required.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **uid** `string` *required*
>
> Bilibili user UID.
>
> **order** `string ("pubdate" | "click" | "stow")`
>
> Sort by newest publication, most plays, or most favorites.
>
> **page\_size** `integer`
>
> Number of videos per page (1-50).
>
> **page\_number** `integer`
>
> Page number (1-100).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Bilibili user videos (page info)
>
> **Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_USER_POST_VIDEOS_V2`
>
> List a Bilibili user's uploaded videos by user UID, with optional keyword filter, page number and size up to 100. Returns only page metadata (page number, size, total), not video details.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **uid** `string` *required*
>
> User UID.
>
> **keyword** `string`
>
> Keyword, empty returns all
>
> **page\_size** `integer`
>
> Number of videos per page (1-100).
>
> **page\_number** `integer`
>
> Page number, starting at 1.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Fetch Bilibili user profile
>
> **Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_USER_PROFILE`
>
> Get a Bilibili user's public profile by UID: name, avatar, sign (bio), sex, level, birthday, coins, top photo, follow state and live room details when present.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **uid** `string` *required*
>
> Bilibili user UID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bilibili user follower counts
>
> **Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_USER_RELATION_STAT`
>
> Get a Bilibili user's relationship stats by UID: follower count, following count, blacklist count and whisper count.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **uid** `string` *required*
>
> User UID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bilibili video comments
>
> **Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_VIDEO_COMMENTS`
>
> Get the comments on a Bilibili video by BV ID, one page at a time via page number. Returns the comment replies with page info, uploader info and comment-area config.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **bv\_id** `string` *required*
>
> Video id
>
> **page\_number** `integer`
>
> Page number
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bilibili video play info from URL
>
> **Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_VIDEO_PLAY_INFO`
>
> Get playback information for a Bilibili video from its URL, including available qualities and formats and the DASH video/audio stream details.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Video URL
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bilibili video playback URLs
>
> **Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_VIDEO_PLAYURL`
>
> Get the playback stream details for a Bilibili video from its BV ID and page cid, including available qualities and formats, DASH streams and video duration (timelength).
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **cid** `string` *required*
>
> Video cid
>
> **bv\_id** `string` *required*
>
> Video id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bilibili video subtitles
>
> **Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_VIDEO_SUBTITLE`
>
> Get the subtitle tracks of a Bilibili video from its AV ID (aid) and page content ID (cid). Returns each subtitle's language, AI-generated status and subtitle file URL.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **av\_id** `string` *required*
>
> Bilibili AV video ID returned as aid by a video lookup.
>
> **content\_id** `string` *required*
>
> Bilibili page content ID returned as cid for the selected video page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bilibili dynamic details
>
> **Slug:** `TIK_HUB_BILIBILI_WEB_GET_NONVIDEO_DYNAMIC_DETAIL`
>
> Get a Bilibili dynamic (feed post) by dynamic ID. Returns its basic info (type, title, user ID) and engagement statistics such as coin, comment, favorite, forward and like counts.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **dynamic\_id** `string` *required*
>
> Dynamic id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bilibili Video By AV ID And CID
>
> **Slug:** `TIK_HUB_BILIBILI_WEB_GET_VIDEO_BY_AV_ID_AND_CID`
>
> Fetch Bilibili video details by AV ID and CID. The BV variant instead accepts a BV ID.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.002 per request
>
> #### Input Parameters
>
> **av\_id** `string` *required*
>
> Bilibili AV video ID parsed from a video URL or returned as aid by search.
>
> **content\_id** `string` *required*
>
> Bilibili page content ID returned as cid for the selected video page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bilibili Video By BV ID
>
> **Slug:** `TIK_HUB_BILIBILI_WEB_GET_VIDEO_BY_BV_ID`
>
> Fetch Bilibili video details by BV ID. The AV-and-CID variant is a distinct lookup that requires both identifiers.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **bv\_id** `string` *required*
>
> Video id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Bilibili Video Dynamic Engagement
>
> **Slug:** `TIK_HUB_BILIBILI_WEB_GET_VIDEO_DYNAMIC_ENGAGEMENT`
>
> Fetch Bilibili video dynamic details with comment, forward, and like statistics. Use the non-video variant for favorite and coin data on image, text, or article dynamics.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **dynamic\_id** `string` *required*
>
> Dynamic id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin brand hot-search categories
>
> **Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_BRAND_HOT_SEARCH_LIST`
>
> Lists the brand hot-search categories on Douyin (category id and name) plus the banner image and timestamp. Takes no input; use a returned category id with the brand hot-search ranking action.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin brand hot-search ranking
>
> **Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_BRAND_HOT_SEARCH_LIST_DETAIL`
>
> Returns the Douyin brand hot-search ranking for a category ID: each brand with name, logo, rank, rank change, heat and live- streaming status, plus banner and weekly period info.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **category\_id** `integer` *required*
>
> Category id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin hashtag details
>
> **Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_HASHTAG_DETAIL`
>
> Gets details of a Douyin hashtag (challenge) by ch\_id: hashtag name (cha\_name), description, view count, participating user count, create and update time, and the creating author.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **ch\_id** `integer` *required*
>
> Hashtag id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin hashtag videos
>
> **Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_HASHTAG_VIDEO_LIST`
>
> Lists videos posted under a Douyin hashtag by ch\_id, with sort\_type and count options. Each video includes ID, description, author, music and play, like, comment and share counts. Paginate with the returned cursor while has\_more is set.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **ch\_id** `string` *required*
>
> Hashtag id.
>
> **count** `integer`
>
> Number.
>
> **cursor** `integer`
>
> Use 0 for the first page. Reuse data.cursor while data.has\_more is nonzero; stop when data.has\_more is 0.
>
> **sort\_type** `integer`
>
> Sort type.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin hot search list
>
> **Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_HOT_SEARCH_LIST`
>
> Returns the Douyin trending search board (board\_type and board\_sub\_type select the board). Each entry has the search word, hot value, sentence ID, video count, label and event time.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **board\_type** `string`
>
> Board type.
>
> **board\_sub\_type** `string`
>
> Board sub type.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin high-quality video URLs (batch)
>
> **Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_MULTI_VIDEO_HIGH_QUALITY_PLAY_URL`
>
> Gets high-quality original video download URLs for up to 50 Douyin videos at once (comma-separated aweme\_ids, optional region such as CN). Returns per-video URL, content type and file size, plus success and failure counts.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.5 per batch of up to 50 high-quality Douyin video URLs
>
> **Discount:** 50
>
> #### Input Parameters
>
> **region** `string`
>
> Optional, ISO country code (e.g. CN). Pass 'CN' for users in mainland China to get China-region CDN URLs for faster download.
>
> **aweme\_ids** `string` *required*
>
> Video id list, separated by commas, up to 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin video statistics (batch)
>
> **Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_MULTI_VIDEO_STATISTICS`
>
> Gets engagement statistics for several Douyin videos in one call (aweme\_ids). Returns per video the like, play, share and download counts.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.025 per batch of up to 50 Douyin video statistics
>
> #### Input Parameters
>
> **aweme\_ids** `string` *required*
>
> Video id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin music details
>
> **Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_MUSIC_DETAIL`
>
> Gets details of a Douyin music track by music\_id: title, author, album, duration, cover images, play URL, user count and collect count, plus owner information.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **music\_id** `string` *required*
>
> Music id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin hot music chart
>
> **Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_MUSIC_HOT_SEARCH_LIST`
>
> Returns a Douyin music chart selected by chart\_type, listing tracks with title, author, duration, user count and heat. Paginate with the returned cursor.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **cursor** `string`
>
> Use '0' for the first page. Reuse data.cursor as a string while data.has\_more is nonzero; stop when data.has\_more is 0.
>
> **chart\_type** `string`
>
> Chart type.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin videos using a music track
>
> **Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_MUSIC_VIDEO_LIST`
>
> Lists Douyin videos that use a given music track (music\_id). Each video includes ID, description, author, statistics and music info. Paginate with cursor and count while has\_more is set.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **count** `integer`
>
> Number.
>
> **cursor** `integer`
>
> Use 0 for the first page. Reuse data.cursor while data.has\_more is nonzero; stop when data.has\_more is 0.
>
> **music\_id** `string` *required*
>
> Music id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin video details (app)
>
> **Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_ONE_VIDEO`
>
> Gets one Douyin video by aweme\_id using the original app route: description, author, duration, music, hashtags and play, like, comment and share counts. This is the default choice over the v2 and v3 variants.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **aweme\_id** `string` *required*
>
> Video id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin video details by share link (app)
>
> **Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_ONE_VIDEO_BY_SHARE_URL`
>
> Gets one Douyin video from a share link (share\_url): video ID, description, author profile, music, statistics and related video metadata as returned by Douyin.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **share\_url** `string` *required*
>
> Share link
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin video details (app v2)
>
> **Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_ONE_VIDEO_V2`
>
> Gets one Douyin video by aweme\_id using the app v2 route: description, author, duration, music, hashtags and play, like, comment and share counts. Use only if the default app video lookup fails or lacks fields.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **aweme\_id** `string` *required*
>
> Video id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin video or article details (app v3)
>
> **Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_ONE_VIDEO_V3`
>
> Gets a Douyin video or article by aweme\_id using the app v3 route: description, author, duration, music, statistics, and article info when the item is an article. Use only if the default app lookup fails.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **aweme\_id** `string` *required*
>
> Video or Article ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin series details
>
> **Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_SERIES_DETAIL`
>
> Looks up a Douyin series by series\_id. The response model only exposes request metadata (status code and message, log ID, timestamp), not series fields such as title or episode count.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **series\_id** `string` *required*
>
> Series id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin series videos
>
> **Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_SERIES_VIDEO_LIST`
>
> Pages through a Douyin series by series\_id and cursor. The response model exposes only paging and status fields (has\_more, max\_cursor, min\_cursor, status code and message), not the video entries.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **cursor** `integer`
>
> Use 0 for the first page. Reuse data.max\_cursor while data.has\_more is nonzero; stop when data.has\_more is 0.
>
> **series\_id** `string` *required*
>
> Series id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin user liked videos
>
> **Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_USER_LIKE_VIDEOS`
>
> Requests the liked videos of a Douyin user by sec\_user\_id, with max\_cursor and counts (page size). The response model exposes only user identifiers (sec\_uid, uid) and status, not the video entries.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **counts** `integer`
>
> Number per page
>
> **max\_cursor** `integer`
>
> Maximum cursor
>
> **sec\_user\_id** `string` *required*
>
> User sec\_user\_id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin user posted videos
>
> **Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_USER_POST_VIDEOS`
>
> Lists videos posted by a Douyin user (sec\_user\_id), with max\_cursor, count, sort\_type and channel options. Each video includes ID, description, music and play, like, comment and share counts.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **count** `integer`
>
> Number per page.
>
> **channel** `string`
>
> Douyin channel: normal(-), lite().
>
> **sort\_type** `integer`
>
> Sort type.
>
> **max\_cursor** `integer`
>
> Maximum cursor.
>
> **sec\_user\_id** `string` *required*
>
> User sec\_user\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin comment replies
>
> **Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_VIDEO_COMMENT_REPLIES`
>
> Lists replies to a Douyin comment (item\_id video ID and comment\_id), paged by cursor and count. Each reply has text, author, create time, like count and reply-to references.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **count** `integer`
>
> Number
>
> **cursor** `integer`
>
> Cursor
>
> **item\_id** `string` *required*
>
> Video id
>
> **comment\_id** `string` *required*
>
> Comment id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin video comments (app)
>
> **Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_VIDEO_COMMENTS`
>
> Lists comments on a Douyin video by aweme\_id, paged by cursor and count. Each comment has text, author, create time, like count and reply count; returns total and has\_more for pagination.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **count** `integer`
>
> Number.
>
> **cursor** `integer`
>
> Use 0 for the first page. Reuse data.cursor while data.has\_more is nonzero; stop when data.has\_more is 0.
>
> **aweme\_id** `string` *required*
>
> Video id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin high-quality video URL (app)
>
> **Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_VIDEO_HIGH_QUALITY_PLAY_URL`
>
> Requests high-quality playback data for a Douyin video by aweme\_id or share\_url (optional region such as CN). The response model exposes only the video ID, not the playback URL.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.005 per request
>
> #### Input Parameters
>
> **region** `string`
>
> HK). Pass CN to get China-region CDN URLs for faster download in mainland China.
>
> **aweme\_id** `string`
>
> Video id.
>
> **share\_url** `string`
>
> Optional, share link.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin mix collection details
>
> **Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_VIDEO_MIX_DETAIL`
>
> Gets details of a Douyin mix (video collection) by mix\_id: name, description, cover, author, create and update time, and statistics such as play and collect counts.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **mix\_id** `string` *required*
>
> Mix id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List videos in a Douyin mix collection
>
> **Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_VIDEO_MIX_POST_LIST`
>
> Lists the videos in a Douyin mix (collection) by mix\_id, paged by cursor and count. Each video includes ID, description, author, music and play, like, comment and share counts.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **count** `integer`
>
> Number.
>
> **cursor** `integer`
>
> Use 0 for the first page. Reuse data.cursor while data.has\_more is nonzero; stop when data.has\_more is 0.
>
> **mix\_id** `string` *required*
>
> Mix id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin video statistics
>
> **Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_VIDEO_STATISTICS`
>
> Gets engagement statistics for a Douyin video by aweme\_ids: like, play, share and download counts.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **aweme\_ids** `string` *required*
>
> Video id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Douyin short link
>
> **Slug:** `TIK_HUB_DOUYIN_APP_V3_GENERATE_DOUYIN_SHORT_URL`
>
> Converts a Douyin link (url) into a short share URL. Returns the short\_url, its target and status.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Douyin link
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate Douyin video share QR code
>
> **Slug:** `TIK_HUB_DOUYIN_APP_V3_GENERATE_DOUYIN_VIDEO_SHARE_QRCODE`
>
> Generates a share QR code for a Douyin video from its video ID (object\_id). Returns the QR code image URL list and event extra data.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **object\_id** `string` *required*
>
> Video id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin App User Profile
>
> **Slug:** `TIK_HUB_DOUYIN_APP_V3_GET_USER_PROFILE`
>
> Get a compact Douyin app profile by sec\_user\_id. Use the Douyin Web profile action when the identifier is a public unique\_id or numeric uid.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **sec\_user\_id** `string` *required*
>
> User sec\_user\_id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate Douyin keyword-search handoff URL
>
> **Slug:** `TIK_HUB_DOUYIN_APP_V3_OPEN_DOUYIN_APP_TO_KEYWORD_SEARCH`
>
> Generate and return a Douyin mobile-app handoff URL for a keyword search. This read-only action does not open the app; a human must open the URL.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **keyword** `string` *required*
>
> Keyword
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate Douyin private-message handoff URL
>
> **Slug:** `TIK_HUB_DOUYIN_APP_V3_OPEN_DOUYIN_APP_TO_SEND_PRIVATE_MESSAGE`
>
> Generate and return a Douyin mobile-app handoff URL for a private-message recipient. This read-only action does not open the app or send a message; a human must complete the send.
>
> #### Input Parameters
>
> **uid** `string` *required*
>
> User id
>
> **sec\_uid** `string` *required*
>
> User sec\_uid
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate Douyin profile handoff URL
>
> **Slug:** `TIK_HUB_DOUYIN_APP_V3_OPEN_DOUYIN_APP_TO_USER_PROFILE`
>
> Generate and return a Douyin mobile-app handoff URL for a user profile. This read-only action does not open the app; a human must open the URL.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **uid** `string` *required*
>
> User id
>
> **sec\_uid** `string` *required*
>
> User sec\_uid
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate Douyin video handoff URL
>
> **Slug:** `TIK_HUB_DOUYIN_APP_V3_OPEN_DOUYIN_APP_TO_VIDEO_DETAIL`
>
> Generate and return a Douyin mobile-app handoff URL for a video. This read-only action does not open the app; a human must open the URL.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **aweme\_id** `string` *required*
>
> Video id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin billboard cities
>
> **Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_CITY_LIST`
>
> Lists the cities available in Douyin billboard data (label and city code). Takes no input; use the codes to filter the hot calendar and hot city list.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin billboard content tags
>
> **Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_CONTENT_TAG`
>
> Lists Douyin billboard vertical content tags with label, value ID and count, including child tags. Takes no input; use the IDs as tag filters in other billboard actions.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin hot account fan portrait
>
> **Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_ACCOUNT_FANS_PORTRAIT_LIST`
>
> Gets the audience portrait of a hot Douyin account by sec\_uid. The option selects the breakdown (phone price, gender, age, province, city, etc.); returns portrait distribution and TGI values.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **option** `integer`
>
> Breakdown: 1 phone price, 2 gender, 3 age, 4 province, 5 city, 6 city tier, 7 phone brand, 8 interest tags (percentages).
>
> **sec\_uid** `string` *required*
>
> User sec\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin hot account content analysis
>
> **Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_ACCOUNT_ITEM_ANALYSIS_LIST`
>
> Gets content performance benchmarks for a Douyin account by sec\_uid: average post, like, comment, share and follower counts, with percentile rankings.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **sec\_uid** `string` *required*
>
> User sec\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin hot accounts
>
> **Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_ACCOUNT_LIST`
>
> Lists trending Douyin accounts on the billboard for a time window (24, 72 or 168 hours), optionally filtered by vertical tag, with page\_num and page\_size. Each account has nickname, followers, follower growth rate, likes and post count.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **page\_num** `integer`
>
> Page number. Default 1.
>
> **page\_size** `integer`
>
> Results per page. Default 10.
>
> **query\_tag** `object`
>
> Vertical tag filter; empty means all. Get tag IDs from fetch\_content\_tag.
>
> **date\_window** `integer`
>
> Time window in hours: 24, 72 or 168 (last day, 3 days or 7 days). Default 24.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Douyin hot accounts by keyword
>
> **Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_ACCOUNT_SEARCH_LIST`
>
> Searches the Douyin hot-account billboard by username or Douyin ID (keyword) with a pagination cursor. Each account has nickname, followers, follower growth, likes and post count; has\_more signals more results.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **cursor** `integer` *required*
>
> Required pagination cursor. Pass the provider-required first-page cursor value, then pass data.data.cursor from the previous response while data.data.has\_more is true.
>
> **keyword** `string` *required*
>
> Username or Douyin ID to search for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin hot account trends
>
> **Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_ACCOUNT_TRENDS_LIST`
>
> Fetches trend data for a Douyin hot-billboard account from its sec\_uid, with a ranking option and a date window in hours (default 24). Returns a list of trend points.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **option** `integer`
>
> 2  3  4  5.
>
> **sec\_uid** `string` *required*
>
> sec\_id.
>
> **date\_window** `integer`
>
> 24.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin hot calendar event details
>
> **Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_CALENDAR_DETAIL`
>
> Gets one Douyin hot calendar event by calendar\_id: name, description, rewards, category, city, dates, publish window, related topics and challenge info.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **calendar\_id** `string` *required*
>
> Activity ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin hot calendar events
>
> **Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_CALENDAR_LIST`
>
> Lists Douyin hot calendar events and topics between start\_date and end\_date (Unix timestamps), optionally filtered by city\_code and category\_code. Each event has title, dates, status, cover and related topics.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **end\_date** `integer` *required*
>
> Snapshot end time as a 10-digit Unix timestamp.
>
> **city\_code** `string`
>
> City code from the city list; empty means all.
>
> **start\_date** `integer` *required*
>
> Snapshot start time as a 10-digit Unix timestamp.
>
> **category\_code** `string`
>
> Trending-chart category code from the trending-chart categories; empty means all.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin hot chart categories
>
> **Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_CATEGORY_LIST`
>
> Lists the trending-chart categories for a Douyin billboard type, with optional snapshot\_time, date range and keyword. Each category has a label, value and item count; use values as sentence\_tag filters.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **keyword** `string`
>
> Trending search term.
>
> **end\_date** `string`
>
> Snapshot end date, format yyyyMMdd.
>
> **start\_date** `string`
>
> Snapshot start date, format yyyyMMdd.
>
> **snapshot\_time** `string`
>
> Optional snapshot time, format yyyyMMddHHmmss.
>
> **billboard\_type** `string` *required*
>
> Chart type.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin hot challenges
>
> **Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_CHALLENGE_LIST`
>
> Lists trending Douyin challenges on the billboard, with page, page\_size and keyword. Each entry has rank, topic text, hot score, video count and score trend; returns total and last update time.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **page** `integer` *required*
>
> Page number.
>
> **keyword** `string`
>
> Trending search term.
>
> **page\_size** `integer` *required*
>
> Results per page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin hot topics by city
>
> **Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_CITY_LIST`
>
> Lists trending Douyin topics for a city (city\_code), with order, sentence\_tag, keyword, page and page\_size. Each entry has rank, topic text, hot score, video count and score trend.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **page** `integer` *required*
>
> Page number.
>
> **order** `string` *required*
>
> Sort order.
>
> **keyword** `string`
>
> Trending search term.
>
> **city\_code** `string`
>
> City code from the city list; empty means all.
>
> **page\_size** `integer` *required*
>
> Results per page.
>
> **sentence\_tag** `string`
>
> Trending category tags from the trending-chart categories, comma separated; empty means all.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin video hot comment words
>
> **Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_COMMENT_WORD_LIST`
>
> Gets the most frequent words in comments on a Douyin video (aweme\_id). Returns each segmented word with its value.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **aweme\_id** `string` *required*
>
> Video ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin rising hot topics
>
> **Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_RISE_LIST`
>
> Lists rising Douyin topics on the hot billboard, with order, sentence\_tag, keyword, page and page\_size. Each entry has rank, topic text, hot score, video count and score trend.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **page** `integer` *required*
>
> Page number.
>
> **order** `string` *required*
>
> Sort order.
>
> **keyword** `string`
>
> Trending search term.
>
> **page\_size** `integer` *required*
>
> Results per page.
>
> **sentence\_tag** `string`
>
> Trending category tags from the trending-chart categories, comma separated; empty means all.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin high-fan hot videos
>
> **Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_TOTAL_HIGH_FAN_LIST`
>
> Lists videos on the Douyin high-fan billboard for a time window (1, 24, 72 or 168 hours), filterable by keyword and vertical tags with page and page\_size. Each video has title, author, followers, plays, likes and score.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number.
>
> **tags** `array`
>
> Vertical tag filter; empty means all. Get tag IDs from fetch\_content\_tag.
>
> **keyword** `string`
>
> Keyword to filter the chart; empty means all.
>
> **page\_size** `integer`
>
> Results per page.
>
> **date\_window** `integer`
>
> Time window in hours: 1, 24, 72 or 168 (last hour, day, 3 days or 7 days). Default 24.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin high-like hot videos
>
> **Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_TOTAL_HIGH_LIKE_LIST`
>
> Lists videos on the Douyin high-like billboard for a time window (1, 24, 72 or 168 hours), filterable by keyword and vertical tags with page and page\_size. Each video has title, author, plays, likes and score.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number.
>
> **tags** `array`
>
> Vertical tag filter; empty means all. Get tag IDs from fetch\_content\_tag.
>
> **keyword** `string`
>
> Keyword to filter the chart; empty means all.
>
> **page\_size** `integer`
>
> Results per page.
>
> **date\_window** `integer`
>
> Time window in hours: 1, 24, 72 or 168 (last hour, day, 3 days or 7 days). Default 24.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin high-play hot videos
>
> **Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_TOTAL_HIGH_PLAY_LIST`
>
> Lists videos on the Douyin high-play billboard for a time window (1, 24, 72 or 168 hours), filterable by keyword and vertical tags with page and page\_size. Each video has title, author, plays, likes and score.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number.
>
> **tags** `array`
>
> Vertical tag filter; empty means all. Get tag IDs from fetch\_content\_tag.
>
> **keyword** `string`
>
> Keyword to filter the chart; empty means all.
>
> **page\_size** `integer`
>
> Results per page.
>
> **date\_window** `integer`
>
> Time window in hours: 1, 24, 72 or 168 (last hour, day, 3 days or 7 days). Default 24.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin billboard high-search keywords
>
> **Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_TOTAL_HIGH_SEARCH_LIST`
>
> Lists keywords on the Douyin high-search billboard for a time window (1, 24, 72 or 168 hours), filterable by keyword with page\_num and page\_size. Each entry has the keyword and its search score.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **keyword** `string`
>
> Search keyword.
>
> **page\_num** `integer`
>
> Page number.
>
> **page\_size** `integer`
>
> Results per page.
>
> **date\_window** `integer`
>
> Time window in hours: 1, 24, 72 or 168 (last hour, day, 3 days or 7 days). Default 24.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin high-topic challenges
>
> **Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_TOTAL_HIGH_TOPIC_LIST`
>
> Lists challenges on the Douyin high-topic billboard for a time window (1, 24, 72 or 168 hours), filterable by keyword and vertical tags. Each has name, plays, video count, score and daily score trend.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number.
>
> **tags** `array`
>
> Vertical tag filter; empty means all. Get tag IDs from fetch\_content\_tag.
>
> **keyword** `string`
>
> Keyword to filter the chart; empty means all.
>
> **page\_size** `integer`
>
> Results per page.
>
> **date\_window** `integer`
>
> Time window in hours: 1, 24, 72 or 168 (last hour, day, 3 days or 7 days). Default 24.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin billboard hot words
>
> **Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_TOTAL_HOT_WORD_LIST`
>
> Lists hot words on the Douyin billboard for a time window (24, 72 or 168 hours), filterable by keyword with page\_num and page\_size. Each word has title, score, rising ratio and rising speed.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **keyword** `string`
>
> Search keyword.
>
> **page\_num** `integer`
>
> Page number.
>
> **page\_size** `integer`
>
> Results per page.
>
> **date\_window** `integer`
>
> Time window in hours: 24, 72 or 168 (last day, 3 days or 7 days). Default 24.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin overall hot list
>
> **Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_TOTAL_LIST`
>
> Returns the overall Douyin hot list, either a single snapshot or a date range, filterable by sentence\_tag and keyword with page and page\_size. Each entry has rank, topic text, hot score, video count and score trend.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **page** `integer` *required*
>
> Page number.
>
> **type** `string` *required*
>
> Snapshot type: snapshot (a single moment) or range (a time range).
>
> **keyword** `string`
>
> Trending search term.
>
> **end\_date** `string`
>
> Snapshot end date, format yyyyMMdd.
>
> **page\_size** `integer` *required*
>
> Results per page.
>
> **start\_date** `string`
>
> Snapshot start date, format yyyyMMdd.
>
> **sentence\_tag** `string`
>
> Trending category tags from the trending-chart categories, comma separated; empty means all.
>
> **snapshot\_time** `string`
>
> Snapshot time when type=snapshot, format yyyyMMddHHmmss.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin low-fan hot videos
>
> **Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_TOTAL_LOW_FAN_LIST`
>
> Lists videos on the Douyin low-fan billboard for a time window (1, 24, 72 or 168 hours), filterable by keyword and vertical tags with page and page\_size. Each video has title, author, followers, plays, likes and score.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number.
>
> **tags** `array`
>
> Vertical tag filter; empty means all. Get tag IDs from fetch\_content\_tag.
>
> **keyword** `string`
>
> Keyword to filter the chart; empty means all.
>
> **page\_size** `integer`
>
> Results per page.
>
> **date\_window** `integer`
>
> Time window in hours: 1, 24, 72 or 168 (last hour, day, 3 days or 7 days). Default 24.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin billboard search keywords
>
> **Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_TOTAL_SEARCH_LIST`
>
> Lists keywords on the Douyin search billboard for a time window (1, 24, 72 or 168 hours), filterable by keyword with page\_num and page\_size. Each entry has the keyword and its search score.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **keyword** `string`
>
> Search keyword.
>
> **page\_num** `integer`
>
> Page number.
>
> **page\_size** `integer`
>
> Results per page.
>
> **date\_window** `integer`
>
> Time window in hours: 1, 24, 72 or 168 (last hour, day, 3 days or 7 days). Default 24.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin hot topic challenges
>
> **Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_TOTAL_TOPIC_LIST`
>
> Lists challenges on the Douyin hot topic billboard for a time window (1, 24, 72 or 168 hours), filterable by keyword and vertical tags. Each has name, plays, video count, score and daily score trend.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number.
>
> **tags** `array`
>
> Vertical tag filter; empty means all. Get tag IDs from fetch\_content\_tag.
>
> **keyword** `string`
>
> Keyword to filter the chart; empty means all.
>
> **page\_size** `integer`
>
> Results per page.
>
> **date\_window** `integer`
>
> Time window in hours: 1, 24, 72 or 168 (last hour, day, 3 days or 7 days). Default 24.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin hot videos
>
> **Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_TOTAL_VIDEO_LIST`
>
> Lists videos on the Douyin hot video billboard for a time window (1, 24, 72 or 168 hours). The sub\_type picks the chart (overall, small-account viral, high completion, follower growth, like rate), with keyword and tag filters.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number. Default 1.
>
> **tags** `array`
>
> Vertical tag filter; empty means all. Get tag IDs from fetch\_content\_tag.
>
> **keyword** `string`
>
> Keyword to filter the chart; empty means all.
>
> **sub\_type** `integer`
>
> Chart category: 1001 overall videos, 1002 viral from small accounts, 1003 high completion rate, 1004 high follower growth, 1005 high like rate.
>
> **page\_size** `integer`
>
> Results per page. Default 10.
>
> **date\_window** `integer`
>
> Time window in hours: 1, 24, 72 or 168 (last hour, day, 3 days or 7 days). Default 24.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin creator activity details
>
> **Slug:** `TIK_HUB_DOUYIN_CREATOR_FETCH_CREATOR_ACTIVITY_DETAIL`
>
> Gets one Douyin creator activity by activity\_id: name, status, type, level, reward type and rules, show and publish time windows, related topics, cover and jump link.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **activity\_id** `string` *required*
>
> Activity ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin creator activities
>
> **Slug:** `TIK_HUB_DOUYIN_CREATOR_FETCH_CREATOR_ACTIVITY_LIST`
>
> Lists Douyin creator activities between start\_time and end\_time (timestamps). Each activity has ID, display name, type, level, hot score, show and tag time windows, head image and jump link.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **end\_time** `integer` *required*
>
> End timestamp
>
> **start\_time** `integer` *required*
>
> Start timestamp
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin creator content categories
>
> **Slug:** `TIK_HUB_DOUYIN_CREATOR_FETCH_CREATOR_CONTENT_CATEGORY`
>
> Returns Douyin creator content categories (course categories), hot items and selected topics. Hot items include aweme ID, title, category and share URL. Takes no input.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin creator content courses
>
> **Slug:** `TIK_HUB_DOUYIN_CREATOR_FETCH_CREATOR_CONTENT_COURSE`
>
> Lists Douyin creator-academy content courses for a category ID, with ordering and limit/offset paging. Returns the course list, category name, total and has\_more.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **limit** `integer`
>
> Items per page.
>
> **order** `integer`
>
> Order type (1=, 2=, 3=).
>
> **offset** `integer`
>
> Offset (starting position).
>
> **category\_id** `integer` *required*
>
> Category ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin creator hot challenge billboard
>
> **Slug:** `TIK_HUB_DOUYIN_CREATOR_FETCH_CREATOR_HOT_CHALLENGE_BILLBOARD`
>
> Requests the Douyin creator hot challenge billboard. The response model exposes only status code and message, not the challenge entries.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin creator hot courses
>
> **Slug:** `TIK_HUB_DOUYIN_CREATOR_FETCH_CREATOR_HOT_COURSE`
>
> Lists hot Douyin creator-academy courses, optionally filtered by category ID, with ordering and limit/offset paging. Returns the course list, category name, total and has\_more.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Pricing is not available.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Items per page (24).
>
> **order** `integer`
>
> Order type (1=, 2=, 3=).
>
> **offset** `integer`
>
> Use 0 for the first page. Reuse data.offset while data.has\_more is nonzero; stop when data.has\_more is 0.
>
> **category\_id** `string`
>
> Available values: 6976547830546582816=, 6976547923849006336=, 6976547940311633165=, 6976547972108635404=, 6980288134957272352=, 6980288181744766219=, 6980288219548011776=.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin creator hot spot billboard
>
> **Slug:** `TIK_HUB_DOUYIN_CREATOR_FETCH_CREATOR_HOT_SPOT_BILLBOARD`
>
> Returns the Douyin creator hot-spot billboard for billboard\_tag values and hot\_search\_type (overall, local with city\_code, or rising). Each item has title, category, cover, hot score, rank and rank change.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **city\_code** `string`
>
> City code - required when hot\_search\_type=2
>
> **billboard\_tag** `string`
>
> Hot spot tag - multiple tags separated by comma, like '1004,1000,1002'
>
> **hot\_search\_type** `integer ("1" | "2" | "3")`
>
> Hot search type: 1=Overall ranking, 2=Local ranking, 3=Rising ranking
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin creator material center billboard
>
> **Slug:** `TIK_HUB_DOUYIN_CREATOR_FETCH_CREATOR_MATERIAL_CENTER_BILLBOARD`
>
> Returns a Douyin creator material-center billboard filtered by billboard\_tag, order\_key (views, likes, comments, etc.) and time\_filter (24 hours, 7 days or 30 days). Items include title, author, play, like, comment and share counts.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **order\_key** `integer ("1" | "2" | "3" | "4")`
>
> Order key: 1=highest views, 2=most likes, 3=most comments, 4=highest popularity
>
> **time\_filter** `integer ("1" | "2" | "3")`
>
> Time filter: 1=24 hours, 2=7 days, 3=30 days
>
> **billboard\_tag** `integer`
>
> Billboard tag, 0=all, other values can be obtained through config interface
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin creator material center filters
>
> **Slug:** `TIK_HUB_DOUYIN_CREATOR_FETCH_CREATOR_MATERIAL_CENTER_CONFIG`
>
> Returns the Douyin creator material-center filter options: tag lists (hot spot, hot word and general tags), provinces and city codes. Takes no input; use the values in material-center billboard calls.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin creator material center related items
>
> **Slug:** `TIK_HUB_DOUYIN_CREATOR_FETCH_CREATOR_MATERIAL_CENTER_RELATED`
>
> Lists items related to a topic or trending entry in the Douyin creator material center, by query\_id and billboard\_type (trending, topics, effects or music), with limit and offset. Returns items and total.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **limit** `integer`
>
> Items per page
>
> **offset** `integer`
>
> Offset
>
> **query\_id** `string` *required*
>
> Query ID (topic or trending ID from another chart action).
>
> **billboard\_type** `integer`
>
> Chart type (2 = trending, 3 = topics, 4 = effects, 5 = music).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin creator industry categories
>
> **Slug:** `TIK_HUB_DOUYIN_CREATOR_FETCH_INDUSTRY_CATEGORY_CONFIG`
>
> Lists the industry categories used by Douyin creator tools, with labels and nested categories. Takes no input; use the values to filter mission tasks.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin creator mission tasks
>
> **Slug:** `TIK_HUB_DOUYIN_CREATOR_FETCH_MISSION_TASK_LIST`
>
> Requests Douyin creator mission tasks, filterable by mission\_type, industry, platform channel, pay type and keyword, paged by cursor and limit. The response model exposes only paging and status (has\_more, next\_cursor, total\_num), not the task entries.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **limit** `integer`
>
> Items per page
>
> **cursor** `integer`
>
> cursor value documented by TikHub.
>
> **keyword** `string`
>
> keyword value documented by TikHub.
>
> **pay\_type** `integer`
>
> pay type value documented by TikHub.
>
> **tab\_scene** `integer`
>
> tab scene value documented by TikHub.
>
> **industry\_lv1** `integer`
>
> industry lv1 value documented by TikHub.
>
> **industry\_lv2** `integer`
>
> industry lv2 value documented by TikHub.
>
> **mission\_type** `integer`
>
> Mission type
>
> **platform\_channel** `integer`
>
> platform channel value documented by TikHub.
>
> **publish\_time\_start** `integer`
>
> publish time start value documented by TikHub.
>
> **quick\_selector\_scene** `integer`
>
> quick selector scene value documented by TikHub.
>
> **greater\_than\_cost\_progress** `integer`
>
> greater than cost progress value documented by TikHub.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Douyin creators by name
>
> **Slug:** `TIK_HUB_DOUYIN_CREATOR_FETCH_USER_SEARCH`
>
> Searches Douyin creators by username (Douyin ID or nickname). Returns matching users with nickname, short ID, user ID and avatar.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **user\_name** `string` *required*
>
> Username (Douyin ID or Douyin nickname).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin video danmaku comments
>
> **Slug:** `TIK_HUB_DOUYIN_CREATOR_FETCH_VIDEO_DANMAKU_LIST`
>
> Lists danmaku (bullet comments) on a Douyin video by item\_id, with count, offset, order\_type and is\_blocked options. Each has text, user, offset time and like count; returns total\_count and has\_more.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **count** `integer`
>
> Items per page
>
> **offset** `integer`
>
> Offset (starting position)
>
> **item\_id** `string` *required*
>
> Video item ID
>
> **is\_blocked** `boolean`
>
> Is blocked
>
> **order\_type** `integer`
>
> Order type (1 = by time, 2 = other).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin Creator Hot Billboard
>
> **Slug:** `TIK_HUB_DOUYIN_CREATOR_LIST_HOT_BILLBOARD`
>
> List one Douyin Creator hot billboard for music, props, or topics with type-specific ordering. Spot and material-center billboards are separate because their response contracts differ.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **order\_key** `integer`
>
> Sort key for the selected billboard. Music: 1, 2, 4, 5; props: 1, 5, 6, 7; topic: 1, 2, 3, 4.
>
> **time\_filter** `integer ("1" | "2" | "3")`
>
> Time window: 1 for 24 hours, 2 for 7 days, or 3 for 30 days.
>
> **billboard\_tag** `integer`
>
> Billboard category tag. Omit to use the provider's all-categories value 0.
>
> **billboard\_type** `string ("music" | "props" | "topic")` *required*
>
> The creator billboard resource to list: music, props, or topic.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin Index regions and categories
>
> **Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_ALL_AREA`
>
> Returns every region and category option available in Douyin Index, for use as filters in other Douyin Index lookups. Takes no inputs.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin Index valid dates
>
> **Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_ALL_VALID_DATE`
>
> Returns the date ranges Douyin Index currently has data for: latest day and week for brand and keyword data, and latest day, week and month for POI data. Takes no input.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin Index brand hot-video date range
>
> **Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_BRAND_HOT_VIDEOS_TIME_SCOPE`
>
> Get the date range available for Douyin Index brand hot-video analysis. Takes no inputs; returns start\_week, end\_week and latest\_day.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Check Douyin Index brand keywords
>
> **Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_BRAND_VALID_INFO`
>
> Check brand keywords in Douyin Index. Takes a comma-separated brand list and returns, for each keyword, its brand\_status and yuntu\_status.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **keyword\_list** `string` *required*
>
> Brand list comma separated
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin Index content consumption trend
>
> **Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_CONTENT_CONSUME_TREND`
>
> Get Douyin Index consumption and supply trends for a content category over a date range. Takes a category tag\_id (0 is not allowed) and start/end dates (YYYYMMDD); returns dated rate series for consume\_trend and supply\_trend.
>
> #### Input Parameters
>
> **tag\_id** `string` *required*
>
> Category ID, **required, does NOT support 0=all**. Get full list via fetch\_item\_filter\_options (excluding id=0)
>
> **end\_date** `string` *required*
>
> End date YYYYMMDD
>
> **start\_date** `string` *required*
>
> Start date YYYYMMDD
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin Index content interaction trend
>
> **Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_CONTENT_INTERACT_TREND`
>
> Get the Douyin Index interaction trend for a content category over a date range. Takes a category tag\_id (0 is not allowed) and start/end dates (YYYYMMDD); returns a dated interaction rate series.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **tag\_id** `string` *required*
>
> Category ID, **required, does NOT support 0=all**. Get full list via fetch\_item\_filter\_options (excluding id=0)
>
> **end\_date** `string` *required*
>
> End date YYYYMMDD
>
> **start\_date** `string` *required*
>
> Start date YYYYMMDD
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin Index content publishing trend
>
> **Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_CONTENT_PUBLISH_TREND`
>
> Get Douyin Index publishing trends for a content category over a date range. Takes a category tag\_id (0 is not allowed) and start/end dates (YYYYMMDD); returns dated rate series for authors and items.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **tag\_id** `string` *required*
>
> Category ID, **required, does NOT support 0=all**. Get full list via fetch\_item\_filter\_options (excluding id=0)
>
> **end\_date** `string` *required*
>
> End date YYYYMMDD
>
> **start\_date** `string` *required*
>
> Start date YYYYMMDD
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin Index content date range
>
> **Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_CONTENT_VALID_DATE`
>
> Get the valid date boundaries for Douyin Index content analysis. Takes no inputs; returns the day, week, month and earliest\_week values.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin Index current hot topics
>
> **Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_CURRENT_HOT_TOPIC`
>
> Get current and fast-rising (rocketing) hot topics from Douyin Index. Takes no inputs; each topic has topic\_name, category, rank, topic\_index, content\_cnt and vv.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Find Douyin Index creators by keyword
>
> **Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_DAREN_SUG_GREAT_USER_LIST`
>
> Get suggested Douyin creators (daren) for a keyword from Douyin Index. Takes a keyword and a result count; returns user\_name, user\_id, follow/like/item counts, category tags and a sample aweme\_id and URL.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **total** `string`
>
> Return count
>
> **keyword** `string` *required*
>
> Search keyword
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin Index subscribed keywords
>
> **Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_GET_USER_SUB_WORD`
>
> Get the user's subscribed Douyin Index keywords. Takes no inputs; returns sub\_num and a word\_ratio list with each keyword's rank, ratio, keyword\_index and sub\_channel.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin Index trending words
>
> **Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_HOT_TREND_WORD`
>
> Get trending words from Douyin Index for Douyin (aweme) or Toutiao, with a type flag (0 or 1) for content words. Returns trend\_words (id, word) and update\_time.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **type** `integer`
>
> Content words)
>
> **app\_name** `string ("aweme" | "toutiao")`
>
> Platform: aweme (Douyin) or toutiao (Toutiao).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin Index hot keywords
>
> **Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_HOT_WORDS`
>
> Get hot keywords from Douyin Index for Douyin (aweme) or Toutiao. Each keyword comes with its index, growth and growth\_rate.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **app\_name** `string ("aweme" | "toutiao")`
>
> Platform: aweme (Douyin) or toutiao (Toutiao).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get recommended Douyin Index insight report
>
> **Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_INSIGHT_GET_REC`
>
> Get the recommended insight report item for a Douyin Index report ID. Returns its title, author, category, introduction, keywords, cover and create\_time.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **report\_id** `string` *required*
>
> Report ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin Index recommended insights
>
> **Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_INSIGHT_RECOMMEND`
>
> Fetches the recommended insight data shown in Douyin Index. Takes no inputs and returns the provider's data object as-is.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin Index content filter options
>
> **Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_ITEM_FILTER_OPTIONS`
>
> List the content filter options used by Douyin Index: categories (whose IDs serve as tag\_id in the trend actions), date types, duration types and label types, each with id, name and name\_en. Takes no inputs.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Check Douyin keyword valid dates
>
> **Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_KEYWORD_VALID_DATE`
>
> Checks Douyin Index date validity for a comma-separated list of keywords. Returns valid day, weekday and status information for each keyword.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **keyword\_list** `string` *required*
>
> Keyword list, comma separated
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Compare Douyin Index keyword trends
>
> **Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_MULTI_KEYWORD_INTERPRETATION`
>
> Compare keywords in Douyin Index over a date range. Takes comma-separated keywords, start/end dates (YYYYMMDD), platform (aweme or toutiao) and optional regions; returns per-keyword search, content and consume indexes with last-period and last-year differences.
>
> #### Input Parameters
>
> **region** `string`
>
> 地区列表，逗号分隔/Region list, comma separated
>
> **app\_name** `string ("aweme" | "toutiao")`
>
> Platform: aweme (Douyin) or toutiao (Toutiao).
>
> **end\_date** `string` *required*
>
> 结束日期/End date, YYYYMMDD
>
> **start\_date** `string` *required*
>
> 开始日期/Start date, YYYYMMDD
>
> **keyword\_list** `string` *required*
>
> Keyword list, comma separated
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin Index report details
>
> **Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_REPORT_DETAIL`
>
> Get a Douyin Index report by report ID. Returns title, author, category, introduction, keywords, content/html\_content, attached files, and visit and download counts.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **report\_id** `string` *required*
>
> Report ID. Example: 1081
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Douyin Index reports
>
> **Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_REPORT_SEARCH`
>
> Search Douyin Index reports. Takes current\_page and page\_size plus optional type, business, report\_time, search keyword and category filters; returns report\_list (title, author, introduction, keywords, visit and download counts) and total\_num.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **type** `string ("" | "行业洞察" | "产品洞察" | "用户洞察" | "趋势洞察")`
>
> Report type: empty for all, or 行业洞察 (industry), 产品洞察 (product), 用户洞察 (user), 趋势洞察 (trend).
>
> **search** `string`
>
> Search keyword
>
> **business** `string`
>
> Business list, comma separated. Options: 巨量引擎, 今日头条, 抖音, 西瓜视频, 抖音电商, 仕小禄, 其他.
>
> **category** `string`
>
> Top category ID (default 6 = Douyin Index trend reports)
>
> **page\_size** `string`
>
> Page size
>
> **report\_time** `string`
>
> Year list, comma separated. e.g. 2024,2023
>
> **current\_page** `string`
>
> Page number
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin Index word-relation date range
>
> **Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_VALID_DATE_FOR_RELATION`
>
> Get the valid dates for Douyin Index related-word analysis. Takes no inputs; returns datetime and industry\_relative\_words\_end\_date.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Douyin hashtags by keyword
>
> **Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_CHALLENGE_SEARCH_V1`
>
> Search Douyin hashtags (challenges) by keyword. Takes a keyword, optional sort, time, duration and content-type filters, and pagination cursors. Returns challenge\_list with cha\_name, desc, user\_count, view\_count and author, plus cursor and has\_more. Prefer this over the V2 variant by default.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **cursor** `integer`
>
> Offset cursor for pagination, obtained from the last response.
>
> **keyword** `string`
>
> Keyword.
>
> **backtrace** `string`
>
> Backtrace for pagination, obtained from the last response.
>
> **search\_id** `string`
>
> Search ID for pagination, obtained from the last response.
>
> **sort\_type** `string ("0" | "1" | "2")`
>
> Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest.
>
> **content\_type** `string ("0" | "1" | "2" | "3")`
>
> Content type: 0=All, 1=Video, 2=Picture, 3=Article.
>
> **publish\_time** `string ("0" | "1" | "7" | "180")`
>
> Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year.
>
> **filter\_duration** `string ("0" | "0-1" | "1-5" | "5-10000")`
>
> Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Douyin hashtags by keyword (V2)
>
> **Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_CHALLENGE_SEARCH_V2`
>
> Search Douyin hashtags (challenges) by keyword via the V2 variant. Takes a keyword, optional sort, time, duration and content-type filters, and pagination cursors. Returns business\_data entries with challenge\_info (cha\_name, user\_count, view\_count) and a next\_page cursor. Use only when V2 is explicitly required.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **cursor** `integer`
>
> Offset cursor for pagination, obtained from the last response.
>
> **keyword** `string`
>
> Keyword.
>
> **backtrace** `string`
>
> Backtrace for pagination, obtained from the last response.
>
> **search\_id** `string`
>
> Search ID for pagination, obtained from the last response.
>
> **sort\_type** `string ("0" | "1" | "2")`
>
> Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest.
>
> **content\_type** `string ("0" | "1" | "2" | "3")`
>
> Content type: 0=All, 1=Video, 2=Picture, 3=Article.
>
> **publish\_time** `string ("0" | "1" | "7" | "180")`
>
> Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year.
>
> **filter\_duration** `string ("0" | "0-1" | "1-5" | "5-10000")`
>
> Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Suggest Douyin hashtags for a keyword
>
> **Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_CHALLENGE_SUGGEST`
>
> Get Douyin hashtag (challenge) suggestions for a keyword. Returns sug\_list entries with cha\_name, cid, group\_id and view\_count.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **keyword** `string`
>
> Keyword, e.g., 'game'
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Douyin discussions
>
> **Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_DISCUSS_SEARCH`
>
> Searches Douyin discussion results for a keyword, with sort, publish-time, duration and content-type filters and cursor paging. Returns business data cards that contain aweme (video) lists.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **cursor** `integer`
>
> Offset cursor for pagination, obtained from the last response.
>
> **keyword** `string`
>
> Keyword.
>
> **backtrace** `string`
>
> Backtrace for pagination, obtained from the last response.
>
> **search\_id** `string`
>
> Search ID for pagination, obtained from the last response.
>
> **sort\_type** `string ("0" | "1" | "2")`
>
> Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest.
>
> **content\_type** `string ("0" | "1" | "2" | "3")`
>
> Content type: 0=All, 1=Video, 2=Picture, 3=Article.
>
> **publish\_time** `string ("0" | "1" | "7" | "180")`
>
> Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year.
>
> **filter\_duration** `string ("0" | "0-1" | "1-5" | "5-10000")`
>
> Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Douyin experience content
>
> **Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_EXPERIENCE_SEARCH`
>
> Searches Douyin experience-style results for a keyword, with sort, publish-time, duration and content-type filters and cursor paging. Returns business data items with aweme info and recommend titles.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **cursor** `integer`
>
> Offset cursor for pagination, obtained from the last response.
>
> **keyword** `string`
>
> Keyword.
>
> **backtrace** `string`
>
> Backtrace for pagination, obtained from the last response.
>
> **search\_id** `string`
>
> Search ID for pagination, obtained from the last response.
>
> **sort\_type** `string ("0" | "1" | "2")`
>
> Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest.
>
> **content\_type** `string ("0" | "1" | "2" | "3")`
>
> Content type: 0=All, 1=Video, 2=Picture, 3=Article.
>
> **publish\_time** `string ("0" | "1" | "7" | "180")`
>
> Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year.
>
> **filter\_duration** `string ("0" | "0-1" | "1-5" | "5-10000")`
>
> Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Douyin content by keyword
>
> **Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_GENERAL_SEARCH_V1`
>
> Search Douyin content across result types by keyword. Takes a keyword, optional sort, time, duration and content-type filters, and pagination cursors. Returns result cards plus guide\_search\_words, cursor and has\_more. Prefer this over the V2 variant by default.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **cursor** `integer`
>
> Offset cursor for pagination, obtained from the last response.
>
> **keyword** `string`
>
> Keyword.
>
> **backtrace** `string`
>
> Backtrace for pagination, obtained from the last response.
>
> **search\_id** `string`
>
> Search ID for pagination, obtained from the last response.
>
> **sort\_type** `string ("0" | "1" | "2")`
>
> Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest.
>
> **content\_type** `string ("0" | "1" | "2" | "3")`
>
> Content type: 0=All, 1=Video, 2=Picture, 3=Article.
>
> **publish\_time** `string ("0" | "1" | "7" | "180")`
>
> Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year.
>
> **filter\_duration** `string ("0" | "0-1" | "1-5" | "5-10000")`
>
> Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Douyin content by keyword (V2)
>
> **Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_GENERAL_SEARCH_V2`
>
> Search Douyin content across result types by keyword via the V2 variant. Takes a keyword, optional sort, time, duration and content-type filters, and pagination cursors. Returns business\_data cards (aweme\_info with author, statistics, music) and a next\_page cursor. Use only when V2 is explicitly required.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **cursor** `integer`
>
> Offset cursor for pagination, obtained from the last response.
>
> **keyword** `string`
>
> Keyword.
>
> **backtrace** `string`
>
> Backtrace for pagination, obtained from the last response.
>
> **search\_id** `string`
>
> Search ID for pagination, obtained from the last response.
>
> **sort\_type** `string ("0" | "1" | "2")`
>
> Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest.
>
> **content\_type** `string ("0" | "1" | "2" | "3")`
>
> Content type: 0=All, 1=Video, 2=Picture, 3=Article.
>
> **publish\_time** `string ("0" | "1" | "7" | "180")`
>
> Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year.
>
> **filter\_duration** `string ("0" | "0-1" | "1-5" | "5-10000")`
>
> Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Douyin Search Fetch Image Search
>
> **Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_IMAGE_SEARCH`
>
> Search Douyin images with sort, time, duration, content-type, cursor, and search-context controls. Use V3 for the smaller keyword, cursor, and search-ID input surface.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **cursor** `integer`
>
> Offset cursor for pagination, obtained from the last response.
>
> **keyword** `string`
>
> Keyword.
>
> **backtrace** `string`
>
> Backtrace for pagination, obtained from the last response.
>
> **search\_id** `string`
>
> Search ID for pagination, obtained from the last response.
>
> **sort\_type** `string ("0" | "1" | "2")`
>
> Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest.
>
> **content\_type** `string ("0" | "1" | "2" | "3")`
>
> Content type: 0=All, 1=Video, 2=Picture, 3=Article.
>
> **publish\_time** `string ("0" | "1" | "7" | "180")`
>
> Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year.
>
> **filter\_duration** `string ("0" | "0-1" | "1-5" | "5-10000")`
>
> Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Douyin images by keyword (V3)
>
> **Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_IMAGE_SEARCH_V3`
>
> Search Douyin image posts by keyword via the V3 route. Takes only keyword, cursor and search\_id; returns aweme\_info (author, statistics, music) and a next\_page cursor. Use the original image search when filters are needed.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **cursor** `integer`
>
> Pagination cursor.
>
> **keyword** `string` *required*
>
> Search keyword.
>
> **search\_id** `string`
>
> Search ID for pagination.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Douyin users by ID or nickname
>
> **Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_LIVE_SEARCH_V2`
>
> Search Douyin users by Douyin ID or nickname using the live search route. Takes a keyword and cursor (0 for the first page); returns a userList with nickname, uniqueId, shortId, secUid, avatar and follower counts, plus cursor and hasMore.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **cursor** `integer`
>
> Pagination cursor, 0 for the first request, then the cursor from the last response
>
> **keyword** `string`
>
> Douyin ID or nickname
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Douyin across content types
>
> **Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_MULTI_SEARCH`
>
> Runs Douyin's multi-type search for a keyword, with sort, publish-time, duration and content-type filters and cursor paging. Returns business data items with video (aweme) info and comment lists.
>
> #### Input Parameters
>
> **cursor** `integer`
>
> Offset cursor for pagination, obtained from the last response.
>
> **keyword** `string`
>
> Keyword.
>
> **backtrace** `string`
>
> Backtrace for pagination, obtained from the last response.
>
> **search\_id** `string`
>
> Search ID for pagination, obtained from the last response.
>
> **sort\_type** `string ("0" | "1" | "2")`
>
> Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest.
>
> **content\_type** `string ("0" | "1" | "2" | "3")`
>
> Content type: 0=All, 1=Video, 2=Picture, 3=Article.
>
> **publish\_time** `string ("0" | "1" | "7" | "180")`
>
> Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year.
>
> **filter\_duration** `string ("0" | "0-1" | "1-5" | "5-10000")`
>
> Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Douyin music
>
> **Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_MUSIC_SEARCH`
>
> Searches Douyin music for a keyword, with sort, publish-time, duration and content-type filters and cursor paging. Returns the music info list plus cursor and has\_more.
>
> #### Input Parameters
>
> **cursor** `integer`
>
> Offset cursor for pagination, obtained from the last response.
>
> **keyword** `string`
>
> Keyword.
>
> **backtrace** `string`
>
> Backtrace for pagination, obtained from the last response.
>
> **search\_id** `string`
>
> Search ID for pagination, obtained from the last response.
>
> **sort\_type** `string ("0" | "1" | "2")`
>
> Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest.
>
> **content\_type** `string ("0" | "1" | "2" | "3")`
>
> Content type: 0=All, 1=Video, 2=Picture, 3=Article.
>
> **publish\_time** `string ("0" | "1" | "7" | "180")`
>
> Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year.
>
> **filter\_duration** `string ("0" | "0-1" | "1-5" | "5-10000")`
>
> Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Douyin schools by keyword
>
> **Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_SCHOOL_SEARCH`
>
> Search Douyin schools by keyword, such as a school name or location. Returns a list of matching school names.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **keyword** `string`
>
> Keyword, such as school name or location
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin search suggestions
>
> **Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_SEARCH_SUGGEST`
>
> Get Douyin search suggestions for a partial keyword. Returns sug\_list entries with the suggested content, suggestion type and word\_record.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **keyword** `string`
>
> The keyword to be suggested
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Douyin Search Fetch User Search
>
> **Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_USER_SEARCH`
>
> Search Douyin users with follower and user-type filters and search-ID pagination context. The returned projection contains pagination and search configuration metadata, but not matching user records.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **cursor** `integer`
>
> Offset cursor for pagination, obtained from the last response.
>
> **keyword** `string`
>
> Keyword.
>
> **search\_id** `string`
>
> Search ID for pagination, obtained from the last response.
>
> **douyin\_user\_fans** `string`
>
> Fans filter: empty=No limit, 0\_1k=Under 1k, etc.
>
> **douyin\_user\_type** `string`
>
> User type filter: empty=No limit, 300=Creator, 900=Shop, 700=Musician, 800=Celebrity.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Douyin users by keyword (V2)
>
> **Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_USER_SEARCH_V2`
>
> Search Douyin users by keyword with cursor pagination. Takes keyword and cursor only; returns user\_list with nick\_name, user\_id, avatar\_url, fans\_cnt, like\_cnt, publish\_cnt and tag, plus cursor and has\_more.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **cursor** `integer`
>
> Offset cursor for pagination, obtained from the last response
>
> **keyword** `string`
>
> Keyword
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Douyin videos by keyword
>
> **Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_VIDEO_SEARCH_V1`
>
> Search Douyin videos by keyword with filters. Takes a keyword, optional sort, time, duration and content-type filters, and pagination cursors. Returns aweme\_info (desc, author, statistics, music, duration) per video, plus cursor and has\_more. Prefer this over V2 by default.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **cursor** `integer`
>
> Offset cursor for pagination, obtained from the last response.
>
> **keyword** `string`
>
> Keyword.
>
> **backtrace** `string`
>
> Backtrace for pagination, obtained from the last response.
>
> **search\_id** `string`
>
> Search ID for pagination, obtained from the last response.
>
> **sort\_type** `string ("0" | "1" | "2")`
>
> Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest.
>
> **content\_type** `string ("0" | "1" | "2" | "3")`
>
> Content type: 0=All, 1=Video, 2=Picture, 3=Article.
>
> **publish\_time** `string ("0" | "1" | "7" | "180")`
>
> Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year.
>
> **filter\_duration** `string ("0" | "0-1" | "1-5" | "5-10000")`
>
> Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Douyin videos by keyword (V2)
>
> **Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_VIDEO_SEARCH_V2`
>
> Search Douyin videos by keyword with filters via the V2 variant. Takes a keyword, optional sort, time, duration and content-type filters, and pagination cursors. Returns business\_data with aweme\_info (desc, author, statistics, music, duration). Use only when V2 is explicitly required.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **cursor** `integer`
>
> Offset cursor for pagination, obtained from the last response.
>
> **keyword** `string`
>
> Keyword.
>
> **backtrace** `string`
>
> Backtrace for pagination, obtained from the last response.
>
> **search\_id** `string`
>
> Search ID for pagination, obtained from the last response.
>
> **sort\_type** `string ("0" | "1" | "2")`
>
> Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest.
>
> **content\_type** `string ("0" | "1" | "2" | "3")`
>
> Content type: 0=All, 1=Video, 2=Picture, 3=Article.
>
> **publish\_time** `string ("0" | "1" | "7" | "180")`
>
> Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year.
>
> **filter\_duration** `string ("0" | "0-1" | "1-5" | "5-10000")`
>
> Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Douyin videos by keyword (V4 flags)
>
> **Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_VIDEO_SEARCH_V4`
>
> Search Douyin videos by keyword and cursor via the V4 route. Items only carry ad, local-anchor and playlet-type flags (IsAd, HasLocalAnchor, PlayletType), not video IDs or details.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **cursor** `integer`
>
> Pagination cursor, 0 for the first request, then the cursor from the last response
>
> **keyword** `string`
>
> Video title or keyword
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert Douyin UID to sec\_user\_id
>
> **Slug:** `TIK_HUB_DOUYIN_WEB_ENCRYPT_UID_TO_SEC_USER_ID`
>
> Convert a Douyin user uid (short ID) to the encrypted sec\_user\_id that other Douyin actions need.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **uid** `string` *required*
>
> User uid(short\_id).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin user profiles (batch)
>
> **Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_BATCH_USER_PROFILE_V2`
>
> Get profiles for several Douyin users at once. Takes comma-separated sec\_user\_ids; returns each user's nickname, signature, uid, sec\_uid, short\_id, unique\_id, avatar and verification fields.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.15 per batch of up to 50 Douyin user profiles
>
> #### Input Parameters
>
> **sec\_user\_ids** `string` *required*
>
> User sec\_user\_id list, separated by commas
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin hot search words (web)
>
> **Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_HOT_SEARCH_RESULT`
>
> Get Douyin's current hot search list. Takes no inputs; returns trending\_list and word\_list entries with word, hot\_value, video\_count or discuss\_video\_count, label and sentence\_id.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin live room gift ranking
>
> **Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_LIVE_GIFT_RANKING`
>
> Get the gift contribution ranking of a Douyin live room. Takes room\_id and rank\_type; returns ranking data including total, has\_more, currency and self\_info.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **room\_id** `string` *required*
>
> Room room\_id
>
> **rank\_type** `integer`
>
> Leaderboard type
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin live room IM data
>
> **Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_LIVE_IM_FETCH`
>
> Fetch live-room IM (instant message) data from Douyin. Takes the live room\_id and a user\_unique\_id.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **room\_id** `string` *required*
>
> Live room id.
>
> **user\_unique\_id** `string` *required*
>
> User unique ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin video download URLs (batch)
>
> **Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_MULTI_VIDEO_HIGH_QUALITY_PLAY_URL`
>
> Get high-quality play URLs for several Douyin videos at once. Takes comma-separated aweme\_ids (up to 50) and an optional region such as CN; returns each video's original\_video\_url, file size and content\_type with success\_count and failed\_count.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.5 per batch of up to 50 high-quality Douyin video URLs
>
> **Discount:** 50
>
> #### Input Parameters
>
> **region** `string`
>
> Optional, ISO country code (e.g. CN). Pass 'CN' for users in mainland China to get China-region CDN URLs for faster download.
>
> **aweme\_ids** `string` *required*
>
> Video id list, separated by commas, up to 50.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin web video details by ID
>
> **Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_ONE_VIDEO`
>
> Get details for one Douyin video by aweme\_id, optionally including anchor information. Returns aweme\_detail with desc, create\_time, duration, author, music, statistics and video info.
>
> #### Input Parameters
>
> **aweme\_id** `string` *required*
>
> Video id.
>
> **need\_anchor\_info** `boolean`
>
> Whether anchor information is needed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin web video details by share link
>
> **Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_ONE_VIDEO_BY_SHARE_URL`
>
> Get details for one Douyin video from a share link. Takes share\_url; returns the video's author, description and other aweme\_detail data.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **share\_url** `string` *required*
>
> Share link.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin video danmaku comments
>
> **Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_ONE_VIDEO_DANMAKU`
>
> Get danmaku (bullet-screen comments) for a Douyin video within a time window. Takes item\_id, the video duration, and start\_time and end\_time; returns the danmaku payload with total and the window bounds.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **item\_id** `string` *required*
>
> Video id
>
> **duration** `integer` *required*
>
> Video total duration
>
> **end\_time** `integer` *required*
>
> End time
>
> **start\_time** `integer` *required*
>
> Start time
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin web video details by ID (V2)
>
> **Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_ONE_VIDEO_V2`
>
> Get details for one Douyin video by aweme\_id via the V2 route. Returns aweme\_detail with desc, create\_time, duration, author, music, statistics and video info. Use the original route if anchor info is needed.
>
> #### Input Parameters
>
> **aweme\_id** `string` *required*
>
> Video id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Query Douyin user basic info
>
> **Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_QUERY_USER`
>
> Run TikHub's Douyin basic user query. The request has no parameters, and the response only contains status\_code, status\_msg and log\_pb.impr\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get related Douyin videos for a video
>
> **Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_RELATED_POSTS`
>
> Get Douyin videos related to a given video. Takes aweme\_id plus refresh\_index and count for paging; returns aweme\_list (desc, author, statistics, music, duration) and has\_more.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **count** `integer`
>
> Number.
>
> **aweme\_id** `string` *required*
>
> Video id.
>
> **refresh\_index** `integer`
>
> Paging index.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Douyin user followers
>
> **Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_USER_FANS_LIST`
>
> List the followers of a Douyin user. Takes sec\_user\_id plus max\_time, count and source\_type for paging; returns followers (nickname, unique\_id, follower and following counts), total, has\_more and max\_time/min\_time.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **count** `integer`
>
> Number.
>
> **max\_time** `string`
>
> Maximum timestamp.
>
> **sec\_user\_id** `string` *required*
>
> Douyin sec\_user\_id for the user whose followers to fetch.
>
> **source\_type** `integer`
>
> Source type.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List accounts a Douyin user follows
>
> **Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_USER_FOLLOWING_LIST`
>
> List the accounts a Douyin user follows. Takes sec\_user\_id plus max\_time, count and source\_type for paging; returns followings (nickname, unique\_id, follower and following counts), total, has\_more and max\_time/min\_time.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **count** `integer`
>
> Number.
>
> **max\_time** `string`
>
> Maximum timestamp.
>
> **sec\_user\_id** `string` *required*
>
> Douyin sec\_user\_id for the user whose following list to fetch.
>
> **source\_type** `integer`
>
> Source type.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin user live info by UID
>
> **Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_USER_LIVE_INFO_BY_UID`
>
> Get live-stream information for a Douyin user by UID. Returns the provider status\_code and data entries (log\_id, scene\_id).
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **uid** `string` *required*
>
> User UID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin live room data by webcast ID
>
> **Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_USER_LIVE_VIDEOS`
>
> Fetch live-stream data for a Douyin room by webcast\_id. Takes only the webcast\_id.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **webcast\_id** `string` *required*
>
> Room webcast\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin live room by room ID (V2)
>
> **Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_USER_LIVE_VIDEOS_BY_ROOM_ID_V2`
>
> Get live-stream data for a Douyin room by room\_id via the V2 route. Returns room details such as cover, category, create\_time, anchor settings and e-commerce and game data.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **room\_id** `string` *required*
>
> Room room\_id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin live user info by sec\_uid
>
> **Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_USER_LIVE_VIDEOS_BY_SEC_UID`
>
> Get a Douyin live user's information by sec\_uid. The result describes the user, not a list of live videos.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **sec\_uid** `string` *required*
>
> User sec\_uid.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin user profile by short ID
>
> **Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_USER_PROFILE_BY_SHORT_ID`
>
> Get a Douyin user's profile by short\_id. Returns the user's profile data, including avatar and account details.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **short\_id** `string` *required*
>
> User Short ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin user profile by UID
>
> **Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_USER_PROFILE_BY_UID`
>
> Get a Douyin user's profile by uid. Returns the user's profile data, including avatar and account details.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Pricing is not available.
>
> #### Input Parameters
>
> **uid** `string` *required*
>
> User UID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin videos by channel tag
>
> **Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_VIDEO_CHANNEL_RESULT`
>
> Get Douyin videos from a channel by tag\_id. Takes count and refresh\_index for paging; returns aweme\_list (desc, author, statistics, music, duration).
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **count** `integer`
>
> Number.
>
> **tag\_id** `integer` *required*
>
> Tag id.
>
> **refresh\_index** `integer`
>
> Refresh index.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin comment replies
>
> **Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_VIDEO_COMMENT_REPLIES`
>
> Get replies to a comment on a Douyin video. Takes item\_id (video), comment\_id, cursor and count; returns comments (text, user, digg\_count, create\_time, reply counts) with cursor, has\_more and total.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **count** `integer`
>
> Number
>
> **cursor** `integer`
>
> Cursor
>
> **item\_id** `string` *required*
>
> Video id
>
> **comment\_id** `string` *required*
>
> Comment id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin video comments
>
> **Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_VIDEO_COMMENTS`
>
> Get comments on a Douyin video. Takes aweme\_id, cursor (0 for the first page, then reuse data.cursor while has\_more is nonzero) and count; returns comments with their commenters.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **count** `integer`
>
> Number.
>
> **cursor** `integer`
>
> Use 0 for the first page. Reuse data.cursor while data.has\_more is nonzero; stop when data.has\_more is 0.
>
> **aweme\_id** `string` *required*
>
> Video id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin video download URL
>
> **Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_VIDEO_HIGH_QUALITY_PLAY_URL`
>
> Get a high-quality play URL for a Douyin video. Takes aweme\_id or a share\_url and an optional region such as CN; returns video\_id, original\_video\_url, file\_size and content\_type.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.005 per request
>
> #### Input Parameters
>
> **region** `string`
>
> HK). Pass CN to get China-region CDN URLs for faster download in mainland China.
>
> **aweme\_id** `string`
>
> Video id.
>
> **share\_url** `string`
>
> Optional, share link.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate Douyin Web Short URL
>
> **Slug:** `TIK_HUB_DOUYIN_WEB_GENERATE_SHORT_URL`
>
> Generate a shortened Douyin URL for a target URL. This returns the shortened URL and does not fetch the target resource.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **target\_url** `string` *required*
>
> Target URL to be converted.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate Douyin ttwid cookie
>
> **Slug:** `TIK_HUB_DOUYIN_WEB_GENERATE_TTWID`
>
> Generate a Douyin ttwid cookie value for a given user\_agent string, for use with other Douyin web requests.
>
> #### Input Parameters
>
> **user\_agent** `string`
>
> TikHub request field 'user\_agent'
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Extract Douyin video ID from share URL
>
> **Slug:** `TIK_HUB_DOUYIN_WEB_GET_AWEME_ID`
>
> Extract the aweme (video) ID from a Douyin video share URL. Takes the URL and returns the ID.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **url** `string` *required*
>
> A Douyin video share URL from which to extract the aweme (video) ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Extract Douyin sec\_user\_id from profile URL
>
> **Slug:** `TIK_HUB_DOUYIN_WEB_GET_SEC_USER_ID`
>
> Extract the sec\_user\_id from a Douyin user profile share URL. Takes the URL and returns the ID.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **url** `string` *required*
>
> A Douyin user profile share URL from which to extract the sec\_user\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin Web User Profile
>
> **Slug:** `TIK_HUB_DOUYIN_WEB_GET_USER_PROFILE`
>
> Fetch a Douyin Web profile using one identifier kind: sec\_user\_id, unique\_id, or uid. The uid branch's typed projection is limited to message and prompts fields.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **identifier** `string` *required*
>
> The sec\_user\_id, unique\_id, or numeric uid selected by identifier\_type.
>
> **identifier\_type** `string ("sec_user_id" | "unique_id" | "uid")` *required*
>
> The kind of Douyin user identifier supplied in identifier.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Extract Douyin webcast ID from live URL
>
> **Slug:** `TIK_HUB_DOUYIN_WEB_GET_WEBCAST_ID`
>
> Extract the webcast ID from a Douyin live-room share URL. Takes the URL and returns the ID.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **url** `string` *required*
>
> A Douyin live-room share URL from which to extract the webcast ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert Douyin webcast ID to room ID
>
> **Slug:** `TIK_HUB_DOUYIN_WEB_WEBCAST_ID_2_ROOM_ID`
>
> Convert a Douyin webcast ID to the live room\_id used by other live-room actions.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **webcast\_id** `string` *required*
>
> Webcast id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get signed Douyin Xingtu image URL
>
> **Slug:** `TIK_HUB_DOUYIN_XINGTU_GET_SIGN_IMAGE`
>
> Get a signed image URL from Douyin Xingtu. Takes the image uri, duration\_ts and format; returns main\_url, backup\_url and image info.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **uri** `string` *required*
>
> Image URI
>
> **format** `string`
>
> Image format
>
> **duration\_ts** `integer`
>
> Duration in seconds
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Xingtu KOL ID by Douyin sec\_user\_id
>
> **Slug:** `TIK_HUB_DOUYIN_XINGTU_GET_XINGTU_KOLID_BY_SEC_USER_ID`
>
> Look up a creator's Xingtu KOL ID from their Douyin sec\_user\_id. Returns the KOL id, nick\_name, core\_user\_id, tag, avatar\_uri and finish\_rate\_ovr.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **sec\_user\_id** `string` *required*
>
> Douyin User sec\_user\_id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get XingTu KOL ID by Douyin User ID
>
> **Slug:** `TIK_HUB_DOUYIN_XINGTU_GET_XINGTU_KOLID_BY_UID`
>
> Looks up the Xingtu KOL ID for a Douyin user ID (uid). Returns the KOL's ID, nickname, avatar, core user ID, tag and completion-rate fields.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **uid** `string` *required*
>
> Douyin User ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get XingTu KOL ID by Douyin Unique ID
>
> **Slug:** `TIK_HUB_DOUYIN_XINGTU_GET_XINGTU_KOLID_BY_UNIQUE_ID`
>
> Looks up the Xingtu KOL ID for a Douyin unique ID (the public handle). Returns the KOL's ID, nickname, avatar, core user ID, tag and completion-rate fields.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **unique\_id** `string` *required*
>
> Douyin User unique\_id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Douyin Xingtu content trend guide
>
> **Slug:** `TIK_HUB_DOUYIN_XINGTU_V2_GET_CONTENT_TREND_GUIDE`
>
> Get Douyin Xingtu content trend guide data. Takes no inputs; returns two lists, one of id/name/order entries and one of trend items with name, description, industry, start/end dates, link and thumbnail.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Estimate Endpoint Cost
>
> **Slug:** `TIK_HUB_ESTIMATE_ENDPOINT_COST`
>
> Estimate daily TikHub cost for an approved TikHub user-route path and request volume. This pricing metadata lookup never executes the referenced path.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0 per request
>
> #### Input Parameters
>
> **endpoint\_path** `string ("/api/v1/tikhub/user/get_user_info" | "/api/v1/tikhub/user/get_user_daily_usage" | "/api/v1/tikhub/user/calculate_price" | "/api/v1/tikhub/user/get_tiered_discount_info" | "/api/v1/tikhub/user/get_endpoint_info")` *required*
>
> Reviewed TikHub-owned metadata route to price as inert catalog metadata; choose one of the schema's allowed paths. The route is never executed.
>
> **requests\_per\_day** `integer`
>
> Non-negative number of daily requests to include in the estimate.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Account Status
>
> **Slug:** `TIK_HUB_GET_ACCOUNT_STATUS`
>
> Return privacy-minimized status for the connected TikHub account and API key, without identity, balance, scope, or raw key metadata.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List TikHub endpoint information
>
> **Slug:** `TIK_HUB_GET_ALL_ENDPOINTS_INFO`
>
> Read TikHub's endpoint catalog and return one bounded page with pricing, rate-limit, category, and ownership information.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0 per request
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of endpoint entries to return from this catalog read.
>
> **offset** `integer`
>
> Index of the first catalog entry to return. Each page reads the provider catalog again.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Daily Usage
>
> **Slug:** `TIK_HUB_GET_DAILY_USAGE`
>
> Return the connected account owner's current TikHub daily request and billing counters, excluding email and provider diagnostics.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Endpoint Metadata
>
> **Slug:** `TIK_HUB_GET_ENDPOINT_METADATA`
>
> Look up service metadata for one approved TikHub user-route path without executing it. Catalog presence does not authorize route execution.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0 per request
>
> #### Input Parameters
>
> **endpoint\_path** `string ("/api/v1/tikhub/user/get_user_info" | "/api/v1/tikhub/user/get_user_daily_usage" | "/api/v1/tikhub/user/calculate_price" | "/api/v1/tikhub/user/get_tiered_discount_info" | "/api/v1/tikhub/user/get_endpoint_info")` *required*
>
> Reviewed TikHub-owned metadata route to inspect as inert catalog metadata; choose one of the schema's allowed paths. The route is never executed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Parse Douyin or TikTok video from link
>
> **Slug:** `TIK_HUB_HYBRID_VIDEO_DATA`
>
> Parse a Douyin or TikTok video URL, share link or share text and return the video ID, title, description, region, creation time, author profile, playback and download addresses, and play, like, comment, share and collect counts.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Douyin or TikTok video URL, share URL, or share text.
>
> **minimal** `boolean`
>
> Whether to request the provider's minimal response.
>
> **base64\_url** `boolean`
>
> Whether the URL input is base64 encoded.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Instagram cities by country
>
> **Slug:** `TIK_HUB_INSTAGRAM_V1_FETCH_CITIES`
>
> List cities Instagram has location pages for in a country, given a country code (e.g. US, JP). Returns each city's ID, name and slug plus the country info and next page number. Use the city ID with the Instagram locations listing.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number.
>
> **country\_code** `string` *required*
>
> Country code (e.g. US, CN, JP).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Instagram Fetch Fast Post By URL
>
> **Slug:** `TIK_HUB_INSTAGRAM_V1_FETCH_FAST_POST_BY_URL`
>
> Fetch reduced Instagram post details from a post URL using TikHub V2. This variant is faster but less complete than V1 and is suited to high-volume retrieval.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **post\_url** `string` *required*
>
> Post URL.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Instagram Fetch Full Post By URL
>
> **Slug:** `TIK_HUB_INSTAGRAM_V1_FETCH_FULL_POST_BY_URL`
>
> Fetch Instagram post details from a post URL using TikHub's Instagram V1 API. The result contains a validated selection of post fields.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **post\_url** `string` *required*
>
> Post URL.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Instagram location details
>
> **Slug:** `TIK_HUB_INSTAGRAM_V1_FETCH_LOCATION_INFO`
>
> Get an Instagram location by location ID. Returns its name, category, address, city, zip, coordinates, phone, price range, hours status and post count.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **location\_id** `string` *required*
>
> Location ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Instagram locations in a city
>
> **Slug:** `TIK_HUB_INSTAGRAM_V1_FETCH_LOCATIONS`
>
> List Instagram location pages in a city, given a city ID from the Instagram cities listing. Returns each location's ID, name and slug with the city and country info and the next page number.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number.
>
> **city\_id** `string` *required*
>
> City ID (from fetch\_cities).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Instagram posts by music ID or URL
>
> **Slug:** `TIK_HUB_INSTAGRAM_V1_FETCH_MUSIC_POSTS`
>
> Get Instagram posts and reels that use a given audio track, identified by exactly one of a music ID or a music URL. Returns each post's ID, shortcode, media type, product type, comment count and timestamp. Supports a max\_id pagination cursor.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **max\_id** `string`
>
> Pagination cursor for next page.
>
> **music\_id** `string`
>
> Music ID.
>
> **music\_url** `string`
>
> Music URL (alternative to music\_id).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Instagram post by ID
>
> **Slug:** `TIK_HUB_INSTAGRAM_V1_FETCH_POST_BY_ID`
>
> Get an Instagram post by its post ID. Returns the shortcode, display image URL and resolutions, video flag, timestamp, preview like and comment counts, ad and paid-partnership flags, and the owner's username, full name, follower and post counts.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **post\_id** `string` *required*
>
> Post ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get related Instagram profiles
>
> **Slug:** `TIK_HUB_INSTAGRAM_V1_FETCH_RELATED_PROFILES`
>
> Get Instagram profiles related to a given user, by Instagram user ID. Returns each related profile's ID, username, full name, and private and verified flags.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> Instagram user ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Instagram users, hashtags and places
>
> **Slug:** `TIK_HUB_INSTAGRAM_V1_FETCH_SEARCH`
>
> Search Instagram for a keyword and get matching users, hashtags and places in one response. Returns usernames, full names and verified flags for users, hashtag names with post counts, and place titles. Set select to places to return only places.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **query** `string` *required*
>
> Search keyword.
>
> **select** `string`
>
> places, omit for all.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Instagram profile by user ID
>
> **Slug:** `TIK_HUB_INSTAGRAM_V1_FETCH_USER_INFO_BY_ID_V2`
>
> Get an Instagram profile by numeric user ID. Returns username, full name, biography, bio links, follower and following counts, account type, verification and privacy flags, and profile picture.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> Instagram user ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Instagram profile by username
>
> **Slug:** `TIK_HUB_INSTAGRAM_V1_FETCH_USER_INFO_BY_USERNAME_V3`
>
> Get an Instagram profile by username. Returns user ID, full name, biography, bio links, follower and following counts, account type, verification and privacy flags, and profile picture.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **username** `string` *required*
>
> Instagram username
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert Instagram media ID to shortcode (alt)
>
> **Slug:** `TIK_HUB_INSTAGRAM_V1_MEDIA_ID_TO_SHORTCODE`
>
> Convert an Instagram post media ID into its URL shortcode. Returns the media ID, shortcode and a status flag.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **media\_id** `string` *required*
>
> Post media ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert Instagram shortcode to media ID (alt)
>
> **Slug:** `TIK_HUB_INSTAGRAM_V1_SHORTCODE_TO_MEDIA_ID`
>
> Convert an Instagram post URL shortcode into its numeric media ID. Returns the shortcode, media ID and a status flag.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **shortcode** `string` *required*
>
> Post shortcode.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert Instagram user ID to username
>
> **Slug:** `TIK_HUB_INSTAGRAM_V1_USER_ID_TO_USERNAME`
>
> Look up the Instagram username for a numeric user ID. Returns the username, user ID and profile picture URL.
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> User ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Instagram comment replies
>
> **Slug:** `TIK_HUB_INSTAGRAM_V2_FETCH_COMMENT_REPLIES`
>
> Fetch replies to an Instagram comment, given the post shortcode or URL and the comment ID, with an optional pagination token. The typed response only exposes status, attempts and an error message, not reply content.
>
> #### Input Parameters
>
> **comment\_id** `string` *required*
>
> 评论ID/Comment ID
>
> **code\_or\_url** `string` *required*
>
> 帖子Shortcode或URL/Post shortcode or URL
>
> **pagination\_token** `string`
>
> 分页token/Pagination token
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Instagram highlight stories
>
> **Slug:** `TIK_HUB_INSTAGRAM_V2_FETCH_HIGHLIGHT_STORIES`
>
> Fetch the stories inside an Instagram highlight by highlight ID. The typed response only exposes status, attempts and an error message, not the story content.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Pricing is not available.
>
> #### Input Parameters
>
> **highlight\_id** `string` *required*
>
> 精选ID/Highlight ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Instagram posts by audio canonical ID
>
> **Slug:** `TIK_HUB_INSTAGRAM_V2_FETCH_MUSIC_POSTS`
>
> Get Instagram posts and reels that use an audio track, identified by its audio canonical ID. Returns each post's ID, shortcode and media type, plus a pagination token for the next page.
>
> #### Input Parameters
>
> **pagination\_token** `string`
>
> Pagination token returned by the previous page.
>
> **audio\_canonical\_id** `string` *required*
>
> Instagram audio canonical ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Instagram post comments
>
> **Slug:** `TIK_HUB_INSTAGRAM_V2_FETCH_POST_COMMENTS`
>
> Get comments on an Instagram post, given its shortcode or URL. Sort by recent or popular. Returns each comment's text, author user ID, like count, reply count and creation time, plus a pagination token for the next page.
>
> #### Input Parameters
>
> **sort\_by** `string`
>
> 排序方式: recent(最新) 或 popular(热门)/Sort by: recent or popular
>
> **code\_or\_url** `string` *required*
>
> 帖子Shortcode或URL/Post shortcode or URL
>
> **pagination\_token** `string`
>
> 分页token/Pagination token
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Instagram post details by shortcode or URL
>
> **Slug:** `TIK_HUB_INSTAGRAM_V2_FETCH_POST_INFO`
>
> Get detailed information about an Instagram post or reel from its shortcode or URL. Returns the caption, audio and clips metadata, and sharing, comment and community-notes settings.
>
> #### Input Parameters
>
> **code\_or\_url** `string` *required*
>
> 帖子Shortcode或URL/Post shortcode or URL
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get similar Instagram users
>
> **Slug:** `TIK_HUB_INSTAGRAM_V2_FETCH_SIMILAR_USERS`
>
> List Instagram accounts similar to a given user, looked up by username or user ID. Returns a count and items with ID, username, full name, profile picture and verified and private flags.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Pricing is not available.
>
> #### Input Parameters
>
> **user\_id** `string`
>
> User ID
>
> **username** `string`
>
> Username
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Instagram user followers
>
> **Slug:** `TIK_HUB_INSTAGRAM_V2_FETCH_USER_FOLLOWERS`
>
> List an Instagram user's followers by username or user ID, one page at a time with an optional pagination token. Returns the count, total and each follower's ID, username, full name, picture and verified and private flags.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Pricing is not available.
>
> #### Input Parameters
>
> **user\_id** `string`
>
> User ID
>
> **username** `string`
>
> Username
>
> **pagination\_token** `string`
>
> 分页token/Pagination token
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Instagram user following
>
> **Slug:** `TIK_HUB_INSTAGRAM_V2_FETCH_USER_FOLLOWING`
>
> List the accounts an Instagram user follows, by username or user ID, with an optional pagination token. Returns count, total and each account's ID, username, full name, picture and verified and private flags, plus a next-page token.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Pricing is not available.
>
> #### Input Parameters
>
> **user\_id** `string`
>
> User ID
>
> **username** `string`
>
> Username
>
> **pagination\_token** `string`
>
> 分页token/Pagination token
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Instagram user highlights
>
> **Slug:** `TIK_HUB_INSTAGRAM_V2_FETCH_USER_HIGHLIGHTS`
>
> List an Instagram user's story highlights by username or user ID. Returns each highlight's ID, title, media count, creation and update times and reel type.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Pricing is not available.
>
> #### Input Parameters
>
> **user\_id** `string`
>
> User ID
>
> **username** `string`
>
> Username
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Instagram profile details by username or ID
>
> **Slug:** `TIK_HUB_INSTAGRAM_V2_FETCH_USER_INFO`
>
> Get an Instagram profile by username or user ID. Returns biography, links, follower and following counts, category, contact and account settings, and an About block with join date, country and former usernames.
>
> #### Input Parameters
>
> **user\_id** `string`
>
> User ID
>
> **username** `string`
>
> Username
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Instagram user posts
>
> **Slug:** `TIK_HUB_INSTAGRAM_V2_FETCH_USER_POSTS`
>
> Get one page of posts published by an Instagram user through TikHub, selected by username or user ID.
>
> #### Input Parameters
>
> **user\_id** `string`
>
> Instagram numeric user ID; provide this or username.
>
> **username** `string`
>
> Instagram username; provide this or user\_id.
>
> **pagination\_token** `string`
>
> Token returned by a previous call for the next page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Instagram user reels
>
> **Slug:** `TIK_HUB_INSTAGRAM_V2_FETCH_USER_REELS`
>
> Get one page of reels published by an Instagram user through TikHub, selected by username or user ID.
>
> #### Input Parameters
>
> **user\_id** `string`
>
> Instagram numeric user ID; provide this or username.
>
> **username** `string`
>
> Instagram username; provide this or user\_id.
>
> **pagination\_token** `string`
>
> Token returned by a previous call for the next page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Instagram user stories
>
> **Slug:** `TIK_HUB_INSTAGRAM_V2_FETCH_USER_STORIES`
>
> Fetch an Instagram user's current stories by username or user ID. The typed response only exposes the story count, not the story media.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Pricing is not available.
>
> #### Input Parameters
>
> **user\_id** `string`
>
> User ID
>
> **username** `string`
>
> Username
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert Instagram media ID to shortcode
>
> **Slug:** `TIK_HUB_INSTAGRAM_V2_MEDIA_ID_TO_SHORTCODE`
>
> Convert an Instagram post media ID into its URL shortcode. Returns the media ID, shortcode and a status flag.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.002 per request
>
> #### Input Parameters
>
> **media\_id** `string` *required*
>
> Post media ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Find Instagram places by coordinates
>
> **Slug:** `TIK_HUB_INSTAGRAM_V2_SEARCH_BY_COORDINATES`
>
> Find Instagram places near a latitude and longitude. Returns each place's ID, name, address, category, coordinates and website, with a count.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Pricing is not available.
>
> #### Input Parameters
>
> **latitude** `number` *required*
>
> 纬度/Latitude
>
> **longitude** `number` *required*
>
> 经度/Longitude
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Instagram hashtags
>
> **Slug:** `TIK_HUB_INSTAGRAM_V2_SEARCH_HASHTAGS`
>
> Search Instagram hashtags by keyword. Returns each matching hashtag's ID, name and media count, with a count of results.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Pricing is not available.
>
> #### Input Parameters
>
> **keyword** `string` *required*
>
> Search keyword
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Instagram locations by keyword
>
> **Slug:** `TIK_HUB_INSTAGRAM_V2_SEARCH_LOCATIONS`
>
> Search Instagram locations by keyword. Returns each location's ID, name, short name, address, city, coordinates and external source, with a count of results.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Pricing is not available.
>
> #### Input Parameters
>
> **keyword** `string` *required*
>
> Search keyword
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Instagram music
>
> **Slug:** `TIK_HUB_INSTAGRAM_V2_SEARCH_MUSIC`
>
> Search Instagram's music library by keyword. Returns each track's ID, title, artist, subtitle, duration, explicit flag, cover artwork and preview download URLs.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Pricing is not available.
>
> #### Input Parameters
>
> **keyword** `string` *required*
>
> Search keyword
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Instagram users
>
> **Slug:** `TIK_HUB_INSTAGRAM_V2_SEARCH_USERS`
>
> Search Instagram users by keyword. Returns each user's ID, username, full name, profile picture URL and private and verified flags, with a count of results.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Pricing is not available.
>
> #### Input Parameters
>
> **keyword** `string` *required*
>
> Search keyword
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert Instagram shortcode to media ID
>
> **Slug:** `TIK_HUB_INSTAGRAM_V2_SHORTCODE_TO_MEDIA_ID`
>
> Convert an Instagram post URL shortcode into its numeric media ID. Returns the shortcode, media ID and a status flag.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.002 per request
>
> #### Input Parameters
>
> **shortcode** `string` *required*
>
> Post shortcode
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert Instagram user ID to username (alt)
>
> **Slug:** `TIK_HUB_INSTAGRAM_V2_USER_ID_TO_USERNAME`
>
> Look up the Instagram username for a numeric user ID using the second user ID lookup variant. Returns the username, user ID and profile picture URL, the same fields as the first variant.
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> User ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Kuaishou hot board categories
>
> **Slug:** `TIK_HUB_KUAISHOU_APP_FETCH_HOT_BOARD_CATEGORIES`
>
> List the Kuaishou hot boards (trending ranking categories) available in the app. Returns each board's ID, name, type and share/banner details; use boardId and boardType with the hot board detail tool.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Kuaishou hot board trending topics
>
> **Slug:** `TIK_HUB_KUAISHOU_APP_FETCH_HOT_BOARD_DETAIL`
>
> Get the trending entries of a Kuaishou hot board by boardType and boardId. Returns hot keywords with hot value, view count and rank-related fields, plus pinned top entries.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **boardId** `integer`
>
> board Id value documented by TikHub.
>
> **boardType** `integer`
>
> board Type value documented by TikHub.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Kuaishou user profile and counts
>
> **Slug:** `TIK_HUB_KUAISHOU_APP_FETCH_ONE_USER_V2`
>
> Get a Kuaishou user's profile and counts from an eid or numeric user ID. Returns display name, account ID, bio, avatar and verification, plus follower, following, like and photo counts.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> Kuaishou eid or numeric userId.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Kuaishou video by ID
>
> **Slug:** `TIK_HUB_KUAISHOU_APP_FETCH_ONE_VIDEO`
>
> Get a Kuaishou video's details by photo ID using the app API: caption, duration, like/comment/collect/forward counts and author fields.
>
> #### Input Parameters
>
> **photo\_id** `string` *required*
>
> photo id value documented by TikHub.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Kuaishou video from share text
>
> **Slug:** `TIK_HUB_KUAISHOU_APP_FETCH_ONE_VIDEO_BY_URL`
>
> Get a Kuaishou video's details from pasted share text or a share link using the app API: caption, duration, like/comment/collect/forward counts and author fields.
>
> #### Input Parameters
>
> **share\_text** `string` *required*
>
> share text value documented by TikHub.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Kuaishou user live status
>
> **Slug:** `TIK_HUB_KUAISHOU_APP_FETCH_USER_LIVE_INFO`
>
> Check whether a Kuaishou user is currently live, by user ID. Returns the live icon state (isLive), live stream info when available and the user's photo count.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> user id value documented by TikHub.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Fetch Kuaishou video comments
>
> **Slug:** `TIK_HUB_KUAISHOU_APP_FETCH_VIDEO_COMMENT`
>
> Fetch one cursor page of comments for a Kuaishou video through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **pcursor** `string`
>
> Comment cursor from the previous page.
>
> **photo\_id** `string` *required*
>
> Kuaishou photo ID or eID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate Kuaishou share link
>
> **Slug:** `TIK_HUB_KUAISHOU_APP_GENERATE_KUAISHOU_SHARE_LINK`
>
> Generate sharing details for a Kuaishou item from its share object ID, using the app API. Returns the share object with app name, share channel/mode and extra parameters used to build the link.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **shareObjectId** `string` *required*
>
> share Object Id value documented by TikHub.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Kuaishou users
>
> **Slug:** `TIK_HUB_KUAISHOU_APP_SEARCH_USER_V2`
>
> Search Kuaishou users by keyword with filters for relation, gender and follower-count sort. Returns user entries with ID, name, avatar and follower count, plus a pcursor for the next page.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **keyword** `string` *required*
>
> Provider parameter keyword.
>
> **pcursor** `string`
>
> Use an empty string for the first page; pass the response pcursor to the next call.
>
> **fans\_sort** `string ("default" | "most_to_least" | "least_to_most")`
>
> default / most\_to\_least / least\_to\_most
>
> **user\_gender** `string ("all" | "male" | "female")`
>
> all / male / female
>
> **user\_relation** `string ("all" | "same_city" | "verified" | "live" | "following")`
>
> all / same\_city / verified / live / following
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Kuaishou user ID from share link
>
> **Slug:** `TIK_HUB_KUAISHOU_WEB_FETCH_GET_USER_ID`
>
> Resolve a Kuaishou user's share link into the user ID that other Kuaishou web user tools accept. Returns the user ID.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **share\_link** `string` *required*
>
> User Share Link
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Kuaishou video from URL
>
> **Slug:** `TIK_HUB_KUAISHOU_WEB_FETCH_ONE_VIDEO_BY_URL`
>
> Get a Kuaishou video's details from its photo URL using the web API: caption, duration, like/comment/share/forward counts, cover and play URLs, plus the author's follower and photo counts.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.002 per request
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Photo URL
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Kuaishou video comments
>
> **Slug:** `TIK_HUB_KUAISHOU_WEB_FETCH_ONE_VIDEO_COMMENT`
>
> Get the top-level comments on a Kuaishou video by photo ID, paged with an optional pcursor. Returns each comment's author, content, like count and time, plus the total comment count and next pcursor.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.002 per request
>
> #### Input Parameters
>
> **pcursor** `string`
>
> Comment cursor
>
> **photo\_id** `string` *required*
>
> Photo ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Kuaishou comment replies
>
> **Slug:** `TIK_HUB_KUAISHOU_WEB_FETCH_ONE_VIDEO_SUB_COMMENT`
>
> Get the replies to a Kuaishou comment from the photo ID and root comment ID, paged with an optional pcursor. Returns each reply's author, content, like count, time and who it replies to.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **pcursor** `string`
>
> Comment cursor
>
> **photo\_id** `string` *required*
>
> Photo ID
>
> **root\_comment\_id** `string` *required*
>
> Root comment ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Kuaishou user collected videos
>
> **Slug:** `TIK_HUB_KUAISHOU_WEB_FETCH_USER_COLLECT`
>
> Request a Kuaishou user's collected (favorited) videos by user ID with an optional pcursor. Observed responses expose only a result code and error message, so check those fields for success.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **pcursor** `string`
>
> Optional provider cursor. The observed response does not expose a next cursor, so pagination beyond one page is unsupported.
>
> **user\_id** `string` *required*
>
> Provider parameter user\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Kuaishou user profile
>
> **Slug:** `TIK_HUB_KUAISHOU_WEB_FETCH_USER_INFO`
>
> Get a Kuaishou user's profile by user ID (eid) using the web API: profile details, gender, follow state, owner (post) count, live status and custom user ID.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.002 per request
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> User ID (eid)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Kuaishou user live replays
>
> **Slug:** `TIK_HUB_KUAISHOU_WEB_FETCH_USER_LIVE_REPLAY`
>
> Request a Kuaishou user's live replays by user ID with an optional pcursor. Observed responses expose only a result code, error ID and login URL, so check those fields for success.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **pcursor** `string`
>
> Optional provider cursor. The observed response does not expose a next cursor, so pagination beyond one page is unsupported.
>
> **user\_id** `string` *required*
>
> Provider parameter user\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate Kuaishou video share link
>
> **Slug:** `TIK_HUB_KUAISHOU_WEB_GENERATE_SHARE_SHORT_URL`
>
> Generate sharing details for a Kuaishou video from its photo ID using the web API. Returns the share object with app name, share channel/mode and extra parameters used to build the link.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **photo\_id** `string` *required*
>
> Photo ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Kuaishou Video By Photo ID
>
> **Slug:** `TIK_HUB_KUAISHOU_WEB_GET_VIDEO_BY_PHOTO_ID`
>
> Fetch one Kuaishou video by photo\_id. The share-text variant instead accepts share text and excludes photo-only posts.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.002 per request
>
> #### Input Parameters
>
> **photo\_id** `string` *required*
>
> Photo ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Kuaishou Video By Share Text
>
> **Slug:** `TIK_HUB_KUAISHOU_WEB_GET_VIDEO_BY_SHARE_TEXT`
>
> Fetch one Kuaishou video from share text; photo-only posts are unsupported. The photo-ID variant instead requires a photo\_id.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.002 per request
>
> #### Input Parameters
>
> **share\_text** `string` *required*
>
> Photo share link
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Kuaishou Hot Board
>
> **Slug:** `TIK_HUB_KUAISHOU_WEB_LIST_HOT_BOARD`
>
> List the main Kuaishou hot board or select an entertainment, society, useful, challenge, or search ranking board.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **board\_type** `string ("hot" | "entertainment" | "society" | "useful" | "challenge" | "search")`
>
> Kuaishou board to list: hot, entertainment, society, useful, challenge, or search.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Lemon8 discover banners
>
> **Slug:** `TIK_HUB_LEMON8_APP_FETCH_DISCOVER_BANNERS`
>
> List the promotional banners shown on the Lemon8 discover page. Returns each banner's ID, title and click URL.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Lemon8 discover feed info
>
> **Slug:** `TIK_HUB_LEMON8_APP_FETCH_DISCOVER_TAB`
>
> Request the Lemon8 discover page. Returns only paging and impression metadata (has\_more, impr\_id, session\_impr\_id), not the feed content items. Takes no inputs.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Lemon8 hot search keywords
>
> **Slug:** `TIK_HUB_LEMON8_APP_FETCH_HOT_SEARCH_KEYWORDS`
>
> List trending search keywords on Lemon8. Returns each hot word's query text, group ID, type and source.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Lemon8 topic details
>
> **Slug:** `TIK_HUB_LEMON8_APP_FETCH_TOPIC_INFO`
>
> Get details of a Lemon8 topic by topic ID: name, description, follower count, share URL, avatar and background images, and the topic's feed tabs.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **forum\_id** `string` *required*
>
> Topic ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Lemon8 user followers
>
> **Slug:** `TIK_HUB_LEMON8_APP_FETCH_USER_FOLLOWER_LIST`
>
> List a Lemon8 user's followers by user ID. Returns each follower's ID, name, unique name, description, icon URL and follow-relationship flags, with a cursor and has-more flag for paging.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **cursor** `string`
>
> Pagination parameter
>
> **user\_id** `string` *required*
>
> User ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Lemon8 user followings
>
> **Slug:** `TIK_HUB_LEMON8_APP_FETCH_USER_FOLLOWING_LIST`
>
> List the accounts a Lemon8 user follows, by user ID. Returns each account's ID, name, unique name, description, icon URL and follow-relationship flags, with a cursor and has-more flag for paging.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **cursor** `string`
>
> Pagination parameter
>
> **user\_id** `string` *required*
>
> User ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get LinkedIn company profile
>
> **Slug:** `TIK_HUB_LINKEDIN_WEB_V2_GET_COMPANY_PROFILE`
>
> Get a LinkedIn company profile from its full company URL. Returns the name, description, industries, company size, headquarters, locations, website, follower count, specialties, employees, similar and affiliated companies, and recent updates.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.008 per request
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Full company URL
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get LinkedIn post details
>
> **Slug:** `TIK_HUB_LINKEDIN_WEB_V2_GET_POST_DETAIL`
>
> Get a LinkedIn post or article from its URL. Returns the post text, headline, author name and follower count, post date, like and comment counts, hashtags, images, embedded links and top visible comments.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Post or article URL
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get LinkedIn user profile
>
> **Slug:** `TIK_HUB_LINKEDIN_WEB_V2_GET_USER_PROFILE`
>
> Get a LinkedIn member profile from its full profile URL. Returns name, current position, location, about text, connections and followers, current company, experience, education, recent posts and similar profiles.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.008 per request
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Full profile URL
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Discount Tiers
>
> **Slug:** `TIK_HUB_LIST_DISCOUNT_TIERS`
>
> Return TikHub's request-per-day discount bands for internal budgeting, without interpreting whether shared tier boundaries are inclusive or exclusive.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0 per request
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get PiPiXia hashtag details
>
> **Slug:** `TIK_HUB_PIPIXIA_APP_FETCH_HASHTAG_DETAIL`
>
> Get details of a PiPiXia hashtag by hashtag ID: name, intro, creation time, follower and entry counts, whether you follow it, and host user IDs.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **hashtag\_id** `string` *required*
>
> Hashtag id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get PiPiXia hashtag posts
>
> **Slug:** `TIK_HUB_PIPIXIA_APP_FETCH_HASHTAG_POST_LIST`
>
> List posts under a PiPiXia hashtag, given a hashtag ID. Returns post IDs, text, creation time and duration for each entry, plus a cursor for loading the next page.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **cursor** `string`
>
> Page cursor.
>
> **feed\_count** `string`
>
> Zero-based page count.
>
> **hashtag\_id** `string` *required*
>
> PiPiXia hashtag ID.
>
> **hashtag\_sort\_type** `string`
>
> Hashtag sort category.
>
> **hashtag\_request\_type** `string`
>
> Hashtag request category.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get PiPiXia home feed
>
> **Slug:** `TIK_HUB_PIPIXIA_APP_FETCH_HOME_FEED`
>
> Get the PiPiXia home feed. Returns feed entries with post IDs, text, creation time and duration, plus a cursor for loading the next page.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **cursor** `string`
>
> Page cursor.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get PiPiXia home short drama feed
>
> **Slug:** `TIK_HUB_PIPIXIA_APP_FETCH_HOME_SHORT_DRAMA_FEED`
>
> Get the PiPiXia home short-drama feed for a page number. Returns feed cells with cell ID, name, type and channel ID, plus has-more and recommend flags.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get PiPiXia hot-search boards
>
> **Slug:** `TIK_HUB_PIPIXIA_APP_FETCH_HOT_SEARCH_BOARD_LIST`
>
> List the trending hot-search boards on PiPiXia, with each board's ID, type and title and its update label when present.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get PiPiXia post comments
>
> **Slug:** `TIK_HUB_PIPIXIA_APP_FETCH_POST_COMMENT_LIST`
>
> List comments on a PiPiXia post by post ID. Returns each comment's ID, text, creation time, like and reply counts, plus the next page offset and a has-more flag.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **offset** `string`
>
> Page offset cursor.
>
> **cell\_id** `string` *required*
>
> PiPiXia post ID.
>
> **cell\_type** `integer`
>
> Post type; 1 denotes video.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get PiPiXia post detail
>
> **Slug:** `TIK_HUB_PIPIXIA_APP_FETCH_POST_DETAIL`
>
> Get the details of a PiPiXia post by post ID: text, creation time, duration, download flag, author profile (name, follower and following counts) and engagement stats (likes, comments, shares, plays, favorites).
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **cell\_id** `string` *required*
>
> PiPiXia post ID.
>
> **cell\_type** `integer`
>
> Post type; 1 denotes video.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get PiPiXia post statistics
>
> **Slug:** `TIK_HUB_PIPIXIA_APP_FETCH_POST_STATISTICS`
>
> Get engagement statistics for a PiPiXia video by post ID: like, comment, share, play, view, impression, reward and dubbing counts.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **cell\_id** `string` *required*
>
> Video id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search PiPiXia
>
> **Slug:** `TIK_HUB_PIPIXIA_APP_FETCH_SEARCH`
>
> Search PiPiXia by keyword with offset paging and a search category. Returns result cell IDs and types, whether more results exist, the provider-normalized query and the reported result count.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **offset** `string`
>
> Page offset cursor.
>
> **keyword** `string` *required*
>
> Search keyword.
>
> **search\_type** `string`
>
> Search category code.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get PiPiXia short URL
>
> **Slug:** `TIK_HUB_PIPIXIA_APP_FETCH_SHORT_URL`
>
> Convert a PiPiXia URL into its short URL. Takes the original URL and returns the short URL.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **original\_url** `string` *required*
>
> Original URL
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List PiPiXia user followers
>
> **Slug:** `TIK_HUB_PIPIXIA_APP_FETCH_USER_FOLLOWER_LIST`
>
> List a PiPiXia user's followers by user ID. Returns each follower's ID, name, description, gender, age, region and level, with a cursor for paging.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **cursor** `string`
>
> Page cursor
>
> **user\_id** `string` *required*
>
> User id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get PiPiXia user followings
>
> **Slug:** `TIK_HUB_PIPIXIA_APP_FETCH_USER_FOLLOWING_LIST`
>
> List the accounts a PiPiXia user follows, given a user ID. Returns each followed user's ID, name, profile description and follower, following and like counts, plus a pagination cursor.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **cursor** `string`
>
> Page cursor.
>
> **user\_id** `string` *required*
>
> PiPiXia user ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get PiPiXia user posts
>
> **Slug:** `TIK_HUB_PIPIXIA_APP_FETCH_USER_POST_LIST`
>
> List posts published by a PiPiXia user, given a user ID. Returns post IDs, text, creation time and duration for each entry, plus a cursor for loading the next page.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **cursor** `string`
>
> Page cursor.
>
> **user\_id** `string` *required*
>
> PiPiXia user ID.
>
> **feed\_count** `string`
>
> Zero-based page count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Check whether a subreddit is muted on Reddit
>
> **Slug:** `TIK_HUB_REDDIT_APP_CHECK_SUBREDDIT_MUTED`
>
> Check whether a Reddit subreddit is muted, given its subreddit ID. Returns the subreddit's muted flag. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **language** `string`
>
> Preferred response language as an IETF language tag; default: en-US
>
> **need\_format** `boolean`
>
> Whether to clean and format the data
>
> **subreddit\_id** `string` *required*
>
> Subreddit ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Reddit comment replies
>
> **Slug:** `TIK_HUB_REDDIT_APP_FETCH_COMMENT_REPLIES`
>
> Look up comment-reply paging for a Reddit post from a post ID and comment cursor. Returns post ID, title, comment count, subreddit identity and whether another page exists, but not reply text. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **cursor** `string` *required*
>
> Comment cursor from more.cursor field
>
> **post\_id** `string` *required*
>
> Post ID
>
> **language** `string`
>
> Preferred response language as an IETF language tag; default: en-US
>
> **sort\_type** `string ("CONFIDENCE" | "NEW" | "TOP" | "HOT" | "CONTROVERSIAL" | "OLD" | "RANDOM")`
>
> Sort method: CONFIDENCE, NEW, TOP, HOT, CONTROVERSIAL, OLD, RANDOM
>
> **need\_format** `boolean`
>
> Whether to clean and format the data
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Reddit community highlights
>
> **Slug:** `TIK_HUB_REDDIT_APP_FETCH_COMMUNITY_HIGHLIGHTS`
>
> Get a subreddit's community highlights by subreddit ID. Returns only the subreddit's ID and name, not the highlight content. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **language** `string`
>
> Preferred response language as an IETF language tag; default: en-US
>
> **need\_format** `boolean`
>
> Whether to clean and format the data
>
> **subreddit\_id** `string` *required*
>
> Subreddit ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Reddit
>
> **Slug:** `TIK_HUB_REDDIT_APP_FETCH_DYNAMIC_SEARCH`
>
> Search Reddit for posts, communities, comments, media or people by query, with optional sort. Returns only the active search results pane name, not the result items themselves. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **sort** `string ("RELEVANCE" | "HOT" | "TOP" | "NEW" | "COMMENTS")`
>
> Optional result sort for post, comment, or media search.
>
> **after** `string`
>
> Pagination token for the next page.
>
> **query** `string` *required*
>
> Search query.
>
> **language** `string`
>
> Preferred response language as an IETF language tag.
>
> **allow\_nsfw** `string ("0" | "1")`
>
> Whether adult results are allowed.
>
> **time\_range** `string ("all" | "year" | "month" | "week" | "day" | "hour")`
>
> Optional time range for post or media search.
>
> **need\_format** `boolean`
>
> Whether TikHub should normalize the provider payload.
>
> **safe\_search** `string ("unset" | "strict")`
>
> Safe-search mode.
>
> **search\_type** `string ("post" | "community" | "comment" | "media" | "people")`
>
> Type of Reddit resource to search.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Reddit games feed
>
> **Slug:** `TIK_HUB_REDDIT_APP_FETCH_GAMES_FEED`
>
> Get the Reddit games feed, with sort (NEW, HOT, TOP, RISING) and time-range options. Returns feed entry node and group IDs plus a cursor for the next page, not post content. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **sort** `string ("BEST" | "HOT" | "NEW" | "TOP" | "CONTROVERSIAL" | "RISING")`
>
> Sort method: NEW, HOT, TOP, RISING
>
> **time** `string ("ALL" | "HOUR" | "DAY" | "WEEK" | "MONTH" | "YEAR")`
>
> Time range: ALL, HOUR, DAY, WEEK, MONTH, YEAR
>
> **after** `string`
>
> Pagination parameter
>
> **language** `string`
>
> Preferred response language as an IETF language tag; default: en-US
>
> **need\_format** `boolean`
>
> Whether to clean and format the data
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Reddit home feed
>
> **Slug:** `TIK_HUB_REDDIT_APP_FETCH_HOME_FEED`
>
> Get the Reddit home feed. Returns posts with title, URL, score, comment count, permalink and subreddit details, plus an after token for the next page. Supports sort order and excluding post IDs. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **sort** `string ("BEST" | "HOT" | "NEW" | "TOP" | "CONTROVERSIAL" | "RISING")`
>
> Feed sort order.
>
> **after** `string`
>
> Pagination token for the next page.
>
> **language** `string`
>
> Preferred response language as an IETF language tag.
>
> **need\_format** `boolean`
>
> Whether TikHub should normalize the provider payload.
>
> **filter\_posts** `array`
>
> Reddit post IDs to exclude from the feed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Reddit news feed
>
> **Slug:** `TIK_HUB_REDDIT_APP_FETCH_NEWS_FEED`
>
> Get a page of the Reddit news feed for chosen news subtopic IDs and a language. Returns only feed paging data: the element count and the end cursor to pass back as the after token. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **after** `string`
>
> Pagination token for the next page.
>
> **language** `string`
>
> Preferred response language as an IETF language tag.
>
> **need\_format** `boolean`
>
> Whether TikHub should normalize the provider payload.
>
> **subtopic\_ids** `array`
>
> News subtopic IDs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Reddit popular feed
>
> **Slug:** `TIK_HUB_REDDIT_APP_FETCH_POPULAR_FEED`
>
> Get the Reddit popular feed, ranked over a chosen time range. Returns posts with title, URL, score, comment count, permalink and subreddit details, plus an after token for the next page. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **sort** `string ("BEST" | "HOT" | "NEW" | "TOP" | "CONTROVERSIAL" | "RISING")`
>
> Feed sort order.
>
> **time** `string ("ALL" | "HOUR" | "DAY" | "WEEK" | "MONTH" | "YEAR")`
>
> Time range used to rank popular posts.
>
> **after** `string`
>
> Pagination token for the next page.
>
> **language** `string`
>
> Preferred response language as an IETF language tag.
>
> **need\_format** `boolean`
>
> Whether TikHub should normalize the provider payload.
>
> **filter\_posts** `array`
>
> Reddit post IDs to exclude from the feed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Reddit post comment metadata
>
> **Slug:** `TIK_HUB_REDDIT_APP_FETCH_POST_COMMENTS`
>
> Get comment metadata for a Reddit post by post ID, with sort and paging options. Returns post ID, title, comment count, subreddit identity and whether another page exists, but not comment text. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **after** `string`
>
> Pagination parameter for fetching next page
>
> **post\_id** `string` *required*
>
> Post ID
>
> **language** `string`
>
> Preferred response language as an IETF language tag; default: en-US
>
> **sort\_type** `string ("CONFIDENCE" | "NEW" | "TOP" | "HOT" | "CONTROVERSIAL" | "OLD" | "RANDOM")`
>
> Sort method: CONFIDENCE, NEW, TOP, HOT, CONTROVERSIAL, OLD, RANDOM
>
> **need\_format** `boolean`
>
> Whether to clean and format the data
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Reddit post details
>
> **Slug:** `TIK_HUB_REDDIT_APP_FETCH_POST_DETAILS`
>
> Get details of a Reddit post by post ID: title, author, score, upvote ratio, comment count, creation time, URL, permalink, flair, subreddit info and flags such as NSFW, locked and spoiler. Data provided through TikHub.
>
> #### Input Parameters
>
> **post\_id** `string` *required*
>
> Post ID
>
> **language** `string`
>
> Preferred response language as an IETF language tag; default: en-US
>
> **comment\_id** `string`
>
> 评论ID/Comment ID (when include\_comment\_id is True)
>
> **need\_format** `boolean`
>
> Whether to clean and format the data
>
> **include\_comment\_id** `boolean`
>
> 是否包含特定评论ID/Include specific comment ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Reddit post details in batch
>
> **Slug:** `TIK_HUB_REDDIT_APP_FETCH_POST_DETAILS_BATCH`
>
> Get details of up to 5 Reddit posts at once from comma-separated post IDs. Returns each post's title, author, score, comment count, creation time, URL, flair, subreddit info and status flags. Data provided through TikHub.
>
> #### Input Parameters
>
> **language** `string`
>
> Preferred response language as an IETF language tag; default: en-US
>
> **post\_ids** `string` *required*
>
> 帖子ID列表，逗号分隔，最多5条/Post IDs comma-separated, max 5
>
> **comment\_id** `string`
>
> 评论ID/Comment ID (when include\_comment\_id is True)
>
> **need\_format** `boolean`
>
> Whether to clean and format the data
>
> **include\_comment\_id** `boolean`
>
> 是否包含特定评论ID/Include specific comment ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Reddit post details in large batch
>
> **Slug:** `TIK_HUB_REDDIT_APP_FETCH_POST_DETAILS_BATCH_LARGE`
>
> Get details of up to 30 Reddit posts at once from comma-separated post IDs. Returns each post's title, author, score, comment count, creation time, URL, flair, subreddit info and status flags. Data provided through TikHub.
>
> #### Input Parameters
>
> **language** `string`
>
> Preferred response language as an IETF language tag; default: en-US
>
> **post\_ids** `string` *required*
>
> 帖子ID列表，逗号分隔，最多30条/Post IDs comma-separated, max 30
>
> **comment\_id** `string`
>
> 评论ID/Comment ID (when include\_comment\_id is True)
>
> **need\_format** `boolean`
>
> Whether to clean and format the data
>
> **include\_comment\_id** `boolean`
>
> 是否包含特定评论ID/Include specific comment ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Reddit search suggestions
>
> **Slug:** `TIK_HUB_REDDIT_APP_FETCH_SEARCH_TYPEAHEAD`
>
> Get Reddit search autocomplete suggestions for a query. Returns suggestion sections with each suggestion's query text, name, description and icon. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **query** `string` *required*
>
> Search query
>
> **language** `string`
>
> Preferred response language as an IETF language tag; default: en-US
>
> **allow\_nsfw** `string ("0" | "1")`
>
> Allow NSFW content: 0 or 1
>
> **need\_format** `boolean`
>
> Whether to clean and format the data
>
> **safe\_search** `string ("unset" | "strict")`
>
> Safe search setting: unset, strict
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get subreddit feed
>
> **Slug:** `TIK_HUB_REDDIT_APP_FETCH_SUBREDDIT_FEED`
>
> Get a page of a subreddit's feed by subreddit name, with sort order and post exclusions. Returns only feed paging data: the element count and the end cursor for the next page. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **sort** `string ("BEST" | "HOT" | "NEW" | "TOP" | "CONTROVERSIAL" | "RISING")`
>
> Feed sort order.
>
> **after** `string`
>
> Pagination token for the next page.
>
> **language** `string`
>
> Preferred response language as an IETF language tag.
>
> **need\_format** `boolean`
>
> Whether TikHub should normalize the provider payload.
>
> **filter\_posts** `array`
>
> Reddit post IDs to exclude from the feed.
>
> **subreddit\_name** `string` *required*
>
> Subreddit name without the r/ prefix.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Reddit subreddit info
>
> **Slug:** `TIK_HUB_REDDIT_APP_FETCH_SUBREDDIT_INFO`
>
> Get a subreddit's profile by name: title, description, subscriber and active counts, creation time, type, NSFW and quarantine flags, flair settings, styles, community stats and wiki status. Data provided through TikHub.
>
> #### Input Parameters
>
> **language** `string`
>
> Preferred response language as an IETF language tag; default: en-US
>
> **need\_format** `boolean`
>
> Whether to clean and format the data
>
> **subreddit\_name** `string`
>
> Subreddit name
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Reddit subreddit post flairs
>
> **Slug:** `TIK_HUB_REDDIT_APP_FETCH_SUBREDDIT_POST_CHANNELS`
>
> Get a subreddit's post flair templates by subreddit name. Returns each template's ID, text and moderator-only status. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **sort** `string ("BEST" | "HOT" | "NEW" | "TOP" | "CONTROVERSIAL" | "RISING")`
>
> Sort method: HOT, NEW, TOP, CONTROVERSIAL, RISING
>
> **range** `string ("ALL" | "HOUR" | "DAY" | "WEEK" | "MONTH" | "YEAR")`
>
> Time range: HOUR, DAY, WEEK, MONTH, YEAR, ALL
>
> **language** `string`
>
> Preferred response language as an IETF language tag; default: en-US
>
> **need\_format** `boolean`
>
> Whether to clean and format the data
>
> **subreddit\_name** `string`
>
> Subreddit name
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Reddit subreddit settings
>
> **Slug:** `TIK_HUB_REDDIT_APP_FETCH_SUBREDDIT_SETTINGS`
>
> Get a subreddit's settings by subreddit ID: allowed post types, author and post flair settings, comment contribution settings, country site and language, and discovery and archive flags. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **language** `string`
>
> Preferred response language as an IETF language tag; default: en-US
>
> **need\_format** `boolean`
>
> Whether to clean and format the data
>
> **subreddit\_id** `string` *required*
>
> Subreddit ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Reddit subreddit rules and style
>
> **Slug:** `TIK_HUB_REDDIT_APP_FETCH_SUBREDDIT_STYLE`
>
> Get a subreddit's rules and visual style by name. Returns each rule's ID, name, priority and violation reason, plus banner, icon, primary and highlight colors. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **language** `string`
>
> Preferred response language as an IETF language tag; default: en-US
>
> **need\_format** `boolean`
>
> Whether to clean and format the data
>
> **subreddit\_name** `string`
>
> Subreddit name
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Reddit trending searches
>
> **Slug:** `TIK_HUB_REDDIT_APP_FETCH_TRENDING_SEARCHES`
>
> List currently trending Reddit search queries. Returns each query's ID, display text, raw query and trending icon. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **language** `string`
>
> Preferred response language as an IETF language tag; default: en-US
>
> **need\_format** `boolean`
>
> Whether to clean and format the data
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Reddit user active subreddits
>
> **Slug:** `TIK_HUB_REDDIT_APP_FETCH_USER_ACTIVE_SUBREDDITS`
>
> List the subreddits a Reddit user is active in, by username. Returns each subreddit's name, icon, member count and activity level. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **language** `string`
>
> Preferred response language as an IETF language tag; default: en-US
>
> **username** `string` *required*
>
> Username
>
> **need\_format** `boolean`
>
> Whether to clean and format the data
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Reddit user comments
>
> **Slug:** `TIK_HUB_REDDIT_APP_FETCH_USER_COMMENTS`
>
> List a Reddit user's comments by username, with sort, page-size and paging options. Returns each comment's ID, creation time, text preview, score and parent post ID and title, plus an end cursor and has-next-page flag. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **sort** `string ("NEW" | "TOP" | "HOT" | "CONTROVERSIAL")`
>
> Sort method: NEW, TOP, HOT, CONTROVERSIAL
>
> **after** `string`
>
> Pagination parameter
>
> **language** `string`
>
> Preferred response language as an IETF language tag; default: en-US
>
> **username** `string` *required*
>
> Username
>
> **page\_size** `integer`
>
> Page size (default: 25)
>
> **need\_format** `boolean`
>
> Whether to clean and format the data
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Reddit user posts
>
> **Slug:** `TIK_HUB_REDDIT_APP_FETCH_USER_POSTS`
>
> Get a page of a Reddit user's posts by username, with sort order and an after token. Returns only paging data: whether another page exists and the end cursor. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **sort** `string ("NEW" | "TOP" | "HOT" | "CONTROVERSIAL")`
>
> Post sort order.
>
> **after** `string`
>
> Pagination token for the next page.
>
> **language** `string`
>
> Preferred response language as an IETF language tag.
>
> **username** `string` *required*
>
> Reddit username.
>
> **need\_format** `boolean`
>
> Whether TikHub should normalize the provider payload.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Reddit user profile
>
> **Slug:** `TIK_HUB_REDDIT_APP_FETCH_USER_PROFILE`
>
> Get a Reddit user's profile by username: ID, karma breakdown, post and comment counts, account type, verified and premium flags, profile title and description, and trophy case summary. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **language** `string`
>
> Preferred response language as an IETF language tag; default: en-US
>
> **username** `string` *required*
>
> Username
>
> **need\_format** `boolean`
>
> Whether to clean and format the data
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Reddit user trophies
>
> **Slug:** `TIK_HUB_REDDIT_APP_FETCH_USER_TROPHIES`
>
> List a Reddit user's trophies by username. Returns trophy categories with each trophy's ID, name, image URL and number unlocked. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **language** `string`
>
> Preferred response language as an IETF language tag; default: en-US
>
> **username** `string` *required*
>
> Username
>
> **need\_format** `boolean`
>
> Whether to clean and format the data
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get info for multiple Telegram channels
>
> **Slug:** `TIK_HUB_TELEGRAM_WEB_BATCH_CHANNEL_INFO`
>
> Get info for up to 20 public Telegram channels at once from comma-separated usernames. Returns each channel's title, description, subscriber count, photo and verified flag, plus a per-channel ok flag. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.008 per request
>
> #### Input Parameters
>
> **channels** `string` *required*
>
> Comma-separated usernames (max 20).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Telegram channel info
>
> **Slug:** `TIK_HUB_TELEGRAM_WEB_FETCH_CHANNEL_INFO`
>
> Get a public Telegram channel's info by username: title, description, subscriber count, photo, verified flag and counters for links, photos and videos. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **channel** `string` *required*
>
> Channel username.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Telegram channel posts
>
> **Slug:** `TIK_HUB_TELEGRAM_WEB_FETCH_CHANNEL_POSTS`
>
> List posts from a public Telegram channel by username (1-100 per call; page with before/after post IDs). Returns each post's ID, date, text, views, media and link preview, plus channel info and paging cursors. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **after** `integer`
>
> Newer than this id.
>
> **limit** `integer`
>
> Number of posts.
>
> **before** `integer`
>
> Older than this id.
>
> **channel** `string` *required*
>
> Channel username.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Telegram channel posts
>
> **Slug:** `TIK_HUB_TELEGRAM_WEB_FETCH_CHANNEL_SEARCH`
>
> Search a public Telegram channel's posts by keyword. Returns matching posts with ID, date, text, views, forward flag and link preview, plus matched and scanned counts. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **limit** `integer`
>
> Number of hits.
>
> **query** `string` *required*
>
> Keyword.
>
> **channel** `string` *required*
>
> Channel username.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Telegram post details
>
> **Slug:** `TIK_HUB_TELEGRAM_WEB_FETCH_POST_DETAIL`
>
> Get a single Telegram channel post by channel username and post ID: text, date, author, views, photos, reactions with emoji counts, forward flag and URL. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **channel** `string` *required*
>
> Channel username.
>
> **post\_id** `integer` *required*
>
> Post ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Threads post comments
>
> **Slug:** `TIK_HUB_THREADS_WEB_FETCH_POST_COMMENTS`
>
> List comments on a Threads post by post ID, with an optional end cursor for paging. Returns comment IDs and thread types, per-edge cursors and page info, without comment text.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Pricing is not available.
>
> #### Input Parameters
>
> **post\_id** `string` *required*
>
> Post ID
>
> **end\_cursor** `string`
>
> 分页游标/Pagination cursor (optional)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Threads post details
>
> **Slug:** `TIK_HUB_THREADS_WEB_FETCH_POST_DETAIL`
>
> Get a Threads post by post ID. Returns the post ID, thread type, a pagination cursor and the type of each item in the thread.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.002 per request
>
> #### Input Parameters
>
> **post\_id** `string` *required*
>
> Post ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Threads user profile by ID
>
> **Slug:** `TIK_HUB_THREADS_WEB_FETCH_USER_INFO_BY_ID`
>
> Get a Threads user's profile by user ID. Returns username, full name, biography, follower count, verified and private flags, and profile picture URLs.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.002 per request
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> User ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Threads user reposts
>
> **Slug:** `TIK_HUB_THREADS_WEB_FETCH_USER_REPOSTS`
>
> List the posts a Threads user has reposted, by user ID. Returns each repost's ID and type plus page info with start and end cursors; pass end\_cursor to get the next page.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.002 per request
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> User ID
>
> **end\_cursor** `string`
>
> Pagination cursor (optional)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Threads profiles
>
> **Slug:** `TIK_HUB_THREADS_WEB_SEARCH_PROFILES`
>
> Search Threads profiles by keyword. Returns each match's profile ID, username, display name, picture URL, verification state and whether it is active on Threads.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.002 per request
>
> #### Input Parameters
>
> **query** `string` *required*
>
> Search query
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok ad interactive analysis
>
> **Slug:** `TIK_HUB_TIKTOK_ADS_GET_AD_INTERACTIVE_ANALYSIS`
>
> Returns interactive analysis data for a TikTok Creative Center ad by material ID, for a chosen metric type (ctr, cvr, clicks, conversion, remain) over a period in days (default 180).
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **material\_id** `string` *required*
>
> Ad material ID.
>
> **metric\_type** `string`
>
> Analysis type (ctr, cvr, clicks, conversion, remain).
>
> **period\_type** `integer`
>
> Period type (days).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok ad keyframe analysis
>
> **Slug:** `TIK_HUB_TIKTOK_ADS_GET_AD_KEYFRAME_ANALYSIS`
>
> Analyze a TikTok ad by material ID for one metric (retain\_ctr, retain\_cvr, click\_cnt, convert\_cnt or play\_retain\_cnt) and return per-second values, the video duration and highlight seconds.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **metric** `string`
>
> Analysis metric (retain\_ctr, retain\_cvr, click\_cnt, convert\_cnt, play\_retain\_cnt)
>
> **material\_id** `string` *required*
>
> Ad material ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok ad percentile ranking
>
> **Slug:** `TIK_HUB_TIKTOK_ADS_GET_AD_PERCENTILE`
>
> Returns how a TikTok Creative Center ad ranks, as a percentile, on a chosen metric (CTR, conversion rate, clicks, conversions or impressions) over a period in days. Needs the ad material ID.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **metric** `string`
>
> Analysis metric (ctr\_percentile, time\_attr\_conversion\_rate\_percentile, click\_cnt\_percentile, time\_attr\_convert\_cnt\_percentile, show\_cnt\_percentile).
>
> **material\_id** `string` *required*
>
> Ad material ID.
>
> **period\_type** `integer`
>
> Time period (days).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok ad details
>
> **Slug:** `TIK_HUB_TIKTOK_ADS_GET_ADS_DETAIL`
>
> Fetches the details of a single TikTok Creative Center ad by its ad ID. Returns the provider's ad data object as-is.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **ads\_id** `string` *required*
>
> Ad ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok ad safety configuration
>
> **Slug:** `TIK_HUB_TIKTOK_ADS_GET_CONFIGURE_SAFETY`
>
> Returns the safety configuration options used by TikTok Creative Center ad queries. Takes no inputs and returns the provider's data object as-is.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List TikTok Creative Center locations
>
> **Slug:** `TIK_HUB_TIKTOK_ADS_GET_LOCATION_LIST`
>
> Lists the locations (countries and regions) that TikTok Creative Center supports for ad filtering. Takes no inputs and returns the provider's data object as-is.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok Creative Center search suggestions
>
> **Slug:** `TIK_HUB_TIKTOK_ADS_GET_QUERY_SUGGESTIONS`
>
> Returns popular keyword suggestions (scenario 1, empty query) or related suggestions for a keyword (scenario 2), with an optional count (default 50) and country code.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **count** `integer`
>
> Suggestion count.
>
> **query** `string`
>
> Empty for scenario 1; input a keyword for scenario 2.
>
> **scenario** `integer`
>
> 1 popular, 2 related suggestions.
>
> **country\_code** `string`
>
> Optional country code.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok recommended ads
>
> **Slug:** `TIK_HUB_TIKTOK_ADS_GET_RECOMMENDED_ADS`
>
> Returns TikTok Creative Center ads recommended for a given ad material ID, narrowed by industry ID and country code (default US).
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **industry** `string`
>
> Industry ID.
>
> **material\_id** `string` *required*
>
> Ad material ID.
>
> **country\_code** `string`
>
> Country code.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List TikTok top ads filters
>
> **Slug:** `TIK_HUB_TIKTOK_ADS_GET_TOP_ADS_FILTERS`
>
> Lists the filter options available for TikTok Creative Center top-ads queries. Takes no inputs and returns the provider's data object as-is.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok top ads spotlight
>
> **Slug:** `TIK_HUB_TIKTOK_ADS_GET_TOP_ADS_SPOTLIGHT`
>
> Fetches the TikTok Creative Center top-ads spotlight, optionally narrowed by industry ID, with page and limit paging. Returns the provider's data object as-is.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number.
>
> **limit** `integer`
>
> Items per page.
>
> **industry** `string`
>
> Industry ID (optional).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List TikTok top-ranked content
>
> **Slug:** `TIK_HUB_TIKTOK_ADS_GET_TOP_CONTENTS_LIST`
>
> Lists the top 100 ranked TikTok Creative Center videos (trending videos) for a ranking period end timestamp and period dimension, with country, content-label, order-metric and organic-only filters plus paging. An empty list is not an error: TikHub's ranking data lags about two days, so rankings for today and yesterday (UTC) usually come back empty. Request period\_end\_timestamp as midnight UTC at least two days ago; weekly rankings (period\_dimension 1) need a Sunday 00:00 UTC. Also empty for period\_end\_timestamp 0 and for countries TikTok does not publish (US, TH, JP, ID, VN worked as of 2026-08).
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number.
>
> **limit** `integer`
>
> Items per page, max 100.
>
> **country\_code** `string`
>
> Country or region code for the ranking. TikTok only publishes rankings for some countries; US, TH, JP, ID and VN returned data as of 2026-08 and other codes return an empty result rather than an error.
>
> **organic\_only** `boolean`
>
> Organic content only.
>
> **order\_by\_metric** `integer`
>
> Sort metric: 1 for video views (default), 2 for engagement rate, or 3 for six-second view-through rate.
>
> **period\_dimension** `integer`
>
> Ranking period: 1 for the weekly ranking (period\_end\_timestamp must be a Sunday 00:00 UTC), 3 for the daily ranking (default), or 5 for the long-period ranking that covers videos over a longer time span.
>
> **content\_label\_ids** `string`
>
> Content label IDs, comma separated.
>
> **period\_end\_timestamp** `integer` *required*
>
> Required 10-digit Unix timestamp in seconds for the end of the ranking period, for example midnight UTC seven days ago. Do not pass 0: it returns an empty result. For period\_dimension 3 or 5 any past date works in the provider documentation, but the most recent day or two can be empty because of a data lag we observed (UTC yesterday returned nothing while the day before returned data), so for the latest ranking use midnight UTC two or more days ago. For period\_dimension 1 pass a Sunday 00:00 UTC timestamp; other dates return no data.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List TikTok trending hashtags
>
> **Slug:** `TIK_HUB_TIKTOK_ADS_GET_TRENDS_HASHTAG_LIST`
>
> Lists trending TikTok hashtags from Creative Center for a time range in days and a country code (default US), optionally narrowed by first-level industry ID, with page and limit paging.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number.
>
> **limit** `integer`
>
> Items per page.
>
> **time\_range** `integer`
>
> Time range in days.
>
> **industry\_id** `integer`
>
> First-level industry ID (optional).
>
> **country\_code** `string`
>
> Country code.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search TikTok Creative Center ads
>
> **Slug:** `TIK_HUB_TIKTOK_ADS_SEARCH_ADS`
>
> Searches TikTok Creative Center ads by keyword, industry, objective, performance rank, period, country, ad format, language and duration. Sorts by for\_you or likes, with page and limit paging.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **like** `integer`
>
> Performance rank (optional; 1:1-20% 2:21-40% 3:41-60% 4:61-80% 5:81-100%).
>
> **page** `integer`
>
> Page number.
>
> **limit** `integer`
>
> Items per page.
>
> **period** `integer`
>
> Time period (days).
>
> **keyword** `string`
>
> Search keyword.
>
> **duration** `integer`
>
> Video duration filter value (optional).
>
> **industry** `string`
>
> Industry ID.
>
> **order\_by** `string`
>
> Sort by (for\_you, likes).
>
> **ad\_format** `integer`
>
> Ad format (optional; 1:Spark Ads 2:Non-Spark Ads).
>
> **objective** `integer`
>
> Ad objective (optional; 1: 2: 3: 4: 5: 6: 7:).
>
> **search\_id** `string`
>
> Search ID (optional).
>
> **ad\_language** `string`
>
> Ad language (optional).
>
> **country\_code** `string`
>
> Country code.
>
> **pattern\_label** `string`
>
> Creative pattern label (optional).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Detect fake views on a TikTok video
>
> **Slug:** `TIK_HUB_TIKTOK_ANALYTICS_DETECT_FAKE_VIEWS`
>
> Estimate whether a TikTok video's views are inflated, given its video ID and a content category. Returns a fake score, estimated fake-view percentage and count, suspicious flag and reason, traffic-pool tier, creator and engagement metrics, and recommendations.
>
> #### Input Parameters
>
> **item\_id** `string` *required*
>
> Video id
>
> **content\_category** `string ("default" | "entertainment" | "education" | "product" | "verified_large")`
>
> 内容分类/Content category, options: default, entertainment, education, product, verified\_large
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Analyze TikTok Comment Keywords
>
> **Slug:** `TIK_HUB_TIKTOK_ANALYTICS_FETCH_COMMENT_KEYWORDS`
>
> Extract recurring keywords and representative comments for a TikTok video.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **item\_id** `string` *required*
>
> TikTok video identifier to analyze.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok creator info and milestones
>
> **Slug:** `TIK_HUB_TIKTOK_ANALYTICS_FETCH_CREATOR_INFO_AND_MILESTONES`
>
> Fetches a TikTok creator's profile info and milestones from their user ID. Returns creator\_info, milestones and user\_id.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> User id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok video analytics metrics
>
> **Slug:** `TIK_HUB_TIKTOK_ANALYTICS_FETCH_VIDEO_METRICS`
>
> Fetches analytics for a TikTok video from its item ID. Returns views, likes, comments and favorites, with 14-day figures and a video summary.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **item\_id** `string` *required*
>
> Video id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Check if a TikTok live room is online
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_CHECK_LIVE_ROOM_ONLINE`
>
> Check whether a TikTok live room is currently online, given its live room ID. Returns the provider's online status data for that room.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **room\_id** `string` *required*
>
> Live room id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Check if several TikTok live rooms are online
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_CHECK_LIVE_ROOM_ONLINE_BATCH`
>
> Check the online status of multiple TikTok live rooms in one call, given a list of live room IDs. Returns the provider's online status data for the rooms.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **room\_ids** `array` *required*
>
> List of TikTok live room IDs
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Translate text with TikTok
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_CONTENT_TRANSLATE`
>
> Translate text into a target language using TikTok's translation service. Takes the source text and a target language code such as zh-Hans, and returns the translated content list.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **trg\_lang** `string`
>
> Target language ISO639-1 code, e.g. zh-Hans
>
> **src\_content** `string`
>
> Source language content, i.e. the content to be translated
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List TikTok creator search insights
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_CREATOR_SEARCH_INSIGHTS`
>
> List TikTok creator search insights (inspiration items) with offset and limit paging and optional tab, language, category and creator-source filters. Returns inspiration\_list, cursor and has\_more; items supply the query ID used by the detail and trend insight tools.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **tab** `string`
>
> hashtags)
>
> **limit** `integer`
>
> Number per page
>
> **offset** `integer`
>
> Pagination offset
>
> **force\_refresh** `boolean`
>
> Force refresh
>
> **creator\_source** `string`
>
> Creator source
>
> **category\_filters** `string`
>
> Sports)
>
> **language\_filters** `string`
>
> ko)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok creator search audience demographics
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_CREATOR_SEARCH_INSIGHTS_DETAIL`
>
> Get audience demographics for a TikTok creator search insight, given its query ID, a time range (optionally custom start and end timestamps) and dimensions such as gender, age and country. Returns age, gender, location and demographics breakdowns.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **end\_date** `integer`
>
> End timestamp (seconds), only for custom range
>
> **start\_date** `integer`
>
> Start timestamp (seconds), only for custom range
>
> **time\_range** `string`
>
> custom)
>
> **query\_id\_str** `string` *required*
>
> Query ID from fetch\_creator\_search\_insights
>
> **dimension\_list** `string`
>
> country)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok creator search insight trends
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_CREATOR_SEARCH_INSIGHTS_TREND`
>
> Get trend data for a TikTok creator search insight, given its query ID. Returns the top countries and the user inspiration trend data for that query.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **query\_id\_str** `string` *required*
>
> Query ID from fetch\_creator\_search\_insights
>
> **from\_tab\_path** `string`
>
> From tab path
>
> **query\_analysis\_required** `boolean`
>
> Whether query analysis is required
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok hashtag details by ID
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_HASHTAG_DETAIL`
>
> Get details for a TikTok hashtag (challenge), given its hashtag ID and a region such as US, GB, FR, JP, VN or SG. Returns the hashtag info (ch\_info).
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **ch\_id** `string` *required*
>
> Hashtag id
>
> **region** `string`
>
> Region (US, GB, FR, JP, VN, SG)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search TikTok hashtags by keyword
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_HASHTAG_SEARCH_RESULT`
>
> Search TikTok hashtags (challenges) by keyword. Returns the matching challenge\_list with cursor and has\_more; use offset 0 for the first page and reuse the returned cursor while has\_more is true.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **count** `integer`
>
> Number
>
> **offset** `integer`
>
> Use 0 for the first page. Reuse data.cursor while data.has\_more is nonzero; stop when data.has\_more is 0.
>
> **keyword** `string` *required*
>
> Keyword
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List TikTok Hashtag Videos
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_HASHTAG_VIDEO_LIST`
>
> Get one cursor-paginated page of TikTok videos associated with a hashtag ID.
>
> #### Input Parameters
>
> **count** `integer`
>
> Number of videos to request.
>
> **cursor** `integer`
>
> Use 0 for the first page, then pass the cursor returned by the previous page.
>
> **region** `string ("US" | "GB" | "FR" | "JP" | "VN" | "SG")`
>
> TikTok region.
>
> **hashtag\_id** `string` *required*
>
> TikTok hashtag identifier.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Fetch TikTok Live Daily Rank
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_LIVE_DAILY_RANK`
>
> Fetch the daily TikTok live creator ranking and the selected creator's position.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **room\_id** `string`
>
> TikTok live room identifier.
>
> **anchor\_id** `string`
>
> TikTok live anchor identifier.
>
> **rank\_type** `integer`
>
> Provider ranking type.
>
> **region\_type** `integer`
>
> Provider region type.
>
> **gap\_interval** `integer`
>
> Ranking time interval.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok live room ranking list
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_LIVE_RANKING_LIST`
>
> Get the ranking list for a TikTok live room, given the live room ID and the anchor (host) ID. Returns the provider's ranking data along with its status code.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **room\_id** `string` *required*
>
> Live room id
>
> **anchor\_id** `string` *required*
>
> Anchor id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok live room info
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_LIVE_ROOM_INFO`
>
> Get information about a TikTok live room, given its live room ID. Returns the provider's room data along with its status code.
>
> #### Input Parameters
>
> **room\_id** `string` *required*
>
> Live room id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List products in a TikTok live room
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_LIVE_ROOM_PRODUCT_LIST`
>
> List products featured in a TikTok live room, given the live room ID and the anchor (author) ID, with page size, offset and region options. Returns the provider's product data with status code and message.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **offset** `integer`
>
> Number
>
> **region** `string`
>
> Region
>
> **room\_id** `string` *required*
>
> Live room id
>
> **author\_id** `string` *required*
>
> Anchor id
>
> **page\_size** `integer`
>
> Number
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search TikTok locations by keyword
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_LOCATION_SEARCH`
>
> Search TikTok locations (points of interest) by keyword. Returns poi\_info with cursor and has\_more; use offset 0 for the first page and reuse the returned cursor while has\_more is true.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **count** `integer`
>
> Number
>
> **offset** `integer`
>
> Use 0 for the first page. Reuse data.cursor while data.has\_more is nonzero; stop when data.has\_more is 0.
>
> **keyword** `string` *required*
>
> Keyword
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok music details
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_MUSIC_DETAIL`
>
> Get details for a TikTok sound by music ID. Returns music\_info, music\_chart\_rank and whether a Behind the Song entry exists.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **music\_id** `string` *required*
>
> Music id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List TikTok music videos
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_MUSIC_VIDEO_LIST`
>
> Get one cursor-paginated page of TikTok videos that use a specified music track.
>
> #### Input Parameters
>
> **count** `integer`
>
> Number of videos to return.
>
> **cursor** `integer`
>
> Page cursor; use 0 for the first page.
>
> **music\_id** `string` *required*
>
> TikTok music identifier.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok video details (app)
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_ONE_VIDEO`
>
> Get a TikTok video by video (aweme) ID using the app API. Returns the author, engagement counts and playback media metadata. Preferred over V2 by default, as no functional difference between them is substantiated.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **aweme\_id** `string` *required*
>
> TikTok video identifier.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok video details (app, V2)
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_ONE_VIDEO_V2`
>
> Get a TikTok video by video (aweme) ID using the V2 app API. Returns the author, engagement counts and playback media metadata. Use only when V2 is explicitly required; otherwise prefer the standard app video lookup.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **aweme\_id** `string` *required*
>
> TikTok video identifier.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok video details (app, V3)
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_ONE_VIDEO_V3`
>
> Get a TikTok video by video (aweme) ID and two-letter country code using the V3 app API. Returns the author, engagement counts and playback media metadata.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **region** `string`
>
> Two-letter country code.
>
> **aweme\_id** `string` *required*
>
> TikTok video identifier.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate a TikTok share QR code
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_SHARE_QR_CODE`
>
> Generate a TikTok share QR code for an object, given its object ID and a schema type. Returns the QR code image URL (qrcode\_url).
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **object\_id** `string` *required*
>
> Object id
>
> **schema\_type** `integer`
>
> Schema type
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Shorten a TikTok share link
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_SHARE_SHORT_LINK`
>
> Convert a TikTok share link into a shortened share URL. Takes the share link and returns the shortened URL (shorten\_url).
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Share link
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok user country by username
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_USER_COUNTRY_BY_USERNAME`
>
> Look up the country of a TikTok account from its username. Returns the country, user ID, sec user ID, username and the time the username was last modified.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **username** `string` *required*
>
> Username
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List accounts a TikTok user follows
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_USER_FOLLOWING_LIST`
>
> List the accounts a TikTok user follows, given their user ID or sec user ID. Returns one page of followings with has\_more, min\_time and page\_token to fetch the next page.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **count** `integer`
>
> Number
>
> **user\_id** `string`
>
> TikTok numeric user ID. Provide this or sec\_user\_id; an identifier is required.
>
> **min\_time** `integer`
>
> Minimum time for paging
>
> **page\_token** `string`
>
> Page token
>
> **sec\_user\_id** `string`
>
> TikTok secured user ID. Provide this or user\_id; an identifier is required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List music used by a TikTok user
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_USER_MUSIC_LIST`
>
> List music associated with a TikTok user, given their sec user ID, with cursor paging and a count. Returns one page of music tracks plus the next cursor and has\_more.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **count** `integer`
>
> Number of tracks to return.
>
> **cursor** `integer`
>
> Page cursor.
>
> **sec\_uid** `string` *required*
>
> TikTok secure user identifier.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Fetch TikTok User Post Videos
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_USER_POST_VIDEOS`
>
> Fetch one page of videos posted by a TikTok user, selected by secure user ID or username and ordered by latest or popularity.
>
> #### Input Parameters
>
> **count** `integer`
>
> Requested number of videos.
>
> **region** `string`
>
> Preferred region code, such as US or GB; TikHub defaults to US when omitted.
>
> **sort\_type** `integer ("0" | "1")`
>
> Sort order: 0 for latest or 1 for popular.
>
> **unique\_id** `string`
>
> TikTok username. Provide this or sec\_user\_id; at least one is required. Used when sec\_user\_id is absent.
>
> **max\_cursor** `integer`
>
> Cursor from the previous response; use 0 for the first page.
>
> **sec\_user\_id** `string`
>
> TikTok secure user ID. Provide this or unique\_id; at least one is required. Preferred when both are supplied.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search TikTok App Users
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_USER_SEARCH_RESULT`
>
> Search TikTok users with optional provider-supported preference filters.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **count** `integer`
>
> Number of users to return.
>
> **offset** `integer`
>
> Use 0 for the first page. Reuse data.cursor while data.has\_more is nonzero; stop when data.has\_more is 0.
>
> **keyword** `string` *required*
>
> User search keyword.
>
> **user\_search\_other\_pref** `string`
>
> Provider additional search preference.
>
> **user\_search\_profile\_type** `string`
>
> Provider account-type preference.
>
> **user\_search\_follower\_count** `string`
>
> Provider follower-count sort preference.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List replies to a TikTok comment (app)
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_VIDEO_COMMENT_REPLIES`
>
> List replies to a comment on a TikTok video, given the video ID and parent comment ID. Returns one page of replies with the next cursor, has\_more and total reply count.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **count** `integer`
>
> Number of replies to return.
>
> **cursor** `integer`
>
> Page cursor.
>
> **item\_id** `string` *required*
>
> TikTok video identifier.
>
> **comment\_id** `string` *required*
>
> Parent comment identifier.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List TikTok video comments (app)
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_VIDEO_COMMENTS`
>
> List comments on a TikTok video by video (aweme) ID using the app API. Returns one page of comments with author summaries, the next cursor, has\_more and total comment count.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **count** `integer`
>
> Number of comments to return.
>
> **cursor** `integer`
>
> Page cursor.
>
> **aweme\_id** `string` *required*
>
> TikTok video identifier.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search TikTok videos
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_VIDEO_SEARCH_RESULT`
>
> Search TikTok videos by keyword with ordering, publication-time, region, and offset pagination filters.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> #### Input Parameters
>
> **count** `integer`
>
> Requested result count.
>
> **offset** `integer`
>
> Use 0 initially, then the returned cursor.
>
> **region** `string`
>
> TikTok region or ISO country code.
>
> **keyword** `string` *required*
>
> Search keyword.
>
> **sort\_type** `integer ("0" | "1")`
>
> Sort order: 0 for relevance or 1 for most likes.
>
> **publish\_time** `integer ("0" | "1" | "7" | "30" | "90" | "180")`
>
> Publication window in days; 0 means unrestricted.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok live user info
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_WEBCAST_USER_INFO`
>
> Get the live (webcast) profile data for a TikTok user, given their sec user ID and optionally their numeric user ID. Returns the provider's webcast user data.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **user\_id** `string`
>
> User uid (optional, pure number)
>
> **sec\_user\_id** `string`
>
> User sec\_user\_id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok user IDs by username
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_GET_USER_ID_AND_SEC_USER_ID_BY_USERNAME`
>
> Resolve a TikTok username to the account's numeric user ID and sec user ID.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **username** `string` *required*
>
> Username
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok App User Profile
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_GET_USER_PROFILE`
>
> Get a TikTok app profile by secure user ID, user ID, or username, including public profile and engagement fields. This provider call may incur TikHub usage charges.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **user\_id** `string`
>
> User uid (optional, pure number)
>
> **unique\_id** `string`
>
> User unique\_id (username)
>
> **sec\_user\_id** `string`
>
> User sec\_user\_id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate TikTok keyword-search handoff URL
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_OPEN_TIKTOK_APP_TO_KEYWORD_SEARCH`
>
> Generate and return a TikTok mobile-app handoff URL for a keyword search. This read-only action does not open the app; a human must open the URL.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **keyword** `string` *required*
>
> Keyword
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate TikTok private-message handoff URL
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_OPEN_TIKTOK_APP_TO_SEND_PRIVATE_MESSAGE`
>
> Generate and return a TikTok mobile-app handoff URL for a private-message recipient. This read-only action does not open the app or send a message; a human must complete the send.
>
> #### Input Parameters
>
> **uid** `string` *required*
>
> User id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate TikTok profile handoff URL
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_OPEN_TIKTOK_APP_TO_USER_PROFILE`
>
> Generate and return a TikTok mobile-app handoff URL for a user profile. This read-only action does not open the app; a human must open the URL.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **uid** `string` *required*
>
> User id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate TikTok video handoff URL
>
> **Slug:** `TIK_HUB_TIKTOK_APP_V3_OPEN_TIKTOK_APP_TO_VIDEO_DETAIL`
>
> Generate and return a TikTok mobile-app handoff URL for a video. This read-only action does not open the app; a human must open the URL.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **aweme\_id** `string` *required*
>
> Video id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Fetch TikTok Shop Product Detail
>
> **Slug:** `TIK_HUB_TIKTOK_SHOP_WEB_FETCH_PRODUCT_DETAIL`
>
> Fetch TikTok Shop product and seller identifiers using product ID, optional seller ID, and region. Use V3 when seller ID is unavailable and its page-level result is sufficient.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **region** `string`
>
> TikTok Shop region code.
>
> **seller\_id** `string`
>
> Optional seller identifier.
>
> **product\_id** `string` *required*
>
> TikTok Shop product identifier.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok Shop product page ID
>
> **Slug:** `TIK_HUB_TIKTOK_SHOP_WEB_FETCH_PRODUCT_DETAIL_V3`
>
> Look up a TikTok Shop product by product ID and region. Returns only the product page identifier (page\_id from the product's A/B test data), not full product details.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **region** `string`
>
> Region code
>
> **product\_id** `string` *required*
>
> Product ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok Shop product ID from share link
>
> **Slug:** `TIK_HUB_TIKTOK_SHOP_WEB_FETCH_PRODUCT_ID_BY_SHARE_LINK`
>
> Resolve a TikTok Shop product share link to the product. Takes the share link and a region, and returns the product\_id and product\_link.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **region** `string`
>
> Region code selecting the egress used to follow the share link.
>
> **share\_link** `string` *required*
>
> Share link
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List TikTok Shop product categories
>
> **Slug:** `TIK_HUB_TIKTOK_SHOP_WEB_FETCH_PRODUCTS_CATEGORY_LIST`
>
> List the TikTok Shop product categories available for a region (default US).
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **region** `string`
>
> Region code
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search TikTok Shop Products
>
> **Slug:** `TIK_HUB_TIKTOK_SHOP_WEB_FETCH_SEARCH_PRODUCTS_LIST`
>
> Search TikTok Shop products through the original /fetch\_search\_products\_list route. Prefer this original route by default because no documented or live functional difference from V2 is substantiated.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **offset** `integer`
>
> Use 0 for the first page. Reuse data.data.load\_more\_params.offset while data.data.has\_more is true; stop when false.
>
> **region** `string`
>
> TikTok Shop region code.
>
> **page\_token** `string`
>
> Use an empty string for the first page. Reuse data.data.load\_more\_params.page\_token while data.data.has\_more is true; stop when false.
>
> **search\_word** `string` *required*
>
> Product search keyword.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search TikTok Shop Products V2
>
> **Slug:** `TIK_HUB_TIKTOK_SHOP_WEB_FETCH_SEARCH_PRODUCTS_LIST_V2`
>
> Search TikTok Shop products through the /fetch\_search\_products\_list\_v2 route. Use only when the caller explicitly requires V2; otherwise prefer the original route because no documented or live functional difference is substantiated.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **offset** `integer`
>
> Use 0 for the first page. Reuse data.data.component\_data.offset while data.data.component\_data.has\_more is true; stop when false.
>
> **region** `string`
>
> TikTok Shop region code.
>
> **page\_token** `string`
>
> Use an empty string for the first page. Reuse data.data.component\_data.load\_more\_params.page\_token while data.data.component\_data.has\_more is true; stop when false.
>
> **search\_word** `string` *required*
>
> Product search keyword.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Suggest TikTok Shop search keywords
>
> **Slug:** `TIK_HUB_TIKTOK_SHOP_WEB_FETCH_SEARCH_WORD_SUGGESTION_V2`
>
> Get TikTok Shop search keyword suggestions for a search word, language and region (mobile version). Returns the provider's suggestion data with its code and message.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **lang** `string`
>
> Language
>
> **region** `string`
>
> Region code
>
> **search\_word** `string` *required*
>
> Search keyword
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List TikTok Shop seller products
>
> **Slug:** `TIK_HUB_TIKTOK_SHOP_WEB_FETCH_SELLER_PRODUCTS_LIST`
>
> List products sold by a TikTok Shop seller, given the seller ID and a region. Returns products and has\_more; pass the search params from a previous response to page.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **region** `string`
>
> Region code
>
> **seller\_id** `string` *required*
>
> Seller ID
>
> **search\_params** `string`
>
> Search params (for pagination)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok Shop ID from share link
>
> **Slug:** `TIK_HUB_TIKTOK_SHOP_WEB_FETCH_SHOP_ID_BY_SHARE_LINK`
>
> Resolve a TikTok Shop share link to the shop. Takes the share link and a region, and returns the shop\_id and shop\_link.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **region** `string`
>
> Region code selecting the egress used to follow the share link.
>
> **share\_link** `string` *required*
>
> Share link
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Check if several TikTok lives are active (web)
>
> **Slug:** `TIK_HUB_TIKTOK_WEB_FETCH_BATCH_CHECK_LIVE_ALIVE`
>
> Check whether multiple TikTok live streams are currently active, given up to 50 live room IDs separated by commas. Returns per-room results and the number of rooms queried.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** From \$0.025 per TikTok live room checked (up to 50 per batch)
>
> #### Input Parameters
>
> **room\_ids** `string` *required*
>
> Live room ID list separated by commas, up to 50 IDs
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Check if a TikTok live is active (web)
>
> **Slug:** `TIK_HUB_TIKTOK_WEB_FETCH_CHECK_LIVE_ALIVE`
>
> Check whether a TikTok live stream is currently active, given its live room ID. Returns the live room status.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.002 per request
>
> #### Input Parameters
>
> **room\_id** `string` *required*
>
> Live room ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok live gift name by ID
>
> **Slug:** `TIK_HUB_TIKTOK_WEB_FETCH_GIFT_NAME_BY_ID`
>
> Look up the name of a TikTok live gift from its gift ID. Returns the gift ID, gift name and a status code.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **gift\_id** `string` *required*
>
> Gift ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok live gift names by IDs
>
> **Slug:** `TIK_HUB_TIKTOK_WEB_FETCH_GIFT_NAMES_BY_IDS`
>
> Look up names of multiple TikTok live gifts from a list of gift IDs; the first 50 are processed if more are given. Returns results, found and not-found IDs, totals and a truncated flag.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0.025 per gift-name lookup batch (up to 50 IDs)
>
> #### Input Parameters
>
> **gift\_ids** `array` *required*
>
> call for best value (\$0.025), auto-process first 50 if more than 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List TikTok live recommendation tabs
>
> **Slug:** `TIK_HUB_TIKTOK_WEB_FETCH_LIVE_RECOMMEND_TABS`
>
> List the recommendation tabs shown on TikTok Live, with tab name and type. Pass the logid from a previous response to load more; leave it empty for the first page.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **logid** `string`
>
> Pagination cursor, leave empty for the first page; pass the `logid` from the previous response to load more
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok video AI article
>
> **Slug:** `TIK_HUB_TIKTOK_WEB_FETCH_POST_AI_ARTICLE`
>
> Get the AI-generated article data for a TikTok video, given its video ID. Returns the post's itemCustomTDK data and a status code.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **item\_id** `string` *required*
>
> Video id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List TikTok video comments (web)
>
> **Slug:** `TIK_HUB_TIKTOK_WEB_FETCH_POST_COMMENT`
>
> List public comments on a TikTok post by video (aweme) ID using the web API, with an optional region. Returns one page of comments with author summaries, the next cursor, has\_more and total comment count.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **count** `integer`
>
> Number of comments to return.
>
> **cursor** `integer`
>
> Page cursor.
>
> **aweme\_id** `string` *required*
>
> TikTok video identifier.
>
> **current\_region** `string`
>
> Optional current region code.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok search suggestions (web)
>
> **Slug:** `TIK_HUB_TIKTOK_WEB_FETCH_SEARCH_KEYWORD_SUGGEST`
>
> Get TikTok search keyword suggestions for a partial keyword. Returns the provider's suggestion data and log ID.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **keyword** `string` *required*
>
> Search keyword
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search TikTok Live Streams
>
> **Slug:** `TIK_HUB_TIKTOK_WEB_FETCH_SEARCH_LIVE`
>
> Search public TikTok live streams and return room commerce and battle indicators.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **count** `integer`
>
> Number of results to return.
>
> **offset** `integer`
>
> Use 0 for the first page. Reuse data.cursor while data.has\_more is nonzero; stop when data.has\_more is 0.
>
> **keyword** `string` *required*
>
> Live-stream search keyword.
>
> **search\_id** `string`
>
> Search identifier returned by a prior page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok hashtag details by name (web)
>
> **Slug:** `TIK_HUB_TIKTOK_WEB_FETCH_TAG_DETAIL`
>
> Get details for a TikTok hashtag by its tag name (without #). Returns the challenge info (hashtag stats and metadata), share metadata and a status code.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **tag\_name** `string` *required*
>
> Tag name
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok live room data from URL
>
> **Slug:** `TIK_HUB_TIKTOK_WEB_FETCH_TIKTOK_LIVE_DATA`
>
> Get live room data for a TikTok live stream from its live room URL. Returns the room's current state, including anchor details.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **live\_room\_url** `string` *required*
>
> Live room link
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List TikTok trending search words
>
> **Slug:** `TIK_HUB_TIKTOK_WEB_FETCH_TRENDING_SEARCHWORDS`
>
> List the currently trending TikTok search words. Takes no input and returns trending\_search\_words.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok user profile (web)
>
> **Slug:** `TIK_HUB_TIKTOK_WEB_FETCH_USER_PROFILE`
>
> Get a TikTok user's public profile, given their uniqueId (username) or secUid. Returns user\_info and share metadata.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **sec\_uid** `string`
>
> User secUid
>
> **unique\_id** `string`
>
> User uniqueId
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert TikTok email to hashed ID
>
> **Slug:** `TIK_HUB_TIKTOK_WEB_GENERATE_HASHED_ID`
>
> Converts an email address into the hashed ID TikTok uses for it. Returns hashed\_id.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> 邮箱地址/Email address
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate TikTok ttwid cookie
>
> **Slug:** `TIK_HUB_TIKTOK_WEB_GENERATE_TTWID`
>
> Generates a TikTok ttwid cookie value for a given user agent string (a default Firefox user agent is used if omitted). Returns ttwid.
>
> #### Input Parameters
>
> **user\_agent** `string`
>
> User Agent
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Resolve TikTok Video IDs
>
> **Slug:** `TIK_HUB_TIKTOK_WEB_GET_ALL_AWEME_ID`
>
> Resolve a batch of public TikTok video URLs to video identifiers.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **urls** `array` *required*
>
> Public TikTok video URLs to resolve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Resolve TikTok Secure User IDs
>
> **Slug:** `TIK_HUB_TIKTOK_WEB_GET_ALL_SEC_USER_ID`
>
> Resolve a batch of public TikTok profile URLs to secure user identifiers.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **urls** `array` *required*
>
> Public TikTok profile URLs to resolve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Resolve TikTok Usernames
>
> **Slug:** `TIK_HUB_TIKTOK_WEB_GET_ALL_UNIQUE_ID`
>
> Resolve a batch of public TikTok profile URLs to public usernames.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **urls** `array` *required*
>
> Public TikTok profile URLs to resolve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok video ID from URL
>
> **Slug:** `TIK_HUB_TIKTOK_WEB_GET_AWEME_ID`
>
> Extracts the video (aweme) ID from a TikTok video link. Returns the ID as a string.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Video link
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok live room ID from URL
>
> **Slug:** `TIK_HUB_TIKTOK_WEB_GET_LIVE_ROOM_ID`
>
> Extracts the live room ID from a TikTok live room link. Returns room\_id plus the host's nickname, sec\_uid and unique\_id.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **live\_room\_url** `string` *required*
>
> Live room link
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok Web Post Detail
>
> **Slug:** `TIK_HUB_TIKTOK_WEB_GET_POST_DETAIL`
>
> Fetch TikTok post metadata, which may include primary video playback and download addresses.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **region** `string`
>
> Region code, optional; affects content region, e.g. US/GB/JP/ID, default US.
>
> **item\_id** `string` *required*
>
> Video id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok sec\_uid from profile URL
>
> **Slug:** `TIK_HUB_TIKTOK_WEB_GET_SEC_USER_ID`
>
> Extracts the sec\_uid (secure user ID) from a TikTok user homepage link. Returns the ID as a string.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **url** `string` *required*
>
> User homepage link
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok username from profile URL
>
> **Slug:** `TIK_HUB_TIKTOK_WEB_GET_UNIQUE_ID`
>
> Extracts the unique\_id (the @username handle) from a TikTok user homepage link. Returns it as a string.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **url** `string` *required*
>
> User homepage link
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok user ID from profile URL
>
> **Slug:** `TIK_HUB_TIKTOK_WEB_GET_USER_ID`
>
> Extracts the numeric user ID from a TikTok user homepage link. Returns the ID as a string.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **url** `string` *required*
>
> User homepage link
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get TikTok Live Room Stream
>
> **Slug:** `TIK_HUB_TIKTOK_WEB_TIKTOK_LIVE_ROOM`
>
> Get the WebSocket event stream URL for a public TikTok live room and event type.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** \$0 per request
>
> #### Input Parameters
>
> **danmaku\_type** `string` *required*
>
> TikTok live event type, such as WebcastChatMessage.
>
> **live\_room\_url** `string` *required*
>
> Public TikTok live-room URL.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Toutiao article details
>
> **Slug:** `TIK_HUB_TOUTIAO_APP_GET_ARTICLE_INFO`
>
> Get a Toutiao article's details by group ID using the app API: comment, like (digg), read and bury counts, share URL, source, media info and display flags. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **group\_id** `string` *required*
>
> Post ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Toutiao post comments
>
> **Slug:** `TIK_HUB_TOUTIAO_APP_GET_COMMENTS`
>
> Get the comments on a Toutiao post by group ID. Start with offset 0 and reuse the returned offset while has\_more is true. Returns comment cells, the post's group info and comment-permission flags. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **offset** `string` *required*
>
> Use 0 for the first page. Reuse data.offset while data.has\_more is true; stop when data.has\_more is false.
>
> **group\_id** `string` *required*
>
> Post ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Toutiao user ID from profile URL
>
> **Slug:** `TIK_HUB_TOUTIAO_APP_GET_USER_ID`
>
> Resolve a Toutiao user's profile URL into the user\_id and sec\_user\_id that other Toutiao user tools accept. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **user\_profile\_url** `string` *required*
>
> User profile URL
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Toutiao user profile
>
> **Slug:** `TIK_HUB_TOUTIAO_APP_GET_USER_INFO`
>
> Get a Toutiao user's profile by user ID: name, avatar, description, gender, followers and following counts, like (digg) count and publish count. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> User ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Toutiao video details
>
> **Slug:** `TIK_HUB_TOUTIAO_APP_GET_VIDEO_INFO`
>
> Get a Toutiao video's details by group ID using the app API: title, source, publish time, duration, comment, like, read, share and bookmark counts, share URL and author info. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **group\_id** `string` *required*
>
> Post ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Toutiao article content
>
> **Slug:** `TIK_HUB_TOUTIAO_WEB_GET_ARTICLE_INFO`
>
> Get a Toutiao article's content by ID using the web API: the article body, group and item IDs, and its main, thumbnail and title images. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **aweme\_id** `string` *required*
>
> Post ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Toutiao video stats
>
> **Slug:** `TIK_HUB_TOUTIAO_WEB_GET_VIDEO_INFO`
>
> Get a Toutiao video's details by ID using the web API: video URL, source, read, like (digg), bookmark and watch counts, download permission, share URL and author info. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **aweme\_id** `string` *required*
>
> Post ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Check if X user follows another
>
> **Slug:** `TIK_HUB_TWITTER_WEB_FETCH_CHECK_FOLLOW`
>
> Check whether one X (formerly Twitter) account follows another, given the source and target screen names. Returns a follow boolean and the target screen name.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **follows** `string` *required*
>
> Target Twitter screen name.
>
> **user\_name** `string` *required*
>
> Source Twitter screen name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Check if X user reposted post
>
> **Slug:** `TIK_HUB_TWITTER_WEB_FETCH_CHECK_RETWEET`
>
> Check whether an X (formerly Twitter) user reposted a given post, from screen name and post ID. Returns a reposted boolean and a relationship status.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **tweet\_id** `string` *required*
>
> Twitter post ID.
>
> **screen\_name** `string` *required*
>
> Twitter screen name without @.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get X community info
>
> **Slug:** `TIK_HUB_TWITTER_WEB_FETCH_COMMUNITY_INFO`
>
> Get details of an X (formerly Twitter) community by community ID. Returns its name, description, member count, adult-content flag and rules.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **community\_id** `string` *required*
>
> Twitter community ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List X community members
>
> **Slug:** `TIK_HUB_TWITTER_WEB_FETCH_COMMUNITY_MEMBERS`
>
> List members of an X (formerly Twitter) community by community ID. Returns each member's ID, screen name, name and profile image; the provider currently returns only the first page.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **cursor** `string`
>
> Compatibility cursor; the current provider route only returns its first page.
>
> **community\_id** `string` *required*
>
> Twitter community ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List X community posts
>
> **Slug:** `TIK_HUB_TWITTER_WEB_FETCH_COMMUNITY_TIMELINE`
>
> Get the post timeline of an X (formerly Twitter) community by community ID, with optional ranking and a cursor for paging. Returns post text, time, engagement counts and author, plus a next cursor.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **cursor** `string`
>
> Continuation cursor returned by the preceding page.
>
> **ranking** `string`
>
> Optional community timeline ranking.
>
> **community\_id** `string` *required*
>
> Twitter community ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List latest X post comments
>
> **Slug:** `TIK_HUB_TWITTER_WEB_FETCH_LATEST_POST_COMMENTS`
>
> Get the newest replies to an X (formerly Twitter) post by post ID, with a cursor for paging. Returns each reply's text, creation time and like, repost, reply and view counts, plus a next cursor.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **cursor** `string`
>
> Continuation cursor returned by the preceding page.
>
> **tweet\_id** `string` *required*
>
> Twitter post ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List X list followers
>
> **Slug:** `TIK_HUB_TWITTER_WEB_FETCH_LIST_FOLLOWERS`
>
> List the followers of an X (formerly Twitter) list by list ID, with a cursor for paging. Returns each follower's ID, screen name, name, profile image and follower count, plus a next cursor.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **cursor** `string`
>
> Continuation cursor returned by the preceding page.
>
> **list\_id** `string` *required*
>
> Twitter list ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List X list members
>
> **Slug:** `TIK_HUB_TWITTER_WEB_FETCH_LIST_MEMBERS`
>
> List the members of an X (formerly Twitter) list by list ID, with a cursor for paging. Returns each member's ID, screen name, name, profile image and follower count, plus a next cursor.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **cursor** `string`
>
> Continuation cursor returned by the preceding page.
>
> **list\_id** `string` *required*
>
> Twitter list ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List X list posts
>
> **Slug:** `TIK_HUB_TWITTER_WEB_FETCH_LIST_TIMELINE`
>
> Get the post timeline of an X (formerly Twitter) list by list ID, with a cursor for paging. Returns post text, time, engagement counts and author, plus a next cursor.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **cursor** `string`
>
> Continuation cursor returned by the preceding page.
>
> **list\_id** `string` *required*
>
> Twitter list ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List X post comments
>
> **Slug:** `TIK_HUB_TWITTER_WEB_FETCH_POST_COMMENTS`
>
> Get the reply thread under an X (formerly Twitter) post by post ID, with a cursor for more. Returns the root post and its author, plus replies with text, time, likes, reposts and author.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **cursor** `string`
>
> Continuation cursor returned by the preceding page.
>
> **tweet\_id** `string` *required*
>
> Twitter post ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List X post reposters
>
> **Slug:** `TIK_HUB_TWITTER_WEB_FETCH_RETWEET_USER_LIST`
>
> List the accounts that reposted an X (formerly Twitter) post, by post ID, with a cursor for paging. Returns each user's ID, screen name, name, profile image and follower count.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **cursor** `string`
>
> Continuation cursor returned by the preceding page.
>
> **tweet\_id** `string` *required*
>
> Twitter post ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get trending topics on X
>
> **Slug:** `TIK_HUB_TWITTER_WEB_FETCH_TRENDING`
>
> Get the topics currently trending on X (formerly Twitter) for a country, defaulting to the United States. Returns each trend's name, context and optional description.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **country** `string`
>
> Country name used by TikHub's trends route.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get X post details
>
> **Slug:** `TIK_HUB_TWITTER_WEB_FETCH_TWEET_DETAIL`
>
> Get one X (formerly Twitter) post by post ID. Returns its text, creation time, like, repost, reply and view counts, and the author's name, screen name and verification status.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **tweet\_id** `string` *required*
>
> Twitter post ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get X account about info
>
> **Slug:** `TIK_HUB_TWITTER_WEB_FETCH_USER_ABOUT`
>
> Get the About details of an X (formerly Twitter) account by screen name. Returns user ID, display name, avatar, verification status and date, and the account's country or region and signup source.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **screen\_name** `string` *required*
>
> Twitter screen name without @.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List X user affiliates
>
> **Slug:** `TIK_HUB_TWITTER_WEB_FETCH_USER_AFFILIATES`
>
> List accounts affiliated with an X (formerly Twitter) organization account, by screen name, with a cursor for paging. Returns each affiliate's ID, screen name, name, profile image and follower count.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **cursor** `string`
>
> Continuation cursor returned by the preceding page.
>
> **screen\_name** `string` *required*
>
> Twitter screen name without @.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List X user followers
>
> **Slug:** `TIK_HUB_TWITTER_WEB_FETCH_USER_FOLLOWERS`
>
> List the followers of an X (formerly Twitter) user, by screen name, with a cursor for paging. Returns each follower's ID, screen name, name, profile image and follower count, plus a next cursor.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **cursor** `string`
>
> Continuation cursor returned by the preceding page.
>
> **screen\_name** `string` *required*
>
> Twitter screen name without @.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List X user followings
>
> **Slug:** `TIK_HUB_TWITTER_WEB_FETCH_USER_FOLLOWINGS`
>
> List the accounts an X (formerly Twitter) user follows, by screen name, with a cursor for paging. Returns each account's ID, screen name, name, profile image and follower count, plus a next cursor.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **cursor** `string`
>
> Continuation cursor returned by the preceding page.
>
> **screen\_name** `string` *required*
>
> Twitter screen name without @.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Check if X user is live
>
> **Slug:** `TIK_HUB_TWITTER_WEB_FETCH_USER_LIVE_STATUS`
>
> Check whether an X (formerly Twitter) user is currently live-streaming, by numeric user ID. Returns a single live boolean.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **rest\_id** `string` *required*
>
> Numeric Twitter user ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List X user media posts
>
> **Slug:** `TIK_HUB_TWITTER_WEB_FETCH_USER_MEDIA`
>
> List media posts (photos and videos) from an X (formerly Twitter) user, by screen name or user ID, with a cursor for paging. Returns post text, time, engagement counts and author, plus a next cursor.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **cursor** `string`
>
> Continuation cursor returned by the preceding page.
>
> **rest\_id** `integer`
>
> Numeric Twitter user ID. Takes precedence over screen\_name.
>
> **screen\_name** `string` *required*
>
> Twitter screen name without @.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List X user posts
>
> **Slug:** `TIK_HUB_TWITTER_WEB_FETCH_USER_POST_TWEET`
>
> List recent posts from an X (formerly Twitter) user, by screen name or user ID, with a cursor for paging. Returns each post's text, time, engagement counts and author, plus a next cursor.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **cursor** `string`
>
> Continuation cursor returned by the preceding page.
>
> **rest\_id** `integer`
>
> Numeric Twitter user ID. Takes precedence over screen\_name.
>
> **screen\_name** `string`
>
> Twitter screen name without @. Omit when using rest\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get X user profile
>
> **Slug:** `TIK_HUB_TWITTER_WEB_FETCH_USER_PROFILE`
>
> Look up an X (formerly Twitter) profile by screen name or numeric user ID. Returns the user ID, display name, avatar, verification and protected flags, and follower count.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **rest\_id** `integer`
>
> Numeric Twitter user ID. Takes precedence over screen\_name.
>
> **screen\_name** `string`
>
> Twitter screen name without @. Omit when using rest\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get X profiles by user IDs
>
> **Slug:** `TIK_HUB_TWITTER_WEB_FETCH_USER_PROFILES_BY_REST_IDS`
>
> Look up several X (formerly Twitter) profiles at once from comma-separated numeric user IDs. Returns each profile's ID, display name, screen name, avatar, verification and protected flags, and follower count.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **rest\_ids** `string` *required*
>
> Comma-separated numeric Twitter user IDs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List X user replies
>
> **Slug:** `TIK_HUB_TWITTER_WEB_FETCH_USER_TWEET_REPLIES`
>
> List replies posted by an X (formerly Twitter) user, by screen name, with a cursor for paging. Returns each reply's text, time, engagement counts and author, plus a next cursor.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **cursor** `string`
>
> Continuation cursor returned by the preceding page.
>
> **screen\_name** `string` *required*
>
> Twitter screen name without @.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Weibo post details from app
>
> **Slug:** `TIK_HUB_WEIBO_APP_FETCH_STATUS_DETAIL`
>
> Get the full details of a Weibo post (status) by status ID using the app API. Returns the status data as provided by Weibo. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **status\_id** `string` *required*
>
> ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Detailed Weibo App Profile
>
> **Slug:** `TIK_HUB_WEIBO_APP_FETCH_USER_INFO_DETAIL`
>
> Get a detailed Weibo app profile through TikHub, including verification and account counts, by numeric user ID.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **uid** `string` *required*
>
> Numeric Weibo user ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Weibo user feed items
>
> **Slug:** `TIK_HUB_WEIBO_APP_FETCH_USER_PROFILE_FEED`
>
> Get a Weibo user's profile feed by user ID, with a since\_id cursor for paging. Returns limited feed item metadata (item ID, category, type) and paging info, not full post text. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **uid** `string` *required*
>
> User ID.
>
> **since\_id** `string`
>
> Pagination cursor.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Weibo user videos
>
> **Slug:** `TIK_HUB_WEIBO_APP_FETCH_USER_VIDEOS`
>
> List the videos posted by a Weibo user by UID, paged with an optional since\_id cursor. Returns video feed items plus the paging info for the next page. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **uid** `string` *required*
>
> User ID.
>
> **since\_id** `string`
>
> Pagination cursor.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Weibo video post details
>
> **Slug:** `TIK_HUB_WEIBO_APP_FETCH_VIDEO_DETAIL`
>
> Get a Weibo video post's details by post ID (mid): text, creation time, like, comment and favorite counts, and the video and author data. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **mid** `string` *required*
>
> Weibo video post ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Weibo Mobile Profile
>
> **Slug:** `TIK_HUB_WEIBO_APP_GET_MOBILE_PROFILE`
>
> Get the mobile-app Weibo profile projection through TikHub by numeric user ID, including app-specific profile modules. Use a Web V2 profile action for the smaller web summary or username-based lookup.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **uid** `string` *required*
>
> Numeric Weibo user ID from a profile or user lookup result.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Check if Weibo post allows image comments
>
> **Slug:** `TIK_HUB_WEIBO_WEB_V2_CHECK_ALLOW_COMMENT_WITH_PIC`
>
> Check whether a Weibo post, by post ID, allows comments with images. Returns an ok status and a boolean result. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Weibo post ID whose image-comment permission should be checked.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Weibo posts with filters
>
> **Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_ADVANCED_SEARCH`
>
> Search Weibo posts by keyword with filters for search type (all, hot, original, verified, media, viewpoint), content type (pics, video, music, link), a custom time range and page. Returns parsed results and search stats. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number
>
> **query** `string` *required*
>
> Search text to match in Weibo posts.
>
> **timescope** `string`
>
> Time scope (custom:start:end)
>
> **search\_type** `string`
>
> /Search type: all( ), hot( ), original( ), verified( ), media( ), viewpoint( )
>
> **include\_type** `string`
>
> /Include type: all( ), pic( ), video( ), music( ), link( )
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Ask Weibo AI search
>
> **Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_AI_SEARCH`
>
> Run a query through Weibo's AI search and return its generated answer data for the question, including the model used, message content and related analysis fields. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **query** `string` *required*
>
> Search keyword
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Weibo feed groups
>
> **Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_ALL_GROUPS`
>
> List the Weibo feed groups (tabs) available for the account, each with its group type, title and priority, plus the default feed and total count. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Weibo provinces and cities
>
> **Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_CITY_LIST`
>
> List the provinces Weibo uses for location filters, each with its code and name. Set normalized to control whether a normalized structure is returned. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **normalized** `boolean`
>
> Whether to return normalized structure
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Weibo entertainment hot ranking
>
> **Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_ENTERTAINMENT_RANKING`
>
> Get Weibo's entertainment hot-topic ranking board. Returns the ranked topics with their word, rank, hot number, category and note. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Weibo hot search board
>
> **Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_HOT_SEARCH`
>
> Get Weibo's current hot search board, with the government/official hot topic entries (hotgov, hotgovs) and the realtime hot search list with each topic's word, rank, heat and label. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Weibo hot search index
>
> **Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_HOT_SEARCH_INDEX`
>
> Get Weibo's hot search index: the government/official hot topics (hotgovs) and the main hot search list, with each entry's word, position, icon info and search URL. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Weibo hot search summary
>
> **Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_HOT_SEARCH_SUMMARY`
>
> Get a summary of Weibo's hot search list: each keyword with its rank, heat, tag, top-pinned flag and keyword URL, plus the total count. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Weibo lifestyle hot ranking
>
> **Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_LIFE_RANKING`
>
> Get Weibo's life-category hot-topic ranking board. Returns the ranked topics with their word, rank, hot number and category. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Weibo pictures by keyword
>
> **Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_PIC_SEARCH`
>
> Search Weibo pictures by keyword, one page at a time via page number. Returns picture results (original picture URL, text, creation time, author) with a total count and an end-of-results flag. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number
>
> **query** `string` *required*
>
> Search keyword
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Weibo post details
>
> **Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_POST_DETAIL`
>
> Get a Weibo post's details by post ID (from a post URL or search result), optionally including the long text. Returns text, author, created time, like/comment/repost counts, media and edit info. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Weibo post ID from a post URL or search result.
>
> **is\_get\_long\_text** `string`
>
> false)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Weibo posts in realtime
>
> **Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_REALTIME_SEARCH`
>
> Search the latest (realtime) Weibo posts by keyword, one page at a time via page number. Returns the parsed post results with a result count. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number
>
> **query** `string` *required*
>
> Search keyword
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Weibo related searches for keyword
>
> **Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_SIMILAR_SEARCH`
>
> Get Weibo suggestions related to a keyword: related hot queries with discussion counts and a list of matching users. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **keyword** `string` *required*
>
> Search keyword
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Weibo society hot ranking
>
> **Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_SOCIAL_RANKING`
>
> Get Weibo's society/social-category hot-topic ranking board. Returns the ranked topics with their word, rank, hot number, category and note. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Weibo topics by keyword
>
> **Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_TOPIC_SEARCH`
>
> Search Weibo topics by keyword, one page at a time via page number. Returns the parsed topic items with a count. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number
>
> **query** `string` *required*
>
> Search keyword
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Weibo user followers
>
> **Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_USER_FANS`
>
> List the followers (fans) of a Weibo user by numeric user ID, paged with a page number. Returns follower user profiles, the total number and next cursor. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **uid** `string` *required*
>
> Numeric Weibo user ID whose followers should be listed.
>
> **page** `integer`
>
> Page number
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Weibo users by keyword
>
> **Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_USER_SEARCH`
>
> Search Weibo users by keyword with optional filters for region, verification type, gender, age bucket, nickname, tag, school and company, paged by page number. Returns the matching users with a count. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **age** `string`
>
> Age bucket
>
> **tag** `string`
>
> Tag filter
>
> **auth** `string`
>
> Auth type
>
> **page** `integer`
>
> Page
>
> **work** `string`
>
> Company filter
>
> **query** `string`
>
> /Query
>
> **gender** `string`
>
> Gender
>
> **region** `string`
>
> city\_list
>
> **school** `string`
>
> School filter
>
> **nickname** `string`
>
> Nickname filter
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Weibo user video collections
>
> **Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_USER_VIDEO_COLLECTION_LIST`
>
> List the video collections (playlists) of a Weibo user by numeric user ID. Returns each playlist's ID, name and item count. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **uid** `string` *required*
>
> Numeric Weibo user ID whose video collections should be listed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Weibo videos by keyword
>
> **Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_VIDEO_SEARCH`
>
> Search Weibo videos by keyword, choosing hot or all mode, one page at a time via page number. Returns the parsed video results with a result count. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **mode** `string`
>
> hot= / all=
>
> **page** `integer`
>
> Page number
>
> **query** `string` *required*
>
> Search keyword
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Full Weibo Profile
>
> **Slug:** `TIK_HUB_WEIBO_WEB_V2_GET_FULL_PROFILE`
>
> Get the richer Weibo web profile and activity counters through TikHub by numeric user ID or custom username. Use Get Weibo Profile Summary when a faster reduced card projection is sufficient.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **uid** `string`
>
> User id
>
> **custom** `string`
>
> Custom Weibo username
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Weibo Profile Summary
>
> **Slug:** `TIK_HUB_WEIBO_WEB_V2_GET_PROFILE_SUMMARY`
>
> Get a lightweight Weibo profile summary through TikHub by numeric user ID. Prefer this faster reduced projection for profile cards or bulk lookups; use Get Full Weibo Profile for richer profile and activity fields or username lookup.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **uid** `string` *required*
>
> Numeric Weibo user ID whose basic profile should be fetched.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Weibo user posts
>
> **Slug:** `TIK_HUB_WEIBO_WEB_V2_SEARCH_USER_POSTS`
>
> Search one Weibo user's posts by user ID, optional text, page and time range, with toggles for original, repost, text and picture posts. Returns the provider's post results. Set the start and end times explicitly. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **uid** `string` *required*
>
> Numeric Weibo user ID whose posts should be searched.
>
> **page** `integer`
>
> Page number
>
> **query** `string`
>
> Optional text to match within the selected user's posts.
>
> **hasori** `integer ("0" | "1")`
>
> Include original posts, 1=include, 0=exclude
>
> **haspic** `integer ("0" | "1")`
>
> Include image posts, 1=include, 0=exclude
>
> **hasret** `integer ("0" | "1")`
>
> Include retweets, 1=include, 0=exclude
>
> **endtime** `integer`
>
> End timestamp
>
> **hastext** `integer ("0" | "1")`
>
> Include text posts, 1=include, 0=exclude
>
> **hasmusic** `integer ("0" | "1")`
>
> Include music posts, 1=include, 0=exclude
>
> **hasvideo** `integer ("0" | "1")`
>
> Include video posts, 1=include, 0=exclude
>
> **starttime** `integer`
>
> Start timestamp
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Xiaohongshu hot creator inspirations
>
> **Slug:** `TIK_HUB_XIAOHONGSHU_APP_V2_GET_CREATOR_HOT_INSPIRATION_FEED`
>
> List trending creator-center inspiration topics on Xiaohongshu, paged by cursor. Returns items with ID, title, cover, score, score text and deeplink, plus the next cursor and an end flag.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **cursor** `string`
>
> Pagination cursor, leave empty for first request
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Xiaohongshu creator inspirations
>
> **Slug:** `TIK_HUB_XIAOHONGSHU_APP_V2_GET_CREATOR_INSPIRATION_FEED`
>
> List creator-center content inspirations on Xiaohongshu, filtered by tab and paged by cursor. Returns inspirations with ID, name, type, image, description and deeplinks, plus the next cursor and an end flag.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **tab** `integer`
>
> Tab type
>
> **cursor** `string`
>
> Pagination cursor, leave empty for first request
>
> **source** `string`
>
> Source
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Xiaohongshu image note details
>
> **Slug:** `TIK_HUB_XIAOHONGSHU_APP_V2_GET_IMAGE_NOTE_DETAIL`
>
> Get image-note details through Xiaohongshu App V2, including note IDs, titles, descriptions, images, authors, and engagement counts. This can identify video notes but returns only their cover; use GET\_VIDEO\_NOTE\_DETAIL when playback URLs are needed.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **note\_id** `string`
>
> Note ID
>
> **share\_text** `string`
>
> xhslink.com/xhslink.cn/Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Xiaohongshu note comments
>
> **Slug:** `TIK_HUB_XIAOHONGSHU_APP_V2_GET_NOTE_COMMENTS`
>
> List top-level comments for a Xiaohongshu note through App V2 with cursor, index, fold-state, and sort pagination. Use GET\_NOTE\_SUB\_COMMENTS for replies to one parent comment.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **index** `integer`
>
> Comment index, pass 0 for first request
>
> **cursor** `string`
>
> Pagination cursor, leave empty for first request
>
> **note\_id** `string`
>
> Note ID
>
> **page\_area** `string ("UNFOLDED" | "FOLDED")`
>
> Fold state: UNFOLDED (default, expanded) or FOLDED.
>
> **share\_text** `string`
>
> xhslink.com/xhslink.cn/Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn
>
> **sort\_strategy** `string ("default" | "latest_v2" | "like_count")`
>
> Sort strategy: default, latest\_v2, like\_count
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Xiaohongshu comment replies
>
> **Slug:** `TIK_HUB_XIAOHONGSHU_APP_V2_GET_NOTE_SUB_COMMENTS`
>
> List replies beneath a Xiaohongshu parent comment through App V2, using a note ID or share text and the parent comment ID. The request accepts cursor and index pagination controls.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **index** `integer`
>
> Pagination index, pass 1 for first request, extract index from \$.data.data.cursor for next page
>
> **cursor** `string`
>
> Pagination cursor, leave empty for first request, extract cursor from \$.data.data.cursor for next page
>
> **note\_id** `string`
>
> Note ID
>
> **comment\_id** `string` *required*
>
> Parent comment ID
>
> **share\_text** `string`
>
> xhslink.com/xhslink.cn/Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Xiaohongshu product details
>
> **Slug:** `TIK_HUB_XIAOHONGSHU_APP_V2_GET_PRODUCT_DETAIL`
>
> Get Xiaohongshu product details by SKU through App V2. This returns product metadata, not review aggregates or individual reviews.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **sku\_id** `string` *required*
>
> Product SKU ID
>
> **source** `string`
>
> Source
>
> **pre\_page** `string`
>
> Previous page
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Xiaohongshu product review summary
>
> **Slug:** `TIK_HUB_XIAOHONGSHU_APP_V2_GET_PRODUCT_REVIEW_OVERVIEW`
>
> Get the review summary for a Xiaohongshu product by SKU ID. Returns average score and description, total review count, purchase-history count, sort and filter options, and a sample of reviews.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **tab** `integer`
>
> Tab type
>
> **sku\_id** `string` *required*
>
> Product SKU ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Xiaohongshu product reviews
>
> **Slug:** `TIK_HUB_XIAOHONGSHU_APP_V2_GET_PRODUCT_REVIEWS`
>
> List Xiaohongshu product reviews, including review text, scores, images, engagement, and reviewer information.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number, start from 0
>
> **sku\_id** `string` *required*
>
> Product SKU ID
>
> **from\_page** `string`
>
> From page
>
> **share\_pics\_only** `integer ("0" | "1")`
>
> Show reviews with images only: 0=no, 1=yes
>
> **sort\_strategy\_type** `integer ("0" | "1")`
>
> Sort strategy: 0=general, 1=latest
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Xiaohongshu topic details
>
> **Slug:** `TIK_HUB_XIAOHONGSHU_APP_V2_GET_TOPIC_INFO`
>
> Get a Xiaohongshu topic (hashtag page) by topic page ID. Returns its name, description, discussion and view counts, banner, share info, tabs, and top participating users.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **source** `string`
>
> Source
>
> **note\_id** `string`
>
> Source note ID, pass when jumping from note to topic
>
> **page\_id** `string` *required*
>
> Topic page ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Xiaohongshu user saved notes
>
> **Slug:** `TIK_HUB_XIAOHONGSHU_APP_V2_GET_USER_FAVED_NOTES`
>
> List notes a Xiaohongshu user has saved, by user ID or share link, paged by cursor. Returns each note's ID, title, description, type, counts, location and timestamps, plus the next cursor.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **cursor** `string`
>
> Pagination cursor, leave empty for first request, pass last note\_id from previous page for next page
>
> **user\_id** `string`
>
> User ID
>
> **share\_text** `string`
>
> xhslink.com/xhslink.cn/Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Xiaohongshu user profile
>
> **Slug:** `TIK_HUB_XIAOHONGSHU_APP_V2_GET_USER_INFO`
>
> Get a Xiaohongshu user profile by user ID or share link. Returns nickname, Red ID, bio, gender, location, follower and following counts, note stats, level, verification, tags and profile images.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **user\_id** `string`
>
> User ID
>
> **share\_text** `string`
>
> xhslink.com/xhslink.cn/Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Xiaohongshu user posted notes
>
> **Slug:** `TIK_HUB_XIAOHONGSHU_APP_V2_GET_USER_POSTED_NOTES`
>
> Get one page of notes published by a Xiaohongshu user through TikHub, selected by user ID or share link.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Cursor returned as next\_cursor by the previous page.
>
> **user\_id** `string`
>
> Xiaohongshu user ID; provide this or share\_text.
>
> **share\_text** `string`
>
> Xiaohongshu full or short share link; provide this or user\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Xiaohongshu video note details
>
> **Slug:** `TIK_HUB_XIAOHONGSHU_APP_V2_GET_VIDEO_NOTE_DETAIL`
>
> Get video-note details and playback data through Xiaohongshu App V2. This accepts only video notes; use GET\_IMAGE\_NOTE\_DETAIL first when the note type is unknown.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **note\_id** `string`
>
> Note ID
>
> **share\_text** `string`
>
> xhslink.com/xhslink.cn/Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Xiaohongshu groups
>
> **Slug:** `TIK_HUB_XIAOHONGSHU_APP_V2_SEARCH_GROUPS`
>
> Search Xiaohongshu groups by keyword, paged by page number and search ID. Returns groups with ID, name, description, avatar, member count and creator, plus filters and a has-more flag.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **source** `string`
>
> Source
>
> **keyword** `string` *required*
>
> Search keyword
>
> **page\_no** `integer`
>
> Page number, start from 0
>
> **search\_id** `string`
>
> Search ID for pagination
>
> **is\_recommend** `integer ("0" | "1")`
>
> Is recommend: 0=no, 1=yes
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Xiaohongshu image notes
>
> **Slug:** `TIK_HUB_XIAOHONGSHU_APP_V2_SEARCH_IMAGES`
>
> Search Xiaohongshu image notes and return typed note, image, author, and engagement fields with pagination identifiers.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number, start from 1
>
> **source** `string`
>
> Source
>
> **keyword** `string` *required*
>
> Search keyword
>
> **search\_id** `string`
>
> Search ID for pagination
>
> **word\_request\_id** `string`
>
> Word request ID for pagination
>
> **search\_pagination\_context** `string`
>
> Response-derived pagination context. For later pages, pass the search\_session\_id returned by the first search; this is not a cookie, token, or authentication value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Xiaohongshu users
>
> **Slug:** `TIK_HUB_XIAOHONGSHU_APP_V2_SEARCH_USERS`
>
> Search Xiaohongshu users by keyword, paged by page number and search ID. Returns users with ID, nickname, Red ID, avatar, bio, follow state and verification, plus filters and the next page.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number, start from 1
>
> **source** `string`
>
> Source
>
> **keyword** `string` *required*
>
> Search keyword
>
> **search\_id** `string`
>
> Search ID for pagination
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Xiaohongshu home feed notes
>
> **Slug:** `TIK_HUB_XIAOHONGSHU_WEB_V3_FETCH_HOMEFEED`
>
> Get notes from the Xiaohongshu (RedNote) home feed, optionally for a category channel, image notes only, up to 40 per request. Returns feed items and a cursor\_score to pass back as the next page cursor.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **num** `integer`
>
> Number of results, max 40.
>
> **category** `string`
>
> Category channel ID.
>
> **cursor\_score** `string`
>
> Pagination cursor.
>
> **need\_filter\_image** `boolean`
>
> Image notes only.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Xiaohongshu home feed categories
>
> **Slug:** `TIK_HUB_XIAOHONGSHU_WEB_V3_FETCH_HOMEFEED_CATEGORIES`
>
> List the home feed category channels on Xiaohongshu (RedNote), each with its ID and name. Use a category ID with the home feed tool.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Xiaohongshu search suggestions
>
> **Slug:** `TIK_HUB_XIAOHONGSHU_WEB_V3_FETCH_SEARCH_SUGGEST`
>
> Get Xiaohongshu (RedNote) search suggestions for an optional keyword. Returns suggestion items with their text and type, plus the request IDs for the suggestion session.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **keyword** `string`
>
> Keyword (optional).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Xiaohongshu user basic info by ID
>
> **Slug:** `TIK_HUB_XIAOHONGSHU_WEB_V3_FETCH_USER_INFO`
>
> Get a Xiaohongshu user's public profile by user ID. Returns nickname, Red ID, bio, gender, IP location, avatar images, interaction counts (follows, fans, likes) and tags.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.01 per request
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> User ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Xigua video play URLs
>
> **Slug:** `TIK_HUB_XIGUA_APP_V2_FETCH_ONE_VIDEO_PLAY_URL`
>
> Get playback URLs for a Xigua Video by video ID. Returns the original play URL and the available quality renditions with bitrate, resolution, codec and size, plus video duration and poster URL.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **item\_id** `string` *required*
>
> Video id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Xigua user profile
>
> **Slug:** `TIK_HUB_XIGUA_APP_V2_FETCH_USER_INFO`
>
> Get a Xigua Video creator's profile by user ID. Returns name, description, avatar, follower counts, following count, verification status, and video play and share totals.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> User id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get YouTube channel details
>
> **Slug:** `TIK_HUB_YOUTUBE_WEB_GET_CHANNEL_INFO`
>
> Get a YouTube channel's details by channel ID. Returns title, description, avatar and banner images, links, country, creation date, subscriber, video and view counts, and verified status.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **channel\_id** `string` *required*
>
> Channel ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List YouTube channel Shorts
>
> **Slug:** `TIK_HUB_YOUTUBE_WEB_GET_CHANNEL_SHORT_VIDEOS`
>
> List the Shorts published by a YouTube channel, given its channel ID. Returns each Short's video ID, title, view count, published time and length, plus a continuation token for the next page.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **channel\_id** `string` *required*
>
> Channel ID
>
> **continuation\_token** `string`
>
> Pagination token
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get YouTube channel URL from channel ID
>
> **Slug:** `TIK_HUB_YOUTUBE_WEB_GET_CHANNEL_URL`
>
> Get the canonical URL and vanity URL of a YouTube channel from its channel ID (e.g. UCeu6U67OzJhV1KwBansH3Dg).
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **channel\_id** `string` *required*
>
> Channel ID, for example UCeu6U67OzJhV1KwBansH3Dg.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List videos related to a YouTube video
>
> **Slug:** `TIK_HUB_YOUTUBE_WEB_GET_RELATE_VIDEO`
>
> List videos related to a given YouTube video ID. Returns each video's ID, title, author, channel ID, description, view count, published time and length, plus a continuation token for the next page.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **video\_id** `string` *required*
>
> Video ID
>
> **continuation\_token** `string`
>
> Pagination token
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get YouTube trending summary
>
> **Slug:** `TIK_HUB_YOUTUBE_WEB_GET_TRENDING_VIDEOS`
>
> Get YouTube trending summary metadata for a country, language and section (default Now). Returns the reported video count, country, language and timezone, but no video entries.
>
> #### Input Parameters
>
> **section** `string`
>
> 类型/Section
>
> **country\_code** `string`
>
> Country code
>
> **language\_code** `string`
>
> Language code
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Resolve YouTube Channel ID By Name
>
> **Slug:** `TIK_HUB_YOUTUBE_WEB_RESOLVE_CHANNEL_ID_BY_NAME`
>
> Resolve a YouTube channel ID from a channel name. The URL variant instead parses supported channel URL formats and returns normalization metadata.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **channel\_name** `string` *required*
>
> Channel name
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Resolve YouTube Channel ID By URL
>
> **Slug:** `TIK_HUB_YOUTUBE_WEB_RESOLVE_CHANNEL_ID_BY_URL`
>
> Resolve a YouTube channel ID from an @handle, /channel/, /c/, or /user/ URL and return URL normalization metadata. The name variant resolves by channel name.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **channel\_url** `string` *required*
>
> [www.youtube.com/@username](http://www.youtube.com/@username), [https://www.youtube.com/channel/UCxxxxxx](https://www.youtube.com/channel/UCxxxxxx), [https://www.youtube.com/c/channelname](https://www.youtube.com/c/channelname)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search videos in a YouTube channel
>
> **Slug:** `TIK_HUB_YOUTUBE_WEB_SEARCH_CHANNEL`
>
> Search videos inside one YouTube channel by channel ID and keyword, with language, country and a continuation token. Returns videos with title, author, views, publish time and length, plus a continuation token.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **channel\_id** `string` *required*
>
> Channel ID
>
> **country\_code** `string`
>
> Country code
>
> **search\_query** `string` *required*
>
> Search keyword
>
> **language\_code** `string`
>
> Language code
>
> **continuation\_token** `string`
>
> Pagination token
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search YouTube videos
>
> **Slug:** `TIK_HUB_YOUTUBE_WEB_SEARCH_VIDEO`
>
> Search YouTube videos by keyword, with language, country and an order\_by filter (default this month). Returns each video's ID, title, author, channel ID, description, views, published time and length, an estimated result count and a continuation token.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **order\_by** `string`
>
> Order by
>
> **country\_code** `string`
>
> Country code
>
> **search\_query** `string` *required*
>
> Search keyword
>
> **language\_code** `string`
>
> Language code
>
> **continuation\_token** `string`
>
> Pagination token
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List YouTube channel community posts
>
> **Slug:** `TIK_HUB_YOUTUBE_WEB_V2_GET_CHANNEL_COMMUNITY_POSTS`
>
> List a YouTube channel's community posts by channel ID. Returns each post's ID, URL, text, author, published time, vote and comment counts, and attachment type, plus has\_more and a continuation token.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **channel\_id** `string` *required*
>
> Channel ID
>
> **need\_format** `boolean`
>
> Whether to clean and format the data
>
> **country\_code** `string`
>
> Country code
>
> **language\_code** `string`
>
> Language code
>
> **continuation\_token** `string`
>
> Pagination token for next page
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get YouTube channel description and keywords
>
> **Slug:** `TIK_HUB_YOUTUBE_WEB_V2_GET_CHANNEL_DESCRIPTION`
>
> Get a YouTube channel's profile by channel ID. Returns title, handle, description, keywords, avatar and banner images, subscriber and video counts, verified and family-safe flags, and RSS and vanity URLs.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **channel\_id** `string`
>
> Channel ID, can be obtained from channel URL via get\_channel\_id endpoint
>
> **need\_format** `boolean`
>
> Whether to clean and format the data
>
> **country\_code** `string`
>
> Country code
>
> **language\_code** `string`
>
> Language code
>
> **continuation\_token** `string`
>
> Continuation token for getting advanced info like channel creation date
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get YouTube channel ID from URL
>
> **Slug:** `TIK_HUB_YOUTUBE_WEB_V2_GET_CHANNEL_ID`
>
> Resolve a YouTube channel URL (e.g. [https://www.youtube.com/@CozyCraftYT](https://www.youtube.com/@CozyCraftYT)) to its channel ID. Returns the channel ID and channel URL.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **channel\_url** `string` *required*
>
> channelname
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List YouTube channel Shorts by ID or URL
>
> **Slug:** `TIK_HUB_YOUTUBE_WEB_V2_GET_CHANNEL_SHORTS`
>
> List the Shorts on a YouTube channel, by channel ID or channel URL. Returns each Short's video ID, URL, title and view count text, plus has\_more and a continuation token for the next page.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **channel\_id** `string`
>
> Channel ID (e.g., UCuAXFkgsw1L7xaCfnd5JJOw)
>
> **channel\_url** `string`
>
> Ignored if channel\_id is provided)
>
> **need\_format** `boolean`
>
> Whether to format data
>
> **continuation\_token** `string`
>
> Omit for the first page. Reuse data.continuation\_token while data.has\_more is true; stop when false.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get YouTube channel URL from channel ID (alt)
>
> **Slug:** `TIK_HUB_YOUTUBE_WEB_V2_GET_CHANNEL_URL`
>
> Get the canonical URL and vanity URL of a YouTube channel from its channel ID, using the second channel URL variant. Returns the same fields as the first variant.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **channel\_id** `string` *required*
>
> ID/Channel ID ( UCeu6U67OzJhV1KwBansH3Dg)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List YouTube channel videos
>
> **Slug:** `TIK_HUB_YOUTUBE_WEB_V2_GET_CHANNEL_VIDEOS`
>
> List videos uploaded by a YouTube channel, by channel ID. Returns channel info and each video's ID, title, URL, description, duration, view count, published time, thumbnail and live flag, plus a continuation token.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **channel\_id** `string` *required*
>
> Channel ID
>
> **need\_format** `boolean`
>
> Whether to clean and format the data
>
> **country\_code** `string`
>
> Country code
>
> **language\_code** `string`
>
> Language code
>
> **continuation\_token** `string`
>
> Pagination token for next page
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search YouTube
>
> **Slug:** `TIK_HUB_YOUTUBE_WEB_V2_GET_GENERAL_SEARCH_V2`
>
> Search YouTube by keyword with filters for upload date, type, duration, features and sort order, plus a continuation token for paging. Returns video results (author, channel ID, duration, published time) and the next token.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.002 per request
>
> #### Input Parameters
>
> **type** `string ("video" | "channel" | "playlist" | "movie")`
>
> Type filter
>
> **keyword** `string`
>
> Search keyword (required for first request)
>
> **sort\_by** `string ("relevance" | "upload_date" | "view_count" | "rating")`
>
> Sort by
>
> **duration** `string ("short" | "medium" | "long")`
>
> Duration filter: short (\<4min), medium (4-20min), long (>20min)
>
> **features** `string`
>
> Feature filter (comma separated): live, 4k, hd, subtitles, creative\_commons, 360, vr180, 3d, hdr
>
> **upload\_date** `string ("last_hour" | "today" | "this_week" | "this_month" | "this_year")`
>
> Upload date filter
>
> **continuation\_token** `string`
>
> Continuation token for next page
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get YouTube community post comments
>
> **Slug:** `TIK_HUB_YOUTUBE_WEB_V2_GET_POST_COMMENTS`
>
> Get comments on a YouTube community post. Returns each comment's text, author, like count, reply count and published time, plus a continuation token. Pass the post ID on the first request and the token for later pages.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **post\_id** `string`
>
> Post ID (required for first request)
>
> **need\_format** `boolean`
>
> Whether to clean and format the data
>
> **country\_code** `string`
>
> Country code
>
> **language\_code** `string`
>
> Language code
>
> **continuation\_token** `string`
>
> Omit for the first page. Reuse data.continuation\_token; stop when that field is absent or empty.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get YouTube community post details
>
> **Slug:** `TIK_HUB_YOUTUBE_WEB_V2_GET_POST_DETAIL`
>
> Get a YouTube community post by post ID. Returns the text, author, published time, vote and comment counts, attachment type, channel metadata and a token for loading its comments.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **post\_id** `string` *required*
>
> Post ID
>
> **need\_format** `boolean`
>
> Whether to clean and format the data
>
> **country\_code** `string`
>
> Country code
>
> **language\_code** `string`
>
> Language code
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List related YouTube videos by ID or URL
>
> **Slug:** `TIK_HUB_YOUTUBE_WEB_V2_GET_RELATED_VIDEOS`
>
> List videos related to a YouTube video, given a video ID or video URL. Returns each related video's ID, URL, title, author, view count text and published time text, with a total count.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **video\_id** `string`
>
> Video ID
>
> **video\_url** `string`
>
> Ignored if video\_id is provided)
>
> **need\_format** `boolean`
>
> Whether to format data. true: return formatted structured data, false: return raw API structure
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Rich YouTube Video Info
>
> **Slug:** `TIK_HUB_YOUTUBE_WEB_V2_GET_RICH_VIDEO_INFO`
>
> Fetch YouTube video details by video ID through TikHub, returning a validated selection of video metadata.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **video\_id** `string` *required*
>
> Video ID
>
> **need\_format** `boolean`
>
> Whether to clean and format the data
>
> **language\_code** `string`
>
> Language code
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get YouTube search suggestions
>
> **Slug:** `TIK_HUB_YOUTUBE_WEB_V2_GET_SEARCH_SUGGESTIONS`
>
> Get YouTube search autocomplete suggestions for a keyword, with language and region options. Returns the list of suggested queries and a total count.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **region** `string`
>
> Region code (e.g., US, SG, CN, JP)
>
> **keyword** `string` *required*
>
> Search keyword
>
> **language** `string`
>
> Language code (e.g., en, zh-cn, ja)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search YouTube Shorts
>
> **Slug:** `TIK_HUB_YOUTUBE_WEB_V2_GET_SHORTS_SEARCH_V2`
>
> Search YouTube Shorts by keyword, with optional upload date and sort order filters. Returns each Short's video ID, title, URL, author, channel ID, view count and published time, plus a continuation token for the next page.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.002 per request
>
> #### Input Parameters
>
> **keyword** `string`
>
> Search keyword (required for first request)
>
> **sort\_by** `string ("relevance" | "upload_date" | "view_count" | "rating")`
>
> Sort by
>
> **upload\_date** `string ("last_hour" | "today" | "this_week" | "this_month" | "this_year")`
>
> Upload date filter
>
> **continuation\_token** `string`
>
> Continuation token for next page
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get signed YouTube stream URL
>
> **Slug:** `TIK_HUB_YOUTUBE_WEB_V2_GET_SIGNED_STREAM_URL`
>
> Get a signed, time-limited stream URL for one format of a YouTube video, given a video ID or URL and an itag format identifier. Returns the URL, the itag and the seconds until it expires.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **itag** `integer` *required*
>
> Format identifier itag (obtained from get\_video\_streams endpoint)
>
> **video\_id** `string`
>
> Video ID
>
> **video\_url** `string`
>
> Ignored if video\_id is provided)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Stable YouTube Video Info
>
> **Slug:** `TIK_HUB_YOUTUBE_WEB_V2_GET_STABLE_VIDEO_INFO`
>
> Fetch normalized YouTube video details through TikHub's more stable alternate extractor. Use this when the rich extractor has empty core fields; it omits some ancillary fields.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **video\_id** `string`
>
> Video ID
>
> **video\_url** `string`
>
> URL/Video URL ( video\_id )
>
> **need\_format** `boolean`
>
> Whether to return cleaned payload
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List YouTube video comments
>
> **Slug:** `TIK_HUB_YOUTUBE_WEB_V2_GET_VIDEO_COMMENTS`
>
> List comments on a YouTube video by video ID, sorted by top or newest. Returns each comment's text, author, like count, reply count and published time, plus a continuation token for the next page.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **sort\_by** `string ("top" | "newest")`
>
> \| Sort by
>
> **video\_id** `string` *required*
>
> Video ID
>
> **need\_format** `boolean`
>
> Whether to clean and format the data
>
> **country\_code** `string`
>
> Country code
>
> **language\_code** `string`
>
> Language code
>
> **continuation\_token** `string`
>
> Omit for the first page. Reuse data.continuation\_token; stop when that field is absent or empty.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Playable YouTube Video Streams
>
> **Slug:** `TIK_HUB_YOUTUBE_WEB_V2_LIST_PLAYABLE_VIDEO_STREAMS`
>
> List YouTube stream formats with decrypted playback URLs for every format. This costs more, takes longer, and returns links that expire after about six hours.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.004 per request
>
> #### Input Parameters
>
> **video\_id** `string`
>
> Video ID
>
> **video\_url** `string`
>
> Ignored if video\_id is provided)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List YouTube Video Stream Formats
>
> **Slug:** `TIK_HUB_YOUTUBE_WEB_V2_LIST_VIDEO_STREAM_FORMATS`
>
> List YouTube stream formats and metadata without playable URLs. Use the signed-stream tool for one selected format; use the playable-stream variant when all decrypted URLs are needed.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **video\_id** `string`
>
> Video ID
>
> **video\_url** `string`
>
> Ignored if video\_id is provided)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search YouTube channels
>
> **Slug:** `TIK_HUB_YOUTUBE_WEB_V2_SEARCH_CHANNELS`
>
> Search YouTube channels by keyword. Returns each channel's ID, title, handle, description, subscriber count text, URL and thumbnails, with a total count and a has\_more flag.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **keyword** `string`
>
> Search keyword
>
> **need\_format** `boolean`
>
> Whether to format data
>
> **continuation\_token** `string`
>
> Omit for the first page. Committed response evidence has no continuation token to reuse, so only manual one-page retrieval is supported.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Ask Zhihu AI search
>
> **Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_AI_SEARCH_STREAM`
>
> Ask Zhihu's AI search a question (message content), optionally choosing a chat mode and continuing a session. Returns the stream of events with their data. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.005 per request
>
> #### Input Parameters
>
> **chat\_mode** `string`
>
> Chat mode
>
> **session\_id** `string`
>
> Session ID
>
> **message\_content** `string` *required*
>
> Search Content
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zhihu column article
>
> **Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_COLUMN_ARTICLE_DETAIL`
>
> Get a Zhihu column article by article ID. Returns its title, excerpt, content, URL, image, created and updated times, upvote and comment counts, and author. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **article\_id** `string` *required*
>
> Article ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Zhihu column articles
>
> **Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_COLUMN_ARTICLES`
>
> List the articles in a Zhihu column by column ID, with a page limit and offset (start at 0). Returns the article data and paging info. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **limit** `string`
>
> Number of articles per page.
>
> **offset** `string`
>
> Use '0' for the first page. Committed response evidence has no continuation offset or stop flag, so only manual one-page retrieval is supported.
>
> **column\_id** `string` *required*
>
> Column ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zhihu article comment settings
>
> **Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_COLUMN_COMMENT_CONFIG`
>
> Get the comment settings of a Zhihu column article by article ID: whether replies and segment replies are allowed, anonymous mode, emoticon/picture permissions and picture limit. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **article\_id** `string` *required*
>
> Article ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zhihu recommended columns
>
> **Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_COLUMN_RECOMMEND`
>
> Get Zhihu columns recommended for a column article, by article ID, with a page limit and offset (start at 0). Returns the recommended column data and paging info. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **limit** `string`
>
> Number of columns per page.
>
> **offset** `string`
>
> Use '0' for the first page. Committed response evidence has no continuation offset or stop flag, so only manual one-page retrieval is supported.
>
> **article\_id** `string` *required*
>
> Article ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zhihu article column relationship
>
> **Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_COLUMN_RELATIONSHIP`
>
> Get the relationship prompt for a Zhihu column article, by article ID: its type, text and action URL. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **article\_id** `string` *required*
>
> Article ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Zhihu columns by keyword
>
> **Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_COLUMN_SEARCH_V3`
>
> Search Zhihu columns by keyword with offset and limit paging and an optional search hash ID. Returns matching columns and paging info (is\_end, next). Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **limit** `string`
>
> Number of columns per page
>
> **offset** `string`
>
> Offset
>
> **keyword** `string` *required*
>
> Search Keywords
>
> **search\_hash\_id** `string`
>
> Search Hash ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zhihu hot list
>
> **Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_HOT_LIST`
>
> Get the Zhihu hot list (trending questions), with an optional limit and desktop layout flag. Returns each item's trend, detail text and target question (title, URL, excerpt, answer, follower and comment counts). Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **limit** `string`
>
> Maximum hot-list entries to request.
>
> **desktop** `string`
>
> Whether to request the desktop hot-list layout.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zhihu preset search words
>
> **Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_PRESET_SEARCH`
>
> Get Zhihu's preset (placeholder) search words shown in the search box. Returns each word's query and source info, plus a request hash ID. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Zhihu question answers
>
> **Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_QUESTION_ANSWERS`
>
> List the answers to a Zhihu question by question ID, with a limit, offset (start at 0) and sort order (default or updated). Returns the answer data and paging info. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **limit** `integer`
>
> Number of answers per page.
>
> **order** `string`
>
> Sort order: default=default sort, updated=sort by time.
>
> **cursor** `string`
>
> Pagination cursor.
>
> **offset** `integer`
>
> Use 0 for the first page. Committed response evidence has no continuation offset or stop flag, so only manual one-page retrieval is supported.
>
> **question\_id** `string` *required*
>
> Question ID.
>
> **pagination\_context** `string`
>
> Response-derived pagination context. For later pages, pass the session\_id returned by the previous answer page; this is not a cookie, token, or authentication value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zhihu question details
>
> **Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_QUESTION_DETAIL`
>
> Get a Zhihu question by question ID: title, excerpt, detail, URL, created and updated times, answer, follower, visit and comment counts. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **question\_id** `string` *required*
>
> Question ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zhihu recommended users to follow
>
> **Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_RECOMMEND_FOLLOWEES`
>
> Get Zhihu's recommended users to follow. Returns each recommendation with the user (name, headline, URL token, follow state) and the reason it was suggested. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Zhihu content by keyword
>
> **Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_SALT_SEARCH_V3`
>
> Search Zhihu content by keyword with offset and limit paging and an optional search hash ID. Returns result objects (each with a type) and paging info. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **limit** `string`
>
> Number of contents per page
>
> **offset** `string`
>
> Offset
>
> **keyword** `string` *required*
>
> Search Keywords
>
> **search\_hash\_id** `string`
>
> Search Hash ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Zhihu scholar papers
>
> **Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_SCHOLAR_SEARCH_V3`
>
> Search Zhihu's scholar (academic paper) results by keyword with offset and limit paging. Returns matching papers with highlights and paging info. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **limit** `string`
>
> Number of papers per page
>
> **offset** `string`
>
> Offset
>
> **keyword** `string` *required*
>
> Search Keywords
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zhihu recommended searches
>
> **Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_SEARCH_RECOMMEND`
>
> Get Zhihu's recommended search queries. Returns the recommended query list with its hash IDs and the next offset. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zhihu search suggestions
>
> **Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_SEARCH_SUGGEST`
>
> Get Zhihu search suggestions (autocomplete) for a keyword. Returns the suggested queries and the input hash ID. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **keyword** `string` *required*
>
> Search Keywords.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zhihu Topic Search V3
>
> **Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_TOPIC_SEARCH_V3`
>
> Request a Zhihu topic search by keyword through TikHub. The result provides search metadata and paging information; offset and page size can be specified.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **limit** `string`
>
> Number of topics per page
>
> **offset** `string`
>
> Offset
>
> **keyword** `string` *required*
>
> Search Keywords
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zhihu User Created Collections
>
> **Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_USER_COLLECTIONS`
>
> Request collections created by a Zhihu user through TikHub. The response exposes paging information, not the collection entries.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **limit** `string`
>
> Number of collections per page
>
> **offset** `string`
>
> Offset
>
> **user\_url\_token** `string` *required*
>
> User ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zhihu User Follow Collections
>
> **Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_USER_FOLLOW_COLLECTIONS`
>
> Request collections followed by a Zhihu user through TikHub. The response exposes paging information, not the collection entries.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **limit** `string`
>
> Number of collections per page
>
> **offset** `string`
>
> Offset
>
> **user\_url\_token** `string` *required*
>
> User ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zhihu User Columns
>
> **Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_USER_FOLLOW_COLUMNS`
>
> Request columns followed by a Zhihu user through TikHub. The response exposes paging information, not the column entries.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **limit** `string`
>
> Number of columns per page
>
> **offset** `string`
>
> Offset
>
> **user\_url\_token** `string` *required*
>
> User ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List accounts a Zhihu user follows
>
> **Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_USER_FOLLOWEES`
>
> List the accounts a Zhihu user follows, by user URL token, with offset and limit paging. Returns user profiles (name, headline, follower, answer and article counts). Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **limit** `string`
>
> Number of users per page
>
> **offset** `string`
>
> Offset
>
> **user\_url\_token** `string` *required*
>
> User ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Zhihu user followers
>
> **Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_USER_FOLLOWERS`
>
> List the followers of a Zhihu user by user URL token, with an offset (start at 0) and limit. Returns follower profiles and paging info. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **limit** `string`
>
> Number of users per page.
>
> **offset** `string`
>
> Use '0' for the first page. Committed response evidence exposes only paging.totals, not a continuation offset or stop flag, so only manual one-page retrieval is supported.
>
> **user\_url\_token** `string` *required*
>
> User ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zhihu User Follow Topics
>
> **Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_USER_FOLLOW_TOPICS`
>
> Request pagination information for topics followed by a Zhihu user through TikHub. Specify the user ID, offset, and page size.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **limit** `string`
>
> Number of topics per page
>
> **offset** `string`
>
> Offset
>
> **user\_url\_token** `string` *required*
>
> User ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List articles included by Zhihu user
>
> **Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_USER_INCLUDED_ARTICLES`
>
> List the articles included under a Zhihu user, by user URL token, with an offset (start at 0) and limit. Returns the articles with author info and paging info. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **limit** `string`
>
> Number of articles per page.
>
> **offset** `string`
>
> Use '0' for the first page. Committed response evidence exposes only paging.totals, not a continuation offset or stop flag, so only manual one-page retrieval is supported.
>
> **user\_url\_token** `string` *required*
>
> User ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zhihu user profile
>
> **Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_USER_INFO`
>
> Get a Zhihu user's profile by user URL token: name, headline, avatar, gender, follower, answer and article counts, badges and follow state. Data provided through TikHub.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **user\_url\_token** `string` *required*
>
> User ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zhihu User Search V3
>
> **Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_USER_SEARCH_V3`
>
> Request search metadata and pagination information for a keyword search of Zhihu users through TikHub. Specify an offset and page size to navigate the search.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **limit** `string`
>
> Number of users per page
>
> **offset** `string`
>
> Offset
>
> **keyword** `string` *required*
>
> Search Keywords
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zhihu User Segments
>
> **Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_USER_SEGMENTS`
>
> Request text segments highlighted by a Zhihu user through TikHub, using the user's member hash ID and optional content type and pagination parameters. The result provides provider error details when available.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **limit** `string`
>
> Number per page
>
> **offset** `string`
>
> Offset
>
> **content\_type** `string`
>
> Content type
>
> **user\_url\_token** `string` *required*
>
> User member hash id (not url\_token)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zhihu Video List
>
> **Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_VIDEO_LIST`
>
> Request pagination information for Zhihu's homepage video ranking through TikHub. Specify an offset and page size to navigate the ranking.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.001 per request
>
> **Discount:** 50
>
> #### Input Parameters
>
> **limit** `string`
>
> Number of videos per page
>
> **offset** `string`
>
> Offset
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
