Skip to main content
TikHub logo
  • 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

Slug: TIK_HUB_BILIBILI_APP_FETCH_BANGUMI_TABGet 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 requestDiscount: 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_BILIBILI_APP_FETCH_REPLY_DETAILGet 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 requestDiscount: 50

Input Parameters

string
AV ID
string
BV ID
integer
Page size
integer
Next page cursor
string
required
Bilibili root comment ID returned by a video-comments result.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_BILIBILI_APP_FETCH_SEARCH_ALLSearch 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 requestDiscount: 50

Input Parameters

integer
Sort order (0 = overall ranking).
string
Pagination cursor, leave empty for the first page; for the next page pass back data.pagination.next from the previous response
string
required
Search keyword
integer
Page size

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_BILIBILI_WEB_BV_TO_AIDConvert 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 requestDiscount: 50

Input Parameters

string
required
Video id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_BILIBILI_WEB_FETCH_COLLECT_FOLDERSList 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 requestDiscount: 50

Input Parameters

string
required
User UID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_BILIBILI_WEB_FETCH_COMMENT_REPLYGet 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 requestDiscount: 50

Input Parameters

string
required
Video id
string
required
Bilibili reply ID returned by a comment or reply result.
integer
Page number

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_BILIBILI_WEB_FETCH_GENERAL_SEARCHSearch 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 requestDiscount: 50

Input Parameters

integer
required
Page number
string
required
Order method
string
required
Search keyword
integer
Duration filter
integer
required
Number per page
integer
End date (10-digit timestamp)
integer
Start date (10-digit timestamp)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_BILIBILI_WEB_FETCH_LIVE_ROOM_DETAILGet 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 requestDiscount: 50

Input Parameters

string
required
Live room ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_BILIBILI_WEB_FETCH_LIVE_VIDEOSGet 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 requestDiscount: 50

Input Parameters

string
required
Live room ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_BILIBILI_WEB_FETCH_USER_COLLECTION_VIDEOSList 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 requestDiscount: 50

Input Parameters

string
required
collection folder id
integer
Page number

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_BILIBILI_WEB_FETCH_USER_DYNAMICGet 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 requestDiscount: 50

Input Parameters

string
required
User UID.
string
offset

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_BILIBILI_WEB_FETCH_USER_POST_VIDEOSFetch 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 requestDiscount: 50

Input Parameters

string
required
Bilibili user UID.
string ("pubdate" | "click" | "stow")
Sort by newest publication, most plays, or most favorites.
integer
Number of videos per page (1-50).
integer
Page number (1-100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_BILIBILI_WEB_FETCH_USER_POST_VIDEOS_V2List 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 requestDiscount: 50

Input Parameters

string
required
User UID.
string
Keyword, empty returns all
integer
Number of videos per page (1-100).
integer
Page number, starting at 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_BILIBILI_WEB_FETCH_USER_PROFILEGet 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 requestDiscount: 50

Input Parameters

string
required
Bilibili user UID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_BILIBILI_WEB_FETCH_USER_RELATION_STATGet 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 requestDiscount: 50

Input Parameters

string
required
User UID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_BILIBILI_WEB_FETCH_VIDEO_COMMENTSGet 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 requestDiscount: 50

Input Parameters

string
required
Video id
integer
Page number

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_BILIBILI_WEB_FETCH_VIDEO_PLAY_INFOGet 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 requestDiscount: 50

Input Parameters

string
required
Video URL

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_BILIBILI_WEB_FETCH_VIDEO_PLAYURLGet 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 requestDiscount: 50

Input Parameters

string
required
Video cid
string
required
Video id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_BILIBILI_WEB_FETCH_VIDEO_SUBTITLEGet 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 requestDiscount: 50

Input Parameters

string
required
Bilibili AV video ID returned as aid by a video lookup.
string
required
Bilibili page content ID returned as cid for the selected video page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_BILIBILI_WEB_GET_NONVIDEO_DYNAMIC_DETAILGet 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 requestDiscount: 50

Input Parameters

string
required
Dynamic id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_BILIBILI_WEB_GET_VIDEO_BY_AV_ID_AND_CIDFetch 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

string
required
Bilibili AV video ID parsed from a video URL or returned as aid by search.
string
required
Bilibili page content ID returned as cid for the selected video page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_BILIBILI_WEB_GET_VIDEO_BY_BV_IDFetch 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 requestDiscount: 50

Input Parameters

string
required
Video id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_BILIBILI_WEB_GET_VIDEO_DYNAMIC_ENGAGEMENTFetch 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 requestDiscount: 50

Input Parameters

string
required
Dynamic id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_APP_V3_FETCH_BRAND_HOT_SEARCH_LISTLists 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 requestDiscount: 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_APP_V3_FETCH_BRAND_HOT_SEARCH_LIST_DETAILReturns 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 requestDiscount: 50

Input Parameters

integer
required
Category id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_APP_V3_FETCH_HASHTAG_DETAILGets 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 requestDiscount: 50

Input Parameters

integer
required
Hashtag id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_APP_V3_FETCH_HASHTAG_VIDEO_LISTLists 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 requestDiscount: 50

Input Parameters

string
required
Hashtag id.
integer
Number.
integer
Use 0 for the first page. Reuse data.cursor while data.has_more is nonzero; stop when data.has_more is 0.
integer
Sort type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_APP_V3_FETCH_HOT_SEARCH_LISTReturns 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 requestDiscount: 50

Input Parameters

string
Board type.
string
Board sub type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_APP_V3_FETCH_MULTI_VIDEO_HIGH_QUALITY_PLAY_URLGets 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 URLsDiscount: 50

Input Parameters

string
Optional, ISO country code (e.g. CN). Pass ‘CN’ for users in mainland China to get China-region CDN URLs for faster download.
string
required
Video id list, separated by commas, up to 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_APP_V3_FETCH_MULTI_VIDEO_STATISTICSGets 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

string
required
Video id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_APP_V3_FETCH_MUSIC_DETAILGets 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 requestDiscount: 50

Input Parameters

string
required
Music id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_APP_V3_FETCH_MUSIC_HOT_SEARCH_LISTReturns 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 requestDiscount: 50

Input Parameters

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.
string
Chart type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_APP_V3_FETCH_MUSIC_VIDEO_LISTLists 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 requestDiscount: 50

Input Parameters

integer
Number.
integer
Use 0 for the first page. Reuse data.cursor while data.has_more is nonzero; stop when data.has_more is 0.
string
required
Music id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_APP_V3_FETCH_ONE_VIDEOGets 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 requestDiscount: 50

Input Parameters

string
required
Video id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_APP_V3_FETCH_ONE_VIDEO_V2Gets 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 requestDiscount: 50

Input Parameters

string
required
Video id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_APP_V3_FETCH_ONE_VIDEO_V3Gets 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 requestDiscount: 50

Input Parameters

string
required
Video or Article ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_APP_V3_FETCH_SERIES_DETAILLooks 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 requestDiscount: 50

Input Parameters

string
required
Series id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_APP_V3_FETCH_SERIES_VIDEO_LISTPages 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 requestDiscount: 50

Input Parameters

integer
Use 0 for the first page. Reuse data.max_cursor while data.has_more is nonzero; stop when data.has_more is 0.
string
required
Series id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_APP_V3_FETCH_USER_LIKE_VIDEOSRequests 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 requestDiscount: 50

Input Parameters

integer
Number per page
integer
Maximum cursor
string
required
User sec_user_id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_APP_V3_FETCH_USER_POST_VIDEOSLists 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 requestDiscount: 50

Input Parameters

integer
Number per page.
string
Douyin channel: normal(-), lite().
integer
Sort type.
integer
Maximum cursor.
string
required
User sec_user_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_APP_V3_FETCH_VIDEO_COMMENT_REPLIESLists 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 requestDiscount: 50

Input Parameters

integer
Number
integer
Cursor
string
required
Video id
string
required
Comment id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_APP_V3_FETCH_VIDEO_COMMENTSLists 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 requestDiscount: 50

Input Parameters

integer
Number.
integer
Use 0 for the first page. Reuse data.cursor while data.has_more is nonzero; stop when data.has_more is 0.
string
required
Video id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_APP_V3_FETCH_VIDEO_HIGH_QUALITY_PLAY_URLRequests 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

string
HK). Pass CN to get China-region CDN URLs for faster download in mainland China.
string
Video id.
string
Optional, share link.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_APP_V3_FETCH_VIDEO_MIX_DETAILGets 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 requestDiscount: 50

Input Parameters

string
required
Mix id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_APP_V3_FETCH_VIDEO_MIX_POST_LISTLists 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 requestDiscount: 50

Input Parameters

integer
Number.
integer
Use 0 for the first page. Reuse data.cursor while data.has_more is nonzero; stop when data.has_more is 0.
string
required
Mix id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_APP_V3_FETCH_VIDEO_STATISTICSGets 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 requestDiscount: 50

Input Parameters

string
required
Video id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_APP_V3_GENERATE_DOUYIN_VIDEO_SHARE_QRCODEGenerates 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 requestDiscount: 50

Input Parameters

string
required
Video id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_APP_V3_GET_USER_PROFILEGet 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 requestDiscount: 50

Input Parameters

string
required
User sec_user_id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_APP_V3_OPEN_DOUYIN_APP_TO_KEYWORD_SEARCHGenerate 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 requestDiscount: 50

Input Parameters

string
required
Keyword

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_APP_V3_OPEN_DOUYIN_APP_TO_SEND_PRIVATE_MESSAGEGenerate 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

string
required
User id
string
required
User sec_uid

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_APP_V3_OPEN_DOUYIN_APP_TO_USER_PROFILEGenerate 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 requestDiscount: 50

Input Parameters

string
required
User id
string
required
User sec_uid

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_APP_V3_OPEN_DOUYIN_APP_TO_VIDEO_DETAILGenerate 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 requestDiscount: 50

Input Parameters

string
required
Video id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_BILLBOARD_FETCH_CITY_LISTLists 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 requestDiscount: 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_BILLBOARD_FETCH_CONTENT_TAGLists 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 requestDiscount: 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_ACCOUNT_FANS_PORTRAIT_LISTGets 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 requestDiscount: 50

Input Parameters

integer
Breakdown: 1 phone price, 2 gender, 3 age, 4 province, 5 city, 6 city tier, 7 phone brand, 8 interest tags (percentages).
string
required
User sec_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_ACCOUNT_ITEM_ANALYSIS_LISTGets 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 requestDiscount: 50

Input Parameters

string
required
User sec_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_ACCOUNT_LISTLists 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 requestDiscount: 50

Input Parameters

integer
Page number. Default 1.
integer
Results per page. Default 10.
object
Vertical tag filter; empty means all. Get tag IDs from fetch_content_tag.
integer
Time window in hours: 24, 72 or 168 (last day, 3 days or 7 days). Default 24.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_ACCOUNT_SEARCH_LISTSearches 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 requestDiscount: 50

Input Parameters

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.
string
required
Username or Douyin ID to search for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_CALENDAR_DETAILGets 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 requestDiscount: 50

Input Parameters

string
required
Activity ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_CALENDAR_LISTLists 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 requestDiscount: 50

Input Parameters

integer
required
Snapshot end time as a 10-digit Unix timestamp.
string
City code from the city list; empty means all.
integer
required
Snapshot start time as a 10-digit Unix timestamp.
string
Trending-chart category code from the trending-chart categories; empty means all.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_CATEGORY_LISTLists 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 requestDiscount: 50

Input Parameters

string
Trending search term.
string
Snapshot end date, format yyyyMMdd.
string
Snapshot start date, format yyyyMMdd.
string
Optional snapshot time, format yyyyMMddHHmmss.
string
required
Chart type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_CHALLENGE_LISTLists 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 requestDiscount: 50

Input Parameters

integer
required
Page number.
string
Trending search term.
integer
required
Results per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_CITY_LISTLists 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 requestDiscount: 50

Input Parameters

integer
required
Page number.
string
required
Sort order.
string
Trending search term.
string
City code from the city list; empty means all.
integer
required
Results per page.
string
Trending category tags from the trending-chart categories, comma separated; empty means all.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_COMMENT_WORD_LISTGets 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 requestDiscount: 50

Input Parameters

string
required
Video ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_RISE_LISTLists 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 requestDiscount: 50

Input Parameters

integer
required
Page number.
string
required
Sort order.
string
Trending search term.
integer
required
Results per page.
string
Trending category tags from the trending-chart categories, comma separated; empty means all.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_TOTAL_HIGH_FAN_LISTLists 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 requestDiscount: 50

