Derivatives Order Management — DerivativesClient Reference

import { DerivativesClient } from '@siebly/kraken-api';

const client = new DerivativesClient({
  apiKey: process.env.API_FUTURES_KEY,
  apiSecret: process.env.API_FUTURES_SECRET,
});

const response = await client.editOrder({
  orderId: 'a04d0f84-36d4-4499-8382-96fcfc3ce7aa',
  limitPrice: 1850,
  size: 0.02,
});

console.log('Edit status:', response.editStatus.status);
console.log('Events:', response.editStatus.orderEvents);

// Cancel by exchange order ID
const response = await client.cancelOrder({
  order_id: 'a04d0f84-36d4-4499-8382-96fcfc3ce7aa',
});
console.log('Cancel status:', response.cancelStatus.status);

// Cancel by client order ID
const response2 = await client.cancelOrder({
  cliOrdId: 'my-order-id-abc123',
});

// Cancel all open orders
const response = await client.cancelAllOrders();
console.log('Status:', response.cancelStatus.status);
console.log('Cancelled:', response.cancelStatus.cancelledOrders.length, 'orders');

// Cancel all orders for a specific symbol
const symbolResponse = await client.cancelAllOrders({ symbol: 'PF_ETHUSD' });

// Activate: cancel all orders in 60 seconds unless reset
const response = await client.cancelAllOrdersAfter({ timeout: 60 });
console.log('Will cancel at:', response.status.triggerTime);

// Keep alive — reset the timer every 15 seconds
setInterval(async () => {
  await client.cancelAllOrdersAfter({ timeout: 60 });
}, 15_000);

// Deactivate the switch
await client.cancelAllOrdersAfter({ timeout: 0 });

// Transfer 1 BTC from flex to fi_xbtusd margin account
await client.submitWalletTransfer({
  fromAccount: 'flex',
  toAccount: 'fi_xbtusd',
  unit: 'BTC',
  amount: 1,
});

const response = await client.submitTransferToSpot({
  currency: 'USDT',
  amount: '500',
  sourceWallet: 'cash',
});

console.log('Withdrawal UID:', response.uid);

await client.submitSubaccountTransfer({
  fromUser: 'master-uid',
  toUser: 'subaccount-uid',
  fromAccount: 'cash',
  toAccount: 'cash',
  unit: 'USDT',
  amount: '1000',
});

const response = await client.getOpenRFQs();

for (const rfq of response.rfqs) {
  console.log(rfq.rfqUid, 'expires:', rfq.expiry, 'mark price:', rfq.markPrice);
  for (const leg of rfq.legs) {
    console.log('  Leg:', leg.symbol, leg.size, '@', leg.markPrice);
  }
}

const response = await client.getOpenRFQ({ rfqUid: 'rfq-uid-here' });
console.log(response.rfq);

const response = await client.getRFQOpenOffers();

for (const offer of response.openOffers) {
  console.log(offer.uid, 'on RFQ', offer.rfqUid);
  console.log('  Bid:', offer.bid, '| Ask:', offer.ask);
}

const response = await client.submitRFQNewOffer({
  rfqUid: 'rfq-uid-here',
  bid: 42100,
  ask: 42200,
});
console.log('Offer UID:', response.offerUid);

await client.updateRFQOpenOffer({
  rfqUid: 'rfq-uid-here',
  bid: 42050,
  ask: 42150,
});

await client.cancelRFQOffer({ rfqUid: 'rfq-uid-here' });

const response = await client.getAssignmentPrograms();

for (const program of response.participants) {
  console.log(program.id, program.contractType, program.enabled);
}

const response = await client.addAssignmentPreference({
  contractType: 'futures_vanilla',
  acceptLong: true,
  acceptShort: false,
  timeFrame: 'weekdays',
  enabled: true,
  maxSize: 10,
  maxPosition: 50,
});

console.log('Created preference ID:', response.id);

await client.deleteAssignmentPreference({ id: 42 });

const response = await client.getAssignmentPreferencesHistory();

for (const entry of response.participants) {
  console.log(entry.timestamp, entry.contractType, entry.enabled, entry.deleted);
}

const orderId = client.generateNewOrderID();
// e.g. "V1StGXR8_Z5jdHi6B-myT1234abcdef"

const order = await client.submitOrder({
  orderType: 'lmt',
  symbol: 'PF_ETHUSD',
  side: 'buy',
  size: 0.01,
  limitPrice: 1800,
  cliOrdId: orderId, // Use the generated ID
});

import { DerivativesClient } from '@siebly/kraken-api';

const client = new DerivativesClient({
  apiKey: process.env.API_FUTURES_KEY,
  apiSecret: process.env.API_FUTURES_SECRET,
});

async function orderLifecycle() {
  const cliOrdId = client.generateNewOrderID();

  // 1. Place a limit order
  console.log('Placing limit order...');
  const submitResult = await client.submitOrder({
    orderType: 'lmt',
    symbol: 'PF_ETHUSD',
    side: 'buy',
    size: 0.01,
    limitPrice: 1500,
    cliOrdId,
  });

  if (submitResult.sendStatus.status !== 'placed') {
    console.error('Order not placed:', submitResult.sendStatus.status);
    return;
  }

  const orderId = submitResult.sendStatus.order_id!;
  console.log('Order placed:', orderId);

  // 2. Check order status
  const statusResult = await client.getOrderStatus({ orderIds: [orderId] });
  console.log('Order status:', statusResult.orders[0]?.status);

  // 3. Edit the order price
  console.log('Editing order...');
  const editResult = await client.editOrder({
    orderId,
    limitPrice: 1520,
  });
  console.log('Edit status:', editResult.editStatus.status);

  // 4. View all open orders
  const openOrders = await client.getOpenOrders();
  console.log('Open orders:', openOrders.openOrders.length);

  // 5. Cancel the order
  console.log('Cancelling order...');
  const cancelResult = await client.cancelOrder({ order_id: orderId });
  console.log('Cancel status:', cancelResult.cancelStatus.status);

  // 6. Verify it's gone
  const fills = await client.getFills();
  const myFill = fills.fills.find((f) => f.order_id === orderId);
  if (myFill) {
    console.log('Order was partially filled before cancel:', myFill);
  } else {
    console.log('Order fully cancelled, no fills recorded.');
  }
}

orderLifecycle().catch(console.error);