Skip to content

bitmart

Jump to bottom
github-actions[bot] edited this page Jun 11, 2026 · 4 revisions

bitmart{docsify-ignore}

Kind: global class
Extends: Exchange

fetchTime{docsify-ignore}

fetches the current integer timestamp in milliseconds from the exchange server

Kind: instance method of bitmart
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 
bitmart.fetchTime (params?)

fetchStatus{docsify-ignore}

the latest known information on the availability of the exchange API

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

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

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint 
bitmart.fetchStatus (params?)

fetchMarkets{docsify-ignore}

retrieves data on all markets for bitmart

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

See

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint 
bitmart.fetchMarkets (params?)

fetchCurrencies{docsify-ignore}

fetches all available currencies on an exchange

Kind: instance method of bitmart
Returns: object - an associative dictionary of currencies

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

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint 
bitmart.fetchCurrencies (params?)

fetchTransactionFee{docsify-ignore}

DEPRECATED

please use fetchDepositWithdrawFee instead

Kind: instance method of bitmart
Returns: object - a fee structure

Param Type Required Description
code string Yes unified currency code
params object No extra parameters specific to the exchange API endpoint
params.network string No the network code of the currency 
bitmart.fetchTransactionFee (code, params?)

fetchDepositWithdrawFee{docsify-ignore}

fetch the fee for deposits and withdrawals

Kind: instance method of bitmart
Returns: object - a fee structure

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

Param Type Required Description
code string Yes unified currency code
params object No extra parameters specific to the exchange API endpoint
params.network string No the network code of the currency 
bitmart.fetchDepositWithdrawFee (code, params?)

fetchTicker{docsify-ignore}

fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market

Kind: instance method of bitmart
Returns: object - a ticker structure

