okx-node

A template for creating npm packages using TypeScript and VSCode

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
okx-node
1.0.18 months ago9 months agoMinified + gzip package size for okx-node in KB

Readme

okx-node
!npm packagenpm-imgnpm-url !Downloadsdownloads-imgdownloads-url !Lint Statuslint-imglint-url !Test Statustest-imgtest-url !Build Statusbuild-imgbuild-url !Release Statusrelease-imgrelease-url !Issuesissues-imgissues-url !Code Coveragecodecov-imgcodecov-url
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

screenshot snapshot