TikTok for Developers

开发者文档

上次更新时间:2026年9月1日

查询用户置顶视频

创建查询任务

查询

查询参数

Key

类型

描述

示例

是否必填

category

字符串 (String)

需要分析的数据类别。

pinned_videos


是

condition_groups

对象 (Object)


指定要返回和处理的数据。

注意:username 是唯一可查询的参数。eq 是唯一运算符。


condition_groups = [

{

"operator": "and",

"conditions": [

{

"field": "username",

"operator": "eq",

"field_values": ["test user"]

}

]

}

]

是


fields


字符串 (String)


需返回的数据字段。接口将只返回此处列出的字段。

id, create_time, username, region_code, video_description, music_id, like_count, comment_count, share_count, view_count, hashtag_names, is_stem_verified, favorites_count, hashtag_info_list, effect_info_list, sticker_info_list, video_label, video_mention_list, video_tag


是

limit


整数 (int)

返回的最大记录数。

测试阶段

默认值为 100。

执行阶段

默认值为 1000。

200


否

查询条件

Key

类型

描述

是否必填

and

list<Condition>

and 条件规定查询结果必须满足列表中的所有条件。

否

or

list<Condition>

or 条件规定查询结果必须满足至少一个列表中的条件。

否

not


list<Condition>

not 条件规定查询结果不能符合任何列表中的条件。

否

响应

Key

类型

描述

示例

task_id

整数 (int)


数据查询任务的 ID。

12345


查看查询任务状态

查询参数

Key

类型

描述

示例

是否必填

task_id


整数 (int)

数据查询任务的 ID。

12345

是

响应

Key

类型

描述

示例

是否必填

status


字符串 (String)


数据查询任务的状态。


Created

AnalysisFailed

Processing

Completed

Cancelled

Validating

是

查看查询任务示例代码

示例

status = client.check_query_task_status(task_id)

取消查询任务

查询参数

Key

类型

描述

示例

是否必填

task_id

整数 (int)

数据查询任务的 ID。

12345

是

响应

Key

类型

描述

示例

success


布尔值 (Boolean)


表示请求是否已成功取消。


True


取消查询任务示例代码

示例

result = client.cancel_query_task(task_id)

获取查询任务结果

查询参数

Key

类型

描述

示例

是否必填

task_id

整数 (int)

数据查询任务的 ID。

12345

是

响应

Key

类型

描述

示例

result


字符串 (String)


查询任务返回的数据字段。接口将只返回此处列出的字段。

id, create_time, username, region_code, video_description, music_id, like_count, comment_count, share_count, view_count, hashtag_names, is_stem_verified, favorites_count, hashtag_info_list, effect_info_list, sticker_info_list, video_label, video_mention_list, video_tag, video_duration


获取查询任务示例代码

示例

data = client.get_query_task_result(task_id)

通过 SDK 从 TikTok 查询置顶视频数据

示例代码

from pyrqs import rqs
import time
from datetime import datetime, timedelta
import json
category = 'pinned_videos'
fields = 'id,create_time,username,region_code,video_description,music_id,like_count,comment_count,share_count,view_count,hashtag_names,is_stem_verified,favorites_count'
limit = 60
client = rqs.RQSClient()
condition_groups = [
        {
            "operator": "and",
            "conditions": [
                {
                    "field": "username",
                    "operator": "EQ",
                    "field_values": ["test_user"] #enter a valid user name
                }
            ]
        }
]
data = client.query(category=category, fields = fields, condition_groups=condition_groups, limit=limit)
print(data)


TikTok for Developers