---
canonical_url: "https://docs.composio.dev/toolkits/tik_hub"
markdown_url: "https://docs.composio.dev/toolkits/tik_hub.md"
product: "platform"
version: null
last_updated: null
---

# TikHub

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

- **Category:** social & creator data
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 514
- **Triggers:** 0
- **Slug:** `TIK_HUB`
- **Version:** 20261014_02
- **Instant:** Supported on the latest version. Support varies by tool.

## Tools

### BilibiliAppFetchBangumiTab

**Slug:** `TIK_HUB_BILIBILI_APP_FETCH_BANGUMI_TAB`

Fetch Bangumi Tab on Bilibili through TikHub's Bilibili-App surface. This action is limited to fetch bangumi tab and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### BilibiliAppFetchReplyDetail

**Slug:** `TIK_HUB_BILIBILI_APP_FETCH_REPLY_DETAIL`

Fetch Reply Detail on Bilibili through TikHub's Bilibili-App surface. This action is limited to fetch reply detail and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `av_id` | string | No | AV号/AV ID |
| `bv_id` | string | No | BV号/BV ID |
| `page_size` | integer | No | 每页数量/Page size |
| `next_offset` | integer | No | 下一页游标/Next page cursor |
| `root_comment_id` | string | Yes | Bilibili root comment ID returned by a video-comments result. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### BilibiliAppFetchSearchAll

**Slug:** `TIK_HUB_BILIBILI_APP_FETCH_SEARCH_ALL`

Fetch Search All on Bilibili through TikHub's Bilibili-App surface. This action is limited to fetch search all and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order` | integer | No | 排序方式/Sort order (0=综合排序) |
| `cursor` | string | No | 翻页游标，首页留空；翻页时传回上一页响应的 data.pagination.next/Pagination cursor, leave empty for the first page; for the next page pass back data.pagination.next from the previous response |
| `keyword` | string | Yes | 搜索关键词/Search keyword |
| `page_size` | integer | No | 每页数量/Page size |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bilibili Web Bv To Aid

**Slug:** `TIK_HUB_BILIBILI_WEB_BV_TO_AID`

Bv To Aid on Bilibili through TikHub's Bilibili-Web surface. This action is limited to bv to aid and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bv_id` | string | Yes | 作品id/Video id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bilibili Web Fetch Collect Folders

**Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_COLLECT_FOLDERS`

Fetch Collect Folders on Bilibili through TikHub's Bilibili-Web surface. This action is limited to fetch collect folders and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | 用户UID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bilibili Web Fetch Comment Reply

**Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_COMMENT_REPLY`

Fetch Comment Reply on Bilibili through TikHub's Bilibili-Web surface. This action is limited to fetch comment reply and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bv_id` | string | Yes | 作品id/Video id |
| `reply_id` | string | Yes | Bilibili reply ID returned by a comment or reply result. |
| `page_number` | integer | No | 页码/Page number |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bilibili Web Fetch Com Popular

**Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_COM_POPULAR`

Fetch Com Popular on Bilibili through TikHub's Bilibili-Web surface. This action is limited to fetch com popular and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_number` | integer | No | 页码/Page number |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bilibili Web Fetch General Search

**Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_GENERAL_SEARCH`

Fetch General Search on Bilibili through TikHub's Bilibili-Web surface. This action is limited to fetch general search and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | Yes | 页码/Page number |
| `order` | string | Yes | 排序方式/Order method |
| `keyword` | string | Yes | 搜索关键词/Search keyword |
| `duration` | integer | No | 时长筛选/Duration filter |
| `page_size` | integer | Yes | 每页数量/Number per page |
| `pubtime_end_s` | integer | No | 结束日期/End date (10-digit timestamp) |
| `pubtime_begin_s` | integer | No | 开始日期/Start date (10-digit timestamp) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bilibili Web Fetch Get User Id

**Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_GET_USER_ID`

Fetch Get User Id on Bilibili through TikHub's Bilibili-Web surface. This action is limited to fetch get user id and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `share_link` | string | Yes | 用户分享链接/User share link |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bilibili Web Fetch Hot Search

**Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_HOT_SEARCH`

Fetch Hot Search on Bilibili through TikHub's Bilibili-Web surface. This action is limited to fetch hot search and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | Yes | 返回数量/Return number |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bilibili Web Fetch Live Room Detail

**Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_LIVE_ROOM_DETAIL`

Fetch Live Room Detail on Bilibili through TikHub's Bilibili-Web surface. This action is limited to fetch live room detail and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `room_id` | string | Yes | 直播间ID/Live room ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bilibili Web Fetch Live Videos

**Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_LIVE_VIDEOS`

Fetch Live Videos on Bilibili through TikHub's Bilibili-Web surface. This action is limited to fetch live videos and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `room_id` | string | Yes | 直播间ID/Live room ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bilibili Web Fetch User Collection Videos

**Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_USER_COLLECTION_VIDEOS`

Fetch User Collection Videos on Bilibili through TikHub's Bilibili-Web surface. This action is limited to fetch user collection videos and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `folder_id` | string | Yes | 收藏夹id/collection folder id |
| `page_number` | integer | No | 页码/Page number |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bilibili Web Fetch User Dynamic

**Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_USER_DYNAMIC`

Fetch User Dynamic on Bilibili through TikHub's Bilibili-Web surface. This action is limited to fetch user dynamic and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | 用户UID |
| `offset` | string | No | 开始索引/offset |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Bilibili user post videos

**Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_USER_POST_VIDEOS`

