Trigger Orders

Attach take profit and stop loss to orders, or place standalone trigger orders

Attach trigger orders to any order, or place standalone TP/SL on existing positions. The registered provider plugin authorizes both flows with its SDK-managed credential; the user’s wallet is not prompted.

The examples on this page use Hyperliquid (provider: 'hyperliquid'). Replace the provider value with any supported provider from getProviders().

Take Profit & Stop Loss

Attach trigger orders to any order using the takeProfit and stopLoss fields on placeOrder:

import { OrderSide, OrderType } from '@lifi/perps-sdk';

await perps.placeOrder({
  provider: 'hyperliquid',
  address: userAddress,
  market: { marketId: 'BTC', categoryId: 'hyperliquid' },
  side: OrderSide.BUY,
  type: OrderType.MARKET,
  size: '0.1',
  price: '95500.00',
  leverage: 10,
  takeProfit: {
    triggerPrice: '100000.00',          // Triggers when the price moves above 100000
  },
  stopLoss: {
    triggerPrice: '90000.00',           // Triggers when the price moves below 90000
    limitPrice: '89800.00',             // Executes as limit order at 89800
  },
});

This produces multiple actions:

#	Action	Description
1	updateLeverage	Set leverage to 10 (always prepended when leverage is provided)
2	placeOrder	BUY 0.1 BTC @ 95500.00 | TP @ 100000.00 | SL @ 90000.00 (limit @ 89800.00)

Trigger wires are bundled into the placeOrder action. The placeTriggerOrder action type only appears for standalone trigger orders (via placeTriggerOrder()).

If limitPrice is omitted, the trigger executes as a market order.

Bundled legs always cover the whole order; size is rejected on Hyperliquid, Lighter and Ondo. Ondo legs accept triggerPrice only. Spot markets reject TP/SL on Hyperliquid and Lighter. For a partial-size trigger, use placeTriggerOrder.

Trigger order types

Trigger orders are read back as Orders (see getOrders) whose type is one of four OrderType members, with a triggerPrice, a triggerCondition and an optional limitPrice:

OrderType	Description
TAKE_PROFIT_MARKET	Take profit that executes as a market order
TAKE_PROFIT_LIMIT	Take profit that executes as a limit order at limitPrice
STOP_MARKET	Stop loss that executes as a market order
STOP_LIMIT	Stop loss that executes as a limit order at limitPrice

TriggerCondition	Description
ABOVE	Triggers when the price moves above triggerPrice
BELOW	Triggers when the price moves below triggerPrice

The lifecycle is OrderStatus: an armed trigger is OPEN, TRIGGERED means the trigger price was hit and the order went live, and CANCELLED is terminal. See Order Status.

Narrow the Order union with isTriggerOrder, isTakeProfitOrder, isStopLossOrder and isTpSlOrder. triggerConditionFor(type, side) derives the condition from the trigger type and execution side.

Standalone Trigger Orders

Place standalone TP/SL orders on existing positions, separate from a main order, via placeTriggerOrder:

import { OrderSide } from '@lifi/perps-sdk';

const result = await perps.placeTriggerOrder({
  provider: 'hyperliquid',
  address: userAddress,
  market: { marketId: 'BTC', categoryId: 'hyperliquid' },
  side: OrderSide.SELL,    // SELL to close a LONG position
  takeProfit: {
    triggerPrice: '100000.00',
    size: '0.025', // Optional fixed partial close; omit to track the full position
  },
  stopLoss: { triggerPrice: '90000.00', limitPrice: '89800.00' },
});

size is optional per leg: omit it to track the full position, or set a base-asset decimal string for a fixed partial-position trigger.

placeTriggerOrder() sends a placeTriggerOrder action type, which creates standalone trigger orders on existing positions. A venue rejection does not throw; check success on each entry of result.results. See Error Handling.

API Reference: POST /createAction · /executeAction