1.0.2 • Published 6 years ago

kumex-node-sdk v1.0.2

Weekly downloads
1
License
ISC
Repository
github
Last release
6 years ago

Node Helper for KuMEX Strategy

Usage As Framework Helper:

Clone and Dep

  1. git clone
  2. yarn install

Env Config

  1. Run Command
# create auth config
copy .env.tpl.js .env.js
  1. edit
export default {
	key: '[Your api key]',
	secret: '[Your api secret]',
	passphrase: '[Your api passphrase]'
}

How to run

  1. Base Command
#Sandbox
yarn run dev

#Online
yarn run prod 
  1. Strategy

Create appName.js in /app folder, so it won't be tracked by GIT. And tempate.js was already created in /app.

  1. Run
# [appName] is your strategy file name
# default is: template
yarn run dev -- [appName]

Usage As SDK:

build by self

  1. Clone;

  2. Build;

# install deps
yarn install

# build
yarn run build

# link sdk folder
yarn link

use package

# use yarn
yarn add kumex-node-sdk

# or use npm
npm install kumex-node-sdk

use SDK

There's an example in the /sdk_example folder.

TODO

  • Datafeed
  • Logger
  • Ticker
  • Level2
  • Order
  • Orders
  • Position
  • Account Overview
  • Funding Fees
  • Time
  • Level3
  • Build As SDK

License

MIT