# 获取学校搜索/Fetch school search

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v1/douyin/search/fetch_school_search:
    post:
      summary: 获取学校搜索/Fetch school search
      deprecated: false
      description: >-
        # [中文]

        ### 用途:

        - 获取抖音 App 中学校信息的搜索结果。

        - 根据关键词返回学校名称列表，常用于用户设置学校资料、兴趣推荐等场景。


        ### 备注:

        - 本接口专注于学校信息搜索，仅返回学校的名称字段。

        - 初次请求时 `cursor` 应传 0，分页时使用上一次返回的 `cursor`。

        - 本接口响应体较简单，适合快速检索学校数据。


        ### 参数:

        - keyword: 搜索关键词，如学校名称 "北京大学"、地区名 "北京"


        ### 请求体示例：

        ```json

        payload = {
            "keyword": "北京大学"
        }

        ```


        ### 返回（部分常用字段，实际返回字段更多，一切以实际响应为准）:

        - `schools[]`: 学校列表
          - `name`: 学校名称（如 "北京大学"、"北京四中"）
        - `extra`:
          - `now`: 当前服务器时间戳（毫秒）
          - `logid`: 请求日志ID
          - `fatal_item_ids`: 错误项目ID列表（通常为空）
        - `log_pb`:
          - `impr_id`: 曝光追踪ID（用于链路追踪）
        - `status_code`: 状态码（0=成功）

        - `status_msg`: 状态信息（通常为空）


        # [English]

        ### Purpose:

        - Fetch school information search results from Douyin App.

        - Returns a list of school names based on the input keyword, useful for
        user profile settings, school recommendations, etc.


        ### Notes:

        - This API focuses on school information search, and only returns school
        names.

        - Set `cursor` to 0 for the first request; for pagination, use the
        cursor from the last response.

        - The response structure is simple and lightweight for fast lookup.


        ### Parameters:

        - keyword: Search keyword, e.g., school name "Peking University" or city
        "Beijing"


        ### Example Request Body:

        ```json

        payload = {
            "keyword": "Peking University"
        }

        ```


        ### Response (common fields, actual response may contain more fields):

        - `schools[]`: List of schools
          - `name`: School name (e.g., "Peking University", "Beijing No.4 High School")
        - `extra`:
          - `now`: Server timestamp in milliseconds
          - `logid`: Log ID for request tracing
          - `fatal_item_ids`: List of fatal item IDs (usually empty)
        - `log_pb`:
          - `impr_id`: Impression ID for tracking
        - `status_code`: Status code (0=success)

        - `status_msg`: Status message (usually empty)
      operationId: fetch_school_search_api_v1_douyin_search_fetch_school_search_post
      tags:
        - Douyin-Search-API
        - Douyin-Search-API
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SchoolSearchRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseModel'
          headers: {}
          x-apifox-name: OK
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          headers: {}
          x-apifox-name: Unprocessable Entity
      security:
        - HTTPBearer: []
          x-apifox:
            schemeGroups:
              - id: K1LKKlRTsYr62kqY3Og8k
                schemeIds:
                  - HTTPBearer
            required: true
            use:
              id: K1LKKlRTsYr62kqY3Og8k
            scopes:
              K1LKKlRTsYr62kqY3Og8k:
                HTTPBearer: []
      x-apifox-folder: Douyin-Search-API
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/4705614/apis/api-370212799-run
components:
  schemas:
    SchoolSearchRequest:
      properties:
        keyword:
          type: string
          title: Keyword
          description: 关键词，如学校名称或所在地区 / Keyword, such as school name or location
          default: 北京
      type: object
      title: SchoolSearchRequest
      x-apifox-orders:
        - keyword
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    ResponseModel:
      properties:
        code:
          type: integer
          title: Code
          description: HTTP status code | HTTP状态码
          default: 200
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Request Id
          description: Unique request identifier | 唯一请求标识符
        message:
          type: string
          title: Message
          description: Response message (EN-US) | 响应消息 (English)
          default: Request successful. This request will incur a charge.
        message_zh:
          type: string
          title: Message Zh
          description: Response message (ZH-CN) | 响应消息 (中文)
          default: 请求成功，本次请求将被计费。
        support:
          type: string
          title: Support
          description: Support message | 支持消息
          default: 'Discord: https://discord.gg/aMEAS8Xsvz'
        time:
          type: string
          title: Time
          description: The time the response was generated | 生成响应的时间
        time_stamp:
          type: integer
          title: Time Stamp
          description: The timestamp the response was generated | 生成响应的时间戳
        time_zone:
          type: string
          title: Time Zone
          description: The timezone of the response time | 响应时间的时区
          default: America/Los_Angeles
        docs:
          anyOf:
            - type: string
            - type: 'null'
          title: Docs
          description: >-
            Link to the API Swagger documentation for this endpoint | 此端点的 API
            Swagger 文档链接
        cache_message:
          anyOf:
            - type: string
            - type: 'null'
          title: Cache Message
          description: Cache message (EN-US) | 缓存消息 (English)
          default: >-
            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.
        cache_message_zh:
          anyOf:
            - type: string
            - type: 'null'
          title: Cache Message Zh
          description: Cache message (ZH-CN) | 缓存消息 (中文)
          default: >-
            本次响应已缓存，可通过下方 URL 直接查看，有效期 24
            小时，访问缓存链接无额外费用。缓存仅用于请求溯源，不影响接口数据的时效性，也不会再次通过接口返回。
        cache_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Cache Url
          description: The URL to access the cached result | 访问缓存结果的 URL
        router:
          type: string
          title: Router
          description: The endpoint that generated this response | 生成此响应的端点
          default: ''
        params:
          type: string
        data:
          anyOf:
            - type: string
            - type: 'null'
          title: Data
          description: The response data | 响应数据
      type: object
      title: ResponseModel
      x-apifox-orders:
        - code
        - request_id
        - message
        - message_zh
        - support
        - time
        - time_stamp
        - time_zone
        - docs
        - cache_message
        - cache_message_zh
        - cache_url
        - router
        - params
        - data
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
      x-apifox-orders:
        - detail
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
      x-apifox-orders:
        - loc
        - msg
        - type
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
  securitySchemes:
    HTTPBearer:
      type: bearer
      description: >
        ----

        #### API Token Introduction:

        ##### Method 1: Use API Token in the Request Header (Recommended)

        - **Header**: `Authorization`

        - **Format**: `Bearer {token}`

        - **Example**: `{"Authorization": "Bearer your_token"}`

        - **Swagger UI**: Click on the `Authorize` button in the upper right
        corner of the page to enter the API token directly without the `Bearer`
        keyword.


        ##### Method 2: Use API Token in the Cookie (Not Recommended, Use Only
        When Method 1 is Unavailable)

        - **Cookie**: `Authorization`

        - **Format**: `Bearer {token}`

        - **Example**: `Authorization=Bearer your_token`


        #### Get API Token:

        1. Register and log in to your account on the TikHub website.

        2. Go to the user center, click on the API token menu, and create an API
        token.

        3. Copy and use the API token in the request header.

        4. Keep your API token confidential and use it only in the request
        header.


        ----


        #### API令牌简介:

        ##### 方法一：在请求头中使用API令牌（推荐）

        - **请求头**: `Authorization`

        - **格式**: `Bearer {token}`

        - **示例**: `{"Authorization": "Bearer your_token"}`

        - **Swagger UI**: 点击页面右上角的`Authorize`按钮，直接输入API令牌，不需要`Bearer`关键字。


        ##### 方法二：在Cookie中使用API令牌（不推荐，仅在无法使用方法一时使用）

        - **Cookie**: `Authorization`

        - **格式**: `Bearer {token}`

        - **示例**: `Authorization=Bearer your_token`


        #### 获取API令牌:

        1. 在TikHub网站注册并登录账户。

        2. 进入用户中心，点击API令牌菜单，创建API令牌。

        3. 复制并在请求头中使用API令牌。

        4. 保密您的API令牌，仅在请求头中使用。
      scheme: bearer
servers:
  - url: https://api.tikhub.io
    description: Production Environment
security: []

```