Skip to content

docs: add depth level params to attached order docs #1189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
shinexia wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: add depth level params to attached order docs #1189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/en/docs/trade/order/history_orders.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,8 @@ func main() {
"reviewed": false,
"activate_order_type": "MIT",
"activate_rth": "RTH_ONLY",
"submit_price": ""
"submit_price": "",
"limit_depth_level": 0
}
]
}
Expand Down Expand Up @@ -387,3 +388,4 @@ func main() {
| ∟∟ activate_order_type | string | true | Order type submitted after triggering, e.g. `LIT` (limit-if-touched) or `MIT` (market-if-touched) |
| ∟∟ activate_rth | string | true | Whether the order submitted after triggering allows pre/post market trading |
| ∟∟ submit_price | string | true | Submitted price |
| ∟∟ limit_depth_level | int32 | true | Specifies the bid/ask depth level |
4 changes: 3 additions & 1 deletion docs/en/docs/trade/order/order_detail.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -329,7 +329,8 @@ func main() {
"reviewed": false,
"activate_order_type": "MIT",
"activate_rth": "RTH_ONLY",
"submit_price": ""
"submit_price": "",
"limit_depth_level": 0
}
]
}
Expand Down Expand Up @@ -434,3 +435,4 @@ Order Information
| ∟∟ activate_order_type | string | true | Order type submitted after triggering, e.g. `LIT` (limit-if-touched) or `MIT` (market-if-touched) |
| ∟∟ activate_rth | string | true | Whether the order submitted after triggering allows pre/post market trading |
| ∟∟ submit_price | string | true | Submitted price |
| ∟∟ limit_depth_level | int32 | true | Specifies the bid/ask depth level |
2 changes: 2 additions & 0 deletions docs/en/docs/trade/order/replace.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ longbridge order replace 693664675163312128 --qty 200 --price 255.00
| attached_params.profit_taker_submit_price | string | NO | Take-profit limit order submitted price, required when `activate_order_type` is `LIT` |
| attached_params.stop_loss_submit_price | string | NO | Stop-loss limit order submitted price, required when `activate_order_type` is `LIT` |
| attached_params.activate_rth | string | NO | Whether the order submitted after triggering allows pre/post market trading<br/><br/>**Enum Value:**<br/> `RTH_ONLY` - Regular trading hours only<br/> `ANY_TIME` - Any time |
| attached_params.profit_taker_depth_level | int32 | NO | Specifies the bid/ask depth level for the take-profit limit order submitted price, valid when `activate_order_type` is `LIT` |
| attached_params.stop_loss_depth_level | int32 | NO | Specifies the bid/ask depth level for the stop-loss limit order submitted price, valid when `activate_order_type` is `LIT` |

### Request Example

Expand Down
2 changes: 2 additions & 0 deletions docs/en/docs/trade/order/submit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ longbridge order sell TSLA.US 100 --price 260.00
| attached_params.profit_taker_submit_price | string | NO | Take-profit limit order submitted price, required when `activate_order_type` is `LIT` |
| attached_params.stop_loss_submit_price | string | NO | Stop-loss limit order submitted price, required when `activate_order_type` is `LIT` |
| attached_params.activate_rth | string | NO | Whether the order submitted after triggering allows pre/post market trading <br/><br/>**Enum Value:**<br/> `RTH_ONLY` - Regular trading hours only<br/> `ANY_TIME` - Any time |
| attached_params.profit_taker_depth_level | int32 | NO | Specifies the bid/ask depth level for the take-profit limit order submitted price, valid when `activate_order_type` is `LIT` |
| attached_params.stop_loss_depth_level | int32 | NO | Specifies the bid/ask depth level for the stop-loss limit order submitted price, valid when `activate_order_type` is `LIT` |

### Idempotency

