KuCoin API SDK
kucoin-api provides JavaScript and TypeScript clients for KuCoin Spot, margin, futures, broker and Unified Trading Account APIs. Read market data, follow account changes and manage orders through typed REST and WebSocket methods.
JavaScript & TypeScript · v2.6.9 · MIT license
Installation
TypeScript definitions are included.
Install the npm package with your preferred tool:
npm install kucoin-apipnpm add kucoin-apiyarn add kucoin-apibun add kucoin-apideno add npm:kucoin-apiPackage: kucoin-api
npm: https://www.npmjs.com/package/kucoin-apiFor other npm-compatible tools, use the same package from npm. Runtime-specific setup is covered below.
Choose your setup
Follow the guide for your runtime or framework. Each includes a complete project with commands to install dependencies and run it.
| Setup | Guides |
|---|---|
| Node.js | JavaScript or TypeScript |
| Alternative runtimes | Bun or Deno |
| Browser apps | React with Vite or Vite with plain JavaScript |
| Next.js | Node.js server Route Handler |
| Cloudflare Workers | Public prices and authenticated orders |
| Mobile apps | React Native / Expo for iOS and Android |
Browser and Expo guides include SDK-specific bundler configuration and polyfills where needed. See Runtime setup for project recipes and required configuration.
First request
Follow the Node.js quickstart to read a public Bitcoin price without credentials. Clients use live services. Read Testing environments before trying order examples.
Choose a client
- SpotClient: Classic Spot and margin market data, account reads and trading.
- FuturesClient: Classic futures market data, positions and orders.
- BrokerClient: broker and sub-account operations.
- UnifiedAPIClient: Unified Trading Account market data, balances, positions and trading.
- WebsocketClient: public and private subscriptions, connection events and low-level WebSocket API requests.
- WebsocketAPIClient: promise-based Spot, margin, futures and supported UTA order commands over WebSockets.