See

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 
bitmart.fetchTicker (symbol, 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 bitmart
Returns: object - a dictionary of ticker structures

See

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 
bitmart.fetchTickers (symbols, params?)

fetchOrderBook{docsify-ignore}

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

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

See

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 
bitmart.fetchOrderBook (symbol, limit?, params?)

fetchTrades{docsify-ignore}

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

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

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

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

See

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
params.until int No timestamp of the latest candle in ms
params.paginate boolean No spot only default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the availble parameters 
bitmart.fetchOHLCV (symbol, timeframe, since?, limit?, params?)

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

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

See

Param Type Required Description
symbol string Yes unified market symbol
since int No the earliest time in ms to fetch trades for
limit int No the maximum number of trades structures to retrieve
params object No extra parameters specific to the exchange API endpoint
params.until int No the latest time in ms to fetch trades for
params.marginMode boolean No spot whether to fetch trades for margin orders or spot orders, defaults to spot orders (only isolated margin orders are supported)
params.stpMode string No self-trade prevention only for spot, defaults to none, ['none', 'cancel_maker', 'cancel_taker', 'cancel_both'] 
bitmart.fetchMyTrades (symbol, since?, limit?, params?)

fetchOrderTrades{docsify-ignore}

fetch all the trades made from a single order

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

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

Param Type Required Description
id string Yes order id
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 to retrieve
params object No extra parameters specific to the exchange API endpoint
params.stpMode string No self-trade prevention only for spot, defaults to none, ['none', 'cancel_maker', 'cancel_taker', 'cancel_both'] 
bitmart.fetchOrderTrades (id, 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 bitmart
Returns: object - a balance structure

See

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint 
bitmart.fetchBalance (params?)

fetchTradingFee{docsify-ignore}

fetch the trading fees for a market

Kind: instance method of bitmart
Returns: object - a fee structure

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

Param Type Required Description
symbol string Yes unified market symbol
params object No extra parameters specific to the exchange API endpoint 
bitmart.fetchTradingFee (symbol, params?)

createMarketBuyOrderWithCost{docsify-ignore}

create a market buy order by providing the symbol and cost

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

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

Param Type Required Description
symbol string Yes unified symbol of the market to create an order in
cost float Yes how much you want to trade in units of the quote currency
params object No extra parameters specific to the exchange API endpoint 
bitmart.createMarketBuyOrderWithCost (symbol, cost, params?)

createOrder{docsify-ignore}

create a trade order

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

See

Param Type Required Description
symbol string Yes unified symbol of the market to create an order in
type string Yes 'market', 'limit' or 'trailing' for swap markets only
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.marginMode string No 'cross' or 'isolated'
params.leverage string No swap only leverage level
params.clientOrderId string No client order id of the order
params.reduceOnly boolean No swap only reduce only
params.postOnly boolean No make sure the order is posted to the order book and not matched immediately
params.triggerPrice string No swap only the price to trigger a stop order
params.price_type int No swap only 1: last price, 2: fair price, default is 1
params.price_way int No swap only 1: price way long, 2: price way short
params.activation_price_type int No swap trailing order only 1: last price, 2: fair price, default is 1
params.trailingPercent string No swap only the percent to trail away from the current market price, min 0.1 max 5
params.trailingTriggerPrice string No swap only the price to trigger a trailing order, default uses the price argument
params.stopLossPrice string No swap only the price to trigger a stop-loss order
params.takeProfitPrice string No swap only the price to trigger a take-profit order
params.plan_category int No swap tp/sl only 1: tp/sl, 2: position tp/sl, default is 1
params.stpMode string No self-trade prevention only for spot, defaults to none, ['none', 'cancel_maker', 'cancel_taker', 'cancel_both'] 
bitmart.createOrder (symbol, type, side, amount, price?, params?)

createOrders{docsify-ignore}

create a list of trade orders

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

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

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
params.stpMode string No self-trade prevention only for spot, defaults to none, ['none', 'cancel_maker', 'cancel_taker', 'cancel_both'] 
bitmart.createOrders (orders, params?)

cancelOrder{docsify-ignore}

cancels an open order

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

See

Param Type Required Description
id string Yes order id
symbol string Yes unified symbol of the market the order was made in
params object No extra parameters specific to the exchange API endpoint
params.clientOrderId string No spot only the client order id of the order to cancel
params.trailing boolean No swap only whether the order is a stop order
params.trigger boolean No whether the order is a trigger order
params.stopLossTakeProfit boolean No whether the order is a stopLossPrice or takeProfitPrice order 
bitmart.cancelOrder (id, symbol, params?)

cancelOrders{docsify-ignore}

cancel multiple orders

Kind: instance method of bitmart
Returns: object - an list of order structures

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

Param Type Required Description
ids Array<string> Yes order ids
symbol string Yes unified symbol of the market the order was made in
params object No extra parameters specific to the exchange API endpoint
params.clientOrderIds Array<string> No client order ids 
bitmart.cancelOrders (ids, symbol, params?)

cancelAllOrders{docsify-ignore}

cancel all open orders in a market

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

See

Param Type Required Description
symbol string Yes unified market symbol of the market to cancel orders in
params object No extra parameters specific to the exchange API endpoint
params.side string No spot only 'buy' or 'sell'
params.trigger boolean No whether the orders are trigger orders
params.stopLossTakeProfit boolean No whether the orders are stopLossPrice or takeProfitPrice orders 
bitmart.cancelAllOrders (symbol, params?)

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

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

See

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 order structures to retrieve
params object No extra parameters specific to the exchange API endpoint
params.marginMode boolean No spot whether to fetch trades for margin orders or spot orders, defaults to spot orders (only isolated margin orders are supported)
params.until int No spot the latest time in ms to fetch orders for
params.type string No swap order type, 'limit' or 'market'
params.order_state string No swap the order state, 'all' or 'partially_filled', default is 'all'
params.orderType string No swap only 'limit', 'market', or 'trailing'
params.trailing boolean No swap only set to true if you want to fetch trailing orders
params.trigger boolean No set to true if you want to fetch trigger orders
params.stopLossTakeProfit boolean No set to true if you want to fetch stopLossPrice or takeProfitPrice orders
params.stpMode string No self-trade prevention only for spot, defaults to none, ['none', 'cancel_maker', 'cancel_taker', 'cancel_both'] 
bitmart.fetchOpenOrders (symbol, since?, limit?, params?)

fetchClosedOrders{docsify-ignore}

fetches information on multiple closed orders made by the user

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

See

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
params.until int No timestamp in ms of the latest entry
params.marginMode string No spot only 'cross' or 'isolated', for margin trading
params.stpMode string No self-trade prevention only for spot, defaults to none, ['none', 'cancel_maker', 'cancel_taker', 'cancel_both']
params.trigger boolean No set to true if you want to fetch trigger orders
params.stopLossTakeProfit boolean No set to true if you want to fetch stopLossPrice or takeProfitPrice orders 
bitmart.fetchClosedOrders (symbol, since?, limit?, params?)

fetchCanceledOrders{docsify-ignore}

fetches information on multiple canceled orders made by the user

Kind: instance method of bitmart
Returns: object - a list of order structures

Param Type Required Description
symbol string Yes unified market symbol of the market orders were made in
since int No timestamp in ms of the earliest order, default is undefined
limit int No max number of orders to return, default is undefined
params object No extra parameters specific to the exchange API endpoint 
bitmart.fetchCanceledOrders (symbol, since?, limit?, params?)

fetchOrder{docsify-ignore}

fetches information on an order made by the user

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

See

Param Type Required Description
id string Yes the id of the order
symbol string Yes unified symbol of the market the order was made in
params object No extra parameters specific to the exchange API endpoint
params.clientOrderId string No spot fetch the order by client order id instead of order id
params.orderType string No swap only 'limit', 'market', 'liquidate', 'bankruptcy', 'adl' or 'trailing'
params.trailing boolean No swap only set to true if you want to fetch a trailing order
params.stpMode string No self-trade prevention only for spot, defaults to none, ['none', 'cancel_maker', 'cancel_taker', 'cancel_both']
params.trigger boolean No whether the orders is a trigger, stopLossPrice or takeProfitPrice order 
bitmart.fetchOrder (id, symbol, params?)

fetchDepositAddress{docsify-ignore}

fetch the deposit address for a currency associated with this account

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

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

Param Type Required Description
code string Yes unified currency code
params object No extra parameters specific to the exchange API endpoint 
bitmart.fetchDepositAddress (code, params?)

withdraw{docsify-ignore}

make a withdrawal

Kind: instance method of bitmart
Returns: object - a transaction structure

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

Param Type Required Description
code string Yes unified currency code
amount float Yes the amount to withdraw
address string Yes the address to withdraw to
tag string Yes
params object No extra parameters specific to the exchange API endpoint
params.network string No the network name for this withdrawal 
bitmart.withdraw (code, amount, address, tag, params?)

fetchDeposit{docsify-ignore}

fetch information on a deposit

Kind: instance method of bitmart
Returns: object - a transaction structure

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

Param Type Required Description
id string Yes deposit id
code string Yes not used by bitmart fetchDeposit ()
params object No extra parameters specific to the exchange API endpoint 
bitmart.fetchDeposit (id, code, params?)

fetchDeposits{docsify-ignore}

fetch all deposits made to an account

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

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

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 
bitmart.fetchDeposits (code, since?, limit?, params?)

fetchWithdrawal{docsify-ignore}

fetch data on a currency withdrawal via the withdrawal id

Kind: instance method of bitmart
Returns: object - a transaction structure

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

Param Type Required Description
id string Yes withdrawal id
code string Yes not used by bitmart.fetchWithdrawal
params object No extra parameters specific to the exchange API endpoint 
bitmart.fetchWithdrawal (id, code, params?)

fetchWithdrawals{docsify-ignore}

fetch all withdrawals made from an account

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

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

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

repayIsolatedMargin{docsify-ignore}

repay borrowed margin and interest

Kind: instance method of bitmart
Returns: object - a margin loan structure

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

Param Type Required Description
symbol string Yes unified market symbol
code string Yes unified currency code of the currency to repay
amount string Yes the amount to repay
params object No extra parameters specific to the exchange API endpoint 
bitmart.repayIsolatedMargin (symbol, code, amount, params?)

borrowIsolatedMargin{docsify-ignore}

create a loan to borrow margin

Kind: instance method of bitmart
Returns: object - a margin loan structure

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

Param Type Required Description
symbol string Yes unified market symbol
code string Yes unified currency code of the currency to borrow
amount string Yes the amount to borrow
params object No extra parameters specific to the exchange API endpoint 
bitmart.borrowIsolatedMargin (symbol, code, amount, params?)

fetchIsolatedBorrowRate{docsify-ignore}

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

Kind: instance method of bitmart
Returns: object - an isolated borrow rate structure

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

Param Type Required Description
symbol string Yes unified symbol of the market to fetch the borrow rate for
params object No extra parameters specific to the exchange API endpoint 
bitmart.fetchIsolatedBorrowRate (symbol, params?)

fetchIsolatedBorrowRates{docsify-ignore}

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

Kind: instance method of bitmart
Returns: object - a list of isolated borrow rate structures

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

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint 
bitmart.fetchIsolatedBorrowRates (params?)

transfer{docsify-ignore}

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

Kind: instance method of bitmart
Returns: object - a transfer structure

See

Param Type Required Description
code string Yes unified currency code
amount float Yes amount to transfer
fromAccount string Yes account to transfer from
toAccount string Yes account to transfer to
params object No extra parameters specific to the exchange API endpoint 
bitmart.transfer (code, amount, fromAccount, toAccount, params?)

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

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

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
limit int No the maximum number of transfer structures to retrieve
params object No extra parameters specific to the exchange API endpoint
params.page int No the required number of pages, default is 1, max is 1000
params.until int No the latest time in ms to fetch transfers for 
bitmart.fetchTransfers (code, since?, limit?, params?)

fetchBorrowInterest{docsify-ignore}

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

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

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

Param Type Required Description
code string Yes unified currency code
symbol string Yes unified market symbol when fetch interest in isolated markets
since int No the earliest time in ms to fetch borrrow interest for
limit int No the maximum number of structures to retrieve
params object No extra parameters specific to the exchange API endpoint 
bitmart.fetchBorrowInterest (code, symbol, since?, limit?, params?)

fetchOpenInterest{docsify-ignore}

Retrieves the open interest of a currency

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

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

Param Type Required Description
symbol string Yes Unified CCXT market symbol
params object No exchange specific parameters 
bitmart.fetchOpenInterest (symbol, params?)

setLeverage{docsify-ignore}

set the level of leverage for a market

Kind: instance method of bitmart
Returns: object - response from the exchange

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

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
params.marginMode string No 'isolated' or 'cross' 
bitmart.setLeverage (leverage, symbol, params?)

fetchFundingRate{docsify-ignore}

fetch the current funding rate

Kind: instance method of bitmart
Returns: object - a funding rate structure

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

Param Type Required Description
symbol string Yes unified market symbol
params object No extra parameters specific to the exchange API endpoint 
bitmart.fetchFundingRate (symbol, params?)

fetchFundingRateHistory{docsify-ignore}

fetches historical funding rate prices

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

See: https://developer-pro.bitmart.com/en/futuresv2/#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 not sent to exchange api, exchange api always returns the most recent data, only used to filter exchange response
limit int No the maximum amount of funding rate structures to fetch
params object No extra parameters specific to the exchange API endpoint 
bitmart.fetchFundingRateHistory (symbol, since?, limit?, params?)

fetchPosition{docsify-ignore}

fetch data on a single open contract trade position

Kind: instance method of bitmart
Returns: object - a position structure

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

Param Type Required Description
symbol string Yes unified market symbol of the market the position is held in
params object No extra parameters specific to the exchange API endpoint 
bitmart.fetchPosition (symbol, params?)

fetchPositions{docsify-ignore}

fetch all open contract positions

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

See

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 
bitmart.fetchPositions (symbols, params?)

fetchMyLiquidations{docsify-ignore}

retrieves the users liquidated positions

Kind: instance method of bitmart
Returns: object - an array of liquidation structures

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

Param Type Required Description
symbol string Yes unified CCXT market symbol
since int No the earliest time in ms to fetch liquidations for
limit int No the maximum number of liquidation structures to retrieve
params object No exchange specific parameters for the bitmart api endpoint
params.until int No timestamp in ms of the latest liquidation 
bitmart.fetchMyLiquidations (symbol, since?, limit?, params?)

editOrder{docsify-ignore}

edits an open order

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

See

Param Type Required Description
id string Yes order id
symbol string Yes unified symbol of the market to edit an order in
type string Yes 'market' or 'limit'
side string Yes 'buy' or 'sell'
amount float No how much you want to trade in units of the base currency
price float No the price to fulfill the order, in units of the quote currency, ignored in market orders
params object No extra parameters specific to the exchange API endpoint
params.triggerPrice string No swap only the price to trigger a stop order
params.stopLossPrice string No swap only the price to trigger a stop-loss order
params.takeProfitPrice string No swap only the price to trigger a take-profit order
params.stopLoss.triggerPrice string No swap only the price to trigger a preset stop-loss order
params.takeProfit.triggerPrice string No swap only the price to trigger a preset take-profit order
params.clientOrderId string No client order id of the order
params.price_type int No swap only 1: last price, 2: fair price, default is 1
params.plan_category int No swap tp/sl only 1: tp/sl, 2: position tp/sl, default is 1 
bitmart.editOrder (id, symbol, type, side, amount?, price?, 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 bitmart
Returns: Array<object> - a list of ledger structures

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

Param Type Required Description
code string No unified currency code
since int No timestamp in ms of the earliest ledger entry
limit int No max number of ledger entries to return
params object No extra parameters specific to the exchange API endpoint
params.until int No timestamp in ms of the latest ledger entry 
bitmart.fetchLedger (code?, since?, limit?, params?)

fetchFundingHistory{docsify-ignore}

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

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

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

Param Type Required Description
symbol string No unified market symbol
since int No the starting timestamp in milliseconds
limit int No the number of entries to return
params object No extra parameters specific to the exchange API endpoint
params.until int No the latest time in ms to fetch funding history for 
bitmart.fetchFundingHistory (symbol?, since?, limit?, params?)

setPositionMode{docsify-ignore}

set hedged to true or false for a market

Kind: instance method of bitmart
Returns: object - response from the exchange

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

Param Type Required Description
hedged bool Yes set to true to use dualSidePosition
symbol string Yes not used by bingx setPositionMode ()
params object No extra parameters specific to the exchange API endpoint 
bitmart.setPositionMode (hedged, symbol, params?)

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 bitmart
Returns: object - 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

Param Type Required Description
symbol string Yes not used
params object No extra parameters specific to the exchange API endpoint 
bitmart.fetchPositionMode (symbol, params?)

watchBalance{docsify-ignore}

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

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

See

Param Type Required Description
params object No extra parameters specific to the exchange API endpoint 
bitmart.watchBalance (params?)

watchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

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

See

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 
bitmart.watchTrades (symbol, since?, limit?, params?)

watchTradesForSymbols{docsify-ignore}

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

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

See

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 
bitmart.watchTradesForSymbols (symbols, since?, limit?, params?)

unWatchTrades{docsify-ignore}

unWatches from the stream channel

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

See

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 
bitmart.unWatchTrades (symbol, params?)

unWatchTradesForSymbols{docsify-ignore}

unsubscribes from the trades channel

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

See

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 
bitmart.unWatchTradesForSymbols (symbols, 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 bitmart
Returns: object - a ticker structure

See

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

See

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 
bitmart.watchTickers (symbols, params?)

unWatchTicker{docsify-ignore}

unWatches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market

Kind: instance method of bitmart
Returns: object - a ticker structure

See

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 
bitmart.unWatchTicker (symbol, params?)

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

See

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 
bitmart.unWatchTickers (symbols, params?)

watchBidsAsks{docsify-ignore}

watches best bid & ask for symbols

Kind: instance method of bitmart
Returns: object - a ticker structure

See

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 
bitmart.watchBidsAsks (symbols, params?)

watchOrders{docsify-ignore}

watches information on multiple orders made by the user

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

See

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 
bitmart.watchOrders (symbol, since?, limit?, params?)

unWatchOrders{docsify-ignore}

unWatches information on multiple orders made by the user

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

See

Param Type Required Description
symbol string Yes unified market symbol of the market orders were made in
params object No extra parameters specific to the exchange API endpoint 
bitmart.unWatchOrders (symbol, params?)

watchPositions{docsify-ignore}

watch all open positions

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

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

Param Type Required Description
symbols Array<string>, undefined Yes list of unified market symbols
since int No the earliest time in ms to fetch positions
limit int No the maximum number of positions to retrieve
params object Yes extra parameters specific to the exchange API endpoint 
bitmart.watchPositions (symbols, since?, limit?, params)

unWatchPositions{docsify-ignore}

unWatches all open positions

Kind: instance method of bitmart
Returns: object - status of the unwatch request

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

Param Type Required Description
symbols Array<string> No list of unified market symbols
params object No extra parameters specific to the exchange API endpoint 
bitmart.unWatchPositions (symbols?, 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 bitmart
Returns: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume

See

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 
bitmart.watchOHLCV (symbol, timeframe, since?, limit?, params?)

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

See

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 
bitmart.unWatchOHLCV (symbol, timeframe, params?)

watchOrderBook{docsify-ignore}

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

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

See

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
params.speed string No futures only '100ms' or '200ms' 
bitmart.watchOrderBook (symbol, limit?, params?)

unWatchOrderBook{docsify-ignore}

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

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

See

Param Type Required Description
symbol string Yes unified array of symbols
params object No extra parameters specific to the exchange API endpoint 
bitmart.unWatchOrderBook (symbol, params?)

watchOrderBookForSymbols{docsify-ignore}

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

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

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

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.depth string No the type of order book to subscribe to, default is 'depth/increase100', also accepts 'depth5' or 'depth20' or depth50 
bitmart.watchOrderBookForSymbols (symbols, limit?, params?)

unWatchOrderBookForSymbols{docsify-ignore}

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

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

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

Param Type Required Description
symbols Array<string> Yes unified array of symbols
params object No extra parameters specific to the exchange API endpoint
params.depth string No the type of order book to subscribe to, default is 'depth/increase100', also accepts 'depth5' or 'depth20' or depth50 
bitmart.unWatchOrderBookForSymbols (symbols, params?)

watchFundingRate{docsify-ignore}

watch the current funding rate

Kind: instance method of bitmart
Returns: object - a funding rate structure

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

Param Type Required Description
symbol string Yes unified market symbol
params object No extra parameters specific to the exchange API endpoint 
bitmart.watchFundingRate (symbol, params?)

watchFundingRates{docsify-ignore}

watch the funding rate for multiple markets

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

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

Param Type Required Description
symbols Array<string> Yes a list of unified market symbols
params object No extra parameters specific to the exchange API endpoint 
bitmart.watchFundingRates (symbols, params?)

(If the page is not being rendered for you, you can refer to the mirror at https://docs.ccxt.com/)

Clone this wiki locally