Skip to content

Bun quickstart ​

Read a public btcusdt price with @siebly/htx-api. No API key is needed. Prices are btcusdt last traded prices.

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

The streaming example requires DecompressionStream support in your runtime.

Create the project ​

sh
mkdir htx-bun-quickstart
cd htx-bun-quickstart
bun add @siebly/htx-api

Read a price ​

Create price.js to make a public REST request.

js
import { SpotClient } from '@siebly/htx-api';

const client = new SpotClient();
const response = await client.getTicker({ symbol: 'btcusdt' });
const price = response.tick.close;

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

console.log('btcusdt REST price:', price);

Run it:

sh
bun price.js
text
btcusdt REST price: 65000.5

Stream a price (optional) ​

Create stream.js to receive one WebSocket price and close the connection.

js
import { WebsocketClient } from '@siebly/htx-api';
import process from 'node:process';

async function main() {
  const ws = new WebsocketClient();
  let timeout;
  let stopped = false;

  try {
    const firstPrice = new Promise((resolve, reject) => {
      timeout = setTimeout(() => {
        reject(new Error('No btcusdt update within 30 seconds.'));
      }, 30_000);

      ws.on('message', (message) => {
        if (Array.isArray(message) || message.ch !== 'market.btcusdt.detail') {
          return;
        }
        const tick = message.tick;
        if (!tick || typeof tick !== 'object' || !('close' in tick)) {
          return;
        }
        const price = tick.close;

        if (price) {
          resolve(String(price));
        }
      });
      ws.on('exception', reject);

      const subscription = Promise.resolve(ws.subscribe('market.btcusdt.detail', 'spotPublic'));
      subscription.catch(reject).finally(() => {
        if (stopped) {
          ws.closeAll();
        }
      });
    });

    console.log('btcusdt WebSocket price:', await firstPrice);
  } finally {
    stopped = true;
    clearTimeout(timeout);
    ws.closeAll();
    console.log('WebSocket closed.');
  }
}

main().catch((error) => {
  console.error(error);
  process.exitCode = 1;
});

Run it:

sh
bun stream.js

The script receives one update, closes the client in finally and exits. SDK connection logs may also appear:

text
btcusdt 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 update arrives within 30 seconds, check HTTPS and WSS access to the exchange from your network and region.

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

Built by Siebly. Open source SDKs for exchange APIs.