ContextQMD
Back to Ccxt

Bitmart

wiki/exchanges/bitmart.md

4.5.5271.2 KB
Original Source

<a name="bitmart" id="bitmart"></a>

bitmart{docsify-ignore}

Kind: global class
Extends: <code>Exchange</code>

<a name="fetchTime" id="fetchtime"></a>

fetchTime{docsify-ignore}

fetches the current integer timestamp in milliseconds from the exchange server

Kind: instance method of <code>bitmart</code>
Returns: <code>int</code> - the current integer timestamp in milliseconds from the exchange server

See: https://developer-pro.bitmart.com/en/spot/#get-system-time

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.fetchTime ([params])

<a name="fetchStatus" id="fetchstatus"></a>

fetchStatus{docsify-ignore}

the latest known information on the availability of the exchange API

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - a status structure

See: https://developer-pro.bitmart.com/en/spot/#get-system-service-status

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.fetchStatus ([params])

<a name="fetchMarkets" id="fetchmarkets"></a>

fetchMarkets{docsify-ignore}

retrieves data on all markets for bitmart

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

See

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.fetchMarkets ([params])

<a name="fetchCurrencies" id="fetchcurrencies"></a>

fetchCurrencies{docsify-ignore}

fetches all available currencies on an exchange

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - an associative dictionary of currencies

See: https://developer-pro.bitmart.com/en/spot/#get-currency-list-v1

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.fetchCurrencies ([params])

<a name="fetchTransactionFee" id="fetchtransactionfee"></a>

fetchTransactionFee{docsify-ignore}

DEPRECATED

please use fetchDepositWithdrawFee instead

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - a fee structure

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.network<code>string</code>Nothe network code of the currency
javascript
bitmart.fetchTransactionFee (code[, params])

<a name="fetchDepositWithdrawFee" id="fetchdepositwithdrawfee"></a>

fetchDepositWithdrawFee{docsify-ignore}

fetch the fee for deposits and withdrawals

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - a fee structure

See: https://developer-pro.bitmart.com/en/spot/#withdraw-quota-keyed

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.network<code>string</code>Nothe network code of the currency
javascript
bitmart.fetchDepositWithdrawFee (code[, params])

<a name="fetchTicker" id="fetchticker"></a>

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 <code>bitmart</code>
Returns: <code>object</code> - a ticker structure

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the ticker for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.fetchTicker (symbol[, params])

<a name="fetchTickers" id="fetchtickers"></a>

fetchTickers{docsify-ignore}

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

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - a dictionary of ticker structures

See

ParamTypeRequiredDescription
symbols<code>Array<string></code>, <code>undefined</code>Yesunified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.fetchTickers (symbols[, params])

<a name="fetchOrderBook" id="fetchorderbook"></a>

fetchOrderBook{docsify-ignore}

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

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - A dictionary of order book structures indexed by market symbols

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the order book for
limit<code>int</code>Nothe maximum amount of order book entries to return
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.fetchOrderBook (symbol[, limit, params])

<a name="fetchTrades" id="fetchtrades"></a>

fetchTrades{docsify-ignore}

get a list of the most recent trades for a particular symbol

Kind: instance method of <code>bitmart</code>
Returns: <code>Array<Trade></code> - a list of trade structures

See: https://developer-pro.bitmart.com/en/spot/#get-recent-trades-v3

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch trades for
since<code>int</code>Notimestamp in ms of the earliest trade to fetch
limit<code>int</code>Nothe maximum number of trades to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.fetchTrades (symbol[, since, limit, params])

<a name="fetchOHLCV" id="fetchohlcv"></a>

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 <code>bitmart</code>
Returns: <code>Array<Array<int>></code> - A list of candles ordered as timestamp, open, high, low, close, volume

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch OHLCV data for
timeframe<code>string</code>Yesthe length of time each candle represents
since<code>int</code>Notimestamp in ms of the earliest candle to fetch
limit<code>int</code>Nothe maximum amount of candles to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Notimestamp of the latest candle in ms
params.paginate<code>boolean</code>Nospot only default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the availble parameters
javascript
bitmart.fetchOHLCV (symbol, timeframe[, since, limit, params])

<a name="fetchMyTrades" id="fetchmytrades"></a>

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

Kind: instance method of <code>bitmart</code>
Returns: <code>Array<Trade></code> - a list of trade structures

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
since<code>int</code>Nothe earliest time in ms to fetch trades for
limit<code>int</code>Nothe maximum number of trades structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Nothe latest time in ms to fetch trades for
params.marginMode<code>boolean</code>Nospot whether to fetch trades for margin orders or spot orders, defaults to spot orders (only isolated margin orders are supported)
params.stpMode<code>string</code>Noself-trade prevention only for spot, defaults to none, ['none', 'cancel_maker', 'cancel_taker', 'cancel_both']
javascript
bitmart.fetchMyTrades (symbol[, since, limit, params])

<a name="fetchOrderTrades" id="fetchordertrades"></a>

fetchOrderTrades{docsify-ignore}

fetch all the trades made from a single order

Kind: instance method of <code>bitmart</code>
Returns: <code>Array<object></code> - a list of trade structures

See: https://developer-pro.bitmart.com/en/spot/#order-trade-list-v4-signed

ParamTypeRequiredDescription
id<code>string</code>Yesorder id
symbol<code>string</code>Yesunified market symbol
since<code>int</code>Nothe earliest time in ms to fetch trades for
limit<code>int</code>Nothe maximum number of trades to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.stpMode<code>string</code>Noself-trade prevention only for spot, defaults to none, ['none', 'cancel_maker', 'cancel_taker', 'cancel_both']
javascript
bitmart.fetchOrderTrades (id, symbol[, since, limit, params])

<a name="fetchBalance" id="fetchbalance"></a>

fetchBalance{docsify-ignore}

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

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - a balance structure

See

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.fetchBalance ([params])

<a name="fetchTradingFee" id="fetchtradingfee"></a>

fetchTradingFee{docsify-ignore}

fetch the trading fees for a market

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - a fee structure

See: https://developer-pro.bitmart.com/en/spot/#get-actual-trade-fee-rate-keyed

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.fetchTradingFee (symbol[, params])

<a name="createMarketBuyOrderWithCost" id="createmarketbuyorderwithcost"></a>

createMarketBuyOrderWithCost{docsify-ignore}

create a market buy order by providing the symbol and cost

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - an order structure

See: https://developer-pro.bitmart.com/en/spot/#new-order-v2-signed

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to create an order in
cost<code>float</code>Yeshow much you want to trade in units of the quote currency
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.createMarketBuyOrderWithCost (symbol, cost[, params])

<a name="createOrder" id="createorder"></a>

createOrder{docsify-ignore}

create a trade order

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - an order structure

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to create an order in
type<code>string</code>Yes'market', 'limit' or 'trailing' for swap markets only
side<code>string</code>Yes'buy' or 'sell'
amount<code>float</code>Yeshow much of currency you want to trade in units of base currency
price<code>float</code>Nothe price at which the order is to be fulfilled, in units of the quote currency, ignored in market orders
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.marginMode<code>string</code>No'cross' or 'isolated'
params.leverage<code>string</code>Noswap only leverage level
params.clientOrderId<code>string</code>Noclient order id of the order
params.reduceOnly<code>boolean</code>Noswap only reduce only
params.postOnly<code>boolean</code>Nomake sure the order is posted to the order book and not matched immediately
params.triggerPrice<code>string</code>Noswap only the price to trigger a stop order
params.price_type<code>int</code>Noswap only 1: last price, 2: fair price, default is 1
params.price_way<code>int</code>Noswap only 1: price way long, 2: price way short
params.activation_price_type<code>int</code>Noswap trailing order only 1: last price, 2: fair price, default is 1
params.trailingPercent<code>string</code>Noswap only the percent to trail away from the current market price, min 0.1 max 5
params.trailingTriggerPrice<code>string</code>Noswap only the price to trigger a trailing order, default uses the price argument
params.stopLossPrice<code>string</code>Noswap only the price to trigger a stop-loss order
params.takeProfitPrice<code>string</code>Noswap only the price to trigger a take-profit order
params.plan_category<code>int</code>Noswap tp/sl only 1: tp/sl, 2: position tp/sl, default is 1
params.stpMode<code>string</code>Noself-trade prevention only for spot, defaults to none, ['none', 'cancel_maker', 'cancel_taker', 'cancel_both']
javascript
bitmart.createOrder (symbol, type, side, amount[, price, params])

<a name="createOrders" id="createorders"></a>

createOrders{docsify-ignore}

create a list of trade orders

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - an order structure

See: https://developer-pro.bitmart.com/en/spot/#new-batch-order-v4-signed

ParamTypeRequiredDescription
orders<code>Array</code>Yeslist of orders to create, each object should contain the parameters required by createOrder, namely symbol, type, side, amount, price and params
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.stpMode<code>string</code>Noself-trade prevention only for spot, defaults to none, ['none', 'cancel_maker', 'cancel_taker', 'cancel_both']
javascript
bitmart.createOrders (orders[, params])

<a name="cancelOrder" id="cancelorder"></a>

cancelOrder{docsify-ignore}

