## toobit{docsify-ignore} **Kind**: global class **Extends**: Exchange * [fetchStatus](#fetchstatus) * [fetchTime](#fetchtime) * [fetchCurrencies](#fetchcurrencies) * [fetchMarkets](#fetchmarkets) * [fetchOrderBook](#fetchorderbook) * [fetchTrades](#fetchtrades) * [fetchOHLCV](#fetchohlcv) * [fetchTickers](#fetchtickers) * [fetchLastPrices](#fetchlastprices) * [fetchBidsAsks](#fetchbidsasks) * [fetchFundingRates](#fetchfundingrates) * [fetchFundingRateHistory](#fetchfundingratehistory) * [fetchBalance](#fetchbalance) * [createOrder](#createorder) * [cancelOrder](#cancelorder) * [cancelAllOrders](#cancelallorders) * [cancelOrders](#cancelorders) * [fetchOrder](#fetchorder) * [fetchOpenOrders](#fetchopenorders) * [fetchOrders](#fetchorders) * [fetchClosedOrders](#fetchclosedorders) * [fetchMyTrades](#fetchmytrades) * [transfer](#transfer) * [fetchLedger](#fetchledger) * [fetchTradingFees](#fetchtradingfees) * [fetchDeposits](#fetchdeposits) * [fetchWithdrawals](#fetchwithdrawals) * [fetchDepositAddress](#fetchdepositaddress) * [withdraw](#withdraw) * [setMarginMode](#setmarginmode) * [setLeverage](#setleverage) * [fetchLeverage](#fetchleverage) * [fetchPositions](#fetchpositions) * [watchTrades](#watchtrades) * [watchTradesForSymbols](#watchtradesforsymbols) * [watchOHLCV](#watchohlcv) * [watchOHLCVForSymbols](#watchohlcvforsymbols) * [watchTicker](#watchticker) * [watchTickers](#watchtickers) * [watchOrderBook](#watchorderbook) * [watchOrderBookForSymbols](#watchorderbookforsymbols) * [watchBalance](#watchbalance) * [watchOrders](#watchorders) * [watchMyTrades](#watchmytrades) * [watchPositions](#watchpositions) ### fetchStatus{docsify-ignore} the latest known information on the availability of the exchange API **Kind**: instance method of [toobit](#toobit) **Returns**: object - a [status structure](https://docs.ccxt.com/?id=exchange-status-structure) **See**: https://toobit-docs.github.io/apidocs/spot/v1/en/#test-connectivity | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript toobit.fetchStatus (params?) ``` ### fetchTime{docsify-ignore} fetches the current integer timestamp in milliseconds from the exchange server **Kind**: instance method of [toobit](#toobit) **Returns**: int - the current integer timestamp in milliseconds from the exchange server **See**: https://api-docs.toobit.com/api/spot-market-data.html#check-server-time | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript toobit.fetchTime (params?) ``` ### fetchCurrencies{docsify-ignore} fetches all available currencies on an exchange **Kind**: instance method of [toobit](#toobit) **Returns**: object - an associative dictionary of currencies **See**: https://api-docs.toobit.com/api/spot-market-data.html#exchange-information | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript toobit.fetchCurrencies (params?) ``` ### fetchMarkets{docsify-ignore} retrieves data on all markets for toobit **Kind**: instance method of [toobit](#toobit) **Returns**: Array<object> - an array of objects representing market data **See** - https://api-docs.toobit.com/api/spot-market-data.html#exchange-information - https://api-docs.toobit.com/api/usdt-m-market-data.html#exchange-information | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript toobit.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 [toobit](#toobit) **Returns**: object - an [order book structure](https://docs.ccxt.com/?id=order-book-structure) **See** - https://api-docs.toobit.com/api/spot-market-data.html#order-book - https://api-docs.toobit.com/api/usdt-m-market-data.html#order-book | 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 toobit.fetchOrderBook (symbol, limit?, params?) ``` ### fetchTrades{docsify-ignore} get a list of the most recent trades for a particular symbol **Kind**: instance method of [toobit](#toobit) **Returns**: Array<Trade> - a list of [trade structures](https://docs.ccxt.com/?id=public-trades) **See** - https://api-docs.toobit.com/api/spot-market-data.html#recent-trades-list - https://api-docs.toobit.com/api/usdt-m-market-data.html#recent-trades-list | 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 number of trades to fetch | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript toobit.fetchTrades (symbol, since?, 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 [toobit](#toobit) **Returns**: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume **See** - https://api-docs.toobit.com/api/spot-market-data.html#kline-candlestick-data - https://api-docs.toobit.com/api/usdt-m-market-data.html#kline-candlestick-data - https://api-docs.toobit.com/api/usdt-m-market-data.html#index-price-kline-candlestick-data - https://api-docs.toobit.com/api/usdt-m-market-data.html#mark-price-kline-candlestick-data | 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 toobit.fetchOHLCV (symbol, timeframe, since?, 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 [toobit](#toobit) **Returns**: object - a dictionary of [ticker structures](https://docs.ccxt.com/?id=ticker-structure) **See** - https://api-docs.toobit.com/api/spot-market-data.html#_24hr-ticker-price-change-statistics - https://api-docs.toobit.com/api/usdt-m-market-data.html#_24hr-ticker-price-change-statistics | 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 toobit.fetchTickers (symbols, params?) ``` ### fetchLastPrices{docsify-ignore} fetches the last price for multiple markets **Kind**: instance method of [toobit](#toobit) **Returns**: object - a dictionary of lastprices structures **See** - https://api-docs.toobit.com/api/spot-market-data.html#symbol-price-ticker - https://toobit-docs.github.io/apidocs/usdt_swap/v1/en/#symbol-price-ticker | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string>, undefined | Yes | unified symbols of the markets to fetch the last prices | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript toobit.fetchLastPrices (symbols, params?) ``` ### fetchBidsAsks{docsify-ignore} fetches the bid and ask price and volume for multiple markets **Kind**: instance method of [toobit](#toobit) **Returns**: object - a dictionary of [ticker structures](https://docs.ccxt.com/?id=ticker-structure) **See** - https://api-docs.toobit.com/api/spot-market-data.html#symbol-order-book-ticker - https://toobit-docs.github.io/apidocs/usdt_swap/v1/en/#symbol-order-book-ticker | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string> | No | unified symbols of the markets to fetch the bids and asks for, all markets are returned if not assigned | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript toobit.fetchBidsAsks (symbols?, params?) ``` ### fetchFundingRates{docsify-ignore} fetch the funding rate for multiple markets **Kind**: instance method of [toobit](#toobit) **Returns**: Array<object> - a list of [funding rates structures](https://docs.ccxt.com/?id=funding-rates-structure), indexed by market symbols **See**: https://api-docs.toobit.com/api/usdt-m-market-data.html#funding-rate | 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 toobit.fetchFundingRates (symbols, params?) ``` ### fetchFundingRateHistory{docsify-ignore} fetches historical funding rate prices **Kind**: instance method of [toobit](#toobit) **Returns**: Array<object> - a list of [funding rate structures](https://docs.ccxt.com/?id=funding-rate-history-structure) **See**: https://api-docs.toobit.com/api/usdt-m-market-data.html#get-funding-rate-history | 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](https://docs.ccxt.com/?id=funding-rate-history-structure) to fetch | | params | object | No | extra parameters specific to the exchange API endpoint | | params.until | int | No | timestamp in ms of the latest funding rate to fetch | | params.paginate | boolean | No | default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the [availble parameters](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params) | ```javascript toobit.fetchFundingRateHistory (symbol, since?, limit?, 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 [toobit](#toobit) **Returns**: object - a [balance structure](https://docs.ccxt.com/?id=balance-structure) **See** - https://api-docs.toobit.com/api/spot-account-and-trading.html#account-information-user-data - https://api-docs.toobit.com/api/usdt-m-account-and-trading.html#futures-account-balance-user-data | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript toobit.fetchBalance (params?) ``` ### createOrder{docsify-ignore} create a trade order **Kind**: instance method of [toobit](#toobit) **Returns**: object - an [order structure](https://docs.ccxt.com/?id=order-structure) **See** - https://api-docs.toobit.com/api/spot-account-and-trading.html#new-order-trade - https://api-docs.toobit.com/api/usdt-m-account-and-trading.html#new-order-trade | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to create an order in | | type | string | Yes | 'market', '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.cost | float | No | *spot market buy only* the quote quantity that can be used as an alternative for the amount | ```javascript toobit.createOrder (symbol, type, side, amount, price?, params?) ``` ### cancelOrder{docsify-ignore} cancels an open order **Kind**: instance method of [toobit](#toobit) **Returns**: object - An [order structure](https://docs.ccxt.com/?id=order-structure) **See** - https://api-docs.toobit.com/api/spot-account-and-trading.html#cancel-order-trade - https://api-docs.toobit.com/api/usdt-m-account-and-trading.html#cancel-order-trade | 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 toobit.cancelOrder (id, symbol, params?) ``` ### cancelAllOrders{docsify-ignore} cancel all open orders in a market **Kind**: instance method of [toobit](#toobit) **Returns**: Array<object> - a list of [order structures](https://docs.ccxt.com/?id=order-structure) **See** - https://api-docs.toobit.com/api/spot-account-and-trading.html#cancel-all-open-orders-trade - https://api-docs.toobit.com/api/usdt-m-account-and-trading.html#cancel-orders-trade | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript toobit.cancelAllOrders (symbol, params?) ``` ### cancelOrders{docsify-ignore} cancel multiple orders **Kind**: instance method of [toobit](#toobit) **Returns**: object - an list of [order structures](https://docs.ccxt.com/?id=order-structure) **See** - https://api-docs.toobit.com/api/spot-account-and-trading.html#cancel-multiple-orders-trade - https://api-docs.toobit.com/api/usdt-m-account-and-trading.html#cancel-multiple-orders-trade | Param | Type | Required | Description | | --- | --- | --- | --- | | ids | Array<string> | Yes | order ids | | symbol | string | No | unified market symbol | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript toobit.cancelOrders (ids, symbol?, params?) ``` ### fetchOrder{docsify-ignore} fetches information on an order made by the user **Kind**: instance method of [toobit](#toobit) **Returns**: object - An [order structure](https://docs.ccxt.com/?id=order-structure) **See** - https://api-docs.toobit.com/api/spot-account-and-trading.html#query-order-user-data - https://api-docs.toobit.com/api/usdt-m-account-and-trading.html#query-order-user-data | Param | Type | Required | Description | | --- | --- | --- | --- | | id | string | Yes | the 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 toobit.fetchOrder (id, symbol, params?) ``` ### fetchOpenOrders{docsify-ignore} fetches information on multiple orders made by the user **Kind**: instance method of [toobit](#toobit) **Returns**: Array<Order> - a list of [order structures](https://docs.ccxt.com/?id=order-structure) **See** - https://api-docs.toobit.com/api/spot-account-and-trading.html#current-open-orders-user-data - https://api-docs.toobit.com/api/usdt-m-account-and-trading.html#query-current-open-order-user-data | 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 order structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript toobit.fetchOpenOrders (symbol, since?, limit?, params?) ``` ### fetchOrders{docsify-ignore} fetches information on multiple orders made by the user **Kind**: instance method of [toobit](#toobit) **Returns**: Array<Order> - a list of [order structures](https://docs.ccxt.com/?id=order-structure) **See**: https://api-docs.toobit.com/api/spot-account-and-trading.html#all-orders-user-data | 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 order structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript toobit.fetchOrders (symbol, since?, limit?, params?) ``` ### fetchClosedOrders{docsify-ignore} fetches information on multiple closed orders made by the user **Kind**: instance method of [toobit](#toobit) **Returns**: Array<Order> - a list of [order structures](https://docs.ccxt.com/?id=order-structure) **See**: https://api-docs.toobit.com/api/usdt-m-account-and-trading.html#query-history-orders-user-data | 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 order structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript toobit.fetchClosedOrders (symbol, since?, limit?, params?) ``` ### fetchMyTrades{docsify-ignore} fetch all trades made by the user **Kind**: instance method of [toobit](#toobit) **Returns**: Array<Trade> - a list of [trade structures](https://docs.ccxt.com/?id=trade-structure) **See** - https://api-docs.toobit.com/api/spot-account-and-trading.html#account-trade-list-user-data - https://api-docs.toobit.com/api/usdt-m-account-and-trading.html#account-trade-list-user-data | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | No | unified market symbol | | 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 | | params.until | int | No | the latest time in ms to fetch trades for | ```javascript toobit.fetchMyTrades (symbol?, since?, limit?, params?) ``` ### transfer{docsify-ignore} transfer currency internally between wallets on the same account **Kind**: instance method of [toobit](#toobit) **Returns**: object - a [transfer structure](https://docs.ccxt.com/?id=transfer-structure) **See**: https://api-docs.toobit.com/api/spot-account-and-trading.html#account-transfer | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code | | amount | float | Yes | amount to transfer | | fromAccount | string | Yes | 'spot', 'swap' | | toAccount | string | Yes | 'spot', 'swap' | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript toobit.transfer (code, amount, fromAccount, toAccount, params?) ``` ### fetchLedger{docsify-ignore} fetch the history of changes, actions done by the user or operations that altered the balance of the user **Kind**: instance method of [toobit](#toobit) **Returns**: object - a [ledger structure](https://docs.ccxt.com/?id=ledger-entry-structure) **See** - https://api-docs.toobit.com/api/spot-account-and-trading.html#get-account-transaction-history-list-user-data - https://api-docs.toobit.com/api/usdt-m-account-and-trading.html#get-futures-account-transaction-history-list-user-data | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | No | unified currency code, default is undefined | | since | int | No | timestamp in ms of the earliest ledger entry, default is undefined | | limit | int | No | max number of ledger entries to return, default is undefined | | params | object | No | extra parameters specific to the exchange API endpoint | | params.until | int | No | end time in ms | ```javascript toobit.fetchLedger (code?, since?, limit?, params?) ``` ### fetchTradingFees{docsify-ignore} fetch the trading fees for multiple markets **Kind**: instance method of [toobit](#toobit) **Returns**: object - a dictionary of [fee structures](https://docs.ccxt.com/?id=fee-structure) indexed by market symbols **See**: https://api-docs.toobit.com/api/usdt-m-account-and-trading.html#user-trade-fee-rate-user-data | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript toobit.fetchTradingFees (params?) ``` ### fetchDeposits{docsify-ignore} fetch all deposits made to an account **Kind**: instance method of [toobit](#toobit) **Returns**: Array<object> - a list of [transaction structures](https://docs.ccxt.com/?id=transaction-structure) **See**: https://api-docs.toobit.com/api/spot-wallet.html#deposit-history-user-data | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | No | unified currency code | | since | int | No | the earliest time in ms to fetch deposits for | | limit | int | No | the maximum number of deposit structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript toobit.fetchDeposits (code?, since?, limit?, params?) ``` ### fetchWithdrawals{docsify-ignore} fetch all withdrawals made from an account **Kind**: instance method of [toobit](#toobit) **Returns**: Array<object> - a list of [transaction structures](https://docs.ccxt.com/?id=transaction-structure) **See**: https://api-docs.toobit.com/api/spot-wallet.html#withdrawal-records-user-data | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | No | unified currency code | | since | int | No | the earliest time in ms to fetch withdrawals for | | limit | int | No | the maximum number of withdrawal structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript toobit.fetchWithdrawals (code?, since?, limit?, params?) ``` ### fetchDepositAddress{docsify-ignore} fetch the deposit address for a currency associated with this account **Kind**: instance method of [toobit](#toobit) **Returns**: object - an [address structure](https://docs.ccxt.com/?id=address-structure) **See**: https://api-docs.toobit.com/api/spot-wallet.html#deposit-address-user-data | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript toobit.fetchDepositAddress (code, params?) ``` ### withdraw{docsify-ignore} make a withdrawal **Kind**: instance method of [toobit](#toobit) **Returns**: object - a [transaction structure](https://docs.ccxt.com/?id=transaction-structure) **See**: https://api-docs.toobit.com/api/spot-wallet.html#withdraw-user-data | 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 | a memo for the transaction | | params | object | No | extra parameters specific to the exchange API endpoint | | params.addressType | string | No | recipient identifier type, one of BLOCK_CHAIN, PHONE_NUMBER, EMAIL, or UID | ```javascript toobit.withdraw (code, amount, address, tag, params?) ``` ### setMarginMode{docsify-ignore} set margin mode to 'cross' or 'isolated' **Kind**: instance method of [toobit](#toobit) **Returns**: object - response from the exchange **See**: https://api-docs.toobit.com/api/usdt-m-account-and-trading.html#change-margin-type-trade | Param | Type | Required | Description | | --- | --- | --- | --- | | marginMode | string | Yes | 'cross' or 'isolated' | | symbol | string | Yes | unified market symbol | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript toobit.setMarginMode (marginMode, symbol, params?) ``` ### setLeverage{docsify-ignore} set the level of leverage for a market **Kind**: instance method of [toobit](#toobit) **Returns**: object - response from the exchange **See**: https://api-docs.toobit.com/api/usdt-m-account-and-trading.html#change-initial-leverage-trade | Param | Type | Required | Description | | --- | --- | --- | --- | | leverage | float | Yes | the rate of leverage | | symbol | string | Yes | unified market symbol | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript toobit.setLeverage (leverage, symbol, params?) ``` ### fetchLeverage{docsify-ignore} fetch the set leverage for a market **Kind**: instance method of [toobit](#toobit) **Returns**: object - a [leverage structure](https://docs.ccxt.com/?id=leverage-structure) **See**: https://api-docs.toobit.com/api/usdt-m-account-and-trading.html#get-the-leverage-multiple-and-position-mode-user-data | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript toobit.fetchLeverage (symbol, params?) ``` ### fetchPositions{docsify-ignore} fetch all open positions **Kind**: instance method of [toobit](#toobit) **Returns**: Array<object> - a list of [position structures](https://docs.ccxt.com/?id=position-structure) **See**: https://api-docs.toobit.com/api/usdt-m-account-and-trading.html#query-position-user-data | 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 toobit.fetchPositions (symbols, params?) ``` ### watchTrades{docsify-ignore} watches information on multiple trades made in a market **Kind**: instance method of [toobit](#toobit) **Returns**: Array<object> - a list of [trade structures](https://docs.ccxt.com/?id=trade-structure) **See**: https://api-docs.toobit.com/api/spot-websocket-market-data.html#trade-streams | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol of the market trades were made in | | 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 toobit.watchTrades (symbol, since?, limit?, params?) ``` ### watchTradesForSymbols{docsify-ignore} get the list of most recent trades for a list of symbols **Kind**: instance method of [toobit](#toobit) **Returns**: Array<object> - a list of [trade structures](https://docs.ccxt.com/?id=public-trades) **See**: https://api-docs.toobit.com/api/spot-websocket-market-data.html#trade-streams | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<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.name | string | No | the name of the method to call, 'trade' or 'aggTrade', default is 'trade' | ```javascript toobit.watchTradesForSymbols (symbols, since?, limit?, params?) ``` ### watchOHLCV{docsify-ignore} watches historical candlestick data containing the open, high, low, and close price, and the volume of a market **Kind**: instance method of [toobit](#toobit) **Returns**: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume **See** - https://api-docs.toobit.com/api/spot-websocket-market-data.html#kline-candlestick-streams - https://api-docs.toobit.com/api/usdt-m-websocket-market-data.html#kline-candlestick-streams | 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 toobit.watchOHLCV (symbol, timeframe, since?, limit?, params?) ``` ### watchOHLCVForSymbols{docsify-ignore} watches historical candlestick data containing the open, high, low, and close price, and the volume of a market **Kind**: instance method of [toobit](#toobit) **Returns**: object - A list of candles ordered as timestamp, open, high, low, close, volume **See** - https://api-docs.toobit.com/api/spot-websocket-market-data.html#kline-candlestick-streams - https://api-docs.toobit.com/api/usdt-m-websocket-market-data.html#kline-candlestick-streams | 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 toobit.watchOHLCVForSymbols (symbolsAndTimeframes, 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 [toobit](#toobit) **Returns**: object - a [ticker structure](https://docs.ccxt.com/?id=ticker-structure) **See** - https://api-docs.toobit.com/api/spot-websocket-market-data.html#individual-symbol-ticker-streams - https://api-docs.toobit.com/api/usdt-m-websocket-market-data.html#individual-symbol-ticker-streams | 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 toobit.watchTicker (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 [toobit](#toobit) **Returns**: object - a [ticker structure](https://docs.ccxt.com/?id=ticker-structure) **See** - https://api-docs.toobit.com/api/spot-websocket-market-data.html#individual-symbol-ticker-streams - https://api-docs.toobit.com/api/usdt-m-websocket-market-data.html#individual-symbol-ticker-streams | 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 toobit.watchTickers (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 [toobit](#toobit) **Returns**: object - A dictionary of [order book structures](https://docs.ccxt.com/?id=order-book-structure) **See** - https://api-docs.toobit.com/api/spot-websocket-market-data.html#partial-book-depth-streams - https://api-docs.toobit.com/api/spot-websocket-market-data.html#diff-depth-stream - https://api-docs.toobit.com/api/usdt-m-websocket-market-data.html#partial-book-depth-streams - https://api-docs.toobit.com/api/usdt-m-websocket-market-data.html#diff-book-depth-streams | 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 toobit.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 [toobit](#toobit) **Returns**: object - an [order book structure](https://docs.ccxt.com/?id=order-book-structure) **See** - https://api-docs.toobit.com/api/spot-websocket-market-data.html#partial-book-depth-streams - https://api-docs.toobit.com/api/spot-websocket-market-data.html#diff-depth-stream - https://api-docs.toobit.com/api/usdt-m-websocket-market-data.html#partial-book-depth-streams - https://api-docs.toobit.com/api/usdt-m-websocket-market-data.html#diff-book-depth-streams | 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 | ```javascript toobit.watchOrderBookForSymbols (symbols, limit?, params?) ``` ### watchBalance{docsify-ignore} query for balance and get the amount of funds available for trading or funds locked in orders **Kind**: instance method of [toobit](#toobit) **Returns**: object - a [balance structure](https://docs.ccxt.com/?id=balance-structure) **See** - https://api-docs.toobit.com/api/spot-websocket-account.html#payload-account-update - https://api-docs.toobit.com/api/usdt-m-websocket-account.html#event-balance | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript toobit.watchBalance (params?) ``` ### watchOrders{docsify-ignore} watches information on multiple orders made by the user **Kind**: instance method of [toobit](#toobit) **Returns**: Array<object> - a list of [order structures](https://docs.ccxt.com/?id=order-structure) **See** - https://api-docs.toobit.com/api/spot-websocket-account.html#payload-order-update - https://api-docs.toobit.com/api/usdt-m-websocket-account.html#event-order | 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 order structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript toobit.watchOrders (symbol, since?, limit?, params?) ``` ### watchMyTrades{docsify-ignore} watches information on multiple trades made by the user **Kind**: instance method of [toobit](#toobit) **Returns**: Array<object> - a list of [trade structures](https://docs.ccxt.com/?id=trade-structure) **See** - https://api-docs.toobit.com/api/spot-websocket-account.html#payload-ticket-push - https://api-docs.toobit.com/api/usdt-m-websocket-account.html#event-trade-update | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol of the market trades were made in | | 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 | | params.unifiedMargin | boolean | No | use unified margin account | ```javascript toobit.watchMyTrades (symbol, since?, limit?, params?) ``` ### watchPositions{docsify-ignore} watch all open positions **Kind**: instance method of [toobit](#toobit) **Returns**: Array<object> - a list of [position structure](https://docs.ccxt.com/en/latest/manual.html#position-structure) **See**: https://api-docs.toobit.com/api/usdt-m-websocket-account.html#event-position-update | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string> | No | list of unified market symbols | | 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 toobit.watchPositions (symbols?, since?, limit?, params) ```