mzoe/ritmex-bot
1
0
Fork 0
mirror of https://github.com/discountry/ritmex-bot.git synced 2026-09-11 09:18:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

更新文档，添加和修改多个API接口的描述，确保文档内容的准确性和完整性，提升开发者使用体验。

Browse Source
This commit is contained in:
discountry
2025-09-27 02:10:28 +08:00
parent 2c62d2ed3e
commit 64640f4494
297 changed files with 33451 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/grvt/schemas/tpsl_order_metadata.md
+18
View File
@@ -0,0 +1,18 @@
!!! info "[TPSLOrderMetadata](/../../schemas/tpsl_order_metadata)"
Contains metadata for Take Profit (TP) and Stop Loss (SL) trigger orders.<br><br>### Fields:<br>- **triggerBy**: Defines the price type that activates the order (e.g., index price).<br>- **triggerPrice**: The price at which the order is triggered, expressed in `9` decimal precision.<br><br><br>
|Name<br>`Lite`|Type|Required<br>`Default`| Description |
|-|-|-|-|
|trigger_by<br>`tb` |TriggerBy|True|Defines the price type that activates a Take Profit (TP) or Stop Loss (SL) order|
|trigger_price<br>`tp` |string|True|The Trigger Price of the order, expressed in `9` decimals.|
|close_position<br>`cp` |boolean|True|If True, the order will close the position when the trigger price is reached|
??? info "[TriggerBy](/../../schemas/trigger_by)"
Defines the price type that activates a Take Profit (TP) or Stop Loss (SL) order.<br><br>Trigger orders are executed when the selected price type reaches the specified trigger price.Different price types ensure flexibility in executing strategies based on market conditions.<br><br><br>
|Value| Description |
|-|-|
|`UNSPECIFIED` = 0|no trigger condition|
|`INDEX` = 1|INDEX - Order is activated when the index price reaches the trigger price|
|`LAST` = 2|LAST - Order is activated when the last trade price reaches the trigger price|
|`MID` = 3|MID - Order is activated when the mid price reaches the trigger price|
|`MARK` = 4|MARK - Order is activated when the mark price reaches the trigger price|