Skip to content

docs: US market APIs — CLI v0.25.0 + SDK v4.4.0 (14 new methods)#1137

Open
hogan-yuan wants to merge 46 commits into
mainfrom
docs/cli-openapi-update
Open

docs: US market APIs — CLI v0.25.0 + SDK v4.4.0 (14 new methods)#1137
hogan-yuan wants to merge 46 commits into
mainfrom
docs/cli-openapi-update

Conversation

@hogan-yuan

Copy link
Copy Markdown
Member

Summary

新增美股市场 API 文档(CLI PR #262 / OpenAPI PR #555 / openapi-go PR #106),三语言同步。

CLI v0.25.0

新增命令

  • etf-docs <SYMBOL> — 列出美股 ETF 监管文件(招股书、事实说明书等);--limit
  • financial-report key-metrics — 美股关键财务指标;--report annual|quarterly
  • profit-analysis realized — 美股已实现盈亏;--category stock|option|crypto

已有命令更新(美股账户自动路由)

  • company, valuation, financial-report, consensus, dividend — 添加 US 路由说明
  • order — 新增 --status--action 筛选flag,order detail --attached 关联子委托

SDK v4.4.0 — 14 个新方法(均为 US Only)

FundamentalContext(9 个)

us_company_overview, us_valuation_overview, us_financial_overview, us_financial_statement_v3, us_key_financial_metrics, us_analyst_consensus, us_etf_dividend_info, us_company_dividends, us_etf_files

QuoteContext(1 个)

us_crypto_overview

TradeContext(4 个)

us_query_orders, us_order_detail, us_asset_overview, us_realized_pl

Related PRs

🤖 Generated with Claude Code

hogan-yuan and others added 27 commits July 7, 2026 14:53
Added Response sections to all 9 US fundamental analysis methods documenting their return types and fields:
- us_company_overview
- us_valuation_overview
- us_financial_overview
- us_financial_statement_v3
- us_key_financial_metrics
- us_analyst_consensus
- us_etf_dividend_info
- us_company_dividends
- us_etf_files

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

## 響應

返回一個結構靈活的 JSON 對象 包含關鍵財務指標 (revenue, net income, EPS, margins, growth rates) for the requested period. 具體字段因公司而異。 可通過 CLI 使用 `--format json` 或打印原始響應查看數據結構。

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [AutoCorrect Lint] <AutoCorrect> reported by reviewdog 🐶

Suggested change
返回一個結構靈活的 JSON 對象 包含關鍵財務指標 (revenue, net income, EPS, margins, growth rates) for the requested period. 具體字段因公司而異。 可通過 CLI 使用 `--format json` 或打印原始響應查看數據結構。
返回一個結構靈活的 JSON 對象 包含關鍵財務指標 (revenue, net income, EPS, margins, growth rates) for the requested period. 具體字段因公司而異。可通過 CLI 使用 `--format json` 或打印原始響應查看數據結構。


## 響應

返回一個結構靈活的 JSON 對象 其結構因公司和報告週期而異。 對象包含財務摘要數據 including income, balance sheet, and cash flow indicators. 可通過 CLI 使用 `--format json` 或打印原始響應來查看具體標的的數據結構。

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [AutoCorrect Lint] <AutoCorrect> reported by reviewdog 🐶

Suggested change
返回一個結構靈活的 JSON 對象 其結構因公司和報告週期而異。 對象包含財務摘要數據 including income, balance sheet, and cash flow indicators. 可通過 CLI 使用 `--format json` 或打印原始響應來查看具體標的的數據結構。
返回一個結構靈活的 JSON 對象 其結構因公司和報告週期而異。對象包含財務摘要數據 including income, balance sheet, and cash flow indicators. 可通過 CLI 使用 `--format json` 或打印原始響應來查看具體標的的數據結構。


## 響應

返回一個結構靈活的 JSON 對象 包含分析師一致預期數據 — revenue and EPS forecasts, target price distribution, and buy/hold/sell rating breakdown. 具體字段因數據可用性而異。 可通過 CLI 使用 `--format json` 或打印原始響應查看數據結構。

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [AutoCorrect Lint] <AutoCorrect> reported by reviewdog 🐶

Suggested change
返回一個結構靈活的 JSON 對象 包含分析師一致預期數據 — revenue and EPS forecasts, target price distribution, and buy/hold/sell rating breakdown. 具體字段因數據可用性而異。 可通過 CLI 使用 `--format json` 或打印原始響應查看數據結構。
返回一個結構靈活的 JSON 對象 包含分析師一致預期數據 — revenue and EPS forecasts, target price distribution, and buy/hold/sell rating breakdown. 具體字段因數據可用性而異。可通過 CLI 使用 `--format json` 或打印原始響應查看數據結構。


## 响应

返回一个结构灵活的 JSON 对象 包含关键财务指标 (revenue, net income, EPS, margins, growth rates) for the requested period. 具体字段因公司而异。 可通过 CLI 使用 `--format json` 或打印原始响应查看数据结构。

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [AutoCorrect Lint] <AutoCorrect> reported by reviewdog 🐶

Suggested change
返回一个结构灵活的 JSON 对象 包含关键财务指标 (revenue, net income, EPS, margins, growth rates) for the requested period. 具体字段因公司而异。 可通过 CLI 使用 `--format json` 或打印原始响应查看数据结构。
返回一个结构灵活的 JSON 对象 包含关键财务指标 (revenue, net income, EPS, margins, growth rates) for the requested period. 具体字段因公司而异。可通过 CLI 使用 `--format json` 或打印原始响应查看数据结构。


## 响应

返回一个结构灵活的 JSON 对象 其结构因公司和报告周期而异。 对象包含财务摘要数据 including income, balance sheet, and cash flow indicators. 可通过 CLI 使用 `--format json` 或打印原始响应来查看具体标的的数据结构。

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [AutoCorrect Lint] <AutoCorrect> reported by reviewdog 🐶

Suggested change
返回一个结构灵活的 JSON 对象 其结构因公司和报告周期而异。 对象包含财务摘要数据 including income, balance sheet, and cash flow indicators. 可通过 CLI 使用 `--format json` 或打印原始响应来查看具体标的的数据结构。
返回一个结构灵活的 JSON 对象 其结构因公司和报告周期而异。对象包含财务摘要数据 including income, balance sheet, and cash flow indicators. 可通过 CLI 使用 `--format json` 或打印原始响应来查看具体标的的数据结构。


## 响应

返回一个结构灵活的 JSON 对象 包含分析师一致预期数据 — revenue and EPS forecasts, target price distribution, and buy/hold/sell rating breakdown. 具体字段因数据可用性而异。 可通过 CLI 使用 `--format json` 或打印原始响应查看数据结构。

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [AutoCorrect Lint] <AutoCorrect> reported by reviewdog 🐶

Suggested change
返回一个结构灵活的 JSON 对象 包含分析师一致预期数据 — revenue and EPS forecasts, target price distribution, and buy/hold/sell rating breakdown. 具体字段因数据可用性而异。 可通过 CLI 使用 `--format json` 或打印原始响应查看数据结构。
返回一个结构灵活的 JSON 对象 包含分析师一致预期数据 — revenue and EPS forecasts, target price distribution, and buy/hold/sell rating breakdown. 具体字段因数据可用性而异。可通过 CLI 使用 `--format json` 或打印原始响应查看数据结构。

hogan-yuan and others added 17 commits July 7, 2026 17:12
…example+status+schemas)

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
…example+status+schemas)

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
…ge US 账户不支持' vs 'Longbridge US 账户'
…ncial_metrics/analyst_consensus based on SDK commit 15c713ba0 (9 files)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant