Skip to content

Bun quickstart ​

Read a public BTC-USDT price with okx-api. No API key is needed. Prices are BTC-USDT last traded prices.

Install Bun first. You can also view the complete OKX Bun example on GitHub.

These examples use public market data. Keep authenticated account and trading calls on your server. See Runtime setup for the scope of each recipe; a successful build does not verify live exchange access.

Create the project ​

sh
mkdir okx-bun-quickstart
cd okx-bun-quickstart
bun add okx-api

Read a price ​

Create price.js to make a public REST request.

js
import { RestClient } from 'okx-api';

const client = new RestClient();
const tickers = await client.getTicker({ instId: 'BTC-USDT' });
const price = tickers[0]?.last;

if (!price) {
  throw new Error('No BTC-USDT price was returned.');
}

console.log('BTC-USDT REST price:', price);

Run it:

sh
bun price.js
text
BTC-USDT REST price: 65000.5

Stream a price (optional) ​

Create stream.js to stream WebSocket prices until Ctrl+C.

js
import { WebsocketClient } from 'okx-api';
import process from 'node:process';

const ws = new WebsocketClient();

ws.on('update', (message) => {
  if (message.arg?.channel !== 'tickers') {
    console.log('WebSocket update:', message);
    return;
  }

  const price = message.data?.[0]?.last;

  if (price) {
    console.log('BTC-USDT WebSocket price:', String(price));
  }
});

ws.on('response', (message) => {
  console.log('WebSocket response:', message);
});
ws.on('exception', (error) => {
  console.error('WebSocket exception:', error);
});
ws.on('reconnect', (event) => {
  console.log('WebSocket reconnecting:', event);
});
ws.on('reconnected', (event) => {
  console.log('WebSocket reconnected:', event);
});

function stop() {
  ws.closeAll();
  console.log('WebSocket closed.');
}

process.once('SIGINT', stop);
process.once('SIGTERM', stop);

Promise.all(ws.subscribe({ channel: 'tickers', instId: 'BTC-USDT' })).catch((error) => {
  console.error('WebSocket subscription failed:', error);
});

Run it:

sh
bun stream.js

The script keeps streaming until Ctrl+C. Exceptions and reconnections are logged; signal handlers close the client. SDK connection logs may also appear:

text
BTC-USDT WebSocket price: 65001.2
WebSocket closed.

Troubleshooting ​

  • Run bun install in the directory containing package.json if the SDK import cannot be resolved.

  • If a request fails or no stream updates arrive, check HTTPS and WSS access to the exchange from your network and region.

  • See Runtime setup for setup details and WebSocket subscriptions for continuous streams.

Built by Siebly. Open source SDKs for exchange APIs.