@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,2025 @@
1
+ # Reddit-APP-API Full Contract
2
+
3
+ - Back to index: [`api-capability-index.md`](../api-capability-index.md)
4
+ - Back to route summary: [`api-tags/reddit-app-api.md`](../api-tags/reddit-app-api.md)
5
+ - Current contract file: `api-contracts/reddit-app-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: `24`
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: **(Reddit APP数据接口/Reddit-APP-API endpoints)**
12
+
13
+ ## Route Contracts
14
+
15
+ <a id="get-api-u1-v1-reddit-app-check-subreddit-muted"></a>
16
+ ### `GET /api/u1/v1/reddit/app/check_subreddit_muted`
17
+
18
+ - Summary: 检查版块是否静音/Check if Subreddit is Muted
19
+ - Capabilities: general
20
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
21
+ - operationId: `check_subreddit_muted_api_v1_reddit_app_check_subreddit_muted_get`
22
+
23
+ #### Notes
24
+
25
+ > # [中文]
26
+ > ### 用途:
27
+ > - 检查指定Reddit版块是否被当前用户静音
28
+ > ### 参数:
29
+ > - subreddit_id: 版块ID,格式为"t5_"开头,可从fetch_subreddit_info接口获取
30
+ > ### 返回:
31
+ > - 静音状态JSON数据,包含:
32
+ > - isMuted: 是否静音的布尔值
33
+ > - subredditId: 版块ID
34
+ > ### 注意:
35
+ > - **APP接口的ID格式与Web接口不同,需要添加类型前缀**
36
+ > - 版块ID前缀: t5_ (例如: t5_2qh0u)
37
+ >
38
+ > # [English]
39
+ > ### Purpose:
40
+ > - Check if a specified Reddit subreddit is muted by the current user
41
+ > ### Parameters:
42
+ > - subreddit_id: Subreddit ID starting with "t5_", can be obtained from fetch_subreddit_info endpoint
43
+ > ### Returns:
44
+ > - JSON data of mute status containing:
45
+ > - isMuted: Boolean value indicating if muted
46
+ > - subredditId: Subreddit ID
47
+ > ### Note:
48
+ > - **APP API ID format differs from Web API, requires type prefix**
49
+ > - Subreddit ID prefix: t5_ (e.g., t5_2qh0u)
50
+ >
51
+ > # [示例/Example]
52
+ > subreddit_id="t5_2qh0u"
53
+
54
+ #### Parameters
55
+
56
+ | Field | In | Type | Required | Description | Default | Example | Enum |
57
+ | --- | --- | --- | --- | --- | --- | --- | --- |
58
+ | subreddit_id | query | string | Yes | 版块ID/Subreddit ID (format: t5_xxxxx) | None | None | None |
59
+ | need_format | query | boolean | No | 是否需要清洗数据/Whether to clean and format the data | false | None | None |
60
+
61
+ #### Request Body
62
+
63
+ None
64
+
65
+ #### Success Response
66
+
67
+ ##### `200 application/json`
68
+
69
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
70
+
71
+ | Field | Type | Required | Description | Default | Example | Enum |
72
+ | --- | --- | --- | --- | --- | --- | --- |
73
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
74
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
75
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
76
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
77
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
78
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
79
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
80
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
81
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
82
+ | 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 |
83
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
84
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
85
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
86
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
87
+ | data | null | No | The response data \| 响应数据 | None | None | None |
88
+
89
+ <a id="get-api-u1-v1-reddit-app-fetch-comment-replies"></a>
90
+ ### `GET /api/u1/v1/reddit/app/fetch_comment_replies`
91
+
92
+ - Summary: 获取Reddit APP评论回复(二级评论)/Fetch Reddit APP Comment Replies (Sub-comments)
93
+ - Capabilities: comments
94
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
95
+ - operationId: `fetch_comment_replies_api_v1_reddit_app_fetch_comment_replies_get`
96
+
97
+ #### Notes
98
+
99
+ > # [中文]
100
+ > ### 用途:
101
+ > - 获取Reddit APP指定评论下的回复(二级评论/子评论)
102
+ > - 当评论节点有 more.cursor 字段时,使用此接口获取该评论的子评论
103
+ > ### 参数:
104
+ > - post_id: 帖子ID,格式如 "t3_XXXXXX"
105
+ > - cursor: 评论游标,从评论数据的 more.cursor 字段获取,格式如 "commenttree:ex:(xxx)"
106
+ > - sort_type: 排序方式,支持CONFIDENCE, NEW, TOP, HOT, CONTROVERSIAL, OLD, RANDOM
107
+ > ### 返回:
108
+ > - 指定评论下的回复JSON数据,包含:
109
+ > - 子评论列表
110
+ > - 每个子评论的详细信息(内容、作者、点赞数等)
111
+ > - 分页信息
112
+ > ### 使用步骤:
113
+ > 1. 先调用 fetch_post_comments 获取帖子的一级评论
114
+ > 2. 在返回数据中找到有子评论的节点(childCount > 0)
115
+ > 3. 获取该节点的 more.cursor 值
116
+ > 4. 使用该 cursor 调用本接口获取子评论
117
+ > ### 注意:
118
+ > - cursor 值来自评论数据的 more.cursor 字段
119
+ > - 路径示例: $.data.postInfoById.commentForest.trees[*].more.cursor
120
+ > - cursor 格式类似: "commenttree:ex:(RjiJd"
121
+ >
122
+ > # [English]
123
+ > ### Purpose:
124
+ > - Fetch replies (sub-comments/second-level comments) under a specified Reddit APP comment
125
+ > - Use this endpoint when a comment node has more.cursor field to get its sub-comments
126
+ > ### Parameters:
127
+ > - post_id: Post ID, format like "t3_XXXXXX"
128
+ > - cursor: Comment cursor from the more.cursor field in comment data, format like "commenttree:ex:(xxx)"
129
+ > - sort_type: Sort method, supports CONFIDENCE, NEW, TOP, HOT, CONTROVERSIAL, OLD, RANDOM
130
+ > ### Returns:
131
+ > - JSON data of replies under the specified comment, containing:
132
+ > - List of sub-comments
133
+ > - Detailed information for each sub-comment (content, author, upvotes, etc.)
134
+ > - Pagination information
135
+ > ### Usage Steps:
136
+ > 1. First call fetch_post_comments to get top-level comments
137
+ > 2. Find comment nodes with sub-comments (childCount > 0)
138
+ > 3. Get the more.cursor value from that node
139
+ > 4. Use that cursor to call this endpoint to fetch sub-comments
140
+ > ### Note:
141
+ > - cursor value comes from the more.cursor field in comment data
142
+ > - Path example: $.data.postInfoById.commentForest.trees[*].more.cursor
143
+ > - cursor format example: "commenttree:ex:(RjiJd"
144
+ >
145
+ > # [示例/Example]
146
+ > post_id="t3_1qmup73"
147
+ > cursor="commenttree:ex:(RjiJd"
148
+ > sort_type="CONFIDENCE"
149
+
150
+ #### Parameters
151
+
152
+ | Field | In | Type | Required | Description | Default | Example | Enum |
153
+ | --- | --- | --- | --- | --- | --- | --- | --- |
154
+ | post_id | query | string | Yes | 帖子ID/Post ID (e.g., t3_1qmup73) | None | None | None |
155
+ | cursor | query | string | Yes | 评论游标/Comment cursor from more.cursor field (e.g., commenttree:ex:(RjiJd) | None | None | None |
156
+ | sort_type | query | string | No | 排序方式/Sort method: CONFIDENCE, NEW, TOP, HOT, CONTROVERSIAL, OLD, RANDOM | CONFIDENCE | None | None |
157
+ | need_format | query | boolean | No | 是否需要清洗数据/Whether to clean and format the data | false | None | None |
158
+
159
+ #### Request Body
160
+
161
+ None
162
+
163
+ #### Success Response
164
+
165
+ ##### `200 application/json`
166
+
167
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
168
+
169
+ | Field | Type | Required | Description | Default | Example | Enum |
170
+ | --- | --- | --- | --- | --- | --- | --- |
171
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
172
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
173
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
174
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
175
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
176
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
177
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
178
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
179
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
180
+ | 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 |
181
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
182
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
183
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
184
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
185
+ | data | null | No | The response data \| 响应数据 | None | None | None |
186
+
187
+ <a id="get-api-u1-v1-reddit-app-fetch-community-highlights"></a>
188
+ ### `GET /api/u1/v1/reddit/app/fetch_community_highlights`
189
+
190
+ - Summary: 获取Reddit APP社区亮点/Fetch Reddit APP Community Highlights
191
+ - Capabilities: general
192
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
193
+ - operationId: `fetch_community_highlights_api_v1_reddit_app_fetch_community_highlights_get`
194
+
195
+ #### Notes
196
+
197
+ > # [中文]
198
+ > ### 用途:
199
+ > - 获取Reddit APP指定社区的精选亮点内容,包括热门帖子和重要公告
200
+ > ### 参数:
201
+ > - subreddit_id: 版块ID,格式为"t5_"开头,可从fetch_subreddit_info接口获取
202
+ > ### 返回:
203
+ > - 社区亮点JSON数据,包含:
204
+ > - 精选帖子列表
205
+ > - 置顶公告
206
+ > - 社区重要动态
207
+ > - 推荐内容
208
+ > ### 注意:
209
+ > - **APP接口的ID格式与Web接口不同,需要添加类型前缀**
210
+ > - 版块ID前缀: t5_ (例如: t5_2qh0u)
211
+ >
212
+ > # [English]
213
+ > ### Purpose:
214
+ > - Fetch featured highlight content of a specified Reddit APP community, including popular posts and important announcements
215
+ > ### Parameters:
216
+ > - subreddit_id: Subreddit ID starting with "t5_", can be obtained from fetch_subreddit_info endpoint
217
+ > ### Returns:
218
+ > - JSON data of community highlights containing:
219
+ > - Featured post list
220
+ > - Pinned announcements
221
+ > - Important community updates
222
+ > - Recommended content
223
+ > ### Note:
224
+ > - **APP API ID format differs from Web API, requires type prefix**
225
+ > - Subreddit ID prefix: t5_ (e.g., t5_2qh0u)
226
+ >
227
+ > # [示例/Example]
228
+ > subreddit_id="t5_2qh0u"
229
+
230
+ #### Parameters
231
+
232
+ | Field | In | Type | Required | Description | Default | Example | Enum |
233
+ | --- | --- | --- | --- | --- | --- | --- | --- |
234
+ | subreddit_id | query | string | Yes | 版块ID/Subreddit ID (format: t5_xxxxx) | None | None | None |
235
+ | need_format | query | boolean | No | 是否需要清洗数据/Whether to clean and format the data | false | None | None |
236
+
237
+ #### Request Body
238
+
239
+ None
240
+
241
+ #### Success Response
242
+
243
+ ##### `200 application/json`
244
+
245
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
246
+
247
+ | Field | Type | Required | Description | Default | Example | Enum |
248
+ | --- | --- | --- | --- | --- | --- | --- |
249
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
250
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
251
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
252
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
253
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
254
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
255
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
256
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
257
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
258
+ | 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 |
259
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
260
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
261
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
262
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
263
+ | data | null | No | The response data \| 响应数据 | None | None | None |
264
+
265
+ <a id="get-api-u1-v1-reddit-app-fetch-dynamic-search"></a>
266
+ ### `GET /api/u1/v1/reddit/app/fetch_dynamic_search`
267
+
268
+ - Summary: 获取Reddit APP动态搜索结果/Fetch Reddit APP Dynamic Search Results
269
+ - Capabilities: search
270
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
271
+ - operationId: `fetch_dynamic_search_api_v1_reddit_app_fetch_dynamic_search_get`
272
+
273
+ #### Notes
274
+
275
+ > # [中文]
276
+ > ### 用途:
277
+ > - 执行Reddit APP动态搜索,支持搜索帖子、社区、评论、媒体和用户
278
+ > ### 参数:
279
+ > - query: 搜索关键词
280
+ > - search_type: 搜索类型,可选值:
281
+ > - post: 搜索帖子(默认)
282
+ > - community: 搜索社区/版块
283
+ > - comment: 搜索评论
284
+ > - media: 搜索媒体(图片/视频/GIF)
285
+ > - people: 搜索用户
286
+ > - sort: 排序方式(仅适用于post/comment/media类型),可选值:
287
+ > - RELEVANCE: 相关性
288
+ > - HOT: 热门
289
+ > - TOP: 最受欢迎
290
+ > - NEW: 最新
291
+ > - COMMENTS: 评论数(仅适用于post类型)
292
+ > - time_range: 时间范围(仅适用于post/media类型),可选值:
293
+ > - all: 所有时间
294
+ > - year: 去年
295
+ > - month: 上个月
296
+ > - week: 上周
297
+ > - day: 今天
298
+ > - hour: 过去1小时
299
+ > - safe_search: 安全搜索设置,"unset"或"strict"
300
+ > - allow_nsfw: 是否允许NSFW内容,"0"或"1"
301
+ > - after: 分页参数,用于获取下一页结果
302
+ > ### 返回:
303
+ > - 搜索结果JSON数据,包含:
304
+ > - 匹配的结果列表(根据search_type不同返回不同类型的数据)
305
+ > - 分页信息
306
+ > ### 注意:
307
+ > - community和people类型不支持sort和time_range参数
308
+ > - COMMENTS排序方式仅适用于post类型
309
+ > - time_range参数仅适用于post和media类型
310
+ >
311
+ > # [English]
312
+ > ### Purpose:
313
+ > - Perform Reddit APP dynamic search, supporting posts, communities, comments, media, and users
314
+ > ### Parameters:
315
+ > - query: Search keyword
316
+ > - search_type: Search type, options:
317
+ > - post: Search posts (default)
318
+ > - community: Search communities/subreddits
319
+ > - comment: Search comments
320
+ > - media: Search media (images/videos/GIFs)
321
+ > - people: Search users
322
+ > - sort: Sort method (only for post/comment/media types), options:
323
+ > - RELEVANCE: By relevance
324
+ > - HOT: Hot/trending
325
+ > - TOP: Most popular
326
+ > - NEW: Newest
327
+ > - COMMENTS: By comment count (only for post type)
328
+ > - time_range: Time range (only for post/media types), options:
329
+ > - all: All time
330
+ > - year: Past year
331
+ > - month: Past month
332
+ > - week: Past week
333
+ > - day: Today
334
+ > - hour: Past hour
335
+ > - safe_search: Safe search setting, "unset" or "strict"
336
+ > - allow_nsfw: Allow NSFW content, "0" or "1"
337
+ > - after: Pagination parameter for fetching next page
338
+ > ### Returns:
339
+ > - JSON data of search results containing:
340
+ > - List of matching results (different data types based on search_type)
341
+ > - Pagination information
342
+ > ### Notes:
343
+ > - community and people types do not support sort and time_range parameters
344
+ > - COMMENTS sort option only applies to post type
345
+ > - time_range parameter only applies to post and media types
346
+ >
347
+ > # [示例/Example]
348
+ > query="python programming"
349
+ > search_type="post"
350
+ > sort="RELEVANCE"
351
+ > time_range="all"
352
+ > safe_search="unset"
353
+ > allow_nsfw="0"
354
+ > after=""
355
+
356
+ #### Parameters
357
+
358
+ | Field | In | Type | Required | Description | Default | Example | Enum |
359
+ | --- | --- | --- | --- | --- | --- | --- | --- |
360
+ | query | query | string | Yes | 搜索关键词/Search query | None | None | None |
361
+ | search_type | query | string | No | 搜索类型/Search type: post(帖子), community(社区), comment(评论), media(媒体), people(用户) | post | None | None |
362
+ | sort | query | string | No | 排序方式(仅适用于post/comment/media)/Sort method (only for post/comment/media): RELEVANCE(相关性), HOT(热门), TOP(最受欢迎), NEW(最新), COMMENTS(评论数,仅post) | None | None | None |
363
+ | time_range | query | string | No | 时间范围(仅适用于post/media)/Time range (only for post/media): all(所有时间), year(去年), month(上月), week(上周), day(今天), hour(过去1小时) | None | None | None |
364
+ | safe_search | query | string | No | 安全搜索设置/Safe search setting: unset, strict | unset | None | None |
365
+ | allow_nsfw | query | string | No | 是否允许NSFW内容/Allow NSFW content: 0, 1 | 0 | None | None |
366
+ | after | query | string | No | 分页参数/Pagination parameter | None | None | None |
367
+ | need_format | query | boolean | No | 是否需要清洗数据/Whether to clean and format the data | false | None | None |
368
+
369
+ #### Request Body
370
+
371
+ None
372
+
373
+ #### Success Response
374
+
375
+ ##### `200 application/json`
376
+
377
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
378
+
379
+ | Field | Type | Required | Description | Default | Example | Enum |
380
+ | --- | --- | --- | --- | --- | --- | --- |
381
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
382
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
383
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
384
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
385
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
386
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
387
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
388
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
389
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
390
+ | 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 |
391
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
392
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
393
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
394
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
395
+ | data | null | No | The response data \| 响应数据 | None | None | None |
396
+
397
+ <a id="get-api-u1-v1-reddit-app-fetch-games-feed"></a>
398
+ ### `GET /api/u1/v1/reddit/app/fetch_games_feed`
399
+
400
+ - Summary: 获取Reddit APP游戏推荐内容/Fetch Reddit APP Games Feed
401
+ - Capabilities: general
402
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
403
+ - operationId: `fetch_games_feed_api_v1_reddit_app_fetch_games_feed_get`
404
+
405
+ #### Notes
406
+
407
+ > # [中文]
408
+ > ### 用途:
409
+ > - 获取Reddit APP游戏相关的推荐内容,展示游戏社区的热门帖子
410
+ > ### 参数:
411
+ > - sort: 排序方式,可选: NEW(最新), HOT(热门), TOP(顶级), RISING(上升中)
412
+ > - time: 时间范围,可选: ALL(全部时间), HOUR(一小时), DAY(一天), WEEK(一周), MONTH(一个月), YEAR(一年)
413
+ > - after: 分页参数,获取下一页时使用
414
+ > ### 返回:
415
+ > - 游戏推荐内容JSON数据,包含:
416
+ > - 游戏相关帖子列表
417
+ > - 游戏社区讨论
418
+ > - 游戏新闻和更新
419
+ >
420
+ > # [English]
421
+ > ### Purpose:
422
+ > - Fetch gaming-related recommended content on Reddit APP, displaying popular posts from gaming communities
423
+ > ### Parameters:
424
+ > - sort: Sort method, options: NEW, HOT, TOP, RISING
425
+ > - time: Time range, options: ALL, HOUR, DAY, WEEK, MONTH, YEAR
426
+ > - after: Pagination parameter for fetching next page
427
+ > ### Returns:
428
+ > - JSON data of games feed containing:
429
+ > - List of gaming-related posts
430
+ > - Gaming community discussions
431
+ > - Game news and updates
432
+ >
433
+ > # [示例/Example]
434
+ > sort="HOT"
435
+ > time="WEEK"
436
+ > after=""
437
+
438
+ #### Parameters
439
+
440
+ | Field | In | Type | Required | Description | Default | Example | Enum |
441
+ | --- | --- | --- | --- | --- | --- | --- | --- |
442
+ | sort | query | string | No | 排序方式/Sort method: NEW, HOT, TOP, RISING | NEW | None | None |
443
+ | time | query | string | No | 时间范围/Time range: ALL, HOUR, DAY, WEEK, MONTH, YEAR | ALL | None | None |
444
+ | after | query | string | No | 分页参数/Pagination parameter | None | None | None |
445
+ | need_format | query | boolean | No | 是否需要清洗数据/Whether to clean and format the data | false | None | None |
446
+
447
+ #### Request Body
448
+
449
+ None
450
+
451
+ #### Success Response
452
+
453
+ ##### `200 application/json`
454
+
455
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
456
+
457
+ | Field | Type | Required | Description | Default | Example | Enum |
458
+ | --- | --- | --- | --- | --- | --- | --- |
459
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
460
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
461
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
462
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
463
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
464
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
465
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
466
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
467
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
468
+ | 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 |
469
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
470
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
471
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
472
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
473
+ | data | null | No | The response data \| 响应数据 | None | None | None |
474
+
475
+ <a id="get-api-u1-v1-reddit-app-fetch-home-feed"></a>
476
+ ### `GET /api/u1/v1/reddit/app/fetch_home_feed`
477
+
478
+ - Summary: 获取Reddit APP首页推荐内容/Fetch Reddit APP Home Feed
479
+ - Capabilities: profiles / accounts
480
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
481
+ - operationId: `fetch_home_feed_api_v1_reddit_app_fetch_home_feed_get`
482
+
483
+ #### Notes
484
+
485
+ > # [中文]
486
+ > ### 用途:
487
+ > - 获取Reddit APP首页推荐内容
488
+ > ### 参数:
489
+ > - sort: 排序方式,支持HOT, NEW, TOP, BEST, CONTROVERSIAL
490
+ > - filter_posts: 过滤掉指定的帖子ID列表,用于排除已获取的帖子,避免重复获取
491
+ > - after: 分页参数,获取下一页时使用
492
+ > ### 返回:
493
+ > - Reddit APP首页推荐内容的JSON数据
494
+ >
495
+ > # [English]
496
+ > ### Purpose:
497
+ > - Fetch Reddit APP home feed content
498
+ > ### Parameters:
499
+ > - sort: Sort method, supports HOT, NEW, TOP, BEST, CONTROVERSIAL
500
+ > - filter_posts: List of post IDs to filter out, used to exclude already fetched posts
501
+ > - after: Pagination parameter for fetching the next page
502
+ > ### Returns:
503
+ > - JSON data of Reddit APP home feed content
504
+ >
505
+ > # [示例/Example]
506
+ > sort="BEST"
507
+ >
508
+ > filter_posts=["t3_1ojjquz","t3_1ohepm2","t3_1ojxzzz","t3_1ojnvca","t3_1oj9dcb","t3_1ojxubp","t3_1oj5x2b"]
509
+ >
510
+ > after="dDNfMW9qNXgyYg=="
511
+
512
+ #### Parameters
513
+
514
+ | Field | In | Type | Required | Description | Default | Example | Enum |
515
+ | --- | --- | --- | --- | --- | --- | --- | --- |
516
+ | sort | query | string | No | 排序方式/Sort method: HOT, NEW, TOP, BEST, CONTROVERSIAL | BEST | None | None |
517
+ | filter_posts | query | array<Not declared> | No | 过滤掉指定的帖子ID列表/Filter out specified post IDs | None | None | None |
518
+ | after | query | string | No | 分页参数/Pagination parameter for fetching next page | None | None | None |
519
+ | need_format | query | boolean | No | 是否需要清洗数据/Whether to clean and format the data | false | None | None |
520
+
521
+ #### Request Body
522
+
523
+ None
524
+
525
+ #### Success Response
526
+
527
+ ##### `200 application/json`
528
+
529
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
530
+
531
+ | Field | Type | Required | Description | Default | Example | Enum |
532
+ | --- | --- | --- | --- | --- | --- | --- |
533
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
534
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
535
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
536
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
537
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
538
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
539
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
540
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
541
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
542
+ | 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 |
543
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
544
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
545
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
546
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
547
+ | data | null | No | The response data \| 响应数据 | None | None | None |
548
+
549
+ <a id="get-api-u1-v1-reddit-app-fetch-news-feed"></a>
550
+ ### `GET /api/u1/v1/reddit/app/fetch_news_feed`
551
+
552
+ - Summary: 获取Reddit APP资讯推荐内容/Fetch Reddit APP News Feed
553
+ - Capabilities: general
554
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
555
+ - operationId: `fetch_news_feed_api_v1_reddit_app_fetch_news_feed_get`
556
+
557
+ #### Notes
558
+
559
+ > # [中文]
560
+ > ### 用途:
561
+ > - 获取Reddit APP新闻资讯推荐内容,展示最新的新闻和时事讨论
562
+ > ### 参数:
563
+ > - subtopic_ids: 子话题ID列表,默认["all"]表示所有新闻类别
564
+ > - after: 分页参数,获取下一页时使用
565
+ > ### 返回:
566
+ > - 新闻推荐内容JSON数据,包含:
567
+ > - 新闻帖子列表
568
+ > - 时事讨论
569
+ > - 热点话题
570
+ > - 新闻来源和链接
571
+ >
572
+ > # [English]
573
+ > ### Purpose:
574
+ > - Fetch news-related recommended content on Reddit APP, displaying latest news and current affairs discussions
575
+ > ### Parameters:
576
+ > - subtopic_ids: List of subtopic IDs, default ["all"] means all news categories
577
+ > - after: Pagination parameter for fetching next page
578
+ > ### Returns:
579
+ > - JSON data of news feed containing:
580
+ > - List of news posts
581
+ > - Current affairs discussions
582
+ > - Trending topics
583
+ > - News sources and links
584
+ >
585
+ > # [示例/Example]
586
+ > subtopic_ids=["all"]
587
+ > after=""
588
+
589
+ #### Parameters
590
+
591
+ | Field | In | Type | Required | Description | Default | Example | Enum |
592
+ | --- | --- | --- | --- | --- | --- | --- | --- |
593
+ | subtopic_ids | query | array<Not declared> | No | 子话题ID列表/Subtopic IDs list | ["all"] | None | None |
594
+ | after | query | string | No | 分页参数/Pagination parameter | None | None | None |
595
+ | need_format | query | boolean | No | 是否需要清洗数据/Whether to clean and format the data | false | None | None |
596
+
597
+ #### Request Body
598
+
599
+ None
600
+
601
+ #### Success Response
602
+
603
+ ##### `200 application/json`
604
+
605
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
606
+
607
+ | Field | Type | Required | Description | Default | Example | Enum |
608
+ | --- | --- | --- | --- | --- | --- | --- |
609
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
610
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
611
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
612
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
613
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
614
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
615
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
616
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
617
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
618
+ | 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 |
619
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
620
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
621
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
622
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
623
+ | data | null | No | The response data \| 响应数据 | None | None | None |
624
+
625
+ <a id="get-api-u1-v1-reddit-app-fetch-popular-feed"></a>
626
+ ### `GET /api/u1/v1/reddit/app/fetch_popular_feed`
627
+
628
+ - Summary: 获取Reddit APP流行推荐内容/Fetch Reddit APP Popular Feed
629
+ - Capabilities: general
630
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
631
+ - operationId: `fetch_popular_feed_api_v1_reddit_app_fetch_popular_feed_get`
632
+
633
+ #### Notes
634
+
635
+ > # [中文]
636
+ > ### 用途:
637
+ > - 获取Reddit APP流行/热门推荐内容,展示全站最受欢迎的帖子
638
+ > ### 参数:
639
+ > - sort: 排序方式,可选: BEST(最佳), HOT(热门), NEW(最新), TOP(顶级), CONTROVERSIAL(有争议), RISING(上升中)
640
+ > - time: 时间范围,可选: ALL(全部时间), HOUR(一小时), DAY(一天), WEEK(一周), MONTH(一个月), YEAR(一年)
641
+ > - filter_posts: 过滤掉指定的帖子ID列表,用于避免重复获取
642
+ > - after: 分页参数,获取下一页时使用
643
+ > ### 返回:
644
+ > - 流行推荐内容JSON数据,包含:
645
+ > - 热门帖子列表
646
+ > - 帖子详细信息(标题、内容、点赞数、评论数等)
647
+ > - 分页信息(after参数用于下一页)
648
+ >
649
+ > # [English]
650
+ > ### Purpose:
651
+ > - Fetch popular/trending recommended content on Reddit APP, displaying the most popular posts site-wide
652
+ > ### Parameters:
653
+ > - sort: Sort method, options: BEST, HOT, NEW, TOP, CONTROVERSIAL, RISING
654
+ > - time: Time range, options: ALL, HOUR, DAY, WEEK, MONTH, YEAR
655
+ > - filter_posts: List of post IDs to filter out, used to avoid duplicate fetches
656
+ > - after: Pagination parameter for fetching next page
657
+ > ### Returns:
658
+ > - JSON data of popular feed containing:
659
+ > - List of trending posts
660
+ > - Detailed post information (title, content, upvotes, comments, etc.)
661
+ > - Pagination information (after parameter for next page)
662
+ >
663
+ > # [示例/Example]
664
+ > sort="HOT"
665
+ > time="DAY"
666
+ > filter_posts=[]
667
+ > after=""
668
+
669
+ #### Parameters
670
+
671
+ | Field | In | Type | Required | Description | Default | Example | Enum |
672
+ | --- | --- | --- | --- | --- | --- | --- | --- |
673
+ | sort | query | string | No | 排序方式/Sort method: BEST, HOT, NEW, TOP, CONTROVERSIAL, RISING | BEST | None | None |
674
+ | time | query | string | No | 时间范围/Time range: ALL, HOUR, DAY, WEEK, MONTH, YEAR | ALL | None | None |
675
+ | filter_posts | query | array<Not declared> | No | 过滤帖子ID列表/Filter post IDs | None | None | None |
676
+ | after | query | string | No | 分页参数/Pagination parameter | None | None | None |
677
+ | need_format | query | boolean | No | 是否需要清洗数据/Whether to clean and format the data | false | None | None |
678
+
679
+ #### Request Body
680
+
681
+ None
682
+
683
+ #### Success Response
684
+
685
+ ##### `200 application/json`
686
+
687
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
688
+
689
+ | Field | Type | Required | Description | Default | Example | Enum |
690
+ | --- | --- | --- | --- | --- | --- | --- |
691
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
692
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
693
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
694
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
695
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
696
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
697
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
698
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
699
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
700
+ | 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 |
701
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
702
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
703
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
704
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
705
+ | data | null | No | The response data \| 响应数据 | None | None | None |
706
+
707
+ <a id="get-api-u1-v1-reddit-app-fetch-post-comments"></a>
708
+ ### `GET /api/u1/v1/reddit/app/fetch_post_comments`
709
+
710
+ - Summary: 获取Reddit APP帖子评论/Fetch Reddit APP Post Comments
711
+ - Capabilities: comments / content details
712
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
713
+ - operationId: `fetch_post_comments_api_v1_reddit_app_fetch_post_comments_get`
714
+
715
+ #### Notes
716
+
717
+ > # [中文]
718
+ > ### 用途:
719
+ > - 获取Reddit APP指定帖子下的评论
720
+ > ### 参数:
721
+ > - post_id: 帖子ID,格式如 "t3_XXXXXX"
722
+ > - sort_type: 排序方式,支持CONFIDENCE, NEW, TOP, HOT, CONTROVERSIAL, OLD, RANDOM
723
+ > - after: 分页参数,获取下一页时使用,在commentForest里的最后一个评论节点中可以找到,例如$.data.postInfoById.commentForest.trees[-1].more.cursor
724
+ > ### 返回:
725
+ > - 指定帖子下的评论JSON数据
726
+ > ### 注意:
727
+ > - **APP接口的ID格式与Web接口不同,需要添加类型前缀**
728
+ > - 帖子ID前缀: t3_ (例如: t3_1ojnvca)
729
+ >
730
+ > # [English]
731
+ > ### Purpose:
732
+ > - Fetch comments under a specified Reddit APP post
733
+ > ### Parameters:
734
+ > - post_id: Post ID, format like "t3_XXXXXX"
735
+ > - sort_type: Sort method, supports HOT, NEW, TOP, BEST, CONTROVERSIAL
736
+ > - after: Pagination parameter for fetching the next page, can be found in the last comment node in commentForest, e.g., $.data.postInfoById.commentForest.trees[-1].more.cursor
737
+ > ### Returns:
738
+ > - JSON data of comments under the specified post
739
+ > ### Note:
740
+ > - **APP API ID format differs from Web API, requires type prefix**
741
+ > - Post ID prefix: t3_ (e.g., t3_1ojnvca)
742
+ >
743
+ > # [示例/Example]
744
+ > post_id="t3_1ojnvca"
745
+ >
746
+ > sort="CONFIDENCE"
747
+
748
+ #### Parameters
749
+
750
+ | Field | In | Type | Required | Description | Default | Example | Enum |
751
+ | --- | --- | --- | --- | --- | --- | --- | --- |
752
+ | post_id | query | string | Yes | 帖子ID/Post ID | None | None | None |
753
+ | sort_type | query | string | No | 排序方式/Sort method: CONFIDENCE, NEW, TOP, HOT, CONTROVERSIAL, OLD, RANDOM | CONFIDENCE | None | None |
754
+ | after | query | string | No | 分页参数/Pagination parameter for fetching next page | None | None | None |
755
+ | need_format | query | boolean | No | 是否需要清洗数据/Whether to clean and format the data | false | None | None |
756
+
757
+ #### Request Body
758
+
759
+ None
760
+
761
+ #### Success Response
762
+
763
+ ##### `200 application/json`
764
+
765
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
766
+
767
+ | Field | Type | Required | Description | Default | Example | Enum |
768
+ | --- | --- | --- | --- | --- | --- | --- |
769
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
770
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
771
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
772
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
773
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
774
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
775
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
776
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
777
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
778
+ | 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 |
779
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
780
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
781
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
782
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
783
+ | data | null | No | The response data \| 响应数据 | None | None | None |
784
+
785
+ <a id="get-api-u1-v1-reddit-app-fetch-post-details"></a>
786
+ ### `GET /api/u1/v1/reddit/app/fetch_post_details`
787
+
788
+ - Summary: 获取单个Reddit帖子详情/Fetch Single Reddit Post Details
789
+ - Capabilities: content details / details
790
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
791
+ - operationId: `fetch_post_details_api_v1_reddit_app_fetch_post_details_get`
792
+
793
+ #### Notes
794
+
795
+ > # [中文]
796
+ > ## 用途:
797
+ > - 根据帖子ID获取单个帖子详情
798
+ > - 可选择性包含特定评论的上下文
799
+ >
800
+ > ## 参数:
801
+ > - post_id: 帖子ID,格式如 "t3_XXXXXX"
802
+ > - include_comment_id: 是否包含特定评论ID,默认False
803
+ > - comment_id: 评论ID(当include_comment_id为True时使用),格式如 "t1_XXXXXX"
804
+ >
805
+ > ## 返回:
806
+ > - 包含帖子详细信息的数据,包括:
807
+ > - 帖子内容、标题、作者
808
+ > - 统计数据(点赞数、评论数等)
809
+ > - 版块信息
810
+ > - 奖励信息
811
+ > - 媒体资源
812
+ > - 推荐原因等
813
+ >
814
+ > ## 注意:
815
+ > - **APP接口的ID格式与Web接口不同,需要添加类型前缀**
816
+ > - 帖子ID前缀: t3_ (例如: t3_1ojnh50)
817
+ > - 评论ID前缀: t1_ (例如: t1_abcd123)
818
+ >
819
+ > ---
820
+ >
821
+ > # [English]
822
+ > ## Purpose:
823
+ > - Fetch single post details by post ID
824
+ > - Optionally include context for specific comments
825
+ >
826
+ > ## Parameters:
827
+ > - post_id: Post ID, format like "t3_XXXXXX"
828
+ > - include_comment_id: Whether to include specific comment ID, default False
829
+ > - comment_id: Comment ID (used when include_comment_id is True), format like "t1_XXXXXX"
830
+ >
831
+ > ## Returns:
832
+ > - Data containing detailed post information including:
833
+ > - Post content, title, author
834
+ > - Statistics (upvotes, comment count, etc.)
835
+ > - Subreddit information
836
+ > - Award information
837
+ > - Media resources
838
+ > - Recommendation reasons, etc.
839
+ >
840
+ > ## Note:
841
+ > - **APP API ID format differs from Web API, requires type prefix**
842
+ > - Post ID prefix: t3_ (e.g., t3_1ojnh50)
843
+ > - Comment ID prefix: t1_ (e.g., t1_abcd123)
844
+ >
845
+ > # [示例/Example]
846
+ > post_id="t3_1ojnh50"
847
+
848
+ #### Parameters
849
+
850
+ | Field | In | Type | Required | Description | Default | Example | Enum |
851
+ | --- | --- | --- | --- | --- | --- | --- | --- |
852
+ | post_id | query | string | Yes | 帖子ID/Post ID (e.g., t3_1ojnh50) | None | None | None |
853
+ | include_comment_id | query | boolean | No | 是否包含特定评论ID/Include specific comment ID | false | None | None |
854
+ | comment_id | query | string | No | 评论ID/Comment ID (when include_comment_id is True) | None | None | None |
855
+ | need_format | query | boolean | No | 是否需要清洗数据/Whether to clean and format the data | false | None | None |
856
+
857
+ #### Request Body
858
+
859
+ None
860
+
861
+ #### Success Response
862
+
863
+ ##### `200 application/json`
864
+
865
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
866
+
867
+ | Field | Type | Required | Description | Default | Example | Enum |
868
+ | --- | --- | --- | --- | --- | --- | --- |
869
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
870
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
871
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
872
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
873
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
874
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
875
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
876
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
877
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
878
+ | 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 |
879
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
880
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
881
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
882
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
883
+ | data | null | No | The response data \| 响应数据 | None | None | None |
884
+
885
+ <a id="get-api-u1-v1-reddit-app-fetch-post-details-batch"></a>
886
+ ### `GET /api/u1/v1/reddit/app/fetch_post_details_batch`
887
+
888
+ - Summary: 批量获取Reddit帖子详情(最多5条)/Fetch Reddit Post Details in Batch (Max 5)
889
+ - Capabilities: content details / details
890
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
891
+ - operationId: `fetch_post_details_batch_api_v1_reddit_app_fetch_post_details_batch_get`
892
+
893
+ #### Notes
894
+
895
+ > # [中文]
896
+ > ## 用途:
897
+ > - 根据帖子ID列表批量获取帖子详情
898
+ > - 支持最多5条帖子的批量查询
899
+ > - 可选择性包含特定评论的上下文
900
+ >
901
+ > ## 参数:
902
+ > - post_ids: 帖子ID列表,逗号分隔,格式如 "t3_XXXXXX,t3_YYYYYY",最多支持5条
903
+ > - include_comment_id: 是否包含特定评论ID,默认False
904
+ > - comment_id: 评论ID(当include_comment_id为True时使用),格式如 "t1_XXXXXX"
905
+ >
906
+ > ## 返回:
907
+ > - 包含帖子详细信息的数据,包括:
908
+ > - 帖子内容、标题、作者
909
+ > - 统计数据(点赞数、评论数等)
910
+ > - 版块信息
911
+ > - 奖励信息
912
+ > - 媒体资源
913
+ > - 推荐原因等
914
+ >
915
+ > ## 注意:
916
+ > - 最多支持5条帖子的批量查询
917
+ > - 超过5条将返回错误
918
+ > - **APP接口的ID格式与Web接口不同,需要添加类型前缀**
919
+ > - 帖子ID前缀: t3_ (例如: t3_1ojnh50)
920
+ > - 评论ID前缀: t1_ (例如: t1_abcd123)
921
+ >
922
+ > ---
923
+ >
924
+ > # [English]
925
+ > ## Purpose:
926
+ > - Fetch post details in batch by post ID list
927
+ > - Support batch query for up to 5 posts
928
+ > - Optionally include context for specific comments
929
+ >
930
+ > ## Parameters:
931
+ > - post_ids: Post IDs comma-separated, format like "t3_XXXXXX,t3_YYYYYY", max 5 posts
932
+ > - include_comment_id: Whether to include specific comment ID, default False
933
+ > - comment_id: Comment ID (used when include_comment_id is True), format like "t1_XXXXXX"
934
+ >
935
+ > ## Returns:
936
+ > - Data containing detailed post information including:
937
+ > - Post content, title, author
938
+ > - Statistics (upvotes, comment count, etc.)
939
+ > - Subreddit information
940
+ > - Award information
941
+ > - Media resources
942
+ > - Recommendation reasons, etc.
943
+ >
944
+ > ## Notes:
945
+ > - Maximum 5 posts per batch query
946
+ > - Error will be returned if exceeds 5 posts
947
+ > - **APP API ID format differs from Web API, requires type prefix**
948
+ > - Post ID prefix: t3_ (e.g., t3_1ojnh50)
949
+ > - Comment ID prefix: t1_ (e.g., t1_abcd123)
950
+ >
951
+ > # [示例/Example]
952
+ > post_ids="t3_1ojnh50,t3_1ok432f,t3_1nwil8j"
953
+
954
+ #### Parameters
955
+
956
+ | Field | In | Type | Required | Description | Default | Example | Enum |
957
+ | --- | --- | --- | --- | --- | --- | --- | --- |
958
+ | post_ids | query | string | Yes | 帖子ID列表,逗号分隔,最多5条/Post IDs comma-separated, max 5 (e.g., t3_1ojnh50,t3_1ok432f) | None | None | None |
959
+ | include_comment_id | query | boolean | No | 是否包含特定评论ID/Include specific comment ID | false | None | None |
960
+ | comment_id | query | string | No | 评论ID/Comment ID (when include_comment_id is True) | None | None | None |
961
+ | need_format | query | boolean | No | 是否需要清洗数据/Whether to clean and format the data | false | None | None |
962
+
963
+ #### Request Body
964
+
965
+ None
966
+
967
+ #### Success Response
968
+
969
+ ##### `200 application/json`
970
+
971
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
972
+
973
+ | Field | Type | Required | Description | Default | Example | Enum |
974
+ | --- | --- | --- | --- | --- | --- | --- |
975
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
976
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
977
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
978
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
979
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
980
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
981
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
982
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
983
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
984
+ | 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 |
985
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
986
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
987
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
988
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
989
+ | data | null | No | The response data \| 响应数据 | None | None | None |
990
+
991
+ <a id="get-api-u1-v1-reddit-app-fetch-post-details-batch-large"></a>
992
+ ### `GET /api/u1/v1/reddit/app/fetch_post_details_batch_large`
993
+
994
+ - Summary: 大批量获取Reddit帖子详情(最多30条)/Fetch Reddit Post Details in Large Batch (Max 30)
995
+ - Capabilities: content details / details
996
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
997
+ - operationId: `fetch_post_details_batch_large_api_v1_reddit_app_fetch_post_details_batch_large_get`
998
+
999
+ #### Notes
1000
+
1001
+ > # [中文]
1002
+ > ## 用途:
1003
+ > - 根据帖子ID列表大批量获取帖子详情
1004
+ > - 支持最多30条帖子的批量查询
1005
+ > - 可选择性包含特定评论的上下文
1006
+ >
1007
+ > ## 参数:
1008
+ > - post_ids: 帖子ID列表,逗号分隔,格式如 "t3_XXXXXX,t3_YYYYYY,...",最多支持30条
1009
+ > - include_comment_id: 是否包含特定评论ID,默认False
1010
+ > - comment_id: 评论ID(当include_comment_id为True时使用),格式如 "t1_XXXXXX"
1011
+ >
1012
+ > ## 返回:
1013
+ > - 包含帖子详细信息的数据,包括:
1014
+ > - 帖子内容、标题、作者
1015
+ > - 统计数据(点赞数、评论数等)
1016
+ > - 版块信息
1017
+ > - 奖励信息
1018
+ > - 媒体资源
1019
+ > - 推荐原因等
1020
+ >
1021
+ > ## 注意:
1022
+ > - 最多支持30条帖子的批量查询
1023
+ > - 超过30条将返回错误
1024
+ > - 大批量查询可能需要较长的响应时间
1025
+ > - **APP接口的ID格式与Web接口不同,需要添加类型前缀**
1026
+ > - 帖子ID前缀: t3_ (例如: t3_1ojnh50)
1027
+ > - 评论ID前缀: t1_ (例如: t1_abcd123)
1028
+ >
1029
+ > ---
1030
+ >
1031
+ > # [English]
1032
+ > ## Purpose:
1033
+ > - Fetch post details in large batch by post ID list
1034
+ > - Support batch query for up to 30 posts
1035
+ > - Optionally include context for specific comments
1036
+ >
1037
+ > ## Parameters:
1038
+ > - post_ids: Post IDs comma-separated, format like "t3_XXXXXX,t3_YYYYYY,...", max 30 posts
1039
+ > - include_comment_id: Whether to include specific comment ID, default False
1040
+ > - comment_id: Comment ID (used when include_comment_id is True), format like "t1_XXXXXX"
1041
+ >
1042
+ > ## Returns:
1043
+ > - Data containing detailed post information including:
1044
+ > - Post content, title, author
1045
+ > - Statistics (upvotes, comment count, etc.)
1046
+ > - Subreddit information
1047
+ > - Award information
1048
+ > - Media resources
1049
+ > - Recommendation reasons, etc.
1050
+ >
1051
+ > ## Notes:
1052
+ > - Maximum 30 posts per batch query
1053
+ > - Error will be returned if exceeds 30 posts
1054
+ > - Large batch queries may take longer to respond
1055
+ > - **APP API ID format differs from Web API, requires type prefix**
1056
+ > - Post ID prefix: t3_ (e.g., t3_1ojnh50)
1057
+ > - Comment ID prefix: t1_ (e.g., t1_abcd123)
1058
+ >
1059
+ > # [示例/Example]
1060
+ > post_ids="t3_1ojnh50,t3_1ok432f,t3_1nwil8j,t3_1oj6vn6,t3_1nuenmd,..."
1061
+
1062
+ #### Parameters
1063
+
1064
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1065
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1066
+ | post_ids | query | string | Yes | 帖子ID列表,逗号分隔,最多30条/Post IDs comma-separated, max 30 (e.g., t3_1ojnh50,t3_1ok432f,...) | None | None | None |
1067
+ | include_comment_id | query | boolean | No | 是否包含特定评论ID/Include specific comment ID | false | None | None |
1068
+ | comment_id | query | string | No | 评论ID/Comment ID (when include_comment_id is True) | None | None | None |
1069
+ | need_format | query | boolean | No | 是否需要清洗数据/Whether to clean and format the data | false | None | None |
1070
+
1071
+ #### Request Body
1072
+
1073
+ None
1074
+
1075
+ #### Success Response
1076
+
1077
+ ##### `200 application/json`
1078
+
1079
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1080
+
1081
+ | Field | Type | Required | Description | Default | Example | Enum |
1082
+ | --- | --- | --- | --- | --- | --- | --- |
1083
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1084
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1085
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1086
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1087
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1088
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1089
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1090
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1091
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1092
+ | 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 |
1093
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1094
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1095
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1096
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1097
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1098
+
1099
+ <a id="get-api-u1-v1-reddit-app-fetch-search-typeahead"></a>
1100
+ ### `GET /api/u1/v1/reddit/app/fetch_search_typeahead`
1101
+
1102
+ - Summary: 获取Reddit APP搜索自动补全建议/Fetch Reddit APP Search Typeahead Suggestions
1103
+ - Capabilities: search
1104
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1105
+ - operationId: `fetch_search_typeahead_api_v1_reddit_app_fetch_search_typeahead_get`
1106
+
1107
+ #### Notes
1108
+
1109
+ > # [中文]
1110
+ > ### 用途:
1111
+ > - 获取Reddit APP搜索框的自动补全建议,包括推荐的版块、用户和搜索词
1112
+ > ### 参数:
1113
+ > - query: 搜索关键词,输入的搜索文本
1114
+ > - safe_search: 安全搜索设置,可选值为"unset"(未设置)或"strict"(严格模式)
1115
+ > - allow_nsfw: 是否允许显示NSFW(成人)内容,"0"表示不允许,"1"表示允许
1116
+ > ### 返回:
1117
+ > - 搜索建议JSON数据,包含以下类型的建议:
1118
+ > - 相关版块(subreddits)
1119
+ > - 相关用户(users)
1120
+ > - 搜索词建议(search suggestions)
1121
+ > - 热门话题(trending topics)
1122
+ >
1123
+ > # [English]
1124
+ > ### Purpose:
1125
+ > - Fetch autocomplete suggestions for the Reddit APP search box, including recommended subreddits, users, and search terms
1126
+ > ### Parameters:
1127
+ > - query: Search keyword, the search text being typed
1128
+ > - safe_search: Safe search setting, options are "unset" or "strict"
1129
+ > - allow_nsfw: Whether to allow NSFW (adult) content display, "0" means disallow, "1" means allow
1130
+ > ### Returns:
1131
+ > - JSON data of search suggestions containing the following types:
1132
+ > - Related subreddits
1133
+ > - Related users
1134
+ > - Search term suggestions
1135
+ > - Trending topics
1136
+ >
1137
+ > # [示例/Example]
1138
+ > query="programming"
1139
+ > safe_search="unset"
1140
+ > allow_nsfw="0"
1141
+
1142
+ #### Parameters
1143
+
1144
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1145
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1146
+ | query | query | string | Yes | 搜索关键词/Search query | None | None | None |
1147
+ | safe_search | query | string | No | 安全搜索设置/Safe search setting: unset, strict | unset | None | None |
1148
+ | allow_nsfw | query | string | No | 是否允许NSFW内容/Allow NSFW content: 0 or 1 | 0 | None | None |
1149
+ | need_format | query | boolean | No | 是否需要清洗数据/Whether to clean and format the data | false | None | None |
1150
+
1151
+ #### Request Body
1152
+
1153
+ None
1154
+
1155
+ #### Success Response
1156
+
1157
+ ##### `200 application/json`
1158
+
1159
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1160
+
1161
+ | Field | Type | Required | Description | Default | Example | Enum |
1162
+ | --- | --- | --- | --- | --- | --- | --- |
1163
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1164
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1165
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1166
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1167
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1168
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1169
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1170
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1171
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1172
+ | 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 |
1173
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1174
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1175
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1176
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1177
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1178
+
1179
+ <a id="get-api-u1-v1-reddit-app-fetch-subreddit-feed"></a>
1180
+ ### `GET /api/u1/v1/reddit/app/fetch_subreddit_feed`
1181
+
1182
+ - Summary: 获取Reddit APP版块Feed内容/Fetch Reddit APP Subreddit Feed
1183
+ - Capabilities: general
1184
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1185
+ - operationId: `fetch_subreddit_feed_api_v1_reddit_app_fetch_subreddit_feed_get`
1186
+
1187
+ #### Notes
1188
+
1189
+ > # [中文]
1190
+ > ### 用途:
1191
+ > - 获取指定Reddit版块的Feed内容流,展示该版块的帖子列表
1192
+ > ### 参数:
1193
+ > - subreddit_name: 版块名称(不带r/前缀),如"pics", "funny"等
1194
+ > - sort: 排序方式,可选: BEST(最佳), HOT(热门), NEW(最新), TOP(顶级), CONTROVERSIAL(有争议), RISING(上升中)
1195
+ > - filter_posts: 过滤掉指定的帖子ID列表
1196
+ > - after: 分页参数,获取下一页时使用
1197
+ > ### 返回:
1198
+ > - 版块Feed JSON数据,包含:
1199
+ > - 该版块的帖子列表
1200
+ > - 帖子详细信息
1201
+ > - 版块元数据
1202
+ > - 分页信息
1203
+ >
1204
+ > # [English]
1205
+ > ### Purpose:
1206
+ > - Fetch feed content stream of a specified Reddit subreddit, displaying the post list of that subreddit
1207
+ > ### Parameters:
1208
+ > - subreddit_name: Subreddit name (without r/ prefix), e.g., "pics", "funny"
1209
+ > - sort: Sort method, options: BEST, HOT, NEW, TOP, CONTROVERSIAL, RISING
1210
+ > - filter_posts: List of post IDs to filter out
1211
+ > - after: Pagination parameter for fetching next page
1212
+ > ### Returns:
1213
+ > - JSON data of subreddit feed containing:
1214
+ > - List of posts in the subreddit
1215
+ > - Detailed post information
1216
+ > - Subreddit metadata
1217
+ > - Pagination information
1218
+ >
1219
+ > # [示例/Example]
1220
+ > subreddit_name="AskReddit"
1221
+ > sort="HOT"
1222
+ > filter_posts=[]
1223
+ > after=""
1224
+
1225
+ #### Parameters
1226
+
1227
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1228
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1229
+ | subreddit_name | query | string | Yes | 版块名称/Subreddit name | None | None | None |
1230
+ | sort | query | string | No | 排序方式/Sort method: BEST, HOT, NEW, TOP, CONTROVERSIAL, RISING | BEST | None | None |
1231
+ | filter_posts | query | array<Not declared> | No | 过滤帖子ID列表/Filter post IDs | None | None | None |
1232
+ | after | query | string | No | 分页参数/Pagination parameter | None | None | None |
1233
+ | need_format | query | boolean | No | 是否需要清洗数据/Whether to clean and format the data | false | None | None |
1234
+
1235
+ #### Request Body
1236
+
1237
+ None
1238
+
1239
+ #### Success Response
1240
+
1241
+ ##### `200 application/json`
1242
+
1243
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1244
+
1245
+ | Field | Type | Required | Description | Default | Example | Enum |
1246
+ | --- | --- | --- | --- | --- | --- | --- |
1247
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1248
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1249
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1250
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1251
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1252
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1253
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1254
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1255
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1256
+ | 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 |
1257
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1258
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1259
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1260
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1261
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1262
+
1263
+ <a id="get-api-u1-v1-reddit-app-fetch-subreddit-info"></a>
1264
+ ### `GET /api/u1/v1/reddit/app/fetch_subreddit_info`
1265
+
1266
+ - Summary: 获取Reddit APP版块信息/Fetch Reddit APP Subreddit Info
1267
+ - Capabilities: general
1268
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1269
+ - operationId: `fetch_subreddit_info_api_v1_reddit_app_fetch_subreddit_info_get`
1270
+
1271
+ #### Notes
1272
+
1273
+ > # [中文]
1274
+ > ### 用途:
1275
+ > - 获取Reddit APP指定版块的详细信息,包括版块描述、成员数量、创建时间、规则等元数据
1276
+ > ### 参数:
1277
+ > - subreddit_name: 版块名称(不带r/前缀),例如"pics", "funny", "AskReddit"等
1278
+ > ### 返回:
1279
+ > - 指定版块的详细信息JSON数据
1280
+ > # [English]
1281
+ > ### Purpose:
1282
+ > - Fetch detailed information of a specified Reddit APP subreddit, including description, subscriber count, creation time, rules, and other metadata
1283
+ > ### Parameters:
1284
+ > - subreddit_name: Subreddit name (without r/ prefix), e.g., "pics", "funny", "AskReddit"
1285
+ > ### Returns:
1286
+ > - JSON data containing detailed subreddit information
1287
+ >
1288
+ > # [示例/Example]
1289
+ > subreddit_name="pics"
1290
+
1291
+ #### Parameters
1292
+
1293
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1294
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1295
+ | subreddit_name | query | string | No | 版块名称/Subreddit name | pics | None | None |
1296
+ | need_format | query | boolean | No | 是否需要清洗数据/Whether to clean and format the data | false | None | None |
1297
+
1298
+ #### Request Body
1299
+
1300
+ None
1301
+
1302
+ #### Success Response
1303
+
1304
+ ##### `200 application/json`
1305
+
1306
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1307
+
1308
+ | Field | Type | Required | Description | Default | Example | Enum |
1309
+ | --- | --- | --- | --- | --- | --- | --- |
1310
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1311
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1312
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1313
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1314
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1315
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1316
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1317
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1318
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1319
+ | 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 |
1320
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1321
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1322
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1323
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1324
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1325
+
1326
+ <a id="get-api-u1-v1-reddit-app-fetch-subreddit-post-channels"></a>
1327
+ ### `GET /api/u1/v1/reddit/app/fetch_subreddit_post_channels`
1328
+
1329
+ - Summary: 获取Reddit APP版块帖子频道信息/Fetch Reddit APP Subreddit Post Channels
1330
+ - Capabilities: profiles / accounts / content details
1331
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1332
+ - operationId: `fetch_subreddit_post_channels_api_v1_reddit_app_fetch_subreddit_post_channels_get`
1333
+
1334
+ #### Notes
1335
+
1336
+ > # [中文]
1337
+ > ### 用途:
1338
+ > - 获取Reddit APP指定版块的帖子频道信息
1339
+ > ### 参数:
1340
+ > - subreddit_name: 版块名称(不带r/前缀)
1341
+ > - sort: 排序方式,支持HOT, NEW, TOP, CONTROVERSIAL, RISING
1342
+ > - range: 时间范围,支持HOUR, DAY, WEEK, MONTH, YEAR, ALL
1343
+ > ### 返回:
1344
+ > - 指定版块的帖子频道信息JSON数据
1345
+ >
1346
+ > # [English]
1347
+ > ### Purpose:
1348
+ > - Fetch post channel information of a specified Reddit APP subreddit
1349
+ > ### Parameters:
1350
+ > - subreddit_name: Subreddit name
1351
+ > - sort: Sort method, supports HOT, NEW, TOP, CONTROVERSIAL, RISING
1352
+ > - range: Time range, supports HOUR, DAY, WEEK, MONTH, YEAR, ALL
1353
+ > ### Returns:
1354
+ > - JSON data of post channel information of the specified subreddit
1355
+ >
1356
+ > # [示例/Example]
1357
+ > subreddit_name="pics"
1358
+
1359
+ #### Parameters
1360
+
1361
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1362
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1363
+ | subreddit_name | query | string | No | 版块名称/Subreddit name | pics | None | None |
1364
+ | sort | query | string | No | 排序方式/Sort method: HOT, NEW, TOP, CONTROVERSIAL, RISING | HOT | None | None |
1365
+ | range | query | string | No | 时间范围/Time range: HOUR, DAY, WEEK, MONTH, YEAR, ALL | DAY | None | None |
1366
+ | need_format | query | boolean | No | 是否需要清洗数据/Whether to clean and format the data | false | None | None |
1367
+
1368
+ #### Request Body
1369
+
1370
+ None
1371
+
1372
+ #### Success Response
1373
+
1374
+ ##### `200 application/json`
1375
+
1376
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1377
+
1378
+ | Field | Type | Required | Description | Default | Example | Enum |
1379
+ | --- | --- | --- | --- | --- | --- | --- |
1380
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1381
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1382
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1383
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1384
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1385
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1386
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1387
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1388
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1389
+ | 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 |
1390
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1391
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1392
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1393
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1394
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1395
+
1396
+ <a id="get-api-u1-v1-reddit-app-fetch-subreddit-settings"></a>
1397
+ ### `GET /api/u1/v1/reddit/app/fetch_subreddit_settings`
1398
+
1399
+ - Summary: 获取Reddit APP版块设置/Fetch Reddit APP Subreddit Settings
1400
+ - Capabilities: general
1401
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1402
+ - operationId: `fetch_subreddit_settings_api_v1_reddit_app_fetch_subreddit_settings_get`
1403
+
1404
+ #### Notes
1405
+
1406
+ > # [中文]
1407
+ > ### 用途:
1408
+ > - 获取Reddit APP指定版块的设置信息,包括发帖规则、用户标签设置、审核设置等配置信息
1409
+ > ### 参数:
1410
+ > - subreddit_id: 版块ID,格式为t5_开头的唯一标识符,例如"t5_2qh0u"(可从fetch_subreddit_info接口获取版块ID)
1411
+ > ### 返回:
1412
+ > - 指定版块的设置信息JSON数据,包含以下主要字段:
1413
+ > - subredditType: 版块类型(public/private/restricted)
1414
+ > - submissionType: 允许提交的内容类型(any/link/self)
1415
+ > - allowImages: 是否允许图片
1416
+ > - allowVideos: 是否允许视频
1417
+ > - allowPolls: 是否允许投票
1418
+ > - suggestedCommentSort: 建议的评论排序方式
1419
+ > - spoilersEnabled: 是否启用剧透标记
1420
+ > - allowedPostTypes: 允许的帖子类型配置
1421
+ > - contentOptions: 内容选项设置
1422
+ > - flairSettings: 用户/帖子标签设置
1423
+ > ### 注意事项:
1424
+ > - 需要先通过fetch_subreddit_info接口获取版块ID(subreddit.id字段)
1425
+ > - 版块ID格式必须为"t5_"开头
1426
+ > - **APP接口的ID格式与Web接口不同,需要添加类型前缀**
1427
+ > - 版块ID前缀: t5_ (例如: t5_2qh0u)
1428
+ >
1429
+ > # [English]
1430
+ > ### Purpose:
1431
+ > - Fetch settings information of a specified Reddit APP subreddit, including posting rules, flair settings, moderation settings, and other configurations
1432
+ > ### Parameters:
1433
+ > - subreddit_id: Subreddit ID with format starting with t5_, e.g., "t5_2qh0u" (can be obtained from the fetch_subreddit_info endpoint)
1434
+ > ### Returns:
1435
+ > - JSON data containing subreddit settings with the following main fields:
1436
+ > - subredditType: Subreddit type (public/private/restricted)
1437
+ > - submissionType: Allowed submission content types (any/link/self)
1438
+ > - allowImages: Whether images are allowed
1439
+ > - allowVideos: Whether videos are allowed
1440
+ > - allowPolls: Whether polls are allowed
1441
+ > - suggestedCommentSort: Suggested comment sort method
1442
+ > - spoilersEnabled: Whether spoiler tags are enabled
1443
+ > - allowedPostTypes: Allowed post types configuration
1444
+ > - contentOptions: Content options settings
1445
+ > - flairSettings: User/post flair settings
1446
+ > ### Notes:
1447
+ > - You need to first get the subreddit ID (subreddit.id field) via the fetch_subreddit_info endpoint
1448
+ > - Subreddit ID format must start with "t5_"
1449
+ > - **APP API ID format differs from Web API, requires type prefix**
1450
+ > - Subreddit ID prefix: t5_ (e.g., t5_2qh0u)
1451
+ >
1452
+ > # [示例/Example]
1453
+ > subreddit_id="t5_2qh0u"
1454
+
1455
+ #### Parameters
1456
+
1457
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1458
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1459
+ | subreddit_id | query | string | Yes | 版块ID/Subreddit ID (format: t5_xxxxx) | None | None | None |
1460
+ | need_format | query | boolean | No | 是否需要清洗数据/Whether to clean and format the data | false | None | None |
1461
+
1462
+ #### Request Body
1463
+
1464
+ None
1465
+
1466
+ #### Success Response
1467
+
1468
+ ##### `200 application/json`
1469
+
1470
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1471
+
1472
+ | Field | Type | Required | Description | Default | Example | Enum |
1473
+ | --- | --- | --- | --- | --- | --- | --- |
1474
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1475
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1476
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1477
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1478
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1479
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1480
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1481
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1482
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1483
+ | 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 |
1484
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1485
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1486
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1487
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1488
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1489
+
1490
+ <a id="get-api-u1-v1-reddit-app-fetch-subreddit-style"></a>
1491
+ ### `GET /api/u1/v1/reddit/app/fetch_subreddit_style`
1492
+
1493
+ - Summary: 获取Reddit APP版块规则样式信息/Fetch Reddit APP Subreddit Rules and Style Info
1494
+ - Capabilities: general
1495
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1496
+ - operationId: `fetch_subreddit_style_api_v1_reddit_app_fetch_subreddit_style_get`
1497
+
1498
+ #### Notes
1499
+
1500
+ > # [中文]
1501
+ > ### 用途:
1502
+ > - 获取Reddit APP指定版块的规则和样式信息
1503
+ > ### 参数:
1504
+ > - subreddit_name: 版块名称(不带r/前缀)
1505
+ > ### 返回:
1506
+ > - 指定版块的规则和样式信息JSON数据
1507
+ >
1508
+ > # [English]
1509
+ > ### Purpose:
1510
+ > - Fetch rules and style information of a specified Reddit APP subreddit
1511
+ > ### Parameters:
1512
+ > - subreddit_name: Subreddit name
1513
+ > ### Returns:
1514
+ > - JSON data of rules and style information of the specified subreddit
1515
+ >
1516
+ > # [示例/Example]
1517
+ > subreddit_name="pics"
1518
+
1519
+ #### Parameters
1520
+
1521
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1522
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1523
+ | subreddit_name | query | string | No | 版块名称/Subreddit name | pics | None | None |
1524
+ | need_format | query | boolean | No | 是否需要清洗数据/Whether to clean and format the data | false | None | None |
1525
+
1526
+ #### Request Body
1527
+
1528
+ None
1529
+
1530
+ #### Success Response
1531
+
1532
+ ##### `200 application/json`
1533
+
1534
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1535
+
1536
+ | Field | Type | Required | Description | Default | Example | Enum |
1537
+ | --- | --- | --- | --- | --- | --- | --- |
1538
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1539
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1540
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1541
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1542
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1543
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1544
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1545
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1546
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1547
+ | 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 |
1548
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1549
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1550
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1551
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1552
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1553
+
1554
+ <a id="get-api-u1-v1-reddit-app-fetch-trending-searches"></a>
1555
+ ### `GET /api/u1/v1/reddit/app/fetch_trending_searches`
1556
+
1557
+ - Summary: 获取Reddit APP今日热门搜索/Fetch Reddit APP Trending Searches
1558
+ - Capabilities: search / trends / rankings
1559
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1560
+ - operationId: `fetch_trending_searches_api_v1_reddit_app_fetch_trending_searches_get`
1561
+
1562
+ #### Notes
1563
+
1564
+ > # [中文]
1565
+ > ### 用途:
1566
+ > - 获取Reddit APP当前热门搜索话题和趋势内容
1567
+ > ### 参数:
1568
+ > - 无需参数
1569
+ > ### 返回:
1570
+ > - 热门搜索JSON数据,包含:
1571
+ > - 热门搜索关键词列表
1572
+ > - 趋势话题
1573
+ > - 每个话题的搜索量和热度
1574
+ > - 相关帖子预览
1575
+ >
1576
+ > # [English]
1577
+ > ### Purpose:
1578
+ > - Fetch currently trending search topics and content on Reddit APP
1579
+ > ### Parameters:
1580
+ > - No parameters required
1581
+ > ### Returns:
1582
+ > - JSON data of trending searches containing:
1583
+ > - List of trending search keywords
1584
+ > - Trending topics
1585
+ > - Search volume and popularity for each topic
1586
+ > - Related post previews
1587
+ >
1588
+ > # [示例/Example]
1589
+ > 无需参数/No parameters required
1590
+
1591
+ #### Parameters
1592
+
1593
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1594
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1595
+ | need_format | query | boolean | No | 是否需要清洗数据/Whether to clean and format the data | false | None | None |
1596
+
1597
+ #### Request Body
1598
+
1599
+ None
1600
+
1601
+ #### Success Response
1602
+
1603
+ ##### `200 application/json`
1604
+
1605
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1606
+
1607
+ | Field | Type | Required | Description | Default | Example | Enum |
1608
+ | --- | --- | --- | --- | --- | --- | --- |
1609
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1610
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1611
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1612
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1613
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1614
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1615
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1616
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1617
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1618
+ | 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 |
1619
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1620
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1621
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1622
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1623
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1624
+
1625
+ <a id="get-api-u1-v1-reddit-app-fetch-user-active-subreddits"></a>
1626
+ ### `GET /api/u1/v1/reddit/app/fetch_user_active_subreddits`
1627
+
1628
+ - Summary: 获取用户活跃的社区列表/Fetch User's Active Subreddits
1629
+ - Capabilities: profiles / accounts
1630
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1631
+ - operationId: `fetch_user_active_subreddits_api_v1_reddit_app_fetch_user_active_subreddits_get`
1632
+
1633
+ #### Notes
1634
+
1635
+ > # [中文]
1636
+ > ### 用途:
1637
+ > - 获取指定用户最活跃的Reddit社区列表
1638
+ > ### 参数:
1639
+ > - username: Reddit用户名
1640
+ > ### 返回:
1641
+ > - 用户活跃社区JSON数据,包含:
1642
+ > - 用户最常发帖/评论的社区列表
1643
+ > - 每个社区的活跃度信息
1644
+ > - 社区基本信息(名称、图标、成员数等)
1645
+ >
1646
+ > # [English]
1647
+ > ### Purpose:
1648
+ > - Fetch list of Reddit communities where the specified user is most active
1649
+ > ### Parameters:
1650
+ > - username: Reddit username
1651
+ > ### Returns:
1652
+ > - JSON data of user's active communities containing:
1653
+ > - List of communities where user posts/comments most
1654
+ > - Activity level in each community
1655
+ > - Basic community information (name, icon, member count, etc.)
1656
+ >
1657
+ > # [示例/Example]
1658
+ > username="spez"
1659
+
1660
+ #### Parameters
1661
+
1662
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1663
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1664
+ | username | query | string | Yes | 用户名/Username | None | None | None |
1665
+ | need_format | query | boolean | No | 是否需要清洗数据/Whether to clean and format the data | false | None | None |
1666
+
1667
+ #### Request Body
1668
+
1669
+ None
1670
+
1671
+ #### Success Response
1672
+
1673
+ ##### `200 application/json`
1674
+
1675
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1676
+
1677
+ | Field | Type | Required | Description | Default | Example | Enum |
1678
+ | --- | --- | --- | --- | --- | --- | --- |
1679
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1680
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1681
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1682
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1683
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1684
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1685
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1686
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1687
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1688
+ | 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 |
1689
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1690
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1691
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1692
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1693
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1694
+
1695
+ <a id="get-api-u1-v1-reddit-app-fetch-user-comments"></a>
1696
+ ### `GET /api/u1/v1/reddit/app/fetch_user_comments`
1697
+
1698
+ - Summary: 获取用户评论列表/Fetch User Comments
1699
+ - Capabilities: comments / profiles / accounts
1700
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1701
+ - operationId: `fetch_user_comments_api_v1_reddit_app_fetch_user_comments_get`
1702
+
1703
+ #### Notes
1704
+
1705
+ > # [中文]
1706
+ > ### 用途:
1707
+ > - 获取指定用户发表的评论列表
1708
+ > ### 参数:
1709
+ > - username: Reddit用户名
1710
+ > - sort: 排序方式,可选值: NEW(最新), TOP(最热), HOT(热门), CONTROVERSIAL(有争议)
1711
+ > - page_size: 每页返回的评论数量,默认25条
1712
+ > - after: 分页参数,用于获取下一页
1713
+ > ### 返回:
1714
+ > - 用户评论列表JSON数据,包含:
1715
+ > - 评论内容
1716
+ > - 评论所在的帖子信息
1717
+ > - 评论时间
1718
+ > - 点赞数
1719
+ > - 回复数
1720
+ > - 分页信息
1721
+ >
1722
+ > # [English]
1723
+ > ### Purpose:
1724
+ > - Fetch list of comments posted by the specified user
1725
+ > ### Parameters:
1726
+ > - username: Reddit username
1727
+ > - sort: Sort method, options: NEW (newest), TOP (top rated), HOT (hot), CONTROVERSIAL (controversial)
1728
+ > - page_size: Number of comments per page, default 25
1729
+ > - after: Pagination parameter for fetching next page
1730
+ > ### Returns:
1731
+ > - JSON data of user comments containing:
1732
+ > - Comment content
1733
+ > - Information about the post where comment was made
1734
+ > - Comment timestamp
1735
+ > - Upvote count
1736
+ > - Reply count
1737
+ > - Pagination information
1738
+ >
1739
+ > # [示例/Example]
1740
+ > username="spez"
1741
+ > sort="NEW"
1742
+ > page_size=25
1743
+ > after=""
1744
+
1745
+ #### Parameters
1746
+
1747
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1748
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1749
+ | username | query | string | Yes | 用户名/Username | None | None | None |
1750
+ | sort | query | string | No | 排序方式/Sort method: NEW, TOP, HOT, CONTROVERSIAL | NEW | None | None |
1751
+ | page_size | query | integer | No | 每页数量/Page size (default: 25) | 25 | None | None |
1752
+ | after | query | string | No | 分页参数/Pagination parameter | None | None | None |
1753
+ | need_format | query | boolean | No | 是否需要清洗数据/Whether to clean and format the data | false | None | None |
1754
+
1755
+ #### Request Body
1756
+
1757
+ None
1758
+
1759
+ #### Success Response
1760
+
1761
+ ##### `200 application/json`
1762
+
1763
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1764
+
1765
+ | Field | Type | Required | Description | Default | Example | Enum |
1766
+ | --- | --- | --- | --- | --- | --- | --- |
1767
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1768
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1769
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1770
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1771
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1772
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1773
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1774
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1775
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1776
+ | 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 |
1777
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1778
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1779
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1780
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1781
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1782
+
1783
+ <a id="get-api-u1-v1-reddit-app-fetch-user-posts"></a>
1784
+ ### `GET /api/u1/v1/reddit/app/fetch_user_posts`
1785
+
1786
+ - Summary: 获取用户发布的帖子列表/Fetch User Posts
1787
+ - Capabilities: profiles / accounts / content details
1788
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1789
+ - operationId: `fetch_user_posts_api_v1_reddit_app_fetch_user_posts_get`
1790
+
1791
+ #### Notes
1792
+
1793
+ > # [中文]
1794
+ > ### 用途:
1795
+ > - 获取指定用户发布的帖子列表
1796
+ > ### 参数:
1797
+ > - username: Reddit用户名
1798
+ > - sort: 排序方式,可选值: NEW(最新), TOP(最热), HOT(热门), CONTROVERSIAL(有争议)
1799
+ > - after: 分页参数,用于获取下一页
1800
+ > ### 返回:
1801
+ > - 用户帖子列表JSON数据,包含:
1802
+ > - 帖子标题和内容
1803
+ > - 发布时间
1804
+ > - 所属版块
1805
+ > - 点赞数和评论数
1806
+ > - 帖子类型(文本/图片/视频/链接)
1807
+ > - 媒体内容(如有)
1808
+ > - 分页信息
1809
+ >
1810
+ > # [English]
1811
+ > ### Purpose:
1812
+ > - Fetch list of posts submitted by the specified user
1813
+ > ### Parameters:
1814
+ > - username: Reddit username
1815
+ > - sort: Sort method, options: NEW (newest), TOP (top rated), HOT (hot), CONTROVERSIAL (controversial)
1816
+ > - after: Pagination parameter for fetching next page
1817
+ > ### Returns:
1818
+ > - JSON data of user posts containing:
1819
+ > - Post title and content
1820
+ > - Submission time
1821
+ > - Subreddit
1822
+ > - Upvote and comment counts
1823
+ > - Post type (text/image/video/link)
1824
+ > - Media content (if any)
1825
+ > - Pagination information
1826
+ >
1827
+ > # [示例/Example]
1828
+ > username="spez"
1829
+ > sort="NEW"
1830
+ > after=""
1831
+
1832
+ #### Parameters
1833
+
1834
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1835
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1836
+ | username | query | string | Yes | 用户名/Username | None | None | None |
1837
+ | sort | query | string | No | 排序方式/Sort method: NEW, TOP, HOT, CONTROVERSIAL | NEW | None | None |
1838
+ | after | query | string | No | 分页参数/Pagination parameter | None | None | None |
1839
+ | need_format | query | boolean | No | 是否需要清洗数据/Whether to clean and format the data | false | None | None |
1840
+
1841
+ #### Request Body
1842
+
1843
+ None
1844
+
1845
+ #### Success Response
1846
+
1847
+ ##### `200 application/json`
1848
+
1849
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1850
+
1851
+ | Field | Type | Required | Description | Default | Example | Enum |
1852
+ | --- | --- | --- | --- | --- | --- | --- |
1853
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1854
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1855
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1856
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1857
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1858
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1859
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1860
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1861
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1862
+ | 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 |
1863
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1864
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1865
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1866
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1867
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1868
+
1869
+ <a id="get-api-u1-v1-reddit-app-fetch-user-profile"></a>
1870
+ ### `GET /api/u1/v1/reddit/app/fetch_user_profile`
1871
+
1872
+ - Summary: 获取Reddit APP用户资料信息/Fetch Reddit APP User Profile
1873
+ - Capabilities: profiles / accounts
1874
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1875
+ - operationId: `fetch_user_profile_api_v1_reddit_app_fetch_user_profile_get`
1876
+
1877
+ #### Notes
1878
+
1879
+ > # [中文]
1880
+ > ### 用途:
1881
+ > - 获取Reddit APP指定用户的详细资料信息
1882
+ > ### 参数:
1883
+ > - username: Reddit用户名(不带u/前缀)
1884
+ > ### 返回:
1885
+ > - 用户资料JSON数据,包含:
1886
+ > - 用户名和ID
1887
+ > - 账号创建时间
1888
+ > - Karma值(帖子karma和评论karma)
1889
+ > - 头像和横幅图片
1890
+ > - 个人简介
1891
+ > - 是否验证账号
1892
+ > - 徽章和奖励
1893
+ > - 关注者数量
1894
+ >
1895
+ > # [English]
1896
+ > ### Purpose:
1897
+ > - Fetch detailed profile information of a specified Reddit APP user
1898
+ > ### Parameters:
1899
+ > - username: Reddit username (without u/ prefix)
1900
+ > ### Returns:
1901
+ > - JSON data of user profile containing:
1902
+ > - Username and ID
1903
+ > - Account creation date
1904
+ > - Karma values (post karma and comment karma)
1905
+ > - Avatar and banner images
1906
+ > - Bio/description
1907
+ > - Verification status
1908
+ > - Badges and awards
1909
+ > - Follower count
1910
+ >
1911
+ > # [示例/Example]
1912
+ > username="spez"
1913
+
1914
+ #### Parameters
1915
+
1916
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1917
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1918
+ | username | query | string | Yes | 用户名/Username | None | None | None |
1919
+ | need_format | query | boolean | No | 是否需要清洗数据/Whether to clean and format the data | false | None | None |
1920
+
1921
+ #### Request Body
1922
+
1923
+ None
1924
+
1925
+ #### Success Response
1926
+
1927
+ ##### `200 application/json`
1928
+
1929
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
1930
+
1931
+ | Field | Type | Required | Description | Default | Example | Enum |
1932
+ | --- | --- | --- | --- | --- | --- | --- |
1933
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
1934
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
1935
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
1936
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
1937
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
1938
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
1939
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
1940
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
1941
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
1942
+ | 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 |
1943
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
1944
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
1945
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
1946
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
1947
+ | data | null | No | The response data \| 响应数据 | None | None | None |
1948
+
1949
+ <a id="get-api-u1-v1-reddit-app-fetch-user-trophies"></a>
1950
+ ### `GET /api/u1/v1/reddit/app/fetch_user_trophies`
1951
+
1952
+ - Summary: 获取用户公开奖杯/Fetch User Public Trophies
1953
+ - Capabilities: profiles / accounts
1954
+ - Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
1955
+ - operationId: `fetch_user_trophies_api_v1_reddit_app_fetch_user_trophies_get`
1956
+
1957
+ #### Notes
1958
+
1959
+ > # [中文]
1960
+ > ### 用途:
1961
+ > - 获取指定Reddit用户的公开奖杯/成就列表
1962
+ > ### 参数:
1963
+ > - username: Reddit用户名(不带u/前缀)
1964
+ > ### 返回:
1965
+ > - 用户奖杯JSON数据,包含:
1966
+ > - 奖杯列表(trophy list)
1967
+ > - 每个奖杯的详细信息:
1968
+ > - 奖杯名称
1969
+ > - 奖杯描述
1970
+ > - 奖杯图标URL
1971
+ > - 获得时间
1972
+ > - 特殊徽章和成就
1973
+ >
1974
+ > # [English]
1975
+ > ### Purpose:
1976
+ > - Fetch public trophies/achievements list of a specified Reddit user
1977
+ > ### Parameters:
1978
+ > - username: Reddit username (without u/ prefix)
1979
+ > ### Returns:
1980
+ > - JSON data of user trophies containing:
1981
+ > - Trophy list
1982
+ > - Detailed information for each trophy:
1983
+ > - Trophy name
1984
+ > - Trophy description
1985
+ > - Trophy icon URL
1986
+ > - Award date
1987
+ > - Special badges and achievements
1988
+ >
1989
+ > # [示例/Example]
1990
+ > username="spez"
1991
+
1992
+ #### Parameters
1993
+
1994
+ | Field | In | Type | Required | Description | Default | Example | Enum |
1995
+ | --- | --- | --- | --- | --- | --- | --- | --- |
1996
+ | username | query | string | Yes | 用户名/Username | None | None | None |
1997
+ | need_format | query | boolean | No | 是否需要清洗数据/Whether to clean and format the data | false | None | None |
1998
+
1999
+ #### Request Body
2000
+
2001
+ None
2002
+
2003
+ #### Success Response
2004
+
2005
+ ##### `200 application/json`
2006
+
2007
+ - Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
2008
+
2009
+ | Field | Type | Required | Description | Default | Example | Enum |
2010
+ | --- | --- | --- | --- | --- | --- | --- |
2011
+ | code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
2012
+ | request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
2013
+ | message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
2014
+ | message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
2015
+ | support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
2016
+ | time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
2017
+ | time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
2018
+ | time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
2019
+ | docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
2020
+ | 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 |
2021
+ | cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
2022
+ | cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
2023
+ | router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
2024
+ | params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
2025
+ | data | null | No | The response data \| 响应数据 | None | None | None |