cancels an open order

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - An order structure

See

ParamTypeRequiredDescription
id<code>string</code>Yesorder id
symbol<code>string</code>Yesunified symbol of the market the order was made in
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.clientOrderId<code>string</code>Nospot only the client order id of the order to cancel
params.trailing<code>boolean</code>Noswap only whether the order is a stop order
params.trigger<code>boolean</code>Nowhether the order is a trigger order
params.stopLossTakeProfit<code>boolean</code>Nowhether the order is a stopLossPrice or takeProfitPrice order
javascript
bitmart.cancelOrder (id, symbol[, params])

<a name="cancelOrders" id="cancelorders"></a>

cancelOrders{docsify-ignore}

cancel multiple orders

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - an list of order structures

See: https://developer-pro.bitmart.com/en/spot/#cancel-batch-order-v4-signed

ParamTypeRequiredDescription
ids<code>Array<string></code>Yesorder ids
symbol<code>string</code>Yesunified symbol of the market the order was made in
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.clientOrderIds<code>Array<string></code>Noclient order ids
javascript
bitmart.cancelOrders (ids, symbol[, params])

<a name="cancelAllOrders" id="cancelallorders"></a>

cancelAllOrders{docsify-ignore}

cancel all open orders in a market

Kind: instance method of <code>bitmart</code>
Returns: <code>Array<object></code> - a list of order structures

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market to cancel orders in
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.side<code>string</code>Nospot only 'buy' or 'sell'
params.trigger<code>boolean</code>Nowhether the orders are trigger orders
params.stopLossTakeProfit<code>boolean</code>Nowhether the orders are stopLossPrice or takeProfitPrice orders
javascript
bitmart.cancelAllOrders (symbol[, params])

<a name="fetchOpenOrders" id="fetchopenorders"></a>

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

Kind: instance method of <code>bitmart</code>
Returns: <code>Array<Order></code> - a list of order structures

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
since<code>int</code>Nothe earliest time in ms to fetch open orders for
limit<code>int</code>Nothe maximum number of open order structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.marginMode<code>boolean</code>Nospot whether to fetch trades for margin orders or spot orders, defaults to spot orders (only isolated margin orders are supported)
params.until<code>int</code>Nospot the latest time in ms to fetch orders for
params.type<code>string</code>Noswap order type, 'limit' or 'market'
params.order_state<code>string</code>Noswap the order state, 'all' or 'partially_filled', default is 'all'
params.orderType<code>string</code>Noswap only 'limit', 'market', or 'trailing'
params.trailing<code>boolean</code>Noswap only set to true if you want to fetch trailing orders
params.trigger<code>boolean</code>Noset to true if you want to fetch trigger orders
params.stopLossTakeProfit<code>boolean</code>Noset to true if you want to fetch stopLossPrice or takeProfitPrice orders
params.stpMode<code>string</code>Noself-trade prevention only for spot, defaults to none, ['none', 'cancel_maker', 'cancel_taker', 'cancel_both']
javascript
bitmart.fetchOpenOrders (symbol[, since, limit, params])

<a name="fetchClosedOrders" id="fetchclosedorders"></a>

fetchClosedOrders{docsify-ignore}

fetches information on multiple closed orders made by the user

Kind: instance method of <code>bitmart</code>
Returns: <code>Array<Order></code> - a list of order structures

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market orders were made in
since<code>int</code>Nothe earliest time in ms to fetch orders for
limit<code>int</code>Nothe maximum number of order structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Notimestamp in ms of the latest entry
params.marginMode<code>string</code>Nospot only 'cross' or 'isolated', for margin trading
params.stpMode<code>string</code>Noself-trade prevention only for spot, defaults to none, ['none', 'cancel_maker', 'cancel_taker', 'cancel_both']
params.trigger<code>boolean</code>Noset to true if you want to fetch trigger orders
params.stopLossTakeProfit<code>boolean</code>Noset to true if you want to fetch stopLossPrice or takeProfitPrice orders
javascript
bitmart.fetchClosedOrders (symbol[, since, limit, params])

<a name="fetchCanceledOrders" id="fetchcanceledorders"></a>

fetchCanceledOrders{docsify-ignore}

fetches information on multiple canceled orders made by the user

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - a list of order structures

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market orders were made in
since<code>int</code>Notimestamp in ms of the earliest order, default is undefined
limit<code>int</code>Nomax number of orders to return, default is undefined
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.fetchCanceledOrders (symbol[, since, limit, params])

<a name="fetchOrder" id="fetchorder"></a>

fetchOrder{docsify-ignore}

fetches information on an order made by the user

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - An order structure

See

