名称: sharesight
版本: 1.0.0
描述: 通过 API 管理 Sharesight 的投资组合、持仓和自定义投资
元数据: {"openclaw": {"category": "finance", "requires": {"env": ["SHARESIGHT_CLIENT_ID", "SHARESIGHT_CLIENT_SECRET"]}, "optional_env": ["SHARESIGHT_ALLOW_WRITES"]}}
管理 Sharesight 的投资组合、持仓、自定义投资、价格和票面利率。支持完整的增删改查(CRUD)操作。
设置以下环境变量:
- SHARESIGHT_CLIENT_ID - 您的 Sharesight API 客户端 ID
- SHARESIGHT_CLIENT_SECRET - 您的 Sharesight API 客户端密钥
- SHARESIGHT_ALLOW_WRITES - 设置为 true 以启用创建、更新和删除操作(默认禁用以确保安全)
# 认证(首次使用前必需)
sharesight auth login
# 检查认证状态
sharesight auth status
# 清除已保存的令牌
sharesight auth clear
# 列出所有投资组合
sharesight portfolios list
sharesight portfolios list --consolidated
# 获取投资组合详情
sharesight portfolios get <portfolio_id>
# 列出投资组合中的持仓
sharesight portfolios holdings <portfolio_id>
# 获取业绩报告
sharesight portfolios performance <portfolio_id>
sharesight portfolios performance <portfolio_id> --start-date 2024-01-01 --end-date 2024-12-31
sharesight portfolios performance <portfolio_id> --grouping market --include-sales
# 获取业绩图表数据
sharesight portfolios chart <portfolio_id>
sharesight portfolios chart <portfolio_id> --benchmark SPY.NYSE
# 列出所有投资组合中的持仓
sharesight holdings list
# 获取持仓详情
sharesight holdings get <holding_id>
sharesight holdings get <holding_id> --avg-price --cost-base
sharesight holdings get <holding_id> --values-over-time true
# 更新持仓的股息再投资计划(DRP)设置
sharesight holdings update <holding_id> --enable-drp true --drp-mode up
# drp-mode 选项:up, down, half, down_track
# 删除持仓
sharesight holdings delete <holding_id>
# 列出自定义投资
sharesight investments list
sharesight investments list --portfolio-id <portfolio_id>
# 获取自定义投资详情
sharesight investments get <investment_id>
# 创建自定义投资
sharesight investments create --code TEST --name "测试投资" --country AU --type ORDINARY
# type 选项:ORDINARY, TERM_DEPOSIT, FIXED_INTEREST, PROPERTY, ORDINARY_UNLISTED, OTHER
# 更新自定义投资
sharesight investments update <investment_id> --name "新名称"
# 删除自定义投资
sharesight investments delete <investment_id>
# 列出自定义投资的价格
sharesight prices list <instrument_id>
sharesight prices list <instrument_id> --start-date 2024-01-01 --end-date 2024-12-31
# 创建价格
sharesight prices create <instrument_id> --price 100.50 --date 2024-01-15
# 更新价格
sharesight prices update <price_id> --price 101.00
# 删除价格
sharesight prices delete <price_id>
# 列出固定利息投资的票面利率
sharesight coupon-rates list <instrument_id>
sharesight coupon-rates list <instrument_id> --start-date 2024-01-01
# 创建票面利率
sharesight coupon-rates create <instrument_id> --rate 5.5 --date 2024-01-01
# 更新票面利率
sharesight coupon-rates update <coupon_rate_id> --rate 5.75
# 删除票面利率
sharesight coupon-rates delete <coupon_rate_id>
# 列出国家代码
sharesight countries
sharesight countries --supported
所有命令均输出 JSON 格式。投资组合列表响应示例:
{
"portfolios": [
{
"id": 12345,
"name": "我的投资组合",
"currency_code": "AUD",
"country_code": "AU"
}
]
}
所有日期均使用 YYYY-MM-DD 格式(例如:2024-01-15)。
业绩报告支持以下分组选项:
- country - 按国家分组
- currency - 按货币分组
- market - 按市场分组(默认)
- portfolio - 按投资组合分组
- sector_classification - 按行业分类分组
- industry_classification - 按产业分类分组
- investment_type - 按投资类型分组
- ungrouped - 不分组
出于安全考虑,写操作(创建、更新、删除)默认被禁用。要启用它们,请执行:
export SHARESIGHT_ALLOW_WRITES=true
如果未设置此变量,写命令将失败并返回:
{"error": "写操作默认被禁用。设置 SHARESIGHT_ALLOW_WRITES=true 以启用创建、更新和删除操作。", "hint": "export SHARESIGHT_ALLOW_WRITES=true"}
# 获取当年业绩
sharesight portfolios performance 12345 --start-date 2024-01-01
# 与标普 500 指数对比
sharesight portfolios chart 12345 --benchmark SPY.NYSE
# 列出所有持仓及其成本信息
sharesight holdings get 67890 --avg-price --cost-base
# 为追踪非上市资产创建自定义投资
sharesight investments create --code REALESTATE --name "房地产投资" --country AU --type PROPERTY
# 为该投资添加价格历史
sharesight prices create 123456 --price 500000.00 --date 2024-01-01
sharesight prices create 123456 --price 520000.00 --date 2024-06-01
# 创建定期存款
sharesight investments create --code TD001 --name "ANZ 定期存款" --country AU --type TERM_DEPOSIT
# 设置票面利率
sharesight coupon-rates create 123456 --rate 4.5 --date 2024-01-01
# 利率变动时更新
sharesight coupon-rates update 789 --rate 4.75
# 启用 DRP 并向上取整购买
sharesight holdings update 67890 --enable-drp true --drp-mode up
# 禁用 DRP
sharesight holdings update 67890 --enable-drp false