Input Parameters

integer
Page number.
array
Vertical tag filter; empty means all. Get tag IDs from fetch_content_tag.
string
Keyword to filter the chart; empty means all.
integer
Results per page.
integer
Time window in hours: 1, 24, 72 or 168 (last hour, day, 3 days or 7 days). Default 24.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_TOTAL_HIGH_LIKE_LISTLists 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 requestDiscount: 50

Input Parameters

integer
Page number.
array
Vertical tag filter; empty means all. Get tag IDs from fetch_content_tag.
string
Keyword to filter the chart; empty means all.
integer
Results per page.
integer
Time window in hours: 1, 24, 72 or 168 (last hour, day, 3 days or 7 days). Default 24.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_TOTAL_HIGH_PLAY_LISTLists 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 requestDiscount: 50

Input Parameters

integer
Page number.
array
Vertical tag filter; empty means all. Get tag IDs from fetch_content_tag.
string
Keyword to filter the chart; empty means all.
integer
Results per page.
integer
Time window in hours: 1, 24, 72 or 168 (last hour, day, 3 days or 7 days). Default 24.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_TOTAL_HIGH_SEARCH_LISTLists 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 requestDiscount: 50

Input Parameters

string
Search keyword.
integer
Page number.
integer
Results per page.
integer
Time window in hours: 1, 24, 72 or 168 (last hour, day, 3 days or 7 days). Default 24.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_TOTAL_HIGH_TOPIC_LISTLists 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 requestDiscount: 50

Input Parameters

integer
Page number.
array
Vertical tag filter; empty means all. Get tag IDs from fetch_content_tag.
string
Keyword to filter the chart; empty means all.
integer
Results per page.
integer
Time window in hours: 1, 24, 72 or 168 (last hour, day, 3 days or 7 days). Default 24.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_TOTAL_HOT_WORD_LISTLists 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 requestDiscount: 50

Input Parameters

string
Search keyword.
integer
Page number.
integer
Results per page.
integer
Time window in hours: 24, 72 or 168 (last day, 3 days or 7 days). Default 24.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_TOTAL_LISTReturns 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 requestDiscount: 50

Input Parameters

integer
required
Page number.
string
required
Snapshot type: snapshot (a single moment) or range (a time range).
string
Trending search term.
string
Snapshot end date, format yyyyMMdd.
integer
required
Results per page.
string
Snapshot start date, format yyyyMMdd.
string
Trending category tags from the trending-chart categories, comma separated; empty means all.
string
Snapshot time when type=snapshot, format yyyyMMddHHmmss.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_TOTAL_LOW_FAN_LISTLists 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 requestDiscount: 50

Input Parameters

integer
Page number.
array
Vertical tag filter; empty means all. Get tag IDs from fetch_content_tag.
string
Keyword to filter the chart; empty means all.
integer
Results per page.
integer
Time window in hours: 1, 24, 72 or 168 (last hour, day, 3 days or 7 days). Default 24.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_TOTAL_SEARCH_LISTLists 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 requestDiscount: 50

Input Parameters

string
Search keyword.
integer
Page number.
integer
Results per page.
integer
Time window in hours: 1, 24, 72 or 168 (last hour, day, 3 days or 7 days). Default 24.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_TOTAL_TOPIC_LISTLists 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 requestDiscount: 50

Input Parameters

integer
Page number.
array
Vertical tag filter; empty means all. Get tag IDs from fetch_content_tag.
string
Keyword to filter the chart; empty means all.
integer
Results per page.
integer
Time window in hours: 1, 24, 72 or 168 (last hour, day, 3 days or 7 days). Default 24.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_TOTAL_VIDEO_LISTLists 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 requestDiscount: 50

Input Parameters

integer
Page number. Default 1.
array
Vertical tag filter; empty means all. Get tag IDs from fetch_content_tag.
string
Keyword to filter the chart; empty means all.
integer
Chart category: 1001 overall videos, 1002 viral from small accounts, 1003 high completion rate, 1004 high follower growth, 1005 high like rate.
integer
Results per page. Default 10.
integer
Time window in hours: 1, 24, 72 or 168 (last hour, day, 3 days or 7 days). Default 24.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_CREATOR_FETCH_CREATOR_ACTIVITY_DETAILGets 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 requestDiscount: 50

Input Parameters

string
required
Activity ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_CREATOR_FETCH_CREATOR_ACTIVITY_LISTLists 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 requestDiscount: 50

Input Parameters

integer
required
End timestamp
integer
required
Start timestamp

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_CREATOR_FETCH_CREATOR_CONTENT_CATEGORYReturns 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 requestDiscount: 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_CREATOR_FETCH_CREATOR_CONTENT_COURSELists 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 requestDiscount: 50

Input Parameters

integer
Items per page.
integer
Order type (1=, 2=, 3=).
integer
Offset (starting position).
integer
required
Category ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_CREATOR_FETCH_CREATOR_HOT_CHALLENGE_BILLBOARDRequests 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 requestDiscount: 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_CREATOR_FETCH_CREATOR_HOT_COURSELists 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

integer
Items per page (24).
integer
Order type (1=, 2=, 3=).
integer
Use 0 for the first page. Reuse data.offset while data.has_more is nonzero; stop when data.has_more is 0.
string
Available values: 6976547830546582816=, 6976547923849006336=, 6976547940311633165=, 6976547972108635404=, 6980288134957272352=, 6980288181744766219=, 6980288219548011776=.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_CREATOR_FETCH_CREATOR_HOT_SPOT_BILLBOARDReturns 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 requestDiscount: 50

Input Parameters

string
City code - required when hot_search_type=2
string
Hot spot tag - multiple tags separated by comma, like ‘1004,1000,1002’
integer ("1" | "2" | "3")
Hot search type: 1=Overall ranking, 2=Local ranking, 3=Rising ranking

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_CREATOR_FETCH_CREATOR_MATERIAL_CENTER_BILLBOARDReturns 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 requestDiscount: 50

Input Parameters

integer ("1" | "2" | "3" | "4")
Order key: 1=highest views, 2=most likes, 3=most comments, 4=highest popularity
integer ("1" | "2" | "3")
Time filter: 1=24 hours, 2=7 days, 3=30 days
integer
Billboard tag, 0=all, other values can be obtained through config interface

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_CREATOR_FETCH_CREATOR_MATERIAL_CENTER_CONFIGReturns 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 requestDiscount: 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_CREATOR_FETCH_INDUSTRY_CATEGORY_CONFIGLists 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 requestDiscount: 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_CREATOR_FETCH_MISSION_TASK_LISTRequests 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 requestDiscount: 50

Input Parameters

integer
Items per page
integer
cursor value documented by TikHub.
string
keyword value documented by TikHub.
integer
pay type value documented by TikHub.
integer
tab scene value documented by TikHub.
integer
industry lv1 value documented by TikHub.
integer
industry lv2 value documented by TikHub.
integer
Mission type
integer
platform channel value documented by TikHub.
integer
publish time start value documented by TikHub.
integer
quick selector scene value documented by TikHub.
integer
greater than cost progress value documented by TikHub.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_CREATOR_FETCH_USER_SEARCHSearches 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 requestDiscount: 50

Input Parameters

string
required
Username (Douyin ID or Douyin nickname).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_CREATOR_FETCH_VIDEO_DANMAKU_LISTLists 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 requestDiscount: 50

Input Parameters

integer
Items per page
integer
Offset (starting position)
string
required
Video item ID
boolean
Is blocked
integer
Order type (1 = by time, 2 = other).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_CREATOR_LIST_HOT_BILLBOARDList 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 requestDiscount: 50

Input Parameters

integer
Sort key for the selected billboard. Music: 1, 2, 4, 5; props: 1, 5, 6, 7; topic: 1, 2, 3, 4.
integer ("1" | "2" | "3")
Time window: 1 for 24 hours, 2 for 7 days, or 3 for 30 days.
integer
Billboard category tag. Omit to use the provider’s all-categories value 0.
string ("music" | "props" | "topic")
required
The creator billboard resource to list: music, props, or topic.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_INDEX_FETCH_ALL_AREAReturns 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 requestDiscount: 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_INDEX_FETCH_ALL_VALID_DATEReturns 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 requestDiscount: 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_INDEX_FETCH_BRAND_HOT_VIDEOS_TIME_SCOPEGet 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 requestDiscount: 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_INDEX_FETCH_BRAND_VALID_INFOCheck 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 requestDiscount: 50

Input Parameters

string
required
Brand list comma separated

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_INDEX_FETCH_CONTENT_CONSUME_TRENDGet 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

string
required
Category ID, required, does NOT support 0=all. Get full list via fetch_item_filter_options (excluding id=0)
string
required
End date YYYYMMDD
string
required
Start date YYYYMMDD

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_INDEX_FETCH_CONTENT_INTERACT_TRENDGet 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 requestDiscount: 50

Input Parameters

string
required
Category ID, required, does NOT support 0=all. Get full list via fetch_item_filter_options (excluding id=0)
string
required
End date YYYYMMDD
string
required
Start date YYYYMMDD

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_INDEX_FETCH_CONTENT_PUBLISH_TRENDGet 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 requestDiscount: 50

Input Parameters

string
required
Category ID, required, does NOT support 0=all. Get full list via fetch_item_filter_options (excluding id=0)
string
required
End date YYYYMMDD
string
required
Start date YYYYMMDD

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_INDEX_FETCH_CONTENT_VALID_DATEGet 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 requestDiscount: 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_INDEX_FETCH_CURRENT_HOT_TOPICGet 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 requestDiscount: 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_INDEX_FETCH_DAREN_SUG_GREAT_USER_LISTGet 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 requestDiscount: 50

Input Parameters

string
Return count
string
required
Search keyword

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_INDEX_FETCH_GET_USER_SUB_WORDGet 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 requestDiscount: 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_INDEX_FETCH_HOT_WORDSGet 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 requestDiscount: 50

Input Parameters

string ("aweme" | "toutiao")
Platform: aweme (Douyin) or toutiao (Toutiao).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_INDEX_FETCH_ITEM_FILTER_OPTIONSList 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 requestDiscount: 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_INDEX_FETCH_KEYWORD_VALID_DATEChecks 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 requestDiscount: 50

Input Parameters

string
required
Keyword list, comma separated

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_INDEX_FETCH_REPORT_DETAILGet 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 requestDiscount: 50

Input Parameters

string
required
Report ID. Example: 1081

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_INDEX_FETCH_REPORT_SEARCHSearch 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 requestDiscount: 50

Input Parameters

string ("" | "行业洞察" | "产品洞察" | "用户洞察" | "趋势洞察")
Report type: empty for all, or 行业洞察 (industry), 产品洞察 (product), 用户洞察 (user), 趋势洞察 (trend).
Search keyword
string
Business list, comma separated. Options: 巨量引擎, 今日头条, 抖音, 西瓜视频, 抖音电商, 仕小禄, 其他.
string
Top category ID (default 6 = Douyin Index trend reports)
string
Page size
string
Year list, comma separated. e.g. 2024,2023
string
Page number

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_INDEX_FETCH_VALID_DATE_FOR_RELATIONGet 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 requestDiscount: 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_SEARCH_FETCH_CHALLENGE_SEARCH_V1Search 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

integer
Offset cursor for pagination, obtained from the last response.
string
Keyword.
string
Backtrace for pagination, obtained from the last response.
string
Search ID for pagination, obtained from the last response.
string ("0" | "1" | "2")
Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest.
string ("0" | "1" | "2" | "3")
Content type: 0=All, 1=Video, 2=Picture, 3=Article.
string ("0" | "1" | "7" | "180")
Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_SEARCH_FETCH_CHALLENGE_SEARCH_V2Search 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

integer
Offset cursor for pagination, obtained from the last response.
string
Keyword.
string
Backtrace for pagination, obtained from the last response.
string
Search ID for pagination, obtained from the last response.
string ("0" | "1" | "2")
Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest.
string ("0" | "1" | "2" | "3")
Content type: 0=All, 1=Video, 2=Picture, 3=Article.
string ("0" | "1" | "7" | "180")
Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_SEARCH_FETCH_CHALLENGE_SUGGESTGet 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

string
Keyword, e.g., ‘game’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_SEARCH_FETCH_DISCUSS_SEARCHSearches 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

