Reddit-APP-API

获取Reddit APP版块设置/Fetch Reddit APP Subreddit Settings

Changed on

[中文]

用途:

  • 获取Reddit APP指定版块的设置信息,包括发帖规则、用户标签设置、审核设置等配置信息

参数:

  • subreddit_id: 版块ID,格式为t5_开头的唯一标识符,例如"t5_2qh0u"(可从fetch_subreddit_info接口获取版块ID)

返回:

  • 指定版块的设置信息JSON数据,包含以下主要字段:
    • subredditType: 版块类型(public/private/restricted)
    • submissionType: 允许提交的内容类型(any/link/self)
    • allowImages: 是否允许图片
    • allowVideos: 是否允许视频
    • allowPolls: 是否允许投票
    • suggestedCommentSort: 建议的评论排序方式
    • spoilersEnabled: 是否启用剧透标记
    • allowedPostTypes: 允许的帖子类型配置
    • contentOptions: 内容选项设置
    • flairSettings: 用户/帖子标签设置

注意事项:

  • 需要先通过fetch_subreddit_info接口获取版块ID(subreddit.id字段)
  • 版块ID格式必须为"t5_"开头
  • APP接口的ID格式与Web接口不同,需要添加类型前缀
  • 版块ID前缀: t5_ (例如: t5_2qh0u)

[English]

Purpose:

  • Fetch settings information of a specified Reddit APP subreddit, including posting rules, flair settings, moderation settings, and other configurations

Parameters:

  • subreddit_id: Subreddit ID with format starting with t5_, e.g., "t5_2qh0u" (can be obtained from the fetch_subreddit_info endpoint)

Returns:

  • JSON data containing subreddit settings with the following main fields:
    • subredditType: Subreddit type (public/private/restricted)
    • submissionType: Allowed submission content types (any/link/self)
    • allowImages: Whether images are allowed
    • allowVideos: Whether videos are allowed
    • allowPolls: Whether polls are allowed
    • suggestedCommentSort: Suggested comment sort method
    • spoilersEnabled: Whether spoiler tags are enabled
    • allowedPostTypes: Allowed post types configuration
    • contentOptions: Content options settings
    • flairSettings: User/post flair settings

Notes:

  • You need to first get the subreddit ID (subreddit.id field) via the fetch_subreddit_info endpoint
  • Subreddit ID format must start with "t5_"
  • APP API ID format differs from Web API, requires type prefix
  • Subreddit ID prefix: t5_ (e.g., t5_2qh0u)

[示例/Example]

subreddit_id="t5_2qh0u" need_format=false

get/api/v1/reddit/app/fetch_subreddit_settings

Request

  • Base URL
    https://api.tikhub.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Query parameters

languagestring

返回内容使用的语言,采用 IETF 语言标签;默认 en-US / Preferred response language as an IETF language tag; default: en-US

subreddit_idstring required

版块ID/Subreddit ID

need_formatboolean

是否需要清洗数据/Whether to clean and format the data

Response

Successful Response

codeinteger

HTTP status code | HTTP状态码

request_idstring nullable

Unique request identifier | 唯一请求标识符

messagestring

Response message (EN-US) | 响应消息 (English)

message_zhstring

Response message (ZH-CN) | 响应消息 (中文)

supportstring

Support message | 支持消息

timestring

The time the response was generated | 生成响应的时间

time_stampinteger

The timestamp the response was generated | 生成响应的时间戳

time_zonestring

The timezone of the response time | 响应时间的时区

docsstring nullable

Link to the API Swagger documentation for this endpoint | 此端点的 API Swagger 文档链接

cache_messagestring nullable

Cache message (EN-US) | 缓存消息 (English)

cache_message_zhstring nullable

Cache message (ZH-CN) | 缓存消息 (中文)

cache_urlstring nullable

The URL to access the cached result | 访问缓存结果的 URL

routerstring

The endpoint that generated this response | 生成此响应的端点

paramsunknown
dataunknown

Changes

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • breaking

      for the query request parameter subreddit_id, the minLength was increased from 0 to 4

    • breaking

      added the pattern ^t5_[a-z0-9]{1,17}$ to the query request parameter subreddit_id

    • warning

      for the query request parameter subreddit_id, the maxLength was set to 20

    • info

      added the new optional query request parameter language