@tikomni/skills 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (451) hide show
  1. package/.skill-package-allowlist.txt +4 -0
  2. package/LICENSE +21 -0
  3. package/README.md +167 -0
  4. package/README.zh-CN.md +167 -0
  5. package/bin/tikomni-skills.js +127 -0
  6. package/env.example +160 -0
  7. package/lib/installer.js +176 -0
  8. package/package.json +44 -0
  9. package/skills/creator-analysis/SKILL.md +71 -0
  10. package/skills/creator-analysis/agents/openai.yaml +4 -0
  11. package/skills/creator-analysis/env.example +36 -0
  12. package/skills/creator-analysis/references/api-capability-index.md +92 -0
  13. package/skills/creator-analysis/references/api-contracts/asr-api.md +130 -0
  14. package/skills/creator-analysis/references/api-contracts/bilibili-app-api.md +776 -0
  15. package/skills/creator-analysis/references/api-contracts/bilibili-web-api.md +2017 -0
  16. package/skills/creator-analysis/references/api-contracts/demo-api.md +717 -0
  17. package/skills/creator-analysis/references/api-contracts/douyin-app-v3-api.md +3594 -0
  18. package/skills/creator-analysis/references/api-contracts/douyin-billboard-api.md +2274 -0
  19. package/skills/creator-analysis/references/api-contracts/douyin-creator-api.md +1575 -0
  20. package/skills/creator-analysis/references/api-contracts/douyin-creator-v2-api.md +3254 -0
  21. package/skills/creator-analysis/references/api-contracts/douyin-search-api.md +4118 -0
  22. package/skills/creator-analysis/references/api-contracts/douyin-web-api.md +5544 -0
  23. package/skills/creator-analysis/references/api-contracts/douyin-xingtu-api.md +1916 -0
  24. package/skills/creator-analysis/references/api-contracts/douyin-xingtu-v2-api.md +1540 -0
  25. package/skills/creator-analysis/references/api-contracts/health-check.md +69 -0
  26. package/skills/creator-analysis/references/api-contracts/hybrid-parsing.md +78 -0
  27. package/skills/creator-analysis/references/api-contracts/instagram-v1-api.md +2256 -0
  28. package/skills/creator-analysis/references/api-contracts/instagram-v2-api.md +2011 -0
  29. package/skills/creator-analysis/references/api-contracts/instagram-v3-api.md +2630 -0
  30. package/skills/creator-analysis/references/api-contracts/ios-shortcut.md +44 -0
  31. package/skills/creator-analysis/references/api-contracts/kuaishou-app-api.md +1518 -0
  32. package/skills/creator-analysis/references/api-contracts/kuaishou-web-api.md +1242 -0
  33. package/skills/creator-analysis/references/api-contracts/lemon8-app-api.md +1088 -0
  34. package/skills/creator-analysis/references/api-contracts/linkedin-web-api.md +1949 -0
  35. package/skills/creator-analysis/references/api-contracts/media-ingest-api.md +126 -0
  36. package/skills/creator-analysis/references/api-contracts/pipixia-app-api.md +1142 -0
  37. package/skills/creator-analysis/references/api-contracts/reddit-app-api.md +2025 -0
  38. package/skills/creator-analysis/references/api-contracts/sora2-api.md +2266 -0
  39. package/skills/creator-analysis/references/api-contracts/temp-mail-api.md +208 -0
  40. package/skills/creator-analysis/references/api-contracts/threads-web-api.md +897 -0
  41. package/skills/creator-analysis/references/api-contracts/tikhub-downloader-api.md +134 -0
  42. package/skills/creator-analysis/references/api-contracts/tikhub-user-api.md +494 -0
  43. package/skills/creator-analysis/references/api-contracts/tiktok-ads-api.md +5947 -0
  44. package/skills/creator-analysis/references/api-contracts/tiktok-analytics-api.md +968 -0
  45. package/skills/creator-analysis/references/api-contracts/tiktok-app-v3-api.md +5735 -0
  46. package/skills/creator-analysis/references/api-contracts/tiktok-creator-api.md +1951 -0
  47. package/skills/creator-analysis/references/api-contracts/tiktok-interaction-api.md +742 -0
  48. package/skills/creator-analysis/references/api-contracts/tiktok-shop-web-api.md +1890 -0
  49. package/skills/creator-analysis/references/api-contracts/tiktok-web-api.md +4448 -0
  50. package/skills/creator-analysis/references/api-contracts/toutiao-app-api.md +342 -0
  51. package/skills/creator-analysis/references/api-contracts/toutiao-web-api.md +143 -0
  52. package/skills/creator-analysis/references/api-contracts/twitter-web-api.md +989 -0
  53. package/skills/creator-analysis/references/api-contracts/wechat-channels-api.md +809 -0
  54. package/skills/creator-analysis/references/api-contracts/wechat-media-platform-web-api.md +677 -0
  55. package/skills/creator-analysis/references/api-contracts/weibo-app-api.md +1547 -0
  56. package/skills/creator-analysis/references/api-contracts/weibo-web-api.md +798 -0
  57. package/skills/creator-analysis/references/api-contracts/weibo-web-v2-api.md +2459 -0
  58. package/skills/creator-analysis/references/api-contracts/xiaohongshu-app-api.md +1291 -0
  59. package/skills/creator-analysis/references/api-contracts/xiaohongshu-app-v2-api.md +1683 -0
  60. package/skills/creator-analysis/references/api-contracts/xiaohongshu-web-api.md +1324 -0
  61. package/skills/creator-analysis/references/api-contracts/xiaohongshu-web-v2-api.md +1209 -0
  62. package/skills/creator-analysis/references/api-contracts/xigua-app-v2-api.md +489 -0
  63. package/skills/creator-analysis/references/api-contracts/youtube-web-api.md +2636 -0
  64. package/skills/creator-analysis/references/api-contracts/youtube-web-v2-api.md +2660 -0
  65. package/skills/creator-analysis/references/api-contracts/zhihu-web-api.md +2315 -0
  66. package/skills/creator-analysis/references/api-tags/asr-api.md +100 -0
  67. package/skills/creator-analysis/references/api-tags/bilibili-app-api.md +482 -0
  68. package/skills/creator-analysis/references/api-tags/bilibili-web-api.md +1267 -0
  69. package/skills/creator-analysis/references/api-tags/demo-api.md +365 -0
  70. package/skills/creator-analysis/references/api-tags/douyin-app-v3-api.md +2012 -0
  71. package/skills/creator-analysis/references/api-tags/douyin-billboard-api.md +1428 -0
  72. package/skills/creator-analysis/references/api-tags/douyin-creator-api.md +694 -0
  73. package/skills/creator-analysis/references/api-tags/douyin-creator-v2-api.md +694 -0
  74. package/skills/creator-analysis/references/api-tags/douyin-search-api.md +1059 -0
  75. package/skills/creator-analysis/references/api-tags/douyin-web-api.md +3314 -0
  76. package/skills/creator-analysis/references/api-tags/douyin-xingtu-api.md +935 -0
  77. package/skills/creator-analysis/references/api-tags/douyin-xingtu-v2-api.md +925 -0
  78. package/skills/creator-analysis/references/api-tags/health-check.md +40 -0
  79. package/skills/creator-analysis/references/api-tags/hybrid-parsing.md +57 -0
  80. package/skills/creator-analysis/references/api-tags/instagram-v1-api.md +1224 -0
  81. package/skills/creator-analysis/references/api-tags/instagram-v2-api.md +1147 -0
  82. package/skills/creator-analysis/references/api-tags/instagram-v3-api.md +1123 -0
  83. package/skills/creator-analysis/references/api-tags/ios-shortcut.md +45 -0
  84. package/skills/creator-analysis/references/api-tags/kuaishou-app-api.md +846 -0
  85. package/skills/creator-analysis/references/api-tags/kuaishou-web-api.md +551 -0
  86. package/skills/creator-analysis/references/api-tags/lemon8-app-api.md +687 -0
  87. package/skills/creator-analysis/references/api-tags/linkedin-web-api.md +1105 -0
  88. package/skills/creator-analysis/references/api-tags/media-ingest-api.md +112 -0
  89. package/skills/creator-analysis/references/api-tags/pipixia-app-api.md +721 -0
  90. package/skills/creator-analysis/references/api-tags/reddit-app-api.md +1057 -0
  91. package/skills/creator-analysis/references/api-tags/sora2-api.md +737 -0
  92. package/skills/creator-analysis/references/api-tags/temp-mail-api.md +136 -0
  93. package/skills/creator-analysis/references/api-tags/threads-web-api.md +472 -0
  94. package/skills/creator-analysis/references/api-tags/tikhub-downloader-api.md +65 -0
  95. package/skills/creator-analysis/references/api-tags/tikhub-user-api.md +253 -0
  96. package/skills/creator-analysis/references/api-tags/tiktok-ads-api.md +1393 -0
  97. package/skills/creator-analysis/references/api-tags/tiktok-analytics-api.md +179 -0
  98. package/skills/creator-analysis/references/api-tags/tiktok-app-v3-api.md +3264 -0
  99. package/skills/creator-analysis/references/api-tags/tiktok-creator-api.md +709 -0
  100. package/skills/creator-analysis/references/api-tags/tiktok-interaction-api.md +366 -0
  101. package/skills/creator-analysis/references/api-tags/tiktok-shop-web-api.md +663 -0
  102. package/skills/creator-analysis/references/api-tags/tiktok-web-api.md +2516 -0
  103. package/skills/creator-analysis/references/api-tags/toutiao-app-api.md +220 -0
  104. package/skills/creator-analysis/references/api-tags/toutiao-web-api.md +96 -0
  105. package/skills/creator-analysis/references/api-tags/twitter-web-api.md +562 -0
  106. package/skills/creator-analysis/references/api-tags/wechat-channels-api.md +405 -0
  107. package/skills/creator-analysis/references/api-tags/wechat-media-platform-web-api.md +431 -0
  108. package/skills/creator-analysis/references/api-tags/weibo-app-api.md +851 -0
  109. package/skills/creator-analysis/references/api-tags/weibo-web-api.md +470 -0
  110. package/skills/creator-analysis/references/api-tags/weibo-web-v2-api.md +1405 -0
  111. package/skills/creator-analysis/references/api-tags/xiaohongshu-app-api.md +534 -0
  112. package/skills/creator-analysis/references/api-tags/xiaohongshu-app-v2-api.md +934 -0
  113. package/skills/creator-analysis/references/api-tags/xiaohongshu-web-api.md +757 -0
  114. package/skills/creator-analysis/references/api-tags/xiaohongshu-web-v2-api.md +762 -0
  115. package/skills/creator-analysis/references/api-tags/xigua-app-v2-api.md +308 -0
  116. package/skills/creator-analysis/references/api-tags/youtube-web-api.md +934 -0
  117. package/skills/creator-analysis/references/api-tags/youtube-web-v2-api.md +717 -0
  118. package/skills/creator-analysis/references/api-tags/zhihu-web-api.md +1384 -0
  119. package/skills/creator-analysis/references/asr-orchestration.md +33 -0
  120. package/skills/creator-analysis/references/config-templates/defaults.yaml +60 -0
  121. package/skills/creator-analysis/references/contracts/creator-card-fields.md +23 -0
  122. package/skills/creator-analysis/references/contracts/work-card-fields.md +32 -0
  123. package/skills/creator-analysis/references/platform-guides/douyin.md +49 -0
  124. package/skills/creator-analysis/references/platform-guides/generic.md +46 -0
  125. package/skills/creator-analysis/references/platform-guides/xiaohongshu.md +54 -0
  126. package/skills/creator-analysis/references/prompt-contracts/asr-clean.md +28 -0
  127. package/skills/creator-analysis/references/prompt-contracts/author-analysis-v2.md +46 -0
  128. package/skills/creator-analysis/references/prompt-contracts/author-analysis.md +49 -0
  129. package/skills/creator-analysis/references/prompt-contracts/cta.md +24 -0
  130. package/skills/creator-analysis/references/prompt-contracts/hook.md +25 -0
  131. package/skills/creator-analysis/references/prompt-contracts/insight.md +47 -0
  132. package/skills/creator-analysis/references/prompt-contracts/sampled-work-batch-explanations.md +30 -0
  133. package/skills/creator-analysis/references/prompt-contracts/structure.md +25 -0
  134. package/skills/creator-analysis/references/prompt-contracts/style.md +27 -0
  135. package/skills/creator-analysis/references/prompt-contracts/summary.md +29 -0
  136. package/skills/creator-analysis/references/prompt-contracts/topic.md +29 -0
  137. package/skills/creator-analysis/references/schemas/author-analysis-input-v1.schema.json +325 -0
  138. package/skills/creator-analysis/references/schemas/author-analysis-v2.schema.json +158 -0
  139. package/skills/creator-analysis/references/schemas/sampled-work-batch-explanations.schema.json +41 -0
  140. package/skills/creator-analysis/references/service-guides/asr-u2-u3-fallback.md +75 -0
  141. package/skills/creator-analysis/references/workflow.md +18 -0
  142. package/skills/creator-analysis/scripts/__init__.py +0 -0
  143. package/skills/creator-analysis/scripts/author_home/__init__.py +0 -0
  144. package/skills/creator-analysis/scripts/author_home/adapters/__init__.py +0 -0
  145. package/skills/creator-analysis/scripts/author_home/adapters/platform_adapters.py +299 -0
  146. package/skills/creator-analysis/scripts/author_home/analyzers/__init__.py +0 -0
  147. package/skills/creator-analysis/scripts/author_home/analyzers/author_analysis_v2_support.py +1122 -0
  148. package/skills/creator-analysis/scripts/author_home/analyzers/prompt_first_analyzers.py +260 -0
  149. package/skills/creator-analysis/scripts/author_home/analyzers/sampled_work_batch_explainer.py +260 -0
  150. package/skills/creator-analysis/scripts/author_home/asr/__init__.py +5 -0
  151. package/skills/creator-analysis/scripts/author_home/asr/home_asr.py +961 -0
  152. package/skills/creator-analysis/scripts/author_home/builders/__init__.py +0 -0
  153. package/skills/creator-analysis/scripts/author_home/builders/home_builders.py +149 -0
  154. package/skills/creator-analysis/scripts/author_home/collectors/__init__.py +0 -0
  155. package/skills/creator-analysis/scripts/author_home/collectors/homepage_collectors.py +636 -0
  156. package/skills/creator-analysis/scripts/author_home/orchestrator/__init__.py +0 -0
  157. package/skills/creator-analysis/scripts/author_home/orchestrator/run_author_analysis.py +491 -0
  158. package/skills/creator-analysis/scripts/author_home/orchestrator/work_analysis_artifacts.py +553 -0
  159. package/skills/creator-analysis/scripts/author_home/schema.py +417 -0
  160. package/skills/creator-analysis/scripts/core/__init__.py +0 -0
  161. package/skills/creator-analysis/scripts/core/analysis_pipeline.py +133 -0
  162. package/skills/creator-analysis/scripts/core/bootstrap_env.py +35 -0
  163. package/skills/creator-analysis/scripts/core/config_loader.py +418 -0
  164. package/skills/creator-analysis/scripts/core/extract_pipeline.py +173 -0
  165. package/skills/creator-analysis/scripts/core/progress_report.py +111 -0
  166. package/skills/creator-analysis/scripts/core/storage_router.py +253 -0
  167. package/skills/creator-analysis/scripts/core/tikomni_common.py +588 -0
  168. package/skills/creator-analysis/scripts/pipeline/__init__.py +0 -0
  169. package/skills/creator-analysis/scripts/pipeline/asr/__init__.py +0 -0
  170. package/skills/creator-analysis/scripts/pipeline/asr/asr_pipeline.py +1189 -0
  171. package/skills/creator-analysis/scripts/pipeline/asr/poll_u2_task.py +95 -0
  172. package/skills/creator-analysis/scripts/platform/__init__.py +0 -0
  173. package/skills/creator-analysis/scripts/platform/douyin/__init__.py +0 -0
  174. package/skills/creator-analysis/scripts/platform/douyin/douyin_video_type_matrix.py +224 -0
  175. package/skills/creator-analysis/scripts/platform/douyin/run_douyin_single_video.py +1208 -0
  176. package/skills/creator-analysis/scripts/platform/douyin/select_low_quality_video_url.py +200 -0
  177. package/skills/creator-analysis/scripts/platform/xiaohongshu/__init__.py +0 -0
  178. package/skills/creator-analysis/scripts/platform/xiaohongshu/run_xiaohongshu_extract.py +2128 -0
  179. package/skills/creator-analysis/scripts/writers/__init__.py +0 -0
  180. package/skills/creator-analysis/scripts/writers/write_author_homepage_samples.py +106 -0
  181. package/skills/creator-analysis/scripts/writers/write_benchmark_card.py +1402 -0
  182. package/skills/meta-capability/SKILL.md +69 -0
  183. package/skills/meta-capability/agents/openai.yaml +4 -0
  184. package/skills/meta-capability/env.example +42 -0
  185. package/skills/meta-capability/references/api-capability-index.md +92 -0
  186. package/skills/meta-capability/references/api-contracts/asr-api.md +130 -0
  187. package/skills/meta-capability/references/api-contracts/bilibili-app-api.md +776 -0
  188. package/skills/meta-capability/references/api-contracts/bilibili-web-api.md +2017 -0
  189. package/skills/meta-capability/references/api-contracts/demo-api.md +717 -0
  190. package/skills/meta-capability/references/api-contracts/douyin-app-v3-api.md +3594 -0
  191. package/skills/meta-capability/references/api-contracts/douyin-billboard-api.md +2274 -0
  192. package/skills/meta-capability/references/api-contracts/douyin-creator-api.md +1575 -0
  193. package/skills/meta-capability/references/api-contracts/douyin-creator-v2-api.md +3254 -0
  194. package/skills/meta-capability/references/api-contracts/douyin-search-api.md +4118 -0
  195. package/skills/meta-capability/references/api-contracts/douyin-web-api.md +5544 -0
  196. package/skills/meta-capability/references/api-contracts/douyin-xingtu-api.md +1916 -0
  197. package/skills/meta-capability/references/api-contracts/douyin-xingtu-v2-api.md +1540 -0
  198. package/skills/meta-capability/references/api-contracts/health-check.md +69 -0
  199. package/skills/meta-capability/references/api-contracts/hybrid-parsing.md +78 -0
  200. package/skills/meta-capability/references/api-contracts/instagram-v1-api.md +2256 -0
  201. package/skills/meta-capability/references/api-contracts/instagram-v2-api.md +2011 -0
  202. package/skills/meta-capability/references/api-contracts/instagram-v3-api.md +2630 -0
  203. package/skills/meta-capability/references/api-contracts/ios-shortcut.md +44 -0
  204. package/skills/meta-capability/references/api-contracts/kuaishou-app-api.md +1518 -0
  205. package/skills/meta-capability/references/api-contracts/kuaishou-web-api.md +1242 -0
  206. package/skills/meta-capability/references/api-contracts/lemon8-app-api.md +1088 -0
  207. package/skills/meta-capability/references/api-contracts/linkedin-web-api.md +1949 -0
  208. package/skills/meta-capability/references/api-contracts/media-ingest-api.md +126 -0
  209. package/skills/meta-capability/references/api-contracts/pipixia-app-api.md +1142 -0
  210. package/skills/meta-capability/references/api-contracts/reddit-app-api.md +2025 -0
  211. package/skills/meta-capability/references/api-contracts/sora2-api.md +2266 -0
  212. package/skills/meta-capability/references/api-contracts/temp-mail-api.md +208 -0
  213. package/skills/meta-capability/references/api-contracts/threads-web-api.md +897 -0
  214. package/skills/meta-capability/references/api-contracts/tikhub-downloader-api.md +134 -0
  215. package/skills/meta-capability/references/api-contracts/tikhub-user-api.md +494 -0
  216. package/skills/meta-capability/references/api-contracts/tiktok-ads-api.md +5947 -0
  217. package/skills/meta-capability/references/api-contracts/tiktok-analytics-api.md +968 -0
  218. package/skills/meta-capability/references/api-contracts/tiktok-app-v3-api.md +5735 -0
  219. package/skills/meta-capability/references/api-contracts/tiktok-creator-api.md +1951 -0
  220. package/skills/meta-capability/references/api-contracts/tiktok-interaction-api.md +742 -0
  221. package/skills/meta-capability/references/api-contracts/tiktok-shop-web-api.md +1890 -0
  222. package/skills/meta-capability/references/api-contracts/tiktok-web-api.md +4448 -0
  223. package/skills/meta-capability/references/api-contracts/toutiao-app-api.md +342 -0
  224. package/skills/meta-capability/references/api-contracts/toutiao-web-api.md +143 -0
  225. package/skills/meta-capability/references/api-contracts/twitter-web-api.md +989 -0
  226. package/skills/meta-capability/references/api-contracts/wechat-channels-api.md +809 -0
  227. package/skills/meta-capability/references/api-contracts/wechat-media-platform-web-api.md +677 -0
  228. package/skills/meta-capability/references/api-contracts/weibo-app-api.md +1547 -0
  229. package/skills/meta-capability/references/api-contracts/weibo-web-api.md +798 -0
  230. package/skills/meta-capability/references/api-contracts/weibo-web-v2-api.md +2459 -0
  231. package/skills/meta-capability/references/api-contracts/xiaohongshu-app-api.md +1291 -0
  232. package/skills/meta-capability/references/api-contracts/xiaohongshu-app-v2-api.md +1683 -0
  233. package/skills/meta-capability/references/api-contracts/xiaohongshu-web-api.md +1324 -0
  234. package/skills/meta-capability/references/api-contracts/xiaohongshu-web-v2-api.md +1209 -0
  235. package/skills/meta-capability/references/api-contracts/xigua-app-v2-api.md +489 -0
  236. package/skills/meta-capability/references/api-contracts/youtube-web-api.md +2636 -0
  237. package/skills/meta-capability/references/api-contracts/youtube-web-v2-api.md +2660 -0
  238. package/skills/meta-capability/references/api-contracts/zhihu-web-api.md +2315 -0
  239. package/skills/meta-capability/references/api-tags/asr-api.md +100 -0
  240. package/skills/meta-capability/references/api-tags/bilibili-app-api.md +482 -0
  241. package/skills/meta-capability/references/api-tags/bilibili-web-api.md +1267 -0
  242. package/skills/meta-capability/references/api-tags/demo-api.md +365 -0
  243. package/skills/meta-capability/references/api-tags/douyin-app-v3-api.md +2012 -0
  244. package/skills/meta-capability/references/api-tags/douyin-billboard-api.md +1428 -0
  245. package/skills/meta-capability/references/api-tags/douyin-creator-api.md +694 -0
  246. package/skills/meta-capability/references/api-tags/douyin-creator-v2-api.md +694 -0
  247. package/skills/meta-capability/references/api-tags/douyin-search-api.md +1059 -0
  248. package/skills/meta-capability/references/api-tags/douyin-web-api.md +3314 -0
  249. package/skills/meta-capability/references/api-tags/douyin-xingtu-api.md +935 -0
  250. package/skills/meta-capability/references/api-tags/douyin-xingtu-v2-api.md +925 -0
  251. package/skills/meta-capability/references/api-tags/health-check.md +40 -0
  252. package/skills/meta-capability/references/api-tags/hybrid-parsing.md +57 -0
  253. package/skills/meta-capability/references/api-tags/instagram-v1-api.md +1224 -0
  254. package/skills/meta-capability/references/api-tags/instagram-v2-api.md +1147 -0
  255. package/skills/meta-capability/references/api-tags/instagram-v3-api.md +1123 -0
  256. package/skills/meta-capability/references/api-tags/ios-shortcut.md +45 -0
  257. package/skills/meta-capability/references/api-tags/kuaishou-app-api.md +846 -0
  258. package/skills/meta-capability/references/api-tags/kuaishou-web-api.md +551 -0
  259. package/skills/meta-capability/references/api-tags/lemon8-app-api.md +687 -0
  260. package/skills/meta-capability/references/api-tags/linkedin-web-api.md +1105 -0
  261. package/skills/meta-capability/references/api-tags/media-ingest-api.md +112 -0
  262. package/skills/meta-capability/references/api-tags/pipixia-app-api.md +721 -0
  263. package/skills/meta-capability/references/api-tags/reddit-app-api.md +1057 -0
  264. package/skills/meta-capability/references/api-tags/sora2-api.md +737 -0
  265. package/skills/meta-capability/references/api-tags/temp-mail-api.md +136 -0
  266. package/skills/meta-capability/references/api-tags/threads-web-api.md +472 -0
  267. package/skills/meta-capability/references/api-tags/tikhub-downloader-api.md +65 -0
  268. package/skills/meta-capability/references/api-tags/tikhub-user-api.md +253 -0
  269. package/skills/meta-capability/references/api-tags/tiktok-ads-api.md +1393 -0
  270. package/skills/meta-capability/references/api-tags/tiktok-analytics-api.md +179 -0
  271. package/skills/meta-capability/references/api-tags/tiktok-app-v3-api.md +3264 -0
  272. package/skills/meta-capability/references/api-tags/tiktok-creator-api.md +709 -0
  273. package/skills/meta-capability/references/api-tags/tiktok-interaction-api.md +366 -0
  274. package/skills/meta-capability/references/api-tags/tiktok-shop-web-api.md +663 -0
  275. package/skills/meta-capability/references/api-tags/tiktok-web-api.md +2516 -0
  276. package/skills/meta-capability/references/api-tags/toutiao-app-api.md +220 -0
  277. package/skills/meta-capability/references/api-tags/toutiao-web-api.md +96 -0
  278. package/skills/meta-capability/references/api-tags/twitter-web-api.md +562 -0
  279. package/skills/meta-capability/references/api-tags/wechat-channels-api.md +405 -0
  280. package/skills/meta-capability/references/api-tags/wechat-media-platform-web-api.md +431 -0
  281. package/skills/meta-capability/references/api-tags/weibo-app-api.md +851 -0
  282. package/skills/meta-capability/references/api-tags/weibo-web-api.md +470 -0
  283. package/skills/meta-capability/references/api-tags/weibo-web-v2-api.md +1405 -0
  284. package/skills/meta-capability/references/api-tags/xiaohongshu-app-api.md +534 -0
  285. package/skills/meta-capability/references/api-tags/xiaohongshu-app-v2-api.md +934 -0
  286. package/skills/meta-capability/references/api-tags/xiaohongshu-web-api.md +757 -0
  287. package/skills/meta-capability/references/api-tags/xiaohongshu-web-v2-api.md +762 -0
  288. package/skills/meta-capability/references/api-tags/xigua-app-v2-api.md +308 -0
  289. package/skills/meta-capability/references/api-tags/youtube-web-api.md +934 -0
  290. package/skills/meta-capability/references/api-tags/youtube-web-v2-api.md +717 -0
  291. package/skills/meta-capability/references/api-tags/zhihu-web-api.md +1384 -0
  292. package/skills/meta-capability/references/config-templates/defaults.yaml +18 -0
  293. package/skills/meta-capability/references/dispatch.md +27 -0
  294. package/skills/meta-capability/references/execution-guidelines.md +25 -0
  295. package/skills/meta-capability/references/implemented-route-map.md +177 -0
  296. package/skills/meta-capability/references/service-guides/asr-u2-u3-fallback.md +75 -0
  297. package/skills/meta-capability/scripts/__init__.py +1 -0
  298. package/skills/meta-capability/scripts/call_route.py +141 -0
  299. package/skills/meta-capability/scripts/core/__init__.py +1 -0
  300. package/skills/meta-capability/scripts/core/bootstrap_env.py +32 -0
  301. package/skills/meta-capability/scripts/core/config_loader.py +204 -0
  302. package/skills/meta-capability/scripts/core/tikomni_common.py +443 -0
  303. package/skills/meta-capability/scripts/test_auth.py +98 -0
  304. package/skills/single-work-analysis/SKILL.md +62 -0
  305. package/skills/single-work-analysis/agents/openai.yaml +4 -0
  306. package/skills/single-work-analysis/env.example +36 -0
  307. package/skills/single-work-analysis/references/api-capability-index.md +92 -0
  308. package/skills/single-work-analysis/references/api-contracts/asr-api.md +130 -0
  309. package/skills/single-work-analysis/references/api-contracts/bilibili-app-api.md +776 -0
  310. package/skills/single-work-analysis/references/api-contracts/bilibili-web-api.md +2017 -0
  311. package/skills/single-work-analysis/references/api-contracts/demo-api.md +717 -0
  312. package/skills/single-work-analysis/references/api-contracts/douyin-app-v3-api.md +3594 -0
  313. package/skills/single-work-analysis/references/api-contracts/douyin-billboard-api.md +2274 -0
  314. package/skills/single-work-analysis/references/api-contracts/douyin-creator-api.md +1575 -0
  315. package/skills/single-work-analysis/references/api-contracts/douyin-creator-v2-api.md +3254 -0
  316. package/skills/single-work-analysis/references/api-contracts/douyin-search-api.md +4118 -0
  317. package/skills/single-work-analysis/references/api-contracts/douyin-web-api.md +5544 -0
  318. package/skills/single-work-analysis/references/api-contracts/douyin-xingtu-api.md +1916 -0
  319. package/skills/single-work-analysis/references/api-contracts/douyin-xingtu-v2-api.md +1540 -0
  320. package/skills/single-work-analysis/references/api-contracts/health-check.md +69 -0
  321. package/skills/single-work-analysis/references/api-contracts/hybrid-parsing.md +78 -0
  322. package/skills/single-work-analysis/references/api-contracts/instagram-v1-api.md +2256 -0
  323. package/skills/single-work-analysis/references/api-contracts/instagram-v2-api.md +2011 -0
  324. package/skills/single-work-analysis/references/api-contracts/instagram-v3-api.md +2630 -0
  325. package/skills/single-work-analysis/references/api-contracts/ios-shortcut.md +44 -0
  326. package/skills/single-work-analysis/references/api-contracts/kuaishou-app-api.md +1518 -0
  327. package/skills/single-work-analysis/references/api-contracts/kuaishou-web-api.md +1242 -0
  328. package/skills/single-work-analysis/references/api-contracts/lemon8-app-api.md +1088 -0
  329. package/skills/single-work-analysis/references/api-contracts/linkedin-web-api.md +1949 -0
  330. package/skills/single-work-analysis/references/api-contracts/media-ingest-api.md +126 -0
  331. package/skills/single-work-analysis/references/api-contracts/pipixia-app-api.md +1142 -0
  332. package/skills/single-work-analysis/references/api-contracts/reddit-app-api.md +2025 -0
  333. package/skills/single-work-analysis/references/api-contracts/sora2-api.md +2266 -0
  334. package/skills/single-work-analysis/references/api-contracts/temp-mail-api.md +208 -0
  335. package/skills/single-work-analysis/references/api-contracts/threads-web-api.md +897 -0
  336. package/skills/single-work-analysis/references/api-contracts/tikhub-downloader-api.md +134 -0
  337. package/skills/single-work-analysis/references/api-contracts/tikhub-user-api.md +494 -0
  338. package/skills/single-work-analysis/references/api-contracts/tiktok-ads-api.md +5947 -0
  339. package/skills/single-work-analysis/references/api-contracts/tiktok-analytics-api.md +968 -0
  340. package/skills/single-work-analysis/references/api-contracts/tiktok-app-v3-api.md +5735 -0
  341. package/skills/single-work-analysis/references/api-contracts/tiktok-creator-api.md +1951 -0
  342. package/skills/single-work-analysis/references/api-contracts/tiktok-interaction-api.md +742 -0
  343. package/skills/single-work-analysis/references/api-contracts/tiktok-shop-web-api.md +1890 -0
  344. package/skills/single-work-analysis/references/api-contracts/tiktok-web-api.md +4448 -0
  345. package/skills/single-work-analysis/references/api-contracts/toutiao-app-api.md +342 -0
  346. package/skills/single-work-analysis/references/api-contracts/toutiao-web-api.md +143 -0
  347. package/skills/single-work-analysis/references/api-contracts/twitter-web-api.md +989 -0
  348. package/skills/single-work-analysis/references/api-contracts/wechat-channels-api.md +809 -0
  349. package/skills/single-work-analysis/references/api-contracts/wechat-media-platform-web-api.md +677 -0
  350. package/skills/single-work-analysis/references/api-contracts/weibo-app-api.md +1547 -0
  351. package/skills/single-work-analysis/references/api-contracts/weibo-web-api.md +798 -0
  352. package/skills/single-work-analysis/references/api-contracts/weibo-web-v2-api.md +2459 -0
  353. package/skills/single-work-analysis/references/api-contracts/xiaohongshu-app-api.md +1291 -0
  354. package/skills/single-work-analysis/references/api-contracts/xiaohongshu-app-v2-api.md +1683 -0
  355. package/skills/single-work-analysis/references/api-contracts/xiaohongshu-web-api.md +1324 -0
  356. package/skills/single-work-analysis/references/api-contracts/xiaohongshu-web-v2-api.md +1209 -0
  357. package/skills/single-work-analysis/references/api-contracts/xigua-app-v2-api.md +489 -0
  358. package/skills/single-work-analysis/references/api-contracts/youtube-web-api.md +2636 -0
  359. package/skills/single-work-analysis/references/api-contracts/youtube-web-v2-api.md +2660 -0
  360. package/skills/single-work-analysis/references/api-contracts/zhihu-web-api.md +2315 -0
  361. package/skills/single-work-analysis/references/api-tags/asr-api.md +100 -0
  362. package/skills/single-work-analysis/references/api-tags/bilibili-app-api.md +482 -0
  363. package/skills/single-work-analysis/references/api-tags/bilibili-web-api.md +1267 -0
  364. package/skills/single-work-analysis/references/api-tags/demo-api.md +365 -0
  365. package/skills/single-work-analysis/references/api-tags/douyin-app-v3-api.md +2012 -0
  366. package/skills/single-work-analysis/references/api-tags/douyin-billboard-api.md +1428 -0
  367. package/skills/single-work-analysis/references/api-tags/douyin-creator-api.md +694 -0
  368. package/skills/single-work-analysis/references/api-tags/douyin-creator-v2-api.md +694 -0
  369. package/skills/single-work-analysis/references/api-tags/douyin-search-api.md +1059 -0
  370. package/skills/single-work-analysis/references/api-tags/douyin-web-api.md +3314 -0
  371. package/skills/single-work-analysis/references/api-tags/douyin-xingtu-api.md +935 -0
  372. package/skills/single-work-analysis/references/api-tags/douyin-xingtu-v2-api.md +925 -0
  373. package/skills/single-work-analysis/references/api-tags/health-check.md +40 -0
  374. package/skills/single-work-analysis/references/api-tags/hybrid-parsing.md +57 -0
  375. package/skills/single-work-analysis/references/api-tags/instagram-v1-api.md +1224 -0
  376. package/skills/single-work-analysis/references/api-tags/instagram-v2-api.md +1147 -0
  377. package/skills/single-work-analysis/references/api-tags/instagram-v3-api.md +1123 -0
  378. package/skills/single-work-analysis/references/api-tags/ios-shortcut.md +45 -0
  379. package/skills/single-work-analysis/references/api-tags/kuaishou-app-api.md +846 -0
  380. package/skills/single-work-analysis/references/api-tags/kuaishou-web-api.md +551 -0
  381. package/skills/single-work-analysis/references/api-tags/lemon8-app-api.md +687 -0
  382. package/skills/single-work-analysis/references/api-tags/linkedin-web-api.md +1105 -0
  383. package/skills/single-work-analysis/references/api-tags/media-ingest-api.md +112 -0
  384. package/skills/single-work-analysis/references/api-tags/pipixia-app-api.md +721 -0
  385. package/skills/single-work-analysis/references/api-tags/reddit-app-api.md +1057 -0
  386. package/skills/single-work-analysis/references/api-tags/sora2-api.md +737 -0
  387. package/skills/single-work-analysis/references/api-tags/temp-mail-api.md +136 -0
  388. package/skills/single-work-analysis/references/api-tags/threads-web-api.md +472 -0
  389. package/skills/single-work-analysis/references/api-tags/tikhub-downloader-api.md +65 -0
  390. package/skills/single-work-analysis/references/api-tags/tikhub-user-api.md +253 -0
  391. package/skills/single-work-analysis/references/api-tags/tiktok-ads-api.md +1393 -0
  392. package/skills/single-work-analysis/references/api-tags/tiktok-analytics-api.md +179 -0
  393. package/skills/single-work-analysis/references/api-tags/tiktok-app-v3-api.md +3264 -0
  394. package/skills/single-work-analysis/references/api-tags/tiktok-creator-api.md +709 -0
  395. package/skills/single-work-analysis/references/api-tags/tiktok-interaction-api.md +366 -0
  396. package/skills/single-work-analysis/references/api-tags/tiktok-shop-web-api.md +663 -0
  397. package/skills/single-work-analysis/references/api-tags/tiktok-web-api.md +2516 -0
  398. package/skills/single-work-analysis/references/api-tags/toutiao-app-api.md +220 -0
  399. package/skills/single-work-analysis/references/api-tags/toutiao-web-api.md +96 -0
  400. package/skills/single-work-analysis/references/api-tags/twitter-web-api.md +562 -0
  401. package/skills/single-work-analysis/references/api-tags/wechat-channels-api.md +405 -0
  402. package/skills/single-work-analysis/references/api-tags/wechat-media-platform-web-api.md +431 -0
  403. package/skills/single-work-analysis/references/api-tags/weibo-app-api.md +851 -0
  404. package/skills/single-work-analysis/references/api-tags/weibo-web-api.md +470 -0
  405. package/skills/single-work-analysis/references/api-tags/weibo-web-v2-api.md +1405 -0
  406. package/skills/single-work-analysis/references/api-tags/xiaohongshu-app-api.md +534 -0
  407. package/skills/single-work-analysis/references/api-tags/xiaohongshu-app-v2-api.md +934 -0
  408. package/skills/single-work-analysis/references/api-tags/xiaohongshu-web-api.md +757 -0
  409. package/skills/single-work-analysis/references/api-tags/xiaohongshu-web-v2-api.md +762 -0
  410. package/skills/single-work-analysis/references/api-tags/xigua-app-v2-api.md +308 -0
  411. package/skills/single-work-analysis/references/api-tags/youtube-web-api.md +934 -0
  412. package/skills/single-work-analysis/references/api-tags/youtube-web-v2-api.md +717 -0
  413. package/skills/single-work-analysis/references/api-tags/zhihu-web-api.md +1384 -0
  414. package/skills/single-work-analysis/references/asr-and-fallback.md +20 -0
  415. package/skills/single-work-analysis/references/config-templates/defaults.yaml +58 -0
  416. package/skills/single-work-analysis/references/contracts/work-card-fields.md +41 -0
  417. package/skills/single-work-analysis/references/platform-guides/douyin.md +47 -0
  418. package/skills/single-work-analysis/references/platform-guides/generic.md +43 -0
  419. package/skills/single-work-analysis/references/platform-guides/xiaohongshu.md +54 -0
  420. package/skills/single-work-analysis/references/prompt-contracts/asr-clean.md +28 -0
  421. package/skills/single-work-analysis/references/prompt-contracts/cta.md +24 -0
  422. package/skills/single-work-analysis/references/prompt-contracts/hook.md +25 -0
  423. package/skills/single-work-analysis/references/prompt-contracts/insight.md +47 -0
  424. package/skills/single-work-analysis/references/prompt-contracts/structure.md +25 -0
  425. package/skills/single-work-analysis/references/prompt-contracts/style.md +27 -0
  426. package/skills/single-work-analysis/references/prompt-contracts/summary.md +29 -0
  427. package/skills/single-work-analysis/references/prompt-contracts/topic.md +29 -0
  428. package/skills/single-work-analysis/references/schemas/work-card.schema.json +39 -0
  429. package/skills/single-work-analysis/references/service-guides/asr-u2-u3-fallback.md +75 -0
  430. package/skills/single-work-analysis/scripts/__init__.py +0 -0
  431. package/skills/single-work-analysis/scripts/core/__init__.py +0 -0
  432. package/skills/single-work-analysis/scripts/core/analysis_pipeline.py +133 -0
  433. package/skills/single-work-analysis/scripts/core/bootstrap_env.py +35 -0
  434. package/skills/single-work-analysis/scripts/core/config_loader.py +418 -0
  435. package/skills/single-work-analysis/scripts/core/extract_pipeline.py +173 -0
  436. package/skills/single-work-analysis/scripts/core/progress_report.py +111 -0
  437. package/skills/single-work-analysis/scripts/core/storage_router.py +253 -0
  438. package/skills/single-work-analysis/scripts/core/tikomni_common.py +588 -0
  439. package/skills/single-work-analysis/scripts/pipeline/__init__.py +0 -0
  440. package/skills/single-work-analysis/scripts/pipeline/asr/__init__.py +0 -0
  441. package/skills/single-work-analysis/scripts/pipeline/asr/asr_pipeline.py +1189 -0
  442. package/skills/single-work-analysis/scripts/pipeline/asr/poll_u2_task.py +95 -0
  443. package/skills/single-work-analysis/scripts/platform/__init__.py +0 -0
  444. package/skills/single-work-analysis/scripts/platform/douyin/__init__.py +0 -0
  445. package/skills/single-work-analysis/scripts/platform/douyin/douyin_video_type_matrix.py +224 -0
  446. package/skills/single-work-analysis/scripts/platform/douyin/run_douyin_single_video.py +1233 -0
  447. package/skills/single-work-analysis/scripts/platform/douyin/select_low_quality_video_url.py +200 -0
  448. package/skills/single-work-analysis/scripts/platform/xiaohongshu/__init__.py +0 -0
  449. package/skills/single-work-analysis/scripts/platform/xiaohongshu/run_xiaohongshu_extract.py +2156 -0
  450. package/skills/single-work-analysis/scripts/writers/__init__.py +0 -0
  451. package/skills/single-work-analysis/scripts/writers/write_benchmark_card.py +1402 -0
