ContextQMD
Back to Ccxt

Mexc

wiki/exchanges/mexc.md

4.5.5264.3 KB
Original Source

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

mexc{docsify-ignore}

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

<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>mexc</code>
Returns: <code>object</code> - a status structure

See

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

<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>mexc</code>
Returns: <code>int</code> - the current integer timestamp in milliseconds from the exchange server

See

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

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

fetchCurrencies{docsify-ignore}

fetches all available currencies on an exchange

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

See: https://mexcdevelop.github.io/apidocs/spot_v3_en/#query-the-currency-information

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

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

fetchMarkets{docsify-ignore}

retrieves data on all markets for mexc

Kind: instance method of <code>mexc</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
mexc.fetchMarkets ([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>mexc</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
mexc.fetchOrderBook (symbol[, limit, params])

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

fetchTrades{docsify-ignore}

get the list of most recent trades for a particular symbol

Kind: instance method of <code>mexc</code>
Returns: <code>Array<Trade></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
params.until<code>int</code>Nospot only since must be defined the latest time in ms to fetch entries for
javascript
mexc.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>mexc</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 in ms of the latest candle to fetch
params.paginate<code>boolean</code>Nodefault false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the availble parameters
javascript
mexc.fetchOHLCV (symbol, timeframe[, since, limit, 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>mexc</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
mexc.fetchTickers (symbols[, 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>mexc</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
mexc.fetchTicker (symbol[, params])

<a name="fetchBidsAsks" id="fetchbidsasks"></a>

fetchBidsAsks{docsify-ignore}

fetches the bid and ask price and volume for multiple markets

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

See: https://mexcdevelop.github.io/apidocs/spot_v3_en/#symbol-order-book-ticker

ParamTypeRequiredDescription
symbols<code>Array<string></code>, <code>undefined</code>Yesunified symbols of the markets to fetch the bids and asks for, all markets are returned if not assigned
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
mexc.fetchBidsAsks (symbols[, 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>mexc</code>
Returns: <code>object</code> - an order structure

See: https://mexcdevelop.github.io/apidocs/spot_v3_en/#new-order

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
mexc.createMarketBuyOrderWithCost (symbol, cost[, params])

<a name="createMarketSellOrderWithCost" id="createmarketsellorderwithcost"></a>

createMarketSellOrderWithCost{docsify-ignore}

create a market sell order by providing the symbol and cost

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

See: https://mexcdevelop.github.io/apidocs/spot_v3_en/#new-order

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
mexc.createMarketSellOrderWithCost (symbol, cost[, params])

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

createOrder{docsify-ignore}

create a trade order

Kind: instance method of <code>mexc</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' or 'limit'
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>Noonly 'isolated' is supported for spot-margin trading
params.triggerPrice<code>float</code>NoThe price at which a trigger order is triggered at
params.postOnly<code>bool</code>Noif true, the order will only be posted if it will be a maker order
params.reduceOnly<code>bool</code>Nocontract only indicates if this order is to reduce the size of a position
params.hedged<code>bool</code>Noswap only true for hedged mode, false for one way mode, default is false
params.timeInForce<code>string</code>No'IOC' or 'FOK', default is 'GTC' EXCHANGE SPECIFIC PARAMETERS
params.leverage<code>int</code>Nocontract only leverage is necessary on isolated margin
params.positionId<code>long</code>Nocontract only it is recommended to fill in this parameter when closing a position
params.externalOid<code>string</code>Nocontract only external order ID
params.positionMode<code>int</code>Nocontract only 1:hedge, 2:one-way, default: the user's current config
params.test<code>boolean</code>Nospot only whether to use the test endpoint or not, default is false
javascript
mexc.createOrder (symbol, type, side, amount[, price, params])

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

createOrders{docsify-ignore}

spot only all orders must have the same symbol create a list of trade orders

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

See: https://mexcdevelop.github.io/apidocs/spot_v3_en/#batch-orders

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 api endpoint
javascript
mexc.createOrders (orders[, params])

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

fetchOrder{docsify-ignore}

fetches information on an order made by the user

Kind: instance method of <code>mexc</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.marginMode<code>string</code>Noonly 'isolated' is supported, for spot-margin trading
javascript
mexc.fetchOrder (id, symbol[, params])

<a name="fetchOrders" id="fetchorders"></a>

fetchOrders{docsify-ignore}

fetches information on multiple orders made by the user

Kind: instance method of <code>mexc</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>Nothe latest time in ms to fetch orders for
params.marginMode<code>string</code>Noonly 'isolated' is supported, for spot-margin trading
javascript
mexc.fetchOrders (symbol[, since, limit, params])

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

fetchOpenOrders{docsify-ignore}

fetch all unfilled currently open orders

Kind: instance method of <code>mexc</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 orders structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.marginMode<code>string</code>Noonly 'isolated' is supported, for spot-margin trading
javascript
mexc.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>mexc</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
javascript
mexc.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>mexc</code>
Returns: <code>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>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
mexc.fetchCanceledOrders (symbol[, since, limit, params])

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

cancelOrder{docsify-ignore}

cancels an open order

Kind: instance method of <code>mexc</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.marginMode<code>string</code>Noonly 'isolated' is supported for spot-margin trading
javascript
mexc.cancelOrder (id, symbol[, params])

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

cancelOrders{docsify-ignore}

cancel multiple orders

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

See: https://mexcdevelop.github.io/apidocs/contract_v1_en/#cancel-the-order-under-maintenance

ParamTypeRequiredDescription
ids<code>Array<string></code>Yesorder ids
symbol<code>string</code>Yesunified market symbol, default is undefined
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
mexc.cancelOrders (ids, symbol[, params])

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

cancelAllOrders{docsify-ignore}

cancel all open orders

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

See

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.marginMode<code>string</code>Noonly 'isolated' is supported for spot-margin trading
javascript
mexc.cancelAllOrders (symbol[, params])

<a name="fetchAccounts" id="fetchaccounts"></a>

fetchAccounts{docsify-ignore}

fetch all the accounts associated with a profile

Kind: instance method of <code>mexc</code>
Returns: <code>object</code> - a dictionary of account structures indexed by the account type

See

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

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

fetchTradingFee{docsify-ignore}

fetch the trading fees for a market

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

See: https://mexcdevelop.github.io/apidocs/spot_v3_en/#query-mx-deduct-status

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
mexc.fetchTradingFee (symbol[, 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>mexc</code>
Returns: <code>object</code> - a balance structure

See

ParamTypeRequiredDescription
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.symbols<code>string</code>No// required for margin, market id's separated by commas
javascript
mexc.fetchBalance ([params])

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

fetchMyTrades{docsify-ignore}

fetch all trades made by the user

Kind: instance method of <code>mexc</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
javascript
mexc.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>mexc</code>
Returns: <code>Array<object></code> - a list of trade structures

See

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
javascript
mexc.fetchOrderTrades (id, symbol[, since, limit, params])

<a name="reduceMargin" id="reducemargin"></a>

reduceMargin{docsify-ignore}

remove margin from a position

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

See: https://mexcdevelop.github.io/apidocs/contract_v1_en/#increase-or-decrease-margin

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
amount<code>float</code>Yesthe amount of margin to remove
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
mexc.reduceMargin (symbol, amount[, params])

<a name="addMargin" id="addmargin"></a>

addMargin{docsify-ignore}

add margin

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

See: https://mexcdevelop.github.io/apidocs/contract_v1_en/#increase-or-decrease-margin

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified market symbol
amount<code>float</code>Yesamount of margin to add
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
mexc.addMargin (symbol, amount[, params])

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

setLeverage{docsify-ignore}

set the level of leverage for a market

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

See: https://mexcdevelop.github.io/apidocs/contract_v1_en/#switch-leverage

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
javascript
mexc.setLeverage (leverage, symbol[, 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>mexc</code>
Returns: <code>object</code> - a funding history structure

See: https://mexcdevelop.github.io/apidocs/contract_v1_en/#get-details-of-user-s-funding-rate

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

<a name="fetchFundingInterval" id="fetchfundinginterval"></a>

fetchFundingInterval{docsify-ignore}

fetch the current funding rate interval

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

See: https://mexcdevelop.github.io/apidocs/contract_v1_en/#get-contract-funding-rate

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

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

fetchFundingRate{docsify-ignore}

fetch the current funding rate

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

See: https://mexcdevelop.github.io/apidocs/contract_v1_en/#get-contract-funding-rate

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

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

fetchFundingRateHistory{docsify-ignore}

fetches historical funding rate prices

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

See: https://mexcdevelop.github.io/apidocs/contract_v1_en/#get-contract-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 used by mexc, but filtered internally by ccxt
limit<code>int</code>Nomexc limit is page_size default 20, maximum is 100
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
mexc.fetchFundingRateHistory (symbol[, since, limit, params])

<a name="fetchLeverageTiers" id="fetchleveragetiers"></a>

fetchLeverageTiers{docsify-ignore}

retrieve information on the maximum leverage, and maintenance margin for trades of varying trade sizes, if a market has a leverage tier of 0, then the leverage tiers cannot be obtained for this market

Kind: instance method of <code>mexc</code>
Returns: <code>object</code> - a dictionary of leverage tiers structures, indexed by market symbols

See: https://mexcdevelop.github.io/apidocs/contract_v1_en/#get-the-contract-information

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

<a name="fetchDepositAddressesByNetwork" id="fetchdepositaddressesbynetwork"></a>

fetchDepositAddressesByNetwork{docsify-ignore}

fetch a dictionary of addresses for a currency, indexed by network

Kind: instance method of <code>mexc</code>
Returns: <code>object</code> - a dictionary of address structures indexed by the network

See: https://mexcdevelop.github.io/apidocs/spot_v3_en/#deposit-address-supporting-network

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code of the currency for the deposit address
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
mexc.fetchDepositAddressesByNetwork (code[, params])

<a name="createDepositAddress" id="createdepositaddress"></a>

createDepositAddress{docsify-ignore}

create a currency deposit address

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

See: https://mexcdevelop.github.io/apidocs/spot_v3_en/#generate-deposit-address-supporting-network

ParamTypeRequiredDescription
code<code>string</code>Yesunified currency code of the currency for the deposit address
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.network<code>string</code>Nothe blockchain network name
javascript
mexc.createDepositAddress (code[, 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>mexc</code>
Returns: <code>object</code> - an address structure

See: https://mexcdevelop.github.io/apidocs/spot_v3_en/#deposit-address-supporting-network

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 chain of currency, this only apply for multi-chain currency, and there is no need for single chain currency
javascript
mexc.fetchDepositAddress (code[, params])

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

fetchDeposits{docsify-ignore}

fetch all deposits made to an account

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

See: https://mexcdevelop.github.io/apidocs/spot_v3_en/#deposit-history-supporting-network

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
mexc.fetchDeposits (code[, since, limit, params])

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

fetchWithdrawals{docsify-ignore}

fetch all withdrawals made from an account

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

See: https://mexcdevelop.github.io/apidocs/spot_v3_en/#withdraw-history-supporting-network

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
mexc.fetchWithdrawals (code[, 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>mexc</code>
Returns: <code>object</code> - a position structure

See: https://mexcdevelop.github.io/apidocs/contract_v1_en/#get-the-user-s-history-position-information

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

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

fetchPositions{docsify-ignore}

fetch all open positions

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

See: https://mexcdevelop.github.io/apidocs/contract_v1_en/#get-the-user-s-history-position-information

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
mexc.fetchPositions (symbols[, params])

<a name="fetchTransfer" id="fetchtransfer"></a>

fetchTransfer{docsify-ignore}

fetches a transfer

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

See: https://mexcdevelop.github.io/apidocs/spot_v2_en/#internal-assets-transfer-order-inquiry

ParamTypeRequiredDescription
id<code>string</code>Yestransfer id
code<code>string</code>Nonot used by mexc fetchTransfer
params<code>object</code>Yesextra parameters specific to the exchange api endpoint
javascript
mexc.fetchTransfer (id[, code, params])

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

fetchTransfers{docsify-ignore}

fetch a history of internal transfers made on an account

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

See

ParamTypeRequiredDescription
codeYes
since<code>int</code>Nothe earliest time in ms to fetch transfers for
limit<code>int</code>Nothe maximum number of transfers structures to retrieve
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.fromAccountType<code>string</code>No'SPOT' for spot wallet, 'FUTURES' for contract wallet
params.toAccountType<code>string</code>No'SPOT' for spot wallet, 'FUTURES' for contract wallet
javascript
mexc.fetchTransfers (code[, since, limit, params])

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

transfer{docsify-ignore}

transfer currency internally between wallets on the same account

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

See: https://mexcdevelop.github.io/apidocs/spot_v3_en/#user-universal-transfer

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
params.symbol<code>string</code>Nomarket symbol required for margin account transfers eg:BTCUSDT
javascript
mexc.transfer (code, amount, fromAccount, toAccount[, params])

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

withdraw{docsify-ignore}

make a withdrawal

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

See

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.internal<code>object</code>Nofalse by default, set to true for an "internal transfer"
params.toAccountType<code>object</code>Noskipped by default, set to 'EMAIL
javascript
mexc.withdraw (code, amount, address, tag[, params])

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

setPositionMode{docsify-ignore}

set hedged to true or false for a market

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

See: https://mexcdevelop.github.io/apidocs/contract_v1_en/#change-position-mode

ParamTypeRequiredDescription
hedged<code>bool</code>Yesset to true to use dualSidePosition
symbol<code>string</code>Yesnot used by mexc setPositionMode ()
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
mexc.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>mexc</code>
Returns: <code>object</code> - an object detailing whether the market is in hedged or one-way mode

See: https://mexcdevelop.github.io/apidocs/contract_v1_en/#get-position-mode

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

<a name="fetchTransactionFees" id="fetchtransactionfees"></a>

fetchTransactionFees{docsify-ignore}

fetch deposit and withdrawal fees

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

See: https://mexcdevelop.github.io/apidocs/spot_v3_en/#query-the-currency-information

ParamTypeRequiredDescription
codes<code>Array<string></code>, <code>undefined</code>Yesreturns fees for all currencies if undefined
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
mexc.fetchTransactionFees (codes[, params])

<a name="fetchDepositWithdrawFees" id="fetchdepositwithdrawfees"></a>

fetchDepositWithdrawFees{docsify-ignore}

fetch deposit and withdrawal fees

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

See: https://mexcdevelop.github.io/apidocs/spot_v3_en/#query-the-currency-information

ParamTypeRequiredDescription
codes<code>Array<string></code>, <code>undefined</code>Yesreturns fees for all currencies if undefined
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
mexc.fetchDepositWithdrawFees (codes[, params])

<a name="fetchLeverage" id="fetchleverage"></a>

fetchLeverage{docsify-ignore}

fetch the set leverage for a market

Kind: instance method of <code>mexc</code>
Returns: <code>object</code> - a leverage structure

See: https://mexcdevelop.github.io/apidocs/contract_v1_en/#get-leverage

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

<a name="fetchPositionsHistory" id="fetchpositionshistory"></a>

fetchPositionsHistory{docsify-ignore}

fetches historical positions

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

See: https://mexcdevelop.github.io/apidocs/contract_v1_en/#get-the-user-s-history-position-information

ParamTypeRequiredDescription
symbols<code>Array<string></code>Nounified contract symbols
since<code>int</code>Nonot used by mexc fetchPositionsHistory
limit<code>int</code>Nothe maximum amount of candles to fetch, default=1000
params<code>object</code>Noextra parameters specific to the exchange api endpoint EXCHANGE SPECIFIC PARAMETERS
params.type<code>int</code>Noposition type，1: long, 2: short
params.page_num<code>int</code>Nocurrent page number, default is 1
javascript
mexc.fetchPositionsHistory ([symbols, since, limit, params])

<a name="setMarginMode" id="setmarginmode"></a>

setMarginMode{docsify-ignore}

set margin mode to 'cross' or 'isolated'

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

See: https://mexcdevelop.github.io/apidocs/contract_v1_en/#switch-leverage

ParamTypeRequiredDescription
marginMode<code>string</code>Yes'cross' or 'isolated'
symbol<code>string</code>Norequired when there is no position, else provide params["positionId"]
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.positionId<code>string</code>Norequired when a position is set
params.direction<code>string</code>No"long" or "short" required when there is no position
javascript
mexc.setMarginMode (marginMode[, symbol, 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>mexc</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
params.miniTicker<code>boolean</code>Noset to true for using the miniTicker endpoint
javascript
mexc.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>mexc</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
params.miniTicker<code>boolean</code>Noset to true for using the miniTicker endpoint
javascript
mexc.watchTickers (symbols[, params])

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

watchBidsAsks{docsify-ignore}

watches best bid & ask for symbols

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

See: https://mexcdevelop.github.io/apidocs/spot_v3_en/#individual-symbol-book-ticker-streams

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

See: https://www.mexc.com/api-docs/spot-v3/websocket-market-streams#trade-streams

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
mexc.watchOHLCV (symbol, timeframe[, since, limit, 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>mexc</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.frequency<code>string</code>Nothe frequency of the order book updates, default is '10ms', can be '100ms' or '10ms
javascript
mexc.watchOrderBook (symbol[, limit, 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>mexc</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
mexc.watchTrades (symbol[, since, limit, params])

<a name="watchMyTrades" id="watchmytrades"></a>

watchMyTrades{docsify-ignore}

watches information on multiple trades made by the user

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

See

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

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

watchOrders{docsify-ignore}

watches information on multiple orders made by the user

Kind: instance method of <code>mexc</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
params.type<code>string</code>, <code>undefined</code>Yesthe type of orders to retrieve, can be 'spot' or 'margin'
javascript
mexc.watchOrders (symbol[, since, limit, 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>mexc</code>
Returns: <code>object</code> - a balance structure

See: https://www.mexc.com/api-docs/spot-v3/websocket-user-data-streams#spot-account-update

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

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

watchFundingRate{docsify-ignore}

watch the current funding rate

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

See: https://www.mexc.com/api-docs/futures/websocket-api#funding-rate

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

<a name="unWatchFundingRate" id="unwatchfundingrate"></a>

unWatchFundingRate{docsify-ignore}

unWatches the current funding rate for a symbol

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

See: https://www.mexc.com/api-docs/futures/websocket-api#funding-rate

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified symbol of the market
params<code>object</code>Noextra parameters specific to the exchange API endpoint
javascript
mexc.unWatchFundingRate (symbol[, 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 all markets of a specific list

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

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

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
mexc.unWatchTickers (symbols[, params])

<a name="unWatchBidsAsks" id="unwatchbidsasks"></a>

unWatchBidsAsks{docsify-ignore}

unWatches best bid & ask for symbols

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

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
mexc.unWatchBidsAsks (symbols[, 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>mexc</code>
Returns: <code>Array<Array<int>></code> - A list of candles ordered as timestamp, open, high, low, close, volume

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
params.timezone<code>object</code>Noif provided, kline intervals are interpreted in that timezone instead of UTC, example '+08:00'
javascript
mexc.unWatchOHLCV (symbol, timeframe[, 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>mexc</code>
Returns: <code>object</code> - A dictionary of order book structures indexed by market symbols

ParamTypeRequiredDescription
symbol<code>string</code>Yesunified array of symbols
params<code>object</code>Noextra parameters specific to the exchange API endpoint
params.frequency<code>string</code>Nothe frequency of the order book updates, default is '10ms', can be '100ms' or '10ms
javascript
mexc.unWatchOrderBook (symbol[, params])

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

unWatchTrades{docsify-ignore}

unsubscribes from the trades channel

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

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
params.name<code>string</code>Nothe name of the method to call, 'trade' or 'aggTrade', default is 'trade'
javascript
mexc.unWatchTrades (symbol[, params])