← 返回控制台

Local API Documentation

数据检索2.0 API

这是你自己的本地接口文档。接口路径兼容常用 Douyin 路由;默认不调用 TikHub,不登录你的抖音账号,只尝试公开数据。

查看 OpenAPI JSON

认证

如果 `.env` 未设置 OWN_API_TOKEN,本地 API 不需要认证;如果设置了,则请求需携带:

Authorization: Bearer <OWN_API_TOKEN>
# 或
x-api-key: <OWN_API_TOKEN>

GET /api/v1/douyin/web/get_sec_user_id

从抖音公开主页链接、短链或包含 sec_user_id 的文本里解析用户 sec_user_id。

参数必填说明
url抖音用户主页链接 / 分享短链 / 包含 sec_user_id 的文本
curl 'http://localhost:4177/api/v1/douyin/web/get_sec_user_id?url=https://www.douyin.com/user/YOUR_SEC_USER_ID'

GET /api/v1/douyin/app/v3/handler_user_profile

获取指定用户的信息。

参数必填说明
sec_user_id用户 sec_user_id
curl 'http://localhost:4177/api/v1/douyin/app/v3/handler_user_profile?sec_user_id=YOUR_SEC_USER_ID'

GET /api/v1/douyin/app/v3/fetch_user_post_videos

获取用户主页作品数据。

参数必填默认值说明
sec_user_id-用户 sec_user_id
max_cursor0分页游标;下一页用响应中的 max_cursor
count20每页数量,1-20
sort_type00 最新排序,1 最热排序
curl 'http://localhost:4177/api/v1/douyin/app/v3/fetch_user_post_videos?sec_user_id=YOUR_SEC_USER_ID&max_cursor=0&count=20&sort_type=0'

GET /api/v1/douyin/app/v3/fetch_user_metrics

获取达人统计数据:粉丝、总获赞、近 N 天均赞、近 N 天最高点赞作品。

参数必填默认值说明
sec_user_id-用户 sec_user_id
days10统计近 N 天
count20用于分析的作品数量,1-20
curl 'http://localhost:4177/api/v1/douyin/app/v3/fetch_user_metrics?sec_user_id=YOUR_SEC_USER_ID&days=10&count=20'

POST /api/v1/douyin/web/fetch_multi_video

按 TikHub Web 版契约接收顶层作品 ID 字符串数组,最多 50 个;并发读取移动公开视频 SSR 详情和本地缓存。

curl -X POST 'http://localhost:4177/api/v1/douyin/web/fetch_multi_video' \
  -H 'Content-Type: application/json' \
  -d '["AWEME_ID_1","AWEME_ID_2"]'

GET /api/v1/douyin/app/v3/fetch_music_video_list

读取指定 music_id 单次最多 20 条的真实公开作品首屏,并保存历次公开快照并集;本地 cursor 在观测并集内分页。

参数必填默认值说明
music_id-音乐 ID
cursor0本地观测并集游标,下一页使用响应中的 cursor
count10每页数量,1-20
refreshfalse请求新的公开首屏并合并到本地历史;相同作品按 aweme_id 去重
curl 'http://localhost:4177/api/v1/douyin/app/v3/fetch_music_video_list?music_id=YOUR_MUSIC_ID&cursor=0&count=10'

pagination_mode=public_first_screen_local_cursorplatform_has_more 只记录平台信号,不代表本接口已取得受保护深分页。

GET /api/v1/douyin/app/v3/fetch_hashtag_video_list

读取指定话题的真实公开作品首屏;sort_type=0 保留公开顺序,1 按点赞排序,2 按发布时间排序。

curl 'http://localhost:4177/api/v1/douyin/app/v3/fetch_hashtag_video_list?ch_id=YOUR_CHALLENGE_ID&cursor=0&sort_type=0&count=10'

关键词搜索兼容契约

以下 TikHub 风格 JSON 搜索路径仍要求受保护平台验证,因此返回 501。歌曲图谱任务不调用这些路径,而是从抖音官方游客 SEO 首屏取得 search_idcursorbacktrace,再使用官方匿名游客状态分页补充候选;不生成签名、不绕验证、不返回模拟结果。

POST /api/v1/douyin/search/fetch_music_search
POST /api/v1/douyin/search/fetch_video_search_v1

{"keyword":"歌曲名","cursor":0,"sort_type":"0","publish_time":"0","filter_duration":"0","content_type":"0","search_id":"","backtrace":""}

GET /api/v1/douyin/app/v3/fetch_music_hot_videos

用公开音乐、话题和作者首屏扩展候选池,读取公开视频 SSR 详情,验证其他 music_id 后在本地计算爆款排行。public-graph 返回异步任务。