integer
Offset cursor for pagination, obtained from the last response.
string
Keyword.
string
Backtrace for pagination, obtained from the last response.
string
Search ID for pagination, obtained from the last response.
string ("0" | "1" | "2")
Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest.
string ("0" | "1" | "2" | "3")
Content type: 0=All, 1=Video, 2=Picture, 3=Article.
string ("0" | "1" | "7" | "180")
Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_SEARCH_FETCH_EXPERIENCE_SEARCHSearches 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

integer
Offset cursor for pagination, obtained from the last response.
string
Keyword.
string
Backtrace for pagination, obtained from the last response.
string
Search ID for pagination, obtained from the last response.
string ("0" | "1" | "2")
Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest.
string ("0" | "1" | "2" | "3")
Content type: 0=All, 1=Video, 2=Picture, 3=Article.
string ("0" | "1" | "7" | "180")
Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_SEARCH_FETCH_GENERAL_SEARCH_V1Search 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

integer
Offset cursor for pagination, obtained from the last response.
string
Keyword.
string
Backtrace for pagination, obtained from the last response.
string
Search ID for pagination, obtained from the last response.
string ("0" | "1" | "2")
Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest.
string ("0" | "1" | "2" | "3")
Content type: 0=All, 1=Video, 2=Picture, 3=Article.
string ("0" | "1" | "7" | "180")
Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_SEARCH_FETCH_GENERAL_SEARCH_V2Search 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

integer
Offset cursor for pagination, obtained from the last response.
string
Keyword.
string
Backtrace for pagination, obtained from the last response.
string
Search ID for pagination, obtained from the last response.
string ("0" | "1" | "2")
Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest.
string ("0" | "1" | "2" | "3")
Content type: 0=All, 1=Video, 2=Picture, 3=Article.
string ("0" | "1" | "7" | "180")
Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_SEARCH_FETCH_IMAGE_SEARCHSearch 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

integer
Offset cursor for pagination, obtained from the last response.
string
Keyword.
string
Backtrace for pagination, obtained from the last response.
string
Search ID for pagination, obtained from the last response.
string ("0" | "1" | "2")
Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest.
string ("0" | "1" | "2" | "3")
Content type: 0=All, 1=Video, 2=Picture, 3=Article.
string ("0" | "1" | "7" | "180")
Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_SEARCH_FETCH_IMAGE_SEARCH_V3Search 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

integer
Pagination cursor.
string
required
Search keyword.
string
Search ID for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_SEARCH_FETCH_LIVE_SEARCH_V2Search 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

integer
Pagination cursor, 0 for the first request, then the cursor from the last response
string
Douyin ID or nickname

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_SEARCH_FETCH_MULTI_SEARCHRuns 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

integer
Offset cursor for pagination, obtained from the last response.
string
Keyword.
string
Backtrace for pagination, obtained from the last response.
string
Search ID for pagination, obtained from the last response.
string ("0" | "1" | "2")
Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest.
string ("0" | "1" | "2" | "3")
Content type: 0=All, 1=Video, 2=Picture, 3=Article.
string ("0" | "1" | "7" | "180")
Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_SEARCH_FETCH_MUSIC_SEARCHSearches 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

integer
Offset cursor for pagination, obtained from the last response.
string
Keyword.
string
Backtrace for pagination, obtained from the last response.
string
Search ID for pagination, obtained from the last response.
string ("0" | "1" | "2")
Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest.
string ("0" | "1" | "2" | "3")
Content type: 0=All, 1=Video, 2=Picture, 3=Article.
string ("0" | "1" | "7" | "180")
Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_SEARCH_FETCH_SCHOOL_SEARCHSearch 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

string
Keyword, such as school name or location

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_SEARCH_FETCH_SEARCH_SUGGESTGet 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

string
The keyword to be suggested

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_SEARCH_FETCH_USER_SEARCHSearch 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

integer
Offset cursor for pagination, obtained from the last response.
string
Keyword.
string
Search ID for pagination, obtained from the last response.
string
Fans filter: empty=No limit, 0_1k=Under 1k, etc.
string
User type filter: empty=No limit, 300=Creator, 900=Shop, 700=Musician, 800=Celebrity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_SEARCH_FETCH_USER_SEARCH_V2Search 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 requestDiscount: 50

Input Parameters

integer
Offset cursor for pagination, obtained from the last response
string
Keyword

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_SEARCH_FETCH_VIDEO_SEARCH_V1Search 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

integer
Offset cursor for pagination, obtained from the last response.
string
Keyword.
string
Backtrace for pagination, obtained from the last response.
string
Search ID for pagination, obtained from the last response.
string ("0" | "1" | "2")
Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest.
string ("0" | "1" | "2" | "3")
Content type: 0=All, 1=Video, 2=Picture, 3=Article.
string ("0" | "1" | "7" | "180")
Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_SEARCH_FETCH_VIDEO_SEARCH_V2Search 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

integer
Offset cursor for pagination, obtained from the last response.
string
Keyword.
string
Backtrace for pagination, obtained from the last response.
string
Search ID for pagination, obtained from the last response.
string ("0" | "1" | "2")
Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest.
string ("0" | "1" | "2" | "3")
Content type: 0=All, 1=Video, 2=Picture, 3=Article.
string ("0" | "1" | "7" | "180")
Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_SEARCH_FETCH_VIDEO_SEARCH_V4Search 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

integer
Pagination cursor, 0 for the first request, then the cursor from the last response
string
Video title or keyword

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_WEB_ENCRYPT_UID_TO_SEC_USER_IDConvert 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 requestDiscount: 50

Input Parameters

string
required
User uid(short_id).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_WEB_FETCH_BATCH_USER_PROFILE_V2Get 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

string
required
User sec_user_id list, separated by commas

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_WEB_FETCH_HOT_SEARCH_RESULTGet 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 requestDiscount: 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_WEB_FETCH_LIVE_GIFT_RANKINGGet 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 requestDiscount: 50

Input Parameters

string
required
Room room_id
integer
Leaderboard type

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_WEB_FETCH_LIVE_IM_FETCHFetch 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 requestDiscount: 50

Input Parameters

string
required
Live room id.
string
required
User unique ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_WEB_FETCH_MULTI_VIDEO_HIGH_QUALITY_PLAY_URLGet 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 URLsDiscount: 50

Input Parameters

string
Optional, ISO country code (e.g. CN). Pass ‘CN’ for users in mainland China to get China-region CDN URLs for faster download.
string
required
Video id list, separated by commas, up to 50.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_WEB_FETCH_ONE_VIDEOGet 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

string
required
Video id.
boolean
Whether anchor information is needed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_WEB_FETCH_ONE_VIDEO_DANMAKUGet 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 requestDiscount: 50

Input Parameters

string
required
Video id
integer
required
Video total duration
integer
required
End time
integer
required
Start time

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_WEB_FETCH_ONE_VIDEO_V2Get 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

string
required
Video id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_WEB_FETCH_QUERY_USERRun 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_WEB_FETCH_USER_FANS_LISTList 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 requestDiscount: 50

Input Parameters

integer
Number.
string
Maximum timestamp.
string
required
Douyin sec_user_id for the user whose followers to fetch.
integer
Source type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_WEB_FETCH_USER_FOLLOWING_LISTList 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 requestDiscount: 50

Input Parameters

integer
Number.
string
Maximum timestamp.
string
required
Douyin sec_user_id for the user whose following list to fetch.
integer
Source type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_WEB_FETCH_USER_LIVE_INFO_BY_UIDGet 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 requestDiscount: 50

Input Parameters

string
required
User UID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_WEB_FETCH_USER_LIVE_VIDEOSFetch 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 requestDiscount: 50

Input Parameters

string
required
Room webcast_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_WEB_FETCH_USER_LIVE_VIDEOS_BY_ROOM_ID_V2Get 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 requestDiscount: 50

Input Parameters

string
required
Room room_id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_WEB_FETCH_USER_LIVE_VIDEOS_BY_SEC_UIDGet 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 requestDiscount: 50

Input Parameters

string
required
User sec_uid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_WEB_FETCH_USER_PROFILE_BY_SHORT_IDGet 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 requestDiscount: 50

Input Parameters

string
required
User Short ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_WEB_FETCH_USER_PROFILE_BY_UIDGet 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

string
required
User UID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_WEB_FETCH_VIDEO_CHANNEL_RESULTGet 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 requestDiscount: 50

Input Parameters

integer
Number.
integer
required
Tag id.
integer
Refresh index.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_WEB_FETCH_VIDEO_COMMENT_REPLIESGet 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 requestDiscount: 50

Input Parameters

integer
Number
integer
Cursor
string
required
Video id
string
required
Comment id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_WEB_FETCH_VIDEO_COMMENTSGet 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 requestDiscount: 50

Input Parameters

integer
Number.
integer
Use 0 for the first page. Reuse data.cursor while data.has_more is nonzero; stop when data.has_more is 0.
string
required
Video id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_WEB_FETCH_VIDEO_HIGH_QUALITY_PLAY_URLGet 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

string
HK). Pass CN to get China-region CDN URLs for faster download in mainland China.
string
Video id.
string
Optional, share link.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_WEB_GENERATE_SHORT_URLGenerate 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 requestDiscount: 50

Input Parameters

string
required
Target URL to be converted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_WEB_GET_AWEME_IDExtract 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 requestDiscount: 50

Input Parameters

string
required
A Douyin video share URL from which to extract the aweme (video) ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_WEB_GET_SEC_USER_IDExtract 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 requestDiscount: 50

Input Parameters

string
required
A Douyin user profile share URL from which to extract the sec_user_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_WEB_GET_USER_PROFILEFetch 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 requestDiscount: 50

Input Parameters

string
required
The sec_user_id, unique_id, or numeric uid selected by identifier_type.
string ("sec_user_id" | "unique_id" | "uid")
required
The kind of Douyin user identifier supplied in identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_WEB_GET_WEBCAST_IDExtract 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 requestDiscount: 50

Input Parameters

string
required
A Douyin live-room share URL from which to extract the webcast ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_WEB_WEBCAST_ID_2_ROOM_IDConvert 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 requestDiscount: 50

Input Parameters

string
required
Webcast id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_XINGTU_GET_SIGN_IMAGEGet 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 requestDiscount: 50

Input Parameters

string
required
Image URI
string
Image format
integer
Duration in seconds

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_XINGTU_GET_XINGTU_KOLID_BY_SEC_USER_IDLook 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 requestDiscount: 50

Input Parameters

string
required
Douyin User sec_user_id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_XINGTU_GET_XINGTU_KOLID_BY_UIDLooks 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 requestDiscount: 50

Input Parameters

string
required
Douyin User ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_XINGTU_GET_XINGTU_KOLID_BY_UNIQUE_IDLooks 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 requestDiscount: 50

Input Parameters

string
required
Douyin User unique_id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_DOUYIN_XINGTU_V2_GET_CONTENT_TREND_GUIDEGet 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 requestDiscount: 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_ESTIMATE_ENDPOINT_COSTEstimate 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

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.
integer
Non-negative number of daily requests to include in the estimate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_GET_ACCOUNT_STATUSReturn privacy-minimized status for the connected TikHub account and API key, without identity, balance, scope, or raw key metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_GET_ALL_ENDPOINTS_INFORead 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

integer
Maximum number of endpoint entries to return from this catalog read.
integer
Index of the first catalog entry to return. Each page reads the provider catalog again.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_GET_DAILY_USAGEReturn the connected account owner’s current TikHub daily request and billing counters, excluding email and provider diagnostics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_GET_ENDPOINT_METADATALook 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

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V1_FETCH_CITIESList 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 requestDiscount: 50

Input Parameters

integer
Page number.
string
required
Country code (e.g. US, CN, JP).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V1_FETCH_FAST_POST_BY_URLFetch 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 requestDiscount: 50

Input Parameters

string
required
Post URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V1_FETCH_FULL_POST_BY_URLFetch 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 requestDiscount: 50

Input Parameters

string
required
Post URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V1_FETCH_LOCATION_INFOGet 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 requestDiscount: 50

Input Parameters

string
required
Location ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V1_FETCH_LOCATIONSList 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 requestDiscount: 50

Input Parameters

integer
Page number.
string
required
City ID (from fetch_cities).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V1_FETCH_MUSIC_POSTSGet 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 requestDiscount: 50

Input Parameters

string
Pagination cursor for next page.
string
Music ID.
string
Music URL (alternative to music_id).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V1_FETCH_POST_BY_IDGet 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 requestDiscount: 50

Input Parameters

