From 10e2ac637affd28351abc113ae68ec32e46e6d77 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 14:53:13 +0800 Subject: [PATCH 01/51] docs(cli): add etf-docs command (US only) --- docs/en/docs/cli/fundamentals/etf-docs.md | 49 ++++++++++++++++++++ docs/zh-CN/docs/cli/fundamentals/etf-docs.md | 49 ++++++++++++++++++++ docs/zh-HK/docs/cli/fundamentals/etf-docs.md | 49 ++++++++++++++++++++ 3 files changed, 147 insertions(+) create mode 100644 docs/en/docs/cli/fundamentals/etf-docs.md create mode 100644 docs/zh-CN/docs/cli/fundamentals/etf-docs.md create mode 100644 docs/zh-HK/docs/cli/fundamentals/etf-docs.md diff --git a/docs/en/docs/cli/fundamentals/etf-docs.md b/docs/en/docs/cli/fundamentals/etf-docs.md new file mode 100644 index 00000000..56908051 --- /dev/null +++ b/docs/en/docs/cli/fundamentals/etf-docs.md @@ -0,0 +1,49 @@ +--- +title: 'etf-docs' +sidebar_label: 'etf-docs' +sidebar_position: 21 +--- + +# longbridge etf-docs + +List regulatory documents for a US ETF — prospectus, fact sheets, and other filings. + +:::warning US Only +This command is only available for US data-center accounts. +::: + +## Basic Usage + +```bash +longbridge etf-docs IVV.US +``` + +``` +Name +---- +iShares Core S&P 500 ETF Prospectus +iShares Core S&P 500 ETF Statement of Additional Information +iShares Core S&P 500 ETF Annual Report +... +``` + +## Examples + +### List ETF documents + + +longbridge etf-docs IVV.US +longbridge etf-docs SPY.US + + +### Limit number of results + +```bash +longbridge etf-docs IVV.US --limit 5 +``` + +## Options + +| Option | Description | Default | +| ------ | ----------- | ------- | +| `--limit` | Maximum number of documents to return | 10 | diff --git a/docs/zh-CN/docs/cli/fundamentals/etf-docs.md b/docs/zh-CN/docs/cli/fundamentals/etf-docs.md new file mode 100644 index 00000000..150e5892 --- /dev/null +++ b/docs/zh-CN/docs/cli/fundamentals/etf-docs.md @@ -0,0 +1,49 @@ +--- +title: 'etf-docs' +sidebar_label: 'etf-docs' +sidebar_position: 21 +--- + +# longbridge etf-docs + +列出美股 ETF 的监管文件，包括招股书、事实说明书及申报文件。 + +:::warning 仅限美股账户 +此命令仅适用于美国数据中心账户。 +::: + +## 基本用法 + +```bash +longbridge etf-docs IVV.US +``` + +``` +Name +---- +iShares Core S&P 500 ETF Prospectus +iShares Core S&P 500 ETF Statement of Additional Information +iShares Core S&P 500 ETF Annual Report +... +``` + +## 示例 + +### 列出 ETF 文件 + + +longbridge etf-docs IVV.US +longbridge etf-docs SPY.US + + +### 限制返回数量 + +```bash +longbridge etf-docs IVV.US --limit 5 +``` + +## 选项 + +| 选项 | 描述 | 默认值 | +| ---- | ---- | ------ | +| `--limit` | 返回文件数量上限 | 10 | diff --git a/docs/zh-HK/docs/cli/fundamentals/etf-docs.md b/docs/zh-HK/docs/cli/fundamentals/etf-docs.md new file mode 100644 index 00000000..185c8cfc --- /dev/null +++ b/docs/zh-HK/docs/cli/fundamentals/etf-docs.md @@ -0,0 +1,49 @@ +--- +title: 'etf-docs' +sidebar_label: 'etf-docs' +sidebar_position: 21 +--- + +# longbridge etf-docs + +列出美股 ETF 的監管文件，包括招股書、事實說明書及申報文件。 + +:::warning 僅限美股賬戶 +此命令僅適用於美國數據中心賬戶。 +::: + +## 基本用法 + +```bash +longbridge etf-docs IVV.US +``` + +``` +Name +---- +iShares Core S&P 500 ETF Prospectus +iShares Core S&P 500 ETF Statement of Additional Information +iShares Core S&P 500 ETF Annual Report +... +``` + +## 示例 + +### 列出 ETF 文件 + + +longbridge etf-docs IVV.US +longbridge etf-docs SPY.US + + +### 限制返回數量 + +```bash +longbridge etf-docs IVV.US --limit 5 +``` + +## 選項 + +| 選項 | 描述 | 默認值 | +| ---- | ---- | ------ | +| `--limit` | 返回文件數量上限 | 10 | From 3691e93f07c1432bd22eaa7c80fed9d81d4b997b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 14:54:18 +0800 Subject: [PATCH 02/51] docs(cli): update order command with US flags (--status, --action, --attached) --- docs/en/docs/cli/orders/order.md | 30 +++++++++++++++++++++++++++++ docs/zh-CN/docs/cli/orders/order.md | 30 +++++++++++++++++++++++++++++ docs/zh-HK/docs/cli/orders/order.md | 27 ++++++++++++++++++++++++++ 3 files changed, 87 insertions(+) diff --git a/docs/en/docs/cli/orders/order.md b/docs/en/docs/cli/orders/order.md index b4767680..ba44f417 100644 --- a/docs/en/docs/cli/orders/order.md +++ b/docs/en/docs/cli/orders/order.md @@ -89,6 +89,28 @@ longbridge order detail 701276261045858304 Returns execution details, timestamps, and fill information for the order. +### View attached child order (US accounts) + +```bash +longbridge order detail 701276261045858304 --attached +``` + +Fetches the order detail along with its attached child order (e.g. bracket or OCO orders). US accounts only. + +### Filter US orders by status and side + +```bash +# Pending orders only +longbridge order --status pending + +# Filled buy orders +longbridge order --status history --action buy +``` + +:::info US Accounts +For US data-center accounts, `order` routes to the US API automatically. Use `--status` and `--action` to filter US order history. These flags are ignored for non-US accounts. +::: + ### Cancel a pending order ```bash @@ -107,6 +129,14 @@ longbridge order replace 701276261045858304 --qty 5 --price 350.00 `--qty` is required. Omit `--price` to keep the current limit price. Use `-y` to skip the confirmation prompt in scripts. +## Options + +| Option | Description | Default | +| ------ | ----------- | ------- | +| `--status` | Filter orders: `pending` \| `history` \| `all` (US accounts) | all | +| `--action` | Filter by side: `buy` \| `sell` (US accounts) | — | +| `--attached` | Show attached child order in `order detail` (US accounts) | false | + ## Requirements OAuth trade permission is required to place, cancel, or replace orders. See the [trade permission setup](/docs/trade/) guide to enable trading access. diff --git a/docs/zh-CN/docs/cli/orders/order.md b/docs/zh-CN/docs/cli/orders/order.md index fda7e508..5f46aa38 100644 --- a/docs/zh-CN/docs/cli/orders/order.md +++ b/docs/zh-CN/docs/cli/orders/order.md @@ -89,6 +89,28 @@ longbridge order detail 701276261045858304 返回该委托的成交明细、时间戳和成交信息。 +### 查看关联子委托（美股账户） + +```bash +longbridge order detail 701276261045858304 --attached +``` + +同时获取关联的子委托（如括号单、OCO 委托）。仅限美股账户。 + +### 按状态和方向筛选委托（美股账户） + +```bash +# 仅查看待成交委托 +longbridge order --status pending + +# 查看历史买入委托 +longbridge order --status history --action buy +``` + +:::info 美股账户 +美国数据中心账户会自动路由至美股 API。`--status` 和 `--action` 仅对美股账户生效。 +::: + ### 撤销待成交委托 ```bash @@ -107,6 +129,14 @@ longbridge order replace 701276261045858304 --qty 5 --price 350.00 `--qty` 为必填项。省略 `--price` 则保持当前限价不变。在脚本中使用 `-y` 跳过确认提示。 +## 选项 + +| 选项 | 描述 | 默认值 | +| ---- | ---- | ------ | +| `--status` | 委托状态筛选：`pending` \| `history` \| `all`（美股账户） | all | +| `--action` | 方向筛选：`buy` \| `sell`（美股账户） | — | +| `--attached` | 在 `order detail` 中显示关联子委托（美股账户） | false | + ## 权限要求 提交、撤销或修改委托需要 OAuth 交易权限。详见 [交易权限设置](/zh-CN/docs/trade/) 指南以开启交易访问。 diff --git a/docs/zh-HK/docs/cli/orders/order.md b/docs/zh-HK/docs/cli/orders/order.md index f5cffe2f..9ea34b1d 100644 --- a/docs/zh-HK/docs/cli/orders/order.md +++ b/docs/zh-HK/docs/cli/orders/order.md @@ -89,6 +89,25 @@ longbridge order detail 701276261045858304 返回該委託的成交明細、時間戳和成交資訊。 +### 查看關聯子委託（美股賬戶） + +```bash +longbridge order detail 701276261045858304 --attached +``` + +同時獲取關聯的子委託（如括號單、OCO 委託）。僅限美股賬戶。 + +### 按狀態和方向篩選委託（美股賬戶） + +```bash +longbridge order --status pending +longbridge order --status history --action buy +``` + +:::info 美股賬戶 +美國數據中心賬戶會自動路由至美股 API。`--status` 和 `--action` 僅對美股賬戶生效。 +::: + ### 撤銷待成交委託 ```bash @@ -107,6 +126,14 @@ longbridge order replace 701276261045858304 --qty 5 --price 350.00 `--qty` 為必填項。省略 `--price` 則保持當前限價不變。在腳本中使用 `-y` 跳過確認提示。 +## 選項 + +| 選項 | 描述 | 默認值 | +| ---- | ---- | ------ | +| `--status` | 委託狀態篩選：`pending` \| `history` \| `all`（美股賬戶） | all | +| `--action` | 方向篩選：`buy` \| `sell`（美股賬戶） | — | +| `--attached` | 在 `order detail` 中顯示關聯子委託（美股賬戶） | false | + ## 權限要求 提交、撤銷或修改委託需要 OAuth 交易權限。詳見 [交易權限設定](/zh-HK/docs/trade/) 指南以開啟交易存取。 From db9a68e0aacf3bec0e1cbc51eb783ccf4e523f7a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 14:55:03 +0800 Subject: [PATCH 03/51] docs(cli): add US routing and key-metrics subcommand to financial-report --- .../docs/cli/fundamentals/financial-report.md | 25 +++++++++++++++++++ .../docs/cli/fundamentals/financial-report.md | 25 +++++++++++++++++++ .../docs/cli/fundamentals/financial-report.md | 25 +++++++++++++++++++ 3 files changed, 75 insertions(+) diff --git a/docs/en/docs/cli/fundamentals/financial-report.md b/docs/en/docs/cli/fundamentals/financial-report.md index 84dc6b86..a5595b2b 100644 --- a/docs/en/docs/cli/fundamentals/financial-report.md +++ b/docs/en/docs/cli/fundamentals/financial-report.md @@ -96,3 +96,28 @@ longbridge financial-report snapshot TSLA.US --report qf --year 2025 --period 4 ``` Use `--report qf --year --period <1-4>` to retrieve a specific quarter. + +### Key financial metrics (US accounts) + +```bash +longbridge financial-report key-metrics AAPL.US +longbridge financial-report key-metrics AAPL.US --report quarterly +``` + +Returns key financial indicators for US stocks: revenue, net income, EPS, margins, and growth rates. + +:::warning US Only +`financial-report key-metrics` is only available for US data-center accounts. +::: + +| Option | Description | Default | +| ------ | ----------- | ------- | +| `--report` | Reporting period: `annual` \| `quarterly` | annual | + +:::info US Accounts +For `.US` symbols on US data-center accounts: +- Omitting `--kind` returns a financial overview via the US API +- Specifying `--kind IS`, `BS`, or `CF` returns the detailed statement via the US API + +Note: `--kind` defaults to an empty string (not `ALL`) to enable this US routing behavior. +::: diff --git a/docs/zh-CN/docs/cli/fundamentals/financial-report.md b/docs/zh-CN/docs/cli/fundamentals/financial-report.md index d1082ecb..2eb3f8e2 100644 --- a/docs/zh-CN/docs/cli/fundamentals/financial-report.md +++ b/docs/zh-CN/docs/cli/fundamentals/financial-report.md @@ -93,3 +93,28 @@ Apple Inc. (AAPL) Q1 FY2026 Jan 2026 – Mar 2026 USD # 查询历史特定季度 longbridge financial-report snapshot TSLA.US --report qf --year 2025 --period 4 ``` + +### 关键财务指标（美股账户） + +```bash +longbridge financial-report key-metrics AAPL.US +longbridge financial-report key-metrics AAPL.US --report quarterly +``` + +返回美股的关键财务指标：营收、净利润、EPS、利润率和增长率。 + +:::warning 仅限美股账户 +`financial-report key-metrics` 仅适用于美国数据中心账户。 +::: + +| 选项 | 描述 | 默认值 | +| ---- | ---- | ------ | +| `--report` | 报告周期：`annual` \| `quarterly` | annual | + +:::info 美股账户 +对于美国数据中心账户的 `.US` 标的： +- 不指定 `--kind` 时，通过美股 API 返回财务概览 +- 指定 `--kind IS`、`BS` 或 `CF` 时，通过美股 API 返回详细报表 + +注意：`--kind` 默认为空字符串（非 `ALL`），以支持美股路由逻辑。 +::: diff --git a/docs/zh-HK/docs/cli/fundamentals/financial-report.md b/docs/zh-HK/docs/cli/fundamentals/financial-report.md index 6c935a54..3f2e15d5 100644 --- a/docs/zh-HK/docs/cli/fundamentals/financial-report.md +++ b/docs/zh-HK/docs/cli/fundamentals/financial-report.md @@ -93,3 +93,28 @@ Apple Inc. (AAPL) Q1 FY2026 Jan 2026 – Mar 2026 USD # 查詢歷史特定季度 longbridge financial-report snapshot TSLA.US --report qf --year 2025 --period 4 ``` + +### 關鍵財務指標（美股賬戶） + +```bash +longbridge financial-report key-metrics AAPL.US +longbridge financial-report key-metrics AAPL.US --report quarterly +``` + +返回美股的關鍵財務指標：營收、淨利潤、EPS、利潤率和增長率。 + +:::warning 僅限美股賬戶 +`financial-report key-metrics` 僅適用於美國數據中心賬戶。 +::: + +| 選項 | 描述 | 默認值 | +| ---- | ---- | ------ | +| `--report` | 報告週期：`annual` \| `quarterly` | annual | + +:::info 美股賬戶 +對於美國數據中心賬戶的 `.US` 標的： +- 不指定 `--kind` 時，透過美股 API 返回財務概覽 +- 指定 `--kind IS`、`BS` 或 `CF` 時，透過美股 API 返回詳細報表 + +注意：`--kind` 默認為空字符串（非 `ALL`），以支持美股路由邏輯。 +::: From 496686f74138972f81b86d0b81e4732bfb5a6cfe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 14:55:40 +0800 Subject: [PATCH 04/51] docs(cli): add realized subcommand to profit-analysis (US only) --- docs/en/docs/cli/account/profit-analysis.md | 21 +++++++++++++++++++ .../zh-CN/docs/cli/account/profit-analysis.md | 21 +++++++++++++++++++ .../zh-HK/docs/cli/account/profit-analysis.md | 21 +++++++++++++++++++ 3 files changed, 63 insertions(+) diff --git a/docs/en/docs/cli/account/profit-analysis.md b/docs/en/docs/cli/account/profit-analysis.md index 7835670f..04d43338 100644 --- a/docs/en/docs/cli/account/profit-analysis.md +++ b/docs/en/docs/cli/account/profit-analysis.md @@ -83,3 +83,24 @@ Shows stock P&L filtered by market with pagination support. ## Requirements OAuth account permission required. See the [account permission setup](/docs/trade/) guide. + +## Subcommands + +### `realized` — Realized P&L (US accounts) + +```bash +longbridge profit-analysis realized +longbridge profit-analysis realized --category stock +longbridge profit-analysis realized --category option --currency USD +``` + +Returns realized profit and loss breakdown by asset category for US accounts. + +:::warning US Only +`profit-analysis realized` is only available for US data-center accounts. +::: + +| Option | Description | Default | +| ------ | ----------- | ------- | +| `--category` | Asset category: `all` \| `stock` \| `option` \| `crypto` | all | +| `--currency` | Settlement currency | USD | diff --git a/docs/zh-CN/docs/cli/account/profit-analysis.md b/docs/zh-CN/docs/cli/account/profit-analysis.md index 92046569..1f4e8707 100644 --- a/docs/zh-CN/docs/cli/account/profit-analysis.md +++ b/docs/zh-CN/docs/cli/account/profit-analysis.md @@ -83,3 +83,24 @@ longbridge profit-analysis by-market US --size 50 ## 权限要求 需要 OAuth 账户权限。参见[账户权限设置](/zh-CN/docs/trade/)。 + +## 子命令 + +### `realized` — 已实现盈亏（美股账户） + +```bash +longbridge profit-analysis realized +longbridge profit-analysis realized --category stock +longbridge profit-analysis realized --category option --currency USD +``` + +按资产类别返回美股账户的已实现盈亏明细。 + +:::warning 仅限美股账户 +`profit-analysis realized` 仅适用于美国数据中心账户。 +::: + +| 选项 | 描述 | 默认值 | +| ---- | ---- | ------ | +| `--category` | 资产类别：`all` \| `stock` \| `option` \| `crypto` | all | +| `--currency` | 结算货币 | USD | diff --git a/docs/zh-HK/docs/cli/account/profit-analysis.md b/docs/zh-HK/docs/cli/account/profit-analysis.md index d51e1f9e..654ceff5 100644 --- a/docs/zh-HK/docs/cli/account/profit-analysis.md +++ b/docs/zh-HK/docs/cli/account/profit-analysis.md @@ -83,3 +83,24 @@ longbridge profit-analysis by-market US --size 50 ## 權限要求 需要 OAuth 帳戶權限。參見[帳戶權限設置](/zh-HK/docs/trade/)。 + +## 子命令 + +### `realized` — 已實現盈虧（美股賬戶） + +```bash +longbridge profit-analysis realized +longbridge profit-analysis realized --category stock +longbridge profit-analysis realized --category option --currency USD +``` + +按資產類別返回美股賬戶的已實現盈虧明細。 + +:::warning 僅限美股賬戶 +`profit-analysis realized` 僅適用於美國數據中心賬戶。 +::: + +| 選項 | 描述 | 默認值 | +| ---- | ---- | ------ | +| `--category` | 資產類別：`all` \| `stock` \| `option` \| `crypto` | all | +| `--currency` | 結算貨幣 | USD | From 77f21f3b40227def54eca9a0e409c64fcee4d389 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 14:56:15 +0800 Subject: [PATCH 05/51] docs(cli): add US account routing notes to company/valuation/consensus/dividend --- docs/en/docs/cli/fundamentals/company.md | 4 ++++ docs/en/docs/cli/fundamentals/consensus.md | 4 ++++ docs/en/docs/cli/fundamentals/dividend.md | 4 ++++ docs/en/docs/cli/fundamentals/valuation.md | 4 ++++ docs/zh-CN/docs/cli/fundamentals/company.md | 4 ++++ docs/zh-CN/docs/cli/fundamentals/consensus.md | 4 ++++ docs/zh-CN/docs/cli/fundamentals/dividend.md | 4 ++++ docs/zh-CN/docs/cli/fundamentals/valuation.md | 4 ++++ docs/zh-HK/docs/cli/fundamentals/company.md | 4 ++++ docs/zh-HK/docs/cli/fundamentals/consensus.md | 4 ++++ docs/zh-HK/docs/cli/fundamentals/dividend.md | 4 ++++ docs/zh-HK/docs/cli/fundamentals/valuation.md | 4 ++++ 12 files changed, 48 insertions(+) diff --git a/docs/en/docs/cli/fundamentals/company.md b/docs/en/docs/cli/fundamentals/company.md index 01909029..815ed5fa 100644 --- a/docs/en/docs/cli/fundamentals/company.md +++ b/docs/en/docs/cli/fundamentals/company.md @@ -42,3 +42,7 @@ Shows key company information including founding date, number of employees, IPO ```bash longbridge company TSLA.US --format json ``` + +:::info US Accounts +For `.US` symbols on US data-center accounts, `company` routes to the US company overview API automatically. +::: diff --git a/docs/en/docs/cli/fundamentals/consensus.md b/docs/en/docs/cli/fundamentals/consensus.md index 34b3db26..3e89ffd6 100644 --- a/docs/en/docs/cli/fundamentals/consensus.md +++ b/docs/en/docs/cli/fundamentals/consensus.md @@ -56,3 +56,7 @@ longbridge consensus TSLA.US --format json ``` Each `details` entry includes the metric key, the consensus estimate value, and whether the actual result has already been released. `current_index` in the full response indicates which period in the list is the current one. + +:::info US Accounts +For `.US` symbols on US data-center accounts, `consensus` routes to the US analyst consensus API automatically. +::: diff --git a/docs/en/docs/cli/fundamentals/dividend.md b/docs/en/docs/cli/fundamentals/dividend.md index 921a15bc..0a1af3a1 100644 --- a/docs/en/docs/cli/fundamentals/dividend.md +++ b/docs/en/docs/cli/fundamentals/dividend.md @@ -66,3 +66,7 @@ longbridge dividend AAPL.US --format json ``` Returns structured JSON with `ex_date`, `payment_date`, `record_date`, and a `desc` field containing the dividend amount description (e.g., `"Dividend: USD 0.26/share"`) — suitable for piping into scripts or tracking tools. + +:::info US Accounts +For US data-center accounts: `.US` ETF symbols route to the US ETF dividend API; `.US` stock symbols route to the US company dividends API. +::: diff --git a/docs/en/docs/cli/fundamentals/valuation.md b/docs/en/docs/cli/fundamentals/valuation.md index d61ca9a0..d0d5c0dd 100644 --- a/docs/en/docs/cli/fundamentals/valuation.md +++ b/docs/en/docs/cli/fundamentals/valuation.md @@ -77,3 +77,7 @@ longbridge valuation TSLA.US --history --indicator pb --format json ``` The `desc` field provides a human-readable summary of how the current valuation compares to historical range and industry peers. The `list` array contains the time series data points. + +:::info US Accounts +For `.US` symbols on US data-center accounts, `valuation` routes to the US valuation overview API automatically. +::: diff --git a/docs/zh-CN/docs/cli/fundamentals/company.md b/docs/zh-CN/docs/cli/fundamentals/company.md index d27508d9..319df386 100644 --- a/docs/zh-CN/docs/cli/fundamentals/company.md +++ b/docs/zh-CN/docs/cli/fundamentals/company.md @@ -42,3 +42,7 @@ longbridge company 700.HK ```bash longbridge company TSLA.US --format json ``` + +:::info 美股账户 +美国数据中心账户的 `.US` 标的，`company` 会自动路由至美股公司概览 API。 +::: diff --git a/docs/zh-CN/docs/cli/fundamentals/consensus.md b/docs/zh-CN/docs/cli/fundamentals/consensus.md index cd60dcc6..af799609 100644 --- a/docs/zh-CN/docs/cli/fundamentals/consensus.md +++ b/docs/zh-CN/docs/cli/fundamentals/consensus.md @@ -56,3 +56,7 @@ longbridge consensus TSLA.US --format json ``` 每条 `details` 记录包含指标名称、一致性预测值，以及实际结果是否已发布。完整响应中的 `current_index` 标示当前所在的报告期。 + +:::info 美股账户 +美国数据中心账户的 `.US` 标的，`consensus` 会自动路由至美股分析师一致预期 API。 +::: diff --git a/docs/zh-CN/docs/cli/fundamentals/dividend.md b/docs/zh-CN/docs/cli/fundamentals/dividend.md index db474961..614110ae 100644 --- a/docs/zh-CN/docs/cli/fundamentals/dividend.md +++ b/docs/zh-CN/docs/cli/fundamentals/dividend.md @@ -66,3 +66,7 @@ longbridge dividend AAPL.US --format json ``` 返回包含 `ex_date`、`payment_date`、`record_date` 及 `desc` 字段（如 `"Dividend: USD 0.26/share"`）的结构化 JSON，适合传入脚本或跟踪工具处理。 + +:::info 美股账户 +美国数据中心账户：`.US` ETF 标的路由至美股 ETF 分红 API；`.US` 股票标的路由至美股公司分红 API。 +::: diff --git a/docs/zh-CN/docs/cli/fundamentals/valuation.md b/docs/zh-CN/docs/cli/fundamentals/valuation.md index fd7a50b3..9895ec12 100644 --- a/docs/zh-CN/docs/cli/fundamentals/valuation.md +++ b/docs/zh-CN/docs/cli/fundamentals/valuation.md @@ -77,3 +77,7 @@ longbridge valuation TSLA.US --history --indicator pb --format json ``` `desc` 字段提供当前估值与历史区间及行业同类对比的可读摘要；`list` 数组包含时间序列数据点。 + +:::info 美股账户 +美国数据中心账户的 `.US` 标的，`valuation` 会自动路由至美股估值概览 API。 +::: diff --git a/docs/zh-HK/docs/cli/fundamentals/company.md b/docs/zh-HK/docs/cli/fundamentals/company.md index 864a1331..917785b3 100644 --- a/docs/zh-HK/docs/cli/fundamentals/company.md +++ b/docs/zh-HK/docs/cli/fundamentals/company.md @@ -41,3 +41,7 @@ longbridge company 700.HK ```bash longbridge company TSLA.US --format json ``` + +:::info 美股賬戶 +美國數據中心賬戶的 `.US` 標的，`company` 會自動路由至美股公司概覽 API。 +::: diff --git a/docs/zh-HK/docs/cli/fundamentals/consensus.md b/docs/zh-HK/docs/cli/fundamentals/consensus.md index 958dc743..d6d72355 100644 --- a/docs/zh-HK/docs/cli/fundamentals/consensus.md +++ b/docs/zh-HK/docs/cli/fundamentals/consensus.md @@ -56,3 +56,7 @@ longbridge consensus TSLA.US --format json ``` 每條 `details` 記錄包含指標名稱、一致性預測值，以及實際結果是否已發布。完整響應中的 `current_index` 標示當前所在的報告期。 + +:::info 美股賬戶 +美國數據中心賬戶的 `.US` 標的，`consensus` 會自動路由至美股分析師一致預期 API。 +::: diff --git a/docs/zh-HK/docs/cli/fundamentals/dividend.md b/docs/zh-HK/docs/cli/fundamentals/dividend.md index 27e5d3bf..03a2491c 100644 --- a/docs/zh-HK/docs/cli/fundamentals/dividend.md +++ b/docs/zh-HK/docs/cli/fundamentals/dividend.md @@ -66,3 +66,7 @@ longbridge dividend AAPL.US --format json ``` 返回包含 `ex_date`、`payment_date`、`record_date` 及 `desc` 字段（如 `"Dividend: USD 0.26/share"`）的結構化 JSON，適合傳入腳本或跟蹤工具處理。 + +:::info 美股賬戶 +美國數據中心賬戶：`.US` ETF 標的路由至美股 ETF 分紅 API；`.US` 股票標的路由至美股公司分紅 API。 +::: diff --git a/docs/zh-HK/docs/cli/fundamentals/valuation.md b/docs/zh-HK/docs/cli/fundamentals/valuation.md index cf2c0625..acb37e10 100644 --- a/docs/zh-HK/docs/cli/fundamentals/valuation.md +++ b/docs/zh-HK/docs/cli/fundamentals/valuation.md @@ -77,3 +77,7 @@ longbridge valuation TSLA.US --history --indicator pb --format json ``` `desc` 字段提供當前估值與歷史區間及行業同類對比的可讀摘要；`list` 數組包含時間序列數據點。 + +:::info 美股賬戶 +美國數據中心賬戶的 `.US` 標的，`valuation` 會自動路由至美股估值概覽 API。 +::: From 702b1a79fe8c7430aa4753310fd02c795837c14f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 14:57:51 +0800 Subject: [PATCH 06/51] docs(fundamental): add US market SDK docs EN (9 FundamentalContext methods) --- .../fundamental/us_analyst_consensus.md | 75 ++++++++++++++++++ .../fundamental/us_company_dividends.md | 74 ++++++++++++++++++ .../fundamental/us_company_overview.md | 74 ++++++++++++++++++ .../fundamental/us_etf_dividend_info.md | 74 ++++++++++++++++++ .../fundamental/fundamental/us_etf_files.md | 75 ++++++++++++++++++ .../fundamental/us_financial_overview.md | 75 ++++++++++++++++++ .../fundamental/us_financial_statement_v3.md | 76 +++++++++++++++++++ .../fundamental/us_key_financial_metrics.md | 75 ++++++++++++++++++ .../fundamental/us_valuation_overview.md | 74 ++++++++++++++++++ 9 files changed, 672 insertions(+) create mode 100644 docs/en/docs/fundamental/fundamental/us_analyst_consensus.md create mode 100644 docs/en/docs/fundamental/fundamental/us_company_dividends.md create mode 100644 docs/en/docs/fundamental/fundamental/us_company_overview.md create mode 100644 docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md create mode 100644 docs/en/docs/fundamental/fundamental/us_etf_files.md create mode 100644 docs/en/docs/fundamental/fundamental/us_financial_overview.md create mode 100644 docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md create mode 100644 docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md create mode 100644 docs/en/docs/fundamental/fundamental/us_valuation_overview.md diff --git a/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md new file mode 100644 index 00000000..31714e69 --- /dev/null +++ b/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md @@ -0,0 +1,75 @@ +--- +slug: /us_analyst_consensus +title: US Analyst Consensus +sidebar_position: 35 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning US Only +This method is only available for US data-center accounts. +::: + +Get analyst consensus estimates for a US stock — revenue, EPS forecasts, and buy/hold/sell ratings. + + + +## Parameters + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| counter_id | string | YES | Stock symbol, e.g. `AAPL.US` | +| report | string | NO | Period: `annual` or `quarterly` (default: annual) | + +## Request Example + + + + +```python +from longbridge.openapi import FundamentalContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +config = Config.from_oauth(oauth) +ctx = FundamentalContext(config) +resp = ctx.us_analyst_consensus("AAPL.US", report="annual") +print(resp) +``` + + + + +```go +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/fundamental" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, _ := config.New(config.WithOAuthClient(o)) + c, _ := fundamental.NewFromCfg(conf) + defer c.Close() + resp, err := c.AnalystConsensus(context.Background(), "AAPL.US", "annual") + if err != nil { log.Fatal(err) } + fmt.Printf("%+v\n", resp) +} +``` + + + diff --git a/docs/en/docs/fundamental/fundamental/us_company_dividends.md b/docs/en/docs/fundamental/fundamental/us_company_dividends.md new file mode 100644 index 00000000..c15e7105 --- /dev/null +++ b/docs/en/docs/fundamental/fundamental/us_company_dividends.md @@ -0,0 +1,74 @@ +--- +slug: /us_company_dividends +title: US Company Dividends +sidebar_position: 37 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning US Only +This method is only available for US data-center accounts. +::: + +Get dividend history for a US stock — TTM yield, payout count, and individual dividend records. + + + +## Parameters + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| counter_id | string | YES | Stock symbol, e.g. `AAPL.US` | + +## Request Example + + + + +```python +from longbridge.openapi import FundamentalContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +config = Config.from_oauth(oauth) +ctx = FundamentalContext(config) +resp = ctx.us_company_dividends("AAPL.US") +print(resp) +``` + + + + +```go +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/fundamental" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, _ := config.New(config.WithOAuthClient(o)) + c, _ := fundamental.NewFromCfg(conf) + defer c.Close() + resp, err := c.CompanyDividends(context.Background(), "AAPL.US") + if err != nil { log.Fatal(err) } + fmt.Printf("%+v\n", resp) +} +``` + + + diff --git a/docs/en/docs/fundamental/fundamental/us_company_overview.md b/docs/en/docs/fundamental/fundamental/us_company_overview.md new file mode 100644 index 00000000..6c711238 --- /dev/null +++ b/docs/en/docs/fundamental/fundamental/us_company_overview.md @@ -0,0 +1,74 @@ +--- +slug: /us_company_overview +title: US Company Overview +sidebar_position: 30 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning US Only +This method is only available for US data-center accounts. +::: + +Get company overview for a US stock — introduction, market cap, ranking tags, and detail URL. + + + +## Parameters + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| counter_id | string | YES | Stock symbol, e.g. `AAPL.US` | + +## Request Example + + + + +```python +from longbridge.openapi import FundamentalContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +config = Config.from_oauth(oauth) +ctx = FundamentalContext(config) +resp = ctx.us_company_overview("AAPL.US") +print(resp) +``` + + + + +```go +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/fundamental" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, _ := config.New(config.WithOAuthClient(o)) + c, _ := fundamental.NewFromCfg(conf) + defer c.Close() + resp, err := c.CompanyOverview(context.Background(), "AAPL.US") + if err != nil { log.Fatal(err) } + fmt.Printf("%+v\n", resp) +} +``` + + + diff --git a/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md new file mode 100644 index 00000000..f74276a3 --- /dev/null +++ b/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -0,0 +1,74 @@ +--- +slug: /us_etf_dividend_info +title: US ETF Dividend Info +sidebar_position: 36 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning US Only +This method is only available for US data-center accounts. +::: + +Get dividend information for a US ETF — TTM dividend yield, payout frequency, and fiscal year breakdown. + + + +## Parameters + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| counter_id | string | YES | ETF symbol, e.g. `IVV.US` | + +## Request Example + + + + +```python +from longbridge.openapi import FundamentalContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +config = Config.from_oauth(oauth) +ctx = FundamentalContext(config) +resp = ctx.us_etf_dividend_info("IVV.US") +print(resp) +``` + + + + +```go +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/fundamental" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, _ := config.New(config.WithOAuthClient(o)) + c, _ := fundamental.NewFromCfg(conf) + defer c.Close() + resp, err := c.ETFDividendInfo(context.Background(), "IVV.US") + if err != nil { log.Fatal(err) } + fmt.Printf("%+v\n", resp) +} +``` + + + diff --git a/docs/en/docs/fundamental/fundamental/us_etf_files.md b/docs/en/docs/fundamental/fundamental/us_etf_files.md new file mode 100644 index 00000000..8e27c368 --- /dev/null +++ b/docs/en/docs/fundamental/fundamental/us_etf_files.md @@ -0,0 +1,75 @@ +--- +slug: /us_etf_files +title: US ETF Files +sidebar_position: 38 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning US Only +This method is only available for US data-center accounts. +::: + +List regulatory documents for a US ETF — prospectus, fact sheets, and annual reports. + + + +## Parameters + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| counter_id | string | YES | ETF symbol, e.g. `IVV.US` | +| size | int | NO | Maximum number of files to return | + +## Request Example + + + + +```python +from longbridge.openapi import FundamentalContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +config = Config.from_oauth(oauth) +ctx = FundamentalContext(config) +resp = ctx.us_etf_files("IVV.US") +print(resp) +``` + + + + +```go +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/fundamental" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, _ := config.New(config.WithOAuthClient(o)) + c, _ := fundamental.NewFromCfg(conf) + defer c.Close() + resp, err := c.ETFFiles(context.Background(), "IVV.US", nil) + if err != nil { log.Fatal(err) } + fmt.Printf("%+v\n", resp) +} +``` + + + diff --git a/docs/en/docs/fundamental/fundamental/us_financial_overview.md b/docs/en/docs/fundamental/fundamental/us_financial_overview.md new file mode 100644 index 00000000..2dc730f2 --- /dev/null +++ b/docs/en/docs/fundamental/fundamental/us_financial_overview.md @@ -0,0 +1,75 @@ +--- +slug: /us_financial_overview +title: US Financial Overview +sidebar_position: 32 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning US Only +This method is only available for US data-center accounts. +::: + +Get financial overview for a US stock by reporting period — income, balance sheet, and cash flow summary. + + + +## Parameters + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| counter_id | string | YES | Stock symbol, e.g. `AAPL.US` | +| report | string | NO | Period: `annual` or `quarterly` (default: annual) | + +## Request Example + + + + +```python +from longbridge.openapi import FundamentalContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +config = Config.from_oauth(oauth) +ctx = FundamentalContext(config) +resp = ctx.us_financial_overview("AAPL.US", report="annual") +print(resp) +``` + + + + +```go +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/fundamental" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, _ := config.New(config.WithOAuthClient(o)) + c, _ := fundamental.NewFromCfg(conf) + defer c.Close() + resp, err := c.FinancialOverview(context.Background(), "AAPL.US", "annual") + if err != nil { log.Fatal(err) } + fmt.Printf("%+v\n", resp) +} +``` + + + diff --git a/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md new file mode 100644 index 00000000..66298b5d --- /dev/null +++ b/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -0,0 +1,76 @@ +--- +slug: /us_financial_statement_v3 +title: US Financial Statement +sidebar_position: 33 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning US Only +This method is only available for US data-center accounts. +::: + +Get a specific financial statement (income statement, balance sheet, or cash flow) for a US stock. + + + +## Parameters + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| counter_id | string | YES | Stock symbol, e.g. `AAPL.US` | +| kind | string | YES | Statement type: `IS` (income), `BS` (balance sheet), `CF` (cash flow) | +| report | string | NO | Period: `annual` or `quarterly` (default: annual) | + +## Request Example + + + + +```python +from longbridge.openapi import FundamentalContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +config = Config.from_oauth(oauth) +ctx = FundamentalContext(config) +resp = ctx.us_financial_statement_v3("AAPL.US", kind="IS", report="annual") +print(resp) +``` + + + + +```go +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/fundamental" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, _ := config.New(config.WithOAuthClient(o)) + c, _ := fundamental.NewFromCfg(conf) + defer c.Close() + resp, err := c.FinancialStatementV3(context.Background(), "AAPL.US", "IS", "annual") + if err != nil { log.Fatal(err) } + fmt.Printf("%+v\n", resp) +} +``` + + + diff --git a/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md new file mode 100644 index 00000000..8b76e8fd --- /dev/null +++ b/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -0,0 +1,75 @@ +--- +slug: /us_key_financial_metrics +title: US Key Financial Metrics +sidebar_position: 34 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning US Only +This method is only available for US data-center accounts. +::: + +Get key financial metrics for a US stock — revenue, net income, EPS, margins, and growth rates. + + + +## Parameters + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| counter_id | string | YES | Stock symbol, e.g. `AAPL.US` | +| report | string | NO | Period: `annual` or `quarterly` (default: annual) | + +## Request Example + + + + +```python +from longbridge.openapi import FundamentalContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +config = Config.from_oauth(oauth) +ctx = FundamentalContext(config) +resp = ctx.us_key_financial_metrics("AAPL.US", report="annual") +print(resp) +``` + + + + +```go +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/fundamental" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, _ := config.New(config.WithOAuthClient(o)) + c, _ := fundamental.NewFromCfg(conf) + defer c.Close() + resp, err := c.KeyFinancialMetrics(context.Background(), "AAPL.US", "annual") + if err != nil { log.Fatal(err) } + fmt.Printf("%+v\n", resp) +} +``` + + + diff --git a/docs/en/docs/fundamental/fundamental/us_valuation_overview.md b/docs/en/docs/fundamental/fundamental/us_valuation_overview.md new file mode 100644 index 00000000..b85a83dc --- /dev/null +++ b/docs/en/docs/fundamental/fundamental/us_valuation_overview.md @@ -0,0 +1,74 @@ +--- +slug: /us_valuation_overview +title: US Valuation Overview +sidebar_position: 31 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning US Only +This method is only available for US data-center accounts. +::: + +Get valuation overview for a US stock — current valuation indicators and historical range. + + + +## Parameters + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| counter_id | string | YES | Stock symbol, e.g. `AAPL.US` | + +## Request Example + + + + +```python +from longbridge.openapi import FundamentalContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +config = Config.from_oauth(oauth) +ctx = FundamentalContext(config) +resp = ctx.us_valuation_overview("AAPL.US") +print(resp) +``` + + + + +```go +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/fundamental" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, _ := config.New(config.WithOAuthClient(o)) + c, _ := fundamental.NewFromCfg(conf) + defer c.Close() + resp, err := c.ValuationOverview(context.Background(), "AAPL.US") + if err != nil { log.Fatal(err) } + fmt.Printf("%+v\n", resp) +} +``` + + + From dd53542e974844be5f0b6fb035a2c87ce85df199 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 14:58:16 +0800 Subject: [PATCH 07/51] docs: add CLI v0.25.0 + SDK v4.4.0 changelog and release-notes entries --- docs/en/docs/changelog.md | 15 +++++++++++++++ docs/en/docs/cli/release-notes.md | 8 ++++++++ docs/zh-CN/docs/changelog.md | 15 +++++++++++++++ docs/zh-CN/docs/cli/release-notes.md | 8 ++++++++ docs/zh-HK/docs/changelog.md | 15 +++++++++++++++ docs/zh-HK/docs/cli/release-notes.md | 8 ++++++++ 6 files changed, 69 insertions(+) diff --git a/docs/en/docs/changelog.md b/docs/en/docs/changelog.md index bb108184..143e090a 100644 --- a/docs/en/docs/changelog.md +++ b/docs/en/docs/changelog.md @@ -6,6 +6,21 @@ sidebar_position: 7 sidebar_icon: newspaper --- +## 2026-07-07 + +### SDK v4.4.0 + +- **US market APIs** — 14 new methods across `FundamentalContext` (9), `QuoteContext` (1), `TradeContext` (4); all US data-center only + +### CLI v0.25.0 + +- **US market routing** — `company`, `valuation`, `financial-report`, `consensus`, `dividend`, `order`, `positions` now route to US APIs automatically for US data-center accounts +- **New `etf-docs` command** — list regulatory documents (prospectus, fact sheets) for US ETFs +- **New `financial-report key-metrics` subcommand** — key financial metrics for US stocks (annual/quarterly) +- **New `profit-analysis realized` subcommand** — realized P&L breakdown by asset category for US accounts (stock/option/crypto) +- **New `order --status` / `--action` flags** — filter US order history by status and side +- **New `order detail --attached` flag** — show attached child order for US accounts + ## 2026-06-25 ### SDK v4.3.3 diff --git a/docs/en/docs/cli/release-notes.md b/docs/en/docs/cli/release-notes.md index 9f165a43..c0a2d519 100644 --- a/docs/en/docs/cli/release-notes.md +++ b/docs/en/docs/cli/release-notes.md @@ -7,6 +7,14 @@ sidebar_icon: newspaper # Release Notes +### [v0.25.0](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.25.0) + +- **US market routing** — `company`, `valuation`, `financial-report`, `consensus`, `dividend`, `order`, `positions` auto-route to US APIs for US data-center accounts +- **New `etf-docs` command** — list ETF regulatory documents (prospectus, fact sheets, annual reports) for US ETFs; `--limit` controls how many to return +- **New `financial-report key-metrics` subcommand** — key financial indicators for US stocks; supports `--report annual|quarterly` +- **New `profit-analysis realized` subcommand** — realized P&L by asset category (`--category stock|option|crypto`); US accounts only +- **New order flags** — `--status pending|history|all` and `--action buy|sell` filter US order history; `order detail --attached` fetches child orders + ### [v0.24.0](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.24.0) - **New `macrodata` command** — Browse 400+ macrodata indicators across US/HK/CN/EU/JP/SG; list mode with optional `--country` filter, history mode for a specific indicator code with `--start`/`--end` date range; `--format json` for AI/scripting workflows diff --git a/docs/zh-CN/docs/changelog.md b/docs/zh-CN/docs/changelog.md index 1f09237f..fc4a6f70 100644 --- a/docs/zh-CN/docs/changelog.md +++ b/docs/zh-CN/docs/changelog.md @@ -6,6 +6,21 @@ sidebar_position: 7 sidebar_icon: newspaper --- +## 2026-07-07 + +### SDK v4.4.0 + +- **美股市场 API** — 新增 14 个方法，覆盖 `FundamentalContext`（9 个）、`QuoteContext`（1 个）、`TradeContext`（4 个），全部仅限美股数据中心账户 + +### CLI v0.25.0 + +- **美股账户路由** — `company`、`valuation`、`financial-report`、`consensus`、`dividend`、`order`、`positions` 在美股数据中心账户下自动路由至美股 API +- **新增 `etf-docs` 命令** — 列出美股 ETF 的监管文件（招股书、事实说明书等） +- **新增 `financial-report key-metrics` 子命令** — 美股关键财务指标（支持年报/季报） +- **新增 `profit-analysis realized` 子命令** — 美股账户按资产类别（股票/期权/加密货币）统计已实现盈亏 +- **新增 `order --status` / `--action` 选项** — 筛选美股历史委托状态和方向 +- **新增 `order detail --attached` 选项** — 获取美股账户关联子委托 + ## 2026-06-25 ### SDK v4.3.3 diff --git a/docs/zh-CN/docs/cli/release-notes.md b/docs/zh-CN/docs/cli/release-notes.md index de87731d..663eb3f7 100644 --- a/docs/zh-CN/docs/cli/release-notes.md +++ b/docs/zh-CN/docs/cli/release-notes.md @@ -7,6 +7,14 @@ sidebar_icon: newspaper # Release Notes +### [v0.25.0](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.25.0) + +- **美股账户路由** — `company`、`valuation`、`financial-report`、`consensus`、`dividend`、`order`、`positions` 在美股数据中心账户下自动路由至美股 API +- **新增 `etf-docs` 命令** — 列出美股 ETF 监管文件（招股书、事实说明书、年报），`--limit` 控制返回数量 +- **新增 `financial-report key-metrics` 子命令** — 美股关键财务指标，支持 `--report annual|quarterly` +- **新增 `profit-analysis realized` 子命令** — 美股账户已实现盈亏，支持 `--category stock|option|crypto` 筛选 +- **新增订单选项** — `--status pending|history|all` 和 `--action buy|sell` 筛选美股历史委托；`order detail --attached` 获取关联子委托 + ### [v0.24.0](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.24.0) - **新增 `macrodata` 命令** — 浏览 400+ 宏观数据指标，覆盖美/港/中/欧/日/新六大市场；列表模式支持 `--country` 筛选，历史模式支持 `--start`/`--end` 日期区间；`--format json` 满足 AI / 脚本需求 diff --git a/docs/zh-HK/docs/changelog.md b/docs/zh-HK/docs/changelog.md index b9f3badf..8dcb2045 100644 --- a/docs/zh-HK/docs/changelog.md +++ b/docs/zh-HK/docs/changelog.md @@ -6,6 +6,21 @@ sidebar_position: 7 sidebar_icon: newspaper --- +## 2026-07-07 + +### SDK v4.4.0 + +- **美股市場 API** — 新增 14 個方法，覆蓋 `FundamentalContext`（9 個）、`QuoteContext`（1 個）、`TradeContext`（4 個），全部僅限美股數據中心賬戶 + +### CLI v0.25.0 + +- **美股賬戶路由** — `company`、`valuation`、`financial-report`、`consensus`、`dividend`、`order`、`positions` 在美股數據中心賬戶下自動路由至美股 API +- **新增 `etf-docs` 命令** — 列出美股 ETF 的監管文件（招股書、事實說明書等） +- **新增 `financial-report key-metrics` 子命令** — 美股關鍵財務指標（支持年報/季報） +- **新增 `profit-analysis realized` 子命令** — 美股賬戶按資產類別（股票/期權/加密貨幣）統計已實現盈虧 +- **新增 `order --status` / `--action` 選項** — 篩選美股歷史委託狀態和方向 +- **新增 `order detail --attached` 選項** — 獲取美股賬戶關聯子委託 + ## 2026-06-25 ### SDK v4.3.3 diff --git a/docs/zh-HK/docs/cli/release-notes.md b/docs/zh-HK/docs/cli/release-notes.md index c24148f0..9509d9e9 100644 --- a/docs/zh-HK/docs/cli/release-notes.md +++ b/docs/zh-HK/docs/cli/release-notes.md @@ -7,6 +7,14 @@ sidebar_icon: newspaper # Release Notes +### [v0.25.0](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.25.0) + +- **美股賬戶路由** — `company`、`valuation`、`financial-report`、`consensus`、`dividend`、`order`、`positions` 在美股數據中心賬戶下自動路由至美股 API +- **新增 `etf-docs` 命令** — 列出美股 ETF 監管文件（招股書、事實說明書、年報），`--limit` 控制返回數量 +- **新增 `financial-report key-metrics` 子命令** — 美股關鍵財務指標，支持 `--report annual|quarterly` +- **新增 `profit-analysis realized` 子命令** — 美股賬戶已實現盈虧，支持 `--category stock|option|crypto` 篩選 +- **新增訂單選項** — `--status pending|history|all` 和 `--action buy|sell` 篩選美股歷史委託；`order detail --attached` 獲取關聯子委託 + ### [v0.24.0](https://github.com/longbridge/longbridge-terminal/releases/tag/v0.24.0) - **新增 `macrodata` 命令** — 瀏覽 400+ 宏觀數據指標，覆蓋美/港/中/歐/日/新六大市場；列表模式支持 `--country` 篩選，歷史模式支持 `--start`/`--end` 日期區間；`--format json` 滿足 AI / 腳本需求 From b9b86ffa9e50dc42230c99b50fd1e9413566a315 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 15:01:03 +0800 Subject: [PATCH 08/51] docs(fundamental): add US market SDK docs zh-CN + zh-HK (9 FundamentalContext methods) --- .../fundamental/us_analyst_consensus.md | 75 ++++++++++++++++++ .../fundamental/us_company_dividends.md | 74 ++++++++++++++++++ .../fundamental/us_company_overview.md | 74 ++++++++++++++++++ .../fundamental/us_etf_dividend_info.md | 74 ++++++++++++++++++ .../fundamental/fundamental/us_etf_files.md | 75 ++++++++++++++++++ .../fundamental/us_financial_overview.md | 75 ++++++++++++++++++ .../fundamental/us_financial_statement_v3.md | 76 +++++++++++++++++++ .../fundamental/us_key_financial_metrics.md | 75 ++++++++++++++++++ .../fundamental/us_valuation_overview.md | 74 ++++++++++++++++++ .../fundamental/us_analyst_consensus.md | 75 ++++++++++++++++++ .../fundamental/us_company_dividends.md | 74 ++++++++++++++++++ .../fundamental/us_company_overview.md | 74 ++++++++++++++++++ .../fundamental/us_etf_dividend_info.md | 74 ++++++++++++++++++ .../fundamental/fundamental/us_etf_files.md | 75 ++++++++++++++++++ .../fundamental/us_financial_overview.md | 75 ++++++++++++++++++ .../fundamental/us_financial_statement_v3.md | 76 +++++++++++++++++++ .../fundamental/us_key_financial_metrics.md | 75 ++++++++++++++++++ .../fundamental/us_valuation_overview.md | 74 ++++++++++++++++++ 18 files changed, 1344 insertions(+) create mode 100644 docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md create mode 100644 docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md create mode 100644 docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md create mode 100644 docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md create mode 100644 docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md create mode 100644 docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md create mode 100644 docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md create mode 100644 docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md create mode 100644 docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md create mode 100644 docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md create mode 100644 docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md create mode 100644 docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md create mode 100644 docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md create mode 100644 docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md create mode 100644 docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md create mode 100644 docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md create mode 100644 docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md create mode 100644 docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md new file mode 100644 index 00000000..e0711f7c --- /dev/null +++ b/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md @@ -0,0 +1,75 @@ +--- +slug: /us_analyst_consensus +title: 美股分析师一致预期 +sidebar_position: 35 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning 仅限美股账户 +此方法仅适用于美国数据中心账户。 +::: + +获取美股分析师一致预期——营收、EPS 预测及买入/持有/卖出评级。 + + + +## 参数 + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| counter_id | string | YES | 股票代码，如 `AAPL.US` | +| report | string | NO | 报告周期：`annual` 或 `quarterly`（默认：annual）| + +## 请求示例 + + + + +```python +from longbridge.openapi import FundamentalContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +config = Config.from_oauth(oauth) +ctx = FundamentalContext(config) +resp = ctx.us_analyst_consensus("AAPL.US", report="annual") +print(resp) +``` + + + + +```go +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/fundamental" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, _ := config.New(config.WithOAuthClient(o)) + c, _ := fundamental.NewFromCfg(conf) + defer c.Close() + resp, err := c.AnalystConsensus(context.Background(), "AAPL.US", "annual") + if err != nil { log.Fatal(err) } + fmt.Printf("%+v\n", resp) +} +``` + + + diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md b/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md new file mode 100644 index 00000000..d94a547f --- /dev/null +++ b/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md @@ -0,0 +1,74 @@ +--- +slug: /us_company_dividends +title: 美股公司分红 +sidebar_position: 37 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning 仅限美股账户 +此方法仅适用于美国数据中心账户。 +::: + +获取美股股票分红历史——TTM 股息率、派息次数及逐笔分红记录。 + + + +## 参数 + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| counter_id | string | YES | 股票代码，如 `AAPL.US` | + +## 请求示例 + + + + +```python +from longbridge.openapi import FundamentalContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +config = Config.from_oauth(oauth) +ctx = FundamentalContext(config) +resp = ctx.us_company_dividends("AAPL.US") +print(resp) +``` + + + + +```go +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/fundamental" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, _ := config.New(config.WithOAuthClient(o)) + c, _ := fundamental.NewFromCfg(conf) + defer c.Close() + resp, err := c.CompanyDividends(context.Background(), "AAPL.US") + if err != nil { log.Fatal(err) } + fmt.Printf("%+v\n", resp) +} +``` + + + diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md new file mode 100644 index 00000000..3bc03dd2 --- /dev/null +++ b/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md @@ -0,0 +1,74 @@ +--- +slug: /us_company_overview +title: 美股公司概览 +sidebar_position: 30 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning 仅限美股账户 +此方法仅适用于美国数据中心账户。 +::: + +获取美股公司概览信息——简介、市值、排名标签和详情链接。 + + + +## 参数 + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| counter_id | string | YES | 股票代码，如 `AAPL.US` | + +## 请求示例 + + + + +```python +from longbridge.openapi import FundamentalContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +config = Config.from_oauth(oauth) +ctx = FundamentalContext(config) +resp = ctx.us_company_overview("AAPL.US") +print(resp) +``` + + + + +```go +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/fundamental" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, _ := config.New(config.WithOAuthClient(o)) + c, _ := fundamental.NewFromCfg(conf) + defer c.Close() + resp, err := c.CompanyOverview(context.Background(), "AAPL.US") + if err != nil { log.Fatal(err) } + fmt.Printf("%+v\n", resp) +} +``` + + + diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md new file mode 100644 index 00000000..f563d94e --- /dev/null +++ b/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -0,0 +1,74 @@ +--- +slug: /us_etf_dividend_info +title: 美股 ETF 分红信息 +sidebar_position: 36 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning 仅限美股账户 +此方法仅适用于美国数据中心账户。 +::: + +获取美股 ETF 分红信息——TTM 股息率、派息频率及财年明细。 + + + +## 参数 + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| counter_id | string | YES | ETF 代码，如 `IVV.US` | + +## 请求示例 + + + + +```python +from longbridge.openapi import FundamentalContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +config = Config.from_oauth(oauth) +ctx = FundamentalContext(config) +resp = ctx.us_etf_dividend_info("IVV.US") +print(resp) +``` + + + + +```go +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/fundamental" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, _ := config.New(config.WithOAuthClient(o)) + c, _ := fundamental.NewFromCfg(conf) + defer c.Close() + resp, err := c.ETFDividendInfo(context.Background(), "IVV.US") + if err != nil { log.Fatal(err) } + fmt.Printf("%+v\n", resp) +} +``` + + + diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md b/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md new file mode 100644 index 00000000..8234232c --- /dev/null +++ b/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md @@ -0,0 +1,75 @@ +--- +slug: /us_etf_files +title: 美股 ETF 文件 +sidebar_position: 38 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning 仅限美股账户 +此方法仅适用于美国数据中心账户。 +::: + +列出美股 ETF 的监管文件——招股书、事实说明书和年报。 + + + +## 参数 + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| counter_id | string | YES | ETF 代码，如 `IVV.US` | +| size | int | NO | 最大返回文件数 | + +## 请求示例 + + + + +```python +from longbridge.openapi import FundamentalContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +config = Config.from_oauth(oauth) +ctx = FundamentalContext(config) +resp = ctx.us_etf_files("IVV.US") +print(resp) +``` + + + + +```go +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/fundamental" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, _ := config.New(config.WithOAuthClient(o)) + c, _ := fundamental.NewFromCfg(conf) + defer c.Close() + resp, err := c.ETFFiles(context.Background(), "IVV.US", nil) + if err != nil { log.Fatal(err) } + fmt.Printf("%+v\n", resp) +} +``` + + + diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md new file mode 100644 index 00000000..0288c3f0 --- /dev/null +++ b/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md @@ -0,0 +1,75 @@ +--- +slug: /us_financial_overview +title: 美股财务概览 +sidebar_position: 32 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning 仅限美股账户 +此方法仅适用于美国数据中心账户。 +::: + +按报告周期获取美股财务概览——损益、资产负债和现金流摘要。 + + + +## 参数 + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| counter_id | string | YES | 股票代码，如 `AAPL.US` | +| report | string | NO | 报告周期：`annual` 或 `quarterly`（默认：annual）| + +## 请求示例 + + + + +```python +from longbridge.openapi import FundamentalContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +config = Config.from_oauth(oauth) +ctx = FundamentalContext(config) +resp = ctx.us_financial_overview("AAPL.US", report="annual") +print(resp) +``` + + + + +```go +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/fundamental" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, _ := config.New(config.WithOAuthClient(o)) + c, _ := fundamental.NewFromCfg(conf) + defer c.Close() + resp, err := c.FinancialOverview(context.Background(), "AAPL.US", "annual") + if err != nil { log.Fatal(err) } + fmt.Printf("%+v\n", resp) +} +``` + + + diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md new file mode 100644 index 00000000..c80da383 --- /dev/null +++ b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -0,0 +1,76 @@ +--- +slug: /us_financial_statement_v3 +title: 美股财务报表 +sidebar_position: 33 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning 仅限美股账户 +此方法仅适用于美国数据中心账户。 +::: + +获取美股指定财务报表（损益表、资产负债表或现金流量表）。 + + + +## 参数 + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| counter_id | string | YES | 股票代码，如 `AAPL.US` | +| kind | string | YES | 报表类型：`IS`（损益表）、`BS`（资产负债表）、`CF`（现金流量表）| +| report | string | NO | 报告周期 | + +## 请求示例 + + + + +```python +from longbridge.openapi import FundamentalContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +config = Config.from_oauth(oauth) +ctx = FundamentalContext(config) +resp = ctx.us_financial_statement_v3("AAPL.US", kind="IS", report="annual") +print(resp) +``` + + + + +```go +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/fundamental" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, _ := config.New(config.WithOAuthClient(o)) + c, _ := fundamental.NewFromCfg(conf) + defer c.Close() + resp, err := c.FinancialStatementV3(context.Background(), "AAPL.US", "IS", "annual") + if err != nil { log.Fatal(err) } + fmt.Printf("%+v\n", resp) +} +``` + + + diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md new file mode 100644 index 00000000..e9557a2b --- /dev/null +++ b/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -0,0 +1,75 @@ +--- +slug: /us_key_financial_metrics +title: 美股关键财务指标 +sidebar_position: 34 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning 仅限美股账户 +此方法仅适用于美国数据中心账户。 +::: + +获取美股关键财务指标——营收、净利润、EPS、利润率和增长率。 + + + +## 参数 + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| counter_id | string | YES | 股票代码，如 `AAPL.US` | +| report | string | NO | 报告周期：`annual` 或 `quarterly`（默认：annual）| + +## 请求示例 + + + + +```python +from longbridge.openapi import FundamentalContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +config = Config.from_oauth(oauth) +ctx = FundamentalContext(config) +resp = ctx.us_key_financial_metrics("AAPL.US", report="annual") +print(resp) +``` + + + + +```go +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/fundamental" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, _ := config.New(config.WithOAuthClient(o)) + c, _ := fundamental.NewFromCfg(conf) + defer c.Close() + resp, err := c.KeyFinancialMetrics(context.Background(), "AAPL.US", "annual") + if err != nil { log.Fatal(err) } + fmt.Printf("%+v\n", resp) +} +``` + + + diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md new file mode 100644 index 00000000..b613f55a --- /dev/null +++ b/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md @@ -0,0 +1,74 @@ +--- +slug: /us_valuation_overview +title: 美股估值概览 +sidebar_position: 31 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning 仅限美股账户 +此方法仅适用于美国数据中心账户。 +::: + +获取美股估值概览——当前估值指标及历史区间。 + + + +## 参数 + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| counter_id | string | YES | 股票代码，如 `AAPL.US` | + +## 请求示例 + + + + +```python +from longbridge.openapi import FundamentalContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +config = Config.from_oauth(oauth) +ctx = FundamentalContext(config) +resp = ctx.us_valuation_overview("AAPL.US") +print(resp) +``` + + + + +```go +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/fundamental" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, _ := config.New(config.WithOAuthClient(o)) + c, _ := fundamental.NewFromCfg(conf) + defer c.Close() + resp, err := c.ValuationOverview(context.Background(), "AAPL.US") + if err != nil { log.Fatal(err) } + fmt.Printf("%+v\n", resp) +} +``` + + + diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md new file mode 100644 index 00000000..749b9096 --- /dev/null +++ b/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md @@ -0,0 +1,75 @@ +--- +slug: /us_analyst_consensus +title: 美股分析師一致預期 +sidebar_position: 35 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning 僅限美股賬戶 +此方法僅適用於美國數據中心賬戶。 +::: + +獲取美股分析師一致預期——營收、EPS 預測及買入/持有/賣出評級。 + + + +## 參數 + +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| counter_id | string | YES | 股票代碼，如 `AAPL.US` | +| report | string | NO | 報告週期：`annual` 或 `quarterly`（默認：annual）| + +## 請求示例 + + + + +```python +from longbridge.openapi import FundamentalContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +config = Config.from_oauth(oauth) +ctx = FundamentalContext(config) +resp = ctx.us_analyst_consensus("AAPL.US", report="annual") +print(resp) +``` + + + + +```go +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/fundamental" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, _ := config.New(config.WithOAuthClient(o)) + c, _ := fundamental.NewFromCfg(conf) + defer c.Close() + resp, err := c.AnalystConsensus(context.Background(), "AAPL.US", "annual") + if err != nil { log.Fatal(err) } + fmt.Printf("%+v\n", resp) +} +``` + + + diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md b/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md new file mode 100644 index 00000000..b2113fe2 --- /dev/null +++ b/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md @@ -0,0 +1,74 @@ +--- +slug: /us_company_dividends +title: 美股公司分紅 +sidebar_position: 37 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning 僅限美股賬戶 +此方法僅適用於美國數據中心賬戶。 +::: + +獲取美股股票分紅歷史——TTM 股息率、派息次數及逐筆分紅記錄。 + + + +## 參數 + +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| counter_id | string | YES | 股票代碼，如 `AAPL.US` | + +## 請求示例 + + + + +```python +from longbridge.openapi import FundamentalContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +config = Config.from_oauth(oauth) +ctx = FundamentalContext(config) +resp = ctx.us_company_dividends("AAPL.US") +print(resp) +``` + + + + +```go +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/fundamental" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, _ := config.New(config.WithOAuthClient(o)) + c, _ := fundamental.NewFromCfg(conf) + defer c.Close() + resp, err := c.CompanyDividends(context.Background(), "AAPL.US") + if err != nil { log.Fatal(err) } + fmt.Printf("%+v\n", resp) +} +``` + + + diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md new file mode 100644 index 00000000..24d9282f --- /dev/null +++ b/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md @@ -0,0 +1,74 @@ +--- +slug: /us_company_overview +title: 美股公司概覽 +sidebar_position: 30 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning 僅限美股賬戶 +此方法僅適用於美國數據中心賬戶。 +::: + +獲取美股公司概覽資訊——簡介、市值、排名標籤和詳情連結。 + + + +## 參數 + +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| counter_id | string | YES | 股票代碼，如 `AAPL.US` | + +## 請求示例 + + + + +```python +from longbridge.openapi import FundamentalContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +config = Config.from_oauth(oauth) +ctx = FundamentalContext(config) +resp = ctx.us_company_overview("AAPL.US") +print(resp) +``` + + + + +```go +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/fundamental" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, _ := config.New(config.WithOAuthClient(o)) + c, _ := fundamental.NewFromCfg(conf) + defer c.Close() + resp, err := c.CompanyOverview(context.Background(), "AAPL.US") + if err != nil { log.Fatal(err) } + fmt.Printf("%+v\n", resp) +} +``` + + + diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md new file mode 100644 index 00000000..8eb6ecc1 --- /dev/null +++ b/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -0,0 +1,74 @@ +--- +slug: /us_etf_dividend_info +title: 美股 ETF 分紅資訊 +sidebar_position: 36 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning 僅限美股賬戶 +此方法僅適用於美國數據中心賬戶。 +::: + +獲取美股 ETF 分紅資訊——TTM 股息率、派息頻率及財年明細。 + + + +## 參數 + +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| counter_id | string | YES | ETF 代碼，如 `IVV.US` | + +## 請求示例 + + + + +```python +from longbridge.openapi import FundamentalContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +config = Config.from_oauth(oauth) +ctx = FundamentalContext(config) +resp = ctx.us_etf_dividend_info("IVV.US") +print(resp) +``` + + + + +```go +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/fundamental" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, _ := config.New(config.WithOAuthClient(o)) + c, _ := fundamental.NewFromCfg(conf) + defer c.Close() + resp, err := c.ETFDividendInfo(context.Background(), "IVV.US") + if err != nil { log.Fatal(err) } + fmt.Printf("%+v\n", resp) +} +``` + + + diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md b/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md new file mode 100644 index 00000000..2a2064bb --- /dev/null +++ b/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md @@ -0,0 +1,75 @@ +--- +slug: /us_etf_files +title: 美股 ETF 文件 +sidebar_position: 38 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning 僅限美股賬戶 +此方法僅適用於美國數據中心賬戶。 +::: + +列出美股 ETF 的監管文件——招股書、事實說明書和年報。 + + + +## 參數 + +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| counter_id | string | YES | ETF 代碼，如 `IVV.US` | +| size | int | NO | 最大返回文件數 | + +## 請求示例 + + + + +```python +from longbridge.openapi import FundamentalContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +config = Config.from_oauth(oauth) +ctx = FundamentalContext(config) +resp = ctx.us_etf_files("IVV.US") +print(resp) +``` + + + + +```go +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/fundamental" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, _ := config.New(config.WithOAuthClient(o)) + c, _ := fundamental.NewFromCfg(conf) + defer c.Close() + resp, err := c.ETFFiles(context.Background(), "IVV.US", nil) + if err != nil { log.Fatal(err) } + fmt.Printf("%+v\n", resp) +} +``` + + + diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md new file mode 100644 index 00000000..77ab1873 --- /dev/null +++ b/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md @@ -0,0 +1,75 @@ +--- +slug: /us_financial_overview +title: 美股財務概覽 +sidebar_position: 32 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning 僅限美股賬戶 +此方法僅適用於美國數據中心賬戶。 +::: + +按報告週期獲取美股財務概覽——損益、資產負債和現金流摘要。 + + + +## 參數 + +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| counter_id | string | YES | 股票代碼，如 `AAPL.US` | +| report | string | NO | 報告週期：`annual` 或 `quarterly`（默認：annual）| + +## 請求示例 + + + + +```python +from longbridge.openapi import FundamentalContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +config = Config.from_oauth(oauth) +ctx = FundamentalContext(config) +resp = ctx.us_financial_overview("AAPL.US", report="annual") +print(resp) +``` + + + + +```go +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/fundamental" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, _ := config.New(config.WithOAuthClient(o)) + c, _ := fundamental.NewFromCfg(conf) + defer c.Close() + resp, err := c.FinancialOverview(context.Background(), "AAPL.US", "annual") + if err != nil { log.Fatal(err) } + fmt.Printf("%+v\n", resp) +} +``` + + + diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md new file mode 100644 index 00000000..605d5af4 --- /dev/null +++ b/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -0,0 +1,76 @@ +--- +slug: /us_financial_statement_v3 +title: 美股財務報表 +sidebar_position: 33 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning 僅限美股賬戶 +此方法僅適用於美國數據中心賬戶。 +::: + +獲取美股指定財務報表（損益表、資產負債表或現金流量表）。 + + + +## 參數 + +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| counter_id | string | YES | 股票代碼，如 `AAPL.US` | +| kind | string | YES | 報表類型：`IS`（損益表）、`BS`（資產負債表）、`CF`（現金流量表）| +| report | string | NO | 報告週期 | + +## 請求示例 + + + + +```python +from longbridge.openapi import FundamentalContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +config = Config.from_oauth(oauth) +ctx = FundamentalContext(config) +resp = ctx.us_financial_statement_v3("AAPL.US", kind="IS", report="annual") +print(resp) +``` + + + + +```go +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/fundamental" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, _ := config.New(config.WithOAuthClient(o)) + c, _ := fundamental.NewFromCfg(conf) + defer c.Close() + resp, err := c.FinancialStatementV3(context.Background(), "AAPL.US", "IS", "annual") + if err != nil { log.Fatal(err) } + fmt.Printf("%+v\n", resp) +} +``` + + + diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md new file mode 100644 index 00000000..c5f263bb --- /dev/null +++ b/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -0,0 +1,75 @@ +--- +slug: /us_key_financial_metrics +title: 美股關鍵財務指標 +sidebar_position: 34 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning 僅限美股賬戶 +此方法僅適用於美國數據中心賬戶。 +::: + +獲取美股關鍵財務指標——營收、淨利潤、EPS、利潤率和增長率。 + + + +## 參數 + +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| counter_id | string | YES | 股票代碼，如 `AAPL.US` | +| report | string | NO | 報告週期：`annual` 或 `quarterly`（默認：annual）| + +## 請求示例 + + + + +```python +from longbridge.openapi import FundamentalContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +config = Config.from_oauth(oauth) +ctx = FundamentalContext(config) +resp = ctx.us_key_financial_metrics("AAPL.US", report="annual") +print(resp) +``` + + + + +```go +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/fundamental" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, _ := config.New(config.WithOAuthClient(o)) + c, _ := fundamental.NewFromCfg(conf) + defer c.Close() + resp, err := c.KeyFinancialMetrics(context.Background(), "AAPL.US", "annual") + if err != nil { log.Fatal(err) } + fmt.Printf("%+v\n", resp) +} +``` + + + diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md new file mode 100644 index 00000000..ca7a7d5e --- /dev/null +++ b/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md @@ -0,0 +1,74 @@ +--- +slug: /us_valuation_overview +title: 美股估值概覽 +sidebar_position: 31 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning 僅限美股賬戶 +此方法僅適用於美國數據中心賬戶。 +::: + +獲取美股估值概覽——當前估值指標及歷史區間。 + + + +## 參數 + +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| counter_id | string | YES | 股票代碼，如 `AAPL.US` | + +## 請求示例 + + + + +```python +from longbridge.openapi import FundamentalContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +config = Config.from_oauth(oauth) +ctx = FundamentalContext(config) +resp = ctx.us_valuation_overview("AAPL.US") +print(resp) +``` + + + + +```go +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/fundamental" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, _ := config.New(config.WithOAuthClient(o)) + c, _ := fundamental.NewFromCfg(conf) + defer c.Close() + resp, err := c.ValuationOverview(context.Background(), "AAPL.US") + if err != nil { log.Fatal(err) } + fmt.Printf("%+v\n", resp) +} +``` + + + From cd9831e42343295dc9662cc4c68d9e5b2cfde9c2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 15:02:39 +0800 Subject: [PATCH 09/51] docs(trade/quote): add US market SDK docs (4 TradeContext + 1 QuoteContext methods, 3 langs) --- .../docs/quote/stocks/us_crypto_overview.md | 66 +++++++++++++++++++ docs/en/docs/trade/asset/us_asset_overview.md | 50 ++++++++++++++ docs/en/docs/trade/asset/us_realized_pl.md | 54 +++++++++++++++ docs/en/docs/trade/order/us_order_detail.md | 53 +++++++++++++++ docs/en/docs/trade/order/us_query_orders.md | 58 ++++++++++++++++ .../docs/quote/stocks/us_crypto_overview.md | 52 +++++++++++++++ .../docs/trade/asset/us_asset_overview.md | 50 ++++++++++++++ docs/zh-CN/docs/trade/asset/us_realized_pl.md | 54 +++++++++++++++ .../zh-CN/docs/trade/order/us_order_detail.md | 53 +++++++++++++++ .../zh-CN/docs/trade/order/us_query_orders.md | 58 ++++++++++++++++ .../docs/quote/stocks/us_crypto_overview.md | 52 +++++++++++++++ .../docs/trade/asset/us_asset_overview.md | 50 ++++++++++++++ docs/zh-HK/docs/trade/asset/us_realized_pl.md | 54 +++++++++++++++ .../zh-HK/docs/trade/order/us_order_detail.md | 53 +++++++++++++++ .../zh-HK/docs/trade/order/us_query_orders.md | 58 ++++++++++++++++ 15 files changed, 815 insertions(+) create mode 100644 docs/en/docs/quote/stocks/us_crypto_overview.md create mode 100644 docs/en/docs/trade/asset/us_asset_overview.md create mode 100644 docs/en/docs/trade/asset/us_realized_pl.md create mode 100644 docs/en/docs/trade/order/us_order_detail.md create mode 100644 docs/en/docs/trade/order/us_query_orders.md create mode 100644 docs/zh-CN/docs/quote/stocks/us_crypto_overview.md create mode 100644 docs/zh-CN/docs/trade/asset/us_asset_overview.md create mode 100644 docs/zh-CN/docs/trade/asset/us_realized_pl.md create mode 100644 docs/zh-CN/docs/trade/order/us_order_detail.md create mode 100644 docs/zh-CN/docs/trade/order/us_query_orders.md create mode 100644 docs/zh-HK/docs/quote/stocks/us_crypto_overview.md create mode 100644 docs/zh-HK/docs/trade/asset/us_asset_overview.md create mode 100644 docs/zh-HK/docs/trade/asset/us_realized_pl.md create mode 100644 docs/zh-HK/docs/trade/order/us_order_detail.md create mode 100644 docs/zh-HK/docs/trade/order/us_query_orders.md diff --git a/docs/en/docs/quote/stocks/us_crypto_overview.md b/docs/en/docs/quote/stocks/us_crypto_overview.md new file mode 100644 index 00000000..ed311566 --- /dev/null +++ b/docs/en/docs/quote/stocks/us_crypto_overview.md @@ -0,0 +1,66 @@ +--- +slug: us_crypto_overview +title: US Crypto Overview +sidebar_position: 10 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning US Only +This method is only available for US data-center accounts. +::: + +Get overview data for a US crypto trading pair — all-time highs/lows, asset info, and currency details. + + + +## Parameters + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| counter_id | string | YES | Crypto symbol, e.g. `DOGEUSD.BKKT` | + +## Request Example + + + + +```python +from longbridge.openapi import QuoteContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +config = Config.from_oauth(oauth) +ctx = QuoteContext(config) +resp = ctx.us_crypto_overview("DOGEUSD.BKKT") +print(resp) +``` + + + + +```go +resp, err := c.CryptoOverview(ctx, "DOGEUSD.BKKT") +if err != nil { log.Fatal(err) } +fmt.Printf("%+v\n", resp) +``` + + + + +## Response Fields + +| Field | Type | Description | +| ----- | ---- | ----------- | +| symbol | string | Trading-pair symbol | +| name | string | Asset name | +| ticker | string | Short ticker | +| base_asset | string | Base asset code | +| currency | string | Quote currency | +| all_time_high | string | All-time high price | +| all_time_high_date | string | Date of all-time high | +| all_time_low | string | All-time low price | +| all_time_low_date | string | Date of all-time low | diff --git a/docs/en/docs/trade/asset/us_asset_overview.md b/docs/en/docs/trade/asset/us_asset_overview.md new file mode 100644 index 00000000..bdbfb4db --- /dev/null +++ b/docs/en/docs/trade/asset/us_asset_overview.md @@ -0,0 +1,50 @@ +--- +slug: us_asset_overview +title: US Asset Overview +sidebar_position: 10 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning US Only +This method is only available for US data-center accounts. +::: + +Get an overview of US account assets — buying power, cash, stocks, options, and crypto. + + + +## Parameters + +No parameters required. + +## Request Example + + + + +```python +from longbridge.openapi import TradeContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +config = Config.from_oauth(oauth) +ctx = TradeContext(config) +resp = ctx.us_asset_overview() +print(resp) +``` + + + + +```go +resp, err := c.USAssetOverview(ctx) +if err != nil { log.Fatal(err) } +fmt.Printf("%+v\n", resp) +``` + + + diff --git a/docs/en/docs/trade/asset/us_realized_pl.md b/docs/en/docs/trade/asset/us_realized_pl.md new file mode 100644 index 00000000..56e61515 --- /dev/null +++ b/docs/en/docs/trade/asset/us_realized_pl.md @@ -0,0 +1,54 @@ +--- +slug: us_realized_pl +title: US Realized P&L +sidebar_position: 11 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning US Only +This method is only available for US data-center accounts. +::: + +Get realized profit and loss for a US account, broken down by asset category. + + + +## Parameters + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| currency | string | YES | Settlement currency, e.g. `USD` | +| category | string | NO | Asset category: `ALL` \| `STOCK` \| `OPTION` \| `CRYPTO` (default: `ALL`) | + +## Request Example + + + + +```python +from longbridge.openapi import TradeContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +config = Config.from_oauth(oauth) +ctx = TradeContext(config) +resp = ctx.us_realized_pl("USD", category="STOCK") +print(resp) +``` + + + + +```go +cat := "STOCK" +resp, err := c.USRealizedPL(ctx, &trade.GetUSRealizedPL{Currency: "USD", Category: &cat}) +if err != nil { log.Fatal(err) } +fmt.Printf("%+v\n", resp) +``` + + + diff --git a/docs/en/docs/trade/order/us_order_detail.md b/docs/en/docs/trade/order/us_order_detail.md new file mode 100644 index 00000000..53908e92 --- /dev/null +++ b/docs/en/docs/trade/order/us_order_detail.md @@ -0,0 +1,53 @@ +--- +slug: us_order_detail +title: US Order Detail +sidebar_position: 11 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning US Only +This method is only available for US data-center accounts. +::: + +Get detail for a specific US order — execution history and optionally the attached child order. + + + +## Parameters + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| order_id | string | YES | Order ID | +| is_attached | bool | NO | Include attached child order (default: false) | + +## Request Example + + + + +```python +from longbridge.openapi import TradeContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +config = Config.from_oauth(oauth) +ctx = TradeContext(config) +resp = ctx.us_order_detail("701276261045858304", is_attached=False) +print(resp) +``` + + + + +```go +resp, err := c.USOrderDetail(ctx, "701276261045858304") +if err != nil { log.Fatal(err) } +fmt.Printf("%+v\n", resp) +``` + + + diff --git a/docs/en/docs/trade/order/us_query_orders.md b/docs/en/docs/trade/order/us_query_orders.md new file mode 100644 index 00000000..e53b010f --- /dev/null +++ b/docs/en/docs/trade/order/us_query_orders.md @@ -0,0 +1,58 @@ +--- +slug: us_query_orders +title: US Order History +sidebar_position: 10 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning US Only +This method is only available for US data-center accounts. +::: + +Query historical and pending orders for US accounts with pagination and filtering. + + + +## Parameters + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| symbol | string | NO | Filter by symbol, e.g. `AAPL.US` | +| side | OrderSide | NO | Filter by side: Buy or Sell | +| start_at | int64 | NO | Start time (Unix seconds) | +| end_at | int64 | NO | End time (Unix seconds) | +| query_type | int32 | NO | 0=all, 1=pending, 2=filled (default: 0) | +| page | int32 | NO | Page number, 1-based (default: 1) | +| limit | int32 | NO | Page size (default: 20) | + +## Request Example + + + + +```python +from longbridge.openapi import TradeContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +config = Config.from_oauth(oauth) +ctx = TradeContext(config) +resp = ctx.query_us_orders() +print(resp) +``` + + + + +```go +resp, err := c.QueryUSOrders(ctx, &trade.GetUSHistoryOrders{Page: 1, Limit: 20}) +if err != nil { log.Fatal(err) } +fmt.Printf("%+v\n", resp) +``` + + + diff --git a/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md b/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md new file mode 100644 index 00000000..20e857db --- /dev/null +++ b/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md @@ -0,0 +1,52 @@ +--- +slug: us_crypto_overview +title: 美股加密货币概览 +sidebar_position: 10 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning 仅限美股账户 +此方法仅适用于美国数据中心账户。 +::: + +获取美股加密货币交易对的概览信息——历史最高/最低价、资产详情和货币信息。 + + + +## 参数 + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| counter_id | string | 是 | 加密货币交易对，例如 `DOGEUSD.BKKT` | + +## 请求示例 + + + + +```python +from longbridge.openapi import QuoteContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("请访问：", url)) +config = Config.from_oauth(oauth) +ctx = QuoteContext(config) +resp = ctx.us_crypto_overview("DOGEUSD.BKKT") +print(resp) +``` + + + + +```go +resp, err := c.CryptoOverview(ctx, "DOGEUSD.BKKT") +if err != nil { log.Fatal(err) } +fmt.Printf("%+v\n", resp) +``` + + + diff --git a/docs/zh-CN/docs/trade/asset/us_asset_overview.md b/docs/zh-CN/docs/trade/asset/us_asset_overview.md new file mode 100644 index 00000000..a22255e5 --- /dev/null +++ b/docs/zh-CN/docs/trade/asset/us_asset_overview.md @@ -0,0 +1,50 @@ +--- +slug: us_asset_overview +title: 美股资产概览 +sidebar_position: 10 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning 仅限美股账户 +此方法仅适用于美国数据中心账户。 +::: + +获取美股账户资产概览——买入力、现金、股票、期权和加密货币。 + + + +## 参数 + +无需参数。 + +## 请求示例 + + + + +```python +from longbridge.openapi import TradeContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("请访问：", url)) +config = Config.from_oauth(oauth) +ctx = TradeContext(config) +resp = ctx.us_asset_overview() +print(resp) +``` + + + + +```go +resp, err := c.USAssetOverview(ctx) +if err != nil { log.Fatal(err) } +fmt.Printf("%+v\n", resp) +``` + + + diff --git a/docs/zh-CN/docs/trade/asset/us_realized_pl.md b/docs/zh-CN/docs/trade/asset/us_realized_pl.md new file mode 100644 index 00000000..f1e8ba94 --- /dev/null +++ b/docs/zh-CN/docs/trade/asset/us_realized_pl.md @@ -0,0 +1,54 @@ +--- +slug: us_realized_pl +title: 美股已实现盈亏 +sidebar_position: 11 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning 仅限美股账户 +此方法仅适用于美国数据中心账户。 +::: + +获取美股账户已实现盈亏，按资产类别（股票/期权/加密货币）分组。 + + + +## 参数 + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| currency | string | 是 | 结算货币，例如 `USD` | +| category | string | 否 | 资产类别：`ALL` \| `STOCK` \| `OPTION` \| `CRYPTO`（默认：`ALL`） | + +## 请求示例 + + + + +```python +from longbridge.openapi import TradeContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("请访问：", url)) +config = Config.from_oauth(oauth) +ctx = TradeContext(config) +resp = ctx.us_realized_pl("USD", category="STOCK") +print(resp) +``` + + + + +```go +cat := "STOCK" +resp, err := c.USRealizedPL(ctx, &trade.GetUSRealizedPL{Currency: "USD", Category: &cat}) +if err != nil { log.Fatal(err) } +fmt.Printf("%+v\n", resp) +``` + + + diff --git a/docs/zh-CN/docs/trade/order/us_order_detail.md b/docs/zh-CN/docs/trade/order/us_order_detail.md new file mode 100644 index 00000000..cbb779bd --- /dev/null +++ b/docs/zh-CN/docs/trade/order/us_order_detail.md @@ -0,0 +1,53 @@ +--- +slug: us_order_detail +title: 美股委托详情 +sidebar_position: 11 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning 仅限美股账户 +此方法仅适用于美国数据中心账户。 +::: + +获取美股指定委托的详情，包括成交历史，可选获取关联子委托。 + + + +## 参数 + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| order_id | string | 是 | 委托 ID | +| is_attached | bool | 否 | 是否返回关联子委托（默认：false） | + +## 请求示例 + + + + +```python +from longbridge.openapi import TradeContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("请访问：", url)) +config = Config.from_oauth(oauth) +ctx = TradeContext(config) +resp = ctx.us_order_detail("701276261045858304", is_attached=False) +print(resp) +``` + + + + +```go +resp, err := c.USOrderDetail(ctx, "701276261045858304") +if err != nil { log.Fatal(err) } +fmt.Printf("%+v\n", resp) +``` + + + diff --git a/docs/zh-CN/docs/trade/order/us_query_orders.md b/docs/zh-CN/docs/trade/order/us_query_orders.md new file mode 100644 index 00000000..6d25c50f --- /dev/null +++ b/docs/zh-CN/docs/trade/order/us_query_orders.md @@ -0,0 +1,58 @@ +--- +slug: us_query_orders +title: 美股历史委托 +sidebar_position: 10 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning 仅限美股账户 +此方法仅适用于美国数据中心账户。 +::: + +查询美股账户的历史委托和待成交委托，支持分页和筛选。 + + + +## 参数 + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| symbol | string | 否 | 按标的筛选，例如 `AAPL.US` | +| side | OrderSide | 否 | 按方向筛选：Buy 或 Sell | +| start_at | int64 | 否 | 开始时间（Unix 秒） | +| end_at | int64 | 否 | 结束时间（Unix 秒） | +| query_type | int32 | 否 | 0=全部，1=待成交，2=已成交（默认：0） | +| page | int32 | 否 | 页码，从 1 开始（默认：1） | +| limit | int32 | 否 | 每页数量（默认：20） | + +## 请求示例 + + + + +```python +from longbridge.openapi import TradeContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("请访问：", url)) +config = Config.from_oauth(oauth) +ctx = TradeContext(config) +resp = ctx.query_us_orders() +print(resp) +``` + + + + +```go +resp, err := c.QueryUSOrders(ctx, &trade.GetUSHistoryOrders{Page: 1, Limit: 20}) +if err != nil { log.Fatal(err) } +fmt.Printf("%+v\n", resp) +``` + + + diff --git a/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md b/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md new file mode 100644 index 00000000..8a7790be --- /dev/null +++ b/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md @@ -0,0 +1,52 @@ +--- +slug: us_crypto_overview +title: 美股加密貨幣概覽 +sidebar_position: 10 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning 僅限美股賬戶 +此方法僅適用於美國數據中心賬戶。 +::: + +獲取美股加密貨幣交易對的概覽資訊——歷史最高/最低價、資產詳情和貨幣資訊。 + + + +## 參數 + +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| counter_id | string | 是 | 加密貨幣交易對，例如 `DOGEUSD.BKKT` | + +## 請求示例 + + + + +```python +from longbridge.openapi import QuoteContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("請訪問：", url)) +config = Config.from_oauth(oauth) +ctx = QuoteContext(config) +resp = ctx.us_crypto_overview("DOGEUSD.BKKT") +print(resp) +``` + + + + +```go +resp, err := c.CryptoOverview(ctx, "DOGEUSD.BKKT") +if err != nil { log.Fatal(err) } +fmt.Printf("%+v\n", resp) +``` + + + diff --git a/docs/zh-HK/docs/trade/asset/us_asset_overview.md b/docs/zh-HK/docs/trade/asset/us_asset_overview.md new file mode 100644 index 00000000..7d7de093 --- /dev/null +++ b/docs/zh-HK/docs/trade/asset/us_asset_overview.md @@ -0,0 +1,50 @@ +--- +slug: us_asset_overview +title: 美股資產概覽 +sidebar_position: 10 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning 僅限美股賬戶 +此方法僅適用於美國數據中心賬戶。 +::: + +獲取美股賬戶資產概覽——買入力、現金、股票、期權和加密貨幣。 + + + +## 參數 + +無需參數。 + +## 請求示例 + + + + +```python +from longbridge.openapi import TradeContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("請訪問：", url)) +config = Config.from_oauth(oauth) +ctx = TradeContext(config) +resp = ctx.us_asset_overview() +print(resp) +``` + + + + +```go +resp, err := c.USAssetOverview(ctx) +if err != nil { log.Fatal(err) } +fmt.Printf("%+v\n", resp) +``` + + + diff --git a/docs/zh-HK/docs/trade/asset/us_realized_pl.md b/docs/zh-HK/docs/trade/asset/us_realized_pl.md new file mode 100644 index 00000000..40007d86 --- /dev/null +++ b/docs/zh-HK/docs/trade/asset/us_realized_pl.md @@ -0,0 +1,54 @@ +--- +slug: us_realized_pl +title: 美股已實現盈虧 +sidebar_position: 11 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning 僅限美股賬戶 +此方法僅適用於美國數據中心賬戶。 +::: + +獲取美股賬戶已實現盈虧，按資產類別（股票/期權/加密貨幣）分組。 + + + +## 參數 + +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| currency | string | 是 | 結算貨幣，例如 `USD` | +| category | string | 否 | 資產類別：`ALL` \| `STOCK` \| `OPTION` \| `CRYPTO`（默認：`ALL`） | + +## 請求示例 + + + + +```python +from longbridge.openapi import TradeContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("請訪問：", url)) +config = Config.from_oauth(oauth) +ctx = TradeContext(config) +resp = ctx.us_realized_pl("USD", category="STOCK") +print(resp) +``` + + + + +```go +cat := "STOCK" +resp, err := c.USRealizedPL(ctx, &trade.GetUSRealizedPL{Currency: "USD", Category: &cat}) +if err != nil { log.Fatal(err) } +fmt.Printf("%+v\n", resp) +``` + + + diff --git a/docs/zh-HK/docs/trade/order/us_order_detail.md b/docs/zh-HK/docs/trade/order/us_order_detail.md new file mode 100644 index 00000000..becf0a96 --- /dev/null +++ b/docs/zh-HK/docs/trade/order/us_order_detail.md @@ -0,0 +1,53 @@ +--- +slug: us_order_detail +title: 美股委託詳情 +sidebar_position: 11 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning 僅限美股賬戶 +此方法僅適用於美國數據中心賬戶。 +::: + +獲取美股指定委託的詳情，包括成交歷史，可選獲取關聯子委託。 + + + +## 參數 + +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| order_id | string | 是 | 委託 ID | +| is_attached | bool | 否 | 是否返回關聯子委託（默認：false） | + +## 請求示例 + + + + +```python +from longbridge.openapi import TradeContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("請訪問：", url)) +config = Config.from_oauth(oauth) +ctx = TradeContext(config) +resp = ctx.us_order_detail("701276261045858304", is_attached=False) +print(resp) +``` + + + + +```go +resp, err := c.USOrderDetail(ctx, "701276261045858304") +if err != nil { log.Fatal(err) } +fmt.Printf("%+v\n", resp) +``` + + + diff --git a/docs/zh-HK/docs/trade/order/us_query_orders.md b/docs/zh-HK/docs/trade/order/us_query_orders.md new file mode 100644 index 00000000..726c3ae9 --- /dev/null +++ b/docs/zh-HK/docs/trade/order/us_query_orders.md @@ -0,0 +1,58 @@ +--- +slug: us_query_orders +title: 美股歷史委託 +sidebar_position: 10 +language_tabs: false +toc_footers: [] +includes: [] +search: true +highlight_theme: '' +headingLevel: 2 +--- + +:::warning 僅限美股賬戶 +此方法僅適用於美國數據中心賬戶。 +::: + +查詢美股賬戶的歷史委託和待成交委託，支持分頁和篩選。 + + + +## 參數 + +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| symbol | string | 否 | 按標的篩選，例如 `AAPL.US` | +| side | OrderSide | 否 | 按方向篩選：Buy 或 Sell | +| start_at | int64 | 否 | 開始時間（Unix 秒） | +| end_at | int64 | 否 | 結束時間（Unix 秒） | +| query_type | int32 | 否 | 0=全部，1=待成交，2=已成交（默認：0） | +| page | int32 | 否 | 頁碼，從 1 開始（默認：1） | +| limit | int32 | 否 | 每頁數量（默認：20） | + +## 請求示例 + + + + +```python +from longbridge.openapi import TradeContext, Config, OAuthBuilder + +oauth = OAuthBuilder("your-client-id").build(lambda url: print("請訪問：", url)) +config = Config.from_oauth(oauth) +ctx = TradeContext(config) +resp = ctx.query_us_orders() +print(resp) +``` + + + + +```go +resp, err := c.QueryUSOrders(ctx, &trade.GetUSHistoryOrders{Page: 1, Limit: 20}) +if err != nil { log.Fatal(err) } +fmt.Printf("%+v\n", resp) +``` + + + From 17558bfaf5d2ee72a4c4de111746c59f5663d8eb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 15:12:01 +0800 Subject: [PATCH 10/51] =?UTF-8?q?fix(docs):=20rename=20parameter=20counter?= =?UTF-8?q?=5Fid=20=E2=86=92=20symbol=20in=20all=20US=20SDK=20docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/en/docs/fundamental/fundamental/us_analyst_consensus.md | 2 +- docs/en/docs/fundamental/fundamental/us_company_dividends.md | 2 +- docs/en/docs/fundamental/fundamental/us_company_overview.md | 2 +- docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md | 2 +- docs/en/docs/fundamental/fundamental/us_etf_files.md | 2 +- docs/en/docs/fundamental/fundamental/us_financial_overview.md | 2 +- .../docs/fundamental/fundamental/us_financial_statement_v3.md | 2 +- .../en/docs/fundamental/fundamental/us_key_financial_metrics.md | 2 +- docs/en/docs/fundamental/fundamental/us_valuation_overview.md | 2 +- docs/en/docs/quote/stocks/us_crypto_overview.md | 2 +- docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md | 2 +- docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md | 2 +- docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md | 2 +- docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md | 2 +- docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md | 2 +- .../zh-CN/docs/fundamental/fundamental/us_financial_overview.md | 2 +- .../docs/fundamental/fundamental/us_financial_statement_v3.md | 2 +- .../docs/fundamental/fundamental/us_key_financial_metrics.md | 2 +- .../zh-CN/docs/fundamental/fundamental/us_valuation_overview.md | 2 +- docs/zh-CN/docs/quote/stocks/us_crypto_overview.md | 2 +- docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md | 2 +- docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md | 2 +- docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md | 2 +- docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md | 2 +- docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md | 2 +- .../zh-HK/docs/fundamental/fundamental/us_financial_overview.md | 2 +- .../docs/fundamental/fundamental/us_financial_statement_v3.md | 2 +- .../docs/fundamental/fundamental/us_key_financial_metrics.md | 2 +- .../zh-HK/docs/fundamental/fundamental/us_valuation_overview.md | 2 +- docs/zh-HK/docs/quote/stocks/us_crypto_overview.md | 2 +- 30 files changed, 30 insertions(+), 30 deletions(-) diff --git a/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md index 31714e69..aeb9214f 100644 --- a/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md @@ -22,7 +22,7 @@ Get analyst consensus estimates for a US stock — revenue, EPS forecasts, and b | Name | Type | Required | Description | | ---- | ---- | -------- | ----------- | -| counter_id | string | YES | Stock symbol, e.g. `AAPL.US` | +| symbol | string | YES | Stock symbol, e.g. `AAPL.US` | | report | string | NO | Period: `annual` or `quarterly` (default: annual) | ## Request Example diff --git a/docs/en/docs/fundamental/fundamental/us_company_dividends.md b/docs/en/docs/fundamental/fundamental/us_company_dividends.md index c15e7105..42aec15d 100644 --- a/docs/en/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/en/docs/fundamental/fundamental/us_company_dividends.md @@ -22,7 +22,7 @@ Get dividend history for a US stock — TTM yield, payout count, and individual | Name | Type | Required | Description | | ---- | ---- | -------- | ----------- | -| counter_id | string | YES | Stock symbol, e.g. `AAPL.US` | +| symbol | string | YES | Stock symbol, e.g. `AAPL.US` | ## Request Example diff --git a/docs/en/docs/fundamental/fundamental/us_company_overview.md b/docs/en/docs/fundamental/fundamental/us_company_overview.md index 6c711238..f8d7eb16 100644 --- a/docs/en/docs/fundamental/fundamental/us_company_overview.md +++ b/docs/en/docs/fundamental/fundamental/us_company_overview.md @@ -22,7 +22,7 @@ Get company overview for a US stock — introduction, market cap, ranking tags, | Name | Type | Required | Description | | ---- | ---- | -------- | ----------- | -| counter_id | string | YES | Stock symbol, e.g. `AAPL.US` | +| symbol | string | YES | Stock symbol, e.g. `AAPL.US` | ## Request Example diff --git a/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md index f74276a3..777c1919 100644 --- a/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -22,7 +22,7 @@ Get dividend information for a US ETF — TTM dividend yield, payout frequency, | Name | Type | Required | Description | | ---- | ---- | -------- | ----------- | -| counter_id | string | YES | ETF symbol, e.g. `IVV.US` | +| symbol | string | YES | ETF symbol, e.g. `IVV.US` | ## Request Example diff --git a/docs/en/docs/fundamental/fundamental/us_etf_files.md b/docs/en/docs/fundamental/fundamental/us_etf_files.md index 8e27c368..423f58b1 100644 --- a/docs/en/docs/fundamental/fundamental/us_etf_files.md +++ b/docs/en/docs/fundamental/fundamental/us_etf_files.md @@ -22,7 +22,7 @@ List regulatory documents for a US ETF — prospectus, fact sheets, and annual r | Name | Type | Required | Description | | ---- | ---- | -------- | ----------- | -| counter_id | string | YES | ETF symbol, e.g. `IVV.US` | +| symbol | string | YES | ETF symbol, e.g. `IVV.US` | | size | int | NO | Maximum number of files to return | ## Request Example diff --git a/docs/en/docs/fundamental/fundamental/us_financial_overview.md b/docs/en/docs/fundamental/fundamental/us_financial_overview.md index 2dc730f2..0660c8d3 100644 --- a/docs/en/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/en/docs/fundamental/fundamental/us_financial_overview.md @@ -22,7 +22,7 @@ Get financial overview for a US stock by reporting period — income, balance sh | Name | Type | Required | Description | | ---- | ---- | -------- | ----------- | -| counter_id | string | YES | Stock symbol, e.g. `AAPL.US` | +| symbol | string | YES | Stock symbol, e.g. `AAPL.US` | | report | string | NO | Period: `annual` or `quarterly` (default: annual) | ## Request Example diff --git a/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md index 66298b5d..f31c801d 100644 --- a/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -22,7 +22,7 @@ Get a specific financial statement (income statement, balance sheet, or cash flo | Name | Type | Required | Description | | ---- | ---- | -------- | ----------- | -| counter_id | string | YES | Stock symbol, e.g. `AAPL.US` | +| symbol | string | YES | Stock symbol, e.g. `AAPL.US` | | kind | string | YES | Statement type: `IS` (income), `BS` (balance sheet), `CF` (cash flow) | | report | string | NO | Period: `annual` or `quarterly` (default: annual) | diff --git a/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md index 8b76e8fd..d53d2dae 100644 --- a/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -22,7 +22,7 @@ Get key financial metrics for a US stock — revenue, net income, EPS, margins, | Name | Type | Required | Description | | ---- | ---- | -------- | ----------- | -| counter_id | string | YES | Stock symbol, e.g. `AAPL.US` | +| symbol | string | YES | Stock symbol, e.g. `AAPL.US` | | report | string | NO | Period: `annual` or `quarterly` (default: annual) | ## Request Example diff --git a/docs/en/docs/fundamental/fundamental/us_valuation_overview.md b/docs/en/docs/fundamental/fundamental/us_valuation_overview.md index b85a83dc..3ac70ac6 100644 --- a/docs/en/docs/fundamental/fundamental/us_valuation_overview.md +++ b/docs/en/docs/fundamental/fundamental/us_valuation_overview.md @@ -22,7 +22,7 @@ Get valuation overview for a US stock — current valuation indicators and histo | Name | Type | Required | Description | | ---- | ---- | -------- | ----------- | -| counter_id | string | YES | Stock symbol, e.g. `AAPL.US` | +| symbol | string | YES | Stock symbol, e.g. `AAPL.US` | ## Request Example diff --git a/docs/en/docs/quote/stocks/us_crypto_overview.md b/docs/en/docs/quote/stocks/us_crypto_overview.md index ed311566..73947af8 100644 --- a/docs/en/docs/quote/stocks/us_crypto_overview.md +++ b/docs/en/docs/quote/stocks/us_crypto_overview.md @@ -22,7 +22,7 @@ Get overview data for a US crypto trading pair — all-time highs/lows, asset in | Name | Type | Required | Description | | ---- | ---- | -------- | ----------- | -| counter_id | string | YES | Crypto symbol, e.g. `DOGEUSD.BKKT` | +| symbol | string | YES | Crypto symbol, e.g. `DOGEUSD.BKKT` | ## Request Example diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md index e0711f7c..e34cf567 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md @@ -22,7 +22,7 @@ headingLevel: 2 | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| counter_id | string | YES | 股票代码，如 `AAPL.US` | +| symbol | string | YES | 股票代码，如 `AAPL.US` | | report | string | NO | 报告周期：`annual` 或 `quarterly`（默认：annual）| ## 请求示例 diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md b/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md index d94a547f..522f70d6 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md @@ -22,7 +22,7 @@ headingLevel: 2 | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| counter_id | string | YES | 股票代码，如 `AAPL.US` | +| symbol | string | YES | 股票代码，如 `AAPL.US` | ## 请求示例 diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md index 3bc03dd2..07613b35 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md @@ -22,7 +22,7 @@ headingLevel: 2 | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| counter_id | string | YES | 股票代码，如 `AAPL.US` | +| symbol | string | YES | 股票代码，如 `AAPL.US` | ## 请求示例 diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md index f563d94e..46d9786c 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -22,7 +22,7 @@ headingLevel: 2 | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| counter_id | string | YES | ETF 代码，如 `IVV.US` | +| symbol | string | YES | ETF 代码，如 `IVV.US` | ## 请求示例 diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md b/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md index 8234232c..ca3f1c21 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md @@ -22,7 +22,7 @@ headingLevel: 2 | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| counter_id | string | YES | ETF 代码，如 `IVV.US` | +| symbol | string | YES | ETF 代码，如 `IVV.US` | | size | int | NO | 最大返回文件数 | ## 请求示例 diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md index 0288c3f0..66318019 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md @@ -22,7 +22,7 @@ headingLevel: 2 | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| counter_id | string | YES | 股票代码，如 `AAPL.US` | +| symbol | string | YES | 股票代码，如 `AAPL.US` | | report | string | NO | 报告周期：`annual` 或 `quarterly`（默认：annual）| ## 请求示例 diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md index c80da383..a5d64d48 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -22,7 +22,7 @@ headingLevel: 2 | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| counter_id | string | YES | 股票代码，如 `AAPL.US` | +| symbol | string | YES | 股票代码，如 `AAPL.US` | | kind | string | YES | 报表类型：`IS`（损益表）、`BS`（资产负债表）、`CF`（现金流量表）| | report | string | NO | 报告周期 | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md index e9557a2b..d2f78ff2 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -22,7 +22,7 @@ headingLevel: 2 | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| counter_id | string | YES | 股票代码，如 `AAPL.US` | +| symbol | string | YES | 股票代码，如 `AAPL.US` | | report | string | NO | 报告周期：`annual` 或 `quarterly`（默认：annual）| ## 请求示例 diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md index b613f55a..c2f99a97 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md @@ -22,7 +22,7 @@ headingLevel: 2 | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| counter_id | string | YES | 股票代码，如 `AAPL.US` | +| symbol | string | YES | 股票代码，如 `AAPL.US` | ## 请求示例 diff --git a/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md b/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md index 20e857db..21c5ca2f 100644 --- a/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md +++ b/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md @@ -22,7 +22,7 @@ headingLevel: 2 | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| counter_id | string | 是 | 加密货币交易对，例如 `DOGEUSD.BKKT` | +| symbol | string | 是 | 加密货币交易对，例如 `DOGEUSD.BKKT` | ## 请求示例 diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md index 749b9096..b94a72f6 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md @@ -22,7 +22,7 @@ headingLevel: 2 | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| counter_id | string | YES | 股票代碼，如 `AAPL.US` | +| symbol | string | YES | 股票代碼，如 `AAPL.US` | | report | string | NO | 報告週期：`annual` 或 `quarterly`（默認：annual）| ## 請求示例 diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md b/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md index b2113fe2..c5e1618f 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md @@ -22,7 +22,7 @@ headingLevel: 2 | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| counter_id | string | YES | 股票代碼，如 `AAPL.US` | +| symbol | string | YES | 股票代碼，如 `AAPL.US` | ## 請求示例 diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md index 24d9282f..3146df0c 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md @@ -22,7 +22,7 @@ headingLevel: 2 | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| counter_id | string | YES | 股票代碼，如 `AAPL.US` | +| symbol | string | YES | 股票代碼，如 `AAPL.US` | ## 請求示例 diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md index 8eb6ecc1..e04428e8 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -22,7 +22,7 @@ headingLevel: 2 | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| counter_id | string | YES | ETF 代碼，如 `IVV.US` | +| symbol | string | YES | ETF 代碼，如 `IVV.US` | ## 請求示例 diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md b/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md index 2a2064bb..2563d5e6 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md @@ -22,7 +22,7 @@ headingLevel: 2 | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| counter_id | string | YES | ETF 代碼，如 `IVV.US` | +| symbol | string | YES | ETF 代碼，如 `IVV.US` | | size | int | NO | 最大返回文件數 | ## 請求示例 diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md index 77ab1873..e35efafe 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md @@ -22,7 +22,7 @@ headingLevel: 2 | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| counter_id | string | YES | 股票代碼，如 `AAPL.US` | +| symbol | string | YES | 股票代碼，如 `AAPL.US` | | report | string | NO | 報告週期：`annual` 或 `quarterly`（默認：annual）| ## 請求示例 diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md index 605d5af4..ccb68e73 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -22,7 +22,7 @@ headingLevel: 2 | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| counter_id | string | YES | 股票代碼，如 `AAPL.US` | +| symbol | string | YES | 股票代碼，如 `AAPL.US` | | kind | string | YES | 報表類型：`IS`（損益表）、`BS`（資產負債表）、`CF`（現金流量表）| | report | string | NO | 報告週期 | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md index c5f263bb..c64cc2ad 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -22,7 +22,7 @@ headingLevel: 2 | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| counter_id | string | YES | 股票代碼，如 `AAPL.US` | +| symbol | string | YES | 股票代碼，如 `AAPL.US` | | report | string | NO | 報告週期：`annual` 或 `quarterly`（默認：annual）| ## 請求示例 diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md index ca7a7d5e..f1e5f39d 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md @@ -22,7 +22,7 @@ headingLevel: 2 | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| counter_id | string | YES | 股票代碼，如 `AAPL.US` | +| symbol | string | YES | 股票代碼，如 `AAPL.US` | ## 請求示例 diff --git a/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md b/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md index 8a7790be..d3fd72c2 100644 --- a/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md +++ b/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md @@ -22,7 +22,7 @@ headingLevel: 2 | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| counter_id | string | 是 | 加密貨幣交易對，例如 `DOGEUSD.BKKT` | +| symbol | string | 是 | 加密貨幣交易對，例如 `DOGEUSD.BKKT` | ## 請求示例 From 432b4c727433a7b8fc5f82dff4cb72af3a213f73 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 15:16:07 +0800 Subject: [PATCH 11/51] fix(docs): fix slug format, localize YES/NO in zh-CN/zh-HK, add missing Response Fields to crypto overview --- .../fundamental/us_analyst_consensus.md | 2 +- .../fundamental/us_company_dividends.md | 2 +- .../fundamental/fundamental/us_company_overview.md | 2 +- .../fundamental/us_etf_dividend_info.md | 2 +- .../docs/fundamental/fundamental/us_etf_files.md | 2 +- .../fundamental/us_financial_overview.md | 2 +- .../fundamental/us_financial_statement_v3.md | 2 +- .../fundamental/us_key_financial_metrics.md | 2 +- .../fundamental/us_valuation_overview.md | 2 +- .../fundamental/us_analyst_consensus.md | 6 +++--- .../fundamental/us_company_dividends.md | 4 ++-- .../fundamental/fundamental/us_company_overview.md | 4 ++-- .../fundamental/us_etf_dividend_info.md | 4 ++-- .../docs/fundamental/fundamental/us_etf_files.md | 6 +++--- .../fundamental/us_financial_overview.md | 6 +++--- .../fundamental/us_financial_statement_v3.md | 8 ++++---- .../fundamental/us_key_financial_metrics.md | 6 +++--- .../fundamental/us_valuation_overview.md | 4 ++-- docs/zh-CN/docs/quote/stocks/us_crypto_overview.md | 14 ++++++++++++++ .../fundamental/us_analyst_consensus.md | 6 +++--- .../fundamental/us_company_dividends.md | 4 ++-- .../fundamental/fundamental/us_company_overview.md | 4 ++-- .../fundamental/us_etf_dividend_info.md | 4 ++-- .../docs/fundamental/fundamental/us_etf_files.md | 6 +++--- .../fundamental/us_financial_overview.md | 6 +++--- .../fundamental/us_financial_statement_v3.md | 8 ++++---- .../fundamental/us_key_financial_metrics.md | 6 +++--- .../fundamental/us_valuation_overview.md | 4 ++-- docs/zh-HK/docs/quote/stocks/us_crypto_overview.md | 14 ++++++++++++++ longbridge-terminal | 1 + openapi | 1 + openapi-go | 1 + 32 files changed, 88 insertions(+), 57 deletions(-) create mode 160000 longbridge-terminal create mode 160000 openapi create mode 160000 openapi-go diff --git a/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md index aeb9214f..c749137e 100644 --- a/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md @@ -1,5 +1,5 @@ --- -slug: /us_analyst_consensus +slug: us_analyst_consensus title: US Analyst Consensus sidebar_position: 35 language_tabs: false diff --git a/docs/en/docs/fundamental/fundamental/us_company_dividends.md b/docs/en/docs/fundamental/fundamental/us_company_dividends.md index 42aec15d..b31e3512 100644 --- a/docs/en/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/en/docs/fundamental/fundamental/us_company_dividends.md @@ -1,5 +1,5 @@ --- -slug: /us_company_dividends +slug: us_company_dividends title: US Company Dividends sidebar_position: 37 language_tabs: false diff --git a/docs/en/docs/fundamental/fundamental/us_company_overview.md b/docs/en/docs/fundamental/fundamental/us_company_overview.md index f8d7eb16..31893f4e 100644 --- a/docs/en/docs/fundamental/fundamental/us_company_overview.md +++ b/docs/en/docs/fundamental/fundamental/us_company_overview.md @@ -1,5 +1,5 @@ --- -slug: /us_company_overview +slug: us_company_overview title: US Company Overview sidebar_position: 30 language_tabs: false diff --git a/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md index 777c1919..79bd14c7 100644 --- a/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -1,5 +1,5 @@ --- -slug: /us_etf_dividend_info +slug: us_etf_dividend_info title: US ETF Dividend Info sidebar_position: 36 language_tabs: false diff --git a/docs/en/docs/fundamental/fundamental/us_etf_files.md b/docs/en/docs/fundamental/fundamental/us_etf_files.md index 423f58b1..c3284067 100644 --- a/docs/en/docs/fundamental/fundamental/us_etf_files.md +++ b/docs/en/docs/fundamental/fundamental/us_etf_files.md @@ -1,5 +1,5 @@ --- -slug: /us_etf_files +slug: us_etf_files title: US ETF Files sidebar_position: 38 language_tabs: false diff --git a/docs/en/docs/fundamental/fundamental/us_financial_overview.md b/docs/en/docs/fundamental/fundamental/us_financial_overview.md index 0660c8d3..0175fd3c 100644 --- a/docs/en/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/en/docs/fundamental/fundamental/us_financial_overview.md @@ -1,5 +1,5 @@ --- -slug: /us_financial_overview +slug: us_financial_overview title: US Financial Overview sidebar_position: 32 language_tabs: false diff --git a/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md index f31c801d..f9a8c429 100644 --- a/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -1,5 +1,5 @@ --- -slug: /us_financial_statement_v3 +slug: us_financial_statement_v3 title: US Financial Statement sidebar_position: 33 language_tabs: false diff --git a/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md index d53d2dae..4225f4e9 100644 --- a/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -1,5 +1,5 @@ --- -slug: /us_key_financial_metrics +slug: us_key_financial_metrics title: US Key Financial Metrics sidebar_position: 34 language_tabs: false diff --git a/docs/en/docs/fundamental/fundamental/us_valuation_overview.md b/docs/en/docs/fundamental/fundamental/us_valuation_overview.md index 3ac70ac6..697f8b7d 100644 --- a/docs/en/docs/fundamental/fundamental/us_valuation_overview.md +++ b/docs/en/docs/fundamental/fundamental/us_valuation_overview.md @@ -1,5 +1,5 @@ --- -slug: /us_valuation_overview +slug: us_valuation_overview title: US Valuation Overview sidebar_position: 31 language_tabs: false diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md index e34cf567..8f383fc8 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md @@ -1,5 +1,5 @@ --- -slug: /us_analyst_consensus +slug: us_analyst_consensus title: 美股分析师一致预期 sidebar_position: 35 language_tabs: false @@ -22,8 +22,8 @@ headingLevel: 2 | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| symbol | string | YES | 股票代码，如 `AAPL.US` | -| report | string | NO | 报告周期：`annual` 或 `quarterly`（默认：annual）| +| symbol | string | 是 | 股票代码，如 `AAPL.US` | +| report | string | 否 | 报告周期：`annual` 或 `quarterly`（默认：annual）| ## 请求示例 diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md b/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md index 522f70d6..e2380890 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md @@ -1,5 +1,5 @@ --- -slug: /us_company_dividends +slug: us_company_dividends title: 美股公司分红 sidebar_position: 37 language_tabs: false @@ -22,7 +22,7 @@ headingLevel: 2 | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| symbol | string | YES | 股票代码，如 `AAPL.US` | +| symbol | string | 是 | 股票代码，如 `AAPL.US` | ## 请求示例 diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md index 07613b35..92d079c4 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md @@ -1,5 +1,5 @@ --- -slug: /us_company_overview +slug: us_company_overview title: 美股公司概览 sidebar_position: 30 language_tabs: false @@ -22,7 +22,7 @@ headingLevel: 2 | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| symbol | string | YES | 股票代码，如 `AAPL.US` | +| symbol | string | 是 | 股票代码，如 `AAPL.US` | ## 请求示例 diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md index 46d9786c..c5d4c3d0 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -1,5 +1,5 @@ --- -slug: /us_etf_dividend_info +slug: us_etf_dividend_info title: 美股 ETF 分红信息 sidebar_position: 36 language_tabs: false @@ -22,7 +22,7 @@ headingLevel: 2 | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| symbol | string | YES | ETF 代码，如 `IVV.US` | +| symbol | string | 是 | ETF 代码，如 `IVV.US` | ## 请求示例 diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md b/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md index ca3f1c21..421b5d90 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md @@ -1,5 +1,5 @@ --- -slug: /us_etf_files +slug: us_etf_files title: 美股 ETF 文件 sidebar_position: 38 language_tabs: false @@ -22,8 +22,8 @@ headingLevel: 2 | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| symbol | string | YES | ETF 代码，如 `IVV.US` | -| size | int | NO | 最大返回文件数 | +| symbol | string | 是 | ETF 代码，如 `IVV.US` | +| size | int | 否 | 最大返回文件数 | ## 请求示例 diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md index 66318019..914cf6dc 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md @@ -1,5 +1,5 @@ --- -slug: /us_financial_overview +slug: us_financial_overview title: 美股财务概览 sidebar_position: 32 language_tabs: false @@ -22,8 +22,8 @@ headingLevel: 2 | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| symbol | string | YES | 股票代码，如 `AAPL.US` | -| report | string | NO | 报告周期：`annual` 或 `quarterly`（默认：annual）| +| symbol | string | 是 | 股票代码，如 `AAPL.US` | +| report | string | 否 | 报告周期：`annual` 或 `quarterly`（默认：annual）| ## 请求示例 diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md index a5d64d48..10bff066 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -1,5 +1,5 @@ --- -slug: /us_financial_statement_v3 +slug: us_financial_statement_v3 title: 美股财务报表 sidebar_position: 33 language_tabs: false @@ -22,9 +22,9 @@ headingLevel: 2 | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| symbol | string | YES | 股票代码，如 `AAPL.US` | -| kind | string | YES | 报表类型：`IS`（损益表）、`BS`（资产负债表）、`CF`（现金流量表）| -| report | string | NO | 报告周期 | +| symbol | string | 是 | 股票代码，如 `AAPL.US` | +| kind | string | 是 | 报表类型：`IS`（损益表）、`BS`（资产负债表）、`CF`（现金流量表）| +| report | string | 否 | 报告周期 | ## 请求示例 diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md index d2f78ff2..cec7773b 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -1,5 +1,5 @@ --- -slug: /us_key_financial_metrics +slug: us_key_financial_metrics title: 美股关键财务指标 sidebar_position: 34 language_tabs: false @@ -22,8 +22,8 @@ headingLevel: 2 | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| symbol | string | YES | 股票代码，如 `AAPL.US` | -| report | string | NO | 报告周期：`annual` 或 `quarterly`（默认：annual）| +| symbol | string | 是 | 股票代码，如 `AAPL.US` | +| report | string | 否 | 报告周期：`annual` 或 `quarterly`（默认：annual）| ## 请求示例 diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md index c2f99a97..959df794 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md @@ -1,5 +1,5 @@ --- -slug: /us_valuation_overview +slug: us_valuation_overview title: 美股估值概览 sidebar_position: 31 language_tabs: false @@ -22,7 +22,7 @@ headingLevel: 2 | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| symbol | string | YES | 股票代码，如 `AAPL.US` | +| symbol | string | 是 | 股票代码，如 `AAPL.US` | ## 请求示例 diff --git a/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md b/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md index 21c5ca2f..76f84ca6 100644 --- a/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md +++ b/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md @@ -50,3 +50,17 @@ fmt.Printf("%+v\n", resp) + +## 响应字段 + +| 字段 | 类型 | 描述 | +| ---- | ---- | ---- | +| symbol | string | 交易对代码 | +| name | string | 资产名称 | +| ticker | string | 简短代码 | +| base_asset | string | 基础资产代码 | +| currency | string | 计价货币 | +| all_time_high | string | 历史最高价 | +| all_time_high_date | string | 历史最高价日期 | +| all_time_low | string | 历史最低价 | +| all_time_low_date | string | 历史最低价日期 | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md index b94a72f6..a3fba012 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md @@ -1,5 +1,5 @@ --- -slug: /us_analyst_consensus +slug: us_analyst_consensus title: 美股分析師一致預期 sidebar_position: 35 language_tabs: false @@ -22,8 +22,8 @@ headingLevel: 2 | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| symbol | string | YES | 股票代碼，如 `AAPL.US` | -| report | string | NO | 報告週期：`annual` 或 `quarterly`（默認：annual）| +| symbol | string | 是 | 股票代碼，如 `AAPL.US` | +| report | string | 否 | 報告週期：`annual` 或 `quarterly`（默認：annual）| ## 請求示例 diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md b/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md index c5e1618f..aad3dd98 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md @@ -1,5 +1,5 @@ --- -slug: /us_company_dividends +slug: us_company_dividends title: 美股公司分紅 sidebar_position: 37 language_tabs: false @@ -22,7 +22,7 @@ headingLevel: 2 | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| symbol | string | YES | 股票代碼，如 `AAPL.US` | +| symbol | string | 是 | 股票代碼，如 `AAPL.US` | ## 請求示例 diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md index 3146df0c..62302f27 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md @@ -1,5 +1,5 @@ --- -slug: /us_company_overview +slug: us_company_overview title: 美股公司概覽 sidebar_position: 30 language_tabs: false @@ -22,7 +22,7 @@ headingLevel: 2 | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| symbol | string | YES | 股票代碼，如 `AAPL.US` | +| symbol | string | 是 | 股票代碼，如 `AAPL.US` | ## 請求示例 diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md index e04428e8..ec6e5ba9 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -1,5 +1,5 @@ --- -slug: /us_etf_dividend_info +slug: us_etf_dividend_info title: 美股 ETF 分紅資訊 sidebar_position: 36 language_tabs: false @@ -22,7 +22,7 @@ headingLevel: 2 | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| symbol | string | YES | ETF 代碼，如 `IVV.US` | +| symbol | string | 是 | ETF 代碼，如 `IVV.US` | ## 請求示例 diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md b/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md index 2563d5e6..764eb451 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md @@ -1,5 +1,5 @@ --- -slug: /us_etf_files +slug: us_etf_files title: 美股 ETF 文件 sidebar_position: 38 language_tabs: false @@ -22,8 +22,8 @@ headingLevel: 2 | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| symbol | string | YES | ETF 代碼，如 `IVV.US` | -| size | int | NO | 最大返回文件數 | +| symbol | string | 是 | ETF 代碼，如 `IVV.US` | +| size | int | 否 | 最大返回文件數 | ## 請求示例 diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md index e35efafe..b9845421 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md @@ -1,5 +1,5 @@ --- -slug: /us_financial_overview +slug: us_financial_overview title: 美股財務概覽 sidebar_position: 32 language_tabs: false @@ -22,8 +22,8 @@ headingLevel: 2 | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| symbol | string | YES | 股票代碼，如 `AAPL.US` | -| report | string | NO | 報告週期：`annual` 或 `quarterly`（默認：annual）| +| symbol | string | 是 | 股票代碼，如 `AAPL.US` | +| report | string | 否 | 報告週期：`annual` 或 `quarterly`（默認：annual）| ## 請求示例 diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md index ccb68e73..a796795e 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -1,5 +1,5 @@ --- -slug: /us_financial_statement_v3 +slug: us_financial_statement_v3 title: 美股財務報表 sidebar_position: 33 language_tabs: false @@ -22,9 +22,9 @@ headingLevel: 2 | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| symbol | string | YES | 股票代碼，如 `AAPL.US` | -| kind | string | YES | 報表類型：`IS`（損益表）、`BS`（資產負債表）、`CF`（現金流量表）| -| report | string | NO | 報告週期 | +| symbol | string | 是 | 股票代碼，如 `AAPL.US` | +| kind | string | 是 | 報表類型：`IS`（損益表）、`BS`（資產負債表）、`CF`（現金流量表）| +| report | string | 否 | 報告週期 | ## 請求示例 diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md index c64cc2ad..af82c7a8 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -1,5 +1,5 @@ --- -slug: /us_key_financial_metrics +slug: us_key_financial_metrics title: 美股關鍵財務指標 sidebar_position: 34 language_tabs: false @@ -22,8 +22,8 @@ headingLevel: 2 | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| symbol | string | YES | 股票代碼，如 `AAPL.US` | -| report | string | NO | 報告週期：`annual` 或 `quarterly`（默認：annual）| +| symbol | string | 是 | 股票代碼，如 `AAPL.US` | +| report | string | 否 | 報告週期：`annual` 或 `quarterly`（默認：annual）| ## 請求示例 diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md index f1e5f39d..4ebcb395 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md @@ -1,5 +1,5 @@ --- -slug: /us_valuation_overview +slug: us_valuation_overview title: 美股估值概覽 sidebar_position: 31 language_tabs: false @@ -22,7 +22,7 @@ headingLevel: 2 | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| symbol | string | YES | 股票代碼，如 `AAPL.US` | +| symbol | string | 是 | 股票代碼，如 `AAPL.US` | ## 請求示例 diff --git a/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md b/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md index d3fd72c2..a35b3061 100644 --- a/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md +++ b/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md @@ -50,3 +50,17 @@ fmt.Printf("%+v\n", resp) + +## 響應字段 + +| 字段 | 類型 | 描述 | +| ---- | ---- | ---- | +| symbol | string | 交易對代碼 | +| name | string | 資產名稱 | +| ticker | string | 簡短代碼 | +| base_asset | string | 基礎資產代碼 | +| currency | string | 計價貨幣 | +| all_time_high | string | 歷史最高價 | +| all_time_high_date | string | 歷史最高價日期 | +| all_time_low | string | 歷史最低價 | +| all_time_low_date | string | 歷史最低價日期 | diff --git a/longbridge-terminal b/longbridge-terminal new file mode 160000 index 00000000..b9022136 --- /dev/null +++ b/longbridge-terminal @@ -0,0 +1 @@ +Subproject commit b90221361dad486c61478368cd54bb96d74fcada diff --git a/openapi b/openapi new file mode 160000 index 00000000..daf23233 --- /dev/null +++ b/openapi @@ -0,0 +1 @@ +Subproject commit daf23233dc5c9559c138d6ff089fce3ad15f3b46 diff --git a/openapi-go b/openapi-go new file mode 160000 index 00000000..f9763dcf --- /dev/null +++ b/openapi-go @@ -0,0 +1 @@ +Subproject commit f9763dcfc76f13ea69787fe6618cfdda6e6f36a5 From 9e9e379aadcd603709f97ba1deab633d68b6421f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 15:16:22 +0800 Subject: [PATCH 12/51] chore: remove stray embedded repo directories --- longbridge-terminal | 1 - openapi | 1 - openapi-go | 1 - 3 files changed, 3 deletions(-) delete mode 160000 longbridge-terminal delete mode 160000 openapi delete mode 160000 openapi-go diff --git a/longbridge-terminal b/longbridge-terminal deleted file mode 160000 index b9022136..00000000 --- a/longbridge-terminal +++ /dev/null @@ -1 +0,0 @@ -Subproject commit b90221361dad486c61478368cd54bb96d74fcada diff --git a/openapi b/openapi deleted file mode 160000 index daf23233..00000000 --- a/openapi +++ /dev/null @@ -1 +0,0 @@ -Subproject commit daf23233dc5c9559c138d6ff089fce3ad15f3b46 diff --git a/openapi-go b/openapi-go deleted file mode 160000 index f9763dcf..00000000 --- a/openapi-go +++ /dev/null @@ -1 +0,0 @@ -Subproject commit f9763dcfc76f13ea69787fe6618cfdda6e6f36a5 From e6ca248e907aa797b27f5478b707d2ef2a185e9e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 15:58:08 +0800 Subject: [PATCH 13/51] fix(docs): correct us_query_orders method name, fix action param, remove is_attached from us_order_detail --- docs/en/docs/trade/order/us_order_detail.md | 5 ++--- docs/en/docs/trade/order/us_query_orders.md | 14 +++++++------- docs/zh-CN/docs/trade/order/us_order_detail.md | 3 +-- docs/zh-CN/docs/trade/order/us_query_orders.md | 8 ++++---- docs/zh-HK/docs/trade/order/us_order_detail.md | 3 +-- docs/zh-HK/docs/trade/order/us_query_orders.md | 8 ++++---- 6 files changed, 19 insertions(+), 22 deletions(-) diff --git a/docs/en/docs/trade/order/us_order_detail.md b/docs/en/docs/trade/order/us_order_detail.md index 53908e92..c828b214 100644 --- a/docs/en/docs/trade/order/us_order_detail.md +++ b/docs/en/docs/trade/order/us_order_detail.md @@ -14,7 +14,7 @@ headingLevel: 2 This method is only available for US data-center accounts. ::: -Get detail for a specific US order — execution history and optionally the attached child order. +Get detail for a specific US order — execution history, order status, and any attached child orders. @@ -23,7 +23,6 @@ Get detail for a specific US order — execution history and optionally the atta | Name | Type | Required | Description | | ---- | ---- | -------- | ----------- | | order_id | string | YES | Order ID | -| is_attached | bool | NO | Include attached child order (default: false) | ## Request Example @@ -36,7 +35,7 @@ from longbridge.openapi import TradeContext, Config, OAuthBuilder oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) config = Config.from_oauth(oauth) ctx = TradeContext(config) -resp = ctx.us_order_detail("701276261045858304", is_attached=False) +resp = ctx.us_order_detail("701276261045858304") print(resp) ``` diff --git a/docs/en/docs/trade/order/us_query_orders.md b/docs/en/docs/trade/order/us_query_orders.md index e53b010f..e4088cfe 100644 --- a/docs/en/docs/trade/order/us_query_orders.md +++ b/docs/en/docs/trade/order/us_query_orders.md @@ -23,12 +23,12 @@ Query historical and pending orders for US accounts with pagination and filterin | Name | Type | Required | Description | | ---- | ---- | -------- | ----------- | | symbol | string | NO | Filter by symbol, e.g. `AAPL.US` | -| side | OrderSide | NO | Filter by side: Buy or Sell | -| start_at | int64 | NO | Start time (Unix seconds) | -| end_at | int64 | NO | End time (Unix seconds) | -| query_type | int32 | NO | 0=all, 1=pending, 2=filled (default: 0) | -| page | int32 | NO | Page number, 1-based (default: 1) | -| limit | int32 | NO | Page size (default: 20) | +| action | int | NO | Direction filter: `0`=all, `1`=buy, `2`=sell (default: `0`) | +| start_at | int64 | NO | Start time (Unix seconds); `0` = last 90 days | +| end_at | int64 | NO | End time (Unix seconds); `0` = now | +| query_type | int | NO | `0`=all (incl. rejected), `1`=pending, `2`=filled only (default: `0`) | +| page | int | NO | Page number, 1-based (default: `1`) | +| limit | int | NO | Page size (default: `20`) | ## Request Example @@ -41,7 +41,7 @@ from longbridge.openapi import TradeContext, Config, OAuthBuilder oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) config = Config.from_oauth(oauth) ctx = TradeContext(config) -resp = ctx.query_us_orders() +resp = ctx.us_query_orders() print(resp) ``` diff --git a/docs/zh-CN/docs/trade/order/us_order_detail.md b/docs/zh-CN/docs/trade/order/us_order_detail.md index cbb779bd..25915076 100644 --- a/docs/zh-CN/docs/trade/order/us_order_detail.md +++ b/docs/zh-CN/docs/trade/order/us_order_detail.md @@ -23,7 +23,6 @@ headingLevel: 2 | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | order_id | string | 是 | 委托 ID | -| is_attached | bool | 否 | 是否返回关联子委托（默认：false） | ## 请求示例 @@ -36,7 +35,7 @@ from longbridge.openapi import TradeContext, Config, OAuthBuilder oauth = OAuthBuilder("your-client-id").build(lambda url: print("请访问：", url)) config = Config.from_oauth(oauth) ctx = TradeContext(config) -resp = ctx.us_order_detail("701276261045858304", is_attached=False) +resp = ctx.us_order_detail("701276261045858304") print(resp) ``` diff --git a/docs/zh-CN/docs/trade/order/us_query_orders.md b/docs/zh-CN/docs/trade/order/us_query_orders.md index 6d25c50f..b7edc349 100644 --- a/docs/zh-CN/docs/trade/order/us_query_orders.md +++ b/docs/zh-CN/docs/trade/order/us_query_orders.md @@ -23,9 +23,9 @@ headingLevel: 2 | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | symbol | string | 否 | 按标的筛选，例如 `AAPL.US` | -| side | OrderSide | 否 | 按方向筛选：Buy 或 Sell | -| start_at | int64 | 否 | 开始时间（Unix 秒） | -| end_at | int64 | 否 | 结束时间（Unix 秒） | +| action | int | 否 | 方向筛选：`0`=全部，`1`=买入，`2`=卖出（默认：`0`） | +| start_at | int64 | 否 | 开始时间（Unix 秒）；`0` = 最近 90 天 | +| end_at | int64 | 否 | 结束时间（Unix 秒）；`0` = 当前时间 | | query_type | int32 | 否 | 0=全部，1=待成交，2=已成交（默认：0） | | page | int32 | 否 | 页码，从 1 开始（默认：1） | | limit | int32 | 否 | 每页数量（默认：20） | @@ -41,7 +41,7 @@ from longbridge.openapi import TradeContext, Config, OAuthBuilder oauth = OAuthBuilder("your-client-id").build(lambda url: print("请访问：", url)) config = Config.from_oauth(oauth) ctx = TradeContext(config) -resp = ctx.query_us_orders() +resp = ctx.us_query_orders() print(resp) ``` diff --git a/docs/zh-HK/docs/trade/order/us_order_detail.md b/docs/zh-HK/docs/trade/order/us_order_detail.md index becf0a96..d8cf9694 100644 --- a/docs/zh-HK/docs/trade/order/us_order_detail.md +++ b/docs/zh-HK/docs/trade/order/us_order_detail.md @@ -23,7 +23,6 @@ headingLevel: 2 | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | order_id | string | 是 | 委託 ID | -| is_attached | bool | 否 | 是否返回關聯子委託（默認：false） | ## 請求示例 @@ -36,7 +35,7 @@ from longbridge.openapi import TradeContext, Config, OAuthBuilder oauth = OAuthBuilder("your-client-id").build(lambda url: print("請訪問：", url)) config = Config.from_oauth(oauth) ctx = TradeContext(config) -resp = ctx.us_order_detail("701276261045858304", is_attached=False) +resp = ctx.us_order_detail("701276261045858304") print(resp) ``` diff --git a/docs/zh-HK/docs/trade/order/us_query_orders.md b/docs/zh-HK/docs/trade/order/us_query_orders.md index 726c3ae9..129a1b1d 100644 --- a/docs/zh-HK/docs/trade/order/us_query_orders.md +++ b/docs/zh-HK/docs/trade/order/us_query_orders.md @@ -23,9 +23,9 @@ headingLevel: 2 | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | symbol | string | 否 | 按標的篩選，例如 `AAPL.US` | -| side | OrderSide | 否 | 按方向篩選：Buy 或 Sell | -| start_at | int64 | 否 | 開始時間（Unix 秒） | -| end_at | int64 | 否 | 結束時間（Unix 秒） | +| action | int | 否 | 方向篩選：`0`=全部，`1`=買入，`2`=賣出（默認：`0`） | +| start_at | int64 | 否 | 開始時間（Unix 秒）；`0` = 最近 90 天 | +| end_at | int64 | 否 | 結束時間（Unix 秒）；`0` = 當前時間 | | query_type | int32 | 否 | 0=全部，1=待成交，2=已成交（默認：0） | | page | int32 | 否 | 頁碼，從 1 開始（默認：1） | | limit | int32 | 否 | 每頁數量（默認：20） | @@ -41,7 +41,7 @@ from longbridge.openapi import TradeContext, Config, OAuthBuilder oauth = OAuthBuilder("your-client-id").build(lambda url: print("請訪問：", url)) config = Config.from_oauth(oauth) ctx = TradeContext(config) -resp = ctx.query_us_orders() +resp = ctx.us_query_orders() print(resp) ``` From 5989436e030816a32d6eaf5f1a6006dea047cf32 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 16:02:58 +0800 Subject: [PATCH 14/51] docs: add AP-only (HK/SG) warning to operating, brokers, broker-holding, DCA docs --- docs/en/docs/cli/account/dca.md | 4 ++++ docs/en/docs/cli/market-data/broker-holding.md | 4 ++++ docs/en/docs/fundamental/fundamental/operating.md | 4 ++++ docs/en/docs/fundamental/market/broker_holding_daily.md | 4 ++++ docs/en/docs/fundamental/market/broker_holding_detail.md | 4 ++++ docs/en/docs/fundamental/market/broker_positions.md | 4 ++++ docs/en/docs/quote/stocks/brokers.md | 4 ++++ docs/zh-CN/docs/cli/account/dca.md | 4 ++++ docs/zh-CN/docs/cli/market-data/broker-holding.md | 4 ++++ docs/zh-CN/docs/fundamental/fundamental/operating.md | 4 ++++ docs/zh-CN/docs/fundamental/market/broker_holding_daily.md | 4 ++++ docs/zh-CN/docs/fundamental/market/broker_holding_detail.md | 4 ++++ docs/zh-CN/docs/fundamental/market/broker_positions.md | 4 ++++ docs/zh-CN/docs/quote/stocks/brokers.md | 4 ++++ docs/zh-HK/docs/cli/account/dca.md | 4 ++++ docs/zh-HK/docs/cli/market-data/broker-holding.md | 4 ++++ docs/zh-HK/docs/fundamental/fundamental/operating.md | 4 ++++ docs/zh-HK/docs/fundamental/market/broker_holding_daily.md | 4 ++++ docs/zh-HK/docs/fundamental/market/broker_holding_detail.md | 4 ++++ docs/zh-HK/docs/fundamental/market/broker_positions.md | 4 ++++ docs/zh-HK/docs/quote/stocks/brokers.md | 4 ++++ 21 files changed, 84 insertions(+) diff --git a/docs/en/docs/cli/account/dca.md b/docs/en/docs/cli/account/dca.md index 367df772..34203503 100644 --- a/docs/en/docs/cli/account/dca.md +++ b/docs/en/docs/cli/account/dca.md @@ -4,6 +4,10 @@ sidebar_label: 'dca' sidebar_position: 10 --- +:::warning Not Available for US Accounts +This command requires an AP data-center account (HK or Singapore). US data-center accounts are not supported. +::: + # longbridge dca Recurring investment — automatically invest a fixed amount at regular intervals. Create and manage plans that execute stock purchases on a daily, weekly, fortnightly, or monthly schedule. Track trade history, monitor cumulative profit, and check upcoming trade dates. diff --git a/docs/en/docs/cli/market-data/broker-holding.md b/docs/en/docs/cli/market-data/broker-holding.md index d579c63a..d6e3cb08 100644 --- a/docs/en/docs/cli/market-data/broker-holding.md +++ b/docs/en/docs/cli/market-data/broker-holding.md @@ -4,6 +4,10 @@ sidebar_label: 'broker-holding' sidebar_position: 15 --- +:::warning Not Available for US Accounts +This command requires an AP data-center account (HK or Singapore). US data-center accounts are not supported. +::: + # longbridge broker-holding View broker holding positions for HK-listed stocks — top buyers/sellers, full detail list, and daily history per broker. diff --git a/docs/en/docs/fundamental/fundamental/operating.md b/docs/en/docs/fundamental/fundamental/operating.md index fe18d489..472c11db 100644 --- a/docs/en/docs/fundamental/fundamental/operating.md +++ b/docs/en/docs/fundamental/fundamental/operating.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Not Available for US Accounts +This method is only available for AP data-center accounts (HK, Singapore). US data-center accounts will receive a region restriction error. +::: + Get operating metrics and financial indicator summaries by report period. diff --git a/docs/en/docs/fundamental/market/broker_holding_daily.md b/docs/en/docs/fundamental/market/broker_holding_daily.md index 162d497e..f4b7d251 100644 --- a/docs/en/docs/fundamental/market/broker_holding_daily.md +++ b/docs/en/docs/fundamental/market/broker_holding_daily.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Not Available for US Accounts +This method is only available for AP data-center accounts (HK, Singapore). US data-center accounts will receive a region restriction error. +::: + Get daily holding history for a specific broker in an HK-listed security. diff --git a/docs/en/docs/fundamental/market/broker_holding_detail.md b/docs/en/docs/fundamental/market/broker_holding_detail.md index a9142772..4ccab19e 100644 --- a/docs/en/docs/fundamental/market/broker_holding_detail.md +++ b/docs/en/docs/fundamental/market/broker_holding_detail.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Not Available for US Accounts +This method is only available for AP data-center accounts (HK, Singapore). US data-center accounts will receive a region restriction error. +::: + Get full broker holding detail list for an HK-listed security (all brokers and their positions). diff --git a/docs/en/docs/fundamental/market/broker_positions.md b/docs/en/docs/fundamental/market/broker_positions.md index d4ac0e27..543178e1 100644 --- a/docs/en/docs/fundamental/market/broker_positions.md +++ b/docs/en/docs/fundamental/market/broker_positions.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Not Available for US Accounts +This method is only available for AP data-center accounts (HK, Singapore). US data-center accounts will receive a region restriction error. +::: + View broker holding positions for HK-listed stocks, including top buyers/sellers and full detail. diff --git a/docs/en/docs/quote/stocks/brokers.md b/docs/en/docs/quote/stocks/brokers.md index 28df6a22..2066320a 100644 --- a/docs/en/docs/quote/stocks/brokers.md +++ b/docs/en/docs/quote/stocks/brokers.md @@ -5,6 +5,10 @@ slug: /quote/pull/brokers sidebar_position: 6 --- +:::warning Not Available for US Accounts +This method is only available for AP data-center accounts (HK, Singapore). US data-center accounts will receive a region restriction error. +::: + This API is used to obtain the real-time broker queue data of security. diff --git a/docs/zh-CN/docs/cli/account/dca.md b/docs/zh-CN/docs/cli/account/dca.md index 83974db2..977cfdf5 100644 --- a/docs/zh-CN/docs/cli/account/dca.md +++ b/docs/zh-CN/docs/cli/account/dca.md @@ -4,6 +4,10 @@ sidebar_label: 'dca' sidebar_position: 10 --- +:::warning 不支持美股账户 +此命令需要 AP 数据中心账户（香港或新加坡）。美股数据中心账户不支持此命令。 +::: + # longbridge dca 定投——按固定金额定期自动买入。支持按日、周、双周、月频率创建定投计划，管理计划状态，查看交易历史，并监控累计收益。 diff --git a/docs/zh-CN/docs/cli/market-data/broker-holding.md b/docs/zh-CN/docs/cli/market-data/broker-holding.md index dc2149d4..1f39db71 100644 --- a/docs/zh-CN/docs/cli/market-data/broker-holding.md +++ b/docs/zh-CN/docs/cli/market-data/broker-holding.md @@ -4,6 +4,10 @@ sidebar_label: 'broker-holding' sidebar_position: 15 --- +:::warning 不支持美股账户 +此命令需要 AP 数据中心账户（香港或新加坡）。美股数据中心账户不支持此命令。 +::: + # longbridge broker-holding 查看港股经纪商持仓——买卖方排行、完整持仓明细，以及指定经纪商的每日持仓变化。 diff --git a/docs/zh-CN/docs/fundamental/fundamental/operating.md b/docs/zh-CN/docs/fundamental/fundamental/operating.md index b7d2b446..7473b2bb 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/operating.md +++ b/docs/zh-CN/docs/fundamental/fundamental/operating.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning 不支持美股账户 +此方法仅适用于 AP 数据中心账户（香港、新加坡）。美股数据中心账户将收到区域限制错误。 +::: + 按财报期获取经营数据及核心财务指标摘要。 diff --git a/docs/zh-CN/docs/fundamental/market/broker_holding_daily.md b/docs/zh-CN/docs/fundamental/market/broker_holding_daily.md index 813b3574..cf1d8ac8 100644 --- a/docs/zh-CN/docs/fundamental/market/broker_holding_daily.md +++ b/docs/zh-CN/docs/fundamental/market/broker_holding_daily.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning 不支持美股账户 +此方法仅适用于 AP 数据中心账户（香港、新加坡）。美股数据中心账户将收到区域限制错误。 +::: + 获取某一经纪商在港股上市证券中的每日持仓历史记录。 diff --git a/docs/zh-CN/docs/fundamental/market/broker_holding_detail.md b/docs/zh-CN/docs/fundamental/market/broker_holding_detail.md index 3d2bad20..ca791987 100644 --- a/docs/zh-CN/docs/fundamental/market/broker_holding_detail.md +++ b/docs/zh-CN/docs/fundamental/market/broker_holding_detail.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning 不支持美股账户 +此方法仅适用于 AP 数据中心账户（香港、新加坡）。美股数据中心账户将收到区域限制错误。 +::: + 获取港股上市证券的完整经纪商持仓详情列表（所有经纪商及其持仓数量）。 diff --git a/docs/zh-CN/docs/fundamental/market/broker_positions.md b/docs/zh-CN/docs/fundamental/market/broker_positions.md index e7d1f31b..96ec38a0 100644 --- a/docs/zh-CN/docs/fundamental/market/broker_positions.md +++ b/docs/zh-CN/docs/fundamental/market/broker_positions.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning 不支持美股账户 +此方法仅适用于 AP 数据中心账户（香港、新加坡）。美股数据中心账户将收到区域限制错误。 +::: + 查看港股券商持仓情况，包含主要买卖方和详细持仓列表。 diff --git a/docs/zh-CN/docs/quote/stocks/brokers.md b/docs/zh-CN/docs/quote/stocks/brokers.md index 4467b36a..9375f7fe 100644 --- a/docs/zh-CN/docs/quote/stocks/brokers.md +++ b/docs/zh-CN/docs/quote/stocks/brokers.md @@ -5,6 +5,10 @@ slug: /quote/pull/brokers sidebar_position: 6 --- +:::warning 不支持美股账户 +此方法仅适用于 AP 数据中心账户（香港、新加坡）。美股数据中心账户将收到区域限制错误。 +::: + 该接口用于获取标的的实时经纪队列数据。 diff --git a/docs/zh-HK/docs/cli/account/dca.md b/docs/zh-HK/docs/cli/account/dca.md index a429dde1..e1939efd 100644 --- a/docs/zh-HK/docs/cli/account/dca.md +++ b/docs/zh-HK/docs/cli/account/dca.md @@ -4,6 +4,10 @@ sidebar_label: 'dca' sidebar_position: 10 --- +:::warning 不支援美股賬戶 +此命令需要 AP 數據中心賬戶（香港或新加坡）。美股數據中心賬戶不支援此命令。 +::: + # longbridge dca 定期定額——按固定金額定期自動買入。支援按日、週、雙週、月頻率建立定投計劃，管理計劃狀態，查看交易記錄，並監控累計收益。 diff --git a/docs/zh-HK/docs/cli/market-data/broker-holding.md b/docs/zh-HK/docs/cli/market-data/broker-holding.md index 17106c5b..3ea4c434 100644 --- a/docs/zh-HK/docs/cli/market-data/broker-holding.md +++ b/docs/zh-HK/docs/cli/market-data/broker-holding.md @@ -4,6 +4,10 @@ sidebar_label: 'broker-holding' sidebar_position: 15 --- +:::warning 不支援美股賬戶 +此命令需要 AP 數據中心賬戶（香港或新加坡）。美股數據中心賬戶不支援此命令。 +::: + # longbridge broker-holding 查看港股經紀商持倉——最大買入/賣出經紀商、完整持倉明細，以及指定經紀商的逐日變動。 diff --git a/docs/zh-HK/docs/fundamental/fundamental/operating.md b/docs/zh-HK/docs/fundamental/fundamental/operating.md index ea4b2879..f13cf7ad 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/operating.md +++ b/docs/zh-HK/docs/fundamental/fundamental/operating.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning 不支援美股賬戶 +此方法僅適用於 AP 數據中心賬戶（香港、新加坡）。美股數據中心賬戶將收到區域限制錯誤。 +::: + 按財報期獲取經營數據及核心財務指標摘要。 diff --git a/docs/zh-HK/docs/fundamental/market/broker_holding_daily.md b/docs/zh-HK/docs/fundamental/market/broker_holding_daily.md index 6f46db6b..3d516e87 100644 --- a/docs/zh-HK/docs/fundamental/market/broker_holding_daily.md +++ b/docs/zh-HK/docs/fundamental/market/broker_holding_daily.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning 不支援美股賬戶 +此方法僅適用於 AP 數據中心賬戶（香港、新加坡）。美股數據中心賬戶將收到區域限制錯誤。 +::: + 獲取某一經紀商在港股上市證券中的每日持倉歷史記錄。 diff --git a/docs/zh-HK/docs/fundamental/market/broker_holding_detail.md b/docs/zh-HK/docs/fundamental/market/broker_holding_detail.md index 197ed5ef..ee022cf0 100644 --- a/docs/zh-HK/docs/fundamental/market/broker_holding_detail.md +++ b/docs/zh-HK/docs/fundamental/market/broker_holding_detail.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning 不支援美股賬戶 +此方法僅適用於 AP 數據中心賬戶（香港、新加坡）。美股數據中心賬戶將收到區域限制錯誤。 +::: + 獲取港股上市證券的完整經紀商持倉詳情列表（所有經紀商及其持倉數量）。 diff --git a/docs/zh-HK/docs/fundamental/market/broker_positions.md b/docs/zh-HK/docs/fundamental/market/broker_positions.md index 31a4c3bc..5c22a4ee 100644 --- a/docs/zh-HK/docs/fundamental/market/broker_positions.md +++ b/docs/zh-HK/docs/fundamental/market/broker_positions.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning 不支援美股賬戶 +此方法僅適用於 AP 數據中心賬戶（香港、新加坡）。美股數據中心賬戶將收到區域限制錯誤。 +::: + 查看港股券商持倉情況，包含主要買賣方和詳細持倉列表。 diff --git a/docs/zh-HK/docs/quote/stocks/brokers.md b/docs/zh-HK/docs/quote/stocks/brokers.md index 980c8816..c2085974 100644 --- a/docs/zh-HK/docs/quote/stocks/brokers.md +++ b/docs/zh-HK/docs/quote/stocks/brokers.md @@ -5,6 +5,10 @@ slug: /quote/pull/brokers sidebar_position: 6 --- +:::warning 不支援美股賬戶 +此方法僅適用於 AP 數據中心賬戶（香港、新加坡）。美股數據中心賬戶將收到區域限制錯誤。 +::: + 該接口用於獲取標的的實時經紀隊列數據。 From 630d6d784940b9e770118e5b069fa7d716eab54a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 16:04:56 +0800 Subject: [PATCH 15/51] =?UTF-8?q?docs:=20clarify=20AP-only=20warning=20?= =?UTF-8?q?=E2=80=94=20account=20restriction,=20not=20symbol=20restriction?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/en/docs/cli/account/dca.md | 4 ++-- docs/en/docs/cli/market-data/broker-holding.md | 4 ++-- docs/en/docs/fundamental/fundamental/operating.md | 4 ++-- docs/en/docs/fundamental/market/broker_holding_daily.md | 4 ++-- docs/en/docs/fundamental/market/broker_holding_detail.md | 4 ++-- docs/en/docs/fundamental/market/broker_positions.md | 4 ++-- docs/en/docs/quote/stocks/brokers.md | 4 ++-- docs/zh-CN/docs/cli/account/dca.md | 4 ++-- docs/zh-CN/docs/cli/market-data/broker-holding.md | 4 ++-- docs/zh-CN/docs/fundamental/fundamental/operating.md | 4 ++-- docs/zh-CN/docs/fundamental/market/broker_holding_daily.md | 4 ++-- docs/zh-CN/docs/fundamental/market/broker_holding_detail.md | 4 ++-- docs/zh-CN/docs/fundamental/market/broker_positions.md | 4 ++-- docs/zh-CN/docs/quote/stocks/brokers.md | 4 ++-- docs/zh-HK/docs/cli/account/dca.md | 4 ++-- docs/zh-HK/docs/cli/market-data/broker-holding.md | 4 ++-- docs/zh-HK/docs/fundamental/fundamental/operating.md | 4 ++-- docs/zh-HK/docs/fundamental/market/broker_holding_daily.md | 4 ++-- docs/zh-HK/docs/fundamental/market/broker_holding_detail.md | 4 ++-- docs/zh-HK/docs/fundamental/market/broker_positions.md | 4 ++-- docs/zh-HK/docs/quote/stocks/brokers.md | 4 ++-- longbridge-terminal | 1 + openapi | 1 + openapi-go | 1 + 24 files changed, 45 insertions(+), 42 deletions(-) create mode 160000 longbridge-terminal create mode 160000 openapi create mode 160000 openapi-go diff --git a/docs/en/docs/cli/account/dca.md b/docs/en/docs/cli/account/dca.md index 34203503..a0499e79 100644 --- a/docs/en/docs/cli/account/dca.md +++ b/docs/en/docs/cli/account/dca.md @@ -4,8 +4,8 @@ sidebar_label: 'dca' sidebar_position: 10 --- -:::warning Not Available for US Accounts -This command requires an AP data-center account (HK or Singapore). US data-center accounts are not supported. +:::warning Not Available for US Data-Center Accounts +This command requires an AP data-center account (HK / Singapore). US data-center accounts are not supported. AP accounts can use this command with any supported symbol, including US stocks. ::: # longbridge dca diff --git a/docs/en/docs/cli/market-data/broker-holding.md b/docs/en/docs/cli/market-data/broker-holding.md index d6e3cb08..b1a44601 100644 --- a/docs/en/docs/cli/market-data/broker-holding.md +++ b/docs/en/docs/cli/market-data/broker-holding.md @@ -4,8 +4,8 @@ sidebar_label: 'broker-holding' sidebar_position: 15 --- -:::warning Not Available for US Accounts -This command requires an AP data-center account (HK or Singapore). US data-center accounts are not supported. +:::warning Not Available for US Data-Center Accounts +This command requires an AP data-center account (HK / Singapore). US data-center accounts are not supported. AP accounts can use this command with any supported symbol, including US stocks. ::: # longbridge broker-holding diff --git a/docs/en/docs/fundamental/fundamental/operating.md b/docs/en/docs/fundamental/fundamental/operating.md index 472c11db..2df854a8 100644 --- a/docs/en/docs/fundamental/fundamental/operating.md +++ b/docs/en/docs/fundamental/fundamental/operating.md @@ -10,8 +10,8 @@ highlight_theme: '' headingLevel: 2 --- -:::warning Not Available for US Accounts -This method is only available for AP data-center accounts (HK, Singapore). US data-center accounts will receive a region restriction error. +:::warning Not Available for US Data-Center Accounts +This method requires an AP data-center account (HK / Singapore). US data-center accounts will receive a region restriction error. AP accounts can call this method with any supported symbol, including US stocks. ::: Get operating metrics and financial indicator summaries by report period. diff --git a/docs/en/docs/fundamental/market/broker_holding_daily.md b/docs/en/docs/fundamental/market/broker_holding_daily.md index f4b7d251..32d06b38 100644 --- a/docs/en/docs/fundamental/market/broker_holding_daily.md +++ b/docs/en/docs/fundamental/market/broker_holding_daily.md @@ -10,8 +10,8 @@ highlight_theme: '' headingLevel: 2 --- -:::warning Not Available for US Accounts -This method is only available for AP data-center accounts (HK, Singapore). US data-center accounts will receive a region restriction error. +:::warning Not Available for US Data-Center Accounts +This method requires an AP data-center account (HK / Singapore). US data-center accounts will receive a region restriction error. AP accounts can call this method with any supported symbol, including US stocks. ::: Get daily holding history for a specific broker in an HK-listed security. diff --git a/docs/en/docs/fundamental/market/broker_holding_detail.md b/docs/en/docs/fundamental/market/broker_holding_detail.md index 4ccab19e..4ee584d8 100644 --- a/docs/en/docs/fundamental/market/broker_holding_detail.md +++ b/docs/en/docs/fundamental/market/broker_holding_detail.md @@ -10,8 +10,8 @@ highlight_theme: '' headingLevel: 2 --- -:::warning Not Available for US Accounts -This method is only available for AP data-center accounts (HK, Singapore). US data-center accounts will receive a region restriction error. +:::warning Not Available for US Data-Center Accounts +This method requires an AP data-center account (HK / Singapore). US data-center accounts will receive a region restriction error. AP accounts can call this method with any supported symbol, including US stocks. ::: Get full broker holding detail list for an HK-listed security (all brokers and their positions). diff --git a/docs/en/docs/fundamental/market/broker_positions.md b/docs/en/docs/fundamental/market/broker_positions.md index 543178e1..3de7ff08 100644 --- a/docs/en/docs/fundamental/market/broker_positions.md +++ b/docs/en/docs/fundamental/market/broker_positions.md @@ -10,8 +10,8 @@ highlight_theme: '' headingLevel: 2 --- -:::warning Not Available for US Accounts -This method is only available for AP data-center accounts (HK, Singapore). US data-center accounts will receive a region restriction error. +:::warning Not Available for US Data-Center Accounts +This method requires an AP data-center account (HK / Singapore). US data-center accounts will receive a region restriction error. AP accounts can call this method with any supported symbol, including US stocks. ::: View broker holding positions for HK-listed stocks, including top buyers/sellers and full detail. diff --git a/docs/en/docs/quote/stocks/brokers.md b/docs/en/docs/quote/stocks/brokers.md index 2066320a..dd5ee956 100644 --- a/docs/en/docs/quote/stocks/brokers.md +++ b/docs/en/docs/quote/stocks/brokers.md @@ -5,8 +5,8 @@ slug: /quote/pull/brokers sidebar_position: 6 --- -:::warning Not Available for US Accounts -This method is only available for AP data-center accounts (HK, Singapore). US data-center accounts will receive a region restriction error. +:::warning Not Available for US Data-Center Accounts +This method requires an AP data-center account (HK / Singapore). US data-center accounts will receive a region restriction error. AP accounts can call this method with any supported symbol, including US stocks. ::: This API is used to obtain the real-time broker queue data of security. diff --git a/docs/zh-CN/docs/cli/account/dca.md b/docs/zh-CN/docs/cli/account/dca.md index 977cfdf5..795882a1 100644 --- a/docs/zh-CN/docs/cli/account/dca.md +++ b/docs/zh-CN/docs/cli/account/dca.md @@ -4,8 +4,8 @@ sidebar_label: 'dca' sidebar_position: 10 --- -:::warning 不支持美股账户 -此命令需要 AP 数据中心账户（香港或新加坡）。美股数据中心账户不支持此命令。 +:::warning 美股数据中心账户不支持 +此命令需要 AP 数据中心账户（香港/新加坡）。美股数据中心账户不支持此命令。AP 账户可操作任意标的，包括美股。 ::: # longbridge dca diff --git a/docs/zh-CN/docs/cli/market-data/broker-holding.md b/docs/zh-CN/docs/cli/market-data/broker-holding.md index 1f39db71..d5cf5003 100644 --- a/docs/zh-CN/docs/cli/market-data/broker-holding.md +++ b/docs/zh-CN/docs/cli/market-data/broker-holding.md @@ -4,8 +4,8 @@ sidebar_label: 'broker-holding' sidebar_position: 15 --- -:::warning 不支持美股账户 -此命令需要 AP 数据中心账户（香港或新加坡）。美股数据中心账户不支持此命令。 +:::warning 美股数据中心账户不支持 +此命令需要 AP 数据中心账户（香港/新加坡）。美股数据中心账户不支持此命令。AP 账户可操作任意标的，包括美股。 ::: # longbridge broker-holding diff --git a/docs/zh-CN/docs/fundamental/fundamental/operating.md b/docs/zh-CN/docs/fundamental/fundamental/operating.md index 7473b2bb..e10be45d 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/operating.md +++ b/docs/zh-CN/docs/fundamental/fundamental/operating.md @@ -10,8 +10,8 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 不支持美股账户 -此方法仅适用于 AP 数据中心账户（香港、新加坡）。美股数据中心账户将收到区域限制错误。 +:::warning 美股数据中心账户不支持 +此方法需要 AP 数据中心账户（香港/新加坡）。美股数据中心账户将收到区域限制错误。AP 账户可查询任意标的，包括美股。 ::: 按财报期获取经营数据及核心财务指标摘要。 diff --git a/docs/zh-CN/docs/fundamental/market/broker_holding_daily.md b/docs/zh-CN/docs/fundamental/market/broker_holding_daily.md index cf1d8ac8..39383724 100644 --- a/docs/zh-CN/docs/fundamental/market/broker_holding_daily.md +++ b/docs/zh-CN/docs/fundamental/market/broker_holding_daily.md @@ -10,8 +10,8 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 不支持美股账户 -此方法仅适用于 AP 数据中心账户（香港、新加坡）。美股数据中心账户将收到区域限制错误。 +:::warning 美股数据中心账户不支持 +此方法需要 AP 数据中心账户（香港/新加坡）。美股数据中心账户将收到区域限制错误。AP 账户可查询任意标的，包括美股。 ::: 获取某一经纪商在港股上市证券中的每日持仓历史记录。 diff --git a/docs/zh-CN/docs/fundamental/market/broker_holding_detail.md b/docs/zh-CN/docs/fundamental/market/broker_holding_detail.md index ca791987..3e4ac71b 100644 --- a/docs/zh-CN/docs/fundamental/market/broker_holding_detail.md +++ b/docs/zh-CN/docs/fundamental/market/broker_holding_detail.md @@ -10,8 +10,8 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 不支持美股账户 -此方法仅适用于 AP 数据中心账户（香港、新加坡）。美股数据中心账户将收到区域限制错误。 +:::warning 美股数据中心账户不支持 +此方法需要 AP 数据中心账户（香港/新加坡）。美股数据中心账户将收到区域限制错误。AP 账户可查询任意标的，包括美股。 ::: 获取港股上市证券的完整经纪商持仓详情列表（所有经纪商及其持仓数量）。 diff --git a/docs/zh-CN/docs/fundamental/market/broker_positions.md b/docs/zh-CN/docs/fundamental/market/broker_positions.md index 96ec38a0..9575d90e 100644 --- a/docs/zh-CN/docs/fundamental/market/broker_positions.md +++ b/docs/zh-CN/docs/fundamental/market/broker_positions.md @@ -10,8 +10,8 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 不支持美股账户 -此方法仅适用于 AP 数据中心账户（香港、新加坡）。美股数据中心账户将收到区域限制错误。 +:::warning 美股数据中心账户不支持 +此方法需要 AP 数据中心账户（香港/新加坡）。美股数据中心账户将收到区域限制错误。AP 账户可查询任意标的，包括美股。 ::: 查看港股券商持仓情况，包含主要买卖方和详细持仓列表。 diff --git a/docs/zh-CN/docs/quote/stocks/brokers.md b/docs/zh-CN/docs/quote/stocks/brokers.md index 9375f7fe..53a45dec 100644 --- a/docs/zh-CN/docs/quote/stocks/brokers.md +++ b/docs/zh-CN/docs/quote/stocks/brokers.md @@ -5,8 +5,8 @@ slug: /quote/pull/brokers sidebar_position: 6 --- -:::warning 不支持美股账户 -此方法仅适用于 AP 数据中心账户（香港、新加坡）。美股数据中心账户将收到区域限制错误。 +:::warning 美股数据中心账户不支持 +此方法需要 AP 数据中心账户（香港/新加坡）。美股数据中心账户将收到区域限制错误。AP 账户可查询任意标的，包括美股。 ::: 该接口用于获取标的的实时经纪队列数据。 diff --git a/docs/zh-HK/docs/cli/account/dca.md b/docs/zh-HK/docs/cli/account/dca.md index e1939efd..d3af1fc3 100644 --- a/docs/zh-HK/docs/cli/account/dca.md +++ b/docs/zh-HK/docs/cli/account/dca.md @@ -4,8 +4,8 @@ sidebar_label: 'dca' sidebar_position: 10 --- -:::warning 不支援美股賬戶 -此命令需要 AP 數據中心賬戶（香港或新加坡）。美股數據中心賬戶不支援此命令。 +:::warning 美股數據中心賬戶不支援 +此命令需要 AP 數據中心賬戶（香港/新加坡）。美股數據中心賬戶不支援此命令。AP 賬戶可操作任意標的，包括美股。 ::: # longbridge dca diff --git a/docs/zh-HK/docs/cli/market-data/broker-holding.md b/docs/zh-HK/docs/cli/market-data/broker-holding.md index 3ea4c434..3a7bbb42 100644 --- a/docs/zh-HK/docs/cli/market-data/broker-holding.md +++ b/docs/zh-HK/docs/cli/market-data/broker-holding.md @@ -4,8 +4,8 @@ sidebar_label: 'broker-holding' sidebar_position: 15 --- -:::warning 不支援美股賬戶 -此命令需要 AP 數據中心賬戶（香港或新加坡）。美股數據中心賬戶不支援此命令。 +:::warning 美股數據中心賬戶不支援 +此命令需要 AP 數據中心賬戶（香港/新加坡）。美股數據中心賬戶不支援此命令。AP 賬戶可操作任意標的，包括美股。 ::: # longbridge broker-holding diff --git a/docs/zh-HK/docs/fundamental/fundamental/operating.md b/docs/zh-HK/docs/fundamental/fundamental/operating.md index f13cf7ad..bb29b73e 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/operating.md +++ b/docs/zh-HK/docs/fundamental/fundamental/operating.md @@ -10,8 +10,8 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 不支援美股賬戶 -此方法僅適用於 AP 數據中心賬戶（香港、新加坡）。美股數據中心賬戶將收到區域限制錯誤。 +:::warning 美股數據中心賬戶不支援 +此方法需要 AP 數據中心賬戶（香港/新加坡）。美股數據中心賬戶將收到區域限制錯誤。AP 賬戶可查詢任意標的，包括美股。 ::: 按財報期獲取經營數據及核心財務指標摘要。 diff --git a/docs/zh-HK/docs/fundamental/market/broker_holding_daily.md b/docs/zh-HK/docs/fundamental/market/broker_holding_daily.md index 3d516e87..6eaf2217 100644 --- a/docs/zh-HK/docs/fundamental/market/broker_holding_daily.md +++ b/docs/zh-HK/docs/fundamental/market/broker_holding_daily.md @@ -10,8 +10,8 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 不支援美股賬戶 -此方法僅適用於 AP 數據中心賬戶（香港、新加坡）。美股數據中心賬戶將收到區域限制錯誤。 +:::warning 美股數據中心賬戶不支援 +此方法需要 AP 數據中心賬戶（香港/新加坡）。美股數據中心賬戶將收到區域限制錯誤。AP 賬戶可查詢任意標的，包括美股。 ::: 獲取某一經紀商在港股上市證券中的每日持倉歷史記錄。 diff --git a/docs/zh-HK/docs/fundamental/market/broker_holding_detail.md b/docs/zh-HK/docs/fundamental/market/broker_holding_detail.md index ee022cf0..3cef81a5 100644 --- a/docs/zh-HK/docs/fundamental/market/broker_holding_detail.md +++ b/docs/zh-HK/docs/fundamental/market/broker_holding_detail.md @@ -10,8 +10,8 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 不支援美股賬戶 -此方法僅適用於 AP 數據中心賬戶（香港、新加坡）。美股數據中心賬戶將收到區域限制錯誤。 +:::warning 美股數據中心賬戶不支援 +此方法需要 AP 數據中心賬戶（香港/新加坡）。美股數據中心賬戶將收到區域限制錯誤。AP 賬戶可查詢任意標的，包括美股。 ::: 獲取港股上市證券的完整經紀商持倉詳情列表（所有經紀商及其持倉數量）。 diff --git a/docs/zh-HK/docs/fundamental/market/broker_positions.md b/docs/zh-HK/docs/fundamental/market/broker_positions.md index 5c22a4ee..d699a9a5 100644 --- a/docs/zh-HK/docs/fundamental/market/broker_positions.md +++ b/docs/zh-HK/docs/fundamental/market/broker_positions.md @@ -10,8 +10,8 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 不支援美股賬戶 -此方法僅適用於 AP 數據中心賬戶（香港、新加坡）。美股數據中心賬戶將收到區域限制錯誤。 +:::warning 美股數據中心賬戶不支援 +此方法需要 AP 數據中心賬戶（香港/新加坡）。美股數據中心賬戶將收到區域限制錯誤。AP 賬戶可查詢任意標的，包括美股。 ::: 查看港股券商持倉情況，包含主要買賣方和詳細持倉列表。 diff --git a/docs/zh-HK/docs/quote/stocks/brokers.md b/docs/zh-HK/docs/quote/stocks/brokers.md index c2085974..ec0ad4d3 100644 --- a/docs/zh-HK/docs/quote/stocks/brokers.md +++ b/docs/zh-HK/docs/quote/stocks/brokers.md @@ -5,8 +5,8 @@ slug: /quote/pull/brokers sidebar_position: 6 --- -:::warning 不支援美股賬戶 -此方法僅適用於 AP 數據中心賬戶（香港、新加坡）。美股數據中心賬戶將收到區域限制錯誤。 +:::warning 美股數據中心賬戶不支援 +此方法需要 AP 數據中心賬戶（香港/新加坡）。美股數據中心賬戶將收到區域限制錯誤。AP 賬戶可查詢任意標的，包括美股。 ::: 該接口用於獲取標的的實時經紀隊列數據。 diff --git a/longbridge-terminal b/longbridge-terminal new file mode 160000 index 00000000..b9022136 --- /dev/null +++ b/longbridge-terminal @@ -0,0 +1 @@ +Subproject commit b90221361dad486c61478368cd54bb96d74fcada diff --git a/openapi b/openapi new file mode 160000 index 00000000..daf23233 --- /dev/null +++ b/openapi @@ -0,0 +1 @@ +Subproject commit daf23233dc5c9559c138d6ff089fce3ad15f3b46 diff --git a/openapi-go b/openapi-go new file mode 160000 index 00000000..f9763dcf --- /dev/null +++ b/openapi-go @@ -0,0 +1 @@ +Subproject commit f9763dcfc76f13ea69787fe6618cfdda6e6f36a5 From 3b4b91cad2340d102ae63747f46706d9b7db76e7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 16:05:10 +0800 Subject: [PATCH 16/51] chore: remove stray embedded repo directories --- longbridge-terminal | 1 - openapi | 1 - openapi-go | 1 - 3 files changed, 3 deletions(-) delete mode 160000 longbridge-terminal delete mode 160000 openapi delete mode 160000 openapi-go diff --git a/longbridge-terminal b/longbridge-terminal deleted file mode 160000 index b9022136..00000000 --- a/longbridge-terminal +++ /dev/null @@ -1 +0,0 @@ -Subproject commit b90221361dad486c61478368cd54bb96d74fcada diff --git a/openapi b/openapi deleted file mode 160000 index daf23233..00000000 --- a/openapi +++ /dev/null @@ -1 +0,0 @@ -Subproject commit daf23233dc5c9559c138d6ff089fce3ad15f3b46 diff --git a/openapi-go b/openapi-go deleted file mode 160000 index f9763dcf..00000000 --- a/openapi-go +++ /dev/null @@ -1 +0,0 @@ -Subproject commit f9763dcfc76f13ea69787fe6618cfdda6e6f36a5 From 85983a82303b5e724d7c6e9bcd77eadefdf6d473 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 16:38:27 +0800 Subject: [PATCH 17/51] =?UTF-8?q?docs:=20rename=20'US=20Only'=20warning=20?= =?UTF-8?q?=E2=86=92=20'US=20Data-Center=20Accounts=20Only'=20for=20clarit?= =?UTF-8?q?y?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/en/docs/cli/account/profit-analysis.md | 2 +- docs/en/docs/cli/fundamentals/etf-docs.md | 2 +- docs/en/docs/cli/fundamentals/financial-report.md | 2 +- docs/en/docs/fundamental/fundamental/us_analyst_consensus.md | 2 +- docs/en/docs/fundamental/fundamental/us_company_dividends.md | 2 +- docs/en/docs/fundamental/fundamental/us_company_overview.md | 2 +- docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md | 2 +- docs/en/docs/fundamental/fundamental/us_etf_files.md | 2 +- docs/en/docs/fundamental/fundamental/us_financial_overview.md | 2 +- .../docs/fundamental/fundamental/us_financial_statement_v3.md | 2 +- .../en/docs/fundamental/fundamental/us_key_financial_metrics.md | 2 +- docs/en/docs/fundamental/fundamental/us_valuation_overview.md | 2 +- docs/en/docs/quote/stocks/us_crypto_overview.md | 2 +- docs/en/docs/trade/asset/us_asset_overview.md | 2 +- docs/en/docs/trade/asset/us_realized_pl.md | 2 +- docs/en/docs/trade/order/us_order_detail.md | 2 +- docs/en/docs/trade/order/us_query_orders.md | 2 +- longbridge-terminal | 1 + openapi | 1 + openapi-go | 1 + 20 files changed, 20 insertions(+), 17 deletions(-) create mode 160000 longbridge-terminal create mode 160000 openapi create mode 160000 openapi-go diff --git a/docs/en/docs/cli/account/profit-analysis.md b/docs/en/docs/cli/account/profit-analysis.md index 04d43338..cafbda18 100644 --- a/docs/en/docs/cli/account/profit-analysis.md +++ b/docs/en/docs/cli/account/profit-analysis.md @@ -96,7 +96,7 @@ longbridge profit-analysis realized --category option --currency USD Returns realized profit and loss breakdown by asset category for US accounts. -:::warning US Only +:::warning US Data-Center Accounts Only `profit-analysis realized` is only available for US data-center accounts. ::: diff --git a/docs/en/docs/cli/fundamentals/etf-docs.md b/docs/en/docs/cli/fundamentals/etf-docs.md index 56908051..7313531c 100644 --- a/docs/en/docs/cli/fundamentals/etf-docs.md +++ b/docs/en/docs/cli/fundamentals/etf-docs.md @@ -8,7 +8,7 @@ sidebar_position: 21 List regulatory documents for a US ETF — prospectus, fact sheets, and other filings. -:::warning US Only +:::warning US Data-Center Accounts Only This command is only available for US data-center accounts. ::: diff --git a/docs/en/docs/cli/fundamentals/financial-report.md b/docs/en/docs/cli/fundamentals/financial-report.md index a5595b2b..7d53812c 100644 --- a/docs/en/docs/cli/fundamentals/financial-report.md +++ b/docs/en/docs/cli/fundamentals/financial-report.md @@ -106,7 +106,7 @@ longbridge financial-report key-metrics AAPL.US --report quarterly Returns key financial indicators for US stocks: revenue, net income, EPS, margins, and growth rates. -:::warning US Only +:::warning US Data-Center Accounts Only `financial-report key-metrics` is only available for US data-center accounts. ::: diff --git a/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md index c749137e..dfce4890 100644 --- a/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning US Only +:::warning US Data-Center Accounts Only This method is only available for US data-center accounts. ::: diff --git a/docs/en/docs/fundamental/fundamental/us_company_dividends.md b/docs/en/docs/fundamental/fundamental/us_company_dividends.md index b31e3512..c3998134 100644 --- a/docs/en/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/en/docs/fundamental/fundamental/us_company_dividends.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning US Only +:::warning US Data-Center Accounts Only This method is only available for US data-center accounts. ::: diff --git a/docs/en/docs/fundamental/fundamental/us_company_overview.md b/docs/en/docs/fundamental/fundamental/us_company_overview.md index 31893f4e..0210691f 100644 --- a/docs/en/docs/fundamental/fundamental/us_company_overview.md +++ b/docs/en/docs/fundamental/fundamental/us_company_overview.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning US Only +:::warning US Data-Center Accounts Only This method is only available for US data-center accounts. ::: diff --git a/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md index 79bd14c7..e2d53781 100644 --- a/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning US Only +:::warning US Data-Center Accounts Only This method is only available for US data-center accounts. ::: diff --git a/docs/en/docs/fundamental/fundamental/us_etf_files.md b/docs/en/docs/fundamental/fundamental/us_etf_files.md index c3284067..b8a933de 100644 --- a/docs/en/docs/fundamental/fundamental/us_etf_files.md +++ b/docs/en/docs/fundamental/fundamental/us_etf_files.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning US Only +:::warning US Data-Center Accounts Only This method is only available for US data-center accounts. ::: diff --git a/docs/en/docs/fundamental/fundamental/us_financial_overview.md b/docs/en/docs/fundamental/fundamental/us_financial_overview.md index 0175fd3c..48a753ea 100644 --- a/docs/en/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/en/docs/fundamental/fundamental/us_financial_overview.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning US Only +:::warning US Data-Center Accounts Only This method is only available for US data-center accounts. ::: diff --git a/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md index f9a8c429..4dbb0bbd 100644 --- a/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning US Only +:::warning US Data-Center Accounts Only This method is only available for US data-center accounts. ::: diff --git a/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md index 4225f4e9..c83eeb9c 100644 --- a/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning US Only +:::warning US Data-Center Accounts Only This method is only available for US data-center accounts. ::: diff --git a/docs/en/docs/fundamental/fundamental/us_valuation_overview.md b/docs/en/docs/fundamental/fundamental/us_valuation_overview.md index 697f8b7d..80a87786 100644 --- a/docs/en/docs/fundamental/fundamental/us_valuation_overview.md +++ b/docs/en/docs/fundamental/fundamental/us_valuation_overview.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning US Only +:::warning US Data-Center Accounts Only This method is only available for US data-center accounts. ::: diff --git a/docs/en/docs/quote/stocks/us_crypto_overview.md b/docs/en/docs/quote/stocks/us_crypto_overview.md index 73947af8..96c29d44 100644 --- a/docs/en/docs/quote/stocks/us_crypto_overview.md +++ b/docs/en/docs/quote/stocks/us_crypto_overview.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning US Only +:::warning US Data-Center Accounts Only This method is only available for US data-center accounts. ::: diff --git a/docs/en/docs/trade/asset/us_asset_overview.md b/docs/en/docs/trade/asset/us_asset_overview.md index bdbfb4db..edcab1d9 100644 --- a/docs/en/docs/trade/asset/us_asset_overview.md +++ b/docs/en/docs/trade/asset/us_asset_overview.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning US Only +:::warning US Data-Center Accounts Only This method is only available for US data-center accounts. ::: diff --git a/docs/en/docs/trade/asset/us_realized_pl.md b/docs/en/docs/trade/asset/us_realized_pl.md index 56e61515..8214bbe8 100644 --- a/docs/en/docs/trade/asset/us_realized_pl.md +++ b/docs/en/docs/trade/asset/us_realized_pl.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning US Only +:::warning US Data-Center Accounts Only This method is only available for US data-center accounts. ::: diff --git a/docs/en/docs/trade/order/us_order_detail.md b/docs/en/docs/trade/order/us_order_detail.md index c828b214..bf755842 100644 --- a/docs/en/docs/trade/order/us_order_detail.md +++ b/docs/en/docs/trade/order/us_order_detail.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning US Only +:::warning US Data-Center Accounts Only This method is only available for US data-center accounts. ::: diff --git a/docs/en/docs/trade/order/us_query_orders.md b/docs/en/docs/trade/order/us_query_orders.md index e4088cfe..37dfc8fa 100644 --- a/docs/en/docs/trade/order/us_query_orders.md +++ b/docs/en/docs/trade/order/us_query_orders.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning US Only +:::warning US Data-Center Accounts Only This method is only available for US data-center accounts. ::: diff --git a/longbridge-terminal b/longbridge-terminal new file mode 160000 index 00000000..b9022136 --- /dev/null +++ b/longbridge-terminal @@ -0,0 +1 @@ +Subproject commit b90221361dad486c61478368cd54bb96d74fcada diff --git a/openapi b/openapi new file mode 160000 index 00000000..daf23233 --- /dev/null +++ b/openapi @@ -0,0 +1 @@ +Subproject commit daf23233dc5c9559c138d6ff089fce3ad15f3b46 diff --git a/openapi-go b/openapi-go new file mode 160000 index 00000000..f9763dcf --- /dev/null +++ b/openapi-go @@ -0,0 +1 @@ +Subproject commit f9763dcfc76f13ea69787fe6618cfdda6e6f36a5 From c60a8b36b2c92777e50489bcaf41aadca7f60514 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 16:38:42 +0800 Subject: [PATCH 18/51] chore: remove stray embedded repo directories --- longbridge-terminal | 1 - openapi | 1 - openapi-go | 1 - 3 files changed, 3 deletions(-) delete mode 160000 longbridge-terminal delete mode 160000 openapi delete mode 160000 openapi-go diff --git a/longbridge-terminal b/longbridge-terminal deleted file mode 160000 index b9022136..00000000 --- a/longbridge-terminal +++ /dev/null @@ -1 +0,0 @@ -Subproject commit b90221361dad486c61478368cd54bb96d74fcada diff --git a/openapi b/openapi deleted file mode 160000 index daf23233..00000000 --- a/openapi +++ /dev/null @@ -1 +0,0 @@ -Subproject commit daf23233dc5c9559c138d6ff089fce3ad15f3b46 diff --git a/openapi-go b/openapi-go deleted file mode 160000 index f9763dcf..00000000 --- a/openapi-go +++ /dev/null @@ -1 +0,0 @@ -Subproject commit f9763dcfc76f13ea69787fe6618cfdda6e6f36a5 From 71baed92b89c51db813975e1364eaa518f352cbd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 16:41:52 +0800 Subject: [PATCH 19/51] =?UTF-8?q?docs:=20use=20'Longbridge=20US=20Accounts?= =?UTF-8?q?=20/=20Longbridge=20US=20=E8=B4=A6=E6=88=B7'=20as=20warning=20t?= =?UTF-8?q?itle?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/en/docs/cli/account/profit-analysis.md | 2 +- docs/en/docs/cli/fundamentals/etf-docs.md | 2 +- docs/en/docs/cli/fundamentals/financial-report.md | 2 +- docs/en/docs/fundamental/fundamental/us_analyst_consensus.md | 2 +- docs/en/docs/fundamental/fundamental/us_company_dividends.md | 2 +- docs/en/docs/fundamental/fundamental/us_company_overview.md | 2 +- docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md | 2 +- docs/en/docs/fundamental/fundamental/us_etf_files.md | 2 +- docs/en/docs/fundamental/fundamental/us_financial_overview.md | 2 +- .../docs/fundamental/fundamental/us_financial_statement_v3.md | 2 +- .../en/docs/fundamental/fundamental/us_key_financial_metrics.md | 2 +- docs/en/docs/fundamental/fundamental/us_valuation_overview.md | 2 +- docs/en/docs/quote/stocks/us_crypto_overview.md | 2 +- docs/en/docs/trade/asset/us_asset_overview.md | 2 +- docs/en/docs/trade/asset/us_realized_pl.md | 2 +- docs/en/docs/trade/order/us_order_detail.md | 2 +- docs/en/docs/trade/order/us_query_orders.md | 2 +- docs/zh-CN/docs/cli/account/dca.md | 2 +- docs/zh-CN/docs/cli/account/profit-analysis.md | 2 +- docs/zh-CN/docs/cli/fundamentals/etf-docs.md | 2 +- docs/zh-CN/docs/cli/fundamentals/financial-report.md | 2 +- docs/zh-CN/docs/cli/market-data/broker-holding.md | 2 +- docs/zh-CN/docs/fundamental/fundamental/operating.md | 2 +- docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md | 2 +- docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md | 2 +- docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md | 2 +- docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md | 2 +- docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md | 2 +- .../zh-CN/docs/fundamental/fundamental/us_financial_overview.md | 2 +- .../docs/fundamental/fundamental/us_financial_statement_v3.md | 2 +- .../docs/fundamental/fundamental/us_key_financial_metrics.md | 2 +- .../zh-CN/docs/fundamental/fundamental/us_valuation_overview.md | 2 +- docs/zh-CN/docs/fundamental/market/broker_holding_daily.md | 2 +- docs/zh-CN/docs/fundamental/market/broker_holding_detail.md | 2 +- docs/zh-CN/docs/fundamental/market/broker_positions.md | 2 +- docs/zh-CN/docs/quote/stocks/brokers.md | 2 +- docs/zh-CN/docs/quote/stocks/us_crypto_overview.md | 2 +- docs/zh-CN/docs/trade/asset/us_asset_overview.md | 2 +- docs/zh-CN/docs/trade/asset/us_realized_pl.md | 2 +- docs/zh-CN/docs/trade/order/us_order_detail.md | 2 +- docs/zh-CN/docs/trade/order/us_query_orders.md | 2 +- docs/zh-HK/docs/cli/account/dca.md | 2 +- docs/zh-HK/docs/cli/market-data/broker-holding.md | 2 +- docs/zh-HK/docs/fundamental/fundamental/operating.md | 2 +- docs/zh-HK/docs/fundamental/market/broker_holding_daily.md | 2 +- docs/zh-HK/docs/fundamental/market/broker_holding_detail.md | 2 +- docs/zh-HK/docs/fundamental/market/broker_positions.md | 2 +- docs/zh-HK/docs/quote/stocks/brokers.md | 2 +- longbridge-terminal | 1 + openapi | 1 + openapi-go | 1 + 51 files changed, 51 insertions(+), 48 deletions(-) create mode 160000 longbridge-terminal create mode 160000 openapi create mode 160000 openapi-go diff --git a/docs/en/docs/cli/account/profit-analysis.md b/docs/en/docs/cli/account/profit-analysis.md index cafbda18..2248e1eb 100644 --- a/docs/en/docs/cli/account/profit-analysis.md +++ b/docs/en/docs/cli/account/profit-analysis.md @@ -96,7 +96,7 @@ longbridge profit-analysis realized --category option --currency USD Returns realized profit and loss breakdown by asset category for US accounts. -:::warning US Data-Center Accounts Only +:::warning Longbridge US Accounts `profit-analysis realized` is only available for US data-center accounts. ::: diff --git a/docs/en/docs/cli/fundamentals/etf-docs.md b/docs/en/docs/cli/fundamentals/etf-docs.md index 7313531c..cfea88cf 100644 --- a/docs/en/docs/cli/fundamentals/etf-docs.md +++ b/docs/en/docs/cli/fundamentals/etf-docs.md @@ -8,7 +8,7 @@ sidebar_position: 21 List regulatory documents for a US ETF — prospectus, fact sheets, and other filings. -:::warning US Data-Center Accounts Only +:::warning Longbridge US Accounts This command is only available for US data-center accounts. ::: diff --git a/docs/en/docs/cli/fundamentals/financial-report.md b/docs/en/docs/cli/fundamentals/financial-report.md index 7d53812c..90ff5df8 100644 --- a/docs/en/docs/cli/fundamentals/financial-report.md +++ b/docs/en/docs/cli/fundamentals/financial-report.md @@ -106,7 +106,7 @@ longbridge financial-report key-metrics AAPL.US --report quarterly Returns key financial indicators for US stocks: revenue, net income, EPS, margins, and growth rates. -:::warning US Data-Center Accounts Only +:::warning Longbridge US Accounts `financial-report key-metrics` is only available for US data-center accounts. ::: diff --git a/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md index dfce4890..1c465d7a 100644 --- a/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning US Data-Center Accounts Only +:::warning Longbridge US Accounts This method is only available for US data-center accounts. ::: diff --git a/docs/en/docs/fundamental/fundamental/us_company_dividends.md b/docs/en/docs/fundamental/fundamental/us_company_dividends.md index c3998134..8f31055d 100644 --- a/docs/en/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/en/docs/fundamental/fundamental/us_company_dividends.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning US Data-Center Accounts Only +:::warning Longbridge US Accounts This method is only available for US data-center accounts. ::: diff --git a/docs/en/docs/fundamental/fundamental/us_company_overview.md b/docs/en/docs/fundamental/fundamental/us_company_overview.md index 0210691f..4d4dd208 100644 --- a/docs/en/docs/fundamental/fundamental/us_company_overview.md +++ b/docs/en/docs/fundamental/fundamental/us_company_overview.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning US Data-Center Accounts Only +:::warning Longbridge US Accounts This method is only available for US data-center accounts. ::: diff --git a/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md index e2d53781..0a4a0104 100644 --- a/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning US Data-Center Accounts Only +:::warning Longbridge US Accounts This method is only available for US data-center accounts. ::: diff --git a/docs/en/docs/fundamental/fundamental/us_etf_files.md b/docs/en/docs/fundamental/fundamental/us_etf_files.md index b8a933de..0663d66d 100644 --- a/docs/en/docs/fundamental/fundamental/us_etf_files.md +++ b/docs/en/docs/fundamental/fundamental/us_etf_files.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning US Data-Center Accounts Only +:::warning Longbridge US Accounts This method is only available for US data-center accounts. ::: diff --git a/docs/en/docs/fundamental/fundamental/us_financial_overview.md b/docs/en/docs/fundamental/fundamental/us_financial_overview.md index 48a753ea..f7734ce3 100644 --- a/docs/en/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/en/docs/fundamental/fundamental/us_financial_overview.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning US Data-Center Accounts Only +:::warning Longbridge US Accounts This method is only available for US data-center accounts. ::: diff --git a/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md index 4dbb0bbd..22764912 100644 --- a/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning US Data-Center Accounts Only +:::warning Longbridge US Accounts This method is only available for US data-center accounts. ::: diff --git a/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md index c83eeb9c..4ac68ca2 100644 --- a/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning US Data-Center Accounts Only +:::warning Longbridge US Accounts This method is only available for US data-center accounts. ::: diff --git a/docs/en/docs/fundamental/fundamental/us_valuation_overview.md b/docs/en/docs/fundamental/fundamental/us_valuation_overview.md index 80a87786..5a426c71 100644 --- a/docs/en/docs/fundamental/fundamental/us_valuation_overview.md +++ b/docs/en/docs/fundamental/fundamental/us_valuation_overview.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning US Data-Center Accounts Only +:::warning Longbridge US Accounts This method is only available for US data-center accounts. ::: diff --git a/docs/en/docs/quote/stocks/us_crypto_overview.md b/docs/en/docs/quote/stocks/us_crypto_overview.md index 96c29d44..7ca0cbd5 100644 --- a/docs/en/docs/quote/stocks/us_crypto_overview.md +++ b/docs/en/docs/quote/stocks/us_crypto_overview.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning US Data-Center Accounts Only +:::warning Longbridge US Accounts This method is only available for US data-center accounts. ::: diff --git a/docs/en/docs/trade/asset/us_asset_overview.md b/docs/en/docs/trade/asset/us_asset_overview.md index edcab1d9..29965710 100644 --- a/docs/en/docs/trade/asset/us_asset_overview.md +++ b/docs/en/docs/trade/asset/us_asset_overview.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning US Data-Center Accounts Only +:::warning Longbridge US Accounts This method is only available for US data-center accounts. ::: diff --git a/docs/en/docs/trade/asset/us_realized_pl.md b/docs/en/docs/trade/asset/us_realized_pl.md index 8214bbe8..f682b003 100644 --- a/docs/en/docs/trade/asset/us_realized_pl.md +++ b/docs/en/docs/trade/asset/us_realized_pl.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning US Data-Center Accounts Only +:::warning Longbridge US Accounts This method is only available for US data-center accounts. ::: diff --git a/docs/en/docs/trade/order/us_order_detail.md b/docs/en/docs/trade/order/us_order_detail.md index bf755842..c21faad2 100644 --- a/docs/en/docs/trade/order/us_order_detail.md +++ b/docs/en/docs/trade/order/us_order_detail.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning US Data-Center Accounts Only +:::warning Longbridge US Accounts This method is only available for US data-center accounts. ::: diff --git a/docs/en/docs/trade/order/us_query_orders.md b/docs/en/docs/trade/order/us_query_orders.md index 37dfc8fa..ef5f294d 100644 --- a/docs/en/docs/trade/order/us_query_orders.md +++ b/docs/en/docs/trade/order/us_query_orders.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning US Data-Center Accounts Only +:::warning Longbridge US Accounts This method is only available for US data-center accounts. ::: diff --git a/docs/zh-CN/docs/cli/account/dca.md b/docs/zh-CN/docs/cli/account/dca.md index 795882a1..04f5d127 100644 --- a/docs/zh-CN/docs/cli/account/dca.md +++ b/docs/zh-CN/docs/cli/account/dca.md @@ -4,7 +4,7 @@ sidebar_label: 'dca' sidebar_position: 10 --- -:::warning 美股数据中心账户不支持 +:::warning Longbridge US 账户 此命令需要 AP 数据中心账户（香港/新加坡）。美股数据中心账户不支持此命令。AP 账户可操作任意标的，包括美股。 ::: diff --git a/docs/zh-CN/docs/cli/account/profit-analysis.md b/docs/zh-CN/docs/cli/account/profit-analysis.md index 1f4e8707..04a76cca 100644 --- a/docs/zh-CN/docs/cli/account/profit-analysis.md +++ b/docs/zh-CN/docs/cli/account/profit-analysis.md @@ -96,7 +96,7 @@ longbridge profit-analysis realized --category option --currency USD 按资产类别返回美股账户的已实现盈亏明细。 -:::warning 仅限美股账户 +:::warning Longbridge US 账户 `profit-analysis realized` 仅适用于美国数据中心账户。 ::: diff --git a/docs/zh-CN/docs/cli/fundamentals/etf-docs.md b/docs/zh-CN/docs/cli/fundamentals/etf-docs.md index 150e5892..32f9933f 100644 --- a/docs/zh-CN/docs/cli/fundamentals/etf-docs.md +++ b/docs/zh-CN/docs/cli/fundamentals/etf-docs.md @@ -8,7 +8,7 @@ sidebar_position: 21 列出美股 ETF 的监管文件，包括招股书、事实说明书及申报文件。 -:::warning 仅限美股账户 +:::warning Longbridge US 账户 此命令仅适用于美国数据中心账户。 ::: diff --git a/docs/zh-CN/docs/cli/fundamentals/financial-report.md b/docs/zh-CN/docs/cli/fundamentals/financial-report.md index 2eb3f8e2..e2317dff 100644 --- a/docs/zh-CN/docs/cli/fundamentals/financial-report.md +++ b/docs/zh-CN/docs/cli/fundamentals/financial-report.md @@ -103,7 +103,7 @@ longbridge financial-report key-metrics AAPL.US --report quarterly 返回美股的关键财务指标：营收、净利润、EPS、利润率和增长率。 -:::warning 仅限美股账户 +:::warning Longbridge US 账户 `financial-report key-metrics` 仅适用于美国数据中心账户。 ::: diff --git a/docs/zh-CN/docs/cli/market-data/broker-holding.md b/docs/zh-CN/docs/cli/market-data/broker-holding.md index d5cf5003..62fc2b77 100644 --- a/docs/zh-CN/docs/cli/market-data/broker-holding.md +++ b/docs/zh-CN/docs/cli/market-data/broker-holding.md @@ -4,7 +4,7 @@ sidebar_label: 'broker-holding' sidebar_position: 15 --- -:::warning 美股数据中心账户不支持 +:::warning Longbridge US 账户 此命令需要 AP 数据中心账户（香港/新加坡）。美股数据中心账户不支持此命令。AP 账户可操作任意标的，包括美股。 ::: diff --git a/docs/zh-CN/docs/fundamental/fundamental/operating.md b/docs/zh-CN/docs/fundamental/fundamental/operating.md index e10be45d..f0fc961a 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/operating.md +++ b/docs/zh-CN/docs/fundamental/fundamental/operating.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 美股数据中心账户不支持 +:::warning Longbridge US 账户 此方法需要 AP 数据中心账户（香港/新加坡）。美股数据中心账户将收到区域限制错误。AP 账户可查询任意标的，包括美股。 ::: diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md index 8f383fc8..93dfa132 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 仅限美股账户 +:::warning Longbridge US 账户 此方法仅适用于美国数据中心账户。 ::: diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md b/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md index e2380890..5c32b34d 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 仅限美股账户 +:::warning Longbridge US 账户 此方法仅适用于美国数据中心账户。 ::: diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md index 92d079c4..1e8271e6 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 仅限美股账户 +:::warning Longbridge US 账户 此方法仅适用于美国数据中心账户。 ::: diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md index c5d4c3d0..e898de6e 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 仅限美股账户 +:::warning Longbridge US 账户 此方法仅适用于美国数据中心账户。 ::: diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md b/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md index 421b5d90..97edc31f 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 仅限美股账户 +:::warning Longbridge US 账户 此方法仅适用于美国数据中心账户。 ::: diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md index 914cf6dc..e60da6d8 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 仅限美股账户 +:::warning Longbridge US 账户 此方法仅适用于美国数据中心账户。 ::: diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md index 10bff066..08084e5e 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 仅限美股账户 +:::warning Longbridge US 账户 此方法仅适用于美国数据中心账户。 ::: diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md index cec7773b..baec4865 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 仅限美股账户 +:::warning Longbridge US 账户 此方法仅适用于美国数据中心账户。 ::: diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md index 959df794..4c5ad509 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 仅限美股账户 +:::warning Longbridge US 账户 此方法仅适用于美国数据中心账户。 ::: diff --git a/docs/zh-CN/docs/fundamental/market/broker_holding_daily.md b/docs/zh-CN/docs/fundamental/market/broker_holding_daily.md index 39383724..573f92de 100644 --- a/docs/zh-CN/docs/fundamental/market/broker_holding_daily.md +++ b/docs/zh-CN/docs/fundamental/market/broker_holding_daily.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 美股数据中心账户不支持 +:::warning Longbridge US 账户 此方法需要 AP 数据中心账户（香港/新加坡）。美股数据中心账户将收到区域限制错误。AP 账户可查询任意标的，包括美股。 ::: diff --git a/docs/zh-CN/docs/fundamental/market/broker_holding_detail.md b/docs/zh-CN/docs/fundamental/market/broker_holding_detail.md index 3e4ac71b..f932d06e 100644 --- a/docs/zh-CN/docs/fundamental/market/broker_holding_detail.md +++ b/docs/zh-CN/docs/fundamental/market/broker_holding_detail.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 美股数据中心账户不支持 +:::warning Longbridge US 账户 此方法需要 AP 数据中心账户（香港/新加坡）。美股数据中心账户将收到区域限制错误。AP 账户可查询任意标的，包括美股。 ::: diff --git a/docs/zh-CN/docs/fundamental/market/broker_positions.md b/docs/zh-CN/docs/fundamental/market/broker_positions.md index 9575d90e..9d750ce9 100644 --- a/docs/zh-CN/docs/fundamental/market/broker_positions.md +++ b/docs/zh-CN/docs/fundamental/market/broker_positions.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 美股数据中心账户不支持 +:::warning Longbridge US 账户 此方法需要 AP 数据中心账户（香港/新加坡）。美股数据中心账户将收到区域限制错误。AP 账户可查询任意标的，包括美股。 ::: diff --git a/docs/zh-CN/docs/quote/stocks/brokers.md b/docs/zh-CN/docs/quote/stocks/brokers.md index 53a45dec..5dd656eb 100644 --- a/docs/zh-CN/docs/quote/stocks/brokers.md +++ b/docs/zh-CN/docs/quote/stocks/brokers.md @@ -5,7 +5,7 @@ slug: /quote/pull/brokers sidebar_position: 6 --- -:::warning 美股数据中心账户不支持 +:::warning Longbridge US 账户 此方法需要 AP 数据中心账户（香港/新加坡）。美股数据中心账户将收到区域限制错误。AP 账户可查询任意标的，包括美股。 ::: diff --git a/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md b/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md index 76f84ca6..f25f1caf 100644 --- a/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md +++ b/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 仅限美股账户 +:::warning Longbridge US 账户 此方法仅适用于美国数据中心账户。 ::: diff --git a/docs/zh-CN/docs/trade/asset/us_asset_overview.md b/docs/zh-CN/docs/trade/asset/us_asset_overview.md index a22255e5..12218602 100644 --- a/docs/zh-CN/docs/trade/asset/us_asset_overview.md +++ b/docs/zh-CN/docs/trade/asset/us_asset_overview.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 仅限美股账户 +:::warning Longbridge US 账户 此方法仅适用于美国数据中心账户。 ::: diff --git a/docs/zh-CN/docs/trade/asset/us_realized_pl.md b/docs/zh-CN/docs/trade/asset/us_realized_pl.md index f1e8ba94..8108eed6 100644 --- a/docs/zh-CN/docs/trade/asset/us_realized_pl.md +++ b/docs/zh-CN/docs/trade/asset/us_realized_pl.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 仅限美股账户 +:::warning Longbridge US 账户 此方法仅适用于美国数据中心账户。 ::: diff --git a/docs/zh-CN/docs/trade/order/us_order_detail.md b/docs/zh-CN/docs/trade/order/us_order_detail.md index 25915076..0ffba405 100644 --- a/docs/zh-CN/docs/trade/order/us_order_detail.md +++ b/docs/zh-CN/docs/trade/order/us_order_detail.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 仅限美股账户 +:::warning Longbridge US 账户 此方法仅适用于美国数据中心账户。 ::: diff --git a/docs/zh-CN/docs/trade/order/us_query_orders.md b/docs/zh-CN/docs/trade/order/us_query_orders.md index b7edc349..29a3c95e 100644 --- a/docs/zh-CN/docs/trade/order/us_query_orders.md +++ b/docs/zh-CN/docs/trade/order/us_query_orders.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 仅限美股账户 +:::warning Longbridge US 账户 此方法仅适用于美国数据中心账户。 ::: diff --git a/docs/zh-HK/docs/cli/account/dca.md b/docs/zh-HK/docs/cli/account/dca.md index d3af1fc3..34577887 100644 --- a/docs/zh-HK/docs/cli/account/dca.md +++ b/docs/zh-HK/docs/cli/account/dca.md @@ -4,7 +4,7 @@ sidebar_label: 'dca' sidebar_position: 10 --- -:::warning 美股數據中心賬戶不支援 +:::warning Longbridge US 賬戶 此命令需要 AP 數據中心賬戶（香港/新加坡）。美股數據中心賬戶不支援此命令。AP 賬戶可操作任意標的，包括美股。 ::: diff --git a/docs/zh-HK/docs/cli/market-data/broker-holding.md b/docs/zh-HK/docs/cli/market-data/broker-holding.md index 3a7bbb42..6f5740c4 100644 --- a/docs/zh-HK/docs/cli/market-data/broker-holding.md +++ b/docs/zh-HK/docs/cli/market-data/broker-holding.md @@ -4,7 +4,7 @@ sidebar_label: 'broker-holding' sidebar_position: 15 --- -:::warning 美股數據中心賬戶不支援 +:::warning Longbridge US 賬戶 此命令需要 AP 數據中心賬戶（香港/新加坡）。美股數據中心賬戶不支援此命令。AP 賬戶可操作任意標的，包括美股。 ::: diff --git a/docs/zh-HK/docs/fundamental/fundamental/operating.md b/docs/zh-HK/docs/fundamental/fundamental/operating.md index bb29b73e..795a5f6b 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/operating.md +++ b/docs/zh-HK/docs/fundamental/fundamental/operating.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 美股數據中心賬戶不支援 +:::warning Longbridge US 賬戶 此方法需要 AP 數據中心賬戶（香港/新加坡）。美股數據中心賬戶將收到區域限制錯誤。AP 賬戶可查詢任意標的，包括美股。 ::: diff --git a/docs/zh-HK/docs/fundamental/market/broker_holding_daily.md b/docs/zh-HK/docs/fundamental/market/broker_holding_daily.md index 6eaf2217..681d8326 100644 --- a/docs/zh-HK/docs/fundamental/market/broker_holding_daily.md +++ b/docs/zh-HK/docs/fundamental/market/broker_holding_daily.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 美股數據中心賬戶不支援 +:::warning Longbridge US 賬戶 此方法需要 AP 數據中心賬戶（香港/新加坡）。美股數據中心賬戶將收到區域限制錯誤。AP 賬戶可查詢任意標的，包括美股。 ::: diff --git a/docs/zh-HK/docs/fundamental/market/broker_holding_detail.md b/docs/zh-HK/docs/fundamental/market/broker_holding_detail.md index 3cef81a5..72634327 100644 --- a/docs/zh-HK/docs/fundamental/market/broker_holding_detail.md +++ b/docs/zh-HK/docs/fundamental/market/broker_holding_detail.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 美股數據中心賬戶不支援 +:::warning Longbridge US 賬戶 此方法需要 AP 數據中心賬戶（香港/新加坡）。美股數據中心賬戶將收到區域限制錯誤。AP 賬戶可查詢任意標的，包括美股。 ::: diff --git a/docs/zh-HK/docs/fundamental/market/broker_positions.md b/docs/zh-HK/docs/fundamental/market/broker_positions.md index d699a9a5..ba6bbaf7 100644 --- a/docs/zh-HK/docs/fundamental/market/broker_positions.md +++ b/docs/zh-HK/docs/fundamental/market/broker_positions.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 美股數據中心賬戶不支援 +:::warning Longbridge US 賬戶 此方法需要 AP 數據中心賬戶（香港/新加坡）。美股數據中心賬戶將收到區域限制錯誤。AP 賬戶可查詢任意標的，包括美股。 ::: diff --git a/docs/zh-HK/docs/quote/stocks/brokers.md b/docs/zh-HK/docs/quote/stocks/brokers.md index ec0ad4d3..a14db6c1 100644 --- a/docs/zh-HK/docs/quote/stocks/brokers.md +++ b/docs/zh-HK/docs/quote/stocks/brokers.md @@ -5,7 +5,7 @@ slug: /quote/pull/brokers sidebar_position: 6 --- -:::warning 美股數據中心賬戶不支援 +:::warning Longbridge US 賬戶 此方法需要 AP 數據中心賬戶（香港/新加坡）。美股數據中心賬戶將收到區域限制錯誤。AP 賬戶可查詢任意標的，包括美股。 ::: diff --git a/longbridge-terminal b/longbridge-terminal new file mode 160000 index 00000000..b9022136 --- /dev/null +++ b/longbridge-terminal @@ -0,0 +1 @@ +Subproject commit b90221361dad486c61478368cd54bb96d74fcada diff --git a/openapi b/openapi new file mode 160000 index 00000000..daf23233 --- /dev/null +++ b/openapi @@ -0,0 +1 @@ +Subproject commit daf23233dc5c9559c138d6ff089fce3ad15f3b46 diff --git a/openapi-go b/openapi-go new file mode 160000 index 00000000..f9763dcf --- /dev/null +++ b/openapi-go @@ -0,0 +1 @@ +Subproject commit f9763dcfc76f13ea69787fe6618cfdda6e6f36a5 From 68fcf76b1fcf0e68ccbccce8e098b59b7f818238 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 16:42:06 +0800 Subject: [PATCH 20/51] chore: remove stray embedded repo directories --- longbridge-terminal | 1 - openapi | 1 - openapi-go | 1 - 3 files changed, 3 deletions(-) delete mode 160000 longbridge-terminal delete mode 160000 openapi delete mode 160000 openapi-go diff --git a/longbridge-terminal b/longbridge-terminal deleted file mode 160000 index b9022136..00000000 --- a/longbridge-terminal +++ /dev/null @@ -1 +0,0 @@ -Subproject commit b90221361dad486c61478368cd54bb96d74fcada diff --git a/openapi b/openapi deleted file mode 160000 index daf23233..00000000 --- a/openapi +++ /dev/null @@ -1 +0,0 @@ -Subproject commit daf23233dc5c9559c138d6ff089fce3ad15f3b46 diff --git a/openapi-go b/openapi-go deleted file mode 160000 index f9763dcf..00000000 --- a/openapi-go +++ /dev/null @@ -1 +0,0 @@ -Subproject commit f9763dcfc76f13ea69787fe6618cfdda6e6f36a5 From cbf776fd672145bdd355645c651dc6a9921d7959 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 16:42:29 +0800 Subject: [PATCH 21/51] chore: ignore stray submodule directories --- .gitignore | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.gitignore b/.gitignore index 985ee014..ff8e2e1f 100644 --- a/.gitignore +++ b/.gitignore @@ -43,3 +43,8 @@ docs/superpowers # generated at build time by fetch-mcp-tools plugin docs/.vitepress/data/mcp-tools.json docs/.vitepress/.temp/ + +# Stray submodule directories +longbridge-terminal/ +openapi/ +openapi-go/ From ea41509a4dd4d7e69ae1168eb77dc4e79db7ea49 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 16:44:23 +0800 Subject: [PATCH 22/51] docs(trade): add Response sections to US Trade SDK docs (EN) --- docs/en/docs/trade/asset/us_asset_overview.md | 12 ++++++++++++ docs/en/docs/trade/asset/us_realized_pl.md | 16 ++++++++++++++++ docs/en/docs/trade/order/us_order_detail.md | 10 ++++++++++ docs/en/docs/trade/order/us_query_orders.md | 11 +++++++++++ 4 files changed, 49 insertions(+) diff --git a/docs/en/docs/trade/asset/us_asset_overview.md b/docs/en/docs/trade/asset/us_asset_overview.md index 29965710..5a3c82ab 100644 --- a/docs/en/docs/trade/asset/us_asset_overview.md +++ b/docs/en/docs/trade/asset/us_asset_overview.md @@ -48,3 +48,15 @@ fmt.Printf("%+v\n", resp) + +## Response + +Returns `USAssetOverview` with the following fields: + +| Field | Type | Description | +| ----- | ---- | ----------- | +| account_type | string | Account type identifier | +| asset_timestamp | datetime | Snapshot time of the asset data | +| cash_buy_power | string | Available buying power (cash) | +| cash_list | object[] | Cash balances by currency | +| crypto_list | object[] | Crypto holdings with quantity and value | diff --git a/docs/en/docs/trade/asset/us_realized_pl.md b/docs/en/docs/trade/asset/us_realized_pl.md index f682b003..7129c297 100644 --- a/docs/en/docs/trade/asset/us_realized_pl.md +++ b/docs/en/docs/trade/asset/us_realized_pl.md @@ -52,3 +52,19 @@ fmt.Printf("%+v\n", resp) + +## Response + +Returns `USRealizedPL` with the following fields: + +| Field | Type | Description | +| ----- | ---- | ----------- | +| realized_pl_list | USRealizedPLEntry[] | P&L breakdown by asset category | + +Each `USRealizedPLEntry` contains: + +| Field | Type | Description | +| ----- | ---- | ----------- | +| category | int | Asset category (1=stock, 2=option, 3=crypto) | +| currency | string | Currency code, e.g. `USD` | +| metrics | object[] | P&L metrics for different time periods | diff --git a/docs/en/docs/trade/order/us_order_detail.md b/docs/en/docs/trade/order/us_order_detail.md index c21faad2..bf55f983 100644 --- a/docs/en/docs/trade/order/us_order_detail.md +++ b/docs/en/docs/trade/order/us_order_detail.md @@ -50,3 +50,13 @@ fmt.Printf("%+v\n", resp) + +## Response + +Returns `USOrderDetailResponse` with the following fields: + +| Field | Type | Description | +| ----- | ---- | ----------- | +| order | object | Full order object with status and fill details | +| order_histories | object[] | Historical status changes for the order | +| current_attached_order | object | Attached child order (e.g. bracket/OCO), if any | diff --git a/docs/en/docs/trade/order/us_query_orders.md b/docs/en/docs/trade/order/us_query_orders.md index ef5f294d..82ccd504 100644 --- a/docs/en/docs/trade/order/us_query_orders.md +++ b/docs/en/docs/trade/order/us_query_orders.md @@ -56,3 +56,14 @@ fmt.Printf("%+v\n", resp) + +## Response + +Returns `QueryUSOrdersResponse` with the following fields: + +| Field | Type | Description | +| ----- | ---- | ----------- | +| orders | USOrder[] | List of orders matching the filter | +| total_count | int | Total number of matching orders | + +Each `USOrder` contains: `order_id`, symbol, side, status, quantity, price, executed quantity/price, and creation timestamp. From df4fb09b18656ae6ac5a20ecf9151c65ba9f313a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 16:44:24 +0800 Subject: [PATCH 23/51] docs(fundamental): add Response sections to US SDK docs (EN) 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) --- .../fundamental/fundamental/us_analyst_consensus.md | 4 ++++ .../fundamental/fundamental/us_company_dividends.md | 12 ++++++++++++ .../fundamental/fundamental/us_company_overview.md | 12 ++++++++++++ .../fundamental/fundamental/us_etf_dividend_info.md | 12 ++++++++++++ docs/en/docs/fundamental/fundamental/us_etf_files.md | 9 +++++++++ .../fundamental/fundamental/us_financial_overview.md | 4 ++++ .../fundamental/us_financial_statement_v3.md | 12 ++++++++++++ .../fundamental/us_key_financial_metrics.md | 4 ++++ .../fundamental/fundamental/us_valuation_overview.md | 12 ++++++++++++ 9 files changed, 81 insertions(+) diff --git a/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md index 1c465d7a..c633e8a1 100644 --- a/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md @@ -73,3 +73,7 @@ func main() { + +## Response + +Returns a flexible JSON object containing analyst consensus data — revenue and EPS forecasts, target price distribution, and buy/hold/sell rating breakdown. The exact fields vary by data availability. Use `--format json` in the CLI or print the raw response to inspect the structure. diff --git a/docs/en/docs/fundamental/fundamental/us_company_dividends.md b/docs/en/docs/fundamental/fundamental/us_company_dividends.md index 8f31055d..978c4e32 100644 --- a/docs/en/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/en/docs/fundamental/fundamental/us_company_dividends.md @@ -72,3 +72,15 @@ func main() { + +## Response + +Returns `UsCompanyDividends` with the following fields: + +| Field | Type | Description | +| ----- | ---- | ----------- | +| dividend_ttm | string | Trailing twelve-month dividend per share | +| dividend_yield_ttm | string | TTM dividend yield (%) | +| payouts | string | Number of dividend payouts in the past year | +| currency | string | Currency code, e.g. `USD` | +| items | object[] | Individual dividend payment records | diff --git a/docs/en/docs/fundamental/fundamental/us_company_overview.md b/docs/en/docs/fundamental/fundamental/us_company_overview.md index 4d4dd208..47ea3182 100644 --- a/docs/en/docs/fundamental/fundamental/us_company_overview.md +++ b/docs/en/docs/fundamental/fundamental/us_company_overview.md @@ -72,3 +72,15 @@ func main() { + +## Response + +Returns `UsCompanyOverview` with the following fields: + +| Field | Type | Description | +| ----- | ---- | ----------- | +| intro | string | Company introduction | +| market_cap | string | Market capitalization | +| ccy_symbol | string | Currency symbol | +| top_rank_tags | string[] | Ranking tag labels | +| detail_url | string | Link to full company detail page | diff --git a/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md index 0a4a0104..14b07845 100644 --- a/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -72,3 +72,15 @@ func main() { + +## Response + +Returns `UsETFDividendInfo` with the following fields: + +| Field | Type | Description | +| ----- | ---- | ----------- | +| dividend_ttm | string | Trailing twelve-month dividend per share | +| dividend_yield_ttm | string | TTM dividend yield (%) | +| dividend_freq | string | Payout frequency (e.g. `Quarterly`) | +| currency | string | Currency code, e.g. `USD` | +| fiscal_year_info | object[] | Annual dividend breakdown by fiscal year | diff --git a/docs/en/docs/fundamental/fundamental/us_etf_files.md b/docs/en/docs/fundamental/fundamental/us_etf_files.md index 0663d66d..78a0141d 100644 --- a/docs/en/docs/fundamental/fundamental/us_etf_files.md +++ b/docs/en/docs/fundamental/fundamental/us_etf_files.md @@ -73,3 +73,12 @@ func main() { + +## Response + +Returns `UsETFFileList` with the following field: + +| Field | Type | Description | +| ----- | ---- | ----------- | +| files | object[] | List of ETF documents | +| files[].name | string | Document name (e.g. `iShares Core S&P 500 ETF Prospectus`) | diff --git a/docs/en/docs/fundamental/fundamental/us_financial_overview.md b/docs/en/docs/fundamental/fundamental/us_financial_overview.md index f7734ce3..ac1b7ed6 100644 --- a/docs/en/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/en/docs/fundamental/fundamental/us_financial_overview.md @@ -73,3 +73,7 @@ func main() { + +## Response + +Returns a flexible JSON object whose structure varies by company and reporting period. The object contains financial summary data including income, balance sheet, and cash flow indicators. Use `--format json` in the CLI or print the raw response to inspect the structure for a specific symbol. diff --git a/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md index 22764912..751cea43 100644 --- a/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -74,3 +74,15 @@ func main() { + +## Response + +Returns `UsFinancialStatement` with the following fields: + +| Field | Type | Description | +| ----- | ---- | ----------- | +| revenue | string | Total revenue | +| net_income | string | Net income | +| net_margin | string | Net profit margin | +| periods | object[] | List of reporting periods with line-item values | +| currency | string | Currency code, e.g. `USD` | diff --git a/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md index 4ac68ca2..5a2399b8 100644 --- a/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -73,3 +73,7 @@ func main() { + +## Response + +Returns a flexible JSON object containing key financial metrics (revenue, net income, EPS, margins, growth rates) for the requested period. The exact fields vary by company. Use `--format json` in the CLI or print the raw response to inspect the structure. diff --git a/docs/en/docs/fundamental/fundamental/us_valuation_overview.md b/docs/en/docs/fundamental/fundamental/us_valuation_overview.md index 5a426c71..902c393d 100644 --- a/docs/en/docs/fundamental/fundamental/us_valuation_overview.md +++ b/docs/en/docs/fundamental/fundamental/us_valuation_overview.md @@ -72,3 +72,15 @@ func main() { + +## Response + +Returns `UsValuationOverview` with the following fields: + +| Field | Type | Description | +| ----- | ---- | ----------- | +| indicator | string | Valuation indicator name | +| current_indicator | object | Current indicator value | +| range | int | Historical percentile range | +| date | string | Valuation date | +| ai_summary | string | AI-generated valuation summary | From 43865a8bc1bd800c7ccb58d5d392c30eda10f79d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 16:44:40 +0800 Subject: [PATCH 24/51] docs(trade): add CliCommand block to us_order_detail SDK doc (3 langs) --- docs/en/docs/trade/order/us_order_detail.md | 6 ++++++ docs/zh-CN/docs/trade/order/us_order_detail.md | 6 ++++++ docs/zh-HK/docs/trade/order/us_order_detail.md | 6 ++++++ 3 files changed, 18 insertions(+) diff --git a/docs/en/docs/trade/order/us_order_detail.md b/docs/en/docs/trade/order/us_order_detail.md index bf55f983..3ac3f708 100644 --- a/docs/en/docs/trade/order/us_order_detail.md +++ b/docs/en/docs/trade/order/us_order_detail.md @@ -16,6 +16,12 @@ This method is only available for US data-center accounts. Get detail for a specific US order — execution history, order status, and any attached child orders. + + +# View US order detail +longbridge order detail 701276261045858304 + + ## Parameters diff --git a/docs/zh-CN/docs/trade/order/us_order_detail.md b/docs/zh-CN/docs/trade/order/us_order_detail.md index 0ffba405..c66f59a9 100644 --- a/docs/zh-CN/docs/trade/order/us_order_detail.md +++ b/docs/zh-CN/docs/trade/order/us_order_detail.md @@ -16,6 +16,12 @@ headingLevel: 2 获取美股指定委托的详情，包括成交历史，可选获取关联子委托。 + + +# 查看美股委托详情 +longbridge order detail 701276261045858304 + + ## 参数 diff --git a/docs/zh-HK/docs/trade/order/us_order_detail.md b/docs/zh-HK/docs/trade/order/us_order_detail.md index d8cf9694..5221e414 100644 --- a/docs/zh-HK/docs/trade/order/us_order_detail.md +++ b/docs/zh-HK/docs/trade/order/us_order_detail.md @@ -16,6 +16,12 @@ headingLevel: 2 獲取美股指定委託的詳情，包括成交歷史，可選獲取關聯子委託。 + + +# 查看美股委託詳情 +longbridge order detail 701276261045858304 + + ## 參數 From 5a0bdce6aa7c37b12f9c9a5b2c8c4b1df6184354 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 16:47:43 +0800 Subject: [PATCH 25/51] docs: add CliCommand blocks to all 14 US SDK docs (3 langs) --- .../docs/fundamental/fundamental/us_analyst_consensus.md | 6 ++++++ .../docs/fundamental/fundamental/us_company_dividends.md | 6 ++++++ .../en/docs/fundamental/fundamental/us_company_overview.md | 6 ++++++ .../docs/fundamental/fundamental/us_etf_dividend_info.md | 6 ++++++ docs/en/docs/fundamental/fundamental/us_etf_files.md | 6 ++++++ .../docs/fundamental/fundamental/us_financial_overview.md | 6 ++++++ .../fundamental/fundamental/us_financial_statement_v3.md | 7 +++++++ .../fundamental/fundamental/us_key_financial_metrics.md | 6 ++++++ .../docs/fundamental/fundamental/us_valuation_overview.md | 6 ++++++ docs/en/docs/quote/stocks/us_crypto_overview.md | 5 +++++ docs/en/docs/trade/asset/us_asset_overview.md | 5 +++++ docs/en/docs/trade/asset/us_realized_pl.md | 7 +++++++ docs/en/docs/trade/order/us_query_orders.md | 7 +++++++ .../docs/fundamental/fundamental/us_analyst_consensus.md | 6 ++++++ .../docs/fundamental/fundamental/us_company_dividends.md | 6 ++++++ .../docs/fundamental/fundamental/us_company_overview.md | 6 ++++++ .../docs/fundamental/fundamental/us_etf_dividend_info.md | 6 ++++++ docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md | 6 ++++++ .../docs/fundamental/fundamental/us_financial_overview.md | 6 ++++++ .../fundamental/fundamental/us_financial_statement_v3.md | 7 +++++++ .../fundamental/fundamental/us_key_financial_metrics.md | 6 ++++++ .../docs/fundamental/fundamental/us_valuation_overview.md | 6 ++++++ docs/zh-CN/docs/quote/stocks/us_crypto_overview.md | 5 +++++ docs/zh-CN/docs/trade/asset/us_asset_overview.md | 5 +++++ docs/zh-CN/docs/trade/asset/us_realized_pl.md | 7 +++++++ docs/zh-CN/docs/trade/order/us_query_orders.md | 7 +++++++ .../docs/fundamental/fundamental/us_analyst_consensus.md | 6 ++++++ .../docs/fundamental/fundamental/us_company_dividends.md | 6 ++++++ .../docs/fundamental/fundamental/us_company_overview.md | 6 ++++++ .../docs/fundamental/fundamental/us_etf_dividend_info.md | 6 ++++++ docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md | 6 ++++++ .../docs/fundamental/fundamental/us_financial_overview.md | 6 ++++++ .../fundamental/fundamental/us_financial_statement_v3.md | 7 +++++++ .../fundamental/fundamental/us_key_financial_metrics.md | 6 ++++++ .../docs/fundamental/fundamental/us_valuation_overview.md | 6 ++++++ docs/zh-HK/docs/quote/stocks/us_crypto_overview.md | 5 +++++ docs/zh-HK/docs/trade/asset/us_asset_overview.md | 5 +++++ docs/zh-HK/docs/trade/asset/us_realized_pl.md | 7 +++++++ docs/zh-HK/docs/trade/order/us_query_orders.md | 7 +++++++ 39 files changed, 237 insertions(+) diff --git a/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md index c633e8a1..089a6d6c 100644 --- a/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md @@ -16,6 +16,12 @@ This method is only available for US data-center accounts. Get analyst consensus estimates for a US stock — revenue, EPS forecasts, and buy/hold/sell ratings. + +# US analyst consensus +longbridge consensus AAPL.US +longbridge consensus NVDA.US + + ## Parameters diff --git a/docs/en/docs/fundamental/fundamental/us_company_dividends.md b/docs/en/docs/fundamental/fundamental/us_company_dividends.md index 978c4e32..42408dea 100644 --- a/docs/en/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/en/docs/fundamental/fundamental/us_company_dividends.md @@ -16,6 +16,12 @@ This method is only available for US data-center accounts. Get dividend history for a US stock — TTM yield, payout count, and individual dividend records. + +# Company dividends (US accounts) +longbridge dividend AAPL.US +longbridge dividend MSFT.US + + ## Parameters diff --git a/docs/en/docs/fundamental/fundamental/us_company_overview.md b/docs/en/docs/fundamental/fundamental/us_company_overview.md index 47ea3182..6702e000 100644 --- a/docs/en/docs/fundamental/fundamental/us_company_overview.md +++ b/docs/en/docs/fundamental/fundamental/us_company_overview.md @@ -16,6 +16,12 @@ This method is only available for US data-center accounts. Get company overview for a US stock — introduction, market cap, ranking tags, and detail URL. + +# US company overview +longbridge company AAPL.US +longbridge company TSLA.US + + ## Parameters diff --git a/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md index 14b07845..c0a40b66 100644 --- a/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -16,6 +16,12 @@ This method is only available for US data-center accounts. Get dividend information for a US ETF — TTM dividend yield, payout frequency, and fiscal year breakdown. + +# ETF dividend info (US accounts) +longbridge dividend IVV.US +longbridge dividend SPY.US + + ## Parameters diff --git a/docs/en/docs/fundamental/fundamental/us_etf_files.md b/docs/en/docs/fundamental/fundamental/us_etf_files.md index 78a0141d..8ff98bd4 100644 --- a/docs/en/docs/fundamental/fundamental/us_etf_files.md +++ b/docs/en/docs/fundamental/fundamental/us_etf_files.md @@ -16,6 +16,12 @@ This method is only available for US data-center accounts. List regulatory documents for a US ETF — prospectus, fact sheets, and annual reports. + +# US ETF regulatory documents +longbridge etf-docs IVV.US +longbridge etf-docs SPY.US + + ## Parameters diff --git a/docs/en/docs/fundamental/fundamental/us_financial_overview.md b/docs/en/docs/fundamental/fundamental/us_financial_overview.md index ac1b7ed6..a55b1cd7 100644 --- a/docs/en/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/en/docs/fundamental/fundamental/us_financial_overview.md @@ -16,6 +16,12 @@ This method is only available for US data-center accounts. Get financial overview for a US stock by reporting period — income, balance sheet, and cash flow summary. + +# US financial overview +longbridge financial-report AAPL.US +longbridge financial-report TSLA.US + + ## Parameters diff --git a/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md index 751cea43..f4188204 100644 --- a/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -16,6 +16,13 @@ This method is only available for US data-center accounts. Get a specific financial statement (income statement, balance sheet, or cash flow) for a US stock. + +# Income statement +longbridge financial-report AAPL.US --kind IS +# Balance sheet +longbridge financial-report AAPL.US --kind BS + + ## Parameters diff --git a/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md index 5a2399b8..a6d40a1a 100644 --- a/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -16,6 +16,12 @@ This method is only available for US data-center accounts. Get key financial metrics for a US stock — revenue, net income, EPS, margins, and growth rates. + +# Key financial metrics (US accounts) +longbridge financial-report key-metrics AAPL.US +longbridge financial-report key-metrics AAPL.US --report quarterly + + ## Parameters diff --git a/docs/en/docs/fundamental/fundamental/us_valuation_overview.md b/docs/en/docs/fundamental/fundamental/us_valuation_overview.md index 902c393d..6c0b9e59 100644 --- a/docs/en/docs/fundamental/fundamental/us_valuation_overview.md +++ b/docs/en/docs/fundamental/fundamental/us_valuation_overview.md @@ -16,6 +16,12 @@ This method is only available for US data-center accounts. Get valuation overview for a US stock — current valuation indicators and historical range. + +# US valuation overview +longbridge valuation AAPL.US +longbridge valuation NVDA.US + + ## Parameters diff --git a/docs/en/docs/quote/stocks/us_crypto_overview.md b/docs/en/docs/quote/stocks/us_crypto_overview.md index 7ca0cbd5..0f3fe475 100644 --- a/docs/en/docs/quote/stocks/us_crypto_overview.md +++ b/docs/en/docs/quote/stocks/us_crypto_overview.md @@ -16,6 +16,11 @@ This method is only available for US data-center accounts. Get overview data for a US crypto trading pair — all-time highs/lows, asset info, and currency details. + +# US crypto overview +longbridge static DOGEUSD.BKKT + + ## Parameters diff --git a/docs/en/docs/trade/asset/us_asset_overview.md b/docs/en/docs/trade/asset/us_asset_overview.md index 5a3c82ab..ff58c65e 100644 --- a/docs/en/docs/trade/asset/us_asset_overview.md +++ b/docs/en/docs/trade/asset/us_asset_overview.md @@ -16,6 +16,11 @@ This method is only available for US data-center accounts. Get an overview of US account assets — buying power, cash, stocks, options, and crypto. + +# US account asset overview +longbridge positions + + ## Parameters diff --git a/docs/en/docs/trade/asset/us_realized_pl.md b/docs/en/docs/trade/asset/us_realized_pl.md index 7129c297..93f4a119 100644 --- a/docs/en/docs/trade/asset/us_realized_pl.md +++ b/docs/en/docs/trade/asset/us_realized_pl.md @@ -16,6 +16,13 @@ This method is only available for US data-center accounts. Get realized profit and loss for a US account, broken down by asset category. + +# US realized P&L +longbridge profit-analysis realized +# Filter by stock +longbridge profit-analysis realized --category stock + + ## Parameters diff --git a/docs/en/docs/trade/order/us_query_orders.md b/docs/en/docs/trade/order/us_query_orders.md index 82ccd504..7f1091b4 100644 --- a/docs/en/docs/trade/order/us_query_orders.md +++ b/docs/en/docs/trade/order/us_query_orders.md @@ -16,6 +16,13 @@ This method is only available for US data-center accounts. Query historical and pending orders for US accounts with pagination and filtering. + +# List US orders +longbridge order +# Filter pending orders +longbridge order --status pending + + ## Parameters diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md index 93dfa132..a9be3a18 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md @@ -16,6 +16,12 @@ headingLevel: 2 获取美股分析师一致预期——营收、EPS 预测及买入/持有/卖出评级。 + +# 美股分析师一致预期 +longbridge consensus AAPL.US +longbridge consensus NVDA.US + + ## 参数 diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md b/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md index 5c32b34d..686ec9ab 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md @@ -16,6 +16,12 @@ headingLevel: 2 获取美股股票分红历史——TTM 股息率、派息次数及逐笔分红记录。 + +# 公司分红（美股账户） +longbridge dividend AAPL.US +longbridge dividend MSFT.US + + ## 参数 diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md index 1e8271e6..8c7a93d2 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md @@ -16,6 +16,12 @@ headingLevel: 2 获取美股公司概览信息——简介、市值、排名标签和详情链接。 + +# 美股公司概览 +longbridge company AAPL.US +longbridge company TSLA.US + + ## 参数 diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md index e898de6e..00d53418 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -16,6 +16,12 @@ headingLevel: 2 获取美股 ETF 分红信息——TTM 股息率、派息频率及财年明细。 + +# ETF 分红信息（美股账户） +longbridge dividend IVV.US +longbridge dividend SPY.US + + ## 参数 diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md b/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md index 97edc31f..d234ae10 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md @@ -16,6 +16,12 @@ headingLevel: 2 列出美股 ETF 的监管文件——招股书、事实说明书和年报。 + +# 美股 ETF 监管文件 +longbridge etf-docs IVV.US +longbridge etf-docs SPY.US + + ## 参数 diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md index e60da6d8..10345b31 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md @@ -16,6 +16,12 @@ headingLevel: 2 按报告周期获取美股财务概览——损益、资产负债和现金流摘要。 + +# 美股财务概览 +longbridge financial-report AAPL.US +longbridge financial-report TSLA.US + + ## 参数 diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md index 08084e5e..7b438222 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -16,6 +16,13 @@ headingLevel: 2 获取美股指定财务报表（损益表、资产负债表或现金流量表）。 + +# 损益表 +longbridge financial-report AAPL.US --kind IS +# 资产负债表 +longbridge financial-report AAPL.US --kind BS + + ## 参数 diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md index baec4865..71aa6166 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -16,6 +16,12 @@ headingLevel: 2 获取美股关键财务指标——营收、净利润、EPS、利润率和增长率。 + +# 关键财务指标（美股账户） +longbridge financial-report key-metrics AAPL.US +longbridge financial-report key-metrics AAPL.US --report quarterly + + ## 参数 diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md index 4c5ad509..dadefa93 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md @@ -16,6 +16,12 @@ headingLevel: 2 获取美股估值概览——当前估值指标及历史区间。 + +# 美股估值概览 +longbridge valuation AAPL.US +longbridge valuation NVDA.US + + ## 参数 diff --git a/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md b/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md index f25f1caf..8599a01d 100644 --- a/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md +++ b/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md @@ -16,6 +16,11 @@ headingLevel: 2 获取美股加密货币交易对的概览信息——历史最高/最低价、资产详情和货币信息。 + +# 美股加密货币概览 +longbridge static DOGEUSD.BKKT + + ## 参数 diff --git a/docs/zh-CN/docs/trade/asset/us_asset_overview.md b/docs/zh-CN/docs/trade/asset/us_asset_overview.md index 12218602..3fcfcad0 100644 --- a/docs/zh-CN/docs/trade/asset/us_asset_overview.md +++ b/docs/zh-CN/docs/trade/asset/us_asset_overview.md @@ -16,6 +16,11 @@ headingLevel: 2 获取美股账户资产概览——买入力、现金、股票、期权和加密货币。 + +# 美股账户资产概览 +longbridge positions + + ## 参数 diff --git a/docs/zh-CN/docs/trade/asset/us_realized_pl.md b/docs/zh-CN/docs/trade/asset/us_realized_pl.md index 8108eed6..04161475 100644 --- a/docs/zh-CN/docs/trade/asset/us_realized_pl.md +++ b/docs/zh-CN/docs/trade/asset/us_realized_pl.md @@ -16,6 +16,13 @@ headingLevel: 2 获取美股账户已实现盈亏，按资产类别（股票/期权/加密货币）分组。 + +# 美股已实现盈亏 +longbridge profit-analysis realized +# 按股票类别筛选 +longbridge profit-analysis realized --category stock + + ## 参数 diff --git a/docs/zh-CN/docs/trade/order/us_query_orders.md b/docs/zh-CN/docs/trade/order/us_query_orders.md index 29a3c95e..096b7abf 100644 --- a/docs/zh-CN/docs/trade/order/us_query_orders.md +++ b/docs/zh-CN/docs/trade/order/us_query_orders.md @@ -16,6 +16,13 @@ headingLevel: 2 查询美股账户的历史委托和待成交委托，支持分页和筛选。 + +# 查询美股委托 +longbridge order +# 筛选待成交委托 +longbridge order --status pending + + ## 参数 diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md index a3fba012..983d5ed1 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md @@ -16,6 +16,12 @@ headingLevel: 2 獲取美股分析師一致預期——營收、EPS 預測及買入/持有/賣出評級。 + +# 美股分析師一致預期 +longbridge consensus AAPL.US +longbridge consensus NVDA.US + + ## 參數 diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md b/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md index aad3dd98..527a107d 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md @@ -16,6 +16,12 @@ headingLevel: 2 獲取美股股票分紅歷史——TTM 股息率、派息次數及逐筆分紅記錄。 + +# 公司分紅（美股賬戶） +longbridge dividend AAPL.US +longbridge dividend MSFT.US + + ## 參數 diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md index 62302f27..3191b135 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md @@ -16,6 +16,12 @@ headingLevel: 2 獲取美股公司概覽資訊——簡介、市值、排名標籤和詳情連結。 + +# 美股公司概覽 +longbridge company AAPL.US +longbridge company TSLA.US + + ## 參數 diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md index ec6e5ba9..3ad2c1de 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -16,6 +16,12 @@ headingLevel: 2 獲取美股 ETF 分紅資訊——TTM 股息率、派息頻率及財年明細。 + +# ETF 分紅資訊（美股賬戶） +longbridge dividend IVV.US +longbridge dividend SPY.US + + ## 參數 diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md b/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md index 764eb451..c2f0a63f 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md @@ -16,6 +16,12 @@ headingLevel: 2 列出美股 ETF 的監管文件——招股書、事實說明書和年報。 + +# 美股 ETF 監管文件 +longbridge etf-docs IVV.US +longbridge etf-docs SPY.US + + ## 參數 diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md index b9845421..6ca1aeca 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md @@ -16,6 +16,12 @@ headingLevel: 2 按報告週期獲取美股財務概覽——損益、資產負債和現金流摘要。 + +# 美股財務概覽 +longbridge financial-report AAPL.US +longbridge financial-report TSLA.US + + ## 參數 diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md index a796795e..12390fd2 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -16,6 +16,13 @@ headingLevel: 2 獲取美股指定財務報表（損益表、資產負債表或現金流量表）。 + +# 損益表 +longbridge financial-report AAPL.US --kind IS +# 資產負債表 +longbridge financial-report AAPL.US --kind BS + + ## 參數 diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md index af82c7a8..83b5c22f 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -16,6 +16,12 @@ headingLevel: 2 獲取美股關鍵財務指標——營收、淨利潤、EPS、利潤率和增長率。 + +# 關鍵財務指標（美股賬戶） +longbridge financial-report key-metrics AAPL.US +longbridge financial-report key-metrics AAPL.US --report quarterly + + ## 參數 diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md index 4ebcb395..fcff31bb 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md @@ -16,6 +16,12 @@ headingLevel: 2 獲取美股估值概覽——當前估值指標及歷史區間。 + +# 美股估值概覽 +longbridge valuation AAPL.US +longbridge valuation NVDA.US + + ## 參數 diff --git a/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md b/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md index a35b3061..b78b66f3 100644 --- a/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md +++ b/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md @@ -16,6 +16,11 @@ headingLevel: 2 獲取美股加密貨幣交易對的概覽資訊——歷史最高/最低價、資產詳情和貨幣資訊。 + +# 美股加密貨幣概覽 +longbridge static DOGEUSD.BKKT + + ## 參數 diff --git a/docs/zh-HK/docs/trade/asset/us_asset_overview.md b/docs/zh-HK/docs/trade/asset/us_asset_overview.md index 7d7de093..e89621b0 100644 --- a/docs/zh-HK/docs/trade/asset/us_asset_overview.md +++ b/docs/zh-HK/docs/trade/asset/us_asset_overview.md @@ -16,6 +16,11 @@ headingLevel: 2 獲取美股賬戶資產概覽——買入力、現金、股票、期權和加密貨幣。 + +# 美股賬戶資產概覽 +longbridge positions + + ## 參數 diff --git a/docs/zh-HK/docs/trade/asset/us_realized_pl.md b/docs/zh-HK/docs/trade/asset/us_realized_pl.md index 40007d86..875d1b4c 100644 --- a/docs/zh-HK/docs/trade/asset/us_realized_pl.md +++ b/docs/zh-HK/docs/trade/asset/us_realized_pl.md @@ -16,6 +16,13 @@ headingLevel: 2 獲取美股賬戶已實現盈虧，按資產類別（股票/期權/加密貨幣）分組。 + +# 美股已實現盈虧 +longbridge profit-analysis realized +# 按股票類別篩選 +longbridge profit-analysis realized --category stock + + ## 參數 diff --git a/docs/zh-HK/docs/trade/order/us_query_orders.md b/docs/zh-HK/docs/trade/order/us_query_orders.md index 129a1b1d..29f6a2aa 100644 --- a/docs/zh-HK/docs/trade/order/us_query_orders.md +++ b/docs/zh-HK/docs/trade/order/us_query_orders.md @@ -16,6 +16,13 @@ headingLevel: 2 查詢美股賬戶的歷史委託和待成交委託，支持分頁和篩選。 + +# 查詢美股委託 +longbridge order +# 篩選待成交委託 +longbridge order --status pending + + ## 參數 From aae5077fa83b612c7006d34e3dcc12e74337447e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 16:54:57 +0800 Subject: [PATCH 26/51] docs: add Python async/Node.js/Java/Rust tabs to all US SDK docs (42 files) --- .../fundamental/us_analyst_consensus.md | 73 +++++++++++++++++++ .../fundamental/us_company_dividends.md | 73 +++++++++++++++++++ .../fundamental/us_company_overview.md | 73 +++++++++++++++++++ .../fundamental/us_etf_dividend_info.md | 73 +++++++++++++++++++ .../fundamental/fundamental/us_etf_files.md | 73 +++++++++++++++++++ .../fundamental/us_financial_overview.md | 73 +++++++++++++++++++ .../fundamental/us_financial_statement_v3.md | 73 +++++++++++++++++++ .../fundamental/us_key_financial_metrics.md | 73 +++++++++++++++++++ .../fundamental/us_valuation_overview.md | 73 +++++++++++++++++++ .../docs/quote/stocks/us_crypto_overview.md | 73 +++++++++++++++++++ docs/en/docs/trade/asset/us_asset_overview.md | 73 +++++++++++++++++++ docs/en/docs/trade/asset/us_realized_pl.md | 73 +++++++++++++++++++ docs/en/docs/trade/order/us_order_detail.md | 73 +++++++++++++++++++ docs/en/docs/trade/order/us_query_orders.md | 73 +++++++++++++++++++ .../fundamental/us_analyst_consensus.md | 73 +++++++++++++++++++ .../fundamental/us_company_dividends.md | 73 +++++++++++++++++++ .../fundamental/us_company_overview.md | 73 +++++++++++++++++++ .../fundamental/us_etf_dividend_info.md | 73 +++++++++++++++++++ .../fundamental/fundamental/us_etf_files.md | 73 +++++++++++++++++++ .../fundamental/us_financial_overview.md | 73 +++++++++++++++++++ .../fundamental/us_financial_statement_v3.md | 73 +++++++++++++++++++ .../fundamental/us_key_financial_metrics.md | 73 +++++++++++++++++++ .../fundamental/us_valuation_overview.md | 73 +++++++++++++++++++ .../docs/quote/stocks/us_crypto_overview.md | 73 +++++++++++++++++++ .../docs/trade/asset/us_asset_overview.md | 73 +++++++++++++++++++ docs/zh-CN/docs/trade/asset/us_realized_pl.md | 73 +++++++++++++++++++ .../zh-CN/docs/trade/order/us_order_detail.md | 73 +++++++++++++++++++ .../zh-CN/docs/trade/order/us_query_orders.md | 73 +++++++++++++++++++ .../fundamental/us_analyst_consensus.md | 73 +++++++++++++++++++ .../fundamental/us_company_dividends.md | 73 +++++++++++++++++++ .../fundamental/us_company_overview.md | 73 +++++++++++++++++++ .../fundamental/us_etf_dividend_info.md | 73 +++++++++++++++++++ .../fundamental/fundamental/us_etf_files.md | 73 +++++++++++++++++++ .../fundamental/us_financial_overview.md | 73 +++++++++++++++++++ .../fundamental/us_financial_statement_v3.md | 73 +++++++++++++++++++ .../fundamental/us_key_financial_metrics.md | 73 +++++++++++++++++++ .../fundamental/us_valuation_overview.md | 73 +++++++++++++++++++ .../docs/quote/stocks/us_crypto_overview.md | 73 +++++++++++++++++++ .../docs/trade/asset/us_asset_overview.md | 73 +++++++++++++++++++ docs/zh-HK/docs/trade/asset/us_realized_pl.md | 73 +++++++++++++++++++ .../zh-HK/docs/trade/order/us_order_detail.md | 73 +++++++++++++++++++ .../zh-HK/docs/trade/order/us_query_orders.md | 73 +++++++++++++++++++ 42 files changed, 3066 insertions(+) diff --git a/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md index 089a6d6c..f675c4ea 100644 --- a/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md @@ -44,6 +44,79 @@ config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_analyst_consensus("AAPL.US", report="annual") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncFundamentalContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("Visit:", url)) + config = Config.from_oauth(oauth) + ctx = AsyncFundamentalContext.create(config) + resp = await ctx.us_analyst_consensus("AAPL.US", report="annual") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, FundamentalContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = FundamentalContext.new(config) + const resp = await ctx.usAnalystConsensus("AAPL.US", report="annual") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.fundamental.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + FundamentalContext ctx = FundamentalContext.create(config)) { + var resp = ctx.getUsAnalystConsensus("AAPL.US", report="annual").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, fundamental::FundamentalContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("Open: {url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = FundamentalContext::new(config); + let resp = ctx.us_analyst_consensus("AAPL.US", report="annual").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/en/docs/fundamental/fundamental/us_company_dividends.md b/docs/en/docs/fundamental/fundamental/us_company_dividends.md index 42408dea..142e324d 100644 --- a/docs/en/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/en/docs/fundamental/fundamental/us_company_dividends.md @@ -43,6 +43,79 @@ config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_company_dividends("AAPL.US") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncFundamentalContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("Visit:", url)) + config = Config.from_oauth(oauth) + ctx = AsyncFundamentalContext.create(config) + resp = await ctx.us_company_dividends("AAPL.US") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, FundamentalContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = FundamentalContext.new(config) + const resp = await ctx.usCompanyDividends("AAPL.US") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.fundamental.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + FundamentalContext ctx = FundamentalContext.create(config)) { + var resp = ctx.getUsCompanyDividends("AAPL.US").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, fundamental::FundamentalContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("Open: {url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = FundamentalContext::new(config); + let resp = ctx.us_company_dividends("AAPL.US").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/en/docs/fundamental/fundamental/us_company_overview.md b/docs/en/docs/fundamental/fundamental/us_company_overview.md index 6702e000..145d7c91 100644 --- a/docs/en/docs/fundamental/fundamental/us_company_overview.md +++ b/docs/en/docs/fundamental/fundamental/us_company_overview.md @@ -43,6 +43,79 @@ config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_company_overview("AAPL.US") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncFundamentalContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("Visit:", url)) + config = Config.from_oauth(oauth) + ctx = AsyncFundamentalContext.create(config) + resp = await ctx.us_company_overview("AAPL.US") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, FundamentalContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = FundamentalContext.new(config) + const resp = await ctx.usCompanyOverview("AAPL.US") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.fundamental.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + FundamentalContext ctx = FundamentalContext.create(config)) { + var resp = ctx.getUsCompanyOverview("AAPL.US").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, fundamental::FundamentalContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("Open: {url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = FundamentalContext::new(config); + let resp = ctx.us_company_overview("AAPL.US").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md index c0a40b66..8607ae19 100644 --- a/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -43,6 +43,79 @@ config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_etf_dividend_info("IVV.US") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncFundamentalContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("Visit:", url)) + config = Config.from_oauth(oauth) + ctx = AsyncFundamentalContext.create(config) + resp = await ctx.us_etf_dividend_info("IVV.US") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, FundamentalContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = FundamentalContext.new(config) + const resp = await ctx.usEtfDividendInfo("IVV.US") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.fundamental.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + FundamentalContext ctx = FundamentalContext.create(config)) { + var resp = ctx.getUsEtfDividendInfo("IVV.US").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, fundamental::FundamentalContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("Open: {url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = FundamentalContext::new(config); + let resp = ctx.us_etf_dividend_info("IVV.US").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/en/docs/fundamental/fundamental/us_etf_files.md b/docs/en/docs/fundamental/fundamental/us_etf_files.md index 8ff98bd4..6ba3197d 100644 --- a/docs/en/docs/fundamental/fundamental/us_etf_files.md +++ b/docs/en/docs/fundamental/fundamental/us_etf_files.md @@ -44,6 +44,79 @@ config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_etf_files("IVV.US") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncFundamentalContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("Visit:", url)) + config = Config.from_oauth(oauth) + ctx = AsyncFundamentalContext.create(config) + resp = await ctx.us_etf_files("IVV.US") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, FundamentalContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = FundamentalContext.new(config) + const resp = await ctx.usEtfFiles("IVV.US") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.fundamental.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + FundamentalContext ctx = FundamentalContext.create(config)) { + var resp = ctx.getUsEtfFiles("IVV.US").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, fundamental::FundamentalContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("Open: {url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = FundamentalContext::new(config); + let resp = ctx.us_etf_files("IVV.US").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/en/docs/fundamental/fundamental/us_financial_overview.md b/docs/en/docs/fundamental/fundamental/us_financial_overview.md index a55b1cd7..1d72001e 100644 --- a/docs/en/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/en/docs/fundamental/fundamental/us_financial_overview.md @@ -44,6 +44,79 @@ config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_financial_overview("AAPL.US", report="annual") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncFundamentalContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("Visit:", url)) + config = Config.from_oauth(oauth) + ctx = AsyncFundamentalContext.create(config) + resp = await ctx.us_financial_overview("AAPL.US", report="annual") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, FundamentalContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = FundamentalContext.new(config) + const resp = await ctx.usFinancialOverview("AAPL.US", report="annual") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.fundamental.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + FundamentalContext ctx = FundamentalContext.create(config)) { + var resp = ctx.getUsFinancialOverview("AAPL.US", report="annual").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, fundamental::FundamentalContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("Open: {url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = FundamentalContext::new(config); + let resp = ctx.us_financial_overview("AAPL.US", report="annual").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md index f4188204..33d96d3a 100644 --- a/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -46,6 +46,79 @@ config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_financial_statement_v3("AAPL.US", kind="IS", report="annual") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncFundamentalContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("Visit:", url)) + config = Config.from_oauth(oauth) + ctx = AsyncFundamentalContext.create(config) + resp = await ctx.us_financial_statement_v3("AAPL.US", kind="IS", report="annual") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, FundamentalContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = FundamentalContext.new(config) + const resp = await ctx.usFinancialStatementV3("AAPL.US", kind="IS", report="annual") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.fundamental.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + FundamentalContext ctx = FundamentalContext.create(config)) { + var resp = ctx.getUsFinancialStatementV3("AAPL.US", kind="IS", report="annual").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, fundamental::FundamentalContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("Open: {url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = FundamentalContext::new(config); + let resp = ctx.us_financial_statement_v3("AAPL.US", kind="IS", report="annual").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md index a6d40a1a..a55b782d 100644 --- a/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -44,6 +44,79 @@ config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_key_financial_metrics("AAPL.US", report="annual") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncFundamentalContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("Visit:", url)) + config = Config.from_oauth(oauth) + ctx = AsyncFundamentalContext.create(config) + resp = await ctx.us_key_financial_metrics("AAPL.US", report="annual") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, FundamentalContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = FundamentalContext.new(config) + const resp = await ctx.usKeyFinancialMetrics("AAPL.US", report="annual") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.fundamental.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + FundamentalContext ctx = FundamentalContext.create(config)) { + var resp = ctx.getUsKeyFinancialMetrics("AAPL.US", report="annual").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, fundamental::FundamentalContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("Open: {url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = FundamentalContext::new(config); + let resp = ctx.us_key_financial_metrics("AAPL.US", report="annual").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/en/docs/fundamental/fundamental/us_valuation_overview.md b/docs/en/docs/fundamental/fundamental/us_valuation_overview.md index 6c0b9e59..61ebf8f6 100644 --- a/docs/en/docs/fundamental/fundamental/us_valuation_overview.md +++ b/docs/en/docs/fundamental/fundamental/us_valuation_overview.md @@ -43,6 +43,79 @@ config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_valuation_overview("AAPL.US") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncFundamentalContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("Visit:", url)) + config = Config.from_oauth(oauth) + ctx = AsyncFundamentalContext.create(config) + resp = await ctx.us_valuation_overview("AAPL.US") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, FundamentalContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = FundamentalContext.new(config) + const resp = await ctx.usValuationOverview("AAPL.US") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.fundamental.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + FundamentalContext ctx = FundamentalContext.create(config)) { + var resp = ctx.getUsValuationOverview("AAPL.US").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, fundamental::FundamentalContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("Open: {url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = FundamentalContext::new(config); + let resp = ctx.us_valuation_overview("AAPL.US").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/en/docs/quote/stocks/us_crypto_overview.md b/docs/en/docs/quote/stocks/us_crypto_overview.md index 0f3fe475..ce2f5d16 100644 --- a/docs/en/docs/quote/stocks/us_crypto_overview.md +++ b/docs/en/docs/quote/stocks/us_crypto_overview.md @@ -42,6 +42,79 @@ config = Config.from_oauth(oauth) ctx = QuoteContext(config) resp = ctx.us_crypto_overview("DOGEUSD.BKKT") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncQuoteContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("Visit:", url)) + config = Config.from_oauth(oauth) + ctx = AsyncQuoteContext.create(config) + resp = await ctx.us_crypto_overview("DOGEUSD.BKKT") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, QuoteContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = QuoteContext.new(config) + const resp = await ctx.usCryptoOverview("DOGEUSD.BKKT") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.quote.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + QuoteContext ctx = QuoteContext.create(config)) { + var resp = ctx.getUsCryptoOverview("DOGEUSD.BKKT").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, quote::QuoteContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("Open: {url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = QuoteContext::new(config); + let resp = ctx.us_crypto_overview("DOGEUSD.BKKT").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/en/docs/trade/asset/us_asset_overview.md b/docs/en/docs/trade/asset/us_asset_overview.md index ff58c65e..4d57a520 100644 --- a/docs/en/docs/trade/asset/us_asset_overview.md +++ b/docs/en/docs/trade/asset/us_asset_overview.md @@ -40,6 +40,79 @@ config = Config.from_oauth(oauth) ctx = TradeContext(config) resp = ctx.us_asset_overview() print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncTradeContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("Visit:", url)) + config = Config.from_oauth(oauth) + ctx = AsyncTradeContext.create(config) + resp = await ctx.us_asset_overview() + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, TradeContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = TradeContext.new(config) + const resp = await ctx.usAssetOverview() + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.trade.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + TradeContext ctx = TradeContext.create(config)) { + var resp = ctx.getUsAssetOverview().get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, trade::TradeContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("Open: {url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = TradeContext::new(config); + let resp = ctx.us_asset_overview().await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/en/docs/trade/asset/us_realized_pl.md b/docs/en/docs/trade/asset/us_realized_pl.md index 93f4a119..a338d38c 100644 --- a/docs/en/docs/trade/asset/us_realized_pl.md +++ b/docs/en/docs/trade/asset/us_realized_pl.md @@ -45,6 +45,79 @@ config = Config.from_oauth(oauth) ctx = TradeContext(config) resp = ctx.us_realized_pl("USD", category="STOCK") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncTradeContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("Visit:", url)) + config = Config.from_oauth(oauth) + ctx = AsyncTradeContext.create(config) + resp = await ctx.us_realized_pl("USD", category="STOCK") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, TradeContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = TradeContext.new(config) + const resp = await ctx.usRealizedPl("USD", category="STOCK") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.trade.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + TradeContext ctx = TradeContext.create(config)) { + var resp = ctx.getUsRealizedPl("USD", category="STOCK").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, trade::TradeContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("Open: {url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = TradeContext::new(config); + let resp = ctx.us_realized_pl("USD", category="STOCK").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/en/docs/trade/order/us_order_detail.md b/docs/en/docs/trade/order/us_order_detail.md index 3ac3f708..1db71f4a 100644 --- a/docs/en/docs/trade/order/us_order_detail.md +++ b/docs/en/docs/trade/order/us_order_detail.md @@ -43,6 +43,79 @@ config = Config.from_oauth(oauth) ctx = TradeContext(config) resp = ctx.us_order_detail("701276261045858304") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncTradeContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("Visit:", url)) + config = Config.from_oauth(oauth) + ctx = AsyncTradeContext.create(config) + resp = await ctx.us_order_detail("701276261045858304") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, TradeContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = TradeContext.new(config) + const resp = await ctx.usOrderDetail("701276261045858304") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.trade.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + TradeContext ctx = TradeContext.create(config)) { + var resp = ctx.getUsOrderDetail("701276261045858304").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, trade::TradeContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("Open: {url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = TradeContext::new(config); + let resp = ctx.us_order_detail("701276261045858304").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/en/docs/trade/order/us_query_orders.md b/docs/en/docs/trade/order/us_query_orders.md index 7f1091b4..bbb15d55 100644 --- a/docs/en/docs/trade/order/us_query_orders.md +++ b/docs/en/docs/trade/order/us_query_orders.md @@ -50,6 +50,79 @@ config = Config.from_oauth(oauth) ctx = TradeContext(config) resp = ctx.us_query_orders() print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncTradeContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("Visit:", url)) + config = Config.from_oauth(oauth) + ctx = AsyncTradeContext.create(config) + resp = await ctx.us_query_orders() + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, TradeContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('Open this URL to authorize: ' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = TradeContext.new(config) + const resp = await ctx.usQueryOrders() + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.trade.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + TradeContext ctx = TradeContext.create(config)) { + var resp = ctx.getUsQueryOrders().get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, trade::TradeContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("Open: {url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = TradeContext::new(config); + let resp = ctx.us_query_orders().await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md index a9be3a18..1d38ce97 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md @@ -44,6 +44,79 @@ config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_analyst_consensus("AAPL.US", report="annual") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncFundamentalContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("请访问：", url)) + config = Config.from_oauth(oauth) + ctx = AsyncFundamentalContext.create(config) + resp = await ctx.us_analyst_consensus("AAPL.US", report="annual") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, FundamentalContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('请访问此 URL 授权：' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = FundamentalContext.new(config) + const resp = await ctx.usAnalystConsensus("AAPL.US", report="annual") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.fundamental.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + FundamentalContext ctx = FundamentalContext.create(config)) { + var resp = ctx.getUsAnalystConsensus("AAPL.US", report="annual").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, fundamental::FundamentalContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("请访问：{url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = FundamentalContext::new(config); + let resp = ctx.us_analyst_consensus("AAPL.US", report="annual").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md b/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md index 686ec9ab..4a4d2827 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md @@ -43,6 +43,79 @@ config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_company_dividends("AAPL.US") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncFundamentalContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("请访问：", url)) + config = Config.from_oauth(oauth) + ctx = AsyncFundamentalContext.create(config) + resp = await ctx.us_company_dividends("AAPL.US") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, FundamentalContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('请访问此 URL 授权：' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = FundamentalContext.new(config) + const resp = await ctx.usCompanyDividends("AAPL.US") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.fundamental.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + FundamentalContext ctx = FundamentalContext.create(config)) { + var resp = ctx.getUsCompanyDividends("AAPL.US").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, fundamental::FundamentalContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("请访问：{url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = FundamentalContext::new(config); + let resp = ctx.us_company_dividends("AAPL.US").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md index 8c7a93d2..4f263d80 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md @@ -43,6 +43,79 @@ config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_company_overview("AAPL.US") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncFundamentalContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("请访问：", url)) + config = Config.from_oauth(oauth) + ctx = AsyncFundamentalContext.create(config) + resp = await ctx.us_company_overview("AAPL.US") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, FundamentalContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('请访问此 URL 授权：' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = FundamentalContext.new(config) + const resp = await ctx.usCompanyOverview("AAPL.US") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.fundamental.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + FundamentalContext ctx = FundamentalContext.create(config)) { + var resp = ctx.getUsCompanyOverview("AAPL.US").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, fundamental::FundamentalContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("请访问：{url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = FundamentalContext::new(config); + let resp = ctx.us_company_overview("AAPL.US").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md index 00d53418..80392026 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -43,6 +43,79 @@ config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_etf_dividend_info("IVV.US") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncFundamentalContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("请访问：", url)) + config = Config.from_oauth(oauth) + ctx = AsyncFundamentalContext.create(config) + resp = await ctx.us_etf_dividend_info("IVV.US") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, FundamentalContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('请访问此 URL 授权：' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = FundamentalContext.new(config) + const resp = await ctx.usEtfDividendInfo("IVV.US") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.fundamental.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + FundamentalContext ctx = FundamentalContext.create(config)) { + var resp = ctx.getUsEtfDividendInfo("IVV.US").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, fundamental::FundamentalContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("请访问：{url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = FundamentalContext::new(config); + let resp = ctx.us_etf_dividend_info("IVV.US").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md b/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md index d234ae10..fb3a1ccc 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md @@ -44,6 +44,79 @@ config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_etf_files("IVV.US") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncFundamentalContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("请访问：", url)) + config = Config.from_oauth(oauth) + ctx = AsyncFundamentalContext.create(config) + resp = await ctx.us_etf_files("IVV.US") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, FundamentalContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('请访问此 URL 授权：' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = FundamentalContext.new(config) + const resp = await ctx.usEtfFiles("IVV.US") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.fundamental.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + FundamentalContext ctx = FundamentalContext.create(config)) { + var resp = ctx.getUsEtfFiles("IVV.US").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, fundamental::FundamentalContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("请访问：{url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = FundamentalContext::new(config); + let resp = ctx.us_etf_files("IVV.US").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md index 10345b31..2bdcfb44 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md @@ -44,6 +44,79 @@ config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_financial_overview("AAPL.US", report="annual") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncFundamentalContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("请访问：", url)) + config = Config.from_oauth(oauth) + ctx = AsyncFundamentalContext.create(config) + resp = await ctx.us_financial_overview("AAPL.US", report="annual") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, FundamentalContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('请访问此 URL 授权：' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = FundamentalContext.new(config) + const resp = await ctx.usFinancialOverview("AAPL.US", report="annual") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.fundamental.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + FundamentalContext ctx = FundamentalContext.create(config)) { + var resp = ctx.getUsFinancialOverview("AAPL.US", report="annual").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, fundamental::FundamentalContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("请访问：{url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = FundamentalContext::new(config); + let resp = ctx.us_financial_overview("AAPL.US", report="annual").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md index 7b438222..8b527284 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -46,6 +46,79 @@ config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_financial_statement_v3("AAPL.US", kind="IS", report="annual") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncFundamentalContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("请访问：", url)) + config = Config.from_oauth(oauth) + ctx = AsyncFundamentalContext.create(config) + resp = await ctx.us_financial_statement_v3("AAPL.US", kind="IS", report="annual") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, FundamentalContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('请访问此 URL 授权：' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = FundamentalContext.new(config) + const resp = await ctx.usFinancialStatementV3("AAPL.US", kind="IS", report="annual") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.fundamental.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + FundamentalContext ctx = FundamentalContext.create(config)) { + var resp = ctx.getUsFinancialStatementV3("AAPL.US", kind="IS", report="annual").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, fundamental::FundamentalContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("请访问：{url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = FundamentalContext::new(config); + let resp = ctx.us_financial_statement_v3("AAPL.US", kind="IS", report="annual").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md index 71aa6166..c7c5740d 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -44,6 +44,79 @@ config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_key_financial_metrics("AAPL.US", report="annual") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncFundamentalContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("请访问：", url)) + config = Config.from_oauth(oauth) + ctx = AsyncFundamentalContext.create(config) + resp = await ctx.us_key_financial_metrics("AAPL.US", report="annual") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, FundamentalContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('请访问此 URL 授权：' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = FundamentalContext.new(config) + const resp = await ctx.usKeyFinancialMetrics("AAPL.US", report="annual") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.fundamental.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + FundamentalContext ctx = FundamentalContext.create(config)) { + var resp = ctx.getUsKeyFinancialMetrics("AAPL.US", report="annual").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, fundamental::FundamentalContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("请访问：{url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = FundamentalContext::new(config); + let resp = ctx.us_key_financial_metrics("AAPL.US", report="annual").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md index dadefa93..74b0678e 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md @@ -43,6 +43,79 @@ config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_valuation_overview("AAPL.US") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncFundamentalContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("请访问：", url)) + config = Config.from_oauth(oauth) + ctx = AsyncFundamentalContext.create(config) + resp = await ctx.us_valuation_overview("AAPL.US") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, FundamentalContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('请访问此 URL 授权：' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = FundamentalContext.new(config) + const resp = await ctx.usValuationOverview("AAPL.US") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.fundamental.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + FundamentalContext ctx = FundamentalContext.create(config)) { + var resp = ctx.getUsValuationOverview("AAPL.US").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, fundamental::FundamentalContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("请访问：{url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = FundamentalContext::new(config); + let resp = ctx.us_valuation_overview("AAPL.US").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md b/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md index 8599a01d..0264c58a 100644 --- a/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md +++ b/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md @@ -42,6 +42,79 @@ config = Config.from_oauth(oauth) ctx = QuoteContext(config) resp = ctx.us_crypto_overview("DOGEUSD.BKKT") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncQuoteContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("请访问：", url)) + config = Config.from_oauth(oauth) + ctx = AsyncQuoteContext.create(config) + resp = await ctx.us_crypto_overview("DOGEUSD.BKKT") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, QuoteContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('请访问此 URL 授权：' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = QuoteContext.new(config) + const resp = await ctx.usCryptoOverview("DOGEUSD.BKKT") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.quote.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + QuoteContext ctx = QuoteContext.create(config)) { + var resp = ctx.getUsCryptoOverview("DOGEUSD.BKKT").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, quote::QuoteContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("请访问：{url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = QuoteContext::new(config); + let resp = ctx.us_crypto_overview("DOGEUSD.BKKT").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/zh-CN/docs/trade/asset/us_asset_overview.md b/docs/zh-CN/docs/trade/asset/us_asset_overview.md index 3fcfcad0..4741a702 100644 --- a/docs/zh-CN/docs/trade/asset/us_asset_overview.md +++ b/docs/zh-CN/docs/trade/asset/us_asset_overview.md @@ -40,6 +40,79 @@ config = Config.from_oauth(oauth) ctx = TradeContext(config) resp = ctx.us_asset_overview() print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncTradeContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("请访问：", url)) + config = Config.from_oauth(oauth) + ctx = AsyncTradeContext.create(config) + resp = await ctx.us_asset_overview() + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, TradeContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('请访问此 URL 授权：' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = TradeContext.new(config) + const resp = await ctx.usAssetOverview() + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.trade.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + TradeContext ctx = TradeContext.create(config)) { + var resp = ctx.getUsAssetOverview().get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, trade::TradeContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("请访问：{url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = TradeContext::new(config); + let resp = ctx.us_asset_overview().await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/zh-CN/docs/trade/asset/us_realized_pl.md b/docs/zh-CN/docs/trade/asset/us_realized_pl.md index 04161475..1ad08ca8 100644 --- a/docs/zh-CN/docs/trade/asset/us_realized_pl.md +++ b/docs/zh-CN/docs/trade/asset/us_realized_pl.md @@ -45,6 +45,79 @@ config = Config.from_oauth(oauth) ctx = TradeContext(config) resp = ctx.us_realized_pl("USD", category="STOCK") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncTradeContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("请访问：", url)) + config = Config.from_oauth(oauth) + ctx = AsyncTradeContext.create(config) + resp = await ctx.us_realized_pl("USD", category="STOCK") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, TradeContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('请访问此 URL 授权：' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = TradeContext.new(config) + const resp = await ctx.usRealizedPl("USD", category="STOCK") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.trade.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + TradeContext ctx = TradeContext.create(config)) { + var resp = ctx.getUsRealizedPl("USD", category="STOCK").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, trade::TradeContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("请访问：{url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = TradeContext::new(config); + let resp = ctx.us_realized_pl("USD", category="STOCK").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/zh-CN/docs/trade/order/us_order_detail.md b/docs/zh-CN/docs/trade/order/us_order_detail.md index c66f59a9..d33e5c28 100644 --- a/docs/zh-CN/docs/trade/order/us_order_detail.md +++ b/docs/zh-CN/docs/trade/order/us_order_detail.md @@ -43,6 +43,79 @@ config = Config.from_oauth(oauth) ctx = TradeContext(config) resp = ctx.us_order_detail("701276261045858304") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncTradeContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("请访问：", url)) + config = Config.from_oauth(oauth) + ctx = AsyncTradeContext.create(config) + resp = await ctx.us_order_detail("701276261045858304") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, TradeContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('请访问此 URL 授权：' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = TradeContext.new(config) + const resp = await ctx.usOrderDetail("701276261045858304") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.trade.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + TradeContext ctx = TradeContext.create(config)) { + var resp = ctx.getUsOrderDetail("701276261045858304").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, trade::TradeContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("请访问：{url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = TradeContext::new(config); + let resp = ctx.us_order_detail("701276261045858304").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/zh-CN/docs/trade/order/us_query_orders.md b/docs/zh-CN/docs/trade/order/us_query_orders.md index 096b7abf..14455706 100644 --- a/docs/zh-CN/docs/trade/order/us_query_orders.md +++ b/docs/zh-CN/docs/trade/order/us_query_orders.md @@ -50,6 +50,79 @@ config = Config.from_oauth(oauth) ctx = TradeContext(config) resp = ctx.us_query_orders() print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncTradeContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("请访问：", url)) + config = Config.from_oauth(oauth) + ctx = AsyncTradeContext.create(config) + resp = await ctx.us_query_orders() + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, TradeContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('请访问此 URL 授权：' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = TradeContext.new(config) + const resp = await ctx.usQueryOrders() + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.trade.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + TradeContext ctx = TradeContext.create(config)) { + var resp = ctx.getUsQueryOrders().get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, trade::TradeContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("请访问：{url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = TradeContext::new(config); + let resp = ctx.us_query_orders().await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md index 983d5ed1..26722f5f 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md @@ -44,6 +44,79 @@ config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_analyst_consensus("AAPL.US", report="annual") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncFundamentalContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("請訪問：", url)) + config = Config.from_oauth(oauth) + ctx = AsyncFundamentalContext.create(config) + resp = await ctx.us_analyst_consensus("AAPL.US", report="annual") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, FundamentalContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('請訪問此 URL 授權：' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = FundamentalContext.new(config) + const resp = await ctx.usAnalystConsensus("AAPL.US", report="annual") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.fundamental.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + FundamentalContext ctx = FundamentalContext.create(config)) { + var resp = ctx.getUsAnalystConsensus("AAPL.US", report="annual").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, fundamental::FundamentalContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("請訪問：{url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = FundamentalContext::new(config); + let resp = ctx.us_analyst_consensus("AAPL.US", report="annual").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md b/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md index 527a107d..ca879164 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md @@ -43,6 +43,79 @@ config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_company_dividends("AAPL.US") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncFundamentalContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("請訪問：", url)) + config = Config.from_oauth(oauth) + ctx = AsyncFundamentalContext.create(config) + resp = await ctx.us_company_dividends("AAPL.US") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, FundamentalContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('請訪問此 URL 授權：' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = FundamentalContext.new(config) + const resp = await ctx.usCompanyDividends("AAPL.US") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.fundamental.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + FundamentalContext ctx = FundamentalContext.create(config)) { + var resp = ctx.getUsCompanyDividends("AAPL.US").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, fundamental::FundamentalContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("請訪問：{url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = FundamentalContext::new(config); + let resp = ctx.us_company_dividends("AAPL.US").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md index 3191b135..55e2088b 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md @@ -43,6 +43,79 @@ config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_company_overview("AAPL.US") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncFundamentalContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("請訪問：", url)) + config = Config.from_oauth(oauth) + ctx = AsyncFundamentalContext.create(config) + resp = await ctx.us_company_overview("AAPL.US") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, FundamentalContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('請訪問此 URL 授權：' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = FundamentalContext.new(config) + const resp = await ctx.usCompanyOverview("AAPL.US") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.fundamental.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + FundamentalContext ctx = FundamentalContext.create(config)) { + var resp = ctx.getUsCompanyOverview("AAPL.US").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, fundamental::FundamentalContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("請訪問：{url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = FundamentalContext::new(config); + let resp = ctx.us_company_overview("AAPL.US").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md index 3ad2c1de..27b94db8 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -43,6 +43,79 @@ config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_etf_dividend_info("IVV.US") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncFundamentalContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("請訪問：", url)) + config = Config.from_oauth(oauth) + ctx = AsyncFundamentalContext.create(config) + resp = await ctx.us_etf_dividend_info("IVV.US") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, FundamentalContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('請訪問此 URL 授權：' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = FundamentalContext.new(config) + const resp = await ctx.usEtfDividendInfo("IVV.US") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.fundamental.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + FundamentalContext ctx = FundamentalContext.create(config)) { + var resp = ctx.getUsEtfDividendInfo("IVV.US").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, fundamental::FundamentalContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("請訪問：{url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = FundamentalContext::new(config); + let resp = ctx.us_etf_dividend_info("IVV.US").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md b/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md index c2f0a63f..422c80e0 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md @@ -44,6 +44,79 @@ config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_etf_files("IVV.US") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncFundamentalContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("請訪問：", url)) + config = Config.from_oauth(oauth) + ctx = AsyncFundamentalContext.create(config) + resp = await ctx.us_etf_files("IVV.US") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, FundamentalContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('請訪問此 URL 授權：' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = FundamentalContext.new(config) + const resp = await ctx.usEtfFiles("IVV.US") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.fundamental.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + FundamentalContext ctx = FundamentalContext.create(config)) { + var resp = ctx.getUsEtfFiles("IVV.US").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, fundamental::FundamentalContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("請訪問：{url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = FundamentalContext::new(config); + let resp = ctx.us_etf_files("IVV.US").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md index 6ca1aeca..186bafaa 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md @@ -44,6 +44,79 @@ config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_financial_overview("AAPL.US", report="annual") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncFundamentalContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("請訪問：", url)) + config = Config.from_oauth(oauth) + ctx = AsyncFundamentalContext.create(config) + resp = await ctx.us_financial_overview("AAPL.US", report="annual") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, FundamentalContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('請訪問此 URL 授權：' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = FundamentalContext.new(config) + const resp = await ctx.usFinancialOverview("AAPL.US", report="annual") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.fundamental.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + FundamentalContext ctx = FundamentalContext.create(config)) { + var resp = ctx.getUsFinancialOverview("AAPL.US", report="annual").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, fundamental::FundamentalContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("請訪問：{url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = FundamentalContext::new(config); + let resp = ctx.us_financial_overview("AAPL.US", report="annual").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md index 12390fd2..b94fd6b9 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -46,6 +46,79 @@ config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_financial_statement_v3("AAPL.US", kind="IS", report="annual") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncFundamentalContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("請訪問：", url)) + config = Config.from_oauth(oauth) + ctx = AsyncFundamentalContext.create(config) + resp = await ctx.us_financial_statement_v3("AAPL.US", kind="IS", report="annual") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, FundamentalContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('請訪問此 URL 授權：' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = FundamentalContext.new(config) + const resp = await ctx.usFinancialStatementV3("AAPL.US", kind="IS", report="annual") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.fundamental.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + FundamentalContext ctx = FundamentalContext.create(config)) { + var resp = ctx.getUsFinancialStatementV3("AAPL.US", kind="IS", report="annual").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, fundamental::FundamentalContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("請訪問：{url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = FundamentalContext::new(config); + let resp = ctx.us_financial_statement_v3("AAPL.US", kind="IS", report="annual").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md index 83b5c22f..f6cfb83e 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -44,6 +44,79 @@ config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_key_financial_metrics("AAPL.US", report="annual") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncFundamentalContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("請訪問：", url)) + config = Config.from_oauth(oauth) + ctx = AsyncFundamentalContext.create(config) + resp = await ctx.us_key_financial_metrics("AAPL.US", report="annual") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, FundamentalContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('請訪問此 URL 授權：' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = FundamentalContext.new(config) + const resp = await ctx.usKeyFinancialMetrics("AAPL.US", report="annual") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.fundamental.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + FundamentalContext ctx = FundamentalContext.create(config)) { + var resp = ctx.getUsKeyFinancialMetrics("AAPL.US", report="annual").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, fundamental::FundamentalContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("請訪問：{url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = FundamentalContext::new(config); + let resp = ctx.us_key_financial_metrics("AAPL.US", report="annual").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md index fcff31bb..8fec7436 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md @@ -43,6 +43,79 @@ config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_valuation_overview("AAPL.US") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncFundamentalContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("請訪問：", url)) + config = Config.from_oauth(oauth) + ctx = AsyncFundamentalContext.create(config) + resp = await ctx.us_valuation_overview("AAPL.US") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, FundamentalContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('請訪問此 URL 授權：' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = FundamentalContext.new(config) + const resp = await ctx.usValuationOverview("AAPL.US") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.fundamental.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + FundamentalContext ctx = FundamentalContext.create(config)) { + var resp = ctx.getUsValuationOverview("AAPL.US").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, fundamental::FundamentalContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("請訪問：{url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = FundamentalContext::new(config); + let resp = ctx.us_valuation_overview("AAPL.US").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md b/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md index b78b66f3..b827a368 100644 --- a/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md +++ b/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md @@ -42,6 +42,79 @@ config = Config.from_oauth(oauth) ctx = QuoteContext(config) resp = ctx.us_crypto_overview("DOGEUSD.BKKT") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncQuoteContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("請訪問：", url)) + config = Config.from_oauth(oauth) + ctx = AsyncQuoteContext.create(config) + resp = await ctx.us_crypto_overview("DOGEUSD.BKKT") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, QuoteContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('請訪問此 URL 授權：' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = QuoteContext.new(config) + const resp = await ctx.usCryptoOverview("DOGEUSD.BKKT") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.quote.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + QuoteContext ctx = QuoteContext.create(config)) { + var resp = ctx.getUsCryptoOverview("DOGEUSD.BKKT").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, quote::QuoteContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("請訪問：{url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = QuoteContext::new(config); + let resp = ctx.us_crypto_overview("DOGEUSD.BKKT").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/zh-HK/docs/trade/asset/us_asset_overview.md b/docs/zh-HK/docs/trade/asset/us_asset_overview.md index e89621b0..8fc29340 100644 --- a/docs/zh-HK/docs/trade/asset/us_asset_overview.md +++ b/docs/zh-HK/docs/trade/asset/us_asset_overview.md @@ -40,6 +40,79 @@ config = Config.from_oauth(oauth) ctx = TradeContext(config) resp = ctx.us_asset_overview() print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncTradeContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("請訪問：", url)) + config = Config.from_oauth(oauth) + ctx = AsyncTradeContext.create(config) + resp = await ctx.us_asset_overview() + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, TradeContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('請訪問此 URL 授權：' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = TradeContext.new(config) + const resp = await ctx.usAssetOverview() + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.trade.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + TradeContext ctx = TradeContext.create(config)) { + var resp = ctx.getUsAssetOverview().get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, trade::TradeContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("請訪問：{url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = TradeContext::new(config); + let resp = ctx.us_asset_overview().await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/zh-HK/docs/trade/asset/us_realized_pl.md b/docs/zh-HK/docs/trade/asset/us_realized_pl.md index 875d1b4c..3df1b361 100644 --- a/docs/zh-HK/docs/trade/asset/us_realized_pl.md +++ b/docs/zh-HK/docs/trade/asset/us_realized_pl.md @@ -45,6 +45,79 @@ config = Config.from_oauth(oauth) ctx = TradeContext(config) resp = ctx.us_realized_pl("USD", category="STOCK") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncTradeContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("請訪問：", url)) + config = Config.from_oauth(oauth) + ctx = AsyncTradeContext.create(config) + resp = await ctx.us_realized_pl("USD", category="STOCK") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, TradeContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('請訪問此 URL 授權：' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = TradeContext.new(config) + const resp = await ctx.usRealizedPl("USD", category="STOCK") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.trade.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + TradeContext ctx = TradeContext.create(config)) { + var resp = ctx.getUsRealizedPl("USD", category="STOCK").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, trade::TradeContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("請訪問：{url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = TradeContext::new(config); + let resp = ctx.us_realized_pl("USD", category="STOCK").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/zh-HK/docs/trade/order/us_order_detail.md b/docs/zh-HK/docs/trade/order/us_order_detail.md index 5221e414..89f92a22 100644 --- a/docs/zh-HK/docs/trade/order/us_order_detail.md +++ b/docs/zh-HK/docs/trade/order/us_order_detail.md @@ -43,6 +43,79 @@ config = Config.from_oauth(oauth) ctx = TradeContext(config) resp = ctx.us_order_detail("701276261045858304") print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncTradeContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("請訪問：", url)) + config = Config.from_oauth(oauth) + ctx = AsyncTradeContext.create(config) + resp = await ctx.us_order_detail("701276261045858304") + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, TradeContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('請訪問此 URL 授權：' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = TradeContext.new(config) + const resp = await ctx.usOrderDetail("701276261045858304") + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.trade.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + TradeContext ctx = TradeContext.create(config)) { + var resp = ctx.getUsOrderDetail("701276261045858304").get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, trade::TradeContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("請訪問：{url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = TradeContext::new(config); + let resp = ctx.us_order_detail("701276261045858304").await?; + println!("{:?}", resp); + Ok(()) +} ``` diff --git a/docs/zh-HK/docs/trade/order/us_query_orders.md b/docs/zh-HK/docs/trade/order/us_query_orders.md index 29f6a2aa..765978c9 100644 --- a/docs/zh-HK/docs/trade/order/us_query_orders.md +++ b/docs/zh-HK/docs/trade/order/us_query_orders.md @@ -50,6 +50,79 @@ config = Config.from_oauth(oauth) ctx = TradeContext(config) resp = ctx.us_query_orders() print(resp) +``` + + + + +```python +import asyncio +from longbridge.openapi import AsyncTradeContext, Config, OAuthBuilder + +async def main() -> None: + oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("請訪問：", url)) + config = Config.from_oauth(oauth) + ctx = AsyncTradeContext.create(config) + resp = await ctx.us_query_orders() + print(resp) + +if __name__ == "__main__": + asyncio.run(main()) +``` + + + + +```javascript +const { Config, TradeContext, OAuth } = require('longbridge') + +async function main() { + const oauth = await OAuth.build('your-client-id', (_, url) => { + console.log('請訪問此 URL 授權：' + url) + }) + const config = Config.fromOAuth(oauth) + const ctx = TradeContext.new(config) + const resp = await ctx.usQueryOrders() + console.log(resp) +} +main().catch(console.error) +``` + + + + +```java +import com.longbridge.*; +import com.longbridge.trade.*; + +class Main { + public static void main(String[] args) throws Exception { + try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); + Config config = Config.fromOAuth(oauth); + TradeContext ctx = TradeContext.create(config)) { + var resp = ctx.getUsQueryOrders().get(); + System.out.println(resp); + } + } +} +``` + + + + +```rust +use std::sync::Arc; +use longbridge::{oauth::OAuthBuilder, trade::TradeContext, Config}; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("請訪問：{url}")).await?; + let config = Arc::new(Config::from_oauth(oauth)); + let ctx = TradeContext::new(config); + let resp = ctx.us_query_orders().await?; + println!("{:?}", resp); + Ok(()) +} ``` From 51cfaa3ac927628734d95f9eb69b5d3f4dbc8d17 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 16:58:59 +0800 Subject: [PATCH 27/51] docs: add Response sections to zh-CN + zh-HK US SDK docs (26 files) --- .../fundamental/us_analyst_consensus.md | 4 ++++ .../fundamental/us_company_dividends.md | 12 ++++++++++++ .../fundamental/us_company_overview.md | 12 ++++++++++++ .../fundamental/us_etf_dividend_info.md | 12 ++++++++++++ .../docs/fundamental/fundamental/us_etf_files.md | 9 +++++++++ .../fundamental/us_financial_overview.md | 4 ++++ .../fundamental/us_financial_statement_v3.md | 12 ++++++++++++ .../fundamental/us_key_financial_metrics.md | 4 ++++ .../fundamental/us_valuation_overview.md | 12 ++++++++++++ docs/zh-CN/docs/trade/asset/us_asset_overview.md | 12 ++++++++++++ docs/zh-CN/docs/trade/asset/us_realized_pl.md | 16 ++++++++++++++++ docs/zh-CN/docs/trade/order/us_order_detail.md | 10 ++++++++++ docs/zh-CN/docs/trade/order/us_query_orders.md | 11 +++++++++++ .../fundamental/us_analyst_consensus.md | 4 ++++ .../fundamental/us_company_dividends.md | 12 ++++++++++++ .../fundamental/us_company_overview.md | 12 ++++++++++++ .../fundamental/us_etf_dividend_info.md | 12 ++++++++++++ .../docs/fundamental/fundamental/us_etf_files.md | 9 +++++++++ .../fundamental/us_financial_overview.md | 4 ++++ .../fundamental/us_financial_statement_v3.md | 12 ++++++++++++ .../fundamental/us_key_financial_metrics.md | 4 ++++ .../fundamental/us_valuation_overview.md | 12 ++++++++++++ docs/zh-HK/docs/trade/asset/us_asset_overview.md | 12 ++++++++++++ docs/zh-HK/docs/trade/asset/us_realized_pl.md | 16 ++++++++++++++++ docs/zh-HK/docs/trade/order/us_order_detail.md | 10 ++++++++++ docs/zh-HK/docs/trade/order/us_query_orders.md | 11 +++++++++++ 26 files changed, 260 insertions(+) diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md index 1d38ce97..434f4b68 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md @@ -152,3 +152,7 @@ func main() { + +## 响应 + +返回一个结构灵活的 JSON 对象 包含分析师一致预期数据 — revenue and EPS forecasts, target price distribution, and buy/hold/sell rating breakdown. 具体字段因数据可用性而异。 可通过 CLI 使用 `--format json` 或打印原始响应查看数据结构。 diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md b/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md index 4a4d2827..545fd46b 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md @@ -151,3 +151,15 @@ func main() { + +## 响应 + +返回 `UsCompanyDividends` ，包含以下字段： + +| 字段 | 类型 | 描述 | +| ---- | ---- | ---- | +| dividend_ttm | string | 过去 12 个月每股股息 | +| dividend_yield_ttm | string | TTM 股息率（%） | +| payouts | string | 过去一年的派息次数 | +| currency | string | 货币代码，如 `USD` | +| items | object[] | 逐笔分红支付记录 | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md index 4f263d80..bd4acf75 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md @@ -151,3 +151,15 @@ func main() { + +## 响应 + +返回 `UsCompanyOverview` ，包含以下字段： + +| 字段 | 类型 | 描述 | +| ---- | ---- | ---- | +| intro | string | 公司简介 | +| market_cap | string | 市值 | +| ccy_symbol | string | 货币符号 | +| top_rank_tags | string[] | 排名标签列表 | +| detail_url | string | 公司详情页链接 | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md index 80392026..55cb4ab7 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -151,3 +151,15 @@ func main() { + +## 响应 + +返回 `UsETFDividendInfo` ，包含以下字段： + +| 字段 | 类型 | 描述 | +| ---- | ---- | ---- | +| dividend_ttm | string | 过去 12 个月每股股息 | +| dividend_yield_ttm | string | TTM 股息率（%） | +| dividend_freq | string | 派息频率（如 `Quarterly`） | +| currency | string | 货币代码，如 `USD` | +| fiscal_year_info | object[] | 按财年分列的年度分红明细 | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md b/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md index fb3a1ccc..2f045e05 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md @@ -152,3 +152,12 @@ func main() { + +## 响应 + +返回 `UsETFFileList` ，包含以下字段： + +| 字段 | 类型 | 描述 | +| ---- | ---- | ---- | +| files | object[] | ETF 文件列表 | +| files[].name | string | 文件名称 (e.g. `iShares Core S&P 500 ETF Prospectus`) | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md index 2bdcfb44..62dd8d3a 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md @@ -152,3 +152,7 @@ func main() { + +## 响应 + +返回一个结构灵活的 JSON 对象 其结构因公司和报告周期而异。 对象包含财务摘要数据 including income, balance sheet, and cash flow indicators. 可通过 CLI 使用 `--format json` 或打印原始响应来查看具体标的的数据结构。 diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md index 8b527284..2ff55084 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -154,3 +154,15 @@ func main() { + +## 响应 + +返回 `UsFinancialStatement` ，包含以下字段： + +| 字段 | 类型 | 描述 | +| ---- | ---- | ---- | +| revenue | string | 总营收 | +| net_income | string | 净利润 | +| net_margin | string | 净利润率 | +| periods | object[] | 包含逐行数据的报告期列表 | +| currency | string | 货币代码，如 `USD` | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md index c7c5740d..30c8b018 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -152,3 +152,7 @@ func main() { + +## 响应 + +返回一个结构灵活的 JSON 对象 包含关键财务指标 (revenue, net income, EPS, margins, growth rates) for the requested period. 具体字段因公司而异。 可通过 CLI 使用 `--format json` 或打印原始响应查看数据结构。 diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md index 74b0678e..76dc7012 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md @@ -151,3 +151,15 @@ func main() { + +## 响应 + +返回 `UsValuationOverview` ，包含以下字段： + +| 字段 | 类型 | 描述 | +| ---- | ---- | ---- | +| indicator | string | 估值指标名称 | +| current_indicator | object | 当前估值指标数据 | +| range | int | 历史百分位区间 | +| date | string | 估值日期 | +| ai_summary | string | AI 生成的估值摘要 | diff --git a/docs/zh-CN/docs/trade/asset/us_asset_overview.md b/docs/zh-CN/docs/trade/asset/us_asset_overview.md index 4741a702..58a7efd8 100644 --- a/docs/zh-CN/docs/trade/asset/us_asset_overview.md +++ b/docs/zh-CN/docs/trade/asset/us_asset_overview.md @@ -126,3 +126,15 @@ fmt.Printf("%+v\n", resp) + +## 响应 + +返回 `USAssetOverview` ，包含以下字段： + +| 字段 | 类型 | 描述 | +| ---- | ---- | ---- | +| account_type | string | 账户类型标识 | +| asset_timestamp | datetime | 资产数据快照时间 | +| cash_buy_power | string | 可用买入力（现金） | +| cash_list | object[] | 按货币分列的现金余额 | +| crypto_list | object[] | 加密货币持仓（含数量和估值） | diff --git a/docs/zh-CN/docs/trade/asset/us_realized_pl.md b/docs/zh-CN/docs/trade/asset/us_realized_pl.md index 1ad08ca8..c96d7fd3 100644 --- a/docs/zh-CN/docs/trade/asset/us_realized_pl.md +++ b/docs/zh-CN/docs/trade/asset/us_realized_pl.md @@ -132,3 +132,19 @@ fmt.Printf("%+v\n", resp) + +## 响应 + +返回 `USRealizedPL` ，包含以下字段： + +| 字段 | 类型 | 描述 | +| ---- | ---- | ---- | +| realized_pl_list | USRealizedPLEntry[] | 按资产类别分列的盈亏明细 | + +Each `USRealizedPLEntry` contains: + +| 字段 | 类型 | 描述 | +| ---- | ---- | ---- | +| category | int | 资产类别（1=股票，2=期权，3=加密货币） | +| currency | string | 货币代码，如 `USD` | +| metrics | object[] | 不同时期的盈亏指标 | diff --git a/docs/zh-CN/docs/trade/order/us_order_detail.md b/docs/zh-CN/docs/trade/order/us_order_detail.md index d33e5c28..b4d1bf05 100644 --- a/docs/zh-CN/docs/trade/order/us_order_detail.md +++ b/docs/zh-CN/docs/trade/order/us_order_detail.md @@ -129,3 +129,13 @@ fmt.Printf("%+v\n", resp) + +## 响应 + +返回 `USOrderDetailResponse` ，包含以下字段： + +| 字段 | 类型 | 描述 | +| ---- | ---- | ---- | +| order | object | 含状态及成交详情的完整委托对象 | +| order_histories | object[] | 该委托的历史状态变更记录 | +| current_attached_order | object | 关联子委托（如括号单/OCO），如有 | diff --git a/docs/zh-CN/docs/trade/order/us_query_orders.md b/docs/zh-CN/docs/trade/order/us_query_orders.md index 14455706..7f8e6c3f 100644 --- a/docs/zh-CN/docs/trade/order/us_query_orders.md +++ b/docs/zh-CN/docs/trade/order/us_query_orders.md @@ -136,3 +136,14 @@ fmt.Printf("%+v\n", resp) + +## 响应 + +返回 `QueryUSOrdersResponse` ，包含以下字段： + +| 字段 | 类型 | 描述 | +| ---- | ---- | ---- | +| orders | USOrder[] | 符合筛选条件的委托列表 | +| total_count | int | 满足条件的委托总数 | + +Each `USOrder` contains: `order_id`, symbol, side, status, quantity, price, executed quantity/price, and creation timestamp. diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md index 26722f5f..8a8976b6 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md @@ -152,3 +152,7 @@ func main() { + +## 響應 + +返回一個結構靈活的 JSON 對象 包含分析師一致預期數據 — revenue and EPS forecasts, target price distribution, and buy/hold/sell rating breakdown. 具體字段因數據可用性而異。 可通過 CLI 使用 `--format json` 或打印原始響應查看數據結構。 diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md b/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md index ca879164..f1d1dad0 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md @@ -151,3 +151,15 @@ func main() { + +## 響應 + +返回 `UsCompanyDividends` ，包含以下字段： + +| 字段 | 類型 | 描述 | +| ---- | ---- | ---- | +| dividend_ttm | string | 過去 12 個月每股股息 | +| dividend_yield_ttm | string | TTM 股息率（%） | +| payouts | string | 過去一年的派息次數 | +| currency | string | 貨幣代碼，如 `USD` | +| items | object[] | 逐筆分紅支付記錄 | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md index 55e2088b..498863bf 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md @@ -151,3 +151,15 @@ func main() { + +## 響應 + +返回 `UsCompanyOverview` ，包含以下字段： + +| 字段 | 類型 | 描述 | +| ---- | ---- | ---- | +| intro | string | 公司簡介 | +| market_cap | string | 市值 | +| ccy_symbol | string | 貨幣符號 | +| top_rank_tags | string[] | 排名標籤列表 | +| detail_url | string | 公司詳情頁連結 | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md index 27b94db8..befdae14 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -151,3 +151,15 @@ func main() { + +## 響應 + +返回 `UsETFDividendInfo` ，包含以下字段： + +| 字段 | 類型 | 描述 | +| ---- | ---- | ---- | +| dividend_ttm | string | 過去 12 個月每股股息 | +| dividend_yield_ttm | string | TTM 股息率（%） | +| dividend_freq | string | 派息頻率（如 `Quarterly`） | +| currency | string | 貨幣代碼，如 `USD` | +| fiscal_year_info | object[] | 按財年分列的年度分紅明細 | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md b/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md index 422c80e0..a7f8ef0d 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md @@ -152,3 +152,12 @@ func main() { + +## 響應 + +返回 `UsETFFileList` ，包含以下字段： + +| 字段 | 類型 | 描述 | +| ---- | ---- | ---- | +| files | object[] | ETF 文件列表 | +| files[].name | string | 文件名稱 (e.g. `iShares Core S&P 500 ETF Prospectus`) | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md index 186bafaa..f75017e7 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md @@ -152,3 +152,7 @@ func main() { + +## 響應 + +返回一個結構靈活的 JSON 對象 其結構因公司和報告週期而異。 對象包含財務摘要數據 including income, balance sheet, and cash flow indicators. 可通過 CLI 使用 `--format json` 或打印原始響應來查看具體標的的數據結構。 diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md index b94fd6b9..80ed90da 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -154,3 +154,15 @@ func main() { + +## 響應 + +返回 `UsFinancialStatement` ，包含以下字段： + +| 字段 | 類型 | 描述 | +| ---- | ---- | ---- | +| revenue | string | 總營收 | +| net_income | string | 淨利潤 | +| net_margin | string | 淨利潤率 | +| periods | object[] | 包含逐行數據的報告期列表 | +| currency | string | 貨幣代碼，如 `USD` | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md index f6cfb83e..808b3104 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -152,3 +152,7 @@ func main() { + +## 響應 + +返回一個結構靈活的 JSON 對象 包含關鍵財務指標 (revenue, net income, EPS, margins, growth rates) for the requested period. 具體字段因公司而異。 可通過 CLI 使用 `--format json` 或打印原始響應查看數據結構。 diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md index 8fec7436..f6ce7a9f 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md @@ -151,3 +151,15 @@ func main() { + +## 響應 + +返回 `UsValuationOverview` ，包含以下字段： + +| 字段 | 類型 | 描述 | +| ---- | ---- | ---- | +| indicator | string | 估值指標名稱 | +| current_indicator | object | 當前估值指標數據 | +| range | int | 歷史百分位區間 | +| date | string | 估值日期 | +| ai_summary | string | AI 生成的估值摘要 | diff --git a/docs/zh-HK/docs/trade/asset/us_asset_overview.md b/docs/zh-HK/docs/trade/asset/us_asset_overview.md index 8fc29340..dbc12488 100644 --- a/docs/zh-HK/docs/trade/asset/us_asset_overview.md +++ b/docs/zh-HK/docs/trade/asset/us_asset_overview.md @@ -126,3 +126,15 @@ fmt.Printf("%+v\n", resp) + +## 響應 + +返回 `USAssetOverview` ，包含以下字段： + +| 字段 | 類型 | 描述 | +| ---- | ---- | ---- | +| account_type | string | 賬戶類型標識 | +| asset_timestamp | datetime | 資產數據快照時間 | +| cash_buy_power | string | 可用買入力（現金） | +| cash_list | object[] | 按貨幣分列的現金餘額 | +| crypto_list | object[] | 加密貨幣持倉（含數量和估值） | diff --git a/docs/zh-HK/docs/trade/asset/us_realized_pl.md b/docs/zh-HK/docs/trade/asset/us_realized_pl.md index 3df1b361..6ec74cdc 100644 --- a/docs/zh-HK/docs/trade/asset/us_realized_pl.md +++ b/docs/zh-HK/docs/trade/asset/us_realized_pl.md @@ -132,3 +132,19 @@ fmt.Printf("%+v\n", resp) + +## 響應 + +返回 `USRealizedPL` ，包含以下字段： + +| 字段 | 類型 | 描述 | +| ---- | ---- | ---- | +| realized_pl_list | USRealizedPLEntry[] | 按資產類別分列的盈虧明細 | + +Each `USRealizedPLEntry` contains: + +| 字段 | 類型 | 描述 | +| ---- | ---- | ---- | +| category | int | 資產類別（1=股票，2=期權，3=加密貨幣） | +| currency | string | 貨幣代碼，如 `USD` | +| metrics | object[] | 不同時期的盈虧指標 | diff --git a/docs/zh-HK/docs/trade/order/us_order_detail.md b/docs/zh-HK/docs/trade/order/us_order_detail.md index 89f92a22..e1cf367b 100644 --- a/docs/zh-HK/docs/trade/order/us_order_detail.md +++ b/docs/zh-HK/docs/trade/order/us_order_detail.md @@ -129,3 +129,13 @@ fmt.Printf("%+v\n", resp) + +## 響應 + +返回 `USOrderDetailResponse` ，包含以下字段： + +| 字段 | 類型 | 描述 | +| ---- | ---- | ---- | +| order | object | 含狀態及成交詳情的完整委託對象 | +| order_histories | object[] | 該委託的歷史狀態變更記錄 | +| current_attached_order | object | 關聯子委託（如括號單/OCO），如有 | diff --git a/docs/zh-HK/docs/trade/order/us_query_orders.md b/docs/zh-HK/docs/trade/order/us_query_orders.md index 765978c9..85c79218 100644 --- a/docs/zh-HK/docs/trade/order/us_query_orders.md +++ b/docs/zh-HK/docs/trade/order/us_query_orders.md @@ -136,3 +136,14 @@ fmt.Printf("%+v\n", resp) + +## 響應 + +返回 `QueryUSOrdersResponse` ，包含以下字段： + +| 字段 | 類型 | 描述 | +| ---- | ---- | ---- | +| orders | USOrder[] | 符合篩選條件的委託列表 | +| total_count | int | 滿足條件的委託總數 | + +Each `USOrder` contains: `order_id`, symbol, side, status, quantity, price, executed quantity/price, and creation timestamp. From 5af89fde483b0623c57163f6cbf4b0c9b757662a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 17:02:39 +0800 Subject: [PATCH 28/51] fix(autocorrect): replace mixed-language response descriptions with pure Chinese --- docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md | 2 +- .../zh-CN/docs/fundamental/fundamental/us_financial_overview.md | 2 +- .../docs/fundamental/fundamental/us_key_financial_metrics.md | 2 +- docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md | 2 +- .../zh-HK/docs/fundamental/fundamental/us_financial_overview.md | 2 +- .../docs/fundamental/fundamental/us_key_financial_metrics.md | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md index 434f4b68..ee661bc1 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md @@ -155,4 +155,4 @@ func main() { ## 响应 -返回一个结构灵活的 JSON 对象 包含分析师一致预期数据 — revenue and EPS forecasts, target price distribution, and buy/hold/sell rating breakdown. 具体字段因数据可用性而异。 可通过 CLI 使用 `--format json` 或打印原始响应查看数据结构。 +返回结构灵活的 JSON 对象，包含分析师一致预期数据（营收和 EPS 预测、目标价分布、买入/持有/卖出评级分布）。具体字段因数据可用性而异。可通过 CLI 使用 `--format json` 或打印原始响应查看数据结构。 diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md index 62dd8d3a..1cdd14f6 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md @@ -155,4 +155,4 @@ func main() { ## 响应 -返回一个结构灵活的 JSON 对象 其结构因公司和报告周期而异。 对象包含财务摘要数据 including income, balance sheet, and cash flow indicators. 可通过 CLI 使用 `--format json` 或打印原始响应来查看具体标的的数据结构。 +返回结构灵活的 JSON 对象，内容因公司和报告周期而异，包含损益、资产负债和现金流摘要数据。可通过 CLI 使用 `--format json` 或打印原始响应查看具体标的的数据结构。 diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md index 30c8b018..c433b5d4 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -155,4 +155,4 @@ func main() { ## 响应 -返回一个结构灵活的 JSON 对象 包含关键财务指标 (revenue, net income, EPS, margins, growth rates) for the requested period. 具体字段因公司而异。 可通过 CLI 使用 `--format json` 或打印原始响应查看数据结构。 +返回结构灵活的 JSON 对象，包含关键财务指标（营收、净利润、EPS、利润率和增长率）。具体字段因公司而异。可通过 CLI 使用 `--format json` 或打印原始响应查看数据结构。 diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md index 8a8976b6..86b238e8 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md @@ -155,4 +155,4 @@ func main() { ## 響應 -返回一個結構靈活的 JSON 對象 包含分析師一致預期數據 — revenue and EPS forecasts, target price distribution, and buy/hold/sell rating breakdown. 具體字段因數據可用性而異。 可通過 CLI 使用 `--format json` 或打印原始響應查看數據結構。 +返回結構靈活的 JSON 對象，包含分析師一致預期數據（營收和 EPS 預測、目標價分佈、買入/持有/賣出評級分佈）。具體字段因數據可用性而異。可通過 CLI 使用 `--format json` 或打印原始響應查看數據結構。 diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md index f75017e7..c51b2c71 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md @@ -155,4 +155,4 @@ func main() { ## 響應 -返回一個結構靈活的 JSON 對象 其結構因公司和報告週期而異。 對象包含財務摘要數據 including income, balance sheet, and cash flow indicators. 可通過 CLI 使用 `--format json` 或打印原始響應來查看具體標的的數據結構。 +返回結構靈活的 JSON 對象，內容因公司和報告週期而異，包含損益、資產負債和現金流摘要數據。可通過 CLI 使用 `--format json` 或打印原始響應查看具體標的的數據結構。 diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md index 808b3104..87d0a1d2 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -155,4 +155,4 @@ func main() { ## 響應 -返回一個結構靈活的 JSON 對象 包含關鍵財務指標 (revenue, net income, EPS, margins, growth rates) for the requested period. 具體字段因公司而異。 可通過 CLI 使用 `--format json` 或打印原始響應查看數據結構。 +返回結構靈活的 JSON 對象，包含關鍵財務指標（營收、淨利潤、EPS、利潤率和增長率）。具體字段因公司而異。可通過 CLI 使用 `--format json` 或打印原始響應查看數據結構。 From 3c121c038815ce387f5387f6df3111bae9258457 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 17:04:58 +0800 Subject: [PATCH 29/51] fix(docs): correct Node.js and Java parameter syntax in US SDK docs (positional args) --- docs/en/docs/fundamental/fundamental/us_analyst_consensus.md | 4 ++-- docs/en/docs/fundamental/fundamental/us_financial_overview.md | 4 ++-- .../docs/fundamental/fundamental/us_financial_statement_v3.md | 4 ++-- .../docs/fundamental/fundamental/us_key_financial_metrics.md | 4 ++-- docs/en/docs/trade/asset/us_realized_pl.md | 4 ++-- .../docs/fundamental/fundamental/us_analyst_consensus.md | 4 ++-- .../docs/fundamental/fundamental/us_financial_overview.md | 4 ++-- .../docs/fundamental/fundamental/us_financial_statement_v3.md | 4 ++-- .../docs/fundamental/fundamental/us_key_financial_metrics.md | 4 ++-- docs/zh-CN/docs/trade/asset/us_realized_pl.md | 4 ++-- .../docs/fundamental/fundamental/us_analyst_consensus.md | 4 ++-- .../docs/fundamental/fundamental/us_financial_overview.md | 4 ++-- .../docs/fundamental/fundamental/us_financial_statement_v3.md | 4 ++-- .../docs/fundamental/fundamental/us_key_financial_metrics.md | 4 ++-- docs/zh-HK/docs/trade/asset/us_realized_pl.md | 4 ++-- 15 files changed, 30 insertions(+), 30 deletions(-) diff --git a/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md index f675c4ea..5f4033a7 100644 --- a/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md @@ -76,7 +76,7 @@ async function main() { }) const config = Config.fromOAuth(oauth) const ctx = FundamentalContext.new(config) - const resp = await ctx.usAnalystConsensus("AAPL.US", report="annual") + const resp = await ctx.usAnalystConsensus("AAPL.US", "annual") console.log(resp) } main().catch(console.error) @@ -94,7 +94,7 @@ class Main { try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); Config config = Config.fromOAuth(oauth); FundamentalContext ctx = FundamentalContext.create(config)) { - var resp = ctx.getUsAnalystConsensus("AAPL.US", report="annual").get(); + var resp = ctx.getUsAnalystConsensus("AAPL.US", "annual").get(); System.out.println(resp); } } diff --git a/docs/en/docs/fundamental/fundamental/us_financial_overview.md b/docs/en/docs/fundamental/fundamental/us_financial_overview.md index 1d72001e..e730f28a 100644 --- a/docs/en/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/en/docs/fundamental/fundamental/us_financial_overview.md @@ -76,7 +76,7 @@ async function main() { }) const config = Config.fromOAuth(oauth) const ctx = FundamentalContext.new(config) - const resp = await ctx.usFinancialOverview("AAPL.US", report="annual") + const resp = await ctx.usFinancialOverview("AAPL.US", "annual") console.log(resp) } main().catch(console.error) @@ -94,7 +94,7 @@ class Main { try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); Config config = Config.fromOAuth(oauth); FundamentalContext ctx = FundamentalContext.create(config)) { - var resp = ctx.getUsFinancialOverview("AAPL.US", report="annual").get(); + var resp = ctx.getUsFinancialOverview("AAPL.US", "annual").get(); System.out.println(resp); } } diff --git a/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md index 33d96d3a..e32b0799 100644 --- a/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -78,7 +78,7 @@ async function main() { }) const config = Config.fromOAuth(oauth) const ctx = FundamentalContext.new(config) - const resp = await ctx.usFinancialStatementV3("AAPL.US", kind="IS", report="annual") + const resp = await ctx.usFinancialStatementV3("AAPL.US", "IS", "annual") console.log(resp) } main().catch(console.error) @@ -96,7 +96,7 @@ class Main { try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); Config config = Config.fromOAuth(oauth); FundamentalContext ctx = FundamentalContext.create(config)) { - var resp = ctx.getUsFinancialStatementV3("AAPL.US", kind="IS", report="annual").get(); + var resp = ctx.getUsFinancialStatementV3("AAPL.US", "IS", "annual").get(); System.out.println(resp); } } diff --git a/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md index a55b782d..645cb037 100644 --- a/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -76,7 +76,7 @@ async function main() { }) const config = Config.fromOAuth(oauth) const ctx = FundamentalContext.new(config) - const resp = await ctx.usKeyFinancialMetrics("AAPL.US", report="annual") + const resp = await ctx.usKeyFinancialMetrics("AAPL.US", "annual") console.log(resp) } main().catch(console.error) @@ -94,7 +94,7 @@ class Main { try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); Config config = Config.fromOAuth(oauth); FundamentalContext ctx = FundamentalContext.create(config)) { - var resp = ctx.getUsKeyFinancialMetrics("AAPL.US", report="annual").get(); + var resp = ctx.getUsKeyFinancialMetrics("AAPL.US", "annual").get(); System.out.println(resp); } } diff --git a/docs/en/docs/trade/asset/us_realized_pl.md b/docs/en/docs/trade/asset/us_realized_pl.md index a338d38c..ac62e472 100644 --- a/docs/en/docs/trade/asset/us_realized_pl.md +++ b/docs/en/docs/trade/asset/us_realized_pl.md @@ -77,7 +77,7 @@ async function main() { }) const config = Config.fromOAuth(oauth) const ctx = TradeContext.new(config) - const resp = await ctx.usRealizedPl("USD", category="STOCK") + const resp = await ctx.usRealizedPl("USD", "STOCK") console.log(resp) } main().catch(console.error) @@ -95,7 +95,7 @@ class Main { try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); Config config = Config.fromOAuth(oauth); TradeContext ctx = TradeContext.create(config)) { - var resp = ctx.getUsRealizedPl("USD", category="STOCK").get(); + var resp = ctx.getUsRealizedPl("USD", "STOCK").get(); System.out.println(resp); } } diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md index ee661bc1..d8127522 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md @@ -76,7 +76,7 @@ async function main() { }) const config = Config.fromOAuth(oauth) const ctx = FundamentalContext.new(config) - const resp = await ctx.usAnalystConsensus("AAPL.US", report="annual") + const resp = await ctx.usAnalystConsensus("AAPL.US", "annual") console.log(resp) } main().catch(console.error) @@ -94,7 +94,7 @@ class Main { try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); Config config = Config.fromOAuth(oauth); FundamentalContext ctx = FundamentalContext.create(config)) { - var resp = ctx.getUsAnalystConsensus("AAPL.US", report="annual").get(); + var resp = ctx.getUsAnalystConsensus("AAPL.US", "annual").get(); System.out.println(resp); } } diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md index 1cdd14f6..17cb3eae 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md @@ -76,7 +76,7 @@ async function main() { }) const config = Config.fromOAuth(oauth) const ctx = FundamentalContext.new(config) - const resp = await ctx.usFinancialOverview("AAPL.US", report="annual") + const resp = await ctx.usFinancialOverview("AAPL.US", "annual") console.log(resp) } main().catch(console.error) @@ -94,7 +94,7 @@ class Main { try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); Config config = Config.fromOAuth(oauth); FundamentalContext ctx = FundamentalContext.create(config)) { - var resp = ctx.getUsFinancialOverview("AAPL.US", report="annual").get(); + var resp = ctx.getUsFinancialOverview("AAPL.US", "annual").get(); System.out.println(resp); } } diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md index 2ff55084..320a4d27 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -78,7 +78,7 @@ async function main() { }) const config = Config.fromOAuth(oauth) const ctx = FundamentalContext.new(config) - const resp = await ctx.usFinancialStatementV3("AAPL.US", kind="IS", report="annual") + const resp = await ctx.usFinancialStatementV3("AAPL.US", "IS", "annual") console.log(resp) } main().catch(console.error) @@ -96,7 +96,7 @@ class Main { try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); Config config = Config.fromOAuth(oauth); FundamentalContext ctx = FundamentalContext.create(config)) { - var resp = ctx.getUsFinancialStatementV3("AAPL.US", kind="IS", report="annual").get(); + var resp = ctx.getUsFinancialStatementV3("AAPL.US", "IS", "annual").get(); System.out.println(resp); } } diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md index c433b5d4..d0eef583 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -76,7 +76,7 @@ async function main() { }) const config = Config.fromOAuth(oauth) const ctx = FundamentalContext.new(config) - const resp = await ctx.usKeyFinancialMetrics("AAPL.US", report="annual") + const resp = await ctx.usKeyFinancialMetrics("AAPL.US", "annual") console.log(resp) } main().catch(console.error) @@ -94,7 +94,7 @@ class Main { try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); Config config = Config.fromOAuth(oauth); FundamentalContext ctx = FundamentalContext.create(config)) { - var resp = ctx.getUsKeyFinancialMetrics("AAPL.US", report="annual").get(); + var resp = ctx.getUsKeyFinancialMetrics("AAPL.US", "annual").get(); System.out.println(resp); } } diff --git a/docs/zh-CN/docs/trade/asset/us_realized_pl.md b/docs/zh-CN/docs/trade/asset/us_realized_pl.md index c96d7fd3..6ffe419f 100644 --- a/docs/zh-CN/docs/trade/asset/us_realized_pl.md +++ b/docs/zh-CN/docs/trade/asset/us_realized_pl.md @@ -77,7 +77,7 @@ async function main() { }) const config = Config.fromOAuth(oauth) const ctx = TradeContext.new(config) - const resp = await ctx.usRealizedPl("USD", category="STOCK") + const resp = await ctx.usRealizedPl("USD", "STOCK") console.log(resp) } main().catch(console.error) @@ -95,7 +95,7 @@ class Main { try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); Config config = Config.fromOAuth(oauth); TradeContext ctx = TradeContext.create(config)) { - var resp = ctx.getUsRealizedPl("USD", category="STOCK").get(); + var resp = ctx.getUsRealizedPl("USD", "STOCK").get(); System.out.println(resp); } } diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md index 86b238e8..d3c0d772 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md @@ -76,7 +76,7 @@ async function main() { }) const config = Config.fromOAuth(oauth) const ctx = FundamentalContext.new(config) - const resp = await ctx.usAnalystConsensus("AAPL.US", report="annual") + const resp = await ctx.usAnalystConsensus("AAPL.US", "annual") console.log(resp) } main().catch(console.error) @@ -94,7 +94,7 @@ class Main { try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); Config config = Config.fromOAuth(oauth); FundamentalContext ctx = FundamentalContext.create(config)) { - var resp = ctx.getUsAnalystConsensus("AAPL.US", report="annual").get(); + var resp = ctx.getUsAnalystConsensus("AAPL.US", "annual").get(); System.out.println(resp); } } diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md index c51b2c71..8e540f7f 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md @@ -76,7 +76,7 @@ async function main() { }) const config = Config.fromOAuth(oauth) const ctx = FundamentalContext.new(config) - const resp = await ctx.usFinancialOverview("AAPL.US", report="annual") + const resp = await ctx.usFinancialOverview("AAPL.US", "annual") console.log(resp) } main().catch(console.error) @@ -94,7 +94,7 @@ class Main { try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); Config config = Config.fromOAuth(oauth); FundamentalContext ctx = FundamentalContext.create(config)) { - var resp = ctx.getUsFinancialOverview("AAPL.US", report="annual").get(); + var resp = ctx.getUsFinancialOverview("AAPL.US", "annual").get(); System.out.println(resp); } } diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md index 80ed90da..70a3c85e 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -78,7 +78,7 @@ async function main() { }) const config = Config.fromOAuth(oauth) const ctx = FundamentalContext.new(config) - const resp = await ctx.usFinancialStatementV3("AAPL.US", kind="IS", report="annual") + const resp = await ctx.usFinancialStatementV3("AAPL.US", "IS", "annual") console.log(resp) } main().catch(console.error) @@ -96,7 +96,7 @@ class Main { try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); Config config = Config.fromOAuth(oauth); FundamentalContext ctx = FundamentalContext.create(config)) { - var resp = ctx.getUsFinancialStatementV3("AAPL.US", kind="IS", report="annual").get(); + var resp = ctx.getUsFinancialStatementV3("AAPL.US", "IS", "annual").get(); System.out.println(resp); } } diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md index 87d0a1d2..93813a1a 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -76,7 +76,7 @@ async function main() { }) const config = Config.fromOAuth(oauth) const ctx = FundamentalContext.new(config) - const resp = await ctx.usKeyFinancialMetrics("AAPL.US", report="annual") + const resp = await ctx.usKeyFinancialMetrics("AAPL.US", "annual") console.log(resp) } main().catch(console.error) @@ -94,7 +94,7 @@ class Main { try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); Config config = Config.fromOAuth(oauth); FundamentalContext ctx = FundamentalContext.create(config)) { - var resp = ctx.getUsKeyFinancialMetrics("AAPL.US", report="annual").get(); + var resp = ctx.getUsKeyFinancialMetrics("AAPL.US", "annual").get(); System.out.println(resp); } } diff --git a/docs/zh-HK/docs/trade/asset/us_realized_pl.md b/docs/zh-HK/docs/trade/asset/us_realized_pl.md index 6ec74cdc..5d886bf3 100644 --- a/docs/zh-HK/docs/trade/asset/us_realized_pl.md +++ b/docs/zh-HK/docs/trade/asset/us_realized_pl.md @@ -77,7 +77,7 @@ async function main() { }) const config = Config.fromOAuth(oauth) const ctx = TradeContext.new(config) - const resp = await ctx.usRealizedPl("USD", category="STOCK") + const resp = await ctx.usRealizedPl("USD", "STOCK") console.log(resp) } main().catch(console.error) @@ -95,7 +95,7 @@ class Main { try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); Config config = Config.fromOAuth(oauth); TradeContext ctx = TradeContext.create(config)) { - var resp = ctx.getUsRealizedPl("USD", category="STOCK").get(); + var resp = ctx.getUsRealizedPl("USD", "STOCK").get(); System.out.println(resp); } } From 9fde3379f0073c33f4e5dcfe2689c9ae8d7d8bec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 17:12:16 +0800 Subject: [PATCH 30/51] docs: complete Response sections for 8 US SDK docs with nested type details (3 langs) --- .../fundamental/us_company_dividends.md | 15 +++++++--- .../fundamental/us_etf_dividend_info.md | 15 ++++++++-- .../fundamental/us_financial_statement_v3.md | 12 ++++++-- .../docs/quote/stocks/us_crypto_overview.md | 11 +++++--- docs/en/docs/trade/asset/us_asset_overview.md | 24 +++++++++++++--- docs/en/docs/trade/asset/us_realized_pl.md | 15 ++++++++-- docs/en/docs/trade/order/us_order_detail.md | 28 +++++++++++++++++-- docs/en/docs/trade/order/us_query_orders.md | 15 +++++++++- .../fundamental/us_company_dividends.md | 11 ++++++-- .../fundamental/us_etf_dividend_info.md | 11 +++++++- .../fundamental/us_financial_statement_v3.md | 10 ++++++- .../docs/quote/stocks/us_crypto_overview.md | 16 +++++++++++ .../docs/trade/asset/us_asset_overview.md | 24 +++++++++++++--- docs/zh-CN/docs/trade/asset/us_realized_pl.md | 15 ++++++++-- .../zh-CN/docs/trade/order/us_order_detail.md | 28 +++++++++++++++++-- .../zh-CN/docs/trade/order/us_query_orders.md | 15 +++++++++- .../fundamental/us_company_dividends.md | 11 ++++++-- .../fundamental/us_etf_dividend_info.md | 11 +++++++- .../fundamental/us_financial_statement_v3.md | 10 ++++++- .../docs/quote/stocks/us_crypto_overview.md | 16 +++++++++++ .../docs/trade/asset/us_asset_overview.md | 24 +++++++++++++--- docs/zh-HK/docs/trade/asset/us_realized_pl.md | 15 ++++++++-- .../zh-HK/docs/trade/order/us_order_detail.md | 28 +++++++++++++++++-- .../zh-HK/docs/trade/order/us_query_orders.md | 15 +++++++++- 24 files changed, 341 insertions(+), 54 deletions(-) diff --git a/docs/en/docs/fundamental/fundamental/us_company_dividends.md b/docs/en/docs/fundamental/fundamental/us_company_dividends.md index 142e324d..8fb2a682 100644 --- a/docs/en/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/en/docs/fundamental/fundamental/us_company_dividends.md @@ -152,14 +152,21 @@ func main() { + ## Response Returns `UsCompanyDividends` with the following fields: | Field | Type | Description | | ----- | ---- | ----------- | -| dividend_ttm | string | Trailing twelve-month dividend per share | +| dividend_ttm | string | TTM dividend per share | | dividend_yield_ttm | string | TTM dividend yield (%) | -| payouts | string | Number of dividend payouts in the past year | -| currency | string | Currency code, e.g. `USD` | -| items | object[] | Individual dividend payment records | +| payouts | string | Number of payouts in past year | +| currency | string | Currency code (e.g. `USD`) | +| items | USDividendItem[] | Individual dividend records | + +Each `USDividendItem` contains: + +| Field | Type | Description | +| ----- | ---- | ----------- | +| dividend | string | Dividend amount per share | diff --git a/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md index 8607ae19..59fdff7a 100644 --- a/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -152,14 +152,23 @@ func main() { + ## Response Returns `UsETFDividendInfo` with the following fields: | Field | Type | Description | | ----- | ---- | ----------- | -| dividend_ttm | string | Trailing twelve-month dividend per share | +| dividend_ttm | string | TTM dividend per share | | dividend_yield_ttm | string | TTM dividend yield (%) | | dividend_freq | string | Payout frequency (e.g. `Quarterly`) | -| currency | string | Currency code, e.g. `USD` | -| fiscal_year_info | object[] | Annual dividend breakdown by fiscal year | +| currency | string | Currency code (e.g. `USD`) | +| fiscal_year_info | FiscalYearDividend[] | Annual dividend breakdown by fiscal year | + +Each `FiscalYearDividend` contains: + +| Field | Type | Description | +| ----- | ---- | ----------- | +| year | string | Fiscal year | +| total_dividend | string | Total annual dividend | +| records | object[] | Individual payment records | diff --git a/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md index e32b0799..43585cbb 100644 --- a/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -155,6 +155,7 @@ func main() { + ## Response Returns `UsFinancialStatement` with the following fields: @@ -164,5 +165,12 @@ Returns `UsFinancialStatement` with the following fields: | revenue | string | Total revenue | | net_income | string | Net income | | net_margin | string | Net profit margin | -| periods | object[] | List of reporting periods with line-item values | -| currency | string | Currency code, e.g. `USD` | +| periods | FinancialPeriod[] | Reporting periods with line-item values | +| currency | string | Currency code (e.g. `USD`) | + +Each `FinancialPeriod` contains: + +| Field | Type | Description | +| ----- | ---- | ----------- | +| date | string | Period date | +| values | map[string]any | Financial line items keyed by metric name | diff --git a/docs/en/docs/quote/stocks/us_crypto_overview.md b/docs/en/docs/quote/stocks/us_crypto_overview.md index ce2f5d16..5a9513a8 100644 --- a/docs/en/docs/quote/stocks/us_crypto_overview.md +++ b/docs/en/docs/quote/stocks/us_crypto_overview.md @@ -129,15 +129,18 @@ fmt.Printf("%+v\n", resp) -## Response Fields + +## Response + +Returns `CryptoOverview` with the following fields: | Field | Type | Description | | ----- | ---- | ----------- | -| symbol | string | Trading-pair symbol | +| symbol | string | Trading-pair symbol (e.g. `DOGEUSD.BKKT`) | | name | string | Asset name | | ticker | string | Short ticker | -| base_asset | string | Base asset code | -| currency | string | Quote currency | +| base_asset | string | Base asset code (e.g. `DOGE`) | +| currency | string | Quote currency (e.g. `USD`) | | all_time_high | string | All-time high price | | all_time_high_date | string | Date of all-time high | | all_time_low | string | All-time low price | diff --git a/docs/en/docs/trade/asset/us_asset_overview.md b/docs/en/docs/trade/asset/us_asset_overview.md index 4d57a520..8f36d253 100644 --- a/docs/en/docs/trade/asset/us_asset_overview.md +++ b/docs/en/docs/trade/asset/us_asset_overview.md @@ -127,6 +127,7 @@ fmt.Printf("%+v\n", resp) + ## Response Returns `USAssetOverview` with the following fields: @@ -134,7 +135,22 @@ Returns `USAssetOverview` with the following fields: | Field | Type | Description | | ----- | ---- | ----------- | | account_type | string | Account type identifier | -| asset_timestamp | datetime | Snapshot time of the asset data | -| cash_buy_power | string | Available buying power (cash) | -| cash_list | object[] | Cash balances by currency | -| crypto_list | object[] | Crypto holdings with quantity and value | +| asset_timestamp | int64 | Snapshot time (Unix seconds) | +| cash_buy_power | string | Available buying power | +| cash_list | USCashEntry[] | Cash balances by currency | +| stock_list | USStockEntry[] | Stock positions | +| crypto_list | USCryptoEntry[] | Crypto positions | + +Each `USCashEntry` contains: + +| Field | Type | Description | +| ----- | ---- | ----------- | +| currency | string | Currency code (e.g. `USD`) | +| amount | string | Cash amount | + +Each `USCryptoEntry` contains: + +| Field | Type | Description | +| ----- | ---- | ----------- | +| symbol | string | Crypto trading-pair symbol | +| quantity | string | Quantity held | diff --git a/docs/en/docs/trade/asset/us_realized_pl.md b/docs/en/docs/trade/asset/us_realized_pl.md index ac62e472..20783883 100644 --- a/docs/en/docs/trade/asset/us_realized_pl.md +++ b/docs/en/docs/trade/asset/us_realized_pl.md @@ -133,6 +133,7 @@ fmt.Printf("%+v\n", resp) + ## Response Returns `USRealizedPL` with the following fields: @@ -145,6 +146,14 @@ Each `USRealizedPLEntry` contains: | Field | Type | Description | | ----- | ---- | ----------- | -| category | int | Asset category (1=stock, 2=option, 3=crypto) | -| currency | string | Currency code, e.g. `USD` | -| metrics | object[] | P&L metrics for different time periods | +| category | int | Asset category: `1`=stock, `2`=option, `3`=crypto | +| currency | string | Currency code (e.g. `USD`) | +| metrics | USRealizedPLMetric[] | P&L metrics for different time periods | + +Each `USRealizedPLMetric` contains: + +| Field | Type | Description | +| ----- | ---- | ----------- | +| amount | string | Realized P&L amount | +| period | int | Time period | +| rate | string | Return rate (%) | diff --git a/docs/en/docs/trade/order/us_order_detail.md b/docs/en/docs/trade/order/us_order_detail.md index 1db71f4a..59bb5db5 100644 --- a/docs/en/docs/trade/order/us_order_detail.md +++ b/docs/en/docs/trade/order/us_order_detail.md @@ -130,12 +130,34 @@ fmt.Printf("%+v\n", resp) + ## Response Returns `USOrderDetailResponse` with the following fields: | Field | Type | Description | | ----- | ---- | ----------- | -| order | object | Full order object with status and fill details | -| order_histories | object[] | Historical status changes for the order | -| current_attached_order | object | Attached child order (e.g. bracket/OCO), if any | +| order | USOrder | Full order detail with status and fill information | +| order_histories | USOrderHistory[] | Historical status changes for the order | +| current_attached_order | USOrder \| null | Attached child order (bracket/OCO), null if none | + +Each `USOrder` contains: + +| Field | Type | Description | +| ----- | ---- | ----------- | +| order_id | string | Unique order ID | +| symbol | string | Trading symbol (e.g. `AAPL.US`) | +| side | string | `Buy` or `Sell` | +| status | string | Order status | +| qty | string | Order quantity | +| price | string | Order price | +| executed_qty | string | Executed quantity | +| executed_price | string | Executed price | +| created_at | int64 | Creation time (Unix seconds) | + +Each `USOrderHistory` contains: + +| Field | Type | Description | +| ----- | ---- | ----------- | +| status | string | Order status at this point | +| done_at | int64 | Timestamp (Unix seconds) | diff --git a/docs/en/docs/trade/order/us_query_orders.md b/docs/en/docs/trade/order/us_query_orders.md index bbb15d55..48899db6 100644 --- a/docs/en/docs/trade/order/us_query_orders.md +++ b/docs/en/docs/trade/order/us_query_orders.md @@ -137,6 +137,7 @@ fmt.Printf("%+v\n", resp) + ## Response Returns `QueryUSOrdersResponse` with the following fields: @@ -146,4 +147,16 @@ Returns `QueryUSOrdersResponse` with the following fields: | orders | USOrder[] | List of orders matching the filter | | total_count | int | Total number of matching orders | -Each `USOrder` contains: `order_id`, symbol, side, status, quantity, price, executed quantity/price, and creation timestamp. +Each `USOrder` contains: + +| Field | Type | Description | +| ----- | ---- | ----------- | +| order_id | string | Unique order ID | +| symbol | string | Trading symbol (e.g. `AAPL.US`) | +| side | string | `Buy` or `Sell` | +| status | string | Order status | +| qty | string | Order quantity | +| price | string | Order price | +| executed_qty | string | Executed quantity | +| executed_price | string | Executed price | +| created_at | int64 | Creation time (Unix seconds) | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md b/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md index 545fd46b..fb64418f 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md @@ -152,6 +152,7 @@ func main() { + ## 响应 返回 `UsCompanyDividends` ，包含以下字段： @@ -160,6 +161,12 @@ func main() { | ---- | ---- | ---- | | dividend_ttm | string | 过去 12 个月每股股息 | | dividend_yield_ttm | string | TTM 股息率（%） | -| payouts | string | 过去一年的派息次数 | +| payouts | string | 过去一年派息次数 | | currency | string | 货币代码，如 `USD` | -| items | object[] | 逐笔分红支付记录 | +| items | USDividendItem[] | 逐笔分红记录 | + +每条 `USDividendItem` 包含： + +| 字段 | 类型 | 描述 | +| ---- | ---- | ---- | +| dividend | string | 每股分红金额 | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md index 55cb4ab7..69bf576b 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -152,6 +152,7 @@ func main() { + ## 响应 返回 `UsETFDividendInfo` ，包含以下字段： @@ -162,4 +163,12 @@ func main() { | dividend_yield_ttm | string | TTM 股息率（%） | | dividend_freq | string | 派息频率（如 `Quarterly`） | | currency | string | 货币代码，如 `USD` | -| fiscal_year_info | object[] | 按财年分列的年度分红明细 | +| fiscal_year_info | FiscalYearDividend[] | 按财年分列的年度分红明细 | + +每条 `FiscalYearDividend` 包含： + +| 字段 | 类型 | 描述 | +| ---- | ---- | ---- | +| year | string | 财年 | +| total_dividend | string | 年度总股息 | +| records | object[] | 逐笔支付记录 | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md index 320a4d27..e4e3bf1b 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -155,6 +155,7 @@ func main() { + ## 响应 返回 `UsFinancialStatement` ，包含以下字段： @@ -164,5 +165,12 @@ func main() { | revenue | string | 总营收 | | net_income | string | 净利润 | | net_margin | string | 净利润率 | -| periods | object[] | 包含逐行数据的报告期列表 | +| periods | FinancialPeriod[] | 包含逐行数据的报告期列表 | | currency | string | 货币代码，如 `USD` | + +每条 `FinancialPeriod` 包含： + +| 字段 | 类型 | 描述 | +| ---- | ---- | ---- | +| date | string | 报告期日期 | +| values | map[string]any | 以指标名称为键的财务行项目 | diff --git a/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md b/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md index 0264c58a..f7add0c8 100644 --- a/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md +++ b/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md @@ -142,3 +142,19 @@ fmt.Printf("%+v\n", resp) | all_time_high_date | string | 历史最高价日期 | | all_time_low | string | 历史最低价 | | all_time_low_date | string | 历史最低价日期 | + +## 响应 + +返回 `CryptoOverview` ，包含以下字段： + +| 字段 | 类型 | 描述 | +| ---- | ---- | ---- | +| symbol | string | 交易对代码，如 `DOGEUSD.BKKT` | +| name | string | 资产名称 | +| ticker | string | 简短代码 | +| base_asset | string | 基础资产代码，如 `DOGE` | +| currency | string | 计价货币，如 `USD` | +| all_time_high | string | 历史最高价 | +| all_time_high_date | string | 历史最高价日期 | +| all_time_low | string | 历史最低价 | +| all_time_low_date | string | 历史最低价日期 | diff --git a/docs/zh-CN/docs/trade/asset/us_asset_overview.md b/docs/zh-CN/docs/trade/asset/us_asset_overview.md index 58a7efd8..8bff3560 100644 --- a/docs/zh-CN/docs/trade/asset/us_asset_overview.md +++ b/docs/zh-CN/docs/trade/asset/us_asset_overview.md @@ -127,6 +127,7 @@ fmt.Printf("%+v\n", resp) + ## 响应 返回 `USAssetOverview` ，包含以下字段： @@ -134,7 +135,22 @@ fmt.Printf("%+v\n", resp) | 字段 | 类型 | 描述 | | ---- | ---- | ---- | | account_type | string | 账户类型标识 | -| asset_timestamp | datetime | 资产数据快照时间 | -| cash_buy_power | string | 可用买入力（现金） | -| cash_list | object[] | 按货币分列的现金余额 | -| crypto_list | object[] | 加密货币持仓（含数量和估值） | +| asset_timestamp | int64 | 资产数据快照时间（Unix 秒） | +| cash_buy_power | string | 可用买入力 | +| cash_list | USCashEntry[] | 按货币分列的现金余额 | +| stock_list | USStockEntry[] | 股票持仓 | +| crypto_list | USCryptoEntry[] | 加密货币持仓 | + +每条 `USCashEntry` 包含： + +| 字段 | 类型 | 描述 | +| ---- | ---- | ---- | +| currency | string | 货币代码，如 `USD` | +| amount | string | 现金金额 | + +每条 `USCryptoEntry` 包含： + +| 字段 | 类型 | 描述 | +| ---- | ---- | ---- | +| symbol | string | 加密货币交易对代码 | +| quantity | string | 持有数量 | diff --git a/docs/zh-CN/docs/trade/asset/us_realized_pl.md b/docs/zh-CN/docs/trade/asset/us_realized_pl.md index 6ffe419f..57b096b5 100644 --- a/docs/zh-CN/docs/trade/asset/us_realized_pl.md +++ b/docs/zh-CN/docs/trade/asset/us_realized_pl.md @@ -133,6 +133,7 @@ fmt.Printf("%+v\n", resp) + ## 响应 返回 `USRealizedPL` ，包含以下字段： @@ -141,10 +142,18 @@ fmt.Printf("%+v\n", resp) | ---- | ---- | ---- | | realized_pl_list | USRealizedPLEntry[] | 按资产类别分列的盈亏明细 | -Each `USRealizedPLEntry` contains: +每条 `USRealizedPLEntry` 包含： | 字段 | 类型 | 描述 | | ---- | ---- | ---- | -| category | int | 资产类别（1=股票，2=期权，3=加密货币） | +| category | int | 资产类别：`1`=股票，`2`=期权，`3`=加密货币 | | currency | string | 货币代码，如 `USD` | -| metrics | object[] | 不同时期的盈亏指标 | +| metrics | USRealizedPLMetric[] | 不同时期的盈亏指标 | + +每条 `USRealizedPLMetric` 包含： + +| 字段 | 类型 | 描述 | +| ---- | ---- | ---- | +| amount | string | 已实现盈亏金额 | +| period | int | 时间周期 | +| rate | string | 收益率（%） | diff --git a/docs/zh-CN/docs/trade/order/us_order_detail.md b/docs/zh-CN/docs/trade/order/us_order_detail.md index b4d1bf05..dfc5e674 100644 --- a/docs/zh-CN/docs/trade/order/us_order_detail.md +++ b/docs/zh-CN/docs/trade/order/us_order_detail.md @@ -130,12 +130,34 @@ fmt.Printf("%+v\n", resp) + ## 响应 返回 `USOrderDetailResponse` ，包含以下字段： | 字段 | 类型 | 描述 | | ---- | ---- | ---- | -| order | object | 含状态及成交详情的完整委托对象 | -| order_histories | object[] | 该委托的历史状态变更记录 | -| current_attached_order | object | 关联子委托（如括号单/OCO），如有 | +| order | USOrder | 含状态和成交详情的完整委托信息 | +| order_histories | USOrderHistory[] | 该委托的历史状态变更记录 | +| current_attached_order | USOrder \| null | 关联子委托（括号单/OCO），无则为 null | + +每条 `USOrder` 包含： + +| 字段 | 类型 | 描述 | +| ---- | ---- | ---- | +| order_id | string | 委托唯一 ID | +| symbol | string | 交易标的，如 `AAPL.US` | +| side | string | `Buy`（买入）或 `Sell`（卖出） | +| status | string | 委托状态 | +| qty | string | 委托数量 | +| price | string | 委托价格 | +| executed_qty | string | 已成交数量 | +| executed_price | string | 成交价格 | +| created_at | int64 | 创建时间（Unix 秒） | + +每条 `USOrderHistory` 包含： + +| 字段 | 类型 | 描述 | +| ---- | ---- | ---- | +| status | string | 委托状态 at this point | +| done_at | int64 | 时间戳（Unix 秒） | diff --git a/docs/zh-CN/docs/trade/order/us_query_orders.md b/docs/zh-CN/docs/trade/order/us_query_orders.md index 7f8e6c3f..c6098098 100644 --- a/docs/zh-CN/docs/trade/order/us_query_orders.md +++ b/docs/zh-CN/docs/trade/order/us_query_orders.md @@ -137,6 +137,7 @@ fmt.Printf("%+v\n", resp) + ## 响应 返回 `QueryUSOrdersResponse` ，包含以下字段： @@ -146,4 +147,16 @@ fmt.Printf("%+v\n", resp) | orders | USOrder[] | 符合筛选条件的委托列表 | | total_count | int | 满足条件的委托总数 | -Each `USOrder` contains: `order_id`, symbol, side, status, quantity, price, executed quantity/price, and creation timestamp. +每条 `USOrder` 包含： + +| 字段 | 类型 | 描述 | +| ---- | ---- | ---- | +| order_id | string | 委托唯一 ID | +| symbol | string | 交易标的，如 `AAPL.US` | +| side | string | `Buy`（买入）或 `Sell`（卖出） | +| status | string | 委托状态 | +| qty | string | 委托数量 | +| price | string | 委托价格 | +| executed_qty | string | 已成交数量 | +| executed_price | string | 成交价格 | +| created_at | int64 | 创建时间（Unix 秒） | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md b/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md index f1d1dad0..401d2297 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md @@ -152,6 +152,7 @@ func main() { + ## 響應 返回 `UsCompanyDividends` ，包含以下字段： @@ -160,6 +161,12 @@ func main() { | ---- | ---- | ---- | | dividend_ttm | string | 過去 12 個月每股股息 | | dividend_yield_ttm | string | TTM 股息率（%） | -| payouts | string | 過去一年的派息次數 | +| payouts | string | 過去一年派息次數 | | currency | string | 貨幣代碼，如 `USD` | -| items | object[] | 逐筆分紅支付記錄 | +| items | USDividendItem[] | 逐筆分紅記錄 | + +每條 `USDividendItem` 包含： + +| 字段 | 類型 | 描述 | +| ---- | ---- | ---- | +| dividend | string | 每股分紅金額 | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md index befdae14..422e179e 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -152,6 +152,7 @@ func main() { + ## 響應 返回 `UsETFDividendInfo` ，包含以下字段： @@ -162,4 +163,12 @@ func main() { | dividend_yield_ttm | string | TTM 股息率（%） | | dividend_freq | string | 派息頻率（如 `Quarterly`） | | currency | string | 貨幣代碼，如 `USD` | -| fiscal_year_info | object[] | 按財年分列的年度分紅明細 | +| fiscal_year_info | FiscalYearDividend[] | 按財年分列的年度分紅明細 | + +每條 `FiscalYearDividend` 包含： + +| 字段 | 類型 | 描述 | +| ---- | ---- | ---- | +| year | string | 財年 | +| total_dividend | string | 年度總股息 | +| records | object[] | 逐筆支付記錄 | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md index 70a3c85e..6e220a69 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -155,6 +155,7 @@ func main() { + ## 響應 返回 `UsFinancialStatement` ，包含以下字段： @@ -164,5 +165,12 @@ func main() { | revenue | string | 總營收 | | net_income | string | 淨利潤 | | net_margin | string | 淨利潤率 | -| periods | object[] | 包含逐行數據的報告期列表 | +| periods | FinancialPeriod[] | 包含逐行數據的報告期列表 | | currency | string | 貨幣代碼，如 `USD` | + +每條 `FinancialPeriod` 包含： + +| 字段 | 類型 | 描述 | +| ---- | ---- | ---- | +| date | string | 報告期日期 | +| values | map[string]any | 以指標名稱為鍵的財務行項目 | diff --git a/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md b/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md index b827a368..c33606d5 100644 --- a/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md +++ b/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md @@ -142,3 +142,19 @@ fmt.Printf("%+v\n", resp) | all_time_high_date | string | 歷史最高價日期 | | all_time_low | string | 歷史最低價 | | all_time_low_date | string | 歷史最低價日期 | + +## 響應 + +返回 `CryptoOverview` ，包含以下字段： + +| 字段 | 類型 | 描述 | +| ---- | ---- | ---- | +| symbol | string | 交易對代碼，如 `DOGEUSD.BKKT` | +| name | string | 資產名稱 | +| ticker | string | 簡短代碼 | +| base_asset | string | 基礎資產代碼，如 `DOGE` | +| currency | string | 計價貨幣，如 `USD` | +| all_time_high | string | 歷史最高價 | +| all_time_high_date | string | 歷史最高價日期 | +| all_time_low | string | 歷史最低價 | +| all_time_low_date | string | 歷史最低價日期 | diff --git a/docs/zh-HK/docs/trade/asset/us_asset_overview.md b/docs/zh-HK/docs/trade/asset/us_asset_overview.md index dbc12488..09922a88 100644 --- a/docs/zh-HK/docs/trade/asset/us_asset_overview.md +++ b/docs/zh-HK/docs/trade/asset/us_asset_overview.md @@ -127,6 +127,7 @@ fmt.Printf("%+v\n", resp) + ## 響應 返回 `USAssetOverview` ，包含以下字段： @@ -134,7 +135,22 @@ fmt.Printf("%+v\n", resp) | 字段 | 類型 | 描述 | | ---- | ---- | ---- | | account_type | string | 賬戶類型標識 | -| asset_timestamp | datetime | 資產數據快照時間 | -| cash_buy_power | string | 可用買入力（現金） | -| cash_list | object[] | 按貨幣分列的現金餘額 | -| crypto_list | object[] | 加密貨幣持倉（含數量和估值） | +| asset_timestamp | int64 | 資產數據快照時間（Unix 秒） | +| cash_buy_power | string | 可用買入力 | +| cash_list | USCashEntry[] | 按貨幣分列的現金餘額 | +| stock_list | USStockEntry[] | 股票持倉 | +| crypto_list | USCryptoEntry[] | 加密貨幣持倉 | + +每條 `USCashEntry` 包含： + +| 字段 | 類型 | 描述 | +| ---- | ---- | ---- | +| currency | string | 貨幣代碼，如 `USD` | +| amount | string | 現金金額 | + +每條 `USCryptoEntry` 包含： + +| 字段 | 類型 | 描述 | +| ---- | ---- | ---- | +| symbol | string | 加密貨幣交易對代碼 | +| quantity | string | 持有數量 | diff --git a/docs/zh-HK/docs/trade/asset/us_realized_pl.md b/docs/zh-HK/docs/trade/asset/us_realized_pl.md index 5d886bf3..ac515f42 100644 --- a/docs/zh-HK/docs/trade/asset/us_realized_pl.md +++ b/docs/zh-HK/docs/trade/asset/us_realized_pl.md @@ -133,6 +133,7 @@ fmt.Printf("%+v\n", resp) + ## 響應 返回 `USRealizedPL` ，包含以下字段： @@ -141,10 +142,18 @@ fmt.Printf("%+v\n", resp) | ---- | ---- | ---- | | realized_pl_list | USRealizedPLEntry[] | 按資產類別分列的盈虧明細 | -Each `USRealizedPLEntry` contains: +每條 `USRealizedPLEntry` 包含： | 字段 | 類型 | 描述 | | ---- | ---- | ---- | -| category | int | 資產類別（1=股票，2=期權，3=加密貨幣） | +| category | int | 資產類別：`1`=股票，`2`=期權，`3`=加密貨幣 | | currency | string | 貨幣代碼，如 `USD` | -| metrics | object[] | 不同時期的盈虧指標 | +| metrics | USRealizedPLMetric[] | 不同時期的盈虧指標 | + +每條 `USRealizedPLMetric` 包含： + +| 字段 | 類型 | 描述 | +| ---- | ---- | ---- | +| amount | string | 已實現盈虧金額 | +| period | int | 時間週期 | +| rate | string | 收益率（%） | diff --git a/docs/zh-HK/docs/trade/order/us_order_detail.md b/docs/zh-HK/docs/trade/order/us_order_detail.md index e1cf367b..ea74d168 100644 --- a/docs/zh-HK/docs/trade/order/us_order_detail.md +++ b/docs/zh-HK/docs/trade/order/us_order_detail.md @@ -130,12 +130,34 @@ fmt.Printf("%+v\n", resp) + ## 響應 返回 `USOrderDetailResponse` ，包含以下字段： | 字段 | 類型 | 描述 | | ---- | ---- | ---- | -| order | object | 含狀態及成交詳情的完整委託對象 | -| order_histories | object[] | 該委託的歷史狀態變更記錄 | -| current_attached_order | object | 關聯子委託（如括號單/OCO），如有 | +| order | USOrder | 含狀態和成交詳情的完整委託資訊 | +| order_histories | USOrderHistory[] | 該委託的歷史狀態變更記錄 | +| current_attached_order | USOrder \| null | 關聯子委託（括號單/OCO），無則為 null | + +每條 `USOrder` 包含： + +| 字段 | 類型 | 描述 | +| ---- | ---- | ---- | +| order_id | string | 委託唯一 ID | +| symbol | string | 交易標的，如 `AAPL.US` | +| side | string | `Buy`（買入）或 `Sell`（賣出） | +| status | string | 委託狀態 | +| qty | string | 委託數量 | +| price | string | 委託價格 | +| executed_qty | string | 已成交數量 | +| executed_price | string | 成交價格 | +| created_at | int64 | 創建時間（Unix 秒） | + +每條 `USOrderHistory` 包含： + +| 字段 | 類型 | 描述 | +| ---- | ---- | ---- | +| status | string | 委託狀態 at this point | +| done_at | int64 | 時間戳（Unix 秒） | diff --git a/docs/zh-HK/docs/trade/order/us_query_orders.md b/docs/zh-HK/docs/trade/order/us_query_orders.md index 85c79218..0a3a3392 100644 --- a/docs/zh-HK/docs/trade/order/us_query_orders.md +++ b/docs/zh-HK/docs/trade/order/us_query_orders.md @@ -137,6 +137,7 @@ fmt.Printf("%+v\n", resp) + ## 響應 返回 `QueryUSOrdersResponse` ，包含以下字段： @@ -146,4 +147,16 @@ fmt.Printf("%+v\n", resp) | orders | USOrder[] | 符合篩選條件的委託列表 | | total_count | int | 滿足條件的委託總數 | -Each `USOrder` contains: `order_id`, symbol, side, status, quantity, price, executed quantity/price, and creation timestamp. +每條 `USOrder` 包含： + +| 字段 | 類型 | 描述 | +| ---- | ---- | ---- | +| order_id | string | 委託唯一 ID | +| symbol | string | 交易標的，如 `AAPL.US` | +| side | string | `Buy`（買入）或 `Sell`（賣出） | +| status | string | 委託狀態 | +| qty | string | 委託數量 | +| price | string | 委託價格 | +| executed_qty | string | 已成交數量 | +| executed_price | string | 成交價格 | +| created_at | int64 | 創建時間（Unix 秒） | From 96d29423633663d6d06afb3ac0c97ee0f99eafd5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 17:14:37 +0800 Subject: [PATCH 31/51] docs(fundamental): add complete Response sections to US SDK docs EN (example+status+schemas) Co-Authored-By: Claude Sonnet 4.6 (1M context) --- .../fundamental/us_analyst_consensus.md | 9 ++- .../fundamental/us_company_dividends.md | 45 ++++++++++---- .../fundamental/us_company_overview.md | 41 ++++++++++--- .../fundamental/us_etf_dividend_info.md | 60 +++++++++++++------ .../fundamental/fundamental/us_etf_files.md | 32 ++++++++-- .../fundamental/us_financial_overview.md | 9 ++- .../fundamental/us_financial_statement_v3.md | 58 +++++++++++++----- .../fundamental/us_key_financial_metrics.md | 9 ++- .../fundamental/us_valuation_overview.md | 44 +++++++++++--- 9 files changed, 236 insertions(+), 71 deletions(-) diff --git a/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md index 5f4033a7..6a35dd97 100644 --- a/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md @@ -155,4 +155,11 @@ func main() { ## Response -Returns a flexible JSON object containing analyst consensus data — revenue and EPS forecasts, target price distribution, and buy/hold/sell rating breakdown. The exact fields vary by data availability. Use `--format json` in the CLI or print the raw response to inspect the structure. +Returns a flexible JSON object containing analyst consensus data (revenue/EPS forecasts, target price distribution, buy/hold/sell breakdown). Structure varies by data availability. + +### Response Status + +| Status | Description | Schema | +| ------ | ----------- | ------ | +| 200 | Success | object | +| 400 | Bad request | None | diff --git a/docs/en/docs/fundamental/fundamental/us_company_dividends.md b/docs/en/docs/fundamental/fundamental/us_company_dividends.md index 8fb2a682..2ba4b06b 100644 --- a/docs/en/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/en/docs/fundamental/fundamental/us_company_dividends.md @@ -155,18 +155,39 @@ func main() { ## Response -Returns `UsCompanyDividends` with the following fields: +### Response Example + +```json +{ + "dividend_ttm": "1.00", + "dividend_yield_ttm": "0.0053", + "payouts": "4", + "currency": "USD", + "items": [ + {"dividend": "0.25"}, + {"dividend": "0.25"} + ] +} +``` + +### Response Status + +| Status | Description | Schema | +| ------ | ----------- | ------ | +| 200 | Success | [UsCompanyDividends](#UsCompanyDividends) | +| 400 | Bad request | None | -| Field | Type | Description | -| ----- | ---- | ----------- | -| dividend_ttm | string | TTM dividend per share | -| dividend_yield_ttm | string | TTM dividend yield (%) | -| payouts | string | Number of payouts in past year | -| currency | string | Currency code (e.g. `USD`) | -| items | USDividendItem[] | Individual dividend records | +## Schemas -Each `USDividendItem` contains: +### UsCompanyDividends -| Field | Type | Description | -| ----- | ---- | ----------- | -| dividend | string | Dividend amount per share | + + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| dividend_ttm | string | true | TTM dividend per share | +| dividend_yield_ttm | string | true | TTM dividend yield (%) | +| payouts | string | true | Number of payouts in past year | +| currency | string | true | Currency code (e.g. `USD`) | +| items | USDividendItem[] | false | Individual dividend records | +| ∟ dividend | string | true | Dividend amount per share | diff --git a/docs/en/docs/fundamental/fundamental/us_company_overview.md b/docs/en/docs/fundamental/fundamental/us_company_overview.md index 145d7c91..4f5150fd 100644 --- a/docs/en/docs/fundamental/fundamental/us_company_overview.md +++ b/docs/en/docs/fundamental/fundamental/us_company_overview.md @@ -154,12 +154,35 @@ func main() { ## Response -Returns `UsCompanyOverview` with the following fields: - -| Field | Type | Description | -| ----- | ---- | ----------- | -| intro | string | Company introduction | -| market_cap | string | Market capitalization | -| ccy_symbol | string | Currency symbol | -| top_rank_tags | string[] | Ranking tag labels | -| detail_url | string | Link to full company detail page | +### Response Example + +```json +{ + "intro": "Apple Inc. designs, manufactures, and markets smartphones, personal computers...", + "market_cap": "3150000000000", + "ccy_symbol": "USD", + "top_rank_tags": ["S&P 500", "NASDAQ 100"], + "detail_url": "https://longbridge.com/stocks/AAPL.US" +} +``` + +### Response Status + +| Status | Description | Schema | +| ------ | ----------- | ------ | +| 200 | Success | [UsCompanyOverview](#UsCompanyOverview) | +| 400 | Bad request | None | + +## Schemas + +### UsCompanyOverview + + + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| intro | string | true | Company introduction | +| market_cap | string | true | Market capitalization | +| ccy_symbol | string | true | Currency symbol | +| top_rank_tags | string[] | false | Ranking tag labels | +| detail_url | string | false | Link to full company detail page | diff --git a/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md index 59fdff7a..445125a5 100644 --- a/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -155,20 +155,46 @@ func main() { ## Response -Returns `UsETFDividendInfo` with the following fields: - -| Field | Type | Description | -| ----- | ---- | ----------- | -| dividend_ttm | string | TTM dividend per share | -| dividend_yield_ttm | string | TTM dividend yield (%) | -| dividend_freq | string | Payout frequency (e.g. `Quarterly`) | -| currency | string | Currency code (e.g. `USD`) | -| fiscal_year_info | FiscalYearDividend[] | Annual dividend breakdown by fiscal year | - -Each `FiscalYearDividend` contains: - -| Field | Type | Description | -| ----- | ---- | ----------- | -| year | string | Fiscal year | -| total_dividend | string | Total annual dividend | -| records | object[] | Individual payment records | +### Response Example + +```json +{ + "dividend_ttm": "6.84", + "dividend_yield_ttm": "0.0134", + "dividend_freq": "Quarterly", + "currency": "USD", + "fiscal_year_info": [ + { + "year": "2025", + "total_dividend": "6.52", + "records": [ + {"ex_date": "2025-12-20", "amount": "1.68"} + ] + } + ] +} +``` + +### Response Status + +| Status | Description | Schema | +| ------ | ----------- | ------ | +| 200 | Success | [UsETFDividendInfo](#UsETFDividendInfo) | +| 400 | Bad request | None | + +## Schemas + +### UsETFDividendInfo + + + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| dividend_ttm | string | true | TTM dividend per share | +| dividend_yield_ttm | string | true | TTM dividend yield (%) | +| dividend_freq | string | true | Payout frequency (e.g. `Quarterly`) | +| currency | string | true | Currency code (e.g. `USD`) | +| fiscal_year_info | FiscalYearDividend[] | false | Annual dividend breakdown | +| ∟ year | string | true | Fiscal year | +| ∟ total_dividend | string | true | Total annual dividend | +| ∟ records | object[] | false | Individual payment records | diff --git a/docs/en/docs/fundamental/fundamental/us_etf_files.md b/docs/en/docs/fundamental/fundamental/us_etf_files.md index 6ba3197d..2d5e0556 100644 --- a/docs/en/docs/fundamental/fundamental/us_etf_files.md +++ b/docs/en/docs/fundamental/fundamental/us_etf_files.md @@ -155,9 +155,31 @@ func main() { ## Response -Returns `UsETFFileList` with the following field: +### Response Example + +```json +{ + "files": [ + {"name": "iShares Core S&P 500 ETF Prospectus"}, + {"name": "iShares Core S&P 500 ETF Annual Report"} + ] +} +``` + +### Response Status + +| Status | Description | Schema | +| ------ | ----------- | ------ | +| 200 | Success | [UsETFFileList](#UsETFFileList) | +| 400 | Bad request | None | + +## Schemas -| Field | Type | Description | -| ----- | ---- | ----------- | -| files | object[] | List of ETF documents | -| files[].name | string | Document name (e.g. `iShares Core S&P 500 ETF Prospectus`) | +### UsETFFileList + + + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| files | ETFFile[] | true | List of ETF regulatory documents | +| ∟ name | string | true | Document name | diff --git a/docs/en/docs/fundamental/fundamental/us_financial_overview.md b/docs/en/docs/fundamental/fundamental/us_financial_overview.md index e730f28a..143e5c40 100644 --- a/docs/en/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/en/docs/fundamental/fundamental/us_financial_overview.md @@ -155,4 +155,11 @@ func main() { ## Response -Returns a flexible JSON object whose structure varies by company and reporting period. The object contains financial summary data including income, balance sheet, and cash flow indicators. Use `--format json` in the CLI or print the raw response to inspect the structure for a specific symbol. +Returns a flexible JSON object. Structure varies by company and reporting period. Contains income statement, balance sheet, and cash flow summary data. + +### Response Status + +| Status | Description | Schema | +| ------ | ----------- | ------ | +| 200 | Success | object | +| 400 | Bad request | None | diff --git a/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md index 43585cbb..f91bd4c3 100644 --- a/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -158,19 +158,45 @@ func main() { ## Response -Returns `UsFinancialStatement` with the following fields: - -| Field | Type | Description | -| ----- | ---- | ----------- | -| revenue | string | Total revenue | -| net_income | string | Net income | -| net_margin | string | Net profit margin | -| periods | FinancialPeriod[] | Reporting periods with line-item values | -| currency | string | Currency code (e.g. `USD`) | - -Each `FinancialPeriod` contains: - -| Field | Type | Description | -| ----- | ---- | ----------- | -| date | string | Period date | -| values | map[string]any | Financial line items keyed by metric name | +### Response Example + +```json +{ + "revenue": "124300000000", + "net_income": "30520000000", + "net_margin": "0.2454", + "periods": [ + { + "date": "2026-03-31", + "values": { + "total_assets": "364840000000", + "total_liabilities": "291040000000" + } + } + ], + "currency": "USD" +} +``` + +### Response Status + +| Status | Description | Schema | +| ------ | ----------- | ------ | +| 200 | Success | [UsFinancialStatement](#UsFinancialStatement) | +| 400 | Bad request | None | + +## Schemas + +### UsFinancialStatement + + + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| revenue | string | true | Total revenue | +| net_income | string | true | Net income | +| net_margin | string | true | Net profit margin | +| periods | FinancialPeriod[] | true | Reporting periods with line-item values | +| ∟ date | string | true | Period date | +| ∟ values | map[string]any | true | Financial line items keyed by metric name | +| currency | string | true | Currency code (e.g. `USD`) | diff --git a/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md index 645cb037..137c2677 100644 --- a/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -155,4 +155,11 @@ func main() { ## Response -Returns a flexible JSON object containing key financial metrics (revenue, net income, EPS, margins, growth rates) for the requested period. The exact fields vary by company. Use `--format json` in the CLI or print the raw response to inspect the structure. +Returns a flexible JSON object containing key financial metrics (revenue, net income, EPS, margins, growth rates). Structure varies by company. + +### Response Status + +| Status | Description | Schema | +| ------ | ----------- | ------ | +| 200 | Success | object | +| 400 | Bad request | None | diff --git a/docs/en/docs/fundamental/fundamental/us_valuation_overview.md b/docs/en/docs/fundamental/fundamental/us_valuation_overview.md index 61ebf8f6..d376fc87 100644 --- a/docs/en/docs/fundamental/fundamental/us_valuation_overview.md +++ b/docs/en/docs/fundamental/fundamental/us_valuation_overview.md @@ -154,12 +154,38 @@ func main() { ## Response -Returns `UsValuationOverview` with the following fields: - -| Field | Type | Description | -| ----- | ---- | ----------- | -| indicator | string | Valuation indicator name | -| current_indicator | object | Current indicator value | -| range | int | Historical percentile range | -| date | string | Valuation date | -| ai_summary | string | AI-generated valuation summary | +### Response Example + +```json +{ + "indicator": "PE", + "current_indicator": { + "circle": "35.2" + }, + "range": 72, + "date": "2026-07-01", + "ai_summary": "Apple's PE ratio of 35.2 is in the 72nd percentile..." +} +``` + +### Response Status + +| Status | Description | Schema | +| ------ | ----------- | ------ | +| 200 | Success | [UsValuationOverview](#UsValuationOverview) | +| 400 | Bad request | None | + +## Schemas + +### UsValuationOverview + + + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| indicator | string | true | Valuation indicator name (e.g. `PE`, `PB`) | +| current_indicator | object | true | Current valuation data | +| ∟ circle | string | true | Current indicator value | +| range | int | true | Historical percentile (0–100) | +| date | string | true | Valuation date | +| ai_summary | string | false | AI-generated valuation summary | From 8890309aa8013b5cbbbd9380242babefe41a1c41 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 17:15:15 +0800 Subject: [PATCH 32/51] docs(trade/quote): add complete Response sections to US SDK docs EN (example+status+schemas) Co-Authored-By: Claude Sonnet 4.6 (1M context) --- .../docs/quote/stocks/us_crypto_overview.md | 53 ++++++++--- docs/en/docs/trade/asset/us_asset_overview.md | 80 +++++++++++----- docs/en/docs/trade/asset/us_realized_pl.md | 70 ++++++++++---- docs/en/docs/trade/order/us_order_detail.md | 94 +++++++++++++------ docs/en/docs/trade/order/us_query_orders.md | 74 +++++++++++---- 5 files changed, 270 insertions(+), 101 deletions(-) diff --git a/docs/en/docs/quote/stocks/us_crypto_overview.md b/docs/en/docs/quote/stocks/us_crypto_overview.md index 5a9513a8..be80b72c 100644 --- a/docs/en/docs/quote/stocks/us_crypto_overview.md +++ b/docs/en/docs/quote/stocks/us_crypto_overview.md @@ -132,16 +132,43 @@ fmt.Printf("%+v\n", resp) ## Response -Returns `CryptoOverview` with the following fields: - -| Field | Type | Description | -| ----- | ---- | ----------- | -| symbol | string | Trading-pair symbol (e.g. `DOGEUSD.BKKT`) | -| name | string | Asset name | -| ticker | string | Short ticker | -| base_asset | string | Base asset code (e.g. `DOGE`) | -| currency | string | Quote currency (e.g. `USD`) | -| all_time_high | string | All-time high price | -| all_time_high_date | string | Date of all-time high | -| all_time_low | string | All-time low price | -| all_time_low_date | string | Date of all-time low | +### Response Example + +```json +{ + "symbol": "DOGEUSD.BKKT", + "name": "Dogecoin", + "ticker": "DOGE", + "base_asset": "DOGE", + "currency": "USD", + "all_time_high": "0.7376", + "all_time_high_date": "2021-05-08", + "all_time_low": "0.0000869", + "all_time_low_date": "2015-05-06" +} +``` + +### Response Status + +| Status | Description | Schema | +| ------ | ----------- | ------ | +| 200 | Success | [CryptoOverview](#CryptoOverview) | +| 400 | Bad request | None | + +## Schemas + +### CryptoOverview + + + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| symbol | string | true | Trading-pair symbol (e.g. `DOGEUSD.BKKT`) | +| name | string | true | Asset name | +| ticker | string | true | Short ticker | +| base_asset | string | true | Base asset code (e.g. `DOGE`) | +| currency | string | true | Quote currency (e.g. `USD`) | +| all_time_high | string | true | All-time high price | +| all_time_high_date | string | true | Date of all-time high | +| all_time_low | string | true | All-time low price | +| all_time_low_date | string | true | Date of all-time low | diff --git a/docs/en/docs/trade/asset/us_asset_overview.md b/docs/en/docs/trade/asset/us_asset_overview.md index 8f36d253..74a687a3 100644 --- a/docs/en/docs/trade/asset/us_asset_overview.md +++ b/docs/en/docs/trade/asset/us_asset_overview.md @@ -130,27 +130,59 @@ fmt.Printf("%+v\n", resp) ## Response -Returns `USAssetOverview` with the following fields: - -| Field | Type | Description | -| ----- | ---- | ----------- | -| account_type | string | Account type identifier | -| asset_timestamp | int64 | Snapshot time (Unix seconds) | -| cash_buy_power | string | Available buying power | -| cash_list | USCashEntry[] | Cash balances by currency | -| stock_list | USStockEntry[] | Stock positions | -| crypto_list | USCryptoEntry[] | Crypto positions | - -Each `USCashEntry` contains: - -| Field | Type | Description | -| ----- | ---- | ----------- | -| currency | string | Currency code (e.g. `USD`) | -| amount | string | Cash amount | - -Each `USCryptoEntry` contains: - -| Field | Type | Description | -| ----- | ---- | ----------- | -| symbol | string | Crypto trading-pair symbol | -| quantity | string | Quantity held | +### Response Example + +```json +{ + "account_type": "US", + "asset_timestamp": 1751866334, + "cash_buy_power": "12500.00", + "cash_list": [ + {"currency": "USD", "amount": "12500.00"} + ], + "stock_list": [], + "crypto_list": [ + {"symbol": "BTCUSD.BKKT", "quantity": "0.5"} + ] +} +``` + +### Response Status + +| Status | Description | Schema | +| ------ | ----------- | ------ | +| 200 | Success | [USAssetOverview](#USAssetOverview) | +| 400 | Bad request | None | + +## Schemas + +### USAssetOverview + + + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| account_type | string | true | Account type identifier | +| asset_timestamp | int64 | true | Snapshot time (Unix seconds) | +| cash_buy_power | string | true | Available buying power | +| cash_list | USCashEntry[] | false | Cash balances by currency | +| stock_list | USStockEntry[] | false | Stock positions | +| crypto_list | USCryptoEntry[] | false | Crypto positions | + +### USCashEntry + + + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| currency | string | true | Currency code (e.g. `USD`) | +| amount | string | true | Cash amount | + +### USCryptoEntry + + + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| symbol | string | true | Crypto trading-pair symbol | +| quantity | string | true | Quantity held | diff --git a/docs/en/docs/trade/asset/us_realized_pl.md b/docs/en/docs/trade/asset/us_realized_pl.md index 20783883..4b0daeed 100644 --- a/docs/en/docs/trade/asset/us_realized_pl.md +++ b/docs/en/docs/trade/asset/us_realized_pl.md @@ -136,24 +136,62 @@ fmt.Printf("%+v\n", resp) ## Response -Returns `USRealizedPL` with the following fields: +### Response Example + +```json +{ + "realized_pl_list": [ + { + "category": 1, + "currency": "USD", + "metrics": [ + {"amount": "1250.50", "period": 1, "rate": "0.0312"} + ] + }, + { + "category": 3, + "currency": "USD", + "metrics": [ + {"amount": "-85.20", "period": 1, "rate": "-0.0215"} + ] + } + ] +} +``` + +### Response Status + +| Status | Description | Schema | +| ------ | ----------- | ------ | +| 200 | Success | [USRealizedPL](#USRealizedPL) | +| 400 | Bad request | None | + +## Schemas + +### USRealizedPL + + -| Field | Type | Description | -| ----- | ---- | ----------- | -| realized_pl_list | USRealizedPLEntry[] | P&L breakdown by asset category | +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| realized_pl_list | USRealizedPLEntry[] | true | P&L breakdown by asset category | + +### USRealizedPLEntry + + -Each `USRealizedPLEntry` contains: +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| category | int | true | Asset category: `1`=stock, `2`=option, `3`=crypto | +| currency | string | true | Currency code (e.g. `USD`) | +| metrics | USRealizedPLMetric[] | true | P&L metrics by time period | -| Field | Type | Description | -| ----- | ---- | ----------- | -| category | int | Asset category: `1`=stock, `2`=option, `3`=crypto | -| currency | string | Currency code (e.g. `USD`) | -| metrics | USRealizedPLMetric[] | P&L metrics for different time periods | +### USRealizedPLMetric -Each `USRealizedPLMetric` contains: + -| Field | Type | Description | -| ----- | ---- | ----------- | -| amount | string | Realized P&L amount | -| period | int | Time period | -| rate | string | Return rate (%) | +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| amount | string | true | Realized P&L amount | +| period | int | true | Time period | +| rate | string | true | Return rate (%) | diff --git a/docs/en/docs/trade/order/us_order_detail.md b/docs/en/docs/trade/order/us_order_detail.md index 59bb5db5..dbeda6f8 100644 --- a/docs/en/docs/trade/order/us_order_detail.md +++ b/docs/en/docs/trade/order/us_order_detail.md @@ -133,31 +133,69 @@ fmt.Printf("%+v\n", resp) ## Response -Returns `USOrderDetailResponse` with the following fields: - -| Field | Type | Description | -| ----- | ---- | ----------- | -| order | USOrder | Full order detail with status and fill information | -| order_histories | USOrderHistory[] | Historical status changes for the order | -| current_attached_order | USOrder \| null | Attached child order (bracket/OCO), null if none | - -Each `USOrder` contains: - -| Field | Type | Description | -| ----- | ---- | ----------- | -| order_id | string | Unique order ID | -| symbol | string | Trading symbol (e.g. `AAPL.US`) | -| side | string | `Buy` or `Sell` | -| status | string | Order status | -| qty | string | Order quantity | -| price | string | Order price | -| executed_qty | string | Executed quantity | -| executed_price | string | Executed price | -| created_at | int64 | Creation time (Unix seconds) | - -Each `USOrderHistory` contains: - -| Field | Type | Description | -| ----- | ---- | ----------- | -| status | string | Order status at this point | -| done_at | int64 | Timestamp (Unix seconds) | +### Response Example + +```json +{ + "order": { + "order_id": "701276261045858304", + "symbol": "AAPL.US", + "side": "Buy", + "status": "Filled", + "qty": "10", + "price": "185.00", + "executed_qty": "10", + "executed_price": "184.95", + "created_at": 1751866334 + }, + "order_histories": [ + {"status": "New", "done_at": 1751866334}, + {"status": "Filled", "done_at": 1751866400} + ], + "current_attached_order": null +} +``` + +### Response Status + +| Status | Description | Schema | +| ------ | ----------- | ------ | +| 200 | Success | [USOrderDetailResponse](#USOrderDetailResponse) | +| 400 | Bad request | None | + +## Schemas + +### USOrderDetailResponse + + + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| order | USOrder | true | Full order detail | +| order_histories | USOrderHistory[] | true | Historical status changes | +| current_attached_order | USOrder \| null | false | Attached child order (bracket/OCO), null if none | + +### USOrder + + + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| order_id | string | true | Unique order ID | +| symbol | string | true | Trading symbol (e.g. `AAPL.US`) | +| side | string | true | `Buy` or `Sell` | +| status | string | true | Order status | +| qty | string | true | Order quantity | +| price | string | true | Order price | +| executed_qty | string | true | Executed quantity | +| executed_price | string | true | Average executed price | +| created_at | int64 | true | Creation time (Unix seconds) | + +### USOrderHistory + + + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| status | string | true | Order status at this point | +| done_at | int64 | true | Timestamp (Unix seconds) | diff --git a/docs/en/docs/trade/order/us_query_orders.md b/docs/en/docs/trade/order/us_query_orders.md index 48899db6..cc6e252c 100644 --- a/docs/en/docs/trade/order/us_query_orders.md +++ b/docs/en/docs/trade/order/us_query_orders.md @@ -140,23 +140,57 @@ fmt.Printf("%+v\n", resp) ## Response -Returns `QueryUSOrdersResponse` with the following fields: - -| Field | Type | Description | -| ----- | ---- | ----------- | -| orders | USOrder[] | List of orders matching the filter | -| total_count | int | Total number of matching orders | - -Each `USOrder` contains: - -| Field | Type | Description | -| ----- | ---- | ----------- | -| order_id | string | Unique order ID | -| symbol | string | Trading symbol (e.g. `AAPL.US`) | -| side | string | `Buy` or `Sell` | -| status | string | Order status | -| qty | string | Order quantity | -| price | string | Order price | -| executed_qty | string | Executed quantity | -| executed_price | string | Executed price | -| created_at | int64 | Creation time (Unix seconds) | +### Response Example + +```json +{ + "orders": [ + { + "order_id": "701276261045858304", + "symbol": "AAPL.US", + "side": "Buy", + "status": "Filled", + "qty": "10", + "price": "185.00", + "executed_qty": "10", + "executed_price": "184.95", + "created_at": 1751866334 + } + ], + "total_count": 1 +} +``` + +### Response Status + +| Status | Description | Schema | +| ------ | ----------- | ------ | +| 200 | Success | [QueryUSOrdersResponse](#QueryUSOrdersResponse) | +| 400 | Bad request | None | + +## Schemas + +### QueryUSOrdersResponse + + + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| orders | USOrder[] | true | List of matching orders | +| total_count | int | true | Total number of matching orders | + +### USOrder + + + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| order_id | string | true | Unique order ID | +| symbol | string | true | Trading symbol (e.g. `AAPL.US`) | +| side | string | true | `Buy` or `Sell` | +| status | string | true | Order status (e.g. `Filled`, `New`, `PartialFilled`) | +| qty | string | true | Order quantity | +| price | string | true | Order price | +| executed_qty | string | true | Executed quantity | +| executed_price | string | true | Average executed price | +| created_at | int64 | true | Creation time (Unix seconds) | From 23c1dd3d8b44690e90164cf58ebcee7bc05b6f4e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 17:16:36 +0800 Subject: [PATCH 33/51] docs: port complete Response sections to zh-CN + zh-HK (28 files) with Response Example/Status/Schemas --- .../fundamental/us_analyst_consensus.md | 10 +- .../fundamental/us_company_dividends.md | 46 ++++++--- .../fundamental/us_company_overview.md | 40 ++++++-- .../fundamental/us_etf_dividend_info.md | 55 ++++++++--- .../fundamental/fundamental/us_etf_files.md | 33 ++++++- .../fundamental/us_financial_overview.md | 10 +- .../fundamental/us_financial_statement_v3.md | 53 ++++++++--- .../fundamental/us_key_financial_metrics.md | 10 +- .../fundamental/us_valuation_overview.md | 43 +++++++-- .../docs/quote/stocks/us_crypto_overview.md | 52 +++++++--- .../docs/trade/asset/us_asset_overview.md | 71 ++++++++++---- docs/zh-CN/docs/trade/asset/us_realized_pl.md | 71 ++++++++++---- .../zh-CN/docs/trade/order/us_order_detail.md | 95 +++++++++++++------ .../zh-CN/docs/trade/order/us_query_orders.md | 75 +++++++++++---- .../fundamental/us_analyst_consensus.md | 10 +- .../fundamental/us_company_dividends.md | 46 ++++++--- .../fundamental/us_company_overview.md | 40 ++++++-- .../fundamental/us_etf_dividend_info.md | 55 ++++++++--- .../fundamental/fundamental/us_etf_files.md | 33 ++++++- .../fundamental/us_financial_overview.md | 10 +- .../fundamental/us_financial_statement_v3.md | 53 ++++++++--- .../fundamental/us_key_financial_metrics.md | 10 +- .../fundamental/us_valuation_overview.md | 43 +++++++-- .../docs/quote/stocks/us_crypto_overview.md | 52 +++++++--- .../docs/trade/asset/us_asset_overview.md | 71 ++++++++++---- docs/zh-HK/docs/trade/asset/us_realized_pl.md | 71 ++++++++++---- .../zh-HK/docs/trade/order/us_order_detail.md | 95 +++++++++++++------ .../zh-HK/docs/trade/order/us_query_orders.md | 75 +++++++++++---- 28 files changed, 1012 insertions(+), 316 deletions(-) diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md index d8127522..549db205 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md @@ -153,6 +153,14 @@ func main() { + ## 响应 -返回结构灵活的 JSON 对象，包含分析师一致预期数据（营收和 EPS 预测、目标价分布、买入/持有/卖出评级分布）。具体字段因数据可用性而异。可通过 CLI 使用 `--format json` 或打印原始响应查看数据结构。 +返回结构灵活的 JSON 对象，包含分析师一致预期数据（营收/EPS 预测、目标价分布、买入/持有/卖出分布），具体字段因数据可用性而异。 + +### 响应 Status + +| 状态码 | 描述 | 结构 | +| ------ | ---- | ---- | +| 200 | 成功 | object | +| 400 | 请求错误 | None | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md b/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md index fb64418f..48850517 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md @@ -153,20 +153,42 @@ func main() { + ## 响应 -返回 `UsCompanyDividends` ，包含以下字段： +### 响应 Example + +```json +{ + "dividend_ttm": "1.00", + "dividend_yield_ttm": "0.0053", + "payouts": "4", + "currency": "USD", + "items": [ + {"dividend": "0.25"}, + {"dividend": "0.25"} + ] +} +``` + +### 响应 Status -| 字段 | 类型 | 描述 | -| ---- | ---- | ---- | -| dividend_ttm | string | 过去 12 个月每股股息 | -| dividend_yield_ttm | string | TTM 股息率（%） | -| payouts | string | 过去一年派息次数 | -| currency | string | 货币代码，如 `USD` | -| items | USDividendItem[] | 逐笔分红记录 | +| 状态码 | 描述 | 结构 | +| ------ | ---- | ---- | +| 200 | 成功 | [UsCompanyDividends](#UsCompanyDividends) | +| 400 | 请求错误 | None | -每条 `USDividendItem` 包含： +## 数据结构 -| 字段 | 类型 | 描述 | -| ---- | ---- | ---- | -| dividend | string | 每股分红金额 | +### UsCompanyDividends + + + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| dividend_ttm | string | true | 过去 12 个月每股股息 | +| dividend_yield_ttm | string | true | TTM 股息率（%） | +| payouts | string | true | 过去一年派息次数 | +| currency | string | true | 货币代码，如 `USD` | +| items | USDividendItem[] | false | 逐笔分红记录 | +| ∟ dividend | string | true | 每股分红金额 | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md index bd4acf75..3ff6dfc1 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md @@ -152,14 +152,38 @@ func main() { + ## 响应 -返回 `UsCompanyOverview` ，包含以下字段： +### 响应 Example + +```json +{ + "intro": "Apple Inc. designs, manufactures, and markets smartphones, personal computers...", + "market_cap": "3150000000000", + "ccy_symbol": "USD", + "top_rank_tags": ["S&P 500", "NASDAQ 100"], + "detail_url": "https://longbridge.com/stocks/AAPL.US" +} +``` + +### 响应 Status + +| 状态码 | 描述 | 结构 | +| ------ | ---- | ---- | +| 200 | 成功 | [UsCompanyOverview](#UsCompanyOverview) | +| 400 | 请求错误 | None | -| 字段 | 类型 | 描述 | -| ---- | ---- | ---- | -| intro | string | 公司简介 | -| market_cap | string | 市值 | -| ccy_symbol | string | 货币符号 | -| top_rank_tags | string[] | 排名标签列表 | -| detail_url | string | 公司详情页链接 | +## 数据结构 + +### UsCompanyOverview + + + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| intro | string | true | 公司简介 | +| market_cap | string | true | 市值 | +| ccy_symbol | string | true | 货币符号 | +| top_rank_tags | string[] | false | 排名标签列表 | +| detail_url | string | false | 公司详情页链接 | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md index 69bf576b..b81e6e86 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -153,22 +153,49 @@ func main() { + ## 响应 -返回 `UsETFDividendInfo` ，包含以下字段： +### 响应 Example + +```json +{ + "dividend_ttm": "6.84", + "dividend_yield_ttm": "0.0134", + "dividend_freq": "Quarterly", + "currency": "USD", + "fiscal_year_info": [ + { + "year": "2025", + "total_dividend": "6.52", + "records": [ + {"ex_date": "2025-12-20", "amount": "1.68"} + ] + } + ] +} +``` + +### 响应 Status -| 字段 | 类型 | 描述 | -| ---- | ---- | ---- | -| dividend_ttm | string | 过去 12 个月每股股息 | -| dividend_yield_ttm | string | TTM 股息率（%） | -| dividend_freq | string | 派息频率（如 `Quarterly`） | -| currency | string | 货币代码，如 `USD` | -| fiscal_year_info | FiscalYearDividend[] | 按财年分列的年度分红明细 | +| 状态码 | 描述 | 结构 | +| ------ | ---- | ---- | +| 200 | 成功 | [UsETFDividendInfo](#UsETFDividendInfo) | +| 400 | 请求错误 | None | -每条 `FiscalYearDividend` 包含： +## 数据结构 -| 字段 | 类型 | 描述 | -| ---- | ---- | ---- | -| year | string | 财年 | -| total_dividend | string | 年度总股息 | -| records | object[] | 逐笔支付记录 | +### UsETFDividendInfo + + + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| dividend_ttm | string | true | 过去 12 个月每股股息 | +| dividend_yield_ttm | string | true | TTM 股息率（%） | +| dividend_freq | string | true | 派息频率（如 `Quarterly`） | +| currency | string | true | 货币代码，如 `USD` | +| fiscal_year_info | FiscalYearDividend[] | false | Annual dividend breakdown | +| ∟ year | string | true | 财年 | +| ∟ total_dividend | string | true | 年度总股息 | +| ∟ records | object[] | false | 逐笔支付记录 | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md b/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md index 2f045e05..dc95940d 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md @@ -153,11 +153,34 @@ func main() { + ## 响应 -返回 `UsETFFileList` ，包含以下字段： +### 响应 Example + +```json +{ + "files": [ + {"name": "iShares Core S&P 500 ETF Prospectus"}, + {"name": "iShares Core S&P 500 ETF Annual Report"} + ] +} +``` + +### 响应 Status + +| 状态码 | 描述 | 结构 | +| ------ | ---- | ---- | +| 200 | 成功 | [UsETFFileList](#UsETFFileList) | +| 400 | 请求错误 | None | -| 字段 | 类型 | 描述 | -| ---- | ---- | ---- | -| files | object[] | ETF 文件列表 | -| files[].name | string | 文件名称 (e.g. `iShares Core S&P 500 ETF Prospectus`) | +## 数据结构 + +### UsETFFileList + + + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| files | ETFFile[] | true | ETF 监管文件列表 | +| ∟ name | string | true | 文件名称 | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md index 17cb3eae..f008883b 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md @@ -153,6 +153,14 @@ func main() { + ## 响应 -返回结构灵活的 JSON 对象，内容因公司和报告周期而异，包含损益、资产负债和现金流摘要数据。可通过 CLI 使用 `--format json` 或打印原始响应查看具体标的的数据结构。 +返回结构灵活的 JSON 对象，内容因公司和报告周期而异，包含损益、资产负债和现金流摘要数据。 + +### 响应 Status + +| 状态码 | 描述 | 结构 | +| ------ | ---- | ---- | +| 200 | 成功 | object | +| 400 | 请求错误 | None | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md index e4e3bf1b..e5b79792 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -156,21 +156,48 @@ func main() { + ## 响应 -返回 `UsFinancialStatement` ，包含以下字段： +### 响应 Example + +```json +{ + "revenue": "124300000000", + "net_income": "30520000000", + "net_margin": "0.2454", + "periods": [ + { + "date": "2026-03-31", + "values": { + "total_assets": "364840000000", + "total_liabilities": "291040000000" + } + } + ], + "currency": "USD" +} +``` + +### 响应 Status -| 字段 | 类型 | 描述 | -| ---- | ---- | ---- | -| revenue | string | 总营收 | -| net_income | string | 净利润 | -| net_margin | string | 净利润率 | -| periods | FinancialPeriod[] | 包含逐行数据的报告期列表 | -| currency | string | 货币代码，如 `USD` | +| 状态码 | 描述 | 结构 | +| ------ | ---- | ---- | +| 200 | 成功 | [UsFinancialStatement](#UsFinancialStatement) | +| 400 | 请求错误 | None | -每条 `FinancialPeriod` 包含： +## 数据结构 -| 字段 | 类型 | 描述 | -| ---- | ---- | ---- | -| date | string | 报告期日期 | -| values | map[string]any | 以指标名称为键的财务行项目 | +### UsFinancialStatement + + + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| revenue | string | true | 总营收 | +| net_income | string | true | 净利润 | +| net_margin | string | true | 净利润率 | +| periods | FinancialPeriod[] | true | 包含逐行数据的报告期列表 | +| ∟ date | string | true | 报告期日期 | +| ∟ values | map[string]any | true | 以指标名称为键的财务行项目 | +| currency | string | true | 货币代码，如 `USD` | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md index d0eef583..cdb6b211 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -153,6 +153,14 @@ func main() { + ## 响应 -返回结构灵活的 JSON 对象，包含关键财务指标（营收、净利润、EPS、利润率和增长率）。具体字段因公司而异。可通过 CLI 使用 `--format json` 或打印原始响应查看数据结构。 +返回结构灵活的 JSON 对象，包含关键财务指标（营收、净利润、EPS、利润率和增长率），具体字段因公司而异。 + +### 响应 Status + +| 状态码 | 描述 | 结构 | +| ------ | ---- | ---- | +| 200 | 成功 | object | +| 400 | 请求错误 | None | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md index 76dc7012..9ef9816e 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md @@ -152,14 +152,41 @@ func main() { + ## 响应 -返回 `UsValuationOverview` ，包含以下字段： +### 响应 Example + +```json +{ + "indicator": "PE", + "current_indicator": { + "circle": "35.2" + }, + "range": 72, + "date": "2026-07-01", + "ai_summary": "Apple's PE ratio of 35.2 is in the 72nd percentile..." +} +``` + +### 响应 Status + +| 状态码 | 描述 | 结构 | +| ------ | ---- | ---- | +| 200 | 成功 | [UsValuationOverview](#UsValuationOverview) | +| 400 | 请求错误 | None | -| 字段 | 类型 | 描述 | -| ---- | ---- | ---- | -| indicator | string | 估值指标名称 | -| current_indicator | object | 当前估值指标数据 | -| range | int | 历史百分位区间 | -| date | string | 估值日期 | -| ai_summary | string | AI 生成的估值摘要 | +## 数据结构 + +### UsValuationOverview + + + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| indicator | string | true | 估值指标名称（如 `PE`、`PB`） | +| current_indicator | object | true | 当前估值数据 | +| ∟ circle | string | true | 当前指标数值 | +| range | int | true | 历史百分位（0–100） | +| date | string | true | 估值日期 | +| ai_summary | string | false | AI 生成的估值摘要 | diff --git a/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md b/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md index f7add0c8..a0d7fdac 100644 --- a/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md +++ b/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md @@ -143,18 +143,46 @@ fmt.Printf("%+v\n", resp) | all_time_low | string | 历史最低价 | | all_time_low_date | string | 历史最低价日期 | + ## 响应 -返回 `CryptoOverview` ，包含以下字段： +### 响应 Example + +```json +{ + "symbol": "DOGEUSD.BKKT", + "name": "Dogecoin", + "ticker": "DOGE", + "base_asset": "DOGE", + "currency": "USD", + "all_time_high": "0.7376", + "all_time_high_date": "2021-05-08", + "all_time_low": "0.0000869", + "all_time_low_date": "2015-05-06" +} +``` -| 字段 | 类型 | 描述 | -| ---- | ---- | ---- | -| symbol | string | 交易对代码，如 `DOGEUSD.BKKT` | -| name | string | 资产名称 | -| ticker | string | 简短代码 | -| base_asset | string | 基础资产代码，如 `DOGE` | -| currency | string | 计价货币，如 `USD` | -| all_time_high | string | 历史最高价 | -| all_time_high_date | string | 历史最高价日期 | -| all_time_low | string | 历史最低价 | -| all_time_low_date | string | 历史最低价日期 | +### 响应 Status + +| 状态码 | 描述 | 结构 | +| ------ | ---- | ---- | +| 200 | 成功 | [CryptoOverview](#CryptoOverview) | +| 400 | 请求错误 | None | + +## 数据结构 + +### CryptoOverview + + + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| symbol | string | true | 交易对代码，如 `DOGEUSD.BKKT` | +| name | string | true | 资产名称 | +| ticker | string | true | 简短代码 | +| base_asset | string | true | 基础资产代码，如 `DOGE` | +| currency | string | true | 计价货币，如 `USD` | +| all_time_high | string | true | 历史最高价 | +| all_time_high_date | string | true | 历史最高价日期 | +| all_time_low | string | true | 历史最低价 | +| all_time_low_date | string | true | 历史最低价日期 | diff --git a/docs/zh-CN/docs/trade/asset/us_asset_overview.md b/docs/zh-CN/docs/trade/asset/us_asset_overview.md index 8bff3560..e2d698b4 100644 --- a/docs/zh-CN/docs/trade/asset/us_asset_overview.md +++ b/docs/zh-CN/docs/trade/asset/us_asset_overview.md @@ -128,29 +128,62 @@ fmt.Printf("%+v\n", resp) + ## 响应 -返回 `USAssetOverview` ，包含以下字段： +### 响应 Example + +```json +{ + "account_type": "US", + "asset_timestamp": 1751866334, + "cash_buy_power": "12500.00", + "cash_list": [ + {"currency": "USD", "amount": "12500.00"} + ], + "stock_list": [], + "crypto_list": [ + {"symbol": "BTCUSD.BKKT", "quantity": "0.5"} + ] +} +``` + +### 响应 Status + +| 状态码 | 描述 | 结构 | +| ------ | ---- | ---- | +| 200 | 成功 | [USAssetOverview](#USAssetOverview) | +| 400 | 请求错误 | None | + +## 数据结构 + +### USAssetOverview + + + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| account_type | string | true | 账户类型标识 | +| asset_timestamp | int64 | true | 资产数据快照时间（Unix 秒） | +| cash_buy_power | string | true | 可用买入力 | +| cash_list | USCashEntry[] | false | 按货币分列的现金余额 | +| stock_list | USStockEntry[] | false | 股票持仓 | +| crypto_list | USCryptoEntry[] | false | 加密货币持仓 | + +### USCashEntry -| 字段 | 类型 | 描述 | -| ---- | ---- | ---- | -| account_type | string | 账户类型标识 | -| asset_timestamp | int64 | 资产数据快照时间（Unix 秒） | -| cash_buy_power | string | 可用买入力 | -| cash_list | USCashEntry[] | 按货币分列的现金余额 | -| stock_list | USStockEntry[] | 股票持仓 | -| crypto_list | USCryptoEntry[] | 加密货币持仓 | + -每条 `USCashEntry` 包含： +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| currency | string | true | 货币代码，如 `USD` | +| amount | string | true | 现金金额 | -| 字段 | 类型 | 描述 | -| ---- | ---- | ---- | -| currency | string | 货币代码，如 `USD` | -| amount | string | 现金金额 | +### USCryptoEntry -每条 `USCryptoEntry` 包含： + -| 字段 | 类型 | 描述 | -| ---- | ---- | ---- | -| symbol | string | 加密货币交易对代码 | -| quantity | string | 持有数量 | +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| symbol | string | true | 加密货币交易对代码 | +| quantity | string | true | 持有数量 | diff --git a/docs/zh-CN/docs/trade/asset/us_realized_pl.md b/docs/zh-CN/docs/trade/asset/us_realized_pl.md index 57b096b5..c5da9fc8 100644 --- a/docs/zh-CN/docs/trade/asset/us_realized_pl.md +++ b/docs/zh-CN/docs/trade/asset/us_realized_pl.md @@ -134,26 +134,65 @@ fmt.Printf("%+v\n", resp) + ## 响应 -返回 `USRealizedPL` ，包含以下字段： +### 响应 Example + +```json +{ + "realized_pl_list": [ + { + "category": 1, + "currency": "USD", + "metrics": [ + {"amount": "1250.50", "period": 1, "rate": "0.0312"} + ] + }, + { + "category": 3, + "currency": "USD", + "metrics": [ + {"amount": "-85.20", "period": 1, "rate": "-0.0215"} + ] + } + ] +} +``` + +### 响应 Status -| 字段 | 类型 | 描述 | -| ---- | ---- | ---- | -| realized_pl_list | USRealizedPLEntry[] | 按资产类别分列的盈亏明细 | +| 状态码 | 描述 | 结构 | +| ------ | ---- | ---- | +| 200 | 成功 | [USRealizedPL](#USRealizedPL) | +| 400 | 请求错误 | None | -每条 `USRealizedPLEntry` 包含： +## 数据结构 -| 字段 | 类型 | 描述 | -| ---- | ---- | ---- | -| category | int | 资产类别：`1`=股票，`2`=期权，`3`=加密货币 | -| currency | string | 货币代码，如 `USD` | -| metrics | USRealizedPLMetric[] | 不同时期的盈亏指标 | +### USRealizedPL + + + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| realized_pl_list | USRealizedPLEntry[] | true | 按资产类别分列的盈亏明细 | -每条 `USRealizedPLMetric` 包含： +### USRealizedPLEntry -| 字段 | 类型 | 描述 | -| ---- | ---- | ---- | -| amount | string | 已实现盈亏金额 | -| period | int | 时间周期 | -| rate | string | 收益率（%） | + + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| category | int | true | 资产类别：`1`=股票，`2`=期权，`3`=加密货币 | +| currency | string | true | 货币代码，如 `USD` | +| metrics | USRealizedPLMetric[] | true | 按时期分列的盈亏指标 | + +### USRealizedPLMetric + + + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| amount | string | true | 已实现盈亏金额 | +| period | int | true | 时间周期 | +| rate | string | true | 收益率（%） | diff --git a/docs/zh-CN/docs/trade/order/us_order_detail.md b/docs/zh-CN/docs/trade/order/us_order_detail.md index dfc5e674..b2f43827 100644 --- a/docs/zh-CN/docs/trade/order/us_order_detail.md +++ b/docs/zh-CN/docs/trade/order/us_order_detail.md @@ -131,33 +131,72 @@ fmt.Printf("%+v\n", resp) + ## 响应 -返回 `USOrderDetailResponse` ，包含以下字段： - -| 字段 | 类型 | 描述 | -| ---- | ---- | ---- | -| order | USOrder | 含状态和成交详情的完整委托信息 | -| order_histories | USOrderHistory[] | 该委托的历史状态变更记录 | -| current_attached_order | USOrder \| null | 关联子委托（括号单/OCO），无则为 null | - -每条 `USOrder` 包含： - -| 字段 | 类型 | 描述 | -| ---- | ---- | ---- | -| order_id | string | 委托唯一 ID | -| symbol | string | 交易标的，如 `AAPL.US` | -| side | string | `Buy`（买入）或 `Sell`（卖出） | -| status | string | 委托状态 | -| qty | string | 委托数量 | -| price | string | 委托价格 | -| executed_qty | string | 已成交数量 | -| executed_price | string | 成交价格 | -| created_at | int64 | 创建时间（Unix 秒） | - -每条 `USOrderHistory` 包含： - -| 字段 | 类型 | 描述 | -| ---- | ---- | ---- | -| status | string | 委托状态 at this point | -| done_at | int64 | 时间戳（Unix 秒） | +### 响应 Example + +```json +{ + "order": { + "order_id": "701276261045858304", + "symbol": "AAPL.US", + "side": "Buy", + "status": "Filled", + "qty": "10", + "price": "185.00", + "executed_qty": "10", + "executed_price": "184.95", + "created_at": 1751866334 + }, + "order_histories": [ + {"status": "New", "done_at": 1751866334}, + {"status": "Filled", "done_at": 1751866400} + ], + "current_attached_order": null +} +``` + +### 响应 Status + +| 状态码 | 描述 | 结构 | +| ------ | ---- | ---- | +| 200 | 成功 | [USOrderDetailResponse](#USOrderDetailResponse) | +| 400 | 请求错误 | None | + +## 数据结构 + +### USOrderDetailResponse + + + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| order | USOrder | true | 完整委托详情 | +| order_histories | USOrderHistory[] | true | 历史状态变更记录 | +| current_attached_order | USOrder \| null | false | 关联子委托（括号单/OCO），无则为 null | + +### USOrder + + + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| order_id | string | true | 委托唯一 ID | +| symbol | string | true | 交易标的，如 `AAPL.US` | +| side | string | true | `Buy`（买入）或 `Sell`（卖出） | +| status | string | true | 委托状态 | +| qty | string | true | 委托数量 | +| price | string | true | 委托价格 | +| executed_qty | string | true | 已成交数量 | +| executed_price | string | true | 平均成交价格 | +| created_at | int64 | true | 创建时间（Unix 秒） | + +### USOrderHistory + + + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| status | string | true | 委托状态 at this point | +| done_at | int64 | true | 时间戳（Unix 秒） | diff --git a/docs/zh-CN/docs/trade/order/us_query_orders.md b/docs/zh-CN/docs/trade/order/us_query_orders.md index c6098098..cbc75ddb 100644 --- a/docs/zh-CN/docs/trade/order/us_query_orders.md +++ b/docs/zh-CN/docs/trade/order/us_query_orders.md @@ -138,25 +138,60 @@ fmt.Printf("%+v\n", resp) + ## 响应 -返回 `QueryUSOrdersResponse` ，包含以下字段： - -| 字段 | 类型 | 描述 | -| ---- | ---- | ---- | -| orders | USOrder[] | 符合筛选条件的委托列表 | -| total_count | int | 满足条件的委托总数 | - -每条 `USOrder` 包含： - -| 字段 | 类型 | 描述 | -| ---- | ---- | ---- | -| order_id | string | 委托唯一 ID | -| symbol | string | 交易标的，如 `AAPL.US` | -| side | string | `Buy`（买入）或 `Sell`（卖出） | -| status | string | 委托状态 | -| qty | string | 委托数量 | -| price | string | 委托价格 | -| executed_qty | string | 已成交数量 | -| executed_price | string | 成交价格 | -| created_at | int64 | 创建时间（Unix 秒） | +### 响应 Example + +```json +{ + "orders": [ + { + "order_id": "701276261045858304", + "symbol": "AAPL.US", + "side": "Buy", + "status": "Filled", + "qty": "10", + "price": "185.00", + "executed_qty": "10", + "executed_price": "184.95", + "created_at": 1751866334 + } + ], + "total_count": 1 +} +``` + +### 响应 Status + +| 状态码 | 描述 | 结构 | +| ------ | ---- | ---- | +| 200 | 成功 | [QueryUSOrdersResponse](#QueryUSOrdersResponse) | +| 400 | 请求错误 | None | + +## 数据结构 + +### QueryUSOrdersResponse + + + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| orders | USOrder[] | true | 符合筛选条件的委托列表 | +| total_count | int | true | 满足条件的委托总数 | + +### USOrder + + + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| order_id | string | true | 委托唯一 ID | +| symbol | string | true | 交易标的，如 `AAPL.US` | +| side | string | true | `Buy`（买入）或 `Sell`（卖出） | +| status | string | true | 委托状态（如 `Filled`、`New`、`PartialFilled`） | +| qty | string | true | 委托数量 | +| price | string | true | 委托价格 | +| executed_qty | string | true | 已成交数量 | +| executed_price | string | true | 平均成交价格 | +| created_at | int64 | true | 创建时间（Unix 秒） | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md index d3c0d772..6a73535f 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md @@ -153,6 +153,14 @@ func main() { + ## 響應 -返回結構靈活的 JSON 對象，包含分析師一致預期數據（營收和 EPS 預測、目標價分佈、買入/持有/賣出評級分佈）。具體字段因數據可用性而異。可通過 CLI 使用 `--format json` 或打印原始響應查看數據結構。 +返回結構靈活的 JSON 對象，包含分析師一致預期數據（營收/EPS 預測、目標價分佈、買入/持有/賣出分佈），具體字段因數據可用性而異。 + +### 響應 Status + +| 狀態碼 | 描述 | 結構 | +| ------ | ---- | ---- | +| 200 | 成功 | object | +| 400 | 請求錯誤 | None | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md b/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md index 401d2297..ee334c94 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md @@ -153,20 +153,42 @@ func main() { + ## 響應 -返回 `UsCompanyDividends` ，包含以下字段： +### 響應 Example + +```json +{ + "dividend_ttm": "1.00", + "dividend_yield_ttm": "0.0053", + "payouts": "4", + "currency": "USD", + "items": [ + {"dividend": "0.25"}, + {"dividend": "0.25"} + ] +} +``` + +### 響應 Status -| 字段 | 類型 | 描述 | -| ---- | ---- | ---- | -| dividend_ttm | string | 過去 12 個月每股股息 | -| dividend_yield_ttm | string | TTM 股息率（%） | -| payouts | string | 過去一年派息次數 | -| currency | string | 貨幣代碼，如 `USD` | -| items | USDividendItem[] | 逐筆分紅記錄 | +| 狀態碼 | 描述 | 結構 | +| ------ | ---- | ---- | +| 200 | 成功 | [UsCompanyDividends](#UsCompanyDividends) | +| 400 | 請求錯誤 | None | -每條 `USDividendItem` 包含： +## 數據結構 -| 字段 | 類型 | 描述 | -| ---- | ---- | ---- | -| dividend | string | 每股分紅金額 | +### UsCompanyDividends + + + +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| dividend_ttm | string | true | 過去 12 個月每股股息 | +| dividend_yield_ttm | string | true | TTM 股息率（%） | +| payouts | string | true | 過去一年派息次數 | +| currency | string | true | 貨幣代碼，如 `USD` | +| items | USDividendItem[] | false | 逐筆分紅記錄 | +| ∟ dividend | string | true | 每股分紅金額 | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md index 498863bf..e0eafb7a 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md @@ -152,14 +152,38 @@ func main() { + ## 響應 -返回 `UsCompanyOverview` ，包含以下字段： +### 響應 Example + +```json +{ + "intro": "Apple Inc. designs, manufactures, and markets smartphones, personal computers...", + "market_cap": "3150000000000", + "ccy_symbol": "USD", + "top_rank_tags": ["S&P 500", "NASDAQ 100"], + "detail_url": "https://longbridge.com/stocks/AAPL.US" +} +``` + +### 響應 Status + +| 狀態碼 | 描述 | 結構 | +| ------ | ---- | ---- | +| 200 | 成功 | [UsCompanyOverview](#UsCompanyOverview) | +| 400 | 請求錯誤 | None | -| 字段 | 類型 | 描述 | -| ---- | ---- | ---- | -| intro | string | 公司簡介 | -| market_cap | string | 市值 | -| ccy_symbol | string | 貨幣符號 | -| top_rank_tags | string[] | 排名標籤列表 | -| detail_url | string | 公司詳情頁連結 | +## 數據結構 + +### UsCompanyOverview + + + +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| intro | string | true | 公司簡介 | +| market_cap | string | true | 市值 | +| ccy_symbol | string | true | 貨幣符號 | +| top_rank_tags | string[] | false | 排名標籤列表 | +| detail_url | string | false | 公司詳情頁連結 | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md index 422e179e..99f4eeea 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -153,22 +153,49 @@ func main() { + ## 響應 -返回 `UsETFDividendInfo` ，包含以下字段： +### 響應 Example + +```json +{ + "dividend_ttm": "6.84", + "dividend_yield_ttm": "0.0134", + "dividend_freq": "Quarterly", + "currency": "USD", + "fiscal_year_info": [ + { + "year": "2025", + "total_dividend": "6.52", + "records": [ + {"ex_date": "2025-12-20", "amount": "1.68"} + ] + } + ] +} +``` + +### 響應 Status -| 字段 | 類型 | 描述 | -| ---- | ---- | ---- | -| dividend_ttm | string | 過去 12 個月每股股息 | -| dividend_yield_ttm | string | TTM 股息率（%） | -| dividend_freq | string | 派息頻率（如 `Quarterly`） | -| currency | string | 貨幣代碼，如 `USD` | -| fiscal_year_info | FiscalYearDividend[] | 按財年分列的年度分紅明細 | +| 狀態碼 | 描述 | 結構 | +| ------ | ---- | ---- | +| 200 | 成功 | [UsETFDividendInfo](#UsETFDividendInfo) | +| 400 | 請求錯誤 | None | -每條 `FiscalYearDividend` 包含： +## 數據結構 -| 字段 | 類型 | 描述 | -| ---- | ---- | ---- | -| year | string | 財年 | -| total_dividend | string | 年度總股息 | -| records | object[] | 逐筆支付記錄 | +### UsETFDividendInfo + + + +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| dividend_ttm | string | true | 過去 12 個月每股股息 | +| dividend_yield_ttm | string | true | TTM 股息率（%） | +| dividend_freq | string | true | 派息頻率（如 `Quarterly`） | +| currency | string | true | 貨幣代碼，如 `USD` | +| fiscal_year_info | FiscalYearDividend[] | false | Annual dividend breakdown | +| ∟ year | string | true | 財年 | +| ∟ total_dividend | string | true | 年度總股息 | +| ∟ records | object[] | false | 逐筆支付記錄 | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md b/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md index a7f8ef0d..64c33ca9 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md @@ -153,11 +153,34 @@ func main() { + ## 響應 -返回 `UsETFFileList` ，包含以下字段： +### 響應 Example + +```json +{ + "files": [ + {"name": "iShares Core S&P 500 ETF Prospectus"}, + {"name": "iShares Core S&P 500 ETF Annual Report"} + ] +} +``` + +### 響應 Status + +| 狀態碼 | 描述 | 結構 | +| ------ | ---- | ---- | +| 200 | 成功 | [UsETFFileList](#UsETFFileList) | +| 400 | 請求錯誤 | None | -| 字段 | 類型 | 描述 | -| ---- | ---- | ---- | -| files | object[] | ETF 文件列表 | -| files[].name | string | 文件名稱 (e.g. `iShares Core S&P 500 ETF Prospectus`) | +## 數據結構 + +### UsETFFileList + + + +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| files | ETFFile[] | true | ETF 監管文件列表 | +| ∟ name | string | true | 文件名稱 | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md index 8e540f7f..2e94517d 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md @@ -153,6 +153,14 @@ func main() { + ## 響應 -返回結構靈活的 JSON 對象，內容因公司和報告週期而異，包含損益、資產負債和現金流摘要數據。可通過 CLI 使用 `--format json` 或打印原始響應查看具體標的的數據結構。 +返回結構靈活的 JSON 對象，內容因公司和報告週期而異，包含損益、資產負債和現金流摘要數據。 + +### 響應 Status + +| 狀態碼 | 描述 | 結構 | +| ------ | ---- | ---- | +| 200 | 成功 | object | +| 400 | 請求錯誤 | None | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md index 6e220a69..fe94b202 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -156,21 +156,48 @@ func main() { + ## 響應 -返回 `UsFinancialStatement` ，包含以下字段： +### 響應 Example + +```json +{ + "revenue": "124300000000", + "net_income": "30520000000", + "net_margin": "0.2454", + "periods": [ + { + "date": "2026-03-31", + "values": { + "total_assets": "364840000000", + "total_liabilities": "291040000000" + } + } + ], + "currency": "USD" +} +``` + +### 響應 Status -| 字段 | 類型 | 描述 | -| ---- | ---- | ---- | -| revenue | string | 總營收 | -| net_income | string | 淨利潤 | -| net_margin | string | 淨利潤率 | -| periods | FinancialPeriod[] | 包含逐行數據的報告期列表 | -| currency | string | 貨幣代碼，如 `USD` | +| 狀態碼 | 描述 | 結構 | +| ------ | ---- | ---- | +| 200 | 成功 | [UsFinancialStatement](#UsFinancialStatement) | +| 400 | 請求錯誤 | None | -每條 `FinancialPeriod` 包含： +## 數據結構 -| 字段 | 類型 | 描述 | -| ---- | ---- | ---- | -| date | string | 報告期日期 | -| values | map[string]any | 以指標名稱為鍵的財務行項目 | +### UsFinancialStatement + + + +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| revenue | string | true | 總營收 | +| net_income | string | true | 淨利潤 | +| net_margin | string | true | 淨利潤率 | +| periods | FinancialPeriod[] | true | 包含逐行數據的報告期列表 | +| ∟ date | string | true | 報告期日期 | +| ∟ values | map[string]any | true | 以指標名稱為鍵的財務行項目 | +| currency | string | true | 貨幣代碼，如 `USD` | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md index 93813a1a..ab35aef5 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -153,6 +153,14 @@ func main() { + ## 響應 -返回結構靈活的 JSON 對象，包含關鍵財務指標（營收、淨利潤、EPS、利潤率和增長率）。具體字段因公司而異。可通過 CLI 使用 `--format json` 或打印原始響應查看數據結構。 +返回結構靈活的 JSON 對象，包含關鍵財務指標（營收、淨利潤、EPS、利潤率和增長率），具體字段因公司而異。 + +### 響應 Status + +| 狀態碼 | 描述 | 結構 | +| ------ | ---- | ---- | +| 200 | 成功 | object | +| 400 | 請求錯誤 | None | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md index f6ce7a9f..658f6a9e 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md @@ -152,14 +152,41 @@ func main() { + ## 響應 -返回 `UsValuationOverview` ，包含以下字段： +### 響應 Example + +```json +{ + "indicator": "PE", + "current_indicator": { + "circle": "35.2" + }, + "range": 72, + "date": "2026-07-01", + "ai_summary": "Apple's PE ratio of 35.2 is in the 72nd percentile..." +} +``` + +### 響應 Status + +| 狀態碼 | 描述 | 結構 | +| ------ | ---- | ---- | +| 200 | 成功 | [UsValuationOverview](#UsValuationOverview) | +| 400 | 請求錯誤 | None | -| 字段 | 類型 | 描述 | -| ---- | ---- | ---- | -| indicator | string | 估值指標名稱 | -| current_indicator | object | 當前估值指標數據 | -| range | int | 歷史百分位區間 | -| date | string | 估值日期 | -| ai_summary | string | AI 生成的估值摘要 | +## 數據結構 + +### UsValuationOverview + + + +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| indicator | string | true | 估值指標名稱（如 `PE`、`PB`） | +| current_indicator | object | true | 當前估值數據 | +| ∟ circle | string | true | 當前指標數值 | +| range | int | true | 歷史百分位（0–100） | +| date | string | true | 估值日期 | +| ai_summary | string | false | AI 生成的估值摘要 | diff --git a/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md b/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md index c33606d5..1faa390a 100644 --- a/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md +++ b/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md @@ -143,18 +143,46 @@ fmt.Printf("%+v\n", resp) | all_time_low | string | 歷史最低價 | | all_time_low_date | string | 歷史最低價日期 | + ## 響應 -返回 `CryptoOverview` ，包含以下字段： +### 響應 Example + +```json +{ + "symbol": "DOGEUSD.BKKT", + "name": "Dogecoin", + "ticker": "DOGE", + "base_asset": "DOGE", + "currency": "USD", + "all_time_high": "0.7376", + "all_time_high_date": "2021-05-08", + "all_time_low": "0.0000869", + "all_time_low_date": "2015-05-06" +} +``` -| 字段 | 類型 | 描述 | -| ---- | ---- | ---- | -| symbol | string | 交易對代碼，如 `DOGEUSD.BKKT` | -| name | string | 資產名稱 | -| ticker | string | 簡短代碼 | -| base_asset | string | 基礎資產代碼，如 `DOGE` | -| currency | string | 計價貨幣，如 `USD` | -| all_time_high | string | 歷史最高價 | -| all_time_high_date | string | 歷史最高價日期 | -| all_time_low | string | 歷史最低價 | -| all_time_low_date | string | 歷史最低價日期 | +### 響應 Status + +| 狀態碼 | 描述 | 結構 | +| ------ | ---- | ---- | +| 200 | 成功 | [CryptoOverview](#CryptoOverview) | +| 400 | 請求錯誤 | None | + +## 數據結構 + +### CryptoOverview + + + +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| symbol | string | true | 交易對代碼，如 `DOGEUSD.BKKT` | +| name | string | true | 資產名稱 | +| ticker | string | true | 簡短代碼 | +| base_asset | string | true | 基礎資產代碼，如 `DOGE` | +| currency | string | true | 計價貨幣，如 `USD` | +| all_time_high | string | true | 歷史最高價 | +| all_time_high_date | string | true | 歷史最高價日期 | +| all_time_low | string | true | 歷史最低價 | +| all_time_low_date | string | true | 歷史最低價日期 | diff --git a/docs/zh-HK/docs/trade/asset/us_asset_overview.md b/docs/zh-HK/docs/trade/asset/us_asset_overview.md index 09922a88..45b363fa 100644 --- a/docs/zh-HK/docs/trade/asset/us_asset_overview.md +++ b/docs/zh-HK/docs/trade/asset/us_asset_overview.md @@ -128,29 +128,62 @@ fmt.Printf("%+v\n", resp) + ## 響應 -返回 `USAssetOverview` ，包含以下字段： +### 響應 Example + +```json +{ + "account_type": "US", + "asset_timestamp": 1751866334, + "cash_buy_power": "12500.00", + "cash_list": [ + {"currency": "USD", "amount": "12500.00"} + ], + "stock_list": [], + "crypto_list": [ + {"symbol": "BTCUSD.BKKT", "quantity": "0.5"} + ] +} +``` + +### 響應 Status + +| 狀態碼 | 描述 | 結構 | +| ------ | ---- | ---- | +| 200 | 成功 | [USAssetOverview](#USAssetOverview) | +| 400 | 請求錯誤 | None | + +## 數據結構 + +### USAssetOverview + + + +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| account_type | string | true | 賬戶類型標識 | +| asset_timestamp | int64 | true | 資產數據快照時間（Unix 秒） | +| cash_buy_power | string | true | 可用買入力 | +| cash_list | USCashEntry[] | false | 按貨幣分列的現金餘額 | +| stock_list | USStockEntry[] | false | 股票持倉 | +| crypto_list | USCryptoEntry[] | false | 加密貨幣持倉 | + +### USCashEntry -| 字段 | 類型 | 描述 | -| ---- | ---- | ---- | -| account_type | string | 賬戶類型標識 | -| asset_timestamp | int64 | 資產數據快照時間（Unix 秒） | -| cash_buy_power | string | 可用買入力 | -| cash_list | USCashEntry[] | 按貨幣分列的現金餘額 | -| stock_list | USStockEntry[] | 股票持倉 | -| crypto_list | USCryptoEntry[] | 加密貨幣持倉 | + -每條 `USCashEntry` 包含： +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| currency | string | true | 貨幣代碼，如 `USD` | +| amount | string | true | 現金金額 | -| 字段 | 類型 | 描述 | -| ---- | ---- | ---- | -| currency | string | 貨幣代碼，如 `USD` | -| amount | string | 現金金額 | +### USCryptoEntry -每條 `USCryptoEntry` 包含： + -| 字段 | 類型 | 描述 | -| ---- | ---- | ---- | -| symbol | string | 加密貨幣交易對代碼 | -| quantity | string | 持有數量 | +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| symbol | string | true | 加密貨幣交易對代碼 | +| quantity | string | true | 持有數量 | diff --git a/docs/zh-HK/docs/trade/asset/us_realized_pl.md b/docs/zh-HK/docs/trade/asset/us_realized_pl.md index ac515f42..cfecf394 100644 --- a/docs/zh-HK/docs/trade/asset/us_realized_pl.md +++ b/docs/zh-HK/docs/trade/asset/us_realized_pl.md @@ -134,26 +134,65 @@ fmt.Printf("%+v\n", resp) + ## 響應 -返回 `USRealizedPL` ，包含以下字段： +### 響應 Example + +```json +{ + "realized_pl_list": [ + { + "category": 1, + "currency": "USD", + "metrics": [ + {"amount": "1250.50", "period": 1, "rate": "0.0312"} + ] + }, + { + "category": 3, + "currency": "USD", + "metrics": [ + {"amount": "-85.20", "period": 1, "rate": "-0.0215"} + ] + } + ] +} +``` + +### 響應 Status -| 字段 | 類型 | 描述 | -| ---- | ---- | ---- | -| realized_pl_list | USRealizedPLEntry[] | 按資產類別分列的盈虧明細 | +| 狀態碼 | 描述 | 結構 | +| ------ | ---- | ---- | +| 200 | 成功 | [USRealizedPL](#USRealizedPL) | +| 400 | 請求錯誤 | None | -每條 `USRealizedPLEntry` 包含： +## 數據結構 -| 字段 | 類型 | 描述 | -| ---- | ---- | ---- | -| category | int | 資產類別：`1`=股票，`2`=期權，`3`=加密貨幣 | -| currency | string | 貨幣代碼，如 `USD` | -| metrics | USRealizedPLMetric[] | 不同時期的盈虧指標 | +### USRealizedPL + + + +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| realized_pl_list | USRealizedPLEntry[] | true | 按資產類別分列的盈虧明細 | -每條 `USRealizedPLMetric` 包含： +### USRealizedPLEntry -| 字段 | 類型 | 描述 | -| ---- | ---- | ---- | -| amount | string | 已實現盈虧金額 | -| period | int | 時間週期 | -| rate | string | 收益率（%） | + + +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| category | int | true | 資產類別：`1`=股票，`2`=期權，`3`=加密貨幣 | +| currency | string | true | 貨幣代碼，如 `USD` | +| metrics | USRealizedPLMetric[] | true | 按時期分列的盈虧指標 | + +### USRealizedPLMetric + + + +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| amount | string | true | 已實現盈虧金額 | +| period | int | true | 時間週期 | +| rate | string | true | 收益率（%） | diff --git a/docs/zh-HK/docs/trade/order/us_order_detail.md b/docs/zh-HK/docs/trade/order/us_order_detail.md index ea74d168..6fd9a7fc 100644 --- a/docs/zh-HK/docs/trade/order/us_order_detail.md +++ b/docs/zh-HK/docs/trade/order/us_order_detail.md @@ -131,33 +131,72 @@ fmt.Printf("%+v\n", resp) + ## 響應 -返回 `USOrderDetailResponse` ，包含以下字段： - -| 字段 | 類型 | 描述 | -| ---- | ---- | ---- | -| order | USOrder | 含狀態和成交詳情的完整委託資訊 | -| order_histories | USOrderHistory[] | 該委託的歷史狀態變更記錄 | -| current_attached_order | USOrder \| null | 關聯子委託（括號單/OCO），無則為 null | - -每條 `USOrder` 包含： - -| 字段 | 類型 | 描述 | -| ---- | ---- | ---- | -| order_id | string | 委託唯一 ID | -| symbol | string | 交易標的，如 `AAPL.US` | -| side | string | `Buy`（買入）或 `Sell`（賣出） | -| status | string | 委託狀態 | -| qty | string | 委託數量 | -| price | string | 委託價格 | -| executed_qty | string | 已成交數量 | -| executed_price | string | 成交價格 | -| created_at | int64 | 創建時間（Unix 秒） | - -每條 `USOrderHistory` 包含： - -| 字段 | 類型 | 描述 | -| ---- | ---- | ---- | -| status | string | 委託狀態 at this point | -| done_at | int64 | 時間戳（Unix 秒） | +### 響應 Example + +```json +{ + "order": { + "order_id": "701276261045858304", + "symbol": "AAPL.US", + "side": "Buy", + "status": "Filled", + "qty": "10", + "price": "185.00", + "executed_qty": "10", + "executed_price": "184.95", + "created_at": 1751866334 + }, + "order_histories": [ + {"status": "New", "done_at": 1751866334}, + {"status": "Filled", "done_at": 1751866400} + ], + "current_attached_order": null +} +``` + +### 響應 Status + +| 狀態碼 | 描述 | 結構 | +| ------ | ---- | ---- | +| 200 | 成功 | [USOrderDetailResponse](#USOrderDetailResponse) | +| 400 | 請求錯誤 | None | + +## 數據結構 + +### USOrderDetailResponse + + + +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| order | USOrder | true | 完整委託詳情 | +| order_histories | USOrderHistory[] | true | 歷史狀態變更記錄 | +| current_attached_order | USOrder \| null | false | 關聯子委託（括號單/OCO），無則為 null | + +### USOrder + + + +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| order_id | string | true | 委託唯一 ID | +| symbol | string | true | 交易標的，如 `AAPL.US` | +| side | string | true | `Buy`（買入）或 `Sell`（賣出） | +| status | string | true | 委託狀態 | +| qty | string | true | 委託數量 | +| price | string | true | 委託價格 | +| executed_qty | string | true | 已成交數量 | +| executed_price | string | true | 平均成交價格 | +| created_at | int64 | true | 創建時間（Unix 秒） | + +### USOrderHistory + + + +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| status | string | true | 委託狀態 at this point | +| done_at | int64 | true | 時間戳（Unix 秒） | diff --git a/docs/zh-HK/docs/trade/order/us_query_orders.md b/docs/zh-HK/docs/trade/order/us_query_orders.md index 0a3a3392..0dd8f334 100644 --- a/docs/zh-HK/docs/trade/order/us_query_orders.md +++ b/docs/zh-HK/docs/trade/order/us_query_orders.md @@ -138,25 +138,60 @@ fmt.Printf("%+v\n", resp) + ## 響應 -返回 `QueryUSOrdersResponse` ，包含以下字段： - -| 字段 | 類型 | 描述 | -| ---- | ---- | ---- | -| orders | USOrder[] | 符合篩選條件的委託列表 | -| total_count | int | 滿足條件的委託總數 | - -每條 `USOrder` 包含： - -| 字段 | 類型 | 描述 | -| ---- | ---- | ---- | -| order_id | string | 委託唯一 ID | -| symbol | string | 交易標的，如 `AAPL.US` | -| side | string | `Buy`（買入）或 `Sell`（賣出） | -| status | string | 委託狀態 | -| qty | string | 委託數量 | -| price | string | 委託價格 | -| executed_qty | string | 已成交數量 | -| executed_price | string | 成交價格 | -| created_at | int64 | 創建時間（Unix 秒） | +### 響應 Example + +```json +{ + "orders": [ + { + "order_id": "701276261045858304", + "symbol": "AAPL.US", + "side": "Buy", + "status": "Filled", + "qty": "10", + "price": "185.00", + "executed_qty": "10", + "executed_price": "184.95", + "created_at": 1751866334 + } + ], + "total_count": 1 +} +``` + +### 響應 Status + +| 狀態碼 | 描述 | 結構 | +| ------ | ---- | ---- | +| 200 | 成功 | [QueryUSOrdersResponse](#QueryUSOrdersResponse) | +| 400 | 請求錯誤 | None | + +## 數據結構 + +### QueryUSOrdersResponse + + + +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| orders | USOrder[] | true | 符合篩選條件的委託列表 | +| total_count | int | true | 滿足條件的委託總數 | + +### USOrder + + + +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| order_id | string | true | 委託唯一 ID | +| symbol | string | true | 交易標的，如 `AAPL.US` | +| side | string | true | `Buy`（買入）或 `Sell`（賣出） | +| status | string | true | 委託狀態（如 `Filled`、`New`、`PartialFilled`） | +| qty | string | true | 委託數量 | +| price | string | true | 委託價格 | +| executed_qty | string | true | 已成交數量 | +| executed_price | string | true | 平均成交價格 | +| created_at | int64 | true | 創建時間（Unix 秒） | From 79b938a01fe79476d1b7b6fb0f7d17bdc02265e1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 17:51:15 +0800 Subject: [PATCH 34/51] =?UTF-8?q?fix(docs):=20distinguish=20AP-only=20warn?= =?UTF-8?q?ing=20title=20from=20US-only=20=E2=80=94=20'Longbridge=20US=20?= =?UTF-8?q?=E8=B4=A6=E6=88=B7=E4=B8=8D=E6=94=AF=E6=8C=81'=20vs=20'Longbrid?= =?UTF-8?q?ge=20US=20=E8=B4=A6=E6=88=B7'?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/en/docs/cli/account/dca.md | 2 +- docs/en/docs/cli/market-data/broker-holding.md | 2 +- docs/en/docs/fundamental/fundamental/operating.md | 2 +- docs/en/docs/fundamental/market/broker_holding_daily.md | 2 +- docs/en/docs/fundamental/market/broker_holding_detail.md | 2 +- docs/en/docs/fundamental/market/broker_positions.md | 2 +- docs/en/docs/quote/stocks/brokers.md | 2 +- docs/zh-CN/docs/cli/account/dca.md | 2 +- docs/zh-CN/docs/cli/market-data/broker-holding.md | 2 +- docs/zh-CN/docs/fundamental/fundamental/operating.md | 2 +- docs/zh-CN/docs/fundamental/market/broker_holding_daily.md | 2 +- docs/zh-CN/docs/fundamental/market/broker_holding_detail.md | 2 +- docs/zh-CN/docs/fundamental/market/broker_positions.md | 2 +- docs/zh-CN/docs/quote/stocks/brokers.md | 2 +- docs/zh-HK/docs/cli/account/dca.md | 2 +- docs/zh-HK/docs/cli/market-data/broker-holding.md | 2 +- docs/zh-HK/docs/fundamental/fundamental/operating.md | 2 +- docs/zh-HK/docs/fundamental/market/broker_holding_daily.md | 2 +- docs/zh-HK/docs/fundamental/market/broker_holding_detail.md | 2 +- docs/zh-HK/docs/fundamental/market/broker_positions.md | 2 +- docs/zh-HK/docs/quote/stocks/brokers.md | 2 +- 21 files changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/en/docs/cli/account/dca.md b/docs/en/docs/cli/account/dca.md index a0499e79..79093fac 100644 --- a/docs/en/docs/cli/account/dca.md +++ b/docs/en/docs/cli/account/dca.md @@ -4,7 +4,7 @@ sidebar_label: 'dca' sidebar_position: 10 --- -:::warning Not Available for US Data-Center Accounts +:::warning Not for Longbridge US Accounts This command requires an AP data-center account (HK / Singapore). US data-center accounts are not supported. AP accounts can use this command with any supported symbol, including US stocks. ::: diff --git a/docs/en/docs/cli/market-data/broker-holding.md b/docs/en/docs/cli/market-data/broker-holding.md index b1a44601..ff360d3d 100644 --- a/docs/en/docs/cli/market-data/broker-holding.md +++ b/docs/en/docs/cli/market-data/broker-holding.md @@ -4,7 +4,7 @@ sidebar_label: 'broker-holding' sidebar_position: 15 --- -:::warning Not Available for US Data-Center Accounts +:::warning Not for Longbridge US Accounts This command requires an AP data-center account (HK / Singapore). US data-center accounts are not supported. AP accounts can use this command with any supported symbol, including US stocks. ::: diff --git a/docs/en/docs/fundamental/fundamental/operating.md b/docs/en/docs/fundamental/fundamental/operating.md index 2df854a8..3c3b8fbb 100644 --- a/docs/en/docs/fundamental/fundamental/operating.md +++ b/docs/en/docs/fundamental/fundamental/operating.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning Not Available for US Data-Center Accounts +:::warning Not for Longbridge US Accounts This method requires an AP data-center account (HK / Singapore). US data-center accounts will receive a region restriction error. AP accounts can call this method with any supported symbol, including US stocks. ::: diff --git a/docs/en/docs/fundamental/market/broker_holding_daily.md b/docs/en/docs/fundamental/market/broker_holding_daily.md index 32d06b38..2a146a01 100644 --- a/docs/en/docs/fundamental/market/broker_holding_daily.md +++ b/docs/en/docs/fundamental/market/broker_holding_daily.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning Not Available for US Data-Center Accounts +:::warning Not for Longbridge US Accounts This method requires an AP data-center account (HK / Singapore). US data-center accounts will receive a region restriction error. AP accounts can call this method with any supported symbol, including US stocks. ::: diff --git a/docs/en/docs/fundamental/market/broker_holding_detail.md b/docs/en/docs/fundamental/market/broker_holding_detail.md index 4ee584d8..b2cb1ac2 100644 --- a/docs/en/docs/fundamental/market/broker_holding_detail.md +++ b/docs/en/docs/fundamental/market/broker_holding_detail.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning Not Available for US Data-Center Accounts +:::warning Not for Longbridge US Accounts This method requires an AP data-center account (HK / Singapore). US data-center accounts will receive a region restriction error. AP accounts can call this method with any supported symbol, including US stocks. ::: diff --git a/docs/en/docs/fundamental/market/broker_positions.md b/docs/en/docs/fundamental/market/broker_positions.md index 3de7ff08..e8a60deb 100644 --- a/docs/en/docs/fundamental/market/broker_positions.md +++ b/docs/en/docs/fundamental/market/broker_positions.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning Not Available for US Data-Center Accounts +:::warning Not for Longbridge US Accounts This method requires an AP data-center account (HK / Singapore). US data-center accounts will receive a region restriction error. AP accounts can call this method with any supported symbol, including US stocks. ::: diff --git a/docs/en/docs/quote/stocks/brokers.md b/docs/en/docs/quote/stocks/brokers.md index dd5ee956..1f2c017e 100644 --- a/docs/en/docs/quote/stocks/brokers.md +++ b/docs/en/docs/quote/stocks/brokers.md @@ -5,7 +5,7 @@ slug: /quote/pull/brokers sidebar_position: 6 --- -:::warning Not Available for US Data-Center Accounts +:::warning Not for Longbridge US Accounts This method requires an AP data-center account (HK / Singapore). US data-center accounts will receive a region restriction error. AP accounts can call this method with any supported symbol, including US stocks. ::: diff --git a/docs/zh-CN/docs/cli/account/dca.md b/docs/zh-CN/docs/cli/account/dca.md index 04f5d127..c2c9e5c2 100644 --- a/docs/zh-CN/docs/cli/account/dca.md +++ b/docs/zh-CN/docs/cli/account/dca.md @@ -4,7 +4,7 @@ sidebar_label: 'dca' sidebar_position: 10 --- -:::warning Longbridge US 账户 +:::warning Longbridge US 账户不支持 此命令需要 AP 数据中心账户（香港/新加坡）。美股数据中心账户不支持此命令。AP 账户可操作任意标的，包括美股。 ::: diff --git a/docs/zh-CN/docs/cli/market-data/broker-holding.md b/docs/zh-CN/docs/cli/market-data/broker-holding.md index 62fc2b77..181a411c 100644 --- a/docs/zh-CN/docs/cli/market-data/broker-holding.md +++ b/docs/zh-CN/docs/cli/market-data/broker-holding.md @@ -4,7 +4,7 @@ sidebar_label: 'broker-holding' sidebar_position: 15 --- -:::warning Longbridge US 账户 +:::warning Longbridge US 账户不支持 此命令需要 AP 数据中心账户（香港/新加坡）。美股数据中心账户不支持此命令。AP 账户可操作任意标的，包括美股。 ::: diff --git a/docs/zh-CN/docs/fundamental/fundamental/operating.md b/docs/zh-CN/docs/fundamental/fundamental/operating.md index f0fc961a..908bcf79 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/operating.md +++ b/docs/zh-CN/docs/fundamental/fundamental/operating.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning Longbridge US 账户 +:::warning Longbridge US 账户不支持 此方法需要 AP 数据中心账户（香港/新加坡）。美股数据中心账户将收到区域限制错误。AP 账户可查询任意标的，包括美股。 ::: diff --git a/docs/zh-CN/docs/fundamental/market/broker_holding_daily.md b/docs/zh-CN/docs/fundamental/market/broker_holding_daily.md index 573f92de..129f2e2b 100644 --- a/docs/zh-CN/docs/fundamental/market/broker_holding_daily.md +++ b/docs/zh-CN/docs/fundamental/market/broker_holding_daily.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning Longbridge US 账户 +:::warning Longbridge US 账户不支持 此方法需要 AP 数据中心账户（香港/新加坡）。美股数据中心账户将收到区域限制错误。AP 账户可查询任意标的，包括美股。 ::: diff --git a/docs/zh-CN/docs/fundamental/market/broker_holding_detail.md b/docs/zh-CN/docs/fundamental/market/broker_holding_detail.md index f932d06e..005eb39c 100644 --- a/docs/zh-CN/docs/fundamental/market/broker_holding_detail.md +++ b/docs/zh-CN/docs/fundamental/market/broker_holding_detail.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning Longbridge US 账户 +:::warning Longbridge US 账户不支持 此方法需要 AP 数据中心账户（香港/新加坡）。美股数据中心账户将收到区域限制错误。AP 账户可查询任意标的，包括美股。 ::: diff --git a/docs/zh-CN/docs/fundamental/market/broker_positions.md b/docs/zh-CN/docs/fundamental/market/broker_positions.md index 9d750ce9..2a50d926 100644 --- a/docs/zh-CN/docs/fundamental/market/broker_positions.md +++ b/docs/zh-CN/docs/fundamental/market/broker_positions.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning Longbridge US 账户 +:::warning Longbridge US 账户不支持 此方法需要 AP 数据中心账户（香港/新加坡）。美股数据中心账户将收到区域限制错误。AP 账户可查询任意标的，包括美股。 ::: diff --git a/docs/zh-CN/docs/quote/stocks/brokers.md b/docs/zh-CN/docs/quote/stocks/brokers.md index 5dd656eb..198c5947 100644 --- a/docs/zh-CN/docs/quote/stocks/brokers.md +++ b/docs/zh-CN/docs/quote/stocks/brokers.md @@ -5,7 +5,7 @@ slug: /quote/pull/brokers sidebar_position: 6 --- -:::warning Longbridge US 账户 +:::warning Longbridge US 账户不支持 此方法需要 AP 数据中心账户（香港/新加坡）。美股数据中心账户将收到区域限制错误。AP 账户可查询任意标的，包括美股。 ::: diff --git a/docs/zh-HK/docs/cli/account/dca.md b/docs/zh-HK/docs/cli/account/dca.md index 34577887..f9da18b8 100644 --- a/docs/zh-HK/docs/cli/account/dca.md +++ b/docs/zh-HK/docs/cli/account/dca.md @@ -4,7 +4,7 @@ sidebar_label: 'dca' sidebar_position: 10 --- -:::warning Longbridge US 賬戶 +:::warning Longbridge US 賬戶不支援 此命令需要 AP 數據中心賬戶（香港/新加坡）。美股數據中心賬戶不支援此命令。AP 賬戶可操作任意標的，包括美股。 ::: diff --git a/docs/zh-HK/docs/cli/market-data/broker-holding.md b/docs/zh-HK/docs/cli/market-data/broker-holding.md index 6f5740c4..27c5e0bd 100644 --- a/docs/zh-HK/docs/cli/market-data/broker-holding.md +++ b/docs/zh-HK/docs/cli/market-data/broker-holding.md @@ -4,7 +4,7 @@ sidebar_label: 'broker-holding' sidebar_position: 15 --- -:::warning Longbridge US 賬戶 +:::warning Longbridge US 賬戶不支援 此命令需要 AP 數據中心賬戶（香港/新加坡）。美股數據中心賬戶不支援此命令。AP 賬戶可操作任意標的，包括美股。 ::: diff --git a/docs/zh-HK/docs/fundamental/fundamental/operating.md b/docs/zh-HK/docs/fundamental/fundamental/operating.md index 795a5f6b..09f68b6f 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/operating.md +++ b/docs/zh-HK/docs/fundamental/fundamental/operating.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning Longbridge US 賬戶 +:::warning Longbridge US 賬戶不支援 此方法需要 AP 數據中心賬戶（香港/新加坡）。美股數據中心賬戶將收到區域限制錯誤。AP 賬戶可查詢任意標的，包括美股。 ::: diff --git a/docs/zh-HK/docs/fundamental/market/broker_holding_daily.md b/docs/zh-HK/docs/fundamental/market/broker_holding_daily.md index 681d8326..3be19139 100644 --- a/docs/zh-HK/docs/fundamental/market/broker_holding_daily.md +++ b/docs/zh-HK/docs/fundamental/market/broker_holding_daily.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning Longbridge US 賬戶 +:::warning Longbridge US 賬戶不支援 此方法需要 AP 數據中心賬戶（香港/新加坡）。美股數據中心賬戶將收到區域限制錯誤。AP 賬戶可查詢任意標的，包括美股。 ::: diff --git a/docs/zh-HK/docs/fundamental/market/broker_holding_detail.md b/docs/zh-HK/docs/fundamental/market/broker_holding_detail.md index 72634327..2e2c1e10 100644 --- a/docs/zh-HK/docs/fundamental/market/broker_holding_detail.md +++ b/docs/zh-HK/docs/fundamental/market/broker_holding_detail.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning Longbridge US 賬戶 +:::warning Longbridge US 賬戶不支援 此方法需要 AP 數據中心賬戶（香港/新加坡）。美股數據中心賬戶將收到區域限制錯誤。AP 賬戶可查詢任意標的，包括美股。 ::: diff --git a/docs/zh-HK/docs/fundamental/market/broker_positions.md b/docs/zh-HK/docs/fundamental/market/broker_positions.md index ba6bbaf7..39ba7189 100644 --- a/docs/zh-HK/docs/fundamental/market/broker_positions.md +++ b/docs/zh-HK/docs/fundamental/market/broker_positions.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning Longbridge US 賬戶 +:::warning Longbridge US 賬戶不支援 此方法需要 AP 數據中心賬戶（香港/新加坡）。美股數據中心賬戶將收到區域限制錯誤。AP 賬戶可查詢任意標的，包括美股。 ::: diff --git a/docs/zh-HK/docs/quote/stocks/brokers.md b/docs/zh-HK/docs/quote/stocks/brokers.md index a14db6c1..cbb52622 100644 --- a/docs/zh-HK/docs/quote/stocks/brokers.md +++ b/docs/zh-HK/docs/quote/stocks/brokers.md @@ -5,7 +5,7 @@ slug: /quote/pull/brokers sidebar_position: 6 --- -:::warning Longbridge US 賬戶 +:::warning Longbridge US 賬戶不支援 此方法需要 AP 數據中心賬戶（香港/新加坡）。美股數據中心賬戶將收到區域限制錯誤。AP 賬戶可查詢任意標的，包括美股。 ::: From f8ddb9342fe665cba686da926743f32a36c733cd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 17:56:46 +0800 Subject: [PATCH 35/51] docs: add AP-only warning to DCA SDK docs and broker subscribe doc (3 langs, 27 files) --- docs/en/docs/account/dca/create_dca.md | 4 ++++ docs/en/docs/account/dca/dca_history.md | 4 ++++ docs/en/docs/account/dca/dca_stats.md | 4 ++++ docs/en/docs/account/dca/list_dca.md | 4 ++++ docs/en/docs/account/dca/pause_dca.md | 4 ++++ docs/en/docs/account/dca/resume_dca.md | 4 ++++ docs/en/docs/account/dca/stop_dca.md | 4 ++++ docs/en/docs/account/dca/update_dca.md | 4 ++++ docs/en/docs/quote/subscribe/broker.md | 4 ++++ docs/zh-CN/docs/account/dca/create_dca.md | 4 ++++ docs/zh-CN/docs/account/dca/dca_history.md | 4 ++++ docs/zh-CN/docs/account/dca/dca_stats.md | 4 ++++ docs/zh-CN/docs/account/dca/list_dca.md | 4 ++++ docs/zh-CN/docs/account/dca/pause_dca.md | 4 ++++ docs/zh-CN/docs/account/dca/resume_dca.md | 4 ++++ docs/zh-CN/docs/account/dca/stop_dca.md | 4 ++++ docs/zh-CN/docs/account/dca/update_dca.md | 4 ++++ docs/zh-CN/docs/quote/subscribe/broker.md | 4 ++++ docs/zh-HK/docs/account/dca/create_dca.md | 4 ++++ docs/zh-HK/docs/account/dca/dca_history.md | 4 ++++ docs/zh-HK/docs/account/dca/dca_stats.md | 4 ++++ docs/zh-HK/docs/account/dca/list_dca.md | 4 ++++ docs/zh-HK/docs/account/dca/pause_dca.md | 4 ++++ docs/zh-HK/docs/account/dca/resume_dca.md | 4 ++++ docs/zh-HK/docs/account/dca/stop_dca.md | 4 ++++ docs/zh-HK/docs/account/dca/update_dca.md | 4 ++++ docs/zh-HK/docs/quote/subscribe/broker.md | 4 ++++ 27 files changed, 108 insertions(+) diff --git a/docs/en/docs/account/dca/create_dca.md b/docs/en/docs/account/dca/create_dca.md index 9e571659..e55a9fd0 100644 --- a/docs/en/docs/account/dca/create_dca.md +++ b/docs/en/docs/account/dca/create_dca.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Not for Longbridge US Accounts +This method requires an AP data-center account (HK / Singapore). US data-center accounts will receive a region restriction error. AP accounts can call this method with any supported symbol, including US stocks. +::: + Create a new recurring investment plan for a security. diff --git a/docs/en/docs/account/dca/dca_history.md b/docs/en/docs/account/dca/dca_history.md index d0c183fd..aac05375 100644 --- a/docs/en/docs/account/dca/dca_history.md +++ b/docs/en/docs/account/dca/dca_history.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Not for Longbridge US Accounts +This method requires an AP data-center account (HK / Singapore). US data-center accounts will receive a region restriction error. AP accounts can call this method with any supported symbol, including US stocks. +::: + Get the execution history for a specific DCA plan including trade dates, amounts, and prices. diff --git a/docs/en/docs/account/dca/dca_stats.md b/docs/en/docs/account/dca/dca_stats.md index 6148c39d..37a43aac 100644 --- a/docs/en/docs/account/dca/dca_stats.md +++ b/docs/en/docs/account/dca/dca_stats.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Not for Longbridge US Accounts +This method requires an AP data-center account (HK / Singapore). US data-center accounts will receive a region restriction error. AP accounts can call this method with any supported symbol, including US stocks. +::: + Get DCA statistics summary including total invested amount and profit/loss. diff --git a/docs/en/docs/account/dca/list_dca.md b/docs/en/docs/account/dca/list_dca.md index 4bebab31..ac0844ff 100644 --- a/docs/en/docs/account/dca/list_dca.md +++ b/docs/en/docs/account/dca/list_dca.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Not for Longbridge US Accounts +This method requires an AP data-center account (HK / Singapore). US data-center accounts will receive a region restriction error. AP accounts can call this method with any supported symbol, including US stocks. +::: + Get all recurring investment (DCA) plans for the current user. diff --git a/docs/en/docs/account/dca/pause_dca.md b/docs/en/docs/account/dca/pause_dca.md index 36f749db..a1be72cf 100644 --- a/docs/en/docs/account/dca/pause_dca.md +++ b/docs/en/docs/account/dca/pause_dca.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Not for Longbridge US Accounts +This method requires an AP data-center account (HK / Singapore). US data-center accounts will receive a region restriction error. AP accounts can call this method with any supported symbol, including US stocks. +::: + Temporarily pause a DCA plan. The plan can be resumed later. diff --git a/docs/en/docs/account/dca/resume_dca.md b/docs/en/docs/account/dca/resume_dca.md index 21665097..455924f0 100644 --- a/docs/en/docs/account/dca/resume_dca.md +++ b/docs/en/docs/account/dca/resume_dca.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Not for Longbridge US Accounts +This method requires an AP data-center account (HK / Singapore). US data-center accounts will receive a region restriction error. AP accounts can call this method with any supported symbol, including US stocks. +::: + Resume a previously paused DCA plan. diff --git a/docs/en/docs/account/dca/stop_dca.md b/docs/en/docs/account/dca/stop_dca.md index 142eb956..89140e90 100644 --- a/docs/en/docs/account/dca/stop_dca.md +++ b/docs/en/docs/account/dca/stop_dca.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Not for Longbridge US Accounts +This method requires an AP data-center account (HK / Singapore). US data-center accounts will receive a region restriction error. AP accounts can call this method with any supported symbol, including US stocks. +::: + Permanently stop a DCA plan. This action cannot be undone. diff --git a/docs/en/docs/account/dca/update_dca.md b/docs/en/docs/account/dca/update_dca.md index d8f6d937..3ab9bdc4 100644 --- a/docs/en/docs/account/dca/update_dca.md +++ b/docs/en/docs/account/dca/update_dca.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Not for Longbridge US Accounts +This method requires an AP data-center account (HK / Singapore). US data-center accounts will receive a region restriction error. AP accounts can call this method with any supported symbol, including US stocks. +::: + Pause or resume an existing recurring investment plan. diff --git a/docs/en/docs/quote/subscribe/broker.md b/docs/en/docs/quote/subscribe/broker.md index 1c41d4ae..13b5586a 100644 --- a/docs/en/docs/quote/subscribe/broker.md +++ b/docs/en/docs/quote/subscribe/broker.md @@ -5,6 +5,10 @@ slug: /quote/push/broker sidebar_position: 7 --- +:::warning Not for Longbridge US Accounts +This method requires an AP data-center account (HK / Singapore). US data-center accounts will receive a region restriction error. AP accounts can call this method with any supported symbol, including US stocks. +::: + Real-time brokers data push of the subscribed security. diff --git a/docs/zh-CN/docs/account/dca/create_dca.md b/docs/zh-CN/docs/account/dca/create_dca.md index c14e0f76..b4d7869b 100644 --- a/docs/zh-CN/docs/account/dca/create_dca.md +++ b/docs/zh-CN/docs/account/dca/create_dca.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Longbridge US 账户不支持 +此方法需要 AP 数据中心账户（香港/新加坡）。美股数据中心账户将收到区域限制错误。AP 账户可操作任意标的，包括美股。 +::: + 为指定证券创建新的定投。 diff --git a/docs/zh-CN/docs/account/dca/dca_history.md b/docs/zh-CN/docs/account/dca/dca_history.md index 9cf43a57..61f05c19 100644 --- a/docs/zh-CN/docs/account/dca/dca_history.md +++ b/docs/zh-CN/docs/account/dca/dca_history.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Longbridge US 账户不支持 +此方法需要 AP 数据中心账户（香港/新加坡）。美股数据中心账户将收到区域限制错误。AP 账户可操作任意标的，包括美股。 +::: + 获取指定定投的执行历史，包含交易日期、金额和价格。 diff --git a/docs/zh-CN/docs/account/dca/dca_stats.md b/docs/zh-CN/docs/account/dca/dca_stats.md index 61128f0b..3dd79625 100644 --- a/docs/zh-CN/docs/account/dca/dca_stats.md +++ b/docs/zh-CN/docs/account/dca/dca_stats.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Longbridge US 账户不支持 +此方法需要 AP 数据中心账户（香港/新加坡）。美股数据中心账户将收到区域限制错误。AP 账户可操作任意标的，包括美股。 +::: + 获取定投统计汇总信息，包括总投入金额和盈亏情况。 diff --git a/docs/zh-CN/docs/account/dca/list_dca.md b/docs/zh-CN/docs/account/dca/list_dca.md index 4c2a00b6..77d4b9fe 100644 --- a/docs/zh-CN/docs/account/dca/list_dca.md +++ b/docs/zh-CN/docs/account/dca/list_dca.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Longbridge US 账户不支持 +此方法需要 AP 数据中心账户（香港/新加坡）。美股数据中心账户将收到区域限制错误。AP 账户可操作任意标的，包括美股。 +::: + 获取当前用户的所有定投（DCA）计划。 diff --git a/docs/zh-CN/docs/account/dca/pause_dca.md b/docs/zh-CN/docs/account/dca/pause_dca.md index e640292f..e2e4ca8b 100644 --- a/docs/zh-CN/docs/account/dca/pause_dca.md +++ b/docs/zh-CN/docs/account/dca/pause_dca.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Longbridge US 账户不支持 +此方法需要 AP 数据中心账户（香港/新加坡）。美股数据中心账户将收到区域限制错误。AP 账户可操作任意标的，包括美股。 +::: + 暂停一个定投计划。计划暂停后可随时恢复。 diff --git a/docs/zh-CN/docs/account/dca/resume_dca.md b/docs/zh-CN/docs/account/dca/resume_dca.md index ef357495..2fc3e510 100644 --- a/docs/zh-CN/docs/account/dca/resume_dca.md +++ b/docs/zh-CN/docs/account/dca/resume_dca.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Longbridge US 账户不支持 +此方法需要 AP 数据中心账户（香港/新加坡）。美股数据中心账户将收到区域限制错误。AP 账户可操作任意标的，包括美股。 +::: + 恢复一个已暂停的定投计划。 diff --git a/docs/zh-CN/docs/account/dca/stop_dca.md b/docs/zh-CN/docs/account/dca/stop_dca.md index d29b7d64..53c7657b 100644 --- a/docs/zh-CN/docs/account/dca/stop_dca.md +++ b/docs/zh-CN/docs/account/dca/stop_dca.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Longbridge US 账户不支持 +此方法需要 AP 数据中心账户（香港/新加坡）。美股数据中心账户将收到区域限制错误。AP 账户可操作任意标的，包括美股。 +::: + 永久终止一个定投计划。此操作不可撤销。 diff --git a/docs/zh-CN/docs/account/dca/update_dca.md b/docs/zh-CN/docs/account/dca/update_dca.md index 94aadb8b..2f378b75 100644 --- a/docs/zh-CN/docs/account/dca/update_dca.md +++ b/docs/zh-CN/docs/account/dca/update_dca.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Longbridge US 账户不支持 +此方法需要 AP 数据中心账户（香港/新加坡）。美股数据中心账户将收到区域限制错误。AP 账户可操作任意标的，包括美股。 +::: + 暂停或恢复已有的定投。 diff --git a/docs/zh-CN/docs/quote/subscribe/broker.md b/docs/zh-CN/docs/quote/subscribe/broker.md index 0bbdcae4..c57a9f6e 100644 --- a/docs/zh-CN/docs/quote/subscribe/broker.md +++ b/docs/zh-CN/docs/quote/subscribe/broker.md @@ -5,6 +5,10 @@ slug: /quote/push/broker sidebar_position: 7 --- +:::warning Longbridge US 账户不支持 +此方法需要 AP 数据中心账户（香港/新加坡）。美股数据中心账户将收到区域限制错误。AP 账户可操作任意标的，包括美股。 +::: + 已订阅标的的实时经纪队列数据推送。 diff --git a/docs/zh-HK/docs/account/dca/create_dca.md b/docs/zh-HK/docs/account/dca/create_dca.md index 08f278c1..33624702 100644 --- a/docs/zh-HK/docs/account/dca/create_dca.md +++ b/docs/zh-HK/docs/account/dca/create_dca.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Longbridge US 賬戶不支援 +此方法需要 AP 數據中心賬戶（香港/新加坡）。美股數據中心賬戶將收到區域限制錯誤。AP 賬戶可操作任意標的，包括美股。 +::: + 為指定證券創建新的定投。 diff --git a/docs/zh-HK/docs/account/dca/dca_history.md b/docs/zh-HK/docs/account/dca/dca_history.md index 331ee075..30fc152d 100644 --- a/docs/zh-HK/docs/account/dca/dca_history.md +++ b/docs/zh-HK/docs/account/dca/dca_history.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Longbridge US 賬戶不支援 +此方法需要 AP 數據中心賬戶（香港/新加坡）。美股數據中心賬戶將收到區域限制錯誤。AP 賬戶可操作任意標的，包括美股。 +::: + 獲取指定定投的執行歷史，包含交易日期、金額和價格。 diff --git a/docs/zh-HK/docs/account/dca/dca_stats.md b/docs/zh-HK/docs/account/dca/dca_stats.md index 32f6bf1b..41d5742c 100644 --- a/docs/zh-HK/docs/account/dca/dca_stats.md +++ b/docs/zh-HK/docs/account/dca/dca_stats.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Longbridge US 賬戶不支援 +此方法需要 AP 數據中心賬戶（香港/新加坡）。美股數據中心賬戶將收到區域限制錯誤。AP 賬戶可操作任意標的，包括美股。 +::: + 獲取定投統計匯總信息，包括總投入金額和盈虧情況。 diff --git a/docs/zh-HK/docs/account/dca/list_dca.md b/docs/zh-HK/docs/account/dca/list_dca.md index 0f5b0bce..8cfa6b8b 100644 --- a/docs/zh-HK/docs/account/dca/list_dca.md +++ b/docs/zh-HK/docs/account/dca/list_dca.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Longbridge US 賬戶不支援 +此方法需要 AP 數據中心賬戶（香港/新加坡）。美股數據中心賬戶將收到區域限制錯誤。AP 賬戶可操作任意標的，包括美股。 +::: + 獲取當前用戶的所有定投（DCA）計劃。 diff --git a/docs/zh-HK/docs/account/dca/pause_dca.md b/docs/zh-HK/docs/account/dca/pause_dca.md index f75a5d78..fc15bf89 100644 --- a/docs/zh-HK/docs/account/dca/pause_dca.md +++ b/docs/zh-HK/docs/account/dca/pause_dca.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Longbridge US 賬戶不支援 +此方法需要 AP 數據中心賬戶（香港/新加坡）。美股數據中心賬戶將收到區域限制錯誤。AP 賬戶可操作任意標的，包括美股。 +::: + 暫停一個定投計劃。計劃暫停後可隨時恢復。 diff --git a/docs/zh-HK/docs/account/dca/resume_dca.md b/docs/zh-HK/docs/account/dca/resume_dca.md index 78a93488..347fcc65 100644 --- a/docs/zh-HK/docs/account/dca/resume_dca.md +++ b/docs/zh-HK/docs/account/dca/resume_dca.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Longbridge US 賬戶不支援 +此方法需要 AP 數據中心賬戶（香港/新加坡）。美股數據中心賬戶將收到區域限制錯誤。AP 賬戶可操作任意標的，包括美股。 +::: + 恢復一個已暫停的定投計劃。 diff --git a/docs/zh-HK/docs/account/dca/stop_dca.md b/docs/zh-HK/docs/account/dca/stop_dca.md index 86b37013..b65c9f5d 100644 --- a/docs/zh-HK/docs/account/dca/stop_dca.md +++ b/docs/zh-HK/docs/account/dca/stop_dca.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Longbridge US 賬戶不支援 +此方法需要 AP 數據中心賬戶（香港/新加坡）。美股數據中心賬戶將收到區域限制錯誤。AP 賬戶可操作任意標的，包括美股。 +::: + 永久終止一個定投計劃。此操作不可撤銷。 diff --git a/docs/zh-HK/docs/account/dca/update_dca.md b/docs/zh-HK/docs/account/dca/update_dca.md index 54e27f39..7b7fcfb4 100644 --- a/docs/zh-HK/docs/account/dca/update_dca.md +++ b/docs/zh-HK/docs/account/dca/update_dca.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Longbridge US 賬戶不支援 +此方法需要 AP 數據中心賬戶（香港/新加坡）。美股數據中心賬戶將收到區域限制錯誤。AP 賬戶可操作任意標的，包括美股。 +::: + 暫停或恢復已有的定投。 diff --git a/docs/zh-HK/docs/quote/subscribe/broker.md b/docs/zh-HK/docs/quote/subscribe/broker.md index 0da39448..911eb12d 100644 --- a/docs/zh-HK/docs/quote/subscribe/broker.md +++ b/docs/zh-HK/docs/quote/subscribe/broker.md @@ -5,6 +5,10 @@ slug: /quote/push/broker sidebar_position: 7 --- +:::warning Longbridge US 賬戶不支援 +此方法需要 AP 數據中心賬戶（香港/新加坡）。美股數據中心賬戶將收到區域限制錯誤。AP 賬戶可操作任意標的，包括美股。 +::: + 訂閱標的的實時經紀隊列數據。 From 1fb9f01dfe8200b5b4a52cbf1d0735f8620000f4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 17:59:24 +0800 Subject: [PATCH 36/51] =?UTF-8?q?docs:=20add=20AP-only=20warning=20to=20re?= =?UTF-8?q?maining=20DCA=20SDK=20docs=20(calc=5Fdate,=20check=5Fsupport,?= =?UTF-8?q?=20set=5Freminder=20=C3=97=203=20langs)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/en/docs/account/dca/calc_date.md | 4 ++++ docs/en/docs/account/dca/check_support.md | 4 ++++ docs/en/docs/account/dca/set_reminder.md | 4 ++++ docs/zh-CN/docs/account/dca/calc_date.md | 4 ++++ docs/zh-CN/docs/account/dca/check_support.md | 4 ++++ docs/zh-CN/docs/account/dca/set_reminder.md | 4 ++++ docs/zh-HK/docs/account/dca/calc_date.md | 4 ++++ docs/zh-HK/docs/account/dca/check_support.md | 4 ++++ docs/zh-HK/docs/account/dca/set_reminder.md | 4 ++++ 9 files changed, 36 insertions(+) diff --git a/docs/en/docs/account/dca/calc_date.md b/docs/en/docs/account/dca/calc_date.md index 5d7c8a1b..56894d87 100644 --- a/docs/en/docs/account/dca/calc_date.md +++ b/docs/en/docs/account/dca/calc_date.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Not for Longbridge US Accounts +This method requires an AP data-center account (HK / Singapore). US data-center accounts will receive a region restriction error. AP accounts can call this method with any supported symbol, including US stocks. +::: + Calculate the next projected trade date for given DCA plan parameters. diff --git a/docs/en/docs/account/dca/check_support.md b/docs/en/docs/account/dca/check_support.md index 50097b10..2f870d00 100644 --- a/docs/en/docs/account/dca/check_support.md +++ b/docs/en/docs/account/dca/check_support.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Not for Longbridge US Accounts +This method requires an AP data-center account (HK / Singapore). US data-center accounts will receive a region restriction error. AP accounts can call this method with any supported symbol, including US stocks. +::: + Check whether the given securities support DCA recurring investment. diff --git a/docs/en/docs/account/dca/set_reminder.md b/docs/en/docs/account/dca/set_reminder.md index 4bf64971..21e4af10 100644 --- a/docs/en/docs/account/dca/set_reminder.md +++ b/docs/en/docs/account/dca/set_reminder.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Not for Longbridge US Accounts +This method requires an AP data-center account (HK / Singapore). US data-center accounts will receive a region restriction error. AP accounts can call this method with any supported symbol, including US stocks. +::: + Set the advance reminder time for DCA plans. Supported values: `1`, `6`, or `12` hours. diff --git a/docs/zh-CN/docs/account/dca/calc_date.md b/docs/zh-CN/docs/account/dca/calc_date.md index 5c3d8e3c..bf04f4c3 100644 --- a/docs/zh-CN/docs/account/dca/calc_date.md +++ b/docs/zh-CN/docs/account/dca/calc_date.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Longbridge US 账户不支持 +此方法需要 AP 数据中心账户（香港/新加坡）。美股数据中心账户将收到区域限制错误。AP 账户可操作任意标的，包括美股。 +::: + 根据给定的定投计划参数，计算下一次预计交易日期。 diff --git a/docs/zh-CN/docs/account/dca/check_support.md b/docs/zh-CN/docs/account/dca/check_support.md index c8854e4a..5520e405 100644 --- a/docs/zh-CN/docs/account/dca/check_support.md +++ b/docs/zh-CN/docs/account/dca/check_support.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Longbridge US 账户不支持 +此方法需要 AP 数据中心账户（香港/新加坡）。美股数据中心账户将收到区域限制错误。AP 账户可操作任意标的，包括美股。 +::: + 检查指定标的是否支持定投。 diff --git a/docs/zh-CN/docs/account/dca/set_reminder.md b/docs/zh-CN/docs/account/dca/set_reminder.md index 9040ce7e..2ab6b826 100644 --- a/docs/zh-CN/docs/account/dca/set_reminder.md +++ b/docs/zh-CN/docs/account/dca/set_reminder.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Longbridge US 账户不支持 +此方法需要 AP 数据中心账户（香港/新加坡）。美股数据中心账户将收到区域限制错误。AP 账户可操作任意标的，包括美股。 +::: + 设置定投计划的提前提醒时间。支持的值：`1`、`6` 或 `12` 小时。 diff --git a/docs/zh-HK/docs/account/dca/calc_date.md b/docs/zh-HK/docs/account/dca/calc_date.md index 2217f715..73d393ea 100644 --- a/docs/zh-HK/docs/account/dca/calc_date.md +++ b/docs/zh-HK/docs/account/dca/calc_date.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Longbridge US 賬戶不支援 +此方法需要 AP 數據中心賬戶（香港/新加坡）。美股數據中心賬戶將收到區域限制錯誤。AP 賬戶可操作任意標的，包括美股。 +::: + 根據給定的定投計劃參數，計算下一次預計交易日期。 diff --git a/docs/zh-HK/docs/account/dca/check_support.md b/docs/zh-HK/docs/account/dca/check_support.md index ce93d483..cd7da69c 100644 --- a/docs/zh-HK/docs/account/dca/check_support.md +++ b/docs/zh-HK/docs/account/dca/check_support.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Longbridge US 賬戶不支援 +此方法需要 AP 數據中心賬戶（香港/新加坡）。美股數據中心賬戶將收到區域限制錯誤。AP 賬戶可操作任意標的，包括美股。 +::: + 檢查指定標的是否支持定投。 diff --git a/docs/zh-HK/docs/account/dca/set_reminder.md b/docs/zh-HK/docs/account/dca/set_reminder.md index d497b79a..059c9411 100644 --- a/docs/zh-HK/docs/account/dca/set_reminder.md +++ b/docs/zh-HK/docs/account/dca/set_reminder.md @@ -10,6 +10,10 @@ highlight_theme: '' headingLevel: 2 --- +:::warning Longbridge US 賬戶不支援 +此方法需要 AP 數據中心賬戶（香港/新加坡）。美股數據中心賬戶將收到區域限制錯誤。AP 賬戶可操作任意標的，包括美股。 +::: + 設置定投計劃的提前提醒時間。支持的值：`1`、`6` 或 `12` 小時。 From 4cf2a96a4190efb226dff2618979ad078b59350e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 18:04:20 +0800 Subject: [PATCH 37/51] fix(docs): standardize zh-HK US warning title + fix Rust positional arg syntax --- docs/en/docs/fundamental/fundamental/us_analyst_consensus.md | 2 +- docs/en/docs/fundamental/fundamental/us_financial_overview.md | 2 +- .../docs/fundamental/fundamental/us_financial_statement_v3.md | 2 +- .../docs/fundamental/fundamental/us_key_financial_metrics.md | 2 +- docs/en/docs/trade/asset/us_realized_pl.md | 2 +- .../docs/fundamental/fundamental/us_analyst_consensus.md | 2 +- .../docs/fundamental/fundamental/us_financial_overview.md | 2 +- .../docs/fundamental/fundamental/us_financial_statement_v3.md | 2 +- .../docs/fundamental/fundamental/us_key_financial_metrics.md | 2 +- docs/zh-CN/docs/trade/asset/us_realized_pl.md | 2 +- .../docs/fundamental/fundamental/us_analyst_consensus.md | 4 ++-- .../docs/fundamental/fundamental/us_company_dividends.md | 2 +- .../zh-HK/docs/fundamental/fundamental/us_company_overview.md | 2 +- .../docs/fundamental/fundamental/us_etf_dividend_info.md | 2 +- docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md | 2 +- .../docs/fundamental/fundamental/us_financial_overview.md | 4 ++-- .../docs/fundamental/fundamental/us_financial_statement_v3.md | 4 ++-- .../docs/fundamental/fundamental/us_key_financial_metrics.md | 4 ++-- .../docs/fundamental/fundamental/us_valuation_overview.md | 2 +- docs/zh-HK/docs/quote/stocks/us_crypto_overview.md | 2 +- docs/zh-HK/docs/trade/asset/us_asset_overview.md | 2 +- docs/zh-HK/docs/trade/asset/us_realized_pl.md | 4 ++-- docs/zh-HK/docs/trade/order/us_order_detail.md | 2 +- docs/zh-HK/docs/trade/order/us_query_orders.md | 2 +- 24 files changed, 29 insertions(+), 29 deletions(-) diff --git a/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md index 6a35dd97..f8f39b83 100644 --- a/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md @@ -113,7 +113,7 @@ async fn main() -> Result<(), Box> { let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("Open: {url}")).await?; let config = Arc::new(Config::from_oauth(oauth)); let ctx = FundamentalContext::new(config); - let resp = ctx.us_analyst_consensus("AAPL.US", report="annual").await?; + let resp = ctx.us_analyst_consensus("AAPL.US", "annual").await?; println!("{:?}", resp); Ok(()) } diff --git a/docs/en/docs/fundamental/fundamental/us_financial_overview.md b/docs/en/docs/fundamental/fundamental/us_financial_overview.md index 143e5c40..56859f18 100644 --- a/docs/en/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/en/docs/fundamental/fundamental/us_financial_overview.md @@ -113,7 +113,7 @@ async fn main() -> Result<(), Box> { let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("Open: {url}")).await?; let config = Arc::new(Config::from_oauth(oauth)); let ctx = FundamentalContext::new(config); - let resp = ctx.us_financial_overview("AAPL.US", report="annual").await?; + let resp = ctx.us_financial_overview("AAPL.US", "annual").await?; println!("{:?}", resp); Ok(()) } diff --git a/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md index f91bd4c3..f3397aef 100644 --- a/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -115,7 +115,7 @@ async fn main() -> Result<(), Box> { let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("Open: {url}")).await?; let config = Arc::new(Config::from_oauth(oauth)); let ctx = FundamentalContext::new(config); - let resp = ctx.us_financial_statement_v3("AAPL.US", kind="IS", report="annual").await?; + let resp = ctx.us_financial_statement_v3("AAPL.US", "IS", "annual").await?; println!("{:?}", resp); Ok(()) } diff --git a/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md index 137c2677..7c0862b9 100644 --- a/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -113,7 +113,7 @@ async fn main() -> Result<(), Box> { let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("Open: {url}")).await?; let config = Arc::new(Config::from_oauth(oauth)); let ctx = FundamentalContext::new(config); - let resp = ctx.us_key_financial_metrics("AAPL.US", report="annual").await?; + let resp = ctx.us_key_financial_metrics("AAPL.US", "annual").await?; println!("{:?}", resp); Ok(()) } diff --git a/docs/en/docs/trade/asset/us_realized_pl.md b/docs/en/docs/trade/asset/us_realized_pl.md index 4b0daeed..3ede6cf1 100644 --- a/docs/en/docs/trade/asset/us_realized_pl.md +++ b/docs/en/docs/trade/asset/us_realized_pl.md @@ -114,7 +114,7 @@ async fn main() -> Result<(), Box> { let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("Open: {url}")).await?; let config = Arc::new(Config::from_oauth(oauth)); let ctx = TradeContext::new(config); - let resp = ctx.us_realized_pl("USD", category="STOCK").await?; + let resp = ctx.us_realized_pl("USD", "STOCK").await?; println!("{:?}", resp); Ok(()) } diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md index 549db205..af1c21f9 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md @@ -113,7 +113,7 @@ async fn main() -> Result<(), Box> { let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("请访问：{url}")).await?; let config = Arc::new(Config::from_oauth(oauth)); let ctx = FundamentalContext::new(config); - let resp = ctx.us_analyst_consensus("AAPL.US", report="annual").await?; + let resp = ctx.us_analyst_consensus("AAPL.US", "annual").await?; println!("{:?}", resp); Ok(()) } diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md index f008883b..b2d21774 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md @@ -113,7 +113,7 @@ async fn main() -> Result<(), Box> { let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("请访问：{url}")).await?; let config = Arc::new(Config::from_oauth(oauth)); let ctx = FundamentalContext::new(config); - let resp = ctx.us_financial_overview("AAPL.US", report="annual").await?; + let resp = ctx.us_financial_overview("AAPL.US", "annual").await?; println!("{:?}", resp); Ok(()) } diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md index e5b79792..a1a65654 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -115,7 +115,7 @@ async fn main() -> Result<(), Box> { let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("请访问：{url}")).await?; let config = Arc::new(Config::from_oauth(oauth)); let ctx = FundamentalContext::new(config); - let resp = ctx.us_financial_statement_v3("AAPL.US", kind="IS", report="annual").await?; + let resp = ctx.us_financial_statement_v3("AAPL.US", "IS", "annual").await?; println!("{:?}", resp); Ok(()) } diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md index cdb6b211..1d566bb1 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -113,7 +113,7 @@ async fn main() -> Result<(), Box> { let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("请访问：{url}")).await?; let config = Arc::new(Config::from_oauth(oauth)); let ctx = FundamentalContext::new(config); - let resp = ctx.us_key_financial_metrics("AAPL.US", report="annual").await?; + let resp = ctx.us_key_financial_metrics("AAPL.US", "annual").await?; println!("{:?}", resp); Ok(()) } diff --git a/docs/zh-CN/docs/trade/asset/us_realized_pl.md b/docs/zh-CN/docs/trade/asset/us_realized_pl.md index c5da9fc8..85cd2226 100644 --- a/docs/zh-CN/docs/trade/asset/us_realized_pl.md +++ b/docs/zh-CN/docs/trade/asset/us_realized_pl.md @@ -114,7 +114,7 @@ async fn main() -> Result<(), Box> { let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("请访问：{url}")).await?; let config = Arc::new(Config::from_oauth(oauth)); let ctx = TradeContext::new(config); - let resp = ctx.us_realized_pl("USD", category="STOCK").await?; + let resp = ctx.us_realized_pl("USD", "STOCK").await?; println!("{:?}", resp); Ok(()) } diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md index 6a73535f..0e084651 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 僅限美股賬戶 +:::warning Longbridge US 賬戶 此方法僅適用於美國數據中心賬戶。 ::: @@ -113,7 +113,7 @@ async fn main() -> Result<(), Box> { let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("請訪問：{url}")).await?; let config = Arc::new(Config::from_oauth(oauth)); let ctx = FundamentalContext::new(config); - let resp = ctx.us_analyst_consensus("AAPL.US", report="annual").await?; + let resp = ctx.us_analyst_consensus("AAPL.US", "annual").await?; println!("{:?}", resp); Ok(()) } diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md b/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md index ee334c94..bab7f979 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 僅限美股賬戶 +:::warning Longbridge US 賬戶 此方法僅適用於美國數據中心賬戶。 ::: diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md index e0eafb7a..c91a1783 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 僅限美股賬戶 +:::warning Longbridge US 賬戶 此方法僅適用於美國數據中心賬戶。 ::: diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md index 99f4eeea..a7fd27b6 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 僅限美股賬戶 +:::warning Longbridge US 賬戶 此方法僅適用於美國數據中心賬戶。 ::: diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md b/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md index 64c33ca9..d9abddc3 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 僅限美股賬戶 +:::warning Longbridge US 賬戶 此方法僅適用於美國數據中心賬戶。 ::: diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md index 2e94517d..f41ed892 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 僅限美股賬戶 +:::warning Longbridge US 賬戶 此方法僅適用於美國數據中心賬戶。 ::: @@ -113,7 +113,7 @@ async fn main() -> Result<(), Box> { let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("請訪問：{url}")).await?; let config = Arc::new(Config::from_oauth(oauth)); let ctx = FundamentalContext::new(config); - let resp = ctx.us_financial_overview("AAPL.US", report="annual").await?; + let resp = ctx.us_financial_overview("AAPL.US", "annual").await?; println!("{:?}", resp); Ok(()) } diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md index fe94b202..1f199a1c 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 僅限美股賬戶 +:::warning Longbridge US 賬戶 此方法僅適用於美國數據中心賬戶。 ::: @@ -115,7 +115,7 @@ async fn main() -> Result<(), Box> { let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("請訪問：{url}")).await?; let config = Arc::new(Config::from_oauth(oauth)); let ctx = FundamentalContext::new(config); - let resp = ctx.us_financial_statement_v3("AAPL.US", kind="IS", report="annual").await?; + let resp = ctx.us_financial_statement_v3("AAPL.US", "IS", "annual").await?; println!("{:?}", resp); Ok(()) } diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md index ab35aef5..4d768042 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 僅限美股賬戶 +:::warning Longbridge US 賬戶 此方法僅適用於美國數據中心賬戶。 ::: @@ -113,7 +113,7 @@ async fn main() -> Result<(), Box> { let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("請訪問：{url}")).await?; let config = Arc::new(Config::from_oauth(oauth)); let ctx = FundamentalContext::new(config); - let resp = ctx.us_key_financial_metrics("AAPL.US", report="annual").await?; + let resp = ctx.us_key_financial_metrics("AAPL.US", "annual").await?; println!("{:?}", resp); Ok(()) } diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md index 658f6a9e..3eabcbf6 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 僅限美股賬戶 +:::warning Longbridge US 賬戶 此方法僅適用於美國數據中心賬戶。 ::: diff --git a/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md b/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md index 1faa390a..6458591a 100644 --- a/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md +++ b/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 僅限美股賬戶 +:::warning Longbridge US 賬戶 此方法僅適用於美國數據中心賬戶。 ::: diff --git a/docs/zh-HK/docs/trade/asset/us_asset_overview.md b/docs/zh-HK/docs/trade/asset/us_asset_overview.md index 45b363fa..6ebee52d 100644 --- a/docs/zh-HK/docs/trade/asset/us_asset_overview.md +++ b/docs/zh-HK/docs/trade/asset/us_asset_overview.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 僅限美股賬戶 +:::warning Longbridge US 賬戶 此方法僅適用於美國數據中心賬戶。 ::: diff --git a/docs/zh-HK/docs/trade/asset/us_realized_pl.md b/docs/zh-HK/docs/trade/asset/us_realized_pl.md index cfecf394..7e774686 100644 --- a/docs/zh-HK/docs/trade/asset/us_realized_pl.md +++ b/docs/zh-HK/docs/trade/asset/us_realized_pl.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 僅限美股賬戶 +:::warning Longbridge US 賬戶 此方法僅適用於美國數據中心賬戶。 ::: @@ -114,7 +114,7 @@ async fn main() -> Result<(), Box> { let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("請訪問：{url}")).await?; let config = Arc::new(Config::from_oauth(oauth)); let ctx = TradeContext::new(config); - let resp = ctx.us_realized_pl("USD", category="STOCK").await?; + let resp = ctx.us_realized_pl("USD", "STOCK").await?; println!("{:?}", resp); Ok(()) } diff --git a/docs/zh-HK/docs/trade/order/us_order_detail.md b/docs/zh-HK/docs/trade/order/us_order_detail.md index 6fd9a7fc..cae8fbb6 100644 --- a/docs/zh-HK/docs/trade/order/us_order_detail.md +++ b/docs/zh-HK/docs/trade/order/us_order_detail.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 僅限美股賬戶 +:::warning Longbridge US 賬戶 此方法僅適用於美國數據中心賬戶。 ::: diff --git a/docs/zh-HK/docs/trade/order/us_query_orders.md b/docs/zh-HK/docs/trade/order/us_query_orders.md index 0dd8f334..4b8d39e8 100644 --- a/docs/zh-HK/docs/trade/order/us_query_orders.md +++ b/docs/zh-HK/docs/trade/order/us_query_orders.md @@ -10,7 +10,7 @@ highlight_theme: '' headingLevel: 2 --- -:::warning 僅限美股賬戶 +:::warning Longbridge US 賬戶 此方法僅適用於美國數據中心賬戶。 ::: From 305685e4496046a0d7c8cff39b7e6cebc08e7820 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 18:07:31 +0800 Subject: [PATCH 38/51] fix(docs): localize zh-CN/zh-HK Response headings, Schemas descriptions, and print statements --- .../fundamental/us_analyst_consensus.md | 4 +-- .../fundamental/us_company_dividends.md | 18 +++++------ .../fundamental/us_company_overview.md | 16 +++++----- .../fundamental/us_etf_dividend_info.md | 22 ++++++------- .../fundamental/fundamental/us_etf_files.md | 10 +++--- .../fundamental/us_financial_overview.md | 4 +-- .../fundamental/us_financial_statement_v3.md | 20 ++++++------ .../fundamental/us_key_financial_metrics.md | 4 +-- .../fundamental/us_valuation_overview.md | 18 +++++------ .../docs/quote/stocks/us_crypto_overview.md | 22 ++++++------- .../docs/trade/asset/us_asset_overview.md | 24 +++++++------- docs/zh-CN/docs/trade/asset/us_realized_pl.md | 18 +++++------ .../zh-CN/docs/trade/order/us_order_detail.md | 32 +++++++++---------- .../zh-CN/docs/trade/order/us_query_orders.md | 26 +++++++-------- .../fundamental/us_analyst_consensus.md | 4 +-- .../fundamental/us_company_dividends.md | 18 +++++------ .../fundamental/us_company_overview.md | 16 +++++----- .../fundamental/us_etf_dividend_info.md | 22 ++++++------- .../fundamental/fundamental/us_etf_files.md | 10 +++--- .../fundamental/us_financial_overview.md | 4 +-- .../fundamental/us_financial_statement_v3.md | 20 ++++++------ .../fundamental/us_key_financial_metrics.md | 4 +-- .../fundamental/us_valuation_overview.md | 18 +++++------ .../docs/quote/stocks/us_crypto_overview.md | 22 ++++++------- .../docs/trade/asset/us_asset_overview.md | 24 +++++++------- docs/zh-HK/docs/trade/asset/us_realized_pl.md | 18 +++++------ .../zh-HK/docs/trade/order/us_order_detail.md | 32 +++++++++---------- .../zh-HK/docs/trade/order/us_query_orders.md | 26 +++++++-------- 28 files changed, 238 insertions(+), 238 deletions(-) diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md index af1c21f9..2f78ab18 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md @@ -39,7 +39,7 @@ longbridge consensus NVDA.US ```python from longbridge.openapi import FundamentalContext, Config, OAuthBuilder -oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +oauth = OAuthBuilder("your-client-id").build(lambda url: print("请访问：", url)) config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_analyst_consensus("AAPL.US", report="annual") @@ -158,7 +158,7 @@ func main() { 返回结构灵活的 JSON 对象，包含分析师一致预期数据（营收/EPS 预测、目标价分布、买入/持有/卖出分布），具体字段因数据可用性而异。 -### 响应 Status +### 响应状态 | 状态码 | 描述 | 结构 | | ------ | ---- | ---- | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md b/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md index 48850517..49b15ebe 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md @@ -38,7 +38,7 @@ longbridge dividend MSFT.US ```python from longbridge.openapi import FundamentalContext, Config, OAuthBuilder -oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +oauth = OAuthBuilder("your-client-id").build(lambda url: print("请访问：", url)) config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_company_dividends("AAPL.US") @@ -156,7 +156,7 @@ func main() { ## 响应 -### 响应 Example +### 响应示例 ```json { @@ -171,7 +171,7 @@ func main() { } ``` -### 响应 Status +### 响应状态 | 状态码 | 描述 | 结构 | | ------ | ---- | ---- | @@ -186,9 +186,9 @@ func main() { | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| dividend_ttm | string | true | 过去 12 个月每股股息 | -| dividend_yield_ttm | string | true | TTM 股息率（%） | -| payouts | string | true | 过去一年派息次数 | -| currency | string | true | 货币代码，如 `USD` | -| items | USDividendItem[] | false | 逐笔分红记录 | -| ∟ dividend | string | true | 每股分红金额 | +| dividend_ttm | string | 是 | 过去 12 个月每股股息 | +| dividend_yield_ttm | string | 是 | TTM 股息率（%） | +| payouts | string | 是 | 过去一年派息次数 | +| currency | string | 是 | 货币代码，如 `USD` | +| items | USDividendItem[] | 否 | 逐笔分红记录 | +| ∟ dividend | string | 是 | 每股分红金额 | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md index 3ff6dfc1..65e4d821 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md @@ -38,7 +38,7 @@ longbridge company TSLA.US ```python from longbridge.openapi import FundamentalContext, Config, OAuthBuilder -oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +oauth = OAuthBuilder("your-client-id").build(lambda url: print("请访问：", url)) config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_company_overview("AAPL.US") @@ -155,7 +155,7 @@ func main() { ## 响应 -### 响应 Example +### 响应示例 ```json { @@ -167,7 +167,7 @@ func main() { } ``` -### 响应 Status +### 响应状态 | 状态码 | 描述 | 结构 | | ------ | ---- | ---- | @@ -182,8 +182,8 @@ func main() { | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| intro | string | true | 公司简介 | -| market_cap | string | true | 市值 | -| ccy_symbol | string | true | 货币符号 | -| top_rank_tags | string[] | false | 排名标签列表 | -| detail_url | string | false | 公司详情页链接 | +| intro | string | 是 | 公司简介 | +| market_cap | string | 是 | 市值 | +| ccy_symbol | string | 是 | 货币符号 | +| top_rank_tags | string[] | 否 | 排名标签列表 | +| detail_url | string | 否 | 公司详情页链接 | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md index b81e6e86..79531f2f 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -38,7 +38,7 @@ longbridge dividend SPY.US ```python from longbridge.openapi import FundamentalContext, Config, OAuthBuilder -oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +oauth = OAuthBuilder("your-client-id").build(lambda url: print("请访问：", url)) config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_etf_dividend_info("IVV.US") @@ -156,7 +156,7 @@ func main() { ## 响应 -### 响应 Example +### 响应示例 ```json { @@ -176,7 +176,7 @@ func main() { } ``` -### 响应 Status +### 响应状态 | 状态码 | 描述 | 结构 | | ------ | ---- | ---- | @@ -191,11 +191,11 @@ func main() { | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| dividend_ttm | string | true | 过去 12 个月每股股息 | -| dividend_yield_ttm | string | true | TTM 股息率（%） | -| dividend_freq | string | true | 派息频率（如 `Quarterly`） | -| currency | string | true | 货币代码，如 `USD` | -| fiscal_year_info | FiscalYearDividend[] | false | Annual dividend breakdown | -| ∟ year | string | true | 财年 | -| ∟ total_dividend | string | true | 年度总股息 | -| ∟ records | object[] | false | 逐笔支付记录 | +| dividend_ttm | string | 是 | 过去 12 个月每股股息 | +| dividend_yield_ttm | string | 是 | TTM 股息率（%） | +| dividend_freq | string | 是 | 派息频率（如 `Quarterly`） | +| currency | string | 是 | 货币代码，如 `USD` | +| fiscal_year_info | FiscalYearDividend[] | 否 | 按财年分列的年度分红明细 | +| ∟ year | string | 是 | 财年 | +| ∟ total_dividend | string | 是 | 年度总股息 | +| ∟ records | object[] | 否 | 逐笔支付记录 | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md b/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md index dc95940d..12a28af4 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md @@ -39,7 +39,7 @@ longbridge etf-docs SPY.US ```python from longbridge.openapi import FundamentalContext, Config, OAuthBuilder -oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +oauth = OAuthBuilder("your-client-id").build(lambda url: print("请访问：", url)) config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_etf_files("IVV.US") @@ -156,7 +156,7 @@ func main() { ## 响应 -### 响应 Example +### 响应示例 ```json { @@ -167,7 +167,7 @@ func main() { } ``` -### 响应 Status +### 响应状态 | 状态码 | 描述 | 结构 | | ------ | ---- | ---- | @@ -182,5 +182,5 @@ func main() { | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| files | ETFFile[] | true | ETF 监管文件列表 | -| ∟ name | string | true | 文件名称 | +| files | ETFFile[] | 是 | ETF 监管文件列表 | +| ∟ name | string | 是 | 文件名称 | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md index b2d21774..38141312 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md @@ -39,7 +39,7 @@ longbridge financial-report TSLA.US ```python from longbridge.openapi import FundamentalContext, Config, OAuthBuilder -oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +oauth = OAuthBuilder("your-client-id").build(lambda url: print("请访问：", url)) config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_financial_overview("AAPL.US", report="annual") @@ -158,7 +158,7 @@ func main() { 返回结构灵活的 JSON 对象，内容因公司和报告周期而异，包含损益、资产负债和现金流摘要数据。 -### 响应 Status +### 响应状态 | 状态码 | 描述 | 结构 | | ------ | ---- | ---- | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md index a1a65654..097b2447 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -41,7 +41,7 @@ longbridge financial-report AAPL.US --kind BS ```python from longbridge.openapi import FundamentalContext, Config, OAuthBuilder -oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +oauth = OAuthBuilder("your-client-id").build(lambda url: print("请访问：", url)) config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_financial_statement_v3("AAPL.US", kind="IS", report="annual") @@ -159,7 +159,7 @@ func main() { ## 响应 -### 响应 Example +### 响应示例 ```json { @@ -179,7 +179,7 @@ func main() { } ``` -### 响应 Status +### 响应状态 | 状态码 | 描述 | 结构 | | ------ | ---- | ---- | @@ -194,10 +194,10 @@ func main() { | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| revenue | string | true | 总营收 | -| net_income | string | true | 净利润 | -| net_margin | string | true | 净利润率 | -| periods | FinancialPeriod[] | true | 包含逐行数据的报告期列表 | -| ∟ date | string | true | 报告期日期 | -| ∟ values | map[string]any | true | 以指标名称为键的财务行项目 | -| currency | string | true | 货币代码，如 `USD` | +| revenue | string | 是 | 总营收 | +| net_income | string | 是 | 净利润 | +| net_margin | string | 是 | 净利润率 | +| periods | FinancialPeriod[] | 是 | 包含逐行数据的报告期列表 | +| ∟ date | string | 是 | 报告期日期 | +| ∟ values | map[string]any | 是 | 以指标名称为键的财务行项目 | +| currency | string | 是 | 货币代码，如 `USD` | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md index 1d566bb1..ce6c57a9 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -39,7 +39,7 @@ longbridge financial-report key-metrics AAPL.US --report quarterly ```python from longbridge.openapi import FundamentalContext, Config, OAuthBuilder -oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +oauth = OAuthBuilder("your-client-id").build(lambda url: print("请访问：", url)) config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_key_financial_metrics("AAPL.US", report="annual") @@ -158,7 +158,7 @@ func main() { 返回结构灵活的 JSON 对象，包含关键财务指标（营收、净利润、EPS、利润率和增长率），具体字段因公司而异。 -### 响应 Status +### 响应状态 | 状态码 | 描述 | 结构 | | ------ | ---- | ---- | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md index 9ef9816e..3c6d5033 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md @@ -38,7 +38,7 @@ longbridge valuation NVDA.US ```python from longbridge.openapi import FundamentalContext, Config, OAuthBuilder -oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +oauth = OAuthBuilder("your-client-id").build(lambda url: print("请访问：", url)) config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_valuation_overview("AAPL.US") @@ -155,7 +155,7 @@ func main() { ## 响应 -### 响应 Example +### 响应示例 ```json { @@ -169,7 +169,7 @@ func main() { } ``` -### 响应 Status +### 响应状态 | 状态码 | 描述 | 结构 | | ------ | ---- | ---- | @@ -184,9 +184,9 @@ func main() { | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| indicator | string | true | 估值指标名称（如 `PE`、`PB`） | -| current_indicator | object | true | 当前估值数据 | -| ∟ circle | string | true | 当前指标数值 | -| range | int | true | 历史百分位（0–100） | -| date | string | true | 估值日期 | -| ai_summary | string | false | AI 生成的估值摘要 | +| indicator | string | 是 | 估值指标名称（如 `PE`、`PB`） | +| current_indicator | object | 是 | 当前估值数据 | +| ∟ circle | string | 是 | 当前指标数值 | +| range | int | 是 | 历史百分位（0–100） | +| date | string | 是 | 估值日期 | +| ai_summary | string | 否 | AI 生成的估值摘要 | diff --git a/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md b/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md index a0d7fdac..e3ac6445 100644 --- a/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md +++ b/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md @@ -146,7 +146,7 @@ fmt.Printf("%+v\n", resp) ## 响应 -### 响应 Example +### 响应示例 ```json { @@ -162,7 +162,7 @@ fmt.Printf("%+v\n", resp) } ``` -### 响应 Status +### 响应状态 | 状态码 | 描述 | 结构 | | ------ | ---- | ---- | @@ -177,12 +177,12 @@ fmt.Printf("%+v\n", resp) | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| symbol | string | true | 交易对代码，如 `DOGEUSD.BKKT` | -| name | string | true | 资产名称 | -| ticker | string | true | 简短代码 | -| base_asset | string | true | 基础资产代码，如 `DOGE` | -| currency | string | true | 计价货币，如 `USD` | -| all_time_high | string | true | 历史最高价 | -| all_time_high_date | string | true | 历史最高价日期 | -| all_time_low | string | true | 历史最低价 | -| all_time_low_date | string | true | 历史最低价日期 | +| symbol | string | 是 | 交易对代码，如 `DOGEUSD.BKKT` | +| name | string | 是 | 资产名称 | +| ticker | string | 是 | 简短代码 | +| base_asset | string | 是 | 基础资产代码，如 `DOGE` | +| currency | string | 是 | 计价货币，如 `USD` | +| all_time_high | string | 是 | 历史最高价 | +| all_time_high_date | string | 是 | 历史最高价日期 | +| all_time_low | string | 是 | 历史最低价 | +| all_time_low_date | string | 是 | 历史最低价日期 | diff --git a/docs/zh-CN/docs/trade/asset/us_asset_overview.md b/docs/zh-CN/docs/trade/asset/us_asset_overview.md index e2d698b4..cade837a 100644 --- a/docs/zh-CN/docs/trade/asset/us_asset_overview.md +++ b/docs/zh-CN/docs/trade/asset/us_asset_overview.md @@ -131,7 +131,7 @@ fmt.Printf("%+v\n", resp) ## 响应 -### 响应 Example +### 响应示例 ```json { @@ -148,7 +148,7 @@ fmt.Printf("%+v\n", resp) } ``` -### 响应 Status +### 响应状态 | 状态码 | 描述 | 结构 | | ------ | ---- | ---- | @@ -163,12 +163,12 @@ fmt.Printf("%+v\n", resp) | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| account_type | string | true | 账户类型标识 | -| asset_timestamp | int64 | true | 资产数据快照时间（Unix 秒） | -| cash_buy_power | string | true | 可用买入力 | -| cash_list | USCashEntry[] | false | 按货币分列的现金余额 | -| stock_list | USStockEntry[] | false | 股票持仓 | -| crypto_list | USCryptoEntry[] | false | 加密货币持仓 | +| account_type | string | 是 | 账户类型标识 | +| asset_timestamp | int64 | 是 | 资产数据快照时间（Unix 秒） | +| cash_buy_power | string | 是 | 可用买入力 | +| cash_list | USCashEntry[] | 否 | 按货币分列的现金余额 | +| stock_list | USStockEntry[] | 否 | 股票持仓 | +| crypto_list | USCryptoEntry[] | 否 | 加密货币持仓 | ### USCashEntry @@ -176,8 +176,8 @@ fmt.Printf("%+v\n", resp) | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| currency | string | true | 货币代码，如 `USD` | -| amount | string | true | 现金金额 | +| currency | string | 是 | 货币代码，如 `USD` | +| amount | string | 是 | 现金金额 | ### USCryptoEntry @@ -185,5 +185,5 @@ fmt.Printf("%+v\n", resp) | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| symbol | string | true | 加密货币交易对代码 | -| quantity | string | true | 持有数量 | +| symbol | string | 是 | 加密货币交易对代码 | +| quantity | string | 是 | 持有数量 | diff --git a/docs/zh-CN/docs/trade/asset/us_realized_pl.md b/docs/zh-CN/docs/trade/asset/us_realized_pl.md index 85cd2226..76da7298 100644 --- a/docs/zh-CN/docs/trade/asset/us_realized_pl.md +++ b/docs/zh-CN/docs/trade/asset/us_realized_pl.md @@ -137,7 +137,7 @@ fmt.Printf("%+v\n", resp) ## 响应 -### 响应 Example +### 响应示例 ```json { @@ -160,7 +160,7 @@ fmt.Printf("%+v\n", resp) } ``` -### 响应 Status +### 响应状态 | 状态码 | 描述 | 结构 | | ------ | ---- | ---- | @@ -175,7 +175,7 @@ fmt.Printf("%+v\n", resp) | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| realized_pl_list | USRealizedPLEntry[] | true | 按资产类别分列的盈亏明细 | +| realized_pl_list | USRealizedPLEntry[] | 是 | 按资产类别分列的盈亏明细 | ### USRealizedPLEntry @@ -183,9 +183,9 @@ fmt.Printf("%+v\n", resp) | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| category | int | true | 资产类别：`1`=股票，`2`=期权，`3`=加密货币 | -| currency | string | true | 货币代码，如 `USD` | -| metrics | USRealizedPLMetric[] | true | 按时期分列的盈亏指标 | +| category | int | 是 | 资产类别：`1`=股票，`2`=期权，`3`=加密货币 | +| currency | string | 是 | 货币代码，如 `USD` | +| metrics | USRealizedPLMetric[] | 是 | 按时期分列的盈亏指标 | ### USRealizedPLMetric @@ -193,6 +193,6 @@ fmt.Printf("%+v\n", resp) | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| amount | string | true | 已实现盈亏金额 | -| period | int | true | 时间周期 | -| rate | string | true | 收益率（%） | +| amount | string | 是 | 已实现盈亏金额 | +| period | int | 是 | 时间周期 | +| rate | string | 是 | 收益率（%） | diff --git a/docs/zh-CN/docs/trade/order/us_order_detail.md b/docs/zh-CN/docs/trade/order/us_order_detail.md index b2f43827..b74d7f5b 100644 --- a/docs/zh-CN/docs/trade/order/us_order_detail.md +++ b/docs/zh-CN/docs/trade/order/us_order_detail.md @@ -134,7 +134,7 @@ fmt.Printf("%+v\n", resp) ## 响应 -### 响应 Example +### 响应示例 ```json { @@ -157,7 +157,7 @@ fmt.Printf("%+v\n", resp) } ``` -### 响应 Status +### 响应状态 | 状态码 | 描述 | 结构 | | ------ | ---- | ---- | @@ -172,9 +172,9 @@ fmt.Printf("%+v\n", resp) | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| order | USOrder | true | 完整委托详情 | -| order_histories | USOrderHistory[] | true | 历史状态变更记录 | -| current_attached_order | USOrder \| null | false | 关联子委托（括号单/OCO），无则为 null | +| order | USOrder | 是 | 完整委托详情 | +| order_histories | USOrderHistory[] | 是 | 历史状态变更记录 | +| current_attached_order | USOrder \| null | 否 | 关联子委托（括号单/OCO），无则为 null | ### USOrder @@ -182,15 +182,15 @@ fmt.Printf("%+v\n", resp) | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| order_id | string | true | 委托唯一 ID | -| symbol | string | true | 交易标的，如 `AAPL.US` | -| side | string | true | `Buy`（买入）或 `Sell`（卖出） | -| status | string | true | 委托状态 | -| qty | string | true | 委托数量 | -| price | string | true | 委托价格 | -| executed_qty | string | true | 已成交数量 | -| executed_price | string | true | 平均成交价格 | -| created_at | int64 | true | 创建时间（Unix 秒） | +| order_id | string | 是 | 委托唯一 ID | +| symbol | string | 是 | 交易标的，如 `AAPL.US` | +| side | string | 是 | `Buy`（买入）或 `Sell`（卖出） | +| status | string | 是 | 委托状态 | +| qty | string | 是 | 委托数量 | +| price | string | 是 | 委托价格 | +| executed_qty | string | 是 | 已成交数量 | +| executed_price | string | 是 | 平均成交价格 | +| created_at | int64 | 是 | 创建时间（Unix 秒） | ### USOrderHistory @@ -198,5 +198,5 @@ fmt.Printf("%+v\n", resp) | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| status | string | true | 委托状态 at this point | -| done_at | int64 | true | 时间戳（Unix 秒） | +| status | string | 是 | 委托状态 at this point | +| done_at | int64 | 是 | 时间戳（Unix 秒） | diff --git a/docs/zh-CN/docs/trade/order/us_query_orders.md b/docs/zh-CN/docs/trade/order/us_query_orders.md index cbc75ddb..881e8053 100644 --- a/docs/zh-CN/docs/trade/order/us_query_orders.md +++ b/docs/zh-CN/docs/trade/order/us_query_orders.md @@ -141,7 +141,7 @@ fmt.Printf("%+v\n", resp) ## 响应 -### 响应 Example +### 响应示例 ```json { @@ -162,7 +162,7 @@ fmt.Printf("%+v\n", resp) } ``` -### 响应 Status +### 响应状态 | 状态码 | 描述 | 结构 | | ------ | ---- | ---- | @@ -177,8 +177,8 @@ fmt.Printf("%+v\n", resp) | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| orders | USOrder[] | true | 符合筛选条件的委托列表 | -| total_count | int | true | 满足条件的委托总数 | +| orders | USOrder[] | 是 | 符合筛选条件的委托列表 | +| total_count | int | 是 | 满足条件的委托总数 | ### USOrder @@ -186,12 +186,12 @@ fmt.Printf("%+v\n", resp) | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| order_id | string | true | 委托唯一 ID | -| symbol | string | true | 交易标的，如 `AAPL.US` | -| side | string | true | `Buy`（买入）或 `Sell`（卖出） | -| status | string | true | 委托状态（如 `Filled`、`New`、`PartialFilled`） | -| qty | string | true | 委托数量 | -| price | string | true | 委托价格 | -| executed_qty | string | true | 已成交数量 | -| executed_price | string | true | 平均成交价格 | -| created_at | int64 | true | 创建时间（Unix 秒） | +| order_id | string | 是 | 委托唯一 ID | +| symbol | string | 是 | 交易标的，如 `AAPL.US` | +| side | string | 是 | `Buy`（买入）或 `Sell`（卖出） | +| status | string | 是 | 委托状态（如 `Filled`、`New`、`PartialFilled`） | +| qty | string | 是 | 委托数量 | +| price | string | 是 | 委托价格 | +| executed_qty | string | 是 | 已成交数量 | +| executed_price | string | 是 | 平均成交价格 | +| created_at | int64 | 是 | 创建时间（Unix 秒） | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md index 0e084651..ca501357 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md @@ -39,7 +39,7 @@ longbridge consensus NVDA.US ```python from longbridge.openapi import FundamentalContext, Config, OAuthBuilder -oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +oauth = OAuthBuilder("your-client-id").build(lambda url: print("請訪問：", url)) config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_analyst_consensus("AAPL.US", report="annual") @@ -158,7 +158,7 @@ func main() { 返回結構靈活的 JSON 對象，包含分析師一致預期數據（營收/EPS 預測、目標價分佈、買入/持有/賣出分佈），具體字段因數據可用性而異。 -### 響應 Status +### 響應狀態 | 狀態碼 | 描述 | 結構 | | ------ | ---- | ---- | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md b/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md index bab7f979..978c88c7 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md @@ -38,7 +38,7 @@ longbridge dividend MSFT.US ```python from longbridge.openapi import FundamentalContext, Config, OAuthBuilder -oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +oauth = OAuthBuilder("your-client-id").build(lambda url: print("請訪問：", url)) config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_company_dividends("AAPL.US") @@ -156,7 +156,7 @@ func main() { ## 響應 -### 響應 Example +### 響應示例 ```json { @@ -171,7 +171,7 @@ func main() { } ``` -### 響應 Status +### 響應狀態 | 狀態碼 | 描述 | 結構 | | ------ | ---- | ---- | @@ -186,9 +186,9 @@ func main() { | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| dividend_ttm | string | true | 過去 12 個月每股股息 | -| dividend_yield_ttm | string | true | TTM 股息率（%） | -| payouts | string | true | 過去一年派息次數 | -| currency | string | true | 貨幣代碼，如 `USD` | -| items | USDividendItem[] | false | 逐筆分紅記錄 | -| ∟ dividend | string | true | 每股分紅金額 | +| dividend_ttm | string | 是 | 過去 12 個月每股股息 | +| dividend_yield_ttm | string | 是 | TTM 股息率（%） | +| payouts | string | 是 | 過去一年派息次數 | +| currency | string | 是 | 貨幣代碼，如 `USD` | +| items | USDividendItem[] | 否 | 逐筆分紅記錄 | +| ∟ dividend | string | 是 | 每股分紅金額 | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md index c91a1783..d9809504 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md @@ -38,7 +38,7 @@ longbridge company TSLA.US ```python from longbridge.openapi import FundamentalContext, Config, OAuthBuilder -oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +oauth = OAuthBuilder("your-client-id").build(lambda url: print("請訪問：", url)) config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_company_overview("AAPL.US") @@ -155,7 +155,7 @@ func main() { ## 響應 -### 響應 Example +### 響應示例 ```json { @@ -167,7 +167,7 @@ func main() { } ``` -### 響應 Status +### 響應狀態 | 狀態碼 | 描述 | 結構 | | ------ | ---- | ---- | @@ -182,8 +182,8 @@ func main() { | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| intro | string | true | 公司簡介 | -| market_cap | string | true | 市值 | -| ccy_symbol | string | true | 貨幣符號 | -| top_rank_tags | string[] | false | 排名標籤列表 | -| detail_url | string | false | 公司詳情頁連結 | +| intro | string | 是 | 公司簡介 | +| market_cap | string | 是 | 市值 | +| ccy_symbol | string | 是 | 貨幣符號 | +| top_rank_tags | string[] | 否 | 排名標籤列表 | +| detail_url | string | 否 | 公司詳情頁連結 | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md index a7fd27b6..7937641c 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -38,7 +38,7 @@ longbridge dividend SPY.US ```python from longbridge.openapi import FundamentalContext, Config, OAuthBuilder -oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +oauth = OAuthBuilder("your-client-id").build(lambda url: print("請訪問：", url)) config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_etf_dividend_info("IVV.US") @@ -156,7 +156,7 @@ func main() { ## 響應 -### 響應 Example +### 響應示例 ```json { @@ -176,7 +176,7 @@ func main() { } ``` -### 響應 Status +### 響應狀態 | 狀態碼 | 描述 | 結構 | | ------ | ---- | ---- | @@ -191,11 +191,11 @@ func main() { | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| dividend_ttm | string | true | 過去 12 個月每股股息 | -| dividend_yield_ttm | string | true | TTM 股息率（%） | -| dividend_freq | string | true | 派息頻率（如 `Quarterly`） | -| currency | string | true | 貨幣代碼，如 `USD` | -| fiscal_year_info | FiscalYearDividend[] | false | Annual dividend breakdown | -| ∟ year | string | true | 財年 | -| ∟ total_dividend | string | true | 年度總股息 | -| ∟ records | object[] | false | 逐筆支付記錄 | +| dividend_ttm | string | 是 | 過去 12 個月每股股息 | +| dividend_yield_ttm | string | 是 | TTM 股息率（%） | +| dividend_freq | string | 是 | 派息頻率（如 `Quarterly`） | +| currency | string | 是 | 貨幣代碼，如 `USD` | +| fiscal_year_info | FiscalYearDividend[] | 否 | 按財年分列的年度分紅明細 | +| ∟ year | string | 是 | 財年 | +| ∟ total_dividend | string | 是 | 年度總股息 | +| ∟ records | object[] | 否 | 逐筆支付記錄 | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md b/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md index d9abddc3..f7184ff1 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md @@ -39,7 +39,7 @@ longbridge etf-docs SPY.US ```python from longbridge.openapi import FundamentalContext, Config, OAuthBuilder -oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +oauth = OAuthBuilder("your-client-id").build(lambda url: print("請訪問：", url)) config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_etf_files("IVV.US") @@ -156,7 +156,7 @@ func main() { ## 響應 -### 響應 Example +### 響應示例 ```json { @@ -167,7 +167,7 @@ func main() { } ``` -### 響應 Status +### 響應狀態 | 狀態碼 | 描述 | 結構 | | ------ | ---- | ---- | @@ -182,5 +182,5 @@ func main() { | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| files | ETFFile[] | true | ETF 監管文件列表 | -| ∟ name | string | true | 文件名稱 | +| files | ETFFile[] | 是 | ETF 監管文件列表 | +| ∟ name | string | 是 | 文件名稱 | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md index f41ed892..80b11c57 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md @@ -39,7 +39,7 @@ longbridge financial-report TSLA.US ```python from longbridge.openapi import FundamentalContext, Config, OAuthBuilder -oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +oauth = OAuthBuilder("your-client-id").build(lambda url: print("請訪問：", url)) config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_financial_overview("AAPL.US", report="annual") @@ -158,7 +158,7 @@ func main() { 返回結構靈活的 JSON 對象，內容因公司和報告週期而異，包含損益、資產負債和現金流摘要數據。 -### 響應 Status +### 響應狀態 | 狀態碼 | 描述 | 結構 | | ------ | ---- | ---- | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md index 1f199a1c..dac81486 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -41,7 +41,7 @@ longbridge financial-report AAPL.US --kind BS ```python from longbridge.openapi import FundamentalContext, Config, OAuthBuilder -oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +oauth = OAuthBuilder("your-client-id").build(lambda url: print("請訪問：", url)) config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_financial_statement_v3("AAPL.US", kind="IS", report="annual") @@ -159,7 +159,7 @@ func main() { ## 響應 -### 響應 Example +### 響應示例 ```json { @@ -179,7 +179,7 @@ func main() { } ``` -### 響應 Status +### 響應狀態 | 狀態碼 | 描述 | 結構 | | ------ | ---- | ---- | @@ -194,10 +194,10 @@ func main() { | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| revenue | string | true | 總營收 | -| net_income | string | true | 淨利潤 | -| net_margin | string | true | 淨利潤率 | -| periods | FinancialPeriod[] | true | 包含逐行數據的報告期列表 | -| ∟ date | string | true | 報告期日期 | -| ∟ values | map[string]any | true | 以指標名稱為鍵的財務行項目 | -| currency | string | true | 貨幣代碼，如 `USD` | +| revenue | string | 是 | 總營收 | +| net_income | string | 是 | 淨利潤 | +| net_margin | string | 是 | 淨利潤率 | +| periods | FinancialPeriod[] | 是 | 包含逐行數據的報告期列表 | +| ∟ date | string | 是 | 報告期日期 | +| ∟ values | map[string]any | 是 | 以指標名稱為鍵的財務行項目 | +| currency | string | 是 | 貨幣代碼，如 `USD` | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md index 4d768042..f8d1547e 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -39,7 +39,7 @@ longbridge financial-report key-metrics AAPL.US --report quarterly ```python from longbridge.openapi import FundamentalContext, Config, OAuthBuilder -oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +oauth = OAuthBuilder("your-client-id").build(lambda url: print("請訪問：", url)) config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_key_financial_metrics("AAPL.US", report="annual") @@ -158,7 +158,7 @@ func main() { 返回結構靈活的 JSON 對象，包含關鍵財務指標（營收、淨利潤、EPS、利潤率和增長率），具體字段因公司而異。 -### 響應 Status +### 響應狀態 | 狀態碼 | 描述 | 結構 | | ------ | ---- | ---- | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md index 3eabcbf6..b77795bb 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md @@ -38,7 +38,7 @@ longbridge valuation NVDA.US ```python from longbridge.openapi import FundamentalContext, Config, OAuthBuilder -oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) +oauth = OAuthBuilder("your-client-id").build(lambda url: print("請訪問：", url)) config = Config.from_oauth(oauth) ctx = FundamentalContext(config) resp = ctx.us_valuation_overview("AAPL.US") @@ -155,7 +155,7 @@ func main() { ## 響應 -### 響應 Example +### 響應示例 ```json { @@ -169,7 +169,7 @@ func main() { } ``` -### 響應 Status +### 響應狀態 | 狀態碼 | 描述 | 結構 | | ------ | ---- | ---- | @@ -184,9 +184,9 @@ func main() { | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| indicator | string | true | 估值指標名稱（如 `PE`、`PB`） | -| current_indicator | object | true | 當前估值數據 | -| ∟ circle | string | true | 當前指標數值 | -| range | int | true | 歷史百分位（0–100） | -| date | string | true | 估值日期 | -| ai_summary | string | false | AI 生成的估值摘要 | +| indicator | string | 是 | 估值指標名稱（如 `PE`、`PB`） | +| current_indicator | object | 是 | 當前估值數據 | +| ∟ circle | string | 是 | 當前指標數值 | +| range | int | 是 | 歷史百分位（0–100） | +| date | string | 是 | 估值日期 | +| ai_summary | string | 否 | AI 生成的估值摘要 | diff --git a/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md b/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md index 6458591a..56c823d9 100644 --- a/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md +++ b/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md @@ -146,7 +146,7 @@ fmt.Printf("%+v\n", resp) ## 響應 -### 響應 Example +### 響應示例 ```json { @@ -162,7 +162,7 @@ fmt.Printf("%+v\n", resp) } ``` -### 響應 Status +### 響應狀態 | 狀態碼 | 描述 | 結構 | | ------ | ---- | ---- | @@ -177,12 +177,12 @@ fmt.Printf("%+v\n", resp) | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| symbol | string | true | 交易對代碼，如 `DOGEUSD.BKKT` | -| name | string | true | 資產名稱 | -| ticker | string | true | 簡短代碼 | -| base_asset | string | true | 基礎資產代碼，如 `DOGE` | -| currency | string | true | 計價貨幣，如 `USD` | -| all_time_high | string | true | 歷史最高價 | -| all_time_high_date | string | true | 歷史最高價日期 | -| all_time_low | string | true | 歷史最低價 | -| all_time_low_date | string | true | 歷史最低價日期 | +| symbol | string | 是 | 交易對代碼，如 `DOGEUSD.BKKT` | +| name | string | 是 | 資產名稱 | +| ticker | string | 是 | 簡短代碼 | +| base_asset | string | 是 | 基礎資產代碼，如 `DOGE` | +| currency | string | 是 | 計價貨幣，如 `USD` | +| all_time_high | string | 是 | 歷史最高價 | +| all_time_high_date | string | 是 | 歷史最高價日期 | +| all_time_low | string | 是 | 歷史最低價 | +| all_time_low_date | string | 是 | 歷史最低價日期 | diff --git a/docs/zh-HK/docs/trade/asset/us_asset_overview.md b/docs/zh-HK/docs/trade/asset/us_asset_overview.md index 6ebee52d..feb47977 100644 --- a/docs/zh-HK/docs/trade/asset/us_asset_overview.md +++ b/docs/zh-HK/docs/trade/asset/us_asset_overview.md @@ -131,7 +131,7 @@ fmt.Printf("%+v\n", resp) ## 響應 -### 響應 Example +### 響應示例 ```json { @@ -148,7 +148,7 @@ fmt.Printf("%+v\n", resp) } ``` -### 響應 Status +### 響應狀態 | 狀態碼 | 描述 | 結構 | | ------ | ---- | ---- | @@ -163,12 +163,12 @@ fmt.Printf("%+v\n", resp) | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| account_type | string | true | 賬戶類型標識 | -| asset_timestamp | int64 | true | 資產數據快照時間（Unix 秒） | -| cash_buy_power | string | true | 可用買入力 | -| cash_list | USCashEntry[] | false | 按貨幣分列的現金餘額 | -| stock_list | USStockEntry[] | false | 股票持倉 | -| crypto_list | USCryptoEntry[] | false | 加密貨幣持倉 | +| account_type | string | 是 | 賬戶類型標識 | +| asset_timestamp | int64 | 是 | 資產數據快照時間（Unix 秒） | +| cash_buy_power | string | 是 | 可用買入力 | +| cash_list | USCashEntry[] | 否 | 按貨幣分列的現金餘額 | +| stock_list | USStockEntry[] | 否 | 股票持倉 | +| crypto_list | USCryptoEntry[] | 否 | 加密貨幣持倉 | ### USCashEntry @@ -176,8 +176,8 @@ fmt.Printf("%+v\n", resp) | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| currency | string | true | 貨幣代碼，如 `USD` | -| amount | string | true | 現金金額 | +| currency | string | 是 | 貨幣代碼，如 `USD` | +| amount | string | 是 | 現金金額 | ### USCryptoEntry @@ -185,5 +185,5 @@ fmt.Printf("%+v\n", resp) | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| symbol | string | true | 加密貨幣交易對代碼 | -| quantity | string | true | 持有數量 | +| symbol | string | 是 | 加密貨幣交易對代碼 | +| quantity | string | 是 | 持有數量 | diff --git a/docs/zh-HK/docs/trade/asset/us_realized_pl.md b/docs/zh-HK/docs/trade/asset/us_realized_pl.md index 7e774686..89ff3db6 100644 --- a/docs/zh-HK/docs/trade/asset/us_realized_pl.md +++ b/docs/zh-HK/docs/trade/asset/us_realized_pl.md @@ -137,7 +137,7 @@ fmt.Printf("%+v\n", resp) ## 響應 -### 響應 Example +### 響應示例 ```json { @@ -160,7 +160,7 @@ fmt.Printf("%+v\n", resp) } ``` -### 響應 Status +### 響應狀態 | 狀態碼 | 描述 | 結構 | | ------ | ---- | ---- | @@ -175,7 +175,7 @@ fmt.Printf("%+v\n", resp) | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| realized_pl_list | USRealizedPLEntry[] | true | 按資產類別分列的盈虧明細 | +| realized_pl_list | USRealizedPLEntry[] | 是 | 按資產類別分列的盈虧明細 | ### USRealizedPLEntry @@ -183,9 +183,9 @@ fmt.Printf("%+v\n", resp) | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| category | int | true | 資產類別：`1`=股票，`2`=期權，`3`=加密貨幣 | -| currency | string | true | 貨幣代碼，如 `USD` | -| metrics | USRealizedPLMetric[] | true | 按時期分列的盈虧指標 | +| category | int | 是 | 資產類別：`1`=股票，`2`=期權，`3`=加密貨幣 | +| currency | string | 是 | 貨幣代碼，如 `USD` | +| metrics | USRealizedPLMetric[] | 是 | 按時期分列的盈虧指標 | ### USRealizedPLMetric @@ -193,6 +193,6 @@ fmt.Printf("%+v\n", resp) | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| amount | string | true | 已實現盈虧金額 | -| period | int | true | 時間週期 | -| rate | string | true | 收益率（%） | +| amount | string | 是 | 已實現盈虧金額 | +| period | int | 是 | 時間週期 | +| rate | string | 是 | 收益率（%） | diff --git a/docs/zh-HK/docs/trade/order/us_order_detail.md b/docs/zh-HK/docs/trade/order/us_order_detail.md index cae8fbb6..77caa91c 100644 --- a/docs/zh-HK/docs/trade/order/us_order_detail.md +++ b/docs/zh-HK/docs/trade/order/us_order_detail.md @@ -134,7 +134,7 @@ fmt.Printf("%+v\n", resp) ## 響應 -### 響應 Example +### 響應示例 ```json { @@ -157,7 +157,7 @@ fmt.Printf("%+v\n", resp) } ``` -### 響應 Status +### 響應狀態 | 狀態碼 | 描述 | 結構 | | ------ | ---- | ---- | @@ -172,9 +172,9 @@ fmt.Printf("%+v\n", resp) | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| order | USOrder | true | 完整委託詳情 | -| order_histories | USOrderHistory[] | true | 歷史狀態變更記錄 | -| current_attached_order | USOrder \| null | false | 關聯子委託（括號單/OCO），無則為 null | +| order | USOrder | 是 | 完整委託詳情 | +| order_histories | USOrderHistory[] | 是 | 歷史狀態變更記錄 | +| current_attached_order | USOrder \| null | 否 | 關聯子委託（括號單/OCO），無則為 null | ### USOrder @@ -182,15 +182,15 @@ fmt.Printf("%+v\n", resp) | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| order_id | string | true | 委託唯一 ID | -| symbol | string | true | 交易標的，如 `AAPL.US` | -| side | string | true | `Buy`（買入）或 `Sell`（賣出） | -| status | string | true | 委託狀態 | -| qty | string | true | 委託數量 | -| price | string | true | 委託價格 | -| executed_qty | string | true | 已成交數量 | -| executed_price | string | true | 平均成交價格 | -| created_at | int64 | true | 創建時間（Unix 秒） | +| order_id | string | 是 | 委託唯一 ID | +| symbol | string | 是 | 交易標的，如 `AAPL.US` | +| side | string | 是 | `Buy`（買入）或 `Sell`（賣出） | +| status | string | 是 | 委託狀態 | +| qty | string | 是 | 委託數量 | +| price | string | 是 | 委託價格 | +| executed_qty | string | 是 | 已成交數量 | +| executed_price | string | 是 | 平均成交價格 | +| created_at | int64 | 是 | 創建時間（Unix 秒） | ### USOrderHistory @@ -198,5 +198,5 @@ fmt.Printf("%+v\n", resp) | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| status | string | true | 委託狀態 at this point | -| done_at | int64 | true | 時間戳（Unix 秒） | +| status | string | 是 | 委託狀態 at this point | +| done_at | int64 | 是 | 時間戳（Unix 秒） | diff --git a/docs/zh-HK/docs/trade/order/us_query_orders.md b/docs/zh-HK/docs/trade/order/us_query_orders.md index 4b8d39e8..e5e4b8f6 100644 --- a/docs/zh-HK/docs/trade/order/us_query_orders.md +++ b/docs/zh-HK/docs/trade/order/us_query_orders.md @@ -141,7 +141,7 @@ fmt.Printf("%+v\n", resp) ## 響應 -### 響應 Example +### 響應示例 ```json { @@ -162,7 +162,7 @@ fmt.Printf("%+v\n", resp) } ``` -### 響應 Status +### 響應狀態 | 狀態碼 | 描述 | 結構 | | ------ | ---- | ---- | @@ -177,8 +177,8 @@ fmt.Printf("%+v\n", resp) | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| orders | USOrder[] | true | 符合篩選條件的委託列表 | -| total_count | int | true | 滿足條件的委託總數 | +| orders | USOrder[] | 是 | 符合篩選條件的委託列表 | +| total_count | int | 是 | 滿足條件的委託總數 | ### USOrder @@ -186,12 +186,12 @@ fmt.Printf("%+v\n", resp) | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| order_id | string | true | 委託唯一 ID | -| symbol | string | true | 交易標的，如 `AAPL.US` | -| side | string | true | `Buy`（買入）或 `Sell`（賣出） | -| status | string | true | 委託狀態（如 `Filled`、`New`、`PartialFilled`） | -| qty | string | true | 委託數量 | -| price | string | true | 委託價格 | -| executed_qty | string | true | 已成交數量 | -| executed_price | string | true | 平均成交價格 | -| created_at | int64 | true | 創建時間（Unix 秒） | +| order_id | string | 是 | 委託唯一 ID | +| symbol | string | 是 | 交易標的，如 `AAPL.US` | +| side | string | 是 | `Buy`（買入）或 `Sell`（賣出） | +| status | string | 是 | 委託狀態（如 `Filled`、`New`、`PartialFilled`） | +| qty | string | 是 | 委託數量 | +| price | string | 是 | 委託價格 | +| executed_qty | string | 是 | 已成交數量 | +| executed_price | string | 是 | 平均成交價格 | +| created_at | int64 | 是 | 創建時間（Unix 秒） | From e0850eb172e8d3ee843a0768ed4fe575699cb35e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 18:28:27 +0800 Subject: [PATCH 39/51] =?UTF-8?q?fix(docs):=20align=20US=20SDK=20docs=20wi?= =?UTF-8?q?th=20existing=20doc=20structure=20=E2=80=94=20Parameters=20capt?= =?UTF-8?q?ion,=20Go=20code=20style=20(42=20files)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../fundamental/us_analyst_consensus.md | 18 ++++++++++++++---- .../fundamental/us_company_dividends.md | 18 ++++++++++++++---- .../fundamental/us_company_overview.md | 18 ++++++++++++++---- .../fundamental/us_etf_dividend_info.md | 18 ++++++++++++++---- .../fundamental/fundamental/us_etf_files.md | 18 ++++++++++++++---- .../fundamental/us_financial_overview.md | 18 ++++++++++++++---- .../fundamental/us_financial_statement_v3.md | 18 ++++++++++++++---- .../fundamental/us_key_financial_metrics.md | 18 ++++++++++++++---- .../fundamental/us_valuation_overview.md | 18 ++++++++++++++---- .../en/docs/quote/stocks/us_crypto_overview.md | 2 ++ docs/en/docs/trade/asset/us_realized_pl.md | 2 ++ docs/en/docs/trade/order/us_order_detail.md | 2 ++ docs/en/docs/trade/order/us_query_orders.md | 2 ++ .../fundamental/us_analyst_consensus.md | 18 ++++++++++++++---- .../fundamental/us_company_dividends.md | 18 ++++++++++++++---- .../fundamental/us_company_overview.md | 18 ++++++++++++++---- .../fundamental/us_etf_dividend_info.md | 18 ++++++++++++++---- .../fundamental/fundamental/us_etf_files.md | 18 ++++++++++++++---- .../fundamental/us_financial_overview.md | 18 ++++++++++++++---- .../fundamental/us_financial_statement_v3.md | 18 ++++++++++++++---- .../fundamental/us_key_financial_metrics.md | 18 ++++++++++++++---- .../fundamental/us_valuation_overview.md | 18 ++++++++++++++---- .../docs/quote/stocks/us_crypto_overview.md | 2 ++ docs/zh-CN/docs/trade/asset/us_realized_pl.md | 2 ++ docs/zh-CN/docs/trade/order/us_order_detail.md | 2 ++ docs/zh-CN/docs/trade/order/us_query_orders.md | 2 ++ .../fundamental/us_analyst_consensus.md | 18 ++++++++++++++---- .../fundamental/us_company_dividends.md | 18 ++++++++++++++---- .../fundamental/us_company_overview.md | 18 ++++++++++++++---- .../fundamental/us_etf_dividend_info.md | 18 ++++++++++++++---- .../fundamental/fundamental/us_etf_files.md | 18 ++++++++++++++---- .../fundamental/us_financial_overview.md | 18 ++++++++++++++---- .../fundamental/us_financial_statement_v3.md | 18 ++++++++++++++---- .../fundamental/us_key_financial_metrics.md | 18 ++++++++++++++---- .../fundamental/us_valuation_overview.md | 18 ++++++++++++++---- .../docs/quote/stocks/us_crypto_overview.md | 2 ++ docs/zh-HK/docs/trade/asset/us_realized_pl.md | 2 ++ docs/zh-HK/docs/trade/order/us_order_detail.md | 2 ++ docs/zh-HK/docs/trade/order/us_query_orders.md | 2 ++ 39 files changed, 402 insertions(+), 108 deletions(-) diff --git a/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md index f8f39b83..6d8d00c0 100644 --- a/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md @@ -26,6 +26,8 @@ longbridge consensus NVDA.US ## Parameters +> **SDK method parameters.** + | Name | Type | Required | Description | | ---- | ---- | -------- | ----------- | | symbol | string | YES | Stock symbol, e.g. `AAPL.US` | @@ -137,15 +139,23 @@ import ( func main() { o := oauth.New("your-client-id"). - OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) if err := o.Build(context.Background()); err != nil { log.Fatal(err) } - conf, _ := config.New(config.WithOAuthClient(o)) - c, _ := fundamental.NewFromCfg(conf) + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := fundamental.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } defer c.Close() resp, err := c.AnalystConsensus(context.Background(), "AAPL.US", "annual") - if err != nil { log.Fatal(err) } + if err != nil { + log.Fatal(err) + } fmt.Printf("%+v\n", resp) } ``` diff --git a/docs/en/docs/fundamental/fundamental/us_company_dividends.md b/docs/en/docs/fundamental/fundamental/us_company_dividends.md index 2ba4b06b..9e77c7e3 100644 --- a/docs/en/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/en/docs/fundamental/fundamental/us_company_dividends.md @@ -26,6 +26,8 @@ longbridge dividend MSFT.US ## Parameters +> **SDK method parameters.** + | Name | Type | Required | Description | | ---- | ---- | -------- | ----------- | | symbol | string | YES | Stock symbol, e.g. `AAPL.US` | @@ -136,15 +138,23 @@ import ( func main() { o := oauth.New("your-client-id"). - OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) if err := o.Build(context.Background()); err != nil { log.Fatal(err) } - conf, _ := config.New(config.WithOAuthClient(o)) - c, _ := fundamental.NewFromCfg(conf) + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := fundamental.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } defer c.Close() resp, err := c.CompanyDividends(context.Background(), "AAPL.US") - if err != nil { log.Fatal(err) } + if err != nil { + log.Fatal(err) + } fmt.Printf("%+v\n", resp) } ``` diff --git a/docs/en/docs/fundamental/fundamental/us_company_overview.md b/docs/en/docs/fundamental/fundamental/us_company_overview.md index 4f5150fd..be6ae11d 100644 --- a/docs/en/docs/fundamental/fundamental/us_company_overview.md +++ b/docs/en/docs/fundamental/fundamental/us_company_overview.md @@ -26,6 +26,8 @@ longbridge company TSLA.US ## Parameters +> **SDK method parameters.** + | Name | Type | Required | Description | | ---- | ---- | -------- | ----------- | | symbol | string | YES | Stock symbol, e.g. `AAPL.US` | @@ -136,15 +138,23 @@ import ( func main() { o := oauth.New("your-client-id"). - OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) if err := o.Build(context.Background()); err != nil { log.Fatal(err) } - conf, _ := config.New(config.WithOAuthClient(o)) - c, _ := fundamental.NewFromCfg(conf) + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := fundamental.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } defer c.Close() resp, err := c.CompanyOverview(context.Background(), "AAPL.US") - if err != nil { log.Fatal(err) } + if err != nil { + log.Fatal(err) + } fmt.Printf("%+v\n", resp) } ``` diff --git a/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md index 445125a5..b388370c 100644 --- a/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -26,6 +26,8 @@ longbridge dividend SPY.US ## Parameters +> **SDK method parameters.** + | Name | Type | Required | Description | | ---- | ---- | -------- | ----------- | | symbol | string | YES | ETF symbol, e.g. `IVV.US` | @@ -136,15 +138,23 @@ import ( func main() { o := oauth.New("your-client-id"). - OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) if err := o.Build(context.Background()); err != nil { log.Fatal(err) } - conf, _ := config.New(config.WithOAuthClient(o)) - c, _ := fundamental.NewFromCfg(conf) + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := fundamental.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } defer c.Close() resp, err := c.ETFDividendInfo(context.Background(), "IVV.US") - if err != nil { log.Fatal(err) } + if err != nil { + log.Fatal(err) + } fmt.Printf("%+v\n", resp) } ``` diff --git a/docs/en/docs/fundamental/fundamental/us_etf_files.md b/docs/en/docs/fundamental/fundamental/us_etf_files.md index 2d5e0556..5a8c9a80 100644 --- a/docs/en/docs/fundamental/fundamental/us_etf_files.md +++ b/docs/en/docs/fundamental/fundamental/us_etf_files.md @@ -26,6 +26,8 @@ longbridge etf-docs SPY.US ## Parameters +> **SDK method parameters.** + | Name | Type | Required | Description | | ---- | ---- | -------- | ----------- | | symbol | string | YES | ETF symbol, e.g. `IVV.US` | @@ -137,15 +139,23 @@ import ( func main() { o := oauth.New("your-client-id"). - OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) if err := o.Build(context.Background()); err != nil { log.Fatal(err) } - conf, _ := config.New(config.WithOAuthClient(o)) - c, _ := fundamental.NewFromCfg(conf) + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := fundamental.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } defer c.Close() resp, err := c.ETFFiles(context.Background(), "IVV.US", nil) - if err != nil { log.Fatal(err) } + if err != nil { + log.Fatal(err) + } fmt.Printf("%+v\n", resp) } ``` diff --git a/docs/en/docs/fundamental/fundamental/us_financial_overview.md b/docs/en/docs/fundamental/fundamental/us_financial_overview.md index 56859f18..dadb47d1 100644 --- a/docs/en/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/en/docs/fundamental/fundamental/us_financial_overview.md @@ -26,6 +26,8 @@ longbridge financial-report TSLA.US ## Parameters +> **SDK method parameters.** + | Name | Type | Required | Description | | ---- | ---- | -------- | ----------- | | symbol | string | YES | Stock symbol, e.g. `AAPL.US` | @@ -137,15 +139,23 @@ import ( func main() { o := oauth.New("your-client-id"). - OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) if err := o.Build(context.Background()); err != nil { log.Fatal(err) } - conf, _ := config.New(config.WithOAuthClient(o)) - c, _ := fundamental.NewFromCfg(conf) + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := fundamental.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } defer c.Close() resp, err := c.FinancialOverview(context.Background(), "AAPL.US", "annual") - if err != nil { log.Fatal(err) } + if err != nil { + log.Fatal(err) + } fmt.Printf("%+v\n", resp) } ``` diff --git a/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md index f3397aef..3a63762c 100644 --- a/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -27,6 +27,8 @@ longbridge financial-report AAPL.US --kind BS ## Parameters +> **SDK method parameters.** + | Name | Type | Required | Description | | ---- | ---- | -------- | ----------- | | symbol | string | YES | Stock symbol, e.g. `AAPL.US` | @@ -139,15 +141,23 @@ import ( func main() { o := oauth.New("your-client-id"). - OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) if err := o.Build(context.Background()); err != nil { log.Fatal(err) } - conf, _ := config.New(config.WithOAuthClient(o)) - c, _ := fundamental.NewFromCfg(conf) + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := fundamental.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } defer c.Close() resp, err := c.FinancialStatementV3(context.Background(), "AAPL.US", "IS", "annual") - if err != nil { log.Fatal(err) } + if err != nil { + log.Fatal(err) + } fmt.Printf("%+v\n", resp) } ``` diff --git a/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md index 7c0862b9..739c38dd 100644 --- a/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -26,6 +26,8 @@ longbridge financial-report key-metrics AAPL.US --report quarterly ## Parameters +> **SDK method parameters.** + | Name | Type | Required | Description | | ---- | ---- | -------- | ----------- | | symbol | string | YES | Stock symbol, e.g. `AAPL.US` | @@ -137,15 +139,23 @@ import ( func main() { o := oauth.New("your-client-id"). - OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) if err := o.Build(context.Background()); err != nil { log.Fatal(err) } - conf, _ := config.New(config.WithOAuthClient(o)) - c, _ := fundamental.NewFromCfg(conf) + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := fundamental.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } defer c.Close() resp, err := c.KeyFinancialMetrics(context.Background(), "AAPL.US", "annual") - if err != nil { log.Fatal(err) } + if err != nil { + log.Fatal(err) + } fmt.Printf("%+v\n", resp) } ``` diff --git a/docs/en/docs/fundamental/fundamental/us_valuation_overview.md b/docs/en/docs/fundamental/fundamental/us_valuation_overview.md index d376fc87..7855e8b0 100644 --- a/docs/en/docs/fundamental/fundamental/us_valuation_overview.md +++ b/docs/en/docs/fundamental/fundamental/us_valuation_overview.md @@ -26,6 +26,8 @@ longbridge valuation NVDA.US ## Parameters +> **SDK method parameters.** + | Name | Type | Required | Description | | ---- | ---- | -------- | ----------- | | symbol | string | YES | Stock symbol, e.g. `AAPL.US` | @@ -136,15 +138,23 @@ import ( func main() { o := oauth.New("your-client-id"). - OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) if err := o.Build(context.Background()); err != nil { log.Fatal(err) } - conf, _ := config.New(config.WithOAuthClient(o)) - c, _ := fundamental.NewFromCfg(conf) + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := fundamental.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } defer c.Close() resp, err := c.ValuationOverview(context.Background(), "AAPL.US") - if err != nil { log.Fatal(err) } + if err != nil { + log.Fatal(err) + } fmt.Printf("%+v\n", resp) } ``` diff --git a/docs/en/docs/quote/stocks/us_crypto_overview.md b/docs/en/docs/quote/stocks/us_crypto_overview.md index be80b72c..49abfa22 100644 --- a/docs/en/docs/quote/stocks/us_crypto_overview.md +++ b/docs/en/docs/quote/stocks/us_crypto_overview.md @@ -25,6 +25,8 @@ longbridge static DOGEUSD.BKKT ## Parameters +> **SDK method parameters.** + | Name | Type | Required | Description | | ---- | ---- | -------- | ----------- | | symbol | string | YES | Crypto symbol, e.g. `DOGEUSD.BKKT` | diff --git a/docs/en/docs/trade/asset/us_realized_pl.md b/docs/en/docs/trade/asset/us_realized_pl.md index 3ede6cf1..80494f0f 100644 --- a/docs/en/docs/trade/asset/us_realized_pl.md +++ b/docs/en/docs/trade/asset/us_realized_pl.md @@ -27,6 +27,8 @@ longbridge profit-analysis realized --category stock ## Parameters +> **SDK method parameters.** + | Name | Type | Required | Description | | ---- | ---- | -------- | ----------- | | currency | string | YES | Settlement currency, e.g. `USD` | diff --git a/docs/en/docs/trade/order/us_order_detail.md b/docs/en/docs/trade/order/us_order_detail.md index dbeda6f8..129a7120 100644 --- a/docs/en/docs/trade/order/us_order_detail.md +++ b/docs/en/docs/trade/order/us_order_detail.md @@ -26,6 +26,8 @@ longbridge order detail 701276261045858304 ## Parameters +> **SDK method parameters.** + | Name | Type | Required | Description | | ---- | ---- | -------- | ----------- | | order_id | string | YES | Order ID | diff --git a/docs/en/docs/trade/order/us_query_orders.md b/docs/en/docs/trade/order/us_query_orders.md index cc6e252c..e1fa1a47 100644 --- a/docs/en/docs/trade/order/us_query_orders.md +++ b/docs/en/docs/trade/order/us_query_orders.md @@ -27,6 +27,8 @@ longbridge order --status pending ## Parameters +> **SDK method parameters.** + | Name | Type | Required | Description | | ---- | ---- | -------- | ----------- | | symbol | string | NO | Filter by symbol, e.g. `AAPL.US` | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md index 2f78ab18..aa02930f 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md @@ -26,6 +26,8 @@ longbridge consensus NVDA.US ## 参数 +> **SDK 方法参数。** + | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | symbol | string | 是 | 股票代码，如 `AAPL.US` | @@ -137,15 +139,23 @@ import ( func main() { o := oauth.New("your-client-id"). - OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) if err := o.Build(context.Background()); err != nil { log.Fatal(err) } - conf, _ := config.New(config.WithOAuthClient(o)) - c, _ := fundamental.NewFromCfg(conf) + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := fundamental.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } defer c.Close() resp, err := c.AnalystConsensus(context.Background(), "AAPL.US", "annual") - if err != nil { log.Fatal(err) } + if err != nil { + log.Fatal(err) + } fmt.Printf("%+v\n", resp) } ``` diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md b/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md index 49b15ebe..a4f6cc92 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md @@ -26,6 +26,8 @@ longbridge dividend MSFT.US ## 参数 +> **SDK 方法参数。** + | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | symbol | string | 是 | 股票代码，如 `AAPL.US` | @@ -136,15 +138,23 @@ import ( func main() { o := oauth.New("your-client-id"). - OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) if err := o.Build(context.Background()); err != nil { log.Fatal(err) } - conf, _ := config.New(config.WithOAuthClient(o)) - c, _ := fundamental.NewFromCfg(conf) + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := fundamental.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } defer c.Close() resp, err := c.CompanyDividends(context.Background(), "AAPL.US") - if err != nil { log.Fatal(err) } + if err != nil { + log.Fatal(err) + } fmt.Printf("%+v\n", resp) } ``` diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md index 65e4d821..4c3e55cb 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md @@ -26,6 +26,8 @@ longbridge company TSLA.US ## 参数 +> **SDK 方法参数。** + | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | symbol | string | 是 | 股票代码，如 `AAPL.US` | @@ -136,15 +138,23 @@ import ( func main() { o := oauth.New("your-client-id"). - OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) if err := o.Build(context.Background()); err != nil { log.Fatal(err) } - conf, _ := config.New(config.WithOAuthClient(o)) - c, _ := fundamental.NewFromCfg(conf) + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := fundamental.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } defer c.Close() resp, err := c.CompanyOverview(context.Background(), "AAPL.US") - if err != nil { log.Fatal(err) } + if err != nil { + log.Fatal(err) + } fmt.Printf("%+v\n", resp) } ``` diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md index 79531f2f..7b301ac8 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -26,6 +26,8 @@ longbridge dividend SPY.US ## 参数 +> **SDK 方法参数。** + | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | symbol | string | 是 | ETF 代码，如 `IVV.US` | @@ -136,15 +138,23 @@ import ( func main() { o := oauth.New("your-client-id"). - OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) if err := o.Build(context.Background()); err != nil { log.Fatal(err) } - conf, _ := config.New(config.WithOAuthClient(o)) - c, _ := fundamental.NewFromCfg(conf) + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := fundamental.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } defer c.Close() resp, err := c.ETFDividendInfo(context.Background(), "IVV.US") - if err != nil { log.Fatal(err) } + if err != nil { + log.Fatal(err) + } fmt.Printf("%+v\n", resp) } ``` diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md b/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md index 12a28af4..337ec6a9 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md @@ -26,6 +26,8 @@ longbridge etf-docs SPY.US ## 参数 +> **SDK 方法参数。** + | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | symbol | string | 是 | ETF 代码，如 `IVV.US` | @@ -137,15 +139,23 @@ import ( func main() { o := oauth.New("your-client-id"). - OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) if err := o.Build(context.Background()); err != nil { log.Fatal(err) } - conf, _ := config.New(config.WithOAuthClient(o)) - c, _ := fundamental.NewFromCfg(conf) + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := fundamental.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } defer c.Close() resp, err := c.ETFFiles(context.Background(), "IVV.US", nil) - if err != nil { log.Fatal(err) } + if err != nil { + log.Fatal(err) + } fmt.Printf("%+v\n", resp) } ``` diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md index 38141312..ae86767f 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md @@ -26,6 +26,8 @@ longbridge financial-report TSLA.US ## 参数 +> **SDK 方法参数。** + | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | symbol | string | 是 | 股票代码，如 `AAPL.US` | @@ -137,15 +139,23 @@ import ( func main() { o := oauth.New("your-client-id"). - OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) if err := o.Build(context.Background()); err != nil { log.Fatal(err) } - conf, _ := config.New(config.WithOAuthClient(o)) - c, _ := fundamental.NewFromCfg(conf) + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := fundamental.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } defer c.Close() resp, err := c.FinancialOverview(context.Background(), "AAPL.US", "annual") - if err != nil { log.Fatal(err) } + if err != nil { + log.Fatal(err) + } fmt.Printf("%+v\n", resp) } ``` diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md index 097b2447..2db9fb32 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -27,6 +27,8 @@ longbridge financial-report AAPL.US --kind BS ## 参数 +> **SDK 方法参数。** + | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | symbol | string | 是 | 股票代码，如 `AAPL.US` | @@ -139,15 +141,23 @@ import ( func main() { o := oauth.New("your-client-id"). - OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) if err := o.Build(context.Background()); err != nil { log.Fatal(err) } - conf, _ := config.New(config.WithOAuthClient(o)) - c, _ := fundamental.NewFromCfg(conf) + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := fundamental.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } defer c.Close() resp, err := c.FinancialStatementV3(context.Background(), "AAPL.US", "IS", "annual") - if err != nil { log.Fatal(err) } + if err != nil { + log.Fatal(err) + } fmt.Printf("%+v\n", resp) } ``` diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md index ce6c57a9..326ca302 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -26,6 +26,8 @@ longbridge financial-report key-metrics AAPL.US --report quarterly ## 参数 +> **SDK 方法参数。** + | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | symbol | string | 是 | 股票代码，如 `AAPL.US` | @@ -137,15 +139,23 @@ import ( func main() { o := oauth.New("your-client-id"). - OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) if err := o.Build(context.Background()); err != nil { log.Fatal(err) } - conf, _ := config.New(config.WithOAuthClient(o)) - c, _ := fundamental.NewFromCfg(conf) + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := fundamental.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } defer c.Close() resp, err := c.KeyFinancialMetrics(context.Background(), "AAPL.US", "annual") - if err != nil { log.Fatal(err) } + if err != nil { + log.Fatal(err) + } fmt.Printf("%+v\n", resp) } ``` diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md index 3c6d5033..e6a8679f 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md @@ -26,6 +26,8 @@ longbridge valuation NVDA.US ## 参数 +> **SDK 方法参数。** + | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | symbol | string | 是 | 股票代码，如 `AAPL.US` | @@ -136,15 +138,23 @@ import ( func main() { o := oauth.New("your-client-id"). - OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) if err := o.Build(context.Background()); err != nil { log.Fatal(err) } - conf, _ := config.New(config.WithOAuthClient(o)) - c, _ := fundamental.NewFromCfg(conf) + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := fundamental.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } defer c.Close() resp, err := c.ValuationOverview(context.Background(), "AAPL.US") - if err != nil { log.Fatal(err) } + if err != nil { + log.Fatal(err) + } fmt.Printf("%+v\n", resp) } ``` diff --git a/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md b/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md index e3ac6445..acdfdfa8 100644 --- a/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md +++ b/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md @@ -25,6 +25,8 @@ longbridge static DOGEUSD.BKKT ## 参数 +> **SDK 方法参数。** + | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | symbol | string | 是 | 加密货币交易对，例如 `DOGEUSD.BKKT` | diff --git a/docs/zh-CN/docs/trade/asset/us_realized_pl.md b/docs/zh-CN/docs/trade/asset/us_realized_pl.md index 76da7298..fa3e3e75 100644 --- a/docs/zh-CN/docs/trade/asset/us_realized_pl.md +++ b/docs/zh-CN/docs/trade/asset/us_realized_pl.md @@ -27,6 +27,8 @@ longbridge profit-analysis realized --category stock ## 参数 +> **SDK 方法参数。** + | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | currency | string | 是 | 结算货币，例如 `USD` | diff --git a/docs/zh-CN/docs/trade/order/us_order_detail.md b/docs/zh-CN/docs/trade/order/us_order_detail.md index b74d7f5b..24b9ddd7 100644 --- a/docs/zh-CN/docs/trade/order/us_order_detail.md +++ b/docs/zh-CN/docs/trade/order/us_order_detail.md @@ -26,6 +26,8 @@ longbridge order detail 701276261045858304 ## 参数 +> **SDK 方法参数。** + | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | order_id | string | 是 | 委托 ID | diff --git a/docs/zh-CN/docs/trade/order/us_query_orders.md b/docs/zh-CN/docs/trade/order/us_query_orders.md index 881e8053..185acc23 100644 --- a/docs/zh-CN/docs/trade/order/us_query_orders.md +++ b/docs/zh-CN/docs/trade/order/us_query_orders.md @@ -27,6 +27,8 @@ longbridge order --status pending ## 参数 +> **SDK 方法参数。** + | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | symbol | string | 否 | 按标的筛选，例如 `AAPL.US` | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md index ca501357..0145ebd9 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md @@ -26,6 +26,8 @@ longbridge consensus NVDA.US ## 參數 +> **SDK 方法參數。** + | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | symbol | string | 是 | 股票代碼，如 `AAPL.US` | @@ -137,15 +139,23 @@ import ( func main() { o := oauth.New("your-client-id"). - OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) if err := o.Build(context.Background()); err != nil { log.Fatal(err) } - conf, _ := config.New(config.WithOAuthClient(o)) - c, _ := fundamental.NewFromCfg(conf) + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := fundamental.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } defer c.Close() resp, err := c.AnalystConsensus(context.Background(), "AAPL.US", "annual") - if err != nil { log.Fatal(err) } + if err != nil { + log.Fatal(err) + } fmt.Printf("%+v\n", resp) } ``` diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md b/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md index 978c88c7..233f2bb6 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md @@ -26,6 +26,8 @@ longbridge dividend MSFT.US ## 參數 +> **SDK 方法參數。** + | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | symbol | string | 是 | 股票代碼，如 `AAPL.US` | @@ -136,15 +138,23 @@ import ( func main() { o := oauth.New("your-client-id"). - OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) if err := o.Build(context.Background()); err != nil { log.Fatal(err) } - conf, _ := config.New(config.WithOAuthClient(o)) - c, _ := fundamental.NewFromCfg(conf) + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := fundamental.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } defer c.Close() resp, err := c.CompanyDividends(context.Background(), "AAPL.US") - if err != nil { log.Fatal(err) } + if err != nil { + log.Fatal(err) + } fmt.Printf("%+v\n", resp) } ``` diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md index d9809504..1ef7b469 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md @@ -26,6 +26,8 @@ longbridge company TSLA.US ## 參數 +> **SDK 方法參數。** + | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | symbol | string | 是 | 股票代碼，如 `AAPL.US` | @@ -136,15 +138,23 @@ import ( func main() { o := oauth.New("your-client-id"). - OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) if err := o.Build(context.Background()); err != nil { log.Fatal(err) } - conf, _ := config.New(config.WithOAuthClient(o)) - c, _ := fundamental.NewFromCfg(conf) + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := fundamental.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } defer c.Close() resp, err := c.CompanyOverview(context.Background(), "AAPL.US") - if err != nil { log.Fatal(err) } + if err != nil { + log.Fatal(err) + } fmt.Printf("%+v\n", resp) } ``` diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md index 7937641c..411e17fa 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -26,6 +26,8 @@ longbridge dividend SPY.US ## 參數 +> **SDK 方法參數。** + | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | symbol | string | 是 | ETF 代碼，如 `IVV.US` | @@ -136,15 +138,23 @@ import ( func main() { o := oauth.New("your-client-id"). - OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) if err := o.Build(context.Background()); err != nil { log.Fatal(err) } - conf, _ := config.New(config.WithOAuthClient(o)) - c, _ := fundamental.NewFromCfg(conf) + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := fundamental.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } defer c.Close() resp, err := c.ETFDividendInfo(context.Background(), "IVV.US") - if err != nil { log.Fatal(err) } + if err != nil { + log.Fatal(err) + } fmt.Printf("%+v\n", resp) } ``` diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md b/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md index f7184ff1..a57100b7 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md @@ -26,6 +26,8 @@ longbridge etf-docs SPY.US ## 參數 +> **SDK 方法參數。** + | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | symbol | string | 是 | ETF 代碼，如 `IVV.US` | @@ -137,15 +139,23 @@ import ( func main() { o := oauth.New("your-client-id"). - OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) if err := o.Build(context.Background()); err != nil { log.Fatal(err) } - conf, _ := config.New(config.WithOAuthClient(o)) - c, _ := fundamental.NewFromCfg(conf) + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := fundamental.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } defer c.Close() resp, err := c.ETFFiles(context.Background(), "IVV.US", nil) - if err != nil { log.Fatal(err) } + if err != nil { + log.Fatal(err) + } fmt.Printf("%+v\n", resp) } ``` diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md index 80b11c57..c6027a16 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md @@ -26,6 +26,8 @@ longbridge financial-report TSLA.US ## 參數 +> **SDK 方法參數。** + | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | symbol | string | 是 | 股票代碼，如 `AAPL.US` | @@ -137,15 +139,23 @@ import ( func main() { o := oauth.New("your-client-id"). - OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) if err := o.Build(context.Background()); err != nil { log.Fatal(err) } - conf, _ := config.New(config.WithOAuthClient(o)) - c, _ := fundamental.NewFromCfg(conf) + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := fundamental.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } defer c.Close() resp, err := c.FinancialOverview(context.Background(), "AAPL.US", "annual") - if err != nil { log.Fatal(err) } + if err != nil { + log.Fatal(err) + } fmt.Printf("%+v\n", resp) } ``` diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md index dac81486..1ab722b8 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -27,6 +27,8 @@ longbridge financial-report AAPL.US --kind BS ## 參數 +> **SDK 方法參數。** + | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | symbol | string | 是 | 股票代碼，如 `AAPL.US` | @@ -139,15 +141,23 @@ import ( func main() { o := oauth.New("your-client-id"). - OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) if err := o.Build(context.Background()); err != nil { log.Fatal(err) } - conf, _ := config.New(config.WithOAuthClient(o)) - c, _ := fundamental.NewFromCfg(conf) + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := fundamental.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } defer c.Close() resp, err := c.FinancialStatementV3(context.Background(), "AAPL.US", "IS", "annual") - if err != nil { log.Fatal(err) } + if err != nil { + log.Fatal(err) + } fmt.Printf("%+v\n", resp) } ``` diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md index f8d1547e..c8f240a1 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -26,6 +26,8 @@ longbridge financial-report key-metrics AAPL.US --report quarterly ## 參數 +> **SDK 方法參數。** + | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | symbol | string | 是 | 股票代碼，如 `AAPL.US` | @@ -137,15 +139,23 @@ import ( func main() { o := oauth.New("your-client-id"). - OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) if err := o.Build(context.Background()); err != nil { log.Fatal(err) } - conf, _ := config.New(config.WithOAuthClient(o)) - c, _ := fundamental.NewFromCfg(conf) + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := fundamental.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } defer c.Close() resp, err := c.KeyFinancialMetrics(context.Background(), "AAPL.US", "annual") - if err != nil { log.Fatal(err) } + if err != nil { + log.Fatal(err) + } fmt.Printf("%+v\n", resp) } ``` diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md index b77795bb..b3316656 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md @@ -26,6 +26,8 @@ longbridge valuation NVDA.US ## 參數 +> **SDK 方法參數。** + | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | symbol | string | 是 | 股票代碼，如 `AAPL.US` | @@ -136,15 +138,23 @@ import ( func main() { o := oauth.New("your-client-id"). - OnOpenURL(func(url string) { fmt.Println("Open:", url) }) + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) if err := o.Build(context.Background()); err != nil { log.Fatal(err) } - conf, _ := config.New(config.WithOAuthClient(o)) - c, _ := fundamental.NewFromCfg(conf) + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := fundamental.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } defer c.Close() resp, err := c.ValuationOverview(context.Background(), "AAPL.US") - if err != nil { log.Fatal(err) } + if err != nil { + log.Fatal(err) + } fmt.Printf("%+v\n", resp) } ``` diff --git a/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md b/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md index 56c823d9..d80ca51c 100644 --- a/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md +++ b/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md @@ -25,6 +25,8 @@ longbridge static DOGEUSD.BKKT ## 參數 +> **SDK 方法參數。** + | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | symbol | string | 是 | 加密貨幣交易對，例如 `DOGEUSD.BKKT` | diff --git a/docs/zh-HK/docs/trade/asset/us_realized_pl.md b/docs/zh-HK/docs/trade/asset/us_realized_pl.md index 89ff3db6..e36c89a9 100644 --- a/docs/zh-HK/docs/trade/asset/us_realized_pl.md +++ b/docs/zh-HK/docs/trade/asset/us_realized_pl.md @@ -27,6 +27,8 @@ longbridge profit-analysis realized --category stock ## 參數 +> **SDK 方法參數。** + | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | currency | string | 是 | 結算貨幣，例如 `USD` | diff --git a/docs/zh-HK/docs/trade/order/us_order_detail.md b/docs/zh-HK/docs/trade/order/us_order_detail.md index 77caa91c..fffac29e 100644 --- a/docs/zh-HK/docs/trade/order/us_order_detail.md +++ b/docs/zh-HK/docs/trade/order/us_order_detail.md @@ -26,6 +26,8 @@ longbridge order detail 701276261045858304 ## 參數 +> **SDK 方法參數。** + | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | order_id | string | 是 | 委託 ID | diff --git a/docs/zh-HK/docs/trade/order/us_query_orders.md b/docs/zh-HK/docs/trade/order/us_query_orders.md index e5e4b8f6..aaa366b8 100644 --- a/docs/zh-HK/docs/trade/order/us_query_orders.md +++ b/docs/zh-HK/docs/trade/order/us_query_orders.md @@ -27,6 +27,8 @@ longbridge order --status pending ## 參數 +> **SDK 方法參數。** + | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | symbol | string | 否 | 按標的篩選，例如 `AAPL.US` | From 379908015c18a7196e36b6698f781b5cfca6037f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 18:30:32 +0800 Subject: [PATCH 40/51] fix(docs): revert zh-CN/zh-HK section headings to English (Parameters/Request Example/Response/Schemas) --- .../fundamental/fundamental/us_analyst_consensus.md | 8 ++++---- .../fundamental/fundamental/us_company_dividends.md | 12 ++++++------ .../fundamental/fundamental/us_company_overview.md | 12 ++++++------ .../fundamental/fundamental/us_etf_dividend_info.md | 12 ++++++------ .../docs/fundamental/fundamental/us_etf_files.md | 12 ++++++------ .../fundamental/fundamental/us_financial_overview.md | 8 ++++---- .../fundamental/us_financial_statement_v3.md | 12 ++++++------ .../fundamental/us_key_financial_metrics.md | 8 ++++---- .../fundamental/fundamental/us_valuation_overview.md | 12 ++++++------ docs/zh-CN/docs/quote/stocks/us_crypto_overview.md | 12 ++++++------ docs/zh-CN/docs/trade/asset/us_asset_overview.md | 12 ++++++------ docs/zh-CN/docs/trade/asset/us_realized_pl.md | 12 ++++++------ docs/zh-CN/docs/trade/order/us_order_detail.md | 12 ++++++------ docs/zh-CN/docs/trade/order/us_query_orders.md | 12 ++++++------ .../fundamental/fundamental/us_analyst_consensus.md | 8 ++++---- .../fundamental/fundamental/us_company_dividends.md | 12 ++++++------ .../fundamental/fundamental/us_company_overview.md | 12 ++++++------ .../fundamental/fundamental/us_etf_dividend_info.md | 12 ++++++------ .../docs/fundamental/fundamental/us_etf_files.md | 12 ++++++------ .../fundamental/fundamental/us_financial_overview.md | 8 ++++---- .../fundamental/us_financial_statement_v3.md | 12 ++++++------ .../fundamental/us_key_financial_metrics.md | 8 ++++---- .../fundamental/fundamental/us_valuation_overview.md | 12 ++++++------ docs/zh-HK/docs/quote/stocks/us_crypto_overview.md | 12 ++++++------ docs/zh-HK/docs/trade/asset/us_asset_overview.md | 12 ++++++------ docs/zh-HK/docs/trade/asset/us_realized_pl.md | 12 ++++++------ docs/zh-HK/docs/trade/order/us_order_detail.md | 12 ++++++------ docs/zh-HK/docs/trade/order/us_query_orders.md | 12 ++++++------ 28 files changed, 156 insertions(+), 156 deletions(-) diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md index aa02930f..a1815378 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md @@ -24,7 +24,7 @@ longbridge consensus NVDA.US -## 参数 +## Parameters > **SDK 方法参数。** @@ -33,7 +33,7 @@ longbridge consensus NVDA.US | symbol | string | 是 | 股票代码，如 `AAPL.US` | | report | string | 否 | 报告周期：`annual` 或 `quarterly`（默认：annual）| -## 请求示例 +## Request Example @@ -164,11 +164,11 @@ func main() { -## 响应 +## Response 返回结构灵活的 JSON 对象，包含分析师一致预期数据（营收/EPS 预测、目标价分布、买入/持有/卖出分布），具体字段因数据可用性而异。 -### 响应状态 +### Response Status | 状态码 | 描述 | 结构 | | ------ | ---- | ---- | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md b/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md index a4f6cc92..9953f271 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md @@ -24,7 +24,7 @@ longbridge dividend MSFT.US -## 参数 +## Parameters > **SDK 方法参数。** @@ -32,7 +32,7 @@ longbridge dividend MSFT.US | ---- | ---- | ---- | ---- | | symbol | string | 是 | 股票代码，如 `AAPL.US` | -## 请求示例 +## Request Example @@ -164,9 +164,9 @@ func main() { -## 响应 +## Response -### 响应示例 +### Response Example ```json { @@ -181,14 +181,14 @@ func main() { } ``` -### 响应状态 +### Response Status | 状态码 | 描述 | 结构 | | ------ | ---- | ---- | | 200 | 成功 | [UsCompanyDividends](#UsCompanyDividends) | | 400 | 请求错误 | None | -## 数据结构 +## Schemas ### UsCompanyDividends diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md index 4c3e55cb..c96f3b57 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md @@ -24,7 +24,7 @@ longbridge company TSLA.US -## 参数 +## Parameters > **SDK 方法参数。** @@ -32,7 +32,7 @@ longbridge company TSLA.US | ---- | ---- | ---- | ---- | | symbol | string | 是 | 股票代码，如 `AAPL.US` | -## 请求示例 +## Request Example @@ -163,9 +163,9 @@ func main() { -## 响应 +## Response -### 响应示例 +### Response Example ```json { @@ -177,14 +177,14 @@ func main() { } ``` -### 响应状态 +### Response Status | 状态码 | 描述 | 结构 | | ------ | ---- | ---- | | 200 | 成功 | [UsCompanyOverview](#UsCompanyOverview) | | 400 | 请求错误 | None | -## 数据结构 +## Schemas ### UsCompanyOverview diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md index 7b301ac8..4748d8d3 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -24,7 +24,7 @@ longbridge dividend SPY.US -## 参数 +## Parameters > **SDK 方法参数。** @@ -32,7 +32,7 @@ longbridge dividend SPY.US | ---- | ---- | ---- | ---- | | symbol | string | 是 | ETF 代码，如 `IVV.US` | -## 请求示例 +## Request Example @@ -164,9 +164,9 @@ func main() { -## 响应 +## Response -### 响应示例 +### Response Example ```json { @@ -186,14 +186,14 @@ func main() { } ``` -### 响应状态 +### Response Status | 状态码 | 描述 | 结构 | | ------ | ---- | ---- | | 200 | 成功 | [UsETFDividendInfo](#UsETFDividendInfo) | | 400 | 请求错误 | None | -## 数据结构 +## Schemas ### UsETFDividendInfo diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md b/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md index 337ec6a9..1e783296 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md @@ -24,7 +24,7 @@ longbridge etf-docs SPY.US -## 参数 +## Parameters > **SDK 方法参数。** @@ -33,7 +33,7 @@ longbridge etf-docs SPY.US | symbol | string | 是 | ETF 代码，如 `IVV.US` | | size | int | 否 | 最大返回文件数 | -## 请求示例 +## Request Example @@ -164,9 +164,9 @@ func main() { -## 响应 +## Response -### 响应示例 +### Response Example ```json { @@ -177,14 +177,14 @@ func main() { } ``` -### 响应状态 +### Response Status | 状态码 | 描述 | 结构 | | ------ | ---- | ---- | | 200 | 成功 | [UsETFFileList](#UsETFFileList) | | 400 | 请求错误 | None | -## 数据结构 +## Schemas ### UsETFFileList diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md index ae86767f..50883d2e 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md @@ -24,7 +24,7 @@ longbridge financial-report TSLA.US -## 参数 +## Parameters > **SDK 方法参数。** @@ -33,7 +33,7 @@ longbridge financial-report TSLA.US | symbol | string | 是 | 股票代码，如 `AAPL.US` | | report | string | 否 | 报告周期：`annual` 或 `quarterly`（默认：annual）| -## 请求示例 +## Request Example @@ -164,11 +164,11 @@ func main() { -## 响应 +## Response 返回结构灵活的 JSON 对象，内容因公司和报告周期而异，包含损益、资产负债和现金流摘要数据。 -### 响应状态 +### Response Status | 状态码 | 描述 | 结构 | | ------ | ---- | ---- | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md index 2db9fb32..9d7bbb72 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -25,7 +25,7 @@ longbridge financial-report AAPL.US --kind BS -## 参数 +## Parameters > **SDK 方法参数。** @@ -35,7 +35,7 @@ longbridge financial-report AAPL.US --kind BS | kind | string | 是 | 报表类型：`IS`（损益表）、`BS`（资产负债表）、`CF`（现金流量表）| | report | string | 否 | 报告周期 | -## 请求示例 +## Request Example @@ -167,9 +167,9 @@ func main() { -## 响应 +## Response -### 响应示例 +### Response Example ```json { @@ -189,14 +189,14 @@ func main() { } ``` -### 响应状态 +### Response Status | 状态码 | 描述 | 结构 | | ------ | ---- | ---- | | 200 | 成功 | [UsFinancialStatement](#UsFinancialStatement) | | 400 | 请求错误 | None | -## 数据结构 +## Schemas ### UsFinancialStatement diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md index 326ca302..b3430cc0 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -24,7 +24,7 @@ longbridge financial-report key-metrics AAPL.US --report quarterly -## 参数 +## Parameters > **SDK 方法参数。** @@ -33,7 +33,7 @@ longbridge financial-report key-metrics AAPL.US --report quarterly | symbol | string | 是 | 股票代码，如 `AAPL.US` | | report | string | 否 | 报告周期：`annual` 或 `quarterly`（默认：annual）| -## 请求示例 +## Request Example @@ -164,11 +164,11 @@ func main() { -## 响应 +## Response 返回结构灵活的 JSON 对象，包含关键财务指标（营收、净利润、EPS、利润率和增长率），具体字段因公司而异。 -### 响应状态 +### Response Status | 状态码 | 描述 | 结构 | | ------ | ---- | ---- | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md index e6a8679f..1239fc5e 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md @@ -24,7 +24,7 @@ longbridge valuation NVDA.US -## 参数 +## Parameters > **SDK 方法参数。** @@ -32,7 +32,7 @@ longbridge valuation NVDA.US | ---- | ---- | ---- | ---- | | symbol | string | 是 | 股票代码，如 `AAPL.US` | -## 请求示例 +## Request Example @@ -163,9 +163,9 @@ func main() { -## 响应 +## Response -### 响应示例 +### Response Example ```json { @@ -179,14 +179,14 @@ func main() { } ``` -### 响应状态 +### Response Status | 状态码 | 描述 | 结构 | | ------ | ---- | ---- | | 200 | 成功 | [UsValuationOverview](#UsValuationOverview) | | 400 | 请求错误 | None | -## 数据结构 +## Schemas ### UsValuationOverview diff --git a/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md b/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md index acdfdfa8..500eec30 100644 --- a/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md +++ b/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md @@ -23,7 +23,7 @@ longbridge static DOGEUSD.BKKT -## 参数 +## Parameters > **SDK 方法参数。** @@ -31,7 +31,7 @@ longbridge static DOGEUSD.BKKT | ---- | ---- | ---- | ---- | | symbol | string | 是 | 加密货币交易对，例如 `DOGEUSD.BKKT` | -## 请求示例 +## Request Example @@ -146,9 +146,9 @@ fmt.Printf("%+v\n", resp) | all_time_low_date | string | 历史最低价日期 | -## 响应 +## Response -### 响应示例 +### Response Example ```json { @@ -164,14 +164,14 @@ fmt.Printf("%+v\n", resp) } ``` -### 响应状态 +### Response Status | 状态码 | 描述 | 结构 | | ------ | ---- | ---- | | 200 | 成功 | [CryptoOverview](#CryptoOverview) | | 400 | 请求错误 | None | -## 数据结构 +## Schemas ### CryptoOverview diff --git a/docs/zh-CN/docs/trade/asset/us_asset_overview.md b/docs/zh-CN/docs/trade/asset/us_asset_overview.md index cade837a..4b5e125b 100644 --- a/docs/zh-CN/docs/trade/asset/us_asset_overview.md +++ b/docs/zh-CN/docs/trade/asset/us_asset_overview.md @@ -23,11 +23,11 @@ longbridge positions -## 参数 +## Parameters 无需参数。 -## 请求示例 +## Request Example @@ -129,9 +129,9 @@ fmt.Printf("%+v\n", resp) -## 响应 +## Response -### 响应示例 +### Response Example ```json { @@ -148,14 +148,14 @@ fmt.Printf("%+v\n", resp) } ``` -### 响应状态 +### Response Status | 状态码 | 描述 | 结构 | | ------ | ---- | ---- | | 200 | 成功 | [USAssetOverview](#USAssetOverview) | | 400 | 请求错误 | None | -## 数据结构 +## Schemas ### USAssetOverview diff --git a/docs/zh-CN/docs/trade/asset/us_realized_pl.md b/docs/zh-CN/docs/trade/asset/us_realized_pl.md index fa3e3e75..bfddeeb6 100644 --- a/docs/zh-CN/docs/trade/asset/us_realized_pl.md +++ b/docs/zh-CN/docs/trade/asset/us_realized_pl.md @@ -25,7 +25,7 @@ longbridge profit-analysis realized --category stock -## 参数 +## Parameters > **SDK 方法参数。** @@ -34,7 +34,7 @@ longbridge profit-analysis realized --category stock | currency | string | 是 | 结算货币，例如 `USD` | | category | string | 否 | 资产类别：`ALL` \| `STOCK` \| `OPTION` \| `CRYPTO`（默认：`ALL`） | -## 请求示例 +## Request Example @@ -137,9 +137,9 @@ fmt.Printf("%+v\n", resp) -## 响应 +## Response -### 响应示例 +### Response Example ```json { @@ -162,14 +162,14 @@ fmt.Printf("%+v\n", resp) } ``` -### 响应状态 +### Response Status | 状态码 | 描述 | 结构 | | ------ | ---- | ---- | | 200 | 成功 | [USRealizedPL](#USRealizedPL) | | 400 | 请求错误 | None | -## 数据结构 +## Schemas ### USRealizedPL diff --git a/docs/zh-CN/docs/trade/order/us_order_detail.md b/docs/zh-CN/docs/trade/order/us_order_detail.md index 24b9ddd7..17be399c 100644 --- a/docs/zh-CN/docs/trade/order/us_order_detail.md +++ b/docs/zh-CN/docs/trade/order/us_order_detail.md @@ -24,7 +24,7 @@ longbridge order detail 701276261045858304 -## 参数 +## Parameters > **SDK 方法参数。** @@ -32,7 +32,7 @@ longbridge order detail 701276261045858304 | ---- | ---- | ---- | ---- | | order_id | string | 是 | 委托 ID | -## 请求示例 +## Request Example @@ -134,9 +134,9 @@ fmt.Printf("%+v\n", resp) -## 响应 +## Response -### 响应示例 +### Response Example ```json { @@ -159,14 +159,14 @@ fmt.Printf("%+v\n", resp) } ``` -### 响应状态 +### Response Status | 状态码 | 描述 | 结构 | | ------ | ---- | ---- | | 200 | 成功 | [USOrderDetailResponse](#USOrderDetailResponse) | | 400 | 请求错误 | None | -## 数据结构 +## Schemas ### USOrderDetailResponse diff --git a/docs/zh-CN/docs/trade/order/us_query_orders.md b/docs/zh-CN/docs/trade/order/us_query_orders.md index 185acc23..1fb25f22 100644 --- a/docs/zh-CN/docs/trade/order/us_query_orders.md +++ b/docs/zh-CN/docs/trade/order/us_query_orders.md @@ -25,7 +25,7 @@ longbridge order --status pending -## 参数 +## Parameters > **SDK 方法参数。** @@ -39,7 +39,7 @@ longbridge order --status pending | page | int32 | 否 | 页码，从 1 开始（默认：1） | | limit | int32 | 否 | 每页数量（默认：20） | -## 请求示例 +## Request Example @@ -141,9 +141,9 @@ fmt.Printf("%+v\n", resp) -## 响应 +## Response -### 响应示例 +### Response Example ```json { @@ -164,14 +164,14 @@ fmt.Printf("%+v\n", resp) } ``` -### 响应状态 +### Response Status | 状态码 | 描述 | 结构 | | ------ | ---- | ---- | | 200 | 成功 | [QueryUSOrdersResponse](#QueryUSOrdersResponse) | | 400 | 请求错误 | None | -## 数据结构 +## Schemas ### QueryUSOrdersResponse diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md index 0145ebd9..a1c0e9d1 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md @@ -24,7 +24,7 @@ longbridge consensus NVDA.US -## 參數 +## Parameters > **SDK 方法參數。** @@ -33,7 +33,7 @@ longbridge consensus NVDA.US | symbol | string | 是 | 股票代碼，如 `AAPL.US` | | report | string | 否 | 報告週期：`annual` 或 `quarterly`（默認：annual）| -## 請求示例 +## Request Example @@ -164,11 +164,11 @@ func main() { -## 響應 +## Response 返回結構靈活的 JSON 對象，包含分析師一致預期數據（營收/EPS 預測、目標價分佈、買入/持有/賣出分佈），具體字段因數據可用性而異。 -### 響應狀態 +### Response Status | 狀態碼 | 描述 | 結構 | | ------ | ---- | ---- | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md b/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md index 233f2bb6..6074cd25 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md @@ -24,7 +24,7 @@ longbridge dividend MSFT.US -## 參數 +## Parameters > **SDK 方法參數。** @@ -32,7 +32,7 @@ longbridge dividend MSFT.US | ---- | ---- | ---- | ---- | | symbol | string | 是 | 股票代碼，如 `AAPL.US` | -## 請求示例 +## Request Example @@ -164,9 +164,9 @@ func main() { -## 響應 +## Response -### 響應示例 +### Response Example ```json { @@ -181,14 +181,14 @@ func main() { } ``` -### 響應狀態 +### Response Status | 狀態碼 | 描述 | 結構 | | ------ | ---- | ---- | | 200 | 成功 | [UsCompanyDividends](#UsCompanyDividends) | | 400 | 請求錯誤 | None | -## 數據結構 +## Schemas ### UsCompanyDividends diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md index 1ef7b469..cf2ed758 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md @@ -24,7 +24,7 @@ longbridge company TSLA.US -## 參數 +## Parameters > **SDK 方法參數。** @@ -32,7 +32,7 @@ longbridge company TSLA.US | ---- | ---- | ---- | ---- | | symbol | string | 是 | 股票代碼，如 `AAPL.US` | -## 請求示例 +## Request Example @@ -163,9 +163,9 @@ func main() { -## 響應 +## Response -### 響應示例 +### Response Example ```json { @@ -177,14 +177,14 @@ func main() { } ``` -### 響應狀態 +### Response Status | 狀態碼 | 描述 | 結構 | | ------ | ---- | ---- | | 200 | 成功 | [UsCompanyOverview](#UsCompanyOverview) | | 400 | 請求錯誤 | None | -## 數據結構 +## Schemas ### UsCompanyOverview diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md index 411e17fa..cf476ff9 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -24,7 +24,7 @@ longbridge dividend SPY.US -## 參數 +## Parameters > **SDK 方法參數。** @@ -32,7 +32,7 @@ longbridge dividend SPY.US | ---- | ---- | ---- | ---- | | symbol | string | 是 | ETF 代碼，如 `IVV.US` | -## 請求示例 +## Request Example @@ -164,9 +164,9 @@ func main() { -## 響應 +## Response -### 響應示例 +### Response Example ```json { @@ -186,14 +186,14 @@ func main() { } ``` -### 響應狀態 +### Response Status | 狀態碼 | 描述 | 結構 | | ------ | ---- | ---- | | 200 | 成功 | [UsETFDividendInfo](#UsETFDividendInfo) | | 400 | 請求錯誤 | None | -## 數據結構 +## Schemas ### UsETFDividendInfo diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md b/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md index a57100b7..33f0b27c 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md @@ -24,7 +24,7 @@ longbridge etf-docs SPY.US -## 參數 +## Parameters > **SDK 方法參數。** @@ -33,7 +33,7 @@ longbridge etf-docs SPY.US | symbol | string | 是 | ETF 代碼，如 `IVV.US` | | size | int | 否 | 最大返回文件數 | -## 請求示例 +## Request Example @@ -164,9 +164,9 @@ func main() { -## 響應 +## Response -### 響應示例 +### Response Example ```json { @@ -177,14 +177,14 @@ func main() { } ``` -### 響應狀態 +### Response Status | 狀態碼 | 描述 | 結構 | | ------ | ---- | ---- | | 200 | 成功 | [UsETFFileList](#UsETFFileList) | | 400 | 請求錯誤 | None | -## 數據結構 +## Schemas ### UsETFFileList diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md index c6027a16..f45ece9d 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md @@ -24,7 +24,7 @@ longbridge financial-report TSLA.US -## 參數 +## Parameters > **SDK 方法參數。** @@ -33,7 +33,7 @@ longbridge financial-report TSLA.US | symbol | string | 是 | 股票代碼，如 `AAPL.US` | | report | string | 否 | 報告週期：`annual` 或 `quarterly`（默認：annual）| -## 請求示例 +## Request Example @@ -164,11 +164,11 @@ func main() { -## 響應 +## Response 返回結構靈活的 JSON 對象，內容因公司和報告週期而異，包含損益、資產負債和現金流摘要數據。 -### 響應狀態 +### Response Status | 狀態碼 | 描述 | 結構 | | ------ | ---- | ---- | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md index 1ab722b8..dad3f409 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md @@ -25,7 +25,7 @@ longbridge financial-report AAPL.US --kind BS -## 參數 +## Parameters > **SDK 方法參數。** @@ -35,7 +35,7 @@ longbridge financial-report AAPL.US --kind BS | kind | string | 是 | 報表類型：`IS`（損益表）、`BS`（資產負債表）、`CF`（現金流量表）| | report | string | 否 | 報告週期 | -## 請求示例 +## Request Example @@ -167,9 +167,9 @@ func main() { -## 響應 +## Response -### 響應示例 +### Response Example ```json { @@ -189,14 +189,14 @@ func main() { } ``` -### 響應狀態 +### Response Status | 狀態碼 | 描述 | 結構 | | ------ | ---- | ---- | | 200 | 成功 | [UsFinancialStatement](#UsFinancialStatement) | | 400 | 請求錯誤 | None | -## 數據結構 +## Schemas ### UsFinancialStatement diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md index c8f240a1..6cfa27bf 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -24,7 +24,7 @@ longbridge financial-report key-metrics AAPL.US --report quarterly -## 參數 +## Parameters > **SDK 方法參數。** @@ -33,7 +33,7 @@ longbridge financial-report key-metrics AAPL.US --report quarterly | symbol | string | 是 | 股票代碼，如 `AAPL.US` | | report | string | 否 | 報告週期：`annual` 或 `quarterly`（默認：annual）| -## 請求示例 +## Request Example @@ -164,11 +164,11 @@ func main() { -## 響應 +## Response 返回結構靈活的 JSON 對象，包含關鍵財務指標（營收、淨利潤、EPS、利潤率和增長率），具體字段因公司而異。 -### 響應狀態 +### Response Status | 狀態碼 | 描述 | 結構 | | ------ | ---- | ---- | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md index b3316656..a0a56586 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md @@ -24,7 +24,7 @@ longbridge valuation NVDA.US -## 參數 +## Parameters > **SDK 方法參數。** @@ -32,7 +32,7 @@ longbridge valuation NVDA.US | ---- | ---- | ---- | ---- | | symbol | string | 是 | 股票代碼，如 `AAPL.US` | -## 請求示例 +## Request Example @@ -163,9 +163,9 @@ func main() { -## 響應 +## Response -### 響應示例 +### Response Example ```json { @@ -179,14 +179,14 @@ func main() { } ``` -### 響應狀態 +### Response Status | 狀態碼 | 描述 | 結構 | | ------ | ---- | ---- | | 200 | 成功 | [UsValuationOverview](#UsValuationOverview) | | 400 | 請求錯誤 | None | -## 數據結構 +## Schemas ### UsValuationOverview diff --git a/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md b/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md index d80ca51c..17ecb9bd 100644 --- a/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md +++ b/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md @@ -23,7 +23,7 @@ longbridge static DOGEUSD.BKKT -## 參數 +## Parameters > **SDK 方法參數。** @@ -31,7 +31,7 @@ longbridge static DOGEUSD.BKKT | ---- | ---- | ---- | ---- | | symbol | string | 是 | 加密貨幣交易對，例如 `DOGEUSD.BKKT` | -## 請求示例 +## Request Example @@ -146,9 +146,9 @@ fmt.Printf("%+v\n", resp) | all_time_low_date | string | 歷史最低價日期 | -## 響應 +## Response -### 響應示例 +### Response Example ```json { @@ -164,14 +164,14 @@ fmt.Printf("%+v\n", resp) } ``` -### 響應狀態 +### Response Status | 狀態碼 | 描述 | 結構 | | ------ | ---- | ---- | | 200 | 成功 | [CryptoOverview](#CryptoOverview) | | 400 | 請求錯誤 | None | -## 數據結構 +## Schemas ### CryptoOverview diff --git a/docs/zh-HK/docs/trade/asset/us_asset_overview.md b/docs/zh-HK/docs/trade/asset/us_asset_overview.md index feb47977..0cc3b612 100644 --- a/docs/zh-HK/docs/trade/asset/us_asset_overview.md +++ b/docs/zh-HK/docs/trade/asset/us_asset_overview.md @@ -23,11 +23,11 @@ longbridge positions -## 參數 +## Parameters 無需參數。 -## 請求示例 +## Request Example @@ -129,9 +129,9 @@ fmt.Printf("%+v\n", resp) -## 響應 +## Response -### 響應示例 +### Response Example ```json { @@ -148,14 +148,14 @@ fmt.Printf("%+v\n", resp) } ``` -### 響應狀態 +### Response Status | 狀態碼 | 描述 | 結構 | | ------ | ---- | ---- | | 200 | 成功 | [USAssetOverview](#USAssetOverview) | | 400 | 請求錯誤 | None | -## 數據結構 +## Schemas ### USAssetOverview diff --git a/docs/zh-HK/docs/trade/asset/us_realized_pl.md b/docs/zh-HK/docs/trade/asset/us_realized_pl.md index e36c89a9..3af2ea3d 100644 --- a/docs/zh-HK/docs/trade/asset/us_realized_pl.md +++ b/docs/zh-HK/docs/trade/asset/us_realized_pl.md @@ -25,7 +25,7 @@ longbridge profit-analysis realized --category stock -## 參數 +## Parameters > **SDK 方法參數。** @@ -34,7 +34,7 @@ longbridge profit-analysis realized --category stock | currency | string | 是 | 結算貨幣，例如 `USD` | | category | string | 否 | 資產類別：`ALL` \| `STOCK` \| `OPTION` \| `CRYPTO`（默認：`ALL`） | -## 請求示例 +## Request Example @@ -137,9 +137,9 @@ fmt.Printf("%+v\n", resp) -## 響應 +## Response -### 響應示例 +### Response Example ```json { @@ -162,14 +162,14 @@ fmt.Printf("%+v\n", resp) } ``` -### 響應狀態 +### Response Status | 狀態碼 | 描述 | 結構 | | ------ | ---- | ---- | | 200 | 成功 | [USRealizedPL](#USRealizedPL) | | 400 | 請求錯誤 | None | -## 數據結構 +## Schemas ### USRealizedPL diff --git a/docs/zh-HK/docs/trade/order/us_order_detail.md b/docs/zh-HK/docs/trade/order/us_order_detail.md index fffac29e..09102a1a 100644 --- a/docs/zh-HK/docs/trade/order/us_order_detail.md +++ b/docs/zh-HK/docs/trade/order/us_order_detail.md @@ -24,7 +24,7 @@ longbridge order detail 701276261045858304 -## 參數 +## Parameters > **SDK 方法參數。** @@ -32,7 +32,7 @@ longbridge order detail 701276261045858304 | ---- | ---- | ---- | ---- | | order_id | string | 是 | 委託 ID | -## 請求示例 +## Request Example @@ -134,9 +134,9 @@ fmt.Printf("%+v\n", resp) -## 響應 +## Response -### 響應示例 +### Response Example ```json { @@ -159,14 +159,14 @@ fmt.Printf("%+v\n", resp) } ``` -### 響應狀態 +### Response Status | 狀態碼 | 描述 | 結構 | | ------ | ---- | ---- | | 200 | 成功 | [USOrderDetailResponse](#USOrderDetailResponse) | | 400 | 請求錯誤 | None | -## 數據結構 +## Schemas ### USOrderDetailResponse diff --git a/docs/zh-HK/docs/trade/order/us_query_orders.md b/docs/zh-HK/docs/trade/order/us_query_orders.md index aaa366b8..fb1a2d4f 100644 --- a/docs/zh-HK/docs/trade/order/us_query_orders.md +++ b/docs/zh-HK/docs/trade/order/us_query_orders.md @@ -25,7 +25,7 @@ longbridge order --status pending -## 參數 +## Parameters > **SDK 方法參數。** @@ -39,7 +39,7 @@ longbridge order --status pending | page | int32 | 否 | 頁碼，從 1 開始（默認：1） | | limit | int32 | 否 | 每頁數量（默認：20） | -## 請求示例 +## Request Example @@ -141,9 +141,9 @@ fmt.Printf("%+v\n", resp) -## 響應 +## Response -### 響應示例 +### Response Example ```json { @@ -164,14 +164,14 @@ fmt.Printf("%+v\n", resp) } ``` -### 響應狀態 +### Response Status | 狀態碼 | 描述 | 結構 | | ------ | ---- | ---- | | 200 | 成功 | [QueryUSOrdersResponse](#QueryUSOrdersResponse) | | 400 | 請求錯誤 | None | -## 數據結構 +## Schemas ### QueryUSOrdersResponse From 65c8c502d0b31237597a8da0e709e0c5e7e3e42b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 18:32:51 +0800 Subject: [PATCH 41/51] fix(docs): complete Go example in us_query_orders.md with full package/imports/main structure --- docs/en/docs/trade/order/us_query_orders.md | 38 +++++++++++++++++-- .../zh-CN/docs/trade/order/us_query_orders.md | 38 +++++++++++++++++-- .../zh-HK/docs/trade/order/us_query_orders.md | 38 +++++++++++++++++-- 3 files changed, 105 insertions(+), 9 deletions(-) diff --git a/docs/en/docs/trade/order/us_query_orders.md b/docs/en/docs/trade/order/us_query_orders.md index e1fa1a47..a78ffd00 100644 --- a/docs/en/docs/trade/order/us_query_orders.md +++ b/docs/en/docs/trade/order/us_query_orders.md @@ -131,9 +131,41 @@ async fn main() -> Result<(), Box> { ```go -resp, err := c.QueryUSOrders(ctx, &trade.GetUSHistoryOrders{Page: 1, Limit: 20}) -if err != nil { log.Fatal(err) } -fmt.Printf("%+v\n", resp) +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/trade" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := trade.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } + defer c.Close() + page := int32(1) + limit := int32(20) + resp, err := c.QueryUSOrders(context.Background(), &trade.GetUSHistoryOrders{Page: page, Limit: limit}) + if err != nil { + log.Fatal(err) + } + fmt.Printf("%+v\n", resp) +} ``` diff --git a/docs/zh-CN/docs/trade/order/us_query_orders.md b/docs/zh-CN/docs/trade/order/us_query_orders.md index 1fb25f22..b9559b42 100644 --- a/docs/zh-CN/docs/trade/order/us_query_orders.md +++ b/docs/zh-CN/docs/trade/order/us_query_orders.md @@ -131,9 +131,41 @@ async fn main() -> Result<(), Box> { ```go -resp, err := c.QueryUSOrders(ctx, &trade.GetUSHistoryOrders{Page: 1, Limit: 20}) -if err != nil { log.Fatal(err) } -fmt.Printf("%+v\n", resp) +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/trade" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := trade.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } + defer c.Close() + page := int32(1) + limit := int32(20) + resp, err := c.QueryUSOrders(context.Background(), &trade.GetUSHistoryOrders{Page: page, Limit: limit}) + if err != nil { + log.Fatal(err) + } + fmt.Printf("%+v\n", resp) +} ``` diff --git a/docs/zh-HK/docs/trade/order/us_query_orders.md b/docs/zh-HK/docs/trade/order/us_query_orders.md index fb1a2d4f..be6cebdd 100644 --- a/docs/zh-HK/docs/trade/order/us_query_orders.md +++ b/docs/zh-HK/docs/trade/order/us_query_orders.md @@ -131,9 +131,41 @@ async fn main() -> Result<(), Box> { ```go -resp, err := c.QueryUSOrders(ctx, &trade.GetUSHistoryOrders{Page: 1, Limit: 20}) -if err != nil { log.Fatal(err) } -fmt.Printf("%+v\n", resp) +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/trade" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := trade.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } + defer c.Close() + page := int32(1) + limit := int32(20) + resp, err := c.QueryUSOrders(context.Background(), &trade.GetUSHistoryOrders{Page: page, Limit: limit}) + if err != nil { + log.Fatal(err) + } + fmt.Printf("%+v\n", resp) +} ``` From a4218589acbd8b2bb5051c7227e2562c57205870 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 18:37:16 +0800 Subject: [PATCH 42/51] fix(docs): complete Go examples with package/imports/main in all US SDK docs (12 files) --- .../docs/quote/stocks/us_crypto_overview.md | 36 ++++++++++++++++-- docs/en/docs/trade/asset/us_asset_overview.md | 36 ++++++++++++++++-- docs/en/docs/trade/asset/us_realized_pl.md | 38 +++++++++++++++++-- docs/en/docs/trade/order/us_order_detail.md | 36 ++++++++++++++++-- .../docs/quote/stocks/us_crypto_overview.md | 36 ++++++++++++++++-- .../docs/trade/asset/us_asset_overview.md | 36 ++++++++++++++++-- docs/zh-CN/docs/trade/asset/us_realized_pl.md | 38 +++++++++++++++++-- .../zh-CN/docs/trade/order/us_order_detail.md | 36 ++++++++++++++++-- .../docs/quote/stocks/us_crypto_overview.md | 36 ++++++++++++++++-- .../docs/trade/asset/us_asset_overview.md | 36 ++++++++++++++++-- docs/zh-HK/docs/trade/asset/us_realized_pl.md | 38 +++++++++++++++++-- .../zh-HK/docs/trade/order/us_order_detail.md | 36 ++++++++++++++++-- 12 files changed, 399 insertions(+), 39 deletions(-) diff --git a/docs/en/docs/quote/stocks/us_crypto_overview.md b/docs/en/docs/quote/stocks/us_crypto_overview.md index 49abfa22..7a4edcf3 100644 --- a/docs/en/docs/quote/stocks/us_crypto_overview.md +++ b/docs/en/docs/quote/stocks/us_crypto_overview.md @@ -123,9 +123,39 @@ async fn main() -> Result<(), Box> { ```go -resp, err := c.CryptoOverview(ctx, "DOGEUSD.BKKT") -if err != nil { log.Fatal(err) } -fmt.Printf("%+v\n", resp) +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/quote" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := quote.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } + defer c.Close() + resp, err := c.CryptoOverview(context.Background(), "DOGEUSD.BKKT") + if err != nil { + log.Fatal(err) + } + fmt.Printf("%+v\n", resp) +} ``` diff --git a/docs/en/docs/trade/asset/us_asset_overview.md b/docs/en/docs/trade/asset/us_asset_overview.md index 74a687a3..8794f576 100644 --- a/docs/en/docs/trade/asset/us_asset_overview.md +++ b/docs/en/docs/trade/asset/us_asset_overview.md @@ -119,9 +119,39 @@ async fn main() -> Result<(), Box> { ```go -resp, err := c.USAssetOverview(ctx) -if err != nil { log.Fatal(err) } -fmt.Printf("%+v\n", resp) +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/trade" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := trade.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } + defer c.Close() + resp, err := c.USAssetOverview(context.Background()) + if err != nil { + log.Fatal(err) + } + fmt.Printf("%+v\n", resp) +} ``` diff --git a/docs/en/docs/trade/asset/us_realized_pl.md b/docs/en/docs/trade/asset/us_realized_pl.md index 80494f0f..444466ce 100644 --- a/docs/en/docs/trade/asset/us_realized_pl.md +++ b/docs/en/docs/trade/asset/us_realized_pl.md @@ -126,10 +126,40 @@ async fn main() -> Result<(), Box> { ```go -cat := "STOCK" -resp, err := c.USRealizedPL(ctx, &trade.GetUSRealizedPL{Currency: "USD", Category: &cat}) -if err != nil { log.Fatal(err) } -fmt.Printf("%+v\n", resp) +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/trade" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := trade.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } + defer c.Close() + cat := "STOCK" + resp, err := c.USRealizedPL(context.Background(), &trade.GetUSRealizedPL{Currency: "USD", Category: &cat}) + if err != nil { + log.Fatal(err) + } + fmt.Printf("%+v\n", resp) +} ``` diff --git a/docs/en/docs/trade/order/us_order_detail.md b/docs/en/docs/trade/order/us_order_detail.md index 129a7120..6db5ff66 100644 --- a/docs/en/docs/trade/order/us_order_detail.md +++ b/docs/en/docs/trade/order/us_order_detail.md @@ -124,9 +124,39 @@ async fn main() -> Result<(), Box> { ```go -resp, err := c.USOrderDetail(ctx, "701276261045858304") -if err != nil { log.Fatal(err) } -fmt.Printf("%+v\n", resp) +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/trade" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := trade.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } + defer c.Close() + resp, err := c.USOrderDetail(context.Background(), "701276261045858304") + if err != nil { + log.Fatal(err) + } + fmt.Printf("%+v\n", resp) +} ``` diff --git a/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md b/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md index 500eec30..c2b408bc 100644 --- a/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md +++ b/docs/zh-CN/docs/quote/stocks/us_crypto_overview.md @@ -123,9 +123,39 @@ async fn main() -> Result<(), Box> { ```go -resp, err := c.CryptoOverview(ctx, "DOGEUSD.BKKT") -if err != nil { log.Fatal(err) } -fmt.Printf("%+v\n", resp) +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/quote" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := quote.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } + defer c.Close() + resp, err := c.CryptoOverview(context.Background(), "DOGEUSD.BKKT") + if err != nil { + log.Fatal(err) + } + fmt.Printf("%+v\n", resp) +} ``` diff --git a/docs/zh-CN/docs/trade/asset/us_asset_overview.md b/docs/zh-CN/docs/trade/asset/us_asset_overview.md index 4b5e125b..996f2ecd 100644 --- a/docs/zh-CN/docs/trade/asset/us_asset_overview.md +++ b/docs/zh-CN/docs/trade/asset/us_asset_overview.md @@ -119,9 +119,39 @@ async fn main() -> Result<(), Box> { ```go -resp, err := c.USAssetOverview(ctx) -if err != nil { log.Fatal(err) } -fmt.Printf("%+v\n", resp) +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/trade" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := trade.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } + defer c.Close() + resp, err := c.USAssetOverview(context.Background()) + if err != nil { + log.Fatal(err) + } + fmt.Printf("%+v\n", resp) +} ``` diff --git a/docs/zh-CN/docs/trade/asset/us_realized_pl.md b/docs/zh-CN/docs/trade/asset/us_realized_pl.md index bfddeeb6..0fb5a09a 100644 --- a/docs/zh-CN/docs/trade/asset/us_realized_pl.md +++ b/docs/zh-CN/docs/trade/asset/us_realized_pl.md @@ -126,10 +126,40 @@ async fn main() -> Result<(), Box> { ```go -cat := "STOCK" -resp, err := c.USRealizedPL(ctx, &trade.GetUSRealizedPL{Currency: "USD", Category: &cat}) -if err != nil { log.Fatal(err) } -fmt.Printf("%+v\n", resp) +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/trade" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := trade.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } + defer c.Close() + cat := "STOCK" + resp, err := c.USRealizedPL(context.Background(), &trade.GetUSRealizedPL{Currency: "USD", Category: &cat}) + if err != nil { + log.Fatal(err) + } + fmt.Printf("%+v\n", resp) +} ``` diff --git a/docs/zh-CN/docs/trade/order/us_order_detail.md b/docs/zh-CN/docs/trade/order/us_order_detail.md index 17be399c..70fdc6a5 100644 --- a/docs/zh-CN/docs/trade/order/us_order_detail.md +++ b/docs/zh-CN/docs/trade/order/us_order_detail.md @@ -124,9 +124,39 @@ async fn main() -> Result<(), Box> { ```go -resp, err := c.USOrderDetail(ctx, "701276261045858304") -if err != nil { log.Fatal(err) } -fmt.Printf("%+v\n", resp) +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/trade" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := trade.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } + defer c.Close() + resp, err := c.USOrderDetail(context.Background(), "701276261045858304") + if err != nil { + log.Fatal(err) + } + fmt.Printf("%+v\n", resp) +} ``` diff --git a/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md b/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md index 17ecb9bd..5bd831ee 100644 --- a/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md +++ b/docs/zh-HK/docs/quote/stocks/us_crypto_overview.md @@ -123,9 +123,39 @@ async fn main() -> Result<(), Box> { ```go -resp, err := c.CryptoOverview(ctx, "DOGEUSD.BKKT") -if err != nil { log.Fatal(err) } -fmt.Printf("%+v\n", resp) +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/quote" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := quote.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } + defer c.Close() + resp, err := c.CryptoOverview(context.Background(), "DOGEUSD.BKKT") + if err != nil { + log.Fatal(err) + } + fmt.Printf("%+v\n", resp) +} ``` diff --git a/docs/zh-HK/docs/trade/asset/us_asset_overview.md b/docs/zh-HK/docs/trade/asset/us_asset_overview.md index 0cc3b612..9f05a67b 100644 --- a/docs/zh-HK/docs/trade/asset/us_asset_overview.md +++ b/docs/zh-HK/docs/trade/asset/us_asset_overview.md @@ -119,9 +119,39 @@ async fn main() -> Result<(), Box> { ```go -resp, err := c.USAssetOverview(ctx) -if err != nil { log.Fatal(err) } -fmt.Printf("%+v\n", resp) +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/trade" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := trade.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } + defer c.Close() + resp, err := c.USAssetOverview(context.Background()) + if err != nil { + log.Fatal(err) + } + fmt.Printf("%+v\n", resp) +} ``` diff --git a/docs/zh-HK/docs/trade/asset/us_realized_pl.md b/docs/zh-HK/docs/trade/asset/us_realized_pl.md index 3af2ea3d..3e60a42a 100644 --- a/docs/zh-HK/docs/trade/asset/us_realized_pl.md +++ b/docs/zh-HK/docs/trade/asset/us_realized_pl.md @@ -126,10 +126,40 @@ async fn main() -> Result<(), Box> { ```go -cat := "STOCK" -resp, err := c.USRealizedPL(ctx, &trade.GetUSRealizedPL{Currency: "USD", Category: &cat}) -if err != nil { log.Fatal(err) } -fmt.Printf("%+v\n", resp) +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/trade" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := trade.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } + defer c.Close() + cat := "STOCK" + resp, err := c.USRealizedPL(context.Background(), &trade.GetUSRealizedPL{Currency: "USD", Category: &cat}) + if err != nil { + log.Fatal(err) + } + fmt.Printf("%+v\n", resp) +} ``` diff --git a/docs/zh-HK/docs/trade/order/us_order_detail.md b/docs/zh-HK/docs/trade/order/us_order_detail.md index 09102a1a..d05b0a9d 100644 --- a/docs/zh-HK/docs/trade/order/us_order_detail.md +++ b/docs/zh-HK/docs/trade/order/us_order_detail.md @@ -124,9 +124,39 @@ async fn main() -> Result<(), Box> { ```go -resp, err := c.USOrderDetail(ctx, "701276261045858304") -if err != nil { log.Fatal(err) } -fmt.Printf("%+v\n", resp) +package main + +import ( + "context" + "fmt" + "log" + + "github.com/longbridge/openapi-go/config" + "github.com/longbridge/openapi-go/oauth" + "github.com/longbridge/openapi-go/trade" +) + +func main() { + o := oauth.New("your-client-id"). + OnOpenURL(func(url string) { fmt.Println("Open this URL to authorize:", url) }) + if err := o.Build(context.Background()); err != nil { + log.Fatal(err) + } + conf, err := config.New(config.WithOAuthClient(o)) + if err != nil { + log.Fatal(err) + } + c, err := trade.NewFromCfg(conf) + if err != nil { + log.Fatal(err) + } + defer c.Close() + resp, err := c.USOrderDetail(context.Background(), "701276261045858304") + if err != nil { + log.Fatal(err) + } + fmt.Printf("%+v\n", resp) +} ``` From 5ae3cf27e1a341ce7ae98b189540da9bf593fd2d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Tue, 7 Jul 2026 18:46:11 +0800 Subject: [PATCH 43/51] fix(docs): add missing USStockEntry schema to us_asset_overview (3 langs) --- docs/en/docs/trade/asset/us_asset_overview.md | 12 ++++++++++++ docs/zh-CN/docs/trade/asset/us_asset_overview.md | 12 ++++++++++++ docs/zh-HK/docs/trade/asset/us_asset_overview.md | 12 ++++++++++++ 3 files changed, 36 insertions(+) diff --git a/docs/en/docs/trade/asset/us_asset_overview.md b/docs/en/docs/trade/asset/us_asset_overview.md index 8794f576..359f7795 100644 --- a/docs/en/docs/trade/asset/us_asset_overview.md +++ b/docs/en/docs/trade/asset/us_asset_overview.md @@ -208,6 +208,18 @@ func main() { | currency | string | true | Currency code (e.g. `USD`) | | amount | string | true | Cash amount | +### USStockEntry + + + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| symbol | string | true | Stock symbol (e.g. `AAPL.US`) | +| quantity | string | true | Quantity held | +| cost_price | string | false | Average cost price | +| current_price | string | false | Current market price | +| market_value | string | false | Current market value | + ### USCryptoEntry diff --git a/docs/zh-CN/docs/trade/asset/us_asset_overview.md b/docs/zh-CN/docs/trade/asset/us_asset_overview.md index 996f2ecd..f82974f1 100644 --- a/docs/zh-CN/docs/trade/asset/us_asset_overview.md +++ b/docs/zh-CN/docs/trade/asset/us_asset_overview.md @@ -209,6 +209,18 @@ func main() { | currency | string | 是 | 货币代码，如 `USD` | | amount | string | 是 | 现金金额 | +### USStockEntry + + + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| symbol | string | 是 | 股票代码，如 `AAPL.US` | +| quantity | string | 是 | 持有数量 | +| cost_price | string | 否 | 平均持仓成本价 | +| current_price | string | 否 | 当前市场价格 | +| market_value | string | 否 | 当前市值 | + ### USCryptoEntry diff --git a/docs/zh-HK/docs/trade/asset/us_asset_overview.md b/docs/zh-HK/docs/trade/asset/us_asset_overview.md index 9f05a67b..841a942c 100644 --- a/docs/zh-HK/docs/trade/asset/us_asset_overview.md +++ b/docs/zh-HK/docs/trade/asset/us_asset_overview.md @@ -209,6 +209,18 @@ func main() { | currency | string | 是 | 貨幣代碼，如 `USD` | | amount | string | 是 | 現金金額 | +### USStockEntry + + + +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| symbol | string | 是 | 股票代碼，如 `AAPL.US` | +| quantity | string | 是 | 持有數量 | +| cost_price | string | 否 | 平均持倉成本價 | +| current_price | string | 否 | 當前市場價格 | +| market_value | string | 否 | 當前市值 | + ### USCryptoEntry From c3bb850d6a8c6e9a86fe60f230fe787bf49219e4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Wed, 8 Jul 2026 11:57:21 +0800 Subject: [PATCH 44/51] docs: add typed Response + Schemas for us_financial_overview/key_financial_metrics/analyst_consensus based on SDK commit 15c713ba0 (9 files) --- .../fundamental/us_analyst_consensus.md | 53 ++++++++- .../fundamental/us_financial_overview.md | 105 ++++++++++++++++- .../fundamental/us_key_financial_metrics.md | 54 ++++++++- .../fundamental/us_analyst_consensus.md | 53 ++++++++- .../fundamental/us_financial_overview.md | 105 ++++++++++++++++- .../fundamental/us_key_financial_metrics.md | 54 ++++++++- .../fundamental/us_analyst_consensus.md | 55 ++++++++- .../fundamental/us_financial_overview.md | 107 +++++++++++++++++- .../fundamental/us_key_financial_metrics.md | 56 ++++++++- 9 files changed, 621 insertions(+), 21 deletions(-) diff --git a/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md index 6d8d00c0..d9cd97c5 100644 --- a/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/en/docs/fundamental/fundamental/us_analyst_consensus.md @@ -163,13 +163,62 @@ func main() { + ## Response -Returns a flexible JSON object containing analyst consensus data (revenue/EPS forecasts, target price distribution, buy/hold/sell breakdown). Structure varies by data availability. +### Response Example + +```json +{ + "ai_summary": "Analysts remain broadly bullish on AAPL with 35 Buy ratings...", + "aichat_data": { + "agent_id": "analyst_aapl", + "handoff_agent_id": "", + "symbol": "AAPL.US", + "text": "Analyst consensus summary for AAPL", + "chat_type": "consensus", + "workflow_type": "analyst" + }, + "currency": "USD", + "report": "annual", + "list": null, + "opt_reports": null, + "h5_data": null +} +``` ### Response Status | Status | Description | Schema | | ------ | ----------- | ------ | -| 200 | Success | object | +| 200 | Success | [UsAnalystConsensus](#UsAnalystConsensus) | | 400 | Bad request | None | + +## Schemas + +### UsAnalystConsensus + + + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| ai_summary | string | true | AI-generated analyst consensus summary | +| aichat_data | USAIChatData | true | AI chat context data | +| currency | string | true | Currency code (e.g. `USD`) | +| report | string | true | Report period type | +| list | any | false | Consensus detail list (structure varies) | +| opt_reports | any | false | Optional report data | +| h5_data | any | false | H5 display data | + +### USAIChatData + + + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| agent_id | string | true | AI agent identifier | +| handoff_agent_id | string | false | Handoff agent identifier | +| symbol | string | true | Stock symbol | +| text | string | true | Chat context text | +| chat_type | string | true | Chat type | +| workflow_type | string | true | Workflow type | diff --git a/docs/en/docs/fundamental/fundamental/us_financial_overview.md b/docs/en/docs/fundamental/fundamental/us_financial_overview.md index dadb47d1..ef780e15 100644 --- a/docs/en/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/en/docs/fundamental/fundamental/us_financial_overview.md @@ -163,13 +163,114 @@ func main() { + ## Response -Returns a flexible JSON object. Structure varies by company and reporting period. Contains income statement, balance sheet, and cash flow summary data. +### Response Example + +```json +{ + "ccy_symbol": "USD", + "report_type": "annual", + "is_list": [ + { + "revenue": "391035000000", + "net_income": "93736000000", + "net_margin": "0.2397", + "report": { + "start_date": "2023-10-01", + "end_date": "2024-09-28", + "report_txt": "FY2024" + } + } + ], + "bs_list": [ + { + "debt_assets_ratio": "0.8193", + "total_assets": "364840000000", + "total_liabilities": "308927000000", + "report": { + "start_date": "2023-10-01", + "end_date": "2024-09-28", + "report_txt": "FY2024" + } + } + ], + "cf_list": [ + { + "operating": "118254000000", + "investing": "-21013000000", + "financing": "-89831000000", + "report": { + "start_date": "2023-10-01", + "end_date": "2024-09-28", + "report_txt": "FY2024" + } + } + ] +} +``` ### Response Status | Status | Description | Schema | | ------ | ----------- | ------ | -| 200 | Success | object | +| 200 | Success | [UsFinancialOverview](#UsFinancialOverview) | | 400 | Bad request | None | + +## Schemas + +### UsFinancialOverview + + + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| ccy_symbol | string | true | Currency symbol | +| report_type | string | true | Report type (e.g. `annual`, `quarterly`) | +| is_list | USFinancialISItem[] | true | Income statement items | +| bs_list | USFinancialBSItem[] | true | Balance sheet items | +| cf_list | USFinancialCFItem[] | true | Cash flow items | + +### USFinancialISItem + + + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| revenue | string | true | Total revenue | +| net_income | string | true | Net income | +| net_margin | string | true | Net profit margin | +| report | USReportPeriod | true | Reporting period info | + +### USFinancialBSItem + + + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| debt_assets_ratio | string | true | Debt-to-assets ratio | +| total_assets | string | true | Total assets | +| total_liabilities | string | true | Total liabilities | +| report | USReportPeriod | true | Reporting period info | + +### USFinancialCFItem + + + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| operating | string | true | Operating cash flow | +| investing | string | true | Investing cash flow | +| financing | string | true | Financing cash flow | +| report | USReportPeriod | true | Reporting period info | + +### USReportPeriod + + + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| start_date | string | true | Period start date (YYYY-MM-DD) | +| end_date | string | true | Period end date (YYYY-MM-DD) | +| report_txt | string | true | Period label (e.g. `FY2024`, `Q1 2024`) | diff --git a/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md index 739c38dd..b9e1a04a 100644 --- a/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/en/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -163,13 +163,63 @@ func main() { + ## Response -Returns a flexible JSON object containing key financial metrics (revenue, net income, EPS, margins, growth rates). Structure varies by company. +### Response Example + +```json +{ + "currency": "USD", + "report": "annual", + "empty_fields": [], + "list": [ + { + "ff_period": "A", + "ff_year": 2024, + "fp_end": "2024-09-28", + "report_txt": "FY2024", + "rpt_date": "2024-11-01", + "fields": { + "revenue": "391035000000", + "gross_margin": "0.4621", + "net_margin": "0.2397", + "eps": "6.07" + } + } + ] +} +``` ### Response Status | Status | Description | Schema | | ------ | ----------- | ------ | -| 200 | Success | object | +| 200 | Success | [UsKeyFinancialMetrics](#UsKeyFinancialMetrics) | | 400 | Bad request | None | + +## Schemas + +### UsKeyFinancialMetrics + + + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| currency | string | true | Currency code (e.g. `USD`) | +| report | string | true | Report period type (e.g. `annual`, `quarterly`) | +| empty_fields | string[] | false | Fields with no data for this period | +| list | USKeyMetricItem[] | true | Key metric records by period | + +### USKeyMetricItem + + + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| ff_period | string | true | Period type code (e.g. `A`=annual, `Q`=quarterly) | +| ff_year | int | true | Fiscal year | +| fp_end | string | true | Period end date (YYYY-MM-DD) | +| report_txt | string | true | Period label (e.g. `FY2024`) | +| rpt_date | string | true | Report release date (YYYY-MM-DD) | +| fields | object | true | Key financial metrics (structure varies by company) | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md index a1815378..451bc353 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_analyst_consensus.md @@ -164,13 +164,62 @@ func main() { + ## Response -返回结构灵活的 JSON 对象，包含分析师一致预期数据（营收/EPS 预测、目标价分布、买入/持有/卖出分布），具体字段因数据可用性而异。 +### Response Example + +```json +{ + "ai_summary": "Analysts remain broadly bullish on AAPL with 35 Buy ratings...", + "aichat_data": { + "agent_id": "analyst_aapl", + "handoff_agent_id": "", + "symbol": "AAPL.US", + "text": "Analyst consensus summary for AAPL", + "chat_type": "consensus", + "workflow_type": "analyst" + }, + "currency": "USD", + "report": "annual", + "list": null, + "opt_reports": null, + "h5_data": null +} +``` ### Response Status | 状态码 | 描述 | 结构 | | ------ | ---- | ---- | -| 200 | 成功 | object | +| 200 | 成功 | [UsAnalystConsensus](#UsAnalystConsensus) | | 400 | 请求错误 | None | + +## Schemas + +### UsAnalystConsensus + + + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| ai_summary | string | 是 | AI 生成的分析师一致预期摘要 | +| aichat_data | USAIChatData | 是 | AI 对话上下文数据 | +| currency | string | 是 | 货币代码，如 `USD` | +| report | string | 是 | 报告周期类型 | +| list | any | 否 | 一致预期明细列表（结构不固定） | +| opt_reports | any | 否 | 可选报告数据 | +| h5_data | any | 否 | H5 展示数据 | + +### USAIChatData + + + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| agent_id | string | 是 | AI Agent 标识 | +| handoff_agent_id | string | 否 | 转交 Agent 标识 | +| symbol | string | 是 | 股票代码 | +| text | string | 是 | 对话上下文文本 | +| chat_type | string | 是 | 对话类型 | +| workflow_type | string | 是 | 工作流类型 | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md index 50883d2e..953fe0a4 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_financial_overview.md @@ -164,13 +164,114 @@ func main() { + ## Response -返回结构灵活的 JSON 对象，内容因公司和报告周期而异，包含损益、资产负债和现金流摘要数据。 +### Response Example + +```json +{ + "ccy_symbol": "USD", + "report_type": "annual", + "is_list": [ + { + "revenue": "391035000000", + "net_income": "93736000000", + "net_margin": "0.2397", + "report": { + "start_date": "2023-10-01", + "end_date": "2024-09-28", + "report_txt": "FY2024" + } + } + ], + "bs_list": [ + { + "debt_assets_ratio": "0.8193", + "total_assets": "364840000000", + "total_liabilities": "308927000000", + "report": { + "start_date": "2023-10-01", + "end_date": "2024-09-28", + "report_txt": "FY2024" + } + } + ], + "cf_list": [ + { + "operating": "118254000000", + "investing": "-21013000000", + "financing": "-89831000000", + "report": { + "start_date": "2023-10-01", + "end_date": "2024-09-28", + "report_txt": "FY2024" + } + } + ] +} +``` ### Response Status | 状态码 | 描述 | 结构 | | ------ | ---- | ---- | -| 200 | 成功 | object | +| 200 | 成功 | [UsFinancialOverview](#UsFinancialOverview) | | 400 | 请求错误 | None | + +## Schemas + +### UsFinancialOverview + + + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| ccy_symbol | string | 是 | 货币符号 | +| report_type | string | 是 | 报告类型（如 `annual`、`quarterly`） | +| is_list | USFinancialISItem[] | 是 | 损益表条目列表 | +| bs_list | USFinancialBSItem[] | 是 | 资产负债表条目列表 | +| cf_list | USFinancialCFItem[] | 是 | 现金流量表条目列表 | + +### USFinancialISItem + + + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| revenue | string | 是 | 总营收 | +| net_income | string | 是 | 净利润 | +| net_margin | string | 是 | 净利润率 | +| report | USReportPeriod | 是 | 报告期信息 | + +### USFinancialBSItem + + + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| debt_assets_ratio | string | 是 | 资产负债率 | +| total_assets | string | 是 | 总资产 | +| total_liabilities | string | 是 | 总负债 | +| report | USReportPeriod | 是 | 报告期信息 | + +### USFinancialCFItem + + + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| operating | string | 是 | 经营活动现金流 | +| investing | string | 是 | 投资活动现金流 | +| financing | string | 是 | 筹资活动现金流 | +| report | USReportPeriod | 是 | 报告期信息 | + +### USReportPeriod + + + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| start_date | string | 是 | 报告期开始日期 | +| end_date | string | 是 | 报告期结束日期 | +| report_txt | string | 是 | 报告期标签（如 `FY2024`、`Q1 2024`） | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md index b3430cc0..46f58e5e 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -164,13 +164,63 @@ func main() { + ## Response -返回结构灵活的 JSON 对象，包含关键财务指标（营收、净利润、EPS、利润率和增长率），具体字段因公司而异。 +### Response Example + +```json +{ + "currency": "USD", + "report": "annual", + "empty_fields": [], + "list": [ + { + "ff_period": "A", + "ff_year": 2024, + "fp_end": "2024-09-28", + "report_txt": "FY2024", + "rpt_date": "2024-11-01", + "fields": { + "revenue": "391035000000", + "gross_margin": "0.4621", + "net_margin": "0.2397", + "eps": "6.07" + } + } + ] +} +``` ### Response Status | 状态码 | 描述 | 结构 | | ------ | ---- | ---- | -| 200 | 成功 | object | +| 200 | 成功 | [UsKeyFinancialMetrics](#UsKeyFinancialMetrics) | | 400 | 请求错误 | None | + +## Schemas + +### UsKeyFinancialMetrics + + + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| currency | string | 是 | 货币代码，如 `USD` | +| report | string | 是 | 报告周期类型（如 `annual`、`quarterly`） | +| empty_fields | string[] | 否 | 本期无数据的字段列表 | +| list | USKeyMetricItem[] | 是 | 按报告期排列的关键指标数据 | + +### USKeyMetricItem + + + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| ff_period | string | 是 | 报告周期代码（如 `A`=年报、`Q`=季报） | +| ff_year | int | 是 | 财年 | +| fp_end | string | 是 | 报告期结束日期 | +| report_txt | string | 是 | 报告期标签（如 `FY2024`） | +| rpt_date | string | 是 | 财报发布日期 | +| fields | object | 是 | 关键财务指标（结构因公司而异） | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md b/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md index a1c0e9d1..e5b12bb8 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_analyst_consensus.md @@ -164,13 +164,62 @@ func main() { + ## Response -返回結構靈活的 JSON 對象，包含分析師一致預期數據（營收/EPS 預測、目標價分佈、買入/持有/賣出分佈），具體字段因數據可用性而異。 +### Response Example + +```json +{ + "ai_summary": "Analysts remain broadly bullish on AAPL with 35 Buy ratings...", + "aichat_data": { + "agent_id": "analyst_aapl", + "handoff_agent_id": "", + "symbol": "AAPL.US", + "text": "Analyst consensus summary for AAPL", + "chat_type": "consensus", + "workflow_type": "analyst" + }, + "currency": "USD", + "report": "annual", + "list": null, + "opt_reports": null, + "h5_data": null +} +``` ### Response Status -| 狀態碼 | 描述 | 結構 | +| 状態码 | 描述 | 结構 | | ------ | ---- | ---- | -| 200 | 成功 | object | +| 200 | 成功 | [UsAnalystConsensus](#UsAnalystConsensus) | | 400 | 請求錯誤 | None | + +## Schemas + +### UsAnalystConsensus + + + +| 名称 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| ai_summary | string | 是 | AI 生成的分析师一致预期摘要 | +| aichat_data | USAIChatData | 是 | AI 对话上下文數据 | +| currency | string | 是 | 貨币代码，如 `USD` | +| report | string | 是 | 報告周期類型 | +| list | any | 否 | 一致预期明细列表（结構不固定） | +| opt_reports | any | 否 | 可选報告數据 | +| h5_data | any | 否 | H5 展示數据 | + +### USAIChatData + + + +| 名称 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| agent_id | string | 是 | AI Agent 標识 | +| handoff_agent_id | string | 否 | 转交 Agent 標识 | +| symbol | string | 是 | 股票代码 | +| text | string | 是 | 对话上下文文本 | +| chat_type | string | 是 | 对话類型 | +| workflow_type | string | 是 | 工作流類型 | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md index f45ece9d..d2edeeb3 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_financial_overview.md @@ -164,13 +164,114 @@ func main() { + ## Response -返回結構靈活的 JSON 對象，內容因公司和報告週期而異，包含損益、資產負債和現金流摘要數據。 +### Response Example + +```json +{ + "ccy_symbol": "USD", + "report_type": "annual", + "is_list": [ + { + "revenue": "391035000000", + "net_income": "93736000000", + "net_margin": "0.2397", + "report": { + "start_date": "2023-10-01", + "end_date": "2024-09-28", + "report_txt": "FY2024" + } + } + ], + "bs_list": [ + { + "debt_assets_ratio": "0.8193", + "total_assets": "364840000000", + "total_liabilities": "308927000000", + "report": { + "start_date": "2023-10-01", + "end_date": "2024-09-28", + "report_txt": "FY2024" + } + } + ], + "cf_list": [ + { + "operating": "118254000000", + "investing": "-21013000000", + "financing": "-89831000000", + "report": { + "start_date": "2023-10-01", + "end_date": "2024-09-28", + "report_txt": "FY2024" + } + } + ] +} +``` ### Response Status -| 狀態碼 | 描述 | 結構 | +| 状態码 | 描述 | 结構 | | ------ | ---- | ---- | -| 200 | 成功 | object | +| 200 | 成功 | [UsFinancialOverview](#UsFinancialOverview) | | 400 | 請求錯誤 | None | + +## Schemas + +### UsFinancialOverview + + + +| 名称 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| ccy_symbol | string | 是 | 貨币符号 | +| report_type | string | 是 | 報告類型（如 `annual`、`quarterly`） | +| is_list | USFinancialISItem[] | 是 | 損益表条目列表 | +| bs_list | USFinancialBSItem[] | 是 | 資產負債表条目列表 | +| cf_list | USFinancialCFItem[] | 是 | 现金流量表条目列表 | + +### USFinancialISItem + + + +| 名称 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| revenue | string | 是 | 總營收 | +| net_income | string | 是 | 净利润 | +| net_margin | string | 是 | 净利润率 | +| report | USReportPeriod | 是 | 報告期信息 | + +### USFinancialBSItem + + + +| 名称 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| debt_assets_ratio | string | 是 | 資產負債率 | +| total_assets | string | 是 | 總資產 | +| total_liabilities | string | 是 | 總負債 | +| report | USReportPeriod | 是 | 報告期信息 | + +### USFinancialCFItem + + + +| 名称 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| operating | string | 是 | 经營活动现金流 | +| investing | string | 是 | 投資活动现金流 | +| financing | string | 是 | 籌資活动现金流 | +| report | USReportPeriod | 是 | 報告期信息 | + +### USReportPeriod + + + +| 名称 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| start_date | string | 是 | 報告期开始日期 | +| end_date | string | 是 | 報告期结束日期 | +| report_txt | string | 是 | 報告期標签（如 `FY2024`、`Q1 2024`） | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md b/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md index 6cfa27bf..caf583ae 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_key_financial_metrics.md @@ -164,13 +164,63 @@ func main() { + ## Response -返回結構靈活的 JSON 對象，包含關鍵財務指標（營收、淨利潤、EPS、利潤率和增長率），具體字段因公司而異。 +### Response Example + +```json +{ + "currency": "USD", + "report": "annual", + "empty_fields": [], + "list": [ + { + "ff_period": "A", + "ff_year": 2024, + "fp_end": "2024-09-28", + "report_txt": "FY2024", + "rpt_date": "2024-11-01", + "fields": { + "revenue": "391035000000", + "gross_margin": "0.4621", + "net_margin": "0.2397", + "eps": "6.07" + } + } + ] +} +``` ### Response Status -| 狀態碼 | 描述 | 結構 | +| 状態码 | 描述 | 结構 | | ------ | ---- | ---- | -| 200 | 成功 | object | +| 200 | 成功 | [UsKeyFinancialMetrics](#UsKeyFinancialMetrics) | | 400 | 請求錯誤 | None | + +## Schemas + +### UsKeyFinancialMetrics + + + +| 名称 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| currency | string | 是 | 貨币代码，如 `USD` | +| report | string | 是 | 報告周期類型（如 `annual`、`quarterly`） | +| empty_fields | string[] | 否 | 本期无數据的字段列表 | +| list | USKeyMetricItem[] | 是 | 按報告期排列的关鍵指標數据 | + +### USKeyMetricItem + + + +| 名称 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| ff_period | string | 是 | 報告周期代码（如 `A`=年報、`Q`=季報） | +| ff_year | int | 是 | 財年 | +| fp_end | string | 是 | 報告期结束日期 | +| report_txt | string | 是 | 報告期標签（如 `FY2024`） | +| rpt_date | string | 是 | 財報发布日期 | +| fields | object | 是 | 关鍵財务指標（结構因公司而异） | From 0b2b2ce9bbbf65a710e5b0837301aceaba46aceb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Wed, 8 Jul 2026 15:00:06 +0800 Subject: [PATCH 45/51] fix(docs): add missing Parameters caption to us_asset_overview.md (3 langs) --- docs/en/docs/trade/asset/us_asset_overview.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/en/docs/trade/asset/us_asset_overview.md b/docs/en/docs/trade/asset/us_asset_overview.md index 359f7795..82149197 100644 --- a/docs/en/docs/trade/asset/us_asset_overview.md +++ b/docs/en/docs/trade/asset/us_asset_overview.md @@ -25,6 +25,8 @@ longbridge positions ## Parameters +> **SDK method parameters.** + No parameters required. ## Request Example From d55d7f39487643c465ed6acad6adfd75592d748b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Wed, 8 Jul 2026 15:05:34 +0800 Subject: [PATCH 46/51] fix(docs): add missing Parameters caption to zh-CN/zh-HK us_asset_overview.md --- docs/zh-CN/docs/trade/asset/us_asset_overview.md | 2 ++ docs/zh-HK/docs/trade/asset/us_asset_overview.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/docs/zh-CN/docs/trade/asset/us_asset_overview.md b/docs/zh-CN/docs/trade/asset/us_asset_overview.md index f82974f1..bd47f156 100644 --- a/docs/zh-CN/docs/trade/asset/us_asset_overview.md +++ b/docs/zh-CN/docs/trade/asset/us_asset_overview.md @@ -25,6 +25,8 @@ longbridge positions ## Parameters +> **SDK 方法参数。** + 无需参数。 ## Request Example diff --git a/docs/zh-HK/docs/trade/asset/us_asset_overview.md b/docs/zh-HK/docs/trade/asset/us_asset_overview.md index 841a942c..3d376007 100644 --- a/docs/zh-HK/docs/trade/asset/us_asset_overview.md +++ b/docs/zh-HK/docs/trade/asset/us_asset_overview.md @@ -25,6 +25,8 @@ longbridge positions ## Parameters +> **SDK 方法參數。** + 無需參數。 ## Request Example From 218d74643df2a4724619b277f213dfa4f9db1f3c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Thu, 9 Jul 2026 11:03:24 +0800 Subject: [PATCH 47/51] =?UTF-8?q?fix(docs):=20rename=20us=5Ffinancial=5Fst?= =?UTF-8?q?atement=5Fv3=20=E2=86=92=20us=5Ffinancial=5Fstatement=20(correc?= =?UTF-8?q?t=20SDK=20method=20name)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...ial_statement_v3.md => us_financial_statement.md} | 12 ++++++------ ...ial_statement_v3.md => us_financial_statement.md} | 12 ++++++------ ...ial_statement_v3.md => us_financial_statement.md} | 12 ++++++------ 3 files changed, 18 insertions(+), 18 deletions(-) rename docs/en/docs/fundamental/fundamental/{us_financial_statement_v3.md => us_financial_statement.md} (92%) rename docs/zh-CN/docs/fundamental/fundamental/{us_financial_statement_v3.md => us_financial_statement.md} (92%) rename docs/zh-HK/docs/fundamental/fundamental/{us_financial_statement_v3.md => us_financial_statement.md} (92%) diff --git a/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/en/docs/fundamental/fundamental/us_financial_statement.md similarity index 92% rename from docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md rename to docs/en/docs/fundamental/fundamental/us_financial_statement.md index 3a63762c..d6079d5e 100644 --- a/docs/en/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/en/docs/fundamental/fundamental/us_financial_statement.md @@ -1,5 +1,5 @@ --- -slug: us_financial_statement_v3 +slug: us_financial_statement title: US Financial Statement sidebar_position: 33 language_tabs: false @@ -23,7 +23,7 @@ longbridge financial-report AAPL.US --kind IS longbridge financial-report AAPL.US --kind BS - + ## Parameters @@ -46,7 +46,7 @@ from longbridge.openapi import FundamentalContext, Config, OAuthBuilder oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) config = Config.from_oauth(oauth) ctx = FundamentalContext(config) -resp = ctx.us_financial_statement_v3("AAPL.US", kind="IS", report="annual") +resp = ctx.us_financial_statement("AAPL.US", kind="IS", report="annual") print(resp) ``` @@ -61,7 +61,7 @@ async def main() -> None: oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("Visit:", url)) config = Config.from_oauth(oauth) ctx = AsyncFundamentalContext.create(config) - resp = await ctx.us_financial_statement_v3("AAPL.US", kind="IS", report="annual") + resp = await ctx.us_financial_statement("AAPL.US", kind="IS", report="annual") print(resp) if __name__ == "__main__": @@ -98,7 +98,7 @@ class Main { try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); Config config = Config.fromOAuth(oauth); FundamentalContext ctx = FundamentalContext.create(config)) { - var resp = ctx.getUsFinancialStatementV3("AAPL.US", "IS", "annual").get(); + var resp = ctx.getUsFinancialStatement("AAPL.US", "IS", "annual").get(); System.out.println(resp); } } @@ -117,7 +117,7 @@ async fn main() -> Result<(), Box> { let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("Open: {url}")).await?; let config = Arc::new(Config::from_oauth(oauth)); let ctx = FundamentalContext::new(config); - let resp = ctx.us_financial_statement_v3("AAPL.US", "IS", "annual").await?; + let resp = ctx.us_financial_statement("AAPL.US", "IS", "annual").await?; println!("{:?}", resp); Ok(()) } diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement.md similarity index 92% rename from docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md rename to docs/zh-CN/docs/fundamental/fundamental/us_financial_statement.md index 9d7bbb72..648827b0 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement.md @@ -1,5 +1,5 @@ --- -slug: us_financial_statement_v3 +slug: us_financial_statement title: 美股财务报表 sidebar_position: 33 language_tabs: false @@ -23,7 +23,7 @@ longbridge financial-report AAPL.US --kind IS longbridge financial-report AAPL.US --kind BS - + ## Parameters @@ -46,7 +46,7 @@ from longbridge.openapi import FundamentalContext, Config, OAuthBuilder oauth = OAuthBuilder("your-client-id").build(lambda url: print("请访问：", url)) config = Config.from_oauth(oauth) ctx = FundamentalContext(config) -resp = ctx.us_financial_statement_v3("AAPL.US", kind="IS", report="annual") +resp = ctx.us_financial_statement("AAPL.US", kind="IS", report="annual") print(resp) ``` @@ -61,7 +61,7 @@ async def main() -> None: oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("请访问：", url)) config = Config.from_oauth(oauth) ctx = AsyncFundamentalContext.create(config) - resp = await ctx.us_financial_statement_v3("AAPL.US", kind="IS", report="annual") + resp = await ctx.us_financial_statement("AAPL.US", kind="IS", report="annual") print(resp) if __name__ == "__main__": @@ -98,7 +98,7 @@ class Main { try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); Config config = Config.fromOAuth(oauth); FundamentalContext ctx = FundamentalContext.create(config)) { - var resp = ctx.getUsFinancialStatementV3("AAPL.US", "IS", "annual").get(); + var resp = ctx.getUsFinancialStatement("AAPL.US", "IS", "annual").get(); System.out.println(resp); } } @@ -117,7 +117,7 @@ async fn main() -> Result<(), Box> { let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("请访问：{url}")).await?; let config = Arc::new(Config::from_oauth(oauth)); let ctx = FundamentalContext::new(config); - let resp = ctx.us_financial_statement_v3("AAPL.US", "IS", "annual").await?; + let resp = ctx.us_financial_statement("AAPL.US", "IS", "annual").await?; println!("{:?}", resp); Ok(()) } diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md b/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement.md similarity index 92% rename from docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md rename to docs/zh-HK/docs/fundamental/fundamental/us_financial_statement.md index dad3f409..5ab7e38c 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement_v3.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement.md @@ -1,5 +1,5 @@ --- -slug: us_financial_statement_v3 +slug: us_financial_statement title: 美股財務報表 sidebar_position: 33 language_tabs: false @@ -23,7 +23,7 @@ longbridge financial-report AAPL.US --kind IS longbridge financial-report AAPL.US --kind BS - + ## Parameters @@ -46,7 +46,7 @@ from longbridge.openapi import FundamentalContext, Config, OAuthBuilder oauth = OAuthBuilder("your-client-id").build(lambda url: print("請訪問：", url)) config = Config.from_oauth(oauth) ctx = FundamentalContext(config) -resp = ctx.us_financial_statement_v3("AAPL.US", kind="IS", report="annual") +resp = ctx.us_financial_statement("AAPL.US", kind="IS", report="annual") print(resp) ``` @@ -61,7 +61,7 @@ async def main() -> None: oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("請訪問：", url)) config = Config.from_oauth(oauth) ctx = AsyncFundamentalContext.create(config) - resp = await ctx.us_financial_statement_v3("AAPL.US", kind="IS", report="annual") + resp = await ctx.us_financial_statement("AAPL.US", kind="IS", report="annual") print(resp) if __name__ == "__main__": @@ -98,7 +98,7 @@ class Main { try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); Config config = Config.fromOAuth(oauth); FundamentalContext ctx = FundamentalContext.create(config)) { - var resp = ctx.getUsFinancialStatementV3("AAPL.US", "IS", "annual").get(); + var resp = ctx.getUsFinancialStatement("AAPL.US", "IS", "annual").get(); System.out.println(resp); } } @@ -117,7 +117,7 @@ async fn main() -> Result<(), Box> { let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("請訪問：{url}")).await?; let config = Arc::new(Config::from_oauth(oauth)); let ctx = FundamentalContext::new(config); - let resp = ctx.us_financial_statement_v3("AAPL.US", "IS", "annual").await?; + let resp = ctx.us_financial_statement("AAPL.US", "IS", "annual").await?; println!("{:?}", resp); Ok(()) } From 4a3a6a183c279dc0756f8cd1b5f2cca821f7a8d4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Thu, 9 Jul 2026 11:04:51 +0800 Subject: [PATCH 48/51] =?UTF-8?q?fix(docs):=20correct=20financial-statemen?= =?UTF-8?q?t=20CLI=20routing=20=E2=80=94=20separate=20command=20from=20fin?= =?UTF-8?q?ancial-report,=20fix=20CliCommand=20in=20us=5Ffinancial=5Fstate?= =?UTF-8?q?ment=20SDK=20doc?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/en/docs/cli/fundamentals/financial-report.md | 6 ++---- docs/en/docs/cli/fundamentals/financial-statement.md | 4 ++++ .../docs/fundamental/fundamental/us_financial_statement.md | 4 ++-- docs/zh-CN/docs/cli/fundamentals/financial-report.md | 6 ++---- .../docs/fundamental/fundamental/us_financial_statement.md | 4 ++-- docs/zh-HK/docs/cli/fundamentals/financial-report.md | 6 ++---- .../docs/fundamental/fundamental/us_financial_statement.md | 4 ++-- 7 files changed, 16 insertions(+), 18 deletions(-) diff --git a/docs/en/docs/cli/fundamentals/financial-report.md b/docs/en/docs/cli/fundamentals/financial-report.md index 90ff5df8..f098c070 100644 --- a/docs/en/docs/cli/fundamentals/financial-report.md +++ b/docs/en/docs/cli/fundamentals/financial-report.md @@ -115,9 +115,7 @@ Returns key financial indicators for US stocks: revenue, net income, EPS, margin | `--report` | Reporting period: `annual` \| `quarterly` | annual | :::info US Accounts -For `.US` symbols on US data-center accounts: -- Omitting `--kind` returns a financial overview via the US API -- Specifying `--kind IS`, `BS`, or `CF` returns the detailed statement via the US API +For `.US` symbols on US data-center accounts, omitting `--kind` returns a financial overview via the US API. -Note: `--kind` defaults to an empty string (not `ALL`) to enable this US routing behavior. +To get detailed income statement / balance sheet / cash flow for US stocks, use the [`financial-statement`](/docs/cli/fundamentals/financial-statement) command instead. ::: diff --git a/docs/en/docs/cli/fundamentals/financial-statement.md b/docs/en/docs/cli/fundamentals/financial-statement.md index 94375ca5..5e05ef7b 100644 --- a/docs/en/docs/cli/fundamentals/financial-statement.md +++ b/docs/en/docs/cli/fundamentals/financial-statement.md @@ -8,6 +8,10 @@ sidebar_position: 3 Fetch a fully detailed, line-item financial statement — income statement, balance sheet, or cash flow — for any public company. + +:::info US Accounts +For `.US` symbols on US data-center accounts, `financial-statement` calls `us_financial_statement()` — the US-specific detailed statement API. +::: ## Basic Usage ```bash diff --git a/docs/en/docs/fundamental/fundamental/us_financial_statement.md b/docs/en/docs/fundamental/fundamental/us_financial_statement.md index d6079d5e..6e5312cd 100644 --- a/docs/en/docs/fundamental/fundamental/us_financial_statement.md +++ b/docs/en/docs/fundamental/fundamental/us_financial_statement.md @@ -18,9 +18,9 @@ Get a specific financial statement (income statement, balance sheet, or cash flo # Income statement -longbridge financial-report AAPL.US --kind IS +longbridge financial-statement AAPL.US --kind IS # Balance sheet -longbridge financial-report AAPL.US --kind BS +longbridge financial-statement AAPL.US --kind BS diff --git a/docs/zh-CN/docs/cli/fundamentals/financial-report.md b/docs/zh-CN/docs/cli/fundamentals/financial-report.md index e2317dff..68eb0a57 100644 --- a/docs/zh-CN/docs/cli/fundamentals/financial-report.md +++ b/docs/zh-CN/docs/cli/fundamentals/financial-report.md @@ -112,9 +112,7 @@ longbridge financial-report key-metrics AAPL.US --report quarterly | `--report` | 报告周期：`annual` \| `quarterly` | annual | :::info 美股账户 -对于美国数据中心账户的 `.US` 标的： -- 不指定 `--kind` 时，通过美股 API 返回财务概览 -- 指定 `--kind IS`、`BS` 或 `CF` 时，通过美股 API 返回详细报表 +美国数据中心账户的 `.US` 标的，不指定 `--kind` 时通过美股 API 返回财务概览。 -注意：`--kind` 默认为空字符串（非 `ALL`），以支持美股路由逻辑。 +如需查看美股详细的损益表 / 资产负债表 / 现金流量表，请使用 [`financial-statement`](/zh-CN/docs/cli/fundamentals/financial-statement) 命令。 ::: diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement.md b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement.md index 648827b0..af7e8afe 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement.md @@ -18,9 +18,9 @@ headingLevel: 2 # 损益表 -longbridge financial-report AAPL.US --kind IS +longbridge financial-statement AAPL.US --kind IS # 资产负债表 -longbridge financial-report AAPL.US --kind BS +longbridge financial-statement AAPL.US --kind BS diff --git a/docs/zh-HK/docs/cli/fundamentals/financial-report.md b/docs/zh-HK/docs/cli/fundamentals/financial-report.md index 3f2e15d5..9217f6a4 100644 --- a/docs/zh-HK/docs/cli/fundamentals/financial-report.md +++ b/docs/zh-HK/docs/cli/fundamentals/financial-report.md @@ -112,9 +112,7 @@ longbridge financial-report key-metrics AAPL.US --report quarterly | `--report` | 報告週期：`annual` \| `quarterly` | annual | :::info 美股賬戶 -對於美國數據中心賬戶的 `.US` 標的： -- 不指定 `--kind` 時，透過美股 API 返回財務概覽 -- 指定 `--kind IS`、`BS` 或 `CF` 時，透過美股 API 返回詳細報表 +美國數據中心賬戶的 `.US` 標的，不指定 `--kind` 時透過美股 API 返回財務概覽。 -注意：`--kind` 默認為空字符串（非 `ALL`），以支持美股路由邏輯。 +如需查看美股詳細的損益表 / 資產負債表 / 現金流量表，請使用 [`financial-statement`](/zh-HK/docs/cli/fundamentals/financial-statement) 命令。 ::: diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement.md b/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement.md index 5ab7e38c..a1b7a8e5 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement.md @@ -18,9 +18,9 @@ headingLevel: 2 # 損益表 -longbridge financial-report AAPL.US --kind IS +longbridge financial-statement AAPL.US --kind IS # 資產負債表 -longbridge financial-report AAPL.US --kind BS +longbridge financial-statement AAPL.US --kind BS From ec5dd24875e74bc0e6029e3429243707f9134b53 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Thu, 9 Jul 2026 11:07:27 +0800 Subject: [PATCH 49/51] fix(docs): remove non-existent --status flag from order command (CLI PR #262 only has --action) --- docs/en/docs/cli/orders/order.md | 95 ----------------------------- docs/zh-CN/docs/cli/orders/order.md | 95 ----------------------------- docs/zh-HK/docs/cli/orders/order.md | 92 ---------------------------- 3 files changed, 282 deletions(-) diff --git a/docs/en/docs/cli/orders/order.md b/docs/en/docs/cli/orders/order.md index ba44f417..c71f62f8 100644 --- a/docs/en/docs/cli/orders/order.md +++ b/docs/en/docs/cli/orders/order.md @@ -24,100 +24,6 @@ longbridge order ## Examples -### View today's orders - -```bash -longbridge order -``` - -Lists all orders placed today with their status, symbol, quantity, price, and order ID. - -### Historical orders for a symbol - -```bash -longbridge order --history --start 2026-01-01 --symbol TSLA.US -``` - -Fetches historical orders filtered by symbol and date range. Use `--start` and `--end` to set the date window. - -### Submit a limit buy order - -```bash -longbridge order buy TSLA.US 10 --price 340.00 -``` - -Places a limit buy order for 10 shares of TSLA at $340.00. The command prompts for confirmation before submitting. - -### Submit a limit sell order - -```bash -longbridge order sell TSLA.US 5 --price 360.00 -``` - -Places a limit sell order for 5 shares of TSLA at $360.00. The command prompts for confirmation before submitting. - -### Short sell (no existing position) - -```bash -longbridge order sell META.US 1 --price 620.00 -``` - -Submitting a sell order for a symbol with no existing position opens a short. No special flags are required. To close the short, submit a buy order for the same symbol and quantity. - -**Market support:** - -**US stocks** can be shorted directly with no additional setup. - -**HK stocks** require activation: open the Longbridge mobile app, place your first HK short sell order — the app will trigger a Securities Borrowing and Lending (SBL) agreement signing flow. Complete the signing and wait for approval. Note: HK short selling is subject to a fee levied by the Hong Kong Inland Revenue Department; details are described in the in-app agreement. The API returns error `602301` before the HK SBL agreement is signed. - -**A-share (SH/SZ)** short selling is not supported — the CLI does not support Northbound (Stock Connect) trading. - -### View trade executions - -```bash -longbridge order executions -``` - -Lists all filled trade executions for the current day, including execution price, quantity, and time. - -### View order details - -```bash -# Fetch full detail for a specific order -longbridge order detail 701276261045858304 -``` - -Returns execution details, timestamps, and fill information for the order. - -### View attached child order (US accounts) - -```bash -longbridge order detail 701276261045858304 --attached -``` - -Fetches the order detail along with its attached child order (e.g. bracket or OCO orders). US accounts only. - -### Filter US orders by status and side - -```bash -# Pending orders only -longbridge order --status pending - -# Filled buy orders -longbridge order --status history --action buy -``` - -:::info US Accounts -For US data-center accounts, `order` routes to the US API automatically. Use `--status` and `--action` to filter US order history. These flags are ignored for non-US accounts. -::: - -### Cancel a pending order - -```bash -# Cancel prompts for confirmation before submitting -longbridge order cancel 701276261045858304 -``` - Only orders in cancellable states (New, PartialFilled, etc.) are accepted. Use `-y` to skip the confirmation prompt in scripts. ### Modify an open order @@ -133,7 +39,6 @@ longbridge order replace 701276261045858304 --qty 5 --price 350.00 | Option | Description | Default | | ------ | ----------- | ------- | -| `--status` | Filter orders: `pending` \| `history` \| `all` (US accounts) | all | | `--action` | Filter by side: `buy` \| `sell` (US accounts) | — | | `--attached` | Show attached child order in `order detail` (US accounts) | false | diff --git a/docs/zh-CN/docs/cli/orders/order.md b/docs/zh-CN/docs/cli/orders/order.md index 5f46aa38..6119891c 100644 --- a/docs/zh-CN/docs/cli/orders/order.md +++ b/docs/zh-CN/docs/cli/orders/order.md @@ -24,100 +24,6 @@ longbridge order ## 示例 -### 查看今日委托 - -```bash -longbridge order -``` - -列出今日所有委托及其状态、标的代码、数量、价格和委托 ID。 - -### 查询指定标的的历史委托 - -```bash -longbridge order --history --start 2026-01-01 --symbol TSLA.US -``` - -按标的和日期范围筛选历史委托。使用 `--start` 和 `--end` 设置日期窗口。 - -### 提交限价买入委托 - -```bash -longbridge order buy TSLA.US 10 --price 340.00 -``` - -以 340.00 美元的价格对 TSLA 提交 10 股限价买入委托。命令在提交前会提示确认。 - -### 提交限价卖出委托 - -```bash -longbridge order sell TSLA.US 5 --price 360.00 -``` - -以 360.00 美元的价格对 TSLA 提交 5 股限价卖出委托。命令在提交前会提示确认。 - -### 卖空（无持仓做空） - -```bash -longbridge order sell META.US 1 --price 620.00 -``` - -对没有持仓的标的提交卖出委托即可开空，无需任何额外参数。平仓时对相同标的和数量提交买入委托即可。 - -**市场支持情况：** - -**美股**无需额外开通，直接可以卖空。 - -**港股**卖空需要开通：在 Longbridge 手机客户端发起首笔港股卖空委托，下单过程中会触发「证券借贷协议（SBL）」签署流程，完成签署后等待审核通过即可。注意：港股卖空需缴纳由香港税务局征收的相关税费，具体以应用内协议说明为准。未签署协议时 API 返回错误 `602301`。 - -**A 股（SH/SZ）**暂不支持卖空，CLI 不支持北向通（沪深港通）交易。 - -### 查看成交记录 - -```bash -longbridge order executions -``` - -列出当日所有已成交的委托，包括成交价格、数量和时间。 - -### 查看委托详情 - -```bash -# 查询指定委托的完整详情 -longbridge order detail 701276261045858304 -``` - -返回该委托的成交明细、时间戳和成交信息。 - -### 查看关联子委托（美股账户） - -```bash -longbridge order detail 701276261045858304 --attached -``` - -同时获取关联的子委托（如括号单、OCO 委托）。仅限美股账户。 - -### 按状态和方向筛选委托（美股账户） - -```bash -# 仅查看待成交委托 -longbridge order --status pending - -# 查看历史买入委托 -longbridge order --status history --action buy -``` - -:::info 美股账户 -美国数据中心账户会自动路由至美股 API。`--status` 和 `--action` 仅对美股账户生效。 -::: - -### 撤销待成交委托 - -```bash -# 撤单前会提示确认 -longbridge order cancel 701276261045858304 -``` - 仅接受处于可撤状态的委托（New、PartialFilled 等）。在脚本中使用 `-y` 跳过确认提示。 ### 修改未成交委托 @@ -133,7 +39,6 @@ longbridge order replace 701276261045858304 --qty 5 --price 350.00 | 选项 | 描述 | 默认值 | | ---- | ---- | ------ | -| `--status` | 委托状态筛选：`pending` \| `history` \| `all`（美股账户） | all | | `--action` | 方向筛选：`buy` \| `sell`（美股账户） | — | | `--attached` | 在 `order detail` 中显示关联子委托（美股账户） | false | diff --git a/docs/zh-HK/docs/cli/orders/order.md b/docs/zh-HK/docs/cli/orders/order.md index 9ea34b1d..4d152ed3 100644 --- a/docs/zh-HK/docs/cli/orders/order.md +++ b/docs/zh-HK/docs/cli/orders/order.md @@ -24,97 +24,6 @@ longbridge order ## 示例 -### 查看今日委託 - -```bash -longbridge order -``` - -列出今日所有委託及其狀態、標的代碼、數量、價格和委託 ID。 - -### 查詢指定標的的歷史委託 - -```bash -longbridge order --history --start 2026-01-01 --symbol TSLA.US -``` - -按標的和日期範圍篩選歷史委託。使用 `--start` 和 `--end` 設定日期窗口。 - -### 提交限價買入委託 - -```bash -longbridge order buy TSLA.US 10 --price 340.00 -``` - -以 340.00 美元的價格對 TSLA 提交 10 股限價買入委託。命令在提交前會提示確認。 - -### 提交限價賣出委託 - -```bash -longbridge order sell TSLA.US 5 --price 360.00 -``` - -以 360.00 美元的價格對 TSLA 提交 5 股限價賣出委託。命令在提交前會提示確認。 - -### 賣空（無持倉做空） - -```bash -longbridge order sell META.US 1 --price 620.00 -``` - -對沒有持倉的標的提交賣出委託即可開空，無需任何額外參數。平倉時對相同標的和數量提交買入委託即可。 - -**市場支援情況：** - -**美股**無需額外開通，直接可以賣空。 - -**港股**賣空需要開通：在 Longbridge 手機客戶端發起首筆港股賣空委託，下單過程中會觸發「證券借貸協議（SBL）」簽署流程，完成簽署後等待審核通過即可。注意：港股賣空需繳納由香港稅務局徵收的相關稅費，具體以應用內協議說明為準。未簽署協議時 API 返回錯誤 `602301`。 - -**A 股（SH/SZ）**暫不支援賣空，CLI 不支援北向通（滬深港通）交易。 - -### 查看成交記錄 - -```bash -longbridge order executions -``` - -列出當日所有已成交的委託，包括成交價格、數量和時間。 - -### 查看委託詳情 - -```bash -# 查詢指定委託的完整詳情 -longbridge order detail 701276261045858304 -``` - -返回該委託的成交明細、時間戳和成交資訊。 - -### 查看關聯子委託（美股賬戶） - -```bash -longbridge order detail 701276261045858304 --attached -``` - -同時獲取關聯的子委託（如括號單、OCO 委託）。僅限美股賬戶。 - -### 按狀態和方向篩選委託（美股賬戶） - -```bash -longbridge order --status pending -longbridge order --status history --action buy -``` - -:::info 美股賬戶 -美國數據中心賬戶會自動路由至美股 API。`--status` 和 `--action` 僅對美股賬戶生效。 -::: - -### 撤銷待成交委託 - -```bash -# 撤單前會提示確認 -longbridge order cancel 701276261045858304 -``` - 僅接受處於可撤狀態的委託（New、PartialFilled 等）。在腳本中使用 `-y` 跳過確認提示。 ### 修改未成交委託 @@ -130,7 +39,6 @@ longbridge order replace 701276261045858304 --qty 5 --price 350.00 | 選項 | 描述 | 默認值 | | ---- | ---- | ------ | -| `--status` | 委託狀態篩選：`pending` \| `history` \| `all`（美股賬戶） | all | | `--action` | 方向篩選：`buy` \| `sell`（美股賬戶） | — | | `--attached` | 在 `order detail` 中顯示關聯子委託（美股賬戶） | false | From 9df13b36843aaac9bfef3272b72c7d8b3d19a813 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Thu, 9 Jul 2026 11:09:08 +0800 Subject: [PATCH 50/51] =?UTF-8?q?fix(docs):=20update=20macrodata=20indicat?= =?UTF-8?q?or=20code=2062267=20=E2=86=92=2061744=20(matches=20CLI=20v0.24.?= =?UTF-8?q?0=20release=20examples)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/en/docs/cli/fundamentals/macrodata.md | 12 ++++++------ .../fundamental/macroeconomic-indicators.md | 2 +- .../fundamental/fundamental/macroeconomic.md | 16 ++++++++-------- docs/zh-CN/docs/cli/fundamentals/macrodata.md | 12 ++++++------ .../fundamental/macroeconomic-indicators.md | 2 +- .../fundamental/fundamental/macroeconomic.md | 12 ++++++------ docs/zh-HK/docs/cli/fundamentals/macrodata.md | 10 +++++----- .../fundamental/macroeconomic-indicators.md | 2 +- .../fundamental/fundamental/macroeconomic.md | 12 ++++++------ 9 files changed, 40 insertions(+), 40 deletions(-) diff --git a/docs/en/docs/cli/fundamentals/macrodata.md b/docs/en/docs/cli/fundamentals/macrodata.md index c969f3d2..5363fbc0 100644 --- a/docs/en/docs/cli/fundamentals/macrodata.md +++ b/docs/en/docs/cli/fundamentals/macrodata.md @@ -26,7 +26,7 @@ longbridge macrodata ``` Total: 619 Code Name Category Country Frequency Source -62267 Non-Farm Payroll Employment US Monthly Bureau of Labor Statistics +61744 Non-Farm Payroll Employment US Monthly Bureau of Labor Statistics ... ``` @@ -56,7 +56,7 @@ longbridge macrodata --country US --limit 50 --page 2 ### Historical releases for a specific indicator ```bash -longbridge macrodata 62267 +longbridge macrodata 61744 ``` ``` @@ -71,7 +71,7 @@ Period Actual Forecast Previous Revised Unit ### Filter history by date range ```bash -longbridge macrodata 62267 --start 2024-01-01 --end 2024-12-31 +longbridge macrodata 61744 --start 2024-01-01 --end 2024-12-31 ``` ### JSON output for AI / scripting @@ -81,7 +81,7 @@ longbridge macrodata 62267 --start 2024-01-01 --end 2024-12-31 longbridge macrodata --format json # History as JSON -longbridge macrodata 62267 --format json +longbridge macrodata 61744 --format json ``` **List JSON structure:** @@ -94,7 +94,7 @@ longbridge macrodata 62267 --format json "has_more": true, "list": [ { - "indicator_code": "62267", + "indicator_code": "61744", "country": "US", "name": "Non-Farm Payroll", "periodicity": "Monthly", @@ -113,7 +113,7 @@ longbridge macrodata 62267 --format json "limit": 20, "has_more": true, "info": { - "indicator_code": "62267", + "indicator_code": "61744", "country": "US", "name": "Non-Farm Payroll", "periodicity": "Monthly", diff --git a/docs/en/docs/fundamental/fundamental/macroeconomic-indicators.md b/docs/en/docs/fundamental/fundamental/macroeconomic-indicators.md index 24c6eb80..3c239dc6 100644 --- a/docs/en/docs/fundamental/fundamental/macroeconomic-indicators.md +++ b/docs/en/docs/fundamental/fundamental/macroeconomic-indicators.md @@ -153,7 +153,7 @@ async fn main() -> Result<(), Box> { "count": 619, "list": [ { - "indicator_code": "62267", + "indicator_code": "61744", "country": "US", "name": "Non-Farm Payroll", "periodicity": "Monthly", diff --git a/docs/en/docs/fundamental/fundamental/macroeconomic.md b/docs/en/docs/fundamental/fundamental/macroeconomic.md index d66b63fd..1bbfa317 100644 --- a/docs/en/docs/fundamental/fundamental/macroeconomic.md +++ b/docs/en/docs/fundamental/fundamental/macroeconomic.md @@ -14,9 +14,9 @@ Get historical releases for a specific macroeconomic indicator — actual values # Historical data for Non-Farm Payroll -longbridge macrodata 62267 +longbridge macrodata 61744 # Date range filter -longbridge macrodata 62267 --start 2024-01-01 --end 2024-12-31 +longbridge macrodata 61744 --start 2024-01-01 --end 2024-12-31 @@ -45,7 +45,7 @@ oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url)) config = Config.from_oauth(oauth) ctx = FundamentalContext(config) -resp = ctx.macroeconomic("62267", start_date="2024-01-01", end_date="2024-12-31") +resp = ctx.macroeconomic("61744", start_date="2024-01-01", end_date="2024-12-31") print(resp) ``` @@ -60,7 +60,7 @@ async def main() -> None: oauth = await OAuthBuilder("your-client-id").build_async(lambda url: print("Visit:", url)) config = Config.from_oauth(oauth) ctx = AsyncFundamentalContext.create(config) - resp = await ctx.macroeconomic("62267", start_date="2024-01-01", end_date="2024-12-31") + resp = await ctx.macroeconomic("61744", start_date="2024-01-01", end_date="2024-12-31") print(resp) if __name__ == "__main__": @@ -79,7 +79,7 @@ async function main() { }) const config = Config.fromOAuth(oauth) const ctx = FundamentalContext.new(config) - const resp = await ctx.macroeconomic('62267', { startDate: '2024-01-01', endDate: '2024-12-31' }) + const resp = await ctx.macroeconomic('61744', { startDate: '2024-01-01', endDate: '2024-12-31' }) console.log(resp) } main().catch(console.error) @@ -97,7 +97,7 @@ class Main { try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get(); Config config = Config.fromOAuth(oauth); FundamentalContext ctx = FundamentalContext.create(config)) { - var resp = ctx.getMacroeconomic("62267", "2024-01-01", "2024-12-31", null, null).get(); + var resp = ctx.getMacroeconomic("61744", "2024-01-01", "2024-12-31", null, null).get(); System.out.println(resp); } } @@ -116,7 +116,7 @@ async fn main() -> Result<(), Box> { let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("Open: {url}")).await?; let config = Arc::new(Config::from_oauth(oauth)); let ctx = FundamentalContext::new(config); - let resp = ctx.macroeconomic("62267", Some("2024-01-01"), Some("2024-12-31"), None, None).await?; + let resp = ctx.macroeconomic("61744", Some("2024-01-01"), Some("2024-12-31"), None, None).await?; println!("{:?}", resp); Ok(()) } @@ -133,7 +133,7 @@ async fn main() -> Result<(), Box> { { "count": 24, "info": { - "indicator_code": "62267", + "indicator_code": "61744", "country": "US", "name": "Non-Farm Payroll", "periodicity": "Monthly", diff --git a/docs/zh-CN/docs/cli/fundamentals/macrodata.md b/docs/zh-CN/docs/cli/fundamentals/macrodata.md index 1abb61d1..f6a99be8 100644 --- a/docs/zh-CN/docs/cli/fundamentals/macrodata.md +++ b/docs/zh-CN/docs/cli/fundamentals/macrodata.md @@ -26,7 +26,7 @@ longbridge macrodata ``` Total: 619 Code Name Category Country Frequency Source -62267 非农就业人数 Employment US Monthly Bureau of Labor Statistics +61744 非农就业人数 Employment US Monthly Bureau of Labor Statistics ... ``` @@ -56,7 +56,7 @@ longbridge macrodata --country US --limit 50 --page 2 ### 查看某个指标的历史发布数据 ```bash -longbridge macrodata 62267 +longbridge macrodata 61744 ``` ``` @@ -71,14 +71,14 @@ Period Actual Forecast Previous Revised Unit ### 按日期范围筛选历史数据 ```bash -longbridge macrodata 62267 --start 2024-01-01 --end 2024-12-31 +longbridge macrodata 61744 --start 2024-01-01 --end 2024-12-31 ``` ### JSON 输出（适合 AI / 脚本） ```bash longbridge macrodata --format json -longbridge macrodata 62267 --format json +longbridge macrodata 61744 --format json ``` **列表 JSON 结构：** @@ -91,7 +91,7 @@ longbridge macrodata 62267 --format json "has_more": true, "list": [ { - "indicator_code": "62267", + "indicator_code": "61744", "country": "US", "name": "Non-Farm Payroll", "periodicity": "Monthly", @@ -110,7 +110,7 @@ longbridge macrodata 62267 --format json "limit": 20, "has_more": true, "info": { - "indicator_code": "62267", + "indicator_code": "61744", "country": "US", "name": "Non-Farm Payroll", "periodicity": "Monthly", diff --git a/docs/zh-CN/docs/fundamental/fundamental/macroeconomic-indicators.md b/docs/zh-CN/docs/fundamental/fundamental/macroeconomic-indicators.md index 7116e5fe..3fe0edc0 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/macroeconomic-indicators.md +++ b/docs/zh-CN/docs/fundamental/fundamental/macroeconomic-indicators.md @@ -107,7 +107,7 @@ async fn main() -> Result<(), Box> { "count": 619, "list": [ { - "indicator_code": "62267", + "indicator_code": "61744", "country": "US", "name": "Non-Farm Payroll", "periodicity": "Monthly", diff --git a/docs/zh-CN/docs/fundamental/fundamental/macroeconomic.md b/docs/zh-CN/docs/fundamental/fundamental/macroeconomic.md index 7280a5a6..0820ccb4 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/macroeconomic.md +++ b/docs/zh-CN/docs/fundamental/fundamental/macroeconomic.md @@ -14,9 +14,9 @@ headingLevel: 2 # 查询非农就业人数历史数据 -longbridge macrodata 62267 +longbridge macrodata 61744 # 指定日期范围 -longbridge macrodata 62267 --start 2024-01-01 --end 2024-12-31 +longbridge macrodata 61744 --start 2024-01-01 --end 2024-12-31 @@ -45,7 +45,7 @@ oauth = OAuthBuilder("your-client-id").build(lambda url: print("请访问：", u config = Config.from_oauth(oauth) ctx = FundamentalContext(config) -resp = ctx.macroeconomic("62267", start_date="2024-01-01", end_date="2024-12-31") +resp = ctx.macroeconomic("61744", start_date="2024-01-01", end_date="2024-12-31") print(resp) ``` @@ -61,7 +61,7 @@ async function main() { }) const config = Config.fromOAuth(oauth) const ctx = FundamentalContext.new(config) - const resp = await ctx.macroeconomic('62267', { startDate: '2024-01-01', endDate: '2024-12-31' }) + const resp = await ctx.macroeconomic('61744', { startDate: '2024-01-01', endDate: '2024-12-31' }) console.log(resp) } main().catch(console.error) @@ -79,7 +79,7 @@ async fn main() -> Result<(), Box> { let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("请访问：{url}")).await?; let config = Arc::new(Config::from_oauth(oauth)); let ctx = FundamentalContext::new(config); - let resp = ctx.macroeconomic("62267", Some("2024-01-01"), Some("2024-12-31"), None, None).await?; + let resp = ctx.macroeconomic("61744", Some("2024-01-01"), Some("2024-12-31"), None, None).await?; println!("{:?}", resp); Ok(()) } @@ -96,7 +96,7 @@ async fn main() -> Result<(), Box> { { "count": 24, "info": { - "indicator_code": "62267", + "indicator_code": "61744", "country": "US", "name": "Non-Farm Payroll", "periodicity": "Monthly", diff --git a/docs/zh-HK/docs/cli/fundamentals/macrodata.md b/docs/zh-HK/docs/cli/fundamentals/macrodata.md index 2545874c..9ee8b9a7 100644 --- a/docs/zh-HK/docs/cli/fundamentals/macrodata.md +++ b/docs/zh-HK/docs/cli/fundamentals/macrodata.md @@ -42,15 +42,15 @@ longbridge macrodata --keyword CPI --country US ### 查看某個指標的歷史發布數據 ```bash -longbridge macrodata 62267 -longbridge macrodata 62267 --start 2024-01-01 --end 2024-12-31 +longbridge macrodata 61744 +longbridge macrodata 61744 --start 2024-01-01 --end 2024-12-31 ``` ### JSON 輸出（適合 AI / 腳本） ```bash longbridge macrodata --format json -longbridge macrodata 62267 --format json +longbridge macrodata 61744 --format json ``` **列表 JSON 結構：** @@ -63,7 +63,7 @@ longbridge macrodata 62267 --format json "has_more": true, "list": [ { - "indicator_code": "62267", + "indicator_code": "61744", "country": "US", "name": "Non-Farm Payroll", "periodicity": "Monthly", @@ -82,7 +82,7 @@ longbridge macrodata 62267 --format json "limit": 20, "has_more": true, "info": { - "indicator_code": "62267", + "indicator_code": "61744", "country": "US", "name": "Non-Farm Payroll", "periodicity": "Monthly", diff --git a/docs/zh-HK/docs/fundamental/fundamental/macroeconomic-indicators.md b/docs/zh-HK/docs/fundamental/fundamental/macroeconomic-indicators.md index 4d3726a7..9a486448 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/macroeconomic-indicators.md +++ b/docs/zh-HK/docs/fundamental/fundamental/macroeconomic-indicators.md @@ -107,7 +107,7 @@ async fn main() -> Result<(), Box> { "count": 619, "list": [ { - "indicator_code": "62267", + "indicator_code": "61744", "country": "US", "name": "Non-Farm Payroll", "periodicity": "Monthly", diff --git a/docs/zh-HK/docs/fundamental/fundamental/macroeconomic.md b/docs/zh-HK/docs/fundamental/fundamental/macroeconomic.md index 43a08a25..6aeaa1c5 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/macroeconomic.md +++ b/docs/zh-HK/docs/fundamental/fundamental/macroeconomic.md @@ -14,9 +14,9 @@ headingLevel: 2 # 查詢非農就業人數歷史數據 -longbridge macrodata 62267 +longbridge macrodata 61744 # 指定日期範圍 -longbridge macrodata 62267 --start 2024-01-01 --end 2024-12-31 +longbridge macrodata 61744 --start 2024-01-01 --end 2024-12-31 @@ -45,7 +45,7 @@ oauth = OAuthBuilder("your-client-id").build(lambda url: print("請訪問：", u config = Config.from_oauth(oauth) ctx = FundamentalContext(config) -resp = ctx.macroeconomic("62267", start_date="2024-01-01", end_date="2024-12-31") +resp = ctx.macroeconomic("61744", start_date="2024-01-01", end_date="2024-12-31") print(resp) ``` @@ -61,7 +61,7 @@ async function main() { }) const config = Config.fromOAuth(oauth) const ctx = FundamentalContext.new(config) - const resp = await ctx.macroeconomic('62267', { startDate: '2024-01-01', endDate: '2024-12-31' }) + const resp = await ctx.macroeconomic('61744', { startDate: '2024-01-01', endDate: '2024-12-31' }) console.log(resp) } main().catch(console.error) @@ -79,7 +79,7 @@ async fn main() -> Result<(), Box> { let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("請訪問：{url}")).await?; let config = Arc::new(Config::from_oauth(oauth)); let ctx = FundamentalContext::new(config); - let resp = ctx.macroeconomic("62267", Some("2024-01-01"), Some("2024-12-31"), None, None).await?; + let resp = ctx.macroeconomic("61744", Some("2024-01-01"), Some("2024-12-31"), None, None).await?; println!("{:?}", resp); Ok(()) } @@ -94,7 +94,7 @@ async fn main() -> Result<(), Box> { { "count": 24, "info": { - "indicator_code": "62267", + "indicator_code": "61744", "country": "US", "name": "Non-Farm Payroll", "periodicity": "Monthly", From 82388fc2a9ee28d6cf33d9b1f90608a1fe1bc04c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E7=AB=A0=E6=B4=AA?= Date: Thu, 9 Jul 2026 11:40:26 +0800 Subject: [PATCH 51/51] fix(docs): correct Response/Schema for 7 US SDK docs based on PR #555 actual types - us_company_overview: USRankTag[] type + share_list field - us_valuation_overview: metrics map + ccy_symbol + aichat_data structure - us_financial_statement: new list/emptyFields structure - us_etf_dividend_info: dividend_frequency + USFiscalYearDividend fields - us_company_dividends: USRecentDividend + USDividendHistoryItem + USDividendPayoutRecord - us_etf_files: USETFFile with file_name/file_path/update_date/code/format - us_order_detail: USOrderDetailResponse correct fields, USOrderDetail full structure - us_asset_overview: overnight_buy_power + USCashEntry/USStockEntry/USCryptoEntry correct fields --- .../fundamental/us_company_dividends.md | 49 +++++++++++-- .../fundamental/us_company_overview.md | 25 ++++++- .../fundamental/us_etf_dividend_info.md | 20 +++-- .../fundamental/fundamental/us_etf_files.md | 20 ++++- .../fundamental/us_financial_statement.md | 71 +++++++++++++----- .../fundamental/us_valuation_overview.md | 41 +++++++++-- docs/en/docs/trade/asset/us_asset_overview.md | 45 ++++++++---- docs/en/docs/trade/order/us_order_detail.md | 54 +++++++------- .../fundamental/us_company_dividends.md | 49 +++++++++++-- .../fundamental/us_company_overview.md | 25 ++++++- .../fundamental/us_etf_dividend_info.md | 20 +++-- .../fundamental/fundamental/us_etf_files.md | 20 ++++- .../fundamental/us_financial_statement.md | 71 +++++++++++++----- .../fundamental/us_valuation_overview.md | 33 +++++++-- .../docs/trade/asset/us_asset_overview.md | 45 ++++++++---- .../zh-CN/docs/trade/order/us_order_detail.md | 54 +++++++------- .../fundamental/us_company_dividends.md | 49 +++++++++++-- .../fundamental/us_company_overview.md | 27 ++++++- .../fundamental/us_etf_dividend_info.md | 20 +++-- .../fundamental/fundamental/us_etf_files.md | 20 ++++- .../fundamental/us_financial_statement.md | 73 ++++++++++++++----- .../fundamental/us_valuation_overview.md | 35 +++++++-- .../docs/trade/asset/us_asset_overview.md | 45 ++++++++---- .../zh-HK/docs/trade/order/us_order_detail.md | 54 +++++++------- 24 files changed, 713 insertions(+), 252 deletions(-) diff --git a/docs/en/docs/fundamental/fundamental/us_company_dividends.md b/docs/en/docs/fundamental/fundamental/us_company_dividends.md index 9e77c7e3..a3e07fdc 100644 --- a/docs/en/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/en/docs/fundamental/fundamental/us_company_dividends.md @@ -187,6 +187,7 @@ func main() { | 200 | Success | [UsCompanyDividends](#UsCompanyDividends) | | 400 | Bad request | None | + ## Schemas ### UsCompanyDividends @@ -195,9 +196,45 @@ func main() { | Name | Type | Required | Description | | ---- | ---- | -------- | ----------- | -| dividend_ttm | string | true | TTM dividend per share | -| dividend_yield_ttm | string | true | TTM dividend yield (%) | -| payouts | string | true | Number of payouts in past year | -| currency | string | true | Currency code (e.g. `USD`) | -| items | USDividendItem[] | false | Individual dividend records | -| ∟ dividend | string | true | Dividend amount per share | +| recent_dividends | USRecentDividend | true | Recent dividend summary | +| dividend_history | USDividendHistoryItem[] | false | Annual dividend history | +| payout_ratios | USDividendHistoryItem[] | false | Payout ratio history | +| dividend_payout_history | USDividendPayoutRecord[] | false | Individual payout records | + +### USRecentDividend + + + +| Name | Type | Description | +| ---- | ---- | ----------- | +| dividend_ttm | string | TTM dividend per share | +| dividend_yield_ttm | string | TTM dividend yield (%) | +| payouts | string | Number of payouts in past year | +| currency | string | Currency code | + +### USDividendHistoryItem + + + +| Name | Type | Description | +| ---- | ---- | ----------- | +| fiscal_year | string | Fiscal year | +| fiscal_year_range | string | Fiscal year date range | +| dividend | string | Total dividend | +| dividend_yield | string | Dividend yield | +| dividend_growth_rate | string | Year-over-year dividend growth rate | +| dividend_payout_ratio | string | Dividend payout ratio | +| total_shareholder_yield | string | Total shareholder yield | + +### USDividendPayoutRecord + + + +| Name | Type | Description | +| ---- | ---- | ----------- | +| dividend | string | Dividend amount per share | +| dividend_type | string | Dividend type (e.g. `Cash`) | +| currency | string | Currency code | +| ex_date | string | Ex-dividend date | +| payment_date | string | Payment date | +| record_date | string | Record date | diff --git a/docs/en/docs/fundamental/fundamental/us_company_overview.md b/docs/en/docs/fundamental/fundamental/us_company_overview.md index be6ae11d..69f59c87 100644 --- a/docs/en/docs/fundamental/fundamental/us_company_overview.md +++ b/docs/en/docs/fundamental/fundamental/us_company_overview.md @@ -183,6 +183,7 @@ func main() { | 200 | Success | [UsCompanyOverview](#UsCompanyOverview) | | 400 | Bad request | None | + ## Schemas ### UsCompanyOverview @@ -194,5 +195,27 @@ func main() { | intro | string | true | Company introduction | | market_cap | string | true | Market capitalization | | ccy_symbol | string | true | Currency symbol | -| top_rank_tags | string[] | false | Ranking tag labels | +| top_rank_tags | USRankTag[] | false | Ranking tag labels | | detail_url | string | false | Link to full company detail page | +| share_list | USSharelistItem[] | false | Related sharelist items | + +### USRankTag + + + +| Name | Type | Description | +| ---- | ---- | ----------- | +| key | string | Tag key identifier | +| title | string | Tag title | +| text | string | Tag display text | +| rank_type | int | Ranking type | + +### USSharelistItem + + + +| Name | Type | Description | +| ---- | ---- | ----------- | +| id | string | Sharelist ID | +| name | string | Sharelist name | +| chg | string | Change value | diff --git a/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md index b388370c..173bde2c 100644 --- a/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/en/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -192,6 +192,7 @@ func main() { | 200 | Success | [UsETFDividendInfo](#UsETFDividendInfo) | | 400 | Bad request | None | + ## Schemas ### UsETFDividendInfo @@ -202,9 +203,18 @@ func main() { | ---- | ---- | -------- | ----------- | | dividend_ttm | string | true | TTM dividend per share | | dividend_yield_ttm | string | true | TTM dividend yield (%) | -| dividend_freq | string | true | Payout frequency (e.g. `Quarterly`) | +| dividend_frequency | string | true | Payout frequency (e.g. `Quarterly`) | | currency | string | true | Currency code (e.g. `USD`) | -| fiscal_year_info | FiscalYearDividend[] | false | Annual dividend breakdown | -| ∟ year | string | true | Fiscal year | -| ∟ total_dividend | string | true | Total annual dividend | -| ∟ records | object[] | false | Individual payment records | +| fiscal_year_info | USFiscalYearDividend[] | false | Annual dividend breakdown by fiscal year | + +### USFiscalYearDividend + + + +| Name | Type | Description | +| ---- | ---- | ----------- | +| fiscal_year | string | Fiscal year | +| fiscal_year_range | string | Fiscal year date range | +| dividend | string | Total dividend for the year | +| dividend_yield | string | Dividend yield for the year | +| currency | string | Currency code | diff --git a/docs/en/docs/fundamental/fundamental/us_etf_files.md b/docs/en/docs/fundamental/fundamental/us_etf_files.md index 5a8c9a80..b8bcd38c 100644 --- a/docs/en/docs/fundamental/fundamental/us_etf_files.md +++ b/docs/en/docs/fundamental/fundamental/us_etf_files.md @@ -183,13 +183,25 @@ func main() { | 200 | Success | [UsETFFileList](#UsETFFileList) | | 400 | Bad request | None | + ## Schemas -### UsETFFileList +### UsETFFilesResponse - + | Name | Type | Required | Description | | ---- | ---- | -------- | ----------- | -| files | ETFFile[] | true | List of ETF regulatory documents | -| ∟ name | string | true | Document name | +| files | USETFFile[] | true | List of ETF regulatory documents | + +### USETFFile + + + +| Name | Type | Description | +| ---- | ---- | ----------- | +| file_name | string | Document file name | +| file_path | string | Document file path or URL | +| update_date | string | Last update date | +| code | string | Document code | +| format | string | File format (e.g. `pdf`) | diff --git a/docs/en/docs/fundamental/fundamental/us_financial_statement.md b/docs/en/docs/fundamental/fundamental/us_financial_statement.md index 6e5312cd..4b1cd063 100644 --- a/docs/en/docs/fundamental/fundamental/us_financial_statement.md +++ b/docs/en/docs/fundamental/fundamental/us_financial_statement.md @@ -166,25 +166,37 @@ func main() { + ## Response ### Response Example ```json { - "revenue": "124300000000", - "net_income": "30520000000", - "net_margin": "0.2454", - "periods": [ + "currency": "USD", + "report": "annual", + "empty_fields": [], + "list": [ { - "date": "2026-03-31", - "values": { - "total_assets": "364840000000", - "total_liabilities": "291040000000" - } + "ff_period": "A", + "ff_year": 2024, + "fp_end": "2024-09-28", + "report_txt": "FY2024", + "rpt_date": "2024-11-01", + "fields": [ + { + "id": "revenue", + "name": "Total Revenue", + "value": "391035000000", + "yoy": "0.0198", + "level": 1, + "display_order": 1, + "field": "revenue", + "value_type": "amount" + } + ] } - ], - "currency": "USD" + ] } ``` @@ -203,10 +215,35 @@ func main() { | Name | Type | Required | Description | | ---- | ---- | -------- | ----------- | -| revenue | string | true | Total revenue | -| net_income | string | true | Net income | -| net_margin | string | true | Net profit margin | -| periods | FinancialPeriod[] | true | Reporting periods with line-item values | -| ∟ date | string | true | Period date | -| ∟ values | map[string]any | true | Financial line items keyed by metric name | | currency | string | true | Currency code (e.g. `USD`) | +| report | string | true | Report period type (e.g. `annual`, `quarterly`) | +| empty_fields | string[] | false | Fields with no data for this period | +| list | USFinancialStatementPeriod[] | true | Statement data by period | + +### USFinancialStatementPeriod + + + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| ff_period | string | true | Period type code (e.g. `A`=annual, `Q`=quarterly) | +| ff_year | int | true | Fiscal year | +| fp_end | string | true | Period end date (YYYY-MM-DD) | +| report_txt | string | true | Period label (e.g. `FY2024`) | +| rpt_date | string | true | Report release date (YYYY-MM-DD) | +| fields | USFinancialStatementField[] | true | Financial line items | + +### USFinancialStatementField + + + +| Name | Type | Required | Description | +| ---- | ---- | -------- | ----------- | +| id | string | true | Field identifier | +| name | string | true | Field display name | +| value | string | true | Field value | +| yoy | string | false | Year-over-year change rate | +| level | int | true | Hierarchy level (1=top level) | +| display_order | int | true | Display order | +| field | string | true | Field key name | +| value_type | string | true | Value type (e.g. `amount`, `ratio`) | diff --git a/docs/en/docs/fundamental/fundamental/us_valuation_overview.md b/docs/en/docs/fundamental/fundamental/us_valuation_overview.md index 7855e8b0..ca21634e 100644 --- a/docs/en/docs/fundamental/fundamental/us_valuation_overview.md +++ b/docs/en/docs/fundamental/fundamental/us_valuation_overview.md @@ -162,6 +162,7 @@ func main() { + ## Response ### Response Example @@ -169,12 +170,27 @@ func main() { ```json { "indicator": "PE", - "current_indicator": { - "circle": "35.2" + "metrics": { + "pe": { + "circle": "35.2", + "part": "72", + "metric": "PE", + "desc": "Price-to-Earnings ratio", + "industry_median": "28.4" + } }, "range": 72, "date": "2026-07-01", - "ai_summary": "Apple's PE ratio of 35.2 is in the 72nd percentile..." + "ccy_symbol": "USD", + "ai_summary": "Apple's PE ratio is in the 72nd percentile...", + "aichat_data": { + "agent_id": "valuation_aapl", + "handoff_agent_id": "", + "symbol": "AAPL.US", + "text": "Valuation overview for AAPL", + "chat_type": "valuation", + "workflow_type": "valuation" + } } ``` @@ -193,9 +209,22 @@ func main() { | Name | Type | Required | Description | | ---- | ---- | -------- | ----------- | -| indicator | string | true | Valuation indicator name (e.g. `PE`, `PB`) | -| current_indicator | object | true | Current valuation data | -| ∟ circle | string | true | Current indicator value | +| indicator | string | true | Primary valuation indicator name (e.g. `PE`) | +| metrics | map[string, USValuationMetric] | true | Valuation metrics keyed by indicator name | | range | int | true | Historical percentile (0–100) | | date | string | true | Valuation date | +| ccy_symbol | string | true | Currency symbol | | ai_summary | string | false | AI-generated valuation summary | +| aichat_data | USAIChatData | false | AI chat context data | + +### USValuationMetric + + + +| Name | Type | Description | +| ---- | ---- | ----------- | +| circle | string | Current indicator value | +| part | string | Percentile position | +| metric | string | Metric name | +| desc | string | Metric description | +| industry_median | string | Industry median value | diff --git a/docs/en/docs/trade/asset/us_asset_overview.md b/docs/en/docs/trade/asset/us_asset_overview.md index 82149197..7673a06d 100644 --- a/docs/en/docs/trade/asset/us_asset_overview.md +++ b/docs/en/docs/trade/asset/us_asset_overview.md @@ -186,6 +186,7 @@ func main() { | 200 | Success | [USAssetOverview](#USAssetOverview) | | 400 | Bad request | None | + ## Schemas ### USAssetOverview @@ -196,7 +197,9 @@ func main() { | ---- | ---- | -------- | ----------- | | account_type | string | true | Account type identifier | | asset_timestamp | int64 | true | Snapshot time (Unix seconds) | -| cash_buy_power | string | true | Available buying power | +| cash_buy_power | string | true | Available buying power (cash) | +| overnight_buy_power | string | true | Overnight buying power | +| currency | string | true | Base currency | | cash_list | USCashEntry[] | false | Cash balances by currency | | stock_list | USStockEntry[] | false | Stock positions | | crypto_list | USCryptoEntry[] | false | Crypto positions | @@ -205,28 +208,38 @@ func main() { -| Name | Type | Required | Description | -| ---- | ---- | -------- | ----------- | -| currency | string | true | Currency code (e.g. `USD`) | -| amount | string | true | Cash amount | +| Name | Type | Description | +| ---- | ---- | ----------- | +| currency | string | Currency code | +| total_cash | string | Total cash | +| settled_cash | string | Settled cash | +| total_amount | string | Total amount including unsettled | +| outstanding | string | Outstanding (unsettled) amount | +| frozen_buy_cash | string | Frozen amount for pending buys | ### USStockEntry -| Name | Type | Required | Description | -| ---- | ---- | -------- | ----------- | -| symbol | string | true | Stock symbol (e.g. `AAPL.US`) | -| quantity | string | true | Quantity held | -| cost_price | string | false | Average cost price | -| current_price | string | false | Current market price | -| market_value | string | false | Current market value | +| Name | Type | Description | +| ---- | ---- | ----------- | +| symbol | string | Trading symbol (e.g. `AAPL.US`) | +| quantity | string | Quantity held | +| currency | string | Currency code | +| average_cost | string | Average cost price | +| last_done | string | Current market price | +| prev_close | string | Previous close price | +| asset_type | string | Asset type | +| trade_status | string | Trading status | ### USCryptoEntry -| Name | Type | Required | Description | -| ---- | ---- | -------- | ----------- | -| symbol | string | true | Crypto trading-pair symbol | -| quantity | string | true | Quantity held | +| Name | Type | Description | +| ---- | ---- | ----------- | +| symbol | string | Crypto trading-pair symbol (e.g. `BTCUSD.BKKT`) | +| average_cost | string | Average cost price | +| currency | string | Quote currency | +| asset_type | string | Asset type | +| industry_name | string | Industry/category name | diff --git a/docs/en/docs/trade/order/us_order_detail.md b/docs/en/docs/trade/order/us_order_detail.md index 6db5ff66..059dacbb 100644 --- a/docs/en/docs/trade/order/us_order_detail.md +++ b/docs/en/docs/trade/order/us_order_detail.md @@ -195,6 +195,7 @@ func main() { | 200 | Success | [USOrderDetailResponse](#USOrderDetailResponse) | | 400 | Bad request | None | + ## Schemas ### USOrderDetailResponse @@ -203,31 +204,28 @@ func main() { | Name | Type | Required | Description | | ---- | ---- | -------- | ----------- | -| order | USOrder | true | Full order detail | -| order_histories | USOrderHistory[] | true | Historical status changes | -| current_attached_order | USOrder \| null | false | Attached child order (bracket/OCO), null if none | - -### USOrder - - - -| Name | Type | Required | Description | -| ---- | ---- | -------- | ----------- | -| order_id | string | true | Unique order ID | -| symbol | string | true | Trading symbol (e.g. `AAPL.US`) | -| side | string | true | `Buy` or `Sell` | -| status | string | true | Order status | -| qty | string | true | Order quantity | -| price | string | true | Order price | -| executed_qty | string | true | Executed quantity | -| executed_price | string | true | Average executed price | -| created_at | int64 | true | Creation time (Unix seconds) | - -### USOrderHistory - - - -| Name | Type | Required | Description | -| ---- | ---- | -------- | ----------- | -| status | string | true | Order status at this point | -| done_at | int64 | true | Timestamp (Unix seconds) | +| order | USOrderDetail \| null | true | Full order detail, null if not found | +| current_attached_order | USOrderDetail \| null | false | Attached child order (bracket/OCO), null if none | +| current_millisecond | string | false | Server timestamp (milliseconds) | + +### USOrderDetail + + + +| Name | Type | Description | +| ---- | ---- | ----------- | +| id | string | Order ID | +| symbol | string | Trading symbol (e.g. `AAPL.US`) | +| action | int | Order action: 1=Buy, 2=Sell | +| order_type | string | Order type | +| status | string | Order status | +| price | string | Order price | +| quantity | string | Order quantity | +| executed_qty | string | Executed quantity | +| executed_price | string | Average executed price | +| executed_amount | string | Total executed amount | +| currency | string | Currency code | +| submitted_at | string | Submission time | +| done_at | string | Completion time | +| time_in_force | int | Time-in-force type | +| msg | string | Status message | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md b/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md index 9953f271..d16596e2 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_company_dividends.md @@ -188,6 +188,7 @@ func main() { | 200 | 成功 | [UsCompanyDividends](#UsCompanyDividends) | | 400 | 请求错误 | None | + ## Schemas ### UsCompanyDividends @@ -196,9 +197,45 @@ func main() { | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| dividend_ttm | string | 是 | 过去 12 个月每股股息 | -| dividend_yield_ttm | string | 是 | TTM 股息率（%） | -| payouts | string | 是 | 过去一年派息次数 | -| currency | string | 是 | 货币代码，如 `USD` | -| items | USDividendItem[] | 否 | 逐笔分红记录 | -| ∟ dividend | string | 是 | 每股分红金额 | +| recent_dividends | USRecentDividend | 是 | 近期分红摘要 | +| dividend_history | USDividendHistoryItem[] | 否 | 历年分红历史 | +| payout_ratios | USDividendHistoryItem[] | 否 | 派息率历史 | +| dividend_payout_history | USDividendPayoutRecord[] | 否 | 逐笔分红派发记录 | + +### USRecentDividend + + + +| 名称 | 类型 | 描述 | +| ---- | ---- | ---- | +| dividend_ttm | string | 过去 12 个月每股股息 | +| dividend_yield_ttm | string | TTM 股息率（%） | +| payouts | string | 过去一年派息次数 | +| currency | string | 货币代码 | + +### USDividendHistoryItem + + + +| 名称 | 类型 | 描述 | +| ---- | ---- | ---- | +| fiscal_year | string | 财年 | +| fiscal_year_range | string | 财年日期范围 | +| dividend | string | 年度总股息 | +| dividend_yield | string | 年度股息率 | +| dividend_growth_rate | string | 股息同比增长率 | +| dividend_payout_ratio | string | 派息率 | +| total_shareholder_yield | string | 股东总回报率 | + +### USDividendPayoutRecord + + + +| 名称 | 类型 | 描述 | +| ---- | ---- | ---- | +| dividend | string | 每股分红金额 | +| dividend_type | string | 分红类型（如 `Cash`） | +| currency | string | 货币代码 | +| ex_date | string | 除权日 | +| payment_date | string | 派息日 | +| record_date | string | 登记日 | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md index c96f3b57..fa6a0209 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_company_overview.md @@ -184,6 +184,7 @@ func main() { | 200 | 成功 | [UsCompanyOverview](#UsCompanyOverview) | | 400 | 请求错误 | None | + ## Schemas ### UsCompanyOverview @@ -195,5 +196,27 @@ func main() { | intro | string | 是 | 公司简介 | | market_cap | string | 是 | 市值 | | ccy_symbol | string | 是 | 货币符号 | -| top_rank_tags | string[] | 否 | 排名标签列表 | +| top_rank_tags | USRankTag[] | 否 | 排名标签列表 | | detail_url | string | 否 | 公司详情页链接 | +| share_list | USSharelistItem[] | 否 | 相关自选列表 | + +### USRankTag + + + +| 名称 | 类型 | 描述 | +| ---- | ---- | ---- | +| key | string | 标签标识 | +| title | string | 标签标题 | +| text | string | 标签显示文本 | +| rank_type | int | 排名类型 | + +### USSharelistItem + + + +| 名称 | 类型 | 描述 | +| ---- | ---- | ---- | +| id | string | 自选列表 ID | +| name | string | 自选列表名称 | +| chg | string | 变动值 | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md index 4748d8d3..07623083 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -193,6 +193,7 @@ func main() { | 200 | 成功 | [UsETFDividendInfo](#UsETFDividendInfo) | | 400 | 请求错误 | None | + ## Schemas ### UsETFDividendInfo @@ -203,9 +204,18 @@ func main() { | ---- | ---- | ---- | ---- | | dividend_ttm | string | 是 | 过去 12 个月每股股息 | | dividend_yield_ttm | string | 是 | TTM 股息率（%） | -| dividend_freq | string | 是 | 派息频率（如 `Quarterly`） | +| dividend_frequency | string | 是 | 派息频率（如 `Quarterly`） | | currency | string | 是 | 货币代码，如 `USD` | -| fiscal_year_info | FiscalYearDividend[] | 否 | 按财年分列的年度分红明细 | -| ∟ year | string | 是 | 财年 | -| ∟ total_dividend | string | 是 | 年度总股息 | -| ∟ records | object[] | 否 | 逐笔支付记录 | +| fiscal_year_info | USFiscalYearDividend[] | 否 | 按财年分列的年度分红明细 | + +### USFiscalYearDividend + + + +| 名称 | 类型 | 描述 | +| ---- | ---- | ---- | +| fiscal_year | string | 财年 | +| fiscal_year_range | string | 财年日期范围 | +| dividend | string | 年度总股息 | +| dividend_yield | string | 年度股息率 | +| currency | string | 货币代码 | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md b/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md index 1e783296..835d11ef 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_etf_files.md @@ -184,13 +184,25 @@ func main() { | 200 | 成功 | [UsETFFileList](#UsETFFileList) | | 400 | 请求错误 | None | + ## Schemas -### UsETFFileList +### UsETFFilesResponse - + | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| files | ETFFile[] | 是 | ETF 监管文件列表 | -| ∟ name | string | 是 | 文件名称 | +| files | USETFFile[] | 是 | ETF 监管文件列表 | + +### USETFFile + + + +| 名称 | 类型 | 描述 | +| ---- | ---- | ---- | +| file_name | string | 文件名称 | +| file_path | string | 文件路径或 URL | +| update_date | string | 最后更新日期 | +| code | string | 文件代码 | +| format | string | 文件格式（如 `pdf`） | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement.md b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement.md index af7e8afe..5972cab0 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_financial_statement.md @@ -167,25 +167,37 @@ func main() { + ## Response ### Response Example ```json { - "revenue": "124300000000", - "net_income": "30520000000", - "net_margin": "0.2454", - "periods": [ + "currency": "USD", + "report": "annual", + "empty_fields": [], + "list": [ { - "date": "2026-03-31", - "values": { - "total_assets": "364840000000", - "total_liabilities": "291040000000" - } + "ff_period": "A", + "ff_year": 2024, + "fp_end": "2024-09-28", + "report_txt": "FY2024", + "rpt_date": "2024-11-01", + "fields": [ + { + "id": "revenue", + "name": "总营收", + "value": "391035000000", + "yoy": "0.0198", + "level": 1, + "display_order": 1, + "field": "revenue", + "value_type": "amount" + } + ] } - ], - "currency": "USD" + ] } ``` @@ -204,10 +216,35 @@ func main() { | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| revenue | string | 是 | 总营收 | -| net_income | string | 是 | 净利润 | -| net_margin | string | 是 | 净利润率 | -| periods | FinancialPeriod[] | 是 | 包含逐行数据的报告期列表 | -| ∟ date | string | 是 | 报告期日期 | -| ∟ values | map[string]any | 是 | 以指标名称为键的财务行项目 | | currency | string | 是 | 货币代码，如 `USD` | +| report | string | 是 | 报告周期类型（如 `annual`、`quarterly`） | +| empty_fields | string[] | 否 | 本期无数据的字段列表 | +| list | USFinancialStatementPeriod[] | 是 | 按报告期排列的报表数据 | + +### USFinancialStatementPeriod + + + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| ff_period | string | 是 | 报告周期代码（如 `A`=年报、`Q`=季报） | +| ff_year | int | 是 | 财年 | +| fp_end | string | 是 | 报告期结束日期 | +| report_txt | string | 是 | 报告期标签（如 `FY2024`） | +| rpt_date | string | 是 | 财报发布日期 | +| fields | USFinancialStatementField[] | 是 | 财务行项目列表 | + +### USFinancialStatementField + + + +| 名称 | 类型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| id | string | 是 | 字段标识 | +| name | string | 是 | 字段显示名称 | +| value | string | 是 | 字段值 | +| yoy | string | 否 | 同比变动率 | +| level | int | 是 | 层级（1=顶层） | +| display_order | int | 是 | 显示顺序 | +| field | string | 是 | 字段键名 | +| value_type | string | 是 | 值类型（如 `amount`、`ratio`） | diff --git a/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md b/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md index 1239fc5e..d08ee49c 100644 --- a/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md +++ b/docs/zh-CN/docs/fundamental/fundamental/us_valuation_overview.md @@ -163,6 +163,7 @@ func main() { + ## Response ### Response Example @@ -170,12 +171,19 @@ func main() { ```json { "indicator": "PE", - "current_indicator": { - "circle": "35.2" + "metrics": { + "pe": { + "circle": "35.2", + "part": "72", + "metric": "PE", + "desc": "市盈率", + "industry_median": "28.4" + } }, "range": 72, "date": "2026-07-01", - "ai_summary": "Apple's PE ratio of 35.2 is in the 72nd percentile..." + "ccy_symbol": "USD", + "ai_summary": "苹果市盈率处于历史 72 百分位..." } ``` @@ -194,9 +202,22 @@ func main() { | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| indicator | string | 是 | 估值指标名称（如 `PE`、`PB`） | -| current_indicator | object | 是 | 当前估值数据 | -| ∟ circle | string | 是 | 当前指标数值 | +| indicator | string | 是 | 主要估值指标名称（如 `PE`） | +| metrics | map[string, USValuationMetric] | 是 | 以指标名称为键的估值指标字典 | | range | int | 是 | 历史百分位（0–100） | | date | string | 是 | 估值日期 | +| ccy_symbol | string | 是 | 货币符号 | | ai_summary | string | 否 | AI 生成的估值摘要 | +| aichat_data | USAIChatData | 否 | AI 对话上下文数据 | + +### USValuationMetric + + + +| 名称 | 类型 | 描述 | +| ---- | ---- | ---- | +| circle | string | 当前指标数值 | +| part | string | 百分位位置 | +| metric | string | 指标名称 | +| desc | string | 指标描述 | +| industry_median | string | 行业中位数 | diff --git a/docs/zh-CN/docs/trade/asset/us_asset_overview.md b/docs/zh-CN/docs/trade/asset/us_asset_overview.md index bd47f156..4857648d 100644 --- a/docs/zh-CN/docs/trade/asset/us_asset_overview.md +++ b/docs/zh-CN/docs/trade/asset/us_asset_overview.md @@ -187,6 +187,7 @@ func main() { | 200 | 成功 | [USAssetOverview](#USAssetOverview) | | 400 | 请求错误 | None | + ## Schemas ### USAssetOverview @@ -197,7 +198,9 @@ func main() { | ---- | ---- | ---- | ---- | | account_type | string | 是 | 账户类型标识 | | asset_timestamp | int64 | 是 | 资产数据快照时间（Unix 秒） | -| cash_buy_power | string | 是 | 可用买入力 | +| cash_buy_power | string | 是 | 可用买入力（现金） | +| overnight_buy_power | string | 是 | 隔夜买入力 | +| currency | string | 是 | 基础货币 | | cash_list | USCashEntry[] | 否 | 按货币分列的现金余额 | | stock_list | USStockEntry[] | 否 | 股票持仓 | | crypto_list | USCryptoEntry[] | 否 | 加密货币持仓 | @@ -206,28 +209,38 @@ func main() { -| 名称 | 类型 | 必填 | 描述 | -| ---- | ---- | ---- | ---- | -| currency | string | 是 | 货币代码，如 `USD` | -| amount | string | 是 | 现金金额 | +| 名称 | 类型 | 描述 | +| ---- | ---- | ---- | +| currency | string | 货币代码 | +| total_cash | string | 总现金 | +| settled_cash | string | 已结算现金 | +| total_amount | string | 含未结算的总金额 | +| outstanding | string | 未结算金额 | +| frozen_buy_cash | string | 待成交买单冻结金额 | ### USStockEntry -| 名称 | 类型 | 必填 | 描述 | -| ---- | ---- | ---- | ---- | -| symbol | string | 是 | 股票代码，如 `AAPL.US` | -| quantity | string | 是 | 持有数量 | -| cost_price | string | 否 | 平均持仓成本价 | -| current_price | string | 否 | 当前市场价格 | -| market_value | string | 否 | 当前市值 | +| 名称 | 类型 | 描述 | +| ---- | ---- | ---- | +| symbol | string | 交易标的，如 `AAPL.US` | +| quantity | string | 持有数量 | +| currency | string | 货币代码 | +| average_cost | string | 平均持仓成本价 | +| last_done | string | 当前市场价格 | +| prev_close | string | 上一收盘价 | +| asset_type | string | 资产类型 | +| trade_status | string | 交易状态 | ### USCryptoEntry -| 名称 | 类型 | 必填 | 描述 | -| ---- | ---- | ---- | ---- | -| symbol | string | 是 | 加密货币交易对代码 | -| quantity | string | 是 | 持有数量 | +| 名称 | 类型 | 描述 | +| ---- | ---- | ---- | +| symbol | string | 加密货币交易对代码，如 `BTCUSD.BKKT` | +| average_cost | string | 平均持仓成本价 | +| currency | string | 计价货币 | +| asset_type | string | 资产类型 | +| industry_name | string | 行业/分类名称 | diff --git a/docs/zh-CN/docs/trade/order/us_order_detail.md b/docs/zh-CN/docs/trade/order/us_order_detail.md index 70fdc6a5..91300ab5 100644 --- a/docs/zh-CN/docs/trade/order/us_order_detail.md +++ b/docs/zh-CN/docs/trade/order/us_order_detail.md @@ -196,6 +196,7 @@ func main() { | 200 | 成功 | [USOrderDetailResponse](#USOrderDetailResponse) | | 400 | 请求错误 | None | + ## Schemas ### USOrderDetailResponse @@ -204,31 +205,28 @@ func main() { | 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| order | USOrder | 是 | 完整委托详情 | -| order_histories | USOrderHistory[] | 是 | 历史状态变更记录 | -| current_attached_order | USOrder \| null | 否 | 关联子委托（括号单/OCO），无则为 null | - -### USOrder - - - -| 名称 | 类型 | 必填 | 描述 | -| ---- | ---- | ---- | ---- | -| order_id | string | 是 | 委托唯一 ID | -| symbol | string | 是 | 交易标的，如 `AAPL.US` | -| side | string | 是 | `Buy`（买入）或 `Sell`（卖出） | -| status | string | 是 | 委托状态 | -| qty | string | 是 | 委托数量 | -| price | string | 是 | 委托价格 | -| executed_qty | string | 是 | 已成交数量 | -| executed_price | string | 是 | 平均成交价格 | -| created_at | int64 | 是 | 创建时间（Unix 秒） | - -### USOrderHistory - - - -| 名称 | 类型 | 必填 | 描述 | -| ---- | ---- | ---- | ---- | -| status | string | 是 | 委托状态 at this point | -| done_at | int64 | 是 | 时间戳（Unix 秒） | +| order | USOrderDetail \| null | 是 | 完整委托详情，未找到时为 null | +| current_attached_order | USOrderDetail \| null | 否 | 关联子委托（括号单/OCO），无则为 null | +| current_millisecond | string | 否 | 服务器时间戳（毫秒） | + +### USOrderDetail + + + +| 名称 | 类型 | 描述 | +| ---- | ---- | ---- | +| id | string | 委托 ID | +| symbol | string | 交易标的，如 `AAPL.US` | +| action | int | 方向：1=买入，2=卖出 | +| order_type | string | 委托类型 | +| status | string | 委托状态 | +| price | string | 委托价格 | +| quantity | string | 委托数量 | +| executed_qty | string | 已成交数量 | +| executed_price | string | 平均成交价格 | +| executed_amount | string | 成交总金额 | +| currency | string | 货币代码 | +| submitted_at | string | 提交时间 | +| done_at | string | 完成时间 | +| time_in_force | int | 有效期类型 | +| msg | string | 状态消息 | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md b/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md index 6074cd25..1ae8f4dd 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_company_dividends.md @@ -188,6 +188,7 @@ func main() { | 200 | 成功 | [UsCompanyDividends](#UsCompanyDividends) | | 400 | 請求錯誤 | None | + ## Schemas ### UsCompanyDividends @@ -196,9 +197,45 @@ func main() { | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| dividend_ttm | string | 是 | 過去 12 個月每股股息 | -| dividend_yield_ttm | string | 是 | TTM 股息率（%） | -| payouts | string | 是 | 過去一年派息次數 | -| currency | string | 是 | 貨幣代碼，如 `USD` | -| items | USDividendItem[] | 否 | 逐筆分紅記錄 | -| ∟ dividend | string | 是 | 每股分紅金額 | +| recent_dividends | USRecentDividend | 是 | 近期分紅摘要 | +| dividend_history | USDividendHistoryItem[] | 否 | 歷年分紅歷史 | +| payout_ratios | USDividendHistoryItem[] | 否 | 派息率歷史 | +| dividend_payout_history | USDividendPayoutRecord[] | 否 | 逐筆分紅派發記錄 | + +### USRecentDividend + + + +| 名稱 | 類型 | 描述 | +| ---- | ---- | ---- | +| dividend_ttm | string | 過去 12 個月每股股息 | +| dividend_yield_ttm | string | TTM 股息率（%） | +| payouts | string | 過去一年派息次數 | +| currency | string | 貨幣代碼 | + +### USDividendHistoryItem + + + +| 名稱 | 類型 | 描述 | +| ---- | ---- | ---- | +| fiscal_year | string | 財年 | +| fiscal_year_range | string | 財年日期範圍 | +| dividend | string | 年度總股息 | +| dividend_yield | string | 年度股息率 | +| dividend_growth_rate | string | 股息同比增長率 | +| dividend_payout_ratio | string | 派息率 | +| total_shareholder_yield | string | 股東總回報率 | + +### USDividendPayoutRecord + + + +| 名稱 | 類型 | 描述 | +| ---- | ---- | ---- | +| dividend | string | 每股分紅金額 | +| dividend_type | string | 分紅類型（如 `Cash`） | +| currency | string | 貨幣代碼 | +| ex_date | string | 除權日 | +| payment_date | string | 派息日 | +| record_date | string | 登記日 | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md index cf2ed758..70486982 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_company_overview.md @@ -184,16 +184,39 @@ func main() { | 200 | 成功 | [UsCompanyOverview](#UsCompanyOverview) | | 400 | 請求錯誤 | None | + ## Schemas ### UsCompanyOverview -| 名稱 | 類型 | 必填 | 描述 | +| 名称 | 类型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | | intro | string | 是 | 公司簡介 | | market_cap | string | 是 | 市值 | | ccy_symbol | string | 是 | 貨幣符號 | -| top_rank_tags | string[] | 否 | 排名標籤列表 | +| top_rank_tags | USRankTag[] | 否 | 排名標籤列表 | | detail_url | string | 否 | 公司詳情頁連結 | +| share_list | USSharelistItem[] | 否 | 相關自選列表 | + +### USRankTag + + + +| 名称 | 类型 | 描述 | +| ---- | ---- | ---- | +| key | string | 標籤標識 | +| title | string | 標籤標題 | +| text | string | 標籤顯示文本 | +| rank_type | int | 排名類型 | + +### USSharelistItem + + + +| 名称 | 类型 | 描述 | +| ---- | ---- | ---- | +| id | string | 自選列表 ID | +| name | string | 自選列表名称 | +| chg | string | 變動值 | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md b/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md index cf476ff9..6bfb024a 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_etf_dividend_info.md @@ -193,6 +193,7 @@ func main() { | 200 | 成功 | [UsETFDividendInfo](#UsETFDividendInfo) | | 400 | 請求錯誤 | None | + ## Schemas ### UsETFDividendInfo @@ -203,9 +204,18 @@ func main() { | ---- | ---- | ---- | ---- | | dividend_ttm | string | 是 | 過去 12 個月每股股息 | | dividend_yield_ttm | string | 是 | TTM 股息率（%） | -| dividend_freq | string | 是 | 派息頻率（如 `Quarterly`） | +| dividend_frequency | string | 是 | 派息頻率（如 `Quarterly`） | | currency | string | 是 | 貨幣代碼，如 `USD` | -| fiscal_year_info | FiscalYearDividend[] | 否 | 按財年分列的年度分紅明細 | -| ∟ year | string | 是 | 財年 | -| ∟ total_dividend | string | 是 | 年度總股息 | -| ∟ records | object[] | 否 | 逐筆支付記錄 | +| fiscal_year_info | USFiscalYearDividend[] | 否 | 按財年分列的年度分紅明細 | + +### USFiscalYearDividend + + + +| 名稱 | 類型 | 描述 | +| ---- | ---- | ---- | +| fiscal_year | string | 財年 | +| fiscal_year_range | string | 財年日期範圍 | +| dividend | string | 年度總股息 | +| dividend_yield | string | 年度股息率 | +| currency | string | 貨幣代碼 | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md b/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md index 33f0b27c..33830209 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_etf_files.md @@ -184,13 +184,25 @@ func main() { | 200 | 成功 | [UsETFFileList](#UsETFFileList) | | 400 | 請求錯誤 | None | + ## Schemas -### UsETFFileList +### UsETFFilesResponse - + | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| files | ETFFile[] | 是 | ETF 監管文件列表 | -| ∟ name | string | 是 | 文件名稱 | +| files | USETFFile[] | 是 | ETF 監管文件列表 | + +### USETFFile + + + +| 名稱 | 類型 | 描述 | +| ---- | ---- | ---- | +| file_name | string | 文件名稱 | +| file_path | string | 文件路徑或 URL | +| update_date | string | 最後更新日期 | +| code | string | 文件代碼 | +| format | string | 文件格式（如 `pdf`） | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement.md b/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement.md index a1b7a8e5..96cb3c3b 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_financial_statement.md @@ -167,31 +167,43 @@ func main() { + ## Response ### Response Example ```json { - "revenue": "124300000000", - "net_income": "30520000000", - "net_margin": "0.2454", - "periods": [ + "currency": "USD", + "report": "annual", + "empty_fields": [], + "list": [ { - "date": "2026-03-31", - "values": { - "total_assets": "364840000000", - "total_liabilities": "291040000000" - } + "ff_period": "A", + "ff_year": 2024, + "fp_end": "2024-09-28", + "report_txt": "FY2024", + "rpt_date": "2024-11-01", + "fields": [ + { + "id": "revenue", + "name": "总营收", + "value": "391035000000", + "yoy": "0.0198", + "level": 1, + "display_order": 1, + "field": "revenue", + "value_type": "amount" + } + ] } - ], - "currency": "USD" + ] } ``` ### Response Status -| 狀態碼 | 描述 | 結構 | +| 狀態碼 | 描述 | 结构 | | ------ | ---- | ---- | | 200 | 成功 | [UsFinancialStatement](#UsFinancialStatement) | | 400 | 請求錯誤 | None | @@ -204,10 +216,35 @@ func main() { | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| revenue | string | 是 | 總營收 | -| net_income | string | 是 | 淨利潤 | -| net_margin | string | 是 | 淨利潤率 | -| periods | FinancialPeriod[] | 是 | 包含逐行數據的報告期列表 | -| ∟ date | string | 是 | 報告期日期 | -| ∟ values | map[string]any | 是 | 以指標名稱為鍵的財務行項目 | | currency | string | 是 | 貨幣代碼，如 `USD` | +| report | string | 是 | 報告週期類型（如 `annual`、`quarterly`） | +| empty_fields | string[] | 否 | 本期無數據的字段列表 | +| list | USFinancialStatementPeriod[] | 是 | 按報告期排列的報表數據 | + +### USFinancialStatementPeriod + + + +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| ff_period | string | 是 | 報告週期代碼（如 `A`=年报、`Q`=季报） | +| ff_year | int | 是 | 財年 | +| fp_end | string | 是 | 報告期結束日期 | +| report_txt | string | 是 | 報告期標籤（如 `FY2024`） | +| rpt_date | string | 是 | 財報發布日期 | +| fields | USFinancialStatementField[] | 是 | 財務行項目列表 | + +### USFinancialStatementField + + + +| 名稱 | 類型 | 必填 | 描述 | +| ---- | ---- | ---- | ---- | +| id | string | 是 | 字段標識 | +| name | string | 是 | 字段顯示名稱 | +| value | string | 是 | 字段值 | +| yoy | string | 否 | 同比變動率 | +| level | int | 是 | 層級（1=顶层） | +| display_order | int | 是 | 顯示順序 | +| field | string | 是 | 字段鍵名 | +| value_type | string | 是 | 值類型（如 `amount`、`ratio`） | diff --git a/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md b/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md index a0a56586..b8e6cef2 100644 --- a/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md +++ b/docs/zh-HK/docs/fundamental/fundamental/us_valuation_overview.md @@ -163,6 +163,7 @@ func main() { + ## Response ### Response Example @@ -170,18 +171,25 @@ func main() { ```json { "indicator": "PE", - "current_indicator": { - "circle": "35.2" + "metrics": { + "pe": { + "circle": "35.2", + "part": "72", + "metric": "PE", + "desc": "市盈率", + "industry_median": "28.4" + } }, "range": 72, "date": "2026-07-01", - "ai_summary": "Apple's PE ratio of 35.2 is in the 72nd percentile..." + "ccy_symbol": "USD", + "ai_summary": "苹果市盈率处于历史 72 百分位..." } ``` ### Response Status -| 狀態碼 | 描述 | 結構 | +| 狀態碼 | 描述 | 结构 | | ------ | ---- | ---- | | 200 | 成功 | [UsValuationOverview](#UsValuationOverview) | | 400 | 請求錯誤 | None | @@ -194,9 +202,22 @@ func main() { | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| indicator | string | 是 | 估值指標名稱（如 `PE`、`PB`） | -| current_indicator | object | 是 | 當前估值數據 | -| ∟ circle | string | 是 | 當前指標數值 | +| indicator | string | 是 | 主要估值指標名稱（如 `PE`） | +| metrics | map[string, USValuationMetric] | 是 | 以指標名稱為鍵的估值指標字典 | | range | int | 是 | 歷史百分位（0–100） | | date | string | 是 | 估值日期 | +| ccy_symbol | string | 是 | 貨幣符號 | | ai_summary | string | 否 | AI 生成的估值摘要 | +| aichat_data | USAIChatData | 否 | AI 對話上下文數據 | + +### USValuationMetric + + + +| 名稱 | 類型 | 描述 | +| ---- | ---- | ---- | +| circle | string | 當前指標數值 | +| part | string | 百分位位置 | +| metric | string | 指標名稱 | +| desc | string | 指標描述 | +| industry_median | string | 行業中位數 | diff --git a/docs/zh-HK/docs/trade/asset/us_asset_overview.md b/docs/zh-HK/docs/trade/asset/us_asset_overview.md index 3d376007..28e5d95d 100644 --- a/docs/zh-HK/docs/trade/asset/us_asset_overview.md +++ b/docs/zh-HK/docs/trade/asset/us_asset_overview.md @@ -187,6 +187,7 @@ func main() { | 200 | 成功 | [USAssetOverview](#USAssetOverview) | | 400 | 請求錯誤 | None | + ## Schemas ### USAssetOverview @@ -197,7 +198,9 @@ func main() { | ---- | ---- | ---- | ---- | | account_type | string | 是 | 賬戶類型標識 | | asset_timestamp | int64 | 是 | 資產數據快照時間（Unix 秒） | -| cash_buy_power | string | 是 | 可用買入力 | +| cash_buy_power | string | 是 | 可用買入力（现金） | +| overnight_buy_power | string | 是 | 隔夜買入力 | +| currency | string | 是 | 基礎貨幣 | | cash_list | USCashEntry[] | 否 | 按貨幣分列的現金餘額 | | stock_list | USStockEntry[] | 否 | 股票持倉 | | crypto_list | USCryptoEntry[] | 否 | 加密貨幣持倉 | @@ -206,28 +209,38 @@ func main() { -| 名稱 | 類型 | 必填 | 描述 | -| ---- | ---- | ---- | ---- | -| currency | string | 是 | 貨幣代碼，如 `USD` | -| amount | string | 是 | 現金金額 | +| 名稱 | 類型 | 描述 | +| ---- | ---- | ---- | +| currency | string | 貨幣代碼 | +| total_cash | string | 總現金 | +| settled_cash | string | 已結算現金 | +| total_amount | string | 含未結算的總金額 | +| outstanding | string | 未結算金額 | +| frozen_buy_cash | string | 待成交買單凍結金額 | ### USStockEntry -| 名稱 | 類型 | 必填 | 描述 | -| ---- | ---- | ---- | ---- | -| symbol | string | 是 | 股票代碼，如 `AAPL.US` | -| quantity | string | 是 | 持有數量 | -| cost_price | string | 否 | 平均持倉成本價 | -| current_price | string | 否 | 當前市場價格 | -| market_value | string | 否 | 當前市值 | +| 名稱 | 類型 | 描述 | +| ---- | ---- | ---- | +| symbol | string | 交易標的，如 `AAPL.US` | +| quantity | string | 持有數量 | +| currency | string | 貨幣代碼 | +| average_cost | string | 平均持倉成本價 | +| last_done | string | 當前市場價格 | +| prev_close | string | 上一收盤價 | +| asset_type | string | 資產類型 | +| trade_status | string | 交易狀態 | ### USCryptoEntry -| 名稱 | 類型 | 必填 | 描述 | -| ---- | ---- | ---- | ---- | -| symbol | string | 是 | 加密貨幣交易對代碼 | -| quantity | string | 是 | 持有數量 | +| 名稱 | 類型 | 描述 | +| ---- | ---- | ---- | +| symbol | string | 加密貨幣交易對代碼，如 `BTCUSD.BKKT` | +| average_cost | string | 平均持倉成本價 | +| currency | string | 計價貨幣 | +| asset_type | string | 資產類型 | +| industry_name | string | 行業/分類名稱 | diff --git a/docs/zh-HK/docs/trade/order/us_order_detail.md b/docs/zh-HK/docs/trade/order/us_order_detail.md index d05b0a9d..37820acc 100644 --- a/docs/zh-HK/docs/trade/order/us_order_detail.md +++ b/docs/zh-HK/docs/trade/order/us_order_detail.md @@ -196,6 +196,7 @@ func main() { | 200 | 成功 | [USOrderDetailResponse](#USOrderDetailResponse) | | 400 | 請求錯誤 | None | + ## Schemas ### USOrderDetailResponse @@ -204,31 +205,28 @@ func main() { | 名稱 | 類型 | 必填 | 描述 | | ---- | ---- | ---- | ---- | -| order | USOrder | 是 | 完整委託詳情 | -| order_histories | USOrderHistory[] | 是 | 歷史狀態變更記錄 | -| current_attached_order | USOrder \| null | 否 | 關聯子委託（括號單/OCO），無則為 null | - -### USOrder - - - -| 名稱 | 類型 | 必填 | 描述 | -| ---- | ---- | ---- | ---- | -| order_id | string | 是 | 委託唯一 ID | -| symbol | string | 是 | 交易標的，如 `AAPL.US` | -| side | string | 是 | `Buy`（買入）或 `Sell`（賣出） | -| status | string | 是 | 委託狀態 | -| qty | string | 是 | 委託數量 | -| price | string | 是 | 委託價格 | -| executed_qty | string | 是 | 已成交數量 | -| executed_price | string | 是 | 平均成交價格 | -| created_at | int64 | 是 | 創建時間（Unix 秒） | - -### USOrderHistory - - - -| 名稱 | 類型 | 必填 | 描述 | -| ---- | ---- | ---- | ---- | -| status | string | 是 | 委託狀態 at this point | -| done_at | int64 | 是 | 時間戳（Unix 秒） | +| order | USOrderDetail \| null | 是 | 完整委託詳情，未找到時為 null | +| current_attached_order | USOrderDetail \| null | 否 | 關聯子委託（括號單/OCO），無則為 null | +| current_millisecond | string | 否 | 服務器時間戳（毫秒） | + +### USOrderDetail + + + +| 名稱 | 類型 | 描述 | +| ---- | ---- | ---- | +| id | string | 委託 ID | +| symbol | string | 交易標的，如 `AAPL.US` | +| action | int | 方向：1=買入，2=賣出 | +| order_type | string | 委託類型 | +| status | string | 委託狀態 | +| price | string | 委託價格 | +| quantity | string | 委託數量 | +| executed_qty | string | 已成交數量 | +| executed_price | string | 平均成交價格 | +| executed_amount | string | 成交總金額 | +| currency | string | 貨幣代碼 | +| submitted_at | string | 提交時間 | +| done_at | string | 完成時間 | +| time_in_force | int | 有效期類型 | +| msg | string | 狀態消息 |