Fetch published Bilibili videos with order controls and rich video summaries. Use V2 instead when keyword filtering or page sizes up to 100 are required.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | Bilibili user UID. |
| `order` | string ("pubdate" | "click" | "stow") | No | Sort by newest publication, most plays, or most favorites. |
| `page_size` | integer | No | Number of videos per page (1-50). |
| `page_number` | integer | No | Page number (1-100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Homepage Video Data V2

**Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_USER_POST_VIDEOS_V2`

Fetch Bilibili user-video page metadata with optional keyword filtering and page sizes up to 100. Use the non-V2 action for sortable rich video summaries.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | 用户UID |
| `keyword` | string | No | 关键词，留空返回全部/Keyword, empty returns all |
| `page_size` | integer | No | Number of videos per page (1-100). |
| `page_number` | integer | No | Page number, starting at 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Bilibili user profile

**Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_USER_PROFILE`

Fetch a Bilibili user's public profile through TikHub.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | Bilibili user UID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bilibili Web Fetch User Relation Stat

**Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_USER_RELATION_STAT`

Fetch User Relation Stat on Bilibili through TikHub's Bilibili-Web surface. This action is limited to fetch user relation stat and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | 用户UID/User UID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bilibili Web Fetch Video Comments

**Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_VIDEO_COMMENTS`

Fetch Video Comments on Bilibili through TikHub's Bilibili-Web surface. This action is limited to fetch video comments and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bv_id` | string | Yes | 作品id/Video id |
| `page_number` | integer | No | 页码/Page number |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bilibili Web Fetch Video Play Info

**Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_VIDEO_PLAY_INFO`

Fetch Video Play Info on Bilibili through TikHub's Bilibili-Web surface. This action is limited to fetch video play info and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | 视频链接/Video URL |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bilibili Web Fetch Video Playurl

**Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_VIDEO_PLAYURL`

Fetch Video Playurl on Bilibili through TikHub's Bilibili-Web surface. This action is limited to fetch video playurl and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cid` | string | Yes | 作品cid/Video cid |
| `bv_id` | string | Yes | 作品id/Video id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bilibili Web Fetch Video Subtitle

**Slug:** `TIK_HUB_BILIBILI_WEB_FETCH_VIDEO_SUBTITLE`

Fetch Video Subtitle on Bilibili through TikHub's Bilibili-Web surface. This action is limited to fetch video subtitle and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `av_id` | string | Yes | Bilibili AV video ID returned as aid by a video lookup. |
| `content_id` | string | Yes | Bilibili page content ID returned as cid for the selected video page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bilibili Non-Video Dynamic Detail

**Slug:** `TIK_HUB_BILIBILI_WEB_GET_NONVIDEO_DYNAMIC_DETAIL`

Fetch image, text, or article Bilibili dynamic details with full favorite and coin statistics. Use the video-dynamic variant for video dynamics.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dynamic_id` | string | Yes | 动态id/Dynamic id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bilibili Video By AV ID And CID

**Slug:** `TIK_HUB_BILIBILI_WEB_GET_VIDEO_BY_AV_ID_AND_CID`

Fetch Bilibili video details by AV ID and CID. The BV variant instead accepts a BV ID.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.002 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `av_id` | string | Yes | Bilibili AV video ID parsed from a video URL or returned as aid by search. |
| `content_id` | string | Yes | Bilibili page content ID returned as cid for the selected video page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bilibili Video By BV ID

**Slug:** `TIK_HUB_BILIBILI_WEB_GET_VIDEO_BY_BV_ID`

Fetch Bilibili video details by BV ID. The AV-and-CID variant is a distinct lookup that requires both identifiers.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bv_id` | string | Yes | 作品id/Video id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bilibili Video Dynamic Engagement

**Slug:** `TIK_HUB_BILIBILI_WEB_GET_VIDEO_DYNAMIC_ENGAGEMENT`

Fetch Bilibili video dynamic details with comment, forward, and like statistics. Use the non-video variant for favorite and coin data on image, text, or article dynamics.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dynamic_id` | string | Yes | 动态id/Dynamic id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin AppV3FetchBrandHotSearchList

**Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_BRAND_HOT_SEARCH_LIST`

Fetch Brand Hot Search List on Douyin through TikHub's Douyin-App-V3 surface. This action is limited to fetch brand hot search list and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin AppV3FetchBrandHotSearchListDetail

**Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_BRAND_HOT_SEARCH_LIST_DETAIL`

Fetch Brand Hot Search List Detail on Douyin through TikHub's Douyin-App-V3 surface. This action is limited to fetch brand hot search list detail and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category_id` | integer | Yes | 分类id/Category id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin AppV3FetchHashtagDetail

**Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_HASHTAG_DETAIL`

Fetch Hashtag Detail on Douyin through TikHub's Douyin-App-V3 surface. This action is limited to fetch hashtag detail and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ch_id` | integer | Yes | 话题id/Hashtag id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin App V3 Fetch Hashtag Video List

**Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_HASHTAG_VIDEO_LIST`

Read the fixed TikHub Douyin route /api/v1/douyin/app/v3/fetch_hashtag_video_list and return a typed business-data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ch_id` | string | Yes | Hashtag id. |
| `count` | integer | No | Number. |
| `cursor` | integer | No | Use 0 for the first page. Reuse data.cursor while data.has_more is nonzero; stop when data.has_more is 0. |
| `sort_type` | integer | No | Sort type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin App V3 Fetch Hot Search List

**Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_HOT_SEARCH_LIST`

Read the fixed TikHub Douyin route /api/v1/douyin/app/v3/fetch_hot_search_list and return a typed business-data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `board_type` | string | No | Board type. |
| `board_sub_type` | string | No | Board sub type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin AppV3FetchMultiVideoHighQualityPlayUrl

**Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_MULTI_VIDEO_HIGH_QUALITY_PLAY_URL`

Fetch Multi Video High Quality Play Url on Douyin through TikHub's Douyin-App-V3 surface. This action is limited to fetch multi video high quality play url and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.5 per batch of up to 50 high-quality Douyin video URLs

**Discount:** 50

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `region` | string | No | 可选，请求出口地区(ISO 国家代码，如 CN/US/HK)。抖音根据请求 IP 返回对应区域 CDN，国内用户传 'CN' 可获得国内 CDN 链接以加快下载速度 / Optional, ISO country code (e.g. CN). Pass 'CN' for users in mainland China to get China-region CDN URLs for faster download. |
| `aweme_ids` | string | Yes | 作品id列表，用逗号分隔，最多50个/Video id list, separated by commas, up to 50 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin AppV3FetchMultiVideoStatistics

**Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_MULTI_VIDEO_STATISTICS`

Fetch Multi Video Statistics on Douyin through TikHub's Douyin-App-V3 surface. This action is limited to fetch multi video statistics and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.025 per batch of up to 50 Douyin video statistics

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `aweme_ids` | string | Yes | 作品id/Video id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin AppV3FetchMusicDetail

**Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_MUSIC_DETAIL`

Fetch Music Detail on Douyin through TikHub's Douyin-App-V3 surface. This action is limited to fetch music detail and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `music_id` | string | Yes | 音乐id/Music id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin App V3 Fetch Music Hot Search List

**Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_MUSIC_HOT_SEARCH_LIST`

Read the fixed TikHub Douyin route /api/v1/douyin/app/v3/fetch_music_hot_search_list and return a typed business-data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Use '0' for the first page. Reuse data.cursor as a string while data.has_more is nonzero; stop when data.has_more is 0. |
| `chart_type` | string | No | Chart type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin App V3 Fetch Music Video List

**Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_MUSIC_VIDEO_LIST`

Read the fixed TikHub Douyin route /api/v1/douyin/app/v3/fetch_music_video_list and return a typed business-data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Number. |
| `cursor` | integer | No | Use 0 for the first page. Reuse data.cursor while data.has_more is nonzero; stop when data.has_more is 0. |
| `music_id` | string | Yes | Music id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin App V3 Fetch One Video

**Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_ONE_VIDEO`

Fetch a Douyin App video by aweme ID from the original /fetch_one_video route. Prefer this original route by default because no documented or live functional difference from V2 or V3 is substantiated.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `aweme_id` | string | Yes | Video id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin AppV3FetchOneVideoByShareUrl

**Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_ONE_VIDEO_BY_SHARE_URL`

Fetch One Video By Share Url on Douyin through TikHub's Douyin-App-V3 surface. This action is limited to fetch one video by share url and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `share_url` | string | Yes | 分享链接/Share link |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin App V3 Fetch One Video V2

**Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_ONE_VIDEO_V2`

Fetch a Douyin App video by aweme ID from the /fetch_one_video_v2 route. Use only when the caller explicitly requires V2; otherwise prefer the original route because no documented or live functional difference is substantiated.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `aweme_id` | string | Yes | Video id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin App V3 Fetch One Video V3

**Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_ONE_VIDEO_V3`

Fetch a Douyin App video by aweme ID from the /fetch_one_video_v3 route. Use only when the caller explicitly requires V3; otherwise prefer the original route because no documented or live functional difference is substantiated.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `aweme_id` | string | Yes | Video or Article ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DOUYIN APP V3 FETCH SERIES DETAIL

**Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_SERIES_DETAIL`

Get series detail. Calls TikHub's documented Douyin-App-V3-API route and returns its validated response contract.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `series_id` | string | Yes | Series id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DOUYIN APP V3 FETCH SERIES VIDEO LIST

**Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_SERIES_VIDEO_LIST`

Get series video list. Calls TikHub's documented Douyin-App-V3-API route and returns its validated response contract.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | integer | No | Use 0 for the first page. Reuse data.max_cursor while data.has_more is nonzero; stop when data.has_more is 0. |
| `series_id` | string | Yes | Series id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DOUYIN APP V3 FETCH USER LIKE VIDEOS

**Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_USER_LIKE_VIDEOS`

Get user like video data. Calls TikHub's documented Douyin-App-V3-API route and returns its validated response contract.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `counts` | integer | No | Number per page |
| `max_cursor` | integer | No | Maximum cursor |
| `sec_user_id` | string | Yes | User sec_user_id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin App V3 Fetch User Post Videos

**Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_USER_POST_VIDEOS`

Read the fixed TikHub Douyin route /api/v1/douyin/app/v3/fetch_user_post_videos and return a typed business-data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Number per page. |
| `channel` | string | No | Douyin channel: normal(-), lite(). |
| `sort_type` | integer | No | Sort type. |
| `max_cursor` | integer | No | Maximum cursor. |
| `sec_user_id` | string | Yes | User sec_user_id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin AppV3FetchVideoCommentReplies

**Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_VIDEO_COMMENT_REPLIES`

Fetch Video Comment Replies on Douyin through TikHub's Douyin-App-V3 surface. This action is limited to fetch video comment replies and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | 数量/Number |
| `cursor` | integer | No | 游标/Cursor |
| `item_id` | string | Yes | 作品id/Video id |
| `comment_id` | string | Yes | 评论id/Comment id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin App V3 Fetch Video Comments

**Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_VIDEO_COMMENTS`

Read the fixed TikHub Douyin route /api/v1/douyin/app/v3/fetch_video_comments and return a typed business-data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Number. |
| `cursor` | integer | No | Use 0 for the first page. Reuse data.cursor while data.has_more is nonzero; stop when data.has_more is 0. |
| `aweme_id` | string | Yes | Video id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin App V3 Fetch Video High Quality Play Url

**Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_VIDEO_HIGH_QUALITY_PLAY_URL`

Read the fixed TikHub Douyin route /api/v1/douyin/app/v3/fetch_video_high_quality_play_url and return a typed business-data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.005 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `region` | string | No | HK). Pass CN to get China-region CDN URLs for faster download in mainland China. |
| `aweme_id` | string | No | Video id. |
| `share_url` | string | No | Optional, share link. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin AppV3FetchVideoMixDetail

**Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_VIDEO_MIX_DETAIL`

Fetch Video Mix Detail on Douyin through TikHub's Douyin-App-V3 surface. This action is limited to fetch video mix detail and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mix_id` | string | Yes | 合集id/Mix id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin App V3 Fetch Video Mix Post List

**Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_VIDEO_MIX_POST_LIST`

Read the fixed TikHub Douyin route /api/v1/douyin/app/v3/fetch_video_mix_post_list and return a typed business-data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Number. |
| `cursor` | integer | No | Use 0 for the first page. Reuse data.cursor while data.has_more is nonzero; stop when data.has_more is 0. |
| `mix_id` | string | Yes | Mix id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin AppV3FetchVideoStatistics

**Slug:** `TIK_HUB_DOUYIN_APP_V3_FETCH_VIDEO_STATISTICS`

Fetch Video Statistics on Douyin through TikHub's Douyin-App-V3 surface. This action is limited to fetch video statistics and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `aweme_ids` | string | Yes | 作品id/Video id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin AppV3GenerateDouyin ShortUrl

**Slug:** `TIK_HUB_DOUYIN_APP_V3_GENERATE_DOUYIN_SHORT_URL`

Generate Douyin Short Url on Douyin through TikHub's Douyin-App-V3 surface. This action is limited to generate douyin short url and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | 抖音链接/Douyin link |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin AppV3GenerateDouyin VideoShareQrcode

**Slug:** `TIK_HUB_DOUYIN_APP_V3_GENERATE_DOUYIN_VIDEO_SHARE_QRCODE`

Generate Douyin Video Share Qrcode on Douyin through TikHub's Douyin-App-V3 surface. This action is limited to generate douyin video share qrcode and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `object_id` | string | Yes | 作品id/Video id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Douyin App User Profile

**Slug:** `TIK_HUB_DOUYIN_APP_V3_GET_USER_PROFILE`

Get a compact Douyin app profile by sec_user_id. Use the Douyin Web profile action when the identifier is a public unique_id or numeric uid.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sec_user_id` | string | Yes | 用户sec_user_id/User sec_user_id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Douyin keyword-search handoff URL

**Slug:** `TIK_HUB_DOUYIN_APP_V3_OPEN_DOUYIN_APP_TO_KEYWORD_SEARCH`

Generate and return a Douyin mobile-app handoff URL for a keyword search. This read-only action does not open the app; a human must open the URL.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `keyword` | string | Yes | Keyword |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Douyin private-message handoff URL

**Slug:** `TIK_HUB_DOUYIN_APP_V3_OPEN_DOUYIN_APP_TO_SEND_PRIVATE_MESSAGE`

Generate and return a Douyin mobile-app handoff URL for a private-message recipient. This read-only action does not open the app or send a message; a human must complete the send.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | User id |
| `sec_uid` | string | Yes | User sec_uid |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Douyin profile handoff URL

**Slug:** `TIK_HUB_DOUYIN_APP_V3_OPEN_DOUYIN_APP_TO_USER_PROFILE`

Generate and return a Douyin mobile-app handoff URL for a user profile. This read-only action does not open the app; a human must open the URL.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | User id |
| `sec_uid` | string | Yes | User sec_uid |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Douyin video handoff URL

**Slug:** `TIK_HUB_DOUYIN_APP_V3_OPEN_DOUYIN_APP_TO_VIDEO_DETAIL`

Generate and return a Douyin mobile-app handoff URL for a video. This read-only action does not open the app; a human must open the URL.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `aweme_id` | string | Yes | Video id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Billboard Fetch City List

**Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_CITY_LIST`

Fetch City List on Douyin through TikHub's Douyin-Billboard surface. This action is limited to fetch city list and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Billboard Fetch Content Tag

**Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_CONTENT_TAG`

Fetch Content Tag on Douyin through TikHub's Douyin-Billboard surface. This action is limited to fetch content tag and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Billboard Fetch Hot Account Fans Portrait List

**Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_ACCOUNT_FANS_PORTRAIT_LIST`

Fetch Hot Account Fans Portrait List on Douyin through TikHub's Douyin-Billboard surface. This action is limited to fetch hot account fans portrait list and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `option` | integer | No | 选项，1 手机价格分布 2 性别分布 3 年龄分布 4 地域分布-省份 5 地域分布-城市 6 城市等级 7 手机品牌分布 8 兴趣标签分析 百分比 |
| `sec_uid` | string | Yes | 用户sec_id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Billboard Fetch Hot Account Item Analysis List

**Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_ACCOUNT_ITEM_ANALYSIS_LIST`

Fetch Hot Account Item Analysis List on Douyin through TikHub's Douyin-Billboard surface. This action is limited to fetch hot account item analysis list and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sec_uid` | string | Yes | 用户sec_id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Billboard Fetch Hot Account List

**Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_ACCOUNT_LIST`

Fetch Hot Account List on Douyin through TikHub's Douyin-Billboard surface. This action is limited to fetch hot account list and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_num` | integer | No | 页码，默认1 |
| `page_size` | integer | No | 每页数量，默认10 |
| `query_tag` | object | No | 垂类标签筛选，空则为全部，标签id从 fetch_content_tag 接口获取 |
| `date_window` | integer | No | 时间窗口(小时)，可选 24/72/168，代表近1天/近3天/近7天，默认24 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Billboard Fetch Hot Account Search List

**Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_ACCOUNT_SEARCH_LIST`

Fetch Hot Account Search List on Douyin through TikHub's Douyin-Billboard surface. This action is limited to fetch hot account search list and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | integer | Yes | Required pagination cursor. Pass the provider-required first-page cursor value, then pass data.data.cursor from the previous response while data.data.has_more is true. |
| `keyword` | string | Yes | 搜索的用户名或抖音号 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Billboard Fetch Hot Account Trends List

**Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_ACCOUNT_TRENDS_LIST`

Read the fixed TikHub Douyin route /api/v1/douyin/billboard/fetch_hot_account_trends_list and return a typed business-data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `option` | integer | No | 2  3  4  5. |
| `sec_uid` | string | Yes | sec_id. |
| `date_window` | integer | No | 24. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Billboard Fetch Hot Calendar Detail

**Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_CALENDAR_DETAIL`

Fetch Hot Calendar Detail on Douyin through TikHub's Douyin-Billboard surface. This action is limited to fetch hot calendar detail and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `calendar_id` | string | Yes | 活动id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Billboard Fetch Hot Calendar List

**Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_CALENDAR_LIST`

Fetch Hot Calendar List on Douyin through TikHub's Douyin-Billboard surface. This action is limited to fetch hot calendar list and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_date` | integer | Yes | 快照结束时间，10位Unix时间戳 |
| `city_code` | string | No | 城市编码，从城市列表获取，空为全部 |
| `start_date` | integer | Yes | 快照开始时间，10位Unix时间戳 |
| `category_code` | string | No | 热点榜分类编码，从热点榜分类获取，空为全部 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Billboard Fetch Hot Category List

**Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_CATEGORY_LIST`

Fetch Hot Category List on Douyin through TikHub's Douyin-Billboard surface. This action is limited to fetch hot category list and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `keyword` | string | No | 热点搜索词 |
| `end_date` | string | No | 快照结束时间 格式yyyyMMdd |
| `start_date` | string | No | 快照开始时间 格式yyyyMMdd |
| `snapshot_time` | string | No | 可选快照时间，格式yyyyMMddHHmmss |
| `billboard_type` | string | Yes | 榜单类型 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Billboard Fetch Hot Challenge List

**Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_CHALLENGE_LIST`

Fetch Hot Challenge List on Douyin through TikHub's Douyin-Billboard surface. This action is limited to fetch hot challenge list and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | Yes | 页码 |
| `keyword` | string | No | 热点搜索词 |
| `page_size` | integer | Yes | 每页数量 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Billboard Fetch Hot City List

**Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_CITY_LIST`

Fetch Hot City List on Douyin through TikHub's Douyin-Billboard surface. This action is limited to fetch hot city list and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | Yes | 页码 |
| `order` | string | Yes | 排序方式 |
| `keyword` | string | No | 热点搜索词 |
| `city_code` | string | No | 城市编码，从城市列表获取，空为全部 |
| `page_size` | integer | Yes | 每页数量 |
| `sentence_tag` | string | No | 热点分类标签，从热点榜分类获取，多个分类用逗号分隔，空为全部 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Billboard Fetch Hot Comment Word List

**Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_COMMENT_WORD_LIST`

Fetch Hot Comment Word List on Douyin through TikHub's Douyin-Billboard surface. This action is limited to fetch hot comment word list and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `aweme_id` | string | Yes | 作品id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Billboard Fetch Hot Rise List

**Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_RISE_LIST`

Fetch Hot Rise List on Douyin through TikHub's Douyin-Billboard surface. This action is limited to fetch hot rise list and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | Yes | 页码 |
| `order` | string | Yes | 排序方式 |
| `keyword` | string | No | 热点搜索词 |
| `page_size` | integer | Yes | 每页数量 |
| `sentence_tag` | string | No | 热点分类标签，从热点榜分类获取，多个分类用逗号分隔，空为全部 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Billboard Fetch Hot Total High Fan List

**Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_TOTAL_HIGH_FAN_LIST`

Fetch Hot Total High Fan List on Douyin through TikHub's Douyin-Billboard surface. This action is limited to fetch hot total high fan list and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | 页码 |
| `tags` | array | No | 垂类标签筛选，空则为全部，标签id从 fetch_content_tag 接口获取 |
| `keyword` | string | No | 搜索关键词，对榜单按关键词过滤，空为全部 |
| `page_size` | integer | No | 每页数量 |
| `date_window` | integer | No | 时间窗口(小时)，可选 1/24/72/168，代表近1小时/近1天/近3天/近7天，默认24 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Billboard Fetch Hot Total High Like List

**Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_TOTAL_HIGH_LIKE_LIST`

Fetch Hot Total High Like List on Douyin through TikHub's Douyin-Billboard surface. This action is limited to fetch hot total high like list and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | 页码 |
| `tags` | array | No | 垂类标签筛选，空则为全部，标签id从 fetch_content_tag 接口获取 |
| `keyword` | string | No | 搜索关键词，对榜单按关键词过滤，空为全部 |
| `page_size` | integer | No | 每页数量 |
| `date_window` | integer | No | 时间窗口(小时)，可选 1/24/72/168，代表近1小时/近1天/近3天/近7天，默认24 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Billboard Fetch Hot Total High Play List

**Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_TOTAL_HIGH_PLAY_LIST`

Fetch Hot Total High Play List on Douyin through TikHub's Douyin-Billboard surface. This action is limited to fetch hot total high play list and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | 页码 |
| `tags` | array | No | 垂类标签筛选，空则为全部，标签id从 fetch_content_tag 接口获取 |
| `keyword` | string | No | 搜索关键词，对榜单按关键词过滤，空为全部 |
| `page_size` | integer | No | 每页数量 |
| `date_window` | integer | No | 时间窗口(小时)，可选 1/24/72/168，代表近1小时/近1天/近3天/近7天，默认24 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Billboard Fetch Hot Total High Search List

**Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_TOTAL_HIGH_SEARCH_LIST`

Fetch Hot Total High Search List on Douyin through TikHub's Douyin-Billboard surface. This action is limited to fetch hot total high search list and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `keyword` | string | No | 搜索关键字 |
| `page_num` | integer | No | 页码 |
| `page_size` | integer | No | 每页数量 |
| `date_window` | integer | No | 时间窗口(小时)，可选 1/24/72/168，代表近1小时/近1天/近3天/近7天，默认24 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Billboard Fetch Hot Total High Topic List

**Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_TOTAL_HIGH_TOPIC_LIST`

Fetch Hot Total High Topic List on Douyin through TikHub's Douyin-Billboard surface. This action is limited to fetch hot total high topic list and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | 页码 |
| `tags` | array | No | 垂类标签筛选，空则为全部，标签id从 fetch_content_tag 接口获取 |
| `keyword` | string | No | 搜索关键词，对榜单按关键词过滤，空为全部 |
| `page_size` | integer | No | 每页数量 |
| `date_window` | integer | No | 时间窗口(小时)，可选 1/24/72/168，代表近1小时/近1天/近3天/近7天，默认24 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Billboard Fetch Hot Total Hot Word List

**Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_TOTAL_HOT_WORD_LIST`

Fetch Hot Total Hot Word List on Douyin through TikHub's Douyin-Billboard surface. This action is limited to fetch hot total hot word list and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `keyword` | string | No | 搜索关键字 |
| `page_num` | integer | No | 页码 |
| `page_size` | integer | No | 每页数量 |
| `date_window` | integer | No | 时间窗口(小时)，可选 24/72/168，代表近1天/近3天/近7天，默认24 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Billboard Fetch Hot Total List

**Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_TOTAL_LIST`

Fetch Hot Total List on Douyin through TikHub's Douyin-Billboard surface. This action is limited to fetch hot total list and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | Yes | 页码 |
| `type` | string | Yes | 快照类型 snapshot 按时刻查看 range 按时间范围 |
| `keyword` | string | No | 热点搜索词 |
| `end_date` | string | No | 快照结束时间 格式yyyyMMdd |
| `page_size` | integer | Yes | 每页数量 |
| `start_date` | string | No | 快照开始时间 格式yyyyMMdd |
| `sentence_tag` | string | No | 热点分类标签，从热点榜分类获取，多个分类用逗号分隔，空为全部 |
| `snapshot_time` | string | No | type=snapshot 时的快照时间，格式yyyyMMddHHmmss |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Billboard Fetch Hot Total Low Fan List

**Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_TOTAL_LOW_FAN_LIST`

Fetch Hot Total Low Fan List on Douyin through TikHub's Douyin-Billboard surface. This action is limited to fetch hot total low fan list and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | 页码 |
| `tags` | array | No | 垂类标签筛选，空则为全部，标签id从 fetch_content_tag 接口获取 |
| `keyword` | string | No | 搜索关键词，对榜单按关键词过滤，空为全部 |
| `page_size` | integer | No | 每页数量 |
| `date_window` | integer | No | 时间窗口(小时)，可选 1/24/72/168，代表近1小时/近1天/近3天/近7天，默认24 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Billboard Fetch Hot Total Search List

**Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_TOTAL_SEARCH_LIST`

Fetch Hot Total Search List on Douyin through TikHub's Douyin-Billboard surface. This action is limited to fetch hot total search list and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `keyword` | string | No | 搜索关键字 |
| `page_num` | integer | No | 页码 |
| `page_size` | integer | No | 每页数量 |
| `date_window` | integer | No | 时间窗口(小时)，可选 1/24/72/168，代表近1小时/近1天/近3天/近7天，默认24 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Billboard Fetch Hot Total Topic List

**Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_TOTAL_TOPIC_LIST`

Fetch Hot Total Topic List on Douyin through TikHub's Douyin-Billboard surface. This action is limited to fetch hot total topic list and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | 页码 |
| `tags` | array | No | 垂类标签筛选，空则为全部，标签id从 fetch_content_tag 接口获取 |
| `keyword` | string | No | 搜索关键词，对榜单按关键词过滤，空为全部 |
| `page_size` | integer | No | 每页数量 |
| `date_window` | integer | No | 时间窗口(小时)，可选 1/24/72/168，代表近1小时/近1天/近3天/近7天，默认24 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Billboard Fetch Hot Total Video List

**Slug:** `TIK_HUB_DOUYIN_BILLBOARD_FETCH_HOT_TOTAL_VIDEO_LIST`

Fetch Hot Total Video List on Douyin through TikHub's Douyin-Billboard surface. This action is limited to fetch hot total video list and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | 页码，默认1 |
| `tags` | array | No | 垂类标签筛选，空则为全部，标签id从 fetch_content_tag 接口获取 |
| `keyword` | string | No | 搜索关键词，对榜单按关键词过滤，空为全部 |
| `sub_type` | integer | No | 榜单分类，1001 视频总榜 1002 低粉爆款 1003 高完播率 1004 高涨粉率 1005 高点赞率 |
| `page_size` | integer | No | 每页数量，默认10 |
| `date_window` | integer | No | 时间窗口(小时)，可选 1/24/72/168，代表近1小时/近1天/近3天/近7天，默认24 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin CreatorFetchCreatorActivityDetail

**Slug:** `TIK_HUB_DOUYIN_CREATOR_FETCH_CREATOR_ACTIVITY_DETAIL`

Fetch Creator Activity Detail on Douyin through TikHub's Douyin-Creator surface. This action is limited to fetch creator activity detail and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `activity_id` | string | Yes | 活动ID/Activity ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin CreatorFetchCreatorActivityList

**Slug:** `TIK_HUB_DOUYIN_CREATOR_FETCH_CREATOR_ACTIVITY_LIST`

Fetch Creator Activity List on Douyin through TikHub's Douyin-Creator surface. This action is limited to fetch creator activity list and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_time` | integer | Yes | 结束时间戳/End timestamp |
| `start_time` | integer | Yes | 开始时间戳/Start timestamp |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin CreatorFetchCreatorContentCategory

**Slug:** `TIK_HUB_DOUYIN_CREATOR_FETCH_CREATOR_CONTENT_CATEGORY`

Fetch Creator Content Category on Douyin through TikHub's Douyin-Creator surface. This action is limited to fetch creator content category and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Creator Fetch Creator Content Course

**Slug:** `TIK_HUB_DOUYIN_CREATOR_FETCH_CREATOR_CONTENT_COURSE`

Read the fixed TikHub Douyin route /api/v1/douyin/creator/fetch_creator_content_course and return a typed business-data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Items per page. |
| `order` | integer | No | Order type (1=, 2=, 3=). |
| `offset` | integer | No | Offset (starting position). |
| `category_id` | integer | Yes | Category ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DOUYIN CREATOR FETCH CREATOR HOT CHALLENGE BILLBOARD

**Slug:** `TIK_HUB_DOUYIN_CREATOR_FETCH_CREATOR_HOT_CHALLENGE_BILLBOARD`

Get creator hot challenge billboard. Calls TikHub's documented Douyin-Creator-API route and returns its validated response contract.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Creator Fetch Creator Hot Course

**Slug:** `TIK_HUB_DOUYIN_CREATOR_FETCH_CREATOR_HOT_COURSE`

Read the fixed TikHub Douyin route /api/v1/douyin/creator/fetch_creator_hot_course and return a typed business-data projection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Items per page (24). |
| `order` | integer | No | Order type (1=, 2=, 3=). |
| `offset` | integer | No | Use 0 for the first page. Reuse data.offset while data.has_more is nonzero; stop when data.has_more is 0. |
| `category_id` | string | No | Available values: 6976547830546582816=, 6976547923849006336=, 6976547940311633165=, 6976547972108635404=, 6980288134957272352=, 6980288181744766219=, 6980288219548011776=. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin CreatorFetchCreatorHotSpotBillboard

**Slug:** `TIK_HUB_DOUYIN_CREATOR_FETCH_CREATOR_HOT_SPOT_BILLBOARD`

Fetch Creator Hot Spot Billboard on Douyin through TikHub's Douyin-Creator surface. This action is limited to fetch creator hot spot billboard and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `city_code` | string | No | 城市代码，当hot_search_type=2时必需/City code - required when hot_search_type=2 |
| `billboard_tag` | string | No | 热点标签，多个标签用逗号分隔，如'1004,1000,1002'/Hot spot tag - multiple tags separated by comma, like '1004,1000,1002' |
| `hot_search_type` | integer ("1" | "2" | "3") | No | 热搜类型: 1=热点总榜, 2=同城热点榜, 3=热点上升榜/Hot search type: 1=Overall ranking, 2=Local ranking, 3=Rising ranking |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin CreatorFetchCreatorMaterialCenterBillboard

**Slug:** `TIK_HUB_DOUYIN_CREATOR_FETCH_CREATOR_MATERIAL_CENTER_BILLBOARD`

Fetch Creator Material Center Billboard on Douyin through TikHub's Douyin-Creator surface. This action is limited to fetch creator material center billboard and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_key` | integer ("1" | "2" | "3" | "4") | No | 排序键: 1=播放最高, 2=点赞最多, 3=评论最多, 4=热度最高/Order key: 1=highest views, 2=most likes, 3=most comments, 4=highest popularity |
| `time_filter` | integer ("1" | "2" | "3") | No | 时间筛选: 1=24小时, 2=7天, 3=30天/Time filter: 1=24 hours, 2=7 days, 3=30 days |
| `billboard_tag` | integer | No | 榜单标签，0=全部，其他值请通过config接口获取/Billboard tag, 0=all, other values can be obtained through config interface |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin CreatorFetchCreatorMaterialCenterConfig

**Slug:** `TIK_HUB_DOUYIN_CREATOR_FETCH_CREATOR_MATERIAL_CENTER_CONFIG`

Fetch Creator Material Center Config on Douyin through TikHub's Douyin-Creator surface. This action is limited to fetch creator material center config and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin CreatorFetchCreatorMaterialCenterRelated

**Slug:** `TIK_HUB_DOUYIN_CREATOR_FETCH_CREATOR_MATERIAL_CENTER_RELATED`

Fetch Creator Material Center Related on Douyin through TikHub's Douyin-Creator surface. This action is limited to fetch creator material center related and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | 每页数量/Items per page |
| `offset` | integer | No | 偏移量/Offset |
| `query_id` | string | Yes | 查询ID/Query ID (话题ID/热点ID，从其他榜单接口获取) |
| `billboard_type` | integer | No | 榜单类型/Billboard type (2=热点, 3=话题, 4=道具, 5=音乐) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin CreatorFetchIndustryCategoryConfig

**Slug:** `TIK_HUB_DOUYIN_CREATOR_FETCH_INDUSTRY_CATEGORY_CONFIG`

Fetch Industry Category Config on Douyin through TikHub's Douyin-Creator surface. This action is limited to fetch industry category config and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### DOUYIN CREATOR FETCH MISSION TASK LIST

**Slug:** `TIK_HUB_DOUYIN_CREATOR_FETCH_MISSION_TASK_LIST`

Get mission task list. Calls TikHub's documented Douyin-Creator-API route and returns its validated response contract.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Items per page |
| `cursor` | integer | No | cursor value documented by TikHub. |
| `keyword` | string | No | keyword value documented by TikHub. |
| `pay_type` | integer | No | pay type value documented by TikHub. |
| `tab_scene` | integer | No | tab scene value documented by TikHub. |
| `industry_lv1` | integer | No | industry lv1 value documented by TikHub. |
| `industry_lv2` | integer | No | industry lv2 value documented by TikHub. |
| `mission_type` | integer | No | Mission type |
| `platform_channel` | integer | No | platform channel value documented by TikHub. |
| `publish_time_start` | integer | No | publish time start value documented by TikHub. |
| `quick_selector_scene` | integer | No | quick selector scene value documented by TikHub. |
| `greater_than_cost_progress` | integer | No | greater than cost progress value documented by TikHub. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin CreatorFetchUserSearch

**Slug:** `TIK_HUB_DOUYIN_CREATOR_FETCH_USER_SEARCH`

Fetch User Search on Douyin through TikHub's Douyin-Creator surface. This action is limited to fetch user search and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_name` | string | Yes | 用户名/Username (支持抖音号和抖音昵称) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin CreatorFetchVideoDanmakuList

**Slug:** `TIK_HUB_DOUYIN_CREATOR_FETCH_VIDEO_DANMAKU_LIST`

Fetch Video Danmaku List on Douyin through TikHub's Douyin-Creator surface. This action is limited to fetch video danmaku list and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | 每页数量/Items per page |
| `offset` | integer | No | 偏移量/Offset (starting position) |
| `item_id` | string | Yes | 作品ID/Video item ID |
| `is_blocked` | boolean | No | 是否被屏蔽/Is blocked |
| `order_type` | integer | No | 排序类型/Order type (1=时间排序, 2=其他排序) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Douyin Creator Hot Billboard

**Slug:** `TIK_HUB_DOUYIN_CREATOR_LIST_HOT_BILLBOARD`

List one Douyin Creator hot billboard for music, props, or topics with type-specific ordering. Spot and material-center billboards are separate because their response contracts differ.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_key` | integer | No | Sort key for the selected billboard. Music: 1, 2, 4, 5; props: 1, 5, 6, 7; topic: 1, 2, 3, 4. |
| `time_filter` | integer ("1" | "2" | "3") | No | Time window: 1 for 24 hours, 2 for 7 days, or 3 for 30 days. |
| `billboard_tag` | integer | No | Billboard category tag. Omit to use the provider's all-categories value 0. |
| `billboard_type` | string ("music" | "props" | "topic") | Yes | The creator billboard resource to list: music, props, or topic. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Index Fetch All Area

**Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_ALL_AREA`

Read the fixed TikHub Douyin route /api/v1/douyin/index/fetch_all_area and return a typed business-data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Index Fetch All Valid Date

**Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_ALL_VALID_DATE`

Fetch All Valid Date on Douyin through TikHub's Douyin-Index surface. This action is limited to fetch all valid date and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Index Fetch Brand Hot Videos Time Scope

**Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_BRAND_HOT_VIDEOS_TIME_SCOPE`

Fetch Brand Hot Videos Time Scope on Douyin through TikHub's Douyin-Index surface. This action is limited to fetch brand hot videos time scope and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Index Fetch Brand Valid Info

**Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_BRAND_VALID_INFO`

Fetch Brand Valid Info on Douyin through TikHub's Douyin-Index surface. This action is limited to fetch brand valid info and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `keyword_list` | string | Yes | 品牌名称列表逗号分隔/Brand list comma separated |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Index Fetch Content Consume Trend

**Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_CONTENT_CONSUME_TREND`

Fetch Content Consume Trend on Douyin through TikHub's Douyin-Index surface. This action is limited to fetch content consume trend and returns its validated typed projection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | string | Yes | 垂类ID，**必填，不支持 0=全部**（同 fetch_item_query 的 category_id 但不接受 0）/Category ID, **required, does NOT support 0=all**. Get full list via fetch_item_filter_options (excluding id=0) |
| `end_date` | string | Yes | 结束日期/End date YYYYMMDD |
| `start_date` | string | Yes | 开始日期/Start date YYYYMMDD |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Index Fetch Content Interact Trend

**Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_CONTENT_INTERACT_TREND`

Fetch Content Interact Trend on Douyin through TikHub's Douyin-Index surface. This action is limited to fetch content interact trend and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | string | Yes | 垂类ID，**必填，不支持 0=全部**（同 fetch_item_query 的 category_id 但不接受 0）/Category ID, **required, does NOT support 0=all**. Get full list via fetch_item_filter_options (excluding id=0) |
| `end_date` | string | Yes | 结束日期/End date YYYYMMDD |
| `start_date` | string | Yes | 开始日期/Start date YYYYMMDD |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Index Fetch Content Publish Trend

**Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_CONTENT_PUBLISH_TREND`

Fetch Content Publish Trend on Douyin through TikHub's Douyin-Index surface. This action is limited to fetch content publish trend and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | string | Yes | 垂类ID，**必填，不支持 0=全部**（同 fetch_item_query 的 category_id 但不接受 0）/Category ID, **required, does NOT support 0=all**. Get full list via fetch_item_filter_options (excluding id=0) |
| `end_date` | string | Yes | 结束日期/End date YYYYMMDD |
| `start_date` | string | Yes | 开始日期/Start date YYYYMMDD |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Index Fetch Content Valid Date

**Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_CONTENT_VALID_DATE`

Fetch Content Valid Date on Douyin through TikHub's Douyin-Index surface. This action is limited to fetch content valid date and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Index Fetch Current Hot Topic

**Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_CURRENT_HOT_TOPIC`

Fetch Current Hot Topic on Douyin through TikHub's Douyin-Index surface. This action is limited to fetch current hot topic and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Index Fetch Daren Sug Great User List

**Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_DAREN_SUG_GREAT_USER_LIST`

Fetch Daren Sug Great User List on Douyin through TikHub's Douyin-Index surface. This action is limited to fetch daren sug great user list and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `total` | string | No | 返回数量/Return count |
| `keyword` | string | Yes | 搜索关键词/Search keyword |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Index Fetch Get User Sub Word

**Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_GET_USER_SUB_WORD`

Fetch Get User Sub Word on Douyin through TikHub's Douyin-Index surface. This action is limited to fetch get user sub word and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Index Fetch Hot Trend Word

**Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_HOT_TREND_WORD`

Fetch Hot Trend Word on Douyin through TikHub's Douyin-Index surface. This action is limited to fetch hot trend word and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | integer | No | 推荐词类型/Word type: 0(搜索热词/Search words), 1(内容热词/Content words) |
| `app_name` | string ("aweme" | "toutiao") | No | 平台/Platform: aweme(抖音), toutiao(头条) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Index Fetch Hot Words

**Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_HOT_WORDS`

Fetch Hot Words on Douyin through TikHub's Douyin-Index surface. This action is limited to fetch hot words and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_name` | string ("aweme" | "toutiao") | No | 平台/Platform: aweme(抖音), toutiao(头条) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Index Fetch Insight Get Rec

**Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_INSIGHT_GET_REC`

Fetch Insight Get Rec on Douyin through TikHub's Douyin-Index surface. This action is limited to fetch insight get rec and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `report_id` | string | Yes | 报告ID/Report ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Index Fetch Insight Recommend

**Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_INSIGHT_RECOMMEND`

Read the fixed TikHub Douyin route /api/v1/douyin/index/fetch_insight_recommend and return a typed business-data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Index Fetch Item Filter Options

**Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_ITEM_FILTER_OPTIONS`

Fetch Item Filter Options on Douyin through TikHub's Douyin-Index surface. This action is limited to fetch item filter options and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get keyword valid date

**Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_KEYWORD_VALID_DATE`

Return the valid day, weekday, and status for each requested Douyin keyword.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `keyword_list` | string | Yes | 关键词列表，逗号分隔/Keyword list, comma separated |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Index Fetch Multi Keyword Interpretation

**Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_MULTI_KEYWORD_INTERPRETATION`

Fetch Multi Keyword Interpretation on Douyin through TikHub's Douyin-Index surface. This action is limited to fetch multi keyword interpretation and returns its validated typed projection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `region` | string | No | 地区列表，逗号分隔/Region list, comma separated |
| `app_name` | string ("aweme" | "toutiao") | No | 平台/Platform: aweme(抖音), toutiao(头条) |
| `end_date` | string | Yes | 结束日期/End date, YYYYMMDD |
| `start_date` | string | Yes | 开始日期/Start date, YYYYMMDD |
| `keyword_list` | string | Yes | 关键词列表，逗号分隔/Keyword list, comma separated |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Index Fetch Report Detail

**Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_REPORT_DETAIL`

Fetch Report Detail on Douyin through TikHub's Douyin-Index surface. This action is limited to fetch report detail and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `report_id` | string | Yes | 报告ID/Report ID. Example: 1081 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Index Fetch Report Search

**Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_REPORT_SEARCH`

Fetch Report Search on Douyin through TikHub's Douyin-Index surface. This action is limited to fetch report search and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("" | "行业洞察" | "产品洞察" | "用户洞察" | "趋势洞察") | No | 报告类型/Report type: 空=全部, 行业洞察=Industry, 产品洞察=Product, 用户洞察=User, 趋势洞察=Trend |
| `search` | string | No | 报告关键词搜索/Search keyword |
| `business` | string | No | 所属产品列表，逗号分隔/Business list, comma separated. Options: 巨量引擎, 今日头条, 抖音, 西瓜视频, 抖音电商, 仕小禄, 其他 |
| `category` | string | No | 顶层分类ID（默认 6 表示抖音指数趋势报告）/Top category ID (default 6 = Douyin Index trend reports) |
| `page_size` | string | No | 每页数量/Page size |
| `report_time` | string | No | 发布年份列表，逗号分隔/Year list, comma separated. e.g. 2024,2023 |
| `current_page` | string | No | 页码/Page number |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Index Fetch Valid Date For Relation

**Slug:** `TIK_HUB_DOUYIN_INDEX_FETCH_VALID_DATE_FOR_RELATION`

Fetch Valid Date For Relation on Douyin through TikHub's Douyin-Index surface. This action is limited to fetch valid date for relation and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Search Fetch Challenge Search V1

**Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_CHALLENGE_SEARCH_V1`

Search Douyin challenges through the /fetch_challenge_search_v1 route. Prefer V1 by default because no documented or live functional difference from V2 is substantiated.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | integer | No | Offset cursor for pagination, obtained from the last response. |
| `keyword` | string | No | Keyword. |
| `backtrace` | string | No | Backtrace for pagination, obtained from the last response. |
| `search_id` | string | No | Search ID for pagination, obtained from the last response. |
| `sort_type` | string ("0" | "1" | "2") | No | Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest. |
| `content_type` | string ("0" | "1" | "2" | "3") | No | Content type: 0=All, 1=Video, 2=Picture, 3=Article. |
| `publish_time` | string ("0" | "1" | "7" | "180") | No | Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year. |
| `filter_duration` | string ("0" | "0-1" | "1-5" | "5-10000") | No | Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Search Fetch Challenge Search V2

**Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_CHALLENGE_SEARCH_V2`

Search Douyin challenges through the /fetch_challenge_search_v2 route. Use only when the caller explicitly requires V2; otherwise prefer V1 because no documented or live functional difference is substantiated.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | integer | No | Offset cursor for pagination, obtained from the last response. |
| `keyword` | string | No | Keyword. |
| `backtrace` | string | No | Backtrace for pagination, obtained from the last response. |
| `search_id` | string | No | Search ID for pagination, obtained from the last response. |
| `sort_type` | string ("0" | "1" | "2") | No | Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest. |
| `content_type` | string ("0" | "1" | "2" | "3") | No | Content type: 0=All, 1=Video, 2=Picture, 3=Article. |
| `publish_time` | string ("0" | "1" | "7" | "180") | No | Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year. |
| `filter_duration` | string ("0" | "0-1" | "1-5" | "5-10000") | No | Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Search Fetch Challenge Suggest

**Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_CHALLENGE_SUGGEST`

Fetch Challenge Suggest on Douyin through TikHub's Douyin-Search surface. This action is limited to fetch challenge suggest and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `keyword` | string | No | 关键词，如 '游戏' / Keyword, e.g., 'game' |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Search Fetch Discuss Search

**Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_DISCUSS_SEARCH`

Read the fixed TikHub Douyin route /api/v1/douyin/search/fetch_discuss_search and return a typed business-data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | integer | No | Offset cursor for pagination, obtained from the last response. |
| `keyword` | string | No | Keyword. |
| `backtrace` | string | No | Backtrace for pagination, obtained from the last response. |
| `search_id` | string | No | Search ID for pagination, obtained from the last response. |
| `sort_type` | string ("0" | "1" | "2") | No | Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest. |
| `content_type` | string ("0" | "1" | "2" | "3") | No | Content type: 0=All, 1=Video, 2=Picture, 3=Article. |
| `publish_time` | string ("0" | "1" | "7" | "180") | No | Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year. |
| `filter_duration` | string ("0" | "0-1" | "1-5" | "5-10000") | No | Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Search Fetch Experience Search

**Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_EXPERIENCE_SEARCH`

Read the fixed TikHub Douyin route /api/v1/douyin/search/fetch_experience_search and return a typed business-data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | integer | No | Offset cursor for pagination, obtained from the last response. |
| `keyword` | string | No | Keyword. |
| `backtrace` | string | No | Backtrace for pagination, obtained from the last response. |
| `search_id` | string | No | Search ID for pagination, obtained from the last response. |
| `sort_type` | string ("0" | "1" | "2") | No | Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest. |
| `content_type` | string ("0" | "1" | "2" | "3") | No | Content type: 0=All, 1=Video, 2=Picture, 3=Article. |
| `publish_time` | string ("0" | "1" | "7" | "180") | No | Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year. |
| `filter_duration` | string ("0" | "0-1" | "1-5" | "5-10000") | No | Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Search Fetch General Search V1

**Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_GENERAL_SEARCH_V1`

Search Douyin content through the /fetch_general_search_v1 route. Prefer V1 by default because no documented or live functional difference from V2 is substantiated.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | integer | No | Offset cursor for pagination, obtained from the last response. |
| `keyword` | string | No | Keyword. |
| `backtrace` | string | No | Backtrace for pagination, obtained from the last response. |
| `search_id` | string | No | Search ID for pagination, obtained from the last response. |
| `sort_type` | string ("0" | "1" | "2") | No | Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest. |
| `content_type` | string ("0" | "1" | "2" | "3") | No | Content type: 0=All, 1=Video, 2=Picture, 3=Article. |
| `publish_time` | string ("0" | "1" | "7" | "180") | No | Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year. |
| `filter_duration` | string ("0" | "0-1" | "1-5" | "5-10000") | No | Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Search Fetch General Search V2

**Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_GENERAL_SEARCH_V2`

Search Douyin content through the /fetch_general_search_v2 route. Use only when the caller explicitly requires V2; otherwise prefer V1 because no documented or live functional difference is substantiated.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | integer | No | Offset cursor for pagination, obtained from the last response. |
| `keyword` | string | No | Keyword. |
| `backtrace` | string | No | Backtrace for pagination, obtained from the last response. |
| `search_id` | string | No | Search ID for pagination, obtained from the last response. |
| `sort_type` | string ("0" | "1" | "2") | No | Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest. |
| `content_type` | string ("0" | "1" | "2" | "3") | No | Content type: 0=All, 1=Video, 2=Picture, 3=Article. |
| `publish_time` | string ("0" | "1" | "7" | "180") | No | Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year. |
| `filter_duration` | string ("0" | "0-1" | "1-5" | "5-10000") | No | Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Search Fetch Image Search

**Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_IMAGE_SEARCH`

Search Douyin images with sort, time, duration, content-type, cursor, and search-context controls. Use V3 for the smaller keyword, cursor, and search-ID input surface.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | integer | No | Offset cursor for pagination, obtained from the last response. |
| `keyword` | string | No | Keyword. |
| `backtrace` | string | No | Backtrace for pagination, obtained from the last response. |
| `search_id` | string | No | Search ID for pagination, obtained from the last response. |
| `sort_type` | string ("0" | "1" | "2") | No | Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest. |
| `content_type` | string ("0" | "1" | "2" | "3") | No | Content type: 0=All, 1=Video, 2=Picture, 3=Article. |
| `publish_time` | string ("0" | "1" | "7" | "180") | No | Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year. |
| `filter_duration` | string ("0" | "0-1" | "1-5" | "5-10000") | No | Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Search Fetch Image Search V3

**Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_IMAGE_SEARCH_V3`

Search Douyin images through the exact V3 route using only keyword, cursor, and search ID. Use the original route when sort, time, duration, or content-type filters are required.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | integer | No | Pagination cursor. |
| `keyword` | string | Yes | Search keyword. |
| `search_id` | string | No | Search ID for pagination. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch live search V2

**Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_LIVE_SEARCH_V2`

Call the exact TikHub POST /api/v1/douyin/search/fetch_live_search_v2 route and return only its validated response projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | integer | No | 翻页游标，首次请求传 0，之后传上一页响应里的 cursor / Pagination cursor, 0 for the first request, then the cursor from the last response |
| `keyword` | string | No | 抖音号 或 抖音昵称 / Douyin ID or nickname |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Search Fetch Multi Search

**Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_MULTI_SEARCH`

Read the fixed TikHub Douyin route /api/v1/douyin/search/fetch_multi_search and return a typed business-data projection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | integer | No | Offset cursor for pagination, obtained from the last response. |
| `keyword` | string | No | Keyword. |
| `backtrace` | string | No | Backtrace for pagination, obtained from the last response. |
| `search_id` | string | No | Search ID for pagination, obtained from the last response. |
| `sort_type` | string ("0" | "1" | "2") | No | Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest. |
| `content_type` | string ("0" | "1" | "2" | "3") | No | Content type: 0=All, 1=Video, 2=Picture, 3=Article. |
| `publish_time` | string ("0" | "1" | "7" | "180") | No | Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year. |
| `filter_duration` | string ("0" | "0-1" | "1-5" | "5-10000") | No | Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Search Fetch Music Search

**Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_MUSIC_SEARCH`

Read the fixed TikHub Douyin route /api/v1/douyin/search/fetch_music_search and return a typed business-data projection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | integer | No | Offset cursor for pagination, obtained from the last response. |
| `keyword` | string | No | Keyword. |
| `backtrace` | string | No | Backtrace for pagination, obtained from the last response. |
| `search_id` | string | No | Search ID for pagination, obtained from the last response. |
| `sort_type` | string ("0" | "1" | "2") | No | Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest. |
| `content_type` | string ("0" | "1" | "2" | "3") | No | Content type: 0=All, 1=Video, 2=Picture, 3=Article. |
| `publish_time` | string ("0" | "1" | "7" | "180") | No | Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year. |
| `filter_duration` | string ("0" | "0-1" | "1-5" | "5-10000") | No | Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Search Fetch School Search

**Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_SCHOOL_SEARCH`

Fetch School Search on Douyin through TikHub's Douyin-Search surface. This action is limited to fetch school search and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `keyword` | string | No | 关键词，如学校名称或所在地区 / Keyword, such as school name or location |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Search Fetch Search Suggest

**Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_SEARCH_SUGGEST`

Fetch Search Suggest on Douyin through TikHub's Douyin-Search surface. This action is limited to fetch search suggest and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `keyword` | string | No | 需要联想的关键词/The keyword to be suggested |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Search Fetch User Search

**Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_USER_SEARCH`

Search Douyin users with follower/type filters and search-ID pagination context. Use V2 for the simpler keyword-and-cursor contract.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | integer | No | Offset cursor for pagination, obtained from the last response. |
| `keyword` | string | No | Keyword. |
| `search_id` | string | No | Search ID for pagination, obtained from the last response. |
| `douyin_user_fans` | string | No | Fans filter: empty=No limit, 0_1k=Under 1k, etc. |
| `douyin_user_type` | string | No | User type filter: empty=No limit, 300=Creator, 900=Shop, 700=Musician, 800=Celebrity. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch user search V2

**Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_USER_SEARCH_V2`

Search Douyin users through the exact V2 route using keyword and cursor only. Use the original route when follower/type filters or search-ID context are required.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | integer | No | 偏移游标，用于翻页，从上一次请求返回的响应中获取 / Offset cursor for pagination, obtained from the last response |
| `keyword` | string | No | 关键词 / Keyword |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Search Fetch Video Search V1

**Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_VIDEO_SEARCH_V1`

Search Douyin videos with filter controls through the /fetch_video_search_v1 route. Prefer V1 over V2 by default because no documented or live difference is substantiated; use V4 only for its smaller keyword-and-cursor contract.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | integer | No | Offset cursor for pagination, obtained from the last response. |
| `keyword` | string | No | Keyword. |
| `backtrace` | string | No | Backtrace for pagination, obtained from the last response. |
| `search_id` | string | No | Search ID for pagination, obtained from the last response. |
| `sort_type` | string ("0" | "1" | "2") | No | Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest. |
| `content_type` | string ("0" | "1" | "2" | "3") | No | Content type: 0=All, 1=Video, 2=Picture, 3=Article. |
| `publish_time` | string ("0" | "1" | "7" | "180") | No | Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year. |
| `filter_duration` | string ("0" | "0-1" | "1-5" | "5-10000") | No | Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Search Fetch Video Search V2

**Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_VIDEO_SEARCH_V2`

Search Douyin videos with filter controls through the /fetch_video_search_v2 route. Use only when the caller explicitly requires V2; otherwise prefer V1 because no documented or live difference is substantiated. Use V4 only for its smaller keyword-and-cursor contract.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | integer | No | Offset cursor for pagination, obtained from the last response. |
| `keyword` | string | No | Keyword. |
| `backtrace` | string | No | Backtrace for pagination, obtained from the last response. |
| `search_id` | string | No | Search ID for pagination, obtained from the last response. |
| `sort_type` | string ("0" | "1" | "2") | No | Sort type: 0=Comprehensive, 1=Most Likes, 2=Latest. |
| `content_type` | string ("0" | "1" | "2" | "3") | No | Content type: 0=All, 1=Video, 2=Picture, 3=Article. |
| `publish_time` | string ("0" | "1" | "7" | "180") | No | Publish time filter: 0=Unlimited, 1=Last day, 7=Last week, 180=Last half year. |
| `filter_duration` | string ("0" | "0-1" | "1-5" | "5-10000") | No | Video duration filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes, 5-10000=More than 5 minutes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch video search V4

**Slug:** `TIK_HUB_DOUYIN_SEARCH_FETCH_VIDEO_SEARCH_V4`

Search Douyin videos through the exact V4 route using keyword and cursor only. Use V1 or V2 when sort, publish-time, duration, content-type, or search-context controls are required.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | integer | No | 翻页游标，首次请求传 0，之后传上一页响应里的 cursor / Pagination cursor, 0 for the first request, then the cursor from the last response |
| `keyword` | string | No | 视频标题/关键词 / Video title or keyword |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Web Encrypt Uid To Sec User Id

**Slug:** `TIK_HUB_DOUYIN_WEB_ENCRYPT_UID_TO_SEC_USER_ID`

Encrypt Uid To Sec User Id on Douyin through TikHub's Douyin-Web surface. This action is limited to encrypt uid to sec user id and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | User uid(short_id). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get batch user profile (up to 50)

**Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_BATCH_USER_PROFILE_V2`

Call the exact TikHub GET /api/v1/douyin/web/fetch_batch_user_profile_v2 route and return only its validated response projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.15 per batch of up to 50 Douyin user profile

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sec_user_ids` | string | Yes | 用户sec_user_id列表，用逗号分隔/User sec_user_id list, separated by commas |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Web Fetch Hot Search Result

**Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_HOT_SEARCH_RESULT`

Read the fixed TikHub Douyin route /api/v1/douyin/web/fetch_hot_search_result and return a typed business-data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get live room gift user ranking

**Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_LIVE_GIFT_RANKING`

Call the exact TikHub GET /api/v1/douyin/web/fetch_live_gift_ranking route and return only its validated response projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `room_id` | string | Yes | 直播间room_id/Room room_id |
| `rank_type` | integer | No | 排行类型/Leaderboard type |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Web Fetch Live Im Fetch

**Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_LIVE_IM_FETCH`

Fetch Live Im Fetch on Douyin through TikHub's Douyin-Web surface. This action is limited to fetch live im fetch and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `room_id` | string | Yes | Live room id. |
| `user_unique_id` | string | Yes | User unique ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Web Fetch Multi Video High Quality Play Url

**Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_MULTI_VIDEO_HIGH_QUALITY_PLAY_URL`

Fetch Multi Video High Quality Play Url on Douyin through TikHub's Douyin-Web surface. This action is limited to fetch multi video high quality play url and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.5 per batch of up to 50 high-quality Douyin video URLs

**Discount:** 50

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `region` | string | No | Optional, ISO country code (e.g. CN). Pass 'CN' for users in mainland China to get China-region CDN URLs for faster download. |
| `aweme_ids` | string | Yes | Video id list, separated by commas, up to 50. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Web Fetch One Video

**Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_ONE_VIDEO`

Fetch one Douyin Web video by aweme ID, optionally requesting anchor information. Use V2 when anchor control is not needed and the exact V2 route is required.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `aweme_id` | string | Yes | Video id. |
| `need_anchor_info` | boolean | No | Whether anchor information is needed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Web Fetch One Video By Share Url

**Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_ONE_VIDEO_BY_SHARE_URL`

Fetch One Video By Share Url on Douyin through TikHub's Douyin-Web surface. This action is limited to fetch one video by share url and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `share_url` | string | Yes | Share link. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get single video danmaku data

**Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_ONE_VIDEO_DANMAKU`

Call the exact TikHub GET /api/v1/douyin/web/fetch_one_video_danmaku route and return only its validated response projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | string | Yes | 作品id/Video id |
| `duration` | integer | Yes | 视频总时长/Video total duration |
| `end_time` | integer | Yes | 结束时间/End time |
| `start_time` | integer | Yes | 开始时间/Start time |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Web Fetch One Video V2

**Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_ONE_VIDEO_V2`

Fetch one Douyin Web video by aweme ID through the exact V2 route. Use the original route when the need_anchor_info control is required.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `aweme_id` | string | Yes | Video id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Query Douyin user basic information

**Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_QUERY_USER`

Call the exact TikHub POST /api/v1/douyin/web/fetch_query_user route and return only its validated response projection.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Web Fetch Related Posts

**Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_RELATED_POSTS`

Read the fixed TikHub Douyin route /api/v1/douyin/web/fetch_related_posts and return a typed business-data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Number. |
| `aweme_id` | string | Yes | Video id. |
| `refresh_index` | integer | No | Paging index. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Web Fetch User Fans List

**Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_USER_FANS_LIST`

Read the fixed TikHub Douyin route /api/v1/douyin/web/fetch_user_fans_list and return a typed business-data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Number. |
| `max_time` | string | No | Maximum timestamp. |
| `sec_user_id` | string | Yes | Douyin sec_user_id for the user whose followers to fetch. |
| `source_type` | integer | No | Source type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Web Fetch User Following List

**Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_USER_FOLLOWING_LIST`

Read the fixed TikHub Douyin route /api/v1/douyin/web/fetch_user_following_list and return a typed business-data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Number. |
| `max_time` | string | No | Maximum timestamp. |
| `sec_user_id` | string | Yes | Douyin sec_user_id for the user whose following list to fetch. |
| `source_type` | integer | No | Source type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get user live information by UID

**Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_USER_LIVE_INFO_BY_UID`

Call the exact TikHub GET /api/v1/douyin/web/fetch_user_live_info_by_uid route and return only its validated response projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | 用户UID/User UID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Web Fetch User Live Videos

**Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_USER_LIVE_VIDEOS`

Fetch User Live Videos on Douyin through TikHub's Douyin-Web surface. This action is limited to fetch user live videos and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webcast_id` | string | Yes | Room webcast_id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Gets the live stream data of the specified user by room_id V2

**Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_USER_LIVE_VIDEOS_BY_ROOM_ID_V2`

Call the exact TikHub GET /api/v1/douyin/web/fetch_user_live_videos_by_room_id_v2 route and return only its validated response projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `room_id` | string | Yes | 直播间room_id/Room room_id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Web Fetch User Live Videos By Sec Uid

**Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_USER_LIVE_VIDEOS_BY_SEC_UID`

Fetch User Live Videos By Sec Uid on Douyin through TikHub's Douyin-Web surface. This action is limited to fetch user live videos by sec uid and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sec_uid` | string | Yes | User sec_uid. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Web Fetch User Profile By Short Id

**Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_USER_PROFILE_BY_SHORT_ID`

Fetch User Profile By Short Id on Douyin through TikHub's Douyin-Web surface. This action is limited to fetch user profile by short id and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `short_id` | string | Yes | User Short ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Web Fetch User Profile By Uid

**Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_USER_PROFILE_BY_UID`

Fetch User Profile By Uid on Douyin through TikHub's Douyin-Web surface. This action is limited to fetch user profile by uid and returns its validated typed projection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | User UID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Web Fetch Video Channel Result

**Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_VIDEO_CHANNEL_RESULT`

Read the fixed TikHub Douyin route /api/v1/douyin/web/fetch_video_channel_result and return a typed business-data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Number. |
| `tag_id` | integer | Yes | Tag id. |
| `refresh_index` | integer | No | Refresh index. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get comment replies data of specified video

**Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_VIDEO_COMMENT_REPLIES`

Call the exact TikHub GET /api/v1/douyin/web/fetch_video_comment_replies route and return only its validated response projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | 数量/Number |
| `cursor` | integer | No | 游标/Cursor |
| `item_id` | string | Yes | 作品id/Video id |
| `comment_id` | string | Yes | 评论id/Comment id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Web Fetch Video Comments

**Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_VIDEO_COMMENTS`

Fetch Video Comments on Douyin through TikHub's Douyin-Web surface. This action is limited to fetch video comments and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Number. |
| `cursor` | integer | No | Use 0 for the first page. Reuse data.cursor while data.has_more is nonzero; stop when data.has_more is 0. |
| `aweme_id` | string | Yes | Video id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Web Fetch Video High Quality Play Url

**Slug:** `TIK_HUB_DOUYIN_WEB_FETCH_VIDEO_HIGH_QUALITY_PLAY_URL`

Fetch Video High Quality Play Url on Douyin through TikHub's Douyin-Web surface. This action is limited to fetch video high quality play url and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.005 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `region` | string | No | HK). Pass CN to get China-region CDN URLs for faster download in mainland China. |
| `aweme_id` | string | No | Video id. |
| `share_url` | string | No | Optional, share link. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Douyin Web Short URL

**Slug:** `TIK_HUB_DOUYIN_WEB_GENERATE_SHORT_URL`

Generate a shortened Douyin URL for a target URL. This returns the shortened URL and does not fetch the target resource.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `target_url` | string | Yes | Target URL to be converted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Web Generate Ttwid

**Slug:** `TIK_HUB_DOUYIN_WEB_GENERATE_TTWID`

Generate Ttwid on Douyin through TikHub's Douyin-Web surface. This action is limited to generate ttwid and returns its validated typed projection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_agent` | string | No | TikHub request field 'user_agent' |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Web Get Aweme Id

**Slug:** `TIK_HUB_DOUYIN_WEB_GET_AWEME_ID`

Extract the aweme (video) ID from a Douyin video share URL.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | A Douyin video share URL from which to extract the aweme (video) ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Web Get Sec User Id

**Slug:** `TIK_HUB_DOUYIN_WEB_GET_SEC_USER_ID`

Extract a sec_user_id from a Douyin user profile share URL.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | A Douyin user profile share URL from which to extract the sec_user_id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Douyin Web User Profile

**Slug:** `TIK_HUB_DOUYIN_WEB_GET_USER_PROFILE`

Fetch a Douyin Web profile using exactly one identifier kind: sec_user_id, unique_id, or numeric uid. The selected branch preserves that endpoint's typed response contract.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `identifier` | string | Yes | The sec_user_id, unique_id, or numeric uid selected by identifier_type. |
| `identifier_type` | string ("sec_user_id" | "unique_id" | "uid") | Yes | The kind of Douyin user identifier supplied in identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Web Get Webcast Id

**Slug:** `TIK_HUB_DOUYIN_WEB_GET_WEBCAST_ID`

Extract the webcast ID from a Douyin live-room share URL.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | A Douyin live-room share URL from which to extract the webcast ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Web Webcast Id 2 Room Id

**Slug:** `TIK_HUB_DOUYIN_WEB_WEBCAST_ID_2_ROOM_ID`

Webcast Id 2 Room Id on Douyin through TikHub's Douyin-Web surface. This action is limited to webcast id 2 room id and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webcast_id` | string | Yes | Webcast id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin Xingtu Get Sign Image

**Slug:** `TIK_HUB_DOUYIN_XINGTU_GET_SIGN_IMAGE`

Get Sign Image on Douyin through TikHub's Douyin-Xingtu surface. This action is limited to get sign image and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uri` | string | Yes | 图片的uri/Image URI |
| `format` | string | No | 图片格式/Image format |
| `duration_ts` | integer | No | 有效期时长（秒）/Duration in seconds |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get XingTu KOL ID by Douyin Sec User ID

**Slug:** `TIK_HUB_DOUYIN_XINGTU_GET_XINGTU_KOLID_BY_SEC_USER_ID`

Get the XingTu KOL ID for a Douyin secure user ID through TikHub's pinned Douyin-Xingtu-API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sec_user_id` | string | Yes | 抖音用户sec_user_id/Douyin User sec_user_id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get XingTu KOL ID by Douyin User ID

**Slug:** `TIK_HUB_DOUYIN_XINGTU_GET_XINGTU_KOLID_BY_UID`

Get the XingTu KOL ID for a Douyin user ID through TikHub's pinned Douyin-Xingtu-API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | 抖音用户ID/Douyin User ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get XingTu KOL ID by Douyin Unique ID

**Slug:** `TIK_HUB_DOUYIN_XINGTU_GET_XINGTU_KOLID_BY_UNIQUE_ID`

Get the XingTu KOL ID for a Douyin unique ID through TikHub's pinned Douyin-Xingtu-API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `unique_id` | string | Yes | 抖音号/Douyin User unique_id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Douyin XingtuV2GetContentTrendGuide

**Slug:** `TIK_HUB_DOUYIN_XINGTU_V2_GET_CONTENT_TREND_GUIDE`

Get Content Trend Guide on Douyin through TikHub's Douyin-Xingtu-V2 surface. This action is limited to get content trend guide and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Estimate Endpoint Cost

**Slug:** `TIK_HUB_ESTIMATE_ENDPOINT_COST`

Estimate daily TikHub cost for an approved TikHub user-route path and request volume. This pricing metadata lookup never executes the referenced path.

**Instant:** Supported on the latest version.

**Instant pricing:** $0 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `endpoint_path` | string ("/api/v1/tikhub/user/get_user_info" | "/api/v1/tikhub/user/get_user_daily_usage" | "/api/v1/tikhub/user/calculate_price" | "/api/v1/tikhub/user/get_tiered_discount_info" | "/api/v1/tikhub/user/get_endpoint_info") | Yes | Reviewed TikHub-owned metadata route to price as inert catalog metadata; choose one of the schema's allowed paths. The route is never executed. |
| `requests_per_day` | integer | No | Non-negative number of daily requests to include in the estimate. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Status

**Slug:** `TIK_HUB_GET_ACCOUNT_STATUS`

Return privacy-minimized status for the connected TikHub account and API key, without identity, balance, scope, or raw key metadata.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List TikHub endpoint information

**Slug:** `TIK_HUB_GET_ALL_ENDPOINTS_INFO`

Read TikHub's endpoint catalog and return one bounded page with pricing, rate-limit, category, and ownership information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of endpoint entries to return from this catalog read. |
| `offset` | integer | No | Index of the first catalog entry to return. Each page reads the provider catalog again. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Daily Usage

**Slug:** `TIK_HUB_GET_DAILY_USAGE`

Return the connected account owner's current TikHub daily request and billing counters, excluding email and provider diagnostics.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Endpoint Metadata

**Slug:** `TIK_HUB_GET_ENDPOINT_METADATA`

Look up service metadata for one approved TikHub user-route path without executing it. Catalog presence does not authorize route execution.

**Instant:** Supported on the latest version.

**Instant pricing:** $0 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `endpoint_path` | string ("/api/v1/tikhub/user/get_user_info" | "/api/v1/tikhub/user/get_user_daily_usage" | "/api/v1/tikhub/user/calculate_price" | "/api/v1/tikhub/user/get_tiered_discount_info" | "/api/v1/tikhub/user/get_endpoint_info") | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Parse a Douyin or TikTok video

**Slug:** `TIK_HUB_HYBRID_VIDEO_DATA`

Parse one Douyin or TikTok video through TikHub's exact hybrid parsing route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Douyin or TikTok video URL, share URL, or share text. |
| `minimal` | boolean | No | Whether to request the provider's minimal response. |
| `base64_url` | boolean | No | Whether the URL input is base64 encoded. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Instagram V1 Fetch Cities

**Slug:** `TIK_HUB_INSTAGRAM_V1_FETCH_CITIES`

Fetch Cities on Instagram through TikHub's Instagram-V1 surface. This action is limited to fetch cities and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number. |
| `country_code` | string | Yes | Country code (e.g. US, CN, JP). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Instagram Fetch Fast Post By URL

**Slug:** `TIK_HUB_INSTAGRAM_V1_FETCH_FAST_POST_BY_URL`

Fetch reduced Instagram post details from a post URL using TikHub V2. This variant is faster but less complete than V1 and is suited to high-volume retrieval.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `post_url` | string | Yes | Post URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Instagram Fetch Full Post By URL

**Slug:** `TIK_HUB_INSTAGRAM_V1_FETCH_FULL_POST_BY_URL`

Fetch complete Instagram post details from a post URL. Prefer this richer V1 result when completeness matters more than latency.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `post_url` | string | Yes | Post URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Location Info

**Slug:** `TIK_HUB_INSTAGRAM_V1_FETCH_LOCATION_INFO`

Call TikHub's exact Instagram-V1-API route /api/v1/instagram/v1/fetch_location_info and return its validated response.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `location_id` | string | Yes | 地点ID/Location ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Instagram V1 Fetch Locations

**Slug:** `TIK_HUB_INSTAGRAM_V1_FETCH_LOCATIONS`

Fetch Locations on Instagram through TikHub's Instagram-V1 surface. This action is limited to fetch locations and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number. |
| `city_id` | string | Yes | City ID (from fetch_cities). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Instagram V1 Fetch Music Posts

**Slug:** `TIK_HUB_INSTAGRAM_V1_FETCH_MUSIC_POSTS`

Fetch Music Posts on Instagram through TikHub's Instagram-V1 surface. This action is limited to fetch music posts and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `max_id` | string | No | Pagination cursor for next page. |
| `music_id` | string | No | Music ID. |
| `music_url` | string | No | Music URL (alternative to music_id). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Instagram V1 Fetch Post By Id

**Slug:** `TIK_HUB_INSTAGRAM_V1_FETCH_POST_BY_ID`

Fetch Post By Id on Instagram through TikHub's Instagram-V1 surface. This action is limited to fetch post by id and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `post_id` | string | Yes | Post ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Instagram V1 Fetch Related Profiles

**Slug:** `TIK_HUB_INSTAGRAM_V1_FETCH_RELATED_PROFILES`

Fetch Related Profiles on Instagram through TikHub's Instagram-V1 surface. This action is limited to fetch related profiles and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | Instagram user ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Instagram V1 Fetch Search

**Slug:** `TIK_HUB_INSTAGRAM_V1_FETCH_SEARCH`

Fetch Search on Instagram through TikHub's Instagram-V1 surface. This action is limited to fetch search and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | Search keyword. |
| `select` | string | No | places, omit for all. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Data by User ID V2

**Slug:** `TIK_HUB_INSTAGRAM_V1_FETCH_USER_INFO_BY_ID_V2`

Call TikHub's exact Instagram-V1-API route /api/v1/instagram/v1/fetch_user_info_by_id_v2 and return its validated response.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | Instagram用户ID/Instagram user ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Data by Username V3

**Slug:** `TIK_HUB_INSTAGRAM_V1_FETCH_USER_INFO_BY_USERNAME_V3`

Call TikHub's exact Instagram-V1-API route /api/v1/instagram/v1/fetch_user_info_by_username_v3 and return its validated response.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `username` | string | Yes | Instagram用户名/Instagram username |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Instagram V1 Media Id To Shortcode

**Slug:** `TIK_HUB_INSTAGRAM_V1_MEDIA_ID_TO_SHORTCODE`

Media Id To Shortcode on Instagram through TikHub's Instagram-V1 surface. This action is limited to media id to shortcode and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `media_id` | string | Yes | Post media ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Instagram V1 Shortcode To Media Id

**Slug:** `TIK_HUB_INSTAGRAM_V1_SHORTCODE_TO_MEDIA_ID`

Shortcode To Media Id on Instagram through TikHub's Instagram-V1 surface. This action is limited to shortcode to media id and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shortcode` | string | Yes | Post shortcode. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Instagram V1 User Id To Username

**Slug:** `TIK_HUB_INSTAGRAM_V1_USER_ID_TO_USERNAME`

User Id To Username on Instagram through TikHub's Instagram-V1 surface. This action is limited to user id to username and returns its validated typed projection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | User ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Comment Replies

**Slug:** `TIK_HUB_INSTAGRAM_V2_FETCH_COMMENT_REPLIES`

Call TikHub's exact Instagram-V2-API route /api/v1/instagram/v2/fetch_comment_replies and return its validated response.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `comment_id` | string | Yes | 评论ID/Comment ID |
| `code_or_url` | string | Yes | 帖子Shortcode或URL/Post shortcode or URL |
| `pagination_token` | string | No | 分页token/Pagination token |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Highlight Stories

**Slug:** `TIK_HUB_INSTAGRAM_V2_FETCH_HIGHLIGHT_STORIES`

Call TikHub's exact Instagram-V2-API route /api/v1/instagram/v2/fetch_highlight_stories and return its validated response.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `highlight_id` | string | Yes | 精选ID/Highlight ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Instagram V2 Fetch Music Posts

**Slug:** `TIK_HUB_INSTAGRAM_V2_FETCH_MUSIC_POSTS`

Fetch posts using an audio canonical ID from the exact Instagram V2 endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pagination_token` | string | No | Pagination token returned by the previous page. |
| `audio_canonical_id` | string | Yes | Instagram audio canonical ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Instagram V2 Fetch Post Comments

**Slug:** `TIK_HUB_INSTAGRAM_V2_FETCH_POST_COMMENTS`

Fetch Post Comments on Instagram through TikHub's Instagram-V2 surface. This action is limited to fetch post comments and returns its validated typed projection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort_by` | string | No | 排序方式: recent(最新) 或 popular(热门)/Sort by: recent or popular |
| `code_or_url` | string | Yes | 帖子Shortcode或URL/Post shortcode or URL |
| `pagination_token` | string | No | 分页token/Pagination token |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Instagram V2 Fetch Post Info

**Slug:** `TIK_HUB_INSTAGRAM_V2_FETCH_POST_INFO`

Fetch Post Info on Instagram through TikHub's Instagram-V2 surface. This action is limited to fetch post info and returns its validated typed projection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code_or_url` | string | Yes | 帖子Shortcode或URL/Post shortcode or URL |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Similar Users

**Slug:** `TIK_HUB_INSTAGRAM_V2_FETCH_SIMILAR_USERS`

Call TikHub's exact Instagram-V2-API route /api/v1/instagram/v2/fetch_similar_users and return its validated response.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | No | 用户ID/User ID |
| `username` | string | No | 用户名/Username |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Followers

**Slug:** `TIK_HUB_INSTAGRAM_V2_FETCH_USER_FOLLOWERS`

Call TikHub's exact Instagram-V2-API route /api/v1/instagram/v2/fetch_user_followers and return its validated response.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | No | 用户ID/User ID |
| `username` | string | No | 用户名/Username |
| `pagination_token` | string | No | 分页token/Pagination token |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Following

**Slug:** `TIK_HUB_INSTAGRAM_V2_FETCH_USER_FOLLOWING`

Call TikHub's exact Instagram-V2-API route /api/v1/instagram/v2/fetch_user_following and return its validated response.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | No | 用户ID/User ID |
| `username` | string | No | 用户名/Username |
| `pagination_token` | string | No | 分页token/Pagination token |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Highlights

**Slug:** `TIK_HUB_INSTAGRAM_V2_FETCH_USER_HIGHLIGHTS`

Call TikHub's exact Instagram-V2-API route /api/v1/instagram/v2/fetch_user_highlights and return its validated response.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | No | 用户ID/User ID |
| `username` | string | No | 用户名/Username |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Info

**Slug:** `TIK_HUB_INSTAGRAM_V2_FETCH_USER_INFO`

Call TikHub's exact Instagram-V2-API route /api/v1/instagram/v2/fetch_user_info and return its validated response.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | No | 用户ID/User ID |
| `username` | string | No | 用户名/Username |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Instagram user posts

**Slug:** `TIK_HUB_INSTAGRAM_V2_FETCH_USER_POSTS`

Get one page of posts published by an Instagram user through TikHub, selected by username or user ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | No | Instagram numeric user ID; provide this or username. |
| `username` | string | No | Instagram username; provide this or user_id. |
| `pagination_token` | string | No | Token returned by a previous call for the next page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Instagram user reels

**Slug:** `TIK_HUB_INSTAGRAM_V2_FETCH_USER_REELS`

Get one page of reels published by an Instagram user through TikHub, selected by username or user ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | No | Instagram numeric user ID; provide this or username. |
| `username` | string | No | Instagram username; provide this or user_id. |
| `pagination_token` | string | No | Token returned by a previous call for the next page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Stories

**Slug:** `TIK_HUB_INSTAGRAM_V2_FETCH_USER_STORIES`

Call TikHub's exact Instagram-V2-API route /api/v1/instagram/v2/fetch_user_stories and return its validated response.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | No | 用户ID/User ID |
| `username` | string | No | 用户名/Username |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Instagram V2 Media Id To Shortcode

**Slug:** `TIK_HUB_INSTAGRAM_V2_MEDIA_ID_TO_SHORTCODE`

Media Id To Shortcode on Instagram through TikHub's Instagram-V2 surface. This action is limited to media id to shortcode and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.002 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `media_id` | string | Yes | 帖子Media ID/Post media ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Instagram V2 Search By Coordinates

**Slug:** `TIK_HUB_INSTAGRAM_V2_SEARCH_BY_COORDINATES`

Search By Coordinates on Instagram through TikHub's Instagram-V2 surface. This action is limited to search by coordinates and returns its validated typed projection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `latitude` | number | Yes | 纬度/Latitude |
| `longitude` | number | Yes | 经度/Longitude |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Instagram V2 Search Hashtags

**Slug:** `TIK_HUB_INSTAGRAM_V2_SEARCH_HASHTAGS`

Search Hashtags on Instagram through TikHub's Instagram-V2 surface. This action is limited to search hashtags and returns its validated typed projection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `keyword` | string | Yes | 搜索关键词/Search keyword |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Instagram V2 Search Locations

**Slug:** `TIK_HUB_INSTAGRAM_V2_SEARCH_LOCATIONS`

Search Locations on Instagram through TikHub's Instagram-V2 surface. This action is limited to search locations and returns its validated typed projection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `keyword` | string | Yes | 搜索关键词/Search keyword |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Instagram V2 Search Music

**Slug:** `TIK_HUB_INSTAGRAM_V2_SEARCH_MUSIC`

Search Music on Instagram through TikHub's Instagram-V2 surface. This action is limited to search music and returns its validated typed projection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `keyword` | string | Yes | 搜索关键词/Search keyword |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Instagram V2 Search Users

**Slug:** `TIK_HUB_INSTAGRAM_V2_SEARCH_USERS`

Search Users on Instagram through TikHub's Instagram-V2 surface. This action is limited to search users and returns its validated typed projection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `keyword` | string | Yes | 搜索关键词/Search keyword |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Instagram V2 Shortcode To Media Id

**Slug:** `TIK_HUB_INSTAGRAM_V2_SHORTCODE_TO_MEDIA_ID`

Shortcode To Media Id on Instagram through TikHub's Instagram-V2 surface. This action is limited to shortcode to media id and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.002 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shortcode` | string | Yes | 帖子Shortcode/Post shortcode |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Instagram V2 User Id To Username

**Slug:** `TIK_HUB_INSTAGRAM_V2_USER_ID_TO_USERNAME`

User Id To Username on Instagram through TikHub's Instagram-V2 surface. This action is limited to user id to username and returns its validated typed projection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | 用户ID/User ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Kuaishou App Fetch Hot Board Categories

**Slug:** `TIK_HUB_KUAISHOU_APP_FETCH_HOT_BOARD_CATEGORIES`

Fetch Hot Board Categories on Kuaishou through TikHub's Kuaishou-App surface. This action is limited to fetch hot board categories and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Kuaishou App Fetch Hot Board Detail

**Slug:** `TIK_HUB_KUAISHOU_APP_FETCH_HOT_BOARD_DETAIL`

Fetch Hot Board Detail on Kuaishou through TikHub's Kuaishou-App surface. This action is limited to fetch hot board detail and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `boardId` | integer | No | board Id value documented by TikHub. |
| `boardType` | integer | No | board Type value documented by TikHub. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Kuaishou App Profile And Counts (V2 Route)

**Slug:** `TIK_HUB_KUAISHOU_APP_FETCH_ONE_USER_V2`

Get an app profile and social/content counts from a Kuaishou eid or numeric user ID. Prefer this exact V2 route for those app identifiers and counts; use the web user-info sibling for a web-profile lookup.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | Kuaishou eid or numeric userId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Kuaishou App Fetch One Video

**Slug:** `TIK_HUB_KUAISHOU_APP_FETCH_ONE_VIDEO`

Fetch One Video on Kuaishou through TikHub's Kuaishou-App surface. This action is limited to fetch one video and returns its validated typed projection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `photo_id` | string | Yes | photo id value documented by TikHub. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Kuaishou App Fetch One Video By Url

**Slug:** `TIK_HUB_KUAISHOU_APP_FETCH_ONE_VIDEO_BY_URL`

Fetch One Video By Url on Kuaishou through TikHub's Kuaishou-App surface. This action is limited to fetch one video by url and returns its validated typed projection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `share_text` | string | Yes | share text value documented by TikHub. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Kuaishou App Fetch User Live Info

**Slug:** `TIK_HUB_KUAISHOU_APP_FETCH_USER_LIVE_INFO`

Fetch User Live Info on Kuaishou through TikHub's Kuaishou-App surface. This action is limited to fetch user live info and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | user id value documented by TikHub. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Kuaishou video comments

**Slug:** `TIK_HUB_KUAISHOU_APP_FETCH_VIDEO_COMMENT`

Fetch one cursor page of comments for a Kuaishou video through TikHub.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pcursor` | string | No | Comment cursor from the previous page. |
| `photo_id` | string | Yes | Kuaishou photo ID or eID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Kuaishou App Generate Kuaishou Share Link

**Slug:** `TIK_HUB_KUAISHOU_APP_GENERATE_KUAISHOU_SHARE_LINK`

Generate Kuaishou Share Link on Kuaishou through TikHub's Kuaishou-App surface. This action is limited to generate kuaishou share link and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shareObjectId` | string | Yes | share Object Id value documented by TikHub. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### V2/Search user V2

**Slug:** `TIK_HUB_KUAISHOU_APP_SEARCH_USER_V2`

Search Kuaishou users one page at a time. Start with an empty pcursor and pass the returned pcursor to the next call.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `keyword` | string | Yes | Provider parameter keyword. |
| `pcursor` | string | No | Use an empty string for the first page; pass the response pcursor to the next call. |
| `fans_sort` | string ("default" | "most_to_least" | "least_to_most") | No | default / most_to_least / least_to_most |
| `user_gender` | string ("all" | "male" | "female") | No | all / male / female |
| `user_relation` | string ("all" | "same_city" | "verified" | "live" | "following") | No | all / same_city / verified / live / following |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Kuaishou Web Fetch Get User Id

**Slug:** `TIK_HUB_KUAISHOU_WEB_FETCH_GET_USER_ID`

Fetch Get User Id on Kuaishou through TikHub's Kuaishou-Web surface. This action is limited to fetch get user id and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `share_link` | string | Yes | 用户分享链接/User Share Link |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Kuaishou Web Fetch One Video By Url

**Slug:** `TIK_HUB_KUAISHOU_WEB_FETCH_ONE_VIDEO_BY_URL`

Fetch One Video By Url on Kuaishou through TikHub's Kuaishou-Web surface. This action is limited to fetch one video by url and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.002 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | 作品链接/Photo URL |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Kuaishou Web Fetch One Video Comment

**Slug:** `TIK_HUB_KUAISHOU_WEB_FETCH_ONE_VIDEO_COMMENT`

Fetch One Video Comment on Kuaishou through TikHub's Kuaishou-Web surface. This action is limited to fetch one video comment and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.002 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pcursor` | string | No | 评论游标/Comment cursor |
| `photo_id` | string | Yes | 作品ID/Photo ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Kuaishou Web Fetch One Video Sub Comment

**Slug:** `TIK_HUB_KUAISHOU_WEB_FETCH_ONE_VIDEO_SUB_COMMENT`

Fetch One Video Sub Comment on Kuaishou through TikHub's Kuaishou-Web surface. This action is limited to fetch one video sub comment and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pcursor` | string | No | 评论游标/Comment cursor |
| `photo_id` | string | Yes | 作品ID/Photo ID |
| `root_comment_id` | string | Yes | 根评论ID/Root comment ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch user collect

**Slug:** `TIK_HUB_KUAISHOU_WEB_FETCH_USER_COLLECT`

Fetch one observed page of a Kuaishou user's collected posts. The response does not expose a next cursor, so additional-page pagination is unsupported.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pcursor` | string | No | Optional provider cursor. The observed response does not expose a next cursor, so pagination beyond one page is unsupported. |
| `user_id` | string | Yes | Provider parameter user_id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Kuaishou Web Fetch User Info

**Slug:** `TIK_HUB_KUAISHOU_WEB_FETCH_USER_INFO`

Fetch User Info on Kuaishou through TikHub's Kuaishou-Web surface. This action is limited to fetch user info and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.002 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | 用户 ID (eid)/User ID (eid) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch user live replay

**Slug:** `TIK_HUB_KUAISHOU_WEB_FETCH_USER_LIVE_REPLAY`

Fetch one observed page of a Kuaishou user's live replays. The response does not expose a next cursor, so additional-page pagination is unsupported.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pcursor` | string | No | Optional provider cursor. The observed response does not expose a next cursor, so pagination beyond one page is unsupported. |
| `user_id` | string | Yes | Provider parameter user_id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Kuaishou Web Generate Share Short Url

**Slug:** `TIK_HUB_KUAISHOU_WEB_GENERATE_SHARE_SHORT_URL`

Generate Share Short Url on Kuaishou through TikHub's Kuaishou-Web surface. This action is limited to generate share short url and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `photo_id` | string | Yes | 作品ID/Photo ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Kuaishou Video By Photo ID

**Slug:** `TIK_HUB_KUAISHOU_WEB_GET_VIDEO_BY_PHOTO_ID`

Fetch one Kuaishou video by photo_id. The share-text variant instead accepts share text and excludes photo-only posts.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.002 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `photo_id` | string | Yes | 作品ID/Photo ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Kuaishou Video By Share Text

**Slug:** `TIK_HUB_KUAISHOU_WEB_GET_VIDEO_BY_SHARE_TEXT`

Fetch one Kuaishou video from share text; photo-only posts are unsupported. The photo-ID variant instead requires a photo_id.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.002 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `share_text` | string | Yes | 作品分享链接/Photo share link |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Kuaishou Hot Board

**Slug:** `TIK_HUB_KUAISHOU_WEB_LIST_HOT_BOARD`

List the main Kuaishou hot board or select an entertainment, society, useful, challenge, or search ranking board.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `board_type` | string ("hot" | "entertainment" | "society" | "useful" | "challenge" | "search") | No | Kuaishou board to list: hot, entertainment, society, useful, challenge, or search. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Lemon8 App Fetch Discover Banners

**Slug:** `TIK_HUB_LEMON8_APP_FETCH_DISCOVER_BANNERS`

Fetch Discover Banners on Lemon8 through TikHub's Lemon8-App surface. This action is limited to fetch discover banners and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get main content of discover page

**Slug:** `TIK_HUB_LEMON8_APP_FETCH_DISCOVER_TAB`

Call the exact TikHub Lemon8-App-API route to get main content of discover page. This action performs one provider request and does not infer pagination.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Lemon8 App Fetch Hot Search Keywords

**Slug:** `TIK_HUB_LEMON8_APP_FETCH_HOT_SEARCH_KEYWORDS`

Fetch Hot Search Keywords on Lemon8 through TikHub's Lemon8-App surface. This action is limited to fetch hot search keywords and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Lemon8 App Fetch Topic Info

**Slug:** `TIK_HUB_LEMON8_APP_FETCH_TOPIC_INFO`

Fetch Topic Info on Lemon8 through TikHub's Lemon8-App surface. This action is limited to fetch topic info and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `forum_id` | string | Yes | Topic ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Lemon8 App Fetch User Follower List

**Slug:** `TIK_HUB_LEMON8_APP_FETCH_USER_FOLLOWER_LIST`

Fetch User Follower List on Lemon8 through TikHub's Lemon8-App surface. This action is limited to fetch user follower list and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Pagination parameter |
| `user_id` | string | Yes | User ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Lemon8 App Fetch User Following List

**Slug:** `TIK_HUB_LEMON8_APP_FETCH_USER_FOLLOWING_LIST`

Fetch User Following List on Lemon8 through TikHub's Lemon8-App surface. This action is limited to fetch user following list and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Pagination parameter |
| `user_id` | string | Yes | User ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Linkedin Web V2 Get Company Profile

**Slug:** `TIK_HUB_LINKEDIN_WEB_V2_GET_COMPANY_PROFILE`

Get Company Profile on LinkedIn through TikHub's LinkedIn-Web-V2 surface. This action is limited to get company profile and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.008 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | 公司主页完整 URL/Full company URL |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Linkedin Web V2 Get Post Detail

**Slug:** `TIK_HUB_LINKEDIN_WEB_V2_GET_POST_DETAIL`

Get Post Detail on LinkedIn through TikHub's LinkedIn-Web-V2 surface. This action is limited to get post detail and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | 帖子或文章 URL/Post or article URL |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Linkedin Web V2 Get User Profile

**Slug:** `TIK_HUB_LINKEDIN_WEB_V2_GET_USER_PROFILE`

Get User Profile on LinkedIn through TikHub's LinkedIn-Web-V2 surface. This action is limited to get user profile and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.008 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | 用户主页完整 URL/Full profile URL |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Discount Tiers

**Slug:** `TIK_HUB_LIST_DISCOUNT_TIERS`

Return TikHub's request-per-day discount bands for internal budgeting, without interpreting whether shared tier boundaries are inclusive or exclusive.

**Instant:** Supported on the latest version.

**Instant pricing:** $0 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Pipixia App Fetch Hashtag Detail

**Slug:** `TIK_HUB_PIPIXIA_APP_FETCH_HASHTAG_DETAIL`

Fetch Hashtag Detail on PiPiXia through TikHub's PiPiXia-App surface. This action is limited to fetch hashtag detail and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hashtag_id` | string | Yes | 话题id/Hashtag id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get PiPiXia hashtag posts

**Slug:** `TIK_HUB_PIPIXIA_APP_FETCH_HASHTAG_POST_LIST`

Get PiPiXia hashtag posts through TikHub's exact PiPiXia App API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Page cursor. |
| `feed_count` | string | No | Zero-based page count. |
| `hashtag_id` | string | Yes | PiPiXia hashtag ID. |
| `hashtag_sort_type` | string | No | Hashtag sort category. |
| `hashtag_request_type` | string | No | Hashtag request category. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get PiPiXia home feed

**Slug:** `TIK_HUB_PIPIXIA_APP_FETCH_HOME_FEED`

Get PiPiXia home feed through TikHub's exact PiPiXia App API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Page cursor. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Pipixia App Fetch Home Short Drama Feed

**Slug:** `TIK_HUB_PIPIXIA_APP_FETCH_HOME_SHORT_DRAMA_FEED`

Fetch Home Short Drama Feed on PiPiXia through TikHub's PiPiXia-App surface. This action is limited to fetch home short drama feed and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | 页码/Page number |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get PiPiXia hot-search boards

**Slug:** `TIK_HUB_PIPIXIA_APP_FETCH_HOT_SEARCH_BOARD_LIST`

Get PiPiXia hot-search boards through TikHub's exact PiPiXia App API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get PiPiXia post comments

**Slug:** `TIK_HUB_PIPIXIA_APP_FETCH_POST_COMMENT_LIST`

Get PiPiXia post comments through TikHub's exact PiPiXia App API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `offset` | string | No | Page offset cursor. |
| `cell_id` | string | Yes | PiPiXia post ID. |
| `cell_type` | integer | No | Post type; 1 denotes video. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get PiPiXia post detail

**Slug:** `TIK_HUB_PIPIXIA_APP_FETCH_POST_DETAIL`

Get PiPiXia post detail through TikHub's exact PiPiXia App API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cell_id` | string | Yes | PiPiXia post ID. |
| `cell_type` | integer | No | Post type; 1 denotes video. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Pipixia App Fetch Post Statistics

**Slug:** `TIK_HUB_PIPIXIA_APP_FETCH_POST_STATISTICS`

Fetch Post Statistics on PiPiXia through TikHub's PiPiXia-App surface. This action is limited to fetch post statistics and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cell_id` | string | Yes | 作品id/Video id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search PiPiXia

**Slug:** `TIK_HUB_PIPIXIA_APP_FETCH_SEARCH`

Search PiPiXia through TikHub's exact PiPiXia App API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `offset` | string | No | Page offset cursor. |
| `keyword` | string | Yes | Search keyword. |
| `search_type` | string | No | Search category code. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Pipixia App Fetch Short Url

**Slug:** `TIK_HUB_PIPIXIA_APP_FETCH_SHORT_URL`

Fetch Short Url on PiPiXia through TikHub's PiPiXia-App surface. This action is limited to fetch short url and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `original_url` | string | Yes | 原始链接/Original URL |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Pipixia App Fetch User Follower List

**Slug:** `TIK_HUB_PIPIXIA_APP_FETCH_USER_FOLLOWER_LIST`

Fetch User Follower List on PiPiXia through TikHub's PiPiXia-App surface. This action is limited to fetch user follower list and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | 翻页游标/Page cursor |
| `user_id` | string | Yes | 用户id/User id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get PiPiXia user followings

**Slug:** `TIK_HUB_PIPIXIA_APP_FETCH_USER_FOLLOWING_LIST`

Get PiPiXia user followings through TikHub's exact PiPiXia App API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Page cursor. |
| `user_id` | string | Yes | PiPiXia user ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get PiPiXia user posts

**Slug:** `TIK_HUB_PIPIXIA_APP_FETCH_USER_POST_LIST`

Get PiPiXia user posts through TikHub's exact PiPiXia App API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Page cursor. |
| `user_id` | string | Yes | PiPiXia user ID. |
| `feed_count` | string | No | Zero-based page count. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reddit App Check Subreddit Muted

**Slug:** `TIK_HUB_REDDIT_APP_CHECK_SUBREDDIT_MUTED`

Check Subreddit Muted on Reddit through TikHub's Reddit-APP surface. This action is limited to check subreddit muted and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `language` | string | No | 返回内容使用的语言，采用 IETF 语言标签；默认 en-US / Preferred response language as an IETF language tag; default: en-US |
| `need_format` | boolean | No | 是否需要清洗数据/Whether to clean and format the data |
| `subreddit_id` | string | Yes | 版块ID/Subreddit ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reddit App Fetch Comment Replies

**Slug:** `TIK_HUB_REDDIT_APP_FETCH_COMMENT_REPLIES`

Fetch Comment Replies on Reddit through TikHub's Reddit-APP surface. This action is limited to fetch comment replies and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | Yes | 评论游标/Comment cursor from more.cursor field |
| `post_id` | string | Yes | 帖子ID/Post ID |
| `language` | string | No | 返回内容使用的语言，采用 IETF 语言标签；默认 en-US / Preferred response language as an IETF language tag; default: en-US |
| `sort_type` | string ("CONFIDENCE" | "NEW" | "TOP" | "HOT" | "CONTROVERSIAL" | "OLD" | "RANDOM") | No | 排序方式/Sort method: CONFIDENCE, NEW, TOP, HOT, CONTROVERSIAL, OLD, RANDOM |
| `need_format` | boolean | No | 是否需要清洗数据/Whether to clean and format the data |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reddit App Fetch Community Highlights

**Slug:** `TIK_HUB_REDDIT_APP_FETCH_COMMUNITY_HIGHLIGHTS`

Fetch Community Highlights on Reddit through TikHub's Reddit-APP surface. This action is limited to fetch community highlights and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `language` | string | No | 返回内容使用的语言，采用 IETF 语言标签；默认 en-US / Preferred response language as an IETF language tag; default: en-US |
| `need_format` | boolean | No | 是否需要清洗数据/Whether to clean and format the data |
| `subreddit_id` | string | Yes | 版块ID/Subreddit ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Reddit

**Slug:** `TIK_HUB_REDDIT_APP_FETCH_DYNAMIC_SEARCH`

Search Reddit through TikHub's exact Reddit App API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reddit App Fetch Games Feed

**Slug:** `TIK_HUB_REDDIT_APP_FETCH_GAMES_FEED`

Fetch Games Feed on Reddit through TikHub's Reddit-APP surface. This action is limited to fetch games feed and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("BEST" | "HOT" | "NEW" | "TOP" | "CONTROVERSIAL" | "RISING") | No | 排序方式/Sort method: NEW, HOT, TOP, RISING |
| `time` | string ("ALL" | "HOUR" | "DAY" | "WEEK" | "MONTH" | "YEAR") | No | 时间范围/Time range: ALL, HOUR, DAY, WEEK, MONTH, YEAR |
| `after` | string | No | 分页参数/Pagination parameter |
| `language` | string | No | 返回内容使用的语言，采用 IETF 语言标签；默认 en-US / Preferred response language as an IETF language tag; default: en-US |
| `need_format` | boolean | No | 是否需要清洗数据/Whether to clean and format the data |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reddit home feed

**Slug:** `TIK_HUB_REDDIT_APP_FETCH_HOME_FEED`

Get Reddit home feed through TikHub's exact Reddit App API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reddit news feed

**Slug:** `TIK_HUB_REDDIT_APP_FETCH_NEWS_FEED`

Get Reddit news feed through TikHub's exact Reddit App API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `after` | string | No | Pagination token for the next page. |
| `language` | string | No | Preferred response language as an IETF language tag. |
| `need_format` | boolean | No | Whether TikHub should normalize the provider payload. |
| `subtopic_ids` | array | No | News subtopic IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reddit popular feed

**Slug:** `TIK_HUB_REDDIT_APP_FETCH_POPULAR_FEED`

Get Reddit popular feed through TikHub's exact Reddit App API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("BEST" | "HOT" | "NEW" | "TOP" | "CONTROVERSIAL" | "RISING") | No | Feed sort order. |
| `time` | string ("ALL" | "HOUR" | "DAY" | "WEEK" | "MONTH" | "YEAR") | No | Time range used to rank popular posts. |
| `after` | string | No | Pagination token for the next page. |
| `language` | string | No | Preferred response language as an IETF language tag. |
| `need_format` | boolean | No | Whether TikHub should normalize the provider payload. |
| `filter_posts` | array | No | Reddit post IDs to exclude from the feed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reddit App Fetch Post Comments

**Slug:** `TIK_HUB_REDDIT_APP_FETCH_POST_COMMENTS`

Fetch Post Comments on Reddit through TikHub's Reddit-APP surface. This action is limited to fetch post comments and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `after` | string | No | 分页参数/Pagination parameter for fetching next page |
| `post_id` | string | Yes | 帖子ID/Post ID |
| `language` | string | No | 返回内容使用的语言，采用 IETF 语言标签；默认 en-US / Preferred response language as an IETF language tag; default: en-US |
| `sort_type` | string ("CONFIDENCE" | "NEW" | "TOP" | "HOT" | "CONTROVERSIAL" | "OLD" | "RANDOM") | No | 排序方式/Sort method: CONFIDENCE, NEW, TOP, HOT, CONTROVERSIAL, OLD, RANDOM |
| `need_format` | boolean | No | 是否需要清洗数据/Whether to clean and format the data |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reddit App Fetch Post Details

**Slug:** `TIK_HUB_REDDIT_APP_FETCH_POST_DETAILS`

Fetch Post Details on Reddit through TikHub's Reddit-APP surface. This action is limited to fetch post details and returns its validated typed projection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `post_id` | string | Yes | 帖子ID/Post ID |
| `language` | string | No | 返回内容使用的语言，采用 IETF 语言标签；默认 en-US / Preferred response language as an IETF language tag; default: en-US |
| `comment_id` | string | No | 评论ID/Comment ID (when include_comment_id is True) |
| `need_format` | boolean | No | 是否需要清洗数据/Whether to clean and format the data |
| `include_comment_id` | boolean | No | 是否包含特定评论ID/Include specific comment ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reddit App Fetch Post Details Batch

**Slug:** `TIK_HUB_REDDIT_APP_FETCH_POST_DETAILS_BATCH`

Fetch Post Details Batch on Reddit through TikHub's Reddit-APP surface. This action is limited to fetch post details batch and returns its validated typed projection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `language` | string | No | 返回内容使用的语言，采用 IETF 语言标签；默认 en-US / Preferred response language as an IETF language tag; default: en-US |
| `post_ids` | string | Yes | 帖子ID列表，逗号分隔，最多5条/Post IDs comma-separated, max 5 |
| `comment_id` | string | No | 评论ID/Comment ID (when include_comment_id is True) |
| `need_format` | boolean | No | 是否需要清洗数据/Whether to clean and format the data |
| `include_comment_id` | boolean | No | 是否包含特定评论ID/Include specific comment ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reddit App Fetch Post Details Batch Large

**Slug:** `TIK_HUB_REDDIT_APP_FETCH_POST_DETAILS_BATCH_LARGE`

Fetch Post Details Batch Large on Reddit through TikHub's Reddit-APP surface. This action is limited to fetch post details batch large and returns its validated typed projection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `language` | string | No | 返回内容使用的语言，采用 IETF 语言标签；默认 en-US / Preferred response language as an IETF language tag; default: en-US |
| `post_ids` | string | Yes | 帖子ID列表，逗号分隔，最多30条/Post IDs comma-separated, max 30 |
| `comment_id` | string | No | 评论ID/Comment ID (when include_comment_id is True) |
| `need_format` | boolean | No | 是否需要清洗数据/Whether to clean and format the data |
| `include_comment_id` | boolean | No | 是否包含特定评论ID/Include specific comment ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reddit App Fetch Search Typeahead

**Slug:** `TIK_HUB_REDDIT_APP_FETCH_SEARCH_TYPEAHEAD`

Fetch Search Typeahead on Reddit through TikHub's Reddit-APP surface. This action is limited to fetch search typeahead and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | 搜索关键词/Search query |
| `language` | string | No | 返回内容使用的语言，采用 IETF 语言标签；默认 en-US / Preferred response language as an IETF language tag; default: en-US |
| `allow_nsfw` | string ("0" | "1") | No | 是否允许NSFW内容/Allow NSFW content: 0 or 1 |
| `need_format` | boolean | No | 是否需要清洗数据/Whether to clean and format the data |
| `safe_search` | string ("unset" | "strict") | No | 安全搜索设置/Safe search setting: unset, strict |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get subreddit feed

**Slug:** `TIK_HUB_REDDIT_APP_FETCH_SUBREDDIT_FEED`

Get subreddit feed through TikHub's exact Reddit App API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("BEST" | "HOT" | "NEW" | "TOP" | "CONTROVERSIAL" | "RISING") | No | Feed sort order. |
| `after` | string | No | Pagination token for the next page. |
| `language` | string | No | Preferred response language as an IETF language tag. |
| `need_format` | boolean | No | Whether TikHub should normalize the provider payload. |
| `filter_posts` | array | No | Reddit post IDs to exclude from the feed. |
| `subreddit_name` | string | Yes | Subreddit name without the r/ prefix. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reddit App Fetch Subreddit Info

**Slug:** `TIK_HUB_REDDIT_APP_FETCH_SUBREDDIT_INFO`

Fetch Subreddit Info on Reddit through TikHub's Reddit-APP surface. This action is limited to fetch subreddit info and returns its validated typed projection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `language` | string | No | 返回内容使用的语言，采用 IETF 语言标签；默认 en-US / Preferred response language as an IETF language tag; default: en-US |
| `need_format` | boolean | No | 是否需要清洗数据/Whether to clean and format the data |
| `subreddit_name` | string | No | 版块名称/Subreddit name |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reddit App Fetch Subreddit Post Channels

**Slug:** `TIK_HUB_REDDIT_APP_FETCH_SUBREDDIT_POST_CHANNELS`

Fetch Subreddit Post Channels on Reddit through TikHub's Reddit-APP surface. This action is limited to fetch subreddit post channels and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("BEST" | "HOT" | "NEW" | "TOP" | "CONTROVERSIAL" | "RISING") | No | 排序方式/Sort method: HOT, NEW, TOP, CONTROVERSIAL, RISING |
| `range` | string ("ALL" | "HOUR" | "DAY" | "WEEK" | "MONTH" | "YEAR") | No | 时间范围/Time range: HOUR, DAY, WEEK, MONTH, YEAR, ALL |
| `language` | string | No | 返回内容使用的语言，采用 IETF 语言标签；默认 en-US / Preferred response language as an IETF language tag; default: en-US |
| `need_format` | boolean | No | 是否需要清洗数据/Whether to clean and format the data |
| `subreddit_name` | string | No | 版块名称/Subreddit name |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reddit App Fetch Subreddit Settings

**Slug:** `TIK_HUB_REDDIT_APP_FETCH_SUBREDDIT_SETTINGS`

Fetch Subreddit Settings on Reddit through TikHub's Reddit-APP surface. This action is limited to fetch subreddit settings and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `language` | string | No | 返回内容使用的语言，采用 IETF 语言标签；默认 en-US / Preferred response language as an IETF language tag; default: en-US |
| `need_format` | boolean | No | 是否需要清洗数据/Whether to clean and format the data |
| `subreddit_id` | string | Yes | 版块ID/Subreddit ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reddit App Fetch Subreddit Style

**Slug:** `TIK_HUB_REDDIT_APP_FETCH_SUBREDDIT_STYLE`

Fetch Subreddit Style on Reddit through TikHub's Reddit-APP surface. This action is limited to fetch subreddit style and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `language` | string | No | 返回内容使用的语言，采用 IETF 语言标签；默认 en-US / Preferred response language as an IETF language tag; default: en-US |
| `need_format` | boolean | No | 是否需要清洗数据/Whether to clean and format the data |
| `subreddit_name` | string | No | 版块名称/Subreddit name |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reddit App Fetch Trending Searches

**Slug:** `TIK_HUB_REDDIT_APP_FETCH_TRENDING_SEARCHES`

Fetch Trending Searches on Reddit through TikHub's Reddit-APP surface. This action is limited to fetch trending searches and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `language` | string | No | 返回内容使用的语言，采用 IETF 语言标签；默认 en-US / Preferred response language as an IETF language tag; default: en-US |
| `need_format` | boolean | No | 是否需要清洗数据/Whether to clean and format the data |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reddit App Fetch User Active Subreddits

**Slug:** `TIK_HUB_REDDIT_APP_FETCH_USER_ACTIVE_SUBREDDITS`

Fetch User Active Subreddits on Reddit through TikHub's Reddit-APP surface. This action is limited to fetch user active subreddits and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `language` | string | No | 返回内容使用的语言，采用 IETF 语言标签；默认 en-US / Preferred response language as an IETF language tag; default: en-US |
| `username` | string | Yes | 用户名/Username |
| `need_format` | boolean | No | 是否需要清洗数据/Whether to clean and format the data |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reddit App Fetch User Comments

**Slug:** `TIK_HUB_REDDIT_APP_FETCH_USER_COMMENTS`

Fetch User Comments on Reddit through TikHub's Reddit-APP surface. This action is limited to fetch user comments and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("NEW" | "TOP" | "HOT" | "CONTROVERSIAL") | No | 排序方式/Sort method: NEW, TOP, HOT, CONTROVERSIAL |
| `after` | string | No | 分页参数/Pagination parameter |
| `language` | string | No | 返回内容使用的语言，采用 IETF 语言标签；默认 en-US / Preferred response language as an IETF language tag; default: en-US |
| `username` | string | Yes | 用户名/Username |
| `page_size` | integer | No | 每页数量/Page size (default: 25) |
| `need_format` | boolean | No | 是否需要清洗数据/Whether to clean and format the data |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reddit user posts

**Slug:** `TIK_HUB_REDDIT_APP_FETCH_USER_POSTS`

Get Reddit user posts through TikHub's exact Reddit App API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("NEW" | "TOP" | "HOT" | "CONTROVERSIAL") | No | Post sort order. |
| `after` | string | No | Pagination token for the next page. |
| `language` | string | No | Preferred response language as an IETF language tag. |
| `username` | string | Yes | Reddit username. |
| `need_format` | boolean | No | Whether TikHub should normalize the provider payload. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reddit App Fetch User Profile

**Slug:** `TIK_HUB_REDDIT_APP_FETCH_USER_PROFILE`

Fetch User Profile on Reddit through TikHub's Reddit-APP surface. This action is limited to fetch user profile and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `language` | string | No | 返回内容使用的语言，采用 IETF 语言标签；默认 en-US / Preferred response language as an IETF language tag; default: en-US |
| `username` | string | Yes | 用户名/Username |
| `need_format` | boolean | No | 是否需要清洗数据/Whether to clean and format the data |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reddit App Fetch User Trophies

**Slug:** `TIK_HUB_REDDIT_APP_FETCH_USER_TROPHIES`

Fetch User Trophies on Reddit through TikHub's Reddit-APP surface. This action is limited to fetch user trophies and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `language` | string | No | 返回内容使用的语言，采用 IETF 语言标签；默认 en-US / Preferred response language as an IETF language tag; default: en-US |
| `username` | string | Yes | 用户名/Username |
| `need_format` | boolean | No | 是否需要清洗数据/Whether to clean and format the data |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Telegram Web Batch Channel Info

**Slug:** `TIK_HUB_TELEGRAM_WEB_BATCH_CHANNEL_INFO`

Batch Channel Info on Telegram through TikHub's Telegram-Web surface. This action is limited to batch channel info and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.008 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channels` | string | Yes | Comma-separated usernames (max 20). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Telegram Web Fetch Channel Info

**Slug:** `TIK_HUB_TELEGRAM_WEB_FETCH_CHANNEL_INFO`

Fetch Channel Info on Telegram through TikHub's Telegram-Web surface. This action is limited to fetch channel info and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel` | string | Yes | Channel username. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Telegram Web Fetch Channel Posts

**Slug:** `TIK_HUB_TELEGRAM_WEB_FETCH_CHANNEL_POSTS`

Fetch Channel Posts on Telegram through TikHub's Telegram-Web surface. This action is limited to fetch channel posts and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `after` | integer | No | Newer than this id. |
| `limit` | integer | No | Number of posts. |
| `before` | integer | No | Older than this id. |
| `channel` | string | Yes | Channel username. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Telegram Web Fetch Channel Search

**Slug:** `TIK_HUB_TELEGRAM_WEB_FETCH_CHANNEL_SEARCH`

Fetch Channel Search on Telegram through TikHub's Telegram-Web surface. This action is limited to fetch channel search and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of hits. |
| `query` | string | Yes | Keyword. |
| `channel` | string | Yes | Channel username. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Telegram Web Fetch Post Detail

**Slug:** `TIK_HUB_TELEGRAM_WEB_FETCH_POST_DETAIL`

Fetch Post Detail on Telegram through TikHub's Telegram-Web surface. This action is limited to fetch post detail and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel` | string | Yes | Channel username. |
| `post_id` | integer | Yes | Post ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Post Comments

**Slug:** `TIK_HUB_THREADS_WEB_FETCH_POST_COMMENTS`

Call TikHub's exact Threads-Web-API route /api/v1/threads/web/fetch_post_comments and return its validated response.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `post_id` | string | Yes | 帖子ID/Post ID |
| `end_cursor` | string | No | 分页游标/Pagination cursor (optional) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Threads Web Fetch Post Detail

**Slug:** `TIK_HUB_THREADS_WEB_FETCH_POST_DETAIL`

Fetch Post Detail on Threads through TikHub's Threads-Web surface. This action is limited to fetch post detail and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.002 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `post_id` | string | Yes | Post ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Threads Web Fetch User Info By Id

**Slug:** `TIK_HUB_THREADS_WEB_FETCH_USER_INFO_BY_ID`

Fetch User Info By Id on Threads through TikHub's Threads-Web surface. This action is limited to fetch user info by id and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.002 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | User ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Threads Web Fetch User Reposts

**Slug:** `TIK_HUB_THREADS_WEB_FETCH_USER_REPOSTS`

Fetch User Reposts on Threads through TikHub's Threads-Web surface. This action is limited to fetch user reposts and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.002 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | User ID |
| `end_cursor` | string | No | Pagination cursor (optional) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Profiles

**Slug:** `TIK_HUB_THREADS_WEB_SEARCH_PROFILES`

Search Threads profiles by keyword and return profile IDs, usernames, names, verification state, and onboarding status.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.002 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | 搜索关键词/Search query |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Ads Get Ad Interactive Analysis

**Slug:** `TIK_HUB_TIKTOK_ADS_GET_AD_INTERACTIVE_ANALYSIS`

Call the fixed TikHub POST /api/v1/tiktok/ads/get_ad_interactive_analysis operation and return only its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `material_id` | string | Yes | Ad material ID. |
| `metric_type` | string | No | Analysis type (ctr, cvr, clicks, conversion, remain). |
| `period_type` | integer | No | Period type (days). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Ads Get Ad Keyframe Analysis

**Slug:** `TIK_HUB_TIKTOK_ADS_GET_AD_KEYFRAME_ANALYSIS`

Get ad keyframe analysis

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `metric` | string | No | 分析指标/Analysis metric (retain_ctr, retain_cvr, click_cnt, convert_cnt, play_retain_cnt) |
| `material_id` | string | Yes | 广告素材ID/Ad material ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Ads Get Ad Percentile

**Slug:** `TIK_HUB_TIKTOK_ADS_GET_AD_PERCENTILE`

Call the fixed TikHub POST /api/v1/tiktok/ads/get_ad_percentile operation and return only its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `metric` | string | No | Analysis metric (ctr_percentile, time_attr_conversion_rate_percentile, click_cnt_percentile, time_attr_convert_cnt_percentile, show_cnt_percentile). |
| `material_id` | string | Yes | Ad material ID. |
| `period_type` | integer | No | Time period (days). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Ads Get Ads Detail

**Slug:** `TIK_HUB_TIKTOK_ADS_GET_ADS_DETAIL`

Call the fixed TikHub POST /api/v1/tiktok/ads/get_ads_detail operation and return only its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ads_id` | string | Yes | Ad ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Ads Get Configure Safety

**Slug:** `TIK_HUB_TIKTOK_ADS_GET_CONFIGURE_SAFETY`

Call the fixed TikHub POST /api/v1/tiktok/ads/get_configure_safety operation and return only its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Ads Get Location List

**Slug:** `TIK_HUB_TIKTOK_ADS_GET_LOCATION_LIST`

Call the fixed TikHub POST /api/v1/tiktok/ads/get_location_list operation and return only its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Ads Get Query Suggestions

**Slug:** `TIK_HUB_TIKTOK_ADS_GET_QUERY_SUGGESTIONS`

Call the fixed TikHub POST /api/v1/tiktok/ads/get_query_suggestions operation and return only its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Suggestion count. |
| `query` | string | No | Empty for scenario 1; input a keyword for scenario 2. |
| `scenario` | integer | No | 1 popular, 2 related suggestions. |
| `country_code` | string | No | Optional country code. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Ads Get Recommended Ads

**Slug:** `TIK_HUB_TIKTOK_ADS_GET_RECOMMENDED_ADS`

Call the fixed TikHub POST /api/v1/tiktok/ads/get_recommended_ads operation and return only its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `industry` | string | No | Industry ID. |
| `material_id` | string | Yes | Ad material ID. |
| `country_code` | string | No | Country code. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Ads Get Top Ads Filters

**Slug:** `TIK_HUB_TIKTOK_ADS_GET_TOP_ADS_FILTERS`

Call the fixed TikHub POST /api/v1/tiktok/ads/get_top_ads_filters operation and return only its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Ads Get Top Ads Spotlight

**Slug:** `TIK_HUB_TIKTOK_ADS_GET_TOP_ADS_SPOTLIGHT`

Call the fixed TikHub POST /api/v1/tiktok/ads/get_top_ads_spotlight operation and return only its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number. |
| `limit` | integer | No | Items per page. |
| `industry` | string | No | Industry ID (optional). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Ads Get Top Contents List

**Slug:** `TIK_HUB_TIKTOK_ADS_GET_TOP_CONTENTS_LIST`

Call the fixed TikHub POST /api/v1/tiktok/ads/get_top_contents_list operation and return only its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number. |
| `limit` | integer | No | Items per page, max 100. |
| `country_code` | string | No | Country code. |
| `organic_only` | boolean | No | Organic content only. |
| `order_by_metric` | integer | No | Order by metric. |
| `period_dimension` | integer | No | Period dimension. |
| `content_label_ids` | string | No | Content label IDs, comma separated. |
| `period_end_timestamp` | integer | Yes | The caller must generate this 10-digit Unix timestamp in seconds from the target ranking date, for example 1785024000; do not pass 0 because it returns an empty result. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Ads Get Trends Hashtag List

**Slug:** `TIK_HUB_TIKTOK_ADS_GET_TRENDS_HASHTAG_LIST`

Call the fixed TikHub POST /api/v1/tiktok/ads/get_trends_hashtag_list operation and return only its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number. |
| `limit` | integer | No | Items per page. |
| `time_range` | integer | No | Time range in days. |
| `industry_id` | integer | No | First-level industry ID (optional). |
| `country_code` | string | No | Country code. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Ads Search Ads

**Slug:** `TIK_HUB_TIKTOK_ADS_SEARCH_ADS`

Call the fixed TikHub POST /api/v1/tiktok/ads/search_ads operation and return only its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `like` | integer | No | Performance rank (optional; 1:1-20% 2:21-40% 3:41-60% 4:61-80% 5:81-100%). |
| `page` | integer | No | Page number. |
| `limit` | integer | No | Items per page. |
| `period` | integer | No | Time period (days). |
| `keyword` | string | No | Search keyword. |
| `duration` | integer | No | Video duration filter value (optional). |
| `industry` | string | No | Industry ID. |
| `order_by` | string | No | Sort by (for_you, likes). |
| `ad_format` | integer | No | Ad format (optional; 1:Spark Ads 2:Non-Spark Ads). |
| `objective` | integer | No | Ad objective (optional; 1: 2: 3: 4: 5: 6: 7:). |
| `search_id` | string | No | Search ID (optional). |
| `ad_language` | string | No | Ad language (optional). |
| `country_code` | string | No | Country code. |
| `pattern_label` | string | No | Creative pattern label (optional). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Analytics Detect Fake Views

**Slug:** `TIK_HUB_TIKTOK_ANALYTICS_DETECT_FAKE_VIEWS`

Detect fake views in video

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | string | Yes | 作品id/Video id |
| `content_category` | string ("default" | "entertainment" | "education" | "product" | "verified_large") | No | 内容分类/Content category, options: default, entertainment, education, product, verified_large |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Analyze TikTok Comment Keywords

**Slug:** `TIK_HUB_TIKTOK_ANALYTICS_FETCH_COMMENT_KEYWORDS`

Extract recurring keywords and representative comments for a TikTok video.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | string | Yes | TikTok video identifier to analyze. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### TiktokAnalyticsFetchCreatorInfoAndMilestones

**Slug:** `TIK_HUB_TIKTOK_ANALYTICS_FETCH_CREATOR_INFO_AND_MILESTONES`

Read the documented TikHub TikTok-Analytics-API data from the fixed /api/v1/tiktok/analytics/fetch_creator_info_and_milestones endpoint.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | 用户id/User id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### TiktokAnalyticsFetchVideoMetrics

**Slug:** `TIK_HUB_TIKTOK_ANALYTICS_FETCH_VIDEO_METRICS`

Read the documented TikHub TikTok-Analytics-API data from the fixed /api/v1/tiktok/analytics/fetch_video_metrics endpoint.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | string | Yes | 作品id/Video id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok App V3 Check Live Room Online

**Slug:** `TIK_HUB_TIKTOK_APP_V3_CHECK_LIVE_ROOM_ONLINE`

Call TikHub's documented tiktok app v3 check live room online operation and return only validated, evidenced response fields. This provider call may incur TikHub usage charges.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `room_id` | string | Yes | Live room id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok App V3 Check Live Room Online Batch

**Slug:** `TIK_HUB_TIKTOK_APP_V3_CHECK_LIVE_ROOM_ONLINE_BATCH`

Call TikHub's documented tiktok app v3 check live room online batch operation and return only validated, evidenced response fields. This provider call may incur TikHub usage charges.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `room_ids` | array | Yes | List of TikTok live room IDs |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok App V3 Fetch Content Translate

**Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_CONTENT_TRANSLATE`

Call TikHub's documented tiktok app v3 fetch content translate operation and return only validated, evidenced response fields. This provider call may incur TikHub usage charges.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `trg_lang` | string | No | Target language ISO639-1 code, e.g. zh-Hans |
| `src_content` | string | No | Source language content, i.e. the content to be translated |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok App V3 Fetch Creator Search Insights

**Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_CREATOR_SEARCH_INSIGHTS`

Call TikHub's documented tiktok app v3 fetch creator search insights operation and return only validated, evidenced response fields. This provider call may incur TikHub usage charges.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tab` | string | No | hashtags) |
| `limit` | integer | No | Number per page |
| `offset` | integer | No | Pagination offset |
| `force_refresh` | boolean | No | Force refresh |
| `creator_source` | string | No | Creator source |
| `category_filters` | string | No | Sports) |
| `language_filters` | string | No | ko) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok App V3 Fetch Creator Search Insights Detail

**Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_CREATOR_SEARCH_INSIGHTS_DETAIL`

Call TikHub's documented tiktok app v3 fetch creator search insights detail operation and return only validated, evidenced response fields. This provider call may incur TikHub usage charges.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_date` | integer | No | End timestamp (seconds), only for custom range |
| `start_date` | integer | No | Start timestamp (seconds), only for custom range |
| `time_range` | string | No | custom) |
| `query_id_str` | string | Yes | Query ID from fetch_creator_search_insights |
| `dimension_list` | string | No | country) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok App V3 Fetch Creator Search Insights Trend

**Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_CREATOR_SEARCH_INSIGHTS_TREND`

Call TikHub's documented tiktok app v3 fetch creator search insights trend operation and return only validated, evidenced response fields. This provider call may incur TikHub usage charges.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query_id_str` | string | Yes | Query ID from fetch_creator_search_insights |
| `from_tab_path` | string | No | From tab path |
| `query_analysis_required` | boolean | No | Whether query analysis is required |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok App V3 Fetch Hashtag Detail

**Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_HASHTAG_DETAIL`

Call TikHub's documented tiktok app v3 fetch hashtag detail operation and return only validated, evidenced response fields. This provider call may incur TikHub usage charges.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ch_id` | string | Yes | Hashtag id |
| `region` | string | No | Region (US, GB, FR, JP, VN, SG) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok App V3 Fetch Hashtag Search Result

**Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_HASHTAG_SEARCH_RESULT`

Call TikHub's documented tiktok app v3 fetch hashtag search result operation and return only validated, evidenced response fields. This provider call may incur TikHub usage charges.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Number |
| `offset` | integer | No | Use 0 for the first page. Reuse data.cursor while data.has_more is nonzero; stop when data.has_more is 0. |
| `keyword` | string | Yes | Keyword |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List TikTok Hashtag Videos

**Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_HASHTAG_VIDEO_LIST`

Get one cursor-paginated page of TikTok videos associated with a hashtag ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Number of videos to request. |
| `cursor` | integer | No | Use 0 for the first page, then pass the cursor returned by the previous page. |
| `region` | string ("US" | "GB" | "FR" | "JP" | "VN" | "SG") | No | TikTok region. |
| `hashtag_id` | string | Yes | TikTok hashtag identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch TikTok Live Daily Rank

**Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_LIVE_DAILY_RANK`

Fetch the daily TikTok live creator ranking and the selected creator's position.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `room_id` | string | No | TikTok live room identifier. |
| `anchor_id` | string | No | TikTok live anchor identifier. |
| `rank_type` | integer | No | Provider ranking type. |
| `region_type` | integer | No | Provider region type. |
| `gap_interval` | integer | No | Ranking time interval. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok App V3 Fetch Live Ranking List

**Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_LIVE_RANKING_LIST`

