backpack
backpack cryptocurrency exchange — CCXT unified API: methods, parameters and endpoints.
backpack
Kind: global class
Extends: Exchange
- fetchCurrencies
- fetchMarkets
- fetchTickers
- fetchTicker
- fetchOrderBook
- fetchOHLCV
- fetchFundingRate
- fetchOpenInterest
- fetchFundingRateHistory
- fetchTrades
- fetchMyTrades
- fetchStatus
- fetchTime
- fetchBalance
- fetchDeposits
- fetchWithdrawals
- withdraw
- fetchDepositAddress
- createOrder
- createOrders
- fetchOpenOrders
- fetchOpenOrder
- cancelOrder
- cancelAllOrders
- fetchOrders
- fetchPositions
- fetchFundingHistory
- watchTicker
- unWatchTicker
- watchTickers
- unWatchTickers
- watchBidsAsks
- unWatchBidsAsks
- watchOHLCV
- unWatchOHLCV
- watchOHLCVForSymbols
- unWatchOHLCVForSymbols
- watchTrades
- unWatchTrades
- watchTradesForSymbols
- unWatchTradesForSymbols
- watchOrderBook
- watchOrderBookForSymbols
- unWatchOrderBook
- unWatchOrderBookForSymbols
- watchOrders
- unWatchOrders
- watchPositions
- unWatchPositions
fetchCurrencies
fetches all available currencies on an exchange
Kind: instance method of 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 |
backpack.fetchCurrencies (params?)fetchMarkets
retrieves data on all markets for bitbank
Kind: instance method of 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 |
backpack.fetchMarkets (params?)fetchTickers
fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
Kind: instance method of backpack
Returns: object - a dictionary of ticker structures
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 |
backpack.fetchTickers (symbols, params?)fetchTicker
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
Returns: object - a 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 |
backpack.fetchTicker (symbol, params?)fetchOrderBook
fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of backpack
Returns: object - A dictionary of order book structures 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 |
backpack.fetchOrderBook (symbol, limit?, params?)fetchOHLCV
fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of 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 |
backpack.fetchOHLCV (symbol, timeframe, since?, limit?, params?)fetchFundingRate
fetch the current funding rate
Kind: instance method of backpack
Returns: object - a 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 |
backpack.fetchFundingRate (symbol, params?)fetchOpenInterest
Retrieves the open interest of a derivative trading pair
Kind: instance method of backpack
Returns: object - an open interest structure/docs/manual#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 |
backpack.fetchOpenInterest (symbol, params?)fetchFundingRateHistory
fetches historical funding rate prices
Kind: instance method of backpack
Returns: Array<object> - a list of funding rate structures
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 |
backpack.fetchFundingRateHistory (symbol, since?, limit?, params?)fetchTrades
get the list of most recent trades for a particular symbol
Kind: instance method of backpack
Returns: Array<Trade> - a list of trade structures
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 |
backpack.fetchTrades (symbol, since?, limit?, params?)fetchMyTrades
fetch all trades made by the user
Kind: instance method of backpack
Returns: Array<Trade> - a list of trade structures
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' |
backpack.fetchMyTrades (symbol, since?, limit?, params?)fetchStatus
the latest known information on the availability of the exchange API
Kind: instance method of backpack
Returns: object - a 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 |
backpack.fetchStatus (params?)fetchTime
fetches the current integer timestamp in milliseconds from the exchange server
Kind: instance method of 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 |
backpack.fetchTime (params?)fetchBalance
query for balance and get the amount of funds available for trading or funds locked in orders
Kind: instance method of backpack
Returns: object - a 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 |
backpack.fetchBalance (params?)fetchDeposits
fetch all deposits made to an account
Kind: instance method of backpack
Returns: Array<object> - a list of transaction structures
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 |
backpack.fetchDeposits (code, since?, limit?, params?)fetchWithdrawals
fetch all withdrawals made from an account
Kind: instance method of backpack
Returns: Array<object> - a list of transaction structures
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) |
backpack.fetchWithdrawals (code, since?, limit?, params?)withdraw
make a withdrawal
Kind: instance method of backpack
Returns: object - a 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 | Yes | the network to withdraw on (mandatory) |
backpack.withdraw (code, amount, address, tag, params?)fetchDepositAddress
fetch the deposit address for a currency associated with this account
Kind: instance method of backpack
Returns: object - an 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) |
backpack.fetchDepositAddress (code, params?)createOrder
create a trade order
Kind: instance method of backpack
Returns: object - an 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) |
backpack.createOrder (symbol, type, side, amount, price?, params?)createOrders
create a list of trade orders
Kind: instance method of backpack
Returns: object - an 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 |
backpack.createOrders (orders, params?)fetchOpenOrders
fetch all unfilled currently open orders
Kind: instance method of backpack
Returns: Array<Order> - a list of order structures
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 |
backpack.fetchOpenOrders (symbol, since?, limit?, params?)fetchOpenOrder
fetch an open order by it's id
Kind: instance method of backpack
Returns: object - an 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 |
backpack.fetchOpenOrder (id, symbol, params?)cancelOrder
cancels an open order
Kind: instance method of backpack
Returns: object - An 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 |
backpack.cancelOrder (id, symbol, params?)cancelAllOrders
cancel all open orders
Kind: instance method of backpack
Returns: Array<object> - a list of order structures
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 |
backpack.cancelAllOrders (symbol, params?)fetchOrders
fetches information on multiple orders made by the user
Kind: instance method of backpack
Returns: Array<Order> - a list of order structures
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 |
backpack.fetchOrders (symbol, since?, limit?, params?)fetchPositions
fetch all open positions
Kind: instance method of backpack
Returns: Array<object> - a list of 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 |
backpack.fetchPositions (symbols, params?)fetchFundingHistory
fetches the history of funding payments
Kind: instance method of backpack
Returns: Array<Trade> - a list of trade structures
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) |
backpack.fetchFundingHistory (symbol, since?, limit?, params?)watchTicker
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
Returns: object - a 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 |
backpack.watchTicker (symbol, params?)unWatchTicker
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
Returns: object - a 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 |
backpack.unWatchTicker (symbol, params?)watchTickers
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
Returns: object - a 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 |
backpack.watchTickers (symbols, params?)unWatchTickers
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
Returns: object - a 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 |
backpack.unWatchTickers (symbols, params?)watchBidsAsks
watches best bid & ask for symbols
Kind: instance method of backpack
Returns: object - a 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 |
backpack.watchBidsAsks (symbols, params?)unWatchBidsAsks
unWatches best bid & ask for symbols
Kind: instance method of backpack
Returns: object - a 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 |
backpack.unWatchBidsAsks (symbols, params?)watchOHLCV
watches historical candlestick data containing the open, high, low, close price, and the volume of a market
Kind: instance method of 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 |
backpack.watchOHLCV (symbol, timeframe, since?, limit?, params?)unWatchOHLCV
watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of 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 |
backpack.unWatchOHLCV (symbol, timeframe, params?)watchOHLCVForSymbols
watches historical candlestick data containing the open, high, low, close price, and the volume of a market
Kind: instance method of 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 |
backpack.watchOHLCVForSymbols (symbolsAndTimeframes, since?, limit?, params?)unWatchOHLCVForSymbols
unWatches historical candlestick data containing the open, high, low, and close price, and the volume of a market
Kind: instance method of 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 |
backpack.unWatchOHLCVForSymbols (symbolsAndTimeframes, params?)watchTrades
watches information on multiple trades made in a market
Kind: instance method of backpack
Returns: object - a 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 |
backpack.watchTrades (symbol, since?, limit?, params?)unWatchTrades
unWatches from the stream channel
Kind: instance method of backpack
Returns: Array<object> - a list of trade structures
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 |
backpack.unWatchTrades (symbol, params?)watchTradesForSymbols
watches information on multiple trades made in a market
Kind: instance method of backpack
Returns: object - a 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 |
backpack.watchTradesForSymbols (symbols, since?, limit?, params?)unWatchTradesForSymbols
unWatches from the stream channel
Kind: instance method of backpack
Returns: Array<object> - a list of trade structures
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 |
backpack.unWatchTradesForSymbols (symbols, params?)watchOrderBook
watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of backpack
Returns: object - A dictionary of order book structures 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 |
backpack.watchOrderBook (symbol, limit?, params?)watchOrderBookForSymbols
watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of backpack
Returns: object - A dictionary of order book structures 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' |
backpack.watchOrderBookForSymbols (symbols, limit?, params?)unWatchOrderBook
unWatches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of backpack
Returns: object - A dictionary of order book structures 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 |
backpack.unWatchOrderBook (symbol, params?)unWatchOrderBookForSymbols
unWatches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
Kind: instance method of backpack
Returns: object - A dictionary of order book structures 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' |
backpack.unWatchOrderBookForSymbols (symbols, params?)watchOrders
watches information on multiple orders made by the user
Kind: instance method of backpack
Returns: Array<object> - a list of order structures
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 |
backpack.watchOrders (symbol?, since?, limit?, params?)unWatchOrders
unWatches information on multiple orders made by the user
Kind: instance method of backpack
Returns: Array<object> - a list of order structures
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 |
backpack.unWatchOrders (symbol?, params?)watchPositions
watch all open positions
Kind: instance method of backpack
Returns: Array<object> - a list of 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 |
backpack.watchPositions (symbols?, since?, limit?, params)unWatchPositions
unWatches from the stream channel
Kind: instance method of backpack
Returns: Array<object> - a list of 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 |
backpack.unWatchPositions (symbols?, params)