@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,4448 @@
1
+ # TikTok-Web-API Full Contract
2
+
3
+ - Back to index: [`api-capability-index.md`](../api-capability-index.md)
4
+ - Back to route summary: [`api-tags/tiktok-web-api.md`](../api-tags/tiktok-web-api.md)
5
+ - Current contract file: `api-contracts/tiktok-web-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: `58`
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: **(TikTok-Web-API数据接口/TikTok-Web-API data endpoints)**
12
+
13
+ ## Route Contracts
14
+
15
+ <a id="get-api-u1-v1-tiktok-web-decrypt-strdata"></a>
16
+ ### `GET /api/u1/v1/tiktok/web/decrypt_strData`
17
+
18
+ - Summary: 解密strData/Decrypt strData
19
+ - Capabilities: general
20
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
21
+ - operationId: `decrypt_strData_api_v1_tiktok_web_decrypt_strData_get`
22
+
23
+ #### Notes
24
+
25
+ > # [中文]
26
+ > ### 用途:
27
+ > - 解密strData指纹数据,用于分析msToken请求中的指纹信息
28
+ > ### 参数:
29
+ > - encrypted_data: 加密后的strData字符串,从浏览器自行抓包获取
30
+ > ### 返回:
31
+ > - 解密后的原始指纹数据,包含浏览器指纹信息和环境信息等。
32
+ >
33
+ > # [English]
34
+ > ### Purpose:
35
+ > - Decrypt strData fingerprint data to analyze fingerprint info in msToken request
36
+ > ### Parameters:
37
+ > - encrypted_data: Encrypted strData string, obtained from browser packet capture
38
+ > ### Return:
39
+ > - Decrypted raw fingerprint data, including browser fingerprint info and environment info, etc.
40
+
41
+ #### Parameters
42
+
43
+ | Field | In | Type | Required | Description | Default | Example | Enum |
44
+ | --- | --- | --- | --- | --- | --- | --- | --- |
45
+ | encrypted_data | query | string | Yes | 加密后的strData字符串/Encrypted strData string | None | 3BvqYbNXLLOcZehvxZVbjpAu7vq82RoWmFSJHLFwzDwJIZevE0AeilQfP55LridxmdGGjknoksqIsLq… | None |
46
+
47
+ #### Request Body
48
+
49
+ None
50
+
51
+ #### Success Response
52
+
53
+ ##### `200 application/json`
54
+
55
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
56
+
57
+ | Field | Type | Required | Description | Default | Example | Enum |
58
+ | --- | --- | --- | --- | --- | --- | --- |
59
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
60
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
61
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
62
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
63
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
64
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
65
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
66
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
67
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
68
+ | 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 |
69
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
70
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
71
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
72
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
73
+ | data | null | No | The response data \| 响应数据 | None | None | None |
74
+
75
+ <a id="get-api-u1-v1-tiktok-web-device-register"></a>
76
+ ### `GET /api/u1/v1/tiktok/web/device_register`
77
+
78
+ - Summary: 设备注册/Register device for TikTok Web
79
+ - Capabilities: general
80
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
81
+ - operationId: `device_register_api_v1_tiktok_web_device_register_get`
82
+
83
+ #### Notes
84
+
85
+ > # [中文]
86
+ > ### 用途:
87
+ > - 设备注册,为TikTok Web生成设备ID和游客Cookie
88
+ > ### 参数:
89
+ > - 无
90
+ > ### 返回:
91
+ > - 设备注册信息,包括设备ID和游客Cookie
92
+ >
93
+ > # [English]
94
+ > ### Purpose:
95
+ > - Register device to generate device ID and guest Cookie for TikTok Web
96
+ > ### Parameters:
97
+ > - None
98
+ > ### Return:
99
+ > - Device registration information, including device ID and guest Cookie
100
+ > # [响应/Response]:
101
+ > ```json
102
+ > {
103
+ > "deviceId": "7556227929396708877",
104
+ > "cookie": "tt_chain_token=wBqjjz5I8m1bt96uxA1s8A==",
105
+ > "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.212 Safari/537.36"
106
+ > }
107
+ > ```
108
+
109
+ #### Parameters
110
+
111
+ None
112
+
113
+ #### Request Body
114
+
115
+ None
116
+
117
+ #### Success Response
118
+
119
+ ##### `200 application/json`
120
+
121
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
122
+
123
+ | Field | Type | Required | Description | Default | Example | Enum |
124
+ | --- | --- | --- | --- | --- | --- | --- |
125
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
126
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
127
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
128
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
129
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
130
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
131
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
132
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
133
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
134
+ | 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 |
135
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
136
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
137
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
138
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
139
+ | data | null | No | The response data \| 响应数据 | None | None | None |
140
+
141
+ <a id="get-api-u1-v1-tiktok-web-encrypt-strdata"></a>
142
+ ### `GET /api/u1/v1/tiktok/web/encrypt_strData`
143
+
144
+ - Summary: 加密strData/Encrypt strData
145
+ - Capabilities: general
146
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
147
+ - operationId: `encrypt_strData_api_v1_tiktok_web_encrypt_strData_get`
148
+
149
+ #### Notes
150
+
151
+ > # [中文]
152
+ > ### 用途:
153
+ > - 加密strData指纹数据,用于生成msToken请求
154
+ > ### 参数:
155
+ > - data: 原始指纹数据字符串(请先将JSON格式然后转换成字符串进行请求)
156
+ > ### 返回:
157
+ > - 加密后的strData
158
+ >
159
+ > # [English]
160
+ > ### Purpose:
161
+ > - Encrypt strData fingerprint data for msToken request
162
+ > ### Parameters:
163
+ > - data: Raw fingerprint data string (please convert JSON format to string before requesting)
164
+ > ### Return:
165
+ > - Encrypted strData
166
+
167
+ #### Parameters
168
+
169
+ | Field | In | Type | Required | Description | Default | Example | Enum |
170
+ | --- | --- | --- | --- | --- | --- | --- | --- |
171
+ | data | query | string | Yes | 原始指纹数据字符串(JSON格式或字典字符串)/Raw fingerprint data string (JSON format or dict string) | None | {"behavior":{"beResize":[],"beMotion":[{"ts":1701069187299,"x":null,"y":null,"z… | None |
172
+
173
+ #### Request Body
174
+
175
+ None
176
+
177
+ #### Success Response
178
+
179
+ ##### `200 application/json`
180
+
181
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
182
+
183
+ | Field | Type | Required | Description | Default | Example | Enum |
184
+ | --- | --- | --- | --- | --- | --- | --- |
185
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
186
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
187
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
188
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
189
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
190
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
191
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
192
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
193
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
194
+ | 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 |
195
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
196
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
197
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
198
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
199
+ | data | null | No | The response data \| 响应数据 | None | None | None |
200
+
201
+ <a id="get-api-u1-v1-tiktok-web-fetch-batch-check-live-alive"></a>
202
+ ### `GET /api/u1/v1/tiktok/web/fetch_batch_check_live_alive`
203
+
204
+ - Summary: 批量直播间开播状态检测/Batch live room start status check
205
+ - Capabilities: livestream
206
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
207
+ - operationId: `fetch_batch_check_live_alive_api_v1_tiktok_web_fetch_batch_check_live_alive_get`
208
+
209
+ #### Notes
210
+
211
+ > # [中文]
212
+ > ### 用途:
213
+ > - 批量直播间开播状态检测
214
+ > - 最多支持50个直播间同时查询
215
+ > - 如果某个直播间不存在或已下播,则对应位置返回空或null。
216
+ > ### 参数:
217
+ > - room_ids: 直播间ID列表,用英文逗号分隔,如:7530611486784277278,7530633767468288782
218
+ > ### 返回:
219
+ > - 批量直播间开播状态列表
220
+ > ### 价格:
221
+ > - 定价0.025$,请尽量达到50个直播间查询,避免浪费API调用次数。
222
+ > ### 说明:
223
+ > - 同一个room_id不会重复返回开播状态。
224
+ >
225
+ > # [English]
226
+ > ### Purpose:
227
+ > - Batch live room start status check
228
+ > - Support up to 50 live rooms query at once
229
+ > - If a live room does not exist or has ended, the corresponding position will return empty or null.
230
+ > ### Parameters:
231
+ > - room_ids: Live room ID list separated by commas, e.g.: 7530611486784277278,7530633767468288782
232
+ > ### Return:
233
+ > - Batch live room start status list
234
+ > ### Price:
235
+ > - Charged by the number of live rooms queried, 0.025$ per live room, please try to query 50 live rooms to avoid wasting API call counts.
236
+ > ### Note:
237
+ > - The same room_id will not return the start status repeatedly.
238
+ >
239
+ > # [示例/Example]
240
+ > room_ids = "7530611486784277278,7530633767468288782,7530636465034775310,7530604930088848142"
241
+
242
+ #### Parameters
243
+
244
+ | Field | In | Type | Required | Description | Default | Example | Enum |
245
+ | --- | --- | --- | --- | --- | --- | --- | --- |
246
+ | room_ids | query | string | Yes | 直播间ID列表,用英文逗号分隔,最多支持50个/Live room ID list separated by commas, up to 50 IDs | None | 7530611486784277278,7530633767468288782,7530636465034775310,7530604930088848142 | None |
247
+
248
+ #### Request Body
249
+
250
+ None
251
+
252
+ #### Success Response
253
+
254
+ ##### `200 application/json`
255
+
256
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
257
+
258
+ | Field | Type | Required | Description | Default | Example | Enum |
259
+ | --- | --- | --- | --- | --- | --- | --- |
260
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
261
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
262
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
263
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
264
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
265
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
266
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
267
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
268
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
269
+ | 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 |
270
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
271
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
272
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
273
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
274
+ | data | null | No | The response data \| 响应数据 | None | None | None |
275
+
276
+ <a id="get-api-u1-v1-tiktok-web-fetch-check-live-alive"></a>
277
+ ### `GET /api/u1/v1/tiktok/web/fetch_check_live_alive`
278
+
279
+ - Summary: 直播间开播状态检测/Live room start status check
280
+ - Capabilities: livestream
281
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
282
+ - operationId: `fetch_check_live_alive_api_v1_tiktok_web_fetch_check_live_alive_get`
283
+
284
+ #### Notes
285
+
286
+ > # [中文]
287
+ > ### 用途:
288
+ > - 直播间开播状态检测
289
+ > - 如果当前直播间不存在或已下播,则返回空。
290
+ > ### 参数:
291
+ > - room_id: 直播间ID
292
+ > ### 返回:
293
+ > - 直播间开播状态
294
+ >
295
+ > # [English]
296
+ > ### Purpose:
297
+ > - Live room start status check
298
+ > - If the current live room does not exist or has ended, it will return empty.
299
+ > ### Parameters:
300
+ > - room_id: Live room ID
301
+ > ### Return:
302
+ > - Live room start status
303
+ >
304
+ > # [示例/Example]
305
+ > room_id = "7381444193462078214"
306
+
307
+ #### Parameters
308
+
309
+ | Field | In | Type | Required | Description | Default | Example | Enum |
310
+ | --- | --- | --- | --- | --- | --- | --- | --- |
311
+ | room_id | query | string | Yes | 直播间ID/Live room ID | None | 7381444193462078214 | None |
312
+
313
+ #### Request Body
314
+
315
+ None
316
+
317
+ #### Success Response
318
+
319
+ ##### `200 application/json`
320
+
321
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
322
+
323
+ | Field | Type | Required | Description | Default | Example | Enum |
324
+ | --- | --- | --- | --- | --- | --- | --- |
325
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
326
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
327
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
328
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
329
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
330
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
331
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
332
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
333
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
334
+ | 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 |
335
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
336
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
337
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
338
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
339
+ | data | null | No | The response data \| 响应数据 | None | None | None |
340
+
341
+ <a id="get-api-u1-v1-tiktok-web-fetch-explore-post"></a>
342
+ ### `GET /api/u1/v1/tiktok/web/fetch_explore_post`
343
+
344
+ - Summary: 获取探索作品数据/Get explore video data
345
+ - Capabilities: content details
346
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
347
+ - operationId: `fetch_explore_post_api_v1_tiktok_web_fetch_explore_post_get`
348
+
349
+ #### Notes
350
+
351
+ > # [中文]
352
+ > ### 用途:
353
+ > - 获取探索作品数据
354
+ > ### 参数:
355
+ > - categoryType: 作品分类
356
+ > - 100: 动画与漫画
357
+ > - 101: 表演
358
+ > - 102: 美容护理
359
+ > - 103: 游戏
360
+ > - 104: 喜剧
361
+ > - 105: 日常生活
362
+ > - 106: 家庭
363
+ > - 107: 情感关系
364
+ > - 108: 戏剧
365
+ > - 109: 穿搭
366
+ > - 110: 对口型
367
+ > - 111: 美食
368
+ > - 112: 运动
369
+ > - 113: 动物
370
+ > - 114: 社会
371
+ > - 115: 汽车
372
+ > - 116: 教育
373
+ > - 117: 健身和健康
374
+ > - 118: 科技
375
+ > - 119: 唱歌跳舞
376
+ > - 120: 全部
377
+ > - count: 每页数量
378
+ > ### 返回:
379
+ > - 作品数据
380
+ > ### 备注:
381
+ > - 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问,否则会返回HTTP403错误。
382
+ > - 在访问视频CDN链接时,请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。
383
+ > - **如果访问视频CDN链接时返回HTTP 403错误**:
384
+ > 1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)
385
+ > 2. 在请求该链接时,务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值
386
+ > 3. 示例请求头: `Cookie: tt_chain_token=xxx`
387
+ > - 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接,请使用 TikTok APP V3 目录下的接口。
388
+ >
389
+ > # [English]
390
+ > ### Purpose:
391
+ > - Get explore video data
392
+ > ### Parameters:
393
+ > - categoryType: Video category
394
+ > - 100: Animation and comics
395
+ > - 101: Performance
396
+ > - 102: Beauty care
397
+ > - 103: Game
398
+ > - 104: Comedy
399
+ > - 105: Daily life
400
+ > - 106: Family
401
+ > - 107: Emotional relationship
402
+ > - 108: Drama
403
+ > - 109: Dress up
404
+ > - 110: Dubbing
405
+ > - 111: Food
406
+ > - 112: Sports
407
+ > - 113: Animals
408
+ > - 114: Society
409
+ > - 115: Car
410
+ > - 116: Education
411
+ > - 117: Fitness and health
412
+ > - 118: Technology
413
+ > - 119: Singing and dancing
414
+ > - 120: All
415
+ > - count: Number per page
416
+ > ### Return:
417
+ > - Video data
418
+ > ### Note:
419
+ > - All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.
420
+ > - When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.
421
+ > - **If you receive HTTP 403 error when accessing video CDN links**:
422
+ > 1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)
423
+ > 2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API
424
+ > 3. Example request header: `Cookie: tt_chain_token=xxx`
425
+ > - If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.
426
+ >
427
+ > # [示例/Example]
428
+ > categoryType = "120"
429
+ > count = 16
430
+
431
+ #### Parameters
432
+
433
+ | Field | In | Type | Required | Description | Default | Example | Enum |
434
+ | --- | --- | --- | --- | --- | --- | --- | --- |
435
+ | categoryType | query | string | No | 作品分类/Video category | 120 | None | None |
436
+ | count | query | integer | No | 每页数量/Number per page | 16 | None | None |
437
+
438
+ #### Request Body
439
+
440
+ None
441
+
442
+ #### Success Response
443
+
444
+ ##### `200 application/json`
445
+
446
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
447
+
448
+ | Field | Type | Required | Description | Default | Example | Enum |
449
+ | --- | --- | --- | --- | --- | --- | --- |
450
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
451
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
452
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
453
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
454
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
455
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
456
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
457
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
458
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
459
+ | 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 |
460
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
461
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
462
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
463
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
464
+ | data | null | No | The response data \| 响应数据 | None | None | None |
465
+
466
+ <a id="get-api-u1-v1-tiktok-web-fetch-general-search"></a>
467
+ ### `GET /api/u1/v1/tiktok/web/fetch_general_search`
468
+
469
+ - Summary: 获取综合搜索列表/Get general search list
470
+ - Capabilities: search
471
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
472
+ - operationId: `fetch_general_search_api_v1_tiktok_web_fetch_general_search_get`
473
+
474
+ #### Notes
475
+
476
+ > # [中文]
477
+ > ### 用途:
478
+ > - 获取综合搜索列表
479
+ > ### 参数:
480
+ > - keyword: 搜索关键词
481
+ > - offset: 翻页游标,第一次请求时为0,第二次请求时从上一次请求的返回响应中获取,一般这个值的关键字为offset或者cursor。
482
+ > - search_id: 搜索id,第一次请求时为空,第二次翻页时需要提供,需要从上一次请求的返回响应中获取。
483
+ > - 例如: search_id = "20240828035554C02011379EBB6A00E00B"
484
+ > - JSON Path-1 : $.data.extra.logid
485
+ > - JSON Path-2 : $.data.log_pb.impr_id
486
+ > - cookie: 用户cookie(如果你需要使用自己的账号搜索,或者遇到接口报错,可以自行提供cookie,默认不需要提供)
487
+ > ### 返回:
488
+ > - 综合搜索列表
489
+ > ### 备注:
490
+ > - 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问,否则会返回HTTP403错误。
491
+ > - 在访问视频CDN链接时,请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。
492
+ > - **如果访问视频CDN链接时返回HTTP 403错误**:
493
+ > 1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)
494
+ > 2. 在请求该链接时,务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值
495
+ > 3. 示例请求头: `Cookie: tt_chain_token=xxx`
496
+ > - 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接,请使用 TikTok APP V3 目录下的接口。
497
+ >
498
+ > # [English]
499
+ > ### Purpose:
500
+ > - Get general search list
501
+ > ### Parameters:
502
+ > - keyword: Search keyword
503
+ > - offset: Page cursor, 0 for the first request, need to provide for the second paging, generally the keyword of this value is offset or cursor.
504
+ > - 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.
505
+ > - For example: search_id = "20240828035554C02011379EBB6A00E00B"
506
+ > - JSON Path-1 : $.data.extra.logid
507
+ > - JSON Path-2 : $.data.log_pb.impr_id
508
+ > - cookie: User cookie (If you need to search with your own account, or encounter an interface error, you can provide the cookie yourself, default is not required)
509
+ > ### Return:
510
+ > - General search list
511
+ > ### Note:
512
+ > - All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.
513
+ > - When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.
514
+ > - **If you receive HTTP 403 error when accessing video CDN links**:
515
+ > 1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)
516
+ > 2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API
517
+ > 3. Example request header: `Cookie: tt_chain_token=xxx`
518
+ > - If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.
519
+ >
520
+ > # [示例/Example]
521
+ > keyword = "TikTok"
522
+ > offset = 0
523
+ > search_id = ""
524
+
525
+ #### Parameters
526
+
527
+ | Field | In | Type | Required | Description | Default | Example | Enum |
528
+ | --- | --- | --- | --- | --- | --- | --- | --- |
529
+ | keyword | query | string | Yes | 搜索关键词/Search keyword | None | TikTok | None |
530
+ | offset | query | integer | No | 翻页游标/Page cursor | 0 | None | None |
531
+ | search_id | query | string | No | 搜索id,翻页时需要提供/Search id, need to provide when paging | None | None | None |
532
+ | cookie | query | string | No | 用户cookie(按需提供)/User cookie(if needed) | None | None | None |
533
+
534
+ #### Request Body
535
+
536
+ None
537
+
538
+ #### Success Response
539
+
540
+ ##### `200 application/json`
541
+
542
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
543
+
544
+ | Field | Type | Required | Description | Default | Example | Enum |
545
+ | --- | --- | --- | --- | --- | --- | --- |
546
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
547
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
548
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
549
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
550
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
551
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
552
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
553
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
554
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
555
+ | 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 |
556
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
557
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
558
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
559
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
560
+ | data | null | No | The response data \| 响应数据 | None | None | None |
561
+
562
+ <a id="post-api-u1-v1-tiktok-web-fetch-gift-name-by-id"></a>
563
+ ### `POST /api/u1/v1/tiktok/web/fetch_gift_name_by_id`
564
+
565
+ - Summary: 根据Gift ID查询礼物名称/Get gift name by gift ID
566
+ - Capabilities: general
567
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
568
+ - operationId: `fetch_gift_name_by_id_api_v1_tiktok_web_fetch_gift_name_by_id_post`
569
+
570
+ #### Notes
571
+
572
+ > 根据TikTok的Gift ID查询对应的礼物名称 | Get gift name by TikTok gift ID
573
+
574
+ #### Parameters
575
+
576
+ None
577
+
578
+ #### Request Body
579
+
580
+ - required: Yes
581
+
582
+ ##### `application/json`
583
+
584
+ - Schema summary: `gift_id*`:string
585
+
586
+ | Field | Type | Required | Description | Default | Example | Enum |
587
+ | --- | --- | --- | --- | --- | --- | --- |
588
+ | gift_id | string | Yes | 礼物ID \| Gift ID | None | 10001 | None |
589
+
590
+ #### Success Response
591
+
592
+ ##### `200 application/json`
593
+
594
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
595
+
596
+ | Field | Type | Required | Description | Default | Example | Enum |
597
+ | --- | --- | --- | --- | --- | --- | --- |
598
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
599
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
600
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
601
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
602
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
603
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
604
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
605
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
606
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
607
+ | 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 |
608
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
609
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
610
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
611
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
612
+ | data | null | No | The response data \| 响应数据 | None | None | None |
613
+
614
+ <a id="post-api-u1-v1-tiktok-web-fetch-gift-names-by-ids"></a>
615
+ ### `POST /api/u1/v1/tiktok/web/fetch_gift_names_by_ids`
616
+
617
+ - Summary: 批量查询Gift ID对应的礼物名称($0.025/次,建议50个)/Batch get gift names by gift IDs ($0.025/call, suggest 50)
618
+ - Capabilities: general
619
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
620
+ - operationId: `fetch_gift_names_by_ids_api_v1_tiktok_web_fetch_gift_names_by_ids_post`
621
+
622
+ #### Notes
623
+
624
+ > 批量查询多个TikTok Gift ID对应的礼物名称。计费:$0.025每次调用。建议每次查询50个ID以获得最佳性价比,超过50个时自动处理前50个 | Batch get gift names by multiple TikTok gift IDs. Pricing: $0.025 per call. Recommend querying 50 IDs at once for best value, auto-process first 50 IDs if more than 50
625
+
626
+ #### Parameters
627
+
628
+ None
629
+
630
+ #### Request Body
631
+
632
+ - required: Yes
633
+
634
+ ##### `application/json`
635
+
636
+ - Schema summary: `gift_ids*`[string]
637
+
638
+ | Field | Type | Required | Description | Default | Example | Enum |
639
+ | --- | --- | --- | --- | --- | --- | --- |
640
+ | gift_ids | array<string> | Yes | 礼物ID列表,建议50个/次获得最佳性价比($0.025),超过50个时自动处理前50个 \| Gift ID list, recommend 50/call for best value ($0.025), auto-process first 50 if more than 50 | None | ["10001", "10002", "10003"] | None |
641
+
642
+ #### Success Response
643
+
644
+ ##### `200 application/json`
645
+
646
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
647
+
648
+ | Field | Type | Required | Description | Default | Example | Enum |
649
+ | --- | --- | --- | --- | --- | --- | --- |
650
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
651
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
652
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
653
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
654
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
655
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
656
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
657
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
658
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
659
+ | 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 |
660
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
661
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
662
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
663
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
664
+ | data | null | No | The response data \| 响应数据 | None | None | None |
665
+
666
+ <a id="post-api-u1-v1-tiktok-web-fetch-home-feed"></a>
667
+ ### `POST /api/u1/v1/tiktok/web/fetch_home_feed`
668
+
669
+ - Summary: 首页推荐作品/Home Feed
670
+ - Capabilities: profiles / accounts
671
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
672
+ - operationId: `fetch_home_feed_api_v1_tiktok_web_fetch_home_feed_post`
673
+
674
+ #### Notes
675
+
676
+ > # [中文]
677
+ > ### 用途:
678
+ > - 首页推荐作品
679
+ > ### 参数:
680
+ > - count: 每页数量
681
+ > - cookie: 用户自己的cookie,可选参数,用于接口返回数据的个性化推荐。
682
+ > ### 返回:
683
+ > - 首页推荐作品
684
+ > ### 备注:
685
+ > - 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问,否则会返回HTTP403错误。
686
+ > - 在访问视频CDN链接时,请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。
687
+ > - **如果访问视频CDN链接时返回HTTP 403错误**:
688
+ > 1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)
689
+ > 2. 在请求该链接时,务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值
690
+ > 3. 示例请求头: `Cookie: tt_chain_token=xxx`
691
+ > - 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接,请使用 TikTok APP V3 目录下的接口。
692
+ >
693
+ > # [English]
694
+ > ### Purpose:
695
+ > - Home Feed
696
+ > ### Parameters:
697
+ > - count: Number per page
698
+ > - cookie: User's own cookie, optional parameter, used for personalized recommendations of interface return data.
699
+ > ### Return:
700
+ > - Home Feed
701
+ > ### Note:
702
+ > - All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.
703
+ > - When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.
704
+ > - **If you receive HTTP 403 error when accessing video CDN links**:
705
+ > 1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)
706
+ > 2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API
707
+ > 3. Example request header: `Cookie: tt_chain_token=xxx`
708
+ > - If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.
709
+ >
710
+ > # [示例/Example]
711
+ > count = 15
712
+ > Cookie = "Your_Cookie"
713
+
714
+ #### Parameters
715
+
716
+ None
717
+
718
+ #### Request Body
719
+
720
+ - required: No
721
+
722
+ ##### `application/json`
723
+
724
+ - Schema summary: `count`:integer, `cookie`:string
725
+
726
+ | Field | Type | Required | Description | Default | Example | Enum |
727
+ | --- | --- | --- | --- | --- | --- | --- |
728
+ | count | integer | No | 每页数量/Number per page | 15 | None | None |
729
+ | cookie | string | No | 用户自己的cookie,可选参数,用于接口返回数据的个性化推荐。/ User's own cookie, optional parameter, used for personalized recommendations of interface return data. | None | None | None |
730
+
731
+ #### Success Response
732
+
733
+ ##### `200 application/json`
734
+
735
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
736
+
737
+ | Field | Type | Required | Description | Default | Example | Enum |
738
+ | --- | --- | --- | --- | --- | --- | --- |
739
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
740
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
741
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
742
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
743
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
744
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
745
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
746
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
747
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
748
+ | 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 |
749
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
750
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
751
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
752
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
753
+ | data | null | No | The response data \| 响应数据 | None | None | None |
754
+
755
+ <a id="get-api-u1-v1-tiktok-web-fetch-live-gift-list"></a>
756
+ ### `GET /api/u1/v1/tiktok/web/fetch_live_gift_list`
757
+
758
+ - Summary: 获取直播间礼物列表/Get live room gift list
759
+ - Capabilities: livestream
760
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
761
+ - operationId: `fetch_live_gift_list_api_v1_tiktok_web_fetch_live_gift_list_get`
762
+
763
+ #### Notes
764
+
765
+ > # [中文]
766
+ > ### 用途:
767
+ > - 获取直播间礼物列表
768
+ > - room_id为可选参数,不传则获取通用礼物列表(2025年08月15日统计是256种礼物)
769
+ > ### 参数:
770
+ > - room_id: 直播间ID(可选)
771
+ > ### 返回:
772
+ > - 直播间礼物列表数据
773
+ > ### 备注:
774
+ > - 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问,否则会返回HTTP403错误。
775
+ > - 在访问视频CDN链接时,请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。
776
+ > - **如果访问视频CDN链接时返回HTTP 403错误**:
777
+ > 1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)
778
+ > 2. 在请求该链接时,务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值
779
+ > 3. 示例请求头: `Cookie: tt_chain_token=xxx`
780
+ > - 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接,请使用 TikTok APP V3 目录下的接口。
781
+ >
782
+ > # [English]
783
+ > ### Purpose:
784
+ > - Get live room gift list
785
+ > - room_id is optional parameter, if not provided, will get general gift list (as of August 15, 2025, there are 256 types of gifts)
786
+ > ### Parameters:
787
+ > - room_id: Live room ID (optional)
788
+ > ### Return:
789
+ > - Live room gift list data
790
+ > ### Note:
791
+ > - All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.
792
+ > - When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.
793
+ > - **If you receive HTTP 403 error when accessing video CDN links**:
794
+ > 1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)
795
+ > 2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API
796
+ > 3. Example request header: `Cookie: tt_chain_token=xxx`
797
+ > - If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.
798
+ >
799
+ > # [示例/Example]
800
+ > room_id = "7381444193462078214" # 可选/Optional
801
+
802
+ #### Parameters
803
+
804
+ | Field | In | Type | Required | Description | Default | Example | Enum |
805
+ | --- | --- | --- | --- | --- | --- | --- | --- |
806
+ | room_id | query | string | No | 直播间ID,可选参数/Live room ID, optional parameter | None | 7381444193462078214 | None |
807
+
808
+ #### Request Body
809
+
810
+ None
811
+
812
+ #### Success Response
813
+
814
+ ##### `200 application/json`
815
+
816
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
817
+
818
+ | Field | Type | Required | Description | Default | Example | Enum |
819
+ | --- | --- | --- | --- | --- | --- | --- |
820
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
821
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
822
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
823
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
824
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
825
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
826
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
827
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
828
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
829
+ | 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 |
830
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
831
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
832
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
833
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
834
+ | data | null | No | The response data \| 响应数据 | None | None | None |
835
+
836
+ <a id="get-api-u1-v1-tiktok-web-fetch-live-im-fetch"></a>
837
+ ### `GET /api/u1/v1/tiktok/web/fetch_live_im_fetch`
838
+
839
+ - Summary: TikTok直播间弹幕参数获取/tiktok live room danmaku parameters
840
+ - Capabilities: livestream
841
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
842
+ - operationId: `fetch_live_im_fetch_api_v1_tiktok_web_fetch_live_im_fetch_get`
843
+
844
+ #### Notes
845
+
846
+ > # [中文]
847
+ > ### 用途:
848
+ > - TikTok直播间弹幕参数获取
849
+ > ### 参数:
850
+ > - room_id: 直播间号
851
+ > - user_unique_id: 用户唯一ID
852
+ >
853
+ > ### 返回:
854
+ > - 弹幕参数数据
855
+ >
856
+ > # [English]
857
+ > ### Purpose:
858
+ > - TikTok live room danmaku parameters
859
+ > ### Parameters:
860
+ > - room_id: Live room id
861
+ > - user_unique_id: User unique ID
862
+ >
863
+ > ### Return:
864
+ > - Danmaku parameter data
865
+
866
+ #### Parameters
867
+
868
+ | Field | In | Type | Required | Description | Default | Example | Enum |
869
+ | --- | --- | --- | --- | --- | --- | --- | --- |
870
+ | room_id | query | string | Yes | 直播间号/Live room id | None | 7382517534467115826 | None |
871
+ | user_unique_id | query | string | Yes | 用户唯一ID/User unique ID | None | 7382524529011246630 | None |
872
+
873
+ #### Request Body
874
+
875
+ None
876
+
877
+ #### Success Response
878
+
879
+ ##### `200 application/json`
880
+
881
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
882
+
883
+ | Field | Type | Required | Description | Default | Example | Enum |
884
+ | --- | --- | --- | --- | --- | --- | --- |
885
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
886
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
887
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
888
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
889
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
890
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
891
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
892
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
893
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
894
+ | 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 |
895
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
896
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
897
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
898
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
899
+ | data | null | No | The response data \| 响应数据 | None | None | None |
900
+
901
+ <a id="get-api-u1-v1-tiktok-web-fetch-live-recommend"></a>
902
+ ### `GET /api/u1/v1/tiktok/web/fetch_live_recommend`
903
+
904
+ - Summary: 获取直播间首页推荐列表/Get live room homepage recommendation list
905
+ - Capabilities: livestream
906
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
907
+ - operationId: `fetch_live_recommend_api_v1_tiktok_web_fetch_live_recommend_get`
908
+
909
+ #### Notes
910
+
911
+ > # [中文]
912
+ > ### 用途:
913
+ > - 获取直播间首页推荐列表
914
+ > ### 参数:
915
+ > - related_live_tag: 相关直播标签
916
+ > ### 返回:
917
+ > - 直播间首页推荐列表
918
+ > ### 备注:
919
+ > - 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问,否则会返回HTTP403错误。
920
+ > - 在访问视频CDN链接时,请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。
921
+ > - **如果访问视频CDN链接时返回HTTP 403错误**:
922
+ > 1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)
923
+ > 2. 在请求该链接时,务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值
924
+ > 3. 示例请求头: `Cookie: tt_chain_token=xxx`
925
+ > - 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接,请使用 TikTok APP V3 目录下的接口。
926
+ >
927
+ > # [English]
928
+ > ### Purpose:
929
+ > - Get live room homepage recommendation list
930
+ > ### Parameters:
931
+ > - related_live_tag: Related live tag
932
+ > ### Return:
933
+ > - Live room homepage recommendation list
934
+ > ### Note:
935
+ > - All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.
936
+ > - When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.
937
+ > - **If you receive HTTP 403 error when accessing video CDN links**:
938
+ > 1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)
939
+ > 2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API
940
+ > 3. Example request header: `Cookie: tt_chain_token=xxx`
941
+ > - If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.
942
+ >
943
+ > # [示例/Example]
944
+ > related_live_tag = "VALORANT"
945
+
946
+ #### Parameters
947
+
948
+ | Field | In | Type | Required | Description | Default | Example | Enum |
949
+ | --- | --- | --- | --- | --- | --- | --- | --- |
950
+ | related_live_tag | query | string | Yes | 相关直播标签/Related live tag | None | VALORANT | None |
951
+
952
+ #### Request Body
953
+
954
+ None
955
+
956
+ #### Success Response
957
+
958
+ ##### `200 application/json`
959
+
960
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
961
+
962
+ | Field | Type | Required | Description | Default | Example | Enum |
963
+ | --- | --- | --- | --- | --- | --- | --- |
964
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
965
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
966
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
967
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
968
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
969
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
970
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
971
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
972
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
973
+ | 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 |
974
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
975
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
976
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
977
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
978
+ | data | null | No | The response data \| 响应数据 | None | None | None |
979
+
980
+ <a id="get-api-u1-v1-tiktok-web-fetch-post-comment"></a>
981
+ ### `GET /api/u1/v1/tiktok/web/fetch_post_comment`
982
+
983
+ - Summary: 获取作品的评论列表/Get video comments
984
+ - Capabilities: comments / content details
985
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
986
+ - operationId: `fetch_post_comment_api_v1_tiktok_web_fetch_post_comment_get`
987
+
988
+ #### Notes
989
+
990
+ > # [中文]
991
+ > ### 用途:
992
+ > - 获取作品的评论列表
993
+ > ### 参数:
994
+ > - aweme_id: 作品id
995
+ > - cursor: 翻页游标
996
+ > - count: 每页数量
997
+ > - current_region: 当前地区,默认为空。
998
+ > ### 返回:
999
+ > - 作品的评论列表
1000
+ >
1001
+ > # [English]
1002
+ > ### Purpose:
1003
+ > - Get video comments
1004
+ > ### Parameters:
1005
+ > - aweme_id: Video id
1006
+ > - cursor: Page cursor
1007
+ > - count: Number per page
1008
+ > - current_region: Current region, default is empty.
1009
+ > ### Return:
1010
+ > - Video comments
1011
+ >
1012
+ > # [示例/Eample]
1013
+ > aweme_id = "7304809083817774382"
1014
+ > cursor = 0
1015
+ > count = 20
1016
+ > current_region = ""
1017
+
1018
+ #### Parameters
1019
+
1020
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1021
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1022
+ | aweme_id | query | string | Yes | 作品id/Video id | None | 7304809083817774382 | None |
1023
+ | cursor | query | integer | No | 翻页游标/Page cursor | 0 | None | None |
1024
+ | count | query | integer | No | 每页数量/Number per page | 20 | None | None |
1025
+ | current_region | query | string | No | 当前地区/Current region | None | None | None |
1026
+
1027
+ #### Request Body
1028
+
1029
+ None
1030
+
1031
+ #### Success Response
1032
+
1033
+ ##### `200 application/json`
1034
+
1035
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1036
+
1037
+ | Field | Type | Required | Description | Default | Example | Enum |
1038
+ | --- | --- | --- | --- | --- | --- | --- |
1039
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1040
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1041
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1042
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1043
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1044
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1045
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1046
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1047
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1048
+ | 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 |
1049
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1050
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1051
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1052
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1053
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1054
+
1055
+ <a id="get-api-u1-v1-tiktok-web-fetch-post-comment-reply"></a>
1056
+ ### `GET /api/u1/v1/tiktok/web/fetch_post_comment_reply`
1057
+
1058
+ - Summary: 获取作品的评论回复列表/Get video comment replies
1059
+ - Capabilities: comments / comment replies / content details
1060
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1061
+ - operationId: `fetch_post_comment_reply_api_v1_tiktok_web_fetch_post_comment_reply_get`
1062
+
1063
+ #### Notes
1064
+
1065
+ > # [中文]
1066
+ > ### 用途:
1067
+ > - 获取作品的评论回复列表
1068
+ > ### 参数:
1069
+ > - item_id: 作品id
1070
+ > - comment_id: 评论id
1071
+ > - cursor: 翻页游标
1072
+ > - count: 每页数量
1073
+ > - current_region: 当前地区,默认为空。
1074
+ > ### 返回:
1075
+ > - 作品的评论回复列表
1076
+ >
1077
+ > # [English]
1078
+ > ### Purpose:
1079
+ > - Get video comment replies
1080
+ > ### Parameters:
1081
+ > - item_id: Video id
1082
+ > - comment_id: Comment id
1083
+ > - cursor: Page cursor
1084
+ > - count: Number per page
1085
+ > - current_region: Current region, default is empty.
1086
+ > ### Return:
1087
+ > - Video comment replies
1088
+ >
1089
+ > # [示例/Eample]
1090
+ > item_id = "7304809083817774382"
1091
+ > comment_id = "7304877760886588191"
1092
+ > cursor = 0
1093
+ > count = 20
1094
+ > current_region = ""
1095
+
1096
+ #### Parameters
1097
+
1098
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1099
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1100
+ | item_id | query | string | Yes | 作品id/Video id | None | 7304809083817774382 | None |
1101
+ | comment_id | query | string | Yes | 评论id/Comment id | None | 7304877760886588191 | None |
1102
+ | cursor | query | integer | No | 翻页游标/Page cursor | 0 | None | None |
1103
+ | count | query | integer | No | 每页数量/Number per page | 20 | None | None |
1104
+ | current_region | query | string | No | 当前地区/Current region | None | None | None |
1105
+
1106
+ #### Request Body
1107
+
1108
+ None
1109
+
1110
+ #### Success Response
1111
+
1112
+ ##### `200 application/json`
1113
+
1114
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1115
+
1116
+ | Field | Type | Required | Description | Default | Example | Enum |
1117
+ | --- | --- | --- | --- | --- | --- | --- |
1118
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1119
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1120
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1121
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1122
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1123
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1124
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1125
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1126
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1127
+ | 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 |
1128
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1129
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1130
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1131
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1132
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1133
+
1134
+ <a id="get-api-u1-v1-tiktok-web-fetch-post-detail"></a>
1135
+ ### `GET /api/u1/v1/tiktok/web/fetch_post_detail`
1136
+
1137
+ - Summary: 获取单个作品数据/Get single video data
1138
+ - Capabilities: content details / details
1139
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1140
+ - operationId: `fetch_post_detail_api_v1_tiktok_web_fetch_post_detail_get`
1141
+
1142
+ #### Notes
1143
+
1144
+ > # [中文]
1145
+ > ### 用途:
1146
+ > - 获取单个作品数据
1147
+ > ### 参数:
1148
+ > - itemId: 作品id
1149
+ > ### 返回:
1150
+ > - 作品数据
1151
+ > ### 备注:
1152
+ > - 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问,否则会返回HTTP403错误。
1153
+ > - 在访问视频CDN链接时,请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。
1154
+ > - **如果访问视频CDN链接时返回HTTP 403错误**:
1155
+ > 1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)
1156
+ > 2. 在请求该链接时,务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值
1157
+ > 3. 示例请求头: `Cookie: tt_chain_token=xxx`
1158
+ > - 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接,请使用 TikTok APP V3 目录下的接口。
1159
+ >
1160
+ > # [English]
1161
+ > ### Purpose:
1162
+ > - Get single video data
1163
+ > ### Parameters:
1164
+ > - itemId: Video id
1165
+ > ### Return:
1166
+ > - Video data
1167
+ > ### Note:
1168
+ > - All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.
1169
+ > - When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.
1170
+ > - **If you receive HTTP 403 error when accessing video CDN links**:
1171
+ > 1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)
1172
+ > 2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API
1173
+ > 3. Example request header: `Cookie: tt_chain_token=xxx`
1174
+ > - If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.
1175
+ >
1176
+ > # [示例/Example]
1177
+ > itemId = "7339393672959757570"
1178
+
1179
+ #### Parameters
1180
+
1181
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1182
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1183
+ | itemId | query | string | Yes | 作品id/Video id | None | 7339393672959757570 | None |
1184
+
1185
+ #### Request Body
1186
+
1187
+ None
1188
+
1189
+ #### Success Response
1190
+
1191
+ ##### `200 application/json`
1192
+
1193
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1194
+
1195
+ | Field | Type | Required | Description | Default | Example | Enum |
1196
+ | --- | --- | --- | --- | --- | --- | --- |
1197
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1198
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1199
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1200
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1201
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1202
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1203
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1204
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1205
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1206
+ | 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 |
1207
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1208
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1209
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1210
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1211
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1212
+
1213
+ <a id="get-api-u1-v1-tiktok-web-fetch-post-detail-v2"></a>
1214
+ ### `GET /api/u1/v1/tiktok/web/fetch_post_detail_v2`
1215
+
1216
+ - Summary: 获取单个作品数据 V2/Get single video data V2
1217
+ - Capabilities: content details / details
1218
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1219
+ - operationId: `fetch_post_detail_v2_api_v1_tiktok_web_fetch_post_detail_v2_get`
1220
+
1221
+ #### Notes
1222
+
1223
+ > # [中文]
1224
+ > ### 用途:
1225
+ > - 获取单个作品数据
1226
+ > ### 参数:
1227
+ > - itemId: 作品id
1228
+ > ### 返回:
1229
+ > - 作品数据
1230
+ > ### 备注:
1231
+ > - 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问,否则会返回HTTP403错误。
1232
+ > - 在访问视频CDN链接时,请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。
1233
+ > - **如果访问视频CDN链接时返回HTTP 403错误**:
1234
+ > 1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)
1235
+ > 2. 在请求该链接时,务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值
1236
+ > 3. 示例请求头: `Cookie: tt_chain_token=xxx`
1237
+ > - 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接,请使用 TikTok APP V3 目录下的接口。
1238
+ >
1239
+ > # [English]
1240
+ > ### Purpose:
1241
+ > - Get single video data
1242
+ > ### Parameters:
1243
+ > - itemId: Video id
1244
+ > ### Return:
1245
+ > - Video data
1246
+ > ### Note:
1247
+ > - All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.
1248
+ > - When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.
1249
+ > - **If you receive HTTP 403 error when accessing video CDN links**:
1250
+ > 1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)
1251
+ > 2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API
1252
+ > 3. Example request header: `Cookie: tt_chain_token=xxx`
1253
+ > - If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.
1254
+ >
1255
+ > # [示例/Example]
1256
+ > itemId = "7339393672959757570"
1257
+
1258
+ #### Parameters
1259
+
1260
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1261
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1262
+ | itemId | query | string | Yes | 作品id/Video id | None | 7339393672959757570 | None |
1263
+
1264
+ #### Request Body
1265
+
1266
+ None
1267
+
1268
+ #### Success Response
1269
+
1270
+ ##### `200 application/json`
1271
+
1272
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1273
+
1274
+ | Field | Type | Required | Description | Default | Example | Enum |
1275
+ | --- | --- | --- | --- | --- | --- | --- |
1276
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1277
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1278
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1279
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1280
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1281
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1282
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1283
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1284
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1285
+ | 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 |
1286
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1287
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1288
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1289
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1290
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1291
+
1292
+ <a id="get-api-u1-v1-tiktok-web-fetch-search-keyword-suggest"></a>
1293
+ ### `GET /api/u1/v1/tiktok/web/fetch_search_keyword_suggest`
1294
+
1295
+ - Summary: 搜索关键字推荐/Search keyword suggest
1296
+ - Capabilities: search
1297
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1298
+ - operationId: `fetch_search_keyword_suggest_api_v1_tiktok_web_fetch_search_keyword_suggest_get`
1299
+
1300
+ #### Notes
1301
+
1302
+ > # [中文]
1303
+ > ### 用途:
1304
+ > - 搜索关键字推荐
1305
+ > ### 参数:
1306
+ > - keyword: 搜索关键词
1307
+ > ### 返回:
1308
+ > - 关键字推荐列表
1309
+ >
1310
+ > # [English]
1311
+ > ### Purpose:
1312
+ > - Search keyword suggest
1313
+ > ### Parameters:
1314
+ > - keyword: Search keyword
1315
+ > ### Return:
1316
+ > - Keyword suggest list
1317
+ >
1318
+ > # [示例/Example]
1319
+ > keyword = "TikTok"
1320
+
1321
+ #### Parameters
1322
+
1323
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1324
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1325
+ | keyword | query | string | Yes | 搜索关键词/Search keyword | None | TikTok | None |
1326
+
1327
+ #### Request Body
1328
+
1329
+ None
1330
+
1331
+ #### Success Response
1332
+
1333
+ ##### `200 application/json`
1334
+
1335
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1336
+
1337
+ | Field | Type | Required | Description | Default | Example | Enum |
1338
+ | --- | --- | --- | --- | --- | --- | --- |
1339
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1340
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1341
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1342
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1343
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1344
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1345
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1346
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1347
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1348
+ | 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 |
1349
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1350
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1351
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1352
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1353
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1354
+
1355
+ <a id="get-api-u1-v1-tiktok-web-fetch-search-live"></a>
1356
+ ### `GET /api/u1/v1/tiktok/web/fetch_search_live`
1357
+
1358
+ - Summary: 搜索直播/Search live
1359
+ - Capabilities: search / livestream
1360
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1361
+ - operationId: `fetch_search_live_api_v1_tiktok_web_fetch_search_live_get`
1362
+
1363
+ #### Notes
1364
+
1365
+ > # [中文]
1366
+ > ### 用途:
1367
+ > - 搜索直播
1368
+ > ### 参数:
1369
+ > - keyword: 搜索关键词
1370
+ > - count: 每页数量
1371
+ > - offset: 翻页游标,第一次请求时为0,第二次请求时从上一次请求的返回响应中获取。
1372
+ > - search_id: 搜索id,第一次请求时为空,第二次翻页时需要提供,需要从上一次请求的返回响应中获取。
1373
+ > - 例如: search_id = "20240828035554C02011379EBB6A00E00B"
1374
+ > - JSON Path-1 : $.data.extra.logid
1375
+ > - JSON Path-2 : $.data.log_pb.impr_id
1376
+ > - cookie: 用户cookie(如果你需要使用自己的账号搜索,或者遇到接口报错,可以自行提供cookie,默认不需要提供)
1377
+ > ### 返回:
1378
+ > - 直播列表
1379
+ >
1380
+ > # [English]
1381
+ > ### Purpose:
1382
+ > - Search live
1383
+ > ### Parameters:
1384
+ > - keyword: Search keyword
1385
+ > - count: Number per page
1386
+ > - offset: Page offset, 0 for the first request, need to provide for the second paging.
1387
+ > - 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.
1388
+ > - For example: search_id = "20240828035554C02011379EBB6A00E00B"
1389
+ > - JSON Path-1 : $.data.extra.logid
1390
+ > - JSON Path-2 : $.data.log_pb.impr_id
1391
+ > - cookie: User cookie (If you need to search with your own account, or encounter an interface error, you can provide the cookie yourself, default is not required)
1392
+ > ### Return:
1393
+ > - Live list
1394
+ >
1395
+ > # [示例/Example]
1396
+ > keyword = "TikTok"
1397
+ > count = 20
1398
+ > offset = 0
1399
+ > search_id = ""
1400
+
1401
+ #### Parameters
1402
+
1403
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1404
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1405
+ | keyword | query | string | Yes | 搜索关键词/Search keyword | None | TikTok | None |
1406
+ | count | query | integer | No | 每页数量/Number per page | 20 | None | None |
1407
+ | offset | query | integer | No | 翻页游标/Page cursor | 0 | None | None |
1408
+ | search_id | query | string | No | 搜索id,翻页时需要提供/Search id, need to provide when paging | None | None | None |
1409
+ | cookie | query | string | No | 用户cookie(按需提供)/User cookie(if needed) | None | None | None |
1410
+
1411
+ #### Request Body
1412
+
1413
+ None
1414
+
1415
+ #### Success Response
1416
+
1417
+ ##### `200 application/json`
1418
+
1419
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1420
+
1421
+ | Field | Type | Required | Description | Default | Example | Enum |
1422
+ | --- | --- | --- | --- | --- | --- | --- |
1423
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1424
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1425
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1426
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1427
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1428
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1429
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1430
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1431
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1432
+ | 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 |
1433
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1434
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1435
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1436
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1437
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1438
+
1439
+ <a id="get-api-u1-v1-tiktok-web-fetch-search-photo"></a>
1440
+ ### `GET /api/u1/v1/tiktok/web/fetch_search_photo`
1441
+
1442
+ - Summary: 搜索照片/Search photo
1443
+ - Capabilities: search / trends / rankings
1444
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1445
+ - operationId: `fetch_search_photo_api_v1_tiktok_web_fetch_search_photo_get`
1446
+
1447
+ #### Notes
1448
+
1449
+ > # [中文]
1450
+ > ### 用途:
1451
+ > - 搜索照片
1452
+ > ### 参数:
1453
+ > - keyword: 搜索关键词
1454
+ > - count: 每页数量,建议保持默认值20。
1455
+ > - offset: 翻页游标,第一次请求时为0,第二次请求时从上一次请求的返回响应中获取,一般这个值的关键字为offset或者cursor。
1456
+ > - search_id: 搜索id,第一次请求时为空,第二次翻页时需要提供,需要从上一次请求的返回响应中获取。
1457
+ > - 例如: search_id = "20240828035554C02011379EBB6A00E00B"
1458
+ > - JSON Path-1 : $.data.extra.logid
1459
+ > - JSON Path-2 : $.data.log_pb.impr_id
1460
+ > - cookie: 用户cookie(如果你需要使用自己的账号搜索,或者遇到接口报错,可以自行提供cookie,默认不需要提供)
1461
+ > ### 返回:
1462
+ > - 视频列表
1463
+ >
1464
+ > # [English]
1465
+ > ### Purpose:
1466
+ > - Search photo
1467
+ > ### Parameters:
1468
+ > - keyword: Search keyword
1469
+ > - count: Number per page, it is recommended to keep the default value 20.
1470
+ > - offset: Page cursor, 0 for the first request, need to provide for the second paging, generally the keyword of this value is offset or cursor.
1471
+ > - 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.
1472
+ > - For example: search_id = "20240828035554C02011379EBB6A00E00B"
1473
+ > - JSON Path-1 : $.data.extra.logid
1474
+ > - JSON Path-2 : $.data.log_pb.impr_id
1475
+ > - offset: Page cursor
1476
+ > - cookie: User cookie (If you need to search with your own account, or encounter an interface error, you can provide the cookie yourself, default is not required)
1477
+ > ### Return:
1478
+ > - Video list
1479
+ >
1480
+ > # [示例/Example]
1481
+ > keyword = "TikTok"
1482
+ > count = 20
1483
+ > offset = 0
1484
+ > search_id = ""
1485
+
1486
+ #### Parameters
1487
+
1488
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1489
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1490
+ | keyword | query | string | Yes | 搜索关键词/Search keyword | None | TikTok | None |
1491
+ | count | query | integer | No | 每页数量/Number per page | 20 | None | None |
1492
+ | offset | query | integer | No | 翻页游标/Page offset | 0 | None | None |
1493
+ | search_id | query | string | No | 搜索id,翻页时需要提供/Search id, need to provide when paging | None | None | None |
1494
+ | cookie | query | string | No | 用户cookie(按需提供)/User cookie(if needed) | None | None | None |
1495
+
1496
+ #### Request Body
1497
+
1498
+ None
1499
+
1500
+ #### Success Response
1501
+
1502
+ ##### `200 application/json`
1503
+
1504
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1505
+
1506
+ | Field | Type | Required | Description | Default | Example | Enum |
1507
+ | --- | --- | --- | --- | --- | --- | --- |
1508
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1509
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1510
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1511
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1512
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1513
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1514
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1515
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1516
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1517
+ | 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 |
1518
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1519
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1520
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1521
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1522
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1523
+
1524
+ <a id="get-api-u1-v1-tiktok-web-fetch-search-user"></a>
1525
+ ### `GET /api/u1/v1/tiktok/web/fetch_search_user`
1526
+
1527
+ - Summary: 搜索用户/Search user
1528
+ - Capabilities: search / profiles / accounts
1529
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1530
+ - operationId: `fetch_search_user_api_v1_tiktok_web_fetch_search_user_get`
1531
+
1532
+ #### Notes
1533
+
1534
+ > # [中文]
1535
+ > ### 用途:
1536
+ > - 搜索用户
1537
+ > ### 参数:
1538
+ > - keyword: 搜索关键词
1539
+ > - cursor: 翻页游标,第一次请求时为0,第二次请求时从上一次请求的返回响应中获取,一般这个值的关键字为offset或者cursor。
1540
+ > - search_id: 搜索id,第一次请求时为空,第二次翻页时需要提供,需要从上一次请求的返回响应中获取。
1541
+ > - 例如: search_id = "20240828035554C02011379EBB6A00E00B"
1542
+ > - JSON Path-1 : $.data.extra.logid
1543
+ > - JSON Path-2 : $.data.log_pb.impr_id
1544
+ > - cookie: 用户cookie(如果你需要使用自己的账号搜索,或者遇到接口报错,可以自行提供cookie,默认不需要提供)
1545
+ > ### 返回:
1546
+ > - 用户列表
1547
+ > ### 备注:
1548
+ > - 如果接口响应的 `data` 字段中的 `status_code` 不为0,说明搜索请求未成功,此时请检查响应里的异常,有可能你在搜索 TikTok 不允许的关键词,或者搜索了敏感内容,请更换关键词重试。
1549
+ >
1550
+ > # [English]
1551
+ > ### Purpose:
1552
+ > - Search user
1553
+ > ### Parameters:
1554
+ > - keyword: Search keyword
1555
+ > - cursor: Page cursor, 0 for the first request, need to provide for the second paging, generally the keyword of this value is offset or cursor.
1556
+ > - 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.
1557
+ > - For example: search_id = "20240828035554C02011379EBB6A00E00B"
1558
+ > - JSON Path-1 : $.data.extra.logid
1559
+ > - JSON Path-2 : $.data.log_pb.impr_id
1560
+ > - cookie: User cookie (If you need to search with your own account, or encounter an interface error, you can provide the cookie yourself, default is not required)
1561
+ > ### Return:
1562
+ > - User list
1563
+ > ### Note:
1564
+ > - If the `status_code` in the `data` field of the interface response is not 0, it means that the search request was not successful. Please check the exceptions in the response. You may be searching for keywords that TikTok does not allow, or searching for sensitive content. Please change the keywords and try again.
1565
+ >
1566
+ > # [示例/Example]
1567
+ > keyword = "TikTok"
1568
+ > cursor = 0
1569
+ > search_id = ""
1570
+
1571
+ #### Parameters
1572
+
1573
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1574
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1575
+ | keyword | query | string | Yes | 搜索关键词/Search keyword | None | TikTok | None |
1576
+ | cursor | query | integer | No | 翻页游标/Page cursor | 0 | None | None |
1577
+ | search_id | query | string | No | 搜索id,翻页时需要提供/Search id, need to provide when paging | None | None | None |
1578
+ | cookie | query | string | No | 用户cookie(按需提供)/User cookie(if needed) | None | None | None |
1579
+
1580
+ #### Request Body
1581
+
1582
+ None
1583
+
1584
+ #### Success Response
1585
+
1586
+ ##### `200 application/json`
1587
+
1588
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1589
+
1590
+ | Field | Type | Required | Description | Default | Example | Enum |
1591
+ | --- | --- | --- | --- | --- | --- | --- |
1592
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1593
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1594
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1595
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1596
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1597
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1598
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1599
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1600
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1601
+ | 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 |
1602
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1603
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1604
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1605
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1606
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1607
+
1608
+ <a id="get-api-u1-v1-tiktok-web-fetch-search-video"></a>
1609
+ ### `GET /api/u1/v1/tiktok/web/fetch_search_video`
1610
+
1611
+ - Summary: 搜索视频/Search video
1612
+ - Capabilities: search / content details
1613
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1614
+ - operationId: `fetch_search_video_api_v1_tiktok_web_fetch_search_video_get`
1615
+
1616
+ #### Notes
1617
+
1618
+ > # [中文]
1619
+ > ### 用途:
1620
+ > - 搜索视频
1621
+ > ### 参数:
1622
+ > - keyword: 搜索关键词
1623
+ > - count: 每页数量,建议保持默认值20。
1624
+ > - offset: 翻页游标,第一次请求时为0,第二次请求时从上一次请求的返回响应中获取。
1625
+ > - search_id: 搜索id,第一次请求时为空,第二次翻页时需要提供,需要从上一次请求的返回响应中获取。
1626
+ > - 例如: search_id = "20240828035554C02011379EBB6A00E00B"
1627
+ > - JSON Path-1 : $.data.extra.logid
1628
+ > - JSON Path-2 : $.data.log_pb.impr_id
1629
+ > - cookie: 用户cookie(如果你需要使用自己的账号搜索,或者遇到接口报错,可以自行提供cookie,默认不需要提供)
1630
+ > ### 返回:
1631
+ > - 视频列表
1632
+ >
1633
+ > # [English]
1634
+ > ### Purpose:
1635
+ > - Search video
1636
+ > ### Parameters:
1637
+ > - keyword: Search keyword
1638
+ > - count: Number per page, it is recommended to keep the default value 20.
1639
+ > - offset: Page offset, 0 for the first request, need to provide for the second paging.
1640
+ > - 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.
1641
+ > - For example: search_id = "20240828035554C02011379EBB6A00E00B"
1642
+ > - JSON Path-1 : $.data.extra.logid
1643
+ > - JSON Path-2 : $.data.log_pb.impr_id
1644
+ > - cookie: User cookie (If you need to search with your own account, or encounter an interface error, you can provide the cookie yourself, default is not required)
1645
+ > ### Return:
1646
+ > - Video list
1647
+ >
1648
+ > # [示例/Example]
1649
+ > keyword = "TikTok"
1650
+ > count = 20
1651
+ > offset = 0
1652
+ > search_id = ""
1653
+
1654
+ #### Parameters
1655
+
1656
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1657
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1658
+ | keyword | query | string | Yes | 搜索关键词/Search keyword | None | TikTok | None |
1659
+ | count | query | integer | No | 每页数量/Number per page | 20 | None | None |
1660
+ | offset | query | integer | No | 翻页游标/Page cursor | 0 | None | None |
1661
+ | search_id | query | string | No | 搜索id,翻页时需要提供/Search id, need to provide when paging | None | None | None |
1662
+ | cookie | query | string | No | 用户cookie(按需提供)/User cookie(if needed) | None | None | None |
1663
+
1664
+ #### Request Body
1665
+
1666
+ None
1667
+
1668
+ #### Success Response
1669
+
1670
+ ##### `200 application/json`
1671
+
1672
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1673
+
1674
+ | Field | Type | Required | Description | Default | Example | Enum |
1675
+ | --- | --- | --- | --- | --- | --- | --- |
1676
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1677
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1678
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1679
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1680
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1681
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1682
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1683
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1684
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1685
+ | 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 |
1686
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1687
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1688
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1689
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1690
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1691
+
1692
+ <a id="get-api-u1-v1-tiktok-web-fetch-sso-login-auth"></a>
1693
+ ### `GET /api/u1/v1/tiktok/web/fetch_sso_login_auth`
1694
+
1695
+ - Summary: 认证SSO登录/Authenticate SSO login
1696
+ - Capabilities: general
1697
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1698
+ - operationId: `fetch_sso_login_auth_api_v1_tiktok_web_fetch_sso_login_auth_get`
1699
+
1700
+ #### Notes
1701
+
1702
+ > # [中文]
1703
+ > ### 用途:
1704
+ > - 认证SSO登录
1705
+ > ### 参数:
1706
+ > - device_id: 设备ID
1707
+ > - verifyFp: verifyFp
1708
+ > - region: 地区
1709
+ > - proxy: 代理
1710
+ > ### 返回:
1711
+ > - SSO登录认证信息
1712
+ > ### 说明:
1713
+ > - 认证需要保持参数一致,否则会认证失败。
1714
+ >
1715
+ > # [English]
1716
+ > ### Purpose:
1717
+ > - Authenticate SSO login
1718
+ > ### Parameters:
1719
+ > - token: Login token
1720
+ > - device_id: Device ID
1721
+ > - verifyFp: verifyFp
1722
+ > - region: Region
1723
+ > - proxy: Proxy
1724
+ > ### Return:
1725
+ > - SSO login authentication information
1726
+ > ### Description:
1727
+ > - Please use the value obtained by the /fetch_sso_login_status interface for input.
1728
+ > - If you need to use a proxy, please pass in the proxy address, otherwise pass in None.
1729
+ >
1730
+ > # [示例/Example]
1731
+ > device_id = "7481276116461831688"
1732
+ > verifyFp = "verify_m8909xlr_d7UEdRqf_mA73_4So4_B0RT_L1gFyzsKr7IL"
1733
+ > region = "US"
1734
+ > proxy = "None"
1735
+
1736
+ #### Parameters
1737
+
1738
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1739
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1740
+ | device_id | query | string | Yes | 设备ID/Device ID | None | 7481276116461831688 | None |
1741
+ | verifyFp | query | string | Yes | verifyFp | None | verify_m8909xlr_d7UEdRqf_mA73_4So4_B0RT_L1gFyzsKr7IL | None |
1742
+ | region | query | string | Yes | 地区/Region | None | US | None |
1743
+ | proxy | query | string | Yes | 代理/Proxy | None | None | None |
1744
+
1745
+ #### Request Body
1746
+
1747
+ None
1748
+
1749
+ #### Success Response
1750
+
1751
+ ##### `200 application/json`
1752
+
1753
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1754
+
1755
+ | Field | Type | Required | Description | Default | Example | Enum |
1756
+ | --- | --- | --- | --- | --- | --- | --- |
1757
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1758
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1759
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1760
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1761
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1762
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1763
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1764
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1765
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1766
+ | 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 |
1767
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1768
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1769
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1770
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1771
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1772
+
1773
+ <a id="get-api-u1-v1-tiktok-web-fetch-sso-login-qrcode"></a>
1774
+ ### `GET /api/u1/v1/tiktok/web/fetch_sso_login_qrcode`
1775
+
1776
+ - Summary: 获取SSO登录二维码/Get SSO login QR code
1777
+ - Capabilities: general
1778
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1779
+ - operationId: `fetch_sso_login_qrcode_api_v1_tiktok_web_fetch_sso_login_qrcode_get`
1780
+
1781
+ #### Notes
1782
+
1783
+ > # [中文]
1784
+ > ### 用途:
1785
+ > - 获取SSO登录二维码
1786
+ > ### 参数:
1787
+ > - device_id: 设备ID
1788
+ > - region: 地区
1789
+ > - proxy: 代理
1790
+ > ### 返回:
1791
+ > - SSO登录二维码
1792
+ > ### 说明:
1793
+ > - 该接口返回的二维码需要使用手机扫描登录,登录成功后会返回登录信息。
1794
+ > - 不传入设备ID将由后端自动生成设备ID。
1795
+ > - 如果需要使用代理,请传入代理地址,否则传入None。
1796
+ > - 单次二维码有效期为一分钟。
1797
+ >
1798
+ > # [English]
1799
+ > ### Purpose:
1800
+ > - Get SSO login QR code
1801
+ > ### Parameters:
1802
+ > - device_id: Device ID
1803
+ > - region: Region
1804
+ > - proxy: Proxy
1805
+ > ### Return:
1806
+ > - SSO login QR code
1807
+ > ### Description:
1808
+ > - The QR code returned by this interface needs to be scanned by the mobile phone for login, and the login information will be returned after successful login.
1809
+ > - If the device ID is not passed in, the device ID will be automatically generated by the backend.
1810
+ > - If you need to use a proxy, please pass in the proxy address, otherwise pass in None
1811
+ > - The validity period of a single QR code is one minute.
1812
+ >
1813
+ > # [示例/Example]
1814
+ > device_id = "7481276116461831688"
1815
+ > region = "US"
1816
+ > proxy = "None"
1817
+
1818
+ #### Parameters
1819
+
1820
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1821
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1822
+ | device_id | query | string | Yes | 设备ID/Device ID | None | 7481276116461831688 | None |
1823
+ | region | query | string | Yes | 地区/Region | None | US | None |
1824
+ | proxy | query | string | Yes | 代理/Proxy | None | None | None |
1825
+
1826
+ #### Request Body
1827
+
1828
+ None
1829
+
1830
+ #### Success Response
1831
+
1832
+ ##### `200 application/json`
1833
+
1834
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1835
+
1836
+ | Field | Type | Required | Description | Default | Example | Enum |
1837
+ | --- | --- | --- | --- | --- | --- | --- |
1838
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1839
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1840
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1841
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1842
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1843
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1844
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1845
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1846
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1847
+ | 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 |
1848
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1849
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1850
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1851
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1852
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1853
+
1854
+ <a id="get-api-u1-v1-tiktok-web-fetch-sso-login-status"></a>
1855
+ ### `GET /api/u1/v1/tiktok/web/fetch_sso_login_status`
1856
+
1857
+ - Summary: 获取SSO登录状态/Get SSO login status
1858
+ - Capabilities: general
1859
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1860
+ - operationId: `fetch_sso_login_status_api_v1_tiktok_web_fetch_sso_login_status_get`
1861
+
1862
+ #### Notes
1863
+
1864
+ > # [中文]
1865
+ > ### 用途:
1866
+ > - 获取SSO登录状态
1867
+ > ### 参数:
1868
+ > - token: 登录令牌
1869
+ > - device_id: 设备ID
1870
+ > - verifyFp: verifyFp
1871
+ > - region: 地区
1872
+ > - proxy: 代理
1873
+ > ### 返回:
1874
+ > - SSO登录状态
1875
+ > ### 说明:
1876
+ > - 该接口返回的登录状态需要轮询,建议2秒轮询一次。
1877
+ > - 请使用/fetch_sso_login_qrcode接口获取的值进行传入。
1878
+ > - 如果需要使用代理,请传入代理地址,否则传入None。
1879
+ > - 扫码状态:
1880
+ > - new: 未扫码
1881
+ > - expired: 二维码过期(需要重新请求/fetch_sso_login_qrcode)
1882
+ > - scanned: 已扫码
1883
+ > - confirmed: 已确认登录(需要请求/fetch_sso_login_auth认证)
1884
+ >
1885
+ > # [English]
1886
+ > ### Purpose:
1887
+ > - Get SSO login status
1888
+ > ### Parameters:
1889
+ > - token: Login token
1890
+ > - device_id: Device ID
1891
+ > - verifyFp: verifyFp
1892
+ > - region: Region
1893
+ > - proxy: Proxy
1894
+ > ### Return:
1895
+ > - SSO login status
1896
+ > ### Description:
1897
+ > - The login status returned by this interface needs to be polled, and it is recommended to poll once every 2 seconds.
1898
+ > - Please use the value obtained by the /fetch_sso_login_qrcode interface for input.
1899
+ > - If you need to use a proxy, please pass in the proxy address, otherwise pass in None.
1900
+ > - Scan status:
1901
+ > - new: Not scanned
1902
+ > - expired: QR code expired (need to request /fetch_sso_login_qrcode again)
1903
+ > - scanned: Scanned
1904
+ > - confirmed: Confirmed login (need to request /fetch_sso_login_auth for authentication
1905
+ >
1906
+ > # [示例/Example]
1907
+ > token = "jiHRabSoJdwNrsvJvlRKj4hecTstR2xsn2NmtmKMN8o=_useast5"
1908
+ > device_id = "7481276116461831688"
1909
+ > verifyFp = "verify_m8909xlr_d7UEdRqf_mA73_4So4_B0RT_L1gFyzsKr7IL"
1910
+ > region = "US"
1911
+ > proxy = "None"
1912
+
1913
+ #### Parameters
1914
+
1915
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1916
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1917
+ | token | query | string | Yes | 登录令牌/Login token | None | jiHRabSoJdwNrsvJvlRKj4hecTstR2xsn2NmtmKMN8o=_useast5 | None |
1918
+ | device_id | query | string | Yes | 设备ID/Device ID | None | 7481276116461831688 | None |
1919
+ | verifyFp | query | string | Yes | verifyFp | None | verify_m8909xlr_d7UEdRqf_mA73_4So4_B0RT_L1gFyzsKr7IL | None |
1920
+ | region | query | string | Yes | 地区/Region | None | US | None |
1921
+ | proxy | query | string | Yes | 代理/Proxy | None | None | None |
1922
+
1923
+ #### Request Body
1924
+
1925
+ None
1926
+
1927
+ #### Success Response
1928
+
1929
+ ##### `200 application/json`
1930
+
1931
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1932
+
1933
+ | Field | Type | Required | Description | Default | Example | Enum |
1934
+ | --- | --- | --- | --- | --- | --- | --- |
1935
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1936
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1937
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1938
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1939
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1940
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1941
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1942
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1943
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1944
+ | 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 |
1945
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1946
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1947
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1948
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1949
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1950
+
1951
+ <a id="get-api-u1-v1-tiktok-web-fetch-tag-detail"></a>
1952
+ ### `GET /api/u1/v1/tiktok/web/fetch_tag_detail`
1953
+
1954
+ - Summary: Tag详情/Tag Detail
1955
+ - Capabilities: details
1956
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1957
+ - operationId: `fetch_tag_detail_api_v1_tiktok_web_fetch_tag_detail_get`
1958
+
1959
+ #### Notes
1960
+
1961
+ > # [中文]
1962
+ > ### 用途:
1963
+ > - Tag详情
1964
+ > ### 参数:
1965
+ > - tag_name: Tag名称
1966
+ > ### 返回:
1967
+ > - Tag详情
1968
+ >
1969
+ > # [English]
1970
+ > ### Purpose:
1971
+ > - Tag Detail
1972
+ > ### Parameters:
1973
+ > - tag_name: Tag name
1974
+ > ### Return:
1975
+ > - Tag Detail
1976
+ >
1977
+ > # [示例/Example]
1978
+ > tag_name = "tiktok"
1979
+
1980
+ #### Parameters
1981
+
1982
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1983
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1984
+ | tag_name | query | string | Yes | Tag名称/Tag name | None | tiktok | None |
1985
+
1986
+ #### Request Body
1987
+
1988
+ None
1989
+
1990
+ #### Success Response
1991
+
1992
+ ##### `200 application/json`
1993
+
1994
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1995
+
1996
+ | Field | Type | Required | Description | Default | Example | Enum |
1997
+ | --- | --- | --- | --- | --- | --- | --- |
1998
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1999
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
2000
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
2001
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
2002
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
2003
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
2004
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
2005
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
2006
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
2007
+ | 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 |
2008
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
2009
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
2010
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
2011
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
2012
+ | data | null | No | The response data \| 响应数据 | None | None | None |
2013
+
2014
+ <a id="get-api-u1-v1-tiktok-web-fetch-tag-post"></a>
2015
+ ### `GET /api/u1/v1/tiktok/web/fetch_tag_post`
2016
+
2017
+ - Summary: Tag作品/Tag Post
2018
+ - Capabilities: content details
2019
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2020
+ - operationId: `fetch_tag_post_api_v1_tiktok_web_fetch_tag_post_get`
2021
+
2022
+ #### Notes
2023
+
2024
+ > # [中文]
2025
+ > ### 用途:
2026
+ > - Tag作品
2027
+ > ### 参数:
2028
+ > - challengeID: Tag ID
2029
+ > - count: 每页数量
2030
+ > - cursor: 翻页游标
2031
+ > ### 返回:
2032
+ > - Tag作品
2033
+ > ### 备注:
2034
+ > - 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问,否则会返回HTTP403错误。
2035
+ > - 在访问视频CDN链接时,请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。
2036
+ > - **如果访问视频CDN链接时返回HTTP 403错误**:
2037
+ > 1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)
2038
+ > 2. 在请求该链接时,务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值
2039
+ > 3. 示例请求头: `Cookie: tt_chain_token=xxx`
2040
+ > - 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接,请使用 TikTok APP V3 目录下的接口。
2041
+ >
2042
+ > # [English]
2043
+ > ### Purpose:
2044
+ > - Tag Post
2045
+ > ### Parameters:
2046
+ > - challengeID: Tag ID
2047
+ > - count: Number per page
2048
+ > - cursor: Page cursor
2049
+ > ### Return:
2050
+ > - Tag Post
2051
+ > ### Note:
2052
+ > - All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.
2053
+ > - When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.
2054
+ > - **If you receive HTTP 403 error when accessing video CDN links**:
2055
+ > 1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)
2056
+ > 2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API
2057
+ > 3. Example request header: `Cookie: tt_chain_token=xxx`
2058
+ > - If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.
2059
+ >
2060
+ > # [示例/Example]
2061
+ > challengeID = "7551"
2062
+ > count = 30
2063
+ > cursor = 0
2064
+
2065
+ #### Parameters
2066
+
2067
+ | Field | In | Type | Required | Description | Default | Example | Enum |
2068
+ | --- | --- | --- | --- | --- | --- | --- | --- |
2069
+ | challengeID | query | string | Yes | Tag ID | None | 7551 | None |
2070
+ | count | query | integer | No | 每页数量/Number per page | 30 | None | None |
2071
+ | cursor | query | integer | No | 翻页游标/Page cursor | 0 | None | None |
2072
+
2073
+ #### Request Body
2074
+
2075
+ None
2076
+
2077
+ #### Success Response
2078
+
2079
+ ##### `200 application/json`
2080
+
2081
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2082
+
2083
+ | Field | Type | Required | Description | Default | Example | Enum |
2084
+ | --- | --- | --- | --- | --- | --- | --- |
2085
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
2086
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
2087
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
2088
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
2089
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
2090
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
2091
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
2092
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
2093
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
2094
+ | 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 |
2095
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
2096
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
2097
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
2098
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
2099
+ | data | null | No | The response data \| 响应数据 | None | None | None |
2100
+
2101
+ <a id="get-api-u1-v1-tiktok-web-fetch-tiktok-live-data"></a>
2102
+ ### `GET /api/u1/v1/tiktok/web/fetch_tiktok_live_data`
2103
+
2104
+ - Summary: 通过直播链接获取直播间信息/Get live room information via live link
2105
+ - Capabilities: livestream
2106
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2107
+ - operationId: `fetch_tiktok_live_data_api_v1_tiktok_web_fetch_tiktok_live_data_get`
2108
+
2109
+ #### Notes
2110
+
2111
+ > # [中文]
2112
+ > ### 用途:
2113
+ > - 通过直播链接获取直播间信息
2114
+ > - 此接口可获取离线直播间信息
2115
+ > ### 参数:
2116
+ > - live_room_url: 直播间链接
2117
+ > ### 返回:
2118
+ > - 直播间信息
2119
+ >
2120
+ > # [English]
2121
+ > ### Purpose:
2122
+ > - Get live room information via live link
2123
+ > - This interface can get offline live room information
2124
+ > ### Parameters:
2125
+ > - live_room_url: Live room link
2126
+ > ### Return:
2127
+ > - Live room information
2128
+ >
2129
+ > # [示例/Example]
2130
+ > live_room_url = "https://www.tiktok.com/@.caseoh_daily/live"
2131
+
2132
+ #### Parameters
2133
+
2134
+ | Field | In | Type | Required | Description | Default | Example | Enum |
2135
+ | --- | --- | --- | --- | --- | --- | --- | --- |
2136
+ | live_room_url | query | string | Yes | 直播间链接/Live room link | None | https://www.tiktok.com/@.caseoh_daily/live | None |
2137
+
2138
+ #### Request Body
2139
+
2140
+ None
2141
+
2142
+ #### Success Response
2143
+
2144
+ ##### `200 application/json`
2145
+
2146
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2147
+
2148
+ | Field | Type | Required | Description | Default | Example | Enum |
2149
+ | --- | --- | --- | --- | --- | --- | --- |
2150
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
2151
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
2152
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
2153
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
2154
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
2155
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
2156
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
2157
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
2158
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
2159
+ | 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 |
2160
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
2161
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
2162
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
2163
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
2164
+ | data | null | No | The response data \| 响应数据 | None | None | None |
2165
+
2166
+ <a id="get-api-u1-v1-tiktok-web-fetch-tiktok-web-guest-cookie"></a>
2167
+ ### `GET /api/u1/v1/tiktok/web/fetch_tiktok_web_guest_cookie`
2168
+
2169
+ - Summary: 获取游客 Cookie/Get the guest Cookie
2170
+ - Capabilities: general
2171
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2172
+ - operationId: `fetch_tiktok_web_guest_cookie_api_v1_tiktok_web_fetch_tiktok_web_guest_cookie_get`
2173
+
2174
+ #### Notes
2175
+
2176
+ > # [中文]
2177
+ > ### 用途:
2178
+ > - 获取 TikTok Web的游客Cookie
2179
+ > - 可以用于爬取 TikTok Web 的数据,如用户作品、合辑作品等。
2180
+ > - 可以固定身份避免部分接口重复数据。
2181
+ > - 请注意:游客Cookie无法爬取所有数据,有一定的限制。
2182
+ > - 可以配合开源项目使用此接口实现TikTok Web的数据爬取。
2183
+ > ### 参数:
2184
+ > - user_agent: 用户浏览器代理
2185
+ > ### 返回:
2186
+ > - 游客Cookie
2187
+ >
2188
+ > # [English]
2189
+ > ### Purpose:
2190
+ > - Get the guest Cookie of TikTok Web
2191
+ > - Can be used to crawl data of TikTok Web, such as user videos, mix videos, etc.
2192
+ > - Can fix identity to avoid duplicate data for some interfaces.
2193
+ > - Please note: Guest Cookie cannot crawl all data, there are certain restrictions.
2194
+ > - Can be used with open source projects to implement data crawling of TikTok Web using this interface.
2195
+ > ### Parameters:
2196
+ > - user_agent: User browser agent
2197
+ > ### Return:
2198
+ > - Guest Cookie
2199
+ >
2200
+ > # [示例/Example]
2201
+ > user_agent = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.212 Safari/537.36"
2202
+ >
2203
+ > # [响应/Response]:
2204
+ > ```json
2205
+ > {
2206
+ > "User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.212 Safari/537.36",
2207
+ > "Cookie": "ttwid=1%7Ck5lqyYxAq2wSmaEculMCk31ur4lkvy3DVwn6Phf45GQ%7C1759321284%7C6bac9a25e1f6b512aecad91a37167ad753b47f2306ffe0d70695001d6b4dd793;tt_csrf_token=tueWm0Fw-jL4Ie3Iu2z755XYPzAphhgJmHDA;tt_chain_token=drrbnMAs2A13tME+L6XbsA==",
2208
+ > "Referer": "https://www.tiktok.com/explore"
2209
+ > }
2210
+ > ```
2211
+
2212
+ #### Parameters
2213
+
2214
+ | Field | In | Type | Required | Description | Default | Example | Enum |
2215
+ | --- | --- | --- | --- | --- | --- | --- | --- |
2216
+ | user_agent | query | string | Yes | 用户浏览器代理/User browser agent | None | Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko… | None |
2217
+
2218
+ #### Request Body
2219
+
2220
+ None
2221
+
2222
+ #### Success Response
2223
+
2224
+ ##### `200 application/json`
2225
+
2226
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2227
+
2228
+ | Field | Type | Required | Description | Default | Example | Enum |
2229
+ | --- | --- | --- | --- | --- | --- | --- |
2230
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
2231
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
2232
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
2233
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
2234
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
2235
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
2236
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
2237
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
2238
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
2239
+ | 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 |
2240
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
2241
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
2242
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
2243
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
2244
+ | data | null | No | The response data \| 响应数据 | None | None | None |
2245
+
2246
+ <a id="get-api-u1-v1-tiktok-web-fetch-trending-post"></a>
2247
+ ### `GET /api/u1/v1/tiktok/web/fetch_trending_post`
2248
+
2249
+ - Summary: 获取每日热门内容作品数据/Get daily trending video data
2250
+ - Capabilities: trends / rankings / content details
2251
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2252
+ - operationId: `fetch_trending_post_api_v1_tiktok_web_fetch_trending_post_get`
2253
+
2254
+ #### Notes
2255
+
2256
+ > # [中文]
2257
+ > ### 用途:
2258
+ > - 获取每日热门内容作品数据
2259
+ > ### 返回:
2260
+ > - 作品数据
2261
+ >
2262
+ > # [English]
2263
+ > ### Purpose:
2264
+ > - Get daily trending video data
2265
+ > ### Return:
2266
+ > - Video data
2267
+ >
2268
+ > # [示例/Example]
2269
+
2270
+ #### Parameters
2271
+
2272
+ None
2273
+
2274
+ #### Request Body
2275
+
2276
+ None
2277
+
2278
+ #### Success Response
2279
+
2280
+ ##### `200 application/json`
2281
+
2282
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2283
+
2284
+ | Field | Type | Required | Description | Default | Example | Enum |
2285
+ | --- | --- | --- | --- | --- | --- | --- |
2286
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
2287
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
2288
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
2289
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
2290
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
2291
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
2292
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
2293
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
2294
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
2295
+ | 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 |
2296
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
2297
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
2298
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
2299
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
2300
+ | data | null | No | The response data \| 响应数据 | None | None | None |
2301
+
2302
+ <a id="get-api-u1-v1-tiktok-web-fetch-trending-searchwords"></a>
2303
+ ### `GET /api/u1/v1/tiktok/web/fetch_trending_searchwords`
2304
+
2305
+ - Summary: 获取每日趋势搜索关键词/Get daily trending search words
2306
+ - Capabilities: search / trends / rankings
2307
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2308
+ - operationId: `fetch_trending_searchwords_api_v1_tiktok_web_fetch_trending_searchwords_get`
2309
+
2310
+ #### Notes
2311
+
2312
+ > # [中文]
2313
+ > ### 用途:
2314
+ > - 获取每日趋势搜索关键词
2315
+ > ### 返回:
2316
+ > - 趋势搜索关键词
2317
+ >
2318
+ > # [English]
2319
+ > ### Purpose:
2320
+ > - Get daily trending search words
2321
+ > ### Return:
2322
+ > - Trending search words
2323
+ >
2324
+ > # [示例/Example]
2325
+
2326
+ #### Parameters
2327
+
2328
+ 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-tiktok-web-fetch-user-collect"></a>
2359
+ ### `GET /api/u1/v1/tiktok/web/fetch_user_collect`
2360
+
2361
+ - Summary: 获取用户的收藏列表/Get user favorites
2362
+ - Capabilities: profiles / accounts
2363
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2364
+ - operationId: `fetch_user_collect_api_v1_tiktok_web_fetch_user_collect_get`
2365
+
2366
+ #### Notes
2367
+
2368
+ > # [中文]
2369
+ > ### 用途:
2370
+ > - 获取用户的收藏列表
2371
+ > - 注意: 该接口目前只能获取自己的收藏列表,需要提供自己账号的cookie。
2372
+ > ### 参数:
2373
+ > - cookie: 用户cookie
2374
+ > - secUid: 用户secUid
2375
+ > - cursor: 翻页游标
2376
+ > - count: 每页数量
2377
+ > - coverFormat: 封面格式
2378
+ > ### 返回:
2379
+ > - 用户的收藏列表
2380
+ > ### 备注:
2381
+ > - 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问,否则会返回HTTP403错误。
2382
+ > - 在访问视频CDN链接时,请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。
2383
+ > - **如果访问视频CDN链接时返回HTTP 403错误**:
2384
+ > 1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)
2385
+ > 2. 在请求该链接时,务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值
2386
+ > 3. 示例请求头: `Cookie: tt_chain_token=xxx`
2387
+ > - 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接,请使用 TikTok APP V3 目录下的接口。
2388
+ >
2389
+ > # [English]
2390
+ > ### Purpose:
2391
+ > - Get user favorites
2392
+ > - Note: This interface can currently only get your own favorites list, you need to provide your account cookie.
2393
+ > ### Parameters:
2394
+ > - cookie: User cookie
2395
+ > - secUid: User secUid
2396
+ > - cursor: Page cursor
2397
+ > - count: Number per page
2398
+ > - coverFormat: Cover format
2399
+ > ### Return:
2400
+ > - User favorites
2401
+ > ### Note:
2402
+ > - All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.
2403
+ > - When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.
2404
+ > - **If you receive HTTP 403 error when accessing video CDN links**:
2405
+ > 1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)
2406
+ > 2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API
2407
+ > 3. Example request header: `Cookie: tt_chain_token=xxx`
2408
+ > - If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.
2409
+ >
2410
+ > # [示例/Example]
2411
+ > cookie = "Your_Cookie"
2412
+ > secUid = "Your_SecUid"
2413
+ > cursor = 0
2414
+ > count = 30
2415
+ > coverFormat = 2
2416
+
2417
+ #### Parameters
2418
+
2419
+ | Field | In | Type | Required | Description | Default | Example | Enum |
2420
+ | --- | --- | --- | --- | --- | --- | --- | --- |
2421
+ | cookie | query | string | Yes | 用户cookie/User cookie | None | Your_Cookie | None |
2422
+ | secUid | query | string | Yes | 用户secUid/User secUid | None | Your_SecUid | None |
2423
+ | cursor | query | integer | No | 翻页游标/Page cursor | 0 | None | None |
2424
+ | count | query | integer | No | 每页数量/Number per page | 30 | None | None |
2425
+ | coverFormat | query | integer | No | 封面格式/Cover format | 2 | None | None |
2426
+
2427
+ #### Request Body
2428
+
2429
+ None
2430
+
2431
+ #### Success Response
2432
+
2433
+ ##### `200 application/json`
2434
+
2435
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2436
+
2437
+ | Field | Type | Required | Description | Default | Example | Enum |
2438
+ | --- | --- | --- | --- | --- | --- | --- |
2439
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
2440
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
2441
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
2442
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
2443
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
2444
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
2445
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
2446
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
2447
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
2448
+ | 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 |
2449
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
2450
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
2451
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
2452
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
2453
+ | data | null | No | The response data \| 响应数据 | None | None | None |
2454
+
2455
+ <a id="get-api-u1-v1-tiktok-web-fetch-user-fans"></a>
2456
+ ### `GET /api/u1/v1/tiktok/web/fetch_user_fans`
2457
+
2458
+ - Summary: 获取用户的粉丝列表/Get user followers
2459
+ - Capabilities: profiles / accounts
2460
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2461
+ - operationId: `fetch_user_fans_api_v1_tiktok_web_fetch_user_fans_get`
2462
+
2463
+ #### Notes
2464
+
2465
+ > # [中文]
2466
+ > ### 用途:
2467
+ > - 获取用户的粉丝列表
2468
+ > ### 参数:
2469
+ > - secUid: 用户secUid
2470
+ > - count: 每页数量
2471
+ > - maxCursor: 最大游标
2472
+ > - minCursor: 最小游标
2473
+ > ### 返回:
2474
+ > - 用户的粉丝列表
2475
+ > ### 备注:
2476
+ > - 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问,否则会返回HTTP403错误。
2477
+ > - 在访问视频CDN链接时,请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。
2478
+ > - **如果访问视频CDN链接时返回HTTP 403错误**:
2479
+ > 1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)
2480
+ > 2. 在请求该链接时,务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值
2481
+ > 3. 示例请求头: `Cookie: tt_chain_token=xxx`
2482
+ > - 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接,请使用 TikTok APP V3 目录下的接口。
2483
+ >
2484
+ > # [English]
2485
+ > ### Purpose:
2486
+ > - Get user followers
2487
+ > ### Parameters:
2488
+ > - secUid: User secUid
2489
+ > - count: Number per page
2490
+ > - maxCursor: Max cursor
2491
+ > - minCursor: Min cursor
2492
+ > ### Return:
2493
+ > - User followers
2494
+ > ### Note:
2495
+ > - All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.
2496
+ > - When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.
2497
+ > - **If you receive HTTP 403 error when accessing video CDN links**:
2498
+ > 1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)
2499
+ > 2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API
2500
+ > 3. Example request header: `Cookie: tt_chain_token=xxx`
2501
+ > - If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.
2502
+ >
2503
+ > # [示例/Example]
2504
+ > secUid = "MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM"
2505
+ > count = 30
2506
+ > maxCursor = 0
2507
+ > minCursor = 0
2508
+
2509
+ #### Parameters
2510
+
2511
+ | Field | In | Type | Required | Description | Default | Example | Enum |
2512
+ | --- | --- | --- | --- | --- | --- | --- | --- |
2513
+ | secUid | query | string | Yes | 用户secUid/User secUid | None | MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM | None |
2514
+ | count | query | integer | No | 每页数量/Number per page | 30 | None | None |
2515
+ | maxCursor | query | integer | No | 最大游标/Max cursor | 0 | None | None |
2516
+ | minCursor | query | integer | No | 最小游标/Min cursor | 0 | None | None |
2517
+
2518
+ #### Request Body
2519
+
2520
+ None
2521
+
2522
+ #### Success Response
2523
+
2524
+ ##### `200 application/json`
2525
+
2526
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2527
+
2528
+ | Field | Type | Required | Description | Default | Example | Enum |
2529
+ | --- | --- | --- | --- | --- | --- | --- |
2530
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
2531
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
2532
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
2533
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
2534
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
2535
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
2536
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
2537
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
2538
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
2539
+ | 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 |
2540
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
2541
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
2542
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
2543
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
2544
+ | data | null | No | The response data \| 响应数据 | None | None | None |
2545
+
2546
+ <a id="get-api-u1-v1-tiktok-web-fetch-user-follow"></a>
2547
+ ### `GET /api/u1/v1/tiktok/web/fetch_user_follow`
2548
+
2549
+ - Summary: 获取用户的关注列表/Get user followings
2550
+ - Capabilities: profiles / accounts
2551
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2552
+ - operationId: `fetch_user_follow_api_v1_tiktok_web_fetch_user_follow_get`
2553
+
2554
+ #### Notes
2555
+
2556
+ > # [中文]
2557
+ > ### 用途:
2558
+ > - 获取用户的关注列表
2559
+ > ### 参数:
2560
+ > - secUid: 用户secUid
2561
+ > - count: 每页数量
2562
+ > - maxCursor: 最大游标
2563
+ > - minCursor: 最小游标
2564
+ > ### 返回:
2565
+ > - 用户的关注列表
2566
+ > ### 备注:
2567
+ > - 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问,否则会返回HTTP403错误。
2568
+ > - 在访问视频CDN链接时,请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。
2569
+ > - **如果访问视频CDN链接时返回HTTP 403错误**:
2570
+ > 1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)
2571
+ > 2. 在请求该链接时,务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值
2572
+ > 3. 示例请求头: `Cookie: tt_chain_token=xxx`
2573
+ > - 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接,请使用 TikTok APP V3 目录下的接口。
2574
+ >
2575
+ > # [English]
2576
+ > ### Purpose:
2577
+ > - Get user followings
2578
+ > ### Parameters:
2579
+ > - secUid: User secUid
2580
+ > - count: Number per page
2581
+ > - maxCursor: Max cursor
2582
+ > - minCursor: Min cursor
2583
+ > ### Return:
2584
+ > - User followings
2585
+ > ### Note:
2586
+ > - All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.
2587
+ > - When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.
2588
+ > - **If you receive HTTP 403 error when accessing video CDN links**:
2589
+ > 1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)
2590
+ > 2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API
2591
+ > 3. Example request header: `Cookie: tt_chain_token=xxx`
2592
+ > - If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.
2593
+ >
2594
+ > # [示例/Example]
2595
+ > secUid = "MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM"
2596
+ > count = 30
2597
+ > maxCursor = 0
2598
+ > minCursor = 0
2599
+
2600
+ #### Parameters
2601
+
2602
+ | Field | In | Type | Required | Description | Default | Example | Enum |
2603
+ | --- | --- | --- | --- | --- | --- | --- | --- |
2604
+ | secUid | query | string | Yes | 用户secUid/User secUid | None | MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM | None |
2605
+ | count | query | integer | No | 每页数量/Number per page | 30 | None | None |
2606
+ | maxCursor | query | integer | No | 最大游标/Max cursor | 0 | None | None |
2607
+ | minCursor | query | integer | No | 最小游标/Min cursor | 0 | None | None |
2608
+
2609
+ #### Request Body
2610
+
2611
+ None
2612
+
2613
+ #### Success Response
2614
+
2615
+ ##### `200 application/json`
2616
+
2617
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2618
+
2619
+ | Field | Type | Required | Description | Default | Example | Enum |
2620
+ | --- | --- | --- | --- | --- | --- | --- |
2621
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
2622
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
2623
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
2624
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
2625
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
2626
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
2627
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
2628
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
2629
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
2630
+ | 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 |
2631
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
2632
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
2633
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
2634
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
2635
+ | data | null | No | The response data \| 响应数据 | None | None | None |
2636
+
2637
+ <a id="get-api-u1-v1-tiktok-web-fetch-user-like"></a>
2638
+ ### `GET /api/u1/v1/tiktok/web/fetch_user_like`
2639
+
2640
+ - Summary: 获取用户的点赞列表/Get user likes
2641
+ - Capabilities: profiles / accounts
2642
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2643
+ - operationId: `fetch_user_like_api_v1_tiktok_web_fetch_user_like_get`
2644
+
2645
+ #### Notes
2646
+
2647
+ > # [中文]
2648
+ > ### 用途:
2649
+ > - 获取用户的点赞列表
2650
+ > - 注意: 该接口需要用户点赞列表为公开状态
2651
+ > ### 参数:
2652
+ > - secUid: 用户secUid
2653
+ > - cursor: 翻页游标
2654
+ > - count: 每页数量,默认为20,不可变更。
2655
+ > - coverFormat: 封面格式
2656
+ > - post_item_list_request_type: 排序方式
2657
+ > - 0:默认排序
2658
+ > - 1:热门排序
2659
+ > - 2:最旧排序
2660
+ > ### 返回:
2661
+ > - 用户的点赞列表
2662
+ > ### 备注:
2663
+ > - 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问,否则会返回HTTP403错误。
2664
+ > - 在访问视频CDN链接时,请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。
2665
+ > - **如果访问视频CDN链接时返回HTTP 403错误**:
2666
+ > 1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)
2667
+ > 2. 在请求该链接时,务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值
2668
+ > 3. 示例请求头: `Cookie: tt_chain_token=xxx`
2669
+ > - 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接,请使用 TikTok APP V3 目录下的接口。
2670
+ >
2671
+ > # [English]
2672
+ > ### Purpose:
2673
+ > - Get user likes
2674
+ > - Note: This interface requires that the user's like list be public
2675
+ > ### Parameters:
2676
+ > - secUid: User secUid
2677
+ > - cursor: Page cursor
2678
+ > - count: Number per page, default is 20, cannot be changed.
2679
+ > - coverFormat: Cover format
2680
+ > - post_item_list_request_type: Sort type
2681
+ > - 0: Default sort
2682
+ > - 1: Hot sort
2683
+ > - 2: Oldest sort
2684
+ > ### Return:
2685
+ > - User likes
2686
+ > ### Note:
2687
+ > - All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.
2688
+ > - When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.
2689
+ > - **If you receive HTTP 403 error when accessing video CDN links**:
2690
+ > 1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)
2691
+ > 2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API
2692
+ > 3. Example request header: `Cookie: tt_chain_token=xxx`
2693
+ > - If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.
2694
+ >
2695
+ > # [示例/Example]
2696
+ > secUid = "MS4wLjABAAAAq1iRXNduFZpY301UkVpJ1eQT60_NiWS9QQSeNqmNQEDJp0pOF8cpleNEdiJx5_IU"
2697
+ > cursor = 0
2698
+ > count = 20
2699
+ > coverFormat = 2
2700
+
2701
+ #### Parameters
2702
+
2703
+ | Field | In | Type | Required | Description | Default | Example | Enum |
2704
+ | --- | --- | --- | --- | --- | --- | --- | --- |
2705
+ | secUid | query | string | Yes | 用户secUid/User secUid | None | MS4wLjABAAAAq1iRXNduFZpY301UkVpJ1eQT60_NiWS9QQSeNqmNQEDJp0pOF8cpleNEdiJx5_IU | None |
2706
+ | cursor | query | integer | No | 翻页游标/Page cursor | 0 | None | None |
2707
+ | count | query | integer | No | 每页数量/Number per page | 20 | None | None |
2708
+ | coverFormat | query | integer | No | 封面格式/Cover format | 2 | None | None |
2709
+ | post_item_list_request_type | query | integer | No | 排序方式/Sort type | 0 | None | None |
2710
+
2711
+ #### Request Body
2712
+
2713
+ None
2714
+
2715
+ #### Success Response
2716
+
2717
+ ##### `200 application/json`
2718
+
2719
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2720
+
2721
+ | Field | Type | Required | Description | Default | Example | Enum |
2722
+ | --- | --- | --- | --- | --- | --- | --- |
2723
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
2724
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
2725
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
2726
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
2727
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
2728
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
2729
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
2730
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
2731
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
2732
+ | 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 |
2733
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
2734
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
2735
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
2736
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
2737
+ | data | null | No | The response data \| 响应数据 | None | None | None |
2738
+
2739
+ <a id="get-api-u1-v1-tiktok-web-fetch-user-live-detail"></a>
2740
+ ### `GET /api/u1/v1/tiktok/web/fetch_user_live_detail`
2741
+
2742
+ - Summary: 获取用户的直播详情/Get user live details
2743
+ - Capabilities: profiles / accounts / details / livestream
2744
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2745
+ - operationId: `fetch_user_live_detail_api_v1_tiktok_web_fetch_user_live_detail_get`
2746
+
2747
+ #### Notes
2748
+
2749
+ > # [中文]
2750
+ > ### 用途:
2751
+ > - 获取用户的直播详情
2752
+ > ### 参数:
2753
+ > - uniqueId: 用户uniqueId
2754
+ > ### 返回:
2755
+ > - 用户的直播详情
2756
+ > ### 备注:
2757
+ > - 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问,否则会返回HTTP403错误。
2758
+ > - 在访问视频CDN链接时,请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。
2759
+ > - **如果访问视频CDN链接时返回HTTP 403错误**:
2760
+ > 1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)
2761
+ > 2. 在请求该链接时,务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值
2762
+ > 3. 示例请求头: `Cookie: tt_chain_token=xxx`
2763
+ > - 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接,请使用 TikTok APP V3 目录下的接口。
2764
+ >
2765
+ > # [English]
2766
+ > ### Purpose:
2767
+ > - Get user live details
2768
+ > ### Parameters:
2769
+ > - uniqueId: User uniqueId
2770
+ > ### Return:
2771
+ > - User live details
2772
+ > ### Note:
2773
+ > - All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.
2774
+ > - When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.
2775
+ > - **If you receive HTTP 403 error when accessing video CDN links**:
2776
+ > 1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)
2777
+ > 2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API
2778
+ > 3. Example request header: `Cookie: tt_chain_token=xxx`
2779
+ > - If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.
2780
+ >
2781
+ > # [示例/Example]
2782
+ > uniqueId = "tiktok"
2783
+
2784
+ #### Parameters
2785
+
2786
+ | Field | In | Type | Required | Description | Default | Example | Enum |
2787
+ | --- | --- | --- | --- | --- | --- | --- | --- |
2788
+ | uniqueId | query | string | Yes | 用户uniqueId/User uniqueId | None | tiktok | None |
2789
+
2790
+ #### Request Body
2791
+
2792
+ None
2793
+
2794
+ #### Success Response
2795
+
2796
+ ##### `200 application/json`
2797
+
2798
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2799
+
2800
+ | Field | Type | Required | Description | Default | Example | Enum |
2801
+ | --- | --- | --- | --- | --- | --- | --- |
2802
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
2803
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
2804
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
2805
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
2806
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
2807
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
2808
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
2809
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
2810
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
2811
+ | 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 |
2812
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
2813
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
2814
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
2815
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
2816
+ | data | null | No | The response data \| 响应数据 | None | None | None |
2817
+
2818
+ <a id="get-api-u1-v1-tiktok-web-fetch-user-mix"></a>
2819
+ ### `GET /api/u1/v1/tiktok/web/fetch_user_mix`
2820
+
2821
+ - Summary: 获取用户的合辑列表/Get user mix list
2822
+ - Capabilities: profiles / accounts
2823
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2824
+ - operationId: `fetch_user_mix_api_v1_tiktok_web_fetch_user_mix_get`
2825
+
2826
+ #### Notes
2827
+
2828
+ > # [中文]
2829
+ > ### 用途:
2830
+ > - 获取用户的合辑列表
2831
+ > ### 参数:
2832
+ > - mixId: 合辑id
2833
+ > - cursor: 翻页游标
2834
+ > - count: 每页数量
2835
+ > ### 返回:
2836
+ > - 用户的合辑列表
2837
+ > ### 备注:
2838
+ > - 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问,否则会返回HTTP403错误。
2839
+ > - 在访问视频CDN链接时,请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。
2840
+ > - **如果访问视频CDN链接时返回HTTP 403错误**:
2841
+ > 1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)
2842
+ > 2. 在请求该链接时,务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值
2843
+ > 3. 示例请求头: `Cookie: tt_chain_token=xxx`
2844
+ > - 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接,请使用 TikTok APP V3 目录下的接口。
2845
+ >
2846
+ > # [English]
2847
+ > ### Purpose:
2848
+ > - Get user mix list
2849
+ > ### Parameters:
2850
+ > - mixId: Mix id
2851
+ > - cursor: Page cursor
2852
+ > - count: Number per page
2853
+ > ### Return:
2854
+ > - User mix list
2855
+ > ### Note:
2856
+ > - All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.
2857
+ > - When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.
2858
+ > - **If you receive HTTP 403 error when accessing video CDN links**:
2859
+ > 1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)
2860
+ > 2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API
2861
+ > 3. Example request header: `Cookie: tt_chain_token=xxx`
2862
+ > - If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.
2863
+ >
2864
+ > # [示例/Eample]
2865
+ > mixId = "7101538765474106158"
2866
+ > cursor = 0
2867
+ > count = 30
2868
+
2869
+ #### Parameters
2870
+
2871
+ | Field | In | Type | Required | Description | Default | Example | Enum |
2872
+ | --- | --- | --- | --- | --- | --- | --- | --- |
2873
+ | mixId | query | string | Yes | 合辑id/Mix id | None | 7101538765474106158 | None |
2874
+ | cursor | query | integer | No | 翻页游标/Page cursor | 0 | None | None |
2875
+ | count | query | integer | No | 每页数量/Number per page | 30 | None | None |
2876
+
2877
+ #### Request Body
2878
+
2879
+ None
2880
+
2881
+ #### Success Response
2882
+
2883
+ ##### `200 application/json`
2884
+
2885
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2886
+
2887
+ | Field | Type | Required | Description | Default | Example | Enum |
2888
+ | --- | --- | --- | --- | --- | --- | --- |
2889
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
2890
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
2891
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
2892
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
2893
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
2894
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
2895
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
2896
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
2897
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
2898
+ | 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 |
2899
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
2900
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
2901
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
2902
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
2903
+ | data | null | No | The response data \| 响应数据 | None | None | None |
2904
+
2905
+ <a id="get-api-u1-v1-tiktok-web-fetch-user-play-list"></a>
2906
+ ### `GET /api/u1/v1/tiktok/web/fetch_user_play_list`
2907
+
2908
+ - Summary: 获取用户的播放列表/Get user play list
2909
+ - Capabilities: profiles / accounts
2910
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2911
+ - operationId: `fetch_user_play_list_api_v1_tiktok_web_fetch_user_play_list_get`
2912
+
2913
+ #### Notes
2914
+
2915
+ > # [中文]
2916
+ > ### 用途:
2917
+ > - 获取用户的播放列表
2918
+ > ### 参数:
2919
+ > - secUid: 用户secUid
2920
+ > - cursor: 翻页游标
2921
+ > - count: 每页数量
2922
+ > ### 返回:
2923
+ > - 用户的播放列表
2924
+ > ### 备注:
2925
+ > - 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问,否则会返回HTTP403错误。
2926
+ > - 在访问视频CDN链接时,请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。
2927
+ > - **如果访问视频CDN链接时返回HTTP 403错误**:
2928
+ > 1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)
2929
+ > 2. 在请求该链接时,务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值
2930
+ > 3. 示例请求头: `Cookie: tt_chain_token=xxx`
2931
+ > - 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接,请使用 TikTok APP V3 目录下的接口。
2932
+ >
2933
+ > # [English]
2934
+ > ### Purpose:
2935
+ > - Get user play list
2936
+ > ### Parameters:
2937
+ > - secUid: User secUid
2938
+ > - cursor: Page cursor
2939
+ > - count: Number per page
2940
+ > ### Return:
2941
+ > - User play list
2942
+ > ### Note:
2943
+ > - All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.
2944
+ > - When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.
2945
+ > - **If you receive HTTP 403 error when accessing video CDN links**:
2946
+ > 1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)
2947
+ > 2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API
2948
+ > 3. Example request header: `Cookie: tt_chain_token=xxx`
2949
+ > - If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.
2950
+ >
2951
+ > # [示例/Eample]
2952
+ > secUid = "MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM"
2953
+ > cursor = 0
2954
+ > count = 30
2955
+
2956
+ #### Parameters
2957
+
2958
+ | Field | In | Type | Required | Description | Default | Example | Enum |
2959
+ | --- | --- | --- | --- | --- | --- | --- | --- |
2960
+ | secUid | query | string | Yes | 用户secUid/User secUid | None | MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM | None |
2961
+ | cursor | query | integer | No | 翻页游标/Page cursor | 0 | None | None |
2962
+ | count | query | integer | No | 每页数量/Number per page | 30 | None | None |
2963
+
2964
+ #### Request Body
2965
+
2966
+ None
2967
+
2968
+ #### Success Response
2969
+
2970
+ ##### `200 application/json`
2971
+
2972
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2973
+
2974
+ | Field | Type | Required | Description | Default | Example | Enum |
2975
+ | --- | --- | --- | --- | --- | --- | --- |
2976
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
2977
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
2978
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
2979
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
2980
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
2981
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
2982
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
2983
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
2984
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
2985
+ | 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 |
2986
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
2987
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
2988
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
2989
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
2990
+ | data | null | No | The response data \| 响应数据 | None | None | None |
2991
+
2992
+ <a id="get-api-u1-v1-tiktok-web-fetch-user-post"></a>
2993
+ ### `GET /api/u1/v1/tiktok/web/fetch_user_post`
2994
+
2995
+ - Summary: 获取用户的作品列表/Get user posts
2996
+ - Capabilities: profiles / accounts / content details
2997
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
2998
+ - operationId: `fetch_user_post_api_v1_tiktok_web_fetch_user_post_get`
2999
+
3000
+ #### Notes
3001
+
3002
+ > # [中文]
3003
+ > ### 用途:
3004
+ > - 获取用户的作品列表
3005
+ > ### 参数:
3006
+ > - secUid: 用户secUid
3007
+ > - cursor: 翻页游标
3008
+ > - count: 每页数量,默认为20,不可变更。
3009
+ > - coverFormat: 封面格式,默认为2,可选值为1或2。
3010
+ > - post_item_list_request_type: 排序方式
3011
+ > - 0:默认排序
3012
+ > - 1:热门排序
3013
+ > - 2:最旧排序
3014
+ > ### 返回:
3015
+ > - 用户的作品列表
3016
+ > ### 备注:
3017
+ > - 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问,否则会返回HTTP403错误。
3018
+ > - 在访问视频CDN链接时,请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。
3019
+ > - **如果访问视频CDN链接时返回HTTP 403错误**:
3020
+ > 1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)
3021
+ > 2. 在请求该链接时,务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值
3022
+ > 3. 示例请求头: `Cookie: tt_chain_token=xxx`
3023
+ > - 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接,请使用 TikTok APP V3 目录下的接口。
3024
+ >
3025
+ > # [English]
3026
+ > ### Purpose:
3027
+ > - Get user posts
3028
+ > ### Parameters:
3029
+ > - secUid: User secUid
3030
+ > - cursor: Page cursor
3031
+ > - count: Number per page, default is 20, cannot be changed.
3032
+ > - coverFormat: Cover format, default is 2, optional values are 1 or 2.
3033
+ > - post_item_list_request_type: Sort type
3034
+ > - 0: Default sort
3035
+ > - 1: Hot sort
3036
+ > - 2: Oldest sort
3037
+ > ### Return:
3038
+ > - User posts
3039
+ > ### Note:
3040
+ > - All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.
3041
+ > - When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.
3042
+ > - **If you receive HTTP 403 error when accessing video CDN links**:
3043
+ > 1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)
3044
+ > 2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API
3045
+ > 3. Example request header: `Cookie: tt_chain_token=xxx`
3046
+ > - If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.
3047
+ >
3048
+ > # [示例/Example]
3049
+ > secUid = "MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM"
3050
+ > cursor = 0
3051
+ > post_item_list_request_type = 0
3052
+ > count = 20
3053
+ > coverFormat = 2
3054
+
3055
+ #### Parameters
3056
+
3057
+ | Field | In | Type | Required | Description | Default | Example | Enum |
3058
+ | --- | --- | --- | --- | --- | --- | --- | --- |
3059
+ | secUid | query | string | Yes | 用户secUid/User secUid | None | MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM | None |
3060
+ | cursor | query | integer | No | 翻页游标/Page cursor | 0 | 0 | None |
3061
+ | count | query | integer | No | 每页数量/Number per page | 20 | 20 | None |
3062
+ | coverFormat | query | integer | No | 封面格式/Cover format | 2 | 2 | None |
3063
+ | post_item_list_request_type | query | integer | No | 排序方式/Sort type | 0 | 0 | None |
3064
+
3065
+ #### Request Body
3066
+
3067
+ None
3068
+
3069
+ #### Success Response
3070
+
3071
+ ##### `200 application/json`
3072
+
3073
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
3074
+
3075
+ | Field | Type | Required | Description | Default | Example | Enum |
3076
+ | --- | --- | --- | --- | --- | --- | --- |
3077
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
3078
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
3079
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
3080
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
3081
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
3082
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
3083
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
3084
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
3085
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
3086
+ | 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 |
3087
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
3088
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
3089
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
3090
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
3091
+ | data | null | No | The response data \| 响应数据 | None | None | None |
3092
+
3093
+ <a id="get-api-u1-v1-tiktok-web-fetch-user-profile"></a>
3094
+ ### `GET /api/u1/v1/tiktok/web/fetch_user_profile`
3095
+
3096
+ - Summary: 获取用户的个人信息/Get user profile
3097
+ - Capabilities: profiles / accounts
3098
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
3099
+ - operationId: `fetch_user_profile_api_v1_tiktok_web_fetch_user_profile_get`
3100
+
3101
+ #### Notes
3102
+
3103
+ > # [中文]
3104
+ > ### 用途:
3105
+ > - 获取用户的个人信息
3106
+ > ### 参数:
3107
+ > - secUid: 用户secUid
3108
+ > - uniqueId: 用户uniqueId
3109
+ > - secUid和uniqueId至少提供一个, 优先使用uniqueId, 也就是用户主页的链接中的用户名。
3110
+ > ### 返回:
3111
+ > - 用户的个人信息
3112
+ >
3113
+ > # [English]
3114
+ > ### Purpose:
3115
+ > - Get user profile
3116
+ > ### Parameters:
3117
+ > - secUid: User secUid
3118
+ > - uniqueId: User uniqueId
3119
+ > - At least one of secUid and uniqueId is provided, and uniqueId is preferred, that is, the username in the user's homepage link.
3120
+ > ### Return:
3121
+ > - User profile
3122
+ >
3123
+ > # [示例/Example]
3124
+ > secUid = "MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM"
3125
+ > uniqueId = "tiktok"
3126
+
3127
+ #### Parameters
3128
+
3129
+ | Field | In | Type | Required | Description | Default | Example | Enum |
3130
+ | --- | --- | --- | --- | --- | --- | --- | --- |
3131
+ | uniqueId | query | string | No | 用户uniqueId/User uniqueId | None | tiktok | None |
3132
+ | secUid | query | string | No | 用户secUid/User secUid | None | None | None |
3133
+
3134
+ #### Request Body
3135
+
3136
+ None
3137
+
3138
+ #### Success Response
3139
+
3140
+ ##### `200 application/json`
3141
+
3142
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
3143
+
3144
+ | Field | Type | Required | Description | Default | Example | Enum |
3145
+ | --- | --- | --- | --- | --- | --- | --- |
3146
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
3147
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
3148
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
3149
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
3150
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
3151
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
3152
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
3153
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
3154
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
3155
+ | 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 |
3156
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
3157
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
3158
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
3159
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
3160
+ | data | null | No | The response data \| 响应数据 | None | None | None |
3161
+
3162
+ <a id="get-api-u1-v1-tiktok-web-fetch-user-repost"></a>
3163
+ ### `GET /api/u1/v1/tiktok/web/fetch_user_repost`
3164
+
3165
+ - Summary: 获取用户的转发作品列表/Get user reposts
3166
+ - Capabilities: profiles / accounts / content details
3167
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
3168
+ - operationId: `fetch_user_repost_api_v1_tiktok_web_fetch_user_repost_get`
3169
+
3170
+ #### Notes
3171
+
3172
+ > # [中文]
3173
+ > ### 用途:
3174
+ > - 获取用户的转发作品列表
3175
+ > ### 参数:
3176
+ > - secUid: 用户secUid
3177
+ > - cursor: 翻页游标
3178
+ > - count: 每页数量,默认为20,不可变更。
3179
+ > - coverFormat: 封面格式,默认为2,可选值为1或2。
3180
+ > ### 返回:
3181
+ > - 用户的转发作品列表
3182
+ > ### 备注:
3183
+ > - 此接口返回的所有视频CDN链接均需要携带返回的 `tt_chain_token` 参数才能正常访问,否则会返回HTTP403错误。
3184
+ > - 在访问视频CDN链接时,请务必在请求头中携带 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 替换为接口返回的 `tt_chain_token` 参数值。
3185
+ > - **如果访问视频CDN链接时返回HTTP 403错误**:
3186
+ > 1. 请使用接口响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接(通常在响应数据的 `video.playAddr` 或类似字段中)
3187
+ > 2. 在请求该链接时,务必在请求头中添加 `Cookie: tt_chain_token={tt_chain_token}`,其中 `{tt_chain_token}` 为接口返回的 `tt_chain_token` 参数值
3188
+ > 3. 示例请求头: `Cookie: tt_chain_token=xxx`
3189
+ > - 如果需要绕过此限制获取可以直接访问的无水印视频CDN链接,请使用 TikTok APP V3 目录下的接口。
3190
+ >
3191
+ > # [English]
3192
+ > ### Purpose:
3193
+ > - Get user reposts
3194
+ > ### Parameters:
3195
+ > - secUid: User secUid
3196
+ > - cursor: Page cursor
3197
+ > - count: Number per page, default is 20, cannot be changed.
3198
+ > - coverFormat: Cover format, default is 2, optional values are 1 or 2.
3199
+ > ### Return:
3200
+ > - User reposts
3201
+ > ### Note:
3202
+ > - All video CDN links returned by this interface need to carry the returned `tt_chain_token` parameter to be accessed normally, otherwise HTTP 403 error will be returned.
3203
+ > - When accessing the video CDN link, be sure to carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is replaced with the `tt_chain_token` parameter value returned by the interface.
3204
+ > - **If you receive HTTP 403 error when accessing video CDN links**:
3205
+ > 1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the API response (usually found in `video.playAddr` or similar fields)
3206
+ > 2. When requesting this link, make sure to add `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by the API
3207
+ > 3. Example request header: `Cookie: tt_chain_token=xxx`
3208
+ > - If you need to bypass this restriction to get a watermark-free video CDN link that can be accessed directly, please use the interface under the TikTok APP V3 directory.
3209
+ >
3210
+ > # [示例/Example]
3211
+ > secUid = "MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM"
3212
+ > cursor = 0
3213
+ > count = 20
3214
+ > coverFormat = 2
3215
+
3216
+ #### Parameters
3217
+
3218
+ | Field | In | Type | Required | Description | Default | Example | Enum |
3219
+ | --- | --- | --- | --- | --- | --- | --- | --- |
3220
+ | secUid | query | string | Yes | 用户secUid/User secUid | None | MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM | None |
3221
+ | cursor | query | integer | No | 翻页游标/Page cursor | 0 | 0 | None |
3222
+ | count | query | integer | No | 每页数量/Number per page | 20 | 20 | None |
3223
+ | coverFormat | query | integer | No | 封面格式/Cover format | 2 | 2 | None |
3224
+
3225
+ #### Request Body
3226
+
3227
+ None
3228
+
3229
+ #### Success Response
3230
+
3231
+ ##### `200 application/json`
3232
+
3233
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
3234
+
3235
+ | Field | Type | Required | Description | Default | Example | Enum |
3236
+ | --- | --- | --- | --- | --- | --- | --- |
3237
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
3238
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
3239
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
3240
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
3241
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
3242
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
3243
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
3244
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
3245
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
3246
+ | 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 |
3247
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
3248
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
3249
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
3250
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
3251
+ | data | null | No | The response data \| 响应数据 | None | None | None |
3252
+
3253
+ <a id="get-api-u1-v1-tiktok-web-generate-fingerprint"></a>
3254
+ ### `GET /api/u1/v1/tiktok/web/generate_fingerprint`
3255
+
3256
+ - Summary: 生成浏览器指纹/Generate browser fingerprint
3257
+ - Capabilities: general
3258
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
3259
+ - operationId: `generate_fingerprint_api_v1_tiktok_web_generate_fingerprint_get`
3260
+
3261
+ #### Notes
3262
+
3263
+ > # [中文]
3264
+ > ### 用途:
3265
+ > - 生成随机浏览器指纹数据,可用于自定义msToken请求
3266
+ > ### 参数:
3267
+ > - browser_type: 指定浏览器类型,可选值:
3268
+ > - chrome_windows: Chrome + Windows
3269
+ > - chrome_mac: Chrome + macOS
3270
+ > - firefox_windows: Firefox + Windows
3271
+ > - firefox_mac: Firefox + macOS
3272
+ > - 不传则随机选择
3273
+ > ### 返回:
3274
+ > - 浏览器指纹数据
3275
+ >
3276
+ > # [English]
3277
+ > ### Purpose:
3278
+ > - Generate random browser fingerprint data for custom msToken request
3279
+ > ### Parameters:
3280
+ > - browser_type: Specify browser type, options:
3281
+ > - chrome_windows: Chrome + Windows
3282
+ > - chrome_mac: Chrome + macOS
3283
+ > - firefox_windows: Firefox + Windows
3284
+ > - firefox_mac: Firefox + macOS
3285
+ > - Leave empty for random selection
3286
+ > ### Return:
3287
+ > - Browser fingerprint data
3288
+
3289
+ #### Parameters
3290
+
3291
+ | Field | In | Type | Required | Description | Default | Example | Enum |
3292
+ | --- | --- | --- | --- | --- | --- | --- | --- |
3293
+ | browser_type | query | string | No | None | None | None | None |
3294
+
3295
+ #### Request Body
3296
+
3297
+ None
3298
+
3299
+ #### Success Response
3300
+
3301
+ ##### `200 application/json`
3302
+
3303
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
3304
+
3305
+ | Field | Type | Required | Description | Default | Example | Enum |
3306
+ | --- | --- | --- | --- | --- | --- | --- |
3307
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
3308
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
3309
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
3310
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
3311
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
3312
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
3313
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
3314
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
3315
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
3316
+ | 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 |
3317
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
3318
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
3319
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
3320
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
3321
+ | data | null | No | The response data \| 响应数据 | None | None | None |
3322
+
3323
+ <a id="get-api-u1-v1-tiktok-web-generate-hashed-id"></a>
3324
+ ### `GET /api/u1/v1/tiktok/web/generate_hashed_id`
3325
+
3326
+ - Summary: 生成哈希ID/Generate hashed ID
3327
+ - Capabilities: general
3328
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
3329
+ - operationId: `generate_hashed_id_api_v1_tiktok_web_generate_hashed_id_get`
3330
+
3331
+ #### Notes
3332
+
3333
+ > # [中文]
3334
+ > ### 用途:
3335
+ > - 生成TikTok Web的哈希ID
3336
+ > ### 参数:
3337
+ > - email: 邮箱地址
3338
+ > ### 返回:
3339
+ > - 生成的哈希ID字符串
3340
+ >
3341
+ > # [English]
3342
+ > ### Purpose:
3343
+ > - Generate hashed ID for TikTok Web
3344
+ > ### Parameters:
3345
+ > - email: Email address
3346
+ > ### Return:
3347
+ > - Generated hashed ID string
3348
+ >
3349
+ > # [示例/Example]
3350
+ > email = "test@example.com"
3351
+
3352
+ #### Parameters
3353
+
3354
+ | Field | In | Type | Required | Description | Default | Example | Enum |
3355
+ | --- | --- | --- | --- | --- | --- | --- | --- |
3356
+ | email | query | string | Yes | 邮箱地址/Email address | None | test@example.com | None |
3357
+
3358
+ #### Request Body
3359
+
3360
+ None
3361
+
3362
+ #### Success Response
3363
+
3364
+ ##### `200 application/json`
3365
+
3366
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
3367
+
3368
+ | Field | Type | Required | Description | Default | Example | Enum |
3369
+ | --- | --- | --- | --- | --- | --- | --- |
3370
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
3371
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
3372
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
3373
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
3374
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
3375
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
3376
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
3377
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
3378
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
3379
+ | 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 |
3380
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
3381
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
3382
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
3383
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
3384
+ | data | null | No | The response data \| 响应数据 | None | None | None |
3385
+
3386
+ <a id="get-api-u1-v1-tiktok-web-generate-real-mstoken"></a>
3387
+ ### `GET /api/u1/v1/tiktok/web/generate_real_msToken`
3388
+
3389
+ - Summary: 生成真实msToken/Generate real msToken
3390
+ - Capabilities: general
3391
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
3392
+ - operationId: `generate_real_msToken_api_v1_tiktok_web_generate_real_msToken_get`
3393
+
3394
+ #### Notes
3395
+
3396
+ > # [中文]
3397
+ > ### 用途:
3398
+ > - 生成真实msToken
3399
+ > ### 参数:
3400
+ > - random_strData: 是否使用随机化的浏览器指纹数据(推荐开启以提高反爬虫能力)
3401
+ > - browser_type: 指定浏览器类型,可选值:
3402
+ > - chrome_windows: Chrome + Windows
3403
+ > - chrome_mac: Chrome + macOS
3404
+ > - firefox_windows: Firefox + Windows
3405
+ > - firefox_mac: Firefox + macOS
3406
+ > - 不传则随机选择
3407
+ > ### 返回:
3408
+ > - 真实msToken
3409
+ >
3410
+ > # [English]
3411
+ > ### Purpose:
3412
+ > - Generate real msToken
3413
+ > ### Parameters:
3414
+ > - random_strData: Whether to use randomized browser fingerprint data (recommended for better anti-bot)
3415
+ > - browser_type: Specify browser type, options:
3416
+ > - chrome_windows: Chrome + Windows
3417
+ > - chrome_mac: Chrome + macOS
3418
+ > - firefox_windows: Firefox + Windows
3419
+ > - firefox_mac: Firefox + macOS
3420
+ > - Leave empty for random selection
3421
+ > ### Return:
3422
+ > - Real msToken
3423
+
3424
+ #### Parameters
3425
+
3426
+ | Field | In | Type | Required | Description | Default | Example | Enum |
3427
+ | --- | --- | --- | --- | --- | --- | --- | --- |
3428
+ | random_strData | query | boolean | No | None | false | None | None |
3429
+ | browser_type | query | string | No | None | None | None | None |
3430
+
3431
+ #### Request Body
3432
+
3433
+ None
3434
+
3435
+ #### Success Response
3436
+
3437
+ ##### `200 application/json`
3438
+
3439
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
3440
+
3441
+ | Field | Type | Required | Description | Default | Example | Enum |
3442
+ | --- | --- | --- | --- | --- | --- | --- |
3443
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
3444
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
3445
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
3446
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
3447
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
3448
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
3449
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
3450
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
3451
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
3452
+ | 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 |
3453
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
3454
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
3455
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
3456
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
3457
+ | data | null | No | The response data \| 响应数据 | None | None | None |
3458
+
3459
+ <a id="get-api-u1-v1-tiktok-web-generate-ttwid"></a>
3460
+ ### `GET /api/u1/v1/tiktok/web/generate_ttwid`
3461
+
3462
+ - Summary: 生成ttwid/Generate ttwid
3463
+ - Capabilities: general
3464
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
3465
+ - operationId: `generate_ttwid_api_v1_tiktok_web_generate_ttwid_get`
3466
+
3467
+ #### Notes
3468
+
3469
+ > # [中文]
3470
+ > ### 用途:
3471
+ > - 生成ttwid
3472
+ > ### 参数:
3473
+ > - 无
3474
+ > ### 返回:
3475
+ > - ttwid
3476
+ >
3477
+ > # [English]
3478
+ > ### Purpose:
3479
+ > - Generate ttwid
3480
+ > ### Parameters:
3481
+ > - None
3482
+ > ### Return:
3483
+ > - ttwid
3484
+
3485
+ #### Parameters
3486
+
3487
+ | Field | In | Type | Required | Description | Default | Example | Enum |
3488
+ | --- | --- | --- | --- | --- | --- | --- | --- |
3489
+ | user_agent | query | string | No | None | Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:125.0) Gecko/20100101 Firefox/125.0 | None | None |
3490
+
3491
+ #### Request Body
3492
+
3493
+ None
3494
+
3495
+ #### Success Response
3496
+
3497
+ ##### `200 application/json`
3498
+
3499
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
3500
+
3501
+ | Field | Type | Required | Description | Default | Example | Enum |
3502
+ | --- | --- | --- | --- | --- | --- | --- |
3503
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
3504
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
3505
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
3506
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
3507
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
3508
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
3509
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
3510
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
3511
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
3512
+ | 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 |
3513
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
3514
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
3515
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
3516
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
3517
+ | data | null | No | The response data \| 响应数据 | None | None | None |
3518
+
3519
+ <a id="get-api-u1-v1-tiktok-web-generate-webid"></a>
3520
+ ### `GET /api/u1/v1/tiktok/web/generate_webid`
3521
+
3522
+ - Summary: 生成web_id/Generate web_id
3523
+ - Capabilities: general
3524
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
3525
+ - operationId: `generate_webid_api_v1_tiktok_web_generate_webid_get`
3526
+
3527
+ #### Notes
3528
+
3529
+ > # [中文]
3530
+ > ### 用途:
3531
+ > - 生成 TikTok web_id (Web接口请求参数中的device_id)
3532
+ > ### 参数:
3533
+ > - cookie: 自定义 cookie(需包含 odin_tt),如不传则使用随机生成的游客Cookie值
3534
+ > - user_agent: 用户代理字符串
3535
+ > - url: 请求来源 URL
3536
+ > - referer: 来源页面
3537
+ > - user_unique_id: 用户唯一 ID(可选)
3538
+ > - app_id: 应用 ID,默认 1988,代表 TikTok Web 应用
3539
+ > ### 返回:
3540
+ > - web_id: 生成的 web_id
3541
+ > - e: 错误码 (0 表示成功)
3542
+ > - ssid: 会话 ID
3543
+ >
3544
+ > # [English]
3545
+ > ### Purpose:
3546
+ > - Generate TikTok web_id (device_id in Web API request parameters)
3547
+ > ### Parameters:
3548
+ > - cookie: Custom cookie (must contain odin_tt), uses default if not provided
3549
+ > - user_agent: User agent string
3550
+ > - url: Request source URL
3551
+ > - referer: Referrer page
3552
+ > - user_unique_id: User unique ID (optional)
3553
+ > - app_id: Application ID, default 1988, represents TikTok Web app
3554
+ > ### Return:
3555
+ > - web_id: Generated web_id
3556
+ > - e: Error code (0 means success)
3557
+ > - ssid: Session ID
3558
+
3559
+ #### Parameters
3560
+
3561
+ | Field | In | Type | Required | Description | Default | Example | Enum |
3562
+ | --- | --- | --- | --- | --- | --- | --- | --- |
3563
+ | cookie | query | string | No | None | None | None | None |
3564
+ | user_agent | query | string | No | None | Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:145.0) Gecko/20100101 Firefox/… | None | None |
3565
+ | url | query | string | No | None | https://www.tiktok.com/explore | None | None |
3566
+ | referer | query | string | No | None | None | None | None |
3567
+ | user_unique_id | query | string | No | None | None | None | None |
3568
+ | app_id | query | integer | No | None | 1988 | None | None |
3569
+
3570
+ #### Request Body
3571
+
3572
+ None
3573
+
3574
+ #### Success Response
3575
+
3576
+ ##### `200 application/json`
3577
+
3578
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
3579
+
3580
+ | Field | Type | Required | Description | Default | Example | Enum |
3581
+ | --- | --- | --- | --- | --- | --- | --- |
3582
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
3583
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
3584
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
3585
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
3586
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
3587
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
3588
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
3589
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
3590
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
3591
+ | 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 |
3592
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
3593
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
3594
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
3595
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
3596
+ | data | null | No | The response data \| 响应数据 | None | None | None |
3597
+
3598
+ <a id="post-api-u1-v1-tiktok-web-generate-xbogus"></a>
3599
+ ### `POST /api/u1/v1/tiktok/web/generate_xbogus`
3600
+
3601
+ - Summary: 生成 XBogus/Generate XBogus
3602
+ - Capabilities: general
3603
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
3604
+ - operationId: `generate_xbogus_api_v1_tiktok_web_generate_xbogus_post`
3605
+
3606
+ #### Notes
3607
+
3608
+ > # [中文]
3609
+ > ### 用途:
3610
+ > - 生成xbogus
3611
+ > ### 参数:
3612
+ > - url: 未签名的API URL
3613
+ > - user_agent: 用户浏览器User-Agent
3614
+ > ### 返回:
3615
+ > - xbogus
3616
+ >
3617
+ > # [English]
3618
+ > ### Purpose:
3619
+ > - Generate xbogus
3620
+ > ### Parameters:
3621
+ > - url: Unsigned API URL
3622
+ > - user_agent: User browser User-Agent
3623
+ > ### Return:
3624
+ > - xbogus
3625
+ >
3626
+ > # [示例/Example]
3627
+ >
3628
+ > ```json
3629
+ > {
3630
+ > "url": "https://www.tiktok.com/aweme/v1/web/aweme/detail/?aweme_id=7148736076176215311&device_platform=webapp&aid=6383&channel=channel_pc_web&pc_client_type=1&version_code=170400&version_name=17.4.0&cookie_enabled=true&screen_width=1920&screen_height=1080&browser_language=zh-CN&browser_platform=Win32&browser_name=Edge&browser_version=117.0.2045.47&browser_online=true&engine_name=Blink&engine_version=117.0.0.0&os_name=Windows&os_version=10&cpu_core_num=128&device_memory=10240&platform=PC&downlink=10&effective_type=4g&round_trip_time=100",
3631
+ > "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.212 Safari/537.36"
3632
+ > }
3633
+
3634
+ #### Parameters
3635
+
3636
+ None
3637
+
3638
+ #### Request Body
3639
+
3640
+ - required: Yes
3641
+
3642
+ ##### `application/json`
3643
+
3644
+ - Schema summary: `url*`:string, `user_agent*`:string
3645
+
3646
+ | Field | Type | Required | Description | Default | Example | Enum |
3647
+ | --- | --- | --- | --- | --- | --- | --- |
3648
+ | url | string | Yes | 请求的API URL,不需要进行编码 \| The requested API URL, no need to encode | None | https://www.douyin.com/aweme/v1/web/aweme/detail/?aweme_id=7148736076176215311&… | None |
3649
+ | user_agent | string | Yes | 请求API时的User-Agent \| User-Agent when requesting the API | None | Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko… | None |
3650
+
3651
+ #### Success Response
3652
+
3653
+ ##### `200 application/json`
3654
+
3655
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
3656
+
3657
+ | Field | Type | Required | Description | Default | Example | Enum |
3658
+ | --- | --- | --- | --- | --- | --- | --- |
3659
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
3660
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
3661
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
3662
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
3663
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
3664
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
3665
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
3666
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
3667
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
3668
+ | 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 |
3669
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
3670
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
3671
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
3672
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
3673
+ | data | null | No | The response data \| 响应数据 | None | None | None |
3674
+
3675
+ <a id="post-api-u1-v1-tiktok-web-generate-xgnarly"></a>
3676
+ ### `POST /api/u1/v1/tiktok/web/generate_xgnarly`
3677
+
3678
+ - Summary: 生成 XGnarly /Generate XGnarly
3679
+ - Capabilities: general
3680
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
3681
+ - operationId: `generate_xgnarly_api_v1_tiktok_web_generate_xgnarly_post`
3682
+
3683
+ #### Notes
3684
+
3685
+ > # [中文]
3686
+ > ### 用途:
3687
+ > - 生成 XGnarly 加密,用于 TikTok Web API 请求
3688
+ > ### 参数:
3689
+ > - url (str): 不携带签名(X-Bogus 或 X-Gnarly)的 原始 URL 字符串 或 查询参数字符串,不需要进行URL编码
3690
+ > - user_agent (str): 用户浏览器User-Agent,参与加密,请确保与请求时的User-Agent一致
3691
+ > - body (str): 请求的API参数,适用于POST请求,如果是GET请求则不需要提供
3692
+ > ### 返回:
3693
+ > - X-Gnarly 加密字符串
3694
+ >
3695
+ > # [English]
3696
+ > ### Purpose:
3697
+ > - Generate XGnarly encryption, used for TikTok Web API requests
3698
+ > ### Parameters:
3699
+ > - url (str): The original URL string or query parameter string without signature (X-Bogus or X-Gnarly), no need to URL encode
3700
+ > - user_agent (str): User browser User-Agent, involved in encryption, please ensure it is consistent with the User-Agent when requesting
3701
+ > - body (str): The API parameters of the request, applicable for POST requests, not required for
3702
+ > ### Return:
3703
+ > - X-Gnarly encryption string
3704
+ >
3705
+ > # [示例/Example]
3706
+ >
3707
+ > ```json
3708
+ > {
3709
+ > "url": "https://www.tiktok.com/api/search/user/full/?WebIdLastTime=1756087650&aid=1988&app_language=zh-Hans&app_name=tiktok_web&browser_language=zh-CN&browser_name=Mozilla&browser_online=true&browser_platform=MacIntel&browser_version=5.0%20%28Macintosh%3B%20Intel%20Mac%20OS%20X%2010_15_7%29%20AppleWebKit%2F537.36%20%28KHTML%2C%20like%20Gecko%29%20Chrome%2F139.0.0.0%20Safari%2F537.36&channel=tiktok_web&cookie_enabled=true&cursor=10&data_collection_enabled=false&device_id=7542339104672111234&device_platform=web_pc&focus_state=true&from_page=search&history_len=3&is_fullscreen=true&is_page_visible=true&keyword=musk&odinId=7542338997269211234&os=mac&priority_region&referer&region=US&screen_height=967&screen_width=1496&search_id&tz_name=America%2FLos_Angeles&user_is_login=false&web_search_code=%7B%22tiktok%22%3A%7B%22client_params_x%22%3A%7B%22search_engine%22%3A%7B%22ies_mt_user_live_video_card_use_libra%22%3A1%2C%22mt_search_general_user_live_card%22%3A1%7D%7D%2C%22search_server%22%3A%7B%7D%7D%7D&webcast_language=zh-Hans",
3710
+ > "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/139.0.0.0 Safari/537.36",
3711
+ > "body": ""
3712
+ > }
3713
+
3714
+ #### Parameters
3715
+
3716
+ None
3717
+
3718
+ #### Request Body
3719
+
3720
+ - required: Yes
3721
+
3722
+ ##### `application/json`
3723
+
3724
+ - Schema summary: `url*`:string, `user_agent*`:string, `body`:string
3725
+
3726
+ | Field | Type | Required | Description | Default | Example | Enum |
3727
+ | --- | --- | --- | --- | --- | --- | --- |
3728
+ | url | string | Yes | 请求的API URL,不需要进行URL编码 \| The requested API URL, no need to URL encode | None | None | None |
3729
+ | user_agent | string | Yes | 请求API时的User-Agent \| User-Agent when requesting the API | None | None | None |
3730
+ | body | string | No | 请求的API参数,适用于POST请求 \| The API parameters of the request, applicable for POST requests | None | None | None |
3731
+
3732
+ #### Success Response
3733
+
3734
+ ##### `200 application/json`
3735
+
3736
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
3737
+
3738
+ | Field | Type | Required | Description | Default | Example | Enum |
3739
+ | --- | --- | --- | --- | --- | --- | --- |
3740
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
3741
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
3742
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
3743
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
3744
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
3745
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
3746
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
3747
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
3748
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
3749
+ | 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 |
3750
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
3751
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
3752
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
3753
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
3754
+ | data | null | No | The response data \| 响应数据 | None | None | None |
3755
+
3756
+ <a id="post-api-u1-v1-tiktok-web-generate-xgnarly-and-xbogus"></a>
3757
+ ### `POST /api/u1/v1/tiktok/web/generate_xgnarly_and_xbogus`
3758
+
3759
+ - Summary: 生成 XGnarly 和 XBogus /Generate XGnarly and XBogus
3760
+ - Capabilities: general
3761
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
3762
+ - operationId: `generate_xgnarly_and_xbogus_api_v1_tiktok_web_generate_xgnarly_and_xbogus_post`
3763
+
3764
+ #### Notes
3765
+
3766
+ > # [中文]
3767
+ > ### 用途:
3768
+ > - 生成 XGnarly 加密,用于 TikTok Web API 请求
3769
+ > - 用这个接口可以生成最新版本的加密参数 X-Bogus 和 X-Gnarly,不可自定义 User-Agent,会自动生成一个常见浏览器的User-Agent
3770
+ > - 此接口为完美还原算法,无视除验证码外的一切风控,可以用于爬取商品,价格:0.005 美金/次
3771
+ > - 本接口生成的 X-Bogus 和 X-Gnarly 均为最新版本(2026年1月)
3772
+ > ### 参数:
3773
+ > - url (str): 不携带签名(X-Bogus 或 X-Gnarly)并且包含域名的请求URL,不需要进行URL编码
3774
+ > - body (str): 请求的API参数,适用于POST请求,如果是GET请求则不需要提供
3775
+ > ### 返回:
3776
+ > - 最新版本的 X-Gnarly 加密 + 最新版本的 X-Bogus 加密 + 随机浏览器的 User-Agent
3777
+ >
3778
+ > # [English]
3779
+ > ### Purpose:
3780
+ > - Generate XGnarly encryption, used for TikTok Web API requests
3781
+ > - This interface can generate the latest version of encryption parameters X-Bogus and X-Gnarly, User-Agent cannot be customized, a common browser User-Agent will be automatically generated
3782
+ > - This interface perfectly restores the algorithm, ignores all risk controls except for verification codes, and can be used to crawl products, price: $0.005/time
3783
+ > - The X-Bogus and X-Gnarly generated by this interface are the latest versions (January 2026)
3784
+ > ### Parameters:
3785
+ > - url (str): The requested API URL without signature (X-Bogus or X-Gnarly) and including the domain name, no need to URL encode
3786
+ > - body (str): The API parameters of the request, applicable for POST requests, not required for
3787
+ > ### Return:
3788
+ > - The latest version of X-Gnarly encryption + the latest version of X-Bogus encryption + User-Agent of a random browser
3789
+ >
3790
+ > # [示例/Example]
3791
+ >
3792
+ > ```json
3793
+ > {
3794
+ > "url": "https://www.tiktok.com/api/search/user/full/?WebIdLastTime=1756087650&aid=1988&app_language=zh-Hans&app_name=tiktok_web&browser_language=zh-CN&browser_name=Mozilla&browser_online=true&browser_platform=MacIntel&browser_version=5.0%20%28Macintosh%3B%20Intel%20Mac%20OS%20X%2010_15_7%29%20AppleWebKit%2F537.36%20%28KHTML%2C%20like%20Gecko%29%20Chrome%2F139.0.0.0%20Safari%2F537.36&channel=tiktok_web&cookie_enabled=true&cursor=10&data_collection_enabled=false&device_id=7542339104672111234&device_platform=web_pc&focus_state=true&from_page=search&history_len=3&is_fullscreen=true&is_page_visible=true&keyword=musk&odinId=7542338997269211234&os=mac&priority_region&referer&region=US&screen_height=967&screen_width=1496&search_id&tz_name=America%2FLos_Angeles&user_is_login=false&web_search_code=%7B%22tiktok%22%3A%7B%22client_params_x%22%3A%7B%22search_engine%22%3A%7B%22ies_mt_user_live_video_card_use_libra%22%3A1%2C%22mt_search_general_user_live_card%22%3A1%7D%7D%2C%22search_server%22%3A%7B%7D%7D%7D&webcast_language=zh-Hans",
3795
+ > "body": ""
3796
+ > }
3797
+
3798
+ #### Parameters
3799
+
3800
+ None
3801
+
3802
+ #### Request Body
3803
+
3804
+ - required: Yes
3805
+
3806
+ ##### `application/json`
3807
+
3808
+ - Schema summary: `url*`:string, `body`:string
3809
+
3810
+ | Field | Type | Required | Description | Default | Example | Enum |
3811
+ | --- | --- | --- | --- | --- | --- | --- |
3812
+ | url | string | Yes | 包含域名和参数的请求的API URL,不需要进行URL编码 \| The requested API URL, no need to URL encode | None | None | None |
3813
+ | body | string | No | 请求的API参数,适用于POST请求 \| The API parameters of the request, applicable for POST requests | None | None | None |
3814
+
3815
+ #### Success Response
3816
+
3817
+ ##### `200 application/json`
3818
+
3819
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
3820
+
3821
+ | Field | Type | Required | Description | Default | Example | Enum |
3822
+ | --- | --- | --- | --- | --- | --- | --- |
3823
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
3824
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
3825
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
3826
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
3827
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
3828
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
3829
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
3830
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
3831
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
3832
+ | 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 |
3833
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
3834
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
3835
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
3836
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
3837
+ | data | null | No | The response data \| 响应数据 | None | None | None |
3838
+
3839
+ <a id="post-api-u1-v1-tiktok-web-get-all-aweme-id"></a>
3840
+ ### `POST /api/u1/v1/tiktok/web/get_all_aweme_id`
3841
+
3842
+ - Summary: 提取列表作品id/Extract list video id
3843
+ - Capabilities: general
3844
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
3845
+ - operationId: `get_all_aweme_id_api_v1_tiktok_web_get_all_aweme_id_post`
3846
+
3847
+ #### Notes
3848
+
3849
+ > # [中文]
3850
+ > ### 用途:
3851
+ > - 提取列表作品id
3852
+ > ### 参数:
3853
+ > - url: 作品链接 (最多支持20个链接)
3854
+ > ### 返回:
3855
+ > - 作品id
3856
+ >
3857
+ > # [English]
3858
+ > ### Purpose:
3859
+ > - Extract list video id
3860
+ > ### Parameters:
3861
+ > - url: Video link (Support up to 20 links)
3862
+ > ### Return:
3863
+ > - Video id
3864
+ >
3865
+ > # [示例/Example]
3866
+ > url = ["https://www.tiktok.com/@owlcitymusic/video/7218694761253735723"]
3867
+
3868
+ #### Parameters
3869
+
3870
+ None
3871
+
3872
+ #### Request Body
3873
+
3874
+ - required: Yes
3875
+
3876
+ ##### `application/json`
3877
+
3878
+ - Schema summary: [string]
3879
+
3880
+ | Field | Type | Required | Description | Default | Example | Enum |
3881
+ | --- | --- | --- | --- | --- | --- | --- |
3882
+ | [] | array<string> | Yes | 作品链接/Video link | None | None | None |
3883
+
3884
+ #### Success Response
3885
+
3886
+ ##### `200 application/json`
3887
+
3888
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
3889
+
3890
+ | Field | Type | Required | Description | Default | Example | Enum |
3891
+ | --- | --- | --- | --- | --- | --- | --- |
3892
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
3893
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
3894
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
3895
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
3896
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
3897
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
3898
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
3899
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
3900
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
3901
+ | 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 |
3902
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
3903
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
3904
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
3905
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
3906
+ | data | null | No | The response data \| 响应数据 | None | None | None |
3907
+
3908
+ <a id="post-api-u1-v1-tiktok-web-get-all-sec-user-id"></a>
3909
+ ### `POST /api/u1/v1/tiktok/web/get_all_sec_user_id`
3910
+
3911
+ - Summary: 提取列表用户sec_user_id/Extract list user sec_user_id
3912
+ - Capabilities: profiles / accounts
3913
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
3914
+ - operationId: `get_all_sec_user_id_api_v1_tiktok_web_get_all_sec_user_id_post`
3915
+
3916
+ #### Notes
3917
+
3918
+ > # [中文]
3919
+ > ### 用途:
3920
+ > - 提取列表用户id
3921
+ > ### 参数:
3922
+ > - url: 用户主页链接(最多支持10个链接)、
3923
+ > ### 返回:
3924
+ > - 如果链接成功获取到sec_user_id,则返回sec_user_id,否则返回原始的输入链接,后续可以手动校验链接无法获取sec_user_id的原因。
3925
+ >
3926
+ > # [English]
3927
+ > ### Purpose:
3928
+ > - Extract list user id
3929
+ > ### Parameters:
3930
+ > - url: User homepage link (Support up to 10 links)
3931
+ > ### Return:
3932
+ > - If the sec_user_id is successfully obtained, the sec_user_id is returned, otherwise the original input link is returned, and the reason why the sec_user_id cannot be obtained can be manually verified later.
3933
+ >
3934
+ > # [示例/Example]
3935
+ > url = ["https://www.tiktok.com/@tiktok"]
3936
+
3937
+ #### Parameters
3938
+
3939
+ None
3940
+
3941
+ #### Request Body
3942
+
3943
+ - required: Yes
3944
+
3945
+ ##### `application/json`
3946
+
3947
+ - Schema summary: [string]
3948
+
3949
+ | Field | Type | Required | Description | Default | Example | Enum |
3950
+ | --- | --- | --- | --- | --- | --- | --- |
3951
+ | [] | array<string> | Yes | 用户主页链接/User homepage link | None | None | None |
3952
+
3953
+ #### Success Response
3954
+
3955
+ ##### `200 application/json`
3956
+
3957
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
3958
+
3959
+ | Field | Type | Required | Description | Default | Example | Enum |
3960
+ | --- | --- | --- | --- | --- | --- | --- |
3961
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
3962
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
3963
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
3964
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
3965
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
3966
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
3967
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
3968
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
3969
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
3970
+ | 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 |
3971
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
3972
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
3973
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
3974
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
3975
+ | data | null | No | The response data \| 响应数据 | None | None | None |
3976
+
3977
+ <a id="post-api-u1-v1-tiktok-web-get-all-unique-id"></a>
3978
+ ### `POST /api/u1/v1/tiktok/web/get_all_unique_id`
3979
+
3980
+ - Summary: 获取列表unique_id/Get list unique_id
3981
+ - Capabilities: general
3982
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
3983
+ - operationId: `get_all_unique_id_api_v1_tiktok_web_get_all_unique_id_post`
3984
+
3985
+ #### Notes
3986
+
3987
+ > # [中文]
3988
+ > ### 用途:
3989
+ > - 获取列表unique_id
3990
+ > ### 参数:
3991
+ > - url: 用户主页链接 (最多支持20个链接)
3992
+ > ### 返回:
3993
+ > - unique_id
3994
+ >
3995
+ > # [English]
3996
+ > ### Purpose:
3997
+ > - Get list unique_id
3998
+ > ### Parameters:
3999
+ > - url: User homepage link (Support up to 20 links)
4000
+ > ### Return:
4001
+ > - unique_id
4002
+ >
4003
+ > # [示例/Example]
4004
+ > url = ["https://www.tiktok.com/@tiktok"]
4005
+
4006
+ #### Parameters
4007
+
4008
+ None
4009
+
4010
+ #### Request Body
4011
+
4012
+ - required: Yes
4013
+
4014
+ ##### `application/json`
4015
+
4016
+ - Schema summary: [string]
4017
+
4018
+ | Field | Type | Required | Description | Default | Example | Enum |
4019
+ | --- | --- | --- | --- | --- | --- | --- |
4020
+ | [] | array<string> | Yes | 用户主页链接/User homepage link | None | None | None |
4021
+
4022
+ #### Success Response
4023
+
4024
+ ##### `200 application/json`
4025
+
4026
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
4027
+
4028
+ | Field | Type | Required | Description | Default | Example | Enum |
4029
+ | --- | --- | --- | --- | --- | --- | --- |
4030
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
4031
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
4032
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
4033
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
4034
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
4035
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
4036
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
4037
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
4038
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
4039
+ | 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 |
4040
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
4041
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
4042
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
4043
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
4044
+ | data | null | No | The response data \| 响应数据 | None | None | None |
4045
+
4046
+ <a id="get-api-u1-v1-tiktok-web-get-aweme-id"></a>
4047
+ ### `GET /api/u1/v1/tiktok/web/get_aweme_id`
4048
+
4049
+ - Summary: 提取单个作品id/Extract single video id
4050
+ - Capabilities: general
4051
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
4052
+ - operationId: `get_aweme_id_api_v1_tiktok_web_get_aweme_id_get`
4053
+
4054
+ #### Notes
4055
+
4056
+ > # [中文]
4057
+ > ### 用途:
4058
+ > - 提取单个作品id
4059
+ > ### 参数:
4060
+ > - url: 作品链接
4061
+ > ### 返回:
4062
+ > - 作品id
4063
+ >
4064
+ > # [English]
4065
+ > ### Purpose:
4066
+ > - Extract single video id
4067
+ > ### Parameters:
4068
+ > - url: Video link
4069
+ > ### Return:
4070
+ > - Video id
4071
+ >
4072
+ > # [示例/Example]
4073
+ > url = "https://www.tiktok.com/@owlcitymusic/video/7218694761253735723"
4074
+
4075
+ #### Parameters
4076
+
4077
+ | Field | In | Type | Required | Description | Default | Example | Enum |
4078
+ | --- | --- | --- | --- | --- | --- | --- | --- |
4079
+ | url | query | string | Yes | 作品链接/Video link | None | https://www.tiktok.com/@owlcitymusic/video/7218694761253735723 | None |
4080
+
4081
+ #### Request Body
4082
+
4083
+ None
4084
+
4085
+ #### Success Response
4086
+
4087
+ ##### `200 application/json`
4088
+
4089
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
4090
+
4091
+ | Field | Type | Required | Description | Default | Example | Enum |
4092
+ | --- | --- | --- | --- | --- | --- | --- |
4093
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
4094
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
4095
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
4096
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
4097
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
4098
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
4099
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
4100
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
4101
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
4102
+ | 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 |
4103
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
4104
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
4105
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
4106
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
4107
+ | data | null | No | The response data \| 响应数据 | None | None | None |
4108
+
4109
+ <a id="get-api-u1-v1-tiktok-web-get-live-room-id"></a>
4110
+ ### `GET /api/u1/v1/tiktok/web/get_live_room_id`
4111
+
4112
+ - Summary: 根据直播间链接提取直播间ID/Extract live room ID from live room link
4113
+ - Capabilities: livestream
4114
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
4115
+ - operationId: `get_live_room_id_api_v1_tiktok_web_get_live_room_id_get`
4116
+
4117
+ #### Notes
4118
+
4119
+ > # [中文]
4120
+ > ### 用途:
4121
+ > - 根据直播间链接提取直播间Room ID
4122
+ > - 支持短链接,如:https://vt.tiktok.com/ZSjuyJnWQ/
4123
+ > - 支持长链接,如:https://www.tiktok.com/@maksukaracun/live
4124
+ > ### 参数:
4125
+ > - live_room_url: 直播间链接
4126
+ > ### 返回:
4127
+ > - 直播间Room ID
4128
+ >
4129
+ > # [English]
4130
+ > ### Purpose:
4131
+ > - Extract live room Room ID from live room link
4132
+ > - Support short links, such as: https://vt.tiktok.com/ZSjuyJnWQ/
4133
+ > - Support long links, such as: https://www.tiktok.com/@maksukaracun/live
4134
+ > ### Parameters:
4135
+ > - live_room_url: Live room link
4136
+ > ### Return:
4137
+ > - Live room Room ID
4138
+ >
4139
+ > # [示例/Example]
4140
+ > live_room_url = "https://www.tiktok.com/@maksukaracun/live"
4141
+
4142
+ #### Parameters
4143
+
4144
+ | Field | In | Type | Required | Description | Default | Example | Enum |
4145
+ | --- | --- | --- | --- | --- | --- | --- | --- |
4146
+ | live_room_url | query | string | Yes | 直播间链接/Live room link | None | https://www.tiktok.com/@maksukaracun/live | None |
4147
+
4148
+ #### Request Body
4149
+
4150
+ None
4151
+
4152
+ #### Success Response
4153
+
4154
+ ##### `200 application/json`
4155
+
4156
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
4157
+
4158
+ | Field | Type | Required | Description | Default | Example | Enum |
4159
+ | --- | --- | --- | --- | --- | --- | --- |
4160
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
4161
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
4162
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
4163
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
4164
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
4165
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
4166
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
4167
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
4168
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
4169
+ | 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 |
4170
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
4171
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
4172
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
4173
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
4174
+ | data | null | No | The response data \| 响应数据 | None | None | None |
4175
+
4176
+ <a id="get-api-u1-v1-tiktok-web-get-sec-user-id"></a>
4177
+ ### `GET /api/u1/v1/tiktok/web/get_sec_user_id`
4178
+
4179
+ - Summary: 提取用户sec_user_id/Extract user sec_user_id
4180
+ - Capabilities: profiles / accounts
4181
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
4182
+ - operationId: `get_sec_user_id_api_v1_tiktok_web_get_sec_user_id_get`
4183
+
4184
+ #### Notes
4185
+
4186
+ > # [中文]
4187
+ > ### 用途:
4188
+ > - 提取列表用户id
4189
+ > ### 参数:
4190
+ > - url: 用户主页链接
4191
+ > ### 返回:
4192
+ > - 用户id
4193
+ >
4194
+ > # [English]
4195
+ > ### Purpose:
4196
+ > - Extract list user id
4197
+ > ### Parameters:
4198
+ > - url: User homepage link
4199
+ > ### Return:
4200
+ > - User id
4201
+ >
4202
+ > # [示例/Example]
4203
+ > url = "https://www.tiktok.com/@tiktok"
4204
+
4205
+ #### Parameters
4206
+
4207
+ | Field | In | Type | Required | Description | Default | Example | Enum |
4208
+ | --- | --- | --- | --- | --- | --- | --- | --- |
4209
+ | url | query | string | Yes | 用户主页链接/User homepage link | None | https://www.tiktok.com/@tiktok | None |
4210
+
4211
+ #### Request Body
4212
+
4213
+ None
4214
+
4215
+ #### Success Response
4216
+
4217
+ ##### `200 application/json`
4218
+
4219
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
4220
+
4221
+ | Field | Type | Required | Description | Default | Example | Enum |
4222
+ | --- | --- | --- | --- | --- | --- | --- |
4223
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
4224
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
4225
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
4226
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
4227
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
4228
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
4229
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
4230
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
4231
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
4232
+ | 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 |
4233
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
4234
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
4235
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
4236
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
4237
+ | data | null | No | The response data \| 响应数据 | None | None | None |
4238
+
4239
+ <a id="get-api-u1-v1-tiktok-web-get-unique-id"></a>
4240
+ ### `GET /api/u1/v1/tiktok/web/get_unique_id`
4241
+
4242
+ - Summary: 获取用户unique_id/Get user unique_id
4243
+ - Capabilities: general
4244
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
4245
+ - operationId: `get_unique_id_api_v1_tiktok_web_get_unique_id_get`
4246
+
4247
+ #### Notes
4248
+
4249
+ > # [中文]
4250
+ > ### 用途:
4251
+ > - 获取用户unique_id
4252
+ > ### 参数:
4253
+ > - url: 用户主页链接
4254
+ > ### 返回:
4255
+ > - unique_id
4256
+ >
4257
+ > # [English]
4258
+ > ### Purpose:
4259
+ > - Get user unique_id
4260
+ > ### Parameters:
4261
+ > - url: User homepage link
4262
+ > ### Return:
4263
+ > - unique_id
4264
+ >
4265
+ > # [示例/Example]
4266
+ > url = "https://www.tiktok.com/@tiktok"
4267
+
4268
+ #### Parameters
4269
+
4270
+ | Field | In | Type | Required | Description | Default | Example | Enum |
4271
+ | --- | --- | --- | --- | --- | --- | --- | --- |
4272
+ | url | query | string | Yes | 用户主页链接/User homepage link | None | https://www.tiktok.com/@tiktok | None |
4273
+
4274
+ #### Request Body
4275
+
4276
+ None
4277
+
4278
+ #### Success Response
4279
+
4280
+ ##### `200 application/json`
4281
+
4282
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
4283
+
4284
+ | Field | Type | Required | Description | Default | Example | Enum |
4285
+ | --- | --- | --- | --- | --- | --- | --- |
4286
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
4287
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
4288
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
4289
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
4290
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
4291
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
4292
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
4293
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
4294
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
4295
+ | 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 |
4296
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
4297
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
4298
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
4299
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
4300
+ | data | null | No | The response data \| 响应数据 | None | None | None |
4301
+
4302
+ <a id="get-api-u1-v1-tiktok-web-get-user-id"></a>
4303
+ ### `GET /api/u1/v1/tiktok/web/get_user_id`
4304
+
4305
+ - Summary: 提取用户user_id/Extract user user_id
4306
+ - Capabilities: profiles / accounts
4307
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
4308
+ - operationId: `get_user_id_api_v1_tiktok_web_get_user_id_get`
4309
+
4310
+ #### Notes
4311
+
4312
+ > # [中文]
4313
+ > ### 用途:
4314
+ > - 提取用户user_id
4315
+ > ### 参数:
4316
+ > - url: 用户主页链接
4317
+ > ### 返回:
4318
+ > - 用户id
4319
+ >
4320
+ > # [English]
4321
+ > ### Purpose:
4322
+ > - Extract list user id
4323
+ > ### Parameters:
4324
+ > - url: User homepage link
4325
+ > ### Return:
4326
+ > - User id
4327
+ >
4328
+ > # [示例/Example]
4329
+ > url = "https://www.tiktok.com/@tiktok"
4330
+
4331
+ #### Parameters
4332
+
4333
+ | Field | In | Type | Required | Description | Default | Example | Enum |
4334
+ | --- | --- | --- | --- | --- | --- | --- | --- |
4335
+ | url | query | string | Yes | 用户主页链接/User homepage link | None | https://www.tiktok.com/@tiktok | None |
4336
+
4337
+ #### Request Body
4338
+
4339
+ None
4340
+
4341
+ #### Success Response
4342
+
4343
+ ##### `200 application/json`
4344
+
4345
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
4346
+
4347
+ | Field | Type | Required | Description | Default | Example | Enum |
4348
+ | --- | --- | --- | --- | --- | --- | --- |
4349
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
4350
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
4351
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
4352
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
4353
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
4354
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
4355
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
4356
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
4357
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
4358
+ | 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 |
4359
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
4360
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
4361
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
4362
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
4363
+ | data | null | No | The response data \| 响应数据 | None | None | None |
4364
+
4365
+ <a id="get-api-u1-v1-tiktok-web-tiktok-live-room"></a>
4366
+ ### `GET /api/u1/v1/tiktok/web/tiktok_live_room`
4367
+
4368
+ - Summary: 提取直播间弹幕/Extract live room danmaku
4369
+ - Capabilities: livestream
4370
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
4371
+ - operationId: `tiktok_live_room_api_v1_tiktok_web_tiktok_live_room_get`
4372
+
4373
+ #### Notes
4374
+
4375
+ > # [中文]
4376
+ > ### 用途:
4377
+ > - 提取直播间弹幕
4378
+ > - 该接口已不再提供线上服务,需要自行购买源代码后在本地部署使用,购买源代码请在Discord服务器联系管理员,Discord邀请链接:https://discord.gg/aMEAS8Xsvz
4379
+ > #### 价格:
4380
+ > - 每10条数据消耗0.001$,支持阶梯式计费折扣。
4381
+ > ### 参数:
4382
+ > - live_room_url: 直播间链接
4383
+ > - danmaku_type: 消息类型
4384
+ > - WebcastChatMessage: 聊天消息
4385
+ > - WebcastMemberMessage: 成员消息
4386
+ > - WebcastRoomUserSeqMessage: 用户序列消息
4387
+ > - WebcastGiftMessage: 礼物消息
4388
+ > - WebcastSocialMessage: 社交消息
4389
+ > - WebcastLikeMessage: 点赞消息
4390
+ > - WebcastLinkMicFanTicketMethod: 连麦粉丝票方法
4391
+ > - WebcastLinkMicMethod: 连麦方法
4392
+ > ### 返回:
4393
+ > - 弹幕数据的WebSocket连接信息,需要使用WebSocket连接获取弹幕数据,此接口不返回弹幕数据。
4394
+ >
4395
+ > # [English]
4396
+ > ### Purpose:
4397
+ > - Extract live room danmaku
4398
+ > - This interface is no longer available online, you need to purchase the source code and deploy it locally for use. To purchase the source code, please contact the administrator in the Discord server. Discord invite link: https://discord.gg/aMEAS8Xsvz
4399
+ > #### Price:
4400
+ > - 0.001$ per 10 data, support tiered billing discount.
4401
+ > ### Parameters:
4402
+ > - live_room_url: Live room link
4403
+ > - danmaku_type: Message type
4404
+ > - WebcastChatMessage: Chat message
4405
+ > - WebcastMemberMessage: Member message
4406
+ > - WebcastRoomUserSeqMessage: User sequence message
4407
+ > - WebcastGiftMessage: Gift message
4408
+ > - WebcastSocialMessage: Social message
4409
+ > - WebcastLikeMessage: Like message
4410
+ > - WebcastLinkMicFanTicketMethod: Link Mic Fan Ticket Method
4411
+ > - WebcastLinkMicMethod: Link Mic Method
4412
+ > ### Return:
4413
+ > - WebSocket connection information of the danmaku data, you need to use WebSocket connection to get the danmaku data, this interface does not return the danmaku data.
4414
+
4415
+ #### Parameters
4416
+
4417
+ | Field | In | Type | Required | Description | Default | Example | Enum |
4418
+ | --- | --- | --- | --- | --- | --- | --- | --- |
4419
+ | live_room_url | query | string | Yes | 直播间链接/Live room link | None | https://www.tiktok.com/@mpl.id.official/live | None |
4420
+ | danmaku_type | query | string | Yes | 消息类型/Message type | None | WebcastChatMessage | None |
4421
+
4422
+ #### Request Body
4423
+
4424
+ None
4425
+
4426
+ #### Success Response
4427
+
4428
+ ##### `200 application/json`
4429
+
4430
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
4431
+
4432
+ | Field | Type | Required | Description | Default | Example | Enum |
4433
+ | --- | --- | --- | --- | --- | --- | --- |
4434
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
4435
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
4436
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
4437
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
4438
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
4439
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
4440
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
4441
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
4442
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
4443
+ | 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 |
4444
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
4445
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
4446
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
4447
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
4448
+ | data | null | No | The response data \| 响应数据 | None | None | None |