Call TikHub's documented tiktok app v3 fetch live ranking list operation and return only validated, evidenced response fields. This provider call may incur TikHub usage charges.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `room_id` | string | Yes | Live room id |
| `anchor_id` | string | Yes | Anchor id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok App V3 Fetch Live Room Info

**Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_LIVE_ROOM_INFO`

Call TikHub's documented tiktok app v3 fetch live room info operation and return only validated, evidenced response fields. This provider call may incur TikHub usage charges.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `room_id` | string | Yes | Live room id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok App V3 Fetch Live Room Product List

**Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_LIVE_ROOM_PRODUCT_LIST`

Call TikHub's documented tiktok app v3 fetch live room product list operation and return only validated, evidenced response fields. This provider call may incur TikHub usage charges.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `offset` | integer | No | Number |
| `region` | string | No | Region |
| `room_id` | string | Yes | Live room id |
| `author_id` | string | Yes | Anchor id |
| `page_size` | integer | No | Number |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok App V3 Fetch Location Search

**Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_LOCATION_SEARCH`

Call TikHub's documented tiktok app v3 fetch location search operation and return only validated, evidenced response fields. This provider call may incur TikHub usage charges.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Number |
| `offset` | integer | No | Use 0 for the first page. Reuse data.cursor while data.has_more is nonzero; stop when data.has_more is 0. |
| `keyword` | string | Yes | Keyword |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok App V3 Fetch Music Detail

**Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_MUSIC_DETAIL`

