## mexc{docsify-ignore} **Kind**: global class **Extends**: Exchange * [fetchStatus](#fetchstatus) * [fetchTime](#fetchtime) * [fetchCurrencies](#fetchcurrencies) * [fetchMarkets](#fetchmarkets) * [fetchOrderBook](#fetchorderbook) * [fetchTrades](#fetchtrades) * [fetchOHLCV](#fetchohlcv) * [fetchTickers](#fetchtickers) * [fetchTicker](#fetchticker) * [fetchBidsAsks](#fetchbidsasks) * [createMarketBuyOrderWithCost](#createmarketbuyorderwithcost) * [createOrder](#createorder) * [createOrders](#createorders) * [fetchOrder](#fetchorder) * [fetchOrders](#fetchorders) * [fetchOpenOrders](#fetchopenorders) * [fetchClosedOrders](#fetchclosedorders) * [fetchCanceledOrders](#fetchcanceledorders) * [cancelOrder](#cancelorder) * [cancelOrders](#cancelorders) * [cancelAllOrders](#cancelallorders) * [fetchAccounts](#fetchaccounts) * [fetchTradingFees](#fetchtradingfees) * [fetchBalance](#fetchbalance) * [fetchMyTrades](#fetchmytrades) * [fetchOrderTrades](#fetchordertrades) * [reduceMargin](#reducemargin) * [addMargin](#addmargin) * [setLeverage](#setleverage) * [fetchFundingHistory](#fetchfundinghistory) * [fetchFundingRate](#fetchfundingrate) * [fetchFundingRateHistory](#fetchfundingratehistory) * [fetchLeverageTiers](#fetchleveragetiers) * [fetchDepositAddressesByNetwork](#fetchdepositaddressesbynetwork) * [createDepositAddress](#createdepositaddress) * [fetchDepositAddress](#fetchdepositaddress) * [fetchDeposits](#fetchdeposits) * [fetchWithdrawals](#fetchwithdrawals) * [fetchPosition](#fetchposition) * [fetchPositions](#fetchpositions) * [fetchTransfers](#fetchtransfers) * [transfer](#transfer) * [withdraw](#withdraw) * [fetchTransactionFees](#fetchtransactionfees) * [fetchDepositWithdrawFees](#fetchdepositwithdrawfees) * [fetchLeverage](#fetchleverage) * [fetchPositionsHistory](#fetchpositionshistory) * [watchTicker](#watchticker) * [watchOHLCV](#watchohlcv) * [watchOrderBook](#watchorderbook) * [watchTrades](#watchtrades) * [watchMyTrades](#watchmytrades) * [watchOrders](#watchorders) * [watchBalance](#watchbalance) ### fetchStatus{docsify-ignore} the latest known information on the availability of the exchange API **Kind**: instance method of [mexc](#mexc) **Returns**: object - a [status structure](https://docs.ccxt.com/#/?id=exchange-status-structure) **See** - https://mexcdevelop.github.io/apidocs/spot_v3_en/#test-connectivity - https://mexcdevelop.github.io/apidocs/contract_v1_en/#get-the-server-time | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript mexc.fetchStatus ([params]) ``` ### fetchTime{docsify-ignore} fetches the current integer timestamp in milliseconds from the exchange server **Kind**: instance method of [mexc](#mexc) **Returns**: int - the current integer timestamp in milliseconds from the exchange server **See** - https://mexcdevelop.github.io/apidocs/spot_v3_en/#check-server-time - https://mexcdevelop.github.io/apidocs/contract_v1_en/#get-the-server-time | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript mexc.fetchTime ([params]) ``` ### fetchCurrencies{docsify-ignore} fetches all available currencies on an exchange **Kind**: instance method of [mexc](#mexc) **Returns**: object - an associative dictionary of currencies **See**: https://mexcdevelop.github.io/apidocs/spot_v3_en/#query-the-currency-information | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript mexc.fetchCurrencies ([params]) ``` ### fetchMarkets{docsify-ignore} retrieves data on all markets for mexc **Kind**: instance method of [mexc](#mexc) **Returns**: Array<object> - an array of objects representing market data **See** - https://mexcdevelop.github.io/apidocs/spot_v3_en/#exchange-information - https://mexcdevelop.github.io/apidocs/contract_v1_en/#get-the-contract-information | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript mexc.fetchMarkets ([params]) ``` ### fetchOrderBook{docsify-ignore} fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data **Kind**: instance method of [mexc](#mexc) **Returns**: object - A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols **See** - https://mexcdevelop.github.io/apidocs/spot_v3_en/#order-book - https://mexcdevelop.github.io/apidocs/contract_v1_en/#get-the-contract-s-depth-information | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch the order book for | | limit | int | No | the maximum amount of order book entries to return | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript mexc.fetchOrderBook (symbol[, limit, params]) ``` ### fetchTrades{docsify-ignore} get the list of most recent trades for a particular symbol **Kind**: instance method of [mexc](#mexc) **Returns**: Array<Trade> - a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades) **See** - https://mexcdevelop.github.io/apidocs/spot_v3_en/#recent-trades-list - https://mexcdevelop.github.io/apidocs/spot_v3_en/#compressed-aggregate-trades-list - https://mexcdevelop.github.io/apidocs/contract_v1_en/#get-contract-transaction-data | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch trades for | | since | int | No | timestamp in ms of the earliest trade to fetch | | limit | int | No | the maximum amount of trades to fetch | | params | object | No | extra parameters specific to the exchange API endpoint | | params.until | int | No | *spot only* *since must be defined* the latest time in ms to fetch entries for | ```javascript mexc.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 [mexc](#mexc) **Returns**: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume **See** - https://mexcdevelop.github.io/apidocs/spot_v3_en/#kline-candlestick-data - https://mexcdevelop.github.io/apidocs/contract_v1_en/#k-line-data | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch OHLCV data for | | timeframe | string | Yes | the length of time each candle represents | | since | int | No | timestamp in ms of the earliest candle to fetch | | limit | int | No | the maximum amount of candles to fetch | | params | object | No | extra parameters specific to the exchange API endpoint | | params.until | int | No | timestamp in ms of the latest candle to fetch | | params.paginate | boolean | No | default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the [availble parameters](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params) | ```javascript mexc.fetchOHLCV (symbol, timeframe[, since, limit, params]) ``` ### fetchTickers{docsify-ignore} fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market **Kind**: instance method of [mexc](#mexc) **Returns**: object - a dictionary of [ticker structures](https://docs.ccxt.com/#/?id=ticker-structure) | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string>, undefined | Yes | unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript mexc.fetchTickers (symbols[, 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 [mexc](#mexc) **Returns**: object - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure) | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch the ticker for | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript mexc.fetchTicker (symbol[, params]) ``` ### fetchBidsAsks{docsify-ignore} fetches the bid and ask price and volume for multiple markets **Kind**: instance method of [mexc](#mexc) **Returns**: object - a dictionary of [ticker structures](https://docs.ccxt.com/#/?id=ticker-structure) | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string>, undefined | Yes | unified symbols of the markets to fetch the bids and asks for, all markets are returned if not assigned | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript mexc.fetchBidsAsks (symbols[, params]) ``` ### createMarketBuyOrderWithCost{docsify-ignore} create a market buy order by providing the symbol and cost **Kind**: instance method of [mexc](#mexc) **Returns**: object - an [order structure](https://docs.ccxt.com/#/?id=order-structure) **See**: https://mexcdevelop.github.io/apidocs/spot_v3_en/#new-order | 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 | ```javascript mexc.createMarketBuyOrderWithCost (symbol, cost[, params]) ``` ### createOrder{docsify-ignore} create a trade order **Kind**: instance method of [mexc](#mexc) **Returns**: object - an [order structure](https://docs.ccxt.com/#/?id=order-structure) **See** - https://mexcdevelop.github.io/apidocs/spot_v3_en/#new-order - https://mexcdevelop.github.io/apidocs/contract_v1_en/#order-under-maintenance - https://mexcdevelop.github.io/apidocs/contract_v1_en/#trigger-order-under-maintenance | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to create an order in | | type | string | Yes | 'market' or 'limit' | | side | string | Yes | 'buy' or 'sell' | | amount | float | Yes | how much of currency you want to trade in units of base currency | | price | float | No | the price at which the order is to be 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 | only 'isolated' is supported for spot-margin trading | | params.triggerPrice | float | No | The price at which a trigger order is triggered at | | params.postOnly | bool | No | if true, the order will only be posted if it will be a maker order | | params.reduceOnly | bool | No | *contract only* indicates if this order is to reduce the size of a position EXCHANGE SPECIFIC PARAMETERS | | params.leverage | int | No | *contract only* leverage is necessary on isolated margin | | params.positionId | long | No | *contract only* it is recommended to fill in this parameter when closing a position | | params.externalOid | string | No | *contract only* external order ID | | params.positionMode | int | No | *contract only* 1:hedge, 2:one-way, default: the user's current config | ```javascript mexc.createOrder (symbol, type, side, amount[, price, params]) ``` ### createOrders{docsify-ignore} *spot only* *all orders must have the same symbol* create a list of trade orders **Kind**: instance method of [mexc](#mexc) **Returns**: object - an [order structure](https://docs.ccxt.com/#/?id=order-structure) **See**: https://mexcdevelop.github.io/apidocs/spot_v3_en/#batch-orders | 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 api endpoint | ```javascript mexc.createOrders (orders[, params]) ``` ### fetchOrder{docsify-ignore} fetches information on an order made by the user **Kind**: instance method of [mexc](#mexc) **Returns**: object - An [order structure](https://docs.ccxt.com/#/?id=order-structure) | Param | Type | Required | Description | | --- | --- | --- | --- | | 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.marginMode | string | No | only 'isolated' is supported, for spot-margin trading | ```javascript mexc.fetchOrder (symbol[, params]) ``` ### fetchOrders{docsify-ignore} fetches information on multiple orders made by the user **Kind**: instance method of [mexc](#mexc) **Returns**: Array<Order> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) | 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.marginMode | string | No | only 'isolated' is supported, for spot-margin trading | ```javascript mexc.fetchOrders (symbol[, since, limit, params]) ``` ### fetchOpenOrders{docsify-ignore} fetch all unfilled currently open orders **Kind**: instance method of [mexc](#mexc) **Returns**: Array<Order> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | since | int | No | the earliest time in ms to fetch open orders for | | limit | int | No | the maximum number of open orders structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | | params.marginMode | string | No | only 'isolated' is supported, for spot-margin trading | ```javascript mexc.fetchOpenOrders (symbol[, since, limit, params]) ``` ### fetchClosedOrders{docsify-ignore} fetches information on multiple closed orders made by the user **Kind**: instance method of [mexc](#mexc) **Returns**: Array<Order> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol of the market orders were made in | | since | int | No | the earliest time in ms to fetch orders for | | limit | int | No | the maximum number of order structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript mexc.fetchClosedOrders (symbol[, since, limit, params]) ``` ### fetchCanceledOrders{docsify-ignore} fetches information on multiple canceled orders made by the user **Kind**: instance method of [mexc](#mexc) **Returns**: object - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) | 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 | ```javascript mexc.fetchCanceledOrders (symbol[, since, limit, params]) ``` ### cancelOrder{docsify-ignore} cancels an open order **Kind**: instance method of [mexc](#mexc) **Returns**: object - An [order structure](https://docs.ccxt.com/#/?id=order-structure) | 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.marginMode | string | No | only 'isolated' is supported for spot-margin trading | ```javascript mexc.cancelOrder (id, symbol[, params]) ``` ### cancelOrders{docsify-ignore} cancel multiple orders **Kind**: instance method of [mexc](#mexc) **Returns**: object - an list of [order structures](https://docs.ccxt.com/#/?id=order-structure) | Param | Type | Required | Description | | --- | --- | --- | --- | | ids | Array<string> | Yes | order ids | | symbol | string | Yes | unified market symbol, default is undefined | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript mexc.cancelOrders (ids, symbol[, params]) ``` ### cancelAllOrders{docsify-ignore} cancel all open orders **Kind**: instance method of [mexc](#mexc) **Returns**: Array<object> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined | | params | object | No | extra parameters specific to the exchange API endpoint | | params.marginMode | string | No | only 'isolated' is supported for spot-margin trading | ```javascript mexc.cancelAllOrders (symbol[, params]) ``` ### fetchAccounts{docsify-ignore} fetch all the accounts associated with a profile **Kind**: instance method of [mexc](#mexc) **Returns**: object - a dictionary of [account structures](https://docs.ccxt.com/#/?id=account-structure) indexed by the account type | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript mexc.fetchAccounts ([params]) ``` ### fetchTradingFees{docsify-ignore} fetch the trading fees for multiple markets **Kind**: instance method of [mexc](#mexc) **Returns**: object - a dictionary of [fee structures](https://docs.ccxt.com/#/?id=fee-structure) indexed by market symbols | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript mexc.fetchTradingFees ([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 [mexc](#mexc) **Returns**: object - a [balance structure](https://docs.ccxt.com/#/?id=balance-structure) **See** - https://mexcdevelop.github.io/apidocs/spot_v3_en/#account-information - https://mexcdevelop.github.io/apidocs/contract_v1_en/#get-all-informations-of-user-39-s-asset - https://mexcdevelop.github.io/apidocs/spot_v3_en/#isolated-account | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | | params.symbols | string | No | // required for margin, market id's separated by commas | ```javascript mexc.fetchBalance ([params]) ``` ### fetchMyTrades{docsify-ignore} fetch all trades made by the user **Kind**: instance method of [mexc](#mexc) **Returns**: Array<Trade> - a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure) | 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 | ```javascript mexc.fetchMyTrades (symbol[, since, limit, params]) ``` ### fetchOrderTrades{docsify-ignore} fetch all the trades made from a single order **Kind**: instance method of [mexc](#mexc) **Returns**: Array<object> - a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure) | 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 | ```javascript mexc.fetchOrderTrades (id, symbol[, since, limit, params]) ``` ### reduceMargin{docsify-ignore} remove margin from a position **Kind**: instance method of [mexc](#mexc) **Returns**: object - a [margin structure](https://docs.ccxt.com/#/?id=reduce-margin-structure) | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | amount | float | Yes | the amount of margin to remove | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript mexc.reduceMargin (symbol, amount[, params]) ``` ### addMargin{docsify-ignore} add margin **Kind**: instance method of [mexc](#mexc) **Returns**: object - a [margin structure](https://docs.ccxt.com/#/?id=add-margin-structure) | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | amount | float | Yes | amount of margin to add | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript mexc.addMargin (symbol, amount[, params]) ``` ### setLeverage{docsify-ignore} set the level of leverage for a market **Kind**: instance method of [mexc](#mexc) **Returns**: object - response from the exchange | Param | Type | Required | Description | | --- | --- | --- | --- | | leverage | float | Yes | the rate of leverage | | symbol | string | Yes | unified market symbol | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript mexc.setLeverage (leverage, symbol[, params]) ``` ### fetchFundingHistory{docsify-ignore} fetch the history of funding payments paid and received on this account **Kind**: instance method of [mexc](#mexc) **Returns**: object - a [funding history structure](https://docs.ccxt.com/#/?id=funding-history-structure) | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | since | int | No | the earliest time in ms to fetch funding history for | | limit | int | No | the maximum number of funding history structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript mexc.fetchFundingHistory (symbol[, since, limit, params]) ``` ### fetchFundingRate{docsify-ignore} fetch the current funding rate **Kind**: instance method of [mexc](#mexc) **Returns**: object - a [funding rate structure](https://docs.ccxt.com/#/?id=funding-rate-structure) | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript mexc.fetchFundingRate (symbol[, params]) ``` ### fetchFundingRateHistory{docsify-ignore} fetches historical funding rate prices **Kind**: instance method of [mexc](#mexc) **Returns**: Array<object> - a list of [funding rate structures](https://docs.ccxt.com/#/?id=funding-rate-history-structure) | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch the funding rate history for | | since | int | No | not used by mexc, but filtered internally by ccxt | | limit | int | No | mexc limit is page_size default 20, maximum is 100 | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript mexc.fetchFundingRateHistory (symbol[, since, limit, params]) ``` ### 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 [mexc](#mexc) **Returns**: object - a dictionary of [leverage tiers structures](https://docs.ccxt.com/#/?id=leverage-tiers-structure), indexed by market symbols **See**: https://mexcdevelop.github.io/apidocs/contract_v1_en/#get-the-contract-information | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string> | No | list of unified market symbols | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript mexc.fetchLeverageTiers ([symbols, params]) ``` ### fetchDepositAddressesByNetwork{docsify-ignore} fetch a dictionary of addresses for a currency, indexed by network **Kind**: instance method of [mexc](#mexc) **Returns**: object - a dictionary of [address structures](https://docs.ccxt.com/#/?id=address-structure) indexed by the network **See**: https://mexcdevelop.github.io/apidocs/spot_v3_en/#deposit-address-supporting-network | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code of the currency for the deposit address | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript mexc.fetchDepositAddressesByNetwork (code[, params]) ``` ### createDepositAddress{docsify-ignore} create a currency deposit address **Kind**: instance method of [mexc](#mexc) **Returns**: object - an [address structure](https://docs.ccxt.com/#/?id=address-structure) **See**: https://mexcdevelop.github.io/apidocs/spot_v3_en/#generate-deposit-address-supporting-network | Param | Type | Required | Description | | --- | --- | --- | --- | | code | string | Yes | unified currency code of the currency for the deposit address | | params | object | No | extra parameters specific to the exchange API endpoint | | params.network | string | No | the blockchain network name | ```javascript mexc.createDepositAddress (code[, params]) ``` ### fetchDepositAddress{docsify-ignore} fetch the deposit address for a currency associated with this account **Kind**: instance method of [mexc](#mexc) **Returns**: object - an [address structure](https://docs.ccxt.com/#/?id=address-structure) **See**: https://mexcdevelop.github.io/apidocs/spot_v3_en/#deposit-address-supporting-network | 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 chain of currency, this only apply for multi-chain currency, and there is no need for single chain currency | ```javascript mexc.fetchDepositAddress (code[, params]) ``` ### fetchDeposits{docsify-ignore} fetch all deposits made to an account **Kind**: instance method of [mexc](#mexc) **Returns**: Array<object> - a list of [transaction structures](https://docs.ccxt.com/#/?id=transaction-structure) **See**: https://mexcdevelop.github.io/apidocs/spot_v3_en/#deposit-history-supporting-network | 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 | ```javascript mexc.fetchDeposits (code[, since, limit, params]) ``` ### fetchWithdrawals{docsify-ignore} fetch all withdrawals made from an account **Kind**: instance method of [mexc](#mexc) **Returns**: Array<object> - a list of [transaction structures](https://docs.ccxt.com/#/?id=transaction-structure) **See**: https://mexcdevelop.github.io/apidocs/spot_v3_en/#withdraw-history-supporting-network | 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 | ```javascript mexc.fetchWithdrawals (code[, since, limit, params]) ``` ### fetchPosition{docsify-ignore} fetch data on a single open contract trade position **Kind**: instance method of [mexc](#mexc) **Returns**: object - a [position structure](https://docs.ccxt.com/#/?id=position-structure) | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol of the market the position is held in, default is undefined | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript mexc.fetchPosition (symbol[, params]) ``` ### fetchPositions{docsify-ignore} fetch all open positions **Kind**: instance method of [mexc](#mexc) **Returns**: Array<object> - a list of [position structure](https://docs.ccxt.com/#/?id=position-structure) | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string>, undefined | Yes | list of unified market symbols | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript mexc.fetchPositions (symbols[, params]) ``` ### fetchTransfers{docsify-ignore} fetch a history of internal transfers made on an account **Kind**: instance method of [mexc](#mexc) **Returns**: Array<object> - a list of [transfer structures](https://docs.ccxt.com/#/?id=transfer-structure) | 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 transfers structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript mexc.fetchTransfers (code[, since, limit, params]) ``` ### transfer{docsify-ignore} transfer currency internally between wallets on the same account **Kind**: instance method of [mexc](#mexc) **Returns**: object - a [transfer structure](https://docs.ccxt.com/#/?id=transfer-structure) **See**: https://mexcdevelop.github.io/apidocs/spot_v3_en/#user-universal-transfer | 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 | | params.symbol | string | No | market symbol required for margin account transfers eg:BTCUSDT | ```javascript mexc.transfer (code, amount, fromAccount, toAccount[, params]) ``` ### withdraw{docsify-ignore} make a withdrawal **Kind**: instance method of [mexc](#mexc) **Returns**: object - a [transaction structure](https://docs.ccxt.com/#/?id=transaction-structure) **See**: https://mexcdevelop.github.io/apidocs/spot_v3_en/#withdraw-new | 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 | ```javascript mexc.withdraw (code, amount, address, tag[, params]) ``` ### fetchTransactionFees{docsify-ignore} fetch deposit and withdrawal fees **Kind**: instance method of [mexc](#mexc) **Returns**: Array<object> - a list of [fee structures](https://docs.ccxt.com/#/?id=fee-structure) **See**: https://mexcdevelop.github.io/apidocs/spot_v3_en/#query-the-currency-information | Param | Type | Required | Description | | --- | --- | --- | --- | | codes | Array<string>, undefined | Yes | returns fees for all currencies if undefined | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript mexc.fetchTransactionFees (codes[, params]) ``` ### fetchDepositWithdrawFees{docsify-ignore} fetch deposit and withdrawal fees **Kind**: instance method of [mexc](#mexc) **Returns**: Array<object> - a list of [fee structures](https://docs.ccxt.com/#/?id=fee-structure) **See**: https://mexcdevelop.github.io/apidocs/spot_v3_en/#query-the-currency-information | Param | Type | Required | Description | | --- | --- | --- | --- | | codes | Array<string>, undefined | Yes | returns fees for all currencies if undefined | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript mexc.fetchDepositWithdrawFees (codes[, params]) ``` ### fetchLeverage{docsify-ignore} fetch the set leverage for a market **Kind**: instance method of [mexc](#mexc) **Returns**: object - a [leverage structure](https://docs.ccxt.com/#/?id=leverage-structure) **See**: https://mexcdevelop.github.io/apidocs/contract_v1_en/#get-leverage | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript mexc.fetchLeverage (symbol[, params]) ``` ### fetchPositionsHistory{docsify-ignore} fetches historical positions **Kind**: instance method of [mexc](#mexc) **Returns**: Array<object> - a list of [position structures](https://docs.ccxt.com/#/?id=position-structure) **See**: https://mexcdevelop.github.io/apidocs/contract_v1_en/#get-the-user-s-history-position-information | Param | Type | Required | Description | | --- | --- | --- | --- | | symbols | Array<string> | No | unified contract symbols | | since | int | No | not used by mexc fetchPositionsHistory | | limit | int | No | the maximum amount of candles to fetch, default=1000 | | params | object | Yes | extra parameters specific to the exchange api endpoint EXCHANGE SPECIFIC PARAMETERS | | type | int | Yes | position type，1: long, 2: short | | page_num | int | Yes | current page number, default is 1 | ```javascript mexc.fetchPositionsHistory ([symbols, since, limit, params, type, page_num]) ``` ### 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 [mexc](#mexc) **Returns**: object - a [ticker structure](https://docs.ccxt.com/#/?id=ticker-structure) **See** - https://mexcdevelop.github.io/apidocs/spot_v3_en/#individual-symbol-book-ticker-streams - https://mexcdevelop.github.io/apidocs/contract_v1_en/#public-channels | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch the ticker for | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript mexc.watchTicker (symbol[, 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 [mexc](#mexc) **Returns**: Array<Array<int>> - A list of candles ordered as timestamp, open, high, low, close, volume **See**: https://mexcdevelop.github.io/apidocs/spot_v3_en/#kline-streams | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch OHLCV data for | | timeframe | string | Yes | the length of time each candle represents | | since | int | No | timestamp in ms of the earliest candle to fetch | | limit | int | No | the maximum amount of candles to fetch | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript mexc.watchOHLCV (symbol, timeframe[, since, limit, params]) ``` ### watchOrderBook{docsify-ignore} watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data **Kind**: instance method of [mexc](#mexc) **Returns**: object - A dictionary of [order book structures](https://docs.ccxt.com/#/?id=order-book-structure) indexed by market symbols **See** - https://mexcdevelop.github.io/apidocs/spot_v3_en/#diff-depth-stream - https://mexcdevelop.github.io/apidocs/contract_v1_en/#public-channels | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified symbol of the market to fetch the order book for | | limit | int | No | the maximum amount of order book entries to return | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript mexc.watchOrderBook (symbol[, limit, params]) ``` ### watchTrades{docsify-ignore} get the list of most recent trades for a particular symbol **Kind**: instance method of [mexc](#mexc) **Returns**: Array<object> - a list of [trade structures](https://docs.ccxt.com/#/?id=public-trades) **See** - https://mexcdevelop.github.io/apidocs/spot_v3_en/#trade-streams - https://mexcdevelop.github.io/apidocs/contract_v1_en/#public-channels | 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 | ```javascript mexc.watchTrades (symbol[, since, limit, params]) ``` ### watchMyTrades{docsify-ignore} watches information on multiple trades made by the user **Kind**: instance method of [mexc](#mexc) **Returns**: Array<object> - a list of [trade structures](https://docs.ccxt.com/#/?id=trade-structure) **See** - https://mexcdevelop.github.io/apidocs/spot_v3_en/#spot-account-deals - https://mexcdevelop.github.io/apidocs/contract_v1_en/#private-channels | Param | Type | Required | Description | | --- | --- | --- | --- | | symbol | string | Yes | unified market symbol of the market trades were made in | | since | int | No | the earliest time in ms to fetch trades for | | limit | int | No | the maximum number of trade structures to retrieve | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript mexc.watchMyTrades (symbol[, since, limit, params]) ``` ### watchOrders{docsify-ignore} watches information on multiple orders made by the user **Kind**: instance method of [mexc](#mexc) **Returns**: Array<object> - a list of [order structures](https://docs.ccxt.com/#/?id=order-structure) **See** - https://mexcdevelop.github.io/apidocs/spot_v3_en/#spot-account-orders - https://mexcdevelop.github.io/apidocs/spot_v3_en/#margin-account-orders | 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.type | string, undefined | Yes | the type of orders to retrieve, can be 'spot' or 'margin' | ```javascript mexc.watchOrders (symbol[, since, limit, params]) ``` ### watchBalance{docsify-ignore} watch balance and get the amount of funds available for trading or funds locked in orders **Kind**: instance method of [mexc](#mexc) **Returns**: object - a [balance structure](https://docs.ccxt.com/#/?id=balance-structure) **See**: https://mexcdevelop.github.io/apidocs/spot_v3_en/#spot-account-upadte | Param | Type | Required | Description | | --- | --- | --- | --- | | params | object | No | extra parameters specific to the exchange API endpoint | ```javascript mexc.watchBalance ([params]) ```