string
required
Post ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V1_FETCH_SEARCHSearch 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 requestDiscount: 50

Input Parameters

string
required
Search keyword.
string
places, omit for all.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V1_FETCH_USER_INFO_BY_ID_V2Get 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 requestDiscount: 50

Input Parameters

string
required
Instagram user ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V1_FETCH_USER_INFO_BY_USERNAME_V3Get 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 requestDiscount: 50

Input Parameters

string
required
Instagram username

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V1_MEDIA_ID_TO_SHORTCODEConvert 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 requestDiscount: 50

Input Parameters

string
required
Post media ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V1_SHORTCODE_TO_MEDIA_IDConvert 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 requestDiscount: 50

Input Parameters

string
required
Post shortcode.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V1_USER_ID_TO_USERNAMELook up the Instagram username for a numeric user ID. Returns the username, user ID and profile picture URL.

Input Parameters

string
required
User ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V2_FETCH_COMMENT_REPLIESFetch 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

string
required
评论ID/Comment ID
string
required
帖子Shortcode或URL/Post shortcode or URL
string
分页token/Pagination token

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V2_FETCH_HIGHLIGHT_STORIESFetch 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

string
required
精选ID/Highlight ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V2_FETCH_MUSIC_POSTSGet 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

string
Pagination token returned by the previous page.
string
required
Instagram audio canonical ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V2_FETCH_POST_COMMENTSGet 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

string
排序方式: recent(最新) 或 popular(热门)/Sort by: recent or popular
string
required
帖子Shortcode或URL/Post shortcode or URL
string
分页token/Pagination token

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V2_FETCH_POST_INFOGet 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

string
required
帖子Shortcode或URL/Post shortcode or URL

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V2_FETCH_SIMILAR_USERSList 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

string
User ID
string
Username

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V2_FETCH_USER_FOLLOWERSList 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

string
User ID
string
Username
string
分页token/Pagination token

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V2_FETCH_USER_FOLLOWINGList 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

string
User ID
string
Username
string
分页token/Pagination token

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V2_FETCH_USER_HIGHLIGHTSList 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

string
User ID
string
Username

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V2_FETCH_USER_INFOGet 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

string
User ID
string
Username

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V2_FETCH_USER_POSTSGet one page of posts published by an Instagram user through TikHub, selected by username or user ID.

Input Parameters

string
Instagram numeric user ID; provide this or username.
string
Instagram username; provide this or user_id.
string
Token returned by a previous call for the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V2_FETCH_USER_REELSGet one page of reels published by an Instagram user through TikHub, selected by username or user ID.

Input Parameters

string
Instagram numeric user ID; provide this or username.
string
Instagram username; provide this or user_id.
string
Token returned by a previous call for the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V2_FETCH_USER_STORIESFetch 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

string
User ID
string
Username

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V2_MEDIA_ID_TO_SHORTCODEConvert 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

string
required
Post media ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V2_SEARCH_BY_COORDINATESFind 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

number
required
纬度/Latitude
number
required
经度/Longitude

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V2_SEARCH_HASHTAGSSearch 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

string
required
Search keyword

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V2_SEARCH_LOCATIONSSearch 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

string
required
Search keyword

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V2_SEARCH_MUSICSearch 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

string
required
Search keyword

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V2_SEARCH_USERSSearch 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

string
required
Search keyword

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V2_SHORTCODE_TO_MEDIA_IDConvert 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

string
required
Post shortcode

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_INSTAGRAM_V2_USER_ID_TO_USERNAMELook 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

string
required
User ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_KUAISHOU_APP_FETCH_HOT_BOARD_CATEGORIESList 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 requestDiscount: 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_KUAISHOU_APP_FETCH_ONE_USER_V2Get 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

string
required
Kuaishou eid or numeric userId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_KUAISHOU_APP_FETCH_ONE_VIDEOGet a Kuaishou video’s details by photo ID using the app API: caption, duration, like/comment/collect/forward counts and author fields.

Input Parameters

string
required
photo id value documented by TikHub.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_KUAISHOU_APP_FETCH_ONE_VIDEO_BY_URLGet 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

string
required
share text value documented by TikHub.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_KUAISHOU_APP_FETCH_USER_LIVE_INFOCheck 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 requestDiscount: 50

Input Parameters

string
required
user id value documented by TikHub.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_KUAISHOU_APP_FETCH_VIDEO_COMMENTFetch one cursor page of comments for a Kuaishou video through TikHub.Instant: Supported on the latest version.Instant pricing: Estimated $0.001 per requestDiscount: 50

Input Parameters

string
Comment cursor from the previous page.
string
required
Kuaishou photo ID or eID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_KUAISHOU_APP_SEARCH_USER_V2Search 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

string
required
Provider parameter keyword.
string
Use an empty string for the first page; pass the response pcursor to the next call.
string ("default" | "most_to_least" | "least_to_most")
default / most_to_least / least_to_most
string ("all" | "male" | "female")
all / male / female
string ("all" | "same_city" | "verified" | "live" | "following")
all / same_city / verified / live / following

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_KUAISHOU_WEB_FETCH_ONE_VIDEO_BY_URLGet 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

string
required
Photo URL

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_KUAISHOU_WEB_FETCH_ONE_VIDEO_COMMENTGet 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

string
Comment cursor
string
required
Photo ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_KUAISHOU_WEB_FETCH_ONE_VIDEO_SUB_COMMENTGet 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

string
Comment cursor
string
required
Photo ID
string
required
Root comment ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_KUAISHOU_WEB_FETCH_USER_COLLECTRequest 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

string
Optional provider cursor. The observed response does not expose a next cursor, so pagination beyond one page is unsupported.
string
required
Provider parameter user_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_KUAISHOU_WEB_FETCH_USER_INFOGet 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

string
required
User ID (eid)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_KUAISHOU_WEB_FETCH_USER_LIVE_REPLAYRequest 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

string
Optional provider cursor. The observed response does not expose a next cursor, so pagination beyond one page is unsupported.
string
required
Provider parameter user_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_KUAISHOU_WEB_GET_VIDEO_BY_PHOTO_IDFetch 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

string
required
Photo ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_KUAISHOU_WEB_GET_VIDEO_BY_SHARE_TEXTFetch 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

string
required
Photo share link

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_KUAISHOU_WEB_LIST_HOT_BOARDList 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 requestDiscount: 50

Input Parameters

string ("hot" | "entertainment" | "society" | "useful" | "challenge" | "search")
Kuaishou board to list: hot, entertainment, society, useful, challenge, or search.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_LEMON8_APP_FETCH_DISCOVER_BANNERSList 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 requestDiscount: 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_LEMON8_APP_FETCH_DISCOVER_TABRequest 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 requestDiscount: 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_LEMON8_APP_FETCH_HOT_SEARCH_KEYWORDSList 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 requestDiscount: 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_LEMON8_APP_FETCH_TOPIC_INFOGet 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 requestDiscount: 50

Input Parameters

string
required
Topic ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_LEMON8_APP_FETCH_USER_FOLLOWER_LISTList 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 requestDiscount: 50

Input Parameters

string
Pagination parameter
string
required
User ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_LEMON8_APP_FETCH_USER_FOLLOWING_LISTList 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 requestDiscount: 50

Input Parameters

string
Pagination parameter
string
required
User ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_LINKEDIN_WEB_V2_GET_COMPANY_PROFILEGet 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

string
required
Full company URL

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_LINKEDIN_WEB_V2_GET_POST_DETAILGet 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 requestDiscount: 50

Input Parameters

string
required
Post or article URL

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_LINKEDIN_WEB_V2_GET_USER_PROFILEGet 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

string
required
Full profile URL

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_LIST_DISCOUNT_TIERSReturn 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_PIPIXIA_APP_FETCH_HASHTAG_DETAILGet 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 requestDiscount: 50

Input Parameters

string
required
Hashtag id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_PIPIXIA_APP_FETCH_HASHTAG_POST_LISTList 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 requestDiscount: 50

Input Parameters

string
Page cursor.
string
Zero-based page count.
string
required
PiPiXia hashtag ID.
string
Hashtag sort category.
string
Hashtag request category.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_PIPIXIA_APP_FETCH_HOME_FEEDGet 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 requestDiscount: 50

Input Parameters

string
Page cursor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_PIPIXIA_APP_FETCH_HOME_SHORT_DRAMA_FEEDGet 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 requestDiscount: 50

Input Parameters

integer
Page number

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_PIPIXIA_APP_FETCH_HOT_SEARCH_BOARD_LISTList 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 requestDiscount: 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_PIPIXIA_APP_FETCH_POST_COMMENT_LISTList 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 requestDiscount: 50

Input Parameters

string
Page offset cursor.
string
required
PiPiXia post ID.
integer
Post type; 1 denotes video.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_PIPIXIA_APP_FETCH_POST_DETAILGet 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 requestDiscount: 50

Input Parameters

string
required
PiPiXia post ID.
integer
Post type; 1 denotes video.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_PIPIXIA_APP_FETCH_POST_STATISTICSGet 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 requestDiscount: 50

Input Parameters

string
required
Video id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_PIPIXIA_APP_FETCH_SEARCHSearch 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 requestDiscount: 50

Input Parameters

string
Page offset cursor.
string
required
Search keyword.
string
Search category code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_PIPIXIA_APP_FETCH_SHORT_URLConvert 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 requestDiscount: 50

Input Parameters

string
required
Original URL

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_PIPIXIA_APP_FETCH_USER_FOLLOWER_LISTList 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 requestDiscount: 50

Input Parameters

string
Page cursor
string
required
User id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_PIPIXIA_APP_FETCH_USER_FOLLOWING_LISTList 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 requestDiscount: 50

Input Parameters

string
Page cursor.
string
required
PiPiXia user ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_PIPIXIA_APP_FETCH_USER_POST_LISTList 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 requestDiscount: 50

Input Parameters

string
Page cursor.
string
required
PiPiXia user ID.
string
Zero-based page count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_REDDIT_APP_CHECK_SUBREDDIT_MUTEDCheck 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 requestDiscount: 50

Input Parameters

string
Preferred response language as an IETF language tag; default: en-US
boolean
Whether to clean and format the data
string
required
Subreddit ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_REDDIT_APP_FETCH_COMMENT_REPLIESLook 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 requestDiscount: 50

Input Parameters

string
required
Comment cursor from more.cursor field
string
required
Post ID
string
Preferred response language as an IETF language tag; default: en-US
string ("CONFIDENCE" | "NEW" | "TOP" | "HOT" | "CONTROVERSIAL" | "OLD" | "RANDOM")
Sort method: CONFIDENCE, NEW, TOP, HOT, CONTROVERSIAL, OLD, RANDOM
boolean
Whether to clean and format the data

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_REDDIT_APP_FETCH_COMMUNITY_HIGHLIGHTSGet 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 requestDiscount: 50

Input Parameters

string
Preferred response language as an IETF language tag; default: en-US
boolean
Whether to clean and format the data
string
required
Subreddit ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_REDDIT_APP_FETCH_DYNAMIC_SEARCHSearch 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 requestDiscount: 50

Input Parameters

string ("RELEVANCE" | "HOT" | "TOP" | "NEW" | "COMMENTS")
Optional result sort for post, comment, or media search.
string
Pagination token for the next page.
string
required
Search query.
string
Preferred response language as an IETF language tag.
string ("0" | "1")
Whether adult results are allowed.
string ("all" | "year" | "month" | "week" | "day" | "hour")
Optional time range for post or media search.
boolean
Whether TikHub should normalize the provider payload.
Safe-search mode.
string ("post" | "community" | "comment" | "media" | "people")
Type of Reddit resource to search.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_REDDIT_APP_FETCH_GAMES_FEEDGet 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 requestDiscount: 50

Input Parameters

string ("BEST" | "HOT" | "NEW" | "TOP" | "CONTROVERSIAL" | "RISING")
Sort method: NEW, HOT, TOP, RISING
string ("ALL" | "HOUR" | "DAY" | "WEEK" | "MONTH" | "YEAR")
Time range: ALL, HOUR, DAY, WEEK, MONTH, YEAR
string
Pagination parameter
string
Preferred response language as an IETF language tag; default: en-US
boolean
Whether to clean and format the data

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_REDDIT_APP_FETCH_HOME_FEEDGet 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 requestDiscount: 50

Input Parameters