Call TikHub's documented tiktok app v3 fetch music detail operation and return only validated, evidenced response fields. This provider call may incur TikHub usage charges.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `music_id` | string | Yes | Music id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List TikTok music videos

**Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_MUSIC_VIDEO_LIST`

Get one cursor-paginated page of TikTok videos that use a specified music track.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Number of videos to return. |
| `cursor` | integer | No | Page cursor; use 0 for the first page. |
| `music_id` | string | Yes | TikTok music identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch TikTok App Video

**Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_ONE_VIDEO`

Fetch TikTok video author, engagement, and playback metadata from the original /fetch_one_video route. Prefer this original route by default because no documented or live functional difference from V2 is substantiated.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `aweme_id` | string | Yes | TikTok video identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch TikTok App Video V2

**Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_ONE_VIDEO_V2`

Fetch TikTok video author, engagement, and playback metadata from the /fetch_one_video_v2 route. Use only when the caller explicitly requires V2; otherwise prefer the original route because no documented or live functional difference is substantiated.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `aweme_id` | string | Yes | TikTok video identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch TikTok App Video V3

**Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_ONE_VIDEO_V3`

Fetch region-aware TikTok video author, engagement, and playback metadata.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `region` | string | No | Two-letter country code. |
| `aweme_id` | string | Yes | TikTok video identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok App V3 Fetch Share Qr Code

**Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_SHARE_QR_CODE`

Call TikHub's documented tiktok app v3 fetch share qr code operation and return only validated, evidenced response fields. This provider call may incur TikHub usage charges.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `object_id` | string | Yes | Object id |
| `schema_type` | integer | No | Schema type |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok App V3 Fetch Share Short Link

**Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_SHARE_SHORT_LINK`

Call TikHub's documented tiktok app v3 fetch share short link operation and return only validated, evidenced response fields. This provider call may incur TikHub usage charges.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Share link |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok App V3 Fetch User Country By Username

**Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_USER_COUNTRY_BY_USERNAME`

Call TikHub's documented tiktok app v3 fetch user country by username operation and return only validated, evidenced response fields. This provider call may incur TikHub usage charges.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `username` | string | Yes | Username |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok App V3 Fetch User Following List

**Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_USER_FOLLOWING_LIST`

Call TikHub's documented tiktok app v3 fetch user following list operation and return only validated, evidenced response fields. This provider call may incur TikHub usage charges.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Number |
| `user_id` | string | No | TikTok numeric user ID. Provide this or sec_user_id; an identifier is required. |
| `min_time` | integer | No | Minimum time for paging |
| `page_token` | string | No | Page token |
| `sec_user_id` | string | No | TikTok secured user ID. Provide this or user_id; an identifier is required. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch TikTok User Music

**Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_USER_MUSIC_LIST`

Fetch one page of music associated with a TikTok user.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Number of tracks to return. |
| `cursor` | integer | No | Page cursor. |
| `sec_uid` | string | Yes | TikTok secure user identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch TikTok User Post Videos

**Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_USER_POST_VIDEOS`

Fetch one page of videos posted by a TikTok user, selected by secure user ID or username and ordered by latest or popularity.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search TikTok App Users

**Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_USER_SEARCH_RESULT`

Search TikTok users with optional provider-supported preference filters.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Number of users to return. |
| `offset` | integer | No | Use 0 for the first page. Reuse data.cursor while data.has_more is nonzero; stop when data.has_more is 0. |
| `keyword` | string | Yes | User search keyword. |
| `user_search_other_pref` | string | No | Provider additional search preference. |
| `user_search_profile_type` | string | No | Provider account-type preference. |
| `user_search_follower_count` | string | No | Provider follower-count sort preference. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch TikTok App Comment Replies

**Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_VIDEO_COMMENT_REPLIES`

Fetch one page of replies to a TikTok video comment.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Number of replies to return. |
| `cursor` | integer | No | Page cursor. |
| `item_id` | string | Yes | TikTok video identifier. |
| `comment_id` | string | Yes | Parent comment identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch TikTok App Video Comments

**Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_VIDEO_COMMENTS`

Fetch one page of comments and author summaries for a TikTok video.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Number of comments to return. |
| `cursor` | integer | No | Page cursor. |
| `aweme_id` | string | Yes | TikTok video identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search TikTok videos

**Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_VIDEO_SEARCH_RESULT`

Search TikTok videos by keyword with ordering, publication-time, region, and offset pagination filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Requested result count. |
| `offset` | integer | No | Use 0 initially, then the returned cursor. |
| `region` | string | No | TikTok region or ISO country code. |
| `keyword` | string | Yes | Search keyword. |
| `sort_type` | integer ("0" | "1") | No | Sort order: 0 for relevance or 1 for most likes. |
| `publish_time` | integer ("0" | "1" | "7" | "30" | "90" | "180") | No | Publication window in days; 0 means unrestricted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok App V3 Fetch Webcast User Info

**Slug:** `TIK_HUB_TIKTOK_APP_V3_FETCH_WEBCAST_USER_INFO`

Call TikHub's documented tiktok app v3 fetch webcast user info operation and return only validated, evidenced response fields. This provider call may incur TikHub usage charges.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | No | User uid (optional, pure number) |
| `sec_user_id` | string | No | User sec_user_id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok App V3 Get User Id And Sec User Id By Username

**Slug:** `TIK_HUB_TIKTOK_APP_V3_GET_USER_ID_AND_SEC_USER_ID_BY_USERNAME`

Call TikHub's documented tiktok app v3 get user id and sec user id by username operation and return only validated, evidenced response fields. This provider call may incur TikHub usage charges.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `username` | string | Yes | Username |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get TikTok App User Profile

**Slug:** `TIK_HUB_TIKTOK_APP_V3_GET_USER_PROFILE`

Get a TikTok app profile by sec_user_id, including the evidenced public profile and engagement fields. This provider call may incur TikHub usage charges.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | No | User uid (optional, pure number) |
| `unique_id` | string | No | User unique_id (username) |
| `sec_user_id` | string | No | User sec_user_id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate TikTok keyword-search handoff URL

**Slug:** `TIK_HUB_TIKTOK_APP_V3_OPEN_TIKTOK_APP_TO_KEYWORD_SEARCH`

Generate and return a TikTok mobile-app handoff URL for a keyword search. This read-only action does not open the app; a human must open the URL.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `keyword` | string | Yes | 关键词/Keyword |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate TikTok private-message handoff URL

**Slug:** `TIK_HUB_TIKTOK_APP_V3_OPEN_TIKTOK_APP_TO_SEND_PRIVATE_MESSAGE`

Generate and return a TikTok mobile-app handoff URL for a private-message recipient. This read-only action does not open the app or send a message; a human must complete the send.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | 用户id/User id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate TikTok profile handoff URL

**Slug:** `TIK_HUB_TIKTOK_APP_V3_OPEN_TIKTOK_APP_TO_USER_PROFILE`

Generate and return a TikTok mobile-app handoff URL for a user profile. This read-only action does not open the app; a human must open the URL.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | 用户id/User id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate TikTok video handoff URL

**Slug:** `TIK_HUB_TIKTOK_APP_V3_OPEN_TIKTOK_APP_TO_VIDEO_DETAIL`

Generate and return a TikTok mobile-app handoff URL for a video. This read-only action does not open the app; a human must open the URL.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `aweme_id` | string | Yes | 作品id/Video id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch TikTok Shop Product Detail

**Slug:** `TIK_HUB_TIKTOK_SHOP_WEB_FETCH_PRODUCT_DETAIL`

Fetch TikTok Shop product and seller identifiers using product ID, optional seller ID, and region. Use V3 when seller ID is unavailable and its page-level result is sufficient.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `region` | string | No | TikTok Shop region code. |
| `seller_id` | string | No | Optional seller identifier. |
| `product_id` | string | Yes | TikTok Shop product identifier. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Shop Web Fetch Product Detail V3

**Slug:** `TIK_HUB_TIKTOK_SHOP_WEB_FETCH_PRODUCT_DETAIL_V3`

Fetch the V3 TikTok Shop product page identifier and A/B-test state using product ID and region. Use the original route when seller ID input and product/seller identifiers are required.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `region` | string | No | 地区代码/Region code |
| `product_id` | string | Yes | 商品ID/Product ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Shop Web Fetch Product Id By Share Link

**Slug:** `TIK_HUB_TIKTOK_SHOP_WEB_FETCH_PRODUCT_ID_BY_SHARE_LINK`

Call the documented TikHub TikTok Shop Web endpoint for tiktok shop web fetch product id by share link and return its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `region` | string | No | Region code selecting the egress used to follow the share link. |
| `share_link` | string | Yes | 分享链接/Share link |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Shop Web Fetch Products Category List

**Slug:** `TIK_HUB_TIKTOK_SHOP_WEB_FETCH_PRODUCTS_CATEGORY_LIST`

Call the documented TikHub TikTok Shop Web endpoint for tiktok shop web fetch products category list and return its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `region` | string | No | 地区代码/Region code |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search TikTok Shop Products

**Slug:** `TIK_HUB_TIKTOK_SHOP_WEB_FETCH_SEARCH_PRODUCTS_LIST`

Search TikTok Shop products through the original /fetch_search_products_list route. Prefer this original route by default because no documented or live functional difference from V2 is substantiated.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `offset` | integer | No | Use 0 for the first page. Reuse data.data.load_more_params.offset while data.data.has_more is true; stop when false. |
| `region` | string | No | TikTok Shop region code. |
| `page_token` | string | No | Use an empty string for the first page. Reuse data.data.load_more_params.page_token while data.data.has_more is true; stop when false. |
| `search_word` | string | Yes | Product search keyword. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search TikTok Shop Products V2

**Slug:** `TIK_HUB_TIKTOK_SHOP_WEB_FETCH_SEARCH_PRODUCTS_LIST_V2`

Search TikTok Shop products through the /fetch_search_products_list_v2 route. Use only when the caller explicitly requires V2; otherwise prefer the original route because no documented or live functional difference is substantiated.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `offset` | integer | No | Use 0 for the first page. Reuse data.data.component_data.offset while data.data.component_data.has_more is true; stop when false. |
| `region` | string | No | TikTok Shop region code. |
| `page_token` | string | No | Use an empty string for the first page. Reuse data.data.component_data.load_more_params.page_token while data.data.component_data.has_more is true; stop when false. |
| `search_word` | string | Yes | Product search keyword. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Shop Web Fetch Search Word Suggestion V2

**Slug:** `TIK_HUB_TIKTOK_SHOP_WEB_FETCH_SEARCH_WORD_SUGGESTION_V2`

Get search keyword suggestions V2 (Mobile)

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lang` | string | No | 语言/Language |
| `region` | string | No | 地区代码/Region code |
| `search_word` | string | Yes | 搜索关键词/Search keyword |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Shop Web Fetch Seller Products List

**Slug:** `TIK_HUB_TIKTOK_SHOP_WEB_FETCH_SELLER_PRODUCTS_LIST`

Call the documented TikHub TikTok Shop Web endpoint for tiktok shop web fetch seller products list and return its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `region` | string | No | 地区代码/Region code |
| `seller_id` | string | Yes | 卖家ID/Seller ID |
| `search_params` | string | No | 搜索参数(用于分页)/Search params (for pagination) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Shop Web Fetch Shop Id By Share Link

**Slug:** `TIK_HUB_TIKTOK_SHOP_WEB_FETCH_SHOP_ID_BY_SHARE_LINK`

Call the documented TikHub TikTok Shop Web endpoint for tiktok shop web fetch shop id by share link and return its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `region` | string | No | Region code selecting the egress used to follow the share link. |
| `share_link` | string | Yes | 分享链接/Share link |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Web Fetch Batch Check Live Alive

**Slug:** `TIK_HUB_TIKTOK_WEB_FETCH_BATCH_CHECK_LIVE_ALIVE`

Call the documented TikHub TikTok Web endpoint for tiktok web fetch batch check live alive and return its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** From $0.025 per TikTok live room checked (up to 50 per batch)

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `room_ids` | string | Yes | 直播间ID列表，用英文逗号分隔，最多支持50个/Live room ID list separated by commas, up to 50 IDs |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Web Fetch Check Live Alive

**Slug:** `TIK_HUB_TIKTOK_WEB_FETCH_CHECK_LIVE_ALIVE`

Call the documented TikHub TikTok Web endpoint for tiktok web fetch check live alive and return its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.002 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `room_id` | string | Yes | 直播间ID/Live room ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Web Fetch Gift Name By Id

**Slug:** `TIK_HUB_TIKTOK_WEB_FETCH_GIFT_NAME_BY_ID`

Call the documented TikHub TikTok Web endpoint for tiktok web fetch gift name by id and return its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `gift_id` | string | Yes | 礼物ID | Gift ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Web Fetch Gift Names By Ids

**Slug:** `TIK_HUB_TIKTOK_WEB_FETCH_GIFT_NAMES_BY_IDS`

Call the documented TikHub TikTok Web endpoint for tiktok web fetch gift names by ids and return its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.025 per gift-name lookup batch (up to 50 IDs)

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `gift_ids` | array | Yes | 礼物ID列表，建议50个/次获得最佳性价比($0.025)，超过50个时自动处理前50个 | Gift ID list, recommend 50/call for best value ($0.025), auto-process first 50 if more than 50 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Web Fetch Live Recommend Tabs

**Slug:** `TIK_HUB_TIKTOK_WEB_FETCH_LIVE_RECOMMEND_TABS`

Call the documented TikHub TikTok Web endpoint for tiktok web fetch live recommend tabs and return its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `logid` | string | No | 翻页游标，首页请求留空；加载更多时传入上一次响应返回的 logid/Pagination cursor, leave empty for the first page; pass the `logid` from the previous response to load more |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Web Fetch Post Ai Article

**Slug:** `TIK_HUB_TIKTOK_WEB_FETCH_POST_AI_ARTICLE`

Call the documented TikHub TikTok Web endpoint for tiktok web fetch post ai article and return its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | string | Yes | 作品id/Video id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch TikTok Web Post Comments

**Slug:** `TIK_HUB_TIKTOK_WEB_FETCH_POST_COMMENT`

Fetch one page of public comments and author summaries for a TikTok post.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Number of comments to return. |
| `cursor` | integer | No | Page cursor. |
| `aweme_id` | string | Yes | TikTok video identifier. |
| `current_region` | string | No | Optional current region code. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Web Fetch Search Keyword Suggest

**Slug:** `TIK_HUB_TIKTOK_WEB_FETCH_SEARCH_KEYWORD_SUGGEST`

Call the documented TikHub TikTok Web endpoint for tiktok web fetch search keyword suggest and return its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `keyword` | string | Yes | 搜索关键词/Search keyword |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search TikTok Live Streams

**Slug:** `TIK_HUB_TIKTOK_WEB_FETCH_SEARCH_LIVE`

Search public TikTok live streams and return room commerce and battle indicators.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Number of results to return. |
| `offset` | integer | No | Use 0 for the first page. Reuse data.cursor while data.has_more is nonzero; stop when data.has_more is 0. |
| `keyword` | string | Yes | Live-stream search keyword. |
| `search_id` | string | No | Search identifier returned by a prior page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Web Fetch Tag Detail

**Slug:** `TIK_HUB_TIKTOK_WEB_FETCH_TAG_DETAIL`

Call the documented TikHub TikTok Web endpoint for tiktok web fetch tag detail and return its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_name` | string | Yes | Tag名称/Tag name |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Web Fetch Tiktok Live Data

**Slug:** `TIK_HUB_TIKTOK_WEB_FETCH_TIKTOK_LIVE_DATA`

Call the documented TikHub TikTok Web endpoint for tiktok web fetch tiktok live data and return its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `live_room_url` | string | Yes | 直播间链接/Live room link |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Web Fetch Trending Searchwords

**Slug:** `TIK_HUB_TIKTOK_WEB_FETCH_TRENDING_SEARCHWORDS`

Call the documented TikHub TikTok Web endpoint for tiktok web fetch trending searchwords and return its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Web Fetch User Profile

**Slug:** `TIK_HUB_TIKTOK_WEB_FETCH_USER_PROFILE`

Call the documented TikHub TikTok Web endpoint for tiktok web fetch user profile and return its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sec_uid` | string | No | 用户secUid/User secUid |
| `unique_id` | string | No | 用户uniqueId/User uniqueId |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Web Generate Hashed ID

**Slug:** `TIK_HUB_TIKTOK_WEB_GENERATE_HASHED_ID`

Generate hashed ID

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | 邮箱地址/Email address |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Web Generate Ttwid

**Slug:** `TIK_HUB_TIKTOK_WEB_GENERATE_TTWID`

Call the documented TikHub TikTok Web endpoint for tiktok web generate ttwid and return its validated data projection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_agent` | string | No | User Agent |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Resolve TikTok Video IDs

**Slug:** `TIK_HUB_TIKTOK_WEB_GET_ALL_AWEME_ID`

Resolve a batch of public TikTok video URLs to video identifiers.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `urls` | array | Yes | Public TikTok video URLs to resolve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Resolve TikTok Secure User IDs

**Slug:** `TIK_HUB_TIKTOK_WEB_GET_ALL_SEC_USER_ID`

Resolve a batch of public TikTok profile URLs to secure user identifiers.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `urls` | array | Yes | Public TikTok profile URLs to resolve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Resolve TikTok Usernames

**Slug:** `TIK_HUB_TIKTOK_WEB_GET_ALL_UNIQUE_ID`

Resolve a batch of public TikTok profile URLs to public usernames.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `urls` | array | Yes | Public TikTok profile URLs to resolve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Web Get Aweme Id

**Slug:** `TIK_HUB_TIKTOK_WEB_GET_AWEME_ID`

Call the documented TikHub TikTok Web endpoint for tiktok web get aweme id and return its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | 作品链接/Video link |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Web Get Live Room Id

**Slug:** `TIK_HUB_TIKTOK_WEB_GET_LIVE_ROOM_ID`

Call the documented TikHub TikTok Web endpoint for tiktok web get live room id and return its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `live_room_url` | string | Yes | 直播间链接/Live room link |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get TikTok Web Post Detail

**Slug:** `TIK_HUB_TIKTOK_WEB_GET_POST_DETAIL`

Fetch TikTok post metadata with directly usable primary video URLs.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `region` | string | No | 地区代码，可选；影响作品所属地区，如 US/GB/JP/ID 等，默认 US。/ Region code, optional; affects content region, e.g. US/GB/JP/ID, default US. |
| `item_id` | string | Yes | 作品id/Video id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Web Get Sec User Id

**Slug:** `TIK_HUB_TIKTOK_WEB_GET_SEC_USER_ID`

Call the documented TikHub TikTok Web endpoint for tiktok web get sec user id and return its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | 用户主页链接/User homepage link |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Web Get Unique Id

**Slug:** `TIK_HUB_TIKTOK_WEB_GET_UNIQUE_ID`

Call the documented TikHub TikTok Web endpoint for tiktok web get unique id and return its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | 用户主页链接/User homepage link |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tiktok Web Get User Id

**Slug:** `TIK_HUB_TIKTOK_WEB_GET_USER_ID`

Call the documented TikHub TikTok Web endpoint for tiktok web get user id and return its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | 用户主页链接/User homepage link |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get TikTok Live Room Stream

