Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/tiagosiebler/kucoin-api/llms.txt

Use this file to discover all available pages before exploring further.

The KuCoin API SDK is a robust, production-ready Node.js library for integrating with KuCoin’s full trading platform. It provides dedicated REST clients for Spot, Futures, Broker, and Unified trading, plus a powerful WebSocket client with automatic reconnection — all with complete TypeScript support and browser compatibility.

Quickstart

Get up and running in minutes with your first API call

Authentication

Set up API keys and configure your credentials

REST Clients

Explore Spot, Futures, Broker, and Unified REST clients

WebSockets

Real-time market data and private account streams

​
What’s included

The SDK ships five primary classes covering every KuCoin product:

SpotClient

Spot trading, margin, deposits, withdrawals, and sub-accounts

FuturesClient

Futures order management, positions, and funding rates

BrokerClient

Broker rebate management and sub-account operations

UnifiedAPIClient

Unified Trading Account (UTA/PRO) for cross-product access

WebsocketClient

Event-driven streaming for market data and private events

WebsocketAPIClient

REST-like order placement over the WebSocket API

​
Key features

Full TypeScript Support

Strongly-typed request and response objects for every endpoint

Auto Reconnect

WebSocket client automatically reconnects and resubscribes on disconnect

Multi-Region

Support for KuCoin Global, EU, and AU regional endpoints

Browser Compatible

Works in browser environments via Web Crypto API HMAC signing

​
Installation

npm install kucoin-api

​
Quick example

import { SpotClient } from 'kucoin-api';

const client = new SpotClient({
  apiKey: 'your-api-key',
  apiSecret: 'your-api-secret',
  apiPassphrase: 'your-api-passphrase',
});

const tickers = await client.getTickers();
console.log(tickers.data);
Need help? Join the Node.js Algo Traders Telegram community for real-time support and collaboration.

Build docs developers (and LLMs) love

Get started for freeTalk to us