CoinMClient REST API Method Reference

import { CoinMClient } from 'binance';

// Public (market data only)
const publicClient = new CoinMClient();

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

// Testnet
const testClient = new CoinMClient({ testnet: true });

import { CoinMClient } from 'binance';

const client = new CoinMClient();

// Current mark price for BTCUSD perpetual
const mark = await client.getMarkPrice({ symbol: 'BTCUSD_PERP' });
console.log('Mark price:', (mark as any).markPrice);

// Klines
const klines = await client.getKlines({
  symbol: 'BTCUSD_PERP',
  interval: '4h',
  limit: 10,
});
console.log('Klines count:', klines.length);

// Open interest
const oi = await client.getOpenInterest({ symbol: 'BTCUSD_PERP' });
console.log('Open interest:', oi.openInterest);

import { CoinMClient } from 'binance';

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

// Place a market order
const order = await client.submitNewOrder({
  symbol: 'BTCUSD_PERP',
  side: 'BUY',
  type: 'MARKET',
  quantity: 1, // number of contracts
});
console.log('Filled at avg price:', order.avgPrice);

// View all open orders
const openOrders = await client.getAllOpenOrders({ symbol: 'BTCUSD_PERP' });
console.log('Open orders:', openOrders.length);

import { CoinMClient } from 'binance';

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

async function main() {
  // Account balances
  const balances = await client.getBalance();
  const btcBalance = balances.find((b) => b.asset === 'BTC');
  console.log('BTC available:', btcBalance?.availableBalance);

  // Full account info
  const account = await client.getAccountInformation();
  console.log('Total unrealised PnL:', account.totalUnrealizedProfit);

  // Leverage and margin setup
  await client.setLeverage({ symbol: 'BTCUSD_PERP', leverage: 5 });
  await client.setMarginType({ symbol: 'BTCUSD_PERP', marginType: 'CROSSED' });

  // Current positions
  const positions = await client.getPositions({ pair: 'BTCUSD' });
  console.log('BTCUSD positions:', positions.length);

  // Income history
  const pnl = await client.getIncomeHistory({
    symbol: 'BTCUSD_PERP',
    incomeType: 'REALIZED_PNL',
    limit: 10,
  });
  console.log('Last PnL entry:', pnl[0]?.income);
}

main();