Skip to content

Bun quickstart ​

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

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

See Runtime compatibility for the checks that have been run and their results. Successful imports and builds alone do not verify live exchange access.

Create the project ​

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

Read a price ​

Create price.js to make a public REST request.

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

const client = new SpotClient();
const response = await client.getTicker({ pair: 'XBTUSD' });
const ticker = Object.values(response.result)[0];
const price = ticker?.c[0];

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

console.log('BTC/USD REST price:', price);

Run it:

sh
bun price.js
text
BTC/USD 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/kraken-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 BTC/USD update within 30 seconds.'));
      }, 30_000);

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

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

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

      const subscription = Promise.resolve(ws.subscribe({ topic: 'ticker', payload: { symbol: ['BTC/USD'] } }, 'spotPublicV2'));
      subscription.catch(reject).finally(() => {
        if (stopped) {
          ws.closeAll();
        }
      });
    });

    console.log('BTC/USD 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
BTC/USD 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 compatibility for tested versions and WebSocket subscriptions for continuous streams.

Built by Siebly. Open source SDKs for exchange APIs.