string ("BEST" | "HOT" | "NEW" | "TOP" | "CONTROVERSIAL" | "RISING")
Feed sort order.
string
Pagination token for the next page.
string
Preferred response language as an IETF language tag.
boolean
Whether TikHub should normalize the provider payload.
array
Reddit post IDs to exclude from the feed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_REDDIT_APP_FETCH_NEWS_FEEDGet 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 requestDiscount: 50

Input Parameters

string
Pagination token for the next page.
string
Preferred response language as an IETF language tag.
boolean
Whether TikHub should normalize the provider payload.
array
News subtopic IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_REDDIT_APP_FETCH_POST_COMMENTSGet 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 requestDiscount: 50

Input Parameters

string
Pagination parameter for fetching next page
string
required
Post ID
string
Preferred response language as an IETF language tag; default: en-US
string ("CONFIDENCE" | "NEW" | "TOP" | "HOT" | "CONTROVERSIAL" | "OLD" | "RANDOM")
Sort method: CONFIDENCE, NEW, TOP, HOT, CONTROVERSIAL, OLD, RANDOM
boolean
Whether to clean and format the data

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_REDDIT_APP_FETCH_POST_DETAILSGet 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

string
required
Post ID
string
Preferred response language as an IETF language tag; default: en-US
string
评论ID/Comment ID (when include_comment_id is True)
boolean
Whether to clean and format the data
boolean
是否包含特定评论ID/Include specific comment ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_REDDIT_APP_FETCH_POST_DETAILS_BATCHGet 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

string
Preferred response language as an IETF language tag; default: en-US
string
required
帖子ID列表,逗号分隔,最多5条/Post IDs comma-separated, max 5
string
评论ID/Comment ID (when include_comment_id is True)
boolean
Whether to clean and format the data
boolean
是否包含特定评论ID/Include specific comment ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_REDDIT_APP_FETCH_POST_DETAILS_BATCH_LARGEGet 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

string
Preferred response language as an IETF language tag; default: en-US
string
required
帖子ID列表,逗号分隔,最多30条/Post IDs comma-separated, max 30
string
评论ID/Comment ID (when include_comment_id is True)
boolean
Whether to clean and format the data
boolean
是否包含特定评论ID/Include specific comment ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_REDDIT_APP_FETCH_SEARCH_TYPEAHEADGet 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 requestDiscount: 50

Input Parameters

string
required
Search query
string
Preferred response language as an IETF language tag; default: en-US
string ("0" | "1")
Allow NSFW content: 0 or 1
boolean
Whether to clean and format the data
string ("unset" | "strict")
Safe search setting: unset, strict

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_REDDIT_APP_FETCH_SUBREDDIT_FEEDGet 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 requestDiscount: 50

Input Parameters

string ("BEST" | "HOT" | "NEW" | "TOP" | "CONTROVERSIAL" | "RISING")
Feed sort order.
string
Pagination token for the next page.
string
Preferred response language as an IETF language tag.
boolean
Whether TikHub should normalize the provider payload.
array
Reddit post IDs to exclude from the feed.
string
required
Subreddit name without the r/ prefix.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_REDDIT_APP_FETCH_SUBREDDIT_INFOGet 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

string
Preferred response language as an IETF language tag; default: en-US
boolean
Whether to clean and format the data
string
Subreddit name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_REDDIT_APP_FETCH_SUBREDDIT_POST_CHANNELSGet 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 requestDiscount: 50

Input Parameters

string ("BEST" | "HOT" | "NEW" | "TOP" | "CONTROVERSIAL" | "RISING")
Sort method: HOT, NEW, TOP, CONTROVERSIAL, RISING
string ("ALL" | "HOUR" | "DAY" | "WEEK" | "MONTH" | "YEAR")
Time range: HOUR, DAY, WEEK, MONTH, YEAR, ALL
string
Preferred response language as an IETF language tag; default: en-US
boolean
Whether to clean and format the data
string
Subreddit name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_REDDIT_APP_FETCH_SUBREDDIT_SETTINGSGet 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 requestDiscount: 50

Input Parameters

string
Preferred response language as an IETF language tag; default: en-US
boolean
Whether to clean and format the data
string
required
Subreddit ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_REDDIT_APP_FETCH_SUBREDDIT_STYLEGet 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 requestDiscount: 50

Input Parameters

string
Preferred response language as an IETF language tag; default: en-US
boolean
Whether to clean and format the data
string
Subreddit name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_REDDIT_APP_FETCH_USER_ACTIVE_SUBREDDITSList 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 requestDiscount: 50

Input Parameters

string
Preferred response language as an IETF language tag; default: en-US
string
required
Username
boolean
Whether to clean and format the data

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_REDDIT_APP_FETCH_USER_COMMENTSList 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 requestDiscount: 50

Input Parameters

string ("NEW" | "TOP" | "HOT" | "CONTROVERSIAL")
Sort method: NEW, TOP, HOT, CONTROVERSIAL
string
Pagination parameter
string
Preferred response language as an IETF language tag; default: en-US
string
required
Username
integer
Page size (default: 25)
boolean
Whether to clean and format the data

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_REDDIT_APP_FETCH_USER_POSTSGet 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 requestDiscount: 50

Input Parameters

string ("NEW" | "TOP" | "HOT" | "CONTROVERSIAL")
Post sort order.
string
Pagination token for the next page.
string
Preferred response language as an IETF language tag.
string
required
Reddit username.
boolean
Whether TikHub should normalize the provider payload.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_REDDIT_APP_FETCH_USER_PROFILEGet 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 requestDiscount: 50

Input Parameters

string
Preferred response language as an IETF language tag; default: en-US
string
required
Username
boolean
Whether to clean and format the data

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_REDDIT_APP_FETCH_USER_TROPHIESList 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 requestDiscount: 50

Input Parameters

string
Preferred response language as an IETF language tag; default: en-US
string
required
Username
boolean
Whether to clean and format the data

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TELEGRAM_WEB_BATCH_CHANNEL_INFOGet 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

string
required
Comma-separated usernames (max 20).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TELEGRAM_WEB_FETCH_CHANNEL_INFOGet 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 requestDiscount: 50

Input Parameters

string
required
Channel username.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TELEGRAM_WEB_FETCH_CHANNEL_POSTSList 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 requestDiscount: 50

Input Parameters

integer
Newer than this id.
integer
Number of posts.
integer
Older than this id.
string
required
Channel username.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TELEGRAM_WEB_FETCH_CHANNEL_SEARCHSearch 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 requestDiscount: 50

Input Parameters

integer
Number of hits.
string
required
Keyword.
string
required
Channel username.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TELEGRAM_WEB_FETCH_POST_DETAILGet 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 requestDiscount: 50

Input Parameters

string
required
Channel username.
integer
required
Post ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_THREADS_WEB_FETCH_POST_COMMENTSList 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

string
required
Post ID
string
分页游标/Pagination cursor (optional)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_THREADS_WEB_FETCH_POST_DETAILGet 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

string
required
Post ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_THREADS_WEB_FETCH_USER_INFO_BY_IDGet 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

string
required
User ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_THREADS_WEB_FETCH_USER_REPOSTSList 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

string
required
User ID
string
Pagination cursor (optional)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_THREADS_WEB_SEARCH_PROFILESSearch 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

string
required
Search query

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_ADS_GET_AD_INTERACTIVE_ANALYSISReturns 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 requestDiscount: 50

Input Parameters

string
required
Ad material ID.
string
Analysis type (ctr, cvr, clicks, conversion, remain).
integer
Period type (days).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_ADS_GET_AD_KEYFRAME_ANALYSISAnalyze 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 requestDiscount: 50

Input Parameters

string
Analysis metric (retain_ctr, retain_cvr, click_cnt, convert_cnt, play_retain_cnt)
string
required
Ad material ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_ADS_GET_AD_PERCENTILEReturns 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 requestDiscount: 50

Input Parameters

string
Analysis metric (ctr_percentile, time_attr_conversion_rate_percentile, click_cnt_percentile, time_attr_convert_cnt_percentile, show_cnt_percentile).
string
required
Ad material ID.
integer
Time period (days).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_ADS_GET_ADS_DETAILFetches 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 requestDiscount: 50

Input Parameters

string
required
Ad ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_ADS_GET_CONFIGURE_SAFETYReturns 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 requestDiscount: 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_ADS_GET_LOCATION_LISTLists 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 requestDiscount: 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_ADS_GET_QUERY_SUGGESTIONSReturns 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 requestDiscount: 50

Input Parameters

integer
Suggestion count.
string
Empty for scenario 1; input a keyword for scenario 2.
integer
1 popular, 2 related suggestions.
string
Optional country code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_ADS_GET_TOP_ADS_FILTERSLists 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 requestDiscount: 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_ADS_GET_TOP_ADS_SPOTLIGHTFetches 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 requestDiscount: 50

Input Parameters

integer
Page number.
integer
Items per page.
string
Industry ID (optional).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_ADS_GET_TOP_CONTENTS_LISTLists 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 requestDiscount: 50

Input Parameters

integer
Page number.
integer
Items per page, max 100.
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.
boolean
Organic content only.
integer
Sort metric: 1 for video views (default), 2 for engagement rate, or 3 for six-second view-through rate.
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.
string
Content label IDs, comma separated.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_ADS_SEARCH_ADSSearches 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 requestDiscount: 50

Input Parameters

integer
Performance rank (optional; 1:1-20% 2:21-40% 3:41-60% 4:61-80% 5:81-100%).
integer
Page number.
integer
Items per page.
integer
Time period (days).
string
Search keyword.
integer
Video duration filter value (optional).
string
Industry ID.
string
Sort by (for_you, likes).
integer
Ad format (optional; 1:Spark Ads 2:Non-Spark Ads).
integer
Ad objective (optional; 1: 2: 3: 4: 5: 6: 7:).
string
Search ID (optional).
string
Ad language (optional).
string
Country code.
string
Creative pattern label (optional).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_ANALYTICS_DETECT_FAKE_VIEWSEstimate 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

string
required
Video id
string ("default" | "entertainment" | "education" | "product" | "verified_large")
内容分类/Content category, options: default, entertainment, education, product, verified_large

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_ANALYTICS_FETCH_COMMENT_KEYWORDSExtract recurring keywords and representative comments for a TikTok video.Instant: Supported on the latest version.Instant pricing: Estimated $0.001 per requestDiscount: 50

Input Parameters

string
required
TikTok video identifier to analyze.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_ANALYTICS_FETCH_CREATOR_INFO_AND_MILESTONESFetches 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 requestDiscount: 50

Input Parameters

string
required
User id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_ANALYTICS_FETCH_VIDEO_METRICSFetches 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 requestDiscount: 50

Input Parameters

string
required
Video id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_CHECK_LIVE_ROOM_ONLINECheck 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 requestDiscount: 50

Input Parameters

string
required
Live room id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_CHECK_LIVE_ROOM_ONLINE_BATCHCheck 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

array
required
List of TikTok live room IDs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_FETCH_CONTENT_TRANSLATETranslate 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 requestDiscount: 50

Input Parameters

string
Target language ISO639-1 code, e.g. zh-Hans
string
Source language content, i.e. the content to be translated

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_FETCH_CREATOR_SEARCH_INSIGHTSList 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 requestDiscount: 50

Input Parameters

string
hashtags)
integer
Number per page
integer
Pagination offset
boolean
Force refresh
string
Creator source
string
Sports)
string
ko)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_FETCH_CREATOR_SEARCH_INSIGHTS_DETAILGet 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 requestDiscount: 50

Input Parameters

integer
End timestamp (seconds), only for custom range
integer
Start timestamp (seconds), only for custom range
string
custom)
string
required
Query ID from fetch_creator_search_insights
string
country)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_FETCH_HASHTAG_DETAILGet 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 requestDiscount: 50

Input Parameters

string
required
Hashtag id
string
Region (US, GB, FR, JP, VN, SG)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_FETCH_HASHTAG_SEARCH_RESULTSearch 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 requestDiscount: 50

Input Parameters

integer
Number
integer
Use 0 for the first page. Reuse data.cursor while data.has_more is nonzero; stop when data.has_more is 0.
string
required
Keyword

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_FETCH_HASHTAG_VIDEO_LISTGet one cursor-paginated page of TikTok videos associated with a hashtag ID.

Input Parameters

integer
Number of videos to request.
integer
Use 0 for the first page, then pass the cursor returned by the previous page.
string ("US" | "GB" | "FR" | "JP" | "VN" | "SG")
TikTok region.
string
required
TikTok hashtag identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_FETCH_LIVE_DAILY_RANKFetch the daily TikTok live creator ranking and the selected creator’s position.Instant: Supported on the latest version.Instant pricing: Estimated $0.001 per requestDiscount: 50

