Node.js OKX (OKEX) API SDK

Installation

1npm install okx-api-connector

Usage

1import { OKXRestClient } from 'okx-api-connector';
2// or use common js
3const { OKXRestClient } = require("okx-api-connector");
4// Create rest client
5const okxClient = new OKXRestClient(process.env.OKX_API_KEY, process.env.OKX_SECRET_KEY, process.env.OKX_API_PASSWD);
6
7// Create client with option
8const okxClient = new OKXRestClient(
9  process.env.OKX_API_KEY, 
10  process.env.OKX_SECRET_KEY, 
11  process.env.OKX_API_PASSWD,
12  {
13    baseURL: process.env.OKX_BASE_URL,  // Replace the base url
14    isTestClient: true,  // Config if the client is a test client
15    config: {
16      proxy: {
17        protocol: 'http',
18        host: '127.0.0.1',
19        port: 7890,
20      }
21    }
22  });
23
24// Get balance
25const balance = await okxClient.getBalance();
26console.log(balance.data.data[0].details);
27
28// Check specific token balance
29const balance = await okxClient.getBalance({
30  tokens: ['USDC', 'USDT']
31});
32
33// Put trade, all params please refer to [OKX api](https://www.okx.com/docs-v5/en/#order-book-trading-trade-post-place-order)
34okxClient.newOrder(instId, tdMode, side, ordType, otherParams);
35
36// Transfer assets
37okxClient.transfer({
38  ccy: 'USDT',
39  amt: '10',
40  from: '18',
41  to: '6',
42});
43
44// Other usage
45okxClient.client.get(url);
46okxClient.client.post(url, data);