Expand Down
4 changes: 3 additions & 1 deletion docs/en/docs/trade/order/today_orders.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,8 @@ func main() {
"reviewed": false,
"activate_order_type": "MIT",
"activate_rth": "RTH_ONLY",
"submit_price": ""
"submit_price": "",
"limit_depth_level": 0
}
]
}
Expand Down Expand Up @@ -379,3 +380,4 @@ func main() {
| ∟∟ activate_order_type | string | true | Order type submitted after triggering, e.g. `LIT` (limit-if-touched) or `MIT` (market-if-touched) |
| ∟∟ activate_rth | string | true | Whether the order submitted after triggering allows pre/post market trading |
| ∟∟ submit_price | string | true | Submitted price |
| ∟∟ limit_depth_level | int32 | true | Specifies the bid/ask depth level |
4 changes: 3 additions & 1 deletion docs/zh-CN/docs/trade/order/history_orders.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,8 @@ func main() {
"reviewed": false,
"activate_order_type": "MIT",
"activate_rth": "RTH_ONLY",
"submit_price": ""
"submit_price": "",
"limit_depth_level": 0
}
]
}
Expand Down Expand Up @@ -386,3 +387,4 @@ func main() {
| ∟∟ activate_order_type | string | true | 触发后提交的订单类型，例如 `LIT`（限价单）或 `MIT`（市价单） |
| ∟∟ activate_rth | string | true | 触发后提交订单是否允许盘前盘后。|
| ∟∟ submit_price | string | true | 委托价格 |
| ∟∟ limit_depth_level | int32 | true | 指定买卖档位 |
4 changes: 3 additions & 1 deletion docs/zh-CN/docs/trade/order/order_detail.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,8 @@ func main() {
"reviewed": false,
"activate_order_type": "MIT",
"activate_rth": "RTH_ONLY",
"submit_price": ""
"submit_price": "",
"limit_depth_level": 0
}
]
}
Expand Down Expand Up @@ -433,3 +434,4 @@ func main() {
| ∟∟ activate_order_type | string | true | 触发后提交的订单类型，例如 `LIT`（限价单）或 `MIT`（市价单） |
| ∟∟ activate_rth | string | true | 触发后提交订单是否允许盘前盘后。 |
| ∟∟ submit_price | string | true | 委托价格 |
| ∟∟ limit_depth_level | int32 | true | 指定买卖档位 |
2 changes: 2 additions & 0 deletions docs/zh-CN/docs/trade/order/replace.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ longbridge order replace 693664675163312128 --qty 200 --price 255.00
| attached_params.profit_taker_submit_price | string | NO | 止盈限价委托价格，`activate_order_type` 为 `LIT` 时必填 |
| attached_params.stop_loss_submit_price | string | NO | 止损限价委托价格，`activate_order_type` 为 `LIT` 时必填 |
| attached_params.activate_rth | string | NO | 触发后提交的订单是否允许盘前盘后<br/><br/>**可选值：**<br/> `RTH_ONLY` - 不允许盘前盘后<br/> `ANY_TIME` - 允许盘前盘后 |
| attached_params.profit_taker_depth_level | int32 | NO | 止盈限价委托价格的买卖档位，`activate_order_type` 为 `LIT` 时有效 |
| attached_params.stop_loss_depth_level | int32 | NO | 止损限价委托价格的买卖档位，`activate_order_type` 为 `LIT` 时有效 |


### Request Example
Expand Down
3 changes: 3 additions & 0 deletions docs/zh-CN/docs/trade/order/submit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,9 @@ longbridge order sell TSLA.US 100 --price 260.00
| attached_params.profit_taker_submit_price | string | NO | 止盈限价委托价格，`activate_order_type` 为 `LIT` 时必填 |
| attached_params.stop_loss_submit_price | string | NO | 止损限价委托价格，`activate_order_type` 为 `LIT` 时必填 |
| attached_params.activate_rth | string | NO | 触发后提交的订单是否允许盘前盘后 <br/><br/>**可选值：**<br/> `RTH_ONLY` - 不允许盘前盘后<br/> `ANY_TIME` - 允许盘前盘后 |
| attached_params.profit_taker_depth_level | int32 | NO | 止盈限价委托价格的买卖档位，`activate_order_type` 为 `LIT` 时有效 |
| attached_params.stop_loss_depth_level | int32 | NO | 止损限价委托价格的买卖档位，`activate_order_type` 为 `LIT` 时有效 |


## 幂等性

Expand Down
4 changes: 3 additions & 1 deletion docs/zh-CN/docs/trade/order/today_orders.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,8 @@ func main() {
"reviewed": false,
"activate_order_type": "MIT",
"activate_rth": "RTH_ONLY",
"submit_price": ""
"submit_price": "",
"limit_depth_level": 0
}
]
}
Expand Down Expand Up @@ -378,3 +379,4 @@ func main() {
| ∟∟ activate_order_type | string | true | 触发后提交的订单类型，例如 `LIT`（限价单）或 `MIT`（市价单） |
| ∟∟ activate_rth | string | true | 触发后提交订单是否允许盘前盘后。|
| ∟∟ submit_price | string | true | 委托价格 |
| ∟∟ limit_depth_level | int32 | true | 指定买卖档位 |
4 changes: 3 additions & 1 deletion docs/zh-HK/docs/trade/order/history_orders.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,8 @@ func main() {
"reviewed": false,
"activate_order_type": "MIT",
"activate_rth": "RTH_ONLY",
"submit_price": ""
"submit_price": "",
"limit_depth_level": 0
}
]
}
Expand Down Expand Up @@ -386,3 +387,4 @@ func main() {
| ∟∟ activate_order_type | string | true | 觸發後提交的訂單類型，例如 `LIT`（限價單）或 `MIT`（市價單） |
| ∟∟ activate_rth | string | true | 觸發後提交訂單是否允許盤前盤後。|
| ∟∟ submit_price | string | true | 委託價格 |
| ∟∟ limit_depth_level | int32 | true | 指定買賣檔位 |
4 changes: 3 additions & 1 deletion docs/zh-HK/docs/trade/order/order_detail.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,8 @@ func main() {
"reviewed": false,
"activate_order_type": "MIT",
"activate_rth": "RTH_ONLY",
"submit_price": ""
"submit_price": "",
"limit_depth_level": 0
}
]
}
Expand Down Expand Up @@ -433,3 +434,4 @@ func main() {
| ∟∟ activate_order_type | string | true | 觸發後提交的訂單類型，例如 `LIT`（限價單）或 `MIT`（市價單） |
| ∟∟ activate_rth | string | true | 觸發後提交訂單是否允許盤前盤後。 |
| ∟∟ submit_price | string | true | 委託價格 |
| ∟∟ limit_depth_level | int32 | true | 指定買賣檔位 |
2 changes: 2 additions & 0 deletions docs/zh-HK/docs/trade/order/replace.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ longbridge order replace 693664675163312128 --qty 200 --price 255.00
| attached_params.profit_taker_submit_price | string | NO | 止盈限價委託價格，`activate_order_type` 為 `LIT` 時必填 |
| attached_params.stop_loss_submit_price | string | NO | 止損限價委託價格，`activate_order_type` 為 `LIT` 時必填 |
| attached_params.activate_rth | string | NO | 觸發後提交的訂單是否允許盤前盤後<br/><br/>**可選值：**<br/> `RTH_ONLY` - 不允許盤前盤後<br/> `ANY_TIME` - 允許盤前盤後 |
| attached_params.profit_taker_depth_level | int32 | NO | 止盈限價委託價格的買賣檔位，`activate_order_type` 為 `LIT` 時有效 |
| attached_params.stop_loss_depth_level | int32 | NO | 止損限價委託價格的買賣檔位，`activate_order_type` 為 `LIT` 時有效 |

### Request Example

Expand Down
2 changes: 2 additions & 0 deletions docs/zh-HK/docs/trade/order/submit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ longbridge order sell TSLA.US 100 --price 260.00
| attached_params.profit_taker_submit_price | string | NO | 止盈限價委託價格，`activate_order_type` 為 `LIT` 時必填 |
| attached_params.stop_loss_submit_price | string | NO | 止損限價委託價格，`activate_order_type` 為 `LIT` 時必填 |
| attached_params.activate_rth | string | NO | 觸發後提交的訂單是否允許盤前盤後 <br/><br/>**可選值：**<br/> `RTH_ONLY` - 不允許盤前盤後<br/> `ANY_TIME` - 允許盤前盤後 |
| attached_params.profit_taker_depth_level | int32 | NO | 止盈限價委託價格的買賣檔位，`activate_order_type` 為 `LIT` 時有效 |
| attached_params.stop_loss_depth_level | int32 | NO | 止損限價委託價格的買賣檔位，`activate_order_type` 為 `LIT` 時有效 |

### 冪等性

Expand Down
4 changes: 3 additions & 1 deletion docs/zh-HK/docs/trade/order/today_orders.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,8 @@ func main() {
"reviewed": false,
"activate_order_type": "MIT",
"activate_rth": "RTH_ONLY",
"submit_price": ""
"submit_price": "",
"limit_depth_level": 0
}
]
}
Expand Down Expand Up @@ -378,3 +379,4 @@ func main() {
| ∟∟ activate_order_type | string | true | 觸發後提交的訂單類型，例如 `LIT`（限價單）或 `MIT`（市價單） |
| ∟∟ activate_rth | string | true | 觸發後提交訂單是否允許盤前盤後。|
| ∟∟ submit_price | string | true | 委託價格 |
| ∟∟ limit_depth_level | int32 | true | 指定買賣檔位 |
Loading