bitbns

bitbns{docsify-ignore}

Kind: global class
Extends: Exchange

• fetchStatus
• fetchMarkets
• fetchOrderBook
• fetchTickers
• fetchBalance
• createOrder
• cancelOrder
• fetchOrder
• fetchOpenOrders
• fetchMyTrades
• fetchTrades
• fetchDeposits
• fetchWithdrawals
• fetchDepositAddress

fetchStatus{docsify-ignore}

the latest known information on the availability of the exchange API

Kind: instance method of bitbns
Returns: object - a status structure

Param	Type	Required	Description
params	object	No	extra parameters specific to the exchange API endpoint

bitbns.fetchStatus (params?)

fetchMarkets{docsify-ignore}

retrieves data on all markets for bitbns

Kind: instance method of bitbns
Returns: Array<object> - an array of objects representing market data

Param	Type	Required	Description
params	object	No	extra parameters specific to the exchange API endpoint

bitbns.fetchMarkets (params?)

fetchOrderBook{docsify-ignore}

fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data

Kind: instance method of bitbns
Returns: object - A dictionary of order book structures indexed by market symbols

Param	Type	Required	Description
symbol	string	Yes	unified symbol of the market to fetch the order book for
limit	int	No	the maximum amount of order book entries to return
params	object	No	extra parameters specific to the exchange API endpoint

bitbns.fetchOrderBook (symbol, limit?, params?)

fetchTickers{docsify-ignore}

fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market

Kind: instance method of bitbns
Returns: object - a dictionary of ticker structures

Param	Type	Required	Description
symbols	Array<string>, undefined	Yes	unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned
params	object	No	extra parameters specific to the exchange API endpoint

bitbns.fetchTickers (symbols, params?)

fetchBalance{docsify-ignore}

query for balance and get the amount of funds available for trading or funds locked in orders

Kind: instance method of bitbns
Returns: object - a balance structure

Param	Type	Required	Description
params	object	No	extra parameters specific to the exchange API endpoint

bitbns.fetchBalance (params?)

createOrder{docsify-ignore}

create a trade order

Kind: instance method of bitbns
Returns: object - an order structure

See

• https://docs.bitbns.com/bitbns/rest-endpoints/order-apis/version-2/place-orders
• https://docs.bitbns.com/bitbns/rest-endpoints/order-apis/version-1/market-orders-quantity // market orders

Param	Type	Required	Description
symbol	string	Yes	unified symbol of the market to create an order in
type	string	Yes	'market' or 'limit'
side	string	Yes	'buy' or 'sell'
amount	float	Yes	how much of currency you want to trade in units of base currency
price	float	No	the price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
params	object	No	extra parameters specific to the exchange API endpoint
params.triggerPrice	float	No	the price at which a trigger order is triggered at EXCHANGE SPECIFIC PARAMETERS
params.target_rate	float	No	requires params.trail_rate when set, type must be 'limit' a bracket order is placed when set
params.trail_rate	float	No	requires params.target_rate when set, type must be 'limit' a bracket order is placed when set

bitbns.createOrder (symbol, type, side, amount, price?, params?)

cancelOrder{docsify-ignore}

cancels an open order

Kind: instance method of bitbns
Returns: object - An order structure

See

• https://docs.bitbns.com/bitbns/rest-endpoints/order-apis/version-2/cancel-orders
• https://docs.bitbns.com/bitbns/rest-endpoints/order-apis/version-1/cancel-stop-loss-orders

Param	Type	Required	Description
id	string	Yes	order id
symbol	string	Yes	unified symbol of the market the order was made in
params	object	No	extra parameters specific to the exchange API endpoint
params.trigger	boolean	No	true if cancelling a trigger order

bitbns.cancelOrder (id, symbol, params?)

fetchOrder{docsify-ignore}

fetches information on an order made by the user

Kind: instance method of bitbns
Returns: object - An order structure

See: https://docs.bitbns.com/bitbns/rest-endpoints/order-apis/version-1/order-status

Param	Type	Required	Description
id	string	Yes	order id
symbol	string	Yes	unified symbol of the market the order was made in
params	object	No	extra parameters specific to the exchange API endpoint

bitbns.fetchOrder (id, symbol, params?)

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

Kind: instance method of bitbns
Returns: Array<Order> - a list of order structures

See

• https://docs.bitbns.com/bitbns/rest-endpoints/order-apis/version-2/order-status-limit
• https://docs.bitbns.com/bitbns/rest-endpoints/order-apis/version-2/order-status-limit/order-status-stop-limit

Param	Type	Required	Description
symbol	string	Yes	unified market symbol
since	int	No	the earliest time in ms to fetch open orders for
limit	int	No	the maximum number of open orders structures to retrieve
params	object	No	extra parameters specific to the exchange API endpoint
params.trigger	boolean	No	true if fetching trigger orders

bitbns.fetchOpenOrders (symbol, since?, limit?, params?)

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

Kind: instance method of bitbns
Returns: Array<Trade> - a list of trade structures

Param	Type	Required	Description
symbol	string	Yes	unified market symbol
since	int	No	the earliest time in ms to fetch trades for
limit	int	No	the maximum number of trades structures to retrieve
params	object	No	extra parameters specific to the exchange API endpoint

bitbns.fetchMyTrades (symbol, since?, limit?, params?)

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of bitbns
Returns: Array<Trade> - a list of trade structures

Param	Type	Required	Description
symbol	string	Yes	unified symbol of the market to fetch trades for
since	int	No	timestamp in ms of the earliest trade to fetch
limit	int	No	the maximum amount of trades to fetch
params	object	No	extra parameters specific to the exchange API endpoint

bitbns.fetchTrades (symbol, since?, limit?, params?)

fetchDeposits{docsify-ignore}

fetch all deposits made to an account

Kind: instance method of bitbns
Returns: Array<object> - a list of transaction structures

Param	Type	Required	Description
code	string	Yes	unified currency code
since	int	No	the earliest time in ms to fetch deposits for
limit	int	No	the maximum number of deposits structures to retrieve
params	object	No	extra parameters specific to the exchange API endpoint

bitbns.fetchDeposits (code, since?, limit?, params?)

fetchWithdrawals{docsify-ignore}

fetch all withdrawals made from an account

Kind: instance method of bitbns
Returns: Array<object> - a list of transaction structures

Param	Type	Required	Description
code	string	Yes	unified currency code
since	int	No	the earliest time in ms to fetch withdrawals for
limit	int	No	the maximum number of withdrawals structures to retrieve
params	object	No	extra parameters specific to the exchange API endpoint

bitbns.fetchWithdrawals (code, since?, limit?, params?)

fetchDepositAddress{docsify-ignore}

fetch the deposit address for a currency associated with this account

Kind: instance method of bitbns
Returns: object - an address structure

Param	Type	Required	Description
code	string	Yes	unified currency code
params	object	No	extra parameters specific to the exchange API endpoint

bitbns.fetchDepositAddress (code, params?)