ParamTypeRequiredDescription
id<code>string</code>Yesthe id of the order
symbol<code>string</code>Yesunified symbol of the market the order was made in
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.clientOrderId<code>string</code>Nospot fetch the order by client order id instead of order id
params.orderType<code>string</code>Noswap only 'limit', 'market', 'liquidate', 'bankruptcy', 'adl' or 'trailing'
params.trailing<code>boolean</code>Noswap only set to true if you want to fetch a trailing order
params.stpMode<code>string</code>Noself-trade prevention only for spot, defaults to none, ['none', 'cancel_maker', 'cancel_taker', 'cancel_both']
params.trigger<code>boolean</code>Nowhether the orders is a trigger, stopLossPrice or takeProfitPrice order
javascript
bitmart.fetchOrder (id, symbol[, params])

<a name="fetchDepositAddress" id="fetchdepositaddress"></a>

fetchDepositAddress{docsify-ignore}

fetch the deposit address for a currency associated with this account

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - an address structure

See: https://developer-pro.bitmart.com/en/spot/#deposit-address-keyed

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.fetchDepositAddress (code[, params])

<a name="withdraw" id="withdraw"></a>

withdraw{docsify-ignore}

make a withdrawal

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - a transaction structure

See: https://developer-pro.bitmart.com/en/spot/#withdraw-signed

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
amount<code>float</code>Yesthe amount to withdraw
address<code>string</code>Yesthe address to withdraw to
tag<code>string</code>Yes
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.network<code>string</code>Nothe network name for this withdrawal
javascript
bitmart.withdraw (code, amount, address, tag[, params])

<a name="fetchDeposit" id="fetchdeposit"></a>

fetchDeposit{docsify-ignore}

fetch information on a deposit

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - a transaction structure

See: https://developer-pro.bitmart.com/en/spot/#get-a-deposit-or-withdraw-detail-keyed

ParamTypeRequiredDescription
id<code>string</code>Yesdeposit id
code<code>string</code>Yesnot used by bitmart fetchDeposit ()
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.fetchDeposit (id, code[, params])

<a name="fetchDeposits" id="fetchdeposits"></a>

fetchDeposits{docsify-ignore}

fetch all deposits made to an account

Kind: instance method of <code>bitmart</code>
Returns: <code>Array<object></code> - a list of transaction structures

See: https://developer-pro.bitmart.com/en/spot/#get-deposit-and-withdraw-history-keyed

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
since<code>int</code>Nothe earliest time in ms to fetch deposits for
limit<code>int</code>Nothe maximum number of deposits structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.fetchDeposits (code[, since, limit, params])

<a name="fetchWithdrawal" id="fetchwithdrawal"></a>

fetchWithdrawal{docsify-ignore}

fetch data on a currency withdrawal via the withdrawal id

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - a transaction structure

See: https://developer-pro.bitmart.com/en/spot/#get-a-deposit-or-withdraw-detail-keyed

ParamTypeRequiredDescription
id<code>string</code>Yeswithdrawal id
code<code>string</code>Yesnot used by bitmart.fetchWithdrawal
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.fetchWithdrawal (id, code[, params])

<a name="fetchWithdrawals" id="fetchwithdrawals"></a>

fetchWithdrawals{docsify-ignore}

fetch all withdrawals made from an account

Kind: instance method of <code>bitmart</code>
Returns: <code>Array<object></code> - a list of transaction structures

See: https://developer-pro.bitmart.com/en/spot/#get-deposit-and-withdraw-history-keyed

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
since<code>int</code>Nothe earliest time in ms to fetch withdrawals for
limit<code>int</code>Nothe maximum number of withdrawals structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.fetchWithdrawals (code[, since, limit, params])

<a name="repayIsolatedMargin" id="repayisolatedmargin"></a>

repayIsolatedMargin{docsify-ignore}

repay borrowed margin and interest

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - a margin loan structure

See: https://developer-pro.bitmart.com/en/spot/#margin-repay-isolated-signed

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
code<code>string</code>Yesunified currency code of the currency to repay
amount<code>string</code>Yesthe amount to repay
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.repayIsolatedMargin (symbol, code, amount[, params])

<a name="borrowIsolatedMargin" id="borrowisolatedmargin"></a>

borrowIsolatedMargin{docsify-ignore}

create a loan to borrow margin

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - a margin loan structure

See: https://developer-pro.bitmart.com/en/spot/#margin-borrow-isolated-signed

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
code<code>string</code>Yesunified currency code of the currency to borrow
amount<code>string</code>Yesthe amount to borrow
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.borrowIsolatedMargin (symbol, code, amount[, params])

