Market Data

import { RestClient } from 'okx-api';

const client = new RestClient();

import { RestClient } from 'okx-api';

const client = new RestClient();

// Get all SPOT instruments
const instruments = await client.getInstruments({ instType: 'SPOT' });
const sui = instruments.find((i) => i.baseCcy === 'SUI');
console.log('SUI-USDT min size:', sui?.minSz);
console.log('SUI-USDT tick size:', sui?.tickSz);

const client = new RestClient();

// Single ticker
const [ticker] = await client.getTicker({ instId: 'BTC-USDT' });
console.log('Last price:', ticker.last);
console.log('24h volume:', ticker.vol24h);
console.log('Bid/Ask:', ticker.bidPx, '/', ticker.askPx);

// All SPOT tickers
const allTickers = await client.getTickers({ instType: 'SPOT' });
console.log('Total SPOT pairs:', allTickers.length);

const client = new RestClient();

// Last 100 hourly candles for BTC-USDT
const candles = await client.getCandles({
  instId: 'BTC-USDT',
  bar: '1H',
  limit: '100',
});

// Each candle: [ts, open, high, low, close, vol, volCcy, volCcyQuote, confirm]
for (const [ts, open, high, low, close] of candles) {
  console.log(`${new Date(Number(ts)).toISOString()} O:${open} H:${high} L:${low} C:${close}`);
}

const client = new RestClient();

const [book] = await client.getOrderBook({
  instId: 'BTC-USDT',
  sz: '5',  // depth levels per side (max 400)
});

console.log('Best ask:', book.asks[0][0], 'qty:', book.asks[0][1]);
console.log('Best bid:', book.bids[0][0], 'qty:', book.bids[0][1]);

const client = new RestClient();

const [rate] = await client.getFundingRate({ instId: 'BTC-USDT-SWAP' });
console.log('Current funding rate:', rate.fundingRate);
console.log('Next funding time:', new Date(Number(rate.nextFundingTime)));

// Funding rate history
const history = await client.getFundingRateHistory({
  instId: 'BTC-USDT-SWAP',
  limit: '10',
});
for (const h of history) {
  console.log(`${h.fundingTime}: ${h.fundingRate}`);
}

const client = new RestClient();

const status = await client.getSystemStatus({});
for (const event of status) {
  console.log(`[${event.state}] ${event.title}`);
  console.log(`  Start: ${event.begin}, End: ${event.end}`);
}

const client = new RestClient();

// Long/short ratio for BTC contracts
const ratio = await client.getLongShortRatio({
  ccy: 'BTC',
  period: '1H',
});
console.log('Long/short ratio:', ratio[0]);

// Taker buy/sell volume
const takerVol = await client.getTakerVolume({
  instType: 'SPOT',
  ccy: 'BTC',
  period: '1H',
});
console.log('Taker volume:', takerVol[0]);