Input Parameters

string
TikTok live room identifier.
string
TikTok live anchor identifier.
integer
Provider ranking type.
integer
Provider region type.
integer
Ranking time interval.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_FETCH_LIVE_RANKING_LISTGet 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 requestDiscount: 50

Input Parameters

string
required
Live room id
string
required
Anchor id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_FETCH_LIVE_ROOM_INFOGet information about a TikTok live room, given its live room ID. Returns the provider’s room data along with its status code.

Input Parameters

string
required
Live room id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_FETCH_LIVE_ROOM_PRODUCT_LISTList 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 requestDiscount: 50

Input Parameters

integer
Number
string
Region
string
required
Live room id
string
required
Anchor id
integer
Number

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_FETCH_LOCATION_SEARCHSearch 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 requestDiscount: 50

Input Parameters

integer
Number
integer
Use 0 for the first page. Reuse data.cursor while data.has_more is nonzero; stop when data.has_more is 0.
string
required
Keyword

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_FETCH_MUSIC_DETAILGet 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 requestDiscount: 50

Input Parameters

string
required
Music id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_FETCH_MUSIC_VIDEO_LISTGet one cursor-paginated page of TikTok videos that use a specified music track.

Input Parameters

integer
Number of videos to return.
integer
Page cursor; use 0 for the first page.
string
required
TikTok music identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_FETCH_ONE_VIDEOGet 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 requestDiscount: 50

Input Parameters

string
required
TikTok video identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_FETCH_ONE_VIDEO_V2Get 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 requestDiscount: 50

Input Parameters

string
required
TikTok video identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_FETCH_ONE_VIDEO_V3Get 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 requestDiscount: 50

Input Parameters

string
Two-letter country code.
string
required
TikTok video identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_FETCH_SHARE_QR_CODEGenerate 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 requestDiscount: 50

Input Parameters

string
required
Object id
integer
Schema type

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_FETCH_USER_COUNTRY_BY_USERNAMELook 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 requestDiscount: 50

Input Parameters

string
required
Username

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_FETCH_USER_FOLLOWING_LISTList 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 requestDiscount: 50

Input Parameters

integer
Number
string
TikTok numeric user ID. Provide this or sec_user_id; an identifier is required.
integer
Minimum time for paging
string
Page token
string
TikTok secured user ID. Provide this or user_id; an identifier is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_FETCH_USER_MUSIC_LISTList 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 requestDiscount: 50

Input Parameters

integer
Number of tracks to return.
integer
Page cursor.
string
required
TikTok secure user identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_FETCH_USER_POST_VIDEOSFetch one page of videos posted by a TikTok user, selected by secure user ID or username and ordered by latest or popularity.

Input Parameters

integer
Requested number of videos.
string
Preferred region code, such as US or GB; TikHub defaults to US when omitted.
integer ("0" | "1")
Sort order: 0 for latest or 1 for popular.
string
TikTok username. Provide this or sec_user_id; at least one is required. Used when sec_user_id is absent.
integer
Cursor from the previous response; use 0 for the first page.
string
TikTok secure user ID. Provide this or unique_id; at least one is required. Preferred when both are supplied.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_FETCH_USER_SEARCH_RESULTSearch TikTok users with optional provider-supported preference filters.Instant: Supported on the latest version.Instant pricing: Estimated $0.001 per requestDiscount: 50

Input Parameters

integer
Number of users to return.
integer
Use 0 for the first page. Reuse data.cursor while data.has_more is nonzero; stop when data.has_more is 0.
string
required
User search keyword.
string
Provider additional search preference.
string
Provider account-type preference.
string
Provider follower-count sort preference.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_FETCH_VIDEO_COMMENT_REPLIESList 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 requestDiscount: 50

Input Parameters

integer
Number of replies to return.
integer
Page cursor.
string
required
TikTok video identifier.
string
required
Parent comment identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_FETCH_VIDEO_COMMENTSList 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 requestDiscount: 50

Input Parameters

integer
Number of comments to return.
integer
Page cursor.
string
required
TikTok video identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_FETCH_VIDEO_SEARCH_RESULTSearch 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

integer
Requested result count.
integer
Use 0 initially, then the returned cursor.
string
TikTok region or ISO country code.
string
required
Search keyword.
integer ("0" | "1")
Sort order: 0 for relevance or 1 for most likes.
integer ("0" | "1" | "7" | "30" | "90" | "180")
Publication window in days; 0 means unrestricted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_FETCH_WEBCAST_USER_INFOGet 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 requestDiscount: 50

Input Parameters

string
User uid (optional, pure number)
string
User sec_user_id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_GET_USER_ID_AND_SEC_USER_ID_BY_USERNAMEResolve 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 requestDiscount: 50

Input Parameters

string
required
Username

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_GET_USER_PROFILEGet 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 requestDiscount: 50

Input Parameters

string
User uid (optional, pure number)
string
User unique_id (username)
string
User sec_user_id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_OPEN_TIKTOK_APP_TO_KEYWORD_SEARCHGenerate 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 requestDiscount: 50

Input Parameters

string
required
Keyword

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_OPEN_TIKTOK_APP_TO_SEND_PRIVATE_MESSAGEGenerate 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

string
required
User id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_OPEN_TIKTOK_APP_TO_USER_PROFILEGenerate 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 requestDiscount: 50

Input Parameters

string
required
User id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_APP_V3_OPEN_TIKTOK_APP_TO_VIDEO_DETAILGenerate 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 requestDiscount: 50

Input Parameters

string
required
Video id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_SHOP_WEB_FETCH_PRODUCT_DETAILFetch 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 requestDiscount: 50

Input Parameters

string
TikTok Shop region code.
string
Optional seller identifier.
string
required
TikTok Shop product identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_SHOP_WEB_FETCH_PRODUCT_DETAIL_V3Look 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 requestDiscount: 50

Input Parameters

string
Region code
string
required
Product ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_SHOP_WEB_FETCH_PRODUCTS_CATEGORY_LISTList the TikTok Shop product categories available for a region (default US).Instant: Supported on the latest version.Instant pricing: Estimated $0.001 per requestDiscount: 50

Input Parameters

string
Region code

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_SHOP_WEB_FETCH_SEARCH_PRODUCTS_LISTSearch 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 requestDiscount: 50

Input Parameters

integer
Use 0 for the first page. Reuse data.data.load_more_params.offset while data.data.has_more is true; stop when false.
string
TikTok Shop region code.
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.
string
required
Product search keyword.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_SHOP_WEB_FETCH_SEARCH_PRODUCTS_LIST_V2Search 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 requestDiscount: 50

Input Parameters

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.
string
TikTok Shop region code.
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.
string
required
Product search keyword.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_SHOP_WEB_FETCH_SEARCH_WORD_SUGGESTION_V2Get 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 requestDiscount: 50

Input Parameters

string
Language
string
Region code
string
required
Search keyword

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_SHOP_WEB_FETCH_SELLER_PRODUCTS_LISTList 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 requestDiscount: 50

Input Parameters

string
Region code
string
required
Seller ID
string
Search params (for pagination)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_WEB_FETCH_BATCH_CHECK_LIVE_ALIVECheck 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

string
required
Live room ID list separated by commas, up to 50 IDs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_WEB_FETCH_CHECK_LIVE_ALIVECheck 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

string
required
Live room ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_WEB_FETCH_GIFT_NAME_BY_IDLook 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 requestDiscount: 50

Input Parameters

string
required
Gift ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_WEB_FETCH_GIFT_NAMES_BY_IDSLook 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

array
required
call for best value ($0.025), auto-process first 50 if more than 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_WEB_FETCH_LIVE_RECOMMEND_TABSList 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 requestDiscount: 50

Input Parameters

string
Pagination cursor, leave empty for the first page; pass the logid from the previous response to load more

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_WEB_FETCH_POST_AI_ARTICLEGet 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 requestDiscount: 50

Input Parameters

string
required
Video id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_WEB_FETCH_POST_COMMENTList 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 requestDiscount: 50

Input Parameters

integer
Number of comments to return.
integer
Page cursor.
string
required
TikTok video identifier.
string
Optional current region code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_WEB_FETCH_SEARCH_KEYWORD_SUGGESTGet 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 requestDiscount: 50

Input Parameters

string
required
Search keyword

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_WEB_FETCH_SEARCH_LIVESearch public TikTok live streams and return room commerce and battle indicators.Instant: Supported on the latest version.Instant pricing: Estimated $0.001 per requestDiscount: 50

Input Parameters

integer
Number of results to return.
integer
Use 0 for the first page. Reuse data.cursor while data.has_more is nonzero; stop when data.has_more is 0.
string
required
Live-stream search keyword.
string
Search identifier returned by a prior page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_WEB_FETCH_TAG_DETAILGet 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 requestDiscount: 50

Input Parameters

string
required
Tag name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_WEB_FETCH_TIKTOK_LIVE_DATAGet 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 requestDiscount: 50

Input Parameters

string
required
Live room link

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_WEB_FETCH_USER_PROFILEGet 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 requestDiscount: 50

Input Parameters

string
User secUid
string
User uniqueId

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_WEB_GENERATE_HASHED_IDConverts an email address into the hashed ID TikTok uses for it. Returns hashed_id.

Input Parameters

string
required
邮箱地址/Email address

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_WEB_GET_ALL_AWEME_IDResolve a batch of public TikTok video URLs to video identifiers.Instant: Supported on the latest version.Instant pricing: Estimated $0.001 per requestDiscount: 50

Input Parameters

array
required
Public TikTok video URLs to resolve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_WEB_GET_ALL_SEC_USER_IDResolve a batch of public TikTok profile URLs to secure user identifiers.Instant: Supported on the latest version.Instant pricing: Estimated $0.001 per requestDiscount: 50

Input Parameters

array
required
Public TikTok profile URLs to resolve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_WEB_GET_ALL_UNIQUE_IDResolve a batch of public TikTok profile URLs to public usernames.Instant: Supported on the latest version.Instant pricing: Estimated $0.001 per requestDiscount: 50

Input Parameters

array
required
Public TikTok profile URLs to resolve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_WEB_GET_AWEME_IDExtracts 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 requestDiscount: 50

Input Parameters

string
required
Video link

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_WEB_GET_LIVE_ROOM_IDExtracts 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 requestDiscount: 50

Input Parameters

string
required
Live room link

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_WEB_GET_POST_DETAILFetch TikTok post metadata, which may include primary video playback and download addresses.Instant: Supported on the latest version.Instant pricing: Estimated $0.001 per requestDiscount: 50

Input Parameters

string
Region code, optional; affects content region, e.g. US/GB/JP/ID, default US.
string
required
Video id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_WEB_GET_SEC_USER_IDExtracts 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 requestDiscount: 50

Input Parameters

string
required
User homepage link

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_WEB_GET_UNIQUE_IDExtracts 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 requestDiscount: 50

Input Parameters

string
required
User homepage link

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_WEB_GET_USER_IDExtracts 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 requestDiscount: 50

Input Parameters

string
required
User homepage link

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TIKTOK_WEB_TIKTOK_LIVE_ROOMGet 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

string
required
TikTok live event type, such as WebcastChatMessage.
string
required
Public TikTok live-room URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TOUTIAO_APP_GET_ARTICLE_INFOGet 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 requestDiscount: 50

Input Parameters

string
required
Post ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TOUTIAO_APP_GET_COMMENTSGet 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 requestDiscount: 50

Input Parameters

string
required
Use 0 for the first page. Reuse data.offset while data.has_more is true; stop when data.has_more is false.
string
required
Post ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TOUTIAO_APP_GET_USER_IDResolve 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 requestDiscount: 50

Input Parameters

string
required
User profile URL

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TOUTIAO_APP_GET_USER_INFOGet 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 requestDiscount: 50

Input Parameters

string
required
User ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TOUTIAO_APP_GET_VIDEO_INFOGet 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 requestDiscount: 50

Input Parameters

string
required
Post ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TOUTIAO_WEB_GET_ARTICLE_INFOGet 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 requestDiscount: 50

Input Parameters

string
required
Post ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TOUTIAO_WEB_GET_VIDEO_INFOGet 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 requestDiscount: 50

Input Parameters