<a name="fetchIsolatedBorrowRate" id="fetchisolatedborrowrate"></a>

fetchIsolatedBorrowRate{docsify-ignore}

fetch the rate of interest to borrow a currency for margin trading

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - an isolated borrow rate structure

See: https://developer-pro.bitmart.com/en/spot/#get-trading-pair-borrowing-rate-and-amount-keyed

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the borrow rate for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.fetchIsolatedBorrowRate (symbol[, params])

<a name="fetchIsolatedBorrowRates" id="fetchisolatedborrowrates"></a>

fetchIsolatedBorrowRates{docsify-ignore}

fetch the borrow interest rates of all currencies, currently only works for isolated margin

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - a list of isolated borrow rate structures

See: https://developer-pro.bitmart.com/en/spot/#get-trading-pair-borrowing-rate-and-amount-keyed

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.fetchIsolatedBorrowRates ([params])

<a name="transfer" id="transfer"></a>

transfer{docsify-ignore}

transfer currency internally between wallets on the same account, currently only supports transfer between spot and margin

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - a transfer structure

See

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
amount<code>float</code>Yesamount to transfer
fromAccount<code>string</code>Yesaccount to transfer from
toAccount<code>string</code>Yesaccount to transfer to
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.transfer (code, amount, fromAccount, toAccount[, params])

<a name="fetchTransfers" id="fetchtransfers"></a>

fetchTransfers{docsify-ignore}

fetch a history of internal transfers made on an account, only transfers between spot and swap are supported

Kind: instance method of <code>bitmart</code>
Returns: <code>Array<object></code> - a list of transfer structures

See: https://developer-pro.bitmart.com/en/futuresv2/#get-transfer-list-signed

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code of the currency transferred
since<code>int</code>Nothe earliest time in ms to fetch transfers for
limit<code>int</code>Nothe maximum number of transfer structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.page<code>int</code>Nothe required number of pages, default is 1, max is 1000
params.until<code>int</code>Nothe latest time in ms to fetch transfers for
javascript
bitmart.fetchTransfers (code[, since, limit, params])

<a name="fetchBorrowInterest" id="fetchborrowinterest"></a>

fetchBorrowInterest{docsify-ignore}

fetch the interest owed by the user for borrowing currency for margin trading

Kind: instance method of <code>bitmart</code>
Returns: <code>Array<object></code> - a list of borrow interest structures

See: https://developer-pro.bitmart.com/en/spot/#get-borrow-record-isolated-keyed

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code
symbol<code>string</code>Yesunified market symbol when fetch interest in isolated markets
since<code>int</code>Nothe earliest time in ms to fetch borrrow interest for
limit<code>int</code>Nothe maximum number of structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.fetchBorrowInterest (code, symbol[, since, limit, params])

<a name="fetchOpenInterest" id="fetchopeninterest"></a>

fetchOpenInterest{docsify-ignore}

Retrieves the open interest of a currency

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - an open interest structurehttps://docs.ccxt.com/?id=open-interest-structure

See: https://developer-pro.bitmart.com/en/futuresv2/#get-futures-openinterest

ParamTypeRequiredDescription
symbol<code>string</code>YesUnified CCXT market symbol
params<code>object</code>Noexchange specific parameters
javascript
bitmart.fetchOpenInterest (symbol[, params])

<a name="setLeverage" id="setleverage"></a>

setLeverage{docsify-ignore}

set the level of leverage for a market

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - response from the exchange

See: https://developer-pro.bitmart.com/en/futuresv2/#submit-leverage-signed

ParamTypeRequiredDescription
leverage<code>float</code>Yesthe rate of leverage
symbol<code>string</code>Yesunified market symbol
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.marginMode<code>string</code>No'isolated' or 'cross'
javascript
bitmart.setLeverage (leverage, symbol[, params])

<a name="fetchFundingRate" id="fetchfundingrate"></a>

fetchFundingRate{docsify-ignore}

fetch the current funding rate

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - a funding rate structure

See: https://developer-pro.bitmart.com/en/futuresv2/#get-current-funding-rate

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.fetchFundingRate (symbol[, params])

<a name="fetchFundingRateHistory" id="fetchfundingratehistory"></a>

fetchFundingRateHistory{docsify-ignore}

fetches historical funding rate prices

Kind: instance method of <code>bitmart</code>
Returns: <code>Array<object></code> - a list of funding rate structures

See: https://developer-pro.bitmart.com/en/futuresv2/#get-funding-rate-history

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the funding rate history for
since<code>int</code>Nonot sent to exchange api, exchange api always returns the most recent data, only used to filter exchange response
limit<code>int</code>Nothe maximum amount of funding rate structures to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.fetchFundingRateHistory (symbol[, since, limit, params])