@@ -0,0 +1,3594 @@
1
+ # Douyin-App-V3-API Full Contract
2
+
3
+ - Back to index: [`api-capability-index.md`](../api-capability-index.md)
4
+ - Back to route summary: [`api-tags/douyin-app-v3-api.md`](../api-tags/douyin-app-v3-api.md)
5
+ - Current contract file: `api-contracts/douyin-app-v3-api.md`
6
+ - Source: `https://app.tikomni.com/openapi/tikomni-openapi.full.with-u2.public.latest.json`
7
+ - Fetched at: `2026-03-08T06:54:04+00:00`
8
+ - Route count: `47`
9
+ - Default auth: Header `Authorization` Bearer
10
+ - Read this file only when you need precise auth notes, parameter descriptions, defaults, examples, or success-response fields.
11
+ - Tag description: **(抖音-App-V3数据接口(当前最新版本)/Douyin-App-V3-API (Current latest version))**
12
+
13
+ ## Route Contracts
14
+
15
+ <a id="get-api-u1-v1-douyin-app-v3-add-video-play-count"></a>
16
+ ### `GET /api/u1/v1/douyin/app/v3/add_video_play_count`
17
+
18
+ - Summary: 根据视频ID来增加作品的播放数/Increase the number of plays of the work according to the video ID
19
+ - Capabilities: content details
20
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
21
+ - operationId: `add_video_play_count_api_v1_douyin_app_v3_add_video_play_count_get`
22
+
23
+ #### Notes
24
+
25
+ > # [中文]
26
+ > ### 用途:
27
+ > - 根据视频ID来增加作品的播放数
28
+ > - 该接口默认使用游客Cookie,如果需要使用登录用户的Cookie,请在参数中传入。
29
+ > - 单一作品每次调用增加1次播放数,请求约 `1000` 次后会被抖音限制,需要等待一段时间(如:2小时后)后再继续调用。
30
+ > - 该限制是针对作品的,不是针对接口的,在未登录的情况下,使用不同IP的浏览器或在APP中浏览作品,该作品的播放数也不会增加。
31
+ > - 可以携带抖音网页端的Cookie来请求此接口,但是不保证一定有效,需要自行测试。
32
+ > - 上述的限制是根据测试结果得出的,具体限制可能会有所不同,仅供参考。
33
+ > ### 参数:
34
+ > - aweme_type: 作品类型,0:视频 1:图文,可以从单一作品数据接口中获取。
35
+ > - item_id: 作品id,别名为aweme_id
36
+ > - cookie: 可选,默认使用游客Cookie
37
+ > ### 返回:
38
+ > - 当前时间戳和状态码,状态码为200时表示成功,否则为失败,可以尝试更换一个作品id再次调用,或者等待一段时间后再次调用。
39
+ >
40
+ > # [English]
41
+ > ### Purpose:
42
+ > - Increase the number of plays of the work according to the video ID
43
+ > - This interface uses guest Cookie by default. If you need to use the Cookie of the logged-in user, please pass it in the parameters.
44
+ > - Each call to a single work increases the number of plays by 1. After about `1000` calls, Douyin will restrict it. You need to wait for a period of time (such as 2 hours) before continuing to call.
45
+ > - This restriction is for the work, not for the interface. When browsing the work without logging in, using different IP browsers or browsing the work in the APP, the number of plays of the work will not increase.
46
+ > - You can carry the Cookie of the Douyin web page to request this interface, but it is not guaranteed to be effective and needs to be tested by yourself.
47
+ > - The above restrictions are based on test results, and the specific restrictions may vary, for reference only.
48
+ > ### Parameters:
49
+ > - aweme_type: Video type, 0: Video 1: Graphic and text, can be obtained from the single work data interface.
50
+ > - item_id: Video id, alias aweme_id
51
+ > - cookie: Optional, use guest Cookie by default
52
+ > ### Return:
53
+ > - The current timestamp and status code. When the status code is 200, it means success, otherwise it is a failure. You can try to change another work id and call it again, or wait for a period of time and call it again.
54
+ >
55
+ > # [示例/Example]
56
+ > aweme_type = 0
57
+ > item_id = "7197598285882789120"
58
+ > cookie = None
59
+
60
+ #### Parameters
61
+
62
+ | Field | In | Type | Required | Description | Default | Example | Enum |
63
+ | --- | --- | --- | --- | --- | --- | --- | --- |
64
+ | aweme_type | query | integer | Yes | 作品类型/Video type | None | 0 | None |
65
+ | item_id | query | string | Yes | 作品id/Video id | None | 7197598285882789120 | None |
66
+ | cookie | query | string | No | 可选,默认使用游客Cookie/Optional, use guest Cookie by default | None | None | None |
67
+
68
+ #### Request Body
69
+
70
+ None
71
+
72
+ #### Success Response
73
+
74
+ ##### `200 application/json`
75
+
76
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
77
+
78
+ | Field | Type | Required | Description | Default | Example | Enum |
79
+ | --- | --- | --- | --- | --- | --- | --- |
80
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
81
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
82
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
83
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
84
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
85
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
86
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
87
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
88
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
89
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
90
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
91
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
92
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
93
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
94
+ | data | null | No | The response data \| 响应数据 | None | None | None |
95
+
96
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-brand-hot-search-list"></a>
97
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_brand_hot_search_list`
98
+
99
+ - Summary: 获取抖音品牌热榜分类数据/Get Douyin brand hot search list data
100
+ - Capabilities: search / trends / rankings
101
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
102
+ - operationId: `fetch_hot_brand_search_category_api_v1_douyin_app_v3_fetch_brand_hot_search_list_get`
103
+
104
+ #### Notes
105
+
106
+ > # [中文]
107
+ > ### 用途:
108
+ > - 获取抖音品牌热榜分类数据
109
+ > ### 返回:
110
+ > - 品牌热搜榜分类数据
111
+ >
112
+ > # [English]
113
+ > ### Purpose:
114
+ > - Get Douyin brand hot search category data
115
+ > ### Return:
116
+ > - Hot brand search category data
117
+ >
118
+ > # [示例/Example]
119
+ > pass
120
+
121
+ #### Parameters
122
+
123
+ None
124
+
125
+ #### Request Body
126
+
127
+ None
128
+
129
+ #### Success Response
130
+
131
+ ##### `200 application/json`
132
+
133
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
134
+
135
+ | Field | Type | Required | Description | Default | Example | Enum |
136
+ | --- | --- | --- | --- | --- | --- | --- |
137
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
138
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
139
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
140
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
141
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
142
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
143
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
144
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
145
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
146
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
147
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
148
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
149
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
150
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
151
+ | data | null | No | The response data \| 响应数据 | None | None | None |
152
+
153
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-brand-hot-search-list-detail"></a>
154
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_brand_hot_search_list_detail`
155
+
156
+ - Summary: 获取抖音品牌热榜具体分类数据/Get Douyin brand hot search list detail data
157
+ - Capabilities: search / trends / rankings / details
158
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
159
+ - operationId: `fetch_hot_brand_search_api_v1_douyin_app_v3_fetch_brand_hot_search_list_detail_get`
160
+
161
+ #### Notes
162
+
163
+ > # [中文]
164
+ > ### 用途:
165
+ > - 获取抖音品牌热榜具体分类数据
166
+ > ### 参数:
167
+ > - category_id: 分类id
168
+ > ### 返回:
169
+ > - 品牌热搜榜具体分类数据
170
+ >
171
+ > # [English]
172
+ > ### Purpose:
173
+ > - Get Douyin brand hot search list detail data
174
+ > ### Parameters:
175
+ > - category_id: Category id
176
+ > ### Return:
177
+ > - Hot brand search list detail data
178
+ >
179
+ > # [示例/Example]
180
+ > category_id = 10
181
+
182
+ #### Parameters
183
+
184
+ | Field | In | Type | Required | Description | Default | Example | Enum |
185
+ | --- | --- | --- | --- | --- | --- | --- | --- |
186
+ | category_id | query | integer | Yes | 分类id/Category id | None | 10 | None |
187
+
188
+ #### Request Body
189
+
190
+ None
191
+
192
+ #### Success Response
193
+
194
+ ##### `200 application/json`
195
+
196
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
197
+
198
+ | Field | Type | Required | Description | Default | Example | Enum |
199
+ | --- | --- | --- | --- | --- | --- | --- |
200
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
201
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
202
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
203
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
204
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
205
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
206
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
207
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
208
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
209
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
210
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
211
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
212
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
213
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
214
+ | data | null | No | The response data \| 响应数据 | None | None | None |
215
+
216
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-general-search-result"></a>
217
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_general_search_result`
218
+
219
+ - Summary: 获取指定关键词的综合搜索结果(弃用,替代接口见下方文档说明)/Get comprehensive search results of specified keywords (deprecated, see the documentation below for alternative interfaces)
220
+ - Capabilities: search
221
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
222
+ - operationId: `fetch_general_search_result_api_v1_douyin_app_v3_fetch_general_search_result_get`
223
+
224
+ #### Notes
225
+
226
+ > # [中文]
227
+ > ### 用途:
228
+ > - 获取指定关键词的综合搜索结果
229
+ > - 该接口已弃用,替代接口为:https://docs.tikhub.io/370212773e0
230
+ > ### 参数:
231
+ > - keyword: 关键词
232
+ > - offset: 偏移量
233
+ > - count: 数量,请保持默认,否则会出现BUG。
234
+ > - sort_type: 0:综合排序 1:最多点赞 2:最新发布
235
+ > - publish_time: 0:不限 1:最近一天 7:最近一周 180:最近半年
236
+ > - filter_duration: 0:不限 0-1:1分钟以内 1-5:1-5分钟 5-10000:5分钟以上
237
+ > - content_type: 0:不限 1:视频 2:图片 3:文章
238
+ > ### 返回:
239
+ > - 综合搜索结果
240
+ >
241
+ > # [English]
242
+ > ### Purpose:
243
+ > - Get comprehensive search results of specified keywords
244
+ > - This interface has been deprecated, and the alternative interface is: https://docs.tikhub.io/370212773e0
245
+ > ### Parameters:
246
+ > - keyword: Keyword
247
+ > - offset: Offset
248
+ > - count: Number Please keep the default, otherwise there will be BUG.
249
+ > - sort_type: 0: Comprehensive sorting 1: Most likes 2: Latest release
250
+ > - publish_time: 0: Unlimited 1: Last day 7: Last week 180: Last half year
251
+ > - filter_duration: 0: Unlimited 0-1: Within 1 minute 1-5: 1-5 minutes 5-10000: More than 5 minutes
252
+ > - content_type: 0: Unlimited 1: Video 2: Picture 3: Article
253
+ > ### Return:
254
+ > - Comprehensive search results
255
+ >
256
+ > # [示例/Example]
257
+ > keyword = "中华娘"
258
+ > offset = 0
259
+ > count = 20
260
+ > sort_type = "0"
261
+ > publish_time = "0"
262
+ > filter_duration = "0"
263
+ > content_type = "0"
264
+
265
+ #### Parameters
266
+
267
+ | Field | In | Type | Required | Description | Default | Example | Enum |
268
+ | --- | --- | --- | --- | --- | --- | --- | --- |
269
+ | keyword | query | string | Yes | 关键词/Keyword | None | 中华娘 | None |
270
+ | offset | query | integer | No | 偏移量/Offset | 0 | None | None |
271
+ | count | query | integer | No | 数量/Number | 20 | None | None |
272
+ | sort_type | query | string | No | 排序类型/Sort type | 0 | None | None |
273
+ | publish_time | query | string | No | 发布时间/Publish time | 0 | None | None |
274
+ | filter_duration | query | string | No | 时长/Duration | 0 | None | None |
275
+ | content_type | query | string | No | 内容类型/Content type | 0 | None | None |
276
+
277
+ #### Request Body
278
+
279
+ None
280
+
281
+ #### Success Response
282
+
283
+ ##### `200 application/json`
284
+
285
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
286
+
287
+ | Field | Type | Required | Description | Default | Example | Enum |
288
+ | --- | --- | --- | --- | --- | --- | --- |
289
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
290
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
291
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
292
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
293
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
294
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
295
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
296
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
297
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
298
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
299
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
300
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
301
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
302
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
303
+ | data | null | No | The response data \| 响应数据 | None | None | None |
304
+
305
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-hashtag-detail"></a>
306
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_hashtag_detail`
307
+
308
+ - Summary: 获取指定话题的详情数据/Get details of specified hashtag
309
+ - Capabilities: details / topics
310
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
311
+ - operationId: `fetch_hashtag_detail_api_v1_douyin_app_v3_fetch_hashtag_detail_get`
312
+
313
+ #### Notes
314
+
315
+ > # [中文]
316
+ > ### 用途:
317
+ > - 获取指定话题的详情数据
318
+ > ### 参数:
319
+ > - ch_id: 话题id
320
+ > ### 返回:
321
+ > - 话题详情数据
322
+ >
323
+ > # [English]
324
+ > ### Purpose:
325
+ > - Get details of specified hashtag
326
+ > ### Parameters:
327
+ > - ch_id: Hashtag id
328
+ > ### Return:
329
+ > - Hashtag details data
330
+ >
331
+ > # [示例/Example]
332
+ > ch_id = 1575791821492238
333
+
334
+ #### Parameters
335
+
336
+ | Field | In | Type | Required | Description | Default | Example | Enum |
337
+ | --- | --- | --- | --- | --- | --- | --- | --- |
338
+ | ch_id | query | integer | Yes | 话题id/Hashtag id | None | 1575791821492238 | None |
339
+
340
+ #### Request Body
341
+
342
+ None
343
+
344
+ #### Success Response
345
+
346
+ ##### `200 application/json`
347
+
348
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
349
+
350
+ | Field | Type | Required | Description | Default | Example | Enum |
351
+ | --- | --- | --- | --- | --- | --- | --- |
352
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
353
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
354
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
355
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
356
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
357
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
358
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
359
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
360
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
361
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
362
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
363
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
364
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
365
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
366
+ | data | null | No | The response data \| 响应数据 | None | None | None |
367
+
368
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-hashtag-search-result"></a>
369
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_hashtag_search_result`
370
+
371
+ - Summary: 获取指定关键词的话题搜索结果(弃用,替代接口见下方文档说明)/Get hashtag search results of specified keywords (deprecated, see the documentation below for alternative interfaces)
372
+ - Capabilities: search / topics
373
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
374
+ - operationId: `fetch_hashtag_search_result_api_v1_douyin_app_v3_fetch_hashtag_search_result_get`
375
+
376
+ #### Notes
377
+
378
+ > # [中文]
379
+ > ### 用途:
380
+ > - 获取指定关键词的话题搜索结果
381
+ > - 该接口已弃用,替代接口为:https://docs.tikhub.io/370212794e0
382
+ > ### 参数:
383
+ > - keyword: 关键词
384
+ > - offset: 偏移量
385
+ > - count: 数量,请保持默认,否则会出现BUG。
386
+ > ### 返回:
387
+ > - 话题搜索结果
388
+ >
389
+ > # [English]
390
+ > ### Purpose:
391
+ > - Get hashtag search results of specified keywords
392
+ > - This interface has been deprecated, and the alternative interface is: https://docs.tikhub.io/370212794e0
393
+ > ### Parameters:
394
+ > - keyword: Keyword
395
+ > - offset: Offset
396
+ > - count: Number Please keep the default, otherwise there will be BUG.
397
+ > ### Return:
398
+ > - Hashtag search results
399
+ >
400
+ > # [示例/Example]
401
+ > keyword = "中华娘"
402
+ > offset = 0
403
+ > count = 20
404
+
405
+ #### Parameters
406
+
407
+ | Field | In | Type | Required | Description | Default | Example | Enum |
408
+ | --- | --- | --- | --- | --- | --- | --- | --- |
409
+ | keyword | query | string | Yes | 关键词/Keyword | None | 中华娘 | None |
410
+ | offset | query | integer | No | 偏移量/Offset | 0 | None | None |
411
+ | count | query | integer | No | 数量/Number | 20 | None | None |
412
+
413
+ #### Request Body
414
+
415
+ None
416
+
417
+ #### Success Response
418
+
419
+ ##### `200 application/json`
420
+
421
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
422
+
423
+ | Field | Type | Required | Description | Default | Example | Enum |
424
+ | --- | --- | --- | --- | --- | --- | --- |
425
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
426
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
427
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
428
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
429
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
430
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
431
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
432
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
433
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
434
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
435
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
436
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
437
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
438
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
439
+ | data | null | No | The response data \| 响应数据 | None | None | None |
440
+
441
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-hashtag-video-list"></a>
442
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_hashtag_video_list`
443
+
444
+ - Summary: 获取指定话题的作品数据/Get video list of specified hashtag
445
+ - Capabilities: content details / topics
446
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
447
+ - operationId: `fetch_hashtag_video_list_api_v1_douyin_app_v3_fetch_hashtag_video_list_get`
448
+
449
+ #### Notes
450
+
451
+ > # [中文]
452
+ > ### 用途:
453
+ > - 获取指定话题的作品数据
454
+ > ### 参数:
455
+ > - ch_id: 话题id
456
+ > - cursor: 游标,用于翻页,第一页为0,第二页为第一次响应中的cursor值。
457
+ > - sort_type: 0:综合排序 1:最多点赞 2:最新发布
458
+ > - count: 数量,请保持默认,否则会出现BUG。
459
+ > ### 返回:
460
+ > - 话题作品数据
461
+ >
462
+ > # [English]
463
+ > ### Purpose:
464
+ > - Get video list of specified hashtag
465
+ > ### Parameters:
466
+ > - ch_id: Hashtag id
467
+ > - cursor: Cursor, used for paging, the first page is 0, the second page is the cursor value in the first response.
468
+ > - sort_type: 0: Comprehensive sorting 1: Most likes 2: Latest release
469
+ > - count: Number Please keep the default, otherwise there will be BUG.
470
+ > ### Return:
471
+ > - Hashtag video list data
472
+ >
473
+ > # [示例/Example]
474
+ > ch_id = 1575791821492238
475
+ > cursor = 0
476
+ > sort_type = 0
477
+ > count = 10
478
+
479
+ #### Parameters
480
+
481
+ | Field | In | Type | Required | Description | Default | Example | Enum |
482
+ | --- | --- | --- | --- | --- | --- | --- | --- |
483
+ | ch_id | query | string | Yes | 话题id/Hashtag id | None | 1575791821492238 | None |
484
+ | cursor | query | integer | No | 游标/Cursor | 0 | None | None |
485
+ | sort_type | query | integer | No | 排序类型/Sort type | 0 | None | None |
486
+ | count | query | integer | No | 数量/Number | 10 | None | None |
487
+
488
+ #### Request Body
489
+
490
+ None
491
+
492
+ #### Success Response
493
+
494
+ ##### `200 application/json`
495
+
496
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
497
+
498
+ | Field | Type | Required | Description | Default | Example | Enum |
499
+ | --- | --- | --- | --- | --- | --- | --- |
500
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
501
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
502
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
503
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
504
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
505
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
506
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
507
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
508
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
509
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
510
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
511
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
512
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
513
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
514
+ | data | null | No | The response data \| 响应数据 | None | None | None |
515
+
516
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-hot-search-list"></a>
517
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_hot_search_list`
518
+
519
+ - Summary: 获取抖音热搜榜数据/Get Douyin hot search list data
520
+ - Capabilities: search / trends / rankings
521
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
522
+ - operationId: `fetch_hot_search_list_api_v1_douyin_app_v3_fetch_hot_search_list_get`
523
+
524
+ #### Notes
525
+
526
+ > # [中文]
527
+ > ### 用途:
528
+ > - 获取抖音热榜数据,包括:
529
+ > - 热点榜
530
+ > - 种草榜
531
+ > - 娱乐榜
532
+ > - 社会榜
533
+ > - 挑战榜
534
+ > ### 参数:
535
+ > - board_type:
536
+ > - 0: 热点榜(默认)
537
+ > - 2: 其他榜单,如种草榜等,需要传入对应的board_sub_type参数。
538
+ > - board_sub_type:
539
+ > - 空字符串: 热点榜(默认)
540
+ > - seeding: 种草榜
541
+ > - 2: 娱乐榜
542
+ > - 4: 社会榜
543
+ > - hotspot_challenge: 挑战榜
544
+ > ### 返回:
545
+ > - 热搜榜数据
546
+ >
547
+ > # [English]
548
+ > ### Purpose:
549
+ > - Get Douyin hot search list data, including:
550
+ > - Hot search list
551
+ > - Seeding list
552
+ > - Entertainment list
553
+ > - Social list
554
+ > - Challenge list
555
+ >
556
+ > ### Parameters:
557
+ > - board_type:
558
+ > - 0: Hot search list (default)
559
+ > - 2: Other lists, such as seeding list, etc., need to pass in the corresponding board_sub_type parameter.
560
+ > - board_sub_type:
561
+ > - Empty string: Hot search list (default)
562
+ > - seeding: Seeding list
563
+ > - 2: Entertainment list
564
+ > - 4: Social list
565
+ > - hotspot_challenge: Challenge list
566
+ > ### Return:
567
+ > - Hot search list data
568
+ >
569
+ > # [示例/Example]
570
+ > - 获取热点榜数据
571
+ > - board_type = 0
572
+ > - board_sub_type = ""
573
+ > - 获取种草榜数据
574
+ > - board_type = 2
575
+ > - board_sub_type = "seeding"
576
+
577
+ #### Parameters
578
+
579
+ | Field | In | Type | Required | Description | Default | Example | Enum |
580
+ | --- | --- | --- | --- | --- | --- | --- | --- |
581
+ | board_type | query | string | No | 榜单类型/Board type | 0 | None | None |
582
+ | board_sub_type | query | string | No | 榜单子类型/Board sub type | None | None | None |
583
+
584
+ #### Request Body
585
+
586
+ None
587
+
588
+ #### Success Response
589
+
590
+ ##### `200 application/json`
591
+
592
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
593
+
594
+ | Field | Type | Required | Description | Default | Example | Enum |
595
+ | --- | --- | --- | --- | --- | --- | --- |
596
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
597
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
598
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
599
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
600
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
601
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
602
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
603
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
604
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
605
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
606
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
607
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
608
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
609
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
610
+ | data | null | No | The response data \| 响应数据 | None | None | None |
611
+
612
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-live-hot-search-list"></a>
613
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_live_hot_search_list`
614
+
615
+ - Summary: 获取抖音直播热搜榜数据/Get Douyin live hot search list data
616
+ - Capabilities: search / trends / rankings / livestream
617
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
618
+ - operationId: `fetch_live_hot_search_list_api_v1_douyin_app_v3_fetch_live_hot_search_list_get`
619
+
620
+ #### Notes
621
+
622
+ > # [中文]
623
+ > ### 用途:
624
+ > - 获取抖音直播热搜榜数据
625
+ > ### 返回:
626
+ > - 直播热搜榜数据
627
+ >
628
+ > # [English]
629
+ > ### Purpose:
630
+ > - Get Douyin live hot search list data
631
+ > ### Return:
632
+ > - Live hot search list data
633
+ >
634
+ > # [示例/Example]
635
+ > pass
636
+
637
+ #### Parameters
638
+
639
+ None
640
+
641
+ #### Request Body
642
+
643
+ None
644
+
645
+ #### Success Response
646
+
647
+ ##### `200 application/json`
648
+
649
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
650
+
651
+ | Field | Type | Required | Description | Default | Example | Enum |
652
+ | --- | --- | --- | --- | --- | --- | --- |
653
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
654
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
655
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
656
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
657
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
658
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
659
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
660
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
661
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
662
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
663
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
664
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
665
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
666
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
667
+ | data | null | No | The response data \| 响应数据 | None | None | None |
668
+
669
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-live-search-result"></a>
670
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_live_search_result`
671
+
672
+ - Summary: 获取指定关键词的直播搜索结果(弃用,替代接口见下方文档说明)/Get live search results of specified keywords (deprecated, see the documentation below for alternative interfaces)
673
+ - Capabilities: search / livestream
674
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
675
+ - operationId: `fetch_live_search_result_api_v1_douyin_app_v3_fetch_live_search_result_get`
676
+
677
+ #### Notes
678
+
679
+ > # [中文]
680
+ > ### 用途:
681
+ > - 获取指定关键词的直播搜索结果
682
+ > - 该接口已弃用,替代接口为:https://docs.tikhub.io/370212789e0
683
+ > ### 参数:
684
+ > - keyword: 关键词
685
+ > - cursor: 偏移量,从0开始,每次请求从上次请求返回响应中的cursor中获取。
686
+ > - count: 数量,请保持默认,否则会出现BUG。
687
+ > ### 返回:
688
+ > - 直播搜索结果
689
+ >
690
+ > # [English]
691
+ > ### Purpose:
692
+ > - Get live search results of specified keywords
693
+ > - This interface has been deprecated, and the alternative interface is: https://docs.tikhub.io/370212789e0
694
+ > ### Parameters:
695
+ > - keyword: Keyword
696
+ > - cursor: Offset, starting from 0, each request gets from the cursor in the response returned by the last request.
697
+ > - count: Number Please keep the default, otherwise there will be BUG.
698
+ > ### Return:
699
+ > - Live search results
700
+ >
701
+ > # [示例/Example]
702
+ > keyword = "小米商城"
703
+ > cursor = 0
704
+ > count = 20
705
+
706
+ #### Parameters
707
+
708
+ | Field | In | Type | Required | Description | Default | Example | Enum |
709
+ | --- | --- | --- | --- | --- | --- | --- | --- |
710
+ | keyword | query | string | Yes | 关键词/Keyword | None | 小米商城 | None |
711
+ | cursor | query | integer | No | 偏移量/Offset | 0 | None | None |
712
+ | count | query | integer | No | 数量/Number | 20 | None | None |
713
+
714
+ #### Request Body
715
+
716
+ None
717
+
718
+ #### Success Response
719
+
720
+ ##### `200 application/json`
721
+
722
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
723
+
724
+ | Field | Type | Required | Description | Default | Example | Enum |
725
+ | --- | --- | --- | --- | --- | --- | --- |
726
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
727
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
728
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
729
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
730
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
731
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
732
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
733
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
734
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
735
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
736
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
737
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
738
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
739
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
740
+ | data | null | No | The response data \| 响应数据 | None | None | None |
741
+
742
+ <a id="post-api-u1-v1-douyin-app-v3-fetch-multi-video"></a>
743
+ ### `POST /api/u1/v1/douyin/app/v3/fetch_multi_video`
744
+
745
+ - Summary: 批量获取视频信息 V1/Batch Get Video Information V1
746
+ - Capabilities: content details
747
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
748
+ - operationId: `fetch_multi_video_api_v1_douyin_app_v3_fetch_multi_video_post`
749
+
750
+ #### Notes
751
+
752
+ > # [中文]
753
+ > ### 用途:
754
+ > - 批量获取视频信息,支持图文、视频等,一次性最多支持10个视频,此接口收费固定价格为0.001$ * 10 = 0.01$一次。
755
+ > ### 参数:
756
+ > - aweme_ids: 作品id列表,最多支持10个作品id。
757
+ > ### 返回:
758
+ > - 作品数据
759
+ > ### 备注:
760
+ > - 如果接口出现返回空的情况,请使用一样的参数去请求 Web 版本接口,具体响应状态码参考:
761
+ > - JSON PATH: $.data.filter_list[0].reason
762
+ > - 8:该内容因海外版权限制,暂时无法观看(短剧,电影片段等)
763
+ > - 8:视频不存在或已被删除
764
+ > - 5:该内容被标记为私人内容,没有公开展示权限
765
+ > - 10:该内容被标记为部分可见,仅作者选择的部分用户可见
766
+ > - 更多状态码请提交给我们的客户支持进行补充。
767
+ >
768
+ > # [English]
769
+ > ### Purpose:
770
+ > - Batch Get Video Information, support photo, video, etc., up to 10 videos at a time, this interface charges a fixed price of 0.001$ * 10 = 0.01$ each time.
771
+ > ### Parameters:
772
+ > - aweme_ids: List of video ids, up to 10 video ids are supported.
773
+ > ### Return:
774
+ > - Video data
775
+ > ### Note:
776
+ > - If the interface returns empty, please use the same parameters to request the Web version interface. The specific response status code refers to:
777
+ > - JSON PATH: $.data.filter_list[0].reason
778
+ > - 8: This content is temporarily unavailable for viewing due to overseas copyright restrictions (short dramas, movie clips, etc.)
779
+ > - 8: The video does not exist or has been deleted
780
+ > - 5: This content is marked as private content and does not have public display permissions
781
+ > - 10: This content is marked as partially visible, only visible to some users chosen by the author
782
+ > - For more status codes, please submit them to our customer support for supplementation.
783
+ >
784
+ > # [示例/Example]
785
+ > aweme_ids = ["7448118827402972455", "7126745726494821640", "7448118827402972455", "7126745726494821640", "7448118827402972455", "7126745726494821640", "7448118827402972455", "7126745726494821640", "7448118827402972455", "7126745726494821640"]
786
+
787
+ #### Parameters
788
+
789
+ None
790
+
791
+ #### Request Body
792
+
793
+ - required: Yes
794
+
795
+ ##### `application/json`
796
+
797
+ - Schema summary: [string]
798
+
799
+ | Field | Type | Required | Description | Default | Example | Enum |
800
+ | --- | --- | --- | --- | --- | --- | --- |
801
+ | [] | array<string> | Yes | None | None | None | None |
802
+
803
+ #### Success Response
804
+
805
+ ##### `200 application/json`
806
+
807
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
808
+
809
+ | Field | Type | Required | Description | Default | Example | Enum |
810
+ | --- | --- | --- | --- | --- | --- | --- |
811
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
812
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
813
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
814
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
815
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
816
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
817
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
818
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
819
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
820
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
821
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
822
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
823
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
824
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
825
+ | data | null | No | The response data \| 响应数据 | None | None | None |
826
+
827
+ <a id="post-api-u1-v1-douyin-app-v3-fetch-multi-video-high-quality-play-url"></a>
828
+ ### `POST /api/u1/v1/douyin/app/v3/fetch_multi_video_high_quality_play_url`
829
+
830
+ - Summary: 批量获取视频的最高画质播放链接/Batch get the highest quality play URL of videos
831
+ - Capabilities: content details
832
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
833
+ - operationId: `fetch_multi_video_high_quality_play_url_api_v1_douyin_app_v3_fetch_multi_video_high_quality_play_url_post`
834
+
835
+ #### Notes
836
+
837
+ > # [中文]
838
+ > ### 用途:
839
+ > - 此接口目前优惠活动价为$0.25,活动结束后恢复原价$0.5。不足50个视频按50个视频收费。
840
+ > - 批量获取视频的最高画质(原始上传画质)播放链接
841
+ > - 该接口会返回最高画质的播放链接,原始上传画质是指用户上传视频时的画质,通常最高画质视频无压缩码率并且文件头包含元数据。
842
+ > - 最高画质的视频链接无法从抖音APP或网页版直接获取,需要通过此接口获取。
843
+ > - 此接口非常适合用于批量获取高清无水印视频链接,适用于需要高质量视频的场景,如视频编辑、存档、训练模型等。
844
+ > - 使用并发请求,提高批量获取效率。
845
+ > - 最多支持50个视频ID。
846
+ > ### 参数:
847
+ > - aweme_ids: 作品id列表,用逗号分隔,例如: "123,456,789",最多50个。
848
+ > ### 返回:
849
+ > - total: 总数
850
+ > - success_count: 成功数量
851
+ > - failed_count: 失败数量
852
+ > - videos: 视频列表,每个视频包含以下字段:
853
+ > - video_id: 作品id
854
+ > - original_video_url: 最高画质(原始上传画质)播放链接
855
+ > - file_size: 文件大小(字节)
856
+ > - file_size_in_mb: 文件大小(MB)
857
+ > - content_type: 内容类型
858
+ > - success: 是否成功
859
+ > - error: 错误信息(如果失败)
860
+ > ### 备注:
861
+ > - 由于数量较多,处理时间可能会稍长,请增加等待时间。
862
+ >
863
+ > # [English]
864
+ > ### Purpose:
865
+ > - This interface is currently on sale for $0.25, and will return to the original price of $0.5 after the event ends. If there are less than 50 videos, they will be charged as 50 videos.
866
+ > - Batch get the highest quality (original upload quality) play URL of videos
867
+ > - This interface will return the highest quality play URL, the original upload quality refers to the quality of the video when the user uploads it, usually the highest quality video has an uncompressed bitrate and the file header contains metadata.
868
+ > - The highest quality video link cannot be obtained directly from the Douyin APP or web version, and must be obtained through this interface.
869
+ > - This interface is very suitable for batch obtaining high-definition, watermark-free video links, suitable for scenarios that require high-quality videos, such as video editing, archiving, training models, etc.
870
+ > - Use concurrent requests to improve batch acquisition efficiency.
871
+ > - Support up to 50 video IDs.
872
+ > ### Parameters:
873
+ > - aweme_ids: Video id list, separated by commas, for example: "123,456,789", up to 50.
874
+ > ### Return:
875
+ > - total: Total count
876
+ > - success_count: Success count
877
+ > - failed_count: Failed count
878
+ > - videos: Video list, each video contains the following fields:
879
+ > - video_id: Video id
880
+ > - original_video_url: Highest quality (original upload quality) play URL
881
+ > - file_size: File size (bytes)
882
+ > - file_size_in_mb: File size (MB)
883
+ > - content_type: Content type
884
+ > - success: Whether successful
885
+ > - error: Error message (if failed)
886
+ > ### Note:
887
+ > - Due to the large number, the processing time may be slightly longer, please increase the waiting time.
888
+ > # [示例/Example]
889
+ > aweme_ids = "7512756548356492544,7448118827402972455,7126745726494821640"
890
+
891
+ #### Parameters
892
+
893
+ None
894
+
895
+ #### Request Body
896
+
897
+ - required: Yes
898
+
899
+ ##### `application/json`
900
+
901
+ - Schema summary: `aweme_ids`:string
902
+
903
+ | Field | Type | Required | Description | Default | Example | Enum |
904
+ | --- | --- | --- | --- | --- | --- | --- |
905
+ | aweme_ids | string | No | 作品id列表,用逗号分隔,最多50个/Video id list, separated by commas, up to 50 | 7512756548356492544,7448118827402972455,7126745726494821640 | None | None |
906
+
907
+ #### Success Response
908
+
909
+ ##### `200 application/json`
910
+
911
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
912
+
913
+ | Field | Type | Required | Description | Default | Example | Enum |
914
+ | --- | --- | --- | --- | --- | --- | --- |
915
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
916
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
917
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
918
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
919
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
920
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
921
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
922
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
923
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
924
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
925
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
926
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
927
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
928
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
929
+ | data | null | No | The response data \| 响应数据 | None | None | None |
930
+
931
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-multi-video-statistics"></a>
932
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_multi_video_statistics`
933
+
934
+ - Summary: 根据视频ID批量获取作品的统计数据(点赞数、下载数、播放数、分享数)/Get the statistical data of the Post according to the video ID (like count, download count, play count, share count)
935
+ - Capabilities: content details
936
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
937
+ - operationId: `fetch_multi_video_statistics_api_v1_douyin_app_v3_fetch_multi_video_statistics_get`
938
+
939
+ #### Notes
940
+
941
+ > # [中文]
942
+ > ### 用途:
943
+ > - 根据视频ID获取作品的统计数据,支持多个视频id,一次性最多支持50个视频。
944
+ > - 抖音大多数接口已经不再返回作品的播放数,只能通过此接口获取。
945
+ > - 价格为:0.025$一次。
946
+ > - 可以获取到的统计有:
947
+ > - 点赞数(digg_count)
948
+ > - 下载数(download_count)
949
+ > - 播放数(play_count)
950
+ > - 分享数(share_count)
951
+ > ### 参数:
952
+ > - aweme_ids: 作品id,支持多个视频id,用逗号隔开即可,不能超过50个,单个也可以,则无需逗号。
953
+ > ### 返回:
954
+ > - 作品统计数据
955
+ >
956
+ > # [English]
957
+ > ### Purpose:
958
+ > - Get the statistical data of the Post according to the video ID, support multiple video ids, up to 50 videos at a time.
959
+ > - Most of the Douyin interfaces no longer return the number of plays of the Post, and can only be obtained through this interface.
960
+ > - Price: 0.025$ each time.
961
+ > - List of statistics that can be obtained:
962
+ > - Like count (digg_count)
963
+ > - Download count (download_count)
964
+ > - Play count (play_count)
965
+ > - Share count (share_count)
966
+ > ### Parameters:
967
+ > - aweme_ids: Video id, supports multiple video ids, separated by commas, no more than 50, single is also possible, no need for commas.
968
+ > ### Return:
969
+ > - Post statistics data
970
+ >
971
+ > # [示例/Example]
972
+ > aweme_ids = "7448118827402972455,7126745726494821640"
973
+
974
+ #### Parameters
975
+
976
+ | Field | In | Type | Required | Description | Default | Example | Enum |
977
+ | --- | --- | --- | --- | --- | --- | --- | --- |
978
+ | aweme_ids | query | string | Yes | 作品id/Video id | None | 7448118827402972455,7126745726494821640 | None |
979
+
980
+ #### Request Body
981
+
982
+ None
983
+
984
+ #### Success Response
985
+
986
+ ##### `200 application/json`
987
+
988
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
989
+
990
+ | Field | Type | Required | Description | Default | Example | Enum |
991
+ | --- | --- | --- | --- | --- | --- | --- |
992
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
993
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
994
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
995
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
996
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
997
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
998
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
999
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1000
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1001
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
1002
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1003
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1004
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1005
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1006
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1007
+
1008
+ <a id="post-api-u1-v1-douyin-app-v3-fetch-multi-video-v2"></a>
1009
+ ### `POST /api/u1/v1/douyin/app/v3/fetch_multi_video_v2`
1010
+
1011
+ - Summary: 批量获取视频信息 V2/Batch Get Video Information V2
1012
+ - Capabilities: content details
1013
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1014
+ - operationId: `fetch_multi_video_v2_api_v1_douyin_app_v3_fetch_multi_video_v2_post`
1015
+
1016
+ #### Notes
1017
+
1018
+ > # [中文]
1019
+ > ### 用途:
1020
+ > - 批量获取视频信息,支持图文、视频等,一次性最多支持50个视频,此接口收费固定价格为0.001$ * 50 = 0.05$一次。
1021
+ > ### 参数:
1022
+ > - aweme_ids: 作品id列表,最多支持50个作品id。
1023
+ > ### 返回:
1024
+ > - 作品数据
1025
+ > ### 备注:
1026
+ > - 如果接口出现返回空的情况,请使用一样的参数去请求 Web 版本接口,具体响应状态码参考:
1027
+ > - JSON PATH: $.data.filter_list[0].reason
1028
+ > - 8:该内容因海外版权限制,暂时无法观看(短剧,电影片段等)
1029
+ > - 8:视频不存在或已被删除
1030
+ > - 5:该内容被标记为私人内容,没有公开展示权限
1031
+ > - 10:该内容被标记为部分可见,仅作者选择的部分用户可见
1032
+ > - 更多状态码请提交给我们的客户支持进行补充。
1033
+ >
1034
+ > # [English]
1035
+ > ### Purpose:
1036
+ > - Batch Get Video Information, support photo, video, etc., up to 50 videos at a time, this interface charges a fixed price of 0.001$ * 50 = 0.05$ each time.
1037
+ > ### Parameters:
1038
+ > - aweme_ids: List of video ids, up to 50 video ids are supported.
1039
+ > ### Return:
1040
+ > - Video data
1041
+ > ### Note:
1042
+ > - If the interface returns empty, please use the same parameters to request the Web version interface. The specific response status code refers to:
1043
+ > - JSON PATH: $.data.filter_list[0].reason
1044
+ > - 8: This content is temporarily unavailable for viewing due to overseas copyright restrictions (short dramas, movie clips, etc.)
1045
+ > - 8: The video does not exist or has been deleted
1046
+ > - 5: This content is marked as private content and does not have public display permissions
1047
+ > - 10: This content is marked as partially visible, only visible to some users chosen by the author
1048
+ > - For more status codes, please submit them to our customer support for supplementation.
1049
+ >
1050
+ > # [示例/Example]
1051
+ > aweme_ids = ["7448118827402972455", "7126745726494821640", "7448118827402972455", "7126745726494821640", "7448118827402972455", "7126745726494821640", "7448118827402972455", "7126745726494821640", "7448118827402972455", "7126745726494821640"]
1052
+
1053
+ #### Parameters
1054
+
1055
+ None
1056
+
1057
+ #### Request Body
1058
+
1059
+ - required: Yes
1060
+
1061
+ ##### `application/json`
1062
+
1063
+ - Schema summary: [string]
1064
+
1065
+ | Field | Type | Required | Description | Default | Example | Enum |
1066
+ | --- | --- | --- | --- | --- | --- | --- |
1067
+ | [] | array<string> | Yes | None | None | None | None |
1068
+
1069
+ #### Success Response
1070
+
1071
+ ##### `200 application/json`
1072
+
1073
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1074
+
1075
+ | Field | Type | Required | Description | Default | Example | Enum |
1076
+ | --- | --- | --- | --- | --- | --- | --- |
1077
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1078
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1079
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1080
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1081
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1082
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1083
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1084
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1085
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1086
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
1087
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1088
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1089
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1090
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1091
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1092
+
1093
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-music-detail"></a>
1094
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_music_detail`
1095
+
1096
+ - Summary: 获取指定音乐的详情数据/Get details of specified music
1097
+ - Capabilities: details / music / audio
1098
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1099
+ - operationId: `fetch_music_detail_api_v1_douyin_app_v3_fetch_music_detail_get`
1100
+
1101
+ #### Notes
1102
+
1103
+ > # [中文]
1104
+ > ### 用途:
1105
+ > - 获取指定音乐的详情数据
1106
+ > ### 参数:
1107
+ > - music_id: 音乐id
1108
+ > ### 返回:
1109
+ > - 音乐详情数据
1110
+ >
1111
+ > # [English]
1112
+ > ### Purpose:
1113
+ > - Get details of specified music
1114
+ > ### Parameters:
1115
+ > - music_id: Music id
1116
+ > ### Return:
1117
+ > - Music details data
1118
+ >
1119
+ > # [示例/Example]
1120
+ > music_id = "7136850194742315016"
1121
+
1122
+ #### Parameters
1123
+
1124
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1125
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1126
+ | music_id | query | string | Yes | 音乐id/Music id | None | 7136850194742315016 | None |
1127
+
1128
+ #### Request Body
1129
+
1130
+ None
1131
+
1132
+ #### Success Response
1133
+
1134
+ ##### `200 application/json`
1135
+
1136
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1137
+
1138
+ | Field | Type | Required | Description | Default | Example | Enum |
1139
+ | --- | --- | --- | --- | --- | --- | --- |
1140
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1141
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1142
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1143
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1144
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1145
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1146
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1147
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1148
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1149
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
1150
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1151
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1152
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1153
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1154
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1155
+
1156
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-music-hot-search-list"></a>
1157
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_music_hot_search_list`
1158
+
1159
+ - Summary: 获取抖音音乐榜数据/Get Douyin music hot search list data
1160
+ - Capabilities: search / trends / rankings / music / audio
1161
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1162
+ - operationId: `fetch_music_hot_search_list_api_v1_douyin_app_v3_fetch_music_hot_search_list_get`
1163
+
1164
+ #### Notes
1165
+
1166
+ > # [中文]
1167
+ > ### 用途:
1168
+ > - 获取抖音音乐热榜数据
1169
+ > ### 参数:
1170
+ > - chart_type: 榜单类型,默认值为'hot',支持下面的值:
1171
+ > - 'hot': 热门榜
1172
+ > - 'trending': 飙升榜
1173
+ > - 'original': 原创榜
1174
+ > - cursor: 游标,默认值为'0',用于分页获取数据,每次请求后会返回下一个游标值,并且通过 `has_more` 字段指示是否有更多数据可供获取。
1175
+ > ### 返回:
1176
+ > - 音乐热搜榜数据
1177
+ >
1178
+ > # [English]
1179
+ > ### Purpose:
1180
+ > - Get Douyin music hot search list data
1181
+ > ### Parameters:
1182
+ > - chart_type: Chart type, default value is 'hot', supports the following values:
1183
+ > - 'hot': Hot chart
1184
+ > - 'trending': Trending chart
1185
+ > - 'original': Original chart
1186
+ > - cursor: Cursor, default value is '0', used for paginating data retrieval. After each request, the next cursor value will be returned, and the `has_more` field indicates whether there is more data available.
1187
+ > ### Return:
1188
+ > - Music hot search list data
1189
+ >
1190
+ > # [示例/Example]
1191
+ > chart_type = "hot"
1192
+ > cursor = "0"
1193
+
1194
+ #### Parameters
1195
+
1196
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1197
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1198
+ | chart_type | query | string | No | 榜单类型/Chart type | hot | hot | None |
1199
+ | cursor | query | string | No | 游标/Cursor | 0 | 0 | None |
1200
+
1201
+ #### Request Body
1202
+
1203
+ None
1204
+
1205
+ #### Success Response
1206
+
1207
+ ##### `200 application/json`
1208
+
1209
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1210
+
1211
+ | Field | Type | Required | Description | Default | Example | Enum |
1212
+ | --- | --- | --- | --- | --- | --- | --- |
1213
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1214
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1215
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1216
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1217
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1218
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1219
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1220
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1221
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1222
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
1223
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1224
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1225
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1226
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1227
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1228
+
1229
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-music-search-result"></a>
1230
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_music_search_result`
1231
+
1232
+ - Summary: 获取指定关键词的音乐搜索结果(弃用,替代接口见下方文档说明)/Get music search results of specified keywords (deprecated, see the documentation below for alternative interfaces)
1233
+ - Capabilities: search / music / audio
1234
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1235
+ - operationId: `fetch_music_search_result_api_v1_douyin_app_v3_fetch_music_search_result_get`
1236
+
1237
+ #### Notes
1238
+
1239
+ > # [中文]
1240
+ > ### 用途:
1241
+ > - 获取指定关键词的音乐搜索结果
1242
+ > - 该接口已弃用,替代接口为:https://docs.tikhub.io/370212797e0
1243
+ > ### 参数:
1244
+ > - keyword: 关键词
1245
+ > - offset: 偏移量
1246
+ > - count: 数量,请保持默认,否则会出现BUG。
1247
+ > ### 返回:
1248
+ > - 音乐搜索结果
1249
+ >
1250
+ > # [English]
1251
+ > ### Purpose:
1252
+ > - Get music search results of specified keywords
1253
+ > - This interface has been deprecated, and the alternative interface is: https://docs.tikhub.io/370212797e0
1254
+ > ### Parameters:
1255
+ > - keyword: Keyword
1256
+ > - offset: Offset
1257
+ > - count: Number Please keep the default, otherwise there will be BUG.
1258
+ > ### Return:
1259
+ > - Music search results
1260
+ >
1261
+ > # [示例/Example]
1262
+ > keyword = "中华娘"
1263
+ > offset = 0
1264
+ > count = 20
1265
+
1266
+ #### Parameters
1267
+
1268
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1269
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1270
+ | keyword | query | string | Yes | 关键词/Keyword | None | 中华娘 | None |
1271
+ | offset | query | integer | No | 偏移量/Offset | 0 | None | None |
1272
+ | count | query | integer | No | 数量/Number | 20 | None | None |
1273
+
1274
+ #### Request Body
1275
+
1276
+ None
1277
+
1278
+ #### Success Response
1279
+
1280
+ ##### `200 application/json`
1281
+
1282
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1283
+
1284
+ | Field | Type | Required | Description | Default | Example | Enum |
1285
+ | --- | --- | --- | --- | --- | --- | --- |
1286
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1287
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1288
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1289
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1290
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1291
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1292
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1293
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1294
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1295
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
1296
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1297
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1298
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1299
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1300
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1301
+
1302
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-music-video-list"></a>
1303
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_music_video_list`
1304
+
1305
+ - Summary: 获取指定音乐的视频列表数据/Get video list of specified music
1306
+ - Capabilities: content details / music / audio
1307
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1308
+ - operationId: `fetch_music_video_list_api_v1_douyin_app_v3_fetch_music_video_list_get`
1309
+
1310
+ #### Notes
1311
+
1312
+ > # [中文]
1313
+ > ### 用途:
1314
+ > - 获取指定音乐的视频列表数据
1315
+ > ### 参数:
1316
+ > - music_id: 音乐id
1317
+ > - cursor: 游标,用于翻页,第一页为0,第二页为第一次响应中的cursor值。
1318
+ > - count: 数量,请保持默认,否则会出现BUG。
1319
+ > ### 返回:
1320
+ > - 音乐视频列表数据
1321
+ >
1322
+ > # [English]
1323
+ > ### Purpose:
1324
+ > - Get video list of specified music
1325
+ > ### Parameters:
1326
+ > - music_id: Music id
1327
+ > - cursor: Cursor, used for paging, the first page is 0, the second page is the cursor value in the first response.
1328
+ > - count: Number Please keep the default, otherwise there will be BUG.
1329
+ > ### Return:
1330
+ > - Music video list data
1331
+ >
1332
+ > # [示例/Example]
1333
+ > music_id = "7136850194742315016"
1334
+ > cursor = 0
1335
+ > count = 10
1336
+
1337
+ #### Parameters
1338
+
1339
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1340
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1341
+ | music_id | query | string | Yes | 音乐id/Music id | None | 7136850194742315016 | None |
1342
+ | cursor | query | integer | No | 游标/Cursor | 0 | None | None |
1343
+ | count | query | integer | No | 数量/Number | 10 | None | None |
1344
+
1345
+ #### Request Body
1346
+
1347
+ None
1348
+
1349
+ #### Success Response
1350
+
1351
+ ##### `200 application/json`
1352
+
1353
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1354
+
1355
+ | Field | Type | Required | Description | Default | Example | Enum |
1356
+ | --- | --- | --- | --- | --- | --- | --- |
1357
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1358
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1359
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1360
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1361
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1362
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1363
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1364
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1365
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1366
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
1367
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1368
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1369
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1370
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1371
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1372
+
1373
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-one-video"></a>
1374
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_one_video`
1375
+
1376
+ - Summary: 获取单个作品数据/Get single video data
1377
+ - Capabilities: content details
1378
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1379
+ - operationId: `fetch_one_video_api_v1_douyin_app_v3_fetch_one_video_get`
1380
+
1381
+ #### Notes
1382
+
1383
+ > # [中文]
1384
+ > ### 用途:
1385
+ > - 获取单个作品数据,支持图文、视频等。
1386
+ > ### 参数:
1387
+ > - aweme_id: 作品id
1388
+ > ### 返回:
1389
+ > - 作品数据
1390
+ > ### 备注:
1391
+ > - 如果接口出现返回空的情况,请使用一样的参数去请求 Web 版本接口,具体响应状态码参考:
1392
+ > - JSON PATH: $.data.filter_list[0].reason
1393
+ > - 8:该内容因海外版权限制,暂时无法观看(短剧,电影片段等)
1394
+ > - 8:视频不存在或已被删除
1395
+ > - 5:该内容被标记为私人内容,没有公开展示权限
1396
+ > - 10:该内容被标记为部分可见,仅作者选择的部分用户可见
1397
+ > - 更多状态码请提交给我们的客户支持进行补充。
1398
+ >
1399
+ > # [English]
1400
+ > ### Purpose:
1401
+ > - Get single video data, support photo, video, etc.
1402
+ > ### Parameters:
1403
+ > - aweme_id: Video id
1404
+ > ### Return:
1405
+ > - Video data
1406
+ > ### Note:
1407
+ > - If the interface returns empty, please use the same parameters to request the Web version interface. The specific response status code refers to:
1408
+ > - JSON PATH: $.data.filter_list[0].reason
1409
+ > - 8: This content is temporarily unavailable for viewing due to overseas copyright restrictions (short dramas, movie clips, etc.)
1410
+ > - 8: The video does not exist or has been deleted
1411
+ > - 5: This content is marked as private content and does not have public display permissions
1412
+ > - 10: This content is marked as partially visible, only visible to some users chosen by the author
1413
+ > - For more status codes, please submit them to our customer support for supplementation.
1414
+ >
1415
+ > # [示例/Example]
1416
+ > aweme_id = "7448118827402972455"
1417
+
1418
+ #### Parameters
1419
+
1420
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1421
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1422
+ | aweme_id | query | string | Yes | 作品id/Video id | None | 7448118827402972455 | None |
1423
+
1424
+ #### Request Body
1425
+
1426
+ None
1427
+
1428
+ #### Success Response
1429
+
1430
+ ##### `200 application/json`
1431
+
1432
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1433
+
1434
+ | Field | Type | Required | Description | Default | Example | Enum |
1435
+ | --- | --- | --- | --- | --- | --- | --- |
1436
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1437
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1438
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1439
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1440
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1441
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1442
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1443
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1444
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1445
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
1446
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1447
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1448
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1449
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1450
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1451
+
1452
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-one-video-by-share-url"></a>
1453
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_one_video_by_share_url`
1454
+
1455
+ - Summary: 根据分享链接获取单个作品数据/Get single video data by sharing link
1456
+ - Capabilities: content details
1457
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1458
+ - operationId: `fetch_one_video_by_share_url_api_v1_douyin_app_v3_fetch_one_video_by_share_url_get`
1459
+
1460
+ #### Notes
1461
+
1462
+ > # [中文]
1463
+ > ### 用途:
1464
+ > - 根据分享链接获取单个作品数据
1465
+ > ### 参数:
1466
+ > - share_url: 分享链接
1467
+ > ### 返回:
1468
+ > - 作品数据
1469
+ > ### 备注:
1470
+ > - 如果接口出现返回空的情况,请使用一样的参数去请求 Web 版本接口,具体响应状态码参考:
1471
+ > - JSON PATH: $.data.filter_list[0].reason
1472
+ > - 8:该内容因海外版权限制,暂时无法观看(短剧,电影片段等)
1473
+ > - 8:视频不存在或已被删除
1474
+ > - 5:该内容被标记为私人内容,没有公开展示权限
1475
+ > - 10:该内容被标记为部分可见,仅作者选择的部分用户可见
1476
+ > - 更多状态码请提交给我们的客户支持进行补充。
1477
+ >
1478
+ > # [English]
1479
+ > ### Purpose:
1480
+ > - Get single video data by sharing link
1481
+ > ### Parameters:
1482
+ > - share_url: Share link
1483
+ > ### Return:
1484
+ > - Video data
1485
+ > ### Note:
1486
+ > - If the interface returns empty, please use the same parameters to request the Web version interface. The specific response status code refers to:
1487
+ > - JSON PATH: $.data.filter_list[0].reason
1488
+ > - 8: This content is temporarily unavailable for viewing due to overseas copyright restrictions (short dramas, movie clips, etc.)
1489
+ > - 8: The video does not exist or has been deleted
1490
+ > - 5: This content is marked as private content and does not have public display permissions
1491
+ > - 10: This content is marked as partially visible, only visible to some users chosen by the author
1492
+ > - For more status codes, please submit them to our customer support for supplementation.
1493
+ >
1494
+ > # [示例/Example]
1495
+ > share_url = "https://v.douyin.com/e3x2fjE/"
1496
+
1497
+ #### Parameters
1498
+
1499
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1500
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1501
+ | share_url | query | string | Yes | 分享链接/Share link | None | https://v.douyin.com/e3x2fjE/ | None |
1502
+
1503
+ #### Request Body
1504
+
1505
+ None
1506
+
1507
+ #### Success Response
1508
+
1509
+ ##### `200 application/json`
1510
+
1511
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1512
+
1513
+ | Field | Type | Required | Description | Default | Example | Enum |
1514
+ | --- | --- | --- | --- | --- | --- | --- |
1515
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1516
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1517
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1518
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1519
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1520
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1521
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1522
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1523
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1524
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
1525
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1526
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1527
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1528
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1529
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1530
+
1531
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-one-video-v2"></a>
1532
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_one_video_v2`
1533
+
1534
+ - Summary: 获取单个作品数据 V2/Get single video data V2
1535
+ - Capabilities: content details
1536
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1537
+ - operationId: `fetch_one_video_v2_api_v1_douyin_app_v3_fetch_one_video_v2_get`
1538
+
1539
+ #### Notes
1540
+
1541
+ > # [中文]
1542
+ > ### 用途:
1543
+ > - 获取单个作品数据,支持图文、视频等。
1544
+ > ### 参数:
1545
+ > - aweme_id: 作品id
1546
+ > ### 返回:
1547
+ > - 作品数据
1548
+ > ### 备注:
1549
+ > - 如果接口出现返回空的情况,请使用一样的参数去请求 Web 版本接口,具体响应状态码参考:
1550
+ > - JSON PATH: $.data.filter_list[0].reason
1551
+ > - 8:该内容因海外版权限制,暂时无法观看(短剧,电影片段等)
1552
+ > - 8:视频不存在或已被删除
1553
+ > - 5:该内容被标记为私人内容,没有公开展示权限
1554
+ > - 10:该内容被标记为部分可见,仅作者选择的部分用户可见
1555
+ > - 更多状态码请提交给我们的客户支持进行补充。
1556
+ >
1557
+ > # [English]
1558
+ > ### Purpose:
1559
+ > - Get single video data, support photo, video, etc.
1560
+ > ### Parameters:
1561
+ > - aweme_id: Video id
1562
+ > ### Return:
1563
+ > - Video data
1564
+ > ### Note:
1565
+ > - If the interface returns empty, please use the same parameters to request the Web version interface. The specific response status code refers to:
1566
+ > - JSON PATH: $.data.filter_list[0].reason
1567
+ > - 8: This content is temporarily unavailable for viewing due to overseas copyright restrictions (short dramas, movie clips, etc.)
1568
+ > - 8: The video does not exist or has been deleted
1569
+ > - 5: This content is marked as private content and does not have public display permissions
1570
+ > - 10: This content is marked as partially visible, only visible to some users chosen by the author
1571
+ > - For more status codes, please submit them to our customer support for supplementation.
1572
+ >
1573
+ > # [示例/Example]
1574
+ > aweme_id = "7448118827402972455"
1575
+
1576
+ #### Parameters
1577
+
1578
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1579
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1580
+ | aweme_id | query | string | Yes | 作品id/Video id | None | 7448118827402972455 | None |
1581
+
1582
+ #### Request Body
1583
+
1584
+ None
1585
+
1586
+ #### Success Response
1587
+
1588
+ ##### `200 application/json`
1589
+
1590
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1591
+
1592
+ | Field | Type | Required | Description | Default | Example | Enum |
1593
+ | --- | --- | --- | --- | --- | --- | --- |
1594
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1595
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1596
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1597
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1598
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1599
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1600
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1601
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1602
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1603
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
1604
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1605
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1606
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1607
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1608
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1609
+
1610
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-one-video-v3"></a>
1611
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_one_video_v3`
1612
+
1613
+ - Summary: 获取单个作品数据 V3 (无版权限制)/Get single video data V3 (No copyright restrictions)
1614
+ - Capabilities: content details
1615
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1616
+ - operationId: `fetch_one_video_v3_api_v1_douyin_app_v3_fetch_one_video_v3_get`
1617
+
1618
+ #### Notes
1619
+
1620
+ > # [中文]
1621
+ > ### 用途:
1622
+ > - 获取单个作品数据,支持文章、图文、视频等。
1623
+ > - V3版本的接口,解决了版权限制问题,可以获取更多受限内容,比如 V1,V2版本返回的Reason为8的内容和部分文章或短剧等。
1624
+ > ### 参数:
1625
+ > - aweme_id: 作品id
1626
+ > ### 返回:
1627
+ > - 作品数据
1628
+ >
1629
+ > # [English]
1630
+ > ### Purpose:
1631
+ > - Get single video data, support article, photo, video, etc.
1632
+ > - V3 version of the interface, which solves the copyright restriction problem and can obtain more restricted content, such as content with Reason 8 returned by V1 and V2 versions and some articles or short dramas.
1633
+ > ### Parameters:
1634
+ > - aweme_id: Video id
1635
+ > ### Return:
1636
+ > - Video data
1637
+ >
1638
+ > # [示例/Example]
1639
+ > aweme_id = "7592116912205630761"
1640
+
1641
+ #### Parameters
1642
+
1643
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1644
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1645
+ | aweme_id | query | string | Yes | 作品或文章ID/Video or Article ID | None | 7592116912205630761 | None |
1646
+
1647
+ #### Request Body
1648
+
1649
+ None
1650
+
1651
+ #### Success Response
1652
+
1653
+ ##### `200 application/json`
1654
+
1655
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1656
+
1657
+ | Field | Type | Required | Description | Default | Example | Enum |
1658
+ | --- | --- | --- | --- | --- | --- | --- |
1659
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1660
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1661
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1662
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1663
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1664
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1665
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1666
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1667
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1668
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
1669
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1670
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1671
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1672
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1673
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1674
+
1675
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-series-detail"></a>
1676
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_series_detail`
1677
+
1678
+ - Summary: 获取短剧详情信息/Get series detail
1679
+ - Capabilities: details
1680
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1681
+ - operationId: `fetch_series_detail_api_v1_douyin_app_v3_fetch_series_detail_get`
1682
+
1683
+ #### Notes
1684
+
1685
+ > # [中文]
1686
+ > ### 用途:
1687
+ > - 获取短剧详情信息
1688
+ > ### 参数:
1689
+ > - series_id: 短剧id
1690
+ > ### 返回:
1691
+ > - 短剧详情数据
1692
+ > ### 备注:
1693
+ > - 该接口返回短剧的详细信息,包括:
1694
+ > - 短剧名称、描述、封面
1695
+ > - 作者信息
1696
+ > - 总集数、更新状态
1697
+ > - 播放量、收藏量等统计数据
1698
+ > - 付费信息(如有)
1699
+ >
1700
+ > # [English]
1701
+ > ### Purpose:
1702
+ > - Get series/playlet detail information
1703
+ > ### Parameters:
1704
+ > - series_id: Series id
1705
+ > ### Return:
1706
+ > - Series detail data
1707
+ > ### Note:
1708
+ > - This interface returns detailed information of the series, including:
1709
+ > - Series name, description, cover
1710
+ > - Author information
1711
+ > - Total episodes, update status
1712
+ > - Play count, collection count and other statistics
1713
+ > - Payment information (if any)
1714
+ >
1715
+ > # [示例/Example]
1716
+ > series_id = "7592054624643713067"
1717
+
1718
+ #### Parameters
1719
+
1720
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1721
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1722
+ | series_id | query | string | Yes | 短剧id/Series id | None | 7592054624643713067 | None |
1723
+
1724
+ #### Request Body
1725
+
1726
+ None
1727
+
1728
+ #### Success Response
1729
+
1730
+ ##### `200 application/json`
1731
+
1732
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1733
+
1734
+ | Field | Type | Required | Description | Default | Example | Enum |
1735
+ | --- | --- | --- | --- | --- | --- | --- |
1736
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1737
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1738
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1739
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1740
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1741
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1742
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1743
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1744
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1745
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
1746
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1747
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1748
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1749
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1750
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1751
+
1752
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-series-video-list"></a>
1753
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_series_video_list`
1754
+
1755
+ - Summary: 获取短剧视频列表/Get series video list
1756
+ - Capabilities: content details
1757
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1758
+ - operationId: `fetch_series_video_list_api_v1_douyin_app_v3_fetch_series_video_list_get`
1759
+
1760
+ #### Notes
1761
+
1762
+ > # [中文]
1763
+ > ### 用途:
1764
+ > - 获取短剧视频列表
1765
+ > ### 参数:
1766
+ > - series_id: 短剧id
1767
+ > - cursor: 游标,用于翻页,第一页为0,第二页通常为count的值(如15)。
1768
+ > ### 返回:
1769
+ > - 短剧视频列表数据
1770
+ > ### 备注:
1771
+ > - 该接口返回短剧中的所有视频列表
1772
+ > - 响应中的 aweme_list 包含短剧的各集视频信息
1773
+ > - has_more 字段表示是否还有更多数据
1774
+ >
1775
+ > # [English]
1776
+ > ### Purpose:
1777
+ > - Get series/playlet video list
1778
+ > ### Parameters:
1779
+ > - series_id: Series id
1780
+ > - cursor: Cursor, used for paging, the first page is 0, the second page is usually the value of count (e.g., 15).
1781
+ > ### Return:
1782
+ > - Series video list data
1783
+ > ### Note:
1784
+ > - This interface returns all video list in the series
1785
+ > - The aweme_list in the response contains video information of each episode
1786
+ > - The has_more field indicates whether there is more data
1787
+ >
1788
+ > # [示例/Example]
1789
+ > series_id = "7592054624643713067"
1790
+ > cursor = 0
1791
+
1792
+ #### Parameters
1793
+
1794
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1795
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1796
+ | series_id | query | string | Yes | 短剧id/Series id | None | 7592054624643713067 | None |
1797
+ | cursor | query | integer | No | 游标/Cursor | 0 | None | None |
1798
+
1799
+ #### Request Body
1800
+
1801
+ None
1802
+
1803
+ #### Success Response
1804
+
1805
+ ##### `200 application/json`
1806
+
1807
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1808
+
1809
+ | Field | Type | Required | Description | Default | Example | Enum |
1810
+ | --- | --- | --- | --- | --- | --- | --- |
1811
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1812
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1813
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1814
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1815
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1816
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1817
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1818
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1819
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1820
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
1821
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1822
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1823
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1824
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1825
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1826
+
1827
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-share-info-by-share-code"></a>
1828
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_share_info_by_share_code`
1829
+
1830
+ - Summary: 根据分享口令获取分享信息/Get share info by share code
1831
+ - Capabilities: general
1832
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1833
+ - operationId: `fetch_one_video_by_share_url_api_v1_douyin_app_v3_fetch_share_info_by_share_code_get`
1834
+
1835
+ #### Notes
1836
+
1837
+ > # [中文]
1838
+ > ### 用途:
1839
+ > - 根据分享口令获取分享信息,比如抖音文章的分享口令提取分享人信息和文章ID等然后再去请求单一作品数据接口获取文章内容。
1840
+ > ### 参数:
1841
+ > - share_code: 分享口令
1842
+ > ### 返回:
1843
+ > - 分享信息,包含分享人信息和文章ID等
1844
+ >
1845
+ > # [English]
1846
+ > ### Purpose:
1847
+ > - Get share info by share code, such as extracting sharer information and article ID from Douyin article share code, and then requesting a single video data interface to get the article content.
1848
+ > ### Parameters:
1849
+ > - share_code: Share code
1850
+ > ### Return:
1851
+ > - Share info, including sharer information and article ID, etc.
1852
+ >
1853
+ > # [示例/Example]
1854
+ > share_code = "8:/ h@O.kP 05/21 【生意场上,装逼就是节省沟通成本】长按复制打开抖音,即可阅读文章 ︽︽2QnCB9aIZZ29︽︽"
1855
+
1856
+ #### Parameters
1857
+
1858
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1859
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1860
+ | share_code | query | string | Yes | 分享口令/Share code | None | 8:/ h@O.kP 05/21 【生意场上,装逼就是节省沟通成本】长按复制打开抖音,即可阅读文章 ︽︽2QnCB9aIZZ29︽︽ | None |
1861
+
1862
+ #### Request Body
1863
+
1864
+ None
1865
+
1866
+ #### Success Response
1867
+
1868
+ ##### `200 application/json`
1869
+
1870
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1871
+
1872
+ | Field | Type | Required | Description | Default | Example | Enum |
1873
+ | --- | --- | --- | --- | --- | --- | --- |
1874
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1875
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1876
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1877
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1878
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1879
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1880
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1881
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1882
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1883
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
1884
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1885
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1886
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1887
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1888
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1889
+
1890
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-user-fans-list"></a>
1891
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_user_fans_list`
1892
+
1893
+ - Summary: 获取用户粉丝列表/Get user fans list
1894
+ - Capabilities: profiles / accounts
1895
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1896
+ - operationId: `fetch_user_fans_list_api_v1_douyin_app_v3_fetch_user_fans_list_get`
1897
+
1898
+ #### Notes
1899
+
1900
+ > # [中文]
1901
+ > ### 用途:
1902
+ > - 获取用户粉丝列表
1903
+ > ### 参数:
1904
+ > - sec_user_id: 用户sec_user_id
1905
+ > - max_time: 最大时间戳,默认为0,后续从返回数据中获取,用于翻页。
1906
+ > - count: 数量,默认为20,建议保持不变。
1907
+ > ### 返回:
1908
+ > - 粉丝列表
1909
+ >
1910
+ > # [English]
1911
+ > ### Purpose:
1912
+ > - Get user fans list
1913
+ > ### Parameters:
1914
+ > - sec_user_id: User sec_user_id
1915
+ > - max_time: Maximum timestamp, default is 0, get from the returned data later, used for paging.
1916
+ > - count: Number, default is 20, it is recommended to keep it unchanged.
1917
+ > ### Return:
1918
+ > - Fans list
1919
+ >
1920
+ > # [示例/Example]
1921
+ > sec_user = "MS4wLjABAAAA9y04iBlVdeMQqTJbqsQZKb-tqWqWW29jPVJqideHT70"
1922
+ > max_time = "0"
1923
+ > count = 20
1924
+
1925
+ #### Parameters
1926
+
1927
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1928
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1929
+ | sec_user_id | query | string | No | 用户sec_user_id/User sec_user_id | MS4wLjABAAAA9y04iBlVdeMQqTJbqsQZKb-tqWqWW29jPVJqideHT70 | None | None |
1930
+ | max_time | query | string | No | 最大时间戳/Maximum timestamp | 0 | None | None |
1931
+ | count | query | integer | No | 数量/Number | 20 | None | None |
1932
+
1933
+ #### Request Body
1934
+
1935
+ None
1936
+
1937
+ #### Success Response
1938
+
1939
+ ##### `200 application/json`
1940
+
1941
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1942
+
1943
+ | Field | Type | Required | Description | Default | Example | Enum |
1944
+ | --- | --- | --- | --- | --- | --- | --- |
1945
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1946
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1947
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1948
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1949
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1950
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1951
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1952
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1953
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1954
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
1955
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1956
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1957
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1958
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1959
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1960
+
1961
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-user-following-list"></a>
1962
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_user_following_list`
1963
+
1964
+ - Summary: 获取用户关注列表 (弃用,使用 /api/v1/douyin/web/fetch_user_following_list 替代)/Get user following list (Deprecated, use /api/v1/douyin/web/fetch_user_following_list instead)
1965
+ - Capabilities: profiles / accounts
1966
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1967
+ - operationId: `fetch_user_following_list_api_v1_douyin_app_v3_fetch_user_following_list_get`
1968
+
1969
+ #### Notes
1970
+
1971
+ > # [中文]
1972
+ > ### 用途:
1973
+ > - 获取用户关注列表
1974
+ > ### 参数:
1975
+ > - sec_user_id: 用户sec_user_id
1976
+ > - max_time: 最大时间戳,默认为0,后续从返回数据中获取,用于翻页。
1977
+ > - count: 数量,默认为20,建议保持不变。
1978
+ > ### 返回:
1979
+ > - 关注列表
1980
+ >
1981
+ > # [English]
1982
+ > ### Purpose:
1983
+ > - Get user following list
1984
+ > ### Parameters:
1985
+ > - sec_user_id: User sec_user_id
1986
+ > - max_time: Maximum timestamp, default is 0, get from the returned data later, used for paging.
1987
+ > - count: Number, default is 20, it is recommended to keep it unchanged.
1988
+ > ### Return:
1989
+ > - Following list
1990
+ >
1991
+ > # [示例/Example]
1992
+ > sec_user = "MS4wLjABAAAA9y04iBlVdeMQqTJbqsQZKb-tqWqWW29jPVJqideHT70"
1993
+ > max_time = "0"
1994
+ > count = 20
1995
+
1996
+ #### Parameters
1997
+
1998
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1999
+ | --- | --- | --- | --- | --- | --- | --- | --- |
2000
+ | sec_user_id | query | string | No | 用户sec_user_id/User sec_user_id | MS4wLjABAAAA9y04iBlVdeMQqTJbqsQZKb-tqWqWW29jPVJqideHT70 | None | None |
2001
+ | max_time | query | string | No | 最大时间戳/Maximum timestamp | 0 | None | None |
2002
+ | count | query | integer | No | 数量/Number | 20 | None | None |
2003
+
2004
+ #### Request Body
2005
+
2006
+ None
2007
+
2008
+ #### Success Response
2009
+
2010
+ ##### `200 application/json`
2011
+
2012
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2013
+
2014
+ | Field | Type | Required | Description | Default | Example | Enum |
2015
+ | --- | --- | --- | --- | --- | --- | --- |
2016
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
2017
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
2018
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
2019
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
2020
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
2021
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
2022
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
2023
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
2024
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
2025
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
2026
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
2027
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
2028
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
2029
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
2030
+ | data | null | No | The response data \| 响应数据 | None | None | None |
2031
+
2032
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-user-like-videos"></a>
2033
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_user_like_videos`
2034
+
2035
+ - Summary: 获取用户喜欢作品数据/Get user like video data
2036
+ - Capabilities: profiles / accounts / content details
2037
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2038
+ - operationId: `fetch_user_like_videos_api_v1_douyin_app_v3_fetch_user_like_videos_get`
2039
+
2040
+ #### Notes
2041
+
2042
+ > # [中文]
2043
+ > ### 用途:
2044
+ > - 获取用户喜欢作品数据
2045
+ > ### 参数:
2046
+ > - sec_user_id: 用户sec_user_id
2047
+ > - max_cursor: 最大游标,用于翻页,第一页为0,第二页为第一次响应中的max_cursor值。
2048
+ > - count: 最大数量
2049
+ > ### 返回:
2050
+ > - 用户作品数据
2051
+ >
2052
+ > # [English]
2053
+ > ### Purpose:
2054
+ > - Get user like video data
2055
+ > ### Parameters:
2056
+ > - sec_user_id: User sec_user_id
2057
+ > - max_cursor: Maximum cursor, used for paging, the first page is 0, the second page is the max_cursor value in the first response.
2058
+ > - count: Maximum count number
2059
+ > ### Return:
2060
+ > - User video data
2061
+ >
2062
+ > # [示例/Example]
2063
+ > sec_user_id = "MS4wLjABAAAAW9FWcqS7RdQAWPd2AA5fL_ilmqsIFUCQ_Iym6Yh9_cUa6ZRqVLjVQSUjlHrfXY1Y"
2064
+ > max_cursor = 0
2065
+ > counts = 20
2066
+
2067
+ #### Parameters
2068
+
2069
+ | Field | In | Type | Required | Description | Default | Example | Enum |
2070
+ | --- | --- | --- | --- | --- | --- | --- | --- |
2071
+ | sec_user_id | query | string | Yes | 用户sec_user_id/User sec_user_id | None | MS4wLjABAAAAW9FWcqS7RdQAWPd2AA5fL_ilmqsIFUCQ_Iym6Yh9_cUa6ZRqVLjVQSUjlHrfXY1Y | None |
2072
+ | max_cursor | query | integer | No | 最大游标/Maximum cursor | 0 | None | None |
2073
+ | counts | query | integer | No | 每页数量/Number per page | 20 | None | None |
2074
+
2075
+ #### Request Body
2076
+
2077
+ None
2078
+
2079
+ #### Success Response
2080
+
2081
+ ##### `200 application/json`
2082
+
2083
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2084
+
2085
+ | Field | Type | Required | Description | Default | Example | Enum |
2086
+ | --- | --- | --- | --- | --- | --- | --- |
2087
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
2088
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
2089
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
2090
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
2091
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
2092
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
2093
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
2094
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
2095
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
2096
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
2097
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
2098
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
2099
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
2100
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
2101
+ | data | null | No | The response data \| 响应数据 | None | None | None |
2102
+
2103
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-user-post-videos"></a>
2104
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_user_post_videos`
2105
+
2106
+ - Summary: 获取用户主页作品数据/Get user homepage video data
2107
+ - Capabilities: profiles / accounts / content details
2108
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2109
+ - operationId: `fetch_user_post_videos_api_v1_douyin_app_v3_fetch_user_post_videos_get`
2110
+
2111
+ #### Notes
2112
+
2113
+ > # [中文]
2114
+ > ### 用途:
2115
+ > - 获取用户主页作品数据
2116
+ > ### 参数:
2117
+ > - sec_user_id: 用户sec_user_id
2118
+ > - max_cursor: 最大游标,用于翻页,第一页为0,第二页为第一次响应中的max_cursor值。
2119
+ > - count: 最大数量,不要超过20,建议保持不变。
2120
+ > - sort_type: 排序类型,可选值如下:
2121
+ > - `0`: 最新排序-默认
2122
+ > - `1`: 最热排序
2123
+ > ### 返回:
2124
+ > - 用户作品数据
2125
+ >
2126
+ > # [English]
2127
+ > ### Purpose:
2128
+ > - Get user homepage video data
2129
+ > ### Parameters:
2130
+ > - sec_user_id: User sec_user_id
2131
+ > - max_cursor: Maximum cursor, used for paging, the first page is 0, the second page is the max_cursor value in the first response.
2132
+ > - count: Maximum count number, do not exceed 20, it is recommended to keep it unchanged.
2133
+ > - sort_type: Sort type, optional values are as follows:
2134
+ > - `0`: Latest sorting - default
2135
+ > - `1`: Hottest sorting
2136
+ > ### Return:
2137
+ > - User video data
2138
+ >
2139
+ > # [示例/Example]
2140
+ > sec_user_id = "MS4wLjABAAAANXSltcLCzDGmdNFI2Q_QixVTr67NiYzjKOIP5s03CAE"
2141
+ > max_cursor = 0
2142
+ > counts = 20
2143
+ > sort_type = 0
2144
+
2145
+ #### Parameters
2146
+
2147
+ | Field | In | Type | Required | Description | Default | Example | Enum |
2148
+ | --- | --- | --- | --- | --- | --- | --- | --- |
2149
+ | sec_user_id | query | string | Yes | 用户sec_user_id/User sec_user_id | None | MS4wLjABAAAANXSltcLCzDGmdNFI2Q_QixVTr67NiYzjKOIP5s03CAE | None |
2150
+ | max_cursor | query | integer | No | 最大游标/Maximum cursor | 0 | None | None |
2151
+ | count | query | integer | No | 每页数量/Number per page | 20 | None | None |
2152
+ | sort_type | query | integer | No | 排序类型/Sort type | 0 | None | None |
2153
+
2154
+ #### Request Body
2155
+
2156
+ None
2157
+
2158
+ #### Success Response
2159
+
2160
+ ##### `200 application/json`
2161
+
2162
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2163
+
2164
+ | Field | Type | Required | Description | Default | Example | Enum |
2165
+ | --- | --- | --- | --- | --- | --- | --- |
2166
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
2167
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
2168
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
2169
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
2170
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
2171
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
2172
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
2173
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
2174
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
2175
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
2176
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
2177
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
2178
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
2179
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
2180
+ | data | null | No | The response data \| 响应数据 | None | None | None |
2181
+
2182
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-user-search-result"></a>
2183
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_user_search_result`
2184
+
2185
+ - Summary: 获取指定关键词的用户搜索结果(弃用,替代接口见下方文档说明)/Get user search results of specified keywords (deprecated, see the documentation below for alternative interfaces)
2186
+ - Capabilities: search / profiles / accounts
2187
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2188
+ - operationId: `fetch_user_search_result_api_v1_douyin_app_v3_fetch_user_search_result_get`
2189
+
2190
+ #### Notes
2191
+
2192
+ > # [中文]
2193
+ > ### 用途:
2194
+ > - 获取指定关键词的用户搜索结果
2195
+ > - 该接口已弃用,替代接口为:https://docs.tikhub.io/370212785e0
2196
+ > ### 参数:
2197
+ > - keyword: 关键词
2198
+ > - offset: 偏移量
2199
+ > - count: 数量,请保持默认,否则会出现BUG。
2200
+ > - douyin_user_fans(粉丝数量):
2201
+ > - "": 不限
2202
+ > - "0_1k": 1000以下
2203
+ > - "1k_1w": 1000-1万
2204
+ > - "1w_10w": 1w-10w
2205
+ > - "10w_100w": 10w-100w
2206
+ > - "100w_": 100w以上
2207
+ > - douyin_user_type(用户类型,请使用英文而不是中文):
2208
+ > - "": 不限
2209
+ > - "common_user": 普通用户
2210
+ > - "enterprise_user": 企业认证
2211
+ > - "personal_user": 个人认证
2212
+ > ### 返回:
2213
+ > - 用户搜索结果
2214
+ >
2215
+ > # [English]
2216
+ > ### Purpose:
2217
+ > - Get user search results of specified keywords
2218
+ > - This interface has been deprecated, and the alternative interface is: https://docs.tikhub.io/370212785e0
2219
+ > ### Parameters:
2220
+ > - keyword: Keyword
2221
+ > - offset: Offset
2222
+ > - count: Number Please keep the default, otherwise there will be BUG.
2223
+ > - douyin_user_fans(Fans):
2224
+ > - "": Unlimited
2225
+ > - "0_1k": Less than 1000
2226
+ > - "1k_1w": 1000-10,000
2227
+ > - "1w_10w": 10,000-100,000
2228
+ > - "10w_100w": 100,000-1,000,000
2229
+ > - "100w_": More than 1,000,000
2230
+ > - douyin_user_type(User type, please use English instead of Chinese):
2231
+ > - "": Unlimited
2232
+ > - "common_user": Common user
2233
+ > - "enterprise_user": Enterprise certification
2234
+ > - "personal_user": Personal certification
2235
+ > ### Return:
2236
+ > - User search results
2237
+ >
2238
+ > # [示例/Example]
2239
+ > keyword = "动漫"
2240
+ > offset = 0
2241
+ > count = 20
2242
+
2243
+ #### Parameters
2244
+
2245
+ | Field | In | Type | Required | Description | Default | Example | Enum |
2246
+ | --- | --- | --- | --- | --- | --- | --- | --- |
2247
+ | keyword | query | string | Yes | 关键词/Keyword | None | 中华娘 | None |
2248
+ | offset | query | integer | No | 偏移量/Offset | 0 | None | None |
2249
+ | count | query | integer | No | 数量/Number | 20 | None | None |
2250
+ | douyin_user_fans | query | string | No | 粉丝数/Fans | None | None | None |
2251
+ | douyin_user_type | query | string | No | 用户类型/User type | None | None | None |
2252
+
2253
+ #### Request Body
2254
+
2255
+ None
2256
+
2257
+ #### Success Response
2258
+
2259
+ ##### `200 application/json`
2260
+
2261
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2262
+
2263
+ | Field | Type | Required | Description | Default | Example | Enum |
2264
+ | --- | --- | --- | --- | --- | --- | --- |
2265
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
2266
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
2267
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
2268
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
2269
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
2270
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
2271
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
2272
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
2273
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
2274
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
2275
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
2276
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
2277
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
2278
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
2279
+ | data | null | No | The response data \| 响应数据 | None | None | None |
2280
+
2281
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-user-series-list"></a>
2282
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_user_series_list`
2283
+
2284
+ - Summary: 获取用户短剧合集列表/Get user series list
2285
+ - Capabilities: profiles / accounts
2286
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2287
+ - operationId: `fetch_user_series_list_api_v1_douyin_app_v3_fetch_user_series_list_get`
2288
+
2289
+ #### Notes
2290
+
2291
+ > # [中文]
2292
+ > ### 用途:
2293
+ > - 获取用户的短剧合集列表
2294
+ > ### 参数:
2295
+ > - user_id: 用户id,与sec_user_id二选一即可
2296
+ > - sec_user_id: 用户加密id,与user_id二选一即可
2297
+ > - cursor: 游标,用于翻页,第一页为0,第二页为第一次响应中的cursor值。
2298
+ > ### 返回:
2299
+ > - 用户短剧合集列表数据
2300
+ > ### 备注:
2301
+ > - 该接口返回用户发布的所有短剧合集
2302
+ > - 响应中的 series_id 可用于获取短剧详情和视频列表
2303
+ >
2304
+ > # [English]
2305
+ > ### Purpose:
2306
+ > - Get user's series/playlet collection list
2307
+ > ### Parameters:
2308
+ > - user_id: User id
2309
+ > - sec_user_id: User encrypted id
2310
+ > - cursor: Cursor, used for paging, the first page is 0, the second page is the cursor value in the first response.
2311
+ > ### Return:
2312
+ > - User series list data
2313
+ > ### Note:
2314
+ > - This interface returns all series collections published by the user
2315
+ > - The series_id in the response can be used to get series details and video list
2316
+ >
2317
+ > # [示例/Example]
2318
+ > user_id = "3010877781453635"
2319
+ > sec_user_id = "MS4wLjABAAAAfAU5kMk-W4569G1z2iRsy8t6-kOxO17Eaz6yte4NQokeUeOpeqTGEc480e34O8lK"
2320
+ > cursor = 0
2321
+
2322
+ #### Parameters
2323
+
2324
+ | Field | In | Type | Required | Description | Default | Example | Enum |
2325
+ | --- | --- | --- | --- | --- | --- | --- | --- |
2326
+ | user_id | query | string | No | 用户id/User id | None | 3010877781453635 | None |
2327
+ | sec_user_id | query | string | No | 用户加密id/User sec id | None | MS4wLjABAAAAfAU5kMk-W4569G1z2iRsy8t6-kOxO17Eaz6yte4NQokeUeOpeqTGEc480e34O8lK | None |
2328
+ | cursor | query | integer | No | 游标/Cursor | 0 | None | None |
2329
+
2330
+ #### Request Body
2331
+
2332
+ None
2333
+
2334
+ #### Success Response
2335
+
2336
+ ##### `200 application/json`
2337
+
2338
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2339
+
2340
+ | Field | Type | Required | Description | Default | Example | Enum |
2341
+ | --- | --- | --- | --- | --- | --- | --- |
2342
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
2343
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
2344
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
2345
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
2346
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
2347
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
2348
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
2349
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
2350
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
2351
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
2352
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
2353
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
2354
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
2355
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
2356
+ | data | null | No | The response data \| 响应数据 | None | None | None |
2357
+
2358
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-video-comment-replies"></a>
2359
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_video_comment_replies`
2360
+
2361
+ - Summary: 获取指定视频的评论回复数据/Get comment replies data of specified video
2362
+ - Capabilities: comments / content details
2363
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2364
+ - operationId: `fetch_video_comments_reply_api_v1_douyin_app_v3_fetch_video_comment_replies_get`
2365
+
2366
+ #### Notes
2367
+
2368
+ > # [中文]
2369
+ > ### 用途:
2370
+ > - 获取指定视频的评论回复数据
2371
+ > ### 参数:
2372
+ > - item_id: 作品id
2373
+ > - comment_id: 评论id
2374
+ > - cursor: 游标,用于翻页,第一页为0,第二页为第一次响应中的cursor值。
2375
+ > - count: 数量,请保持默认,否则会出现BUG。
2376
+ > ### 返回:
2377
+ > - 评论回复数据
2378
+ >
2379
+ > # [English]
2380
+ > ### Purpose:
2381
+ > - Get comment replies data of specified video
2382
+ > ### Parameters:
2383
+ > - item_id: Video id
2384
+ > - comment_id: Comment id
2385
+ > - cursor: Cursor, used for paging, the first page is 0, the second page is the cursor value in the first response.
2386
+ > - count: Number Please keep the default, otherwise there will be BUG.
2387
+ > ### Return:
2388
+ > - Comment replies data
2389
+ >
2390
+ > # [示例/Example]
2391
+ > aweme_id = "7354666303006723354"
2392
+ > comment_id = "7354669356632638218"
2393
+ > cursor = 0
2394
+ > count = 20
2395
+
2396
+ #### Parameters
2397
+
2398
+ | Field | In | Type | Required | Description | Default | Example | Enum |
2399
+ | --- | --- | --- | --- | --- | --- | --- | --- |
2400
+ | item_id | query | string | Yes | 作品id/Video id | None | 7354666303006723354 | None |
2401
+ | comment_id | query | string | Yes | 评论id/Comment id | None | 7354669356632638218 | None |
2402
+ | cursor | query | integer | No | 游标/Cursor | 0 | None | None |
2403
+ | count | query | integer | No | 数量/Number | 20 | None | None |
2404
+
2405
+ #### Request Body
2406
+
2407
+ None
2408
+
2409
+ #### Success Response
2410
+
2411
+ ##### `200 application/json`
2412
+
2413
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2414
+
2415
+ | Field | Type | Required | Description | Default | Example | Enum |
2416
+ | --- | --- | --- | --- | --- | --- | --- |
2417
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
2418
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
2419
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
2420
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
2421
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
2422
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
2423
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
2424
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
2425
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
2426
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
2427
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
2428
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
2429
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
2430
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
2431
+ | data | null | No | The response data \| 响应数据 | None | None | None |
2432
+
2433
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-video-comments"></a>
2434
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_video_comments`
2435
+
2436
+ - Summary: 获取单个视频评论数据/Get single video comments data
2437
+ - Capabilities: comments / content details
2438
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2439
+ - operationId: `fetch_video_comments_api_v1_douyin_app_v3_fetch_video_comments_get`
2440
+
2441
+ #### Notes
2442
+
2443
+ > # [中文]
2444
+ > ### 用途:
2445
+ > - 获取单个视频评论数据
2446
+ > ### 参数:
2447
+ > - aweme_id: 作品id
2448
+ > - cursor: 游标,用于翻页,第一页为0,第二页为第一次响应中的cursor值。
2449
+ > - count: 数量,请保持默认,否则会出现BUG。
2450
+ > ### 返回:
2451
+ > - 评论数据
2452
+ >
2453
+ > # [English]
2454
+ > ### Purpose:
2455
+ > - Get single video comments data
2456
+ > ### Parameters:
2457
+ > - aweme_id: Video id
2458
+ > - cursor: Cursor, used for paging, the first page is 0, the second page is the cursor value in the first response.
2459
+ > - count: Number Please keep the default, otherwise there will be BUG.
2460
+ > ### Return:
2461
+ > - Comments data
2462
+ >
2463
+ > # [示例/Example]
2464
+ > aweme_id = "7448118827402972455"
2465
+ > cursor = 0
2466
+ > count = 20
2467
+
2468
+ #### Parameters
2469
+
2470
+ | Field | In | Type | Required | Description | Default | Example | Enum |
2471
+ | --- | --- | --- | --- | --- | --- | --- | --- |
2472
+ | aweme_id | query | string | Yes | 作品id/Video id | None | 7448118827402972455 | None |
2473
+ | cursor | query | integer | No | 游标/Cursor | 0 | None | None |
2474
+ | count | query | integer | No | 数量/Number | 20 | None | None |
2475
+
2476
+ #### Request Body
2477
+
2478
+ None
2479
+
2480
+ #### Success Response
2481
+
2482
+ ##### `200 application/json`
2483
+
2484
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2485
+
2486
+ | Field | Type | Required | Description | Default | Example | Enum |
2487
+ | --- | --- | --- | --- | --- | --- | --- |
2488
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
2489
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
2490
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
2491
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
2492
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
2493
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
2494
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
2495
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
2496
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
2497
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
2498
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
2499
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
2500
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
2501
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
2502
+ | data | null | No | The response data \| 响应数据 | None | None | None |
2503
+
2504
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-video-high-quality-play-url"></a>
2505
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_video_high_quality_play_url`
2506
+
2507
+ - Summary: 获取视频的最高画质播放链接/Get the highest quality play URL of the video
2508
+ - Capabilities: content details
2509
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2510
+ - operationId: `fetch_video_high_quality_play_url_api_v1_douyin_app_v3_fetch_video_high_quality_play_url_get`
2511
+
2512
+ #### Notes
2513
+
2514
+ > # [中文]
2515
+ > ### 用途:
2516
+ > - 价格:0.005$ 一次。
2517
+ > - 获取视频的最高画质(原始上传画质)播放链接
2518
+ > - 该接口会返回最高画质的播放链接,原始上传画质是指用户上传视频时的画质,通常最高画质视频无压缩码率并且文件头包含元数据。
2519
+ > - 最高画质的视频链接无法从抖音APP或网页版直接获取,需要通过此接口获取。
2520
+ > - 此接口非常适合用于获取高清无水印视频链接,适用于需要高质量视频的场景,如视频编辑、存档、训练模型等。
2521
+ > - 一般情况都可以在线播放,如果不行,可以尝试使用IDM或浏览器下载后播放。
2522
+ > ### 参数:
2523
+ > - aweme_id: 作品id,优先使用aweme_id,如果没有则使用share_url。
2524
+ > - share_url: 可选,分享链接,如果提供了作品id,则此参数可以不传。
2525
+ > ### 返回:
2526
+ > - video_id: 作品id
2527
+ > - original_video_url: 最高画质(原始上传画质)播放链接
2528
+ > - video_data: 视频数据,包含视频的元数据,如时长、大小等。
2529
+ >
2530
+ > # [English]
2531
+ > ### Purpose:
2532
+ > - Price: 0.005$ each time.
2533
+ > - Get the highest quality (original upload quality) play URL of the video
2534
+ > - This interface will return the highest quality play URL, the original upload quality refers to the quality of the video when the user uploads it, usually the highest quality video has an uncompressed bitrate and the file header contains metadata.
2535
+ > - The highest quality video link cannot be obtained directly from the Douyin APP or web version, and must be obtained through this interface.
2536
+ > - This interface is very suitable for obtaining high-definition, watermark-free video links, suitable for scenarios that require high-quality videos, such as video editing, archiving, training models, etc.
2537
+ > - Generally, it can be played online, if not, you can try to download it using IDM or a browser and then play it.
2538
+ > ### Parameters:
2539
+ > - aweme_id: Video id, prefer to use aweme_id, if not available, use share_url.
2540
+ > - share_url: Optional, share link, if the video id is provided, this parameter can be omitted.
2541
+ > ### Return:
2542
+ > - video_id: Video id
2543
+ > - original_video_url: Highest quality (original upload quality) play URL
2544
+ > - video_data: Video data, including metadata such as duration, size, etc.
2545
+ > # [示例/Example]
2546
+ > aweme_id = "7512756548356492544"
2547
+ > share_url = "https://www.douyin.com/video/7512756548356492544"
2548
+
2549
+ #### Parameters
2550
+
2551
+ | Field | In | Type | Required | Description | Default | Example | Enum |
2552
+ | --- | --- | --- | --- | --- | --- | --- | --- |
2553
+ | aweme_id | query | string | No | 作品id/Video id | None | 7512756548356492544 | None |
2554
+ | share_url | query | string | No | 可选,分享链接/Optional, share link | None | https://www.douyin.com/video/7512756548356492544 | None |
2555
+
2556
+ #### Request Body
2557
+
2558
+ None
2559
+
2560
+ #### Success Response
2561
+
2562
+ ##### `200 application/json`
2563
+
2564
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2565
+
2566
+ | Field | Type | Required | Description | Default | Example | Enum |
2567
+ | --- | --- | --- | --- | --- | --- | --- |
2568
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
2569
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
2570
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
2571
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
2572
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
2573
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
2574
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
2575
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
2576
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
2577
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
2578
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
2579
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
2580
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
2581
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
2582
+ | data | null | No | The response data \| 响应数据 | None | None | None |
2583
+
2584
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-video-mix-detail"></a>
2585
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_video_mix_detail`
2586
+
2587
+ - Summary: 获取抖音视频合集详情数据/Get Douyin video mix detail data
2588
+ - Capabilities: content details / details
2589
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2590
+ - operationId: `fetch_video_mix_detail_api_v1_douyin_app_v3_fetch_video_mix_detail_get`
2591
+
2592
+ #### Notes
2593
+
2594
+ > # [中文]
2595
+ > ### 用途:
2596
+ > - 获取抖音视频合集详情数据
2597
+ > ### 参数:
2598
+ > - mix_id: 合集id
2599
+ > ### 返回:
2600
+ > - 视频合集详情数据
2601
+ >
2602
+ > # [English]
2603
+ > ### Purpose:
2604
+ > - Get Douyin video mix detail data
2605
+ > ### Parameters:
2606
+ > - mix_id: Mix id
2607
+ > ### Return:
2608
+ > - Video mix detail data
2609
+ >
2610
+ > # [示例/Example]
2611
+ > mix_id = "7302011174286002217"
2612
+
2613
+ #### Parameters
2614
+
2615
+ | Field | In | Type | Required | Description | Default | Example | Enum |
2616
+ | --- | --- | --- | --- | --- | --- | --- | --- |
2617
+ | mix_id | query | string | Yes | 合集id/Mix id | None | 7302011174286002217 | None |
2618
+
2619
+ #### Request Body
2620
+
2621
+ None
2622
+
2623
+ #### Success Response
2624
+
2625
+ ##### `200 application/json`
2626
+
2627
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2628
+
2629
+ | Field | Type | Required | Description | Default | Example | Enum |
2630
+ | --- | --- | --- | --- | --- | --- | --- |
2631
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
2632
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
2633
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
2634
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
2635
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
2636
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
2637
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
2638
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
2639
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
2640
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
2641
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
2642
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
2643
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
2644
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
2645
+ | data | null | No | The response data \| 响应数据 | None | None | None |
2646
+
2647
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-video-mix-post-list"></a>
2648
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_video_mix_post_list`
2649
+
2650
+ - Summary: 获取抖音视频合集作品列表数据/Get Douyin video mix post list data
2651
+ - Capabilities: content details
2652
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2653
+ - operationId: `fetch_video_mix_post_list_api_v1_douyin_app_v3_fetch_video_mix_post_list_get`
2654
+
2655
+ #### Notes
2656
+
2657
+ > # [中文]
2658
+ > ### 用途:
2659
+ > - 获取抖音视频合集作品列表数据
2660
+ > ### 参数:
2661
+ > - mix_id: 合集id
2662
+ > - cursor: 游标,用于翻页,第一页为0,第二页为第一次响应中的cursor值。
2663
+ > - count: 数量,请保持默认,否则会出现BUG。
2664
+ > ### 返回:
2665
+ > - 视频合集作品列表数据
2666
+ >
2667
+ > # [English]
2668
+ > ### Purpose:
2669
+ > - Get Douyin video mix post list data
2670
+ > ### Parameters:
2671
+ > - mix_id: Mix id
2672
+ > - cursor: Cursor, used for paging, the first page is 0, the second page is the cursor value in the first response.
2673
+ > - count: Number Please keep the default, otherwise there will be BUG.
2674
+ > ### Return:
2675
+ > - Video mix post list data
2676
+ >
2677
+ > # [示例/Example]
2678
+ > mix_id = "7302011174286002217"
2679
+ > cursor = 0
2680
+ > count = 20
2681
+
2682
+ #### Parameters
2683
+
2684
+ | Field | In | Type | Required | Description | Default | Example | Enum |
2685
+ | --- | --- | --- | --- | --- | --- | --- | --- |
2686
+ | mix_id | query | string | Yes | 合集id/Mix id | None | 7302011174286002217 | None |
2687
+ | cursor | query | integer | No | 游标/Cursor | 0 | None | None |
2688
+ | count | query | integer | No | 数量/Number | 20 | None | None |
2689
+
2690
+ #### Request Body
2691
+
2692
+ None
2693
+
2694
+ #### Success Response
2695
+
2696
+ ##### `200 application/json`
2697
+
2698
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2699
+
2700
+ | Field | Type | Required | Description | Default | Example | Enum |
2701
+ | --- | --- | --- | --- | --- | --- | --- |
2702
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
2703
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
2704
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
2705
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
2706
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
2707
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
2708
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
2709
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
2710
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
2711
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
2712
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
2713
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
2714
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
2715
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
2716
+ | data | null | No | The response data \| 响应数据 | None | None | None |
2717
+
2718
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-video-search-result"></a>
2719
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_video_search_result`
2720
+
2721
+ - Summary: 获取指定关键词的视频搜索结果(弃用,替代接口见下方文档说明)/Get video search results of specified keywords (deprecated, see the documentation below for alternative interfaces)
2722
+ - Capabilities: search / content details
2723
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2724
+ - operationId: `fetch_video_search_result_api_v1_douyin_app_v3_fetch_video_search_result_get`
2725
+
2726
+ #### Notes
2727
+
2728
+ > # [中文]
2729
+ > ### 用途:
2730
+ > - 获取指定关键词的视频搜索结果
2731
+ > - 该接口已弃用,替代接口为:https://docs.tikhub.io/370212780e0
2732
+ > ### 参数:
2733
+ > - keyword: 关键词
2734
+ > - offset: 偏移量
2735
+ > - count: 数量,请保持默认,否则会出现BUG。
2736
+ > - sort_type: 0:综合排序 1:最多点赞 2:最新发布
2737
+ > - publish_time: 0:不限 1:最近一天 7:最近一周 180:最近半年
2738
+ > - filter_duration: 0:不限 0-1:1分钟以内 1-5:1-5分钟 5-10000:5分钟以上
2739
+ > - content_type: 0:不限 1:视频 2:图文
2740
+ > ### 返回:
2741
+ > - 视频搜索结果
2742
+ >
2743
+ > # [English]
2744
+ > ### Purpose:
2745
+ > - Get video search results of specified keywords
2746
+ > - This interface has been deprecated, and the alternative interface is: https://docs.tikhub.io/370212780e0
2747
+ > ### Parameters:
2748
+ > - keyword: Keyword
2749
+ > - offset: Offset
2750
+ > - count: Number Please keep the default, otherwise there will be BUG.
2751
+ > - sort_type: 0: Comprehensive sorting 1: Most likes 2: Latest release
2752
+ > - publish_time: 0: Unlimited 1: Last day 7: Last week 180: Last half year
2753
+ > - filter_duration: 0: Unlimited 0-1: Within 1 minute 1-5: 1-5 minutes 5-10000: More than 5 minutes
2754
+ > - content_type: 0: Unlimited 1: Video 2: Graphic and text
2755
+ > ### Return:
2756
+ > - Video search results
2757
+ >
2758
+ > # [示例/Example]
2759
+ > keyword = "中华娘"
2760
+ > offset = 0
2761
+ > count = 20
2762
+ > sort_type = "0"
2763
+ > publish_time = "0"
2764
+ > filter_duration = "0"
2765
+
2766
+ #### Parameters
2767
+
2768
+ | Field | In | Type | Required | Description | Default | Example | Enum |
2769
+ | --- | --- | --- | --- | --- | --- | --- | --- |
2770
+ | keyword | query | string | Yes | 关键词/Keyword | None | 中华娘 | None |
2771
+ | offset | query | integer | No | 偏移量/Offset | 0 | None | None |
2772
+ | count | query | integer | No | 数量/Number | 20 | None | None |
2773
+ | sort_type | query | string | No | 排序类型/Sort type | 0 | None | None |
2774
+ | publish_time | query | string | No | 发布时间/Publish time | 0 | None | None |
2775
+ | filter_duration | query | string | No | 时长/Duration | 0 | None | None |
2776
+
2777
+ #### Request Body
2778
+
2779
+ None
2780
+
2781
+ #### Success Response
2782
+
2783
+ ##### `200 application/json`
2784
+
2785
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2786
+
2787
+ | Field | Type | Required | Description | Default | Example | Enum |
2788
+ | --- | --- | --- | --- | --- | --- | --- |
2789
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
2790
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
2791
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
2792
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
2793
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
2794
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
2795
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
2796
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
2797
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
2798
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
2799
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
2800
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
2801
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
2802
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
2803
+ | data | null | No | The response data \| 响应数据 | None | None | None |
2804
+
2805
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-video-search-result-v2"></a>
2806
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_video_search_result_v2`
2807
+
2808
+ - Summary: 获取指定关键词的视频搜索结果 V2 (弃用,替代接口见下方文档说明)/Get video search results of specified keywords V2 (deprecated, see the documentation below for alternative interfaces)
2809
+ - Capabilities: search / content details
2810
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2811
+ - operationId: `fetch_video_search_result_v2_api_v1_douyin_app_v3_fetch_video_search_result_v2_get`
2812
+
2813
+ #### Notes
2814
+
2815
+ > # [中文]
2816
+ > ### 用途:
2817
+ > - 获取指定关键词的视频搜索结果V2,此接口稳定性更好,收费更贵,当`/api/v1/douyin/web/fetch_video_search_result`接口不稳定时,建议使用此接口。
2818
+ > - 收费标准为:0.01$每次请求。
2819
+ > - 该接口已弃用,替代接口为:https://docs.tikhub.io/370212780e0
2820
+ > ### 参数:
2821
+ > - keyword: 关键词
2822
+ > - sort_type:
2823
+ > - 排序类型,可用值如下:
2824
+ > - _0 :综合(General)
2825
+ > - _1 :最多点赞(More likes)
2826
+ > - _2 :最新发布(New)
2827
+ > - publish_time:
2828
+ > - 发布时间,可用值如下:
2829
+ > - _0 :不限(No Limit)
2830
+ > - _1 :一天之内(last 1 day)
2831
+ > - _7 :一周之内(last 1 week)
2832
+ > - _180 :半年之内(last half year)
2833
+ > - filter_duration:
2834
+ > - 视频时长,可用值如下:
2835
+ > - _0 :不限(No Limit)
2836
+ > - _1 :1分钟以下(1 minute and below)
2837
+ > - _2 :1-5分钟 (1-5 minutes)
2838
+ > - _3 :5分钟以上(5 minutes more)
2839
+ > - page: 页码
2840
+ > - 默认从1开始,然后依次递增加1
2841
+ > - search_id: 搜索id,第一次请求时为空,第二次翻页时需要提供,需要从上一次请求的返回响应中获取。
2842
+ > - 例如: search_id = "2024083107320448E367ECDCCC6B71F7F3"
2843
+ > - JSON Path-1 : $.data.extra.logid
2844
+ > - JSON Path-2 : $.data.log_pb.impr_id
2845
+ > ### 返回:
2846
+ > - 视频搜索结果V2
2847
+ >
2848
+ > # [English]
2849
+ > ### Purpose:
2850
+ > - Get video search results of specified keywords V2, this interface has better stability and higher cost, when the `/api/v1/douyin/web/fetch_video_search_result` interface is unstable, it is recommended to use this interface.
2851
+ > - The charging standard is: $0.01 per request.
2852
+ > - This interface has been deprecated, and the alternative interface is: https://docs.tikhub.io/370212780e0
2853
+ > ### Parameters:
2854
+ > - keyword: Keyword
2855
+ > - sort_type:
2856
+ > - Sort type, available values are as follows:
2857
+ > - _0 : General
2858
+ > - _1 : More likes
2859
+ > - _2 : New
2860
+ > - publish_time:
2861
+ > - Publish time, available values are as follows:
2862
+ > - _0 : No Limit
2863
+ > - _1 : last 1 day
2864
+ > - _7 : last 1 week
2865
+ > - _180 : last half year
2866
+ > - filter_duration:
2867
+ > - Duration filter, available values are as follows:
2868
+ > - _0 : No Limit
2869
+ > - _1 : 1 minute and below
2870
+ > - _2 : 1-5 minutes
2871
+ > - _3 : 5 minutes more
2872
+ > - page: Page
2873
+ > - Start from 1 by default, then increase by 1 each time
2874
+ > - search_id: Search id, empty for the first request, need to provide for the second paging, need to get it from the return response of the last request.
2875
+ > - For example: search_id = "2024083107320448E367ECDCCC6B71F7F3"
2876
+ > - JSON Path-1 : $.data.extra.logid
2877
+ > - JSON Path-2 : $.data.log_pb.impr_id
2878
+ > ### Return:
2879
+ > - Video search results V2
2880
+ >
2881
+ > # [示例/Example]
2882
+ > keyword = "中华娘"
2883
+ > sort_type = "_0"
2884
+ > publish_time = "_0"
2885
+ > filter_duration = "_0"
2886
+ > page = 1
2887
+ > search_id = ""
2888
+
2889
+ #### Parameters
2890
+
2891
+ | Field | In | Type | Required | Description | Default | Example | Enum |
2892
+ | --- | --- | --- | --- | --- | --- | --- | --- |
2893
+ | keyword | query | string | Yes | 关键词/Keyword | None | 中华娘 | None |
2894
+ | sort_type | query | string | No | 排序类型/Sort type | _0 | None | None |
2895
+ | publish_time | query | string | No | 发布时间/Publish time | _0 | None | None |
2896
+ | filter_duration | query | string | No | 视频时长/Duration filter | _0 | None | None |
2897
+ | page | query | integer | No | 页码/Page | 1 | None | None |
2898
+ | search_id | query | string | No | 搜索id,翻页时需要提供/Search id, need to provide when paging | None | None | None |
2899
+
2900
+ #### Request Body
2901
+
2902
+ None
2903
+
2904
+ #### Success Response
2905
+
2906
+ ##### `200 application/json`
2907
+
2908
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2909
+
2910
+ | Field | Type | Required | Description | Default | Example | Enum |
2911
+ | --- | --- | --- | --- | --- | --- | --- |
2912
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
2913
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
2914
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
2915
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
2916
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
2917
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
2918
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
2919
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
2920
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
2921
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
2922
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
2923
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
2924
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
2925
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
2926
+ | data | null | No | The response data \| 响应数据 | None | None | None |
2927
+
2928
+ <a id="get-api-u1-v1-douyin-app-v3-fetch-video-statistics"></a>
2929
+ ### `GET /api/u1/v1/douyin/app/v3/fetch_video_statistics`
2930
+
2931
+ - Summary: 根据视频ID获取作品的统计数据(点赞数、下载数、播放数、分享数)/Get the statistical data of the Post according to the video ID (like count, download count, play count, share count)
2932
+ - Capabilities: content details
2933
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2934
+ - operationId: `fetch_video_statistics_api_v1_douyin_app_v3_fetch_video_statistics_get`
2935
+
2936
+ #### Notes
2937
+
2938
+ > # [中文]
2939
+ > ### 用途:
2940
+ > - 根据视频ID获取作品的统计数据
2941
+ > - 抖音大多数接口已经不再返回作品的播放数,只能通过此接口获取。
2942
+ > - 可以获取到的统计有:
2943
+ > - 点赞数(digg_count)
2944
+ > - 下载数(download_count)
2945
+ > - 播放数(play_count)
2946
+ > - 分享数(share_count)
2947
+ > ### 参数:
2948
+ > - aweme_ids: 作品id,支持多个视频id,用逗号隔开即可,不能超过2个,单个也可以,则无需逗号。
2949
+ > ### 返回:
2950
+ > - 作品统计数据
2951
+ >
2952
+ > # [English]
2953
+ > ### Purpose:
2954
+ > - Get the statistical data of the Post according to the video ID
2955
+ > - Most of the Douyin interfaces no longer return the number of plays of the Post, and can only be obtained through this interface.
2956
+ > - List of statistics that can be obtained:
2957
+ > - Like count (digg_count)
2958
+ > - Download count (download_count)
2959
+ > - Play count (play_count)
2960
+ > - Share count (share_count)
2961
+ > ### Parameters:
2962
+ > - aweme_ids: Video id, supports multiple video ids, separated by commas, no more than 2, single is also possible, no need for commas.
2963
+ > ### Return:
2964
+ > - Post statistics data
2965
+ >
2966
+ > # [示例/Example]
2967
+ > aweme_ids = "7448118827402972455,7126745726494821640"
2968
+
2969
+ #### Parameters
2970
+
2971
+ | Field | In | Type | Required | Description | Default | Example | Enum |
2972
+ | --- | --- | --- | --- | --- | --- | --- | --- |
2973
+ | aweme_ids | query | string | Yes | 作品id/Video id | None | 7448118827402972455,7126745726494821640 | None |
2974
+
2975
+ #### Request Body
2976
+
2977
+ None
2978
+
2979
+ #### Success Response
2980
+
2981
+ ##### `200 application/json`
2982
+
2983
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2984
+
2985
+ | Field | Type | Required | Description | Default | Example | Enum |
2986
+ | --- | --- | --- | --- | --- | --- | --- |
2987
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
2988
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
2989
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
2990
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
2991
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
2992
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
2993
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
2994
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
2995
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
2996
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
2997
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
2998
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
2999
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
3000
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
3001
+ | data | null | No | The response data \| 响应数据 | None | None | None |
3002
+
3003
+ <a id="get-api-u1-v1-douyin-app-v3-generate-douyin-short-url"></a>
3004
+ ### `GET /api/u1/v1/douyin/app/v3/generate_douyin_short_url`
3005
+
3006
+ - Summary: 生成抖音短链接/Generate Douyin short link
3007
+ - Capabilities: general
3008
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
3009
+ - operationId: `generate_douyin_short_url_api_v1_douyin_app_v3_generate_douyin_short_url_get`
3010
+
3011
+ #### Notes
3012
+
3013
+ > # [中文]
3014
+ > ### 用途:
3015
+ > - 生成抖音短链接
3016
+ > ### 参数:
3017
+ > - url: 抖音链接
3018
+ > ### 返回:
3019
+ > - 短链接数据
3020
+ >
3021
+ > # [English]
3022
+ > ### Purpose:
3023
+ > - Generate Douyin short link
3024
+ > ### Parameters:
3025
+ > - url: Douyin link
3026
+ > ### Return:
3027
+ > - Short link data
3028
+ >
3029
+ > # [示例/Example]
3030
+ > url = "https://www.douyin.com/passport/web/logout/"
3031
+
3032
+ #### Parameters
3033
+
3034
+ | Field | In | Type | Required | Description | Default | Example | Enum |
3035
+ | --- | --- | --- | --- | --- | --- | --- | --- |
3036
+ | url | query | string | Yes | 抖音链接/Douyin link | None | https://www.douyin.com/passport/web/logout/ | None |
3037
+
3038
+ #### Request Body
3039
+
3040
+ None
3041
+
3042
+ #### Success Response
3043
+
3044
+ ##### `200 application/json`
3045
+
3046
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
3047
+
3048
+ | Field | Type | Required | Description | Default | Example | Enum |
3049
+ | --- | --- | --- | --- | --- | --- | --- |
3050
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
3051
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
3052
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
3053
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
3054
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
3055
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
3056
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
3057
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
3058
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
3059
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
3060
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
3061
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
3062
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
3063
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
3064
+ | data | null | No | The response data \| 响应数据 | None | None | None |
3065
+
3066
+ <a id="get-api-u1-v1-douyin-app-v3-generate-douyin-video-share-qrcode"></a>
3067
+ ### `GET /api/u1/v1/douyin/app/v3/generate_douyin_video_share_qrcode`
3068
+
3069
+ - Summary: 生成抖音视频分享二维码/Generate Douyin video share QR code
3070
+ - Capabilities: content details
3071
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
3072
+ - operationId: `generate_douyin_video_share_qrcode_api_v1_douyin_app_v3_generate_douyin_video_share_qrcode_get`
3073
+
3074
+ #### Notes
3075
+
3076
+ > # [中文]
3077
+ > ### 用途:
3078
+ > - 生成抖音视频分享二维码
3079
+ > ### 参数:
3080
+ > - object_id: 作品id或作者uid
3081
+ > ### 返回:
3082
+ > - 二维码数据
3083
+ >
3084
+ > # [English]
3085
+ > ### Purpose:
3086
+ > - Generate Douyin video share QR code
3087
+ > ### Parameters:
3088
+ > - object_id: Video id or author uid
3089
+ > ### Return:
3090
+ > - QR code data
3091
+ >
3092
+ > # [示例/Example]
3093
+ > object_id = "7348044435755846962"
3094
+
3095
+ #### Parameters
3096
+
3097
+ | Field | In | Type | Required | Description | Default | Example | Enum |
3098
+ | --- | --- | --- | --- | --- | --- | --- | --- |
3099
+ | object_id | query | string | Yes | 作品id/Video id | None | 7348044435755846962 | None |
3100
+
3101
+ #### Request Body
3102
+
3103
+ None
3104
+
3105
+ #### Success Response
3106
+
3107
+ ##### `200 application/json`
3108
+
3109
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
3110
+
3111
+ | Field | Type | Required | Description | Default | Example | Enum |
3112
+ | --- | --- | --- | --- | --- | --- | --- |
3113
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
3114
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
3115
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
3116
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
3117
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
3118
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
3119
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
3120
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
3121
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
3122
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
3123
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
3124
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
3125
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
3126
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
3127
+ | data | null | No | The response data \| 响应数据 | None | None | None |
3128
+
3129
+ <a id="get-api-u1-v1-douyin-app-v3-handler-user-profile"></a>
3130
+ ### `GET /api/u1/v1/douyin/app/v3/handler_user_profile`
3131
+
3132
+ - Summary: 获取指定用户的信息/Get information of specified user
3133
+ - Capabilities: profiles / accounts
3134
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
3135
+ - operationId: `handler_user_profile_api_v1_douyin_app_v3_handler_user_profile_get`
3136
+
3137
+ #### Notes
3138
+
3139
+ > # [中文]
3140
+ > ### 用途:
3141
+ > - 获取指定用户的信息
3142
+ > ### 参数:
3143
+ > - sec_user_id: 用户sec_user_id
3144
+ > ### 返回:
3145
+ > - 用户信息
3146
+ >
3147
+ > # [English]
3148
+ > ### Purpose:
3149
+ > - Get information of specified user
3150
+ > ### Parameters:
3151
+ > - sec_user_id: User sec_user_id
3152
+ > ### Return:
3153
+ > - User information
3154
+ >
3155
+ > # [示例/Example]
3156
+ > sec_user_id = "MS4wLjABAAAAW9FWcqS7RdQAWPd2AA5fL_ilmqsIFUCQ_Iym6Yh9_cUa6ZRqVLjVQSUjlHrfXY1Y"
3157
+
3158
+ #### Parameters
3159
+
3160
+ | Field | In | Type | Required | Description | Default | Example | Enum |
3161
+ | --- | --- | --- | --- | --- | --- | --- | --- |
3162
+ | sec_user_id | query | string | Yes | 用户sec_user_id/User sec_user_id | None | MS4wLjABAAAAW9FWcqS7RdQAWPd2AA5fL_ilmqsIFUCQ_Iym6Yh9_cUa6ZRqVLjVQSUjlHrfXY1Y | None |
3163
+
3164
+ #### Request Body
3165
+
3166
+ None
3167
+
3168
+ #### Success Response
3169
+
3170
+ ##### `200 application/json`
3171
+
3172
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
3173
+
3174
+ | Field | Type | Required | Description | Default | Example | Enum |
3175
+ | --- | --- | --- | --- | --- | --- | --- |
3176
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
3177
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
3178
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
3179
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
3180
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
3181
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
3182
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
3183
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
3184
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
3185
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
3186
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
3187
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
3188
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
3189
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
3190
+ | data | null | No | The response data \| 响应数据 | None | None | None |
3191
+
3192
+ <a id="get-api-u1-v1-douyin-app-v3-open-douyin-app-to-keyword-search"></a>
3193
+ ### `GET /api/u1/v1/douyin/app/v3/open_douyin_app_to_keyword_search`
3194
+
3195
+ - Summary: 生成抖音分享链接,唤起抖音APP,跳转指定关键词搜索结果/Generate Douyin share link, call Douyin APP, and jump to the specified keyword search result
3196
+ - Capabilities: search
3197
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
3198
+ - operationId: `open_douyin_app_to_keyword_search_api_v1_douyin_app_v3_open_douyin_app_to_keyword_search_get`
3199
+
3200
+ #### Notes
3201
+
3202
+ > # [中文]
3203
+ > ### 用途:
3204
+ > - 生成抖音分享链接,唤起抖音APP,跳转指定关键词搜索结果。
3205
+ >
3206
+ > ### 参数:
3207
+ > - keyword: 关键词
3208
+ >
3209
+ > ### 返回:
3210
+ > - 分享链接
3211
+ >
3212
+ > # [English]
3213
+ > ### Purpose:
3214
+ > - Generate Douyin share link, call Douyin APP, and jump to the specified keyword search result
3215
+ >
3216
+ > ### Parameters:
3217
+ > - keyword: Keyword
3218
+ >
3219
+ > ### Return:
3220
+ > - Share link
3221
+ >
3222
+ > # [示例/Example]
3223
+ > keyword = "雷军"
3224
+
3225
+ #### Parameters
3226
+
3227
+ | Field | In | Type | Required | Description | Default | Example | Enum |
3228
+ | --- | --- | --- | --- | --- | --- | --- | --- |
3229
+ | keyword | query | string | Yes | 关键词/Keyword | None | 雷军 | None |
3230
+
3231
+ #### Request Body
3232
+
3233
+ None
3234
+
3235
+ #### Success Response
3236
+
3237
+ ##### `200 application/json`
3238
+
3239
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
3240
+
3241
+ | Field | Type | Required | Description | Default | Example | Enum |
3242
+ | --- | --- | --- | --- | --- | --- | --- |
3243
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
3244
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
3245
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
3246
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
3247
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
3248
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
3249
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
3250
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
3251
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
3252
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
3253
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
3254
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
3255
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
3256
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
3257
+ | data | null | No | The response data \| 响应数据 | None | None | None |
3258
+
3259
+ <a id="get-api-u1-v1-douyin-app-v3-open-douyin-app-to-send-private-message"></a>
3260
+ ### `GET /api/u1/v1/douyin/app/v3/open_douyin_app_to_send_private_message`
3261
+
3262
+ - Summary: 生成抖音分享链接,唤起抖音APP,给指定用户发送私信/Generate Douyin share link, call Douyin APP, and send private messages to specified users
3263
+ - Capabilities: general
3264
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
3265
+ - operationId: `open_douyin_app_to_send_private_message_api_v1_douyin_app_v3_open_douyin_app_to_send_private_message_get`
3266
+
3267
+ #### Notes
3268
+
3269
+ > # [中文]
3270
+ > ### 用途:
3271
+ > - 生成抖音分享链接,唤起抖音APP,给指定用户发送私信。
3272
+ >
3273
+ > ### 参数:
3274
+ > - uid: 用户id
3275
+ > - sec_uid: 用户sec_uid
3276
+ > - 注意: 请确保user_id和sec_uid都有值,否则无法发送私信给指定用户。
3277
+ >
3278
+ > ### 返回:
3279
+ > - 分享链接
3280
+ >
3281
+ > # [English]
3282
+ > ### Purpose:
3283
+ > - Generate Douyin share link, call Douyin APP, and send private messages to specified users
3284
+ >
3285
+ > ### Parameters:
3286
+ > - uid: User id
3287
+ > - sec_uid: User sec_uid
3288
+ > - Note: Please make sure that both user_id and sec_uid have values, otherwise you cannot send private messages to the specified user.
3289
+ >
3290
+ > ### Return:
3291
+ > - Share link
3292
+ >
3293
+ > # [示例/Example]
3294
+ > uid = "96874812426"
3295
+ > sec_uid = "MS4wLjABAAAA9y04iBlVdeMQqTJbqsQZKb-tqWqWW29jPVJqideHT70"
3296
+
3297
+ #### Parameters
3298
+
3299
+ | Field | In | Type | Required | Description | Default | Example | Enum |
3300
+ | --- | --- | --- | --- | --- | --- | --- | --- |
3301
+ | uid | query | string | Yes | 用户id/User id | None | 96874812426 | None |
3302
+ | sec_uid | query | string | Yes | 用户sec_uid/User sec_uid | None | MS4wLjABAAAA9y04iBlVdeMQqTJbqsQZKb-tqWqWW29jPVJqideHT70 | None |
3303
+
3304
+ #### Request Body
3305
+
3306
+ None
3307
+
3308
+ #### Success Response
3309
+
3310
+ ##### `200 application/json`
3311
+
3312
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
3313
+
3314
+ | Field | Type | Required | Description | Default | Example | Enum |
3315
+ | --- | --- | --- | --- | --- | --- | --- |
3316
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
3317
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
3318
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
3319
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
3320
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
3321
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
3322
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
3323
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
3324
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
3325
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
3326
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
3327
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
3328
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
3329
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
3330
+ | data | null | No | The response data \| 响应数据 | None | None | None |
3331
+
3332
+ <a id="get-api-u1-v1-douyin-app-v3-open-douyin-app-to-user-profile"></a>
3333
+ ### `GET /api/u1/v1/douyin/app/v3/open_douyin_app_to_user_profile`
3334
+
3335
+ - Summary: 生成抖音分享链接,唤起抖音APP,跳转指定用户主页/Generate Douyin share link, call Douyin APP, and jump to the specified user profile
3336
+ - Capabilities: profiles / accounts
3337
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
3338
+ - operationId: `open_douyin_app_to_user_profile_api_v1_douyin_app_v3_open_douyin_app_to_user_profile_get`
3339
+
3340
+ #### Notes
3341
+
3342
+ > # [中文]
3343
+ > ### 用途:
3344
+ > - 生成抖音分享链接,唤起抖音APP,跳转指定用户主页。
3345
+ >
3346
+ > ### 参数:
3347
+ > - uid: 用户id
3348
+ > - sec_uid: 用户sec_uid
3349
+ > - 注意: 请确保user_id和sec_uid都有值,否则无法跳转到指定用户主页。
3350
+ >
3351
+ > ### 返回:
3352
+ > - 分享链接
3353
+ >
3354
+ > # [English]
3355
+ > ### Purpose:
3356
+ > - Generate Douyin share link, call Douyin APP, and jump to the specified user profile
3357
+ >
3358
+ > ### Parameters:
3359
+ > - uid: User id
3360
+ > - sec_uid: User sec_uid
3361
+ > - Note: Please make sure that both user_id and sec_uid have values, otherwise you cannot jump to the specified user profile.
3362
+ >
3363
+ > ### Return:
3364
+ > - Share link
3365
+ >
3366
+ > # [示例/Example]
3367
+ > uid = "96874812426"
3368
+ > sec_uid = "MS4wLjABAAAA9y04iBlVdeMQqTJbqsQZKb-tqWqWW29jPVJqideHT70"
3369
+
3370
+ #### Parameters
3371
+
3372
+ | Field | In | Type | Required | Description | Default | Example | Enum |
3373
+ | --- | --- | --- | --- | --- | --- | --- | --- |
3374
+ | uid | query | string | Yes | 用户id/User id | None | 96874812426 | None |
3375
+ | sec_uid | query | string | Yes | 用户sec_uid/User sec_uid | None | MS4wLjABAAAA9y04iBlVdeMQqTJbqsQZKb-tqWqWW29jPVJqideHT70 | None |
3376
+
3377
+ #### Request Body
3378
+
3379
+ None
3380
+
3381
+ #### Success Response
3382
+
3383
+ ##### `200 application/json`
3384
+
3385
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
3386
+
3387
+ | Field | Type | Required | Description | Default | Example | Enum |
3388
+ | --- | --- | --- | --- | --- | --- | --- |
3389
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
3390
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
3391
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
3392
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
3393
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
3394
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
3395
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
3396
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
3397
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
3398
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
3399
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
3400
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
3401
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
3402
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
3403
+ | data | null | No | The response data \| 响应数据 | None | None | None |
3404
+
3405
+ <a id="get-api-u1-v1-douyin-app-v3-open-douyin-app-to-video-detail"></a>
3406
+ ### `GET /api/u1/v1/douyin/app/v3/open_douyin_app_to_video_detail`
3407
+
3408
+ - Summary: 生成抖音分享链接,唤起抖音APP,跳转指定作品详情页/Generate Douyin share link, call Douyin APP, and jump to the specified video details page
3409
+ - Capabilities: content details / details
3410
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
3411
+ - operationId: `open_douyin_app_to_video_detail_api_v1_douyin_app_v3_open_douyin_app_to_video_detail_get`
3412
+
3413
+ #### Notes
3414
+
3415
+ > # [中文]
3416
+ > ### 用途:
3417
+ > - 生成抖音分享链接,唤起抖音APP,跳转指定作品详情页。
3418
+ >
3419
+ > ### 参数:
3420
+ > - aweme_id: 作品id
3421
+ >
3422
+ > ### 返回:
3423
+ > - 分享链接
3424
+ >
3425
+ > # [English]
3426
+ > ### Purpose:
3427
+ > - Generate Douyin share link, call Douyin APP, and jump to the specified video
3428
+ >
3429
+ > ### Parameters:
3430
+ > - aweme_id: Video id
3431
+ >
3432
+ > ### Return:
3433
+ > - Share link
3434
+ >
3435
+ > # [示例/Example]
3436
+ > aweme_id = "7197598285882789120"
3437
+
3438
+ #### Parameters
3439
+
3440
+ | Field | In | Type | Required | Description | Default | Example | Enum |
3441
+ | --- | --- | --- | --- | --- | --- | --- | --- |
3442
+ | aweme_id | query | string | Yes | 作品id/Video id | None | 7348044435755846962 | None |
3443
+
3444
+ #### Request Body
3445
+
3446
+ None
3447
+
3448
+ #### Success Response
3449
+
3450
+ ##### `200 application/json`
3451
+
3452
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
3453
+
3454
+ | Field | Type | Required | Description | Default | Example | Enum |
3455
+ | --- | --- | --- | --- | --- | --- | --- |
3456
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
3457
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
3458
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
3459
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
3460
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
3461
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
3462
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
3463
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
3464
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
3465
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
3466
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
3467
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
3468
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
3469
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
3470
+ | data | null | No | The response data \| 响应数据 | None | None | None |
3471
+
3472
+ <a id="get-api-u1-v1-douyin-app-v3-register-device"></a>
3473
+ ### `GET /api/u1/v1/douyin/app/v3/register_device`
3474
+
3475
+ - Summary: 抖音APP注册设备/Douyin APP register device
3476
+ - Capabilities: general
3477
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
3478
+ - operationId: `register_device_api_v1_douyin_app_v3_register_device_get`
3479
+
3480
+ #### Notes
3481
+
3482
+ > # [中文]
3483
+ > ### 用途:
3484
+ > - 抖音APP注册设备,获取设备信息以及设备的Cookie信息。
3485
+ >
3486
+ > ### 参数:
3487
+ > - proxy: 代理,要带http://或https://,仅支持http代理。
3488
+ > - 格式: username:password@ip:port
3489
+ >
3490
+ > ### 返回:
3491
+ > - 设备信息以及设备的Cookie信息。
3492
+ >
3493
+ > # [English]
3494
+ > ### Purpose:
3495
+ > - Register device in Douyin APP, retrieve device information and device cookies.
3496
+ >
3497
+ > ### Parameters:
3498
+ > - proxy: Proxy, with http:// or https://, only supports http proxies.
3499
+ > - Format: username:password@ip:port
3500
+ >
3501
+ > ### Return:
3502
+ > - Device information and device cookies.
3503
+ >
3504
+ > # [示例/Example]
3505
+ > proxy = "http://username:password@ip:port"
3506
+ >
3507
+ > # [响应/Response]
3508
+ > ```json
3509
+ > {
3510
+ > "code": 200,
3511
+ > "router": "/api/v1/douyin/app/v3/register_device",
3512
+ > "params": {
3513
+ > "proxy": "username:password@ip:port"
3514
+ > },
3515
+ > "data": {
3516
+ > "iid": "3631064037200330",
3517
+ > "device_id": "3631064037196234",
3518
+ > "mssdk_token": "",
3519
+ > "device_platform": "android",
3520
+ > "channel": "xiaomi_64_1775",
3521
+ > "version_code": 240900,
3522
+ > "version_name": "24.9.0",
3523
+ > "manifest_version_code": 240901,
3524
+ > "update_version_code": 24909900,
3525
+ > "device_type": "V1963A",
3526
+ > "device_brand": "vivo",
3527
+ > "device_model": "V1963A",
3528
+ > "openudid": "5d736335afc17aab",
3529
+ > "os_api": 29,
3530
+ > "os_version": "10",
3531
+ > "resolution": "2400x1080",
3532
+ > "dpi": 480,
3533
+ > "host_abi": "arm64-v8a",
3534
+ > "ua": "com.ss.android.ugc.aweme/240901 (Linux; U; Android 10; zh_CN; V1963A; Build/compiler10301842;tt-ok/3.12.13.4-tiktok)",
3535
+ > "cookies": {
3536
+ > "install_id": "3631064037200330",
3537
+ > "odin_tt": "5ef413aaa319b3a4077814a1da3d3e1bcec3e8640ddc3ad30945a8518f59d1563d24c3b7a3c59d97fbd5344f13208a25cf143312acf4462b028e56cd0b611cc3fc2a64318f7375470d6db86440f92841",
3538
+ > "d_ticket": "42186c5b0c54ea1a2a9e02d4e62bf6ab",
3539
+ > "store-region": "cn-js",
3540
+ > "store-region-src": "did",
3541
+ > "multi_sids": "462868309327184:38167255076198698951907954929873",
3542
+ > "passport_csrf_token": "6f75287240634ad1f51f3b3bdcdb5424",
3543
+ > "passport_csrf_token_default": "6f75287240634ad1f51f3b3bdcdb5424",
3544
+ > "ttreq": "1$7f616210b41fc044b1f164542ac4e064288b5163"
3545
+ > },
3546
+ > "lanusk": "",
3547
+ > "device_manufacturer": "vivo",
3548
+ > "uuid": "357125675341697",
3549
+ > "cdid": "f64372bf-4d1d-4883-bc8a-d3d6fa87a9e3",
3550
+ > "first_launch_timestamp": 1726970498636,
3551
+ > "x_tt_dt": "AAA2FGV24A2GAOHJJ3D3XCJ32IZDZ26XXKMQAOTDNUDWTB644ISU5YA3GBYVX2Y3XVOQ3ISDH3UA4JXGGNFXBLJ6AAZU7QTIBKHFYJLDJMDG5K36LVPBRCKLHW2XM",
3552
+ > "BootTime": 1726980411,
3553
+ > "MbTime": 1726780411,
3554
+ > "server_time": 1726980500,
3555
+ > "mc": "2A:66:7A:2D:8B:29",
3556
+ > "rom": "compiler10301842",
3557
+ > "rom_version": "PD1963-user 10 QP1A.190711.020 compiler10301842 release-keys"
3558
+ > }
3559
+ > }
3560
+ > ```
3561
+
3562
+ #### Parameters
3563
+
3564
+ | Field | In | Type | Required | Description | Default | Example | Enum |
3565
+ | --- | --- | --- | --- | --- | --- | --- | --- |
3566
+ | proxy | query | string | No | 代理/Proxy | None | None | None |
3567
+
3568
+ #### Request Body
3569
+
3570
+ None
3571
+
3572
+ #### Success Response
3573
+
3574
+ ##### `200 application/json`
3575
+
3576
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
3577
+
3578
+ | Field | Type | Required | Description | Default | Example | Enum |
3579
+ | --- | --- | --- | --- | --- | --- | --- |
3580
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
3581
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
3582
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
3583
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
3584
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
3585
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
3586
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
3587
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
3588
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
3589
+ | cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
3590
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
3591
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
3592
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
3593
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
3594
+ | data | null | No | The response data \| 响应数据 | None | None | None |