npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

jsmex-trader-sdk

v1.1.50

Published

[![npm version](https://badgen.now.sh/npm/v/jsmex-trader-sdk)](https://www.npmjs.com/package/jsmex-trader-sdk) [![npm downloads](https://badgen.now.sh/npm/dm/jsmex-trader-sdk)](https://www.npmjs.com/package/jsmex-trader-sdk)

Downloads

25

Maintainers

jsb4chjsb4ch

Keywords

algorithmicalgotradingaltcoinaltcoinsapiarbitragebacktestbacktestingbitcoinbotbtccnycoincoinscryptocryptocurrencycrypto currencycrypto marketcurrencycurrenciesdarkcoindashdigital currencydogedogecoine-commerceetcethetherethereumexchangeexchangeseurframeworkinvestinvestinginvestorlibrarylightlitecoinltcmarketmarket datamarketsmerchandisemerchantminimalohlcvorderorderbookorder bookpriceprice datapricefeedprivatepublicripplestrategytickertickerstoolkittradetradertradingusdvolumexbtxrpzeczerocoin1Broker1BTCXEACXacx.ioallcoinallcoin.comANXANXProbiboxbibox.comBinancebinance.combit2c.co.ilBit2CBitBayBitBaysbitcoincoidBitcoin.co.idBitfinexbitFLyerbitflyer.jpbithumbbithumb.combitlishBitMarketBitMEXBitsoBitstampBittrexBL3PBleutradebleutrade.comBlinkTradebraziliexbraziliex.comBtcBoxbtcbox.co.jpBTCCBTCChinaBTC-eBTCeBTCExchangebtcexchange.phBTC Marketsbtcmarketsbtcmarkets.netBTCTraderbtctrader.combtc-trade.com.uaBTC Trade UABTCTurkbtcturk.comBTCXbtc-xbterBter.comBX.in.thccexC-CEXcexCEX.IOCHBTCChileBitchilebit.netcoincheckCoinExchangecoinexchange.iocoingicoingi.comCoinMarketCapCoinMateCoinsecureCoinSpotcoinspot.com.auCrypto Capitalcryptocapital.coDSXdsx.ukEXMOflowBTCflowbtc.comFoxBitfoxbit.exchangeFYB-SEFYB-SGGatecoinGDAXGeminiHitBTCHuobiHuobiPROhuobi.proIndependent Reserveindependentreserve.comitBitjubi.comKrakenKucoinKunaLakeBTClakebtc.comLiveCoinLiquiliqui.iolunomercadoMercadoBitcoinmercadobitcoin.brmixcoinsmixcoins.comnovanovaexchangenovaexchange.comOKCoinOKCoin.comOKCoin.cnOKEXokex.comPaymiumPoloniexQuadrigaCXQryptosQUOINEXSouthxchangeSurBitcoinsurbitcoin.comTidextidex.comTheRockTradingUrduBiturdubit.comVaultoroVBTCvbtc.exchangevbtc.vnVirWoXWEXwex.nzxBTCexbtce.comYoBityobit.netYUNBIZaifZB1btcxe.comAllcoinanxpro.comanybits.comAnybitsbcex.topBCEXBiboxbig.oneBigONEbitbank.ccbitbankbitbay.netbitfinex.combitFlyerbitforex.comBitforexBithumbbitibu.comBitibubitkk.combitkkbitlish.comBitlishbitmarket.plbitmarket.netbitmex.combitsane.comBitsanebitso.combitstamp.netbittrex.combit-z.comBit-Zbl3p.eubitonic.nlBraziliexbtc-alpha.comBTC-Alphabtcchina.combtctrade.imBtcTrade.imbuda.comBudabx.in.thc-cex.comcex.iotrade.chbtc.comcobinhood.comCOBINHOODcoinbase.comCoinbaseprime.coinbase.comCoinbase Primepro.coinbase.comCoinbase Procoincheck.comcoinegg.comCoinEggcoinex.comCoinExcoinfalcon.comCoinFalconcoinfloor.co.ukcoinfloorCoingicoinmarketcap.comcoinmate.iocoinnest.co.krcoinnestcoinone.co.krCoinOnecointiger.proCoinTigercoolcoin.comCoolCoincoss.ioCOSScrex24.comCREX24cryptonbtc.comCryptonderibit.comDeribitethfinex.comEthfinexexmo.meexx.comEXXfcoin.comFCointrader.flowbtc.comfybse.sefybsg.comgatecoin.comgate.ioGate.iogdax.comgemini.comgetbtc.orgGetBTChadax.comHADAXhitbtc.comHuobi Prohuobi.com.ruHuobi Russiaice3x.comice3x.co.zaICE3Xindodax.comINDODAXitbit.comkkex.comKKEXkraken.comkucoin.comKuCoinkuna.iolbank.infoLBankliquid.comLiquidlivecoin.netluno.comlykke.comLykkemercadobitcoin.com.brMercado BitcoinMixCoinsnegociecoins.com.brNegocieCoinsNovaexchangeokcoin.cnOKCoin CNYokcoin.comOKCoin USDpaymium.compoloniex.comquadrigacx.comrightbtc.comRightBTCsouthxchange.comSouthXchangestronghold.coStrongholdtheocean.tradeThe Oceantherocktrading.comtidebit.comTideBituex.comUEXupbit.comUpbitvaultoro.comvirwox.comyunbi.comzaif.jpzb.comfcoinjp.comFCoinJPbinance.jeBinance Jerseybequant.ioBequantmandalaex.comMandaladx.exchangeDX.Exchangeoceanex.pro.comOceanExflowbtc.com.brfoxbit.com.brlatoken.comLatokenbitmart.comBitMartdigifinex.vipDigiFinexidex.marketIDEXadara.ioAdarabinance.usBinance USwhitebit.comWhiteBitbitmax.ioBitMaxbytetrade.comByteTradeftx.comFTX{hostname}bw.comstex.comSTEXBWtimex.ioTimeXbitz.com

Readme

npm version npm downloads

jsmex-trader-sdk -- JSMEX Trader SDK

ALT JSMEX LOGO NPM

jsmex-trader-sdk is a library for nodejs which gives you access to jsmex's API interface. This allows you to create JavaScript strategies which can be deployed in jsmex server and executed in JavaScript environments completely isolated from each other.

JSMEX

JSMEX is the first programmable cryptocurrency exchange! Sign Up Every minute all the uploaded strategies are executed in parallel isolated environments on our servers.

REQUIREMENTS

This project requires nodejs LTS version 10.4.0 (or later).

To install this module run npm install jsmex-trader-sdk.

API DOCUMENTATION

jsmex-trader-sdk is a CCXT extension library is used to build strategies for jsmex runtime executor. It provides quick access to market data for storage, analysis, visualization, indicator development, algorithmic trading, bot programming, and related software engineering.

Class: Trader [core]

This class provide the core interface to ccxt API. Trader instances will inherit all the wrapped ccxt methods and will execute in sequence onInit, onTick and onExit.

Trader.ccxtExchanges.jsmex.ccxtInstance

This is the ccxt instance of the jsmex exchange, if you are not interested in using the wrapper you can directly refer to this reference.

Trader.fetchDepth(options)
  • options [object]
    • symbol [string] - Trading symbol
  • return a [Promise]
Trader.fetchOHLCV(options)
  • options [object]
    • symbol [string] - Trading symbol
    • resolution [string] - Kline resolution
    • since [number] - Time in milliseconds
    • limit [number] - Number of klines
  • return a [Promise]
Trader.cancelOrder(options)
  • options [object]
    • symbol [string] - Trading symbol
    • id [number] - id
  • return a [Promise]
Trader.cancelAllOrders(options)
  • return a [Promise]
Trader.fetchOrders(options)
  • options [object]
    • symbol [string] - Trading symbol
    • offset [number] - Offset
    • limit [number] - Limit records
  • return a [Promise]
Trader.fetchTransactions(options)
  • options [object]
    • symbol [string] - Trading symbol
    • offset [number] - Offset
    • limit [number] - Limit records
  • return a [Promise]
Trader.putOrder(options)
  • options [object]
    • symbol [string] - Trading symbol
    • price [string] - Price
    • amount [string] - Amount
    • side [string] - Side
    • type [string] - Type
  • return a [Promise]
Trader.pipeline(options)

This is restricted API, it allows bulk operations

  • options [object]
    • symbol [string] - Trading symbol
    • pipeline [array] - Pipeline array
  • return a [Promise]
Trader.balance(options)
  • return a [Promise]
Trader.fetchKeyValueStorage(options)

List key-value storage

  • return an [object]
Trader.setKeyValueStorage(options)

Set an element in key-value storage

  • options [object]
    • key [string] - Key
    • value [string] - Value
  • return an [object]
Trader.setBulkKeyValueStorage(options)

Bulk set in key-value storage

  • options [object]
    • bulk [array] - array of key-value object as described in setKeyValueStorage
  • return an [object]
Trader.getKeyValueStorage(options)

Get an element in key-value storage

  • options [object]
    • key [string] - Key
  • return an [object]
Trader.deleteKeyValueStorage(options)

Delete an element in key-value storage

  • options [object]
    • key [string] - Key
  • return an [object]
Trader.open(index)
  • index [number] - Kline index
  • return a [BigNumber]
Trader.high(index)
  • index [number] - Kline index
  • return a [BigNumber]
Trader.low(index)
  • index [number] - Kline index
  • return a [BigNumber]
Trader.close(index)
  • index [number] - Kline index
  • return a [BigNumber]
Trader.volume(index)
  • index [number] - Kline index
  • return a [BigNumber]
Trader.balance(index)
  • return a [object]
Trader.transactions(index)
  • return a [TransactionDTO]
Trader.orders(index)
  • return a [OrderDTO]
Trader.getPublicData(fetchDepthParams, fetchOHLCVParams)

Automatically called in Trader._onInit, results are parsed in Trader.update

  • fetchDepthParams [object] - ccxt interface params
  • fetchOHLCVParams [object] - ccxt interface params
  • return a [Promise]
Trader.getPrivateData(fetchOrdersParams, fetchTransactionsParams)

Automatically called in Trader._onInit, results are parsed in Trader.update

  • fetchOrdersParams [object] - ccxt interface params
  • fetchTransactionsParams [object] - ccxt interface params
  • return a [Promise]

EXAMPLES

Below is a sample program which shows basic usage of the library.

// file index.js
(async function () {
  try {
    const PanicCloseStrategy = require('./strategy.js');
    await PanicCloseStrategy.start()
  } catch (err) {
    console.error('err', err)
  }
})()
// file strategy.js
global.log = global.log || console.log 
global.error = global.error || console.error

// never use console in your program, it doesn't exists in the isolated environment, use global.log in order to receive logs in your account dashboard
module.exports = class extends (global.Trader || require('jsmex-trader-sdk')) {
  constructor (options) {
    super(options)
    this.defaultSymbol = this.options.defaultSymbol
  }

  /**
     * SamplePanicCloseStrategy on init method
     *
     * @author jsb4ch <[email protected]>
     * @since 1.1.0
    */
  onInit () {

  }

  /**
     * SamplePanicCloseStrategy on tick method
     *
     * @author jsb4ch <[email protected]>
     * @since 1.1.0
    */
  async onTick () {
    try {
      let close = this.close()
      let yesterdayOpen = this.open(24)
      let rate = (
        close.minus(yesterdayOpen)
      ).div(yesterdayOpen)
      if (rate.lte(-0.2)) {
        return this.cancelAllOrders()
      } else {
        global.log(rate.toNumber())
      }
    } catch (err) {
      global.error(err)
    }
  }

  /**
     * SamplePanicCloseStrategy on tick method
     *
     * @author jsb4ch <[email protected]>
     * @since 1.1.0
    */
  onExit () {

  }

  /**
     * SamplePanicCloseStrategy static options
     *
     * @author jsb4ch <[email protected]>
     * @since 1.1.0
    */
  static get options () {
    return {
      ...this.defaultOptions,
      defaultSymbol: 'BTC/USDT',
      exchanges: {
        jsmex: {
          wwwDomain: 'jsmex.io',
          apiDomain: 'api.jsmex.io'
        }
      },
      ccxt: {
        fetchOHLCV: {
          resolution: '10m',
          limit: 500
        }
      }
    }
  }
}

For othe examples, like how to use key-value storage, check out examples directory.

SCREENSHOTS

Strategy Editor ALT JSMEX SCREENSHOT

Tradingview (test environment) ALT JSMEX SCREENSHOT

PIPELINE

In our pipeline for 2020 there are really interesting features:

  • Q1 Strategy performance ranking
  • Q2 Strategy Copy Trading

THANKS

Special thanks to:

  • CCXT Team
  • Hapi for Joi
  • MikeMcl for bignumber.js

CONTACT US

[email protected]

NEWS

https://t.me/jsmexio

TWITTER

https://twitter.com/jsmexchange