Lemon8-App-API

搜索接口/Search API

Changed on

[中文]

用途:

  • 搜索接口

参数:

  • query: 搜索关键词
  • max_cursor: 翻页参数,可以从上一次请求的返回结果中获取,第一次请求为空,后续请求使用上一次请求返回的max_cursor进行翻页,可以通过返回结果的has_more字段判断是否还有更多数据。
  • filter_type: 搜索过滤类型,默认为空字符串,可选值如下:
    • 空字符串:All(全部,默认使用此参数搜索)
    • video:只搜索视频作品
    • posts:只搜索文章作品
  • order_by: 搜索排序方式,默认为空字符串,可选值如下:
    • 空字符串:Relevance(相关度,默认使用此参数排序)
    • popular:流行度排序
    • recent:从新到旧排序
  • search_tab: 搜索类型,默认为main,可选值如下:
    • main:APP中显示为 Top(综合搜索,默认使用此参数搜索)
    • user:APP中显示为 Accounts (搜索用户账号)
    • hashtag:APP中显示为 Hashtags(搜索话题)
    • article:APP中显示为 Posts(搜索文章)

返回:

  • 搜索结果

[English]

Purpose:

  • Search API

Parameters:

  • query: Search keyword
  • max_cursor: Pagination parameter, can be obtained from the return result of the last request. It is empty for the first request, and the max_cursor returned by the last request is used for subsequent requests. You can judge whether there is more data by the has_more field in the return result.
  • filter_type: Search filter type, default is an empty string, optional values are as follows:
    • Empty string: All (default using this parameter to search)
    • video: Search only video
    • posts: Search only posts
  • order_by: Search sort type, default is an empty string, optional values are as follows:
    • Empty string: Relevance (default using this parameter to sort)
    • popular: Sort by popularity
    • recent: Sort from new to old
  • search_tab: Search type, default is main, optional values are as follows:
    • main: Display as Top in the APP (comprehensive search, default using this parameter to search)
    • user: Display as Accounts in the APP (search user accounts)
    • hashtag: Display as Hashtags in the APP (search hashtags)
    • article: Display as Posts in the APP (search articles)

Return:

  • Search results

[示例/Example]

query = "lemon8" max_cursor = "" filter_type = "" order_by = "" search_tab = "main"

get/api/v1/lemon8/app/fetch_search

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

querystring required

搜索关键词/Search keyword

max_cursorstring

翻页参数/Pagination parameter

filter_typestring

搜索过滤类型/Search filter type

order_bystring

搜索排序方式/Search sort type

search_tabstring

搜索类型/Search type

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

    • info

      the response's property default value changed from This request will be cached. You can access the cached result directly using the URL below valid for 24 hours. Accessing the cache will not incur additional charges. to This response is cached and accessible via the URL below for 24 hours at no extra cost. The cache is for request tracing only — it doesn't affect the API's data freshness and won't be returned through the API again. for the status

    • info

      the response's property default value changed from 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 to 本次响应已缓存,可通过下方 URL 直接查看,有效期 24 小时,访问缓存链接无额外费用。缓存仅用于请求溯源,不影响接口数据的时效性,也不会再次通过接口返回。 for the status