Following 模块提供关注组的管理功能,包括创建、查询、更新和删除关注组,以及管理组内的关注项。
createFollowGroup()
创建一个新的关注组。
const result = await client.following.createFollowGroup(
'My Stocks',
[
{ follow_type: 'company', follow_value: 'US:AAPL' },
{ follow_type: 'company', follow_value: 'HK:00700' }
]
);
console.log(`Created group: ${result.group_id}`);
followValues
Array<{ follow_type: 'company' | 'channel'; follow_value: string }>
关注项列表,每个元素包含 follow_type(string)和 follow_value(string)
返回值
Promise<{ group_id: string; name: string; count: number }>
包含 group_id, name, count 的对象
API 路径:POST /v1/following/groups
getFollowGroups()
获取当前用户的所有关注组。
const groups = await client.following.getFollowGroups();
groups.forEach(group => {
console.log(`${group.name}: ${group.count} items`);
});
返回值
Promise<Array<{ group_id: string; name: string; count: number }>>
关注组列表
API 路径:GET /v1/following/groups
getFollowGroup()
根据 ID 获取一个关注组的详细信息。
const group = await client.following.getFollowGroup('group_123');
console.log(`${group.name}: ${group.count} items`);
group.follow_values?.forEach(fv => {
console.log(` - ${fv.follow_type}: ${fv.follow_value}`);
});
返回值
Promise<{ group_id: string; name: string; count: number; follow_values?: Array<{ follow_type: string; follow_value: string }> }>
包含 group_id, name, count, follow_values 的对象
API 路径:GET /v1/following/groups/{group_id}
updateFollowGroup()
更新一个关注组的名称。
const result = await client.following.updateFollowGroup('group_123', 'new name');
console.log(`Updated: ${result.name}`);
返回值
Promise<{ group_id: string; name: string; count: number }>
包含 group_id, name, count 的对象
API 路径:POST /v1/following/groups/{group_id}
deleteFollowGroup()
删除一个关注组。
await client.following.deleteFollowGroup('group_123');
console.log('Deleted');
API 路径:DELETE /v1/following/groups/{group_id}
addFollowsToGroup()
向关注组添加关注项。
await client.following.addFollowsToGroup('group_123', [
{ follow_type: 'company', follow_value: 'US:TSLA' }
]);
console.log('Added');
followValues
Array<{ follow_type: 'company' | 'channel'; follow_value: string }>
要添加的关注项列表
API 路径:POST /v1/following/groups/{group_id}/follows
removeFollowsFromGroup()
从关注组中移除关注项。
await client.following.removeFollowsFromGroup('group_123', ['AAPL', 'MSFT']);
console.log('Removed');
API 路径:DELETE /v1/following/groups/{group_id}/follows
setGroupFollows()
设置关注组的关注项(替换所有现有关注项)。
await client.following.setGroupFollows('group_123', [
{ follow_type: 'company', follow_value: 'US:AAPL' },
{ follow_type: 'company', follow_value: 'HK:00700' }
]);
console.log('Set');
followValues
Array<{ follow_type: 'company' | 'channel'; follow_value: string }>
新的关注项列表
API 路径:PUT /v1/following/groups/{group_id}/follows
getFollowGroupDocs()
获取关注组的文档列表。
const result = await client.following.getFollowGroupDocs('group_123', 1, 20);
console.log(`Total: ${result.total_count}`);
result.items.forEach(doc => {
console.log(` - ${doc.title || 'Untitled'}`);
});
返回值
Promise<{ items: any[]; total_count: number; page_num: number; page_size: number }>
包含 items, total_count, page_num, page_size 的对象
API 路径:GET /v1/following/groups/{group_id}/docs