mirror of
https://github.com/discountry/ritmex-bot.git
synced 2026-09-09 16:28:06 +00:00
34 lines
2.9 KiB
Markdown
34 lines
2.9 KiB
Markdown
!!! info "[TriggerOrderMetadata](/../../schemas/trigger_order_metadata)"
|
|
Contains metadata related to trigger orders, such as Take Profit (TP) or Stop Loss (SL).<br><br>Trigger orders are used to automatically execute an order when a predefined price condition is met, allowing traders to implement risk management strategies.<br><br><br>
|
|
|
|
|Name<br>`Lite`|Type|Required<br>`Default`| Description |
|
|
|-|-|-|-|
|
|
|trigger_type<br>`tt` |TriggerType|True|Type of the trigger order. eg: Take Profit, Stop Loss, etc|
|
|
|tpsl<br>`t` |TPSLOrderMetadata|True|Contains metadata for Take Profit (TP) and Stop Loss (SL) trigger orders.<br><br>|
|
|
??? info "[TriggerType](/../../schemas/trigger_type)"
|
|
Defines the type of trigger order used in trading, such as Take Profit or Stop Loss.<br><br>Trigger orders allow execution based on pre-defined price conditions rather than immediate market conditions.<br><br><br>
|
|
|
|
|Value| Description |
|
|
|-|-|
|
|
|`UNSPECIFIED` = 0|Not a trigger order. The order executes normally without any trigger conditions.|
|
|
|`TAKE_PROFIT` = 1|Take Profit Order - Executes when the price reaches a specified level to secure profits.|
|
|
|`STOP_LOSS` = 2|Stop Loss Order - Executes when the price reaches a specified level to limit losses.|
|
|
??? 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|
|