<a name="fetchPosition" id="fetchposition"></a>

fetchPosition{docsify-ignore}

fetch data on a single open contract trade position

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - a position structure

See: https://developer-pro.bitmart.com/en/futuresv2/#get-current-position-keyed

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market the position is held in
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.fetchPosition (symbol[, params])

<a name="fetchPositions" id="fetchpositions"></a>

fetchPositions{docsify-ignore}

fetch all open contract positions

Kind: instance method of <code>bitmart</code>
Returns: <code>Array<object></code> - a list of position structures

See

ParamTypeRequiredDescription
symbols<code>Array<string></code>, <code>undefined</code>Yeslist of unified market symbols
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.fetchPositions (symbols[, params])

<a name="fetchMyLiquidations" id="fetchmyliquidations"></a>

fetchMyLiquidations{docsify-ignore}

retrieves the users liquidated positions

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - an array of liquidation structures

See: https://developer-pro.bitmart.com/en/futuresv2/#get-order-history-keyed

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified CCXT market symbol
since<code>int</code>Nothe earliest time in ms to fetch liquidations for
limit<code>int</code>Nothe maximum number of liquidation structures to retrieve
params<code>object</code>Noexchange specific parameters for the bitmart api endpoint
params.until<code>int</code>Notimestamp in ms of the latest liquidation
javascript
bitmart.fetchMyLiquidations (symbol[, since, limit, params])

<a name="editOrder" id="editorder"></a>

editOrder{docsify-ignore}

edits an open order

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - an order structure

See

ParamTypeRequiredDescription
id<code>string</code>Yesorder id
symbol<code>string</code>Yesunified symbol of the market to edit an order in
type<code>string</code>Yes'market' or 'limit'
side<code>string</code>Yes'buy' or 'sell'
amount<code>float</code>Nohow much you want to trade in units of the base currency
price<code>float</code>Nothe price to fulfill the order, in units of the quote currency, ignored in market orders
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.triggerPrice<code>string</code>Noswap only the price to trigger a stop order
params.stopLossPrice<code>string</code>Noswap only the price to trigger a stop-loss order
params.takeProfitPrice<code>string</code>Noswap only the price to trigger a take-profit order
params.stopLoss.triggerPrice<code>string</code>Noswap only the price to trigger a preset stop-loss order
params.takeProfit.triggerPrice<code>string</code>Noswap only the price to trigger a preset take-profit order
params.clientOrderId<code>string</code>Noclient order id of the order
params.price_type<code>int</code>Noswap only 1: last price, 2: fair price, default is 1
params.plan_category<code>int</code>Noswap tp/sl only 1: tp/sl, 2: position tp/sl, default is 1
javascript
bitmart.editOrder (id, symbol, type, side[, amount, price, params])

<a name="fetchLedger" id="fetchledger"></a>

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 <code>bitmart</code>
Returns: <code>Array<object></code> - a list of ledger structures

See: https://developer-pro.bitmart.com/en/futuresv2/#get-transaction-history-keyed

ParamTypeRequiredDescription
code<code>string</code>Nounified currency code
since<code>int</code>Notimestamp in ms of the earliest ledger entry
limit<code>int</code>Nomax number of ledger entries to return
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Notimestamp in ms of the latest ledger entry
javascript
bitmart.fetchLedger ([code, since, limit, params])

<a name="fetchFundingHistory" id="fetchfundinghistory"></a>

fetchFundingHistory{docsify-ignore}

fetch the history of funding payments paid and received on this account

Kind: instance method of <code>bitmart</code>
Returns: <code>Array<object></code> - a list of funding history structures

See: https://developer-pro.bitmart.com/en/futuresv2/#get-transaction-history-keyed

ParamTypeRequiredDescription
symbol<code>string</code>Nounified market symbol
since<code>int</code>Nothe starting timestamp in milliseconds
limit<code>int</code>Nothe number of entries to return
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.until<code>int</code>Nothe latest time in ms to fetch funding history for
javascript
bitmart.fetchFundingHistory ([symbol, since, limit, params])

<a name="setPositionMode" id="setpositionmode"></a>

setPositionMode{docsify-ignore}

set hedged to true or false for a market

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - response from the exchange

See: https://developer-pro.bitmart.com/en/futuresv2/#submit-leverage-signed

ParamTypeRequiredDescription
hedged<code>bool</code>Yesset to true to use dualSidePosition
symbol<code>string</code>Yesnot used by bingx setPositionMode ()
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.setPositionMode (hedged, symbol[, params])

<a name="fetchPositionMode" id="fetchpositionmode"></a>

