Bincentive Client Methods

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)

Sets client default timeout

Kind: instance method of BincentiveClient

Param	Type
ms	number

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

Adds an order for a specific strategy

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()

Gets the historical data of all transactions

Kind: instance method of BincentiveClient

bincentiveClient.getOrderInfo(orderId)

Gets Bincentive order number

Kind: instance method of BincentiveClient

Param	Type
orderId	number

bincentiveClient.getAvailableExchanges()

Gets the list of exchanges currently available

Kind: instance method of BincentiveClient

bincentiveClient.getAvailableSymbols(exchange_name)

Gets an exchange's available trading pairs

Kind: instance method of BincentiveClient

Param	Type
exchange_name	string

bincentiveClient.getCurrentPrice(exchange_name, symbol_name)

Gets the current price of a trading pair

Kind: instance method of BincentiveClient

Param	Type
exchange_name	string
symbol_name	string

bincentiveClient.getStrategyList()

Gets the list of strategies

Kind: instance method of BincentiveClient

bincentiveClient.getApprovedStrategyList()

Gets the list of approved strategies

Kind: instance method of BincentiveClient

bincentiveClient.getExchangeList()

Gets the list of exchanges

Kind: instance method of BincentiveClient

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

Adds all the keys of each transaction

Kind: instance method of BincentiveClient

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

bincentiveClient.deleteApiKey(exchangeId)

Deletes all the keys of a transaction

Kind: instance method of BincentiveClient

Param	Type
exchangeId	number

bincentiveClient.getApiKeyList()

Gets API key list

Kind: instance method of BincentiveClient