# 获取蒲公英博主笔记案例/Get PGY blogger note cases

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v1/xiaohongshu/pgy/get_blogger_notes:
    post:
      summary: 获取蒲公英博主笔记案例/Get PGY blogger note cases
      deprecated: false
      description: >-
        # [中文]

        ### 用途:

        - 分页获取博主的笔记明细，对应博主主页「笔记数据 → 笔记案例」

        - 想看「这个博主接过哪些商单」，把 note_type 设为 3(合作笔记)

        - **本接口只覆盖原生笔记，少数博主（笔记以跨平台/跨域内容为主）会返回空列表
          （total 为 0）。遇到这种情况改用 `/get_blogger_notes_v2`（覆盖范围更广，返回字段结构不同）**
        ### 请求体参数:

        - user_id: **必填**，博主用户ID

        - page_number: 页码，从 1 开始（注意本接口是 page_number，不是 page_num）

        - page_size: 每页数量，**1-8**（蒲公英网页固定 8，不能更大）

        - note_type: 笔记类型，4=全部类型(默认) 3=合作笔记 1=图文 2=视频
          **注意**: 与 /get_blogger_notes_rate、/get_blogger_core_data 的同名参数取值不同
          （那两个是 1=图文 2=视频 3=图文+视频）。照搬 note_type=3 会从「合作笔记」
          静默变成「图文+视频」，不会报错
        - order_type: 排序，1=最新发布(默认) 2=阅读最多 3=互动最多

        - advertise_switch: 流量类型，1=全部(含商业合作，默认) 0=仅自然流量

        - feature_tag: 按内容特征筛选，如 "韩系"（取值见博主详情的 featureTags）

        - content_tag: 按内容类目筛选，如 "美妆"（取值见博主详情的 contentTags）

        - is_third_platform: 1=只看跨域合作笔记 0=不限(默认)

        ### 返回:

        - list[]: 笔记数组，每条含 noteId / title / imgUrl(封面) / date(发布日期) /
        isVideo(是否视频)

        - 数据: readNum(阅读) / likeNum(点赞) / collectNum(收藏) /
        thirdReadUserNum(站外阅读人数)

        - 合作: isAdvertise(是否商业合作) / brandName(合作品牌)

        - total: 命中总数（随筛选变化，可据此算总页数）

        - 拿到 noteId 后可调 /get_note_detail 查正文、图片/视频与完整互动数据

        - **注意**: 本接口的封面字段是 `imgUrl`，`/get_blogger_notes_v2` 是 `imageUrl`，一字之差

        ### 翻页:

        - 只改 page_number，其余参数原样保持不变；翻到某页返回空数组即没有更多


        ### 响应结构（取数要剥两层）:

        - `resp["data"]` 是蒲公英原样信封（含 `code`/`msg`/`success`），业务数据还在它里面一层

        - 正确取法：`data = resp["data"]["data"]`；下面「返回」列的字段都在这一层下

        ### 计费:

        - HTTP 200 → **计费**。包含「查无结果」（`data` 为 null，如 ID 不存在或筛选无命中）——
          请求已送达蒲公英，同样扣费，不要因为拿不到数据就重试
        - HTTP 400 → 不计费（参数格式非法，或上游资源不足/异常）


        # [English]

        ### Purpose:

        - Paginated note list of a blogger ("Note Data → Note Cases" on the PGY
        blogger page)

        - To inspect sponsored posts only, set note_type=3

        ### Request Body Parameters:

        - user_id: **required**, blogger user ID

        - page_number: page number from 1 (note: this endpoint uses page_number,
        not page_num)

        - page_size: **1-8** (fixed at 8 on the PGY web page, cannot be larger)

        - note_type: 4=all (default), 3=sponsored, 1=image-text, 2=video
          **Warning**: the same parameter means something else in /get_blogger_notes_rate
          and /get_blogger_core_data (1=image-text, 2=video, 3=both). Copying note_type=3
          across silently switches "sponsored" to "image-text+video" with no error
        - order_type: 1=newest (default), 2=most read, 3=most engaged

        - advertise_switch: 1=all traffic incl. sponsored (default), 0=organic
        only

        - feature_tag: filter by feature tag, e.g. "韩系" (see featureTags in
        blogger detail)

        - content_tag: filter by content category, e.g. "美妆" (see contentTags in
        blogger detail)

        - is_third_platform: 1=cross-platform sponsored notes only, 0=no limit
        (default)

        ### Return:

        - list[]: notes with noteId / title / imgUrl (cover) / date (publish
        date) / isVideo

        - Metrics: readNum / likeNum / collectNum / thirdReadUserNum (off-site
        readers)

        - Sponsorship: isAdvertise / brandName

        - total: match count (varies with filters — use it to compute page
        count)

        - Feed noteId into /get_note_detail for full body, media and engagement
        data

        - **Note**: cover key here is `imgUrl`; `/get_blogger_notes_v2` uses
        `imageUrl`

        ### Paging:

        - Change page_number only, keep other params identical; an empty array
        means no more data

        ### Note:

        - This endpoint only covers native notes; a few bloggers (whose notes
        are mostly
          cross-platform) return an empty list (total 0). In that case use `/get_blogger_notes_v2`
          (wider coverage, different response shape).

        ### Response shape (two layers):

        - `resp["data"]` is PGY's raw envelope (with `code`/`msg`/`success`);
        the payload is one level deeper

        - Correct access: `data = resp["data"]["data"]` — every field listed
        under "Return" lives here

        ### Billing:

        - HTTP 200 → **charged**, including "no result" (`data` is null, e.g. ID
        not found or filters matched
          nothing): the request did reach PGY, so retrying on empty data just burns quota
        - HTTP 400 → not charged (malformed params, or upstream
        unavailable/error)


        # [示例/Example]

        ```json

        // ① 最近发布的全部笔记

        {"user_id": "5c668b3e0000000012021605", "page_number": 1, "page_size":
        8}


        // ② 只看合作笔记（商单）

        {"user_id": "5c668b3e0000000012021605", "page_number": 1, "page_size":
        8, "note_type": 3}


        // ③ 只看视频、按互动排序

        {"user_id": "5c668b3e0000000012021605", "page_number": 1, "page_size":
        8, "note_type": 2, "order_type": 2}


        // ④ 只看广告投放过的笔记

        {"user_id": "5c668b3e0000000012021605", "page_number": 1, "page_size":
        8, "advertise_switch": 1}


        // ⑤ 按类目过滤

        {"user_id": "5c668b3e0000000012021605", "page_number": 1, "page_size":
        8, "content_tag": "美妆"}

        ```


        **返空时改用 `/get_blogger_notes_v2`**：本接口走原生 KOL 链路，对跨域博主可能返回空列表。

        两个接口的返回结构不同（v2 在 `noteList[].noteInfo` 下），解析代码不能混用。


        If this returns an empty list for a cross-domain blogger, switch to
        `/get_blogger_notes_v2`.

        Their response shapes differ — do not reuse the same parser.
      operationId: get_blogger_notes_api_v1_xiaohongshu_pgy_get_blogger_notes_post
      tags:
        - Xiaohongshu-PGY-API
        - Xiaohongshu-PGY-API
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotesReq'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseModel'
          headers: {}
          x-apifox-name: ''
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          headers: {}
          x-apifox-name: ''
      security:
        - HTTPBearer: []
          x-apifox:
            schemeGroups:
              - id: 4Zf5m0NuynFItjXe5Ofon
                schemeIds:
                  - HTTPBearer
            required: true
            use:
              id: 4Zf5m0NuynFItjXe5Ofon
            scopes:
              4Zf5m0NuynFItjXe5Ofon:
                HTTPBearer: []
      x-apifox-folder: Xiaohongshu-PGY-API
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/4705614/apis/api-479321009-run
components:
  schemas:
    NotesReq:
      properties:
        user_id:
          type: string
          title: User Id
          description: 博主用户ID/Blogger user ID
          examples:
            - 5c668b3e0000000012021605
        page_number:
          type: integer
          maximum: 1000
          minimum: 1
          title: Page Number
          description: 页码，从 1 开始/Page number, from 1
          default: 1
          examples:
            - 1
        page_size:
          type: integer
          maximum: 8
          minimum: 1
          title: Page Size
          description: 每页数量，1-8（蒲公英网页固定 8）/Page size, 1-8 (fixed at 8 on PGY web)
          default: 8
          examples:
            - 8
        note_type:
          type: integer
          enum:
            - 1
            - 2
            - 3
            - 4
          title: Note Type
          description: 笔记类型 4=全部类型(默认) 3=合作笔记 1=图文 2=视频/Note type
          default: 4
          examples:
            - 4
        order_type:
          type: integer
          enum:
            - 1
            - 2
            - 3
          title: Order Type
          description: 排序 1=最新发布(默认) 2=阅读最多 3=互动最多/Sort
          default: 1
          examples:
            - 1
        advertise_switch:
          type: integer
          enum:
            - 0
            - 1
          title: Advertise Switch
          description: 流量类型 1=全部(含商业合作) 0=仅自然流量/Traffic type
          default: 1
          examples:
            - 1
        feature_tag:
          type: string
          maxLength: 64
          title: Feature Tag
          description: 按内容特征筛选，如 韩系；取值见博主详情的 featureTags/Filter by feature tag
          default: ''
          examples:
            - 韩系
        content_tag:
          type: string
          maxLength: 64
          title: Content Tag
          description: 按内容类目筛选，如 美妆；取值见博主详情的 contentTags/Filter by content tag
          default: ''
          examples:
            - 美妆
        is_third_platform:
          type: integer
          enum:
            - 0
            - 1
          title: Is Third Platform
          description: 1=只看跨域合作笔记 0=不限(默认)/Cross-platform notes only
          default: 0
          examples:
            - 0
      additionalProperties: false
      type: object
      required:
        - user_id
      title: NotesReq
      x-apifox-orders:
        - user_id
        - page_number
        - page_size
        - note_type
        - order_type
        - advertise_switch
        - feature_tag
        - content_tag
        - is_third_platform
      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
        input:
          type: string
        ctx:
          type: object
          title: Context
          x-apifox-orders: []
          properties: {}
          x-apifox-ignore-properties: []
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
      x-apifox-orders:
        - loc
        - msg
        - type
        - input
        - ctx
      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: []

```