fetchPositionMode{docsify-ignore}

fetchs the position mode, hedged or one way, hedged for binance is set identically for all linear markets or all inverse markets

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - an object detailing whether the market is in hedged or one-way mode

See: https://developer-pro.bitmart.com/en/futuresv2/#get-position-mode-keyed

ParamTypeRequiredDescription
symbol<code>string</code>Yesnot used
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.fetchPositionMode (symbol[, params])

<a name="watchBalance" id="watchbalance"></a>

watchBalance{docsify-ignore}

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

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - a balance structure

See

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.watchBalance ([params])

<a name="watchTrades" id="watchtrades"></a>

watchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of <code>bitmart</code>
Returns: <code>Array<object></code> - a list of trade structures

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch trades for
since<code>int</code>Notimestamp in ms of the earliest trade to fetch
limit<code>int</code>Nothe maximum amount of trades to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.watchTrades (symbol[, since, limit, params])

<a name="watchTradesForSymbols" id="watchtradesforsymbols"></a>

watchTradesForSymbols{docsify-ignore}

get the list of most recent trades for a list of symbols

Kind: instance method of <code>bitmart</code>
Returns: <code>Array<object></code> - a list of trade structures

See

ParamTypeRequiredDescription
symbols<code>Array<string></code>Yesunified symbol of the market to fetch trades for
since<code>int</code>Notimestamp in ms of the earliest trade to fetch
limit<code>int</code>Nothe maximum amount of trades to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.watchTradesForSymbols (symbols[, since, limit, params])

<a name="unWatchTrades" id="unwatchtrades"></a>

unWatchTrades{docsify-ignore}

unWatches from the stream channel

Kind: instance method of <code>bitmart</code>
Returns: <code>Array<object></code> - a list of trade structures

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch trades for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.unWatchTrades (symbol[, params])

<a name="unWatchTradesForSymbols" id="unwatchtradesforsymbols"></a>

unWatchTradesForSymbols{docsify-ignore}

unsubscribes from the trades channel

Kind: instance method of <code>bitmart</code>
Returns: <code>Array<object></code> - a list of trade structures

See

ParamTypeRequiredDescription
symbols<code>Array<string></code>Yesunified symbol of the market to fetch trades for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.unWatchTradesForSymbols (symbols[, params])

<a name="watchTicker" id="watchticker"></a>

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 <code>bitmart</code>
Returns: <code>object</code> - a ticker structure

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the ticker for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.watchTicker (symbol[, params])

<a name="watchTickers" id="watchtickers"></a>

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 <code>bitmart</code>
Returns: <code>object</code> - a ticker structure

See

ParamTypeRequiredDescription
symbols<code>Array<string></code>Yesunified symbol of the market to fetch the ticker for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.watchTickers (symbols[, params])

<a name="unWatchTicker" id="unwatchticker"></a>

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 <code>bitmart</code>
Returns: <code>object</code> - a ticker structure

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the ticker for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.unWatchTicker (symbol[, params])

<a name="unWatchTickers" id="unwatchtickers"></a>

unWatchTickers{docsify-ignore}

unWatches 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 <code>bitmart</code>
Returns: <code>object</code> - a ticker structure

See

ParamTypeRequiredDescription
symbols<code>Array<string></code>Yesunified symbol of the market to fetch the ticker for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.unWatchTickers (symbols[, params])

<a name="watchBidsAsks" id="watchbidsasks"></a>

watchBidsAsks{docsify-ignore}

watches best bid & ask for symbols

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - a ticker structure

See

ParamTypeRequiredDescription
symbols<code>Array<string></code>Yesunified symbol of the market to fetch the ticker for
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.watchBidsAsks (symbols[, params])

<a name="watchOrders" id="watchorders"></a>

watchOrders{docsify-ignore}

watches information on multiple orders made by the user

Kind: instance method of <code>bitmart</code>
Returns: <code>Array<object></code> - a list of order structures

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market orders were made in
since<code>int</code>Nothe earliest time in ms to fetch orders for
limit<code>int</code>Nothe maximum number of order structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.watchOrders (symbol[, since, limit, params])

<a name="unWatchOrders" id="unwatchorders"></a>

unWatchOrders{docsify-ignore}

unWatches information on multiple orders made by the user

Kind: instance method of <code>bitmart</code>
Returns: <code>Array<object></code> - a list of order structures

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol of the market orders were made in
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.unWatchOrders (symbol[, params])

<a name="watchPositions" id="watchpositions"></a>

watchPositions{docsify-ignore}

watch all open positions

Kind: instance method of <code>bitmart</code>
Returns: <code>Array<object></code> - a list of position structure