参数必填默认值说明
music_id是*-音乐 ID、音乐分享链接或使用该歌曲的视频链接;也可使用参数名 url
candidate_limit至少 100每首歌公开候选池目标,15-2000
count30从已确认同曲候选中最终返回 Top N,1-500
sort_byhot_scorehot_scorediggcommentcollectsharelatest(从近到远)或 oldest(从远到近)
viral_threshold10000爆款点赞阈值,达到后 is_viral=true
viral_onlyfalse设为 true 时仅返回达到点赞阈值的作品
search_enabledtrue是否加入官方游客综合搜索候选(支持游标续页)
search_keywords音乐标题指定搜索歌名;多个值用逗号分隔,最多 8 个
search_candidate_limit与候选池联动综合搜索历次观测并集目标,0-5000
search_page_limit30每个综合搜索词最多抓取页数,1-60
verify_audiotrue验证其他 music_id / 原声候选的音频
match_threshold0.65跨 music_id 音频匹配阈值,0-1
account_profile_limit与 Top N 联动补齐账号粉丝、总获赞和作品数的账号上限,0-500
refreshfalse是否忽略仍有效的公开数据缓存
curl 'http://localhost:4177/api/v1/douyin/app/v3/fetch_music_hot_videos?music_id=YOUR_MUSIC_ID&candidate_limit=500&count=30&search_enabled=true&search_keywords=YOUR_SONG_TITLE&search_candidate_limit=300&search_page_limit=30&sort_by=hot_score&viral_threshold=10000&viral_only=false&verify_audio=true'

POST /api/v1/douyin/app/v3/music_collection_jobs

创建纯后端公开数据图谱任务。无需抖音账号、Android 模拟器、用户提供 Cookie 或自生成签名;搜索分页自动使用官方下发的匿名游客状态。

JSON 字段必填默认值说明
input是*-music_id、音乐链接或使用该歌曲的视频链接;也可使用字段 music_id / url
candidate_limit至少 100候选池目标,15-2000
count30最终返回 Top N,1-500
sort_byhot_score最终结果排序方式;发布时间支持 latest(从近到远)和 oldest(从远到近)
viral_threshold10000爆款点赞阈值
viral_onlyfalse最终结果是否只保留达到阈值的作品
search_enabledtrue是否加入官方游客综合搜索候选(支持游标续页)
search_keywords音乐标题指定搜索歌名;支持字符串或字符串数组,最多 8 个
search_candidate_limit与候选池联动综合搜索历次观测并集目标,0-5000
search_page_limit30每个综合搜索词最多抓取页数,1-60
verify_audiotrue是否验证跨 music_id / 原声候选
match_threshold0.65跨 music_id 音频匹配阈值,0-1
account_profile_limit与 Top N 联动补齐账号公开资料的账号上限,0-500
refreshfalse是否忽略仍有效且数量足够的本地真实缓存
curl -X POST 'http://localhost:4177/api/v1/douyin/app/v3/music_collection_jobs' \
  -H 'Content-Type: application/json' \
  -d '{"input":"YOUR_MUSIC_ID","candidate_limit":500,"count":30,"search_enabled":true,"search_keywords":"YOUR_SONG_TITLE","search_candidate_limit":300,"search_page_limit":30,"sort_by":"hot_score","viral_threshold":10000,"viral_only":false,"verify_audio":true,"account_profile_limit":100}'

查询与取消

curl 'http://localhost:4177/api/v1/douyin/app/v3/music_collection_jobs/YOUR_JOB_ID'
curl -X DELETE 'http://localhost:4177/api/v1/douyin/app/v3/music_collection_jobs/YOUR_JOB_ID'

POST /api/v1/douyin/app/v3/fetch_music_hot_videos_batch

批量处理 1-10 个音乐 ID、音乐链接或使用该歌曲的视频链接。公开图谱模式为每首创建独立后端任务。

curl -X POST 'http://localhost:4177/api/v1/douyin/app/v3/fetch_music_hot_videos_batch' \
  -H 'Content-Type: application/json' \
  -d '{"inputs":["MUSIC_ID_1","MUSIC_ID_2"],"candidate_limit":500,"count":30,"viral_threshold":10000,"viral_only":false}'

GET /api/v1/douyin/app/v3/discover_music_related_videos

第一层扫描精确歌曲种子作者的公开作品首屏,第二层在本机用音频特征和 DTW 验证跨 music_id / 原声同曲候选。

参数必填默认值说明
music_id是*-音乐 ID、音乐链接或使用该歌曲的视频链接;也可使用 url
author_limit5扫描种子作者数量,1-10
candidate_limit20文本候选上限,1-30
match_threshold0.65音频综合分阈值,0-1
verify_audiotrue对不同 music_id 的文本候选执行本地音频验证
viral_threshold10000爆款点赞阈值
curl 'http://localhost:4177/api/v1/douyin/app/v3/discover_music_related_videos?music_id=YOUR_MUSIC_ID&author_limit=5&candidate_limit=20&match_threshold=0.65&verify_audio=true'

GET /api/v1/music/kugou/top500/history

读取酷狗 TOP500 公开历史期次,按日期范围每 10 日选取一个真实榜单节点,每期固定返回前 20 首。

参数必填默认值说明
start_date-开始日期,格式 YYYY-MM-DD;公开历史当前最早为 2021-01-01
end_date-结束日期;超过最新期次时自动截到最新可用日期
interval_days10固定每 10 日一个查询节点
limit20固定只返回每个历史期次前 20 首
curl 'http://localhost:4177/api/v1/music/kugou/top500/history?start_date=2024-01-01&end_date=2024-03-01'

数据源 Provider

作品列表说明

browser-public 模式会读取移动公开分享页返回的首屏作品 JSON。它不是 TikHub 代理,也不会自己生成 a_bogus / 指纹签名。