获取话题搜索 V2/Fetch hashtag search V2
OpenAPI Specification
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v1/douyin/search/fetch_challenge_search_v2:
post:
summary: 获取话题搜索 V2/Fetch hashtag search V2
deprecated: false
description: >-
# [中文]
### 用途:
- 获取抖音 App 中话题(挑战/标签)搜索的结果,使用 V2 版本 API。
- 支持关键词搜索,返回匹配的话题详情,包括话题名称、话题封面、浏览量、参与人数等。
### 备注:
- 本接口专注于搜索话题(Challenge/Hashtag)内容,不包含视频或直播等其他类型。
- 初次请求时 `cursor` 传入 0,`search_id` 传空字符串,后续翻页请使用上一次返回的 `cursor` 和
`search_id`。
### 参数:
- keyword: 搜索关键词,如 "游戏"
- cursor: 翻页游标(首次请求传 0,翻页时使用上次响应的 cursor)
- sort_type: 排序方式
- `0`: 综合排序
- `1`: 最多点赞
- `2`: 最新发布
- publish_time: 发布时间筛选
- `0`: 不限
- `1`: 最近一天
- `7`: 最近一周
- `180`: 最近半年
- filter_duration: 视频时长筛选
- `0`: 不限
- `0-1`: 1 分钟以内
- `1-5`: 1-5 分钟
- `5-10000`: 5 分钟以上
- content_type: 内容类型筛选
- `0`: 不限
- `1`: 视频
- `2`: 图片
- `3`: 文章
- search_id: 搜索ID(分页时使用)
### 请求体示例:
```json
payload = {
"keyword": "游戏",
"cursor": 0,
"sort_type": "0",
"publish_time": "0",
"filter_duration": "0",
"content_type": "0",
"search_id": ""
}
```
### 返回(部分常用字段,实际返回字段更多,一切以实际响应为准):
- `business_data`(话题搜索结果列表)
- `data_id`: 结果的唯一编号
- `type`: 数据类型(固定为 `2`)
- `data.challenge_info`:
- `cid`: 话题ID
- `cha_name`: 话题名称
- `desc`: 话题描述
- `schema`: 话题跳转链接(aweme://开头,可跳转抖音 App 内话题详情)
- `hashtag_profile`: 话题封面图 URL
- `user_count`: 参与人数
- `view_count`: 话题浏览量
- `challenge_status`: 话题状态(1=正常,其他=异常)
- `author`: 创建者信息
- `uid`: 创建者抖音用户ID
- `nickname`: 昵称
- `avatar_thumb.url_list`: 缩略头像URL列表
- `is_verified`: 是否认证
- `follower_count`: 粉丝数
- `share_info`:
- `share_url`: 话题分享链接
- `share_title`: 分享标题
- `share_desc`: 分享描述
# [English]
### Purpose:
- Fetch hashtag/challenge search results from Douyin App using V2 API.
- Supports searching by keyword and returns detailed challenge
information, including name, cover image, view count, and participant
count.
### Notes:
- This API focuses on searching challenges (hashtags), not including
videos or live streams.
- Set `cursor` to 0 and `search_id` to an empty string for the first
request. For pagination, use the cursor and search_id from the last
response.
### Parameters:
- keyword: Search keyword, e.g., "game"
- cursor: Pagination cursor (0 for first request)
- sort_type: Sorting method
- `0`: Comprehensive
- `1`: Most likes
- `2`: Latest
- publish_time: Publish time filter
- `0`: Unlimited
- `1`: Last day
- `7`: Last week
- `180`: Last half year
- filter_duration: Video duration filter
- `0`: Unlimited
- `0-1`: Under 1 minute
- `1-5`: 1-5 minutes
- `5-10000`: Over 5 minutes
- content_type: Content type filter
- `0`: Unlimited
- `1`: Video
- `2`: Image
- `3`: Article
- search_id: Search ID for pagination
### Request Body Example:
```json
payload = {
"keyword": "game",
"cursor": 0,
"sort_type": "0",
"publish_time": "0",
"filter_duration": "0",
"content_type": "0",
"search_id": ""
}
```
### Response (common fields, actual response may contain more fields):
- `business_data` (list of hashtag search results)
- `data_id`: Unique identifier for the result
- `type`: Data type (fixed `2`)
- `data.challenge_info`:
- `cid`: Challenge ID
- `cha_name`: Challenge name
- `desc`: Challenge description
- `schema`: Challenge detail schema link (aweme:// schema, used to deep link inside Douyin App)
- `hashtag_profile`: URL of the hashtag cover image
- `user_count`: Number of participants
- `view_count`: Number of views
- `challenge_status`: Status (1 = active, others = abnormal)
- `author`: Creator info
- `uid`: User ID
- `nickname`: Nickname
- `avatar_thumb.url_list`: Thumbnail avatar URLs
- `is_verified`: Whether the creator is verified
- `follower_count`: Number of followers
- `share_info`:
- `share_url`: Shareable URL
- `share_title`: Title for sharing
- `share_desc`: Description for sharing
operationId: >-
fetch_challenge_search_v2_api_v1_douyin_search_fetch_challenge_search_v2_post
tags:
- Douyin-Search-API
- Douyin-Search-API
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChallengeSearchV2Request'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseModel'
headers: {}
x-apifox-name: OK
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
headers: {}
x-apifox-name: Unprocessable Entity
security:
- HTTPBearer: []
x-apifox:
schemeGroups:
- id: SIQeOLsUJKaeHNmk5wuqU
schemeIds:
- HTTPBearer
required: true
use:
id: SIQeOLsUJKaeHNmk5wuqU
scopes:
SIQeOLsUJKaeHNmk5wuqU:
HTTPBearer: []
x-apifox-folder: Douyin-Search-API
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/4705614/apis/api-370212794-run
components:
schemas:
ChallengeSearchV2Request:
properties:
keyword:
type: string
title: Keyword
description: 关键词 / Keyword
default: 猫咪
cursor:
type: integer
title: Cursor
description: >-
偏移游标,用于翻页,从上一次请求返回的响应中获取 / Offset cursor for pagination, obtained
from the last response
default: 0
sort_type:
type: string
title: Sort Type
description: >-
排序方式:0=综合排序 1=最多点赞 2=最新发布 / Sort type: 0=Comprehensive, 1=Most
Likes, 2=Latest
default: '0'
publish_time:
type: string
title: Publish Time
description: >-
发布时间筛选:0=不限 1=最近一天 7=最近一周 180=最近半年 / Publish time filter:
0=Unlimited, 1=Last day, 7=Last week, 180=Last half year
default: '0'
filter_duration:
type: string
title: Filter Duration
description: >-
视频时长过滤:0=不限 0-1=一分钟以内 1-5=一到五分钟 5-10000=五分钟以上 / Video duration
filter: 0=Unlimited, 0-1=Within 1 minute, 1-5=1 to 5 minutes,
5-10000=More than 5 minutes
default: '0'
content_type:
type: string
title: Content Type
description: >-
内容类型:0=不限 1=视频 2=图片 3=文章 / Content type: 0=All, 1=Video, 2=Picture,
3=Article
default: '0'
search_id:
type: string
title: Search Id
description: >-
搜索ID,用于翻页,从上一次请求返回的响应中获取 / Search ID for pagination, obtained from
the last response
default: ''
backtrace:
type: string
title: Backtrace
description: >-
翻页回溯标识,用于翻页,从上一次请求返回的响应中获取 / Backtrace for pagination, obtained from
the last response
default: ''
type: object
title: ChallengeSearchV2Request
x-apifox-orders:
- keyword
- cursor
- sort_type
- publish_time
- filter_duration
- content_type
- search_id
- backtrace
x-apifox-ignore-properties: []
x-apifox-folder: ''
ResponseModel:
properties:
code:
type: integer
title: Code
description: HTTP status code | HTTP状态码
default: 200
request_id:
anyOf:
- type: string
- type: 'null'
title: Request Id
description: Unique request identifier | 唯一请求标识符
message:
type: string
title: Message
description: Response message (EN-US) | 响应消息 (English)
default: Request successful. This request will incur a charge.
message_zh:
type: string
title: Message Zh
description: Response message (ZH-CN) | 响应消息 (中文)
default: 请求成功,本次请求将被计费。
support:
type: string
title: Support
description: Support message | 支持消息
default: 'Discord: https://discord.gg/aMEAS8Xsvz'
time:
type: string
title: Time
description: The time the response was generated | 生成响应的时间
time_stamp:
type: integer
title: Time Stamp
description: The timestamp the response was generated | 生成响应的时间戳
time_zone:
type: string
title: Time Zone
description: The timezone of the response time | 响应时间的时区
default: America/Los_Angeles
docs:
anyOf:
- type: string
- type: 'null'
title: Docs
description: >-
Link to the API Swagger documentation for this endpoint | 此端点的 API
Swagger 文档链接
cache_message:
anyOf:
- type: string
- type: 'null'
title: Cache Message
description: Cache message (EN-US) | 缓存消息 (English)
default: >-
This request will be cached. You can access the cached result
directly using the URL below, valid for 24 hours. Accessing the
cache will not incur additional charges.
cache_message_zh:
anyOf:
- type: string
- type: 'null'
title: Cache Message Zh
description: Cache message (ZH-CN) | 缓存消息 (中文)
default: 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。
cache_url:
anyOf:
- type: string
- type: 'null'
title: Cache Url
description: The URL to access the cached result | 访问缓存结果的 URL
router:
type: string
title: Router
description: The endpoint that generated this response | 生成此响应的端点
default: ''
params:
type: string
data:
anyOf:
- type: string
- type: 'null'
title: Data
description: The response data | 响应数据
type: object
title: ResponseModel
x-apifox-orders:
- code
- request_id
- message
- message_zh
- support
- time
- time_stamp
- time_zone
- docs
- cache_message
- cache_message_zh
- cache_url
- router
- params
- data
x-apifox-ignore-properties: []
x-apifox-folder: ''
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
x-apifox-orders:
- detail
x-apifox-ignore-properties: []
x-apifox-folder: ''
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError
x-apifox-orders:
- loc
- msg
- type
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
HTTPBearer:
type: bearer
description: >
----
#### API Token Introduction:
##### Method 1: Use API Token in the Request Header (Recommended)
- **Header**: `Authorization`
- **Format**: `Bearer {token}`
- **Example**: `{"Authorization": "Bearer your_token"}`
- **Swagger UI**: Click on the `Authorize` button in the upper right
corner of the page to enter the API token directly without the `Bearer`
keyword.
##### Method 2: Use API Token in the Cookie (Not Recommended, Use Only
When Method 1 is Unavailable)
- **Cookie**: `Authorization`
- **Format**: `Bearer {token}`
- **Example**: `Authorization=Bearer your_token`
#### Get API Token:
1. Register and log in to your account on the TikHub website.
2. Go to the user center, click on the API token menu, and create an API
token.
3. Copy and use the API token in the request header.
4. Keep your API token confidential and use it only in the request
header.
----
#### API令牌简介:
##### 方法一:在请求头中使用API令牌(推荐)
- **请求头**: `Authorization`
- **格式**: `Bearer {token}`
- **示例**: `{"Authorization": "Bearer your_token"}`
- **Swagger UI**: 点击页面右上角的`Authorize`按钮,直接输入API令牌,不需要`Bearer`关键字。
##### 方法二:在Cookie中使用API令牌(不推荐,仅在无法使用方法一时使用)
- **Cookie**: `Authorization`
- **格式**: `Bearer {token}`
- **示例**: `Authorization=Bearer your_token`
#### 获取API令牌:
1. 在TikHub网站注册并登录账户。
2. 进入用户中心,点击API令牌菜单,创建API令牌。
3. 复制并在请求头中使用API令牌。
4. 保密您的API令牌,仅在请求头中使用。
scheme: bearer
servers:
- url: https://api.tikhub.io
description: Production Environment
security: []