@arbit-x/bitkub-sdk NPM

Bitkub SDK

A modern TypeScript SDK for the Bitkub Exchange API, providing both REST and WebSocket interfaces for cryptocurrency trading and market data.

A TypeScript SDK for the Bitkub Exchange API, providing both REST and WebSocket interfaces for cryptocurrency trading and market data.

Overview

Bitkub SDK is a TypeScript SDK that simplifies interaction with the Bitkub exchange API. It provides easy-to-use methods for both REST and WebSocket endpoints, enabling developers to access market data and trading features with minimal setup.

Features

Fetch available market symbols
Basic error handling
TypeScript type definitions
Configurable API and WebSocket URLs
Support for authenticated requests (API key/secret)
Order book, ticker, trading history, real-time data, trading actions

Installation

npm install @arbit-x/bitkub-sdk

Usage

import { BitkubSDK } from '@arbit-x/bitkub-sdk';

// Initialize SDK (API key/secret are optional for public endpoints)
const bitkubSDK = new BitkubSDK({
  baseUrl: 'https://api.bitkub.com',
  baseWsUrl: 'wss://api.bitkub.com/websocket-api',
  // apiKey: 'your-api-key',
  // apiSecret: 'your-api-secret',
});

// --- REST Example: Fetch market symbols ---
const marketSymbols = await bitkubSDK.fetchMarketSymbols();
console.log('Market symbols:', marketSymbols);

// --- REST Example: Fetch order books for symbols ---
const orderBooks = await bitkubSDK.fetchOrderBooks(['BTC_THB', 'ETH_THB']);
const btcOrderBook = orderBooks['BTC_THB']
const ethOrderBook = orderBooks['ETH_THB']
console.log('Order books:', orderBooks);

// --- WebSocket Example: Subscribe to real-time order book updates ---
const subscriptionId = await bitkubSDK.subscribeOrderBooks(['BTC_THB'], (orderBooks) => {
    const { bids, asks } = orderBooks['BTC_THB']
    console.log('Live order book update:', bids, asks);
});

// ...later, to unsubscribe from updates:
bitkubSDK.unsubscribeOrderBooks(subscriptionId);