See: https://developer-pro.bitmart.com/en/futures/#private-position-channel

ParamTypeRequiredDescription
symbols<code>Array<string></code>, <code>undefined</code>Yeslist of unified market symbols
since<code>int</code>Nothe earliest time in ms to fetch positions
limit<code>int</code>Nothe maximum number of positions to retrieve
params<code>object</code>Yesextra parameters specific to the exchange API endpoint
javascript
bitmart.watchPositions (symbols[, since, limit, params])

<a name="unWatchPositions" id="unwatchpositions"></a>

unWatchPositions{docsify-ignore}

unWatches all open positions

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - status of the unwatch request

See: https://developer-pro.bitmart.com/en/futures/#private-position-channel

ParamTypeRequiredDescription
symbols<code>Array<string></code>Nolist of unified market symbols
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.unWatchPositions ([symbols, params])

<a name="watchOHLCV" id="watchohlcv"></a>

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 <code>bitmart</code>
Returns: <code>Array<Array<int>></code> - A list of candles ordered as timestamp, open, high, low, close, volume

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch OHLCV data for
timeframe<code>string</code>Yesthe length of time each candle represents
since<code>int</code>Notimestamp in ms of the earliest candle to fetch
limit<code>int</code>Nothe maximum amount of candles to fetch
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.watchOHLCV (symbol, timeframe[, since, limit, params])

<a name="unWatchOHLCV" id="unwatchohlcv"></a>

unWatchOHLCV{docsify-ignore}

unWatches historical candlestick data containing the open, high, low, and close price, and the volume of a market

Kind: instance method of <code>bitmart</code>
Returns: <code>Array<Array<int>></code> - A list of candles ordered as timestamp, open, high, low, close, volume

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch OHLCV data for
timeframe<code>string</code>Yesthe length of time each candle represents
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.unWatchOHLCV (symbol, timeframe[, params])

<a name="watchOrderBook" id="watchorderbook"></a>

watchOrderBook{docsify-ignore}

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

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - A dictionary of order book structures indexed by market symbols

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market to fetch the order book for
limit<code>int</code>Nothe maximum amount of order book entries to return
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.speed<code>string</code>Nofutures only '100ms' or '200ms'
javascript
bitmart.watchOrderBook (symbol[, limit, params])

<a name="unWatchOrderBook" id="unwatchorderbook"></a>

unWatchOrderBook{docsify-ignore}

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

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - A dictionary of order book structures indexed by market symbols

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified array of symbols
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.unWatchOrderBook (symbol[, params])

<a name="watchOrderBookForSymbols" id="watchorderbookforsymbols"></a>

watchOrderBookForSymbols{docsify-ignore}

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

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - A dictionary of order book structures indexed by market symbols

See: https://developer-pro.bitmart.com/en/spot/#public-depth-increase-channel

ParamTypeRequiredDescription
symbols<code>Array<string></code>Yesunified array of symbols
limit<code>int</code>Nothe maximum amount of order book entries to return
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.depth<code>string</code>Nothe type of order book to subscribe to, default is 'depth/increase100', also accepts 'depth5' or 'depth20' or depth50
javascript
bitmart.watchOrderBookForSymbols (symbols[, limit, params])

<a name="unWatchOrderBookForSymbols" id="unwatchorderbookforsymbols"></a>

unWatchOrderBookForSymbols{docsify-ignore}

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

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - A dictionary of order book structures indexed by market symbols

See: https://developer-pro.bitmart.com/en/spot/#public-depth-increase-channel

ParamTypeRequiredDescription
symbols<code>Array<string></code>Yesunified array of symbols
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.depth<code>string</code>Nothe type of order book to subscribe to, default is 'depth/increase100', also accepts 'depth5' or 'depth20' or depth50
javascript
bitmart.unWatchOrderBookForSymbols (symbols[, params])

<a name="watchFundingRate" id="watchfundingrate"></a>

watchFundingRate{docsify-ignore}

watch the current funding rate

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - a funding rate structure

See: https://developer-pro.bitmart.com/en/futuresv2/#public-funding-rate-channel

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.watchFundingRate (symbol[, params])

<a name="watchFundingRates" id="watchfundingrates"></a>

watchFundingRates{docsify-ignore}

watch the funding rate for multiple markets

Kind: instance method of <code>bitmart</code>
Returns: <code>object</code> - a dictionary of funding rate structures, indexed by market symbols

See: https://developer-pro.bitmart.com/en/futuresv2/#public-funding-rate-channel

ParamTypeRequiredDescription
symbols<code>Array<string></code>Yesa list of unified market symbols
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
bitmart.watchFundingRates (symbols[, params])