Documentation

Class: BTCMarketsAPI

BTCMarketsAPI

new BTCMarketsAPI()

BTC Markets API Client

Classes

BTCMarketsAPI

Methods

<async> cancelOrders(orderIds)

Parameters:
Name Type Description
orderIds any
Returns:
Type
Promise

<async> createOrder(instrument, currency, price, volume, orderSide, ordertype, clientRequestId)

Parameters:
Name Type Description
instrument string
currency string
price any
volume any
orderSide any
ordertype any
clientRequestId any
Returns:
Type
Promise

<async> getAccountBalances()

Returns:
Type
Promise

<async> getOpenOrders(instrument, currency, limit, since)

Parameters:
Name Type Description
instrument string
currency string
limit number
since any
Returns:
Type
Promise

<async> getOrderBook(instrument, currency)

Parameters:
Name Type Description
instrument String
currency String
Returns:
Type
Promise

<async> getOrderDetail(orderIds)

Parameters:
Name Type Description
orderIds any
Returns:
Type
Promise

<async> getOrderHistory(instrument, currency, limit, since)

Parameters:
Name Type Description
instrument string
currency string
limit number
since any
Returns:
Type
Promise

<async> getTick(instrument, currency)

Parameters:
Name Type Description
instrument String
currency String
Returns:
Type
Promise

<async> getTradeHistory(instrument, currency, limit, since)

Parameters:
Name Type Description
instrument string
currency string
limit number
since any
Returns:
Type
Promise

<async> getTrades(instrument, currency, since)

Parameters:
Name Type Description
instrument string
currency string
since any
Returns:
Type
Promise

<async> getTradingFee(instrument, currency)

Parameters:
Name Type Description
instrument string
currency string
Returns:
Type
Promise

<async> publicRequest(instrument, currency, action, params)

Parameters:
Name Type Description
instrument string
currency string
action any
params any
Returns:
Type
Promise.<object>

signData(path, timestamp [, body])

Parameters:
Name Type Argument Default Description
path any
timestamp any
body string <optional>
 ""
Returns:
Type
Promise

<async> signedRequest(path, params)

Parameters:
Name Type Description
path any
params any
Returns:
Type
Promise

<async> withdrawCrypto(amount, address, currency)

Parameters:
Name Type Description
amount any
address any
currency string
Returns:
Type
Promise

<async> withdrawEFT(accountName, accountNumber, bankName, bsbNumber, amount [, currency])

Parameters:
Name Type Argument Default Description
accountName any
accountNumber any
bankName any
bsbNumber any
amount any
currency string <optional>
 "AUD"
Returns:
Type
Promise

<async> withdrawHistory(limit, since, indexForward)

Parameters:
Name Type Description
limit number | void
since number | void
indexForward boolean | void
Returns:
Type
Promise.<FundWithdrawals>