Skip to content

Add submit parameters: limit_depth_level, trigger_count, monitor_price #337

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

Merged
sunli829 merged 1 commit into from
Jan 14, 2026
Merged

Add submit parameters: limit_depth_level, trigger_count, monitor_price #337

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
8 changes: 7 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 @@ -95,7 +95,10 @@ print(resp)
"trigger_price": "",
"trigger_status": "NOT_USED",
"updated_at": "1651644898",
"remark": ""
"remark": "",
"limit_depth_level": 0,
"monitor_price": "",
"trigger_count": 1
}
]
}
Expand Down Expand Up @@ -149,3 +152,6 @@ print(resp)
| ∟ currency | string | true | Currency |
| ∟ outside_rth | string | true | Enable or disable outside regular trading hours<br/> Default is `UnknownOutsideRth` when the order is not a US stock<br/><br/> **Enum Value:**<br/> `RTH_ONLY` - Regular trading hour only<br/> `ANY_TIME` - Any time<br/> `OVERNIGHT` - Overnight" |
| ∟ remark | string | true | Remark |
| ∟ limit_depth_level | int32 | true | Specifies the bid/ask depth level |
| ∟ monitor_price | string | true | Monitoring price |
| ∟ trigger_count | int32 | true | Number of triggers |
6 changes: 6 additions & 0 deletions 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 @@ -79,6 +79,9 @@ print(resp)
"trailing_amount": "",
"trailing_percent": "",
"limit_offset": "",
"limit_depth_level": 0,
"monitor_price": "",
"trigger_count": 1,
"trigger_status": "NOT_USED",
"outside_rth": "ANY_TIME",
"currency": "USD",
Expand Down Expand Up @@ -201,3 +204,6 @@ Order Information
| ∟∟∟ name | string | true | Charge name |
| ∟∟∟ amount | string | true | Charge amount |
| ∟∟∟ currency | string | true | Charge currency |
| ∟∟∟ limit_depth_level | int32 | true | Specifies the bid/ask depth level |
| ∟∟∟ monitor_price | string | true | Monitoring price |
| ∟∟∟ trigger_count | int32 | true | Number of triggers |
5 changes: 4 additions & 1 deletion docs/en/docs/trade/order/replace.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,13 @@ This API is used to replace order, modify quantity or price.
| quantity | string | YES | Replaced quantity, example: `100` |
| price | string | NO | Replaced price, example: `388.5`<br/><br/> `LO` / `ELO` / `ALO` / `ODD` / `LIT` Order Required |
| trigger_price | string | NO | Trigger price, example: `388.5`<br/><br/> `LIT` / `MIT` Order Required |
| limit_offset | string | NO | Limit offset amount<br/><br/> `TSLPAMT` / `TSLPPCT` Order Required |
| limit_offset | string | NO | Limit offset amount<br/><br/> `TSLPAMT` / `TSLPPCT` Order Required when`limit_depth_level` is set to 0 |
| trailing_amount | string | NO | Trailing amount<br/><br/> `TSLPAMT` Order Required |
| trailing_percent | string | NO | Trailing percent<br/><br/> `TSLPPCT` Order Required |
| remark | string | NO | Remark (Maximum 64 characters) |
| limit_depth_level | int32 | NO | Specifies the bid/ask depth level. `TSLPAMT` / `TSLPPCT` Order Required |
| monitor_price | string | NO | Monitoring price. `TSLPAMT` / `TSLPPCT` Order Required |
| trigger_count | int32 | NO | Number of triggers. `LIT` / `MIT` / `TSLPAMT` / `TSLPPCT` Order Required |

### Request Example

