Derivatives Account — DerivativesClient Reference

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

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

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.getAccounts();
const { accounts } = response;

// Cash account balances
console.log(accounts.cash?.balances);

// Multi-collateral flex account
const flex = accounts.flex;
if (flex) {
  console.log('Available margin:', flex.available);
  console.log('Portfolio value:', flex.portfolioValue);
  console.log('Maintenance margin:', flex.maintenanceMargin);
  console.log('PnL:', flex.pnl);
}

const keyInfo = await client.checkApiKeyV3();

console.log('Account UID:', keyInfo.accountUid);
console.log('General access:', keyInfo.permissions.general);   // "NO_ACCESS" | "READ_ONLY" | "FULL_ACCESS"
console.log('Transfer access:', keyInfo.permissions.transfer);
console.log('Allowed CIDR:', keyInfo.allowedCidrBlock);

const response = await client.getNotifications();

for (const notification of response.notifications) {
  console.log(`[${notification.priority.toUpperCase()}] ${notification.type}: ${notification.note}`);
}

const marketShare = await client.getAccountMarketShare();

for (const [symbol, data] of Object.entries(marketShare.contracts)) {
  console.log(symbol, data.marketShare, data.volume, data.usdRebateCredited);
}

const csv = await client.getAccountLogCsv({ conversion_details: true });

// Write to file, parse with a CSV library, etc.
require('fs').writeFileSync('account-log.csv', csv);

const response = await client.getOpenPositions();

for (const position of response.openPositions) {
  console.log(
    position.symbol,
    position.side,
    position.size,
    '@',
    position.price,
  );
}

const response = await client.getPositionPercentile();

for (const entry of response.queue) {
  console.log(entry.symbol, `${entry.percentile}th percentile in unwind queue`);
}

const response = await client.getPositionEvents({
  tradeable: 'PF_ETHUSD',
  opened: true,
  closed: true,
  count: 50,
  sort: 'desc',
});

for (const element of response.elements) {
  const event = element.event as FuturesPositionUpdateEvent;
  console.log(event.positionChange, event.tradeable, event.newPosition);
}

const response = await client.getExecutionEvents({
  tradeable: 'PF_ETHUSD',
  count: 50,
  sort: 'desc',
});

console.log(`${response.len} events returned`);
for (const element of response.elements) {
  console.log(element.uid, element.timestamp, element.event);
}

// Paginate
if (response.continuationToken) {
  const next = await client.getExecutionEvents({
    continuation_token: response.continuationToken,
  });
}

const response = await client.getOpenOrders();

for (const order of response.openOrders) {
  console.log(order.order_id, order.symbol, order.side, order.orderType);
  console.log('  Limit:', order.limitPrice, '| Filled:', order.filledSize);
}

const response = await client.getOrderStatus({
  orderIds: ['a04d0f84-36d4-4499-8382-96fcfc3ce7aa'],
});

for (const orderInfo of response.orders) {
  console.log(orderInfo.order.orderId, orderInfo.status, orderInfo.updateReason);
}

// Get the 50 most recent order events, newest first
const response = await client.getOrderEvents({
  count: 50,
  sort: 'desc',
  opened: true,
  closed: true,
});

// Filter by symbol
const ethEvents = await client.getOrderEvents({
  tradeable: 'PF_ETHUSD',
  count: 50,
});

const response = await client.getTriggerEvents({
  count: 50,
  sort: 'desc',
});

const response = await client.getLeverageSettings();

for (const pref of response.leveragePreferences) {
  console.log(pref.symbol, 'max leverage:', pref.maxLeverage);
}

// Set 10x isolated margin on PF_ETHUSD
await client.setLeverageSettings({
  symbol: 'PF_ETHUSD',
  maxLeverage: 10,
});

// Switch to cross margin
await client.setLeverageSettings({
  symbol: 'PF_ETHUSD',
});

const response = await client.getPnlPreferences();

for (const pref of response.preferences) {
  console.log(pref.symbol, 'PnL currency:', pref.pnlCurrency);
}

await client.setPnlPreference({
  symbol: 'PF_BTCUSD',
  pnlPreference: 'USDT',
});

const response = await client.getSelfTradeStrategy();
console.log(response.strategy);
// "REJECT_TAKER" | "CANCEL_MAKER_SELF" | "CANCEL_MAKER_CHILD" | "CANCEL_MAKER_ANY"

const response = await client.updateSelfTradeStrategy({
  strategy: 'CANCEL_MAKER_SELF',
});
console.log('Updated strategy:', response.strategy);

const info = await client.getSubaccounts();

console.log('Master UID:', info.masterAccountUid);
for (const sub of info.subaccounts) {
  console.log(sub.accountUid, sub.email);
  console.log('  Flex margin equity:', sub.flexAccount.marginEquity);
}

const status = await client.getSubaccountTradingStatus({
  subaccountUid: '6e5378ff-31ce-44e8-929f-23f822aa5673',
});
console.log('Trading enabled:', status.tradingEnabled);

// Enable trading for a subaccount
await client.updateSubaccountTradingStatus({
  subaccountUid: '6e5378ff-31ce-44e8-929f-23f822aa5673',
  tradingEnabled: true,
});

// Disable trading
await client.updateSubaccountTradingStatus({
  subaccountUid: '6e5378ff-31ce-44e8-929f-23f822aa5673',
  tradingEnabled: false,
});