string
required
Post ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TWITTER_WEB_FETCH_CHECK_FOLLOWCheck 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 requestDiscount: 50

Input Parameters

string
required
Target Twitter screen name.
string
required
Source Twitter screen name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TWITTER_WEB_FETCH_CHECK_RETWEETCheck 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 requestDiscount: 50

Input Parameters

string
required
Twitter post ID.
string
required
Twitter screen name without @.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TWITTER_WEB_FETCH_COMMUNITY_INFOGet 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 requestDiscount: 50

Input Parameters

string
required
Twitter community ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TWITTER_WEB_FETCH_COMMUNITY_MEMBERSList 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 requestDiscount: 50

Input Parameters

string
Compatibility cursor; the current provider route only returns its first page.
string
required
Twitter community ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TWITTER_WEB_FETCH_COMMUNITY_TIMELINEGet 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 requestDiscount: 50

Input Parameters

string
Continuation cursor returned by the preceding page.
string
Optional community timeline ranking.
string
required
Twitter community ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TWITTER_WEB_FETCH_LATEST_POST_COMMENTSGet 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 requestDiscount: 50

Input Parameters

string
Continuation cursor returned by the preceding page.
string
required
Twitter post ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TWITTER_WEB_FETCH_LIST_FOLLOWERSList 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 requestDiscount: 50

Input Parameters

string
Continuation cursor returned by the preceding page.
string
required
Twitter list ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TWITTER_WEB_FETCH_LIST_MEMBERSList 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 requestDiscount: 50

Input Parameters

string
Continuation cursor returned by the preceding page.
string
required
Twitter list ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TWITTER_WEB_FETCH_LIST_TIMELINEGet 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 requestDiscount: 50

Input Parameters

string
Continuation cursor returned by the preceding page.
string
required
Twitter list ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TWITTER_WEB_FETCH_POST_COMMENTSGet 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 requestDiscount: 50

Input Parameters

string
Continuation cursor returned by the preceding page.
string
required
Twitter post ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TWITTER_WEB_FETCH_RETWEET_USER_LISTList 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 requestDiscount: 50

Input Parameters

string
Continuation cursor returned by the preceding page.
string
required
Twitter post ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TWITTER_WEB_FETCH_TWEET_DETAILGet 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 requestDiscount: 50

Input Parameters

string
required
Twitter post ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TWITTER_WEB_FETCH_USER_ABOUTGet 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 requestDiscount: 50

Input Parameters

string
required
Twitter screen name without @.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TWITTER_WEB_FETCH_USER_AFFILIATESList 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 requestDiscount: 50

Input Parameters

string
Continuation cursor returned by the preceding page.
string
required
Twitter screen name without @.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TWITTER_WEB_FETCH_USER_FOLLOWERSList 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 requestDiscount: 50

Input Parameters

string
Continuation cursor returned by the preceding page.
string
required
Twitter screen name without @.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TWITTER_WEB_FETCH_USER_FOLLOWINGSList 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 requestDiscount: 50

Input Parameters

string
Continuation cursor returned by the preceding page.
string
required
Twitter screen name without @.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TWITTER_WEB_FETCH_USER_LIVE_STATUSCheck 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 requestDiscount: 50

Input Parameters

string
required
Numeric Twitter user ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TWITTER_WEB_FETCH_USER_MEDIAList 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 requestDiscount: 50

Input Parameters

string
Continuation cursor returned by the preceding page.
integer
Numeric Twitter user ID. Takes precedence over screen_name.
string
required
Twitter screen name without @.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TWITTER_WEB_FETCH_USER_POST_TWEETList 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 requestDiscount: 50

Input Parameters

string
Continuation cursor returned by the preceding page.
integer
Numeric Twitter user ID. Takes precedence over screen_name.
string
Twitter screen name without @. Omit when using rest_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TWITTER_WEB_FETCH_USER_PROFILELook 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 requestDiscount: 50

Input Parameters

integer
Numeric Twitter user ID. Takes precedence over screen_name.
string
Twitter screen name without @. Omit when using rest_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TWITTER_WEB_FETCH_USER_PROFILES_BY_REST_IDSLook 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 requestDiscount: 50

Input Parameters

string
required
Comma-separated numeric Twitter user IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_TWITTER_WEB_FETCH_USER_TWEET_REPLIESList 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 requestDiscount: 50

Input Parameters

string
Continuation cursor returned by the preceding page.
string
required
Twitter screen name without @.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_WEIBO_APP_FETCH_STATUS_DETAILGet 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 requestDiscount: 50

Input Parameters

string
required
ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_WEIBO_APP_FETCH_USER_INFO_DETAILGet 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 requestDiscount: 50

Input Parameters

string
required
Numeric Weibo user ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_WEIBO_APP_FETCH_USER_PROFILE_FEEDGet 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 requestDiscount: 50

Input Parameters

string
required
User ID.
string
Pagination cursor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_WEIBO_APP_FETCH_USER_VIDEOSList 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 requestDiscount: 50

Input Parameters

string
required
User ID.
string
Pagination cursor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_WEIBO_APP_FETCH_VIDEO_DETAILGet 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 requestDiscount: 50

Input Parameters

string
required
Weibo video post ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_WEIBO_APP_GET_MOBILE_PROFILEGet 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 requestDiscount: 50

Input Parameters

string
required
Numeric Weibo user ID from a profile or user lookup result.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_WEIBO_WEB_V2_CHECK_ALLOW_COMMENT_WITH_PICCheck 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 requestDiscount: 50

Input Parameters

string
required
Weibo post ID whose image-comment permission should be checked.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_WEIBO_WEB_V2_FETCH_ADVANCED_SEARCHSearch 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 requestDiscount: 50

Input Parameters

integer
Page number
string
required
Search text to match in Weibo posts.
string
Time scope (custom:start:end)
string
/Search type: all( ), hot( ), original( ), verified( ), media( ), viewpoint( )
string
/Include type: all( ), pic( ), video( ), music( ), link( )

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_WEIBO_WEB_V2_FETCH_AI_SEARCHRun 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 requestDiscount: 50

Input Parameters

string
required
Search keyword

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_WEIBO_WEB_V2_FETCH_ALL_GROUPSList 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 requestDiscount: 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_WEIBO_WEB_V2_FETCH_CITY_LISTList 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 requestDiscount: 50

Input Parameters

boolean
Whether to return normalized structure

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_WEIBO_WEB_V2_FETCH_ENTERTAINMENT_RANKINGGet 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 requestDiscount: 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_WEIBO_WEB_V2_FETCH_HOT_SEARCHGet 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 requestDiscount: 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_WEIBO_WEB_V2_FETCH_HOT_SEARCH_INDEXGet 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 requestDiscount: 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_WEIBO_WEB_V2_FETCH_HOT_SEARCH_SUMMARYGet 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_WEIBO_WEB_V2_FETCH_LIFE_RANKINGGet 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 requestDiscount: 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_WEIBO_WEB_V2_FETCH_PIC_SEARCHSearch 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 requestDiscount: 50

Input Parameters

integer
Page number
string
required
Search keyword

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_WEIBO_WEB_V2_FETCH_POST_DETAILGet 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 requestDiscount: 50

Input Parameters

string
required
Weibo post ID from a post URL or search result.
string
false)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_WEIBO_WEB_V2_FETCH_REALTIME_SEARCHSearch 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 requestDiscount: 50

Input Parameters

integer
Page number
string
required
Search keyword

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_WEIBO_WEB_V2_FETCH_SOCIAL_RANKINGGet 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 requestDiscount: 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_WEIBO_WEB_V2_FETCH_TOPIC_SEARCHSearch 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 requestDiscount: 50

Input Parameters

integer
Page number
string
required
Search keyword

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_WEIBO_WEB_V2_FETCH_USER_FANSList 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 requestDiscount: 50

Input Parameters

string
required
Numeric Weibo user ID whose followers should be listed.
integer
Page number

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_WEIBO_WEB_V2_FETCH_USER_SEARCHSearch 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 requestDiscount: 50

Input Parameters

string
Age bucket
string
Tag filter
string
Auth type
integer
Page
string
Company filter
string
/Query
string
Gender
string
city_list
string
School filter
string
Nickname filter

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_WEIBO_WEB_V2_FETCH_USER_VIDEO_COLLECTION_LISTList 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 requestDiscount: 50

Input Parameters

string
required
Numeric Weibo user ID whose video collections should be listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_WEIBO_WEB_V2_FETCH_VIDEO_SEARCHSearch 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 requestDiscount: 50

Input Parameters

string
hot= / all=
integer
Page number
string
required
Search keyword

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_WEIBO_WEB_V2_GET_FULL_PROFILEGet 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 requestDiscount: 50

Input Parameters

string
User id
string
Custom Weibo username

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_WEIBO_WEB_V2_GET_PROFILE_SUMMARYGet 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 requestDiscount: 50

Input Parameters

string
required
Numeric Weibo user ID whose basic profile should be fetched.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_WEIBO_WEB_V2_SEARCH_USER_POSTSSearch 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 requestDiscount: 50

Input Parameters

string
required
Numeric Weibo user ID whose posts should be searched.
integer
Page number
string
Optional text to match within the selected user’s posts.
integer ("0" | "1")
Include original posts, 1=include, 0=exclude
integer ("0" | "1")
Include image posts, 1=include, 0=exclude
integer ("0" | "1")
Include retweets, 1=include, 0=exclude
integer
End timestamp
integer ("0" | "1")
Include text posts, 1=include, 0=exclude
integer ("0" | "1")
Include music posts, 1=include, 0=exclude
integer ("0" | "1")
Include video posts, 1=include, 0=exclude
integer
Start timestamp

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_XIAOHONGSHU_APP_V2_GET_CREATOR_HOT_INSPIRATION_FEEDList 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

string
Pagination cursor, leave empty for first request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_XIAOHONGSHU_APP_V2_GET_CREATOR_INSPIRATION_FEEDList 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

integer
Tab type
string
Pagination cursor, leave empty for first request
string
Source

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_XIAOHONGSHU_APP_V2_GET_IMAGE_NOTE_DETAILGet 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

string
Note ID
string
xhslink.com/xhslink.cn/Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_XIAOHONGSHU_APP_V2_GET_NOTE_COMMENTSList 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

integer
Comment index, pass 0 for first request
string
Pagination cursor, leave empty for first request
string
Note ID
string ("UNFOLDED" | "FOLDED")
Fold state: UNFOLDED (default, expanded) or FOLDED.
string
xhslink.com/xhslink.cn/Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn
string ("default" | "latest_v2" | "like_count")
Sort strategy: default, latest_v2, like_count

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_XIAOHONGSHU_APP_V2_GET_NOTE_SUB_COMMENTSList 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

integer
Pagination index, pass 1 for first request, extract index from $.data.data.cursor for next page
string
Pagination cursor, leave empty for first request, extract cursor from $.data.data.cursor for next page
string
Note ID
string
required
Parent comment ID
string
xhslink.com/xhslink.cn/Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_XIAOHONGSHU_APP_V2_GET_PRODUCT_DETAILGet 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

string
required
Product SKU ID
string
Source
string
Previous page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_XIAOHONGSHU_APP_V2_GET_PRODUCT_REVIEW_OVERVIEWGet 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

integer
Tab type
string
required
Product SKU ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_XIAOHONGSHU_APP_V2_GET_PRODUCT_REVIEWSList 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

integer
Page number, start from 0
string
required
Product SKU ID
string
From page
integer ("0" | "1")
Show reviews with images only: 0=no, 1=yes
integer ("0" | "1")
Sort strategy: 0=general, 1=latest

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_XIAOHONGSHU_APP_V2_GET_TOPIC_INFOGet 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

string
Source
string
Source note ID, pass when jumping from note to topic
string
required
Topic page ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_XIAOHONGSHU_APP_V2_GET_USER_FAVED_NOTESList 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

string
Pagination cursor, leave empty for first request, pass last note_id from previous page for next page
string
User ID
string
xhslink.com/xhslink.cn/Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_XIAOHONGSHU_APP_V2_GET_USER_INFOGet 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

string
User ID
string
xhslink.com/xhslink.cn/Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_XIAOHONGSHU_APP_V2_GET_USER_POSTED_NOTESGet one page of notes published by a Xiaohongshu user through TikHub, selected by user ID or share link.

Input Parameters

string
Cursor returned as next_cursor by the previous page.
string
Xiaohongshu user ID; provide this or share_text.
string
Xiaohongshu full or short share link; provide this or user_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_XIAOHONGSHU_APP_V2_GET_VIDEO_NOTE_DETAILGet 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

