TItikhub
Reddit-APP-API

获取Reddit APP版块帖子频道信息/Fetch Reddit APP Subreddit Post Channels

Changed on

[中文]

用途:

  • 获取Reddit APP指定版块的帖子频道信息

参数:

  • subreddit_name: 版块名称(不带r/前缀)
  • sort: 排序方式，支持HOT, NEW, TOP, CONTROVERSIAL, RISING
  • range: 时间范围，支持HOUR, DAY, WEEK, MONTH, YEAR, ALL

返回:

  • 指定版块的帖子频道信息JSON数据

[English]

Purpose:

  • Fetch post channel information of a specified Reddit APP subreddit

Parameters:

  • subreddit_name: Subreddit name
  • sort: Sort method, supports HOT, NEW, TOP, CONTROVERSIAL, RISING
  • range: Time range, supports HOUR, DAY, WEEK, MONTH, YEAR, ALL

Returns:

  • JSON data of post channel information of the specified subreddit

[示例/Example]

subreddit_name="pics" sort="HOT" range="DAY" need_format=false

get/api/v1/reddit/app/fetch_subreddit_post_channels

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_namestring

版块名称/Subreddit name

sort'BEST' | 'HOT' | 'NEW' | 'TOP' | 'CONTROVERSIAL' | 'RISING'

排序方式/Sort method: HOT, NEW, TOP, CONTROVERSIAL, RISING

range'ALL' | 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR'

时间范围/Time range: HOUR, DAY, WEEK, MONTH, YEAR, ALL

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

  • 96a122a5f220Revision changes
    • info

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

    • info

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

  • eab99e8bfe5bRevision changes
    • breaking

      the query request parameter range was restricted to a list of enum values

    • breaking

      the query request parameter sort was restricted to a list of enum values

    • breaking

      for the query request parameter subreddit_name, the minLength was increased from 0 to 2

    • breaking

      added the pattern ^[A-Za-z0-9_]+$ to the query request parameter subreddit_name

    • warning

      for the query request parameter subreddit_name, the maxLength was set to 21

    • info

      added the new optional query request parameter language

    • info

      added the new enum value ALL to the query request parameter range

    • info

      added the new enum value BEST to the query request parameter sort

    • info

      added the new enum value CONTROVERSIAL to the query request parameter sort

    • info

      added the new enum value DAY to the query request parameter range

    • info

      added the new enum value HOT to the query request parameter sort

    • info

      added the new enum value HOUR to the query request parameter range

    • info

      added the new enum value MONTH to the query request parameter range

    • info

      added the new enum value NEW to the query request parameter sort

    • info

      added the new enum value RISING to the query request parameter sort

    • info

      added the new enum value TOP to the query request parameter sort

    • info

      added the new enum value WEEK to the query request parameter range

    • info

      added the new enum value YEAR to the query request parameter range