Node.js / TypeScript quickstart
Write a TypeScript script that reads a public BTC-USDT price with okx-api, then compile and run it in Node.js. No API key is needed. Prices are BTC-USDT last traded prices.
Use Node.js 24 and npm. You can also view the complete OKX TypeScript example on GitHub.
The SDK also works with plain JavaScript. TypeScript is optional, but we strongly recommend it for SDK integrations: checking the included types catches many invalid method names, parameters and response assumptions at build time. Keep a type check in CI even if your runtime can execute TypeScript directly; execution alone does not check types.
These examples use public market data. Keep authenticated account and trading calls on your server. See Runtime setup for the scope of each recipe; a successful build does not verify live exchange access.
Create the project
mkdir okx-typescript-quickstart
cd okx-typescript-quickstart
npm init -y
npm install okx-api
npm install --save-dev typescript@6.0.3 @types/node@24.13.2The install command adds the latest SDK release, which includes its own type definitions. The development dependencies supply the TypeScript compiler and Node.js types.
1. Create tsconfig.json
Enable strict type checking and compile the TypeScript programs into dist/.
{
"compilerOptions": {
"target": "ES2022",
"module": "NodeNext",
"moduleResolution": "NodeNext",
"strict": true,
"skipLibCheck": true,
"outDir": "dist",
"types": [
"node"
]
},
"include": [
"*.mts"
]
}Read a price
Create price.mts. The SDK’s type definitions let TypeScript check the constructor options, request parameters and response types.
import { RestClient } from 'okx-api';
const client = new RestClient();
const tickers = await client.getTicker({ instId: 'BTC-USDT' });
const price = tickers[0]?.last;
if (!price) {
throw new Error('No BTC-USDT price was returned.');
}
console.log('BTC-USDT REST price:', price);Check types, compile and run:
npx tsc --noEmit
npx tsc
node dist/price.mjsBTC-USDT REST price: 65000.5The .mts source compiles to .mjs. NodeNext compiler settings follow Node.js module resolution without changing the package’s default module format.
Stream a price (optional)
Create stream.mts to stream prices until Ctrl+C. Signal handlers close the client; exceptions and reconnections are logged without stopping it.
import { WebsocketClient } from 'okx-api';
import process from 'node:process';
const ws = new WebsocketClient();
ws.on('update', (message) => {
if (message.arg?.channel !== 'tickers') {
console.log('WebSocket update:', message);
return;
}
const price = message.data?.[0]?.last;
if (price) {
console.log('BTC-USDT WebSocket price:', String(price));
}
});
ws.on('response', (message) => {
console.log('WebSocket response:', message);
});
ws.on('exception', (error) => {
console.error('WebSocket exception:', error);
});
ws.on('reconnect', (event) => {
console.log('WebSocket reconnecting:', event);
});
ws.on('reconnected', (event) => {
console.log('WebSocket reconnected:', event);
});
function stop() {
ws.closeAll();
console.log('WebSocket closed.');
}
process.once('SIGINT', stop);
process.once('SIGTERM', stop);
Promise.all(ws.subscribe({ channel: 'tickers', instId: 'BTC-USDT' })).catch((error) => {
console.error('WebSocket subscription failed:', error);
});Compile and run it:
npx tsc
node dist/stream.mjsBTC-USDT WebSocket price: 65001.2
WebSocket closed.Troubleshooting
npx tsc --noEmitchecks types without making exchange requests. Fix compiler errors before running the emitted JavaScript.- If Node cannot find
dist/price.mjsordist/stream.mjs, compile withnpx tscfirst. - If types cannot be resolved, check that both development dependencies installed successfully.
- For network or API errors, see Troubleshooting and Runtime compatibility.