Skip to content

Node.js quickstart with JavaScript ​

Read the live BTC-USDT last price. This public request needs no API key, secret or passphrase.

Installation ​

TypeScript definitions are included.

Install the npm package with your preferred tool:

sh
npm install kucoin-api
sh
pnpm add kucoin-api
sh
yarn add kucoin-api
sh
bun add kucoin-api
sh
deno add npm:kucoin-api
text
Package: kucoin-api
npm: https://www.npmjs.com/package/kucoin-api

For 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.

SetupGuides
Node.jsJavaScript or TypeScript
Alternative runtimesBun or Deno
Browser appsReact with Vite or Vite with plain JavaScript
Next.jsNode.js server Route Handler
Cloudflare WorkersPublic prices and authenticated orders
Mobile appsReact 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.

Use Node.js 24 for this quickstart. For other runtimes and required polyfills, see Runtime compatibility.

Make a request ​

Save this as prices.mjs:

js
import { SpotClient } from 'kucoin-api';

async function main() {
  const client = new SpotClient();
  const response = await client.getTicker({ symbol: 'BTC-USDT' });
  console.log('BTC-USDT last price:', response.data.price);
}

main().catch(() => {
  console.error('Public ticker request failed. Check connectivity and region.');
  process.exitCode = 1;
});
sh
node prices.mjs

Example output ​

text
BTC-USDT last price: 65000.1

Your price will differ. getTicker() returns an envelope with code and data; the last price is response.data.price. Price and quantity fields are decimal strings. Spot symbols use hyphens, as in BTC-USDT.

Module formats ​

The .mjs extension selects ES modules. For CommonJS, save a .cjs file, replace the import with const { SpotClient } = require('kucoin-api'), and keep the async function. TypeScript uses the same import with included types.

Market data · Streaming · Runtime setup · API reference

TypeScript integrations ​

The SDK works with both JavaScript and TypeScript. TypeScript is optional, but we strongly recommend it for SDK integrations: the included types help catch invalid method names, parameter shapes and response assumptions at build time, before requests reach the exchange. If you choose TypeScript, follow the TypeScript setup and run npx tsc --noEmit during development and CI. Type checking does not replace runtime validation or exchange-side checks.

Some runtimes can execute TypeScript directly. For example, Node.js type stripping supports erasable TypeScript syntax without a separate compiler, but does not check types. If your runtime cannot execute the syntax used by a TypeScript example, compile that example to JavaScript or use a compatible TypeScript runner. Examples with local .js imports that refer to TypeScript source files can use the compiler-based setup above. Plain JavaScript usage does not need any TypeScript tooling.

See Test order validation for the validation endpoint, or Testing without orders for offline recovery tests.

Built by Siebly. Open source SDKs for exchange APIs.