@nukeguys/exkit-upbit

TypeScript wrapper for the Upbit Open API.

This package provides typed REST and WebSocket clients for Upbit, following the official documentation structure and validating request and response shapes with zod.

Installation

npm install @nukeguys/exkit-upbit

Quick Start

import { createUpbitRestClient, createUpbitWebSocketClient } from '@nukeguys/exkit-upbit';

const restClient = createUpbitRestClient();
const markets = await restClient.listTradingPairs({ is_details: true });

const websocketClient = createUpbitWebSocketClient();
const connection = await websocketClient.connectPublic();

connection.subscribeTicker({
  type: 'ticker',
  codes: ['KRW-BTC'],
  is_only_snapshot: true,
});

API Surface

• REST host: https://api.upbit.com/v1
• Public WebSocket host: wss://api.upbit.com/websocket/v1
• Private WebSocket host: wss://api.upbit.com/websocket/v1/private
• Auth style: explicit accessKey and secretKey

Notes

• The package follows the Upbit documentation layout for operations.
• Private APIs are available, but example code should avoid accidental state-changing calls.
• WebSocket consumers can use either onMessage() or queue-based consumption APIs depending on the integration style.

Reference

• Official docs: docs.upbit.com
• LLM reference: docs.upbit.com/kr/llms.txt
• Live example: apps/test/src/upbit-live-test.ts