kumex-node-sdk
v1.0.2
Published
KuMEX API SDK for Node.js language
Downloads
26
Readme
Node Helper for KuMEX Strategy
Usage As Framework Helper:
Clone and Dep
- git clone
- yarn install
Env Config
- Run Command
# create auth config
copy .env.tpl.js .env.js
- edit
export default {
key: '[Your api key]',
secret: '[Your api secret]',
passphrase: '[Your api passphrase]'
}
How to run
- Base Command
#Sandbox
yarn run dev
#Online
yarn run prod
- Strategy
Create [appName].js in /app folder, so it won't be tracked by GIT. And tempate.js
was already created in /app.
- Run
# [appName] is your strategy file name
# default is: template
yarn run dev -- [appName]
Usage As SDK:
build by self
Clone;
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
- [x] Datafeed
- [x] Logger
- [x] Ticker
- [x] Level2
- [x] Order
- [x] Orders
- [x] Position
- [x] Account Overview
- [x] Funding Fees
- [x] Time
- [x] Level3
- [x] Build As SDK