Skip to content
On this page

Hashtag List

  • Endpoint Path: /api/v2/hashtag/list
  • Method: GET
  • Request: Query

Headers Optional Parameter

Parameter NamePublic Mode (Required)Private Mode (Required)
X-Fresns-Aidoptionalrequired
X-Fresns-Aid-Tokenoptionalrequired
X-Fresns-Uidoptionalrequired
X-Fresns-Uid-Tokenoptionalrequired

Body Params

Parameter NameTypeRequiredDescription
createDateStringoptional创建日期:today,yesterday,week,lastWeek,month,lastMonth,year,lastYear
createDateGtStringoptional创建时间大于 Y-m-d
createDateLtStringoptional创建时间小于 Y-m-d
likeCountGtNumberoptional点赞数大于
likeCountLtNumberoptional点赞数小于
followCountGtNumberoptional关注数大于
followCountLtNumberoptional关注数小于
blockCountGtNumberoptional屏蔽数大于
blockCountLtNumberoptional屏蔽数小于
postCountGtNumberoptional帖子数大于
postCountLtNumberoptional帖子数小于
postDigestCountGtNumberoptional精华数大于
postDigestCountLtNumberoptional精华数小于
orderTypeStringoptional排序类型 createDate,like,follow,block,post,postDigest
默认 createDate
orderDirectionStringoptional排序方向 asc,desc,默认 desc
whitelistKeysStringoptional白名单键名,只返回给定键名的键值对
多个以英文逗号隔开,支持「点表示法」表示多维数组
blacklistKeysStringoptional黑名单键名,从返回数据中删除指定的键值对
多个以英文逗号隔开,支持「点表示法」表示多维数组
pageSizeNumberoptional每页显示条数(默认 30 条)
pageNumberoptional页码(默认 1)

Return

json
{
    "code": 0,
    "message": "ok",
    "data": {
        "pagination": {
            "total": "Number / How much data in total",
            "current": "Number / Current page number",
            "pageSize": "Number / How much data on each page",
            "lastPage": "Number / Last page number"
        },
        "list": [
            {
                // Common Data Structure -> Hashtag Info
            }
        ]
    }
}

Released under the Apache-2.0 License