@livefolio/sdk / Order

Type Alias: Order

Order = OpenOrder | CloseOrder | AdjustOrder | RebalanceOrder

Defined in: orders/types.ts:155

Discriminated union of all order types. Narrow on order.kind to access kind-specific fields.

Variants:

• 'open' — OpenOrder: opens a new long or short position.
• 'close' — CloseOrder: closes an existing position fully or partially.
• 'adjust' — AdjustOrder: mutates fields of an existing position.
• 'rebalance' — RebalanceOrder: delta-adjusts a long position; used by the rebalance engine.

Example

import type { Order } from '@livefolio/sdk';

function describe(order: Order): string {
  switch (order.kind) {
    case 'open':      return `open ${order.side} ${order.quantity} ${order.asset.symbol}`;
    case 'close':     return `close position ${order.positionId}`;
    case 'adjust':    return `adjust position ${order.positionId}`;
    case 'rebalance': return `rebalance ${order.asset.symbol} by ${order.delta}`;
  }
}