Node.js & Typescript OKX (OKEX) API & WebSocket SDK

原仓库：https://github.com/tiagosiebler/okx-api

[][1]

Node.js连接器，用于OKX APIs和WebSockets：

1. 与所有OKX APIs的完全集成。
2. 支持TypeScript（具有大多数API请求和响应的类型声明）。
3. 超过100个端到端测试进行真实的API调用和WebSocket连接，在它们到达npm之前验证任何更改。
4. 强大的WebSocket集成

• 可配置连接心跳（自动检测失败的连接）。
• 自动重新连接，然后重新订阅工作流程。
• 自动身份验证和心跳处理。

5. 浏览器支持（通过webpack捆绑包，请参见下面的“浏览器使用”）。

下载

1npm install okx-api-new

文档说明

大多数方法接受JS对象。这些可以使用okx的API文档中指定的参数进行填充，或者检查rest-client类方法中的类型定义。

• RestClient.
• OKX API Documentation.
• TSDoc Documentation (generated using typedoc via npm module)

Contributions & Thanks

Support my efforts to make algo trading accessible to all - register with my referral links:

• Bybit
• Binance
• OKX

For more ways to give thanks & support my efforts, visit Contributions & Thanks!

项目结构

该项目使用TypeScript，资源存储在三个关键结构中。

• src - the whole connector written in typescript
• lib - the javascript version of the project (compiled from typescript). This should not be edited directly, as it will be overwritten with each release. This is also the version published to npm.
• dist - the packed bundle of the project for use in browser environments (manual, using webpack).
• examples - some implementation examples & demonstrations. Contributions are welcome!

---

使用方法

• 申请API key

基本使用实例

1. 根据需求在OKX API Documentation找到对应的接口 -> A
2. 在代码中引入之后，点击'okx-api-new' 进入包，找到rest-client.js 文件，搜索 A ,复制函数名，
3. 在代码中使用

1
2// 实例一
3import { RestClient, OrderRequest } from 'okx-api-new';
4const API_KEY = "生成的key"
5const API_SECRET = "生成的密钥"
6const API_PASS = "密码"
7
8const client = new RestClient({
9  apiKey: API_KEY,
10  apiSecret: API_SECRET,
11  apiPass: API_PASS,
12});
13
14async function main() {
15  const args = {
16    instId: "TRX-USDT-SWAP",
17  }
18  // 获取资金费率
19  const info = await client.getFundingRateHistory(args)
20  console.log(JSON.stringify(info));
21}
22
23main()
24

1// 实例二
2import { RestClient, OrderRequest, WebsocketClient } from 'okx-api-new';
3const API_KEY = "生成的key"
4const API_SECRET = "生成的密钥"
5const API_PASS = "密码"
6
7const client = new RestClient({
8  apiKey: API_KEY,
9  apiSecret: API_SECRET,
10  apiPass: API_PASS,
11});
12/*
13 * 如果需要测试的相关配置，看WebsocketClient可选项
14 * 1. 收到打开ws, 会先执行new WebsocketClient() 打印一段信息
15 * 2. 第二步 wsClient.on('open',
16 * 3. 第三步 wsClient.on('response',
17 * 4. 第四步 wsClient.on('update'
18 * 
19 *
20 */
21
22// 私有频道
23// const wsClient = new WebsocketClient(
24//   {
25//     accounts: [
26//       {
27//         apiKey: API_KEY,
28//         apiSecret: API_SECRET,
29//         apiPass: API_PASS,
30//       },
31//     ],
32//   },
33// );
34
35// 共有频道
36const wsClient = new WebsocketClient({});
37
38
39wsClient.on('update', (data) => {
40  console.log(new Date(), " 接受到的消息: ", JSON.stringify(data));
41});
42wsClient.on('open', (data) => {
43  console.log('ws connection opened open:', data.wsKey);
44});
45
46wsClient.on('response', (data) => {
47  console.log('ws response received: ', JSON.stringify(data, null, 2));
48});
49// 尝试自动重连接
50wsClient.on('reconnect', ({ wsKey }) => {
51  console.log('ws automatically reconnecting.... ', wsKey);
52});
53// 自动重连成功
54wsClient.on('reconnected', (data) => {
55  console.log('ws has reconnected ', data?.wsKey);
56});
57// 报错
58wsClient.on('error', (data) => {
59  console.error('ws exception: ', data);
60});
61
62
63// ====>>> 订阅 资金费率
64wsClient.subscribe({
65  channel: "funding-rate",
66  instId: "BTC-USDT-SWAP"
67});

npm 发布流程

REST Client

Requests & Responses

• 官方 API docs.
• 统一返回数据格式

1HTTP 200 and "code" in the response body === "0"

如果返回非正常，请看APIResponse.

Websocket Client

此连接器包括用于 OKX 公共和私有 websockets 的高性能 node.js 和 typescript websocket 客户端。

• If your IDE doesn't have IntelliSense, check the websocket-client.ts for a list of methods, params & return types.
• When subscribing to channels, only the "args" should be passed as an object or array when calling the websocket client subcribe() function: API docs.
• TypeScript recommended (but it is not required) for a richer experience:
• The ws client will automatically open connections as needed when subscribing to a channel.
• If the connection is lost for any reason, the ws client will detect this (via the connection heartbeats). It will then:
  • Automatically teardown the dead connection.
  • Automatically respawn a fresh connection.
  • Automatically reauthenticate, if using private channels.
  • Automatically resubscribe to previously subscribed topics.
  • Resume producing events as before, without extra handling needed in your logic.
• The ws client will automatically authenticate if accounts are provided and a private channel is subscribed to.
• Up to 100 accounts are supported on the private connection, as per the API docs. Authentication is automatic if accounts are provided.
• For examples in using the websocket client, check the examples in the repo:
  • Private channels (account data): examples/ws-private.ts
  • Public chanels (market data): examples/ws-public.ts
  • These examples are written in TypeScript, so can be executed with ts-node for easy testing: ts-node examples/ws-private.ts
  • Or convert them to javascript:
    • Change the import { ... } from 'okx-api' to const { ... } = require('okx-api');
    • Rename the file to ws-private.js
    • And execute with node: node examples/ws-private.js

Public Events

See examples/ws-public.ts for a full example:

Private Events

See examples/ws-private.ts for a full example:

Browser/Frontend Usage

Import

This is the "modern" way, allowing the package to be directly imported into frontend projects with full typescript support.

1. Install these dependencies

   1npm install crypto-browserify stream-browserify

2. Add this to your tsconfig.json

   1{
   2  "compilerOptions": {
   3    "paths": {
   4      "crypto": [
   5        "./node_modules/crypto-browserify"
   6      ],
   7      "stream": [
   8        "./node_modules/stream-browserify"
   9      ]
   10}

3. Declare this in the global context of your application (ex: in polyfills for angular)

   1(window as any).global = window;

Webpack

This is the "old" way of using this package on webpages. This will build a minified js bundle that can be pulled in using a script tag on a website.

Build a bundle using webpack:

• npm install
• npm build
• npm pack

The bundle can be found in dist/. Altough usage should be largely consistent, smaller differences will exist. Documentation is still TODO.

---

Star History