BincentiveClient

Bincentive Trader Client

Kind: global class

• BincentiveClient
  • new BincentiveClient(email, password, sandbox)
  • .timeout(ms)
  • .addOrder(strategyId, exchangeId, baseCurrency, quoteCurrency, orderType, orderSide, unit, limitPrice)
  • .getHistoryList()
  • .getOrderInfo(orderId)
  • .getAvailableExchanges()
  • .getAvailableSymbols(exchange_name)
  • .getCurrentPrice(exchange_name, symbol_name)
  • .getStrategyList()
  • .getApprovedStrategyList()
  • .getExchangeList()
  • .addApiKey(apiKey, secretKey, exchangeId, apiNickname, fixApiAssign)
  • .deleteApiKey(exchangeId)
  • .getApiKeyList()

new BincentiveClient(email, password, sandbox)

bincentive Trader Client

Param	Type	Default
email	string
password	string
sandbox	boolean	true

bincentiveClient.timeout(ms)

set client default timeout

Kind: instance method of BincentiveClient

Param	Type
ms	number

bincentiveClient.addOrder(strategyId, exchangeId, baseCurrency, quoteCurrency, orderType, orderSide, unit, limitPrice)

add market order to specify strategy id

Kind: instance method of BincentiveClient

Param	Type
strategyId	number
exchangeId	number
baseCurrency	string
quoteCurrency	string
orderType	string
orderSide	string
unit	number
limitPrice	number

bincentiveClient.getHistoryList()

get order history

Kind: instance method of BincentiveClient

bincentiveClient.getOrderInfo(orderId)

get order detail info

Kind: instance method of BincentiveClient

Param	Type
orderId	number

bincentiveClient.getAvailableExchanges()

get supported exchanges

Kind: instance method of BincentiveClient

bincentiveClient.getAvailableSymbols(exchange_name)

get exhange supported symbols

Kind: instance method of BincentiveClient

Param	Type
exchange_name	string

bincentiveClient.getCurrentPrice(exchange_name, symbol_name)

get symbol current price

Kind: instance method of BincentiveClient

Param	Type
exchange_name	string
symbol_name	string

bincentiveClient.getStrategyList()

get strategy list

Kind: instance method of BincentiveClient

bincentiveClient.getApprovedStrategyList()

get approved stragtegy list

Kind: instance method of BincentiveClient

bincentiveClient.getExchangeList()

get exchange list

Kind: instance method of BincentiveClient

bincentiveClient.addApiKey(apiKey, secretKey, exchangeId, apiNickname, fixApiAssign)

add exchange api key

Kind: instance method of BincentiveClient

Param	Type
apiKey	string
secretKey	string
exchangeId	number
apiNickname	string
fixApiAssign	boolean

bincentiveClient.deleteApiKey(exchangeId)

delete exchange api key by id

Kind: instance method of BincentiveClient

Param	Type
exchangeId	number

bincentiveClient.getApiKeyList()

get exchange api key list

Kind: instance method of BincentiveClient