Expand Down
5 changes: 4 additions & 1 deletion docs/en/docs/trade/order/submit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,17 @@ This API is used to submit order for HK and US stocks, warrant and option.
| submitted_price | string | NO | Submitted price, example: `388.5`<br/><br/> `LO` / `ELO` / `ALO` / `ODD` / `LIT` Order Required |
| submitted_quantity | string | YES | Submitted quantity, example: `100` |
| trigger_price | string | NO | Trigger price, example: `388.5`<br/><br/> `LIT` / `MIT` Order Required |
| limit_offset | string | NO | Limit offset amount<br/><br/> `TSLPAMT` / `TSLPPCT` Order Required |
| limit_offset | string | NO | Limit offset amount<br/><br/> `TSLPAMT` / `TSLPPCT` Order Required when`limit_depth_level` is set to 0 |
| trailing_amount | string | NO | Trailing amount<br/><br/> `TSLPAMT` Order Required |
| trailing_percent | string | NO | Trailing percent<br/><br/> `TSLPPCT` Order Required |
| expire_date | string | NO | Long term order expire date, format `YYYY-MM-DD`, example: `2022-12-05`<br/><br/> Required when `time_in_force` is `GTD` |
| side | string | YES | Order Side<br/><br/> **Enum Value:**<br/> `Buy`<br/> `Sell` |
| outside_rth | string | NO | Enable or disable outside regular trading hours<br/><br/> **Enum Value:**<br/> `RTH_ONLY` - regular trading hour only<br/> `ANY_TIME` - any time<br/> `OVERNIGHT` - Overnight |
| time_in_force | string | YES | Time in force Type<br/><br/> **Enum Value:**<br/> `Day` - Day Order<br/> `GTC` - Good Til Canceled Order<br/> `GTD` - Good Til Date Order |
| remark | string | NO | remark (Maximum 255 characters) |
| limit_depth_level | int32 | NO | Specifies the bid/ask depth level. Value range is -5 ~ 0 ~ 5. <br/>Negative numbers indicate bid levels (e.g., -1 means best bid level 1),<br/>positive numbers indicate ask levels (e.g., 1 means best ask level 1).<br/>When set to 0, the `limit_offset` parameter takes effect.<br/>Valid for `TSLPAMT` / `TSLPPCT` orders. |
| monitor_price | string | NO | Monitoring price. <br/>Monitoring starts only after reaching this price, updating the reference price.<br/>Valid for `TSLPAMT` / `TSLPPCT` orders. |
| trigger_count | int32 | NO | Number of triggers. Value range is 0 ~ 3.<br/>Specifies that within 1 minute, the order will only be placed after being triggered multiple times.<br/>Valid for `LIT` / `MIT` / `TSLPAMT` / `TSLPPCT` orders. |

### Request Example

