REST Client

npm install okx-api

import { RestClient } from 'okx-api';

// Public endpoints only (no credentials required)
const publicClient = new RestClient();

// Private + public endpoints
const client = new RestClient({
  apiKey: 'your-api-key',
  apiSecret: 'your-api-secret',
  apiPass: 'your-api-passphrase',
});

// The promise resolves with AccountBalance[] directly
const balances = await client.getBalance();
console.log(balances[0].totalEq); // e.g. '1234.56'

import { RestClient } from 'okx-api';

const client = new RestClient({
  apiKey: process.env.API_KEY!,
  apiSecret: process.env.API_SECRET!,
  apiPass: process.env.API_PASS!,
});

try {
  const positions = await client.getPositions();
  console.log('Open positions:', positions.length);
} catch (err) {
  // err.body contains the raw OKX error response
  console.error('OKX error:', err);
}

const result = await client.fetchLatencySummary();
console.log(`Round trip: ${result.roundTripTime}ms`);
console.log(`Clock skew: ${result.timeDifference}ms`);