## backpack{docsify-ignore} **Kind**: global class **Extends**: Exchange * [fetchCurrencies](#fetchcurrencies) * [fetchMarkets](#fetchmarkets) * [fetchTickers](#fetchtickers) * [fetchTicker](#fetchticker) * [fetchOrderBook](#fetchorderbook) * [fetchOHLCV](#fetchohlcv) * [fetchFundingRate](#fetchfundingrate) * [fetchOpenInterest](#fetchopeninterest) * [fetchFundingRateHistory](#fetchfundingratehistory) * [fetchTrades](#fetchtrades) * [fetchMyTrades](#fetchmytrades) * [fetchStatus](#fetchstatus) * [fetchTime](#fetchtime) * [fetchBalance](#fetchbalance) * [fetchDeposits](#fetchdeposits) * [fetchWithdrawals](#fetchwithdrawals) * [withdraw](#withdraw) * [fetchDepositAddress](#fetchdepositaddress) * [createOrder](#createorder) * [createOrders](#createorders) * [fetchOpenOrders](#fetchopenorders) * [fetchOpenOrder](#fetchopenorder) * [cancelOrder](#cancelorder) * [cancelAllOrders](#cancelallorders) * [fetchOrders](#fetchorders) * [fetchPositions](#fetchpositions) * [fetchFundingHistory](#fetchfundinghistory) * [watchTicker](#watchticker) * [unWatchTicker](#unwatchticker) * [watchTickers](#watchtickers) * [unWatchTickers](#unwatchtickers) * [watchBidsAsks](#watchbidsasks) * [unWatchBidsAsks](#unwatchbidsasks) * [watchOHLCV](#watchohlcv) * [unWatchOHLCV](#unwatchohlcv) * [watchOHLCVForSymbols](#watchohlcvforsymbols) * [unWatchOHLCVForSymbols](#unwatchohlcvforsymbols) * [watchTrades](#watchtrades) * [unWatchTrades](#unwatchtrades) * [watchTradesForSymbols](#watchtradesforsymbols) * [unWatchTradesForSymbols](#unwatchtradesforsymbols) * [watchOrderBook](#watchorderbook) * [watchOrderBookForSymbols](#watchorderbookforsymbols) * [unWatchOrderBook](#unwatchorderbook) * [unWatchOrderBookForSymbols](#unwatchorderbookforsymbols) * [watchOrders](#watchorders) * [unWatchOrders](#unwatchorders) * [watchPositions](#watchpositions) * [unWatchPositions](#unwatchpositions) ### fetchCurrencies{docsify-ignore} fetches all available currencies on an exchange **Kind**: instance method of [backpack](#backpack) **Returns**: object - an associative dictionary of currencies **See**: https://docs.backpack.exchange/#tag/Assets | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript backpack.fetchCurrencies ([params]) ``` ### fetchMarkets{docsify-ignore} retrieves data on all markets for bitbank **Kind**: instance method of [backpack](#backpack) **Returns**: Array<object> - an array of objects representing market data **See**: https://docs.backpack.exchange/#tag/Markets/operation/get_markets | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript backpack.fetchMarkets ([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 [backpack](#backpack) **Returns**: object - a dictionary of [ticker structures](https://docs.ccxt.com/#/?id=ticker-structure) **See**: https://docs.backpack.exchange/#tag/Markets/operation/get_tickers | 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 | ```javascript backpack.fetchTickers (symbols[, params]) ``` ### fetchTicker{docsify-ignore} fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market **Kind**: instance method of [backpack](#backpack) **Returns**: object - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure) **See**: https://docs.backpack.exchange/#tag/Markets/operation/get_ticker | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch the ticker for | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript backpack.fetchTicker (symbol[, params]) ``` ### fetchOrderBook{docsify-ignore} fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data **Kind**: instance method of [backpack](#backpack) **Returns**: object - A dictionary of [order book structures](https://github.com/ccxt/ccxt/wiki/Manual#order-book-structure) indexed by market symbols **See**: https://docs.backpack.exchange/#tag/Markets/operation/get_depth | 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 (default 100, max 200) | | params | object | No | extra parameters specific to the bitteam api endpoint | ```javascript backpack.fetchOrderBook (symbol[, limit, params]) ``` ### fetchOHLCV{docsify-ignore} fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market **Kind**: instance method of [backpack](#backpack) **Returns**: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume **See**: https://docs.backpack.exchange/#tag/Markets/operation/get_klines | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch OHLCV data for | | timeframe | string | Yes | the length of time each candle represents | | since | int | No | timestamp in seconds of the earliest candle to fetch | | limit | int | No | the maximum amount of candles to fetch (default 100) | | params | object | No | extra parameters specific to the bitteam api endpoint | ```javascript backpack.fetchOHLCV (symbol, timeframe[, since, limit, params]) ``` ### fetchFundingRate{docsify-ignore} fetch the current funding rate **Kind**: instance method of [backpack](#backpack) **Returns**: object - a [funding rate structure](https://docs.ccxt.com/#/?id=funding-rate-structure) **See**: https://docs.backpack.exchange/#tag/Markets/operation/get_mark_prices | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript backpack.fetchFundingRate (symbol[, params]) ``` ### fetchOpenInterest{docsify-ignore} Retrieves the open interest of a derivative trading pair **Kind**: instance method of [backpack](#backpack) **Returns**: object - an open interest structure[https://docs.ccxt.com/#/?id=interest-history-structure](https://docs.ccxt.com/#/?id=interest-history-structure) **See**: https://docs.backpack.exchange/#tag/Markets/operation/get_open_interest | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | Unified CCXT market symbol | | params | object | No | exchange specific parameters | ```javascript backpack.fetchOpenInterest (symbol[, params]) ``` ### fetchFundingRateHistory{docsify-ignore} fetches historical funding rate prices **Kind**: instance method of [backpack](#backpack) **Returns**: Array<object> - a list of [funding rate structures](https://docs.ccxt.com/#/?id=funding-rate-history-structure) **See**: https://docs.backpack.exchange/#tag/Markets/operation/get_funding_interval_rates | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch the funding rate history for | | since | int | No | timestamp in ms of the earliest funding rate to fetch | | limit | int | No | the maximum amount of funding rate structures | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript backpack.fetchFundingRateHistory (symbol[, since, limit, params]) ``` ### fetchTrades{docsify-ignore} get the list of most recent trades for a particular symbol **Kind**: instance method of [backpack](#backpack) **Returns**: Array<Trade> - a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades) **See** - https://docs.backpack.exchange/#tag/Trades/operation/get_recent_trades - https://docs.backpack.exchange/#tag/Trades/operation/get_historical_trades | 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 | | params.offset | int | No | the number of trades to skip, default is 0 | ```javascript backpack.fetchTrades (symbol[, since, limit, params]) ``` ### fetchMyTrades{docsify-ignore} fetch all trades made by the user **Kind**: instance method of [backpack](#backpack) **Returns**: Array<Trade> - a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure) **See**: https://docs.backpack.exchange/#tag/History/operation/get_fills | 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 (default 100, max 1000) | | params | object | No | extra parameters specific to the exchange API endpoint | | params.until | int | No | the latest time in ms to fetch trades for | | params.fillType | string | No | 'User' (default) 'BookLiquidation' or 'Adl' or 'Backstop' or 'Liquidation' or 'AllLiquidation' or 'CollateralConversion' or 'CollateralConversionAndSpotLiquidation' | ```javascript backpack.fetchMyTrades (symbol[, since, limit, params]) ``` ### fetchStatus{docsify-ignore} the latest known information on the availability of the exchange API **Kind**: instance method of [backpack](#backpack) **Returns**: object - a [status structure](https://docs.ccxt.com/#/?id=exchange-status-structure) **See**: https://docs.backpack.exchange/#tag/System/operation/get_status | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript backpack.fetchStatus ([params]) ``` ### fetchTime{docsify-ignore} fetches the current integer timestamp in milliseconds from the exchange server **Kind**: instance method of [backpack](#backpack) **Returns**: int - the current integer timestamp in milliseconds from the exchange server **See**: https://developer-pro.bitmart.com/en/spot/#get-system-time | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript backpack.fetchTime ([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 [backpack](#backpack) **Returns**: object - a [balance structure](https://docs.ccxt.com/#/?id=balance-structure) **See**: https://docs.backpack.exchange/#tag/Capital/operation/get_balances | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript backpack.fetchBalance ([params]) ``` ### fetchDeposits{docsify-ignore} fetch all deposits made to an account **Kind**: instance method of [backpack](#backpack) **Returns**: Array<object> - a list of [transaction structures](https://docs.ccxt.com/#/?id=transaction-structure) **See**: https://docs.backpack.exchange/#tag/Capital/operation/get_deposits | 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 | | params.until | int | No | the latest time in ms to fetch entries for | ```javascript backpack.fetchDeposits (code[, since, limit, params]) ``` ### fetchWithdrawals{docsify-ignore} fetch all withdrawals made from an account **Kind**: instance method of [backpack](#backpack) **Returns**: Array<object> - a list of [transaction structures](https://docs.ccxt.com/#/?id=transaction-structure) **See**: https://docs.backpack.exchange/#tag/Capital/operation/get_withdrawals | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code of the currency transferred | | since | int | No | the earliest time in ms to fetch transfers for (default 24 hours ago) | | limit | int | No | the maximum number of transfer structures to retrieve (default 50, max 200) | | params | object | No | extra parameters specific to the exchange API endpoint | | params.until | int | No | the latest time in ms to fetch transfers for (default time now) | ```javascript backpack.fetchWithdrawals (code[, since, limit, params]) ``` ### withdraw{docsify-ignore} make a withdrawal **Kind**: instance method of [backpack](#backpack) **Returns**: object - a [transaction structure](https://docs.ccxt.com/#/?id=transaction-structure) **See**: https://docs.backpack.exchange/#tag/Capital/operation/request_withdrawal | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code | | amount | float | Yes | the amount to withdraw | | address | string | Yes | the address to withdraw to | | tag | string | Yes | | | params | object | No | extra parameters specific to the exchange API endpoint | | params.network | string | No | the network to withdraw on (mandatory) | ```javascript backpack.withdraw (code, amount, address, tag[, params]) ``` ### fetchDepositAddress{docsify-ignore} fetch the deposit address for a currency associated with this account **Kind**: instance method of [backpack](#backpack) **Returns**: object - an [address structure](https://docs.ccxt.com/#/?id=address-structure) **See**: https://docs.backpack.exchange/#tag/Capital/operation/get_deposit_address | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code | | params | object | No | extra parameters specific to the exchange API endpoint | | params.networkCode | string | No | the network to fetch the deposit address (mandatory) | ```javascript backpack.fetchDepositAddress (code[, params]) ``` ### createOrder{docsify-ignore} create a trade order **Kind**: instance method of [backpack](#backpack) **Returns**: object - an [order structure](https://docs.ccxt.com/#/?id=order-structure) **See**: https://docs.backpack.exchange/#tag/Order/operation/execute_order | 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 fullfilled, in units of the quote currency, ignored in market orders | | params | object | No | extra parameters specific to the exchange API endpoint | | params.cost | float | No | *market orders only* the cost of the order in units of the quote currency (could be used instead of amount) | | params.clientOrderId | int | No | a unique id for the order | | params.postOnly | boolean | No | true to place a post only order | | params.timeInForce | string | No | 'GTC', 'IOC', 'FOK' or 'PO' | | params.reduceOnly | bool | No | *contract only* Indicates if this order is to reduce the size of a position | | params.selfTradePrevention | string | No | one of EXPIRE_MAKER, EXPIRE_TAKER or EXPIRE_BOTH | | params.autoLend | bool | No | *spot margin only* if true then the order can lend | | params.autoLendRedeem | bool | No | *spot margin only* if true then the order can redeem a lend if required | | params.autoBorrow | bool | No | *spot margin only* if true then the order can borrow | | params.autoBorrowRepay | bool | No | *spot margin only* if true then the order can repay a borrow | | params.triggerPrice | float | No | the price that a trigger order is triggered at | | params.takeProfit | object | No | *swap markets only - takeProfit object in params* containing the triggerPrice at which the attached take profit order will be triggered | | params.takeProfit.triggerPrice | float | No | take profit trigger price | | params.takeProfit.price | float | No | take profit order price (if not provided the order will be a market order) | | params.stopLoss | object | No | *swap markets only - stopLoss object in params* containing the triggerPrice at which the attached stop loss order will be triggered | | params.stopLoss.triggerPrice | float | No | stop loss trigger price | | params.stopLoss.price | float | No | stop loss order price (if not provided the order will be a market order) | ```javascript backpack.createOrder (symbol, type, side, amount[, price, params]) ``` ### createOrders{docsify-ignore} create a list of trade orders **Kind**: instance method of [backpack](#backpack) **Returns**: object - an [order structure](https://docs.ccxt.com/#/?id=order-structure) **See**: https://docs.backpack.exchange/#tag/Order/operation/execute_order_batch | Param | Type | Required | Description | | --- | --- | --- | --- | | orders | Array | Yes | list of orders to create, each object should contain the parameters required by createOrder, namely symbol, type, side, amount, price and params | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript backpack.createOrders (orders[, params]) ``` ### fetchOpenOrders{docsify-ignore} fetch all unfilled currently open orders **Kind**: instance method of [backpack](#backpack) **Returns**: Array<Order> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See**: https://docs.backpack.exchange/#tag/Order/operation/get_open_orders | 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 | ```javascript backpack.fetchOpenOrders (symbol[, since, limit, params]) ``` ### fetchOpenOrder{docsify-ignore} fetch an open order by it's id **Kind**: instance method of [backpack](#backpack) **Returns**: object - an [order structure](https://docs.ccxt.com/#/?id=order-structure) **See**: https://docs.backpack.exchange/#tag/Order/operation/get_order | Param | Type | Required | Description | | --- | --- | --- | --- | | id | string | Yes | order id | | symbol | string | Yes | not used by hollaex fetchOpenOrder () | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript backpack.fetchOpenOrder (id, symbol[, params]) ``` ### cancelOrder{docsify-ignore} cancels an open order **Kind**: instance method of [backpack](#backpack) **Returns**: object - An [order structure](https://docs.ccxt.com/#/?id=order-structure) **See**: https://docs.backpack.exchange/#tag/Order/operation/cancel_order | 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 | ```javascript backpack.cancelOrder (id, symbol[, params]) ``` ### cancelAllOrders{docsify-ignore} cancel all open orders **Kind**: instance method of [backpack](#backpack) **Returns**: Array<object> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See**: https://docs.backpack.exchange/#tag/Order/operation/cancel_open_orders | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript backpack.cancelAllOrders (symbol[, params]) ``` ### fetchOrders{docsify-ignore} fetches information on multiple orders made by the user **Kind**: instance method of [backpack](#backpack) **Returns**: Array<Order> - a list of [order structures](https://github.com/ccxt/ccxt/wiki/Manual#order-structure) **See**: https://docs.backpack.exchange/#tag/History/operation/get_order_history | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol of the market orders were made in | | since | int | No | the earliest time in ms to fetch orders for | | limit | int | No | the maximum number of orde structures to retrieve (default 100, max 1000) | | params | object | No | extra parameters specific to the bitteam api endpoint | ```javascript backpack.fetchOrders (symbol[, since, limit, params]) ``` ### fetchPositions{docsify-ignore} fetch all open positions **Kind**: instance method of [backpack](#backpack) **Returns**: Array<object> - a list of [position structure](https://docs.ccxt.com/#/?id=position-structure) **See**: https://docs.backpack.exchange/#tag/Futures/operation/get_positions | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string>, undefined | Yes | list of unified market symbols | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript backpack.fetchPositions (symbols[, params]) ``` ### fetchFundingHistory{docsify-ignore} fetches the history of funding payments **Kind**: instance method of [backpack](#backpack) **Returns**: Array<Trade> - a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades) **See**: https://docs.backpack.exchange/#tag/History/operation/get_funding_payments | 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 (default 24 hours ago) | | limit | int | No | the maximum amount of trades to fetch (default 200, max 500) | | params | object | No | extra parameters specific to the exchange API endpoint | | params.until | int | No | timestamp in ms of the latest trade to fetch (default now) | ```javascript backpack.fetchFundingHistory (symbol[, since, limit, params]) ``` ### watchTicker{docsify-ignore} watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market **Kind**: instance method of [backpack](#backpack) **Returns**: object - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure) **See**: https://docs.backpack.exchange/#tag/Streams/Public/Ticker | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch the ticker for | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript backpack.watchTicker (symbol[, params]) ``` ### unWatchTicker{docsify-ignore} unWatches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market **Kind**: instance method of [backpack](#backpack) **Returns**: object - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure) **See**: https://docs.backpack.exchange/#tag/Streams/Public/Ticker | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch the ticker for | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript backpack.unWatchTicker (symbol[, params]) ``` ### watchTickers{docsify-ignore} watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for all markets of a specific list **Kind**: instance method of [backpack](#backpack) **Returns**: object - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure) **See**: https://docs.backpack.exchange/#tag/Streams/Public/Ticker | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string> | Yes | unified symbol of the market to fetch the ticker for | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript backpack.watchTickers (symbols[, params]) ``` ### unWatchTickers{docsify-ignore} watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for all markets of a specific list **Kind**: instance method of [backpack](#backpack) **Returns**: object - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure) **See**: https://docs.backpack.exchange/#tag/Streams/Public/Ticker | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string> | Yes | unified symbol of the market to fetch the ticker for | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript backpack.unWatchTickers (symbols[, params]) ``` ### watchBidsAsks{docsify-ignore} watches best bid & ask for symbols **Kind**: instance method of [backpack](#backpack) **Returns**: object - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure) **See**: https://docs.backpack.exchange/#tag/Streams/Public/Book-ticker | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string> | Yes | unified symbol of the market to fetch the ticker for | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript backpack.watchBidsAsks (symbols[, params]) ``` ### unWatchBidsAsks{docsify-ignore} unWatches best bid & ask for symbols **Kind**: instance method of [backpack](#backpack) **Returns**: object - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure) | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string> | Yes | unified symbol of the market to fetch the ticker for | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript backpack.unWatchBidsAsks (symbols[, params]) ``` ### watchOHLCV{docsify-ignore} watches historical candlestick data containing the open, high, low, close price, and the volume of a market **Kind**: instance method of [backpack](#backpack) **Returns**: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume **See**: https://docs.backpack.exchange/#tag/Streams/Public/K-Line | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch OHLCV data for | | timeframe | string | Yes | the length of time each candle represents | | since | int | No | timestamp in ms of the earliest candle to fetch | | limit | int | No | the maximum amount of candles to fetch | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript backpack.watchOHLCV (symbol, timeframe[, since, limit, params]) ``` ### unWatchOHLCV{docsify-ignore} watches historical candlestick data containing the open, high, low, and close price, and the volume of a market **Kind**: instance method of [backpack](#backpack) **Returns**: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume **See**: https://docs.backpack.exchange/#tag/Streams/Public/K-Line | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch OHLCV data for | | timeframe | string | Yes | the length of time each candle represents | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript backpack.unWatchOHLCV (symbol, timeframe[, params]) ``` ### watchOHLCVForSymbols{docsify-ignore} watches historical candlestick data containing the open, high, low, close price, and the volume of a market **Kind**: instance method of [backpack](#backpack) **Returns**: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume **See**: https://docs.backpack.exchange/#tag/Streams/Public/K-Line | Param | Type | Required | Description | | --- | --- | --- | --- | | symbolsAndTimeframes | Array<Array<string>> | Yes | array of arrays containing unified symbols and timeframes to fetch OHLCV data for, example [['BTC/USDT', '1m'], ['LTC/USDT', '5m']] | | since | int | No | timestamp in ms of the earliest candle to fetch | | limit | int | No | the maximum amount of candles to fetch | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript backpack.watchOHLCVForSymbols (symbolsAndTimeframes[, since, limit, params]) ``` ### unWatchOHLCVForSymbols{docsify-ignore} unWatches historical candlestick data containing the open, high, low, and close price, and the volume of a market **Kind**: instance method of [backpack](#backpack) **Returns**: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume **See**: https://docs.backpack.exchange/#tag/Streams/Public/K-Line | Param | Type | Required | Description | | --- | --- | --- | --- | | symbolsAndTimeframes | Array<Array<string>> | Yes | array of arrays containing unified symbols and timeframes to fetch OHLCV data for, example [['BTC/USDT', '1m'], ['LTC/USDT', '5m']] | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript backpack.unWatchOHLCVForSymbols (symbolsAndTimeframes[, params]) ``` ### watchTrades{docsify-ignore} watches information on multiple trades made in a market **Kind**: instance method of [backpack](#backpack) **Returns**: object - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure) **See**: https://docs.backpack.exchange/#tag/Streams/Public/Trade | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch the ticker for | | since | int | No | the earliest time in ms to fetch trades for | | limit | int | No | the maximum number of trade structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript backpack.watchTrades (symbol[, since, limit, params]) ``` ### unWatchTrades{docsify-ignore} unWatches from the stream channel **Kind**: instance method of [backpack](#backpack) **Returns**: Array<object> - a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades) **See**: https://docs.backpack.exchange/#tag/Streams/Public/Trade | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch trades for | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript backpack.unWatchTrades (symbol[, params]) ``` ### watchTradesForSymbols{docsify-ignore} watches information on multiple trades made in a market **Kind**: instance method of [backpack](#backpack) **Returns**: object - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure) **See**: https://docs.backpack.exchange/#tag/Streams/Public/Trade | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string> | Yes | unified symbol of the market to fetch trades for | | since | int | No | the earliest time in ms to fetch trades for | | limit | int | No | the maximum number of trade structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript backpack.watchTradesForSymbols (symbols[, since, limit, params]) ``` ### unWatchTradesForSymbols{docsify-ignore} unWatches from the stream channel **Kind**: instance method of [backpack](#backpack) **Returns**: Array<object> - a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades) **See**: https://docs.backpack.exchange/#tag/Streams/Public/Trade | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string> | Yes | unified symbol of the market to fetch trades for | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript backpack.unWatchTradesForSymbols (symbols[, params]) ``` ### watchOrderBook{docsify-ignore} watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data **Kind**: instance method of [backpack](#backpack) **Returns**: object - A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols **See**: https://docs.backpack.exchange/#tag/Streams/Public/Depth | 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 | ```javascript backpack.watchOrderBook (symbol[, limit, params]) ``` ### watchOrderBookForSymbols{docsify-ignore} watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data **Kind**: instance method of [backpack](#backpack) **Returns**: object - A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols **See**: https://docs.backpack.exchange/#tag/Streams/Public/Depth | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string> | Yes | unified array of symbols | | limit | int | No | the maximum amount of order book entries to return | | params | object | No | extra parameters specific to the exchange API endpoint | | params.method | string | No | either '/market/level2' or '/spotMarket/level2Depth5' or '/spotMarket/level2Depth50' default is '/market/level2' | ```javascript backpack.watchOrderBookForSymbols (symbols[, limit, params]) ``` ### unWatchOrderBook{docsify-ignore} unWatches information on open orders with bid (buy) and ask (sell) prices, volumes and other data **Kind**: instance method of [backpack](#backpack) **Returns**: object - A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified array of symbols | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript backpack.unWatchOrderBook (symbol[, params]) ``` ### unWatchOrderBookForSymbols{docsify-ignore} unWatches information on open orders with bid (buy) and ask (sell) prices, volumes and other data **Kind**: instance method of [backpack](#backpack) **Returns**: object - A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string> | Yes | unified array of symbols | | params | object | No | extra parameters specific to the exchange API endpoint | | params.method | string | No | either '/market/level2' or '/spotMarket/level2Depth5' or '/spotMarket/level2Depth50' default is '/market/level2' | ```javascript backpack.unWatchOrderBookForSymbols (symbols[, params]) ``` ### watchOrders{docsify-ignore} watches information on multiple orders made by the user **Kind**: instance method of [backpack](#backpack) **Returns**: Array<object> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See**: https://docs.backpack.exchange/#tag/Streams/Private/Order-update | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | No | unified market symbol of the market orders were made in | | since | int | No | the earliest time in ms to fetch orders for | | limit | int | No | the maximum number of order structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript backpack.watchOrders ([symbol, since, limit, params]) ``` ### unWatchOrders{docsify-ignore} unWatches information on multiple orders made by the user **Kind**: instance method of [backpack](#backpack) **Returns**: Array<object> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See**: https://docs.backpack.exchange/#tag/Streams/Private/Order-update | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | No | unified market symbol of the market orders were made in | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript backpack.unWatchOrders ([symbol, params]) ``` ### watchPositions{docsify-ignore} watch all open positions **Kind**: instance method of [backpack](#backpack) **Returns**: Array<object> - a list of [position structure](https://docs.ccxt.com/en/latest/manual.html#position-structure) **See**: https://docs.backpack.exchange/#tag/Streams/Private/Position-update | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string> | No | list of unified market symbols to watch positions for | | since | int | No | the earliest time in ms to fetch positions for | | limit | int | No | the maximum number of positions to retrieve | | params | object | Yes | extra parameters specific to the exchange API endpoint | ```javascript backpack.watchPositions ([symbols, since, limit, params]) ``` ### unWatchPositions{docsify-ignore} unWatches from the stream channel **Kind**: instance method of [backpack](#backpack) **Returns**: Array<object> - a list of [position structure](https://docs.ccxt.com/en/latest/manual.html#position-structure) **See**: https://docs.backpack.exchange/#tag/Streams/Private/Position-update | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string> | No | list of unified market symbols to watch positions for | | params | object | Yes | extra parameters specific to the exchange API endpoint | ```javascript backpack.unWatchPositions ([symbols, params]) ```