> ## Documentation Index
> Fetch the complete documentation index at: https://docs.reportify.cn/llms.txt
> Use this file to discover all available pages before exploring further.

# Channel Followings Docs

> Get documents from followed channels

## 获取用户关注的账号的文档列表

**URL**: `/v1/channels/{channel_id}/followings/docs`\
**方法**: `GET`\
**描述**: 关注账号文档列表

### 请求参数

| 参数名         | 类型  | 描述               |
| ----------- | --- | ---------------- |
| channel\_id | str | 账号唯一 ID。         |
| page\_num   | int | 当前页码，默认值为 `1`。   |
| page\_size  | int | 每页条目数，默认值为 `10`。 |

### 响应参数

| 参数名             | 类型    | 描述                                                                                                      |
| --------------- | ----- | ------------------------------------------------------------------------------------------------------- |
| page\_num       | int   | 当前页码。                                                                                                   |
| page\_size      | int   | 每页条目数。                                                                                                  |
| total\_page     | int   | 总页数。                                                                                                    |
| total\_count    | int   | 总条目数。                                                                                                   |
| docs            | array | 文档数组，每个文档包含以下字段：                                                                                        |
|   id            | str   | 文档唯一 ID。                                                                                                |
|   title         | str   | 文档标题。                                                                                                   |
|   url           | str   | 文档网页链接。                                                                                                 |
|   institution   | str   | 发布机构。                                                                                                   |
|   author        | str   | 作者。                                                                                                     |
|   published\_at | str   | 发布时间，格式为 `YYYY-MM-DDTHH:MM:SS.000Z`。                                                                    |
|   category      | str   | 文档类别（`financials`, `transcripts`, `reports`, `global_research`, `filings`, `news`, `socials`, `files`）。 |
|   market        | str   | 市场区域（`cn`, `hk`, `us`）。                                                                                 |
|   symbol        | str   | 股票代码。                                                                                                   |
|   company\_name | str   | 公司名称。                                                                                                   |
|   summary       | str   | 文档摘要。*暂未支持*                                                                                             |
|   tags          | dict  | 标签数组。                                                                                                   |
|     key         | str   | 标签类型（如 `industry`, `company`, `person`, `event`）。                                                       |
|     value       | array | 标签内容数组。                                                                                                 |
|   metadatas     | dict  | 元数据数组，包含以下字段：                                                                                           |
|     key         | str   | 元数据类型（如 `periods`, `entities`）。                                                                         |
|     value       | array | 元数据内容数组。                                                                                                |
|   channel\_id   | str   | 账号唯一 ID。                                                                                                |
|   channel\_name | str   | 账号名称。                                                                                                   |


## OpenAPI

````yaml GET /v1/channels/followings/docs
openapi: 3.1.0
info:
  title: Reportify API
  version: 1.0.0
  description: API documentation for Reportify's document management and search services.
servers:
  - url: https://api.reportify.cn
    description: Production server
security:
  - BearerAuth: []
paths:
  /v1/channels/followings/docs:
    get:
      tags:
        - openapi-channels
      summary: Get Channel Docs
      description: Get documents from followed channels
      operationId: get_channel_docs_reportify_api_v1_channels_followings_docs_get
      parameters:
        - description: Channel IDs
          required: false
          schema:
            type: string
            title: Channel Ids
            description: Channel IDs
          name: channel_ids
          in: query
        - required: false
          schema:
            type: integer
            title: Page Num
            default: 1
          name: page_num
          in: query
        - required: false
          schema:
            type: integer
            title: Page Size
            default: 10
          name: page_size
          in: query
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAIChannelDocPagination'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - BearerAuth: []
components:
  schemas:
    OAIChannelDocPagination:
      properties:
        total_count:
          type: integer
          title: Total Count
          default: 0
        total_page:
          type: integer
          title: Total Page
          default: 0
        page_num:
          type: integer
          title: Page Num
          default: 1
        page_size:
          type: integer
          title: Page Size
          default: 10
        docs:
          items:
            $ref: '#/components/schemas/OAIDoc'
          type: array
          title: Docs
          description: List of doc responses.
      type: object
      title: OAIChannelDocPagination
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    OAIDoc:
      properties:
        doc_id:
          type: string
          title: Doc Id
        title:
          type: string
          title: Title
        url:
          type: string
          title: Url
        institution:
          type: string
          title: Institution
        author:
          type: string
          title: Author
        published_at:
          type: integer
          title: Published At
        category:
          $ref: '#/components/schemas/OAIDocCategory'
        market:
          $ref: '#/components/schemas/OAIMarket'
        ticker:
          type: string
          title: Ticker
        symbol:
          type: string
          title: Symbol
        company_name:
          type: string
          title: Company Name
        logo:
          type: string
          title: Logo
        companies:
          items:
            $ref: '#/components/schemas/CompanyLabel'
          type: array
          title: Companies
        tags:
          additionalProperties:
            items: {}
            type: array
          type: object
          title: Tags
        metadatas:
          additionalProperties:
            items: {}
            type: array
          type: object
          title: Metadatas
        report_type:
          type: integer
          title: Report Type
        channel_id:
          type: string
          title: Channel Id
        channel_name:
          type: string
          title: Channel Name
        summary:
          type: string
          title: Summary
          description: Two-line document summary
          nullable: true
      type: object
      required:
        - doc_id
        - title
        - url
      title: OAIDoc
    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
    OAIDocCategory:
      type: string
      enum:
        - financials
        - transcripts
        - reports
        - news
        - files
        - filings
        - socials
        - global_research
      title: OAIDocCategory
      description: An enumeration.
    OAIMarket:
      type: string
      enum:
        - cn
        - hk
        - us
      title: OAIMarket
      description: An enumeration.
    CompanyLabel:
      properties:
        name:
          type: string
          title: Name
        logo:
          type: string
          title: Logo
        stocks:
          items:
            $ref: '#/components/schemas/CompanyStock'
          type: array
          title: Stocks
      type: object
      required:
        - name
      title: CompanyLabel
    CompanyStock:
      properties:
        symbol:
          type: string
          title: Symbol
        market:
          type: string
          title: Market
        code:
          type: string
          title: Code
      type: object
      required:
        - symbol
        - market
        - code
      title: CompanyStock
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Enter your Bearer token

````