> ## 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.

# 关注组

> Python SDK Following 模块 - 关注组管理

## 概述

Following 模块提供关注组的管理功能，包括创建、查询、更新和删除关注组，以及管理组内的关注项。

## create\_follow\_group()

创建一个新的关注组。

```python theme={null}
result = client.following.create_follow_group(
    name="My Stocks",
    follow_values=[
        {"follow_type": "company", "follow_value": "US:AAPL"},
        {"follow_type": "company", "follow_value": "HK:00700"}
    ]
)
print(f"创建成功: {result['group_id']}")
```

<ResponseField name="name" type="str">
  组名称
</ResponseField>

<ResponseField name="follow_values" type="list[dict]">
  关注项列表，每个元素包含 `follow_type`（str: "company", "channel"）和 `follow_value`（str）
</ResponseField>

<ResponseField name="返回值" type="dict">
  包含 `group_id`, `name`, `count` 的字典
</ResponseField>

**API 路径**：`POST /v1/following/groups`

***

## get\_follow\_groups()

获取当前用户的所有关注组。

```python theme={null}
groups = client.following.get_follow_groups()
for group in groups:
    print(f"{group['name']}: {group['count']} items")
```

<ResponseField name="返回值" type="list[dict]">
  关注组列表，每个元素包含 `group_id`, `name`, `count`
</ResponseField>

**API 路径**：`GET /v1/following/groups`

***

## get\_follow\_group()

根据 ID 获取一个关注组的详细信息。

```python theme={null}
group = client.following.get_follow_group("group_123")
print(f"{group['name']}: {group['count']} items")
for fv in group.get('follow_values', []):
    print(f"  - {fv['follow_type']}: {fv['follow_value']}")
```

<ResponseField name="group_id" type="str">
  关注组 ID
</ResponseField>

<ResponseField name="返回值" type="dict">
  包含 `group_id`, `name`, `count`, `follow_values` 的字典
</ResponseField>

**API 路径**：`GET /v1/following/groups/{group_id}`

***

## update\_follow\_group()

更新一个关注组的名称。

```python theme={null}
result = client.following.update_follow_group("group_123", name="new name")
print(f"更新成功: {result['name']}")
```

<ResponseField name="group_id" type="str">
  关注组 ID
</ResponseField>

<ResponseField name="name" type="str">
  新的组名称
</ResponseField>

<ResponseField name="返回值" type="dict">
  包含 `group_id`, `name`, `count` 的字典
</ResponseField>

**API 路径**：`POST /v1/following/groups/{group_id}`

***

## delete\_follow\_group()

删除一个关注组。

```python theme={null}
result = client.following.delete_follow_group("group_123")
print(result.get('message', 'deleted'))
```

<ResponseField name="group_id" type="str">
  关注组 ID
</ResponseField>

<ResponseField name="返回值" type="dict">
  操作结果
</ResponseField>

**API 路径**：`DELETE /v1/following/groups/{group_id}`

***

## add\_follows\_to\_group()

向关注组添加关注项。

```python theme={null}
result = client.following.add_follows_to_group(
    "group_123",
    follow_values=[{"follow_type": "company", "follow_value": "US:TSLA"}]
)
print(result.get('message', 'Added'))
```

<ResponseField name="group_id" type="str">
  关注组 ID
</ResponseField>

<ResponseField name="follow_values" type="list[dict]">
  要添加的关注项列表，每个元素包含 `follow_type`（str: "company", "channel"）和 `follow_value`（str）
</ResponseField>

<ResponseField name="返回值" type="dict">
  操作结果
</ResponseField>

**API 路径**：`POST /v1/following/groups/{group_id}/follows`

***

## remove\_follows\_from\_group()

从关注组中移除关注项。

```python theme={null}
result = client.following.remove_follows_from_group("group_123", ["AAPL", "MSFT"])
print(result.get('message', 'Removed'))
```

<ResponseField name="group_id" type="str">
  关注组 ID
</ResponseField>

<ResponseField name="follow_values" type="list[str]">
  要删除的关注值列表（如股票代码、频道 ID）
</ResponseField>

<ResponseField name="返回值" type="dict">
  操作结果
</ResponseField>

**API 路径**：`DELETE /v1/following/groups/{group_id}/follows`

***

## set\_group\_follows()

设置关注组的关注项（替换所有现有关注项）。

```python theme={null}
result = client.following.set_group_follows(
    "group_123",
    follow_values=[
        {"follow_type": "company", "follow_value": "US:AAPL"},
        {"follow_type": "company", "follow_value": "HK:00700"}
    ]
)
print(result.get('message', 'Set'))
```

<ResponseField name="group_id" type="str">
  关注组 ID
</ResponseField>

<ResponseField name="follow_values" type="list[dict]">
  新的关注项列表，每个元素包含 `follow_type`（str: "company", "channel"）和 `follow_value`（str）
</ResponseField>

<ResponseField name="返回值" type="dict">
  操作结果
</ResponseField>

**API 路径**：`PUT /v1/following/groups/{group_id}/follows`

***

## get\_follow\_group\_docs()

获取关注组的文档列表。

```python theme={null}
result = client.following.get_follow_group_docs("group_123", page_num=1, page_size=20)
print(f"total reports: {result['total_count']}")
for item in result['items']:
    print(f"  - {item.get('title', 'Untitled')}")
```

<ResponseField name="group_id" type="str">
  关注组 ID
</ResponseField>

<ResponseField name="page_num" type="int">
  页码，默认值为 `1`
</ResponseField>

<ResponseField name="page_size" type="int">
  每页条目数，默认值为 `10`
</ResponseField>

<ResponseField name="返回值" type="dict">
  包含 `items`, `total_count`, `page_num`, `page_size` 的字典
</ResponseField>

**API 路径**：`GET /v1/following/groups/{group_id}/docs`