Expand Down
3 changes: 3 additions & 0 deletions 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 @@ -144,3 +144,6 @@ print(resp)
| ∟ currency | string | true | Currency |
| ∟ outside_rth | string | true | Enable or disable outside regular trading hours<br/> Default is `UnknownOutsideRth` when the order is not a US stock<br/><br/> **Enum Value:**<br/> `RTH_ONLY` - Regular trading hour only<br/> `ANY_TIME` - Any time<br/> `OVERNIGHT` - Overnight" |
| ∟ remark | string | true | Remark |
| ∟ limit_depth_level | int32 | true | Specifies the bid/ask depth level |
| ∟ monitor_price | string | true | Monitoring price |
| ∟ trigger_count | int32 | true | Number of triggers |
8 changes: 7 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 @@ -95,7 +95,10 @@ print(resp)
"trigger_price": "",
"trigger_status": "NOT_USED",
"updated_at": "1651644898",
"remark": ""
"remark": "",
"limit_depth_level": 0,
"monitor_price": "",
"trigger_count": 1
}
]
}
Expand Down Expand Up @@ -149,3 +152,6 @@ print(resp)
| ∟ currency | string | true | 结算货币 |
| ∟ outside_rth | string | true | 是否允许盘前盘后<br/> 当订单不是美股时，默认为 UnknownOutsideRth<br/><br/> **可选值：**<br/> `RTH_ONLY` - 不允许盘前盘后<br/> `ANY_TIME` - 允许盘前盘后<br/> `OVERNIGHT` - 夜盘" |
| ∟ remark | string | true | 备注 |
| ∟ limit_depth_level | int32 | true | 指定买卖档位 |
| ∟ monitor_price | string | true | 监控价格 |
| ∟ trigger_count | int32 | true | 触发次数 |
6 changes: 6 additions & 0 deletions 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 @@ -79,6 +79,9 @@ print(resp)
"trailing_amount": "",
"trailing_percent": "",
"limit_offset": "",
"limit_depth_level": 0,
"monitor_price": "",
"trigger_count": 1,
"trigger_status": "NOT_USED",
"outside_rth": "ANY_TIME",
"currency": "USD",
Expand Down Expand Up @@ -201,3 +204,6 @@ print(resp)
| ∟∟∟ name | string | true | 收费名称 |
| ∟∟∟ amount | string | true | 单项收费金额 |
| ∟∟∟ currency | string | true | 收费货币 |
| ∟∟∟ limit_depth_level | int32 | true | 指定买卖档位 |
| ∟∟∟ monitor_price | string | true | 监控价格 |
| ∟∟∟ trigger_count | int32 | true | 触发次数 |
6 changes: 5 additions & 1 deletion 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 @@ -32,10 +32,14 @@ headingLevel: 2
| quantity | string | YES | 改单数量，例如：`200` |
| price | string | NO | 改单价格，例如：`388.5`<br/><br/> `LO` / `ELO` / `ALO` / `ODD` / `LIT` 订单必填 |
| trigger_price | string | NO | 触发价格，例如：`388.5`<br/><br/> `LIT` / `MIT` 订单必填 |
| limit_offset | string | NO | 指定价差<br/><br/> `TSLPAMT` / `TSLPPCT` 订单必填 |
| limit_offset | string | NO | 指定价差<br/><br/> `TSLPAMT` / `TSLPPCT` 订单在 `limit_depth_level` 为 0 时必填 |
| trailing_amount | string | NO | 跟踪金额<br/><br/> `TSLPAMT` 订单必填 |
| trailing_percent | string | NO | 跟踪涨跌幅<br/><br/> `TSLPPCT` 订单必填 |
| remark | string | NO | 备注 (最大 64 字符) |
| limit_depth_level | int32 | NO | 指定买卖档位，`TSLPAMT` / `TSLPPCT` 订单必填 |
| monitor_price | string| NO | 监控价格，`TSLPAMT` / `TSLPPCT` 订单必填 |
| trigger_count | int32 | NO | 触发次数，`LIT` / `MIT` / `TSLPAMT` / `TSLPPCT` 订单必填 |


### Request Example

