SDK guide

JavaScript

REST API + WebSocket

OKX JavaScript SDK

Build with the OKX REST API & WebSockets with our JavaScript SDK, TypeScript-first package declarations, and Node.js-compatible runtime patterns. Discover installation, common examples, a detailed endpoint-to-function map, and the REST API/WebSocket patterns shared across our Siebly SDK family.

Use the same TypeScript-first REST API and WebSocket clients from plain JavaScript or TypeScript in Node.js-compatible runtimes.

Package surfaces

Explore the following API capabilities are covered by our OKX SDK:

Spot
Futures
Options
Grid
WebSockets
WebSocket API
WebSocket clients with:
- Built-in heartbeats.
- Automatic reconnection.
- Automatic reauthentication and resubscribe where the exchange supports it.
Promise-wrapped WebSocket API commands you can await like a REST API.
Typed requests and responses for Node.js, JavaScript, and TypeScript IDEs.
Framework-neutral JavaScript snippets that stay approachable in Node.js-compatible runtimes.
TypeScript-first package declarations for stricter services, shared libraries, and editor-assisted integrations.

Install OKX SDK

# Via your favourite package manager, e.g. npm:
npm install okx-api
# or pnpm:
pnpm install okx-api
# or yarn:
yarn add okx-api

Quickstart Examples with the OKX JavaScript SDK

Get started with just a few lines of JavaScript. TypeScript, while not required, is absolutely recommended. TypeScript declarations are included with all our SDKs and provide convenient definitions on request & response fields, WebSocket payloads, and generally safer integrations.

Quickstart snippets are currently unavailable for this SDK and language combination.

Showing cached quickstart content from build-time configuration.

Common OKX implementation tasks

Start from the behavior you need, not just from REST or WebSocket as a transport. Market-data driven systems should be event driven. Backfill via the REST API once and let WebSockets passively stream new data to you, as it becomes available.

REST API hydration or backfill

Start from the REST API quickstart and endpoint reference, then normalize exchange-specific IDs, timestamps, symbols, and product scope.

Open endpoint reference

WebSocket consumer

Start from the WebSocket quickstart that matches the task boundary, verify subscription acknowledgement semantics, and keep reconnect handling explicit.

Open WebSocket quickstart

Agent prompt recipe

Use the AI prompt generator when the task combines REST API hydration, live streams, in-memory state, operational outputs, or strategy code.

Build an agent prompt

For coding agents

Give these files to an agent before implementation so it can find the package, examples, task guidance, and safety rules from the normal SDK-page flow.

AI prompt framework

Prompt generator and task recipes for exchange API projects.

llms.txt

Compact discovery file for agents choosing where to start.

llms-full.txt

Full route and implementation guidance index for machine readers.

SDK catalog

Machine-readable package, docs, examples, and task guidance.

Agent skill

Reusable workflow rules for coding agents using exchange APIs.

Endpoint Function Reference

View endpoint map source

OKX JavaScript FAQ

What does the OKX JavaScript SDK cover?

OKX supports Spot, Futures, Options, Grid, WebSockets, and WebSocket API workflows. The JavaScript guide covers the main REST and WebSocket integration patterns.

How do I authenticate private OKX API calls in JavaScript?

Install okx-api from npm & pass API credentials into the SDK client options, as shown in the OKX JavaScript examples above. The SDK handles the exchange-specific signing requirements for private requests.

Does the OKX JavaScript SDK help with WebSocket connection management?

Yes. Use the SDK WebSocket client for subscriptions, reconnect handling, and stream lifecycle management instead of building raw socket flows yourself.

When should I use the OKX WebSocket API instead of REST?

Use REST for standard request and response workflows such as account queries and order management. Use the WebSocket API flow when you want persistent low-latency interactions over a connected session.

Direct Example Files

Open the example files below for JavaScript and TypeScript-compatible request, authentication, WebSocket, and Node.js service patterns.

OKX REST API example file

OKX/Rest/rest-private-trade.ts

OKX WebSocket example file

OKX/Websocket/ws-private.ts

OKX WebSocket API example file

OKX/Websocket/WS-API/ws-api-client.ts