string
Note ID
string
xhslink.com/xhslink.cn/Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_XIAOHONGSHU_APP_V2_SEARCH_GROUPSSearch 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

string
Source
string
required
Search keyword
integer
Page number, start from 0
string
Search ID for pagination
integer ("0" | "1")
Is recommend: 0=no, 1=yes

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_XIAOHONGSHU_APP_V2_SEARCH_IMAGESSearch 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

integer
Page number, start from 1
string
Source
string
required
Search keyword
string
Search ID for pagination
string
Word request ID for pagination
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_XIAOHONGSHU_APP_V2_SEARCH_USERSSearch 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

integer
Page number, start from 1
string
Source
string
required
Search keyword
string
Search ID for pagination

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_XIAOHONGSHU_WEB_V3_FETCH_HOMEFEEDGet 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

integer
Number of results, max 40.
string
Category channel ID.
string
Pagination cursor.
boolean
Image notes only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_XIAOHONGSHU_WEB_V3_FETCH_HOMEFEED_CATEGORIESList 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_XIAOHONGSHU_WEB_V3_FETCH_SEARCH_SUGGESTGet 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

string
Keyword (optional).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_XIAOHONGSHU_WEB_V3_FETCH_USER_INFOGet 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

string
required
User ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_XIGUA_APP_V2_FETCH_ONE_VIDEO_PLAY_URLGet 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 requestDiscount: 50

Input Parameters

string
required
Video id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_XIGUA_APP_V2_FETCH_USER_INFOGet 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 requestDiscount: 50

Input Parameters

string
required
User id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_YOUTUBE_WEB_GET_CHANNEL_INFOGet 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 requestDiscount: 50

Input Parameters

string
required
Channel ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_YOUTUBE_WEB_GET_CHANNEL_SHORT_VIDEOSList 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 requestDiscount: 50

Input Parameters

string
required
Channel ID
string
Pagination token

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_YOUTUBE_WEB_GET_CHANNEL_URLGet 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 requestDiscount: 50

Input Parameters

string
required
Channel ID, for example UCeu6U67OzJhV1KwBansH3Dg.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_YOUTUBE_WEB_RESOLVE_CHANNEL_ID_BY_NAMEResolve 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 requestDiscount: 50

Input Parameters

string
required
Channel name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_YOUTUBE_WEB_RESOLVE_CHANNEL_ID_BY_URLResolve 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 requestDiscount: 50

Input Parameters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_YOUTUBE_WEB_SEARCH_CHANNELSearch 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 requestDiscount: 50

Input Parameters

string
required
Channel ID
string
Country code
string
required
Search keyword
string
Language code
string
Pagination token

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_YOUTUBE_WEB_SEARCH_VIDEOSearch 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 requestDiscount: 50

Input Parameters

string
Order by
string
Country code
string
required
Search keyword
string
Language code
string
Pagination token

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_YOUTUBE_WEB_V2_GET_CHANNEL_COMMUNITY_POSTSList 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 requestDiscount: 50

Input Parameters

string
required
Channel ID
boolean
Whether to clean and format the data
string
Country code
string
Language code
string
Pagination token for next page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_YOUTUBE_WEB_V2_GET_CHANNEL_DESCRIPTIONGet 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 requestDiscount: 50

Input Parameters

string
Channel ID, can be obtained from channel URL via get_channel_id endpoint
boolean
Whether to clean and format the data
string
Country code
string
Language code
string
Continuation token for getting advanced info like channel creation date

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_YOUTUBE_WEB_V2_GET_CHANNEL_IDResolve a YouTube channel URL (e.g. 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 requestDiscount: 50

Input Parameters

string
required
channelname

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_YOUTUBE_WEB_V2_GET_CHANNEL_SHORTSList 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 requestDiscount: 50

Input Parameters

string
Channel ID (e.g., UCuAXFkgsw1L7xaCfnd5JJOw)
string
Ignored if channel_id is provided)
boolean
Whether to format data
string
Omit for the first page. Reuse data.continuation_token while data.has_more is true; stop when false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_YOUTUBE_WEB_V2_GET_CHANNEL_URLGet 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 requestDiscount: 50

Input Parameters

string
required
ID/Channel ID ( UCeu6U67OzJhV1KwBansH3Dg)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_YOUTUBE_WEB_V2_GET_CHANNEL_VIDEOSList 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 requestDiscount: 50

Input Parameters

string
required
Channel ID
boolean
Whether to clean and format the data
string
Country code
string
Language code
string
Pagination token for next page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_YOUTUBE_WEB_V2_GET_GENERAL_SEARCH_V2Search 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

string ("video" | "channel" | "playlist" | "movie")
Type filter
string
Search keyword (required for first request)
string ("relevance" | "upload_date" | "view_count" | "rating")
Sort by
string ("short" | "medium" | "long")
Duration filter: short (<4min), medium (4-20min), long (>20min)
string
Feature filter (comma separated): live, 4k, hd, subtitles, creative_commons, 360, vr180, 3d, hdr
string ("last_hour" | "today" | "this_week" | "this_month" | "this_year")
Upload date filter
string
Continuation token for next page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_YOUTUBE_WEB_V2_GET_POST_COMMENTSGet 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 requestDiscount: 50

Input Parameters

string
Post ID (required for first request)
boolean
Whether to clean and format the data
string
Country code
string
Language code
string
Omit for the first page. Reuse data.continuation_token; stop when that field is absent or empty.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_YOUTUBE_WEB_V2_GET_POST_DETAILGet 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 requestDiscount: 50

Input Parameters

string
required
Post ID
boolean
Whether to clean and format the data
string
Country code
string
Language code

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_YOUTUBE_WEB_V2_GET_RICH_VIDEO_INFOFetch 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 requestDiscount: 50

Input Parameters

string
required
Video ID
boolean
Whether to clean and format the data
string
Language code

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_YOUTUBE_WEB_V2_GET_SEARCH_SUGGESTIONSGet 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 requestDiscount: 50

Input Parameters

string
Region code (e.g., US, SG, CN, JP)
string
required
Search keyword
string
Language code (e.g., en, zh-cn, ja)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_YOUTUBE_WEB_V2_GET_SHORTS_SEARCH_V2Search 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

string
Search keyword (required for first request)
string ("relevance" | "upload_date" | "view_count" | "rating")
Sort by
string ("last_hour" | "today" | "this_week" | "this_month" | "this_year")
Upload date filter
string
Continuation token for next page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_YOUTUBE_WEB_V2_GET_SIGNED_STREAM_URLGet 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 requestDiscount: 50

Input Parameters

integer
required
Format identifier itag (obtained from get_video_streams endpoint)
string
Video ID
string
Ignored if video_id is provided)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_YOUTUBE_WEB_V2_GET_STABLE_VIDEO_INFOFetch 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 requestDiscount: 50

Input Parameters

string
Video ID
string
URL/Video URL ( video_id )
boolean
Whether to return cleaned payload

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_YOUTUBE_WEB_V2_GET_VIDEO_COMMENTSList 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 requestDiscount: 50

Input Parameters

string ("top" | "newest")
| Sort by
string
required
Video ID
boolean
Whether to clean and format the data
string
Country code
string
Language code
string
Omit for the first page. Reuse data.continuation_token; stop when that field is absent or empty.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_YOUTUBE_WEB_V2_LIST_PLAYABLE_VIDEO_STREAMSList 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

string
Video ID
string
Ignored if video_id is provided)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_YOUTUBE_WEB_V2_LIST_VIDEO_STREAM_FORMATSList 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 requestDiscount: 50

Input Parameters

string
Video ID
string
Ignored if video_id is provided)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_YOUTUBE_WEB_V2_SEARCH_CHANNELSSearch 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 requestDiscount: 50

Input Parameters

string
Search keyword
boolean
Whether to format data
string
Omit for the first page. Committed response evidence has no continuation token to reuse, so only manual one-page retrieval is supported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_ZHIHU_WEB_FETCH_AI_SEARCH_STREAMAsk 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

string
Chat mode
string
Session ID
string
required
Search Content

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_ZHIHU_WEB_FETCH_COLUMN_ARTICLE_DETAILGet 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 requestDiscount: 50

Input Parameters

string
required
Article ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_ZHIHU_WEB_FETCH_COLUMN_ARTICLESList 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 requestDiscount: 50

Input Parameters

string
Number of articles per page.
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.
string
required
Column ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_ZHIHU_WEB_FETCH_COLUMN_COMMENT_CONFIGGet 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 requestDiscount: 50

Input Parameters

string
required
Article ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_ZHIHU_WEB_FETCH_COLUMN_RELATIONSHIPGet 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 requestDiscount: 50

Input Parameters

string
required
Article ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_ZHIHU_WEB_FETCH_COLUMN_SEARCH_V3Search 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 requestDiscount: 50

Input Parameters

string
Number of columns per page
string
Offset
string
required
Search Keywords
string
Search Hash ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_ZHIHU_WEB_FETCH_HOT_LISTGet 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 requestDiscount: 50

Input Parameters

string
Maximum hot-list entries to request.
string
Whether to request the desktop hot-list layout.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_ZHIHU_WEB_FETCH_PRESET_SEARCHGet 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 requestDiscount: 50

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_ZHIHU_WEB_FETCH_QUESTION_ANSWERSList 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 requestDiscount: 50

Input Parameters

integer
Number of answers per page.
string
Sort order: default=default sort, updated=sort by time.
string
Pagination cursor.
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.
string
required
Question ID.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_ZHIHU_WEB_FETCH_QUESTION_DETAILGet 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 requestDiscount: 50

Input Parameters

string
required
Question ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_ZHIHU_WEB_FETCH_SALT_SEARCH_V3Search 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 requestDiscount: 50

Input Parameters

string
Number of contents per page
string
Offset
string
required
Search Keywords
string
Search Hash ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_ZHIHU_WEB_FETCH_SCHOLAR_SEARCH_V3Search 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 requestDiscount: 50

Input Parameters

string
Number of papers per page
string
Offset
string
required
Search Keywords

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_ZHIHU_WEB_FETCH_SEARCH_SUGGESTGet 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 requestDiscount: 50

Input Parameters

string
required
Search Keywords.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_ZHIHU_WEB_FETCH_TOPIC_SEARCH_V3Request 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 requestDiscount: 50

Input Parameters

string
Number of topics per page
string
Offset
string
required
Search Keywords

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_ZHIHU_WEB_FETCH_USER_COLLECTIONSRequest 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 requestDiscount: 50

Input Parameters

string
Number of collections per page
string
Offset
string
required
User ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_ZHIHU_WEB_FETCH_USER_FOLLOW_COLLECTIONSRequest 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 requestDiscount: 50

Input Parameters

string
Number of collections per page
string
Offset
string
required
User ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_ZHIHU_WEB_FETCH_USER_FOLLOW_COLUMNSRequest 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 requestDiscount: 50

Input Parameters

string
Number of columns per page
string
Offset
string
required
User ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_ZHIHU_WEB_FETCH_USER_FOLLOWEESList 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 requestDiscount: 50

Input Parameters

string
Number of users per page
string
Offset
string
required
User ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_ZHIHU_WEB_FETCH_USER_FOLLOWERSList 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 requestDiscount: 50

Input Parameters

string
Number of users per page.
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.
string
required
User ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_ZHIHU_WEB_FETCH_USER_FOLLOW_TOPICSRequest 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 requestDiscount: 50

Input Parameters

string
Number of topics per page
string
Offset
string
required
User ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_ZHIHU_WEB_FETCH_USER_INCLUDED_ARTICLESList 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 requestDiscount: 50

Input Parameters

string
Number of articles per page.
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.
string
required
User ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_ZHIHU_WEB_FETCH_USER_INFOGet 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 requestDiscount: 50

Input Parameters

string
required
User ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_ZHIHU_WEB_FETCH_USER_SEARCH_V3Request 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 requestDiscount: 50

Input Parameters

string
Number of users per page
string
Offset
string
required
Search Keywords

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_ZHIHU_WEB_FETCH_USER_SEGMENTSRequest 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 requestDiscount: 50

Input Parameters

string
Number per page
string
Offset
string
Content type
string
required
User member hash id (not url_token)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TIK_HUB_ZHIHU_WEB_FETCH_VIDEO_LISTRequest 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 requestDiscount: 50

Input Parameters

string
Number of videos per page
string
Offset

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not