Expand Down
5 changes: 4 additions & 1 deletion 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 @@ -29,14 +29,17 @@ headingLevel: 3
| submitted_price | string | NO | 下单价格，例如：`388.5`<br/><br/> `LO` / `ELO` / `ALO` / `ODD` / `LIT` 订单必填 |
| submitted_quantity | string | YES | 下单数量，例如：`100` |
| trigger_price | string | NO | 触发价格，例如：`388.5`<br/><br/> `LIT` / `MIT` 订单必填 |
| limit_offset | string | NO | 指定价差，例如 "1.2" 表示价差 1.2 USD (如果是美股)<br/><br/> `TSLPAMT` / `TSLPPCT` 订单必填 |
| limit_offset | string | NO | 指定价差，例如 "1.2" 表示价差 1.2 USD (如果是美股)<br/><br/> `TSLPAMT` / `TSLPPCT` 订单在 `limit_depth_level` 为 0 时必填 |
| trailing_amount | string | NO | 跟踪金额<br/><br/> `TSLPAMT` 订单必填 |
| trailing_percent | string | NO | 跟踪涨跌幅，单位为百分比，例如 "2.5" 表示 "2.5%"<br/><br/> `TSLPPCT` 订单必填 |
| expire_date | string | NO | 长期单过期时间，格式为 `YYYY-MM-DD`, 例如：`2022-12-05`<br/><br/> time_in_force 为 `GTD` 时必填 |
| side | string | YES | 买卖方向<br/><br/> **可选值：**<br/> `Buy` - 买入<br/> `Sell` - 卖出 |
| outside_rth | string | NO | 是否允许盘前盘后，美股必填<br/><br/> **可选值：**<br/> `RTH_ONLY` - 不允许盘前盘后<br/> `ANY_TIME` - 允许盘前盘后<br/> `OVERNIGHT` - 夜盘 |
| time_in_force | string | YES | 订单有效期类型<br/><br/> **可选值：**<br/> `Day` - 当日有效<br/> `GTC` - 撤单前有效<br/> `GTD` - 到期前有效 |
| remark | string | NO | 备注 (最大 64 字符) |
| limit_depth_level | int32 | NO | 指定买卖档位，取值范围为 -5 ～ 0 ～ 5，负数代表买盘档位（如 -1 表示买一），<br/>正数代表卖盘档位（如 1 表示卖一），为 0 时 limit_offset 参数生效<br/>`TSLPAMT` / `TSLPPCT` 订单有效 |
| monitor_price | string | NO | 监控价格，需要达到该价格才会开始监控，更新参考价<br/>`TSLPAMT` / `TSLPPCT` 订单有效 |
| trigger_count | int32 | NO | 触发次数，取值范围 0 ~ 3, 表示在 1 分钟内触发多次才会触发订单<br/>`LIT` / `MIT` / `TSLPAMT` / `TSLPPCT` 订单有效 |

## Examples

Expand Down
8 changes: 7 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 @@ -91,7 +91,10 @@ print(resp)
"trigger_price": "",
"trigger_status": "NOT_USED",
"updated_at": "1651644898",
"remark": ""
"remark": "",
"limit_depth_level": 0,
"monitor_price": "",
"trigger_count": 1
}
]
}
Expand Down Expand Up @@ -144,3 +147,6 @@ print(resp)
| ∟ currency | string | true | 结算货币 |
| ∟ outside_rth | string | true | 是否允许盘前盘后<br/> 当订单不是美股时，默认为 UnknownOutsideRth<br/><br/> **可选值：**<br/> `RTH_ONLY` - 不允许盘前盘后<br/> `ANY_TIME` - 允许盘前盘后<br/> `OVERNIGHT` - 夜盘" |
| ∟ remark | string | true | 备注 |
| ∟ limit_depth_level | int32 | true | 指定买卖档位 |
| ∟ trigger_count | int32 | true | 触发次数 |
| ∟ monitor_price | string | true | 监控价格 |
8 changes: 7 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 @@ -95,7 +95,10 @@ print(resp)
"trigger_price": "",
"trigger_status": "NOT_USED",
"updated_at": "1651644898",
"remark": ""
"remark": "",
"limit_depth_level": 0,
"monitor_price": "",
"trigger_count": 1
}
]
}
Expand Down Expand Up @@ -149,3 +152,6 @@ print(resp)
| ∟ currency | string | true | 結算貨幣 |
| ∟ outside_rth | string | true | 是否允許盤前盤後<br/> 當訂單不是美股時，默認為 UnknownOutsideRth<br/><br/> **可選值：**<br/> `RTH_ONLY` - 不允許盤前盤後<br/> `ANY_TIME` - 允許盤前盤後<br/> `OVERNIGHT` - 夜盤 |
| ∟ remark | string | true | 備註 |
| ∟ limit_depth_level | int32 | true | 指定買賣檔位 |
| ∟ monitor_price | string | true | 監控價格 |
| ∟ trigger_count | int32 | true | 觸發次數 |
Loading