**Slug:** `TIK_HUB_TIKTOK_WEB_TIKTOK_LIVE_ROOM`

Get the WebSocket event stream URL for a public TikTok live room and event type.

**Instant:** Supported on the latest version.

**Instant pricing:** $0 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `danmaku_type` | string | Yes | TikTok live event type, such as WebcastChatMessage. |
| `live_room_url` | string | Yes | Public TikTok live-room URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Toutiao App Get Article Info

**Slug:** `TIK_HUB_TOUTIAO_APP_GET_ARTICLE_INFO`

Get Article Info on Toutiao through TikHub's Toutiao-App surface. This action is limited to get article info and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | Post ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Toutiao App Get Comments

**Slug:** `TIK_HUB_TOUTIAO_APP_GET_COMMENTS`

Get Comments on Toutiao through TikHub's Toutiao-App surface. This action is limited to get comments and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `offset` | string | Yes | Use 0 for the first page. Reuse data.offset while data.has_more is true; stop when data.has_more is false. |
| `group_id` | string | Yes | Post ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Toutiao App Get User Id

**Slug:** `TIK_HUB_TOUTIAO_APP_GET_USER_ID`

Get User Id on Toutiao through TikHub's Toutiao-App surface. This action is limited to get user id and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_profile_url` | string | Yes | User profile URL |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Toutiao App Get User Info

**Slug:** `TIK_HUB_TOUTIAO_APP_GET_USER_INFO`

Get User Info on Toutiao through TikHub's Toutiao-App surface. This action is limited to get user info and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | User ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Toutiao App Get Video Info

**Slug:** `TIK_HUB_TOUTIAO_APP_GET_VIDEO_INFO`

Get Video Info on Toutiao through TikHub's Toutiao-App surface. This action is limited to get video info and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | Post ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Toutiao Web Get Article Info

**Slug:** `TIK_HUB_TOUTIAO_WEB_GET_ARTICLE_INFO`

Get Article Info on Toutiao through TikHub's Toutiao-Web surface. This action is limited to get article info and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `aweme_id` | string | Yes | 作品ID/Post ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Toutiao Web Get Video Info

**Slug:** `TIK_HUB_TOUTIAO_WEB_GET_VIDEO_INFO`

Get Video Info on Toutiao through TikHub's Toutiao-Web surface. This action is limited to get video info and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `aweme_id` | string | Yes | 作品ID/Post ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check follow relationship

**Slug:** `TIK_HUB_TWITTER_WEB_FETCH_CHECK_FOLLOW`

Check follow relationship through TikHub's exact Twitter Web API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `follows` | string | Yes | Target Twitter screen name. |
| `user_name` | string | Yes | Source Twitter screen name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check retweet relationship

**Slug:** `TIK_HUB_TWITTER_WEB_FETCH_CHECK_RETWEET`

Check retweet relationship through TikHub's exact Twitter Web API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tweet_id` | string | Yes | Twitter post ID. |
| `screen_name` | string | Yes | Twitter screen name without @. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get community info

**Slug:** `TIK_HUB_TWITTER_WEB_FETCH_COMMUNITY_INFO`

Get community info through TikHub's exact Twitter Web API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `community_id` | string | Yes | Twitter community ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get community members

**Slug:** `TIK_HUB_TWITTER_WEB_FETCH_COMMUNITY_MEMBERS`

Get community members through TikHub's exact Twitter Web API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Compatibility cursor; the current provider route only returns its first page. |
| `community_id` | string | Yes | Twitter community ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get community timeline

**Slug:** `TIK_HUB_TWITTER_WEB_FETCH_COMMUNITY_TIMELINE`

Get community timeline through TikHub's exact Twitter Web API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by the preceding page. |
| `ranking` | string | No | Optional community timeline ranking. |
| `community_id` | string | Yes | Twitter community ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get latest post comments

**Slug:** `TIK_HUB_TWITTER_WEB_FETCH_LATEST_POST_COMMENTS`

Get latest post comments through TikHub's exact Twitter Web API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by the preceding page. |
| `tweet_id` | string | Yes | Twitter post ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get list followers

**Slug:** `TIK_HUB_TWITTER_WEB_FETCH_LIST_FOLLOWERS`

Get list followers through TikHub's exact Twitter Web API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by the preceding page. |
| `list_id` | string | Yes | Twitter list ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get list members

**Slug:** `TIK_HUB_TWITTER_WEB_FETCH_LIST_MEMBERS`

Get list members through TikHub's exact Twitter Web API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by the preceding page. |
| `list_id` | string | Yes | Twitter list ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get list timeline

**Slug:** `TIK_HUB_TWITTER_WEB_FETCH_LIST_TIMELINE`

Get list timeline through TikHub's exact Twitter Web API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by the preceding page. |
| `list_id` | string | Yes | Twitter list ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get post comments

**Slug:** `TIK_HUB_TWITTER_WEB_FETCH_POST_COMMENTS`

Get post comments through TikHub's exact Twitter Web API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by the preceding page. |
| `tweet_id` | string | Yes | Twitter post ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get retweet users

**Slug:** `TIK_HUB_TWITTER_WEB_FETCH_RETWEET_USER_LIST`

Get retweet users through TikHub's exact Twitter Web API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by the preceding page. |
| `tweet_id` | string | Yes | Twitter post ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get trends

**Slug:** `TIK_HUB_TWITTER_WEB_FETCH_TRENDING`

Get trends through TikHub's exact Twitter Web API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `country` | string | No | Country name used by TikHub's trends route. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get tweet detail

**Slug:** `TIK_HUB_TWITTER_WEB_FETCH_TWEET_DETAIL`

Get tweet detail through TikHub's exact Twitter Web API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tweet_id` | string | Yes | Twitter post ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get user account details

**Slug:** `TIK_HUB_TWITTER_WEB_FETCH_USER_ABOUT`

Get user account details through TikHub's exact Twitter Web API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `screen_name` | string | Yes | Twitter screen name without @. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get user affiliates

**Slug:** `TIK_HUB_TWITTER_WEB_FETCH_USER_AFFILIATES`

Get user affiliates through TikHub's exact Twitter Web API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by the preceding page. |
| `screen_name` | string | Yes | Twitter screen name without @. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get user followers

**Slug:** `TIK_HUB_TWITTER_WEB_FETCH_USER_FOLLOWERS`

Get user followers through TikHub's exact Twitter Web API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by the preceding page. |
| `screen_name` | string | Yes | Twitter screen name without @. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get user followings

**Slug:** `TIK_HUB_TWITTER_WEB_FETCH_USER_FOLLOWINGS`

Get user followings through TikHub's exact Twitter Web API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by the preceding page. |
| `screen_name` | string | Yes | Twitter screen name without @. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get user live status

**Slug:** `TIK_HUB_TWITTER_WEB_FETCH_USER_LIVE_STATUS`

Get user live status through TikHub's exact Twitter Web API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rest_id` | string | Yes | Numeric Twitter user ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get user media

**Slug:** `TIK_HUB_TWITTER_WEB_FETCH_USER_MEDIA`

Get user media through TikHub's exact Twitter Web API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by the preceding page. |
| `rest_id` | integer | No | Numeric Twitter user ID. Takes precedence over screen_name. |
| `screen_name` | string | Yes | Twitter screen name without @. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get user posts

**Slug:** `TIK_HUB_TWITTER_WEB_FETCH_USER_POST_TWEET`

Get user posts through TikHub's exact Twitter Web API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by the preceding page. |
| `rest_id` | integer | No | Numeric Twitter user ID. Takes precedence over screen_name. |
| `screen_name` | string | No | Twitter screen name without @. Omit when using rest_id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get user profile

**Slug:** `TIK_HUB_TWITTER_WEB_FETCH_USER_PROFILE`

Get user profile through TikHub's exact Twitter Web API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rest_id` | integer | No | Numeric Twitter user ID. Takes precedence over screen_name. |
| `screen_name` | string | No | Twitter screen name without @. Omit when using rest_id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get profiles by user IDs

**Slug:** `TIK_HUB_TWITTER_WEB_FETCH_USER_PROFILES_BY_REST_IDS`

Get profiles by user IDs through TikHub's exact Twitter Web API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rest_ids` | string | Yes | Comma-separated numeric Twitter user IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get user tweet replies

**Slug:** `TIK_HUB_TWITTER_WEB_FETCH_USER_TWEET_REPLIES`

Get user tweet replies through TikHub's exact Twitter Web API route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by the preceding page. |
| `screen_name` | string | Yes | Twitter screen name without @. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Weibo App Fetch Status Detail

**Slug:** `TIK_HUB_WEIBO_APP_FETCH_STATUS_DETAIL`

Fetch Status Detail on Weibo through TikHub's Weibo-App surface. This action is limited to fetch status detail and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status_id` | string | Yes | ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Detailed Weibo App Profile

**Slug:** `TIK_HUB_WEIBO_APP_FETCH_USER_INFO_DETAIL`

Get a detailed Weibo app profile through TikHub, including verification and account counts, by numeric user ID.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | Numeric Weibo user ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Profile Feed

**Slug:** `TIK_HUB_WEIBO_APP_FETCH_USER_PROFILE_FEED`

Get a user's Weibo profile feed through TikHub's exact reviewed provider route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | 用户ID |
| `since_id` | string | No | 翻页游标 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Videos

**Slug:** `TIK_HUB_WEIBO_APP_FETCH_USER_VIDEOS`

Get a user's Weibo videos through TikHub's exact reviewed provider route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | 用户ID |
| `since_id` | string | No | 翻页游标 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Video Detail

**Slug:** `TIK_HUB_WEIBO_APP_FETCH_VIDEO_DETAIL`

Get Weibo video details through TikHub's exact reviewed provider route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mid` | string | Yes | 视频微博ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Weibo Mobile Profile

**Slug:** `TIK_HUB_WEIBO_APP_GET_MOBILE_PROFILE`

Get the mobile-app Weibo profile projection through TikHub by numeric user ID, including app-specific profile modules. Use a Web V2 profile action for the smaller web summary or username-based lookup.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | Numeric Weibo user ID from a profile or user lookup result. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Weibo Web V2 Check Allow Comment With Pic

**Slug:** `TIK_HUB_WEIBO_WEB_V2_CHECK_ALLOW_COMMENT_WITH_PIC`

Check Allow Comment With Pic on Weibo through TikHub's Weibo-Web-V2 surface. This action is limited to check allow comment with pic and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Weibo post ID whose image-comment permission should be checked. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Weibo Web V2 Fetch Advanced Search

**Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_ADVANCED_SEARCH`

Fetch Advanced Search on Weibo through TikHub's Weibo-Web-V2 surface. This action is limited to fetch advanced search and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number |
| `query` | string | Yes | Search text to match in Weibo posts. |
| `timescope` | string | No | Time scope (custom:start:end) |
| `search_type` | string | No | /Search type: all( ), hot( ), original( ), verified( ), media( ), viewpoint( ) |
| `include_type` | string | No | /Include type: all( ), pic( ), video( ), music( ), link( ) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Weibo Web V2 Fetch Ai Search

**Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_AI_SEARCH`

Fetch Ai Search on Weibo through TikHub's Weibo-Web-V2 surface. This action is limited to fetch ai search and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | Search keyword |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Weibo Web V2 Fetch All Groups

**Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_ALL_GROUPS`

Fetch All Groups on Weibo through TikHub's Weibo-Web-V2 surface. This action is limited to fetch all groups and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Weibo Web V2 Fetch City List

**Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_CITY_LIST`

Fetch City List on Weibo through TikHub's Weibo-Web-V2 surface. This action is limited to fetch city list and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `normalized` | boolean | No | Whether to return normalized structure |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Weibo Web V2 Fetch Entertainment Ranking

**Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_ENTERTAINMENT_RANKING`

Fetch Entertainment Ranking on Weibo through TikHub's Weibo-Web-V2 surface. This action is limited to fetch entertainment ranking and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Weibo Web V2 Fetch Hot Search

**Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_HOT_SEARCH`

Fetch Hot Search on Weibo through TikHub's Weibo-Web-V2 surface. This action is limited to fetch hot search and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Weibo Web V2 Fetch Hot Search Index

**Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_HOT_SEARCH_INDEX`

Fetch Hot Search Index on Weibo through TikHub's Weibo-Web-V2 surface. This action is limited to fetch hot search index and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Weibo Web V2 Fetch Hot Search Summary

**Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_HOT_SEARCH_SUMMARY`

Fetch Hot Search Summary on Weibo through TikHub's Weibo-Web-V2 surface. This action is limited to fetch hot search summary and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Weibo Web V2 Fetch Life Ranking

**Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_LIFE_RANKING`

Fetch Life Ranking on Weibo through TikHub's Weibo-Web-V2 surface. This action is limited to fetch life ranking and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Weibo Web V2 Fetch Pic Search

**Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_PIC_SEARCH`

Fetch Pic Search on Weibo through TikHub's Weibo-Web-V2 surface. This action is limited to fetch pic search and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number |
| `query` | string | Yes | Search keyword |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Weibo Web V2 Fetch Post Detail

**Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_POST_DETAIL`

Fetch Post Detail on Weibo through TikHub's Weibo-Web-V2 surface. This action is limited to fetch post detail and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Weibo post ID from a post URL or search result. |
| `is_get_long_text` | string | No | false) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Weibo Web V2 Fetch Realtime Search

**Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_REALTIME_SEARCH`

Fetch Realtime Search on Weibo through TikHub's Weibo-Web-V2 surface. This action is limited to fetch realtime search and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number |
| `query` | string | Yes | Search keyword |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Weibo Web V2 Fetch Similar Search

**Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_SIMILAR_SEARCH`

Fetch Similar Search on Weibo through TikHub's Weibo-Web-V2 surface. This action is limited to fetch similar search and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `keyword` | string | Yes | Search keyword |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Weibo Web V2 Fetch Social Ranking

**Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_SOCIAL_RANKING`

Fetch Social Ranking on Weibo through TikHub's Weibo-Web-V2 surface. This action is limited to fetch social ranking and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Weibo Web V2 Fetch Topic Search

**Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_TOPIC_SEARCH`

Fetch Topic Search on Weibo through TikHub's Weibo-Web-V2 surface. This action is limited to fetch topic search and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number |
| `query` | string | Yes | Search keyword |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Weibo Web V2 Fetch User Fans

**Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_USER_FANS`

Fetch User Fans on Weibo through TikHub's Weibo-Web-V2 surface. This action is limited to fetch user fans and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | Numeric Weibo user ID whose followers should be listed. |
| `page` | integer | No | Page number |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Weibo Web V2 Fetch User Search

**Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_USER_SEARCH`

Fetch User Search on Weibo through TikHub's Weibo-Web-V2 surface. This action is limited to fetch user search and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `age` | string | No | Age bucket |
| `tag` | string | No | Tag filter |
| `auth` | string | No | Auth type |
| `page` | integer | No | Page |
| `work` | string | No | Company filter |
| `query` | string | No | /Query |
| `gender` | string | No | Gender |
| `region` | string | No | city_list |
| `school` | string | No | School filter |
| `nickname` | string | No | Nickname filter |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Weibo Web V2 Fetch User Video Collection List

**Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_USER_VIDEO_COLLECTION_LIST`

Fetch User Video Collection List on Weibo through TikHub's Weibo-Web-V2 surface. This action is limited to fetch user video collection list and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | Numeric Weibo user ID whose video collections should be listed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Weibo Web V2 Fetch Video Search

**Slug:** `TIK_HUB_WEIBO_WEB_V2_FETCH_VIDEO_SEARCH`

Fetch Video Search on Weibo through TikHub's Weibo-Web-V2 surface. This action is limited to fetch video search and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mode` | string | No | hot= / all= |
| `page` | integer | No | Page number |
| `query` | string | Yes | Search keyword |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Full Weibo Profile

**Slug:** `TIK_HUB_WEIBO_WEB_V2_GET_FULL_PROFILE`

Get the richer Weibo web profile and activity counters through TikHub by numeric user ID or custom username. Use Get Weibo Profile Summary when a faster reduced card projection is sufficient.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | No | User id |
| `custom` | string | No | Custom Weibo username |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Weibo Profile Summary

**Slug:** `TIK_HUB_WEIBO_WEB_V2_GET_PROFILE_SUMMARY`

Get a lightweight Weibo profile summary through TikHub by numeric user ID. Prefer this faster reduced projection for profile cards or bulk lookups; use Get Full Weibo Profile for richer profile and activity fields or username lookup.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | Numeric Weibo user ID whose basic profile should be fetched. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Weibo Web V2 Search User Posts

**Slug:** `TIK_HUB_WEIBO_WEB_V2_SEARCH_USER_POSTS`

Search User Posts on Weibo through TikHub's Weibo-Web-V2 surface. This action is limited to search user posts and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | Numeric Weibo user ID whose posts should be searched. |
| `page` | integer | No | Page number |
| `query` | string | No | Optional text to match within the selected user's posts. |
| `hasori` | integer ("0" | "1") | No | Include original posts, 1=include, 0=exclude |
| `haspic` | integer ("0" | "1") | No | Include image posts, 1=include, 0=exclude |
| `hasret` | integer ("0" | "1") | No | Include retweets, 1=include, 0=exclude |
| `endtime` | integer | No | End timestamp |
| `hastext` | integer ("0" | "1") | No | Include text posts, 1=include, 0=exclude |
| `hasmusic` | integer ("0" | "1") | No | Include music posts, 1=include, 0=exclude |
| `hasvideo` | integer ("0" | "1") | No | Include video posts, 1=include, 0=exclude |
| `starttime` | integer | No | Start timestamp |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Xiaohongshu AppV2GetCreatorHotInspirationFeed

**Slug:** `TIK_HUB_XIAOHONGSHU_APP_V2_GET_CREATOR_HOT_INSPIRATION_FEED`

Read the documented TikHub Xiaohongshu-App-V2-API data from the fixed /api/v1/xiaohongshu/app_v2/get_creator_hot_inspiration_feed endpoint.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | 分页游标，首次请求留空/Pagination cursor, leave empty for first request |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Xiaohongshu AppV2GetCreatorInspirationFeed

**Slug:** `TIK_HUB_XIAOHONGSHU_APP_V2_GET_CREATOR_INSPIRATION_FEED`

Read the documented TikHub Xiaohongshu-App-V2-API data from the fixed /api/v1/xiaohongshu/app_v2/get_creator_inspiration_feed endpoint.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tab` | integer | No | 标签类型/Tab type |
| `cursor` | string | No | 分页游标，首次请求留空/Pagination cursor, leave empty for first request |
| `source` | string | No | 来源/Source |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Xiaohongshu AppV2GetImageNoteDetail

**Slug:** `TIK_HUB_XIAOHONGSHU_APP_V2_GET_IMAGE_NOTE_DETAIL`

Get image-note details through Xiaohongshu App V2, including note IDs, titles, descriptions, images, authors, and engagement counts. This can identify video notes but returns only their cover; use GET_VIDEO_NOTE_DETAIL when playback URLs are needed.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `note_id` | string | No | 笔记ID/Note ID |
| `share_text` | string | No | 分享链接，支持xiaohongshu.com/xhslink.com/xhslink.cn/Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Xiaohongshu AppV2GetNoteComments

**Slug:** `TIK_HUB_XIAOHONGSHU_APP_V2_GET_NOTE_COMMENTS`

List top-level comments for a Xiaohongshu note through App V2 with cursor, index, fold-state, and sort pagination. Use GET_NOTE_SUB_COMMENTS for replies to one parent comment.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `index` | integer | No | 评论索引，首次请求传0/Comment index, pass 0 for first request |
| `cursor` | string | No | 分页游标，首次请求留空/Pagination cursor, leave empty for first request |
| `note_id` | string | No | 笔记ID/Note ID |
| `page_area` | string ("UNFOLDED" | "FOLDED") | No | 折叠状态: UNFOLDED(默认-展开), FOLDED(折叠) |
| `share_text` | string | No | 分享链接，支持xiaohongshu.com/xhslink.com/xhslink.cn/Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn |
| `sort_strategy` | string ("default" | "latest_v2" | "like_count") | No | 排序策略/Sort strategy: default, latest_v2, like_count |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Xiaohongshu AppV2GetNoteSubComments

**Slug:** `TIK_HUB_XIAOHONGSHU_APP_V2_GET_NOTE_SUB_COMMENTS`

List replies beneath one Xiaohongshu parent comment through App V2. Supply comment_id and continue with the cursor and index returned by the previous page; use GET_NOTE_COMMENTS for top-level comments.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `index` | integer | No | 分页索引，首次传1，翻页时从$.data.data.cursor中提取index值/Pagination index, pass 1 for first request, extract index from $.data.data.cursor for next page |
| `cursor` | string | No | 分页游标，首次留空，翻页时从$.data.data.cursor中提取cursor值/Pagination cursor, leave empty for first request, extract cursor from $.data.data.cursor for next page |
| `note_id` | string | No | 笔记ID/Note ID |
| `comment_id` | string | Yes | 父评论ID/Parent comment ID |
| `share_text` | string | No | 分享链接，支持xiaohongshu.com/xhslink.com/xhslink.cn/Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Xiaohongshu AppV2GetProductDetail

**Slug:** `TIK_HUB_XIAOHONGSHU_APP_V2_GET_PRODUCT_DETAIL`

Get Xiaohongshu product details by SKU through App V2. This returns product metadata, not review aggregates or individual reviews.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sku_id` | string | Yes | 商品SKU ID/Product SKU ID |
| `source` | string | No | 来源/Source |
| `pre_page` | string | No | 前置页面/Previous page |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Xiaohongshu AppV2GetProductReviewOverview

**Slug:** `TIK_HUB_XIAOHONGSHU_APP_V2_GET_PRODUCT_REVIEW_OVERVIEW`

Read the documented TikHub Xiaohongshu-App-V2-API data from the fixed /api/v1/xiaohongshu/app_v2/get_product_review_overview endpoint.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tab` | integer | No | 标签类型/Tab type |
| `sku_id` | string | Yes | 商品SKU ID/Product SKU ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Xiaohongshu AppV2GetProductReviews

**Slug:** `TIK_HUB_XIAOHONGSHU_APP_V2_GET_PRODUCT_REVIEWS`

List Xiaohongshu product reviews, including review text, scores, images, engagement, and reviewer information.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | 页码，从0开始/Page number, start from 0 |
| `sku_id` | string | Yes | 商品SKU ID/Product SKU ID |
| `from_page` | string | No | 来源页面/From page |
| `share_pics_only` | integer ("0" | "1") | No | 仅看有图评论：0=否, 1=是/Show reviews with images only: 0=no, 1=yes |
| `sort_strategy_type` | integer ("0" | "1") | No | 排序策略：0=综合排序, 1=最新排序/Sort strategy: 0=general, 1=latest |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Xiaohongshu AppV2GetTopicInfo

**Slug:** `TIK_HUB_XIAOHONGSHU_APP_V2_GET_TOPIC_INFO`

Read the documented TikHub Xiaohongshu-App-V2-API data from the fixed /api/v1/xiaohongshu/app_v2/get_topic_info endpoint.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `source` | string | No | 来源/Source |
| `note_id` | string | No | 来源笔记ID，从笔记跳转到话题时传入/Source note ID, pass when jumping from note to topic |
| `page_id` | string | Yes | 话题页面ID/Topic page ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Xiaohongshu AppV2GetUserFavedNotes

**Slug:** `TIK_HUB_XIAOHONGSHU_APP_V2_GET_USER_FAVED_NOTES`

Read the documented TikHub Xiaohongshu-App-V2-API data from the fixed /api/v1/xiaohongshu/app_v2/get_user_faved_notes endpoint.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | 分页游标，首次请求留空，翻页时传入上一页最后一条笔记的note_id/Pagination cursor, leave empty for first request, pass last note_id from previous page for next page |
| `user_id` | string | No | 用户ID/User ID |
| `share_text` | string | No | 分享链接，支持xiaohongshu.com/xhslink.com/xhslink.cn/Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Xiaohongshu AppV2GetUserInfo

**Slug:** `TIK_HUB_XIAOHONGSHU_APP_V2_GET_USER_INFO`

Read the documented TikHub Xiaohongshu-App-V2-API data from the fixed /api/v1/xiaohongshu/app_v2/get_user_info endpoint.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | No | 用户ID/User ID |
| `share_text` | string | No | 分享链接，支持xiaohongshu.com/xhslink.com/xhslink.cn/Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Xiaohongshu AppV2GetVideoNoteDetail

**Slug:** `TIK_HUB_XIAOHONGSHU_APP_V2_GET_VIDEO_NOTE_DETAIL`

Get video-note details and playback data through Xiaohongshu App V2. This accepts only video notes; use GET_IMAGE_NOTE_DETAIL first when the note type is unknown.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `note_id` | string | No | 笔记ID/Note ID |
| `share_text` | string | No | 分享链接，支持xiaohongshu.com/xhslink.com/xhslink.cn/Share link, supports xiaohongshu.com, xhslink.com, xhslink.cn |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Xiaohongshu AppV2SearchGroups

**Slug:** `TIK_HUB_XIAOHONGSHU_APP_V2_SEARCH_GROUPS`

Read the documented TikHub Xiaohongshu-App-V2-API data from the fixed /api/v1/xiaohongshu/app_v2/search_groups endpoint.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `source` | string | No | 来源/Source |
| `keyword` | string | Yes | 搜索关键词/Search keyword |
| `page_no` | integer | No | 页码，从0开始/Page number, start from 0 |
| `search_id` | string | No | 搜索ID，翻页时传入首次搜索返回的值/Search ID for pagination |
| `is_recommend` | integer ("0" | "1") | No | 是否推荐：0=否, 1=是/Is recommend: 0=no, 1=yes |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Xiaohongshu AppV2SearchImages

**Slug:** `TIK_HUB_XIAOHONGSHU_APP_V2_SEARCH_IMAGES`

Search Xiaohongshu image notes and return typed note, image, author, and engagement fields with pagination identifiers.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | 页码，从1开始/Page number, start from 1 |
| `source` | string | No | 来源/Source |
| `keyword` | string | Yes | 搜索关键词/Search keyword |
| `search_id` | string | No | 搜索ID，翻页时传入首次搜索返回的值/Search ID for pagination |
| `word_request_id` | string | No | 词请求ID，翻页时传入首次搜索返回的值/Word request ID for pagination |
| `search_pagination_context` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Xiaohongshu AppV2SearchUsers

**Slug:** `TIK_HUB_XIAOHONGSHU_APP_V2_SEARCH_USERS`

Read the documented TikHub Xiaohongshu-App-V2-API data from the fixed /api/v1/xiaohongshu/app_v2/search_users endpoint.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | 页码，从1开始/Page number, start from 1 |
| `source` | string | No | 来源/Source |
| `keyword` | string | Yes | 搜索关键词/Search keyword |
| `search_id` | string | No | 搜索ID，翻页时传入首次搜索返回的值/Search ID for pagination |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Xiaohongshu Web V3 Fetch Homefeed

**Slug:** `TIK_HUB_XIAOHONGSHU_WEB_V3_FETCH_HOMEFEED`

Call the fixed TikHub GET /api/v1/xiaohongshu/web_v3/fetch_homefeed operation and return only its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `num` | integer | No | Number of results, max 40. |
| `category` | string | No | Category channel ID. |
| `cursor_score` | string | No | Pagination cursor. |
| `need_filter_image` | boolean | No | Image notes only. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Xiaohongshu Web V3 Fetch Homefeed Categories

**Slug:** `TIK_HUB_XIAOHONGSHU_WEB_V3_FETCH_HOMEFEED_CATEGORIES`

Call the fixed TikHub GET /api/v1/xiaohongshu/web_v3/fetch_homefeed_categories operation and return only its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Xiaohongshu Web V3 Fetch Search Suggest

**Slug:** `TIK_HUB_XIAOHONGSHU_WEB_V3_FETCH_SEARCH_SUGGEST`

Call the fixed TikHub GET /api/v1/xiaohongshu/web_v3/fetch_search_suggest operation and return only its validated data projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `keyword` | string | No | Keyword (optional). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch User Info

**Slug:** `TIK_HUB_XIAOHONGSHU_WEB_V3_FETCH_USER_INFO`

Fetch Xiaohongshu user information through TikHub's Xiaohongshu-Web-V3-API surface. Returns only the evidence-backed response contract.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.01 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | 用户ID/User ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Xigua App V2 Fetch One Video Play Url

**Slug:** `TIK_HUB_XIGUA_APP_V2_FETCH_ONE_VIDEO_PLAY_URL`

Fetch One Video Play Url on Xigua Video through TikHub's Xigua-App-V2 surface. This action is limited to fetch one video play url and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | string | Yes | Video id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Xigua App V2 Fetch User Info

**Slug:** `TIK_HUB_XIGUA_APP_V2_FETCH_USER_INFO`

Fetch User Info on Xigua Video through TikHub's Xigua-App-V2 surface. This action is limited to fetch user info and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | User id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### YouTube WebGetChannelInfo

**Slug:** `TIK_HUB_YOUTUBE_WEB_GET_CHANNEL_INFO`

Get Channel Info on YouTube through TikHub's YouTube-Web surface. This action is limited to get channel info and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel_id` | string | Yes | 频道ID/Channel ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### YouTube WebGetChannelShortVideos

