PortfolioClient REST API Method Reference

import { PortfolioClient } from 'binance';

const client = new PortfolioClient({
  api_key: process.env.BINANCE_API_KEY,
  api_secret: process.env.BINANCE_API_SECRET,
});

import { PortfolioClient } from 'binance';

const client = new PortfolioClient({
  api_key: process.env.BINANCE_API_KEY,
  api_secret: process.env.BINANCE_API_SECRET,
});

// Place a UM LIMIT order
const order = await client.submitNewUMOrder({
  symbol: 'BTCUSDT',
  side: 'BUY',
  type: 'LIMIT',
  timeInForce: 'GTC',
  quantity: '0.01',
  price: '50000',
});
console.log('UM Order ID:', order.orderId);

// Cancel it
await client.cancelUMOrder({
  symbol: 'BTCUSDT',
  orderId: order.orderId,
});

import { PortfolioClient } from 'binance';

const client = new PortfolioClient({
  api_key: process.env.BINANCE_API_KEY,
  api_secret: process.env.BINANCE_API_SECRET,
});

async function main() {
  // --- Account overview ---
  const account = await client.getAccountInfo();
  console.log('uniMMR:', account.uniMMR); // Unified Maintenance Margin Ratio

  const balances = await client.getBalance();
  console.log('Account balances:', balances.length, 'assets');

  // --- UM positions ---
  const umPositions = await client.getUMPosition({ symbol: 'BTCUSDT' });
  console.log('BTC UM position:', umPositions[0]?.positionAmt);

  // --- Set leverage ---
  await client.updateUMLeverage({ symbol: 'BTCUSDT', leverage: 10 });

  // --- Place a UM order ---
  const order = await client.submitNewUMOrder({
    symbol: 'BTCUSDT',
    side: 'BUY',
    type: 'MARKET',
    quantity: '0.001',
  });
  console.log('UM Order status:', order.status);

  // --- Place a Margin order ---
  const marginOrder = await client.submitNewMarginOrder({
    symbol: 'ETHUSDT',
    side: 'BUY',
    type: 'LIMIT',
    timeInForce: 'GTC',
    quantity: '0.1',
    price: '2000',
  });
  console.log('Margin Order ID:', marginOrder.orderId);

  // --- UM income ---
  const income = await client.getUMIncomeHistory({
    symbol: 'BTCUSDT',
    incomeType: 'REALIZED_PNL',
    limit: 5,
  });
  console.log('Recent UM PnL:', income.map((i) => i.income));
}

main();