TItikhub
PiPiXia-App-API

搜索接口/Search API

Changed on

[中文]

用途:

  • 搜索接口，支持搜索用户、作品等。

参数:

  • keyword: 搜索关键词。
  • offset: 翻页游标，默认为0，后续页码从上一页返回的 offset Key中获取对应值。
  • search_type: 搜索类型，可用值如下：
    • 1: 综合
    • 8: 热门
    • 9: 新鲜
    • 2：视频
    • 3：图文
    • 4：用户
    • 5：话题

返回:

  • 搜索结果

[English]

Purpose:

  • Search API, support search user, post, etc.

Parameters:

  • keyword: Search keyword.
  • offset: Page cursor, default is 0, get the corresponding value from the offset Key in the previous page.
  • search_type: Search type, available values are as follows:
    • 1: Comprehensive
    • 8: Hot
    • 9: Fresh
    • 2: Video
    • 3: Photo
    • 4: User
    • 5: Hashtag

Return:

  • Search result

[示例/Example]

keyword = "皮皮虾" offset = "0" search_type = "1"

get/api/v1/pipixia/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

keywordstring required

搜索关键词/Search keyword

offsetstring

翻页游标/Page cursor

search_typestring

搜索类型/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

  • 96a122a5f220Revision changes
    • info

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

    • info

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

  • 50f9ec6e1cd3Revision changes
    • 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