JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 8
  • Score
    100M100P100Q41766F
  • License MIT

A template for creating npm packages using TypeScript and VSCode

Package Exports

  • okx-node
  • okx-node/account
  • okx-node/client
  • okx-node/constant
  • okx-node/index
  • okx-node/instanse
  • okx-node/market
  • okx-node/order
  • okx-node/package.json
  • okx-node/rest/constants/funding
  • okx-node/rest/constants/index
  • okx-node/rest/index
  • okx-node/rest/rest-client
  • okx-node/rest/type/client
  • okx-node/rest/type/index
  • okx-node/rest/type/request/account
  • okx-node/rest/type/request/block-trading
  • okx-node/rest/type/request/convert
  • okx-node/rest/type/request/funding
  • okx-node/rest/type/request/grid-trading
  • okx-node/rest/type/request/index
  • okx-node/rest/type/request/shared
  • okx-node/rest/type/request/subaccount
  • okx-node/rest/type/request/trade
  • okx-node/rest/type/response/index
  • okx-node/rest/type/response/private-account
  • okx-node/rest/type/response/private-block-trading
  • okx-node/rest/type/response/private-funding
  • okx-node/rest/type/response/private-subaccount
  • okx-node/rest/type/response/private-trade
  • okx-node/rest/type/response/public-data
  • okx-node/rest/type/shared
  • okx-node/rest/util/request-util
  • okx-node/rest/util/rest-client-base
  • okx-node/rest/util/type-guard
  • okx-node/trade
  • okx-node/type/index
  • okx-node/type/meta
  • okx-node/type/push
  • okx-node/type/request
  • okx-node/type/response
  • okx-node/type/websocket/index
  • okx-node/type/websocket/meta
  • okx-node/type/websocket/push
  • okx-node/type/websocket/request
  • okx-node/type/websocket/response
  • okx-node/util/authorization-browser
  • okx-node/util/authorization-node
  • okx-node/websocket/account
  • okx-node/websocket/index
  • okx-node/websocket/instanse
  • okx-node/websocket/market
  • okx-node/websocket/order
  • okx-node/websocket/type/index
  • okx-node/websocket/type/meta
  • okx-node/websocket/type/push
  • okx-node/websocket/type/request
  • okx-node/websocket/type/response
  • okx-node/websocket/websocket/index
  • okx-node/websocket/websocket/meta
  • okx-node/websocket/websocket/push
  • okx-node/websocket/websocket/request
  • okx-node/websocket/websocket/response
  • okx-node/websocket/ws-client
  • okx-node/websocket/ws-util
  • okx-node/ws-client
  • okx-node/ws-util

Readme

okx-node

npm package Downloads Lint Status Test Status Build Status Release Status Issues Code Coverage

My awesome module

Install

npm install okx-node

Usage

import { OkxRestClient, OkxWebSocketClient } from 'okx-node';

const okxRestClient = new OkxRestClient(
  {
    apiKey: API_KEY,
    apiPass: PASSPHRASE,
    apiSecret: SECRET_KEY,
  },
  MARKET
);

const okxWsClient = OkxWebSocketClient.getInstance({
  apiKey: API_KEY,
  passphrase: PASSPHRASE,
  secretKey: SECRET_KEY,
  market: MARKET,
});

void okxRestClient.getPositions().then(data => console.log(data));
void okxRestClient
  .getIndexTickers({ instId: 'BTC-USDT' })
  .then(data => console.log(data));

const channel = 'index-candle15m';
const eventName = `push-${channel}` as const;
const args: WsPublicChannelArgInstId[] = [
  {
    channel,
    instId: 'BTC-USDT',
  },
];
okxWsClient.subscribe({
  op: 'subscribe',
  args,
});
okxWsClient.on(eventName, data => console.log(data));

Browser Usage

Need to install events package.

npm install events -s

Use Case