**Slug:** `TIK_HUB_YOUTUBE_WEB_GET_CHANNEL_SHORT_VIDEOS`

Get Channel Short Videos on YouTube through TikHub's YouTube-Web surface. This action is limited to get channel short videos and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel_id` | string | Yes | 频道ID/Channel ID |
| `continuation_token` | string | No | 翻页令牌/Pagination token |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### YouTube WebGetChannelUrl

**Slug:** `TIK_HUB_YOUTUBE_WEB_GET_CHANNEL_URL`

Get Channel Url on YouTube through TikHub's YouTube-Web surface. This action is limited to get channel url and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel_id` | string | Yes | 频道ID/Channel ID (格式如：UCeu6U67OzJhV1KwBansH3Dg) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### YouTube WebGetRelateVideo

**Slug:** `TIK_HUB_YOUTUBE_WEB_GET_RELATE_VIDEO`

Get Relate Video on YouTube through TikHub's YouTube-Web surface. This action is limited to get relate video and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `video_id` | string | Yes | 视频ID/Video ID |
| `continuation_token` | string | No | 翻页令牌/Pagination token |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trending Videos

**Slug:** `TIK_HUB_YOUTUBE_WEB_GET_TRENDING_VIDEOS`

Get trending YouTube videos through TikHub's exact reviewed provider route.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `section` | string | No | 类型/Section |
| `country_code` | string | No | 国家代码/Country code |
| `language_code` | string | No | 语言代码/Language code |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Resolve YouTube Channel ID By Name

**Slug:** `TIK_HUB_YOUTUBE_WEB_RESOLVE_CHANNEL_ID_BY_NAME`

Resolve a YouTube channel ID from a channel name. The URL variant instead parses supported channel URL formats and returns normalization metadata.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel_name` | string | Yes | 频道名称/Channel name |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Resolve YouTube Channel ID By URL

**Slug:** `TIK_HUB_YOUTUBE_WEB_RESOLVE_CHANNEL_ID_BY_URL`

Resolve a YouTube channel ID from an @handle, /channel/, /c/, or /user/ URL and return URL normalization metadata. The name variant resolves by channel name.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel_url` | string | Yes | 频道URL/Channel URL，支持多种格式如：https://www.youtube.com/@username, https://www.youtube.com/channel/UCxxxxxx, https://www.youtube.com/c/channelname |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### YouTube WebSearchChannel

**Slug:** `TIK_HUB_YOUTUBE_WEB_SEARCH_CHANNEL`

Search Channel on YouTube through TikHub's YouTube-Web surface. This action is limited to search channel and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel_id` | string | Yes | 频道ID/Channel ID |
| `country_code` | string | No | 国家代码/Country code |
| `search_query` | string | Yes | 搜索关键字/Search keyword |
| `language_code` | string | No | 语言代码/Language code |
| `continuation_token` | string | No | 翻页令牌/Pagination token |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### YouTube WebSearchVideo

**Slug:** `TIK_HUB_YOUTUBE_WEB_SEARCH_VIDEO`

Search Video on YouTube through TikHub's YouTube-Web surface. This action is limited to search video and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_by` | string | No | 排序方式/Order by |
| `country_code` | string | No | 国家代码/Country code |
| `search_query` | string | Yes | 搜索关键字/Search keyword |
| `language_code` | string | No | 语言代码/Language code |
| `continuation_token` | string | No | 翻页令牌/Pagination token |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Youtube Web V2 Get Channel Community Posts

**Slug:** `TIK_HUB_YOUTUBE_WEB_V2_GET_CHANNEL_COMMUNITY_POSTS`

Get Channel Community Posts on YouTube through TikHub's YouTube-Web-V2 surface. This action is limited to get channel community posts and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel_id` | string | Yes | Channel ID |
| `need_format` | boolean | No | Whether to clean and format the data |
| `country_code` | string | No | Country code |
| `language_code` | string | No | Language code |
| `continuation_token` | string | No | Pagination token for next page |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Youtube Web V2 Get Channel Description

**Slug:** `TIK_HUB_YOUTUBE_WEB_V2_GET_CHANNEL_DESCRIPTION`

Get Channel Description on YouTube through TikHub's YouTube-Web-V2 surface. This action is limited to get channel description and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel_id` | string | No | Channel ID, can be obtained from channel URL via get_channel_id endpoint |
| `need_format` | boolean | No | Whether to clean and format the data |
| `country_code` | string | No | Country code |
| `language_code` | string | No | Language code |
| `continuation_token` | string | No | Continuation token for getting advanced info like channel creation date |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Youtube Web V2 Get Channel Id

**Slug:** `TIK_HUB_YOUTUBE_WEB_V2_GET_CHANNEL_ID`

Get Channel Id on YouTube through TikHub's YouTube-Web-V2 surface. This action is limited to get channel id and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel_url` | string | Yes | channelname |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Youtube Web V2 Get Channel Shorts

**Slug:** `TIK_HUB_YOUTUBE_WEB_V2_GET_CHANNEL_SHORTS`

Get Channel Shorts on YouTube through TikHub's YouTube-Web-V2 surface. This action is limited to get channel shorts and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel_id` | string | No | Channel ID (e.g., UCuAXFkgsw1L7xaCfnd5JJOw) |
| `channel_url` | string | No | Ignored if channel_id is provided) |
| `need_format` | boolean | No | Whether to format data |
| `continuation_token` | string | No | Omit for the first page. Reuse data.continuation_token while data.has_more is true; stop when false. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Youtube Web V2 Get Channel Url

**Slug:** `TIK_HUB_YOUTUBE_WEB_V2_GET_CHANNEL_URL`

Get Channel Url on YouTube through TikHub's YouTube-Web-V2 surface. This action is limited to get channel url and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel_id` | string | Yes | ID/Channel ID ( UCeu6U67OzJhV1KwBansH3Dg) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Youtube Web V2 Get Channel Videos

**Slug:** `TIK_HUB_YOUTUBE_WEB_V2_GET_CHANNEL_VIDEOS`

Get Channel Videos on YouTube through TikHub's YouTube-Web-V2 surface. This action is limited to get channel videos and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel_id` | string | Yes | Channel ID |
| `need_format` | boolean | No | Whether to clean and format the data |
| `country_code` | string | No | Country code |
| `language_code` | string | No | Language code |
| `continuation_token` | string | No | Pagination token for next page |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### General Search V2

**Slug:** `TIK_HUB_YOUTUBE_WEB_V2_GET_GENERAL_SEARCH_V2`

Run a general YouTube search through TikHub's exact reviewed V2 provider route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.002 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("video" | "channel" | "playlist" | "movie") | No | 类型过滤/Type filter |
| `keyword` | string | No | 搜索关键词（首次请求必填）/Search keyword (required for first request) |
| `sort_by` | string ("relevance" | "upload_date" | "view_count" | "rating") | No | 排序方式/Sort by |
| `duration` | string ("short" | "medium" | "long") | No | 时长过滤/Duration filter: short (<4min), medium (4-20min), long (>20min) |
| `features` | string | No | 特性过滤（逗号分隔）/Feature filter (comma separated): live, 4k, hd, subtitles, creative_commons, 360, vr180, 3d, hdr |
| `upload_date` | string ("last_hour" | "today" | "this_week" | "this_month" | "this_year") | No | 上传时间过滤/Upload date filter |
| `continuation_token` | string | No | 分页token，用于获取下一页/Continuation token for next page |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Youtube Web V2 Get Post Comments

**Slug:** `TIK_HUB_YOUTUBE_WEB_V2_GET_POST_COMMENTS`

Get Post Comments on YouTube through TikHub's YouTube-Web-V2 surface. This action is limited to get post comments and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `post_id` | string | No | Post ID (required for first request) |
| `need_format` | boolean | No | Whether to clean and format the data |
| `country_code` | string | No | Country code |
| `language_code` | string | No | Language code |
| `continuation_token` | string | No | Omit for the first page. Reuse data.continuation_token; stop when that field is absent or empty. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Youtube Web V2 Get Post Detail

**Slug:** `TIK_HUB_YOUTUBE_WEB_V2_GET_POST_DETAIL`

Get Post Detail on YouTube through TikHub's YouTube-Web-V2 surface. This action is limited to get post detail and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `post_id` | string | Yes | Post ID |
| `need_format` | boolean | No | Whether to clean and format the data |
| `country_code` | string | No | Country code |
| `language_code` | string | No | Language code |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Youtube Web V2 Get Related Videos

**Slug:** `TIK_HUB_YOUTUBE_WEB_V2_GET_RELATED_VIDEOS`

Get Related Videos on YouTube through TikHub's YouTube-Web-V2 surface. This action is limited to get related videos and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `video_id` | string | No | Video ID |
| `video_url` | string | No | Ignored if video_id is provided) |
| `need_format` | boolean | No | Whether to format data. true: return formatted structured data, false: return raw API structure |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Rich YouTube Video Info

**Slug:** `TIK_HUB_YOUTUBE_WEB_V2_GET_RICH_VIDEO_INFO`

Fetch the richer raw YouTube video detail payload, including playerResponse and initialData. This has more ancillary fields than the stable extractor but can be less reliable for restricted or music videos.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `video_id` | string | Yes | Video ID |
| `need_format` | boolean | No | Whether to clean and format the data |
| `language_code` | string | No | Language code |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Youtube Web V2 Get Search Suggestions

**Slug:** `TIK_HUB_YOUTUBE_WEB_V2_GET_SEARCH_SUGGESTIONS`

Get Search Suggestions on YouTube through TikHub's YouTube-Web-V2 surface. This action is limited to get search suggestions and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `region` | string | No | Region code (e.g., US, SG, CN, JP) |
| `keyword` | string | Yes | Search keyword |
| `language` | string | No | Language code (e.g., en, zh-cn, ja) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Shorts Search V2

**Slug:** `TIK_HUB_YOUTUBE_WEB_V2_GET_SHORTS_SEARCH_V2`

Search YouTube Shorts through TikHub's exact reviewed V2 provider route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.002 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `keyword` | string | No | 搜索关键词（首次请求必填）/Search keyword (required for first request) |
| `sort_by` | string ("relevance" | "upload_date" | "view_count" | "rating") | No | 排序方式/Sort by |
| `upload_date` | string ("last_hour" | "today" | "this_week" | "this_month" | "this_year") | No | 上传时间过滤/Upload date filter |
| `continuation_token` | string | No | 分页token，用于获取下一页/Continuation token for next page |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Youtube Web V2 Get Signed Stream Url

**Slug:** `TIK_HUB_YOUTUBE_WEB_V2_GET_SIGNED_STREAM_URL`

Get Signed Stream Url on YouTube through TikHub's YouTube-Web-V2 surface. This action is limited to get signed stream url and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `itag` | integer | Yes | Format identifier itag (obtained from get_video_streams endpoint) |
| `video_id` | string | No | Video ID |
| `video_url` | string | No | Ignored if video_id is provided) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Stable YouTube Video Info

**Slug:** `TIK_HUB_YOUTUBE_WEB_V2_GET_STABLE_VIDEO_INFO`

Fetch normalized YouTube video details through TikHub's more stable alternate extractor. Use this when the rich extractor has empty core fields; it omits some ancillary fields.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `video_id` | string | No | Video ID |
| `video_url` | string | No | URL/Video URL ( video_id ) |
| `need_format` | boolean | No | Whether to return cleaned payload |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Youtube Web V2 Get Video Comments

**Slug:** `TIK_HUB_YOUTUBE_WEB_V2_GET_VIDEO_COMMENTS`

Get Video Comments on YouTube through TikHub's YouTube-Web-V2 surface. This action is limited to get video comments and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort_by` | string ("top" | "newest") | No | &#124; Sort by |
| `video_id` | string | Yes | Video ID |
| `need_format` | boolean | No | Whether to clean and format the data |
| `country_code` | string | No | Country code |
| `language_code` | string | No | Language code |
| `continuation_token` | string | No | Omit for the first page. Reuse data.continuation_token; stop when that field is absent or empty. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Playable YouTube Video Streams

**Slug:** `TIK_HUB_YOUTUBE_WEB_V2_LIST_PLAYABLE_VIDEO_STREAMS`

List YouTube stream formats with decrypted playback URLs for every format. This costs more, takes longer, and returns links that expire after about six hours.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.004 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `video_id` | string | No | Video ID |
| `video_url` | string | No | Ignored if video_id is provided) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List YouTube Video Stream Formats

**Slug:** `TIK_HUB_YOUTUBE_WEB_V2_LIST_VIDEO_STREAM_FORMATS`

List YouTube stream formats and metadata without playable URLs. Use the signed-stream tool for one selected format; use the playable-stream variant when all decrypted URLs are needed.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `video_id` | string | No | Video ID |
| `video_url` | string | No | Ignored if video_id is provided) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Youtube Web V2 Search Channels

**Slug:** `TIK_HUB_YOUTUBE_WEB_V2_SEARCH_CHANNELS`

Search Channels on YouTube through TikHub's YouTube-Web-V2 surface. This action is limited to search channels and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `keyword` | string | No | Search keyword |
| `need_format` | boolean | No | Whether to format data |
| `continuation_token` | string | No | Omit for the first page. Committed response evidence has no continuation token to reuse, so only manual one-page retrieval is supported. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Zhihu AI Search (v2)

**Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_AI_SEARCH_STREAM`

Run Zhihu AI Search V2 through TikHub's exact reviewed provider route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.005 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `chat_mode` | string | No | 对话模式/Chat mode |
| `session_id` | string | No | 会话ID/Session ID |
| `message_content` | string | Yes | 搜索内容/Search Content |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Zhihu Web Fetch Column Article Detail

**Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_COLUMN_ARTICLE_DETAIL`

Fetch Column Article Detail on Zhihu through TikHub's Zhihu-Web surface. This action is limited to fetch column article detail and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `article_id` | string | Yes | Article ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Zhihu Web Fetch Column Articles

**Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_COLUMN_ARTICLES`

Fetch Column Articles on Zhihu through TikHub's Zhihu-Web surface. This action is limited to fetch column articles and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | Number of articles per page. |
| `offset` | string | No | Use '0' for the first page. Committed response evidence has no continuation offset or stop flag, so only manual one-page retrieval is supported. |
| `column_id` | string | Yes | Column ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Zhihu Web Fetch Column Comment Config

**Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_COLUMN_COMMENT_CONFIG`

Fetch Column Comment Config on Zhihu through TikHub's Zhihu-Web surface. This action is limited to fetch column comment config and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `article_id` | string | Yes | Article ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Zhihu Web Fetch Column Recommend

**Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_COLUMN_RECOMMEND`

Fetch Column Recommend on Zhihu through TikHub's Zhihu-Web surface. This action is limited to fetch column recommend and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | Number of columns per page. |
| `offset` | string | No | Use '0' for the first page. Committed response evidence has no continuation offset or stop flag, so only manual one-page retrieval is supported. |
| `article_id` | string | Yes | Article ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Zhihu Web Fetch Column Relationship

**Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_COLUMN_RELATIONSHIP`

Fetch Column Relationship on Zhihu through TikHub's Zhihu-Web surface. This action is limited to fetch column relationship and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `article_id` | string | Yes | Article ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Zhihu Column Search V3

**Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_COLUMN_SEARCH_V3`

Search Zhihu columns through TikHub's exact reviewed V3 provider route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | 每页专栏数量/Number of columns per page |
| `offset` | string | No | 偏移量/Offset |
| `keyword` | string | Yes | 搜索关键词/Search Keywords |
| `search_hash_id` | string | No | 搜索哈希ID/Search Hash ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Zhihu Hot List

**Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_HOT_LIST`

Get the current Zhihu home-page hot list through TikHub.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | Maximum hot-list entries to request. |
| `desktop` | string | No | Whether to request the desktop hot-list layout. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Zhihu Web Fetch Preset Search

**Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_PRESET_SEARCH`

Fetch Preset Search on Zhihu through TikHub's Zhihu-Web surface. This action is limited to fetch preset search and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Zhihu Web Fetch Question Answers

**Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_QUESTION_ANSWERS`

Fetch Question Answers on Zhihu through TikHub's Zhihu-Web surface. This action is limited to fetch question answers and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of answers per page. |
| `order` | string | No | Sort order: default=default sort, updated=sort by time. |
| `cursor` | string | No | Pagination cursor. |
| `offset` | integer | No | Use 0 for the first page. Committed response evidence has no continuation offset or stop flag, so only manual one-page retrieval is supported. |
| `question_id` | string | Yes | Question ID. |
| `pagination_context` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Zhihu Web Fetch Question Detail

**Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_QUESTION_DETAIL`

Fetch Question Detail on Zhihu through TikHub's Zhihu-Web surface. This action is limited to fetch question detail and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `question_id` | string | Yes | Question ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Zhihu Web Fetch Recommend Followees

**Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_RECOMMEND_FOLLOWEES`

Fetch Recommend Followees on Zhihu through TikHub's Zhihu-Web surface. This action is limited to fetch recommend followees and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Zhihu Salt Search V3

**Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_SALT_SEARCH_V3`

Search Zhihu Salt premium content through TikHub's exact reviewed V3 provider route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | 每页内容数量/Number of contents per page |
| `offset` | string | No | 偏移量/Offset |
| `keyword` | string | Yes | 搜索关键词/Search Keywords |
| `search_hash_id` | string | No | 搜索哈希ID/Search Hash ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Zhihu Scholar Search V3

**Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_SCHOLAR_SEARCH_V3`

Search Zhihu Scholar papers through TikHub's exact reviewed V3 provider route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | 每页论文数量/Number of papers per page |
| `offset` | string | No | 偏移量/Offset |
| `keyword` | string | Yes | 搜索关键词/Search Keywords |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Zhihu Search Recommend

**Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_SEARCH_RECOMMEND`

Get Zhihu search recommendations through TikHub's exact reviewed provider route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Zhihu Web Fetch Search Suggest

**Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_SEARCH_SUGGEST`

Fetch Search Suggest on Zhihu through TikHub's Zhihu-Web surface. This action is limited to fetch search suggest and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `keyword` | string | Yes | Search Keywords. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Zhihu Topic Search V3

**Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_TOPIC_SEARCH_V3`

Search Zhihu topics through TikHub's exact reviewed V3 provider route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | 每页话题数量/Number of topics per page |
| `offset` | string | No | 偏移量/Offset |
| `keyword` | string | Yes | 搜索关键词/Search Keywords |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Zhihu User Created Collections

**Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_USER_COLLECTIONS`

Get collections created by a Zhihu user through TikHub's exact reviewed provider route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | 每页收藏夹数量/Number of collections per page |
| `offset` | string | No | 偏移量/Offset |
| `user_url_token` | string | Yes | 用户ID/User ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Zhihu User Follow Collections

**Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_USER_FOLLOW_COLLECTIONS`

Get collections followed by a Zhihu user through TikHub's exact reviewed provider route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | 每页收藏数量/Number of collections per page |
| `offset` | string | No | 偏移量/Offset |
| `user_url_token` | string | Yes | 用户ID/User ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Zhihu User Columns

**Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_USER_FOLLOW_COLUMNS`

Get columns followed by a Zhihu user through TikHub's exact reviewed provider route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | 每页专栏数量/Number of columns per page |
| `offset` | string | No | 偏移量/Offset |
| `user_url_token` | string | Yes | 用户ID/User ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Zhihu User Following

**Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_USER_FOLLOWEES`

Get users followed by a Zhihu user through TikHub's exact reviewed provider route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | 每页用户数量/Number of users per page |
| `offset` | string | No | 偏移量/Offset |
| `user_url_token` | string | Yes | 用户ID/User ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Zhihu Web Fetch User Followers

**Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_USER_FOLLOWERS`

Fetch User Followers on Zhihu through TikHub's Zhihu-Web surface. This action is limited to fetch user followers and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | Number of users per page. |
| `offset` | string | No | Use '0' for the first page. Committed response evidence exposes only paging.totals, not a continuation offset or stop flag, so only manual one-page retrieval is supported. |
| `user_url_token` | string | Yes | User ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Zhihu User Follow Topics

**Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_USER_FOLLOW_TOPICS`

Get topics followed by a Zhihu user through TikHub's exact reviewed provider route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | 每页话题数量/Number of topics per page |
| `offset` | string | No | 偏移量/Offset |
| `user_url_token` | string | Yes | 用户ID/User ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Zhihu Web Fetch User Included Articles

**Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_USER_INCLUDED_ARTICLES`

Fetch User Included Articles on Zhihu through TikHub's Zhihu-Web surface. This action is limited to fetch user included articles and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | Number of articles per page. |
| `offset` | string | No | Use '0' for the first page. Committed response evidence exposes only paging.totals, not a continuation offset or stop flag, so only manual one-page retrieval is supported. |
| `user_url_token` | string | Yes | User ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Zhihu Web Fetch User Info

**Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_USER_INFO`

Fetch User Info on Zhihu through TikHub's Zhihu-Web surface. This action is limited to fetch user info and returns its validated typed projection.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_url_token` | string | Yes | User ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Zhihu User Search V3

**Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_USER_SEARCH_V3`

Search Zhihu users through TikHub's exact reviewed V3 provider route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | 每页用户数量/Number of users per page |
| `offset` | string | No | 偏移量/Offset |
| `keyword` | string | Yes | 搜索关键词/Search Keywords |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Zhihu User Segments

**Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_USER_SEGMENTS`

Get text segments highlighted by a Zhihu user through TikHub's exact reviewed provider route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | 每页数量/Number per page |
| `offset` | string | No | 偏移量/Offset |
| `content_type` | string | No | 内容类型/Content type |
| `user_url_token` | string | Yes | 用户 member hash id (非 url_token)/User member hash id (not url_token) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Zhihu Video List

**Slug:** `TIK_HUB_ZHIHU_WEB_FETCH_VIDEO_LIST`

Get the Zhihu homepage video ranking through TikHub's exact reviewed provider route.

**Instant:** Supported on the latest version.

**Instant pricing:** Estimated $0.001 per request

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | 每页视频数量/Number of videos per page |
| `offset` | string | No | 偏移量/Offset |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |