diff --git a/docs/en/docs/quote/watchlist/watchlist_update_group.md b/docs/en/docs/quote/watchlist/watchlist_update_group.md
index 9352193cd..ea70f4957 100644
--- a/docs/en/docs/quote/watchlist/watchlist_update_group.md
+++ b/docs/en/docs/quote/watchlist/watchlist_update_group.md
@@ -56,7 +56,7 @@ from longbridge.openapi import QuoteContext, Config, SecuritiesUpdateMode, OAuth
oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url))
config = Config.from_oauth(oauth)
ctx = QuoteContext(config)
-ctx.update_watchlist_group(10086, name = "Watchlist2", securities = ["700.HK", "AAPL.US"], SecuritiesUpdateMode.Replace)
+ctx.update_watchlist_group(10086, name = "Watchlist2", securities = ["700.HK", "AAPL.US"], mode = SecuritiesUpdateMode.Replace)
```
@@ -70,7 +70,7 @@ 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)
- ctx.update_watchlist_group(10086, name = "Watchlist2", securities = ["700.HK", "AAPL.US"], SecuritiesUpdateMode.Replace)
+ ctx.update_watchlist_group(10086, name = "Watchlist2", securities = ["700.HK", "AAPL.US"], mode = SecuritiesUpdateMode.Replace)
if __name__ == "__main__":
asyncio.run(main())
diff --git a/docs/en/docs/socket/control-command.md b/docs/en/docs/socket/control-command.md
index ee11dbbc7..b29fafdeb 100644
--- a/docs/en/docs/socket/control-command.md
+++ b/docs/en/docs/socket/control-command.md
@@ -36,7 +36,7 @@ Cases server will close the connection:
6. session expired when reconnect
7. duplicate connection have been created
-The reason why server close the connection will send by close packet, protobuf defination:
+The reason why server close the connection will send by close packet, protobuf definition:
```protobuf
message Close {
@@ -140,4 +140,4 @@ message ReconnectResponse {
## Protobuf
-All control command protobuf definations are opensource in [GitHub](https://github.com/longbridge/openapi-protobufs/blob/main/control/control.proto)
+All control command protobuf definitions are opensource in [GitHub](https://github.com/longbridge/openapi-protobufs/blob/main/control/control.proto)
diff --git a/docs/en/docs/socket/how_to_subscribe_quote.md b/docs/en/docs/socket/how_to_subscribe_quote.md
index 18e7abfda..55ebacb9b 100644
--- a/docs/en/docs/socket/how_to_subscribe_quote.md
+++ b/docs/en/docs/socket/how_to_subscribe_quote.md
@@ -48,7 +48,7 @@ end
Client can subscribe different quote type through subscribe commmand.
-Subscribe command [protobuf defination](../quote/subscribe/subscribe)
+Subscribe command [protobuf definition](../quote/subscribe/subscribe)
Example:
@@ -63,9 +63,9 @@ Example:
> Here is `JSON` for easy showing case, actually need using protobuf encoding.
-Client can also check quote topics already subscribing, [protobuf defination](../quote/subscribe/subscription).
+Client can also check quote topics already subscribing, [protobuf definition](../quote/subscribe/subscription).
-After client success subscribing quote, server will push real-time quote data to client, data [protobuf defination](../quote/overview).
+After client success subscribing quote, server will push real-time quote data to client, data [protobuf definition](../quote/overview).
## Other Quote APIs
diff --git a/docs/en/docs/socket/how_to_subscribe_trade.md b/docs/en/docs/socket/how_to_subscribe_trade.md
index ed5116c29..727bb1a05 100644
--- a/docs/en/docs/socket/how_to_subscribe_trade.md
+++ b/docs/en/docs/socket/how_to_subscribe_trade.md
@@ -36,7 +36,7 @@ end
## Subscribe
-Subscribe [protobuf defination](../trade/trade-push)
+Subscribe [protobuf definition](../trade/trade-push)
Example:
diff --git a/docs/en/docs/socket/protocol/how-to-parse-request.md b/docs/en/docs/socket/protocol/how-to-parse-request.md
index fa2604a1e..014516d00 100644
--- a/docs/en/docs/socket/protocol/how-to-parse-request.md
+++ b/docs/en/docs/socket/protocol/how-to-parse-request.md
@@ -53,5 +53,5 @@ Fields Descriptions:
| signature | 128 | 16 | exists when `verify` is `1` |
:::info
-Using specific protobuf defination to encode/decode body data
+Using specific protobuf definition to encode/decode body data
:::
diff --git a/docs/en/docs/trade/trade-push.md b/docs/en/docs/trade/trade-push.md
index 267365202..7b9098cd3 100644
--- a/docs/en/docs/trade/trade-push.md
+++ b/docs/en/docs/trade/trade-push.md
@@ -79,7 +79,7 @@ Current support topics:
Cmd: `17`
:::
-Protobuf defination:
+Protobuf definition:
```protobuf
// Unsub is Unsub command content, command is 17
@@ -103,7 +103,7 @@ After we `subscribe` to the trade gateway, we can get real-time trade updates fr
Cmd: `18`
:::
-Protobuf defination:
+Protobuf definition:
```protobuf
// Dispatch type
diff --git a/docs/zh-CN/docs/quote/objects.md b/docs/zh-CN/docs/quote/objects.md
index 050e04563..1fcdac9fa 100644
--- a/docs/zh-CN/docs/quote/objects.md
+++ b/docs/zh-CN/docs/quote/objects.md
@@ -68,24 +68,24 @@ enum TradeSession {
| ID | 描述 |
| ---- | --------------- |
-| 1 | 一分钟 k 线 |
-| 2 | 两分钟 k 线 |
-| 3 | 三分钟 k 线 |
-| 5 | 五分钟 k 线 |
-| 10 | 十分钟 k 线 |
-| 15 | 十五分钟 k 线 |
-| 20 | 二十分钟 k 线 |
-| 30 | 三十分钟 k 线 |
-| 45 | 四十五分钟 k 线 |
-| 60 | 六十分钟 k 线 |
-| 120 | 两小时 k 线 |
-| 180 | 三小时 k 线 |
-| 240 | 四小时 k 线 |
-| 1000 | 日 k 线 |
-| 2000 | 周 k 线 |
-| 3000 | 月 k 线 |
-| 3500 | 季 k 线 |
-| 4000 | 年 k 线 |
+| 1 | 一分钟 K 线 |
+| 2 | 两分钟 K 线 |
+| 3 | 三分钟 K 线 |
+| 5 | 五分钟 K 线 |
+| 10 | 十分钟 K 线 |
+| 15 | 十五分钟 K 线 |
+| 20 | 二十分钟 K 线 |
+| 30 | 三十分钟 K 线 |
+| 45 | 四十五分钟 K 线 |
+| 60 | 六十分钟 K 线 |
+| 120 | 两小时 K 线 |
+| 180 | 三小时 K 线 |
+| 240 | 四小时 K 线 |
+| 1000 | 日 K 线 |
+| 2000 | 周 K 线 |
+| 3000 | 月 K 线 |
+| 3500 | 季 K 线 |
+| 4000 | 年 K 线 |
### Protobuf
diff --git a/docs/zh-CN/docs/quote/overview.md b/docs/zh-CN/docs/quote/overview.md
index 365774f7b..6d1817332 100644
--- a/docs/zh-CN/docs/quote/overview.md
+++ b/docs/zh-CN/docs/quote/overview.md
@@ -33,7 +33,7 @@ slug: overview
获取标的经纪队列 |
- | 获取券商席位 id |
+ 获取券商席位 ID |
| 获取标的成交明细 |
@@ -72,7 +72,7 @@ slug: overview
获取标的计算指标 |
- | 获取标的历史 k 线 |
+ 获取标的历史 K 线 |
| 订阅 |
diff --git a/docs/zh-CN/docs/quote/stocks/candlestick.md b/docs/zh-CN/docs/quote/stocks/candlestick.md
index 53ee23f9f..46790613f 100644
--- a/docs/zh-CN/docs/quote/stocks/candlestick.md
+++ b/docs/zh-CN/docs/quote/stocks/candlestick.md
@@ -37,7 +37,7 @@ longbridge kline NVDA.US --period day --count 20
| Name | Type | Required | Description |
| ------------- | ------ | -------- | ---------------------------------------------------------------------------- |
| symbol | string | 是 | 标的代码,使用 `ticker.region` 格式,例如:`700.HK` |
-| period | int32 | 是 | k 线周期,例如:`1000`,详见 [Period](../objects#period---k-线周期) |
+| period | int32 | 是 | K 线周期,例如:`1000`,详见 [Period](../objects#period---k-线周期) |
| count | int32 | 是 | 数据数量,例如:`100`
**校验规则:**
请求数量最大为 `1000` |
| adjust_type | int32 | 是 | 复权类型,例如:`0`,详见 [AdjustType](../objects#adjusttype---k-线复权类型) |
| trade_session | int32 | 否 | 交易时段,0: 盘中,100: 所有(盘前,盘中,盘后,夜盘)
注意:夜盘数据需购买「LV1 实时行情 (OpenAPI)」行情卡,且仅支持美股 |
diff --git a/docs/zh-CN/docs/quote/stocks/history-candlestick.md b/docs/zh-CN/docs/quote/stocks/history-candlestick.md
index 385d3257a..eb599b911 100644
--- a/docs/zh-CN/docs/quote/stocks/history-candlestick.md
+++ b/docs/zh-CN/docs/quote/stocks/history-candlestick.md
@@ -33,7 +33,7 @@ longbridge kline history NVDA.US --start 2025-01-01 --end 2025-12-31
| Name | Type | Required | Description |
| -------------- | ------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| symbol | string | 是 | 标的代码,使用 `ticker.region` 格式,例如:`700.HK` |
-| period | int32 | 是 | k 线周期,例如:`1000`,详见 [Period](../objects#period---k-线周期) |
+| period | int32 | 是 | K 线周期,例如:`1000`,详见 [Period](../objects#period---k-线周期) |
| adjust_type | int32 | 是 | 复权类型,例如:`0`,详见 [AdjustType](../objects#adjusttype---k-线复权类型) |
| query_type | int32 | 是 | 查询方式
**可选值:**
`1` - 按偏移查询
`2` - 按日期区间查询 |
| date_request | object | 否 | 按日期查询时必填 |
diff --git a/docs/zh-CN/docs/quote/watchlist/watchlist_update_group.md b/docs/zh-CN/docs/quote/watchlist/watchlist_update_group.md
index 15425eda6..a12000c47 100644
--- a/docs/zh-CN/docs/quote/watchlist/watchlist_update_group.md
+++ b/docs/zh-CN/docs/quote/watchlist/watchlist_update_group.md
@@ -57,7 +57,7 @@ from longbridge.openapi import QuoteContext, Config, SecuritiesUpdateMode, OAuth
oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url))
config = Config.from_oauth(oauth)
ctx = QuoteContext(config)
-ctx.update_watchlist_group(10086, name = "WatchList2", securities = ["700.HK", "AAPL.US"], SecuritiesUpdateMode.Replace)
+ctx.update_watchlist_group(10086, name = "WatchList2", securities = ["700.HK", "AAPL.US"], mode = SecuritiesUpdateMode.Replace)
```
@@ -71,7 +71,7 @@ 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)
- ctx.update_watchlist_group(10086, name = "WatchList2", securities = ["700.HK", "AAPL.US"], SecuritiesUpdateMode.Replace)
+ ctx.update_watchlist_group(10086, name = "WatchList2", securities = ["700.HK", "AAPL.US"], mode = SecuritiesUpdateMode.Replace)
if __name__ == "__main__":
asyncio.run(main())
diff --git a/docs/zh-CN/docs/socket/biz_command.md b/docs/zh-CN/docs/socket/biz_command.md
index b9c87318e..ebdba4a60 100644
--- a/docs/zh-CN/docs/socket/biz_command.md
+++ b/docs/zh-CN/docs/socket/biz_command.md
@@ -34,7 +34,7 @@ sidebar_position: 5
获取标的经纪队列 |
- | 获取券商席位 id |
+ 获取券商席位 ID |
| 获取标的成交明细 |
diff --git a/docs/zh-CN/sdk.md b/docs/zh-CN/sdk.md
index 060fc91e3..e54d69648 100644
--- a/docs/zh-CN/sdk.md
+++ b/docs/zh-CN/sdk.md
@@ -26,7 +26,7 @@ SDK 包名已从 `longport` 更名为 `longbridge`,旧包名 `longport` 已废
### 安装 SDK
-你可以通过 Pip 安装 SDK,或者直接访问 [PyPI](https://pypi.org/project/longbridge/) 页面来下载。
+你可以通过 pip 安装 SDK,或者直接访问 [PyPI](https://pypi.org/project/longbridge/) 页面来下载。
```bash
$ pip install longbridge
diff --git a/docs/zh-HK/docs/quote/objects.md b/docs/zh-HK/docs/quote/objects.md
index fe44949d8..88a509424 100644
--- a/docs/zh-HK/docs/quote/objects.md
+++ b/docs/zh-HK/docs/quote/objects.md
@@ -66,24 +66,24 @@ enum TradeSession {
| ID | 描述 |
| ---- | --------------- |
-| 1 | 一分鐘 k 線 |
-| 2 | 兩分鐘 k 線 |
-| 3 | 三分鐘 k 線 |
-| 5 | 五分鐘 k 線 |
-| 10 | 十分鐘 k 線 |
-| 15 | 十五分鐘 k 線 |
-| 20 | 二十分鐘 k 線 |
-| 30 | 三十分鐘 k 線 |
-| 45 | 四十五分鐘 k 線 |
-| 60 | 六十分鐘 k 線 |
-| 120 | 兩小時 k 線 |
-| 180 | 三小時 k 線 |
-| 240 | 四小時 k 線 |
-| 1000 | 日 k 線 |
-| 2000 | 週 k 線 |
-| 3000 | 月 k 線 |
-| 3500 | 季 k 線 |
-| 4000 | 年 k 線 |
+| 1 | 一分鐘 K 線 |
+| 2 | 兩分鐘 K 線 |
+| 3 | 三分鐘 K 線 |
+| 5 | 五分鐘 K 線 |
+| 10 | 十分鐘 K 線 |
+| 15 | 十五分鐘 K 線 |
+| 20 | 二十分鐘 K 線 |
+| 30 | 三十分鐘 K 線 |
+| 45 | 四十五分鐘 K 線 |
+| 60 | 六十分鐘 K 線 |
+| 120 | 兩小時 K 線 |
+| 180 | 三小時 K 線 |
+| 240 | 四小時 K 線 |
+| 1000 | 日 K 線 |
+| 2000 | 週 K 線 |
+| 3000 | 月 K 線 |
+| 3500 | 季 K 線 |
+| 4000 | 年 K 線 |
### Protobuf
diff --git a/docs/zh-HK/docs/quote/overview.md b/docs/zh-HK/docs/quote/overview.md
index 9e0789d26..55fe1f945 100644
--- a/docs/zh-HK/docs/quote/overview.md
+++ b/docs/zh-HK/docs/quote/overview.md
@@ -33,7 +33,7 @@ slug: overview
獲取標的經紀隊列 |
- | 獲取券商席位 id |
+ 獲取券商席位 ID |
| 獲取標的成交明細 |
@@ -42,7 +42,7 @@ slug: overview
獲取標的分時 |
- | 獲取標的 k 線 |
+ 獲取標的 K 線 |
| 獲取標的的期權鏈到期日列表 |
@@ -51,7 +51,7 @@ slug: overview
獲取標的的期權鏈到期日期權標的列表 |
- | 獲取輪證發行商 id |
+ 獲取輪證發行商 ID |
| 獲取輪證篩選列表 |
diff --git a/docs/zh-HK/docs/quote/stocks/candlestick.md b/docs/zh-HK/docs/quote/stocks/candlestick.md
index cffe9f317..b56cec467 100644
--- a/docs/zh-HK/docs/quote/stocks/candlestick.md
+++ b/docs/zh-HK/docs/quote/stocks/candlestick.md
@@ -37,7 +37,7 @@ longbridge kline NVDA.US --period day --count 20
| Name | Type | Required | Description |
| ------------- | ------ | -------- | ---------------------------------------------------------------------------- |
| symbol | string | 是 | 標的代碼,使用 `ticker.region` 格式,例如:`700.HK` |
-| period | int32 | 是 | k 線週期,例如:`1000`,详见 [Period](../objects#period---k-線週期) |
+| period | int32 | 是 | K 線週期,例如:`1000`,详见 [Period](../objects#period---k-線週期) |
| count | int32 | 是 | 數據數量,例如:`100`
**校验规则:**
請求數量最大為 `1000` |
| adjust_type | int32 | 是 | 復權類型,例如:`0`,详见 [AdjustType](../objects#adjusttype---k-線復權類型) |
| trade_session | int32 | 否 | 交易時段,0: 盤中,100: 所有延長時段(盤前,盤中,盤後,夜盤)
注意:夜盤數據需購買「LV1 實時行情 (OpenAPI)」行情卡,且僅支援美股 |
diff --git a/docs/zh-HK/docs/quote/stocks/history-candlestick.md b/docs/zh-HK/docs/quote/stocks/history-candlestick.md
index fd887165d..8795e782e 100644
--- a/docs/zh-HK/docs/quote/stocks/history-candlestick.md
+++ b/docs/zh-HK/docs/quote/stocks/history-candlestick.md
@@ -33,7 +33,7 @@ longbridge kline history NVDA.US --start 2025-01-01 --end 2025-12-31
| Name | Type | Required | Description |
| -------------- | ------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| symbol | string | 是 | 標的代碼,使用 `ticker.region` 格式,例如:`700.HK` |
-| period | int32 | 是 | k 線周期,例如:`1000`,詳見 [Period](../objects#period---k-線周期) |
+| period | int32 | 是 | K 線周期,例如:`1000`,詳見 [Period](../objects#period---k-線周期) |
| adjust_type | int32 | 是 | 複權類型,例如:`0`,詳見 [AdjustType](../objects#adjusttype---k-線復權類型) |
| query_type | int32 | 是 | 查詢方式
**可選值:**
`1` - 按偏移查詢
`2` - 按日期區間查詢 |
| date_request | object | 否 | 按日期查詢時必填 |
@@ -42,7 +42,7 @@ longbridge kline history NVDA.US --start 2025-01-01 --end 2025-12-31
| offset_request | object | 否 | 按偏移查詢時必填 |
| ∟ direction | int32 | 是 | 查詢方嚮
**可選值:**
`0` - 嚮曆史數據方嚮查找
`1` - 嚮最新數據方嚮查找 |
| ∟ date | string | 否 | 查詢日期,格式為 `YYYYMMDD`,例如:20231016,為空時使用標的所在市場的最新交易日 |
-| ∟ minute | string | 否 | 查詢時間,格式為 `HHMM`,例如:09:35,僅在查詢分鍾級別 k 線時有效 |
+| ∟ minute | string | 否 | 查詢時間,格式為 `HHMM`,例如:09:35,僅在查詢分鍾級別 K 線時有效 |
| ∟ count | int32 | 否 | 查詢數量,填寫範圍 `[1,1000]`,為空時默認查詢 `10` 條 |
| trade_session | int32 | 否 | 交易時段,0: 盤中,100: 所有延長時段(盤前,盤中,盤後,夜盤)
注意:夜盤數據需購買「LV1 實時行情 (OpenAPI)」行情卡,且僅支援美股 |
diff --git a/docs/zh-HK/docs/quote/watchlist/watchlist_update_group.md b/docs/zh-HK/docs/quote/watchlist/watchlist_update_group.md
index a4d5c5d01..40502d620 100644
--- a/docs/zh-HK/docs/quote/watchlist/watchlist_update_group.md
+++ b/docs/zh-HK/docs/quote/watchlist/watchlist_update_group.md
@@ -56,7 +56,7 @@ from longbridge.openapi import QuoteContext, Config, SecuritiesUpdateMode, OAuth
oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url))
config = Config.from_oauth(oauth)
ctx = QuoteContext(config)
-ctx.update_watchlist_group(10086, name = "WatchList2", securities = ["700.HK", "AAPL.US"], SecuritiesUpdateMode.Replace)
+ctx.update_watchlist_group(10086, name = "WatchList2", securities = ["700.HK", "AAPL.US"], mode = SecuritiesUpdateMode.Replace)
```
@@ -70,7 +70,7 @@ 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)
- ctx.update_watchlist_group(10086, name = "WatchList2", securities = ["700.HK", "AAPL.US"], SecuritiesUpdateMode.Replace)
+ ctx.update_watchlist_group(10086, name = "WatchList2", securities = ["700.HK", "AAPL.US"], mode = SecuritiesUpdateMode.Replace)
if __name__ == "__main__":
asyncio.run(main())
diff --git a/docs/zh-HK/docs/socket/biz_command.md b/docs/zh-HK/docs/socket/biz_command.md
index d195340a6..10afca6e2 100644
--- a/docs/zh-HK/docs/socket/biz_command.md
+++ b/docs/zh-HK/docs/socket/biz_command.md
@@ -34,7 +34,7 @@ sidebar_position: 5
獲取標的經紀隊列 |
- | 獲取券商席位 id |
+ 獲取券商席位 ID |
| 獲取標的成交明細 |
@@ -43,7 +43,7 @@ sidebar_position: 5
獲取標的分時 |
- | 獲取標的 k 線 |
+ 獲取標的 K 線 |
| 獲取標的的期權鏈到期日列表 |
@@ -52,7 +52,7 @@ sidebar_position: 5
獲取標的的期權鏈到期日期權標的列表 |
- | 獲取輪證發行商 id |
+ 獲取輪證發行商 ID |
| 獲取輪證篩選列表 |
diff --git a/docs/zh-HK/docs/trade/trade-push.md b/docs/zh-HK/docs/trade/trade-push.md
index 889e58bb3..b1bc619e1 100644
--- a/docs/zh-HK/docs/trade/trade-push.md
+++ b/docs/zh-HK/docs/trade/trade-push.md
@@ -15,7 +15,7 @@ from decimal import Decimal
from longbridge.openapi import TradeContext, Config, OrderSide, OrderType, TimeInForceType, PushOrderChanged, TopicType, OAuthBuilder
def on_order_changed(event: PushOrderChanged):
-print(event)
+ print(event)
oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url))
config = Config.from_oauth(oauth)
diff --git a/docs/zh-HK/sdk.md b/docs/zh-HK/sdk.md
index 74f92967b..f5eea5b90 100644
--- a/docs/zh-HK/sdk.md
+++ b/docs/zh-HK/sdk.md
@@ -26,7 +26,7 @@ SDK 包名已從 `longport` 更名為 `longbridge`,舊包名 `longport` 已廢
### 安裝 SDK
-你可以通過 Pip 安裝 SDK,或者直接訪問 [PyPI](https://pypi.org/project/longbridge/) 頁面來下載。
+你可以通過 pip 安裝 SDK,或者直接訪問 [PyPI](https://pypi.org/project/longbridge/) 頁面來下載。
```bash
$ pip install longbridge