Introduction

API Key Setup

• Some endpoints will require an API Key. Please refer to this page regarding API key creation.
• Once API key is created, it is recommended to set IP restrictions on the key for security reasons.
• Never share your API key/secret key to ANYONE.

API Key Restrictions

Check the required permissions when creating an API Key

API Library

We provide developers with SDKs in five languages: Python, DotNET, Java, Javascript, and Go, and provide users with methods to call APIs directly through the SDK. Currently supports all interfaces in spot.

https://github.com/mexcdevelop/mexc-api-sdk

Postman Collections

There is now a Postman collection containing the API endpoints for quick and easy use.

This is recommended for new users who want to get a quick-start into using the API.

For more information please refer to this page: MEXC API Postman

MEXC Broker Introduction

MEXC is committed to building crypto infrastructure, with API broker partners that provide valuable services being an essential part of the MEXC ecosystem. To reward the partners, MEXC now provides privileges for MEXC brokers, including trading rebates and marketing support.

Broker Modes Supported by MEXC

1. API Broker

This includes copy trade platforms, trading bots, quantitative strategy platforms, or other asset management platforms with more than 500 people, etc. Users can authorize the API key to the API broker, and the API broker will send the trading orders containing the broker ID on behalf of the user and receive profit shares from fees.

2. Independent Broker

This includes wallet platforms, market data platforms, aggregation trading platforms, stockbrokers, as well as stock and securities trading platforms, etc., all of which have their own independent users. MEXC can provide order matching systems, account management systems, settlement systems, as well as main and sub-account systems, etc. Independent brokers can share the trading fluidity and depth over the MEXC platform and receive profit shares from fees.

To apply for a partnership, please contact: broker@mexc.com

Contact us

• MEXC API Telegram Group MEXC API Support Group
  • For any general questions about the API not covered in the documentation.
  • For any MM questions
• MEXC Customer Support website.app online customer server
  • For cases such as missing funds, help with 2FA, etc.

Change Log

2024-10-17

• Add Query Kyc status endpoint

2024-08-16

• Exchange Information endpoint update params:status and tradeSideType.

2024-06-09

• Query The Currency Information endpoint add params:netWork,network will offline soon.
• Add new withdraw endpoint,previous withdraw endpoint will offline soon.

2024-05-15

• Add query commission endpoint

2024-04-08

• Update response params of Get Withdraw History endpoint

2024-01-12

• Add query sub-account asset endpoint

2024-01-01

• Kline support interval: week
• Deposit and withdraw history endpoint update the query timestamp range

2023-12-11

• Query Sub-account List endpoint add response params:uid

2023-11-10

• Add user internal transfer endpoint and query internal transfer history endpoint.
• Add ws miniTicker and miniTickers channels.

2023-10-17

• Add Get Affiliate Referral Data endpoint and Get Subaffiliates Data endpoint

2023-09-27

• Add Get Affiliate Withdraw Record endpoint and Get Affiliate Commission Detail Record endpoint

2023-08-15

• Add Get Affiliate Commission Record endpoint

2023-06-13

• Add query all listenKey endpoint

2023-05-21

• Add Download Historical Market Data

2023-03-16

• Add:Query User Universal Transfer History (by tranId) endpoint

• ws spot@private.deals.v3.api channel add params:"commission","commissionAsset"and"deals amount"

2023-03-12

• Add:API default symbol,User API default symbol,cancel withdraw,Deposit Address endpoints.

2023-03-07

• ws add channel:Account Update

2023-02-13

• Add:Get Assets That Can Be Converted Into MX,Dust Transfer,Dust Log endpoints

2023-02-07

• ws add channel:Individual Symbol Book Ticker Streams

2023-01-06

• Update Limits Info

2022-12-29

• ETF remove some response params:

2022-12-28

• websocket add Partial Book Depth Streams

2022-12-13

• Add params: avgPrice,cumulativeQuantity,cumulativeAmount for spot@private.orders.v3.api channel
• Add Query ReferCode Endpoint

2022-11-24

• Add MEXC Broker Introduction
• Add "Enable MX Deduct" and "Query MX Deduct Status" Endpoints

2022-10-14

• Update Endpoints Wallet Endpoints:

1.Withdraw: When do a withdraw, address and memo should be passed separate (The previous version the memo is joined with a ":" after address).

2.Withdraw History: Parameters address and memo should be returned separate (The previous version the memo is joined with a ":" after address).

3.Deposit Address: The return parameter tag is changed to memo, and the memo required for deposite is returned in the memo parameter.

4.Deposit History: The return parameter addressTag is changed to memo, and the memo required for deposite is returned in the memo parameter.

5.Add Generate deposit address

6.Query the currency information: add withdrawTips and depositTips params。

2022-09-06

• Add Rebate Endpoints:

1.Get Rebate History Records:Get the rebates from friends you invited and the transactions they make.

2.Get Rebate Records Detail:You can query the records of each rebate generated by contracts and spot (non-leveraged) transactions made by your friends and their sub-accounts.

3.Get Self Rebate Records Detail:You can query the each contract and spot (no margin) your invited friend made as the self-commission record generated from it.

2022-09-02

• Add v3 websocket:

1.Websocket Market Streams:Trade Streams,Kline Streams,Diff.Depth Stream;

2.Websocket User Data Streams:Account Deals,Account Orders.

2022-08-26

• ETF add some response params:

2022-08-15

• Update for Sub-account endpoints:

1.Universal Transfer

2.Query Universal Transfer History

2022-08-03

• Add Wallet Endpoints:

1.Query the currency information

2.Withdraw

3.Deposit History

4.Withdraw History

5.Deposit Address

6.User Universal Transfer

7.Query User Universal Transfer History

2022-07-27

• Spot New Order Order type add: IOC and FOK

2022-07-15

• Account Trade List add params: isSelfTrade

2022-07-08

• Add Batch Orders Supports 20 orders in a batch,rate limit: 2 times/s.

2022-07-03

• Add Query the currency information,Query currency details and the smart contract address.

2022-05-22

• Optimize exchangeInfo Endpoints
• Optimize order Endpoints,add parameter: order id

2022-04-25

• Exchange Info add parameters:

• Current Open Orders Optimize: Get all open orders on multiple symbols,maximun support 5 symbols for one request.

2022-03-29

• Add Sub-Account Endpoints:

1.Create a Sub-account

2.Query Sub-account List

3.Create an APIKey for a sub-account

4.Query the APIKey of a sub-account

5.Delete the APIKey of a sub-account

6.Universal Transfer

7.Query Universal Transfer History

2022-03-25

• Add Postman collection

2022-03-24

• Add information of market order

2022-03-21

• Add order status

2022-03-18

• Add new Order Type: Market
• Add time page info: startTime and endTime need to the same time

2022-03-09

• Add kline interval

2022-02-19

• Add ETF

2022-02-11

• New version API

FAQs

Q1: How many API Keys can a user apply?

Each account can create up to 30 API Keys. The validity of an API Key without a linked IP address is 90 days, and the API Key will expire automatically. Each API Key can be linked to a maximum of 10 IP addresses.

Q2: How many sub-accounts can a main account apply?

Each main account can create up to 30 sub-accounts. The sub-accounts will automatically inherit the main account rates. However, sub-accounts created via API cannot be logged in on Web.

Q3: Why are there often issues of disconnections and expired sessions?

If stable access is not possible, it is recommended to use Japan or Singapore AWS cloud servers for access.

Q4: What should I do after an error is reported for exceeding the limit frequency?

After exceeding the interface access frequency limit, you will not be able to continue accessing the interface. It will resume to normal after 10 minutes to keep the interface access frequency below the limit.

Q5: How many orders can an account place?

Each account can hold up to 500 valid orders that are not completely filled.

Q6:Why does WebSocket always disconnect?

1. If there is no valid subscription, it will disconnect in 30 seconds.
2. If the subscription is successful, and there is no traffic in 60 seconds, it will automatically disconnect.
3. To ensure a stable connection, a Pong reply is required upon receiving the Ping message sent from the server.

Q7: Why am I unable to subcribe to multiple channels on WebSocket?

WebSocket currently allows subscription to up to 30 channels via a single link. Any subscription will be invalid after the limit is exceeded. To subscribe to more channels, it is recommended to create multiple links.

General Info

Base endpoint

The base endpoint is:

• https://api.mexc.com

HTTP Return Codes

• HTTP 4XX return codes are used for malformed requests; the issue is on the sender's side.
• HTTP 403 return code is used when the WAF Limit (Web Application Firewall) has been violated.
• HTTP 429 return code is used when breaking a request rate limit.
• HTTP 5XX return codes are used for internal errors; the issue is on MEXC's side. It is important to NOT treat this as a failure operation; the execution status is UNKNOWN and could have been a success.

General Information on Endpoints

The API accepts requests of type GET, POST or DELETE

• For GET endpoints, parameters must be sent as a query string.
• For POST, PUT, and DELETE endpoints, the parameters may be sent as a query string with content type application/x-www-form-urlencoded,or in the request body with content type application/json. You may mix parameters between both the query string and request body if you wish to do so.
• Parameters may be sent in any order.
• If a parameter sent in both the query string and request body, the query string parameter will be used.

Header

Relevant parameters in the header

SIGNED

• SIGNED endpoints require an additional parameter, signature, to be sent in the query string or request body(in the API of batch operation, if there are special symbols such as comma in the parameter value, these symbols need to be URL encoded when signing,and encode only support uppercase).
• Endpoints use HMAC SHA256 signatures. The HMAC SHA256 signature is a keyed HMAC SHA256 operation. Use your secretKey as the key and totalParams as the value for the HMAC operation.
• The signature is support lowercase only.
• totalParams is defined as the query string concatenated with the request body.

Timing security

The logic is as follows:

 if (timestamp < (serverTime + 1000) && (serverTime - timestamp) <= recvWindow)
  {
    // process request
  } 
  else 
  {
    // reject request
  }

• A SIGNED endpoint also requires a parameter, timestamp, to be sent which should be the millisecond timestamp of when the request was created and sent.
• An additional parameter, recvWindow, may be sent to specify the number of milliseconds after timestamp the request is valid for. If recvWindow is not sent, it defaults to 5000.

Serious trading is about timing. Networks can be unstable and unreliable, which can lead to requests taking varying amounts of time to reach the servers. With recvWindow, you can specify that the request must be processed within a certain number of milliseconds or be rejected by the server.

SIGNED Endpoint Examples for POST /api/v3/order

Example 1

HMAC SHA256 signature:

    $ echo -n "symbol=BTCUSDT&side=BUY&type=LIMIT&quantity=1&price=11&recvWindow=5000&timestamp=1644489390087" | openssl dgst -sha256 -hmac "45d0b3c26f2644f19bfb98b07741b2f5"
    (stdin)= 323c96ab85a745712e95e63cad28903dd8292e4a905e99c4ee3932023843a117

curl command:

    (HMAC SHA256)
    $ curl -H "X-MEXC-APIKEY: mx0aBYs33eIilxBWC5" -X POST 'https://api.mexc.com/api/v3/order' -d 'symbol=BTCUSDT&side=BUY&type=LIMIT&quantity=1&price=11&recvWindow=5000&timestamp=1644489390087&signature=323c96ab85a745712e95e63cad28903dd8292e4a905e99c4ee3932023843a117'

Example 2

HMAC SHA256 signature:

    $ echo -n "symbol=BTCUSDT&side=BUY&type=LIMIT&quantity=1&price=11&recvWindow=5000&timestamp=1644489390087" | openssl dgst -sha256 -hmac "45d0b3c26f2644f19bfb98b07741b2f5"
    (stdin)= fd3e4e8543c5188531eb7279d68ae7d26a573d0fc5ab0d18eb692451654d837a

curl command:

    (HMAC SHA256)
    $ curl -H "X-MEXC-APIKEY: mx0aBYs33eIilxBWC5" -X POST 'https://api.mexc.com/api/v3/order' -d 'symbol=BTCUSDT&side=BUY&type=LIMIT&quantity=1&price=11&recvWindow=5000&timestamp=1644489390087&signature=fd3e4e8543c5188531eb7279d68ae7d26a573d0fc5ab0d18eb692451654d837a'

Example 3

HMAC SHA256 signature:

    $ echo -n "symbol=BTCUSDT&side=BUY&type=LIMITquantity=1&price=11&recvWindow=5000&timestamp=1644489390087" | openssl dgst -sha256 -hmac "45d0b3c26f2644f19bfb98b07741b2f5"
    (stdin)= d1a676610ceb39174c8039b3f548357994b2a34139a8addd33baadba65684592

curl command:

    (HMAC SHA256)
    $ curl -H "X-MEXC-APIKEY: mx0aBYs33eIilxBWC5" -X POST 'https://api.mexc.com/api/v3/order?symbol=BTCUSDT&side=BUY&type=LIMIT' -d 'quantity=1&price=11&recvWindow=5000&timestamp=1644489390087&signature=d1a676610ceb39174c8039b3f548357994b2a34139a8addd33baadba65684592'

Here is a step-by-step example of how to send a vaild signed payload from the Linux command line using echo, openssl, and curl.

Example 1: As a request body

• requestBody: symbol=BTCUSDT&side=BUY&type=LIMIT&quantity=1&price=11&recvWindow=5000&timestamp=1644489390087

Example 2: As a query string

• queryString: symbol=BTCUSDT&side=BUY&type=LIMIT&quantity=1&price=11&recvWindow=5000&timestamp=1644489390087

Example 3: Mixed query string and request body

• queryString: symbol=BTCUSDT&side=BUY&type=LIMIT

• requestBody: quantity=1&price=11&recvWindow=5000&timestamp=1644489390087

Note that the signature is different in example 3. There is no & between "LIMIT" and "quantity=1".

LIMITS

There is rate limit for API access frequency, upon exceed client will get code 429: Too many requests. The account is used as the basic unit of speed limit for the endpoints that need to carry access keys. For endpoints that do not need to carry access keys, IP addresses are used as the basic unit of rate limiting.

Limits Description

• According to the two modes of IP and UID (account) limit, each are independent.
• Endpoints are marked according to IP or UID limit and their corresponding weight value.
• Each endpoint with IP limits has an independent 500 every 10 second limit.
• Each endpoint with UID limits has an independent 500 every 10 second limit.

Limits Error

• When a 429 is received, it's your obligation as an API to back off and not spam the API.
• Repeatedly violating rate limits and/or failing to back off after receiving 429s will result in an automated IP ban .
• IP bans are tracked and scale in duration for repeat offenders, from 2 minutes to 3 days.
• A Retry-After header is sent with a 418 or 429 responses and will give the number of seconds required to wait, in the case of a 429, to prevent a ban, or, in the case of a 418, until the ban is over.

Websocket Limits

• The Websocket limits is: 100times/s.
• A connection that goes beyond the limit will be disconnected; IPs that are repeatedly disconnected may be banned.
• A single connection can listen to a maximum of 30 streams.

Error Code

The following error information can be returend

Market Data Endpoints

Download Historical Market Data

Provides kline and trading data for all Spot pairs since 01-01-2023:Historical Market Data

Test Connectivity

Response

{}

• GET /api/v3/ping

Test connectivity to the Rest API.

Weight(IP): 1

Parameter:

NONE

Check Server Time

Response

{
    "serverTime" : 1645539742000
}

• GET /api/v3/time

Weight(IP): 1

Parameter:

NONE

API default symbol

Request

GET /api/v3/defaultSymbols

Response

{
    "code": 200,
    "data": [
        "GENE1USDT",
        "SNTUSDT",
        "SQUAWKUSDT",
        "HEGICUSDT",
        "GUMUSDT"
    ],
    "msg": null
}

• GET /api/v3/defaultSymbols

Weight(IP): 1

Request

NONE

Response

Exchange Information

Response

{
    "symbol": "TOMO3LUSDT",
    "status": "ENABLED",
    "baseAsset": "TOMO3L",
    "baseAssetPrecision": 2,
    "quoteAsset": "USDT",
    "quotePrecision": 3,
    "quoteAssetPrecision": 3,
    "baseCommissionPrecision": 2,
    "quoteCommissionPrecision": 3,
    "orderTypes": [
        "LIMIT",
        "LIMIT_MAKER"
    ],
    "quoteOrderQtyMarketAllowed": false,
    "isSpotTradingAllowed": false,
    "isMarginTradingAllowed": false,
    "quoteAmountPrecision": "5",
    "baseSizePrecision": "0.0001",
    "permissions": [
        "SPOT",
        "LIMIT"
    ],
    "filters": [],
    "maxQuoteAmount": "5000000",
    "makerCommission": "0.002",
    "takerCommission": "0.002",
    "tradeSideType":"1"
}

• GET /api/v3/exchangeInfo

Current exchange trading rules and symbol information

Weight(IP): 10

Parameter:

There are 3 possible options:

Response:

Order Book

Response

{
  "lastUpdateId": 1112416,
  "bids": [
      ["15.00000", "49999.00000"]
  ],
  "asks": [
    ["14.0000", "1.0000"]
  ]
}

• GET /api/v3/depth

Weight(IP): 1

Parameter:

Response:

Recent Trades List

Response

[
  {
    "id": null,
    "price": "23",
    "qty": "0.478468",
    "quoteQty": "11.004764",
    "time": 1640830579240,
    "isBuyerMaker": true,
    "isBestMatch": true
  }
]

• GET /api/v3/trades

Weight(IP): 5

Parameter:

Response:

Compressed/Aggregate Trades List

Response

[
  {
    "a": null,
    "f": null,
    "l": null,
    "p": "46782.67",
    "q": "0.0038",
    "T": 1641380483000,
    "m": false,
    "M": true
  }
]

• GET /api/v3/aggTrades

Weight(IP): 1

Get compressed, aggregate trades. Trades that fill at the time, from the same order, with the same price will have the quantity aggregated.

Parameters:

startTime and endTime must be used at the same time.

Response:

Kline/Candlestick Data

Response

[
  [
    1640804880000, 
    "47482.36", 
    "47482.36", 
    "47416.57", 
    "47436.1", 
    "3.550717", 
    1640804940000, 
    "168387.3"
  ]
]

• GET /api/v3/klines

Weight(IP): 1

Kline/candlestick bars for a symbol. Klines are uniquely identified by their open time.

Parameters:

Response:

Current Average Price

Response

{
  "mins": 5,
  "price": "9.35751834"
}

• GET /api/v3/avgPrice

Weight(IP): 1

Parameters:

Response:

24hr Ticker Price Change Statistics

Response

{
    "symbol": "BTCUSDT",
    "priceChange": "184.34",
    "priceChangePercent": "0.00400048",
    "prevClosePrice": "46079.37",
    "lastPrice": "46263.71",
    "bidPrice": "46260.38",
    "bidQty": "",
    "askPrice": "46260.41",
    "askQty": "",
    "openPrice": "46079.37",
    "highPrice": "47550.01",
    "lowPrice": "45555.5",
    "volume": "1732.461487",
    "quoteVolume": null,
    "openTime": 1641349500000,
    "closeTime": 1641349582808,
    "count": null
}
or
[
  {
    "symbol": "BTCUSDT",
    "priceChange": "184.34",
    "priceChangePercent": "0.00400048",
    "prevClosePrice": "46079.37",
    "lastPrice": "46263.71",
    "bidPrice": "46260.38",
    "bidQty": "",
    "askPrice": "46260.41",
    "askQty": "",
    "openPrice": "46079.37",
    "highPrice": "47550.01",
    "lowPrice": "45555.5",
    "volume": "1732.461487",
    "quoteVolume": null,
    "openTime": 1641349500000,
    "closeTime": 1641349582808,
    "count": null
  },
  {
    "symbol": "ETHUSDT",
    "priceChange": "184.34",
    "priceChangePercent": "0.00400048",
    "prevClosePrice": "46079.37",
    "lastPrice": "46263.71",
    "bidPrice": "46260.38",
    "bidQty": "",
    "askPrice": "46260.41",
    "askQty": "",
    "openPrice": "46079.37",
    "highPrice": "47550.01",
    "lowPrice": "45555.5",
    "volume": "1732.461487",
    "quoteVolume": null,
    "openTime": 1641349500000,
    "closeTime": 1641349582808,
    "count": null
  }
]

• GET /api/v3/ticker/24hr

Weight(IP):

Parameters:

Response:

Symbol Price Ticker

Response

{
    "symbol": "BTCUSDT",
    "price": "184.34"
}
or
[
  {
    "symbol": "BTCUSDT",
    "price": "6.65"
  },
  {
    "symbol": "ETHUSDT",
    "price": "5.65"
  }
]

• GET /api/v3/ticker/price

Weight(IP):

Parameters:

Response:

Symbol Order Book Ticker

Response

{
  "symbol": "AEUSDT",
  "bidPrice": "0.11001",
  "bidQty": "115.59",
  "askPrice": "0.11127",
  "askQty": "215.48"
}
OR
[
  {
    "symbol": "AEUSDT",
    "bidPrice": "0.11001",
    "bidQty": "115.59",
    "askPrice": "0.11127",
    "askQty": "215.48"
  },
  {
    "symbol": "AEUSDT",
    "bidPrice": "0.11001",
    "bidQty": "115.59",
    "askPrice": "0.11127",
    "askQty": "215.48"
  }
]

• GET /api/v3/ticker/bookTicker

Weight(IP): 1

Best price/qty on the order book for a symbol or symbols.

Parameters:

Response:

Sub-Account Endpoints

Create a Sub-account(For Master Account)

Create a sub-account from the master account.

Response

{
    "subAccount":"mexc1",
    "note":"1"
}

• POST / api/v3/sub-account/virtualSubAccount
  

Permission: SPOT_ACCOUNT_READ

Weight(IP): 1

Parameters:

Query Sub-account List (For Master Account)

Get details of the sub-account list

Response

{
    "subAccounts":[
        {
            "subAccount":"mexc666",
            "isFreeze":false,
            "createTime":1544433328000,
            "uid": "49910511"
        },
        {
            "subAccount":"mexc888",
            "isFreeze":false,
            "createTime":1544433328000,
            "uid": "91921059"
        }
    ]
}

• GET / api/v3/sub-account/list
  

Permission: SPOT_ACCOUNT_READ

Weight(IP): 1

Parameters:

Response:

Create an APIKey for a sub-account (For Master Account)

Response

    {
        "subAccount": "mexc1",
        "note": "1",
        "apiKey": "arg13sdfgs",
        "secretKey": "nkjwn21973ihi",
        "permissions": "SPOT_ACCOUNT_READ",
        "ip": "135.181.193",
        "creatTime": 1597026383085
    }

• POST /api/v3/sub-account/apiKey
  

Permission: SPOT_ACCOUNT_READ

Weight(IP): 1

Parameters:

Query the APIKey of a sub-account (For Master Account)

Applies to master accounts only

Response

   {
       "subAccount":[
        {
            "note":"v5",
            "apiKey":"arg13sdfgs",
            "permissions":"SPOT_ACCOUNT_READ,SPOT_ACCOUNT_WRITE",
            "ip":"1.1.1.1,2.2.2.2",
            "creatTime":1597026383085
        },
        {
            "note":"v5.1",
            "apiKey":"arg13sdfgs12",
            "permissions":"SPOT_ACCOUNT_READ,SPOT_ACCOUNT_WRITE",
            "ip":"1.1.1.1,2.2.2.2",
            "creatTime":1597026383085
        }
        ]
   }

• GET/api/v3/sub-account/apiKey
  

Permission: SPOT_ACCOUNT_READ

Weight(IP): 1

Parameters:

Delete the APIKey of a sub-account (For Master Account)

Response

  {
           "subAccount":"mexc1"
}

• DELETE /api/v3/sub-account/apiKey
  

Permission: SPOT_ACCOUNT_READ

Weight(IP): 1

Parameters:

Universal Transfer (For Master Account)

Request

post /api/v3/capital/sub-account/universalTransfer

Response

 {
    "tranId":11945860693 
 }

• POST /api/v3/capital/sub-account/universalTransfer
  

Permission: SPOT_TRANSFER_WRITE

Weight(IP): 1

Parameters:

Response:

Query Universal Transfer History (For Master Account)

Request

get /api/v3/capital/sub-account/universalTransfer

Response

  {
    "tranId":"11945860693",
    "fromAccount":"master@test.com",
    "toAccount":"subaccount1@test.com",
    "clientTranId":"test",
    "asset":"BTC",
    "amount":"0.1",
    "fromAccountType":"SPOT",
    "toAccountType":"FUTURE",
    "fromSymbol":"SPOT",
    "toSymbol":"FUTURE",
    "status":"SUCCESS",
    "timestamp":1544433325000
  }

• GET /api/v3/capital/sub-account/universalTransfer
  

Permission: SPOT_TRANSFER_READ

Weight(IP): 1

Parameters:

Response:

Query Sub-account Asset

request

get /api/v3/sub-account/asset?subAccount=account1&accountType=SPOT&timestamp={{timestamp}}&signature={{signature}}

response

{
    "balances": [
        {
            "asset": "MX",
            "free": "3",
            "locked": "0"
        },
        {
            "asset": "BTC",
            "free": "0.0003",
            "locked": "0"
        }
    ]
}

• GET /api/v3/sub-account/asset
  

Permission: SPOT_TRANSFER_READ

Weight(IP): 1

request

response

Spot Account/Trade

Query KYC status

request

GET /api/v3/kyc/status?timestamp={{timestamp}}&signature={{signature}}

response

{
"status": "1"
}

GET /api/v3/kyc/status

Permission: SPOT_ACCOUNT_READ

Weight(IP): 1

Request

Response

User API default symbol

Request

GET /api/v3/selfSymbols?timestamp={{timestamp}}&signature={{signature}}

Response

{
    "code": 200,
    "data": [
        "GENE1USDT",
        "SNTUSDT",
        "SQUAWKUSDT",
        "HEGICUSDT",
        "GUMUSDT"
    ],
    "msg": null
}

• GET /api/v3/selfSymbols

Permission: SPOT_ACCOUNT_R

Weight(IP): 1

Request

NONE

Response

Test New Order

Response

{}

• POST /api/v3/order/test
  

Permission: SPOT_DEAL_WRITE

Weight(IP): 1

Creates and validates a new order but does not send it into the matching engine.

Parameters:

equaled POST /api/v3/order

New Order

Request

POST /api/v3/order?symbol=MXUSDT&side=BUY&type=LIMIT&quantity=50&price=0.1&timestamp={{timestamp}}&signature={{signature}}

Response

{
    "symbol": "MXUSDT",
    "orderId": "06a480e69e604477bfb48dddd5f0b750",
    "orderListId": -1,
    "price": "0.1",
    "origQty": "50",
    "type": "LIMIT",
    "side": "BUY",
    "transactTime": 1666676533741
}

• POST /api/v3/order
  

Permission: SPOT_DEAL_WRITE

Weight(IP): 1, Weight(UID): 1

Parameters:

Response:

Additional mandatory parameters based on type:

Other info:

MARKET: When type is market, quoteOrderQty or quantity required to choose anyone.

• MARKET orders using the quantity field specifies the amount of the base asset the user wants to sell at the market price
  • For example, sending a MARKET order on BTCUSDT will specify how much BTC the user is selling.
• MARKET orders using quoteOrderQty specifies the amount the user wants to spend (when buying) the quote asset; the correct quantity will be determined based on the market liquidity
  • Using BTCUSDT as an example:
  • On the BUY side, the order will buy as many BTC as quoteOrderQty USDT can.
  • On the SELL side, the order will sell the quantity of BTC.

Batch Orders

Supports 20 orders with a same symbol in a batch,rate limit:2 times/s.

Request

POST /api/v3/batchOrders?batchOrders=[{"type": "LIMIT_ORDER","price": "40000","quantity": "0.0002","symbol": "BTCUSDT","side": "BUY","newClientOrderId": 9588234},{"type": "LIMIT_ORDER","price": "4005","quantity": "0.0003","symbol": "BTCUSDT","side": "SELL"}]

Response

{
  { //success response:
   [
     {   
       "symbol": "BTCUSDT",   
       "orderId": "1196315350023612316",   
       "orderListId": -1 
     },
     {   
       "symbol": "BTCUSDT",   
       "orderId": "1196315350023612318",   
       "orderListId": -1 
     }
   ],
   //error response:
   [
     { 
       "symbol": "BTCUSDT", 
       "orderId": "1196315350023612316", 
       "newClientOrderId": "hio8279hbdsds", 
       "orderListId": -1 
     },
     { 
       "newClientOrderId": "123456",
       "msg": "The minimum transaction volume cannot be less than:0.5USDT", 
       "code": 30002
     },
     { 
       "symbol": "BTCUSDT", 
       "orderId": "1196315350023612318", 
       "orderListId": -1 
     }
   ] 
 }
}

• POST /api/v3/batchOrders
  

Permission: SPOT_DEAL_WRITE

Weight(IP): 1,Weight(UID): 1

Parameters:

base on differenttype,some params are mandatory:

Response

Cancel Order

Response

{
  "symbol": "LTCBTC",
  "origClientOrderId": "myOrder1",
  "orderId": 4,
  "clientOrderId": "cancelMyOrder1",
  "price": "2.00000000",
  "origQty": "1.00000000",
  "executedQty": "0.00000000",
  "cummulativeQuoteQty": "0.00000000",
  "status": "CANCELED",
  "timeInForce": "GTC",
  "type": "LIMIT",
  "side": "BUY"
}

• DELETE /api/v3/order
  

Permission: SPOT_DEAL_WRITE

Weight(IP): 1

Cancel an active order.

Parameters:

Either orderId or origClientOrderId must be sent.

Response:

Cancel all Open Orders on a Symbol

Response

[
  {
    "symbol": "BTCUSDT",
    "origClientOrderId": "E6APeyTJvkMvLMYMqu1KQ4",
    "orderId": 11,
    "orderListId": -1,
    "clientOrderId": "pXLV6Hz6mprAcVYpVMTGgx",
    "price": "0.089853",
    "origQty": "0.178622",
    "executedQty": "0.000000",
    "cummulativeQuoteQty": "0.000000",
    "status": "CANCELED",
    "timeInForce": "GTC",
    "type": "LIMIT",
    "side": "BUY"
  },
  {
    "symbol": "BTCUSDT",
    "origClientOrderId": "A3EF2HCwxgZPFMrfwbgrhv",
    "orderId": 13,
    "orderListId": -1,
    "clientOrderId": "pXLV6Hz6mprAcVYpVMTGgx",
    "price": "0.090430",
    "origQty": "0.178622",
    "executedQty": "0.000000",
    "cummulativeQuoteQty": "0.000000",
    "status": "CANCELED",
    "timeInForce": "GTC",
    "type": "LIMIT",
    "side": "BUY"
  }
]

• DELETE /api/v3/openOrders
  

Permission: SPOT_DEAL_WRITE

Weight(IP): 1

Cancel all pending orders for a single symbol, including OCO pending orders.

Parameters:

Response:

Query Order

Response

{
  "symbol": "LTCBTC",
  "orderId": 1,
  "orderListId": -1,
  "clientOrderId": "myOrder1",
  "price": "0.1",
  "origQty": "1.0",
  "executedQty": "0.0",
  "cummulativeQuoteQty": "0.0",
  "status": "NEW",
  "timeInForce": "GTC",
  "type": "LIMIT",
  "side": "BUY",
  "stopPrice": "0.0",
  "time": 1499827319559,
  "updateTime": 1499827319559,
  "isWorking": true,
  "origQuoteOrderQty": "0.000000"
}

• GET /api/v3/order
  

Permission: SPOT_DEAL_READ

Weight(IP): 2

Check an order's status.

Parameters:

Response:

Current Open Orders

Response

[
  {
    "symbol": "LTCBTC",
    "orderId": 1,
    "orderListId": -1, 
    "clientOrderId": "myOrder1",
    "price": "0.1",
    "origQty": "1.0",
    "executedQty": "0.0",
    "cummulativeQuoteQty": "0.0",
    "status": "NEW",
    "timeInForce": "GTC",
    "type": "LIMIT",
    "side": "BUY",
    "stopPrice": "0.0",
    "icebergQty": "0.0",
    "time": 1499827319559,
    "updateTime": 1499827319559,
    "isWorking": true,
    "origQuoteOrderQty": "0.000000"
  }
]

• GET /api/v3/openOrders
  

Permission: SPOT_DEAL_READ

Weight(IP): 3

Get all open orders on a symbol. Careful when accessing this with no symbol.

Parameters:

Response:

All Orders

Response

[
  {
    "symbol": "LTCBTC",
    "orderId": 1,
    "orderListId": -1, 
    "clientOrderId": "myOrder1",
    "price": "0.1",
    "origQty": "1.0",
    "executedQty": "0.0",
    "cummulativeQuoteQty": "0.0",
    "status": "NEW",
    "timeInForce": "GTC",
    "type": "LIMIT",
    "side": "BUY",
    "stopPrice": "0.0",
    "icebergQty": "0.0",
    "time": 1499827319559,
    "updateTime": 1499827319559,
    "isWorking": true,
    "origQuoteOrderQty": "0.000000"
  }
]

• GET /api/v3/allOrders
  

Permission: SPOT_DEAL_READ

Weight(IP): 10

Get all account orders including active, cancelled or completed orders(the query period is the latest 24 hours by default). You can query a maximum of the latest 7 days.

Parameters:

Response:

Account Information

Response

{
    "canTrade": true,
    "canWithdraw": true,
    "canDeposit": true,
    "updateTime": null,
    "accountType": "SPOT",
    "balances": [{
        "asset": "NBNTEST",
        "free": "1111078",
        "locked": "33"
    }, {
        "asset": "MAIN",
        "free": "1020000",
        "locked": "0"
    }],
    "permissions": ["SPOT"]
}

• GET /api/v3/account
  

Permission: SPOT_ACCOUNT_READ

Weight(IP): 10

Get current account information,rate limit:2 times/s.

Parameters:

Response:

Account Trade List

Response

[
  {
    "symbol": "BNBBTC",
    "id": "fad2af9e942049b6adbda1a271f990c6",
    "orderId": "bb41e5663e124046bd9497a3f5692f39",
    "orderListId": -1,
    "price": "4.00000100", 
    "qty": "12.00000000", 
    "quoteQty": "48.000012", 
    "commission": "10.10000000", 
    "commissionAsset": "BNB", 
    "time": 1499865549590, 
    "isBuyer": true, 
    "isMaker": false, 
    "isBestMatch": true,
    "isSelfTrade": true,
    "clientOrderId": null
  }
]

• GET /api/v3/myTrades
  

Permission: SPOT_ACCOUNT_READ

Weight(IP): 10

Get trades for a specific account and symbol,Only the transaction records in the past 1 month can be queried. If you want to view more transaction records, please use the export function on the web side, which supports exporting transaction records of the past 3 years at most.

Parameters:

Response:

Enable MX Deduct

Enable or disable MX deduct for spot commission fee

Request

post api/v3/mxDeduct/enable

Response

{
  "data":{
    "mxDeductEnable":true
  },
  "code":0,
  "msg":"success",
  "timestamp":1669109672280
} 

• POST api/v3/mxDeduct/enable
  

Permission: SPOT_DEAL_WRITE

Weight(IP): 1

Parameters:

Response:

Query MX Deduct Status

Request

get api/v3/mxDeduct/enable

Response

{
  "data":{
    "mxDeductEnable":false
  },
  "code":0,
  "msg":"success",
  "timestamp":1669109672717
}

• GET api/v3/mxDeduct/enable
  

Permission: SPOT_DEAL_READ

Weight(IP): 1

Parameters:

Response:

Query Symbol Commission

request

get api/v3/tradeFee?symbol=MXUSDT&timestamp={{timestamp}}&signature={{signature}}

return

{
  "data":{
    "makerCommission":0.003000000000000000,
    "takerCommission":0.003000000000000000
  },
  "code":0,
  "msg":"success",
  "timestamp":1669109672717
}

HTTP请求

• GET api/v3/tradeFee
  

Permission: SPOT_ACCOUNT_READ

Weight(IP): 20

request

return

Wallet Endpoints

Query the currency information

Request

Get /api/v3/capital/config/getall

Response

[
  {
    "coin": "EOS",
    "Name": "EOS",
    "networkList": [
      {
          "coin": "EOS",
          "depositDesc": null,
          "depositEnable": true,
          "minConfirm": 0,
          "Name": "EOS",
          "network": "EOS",
          "withdrawEnable": false,
          "withdrawFee": "0.000100000000000000",
          "withdrawIntegerMultiple": null,
          "withdrawMax": "10000.000000000000000000",
          "withdrawMin": "0.001000000000000000",
          "sameAddress": false,
          "contract": "TN3W4H6rK2ce4vX9YnFQHwKENnHjoxbm9",
          "withdrawTips": "Both a MEMO and an Address are required.",
          "depositTips": "Both a MEMO and an Address are required.",
          "netWork": "EOS"
      },
      {
          "coin": "BTC",
          "depositDesc": null,
          "depositEnable": true,
          "minConfirm": 0,
          "Name": "BTC-BSC",
          "network": "BEP20(BSC)",
          "withdrawEnable": true,
          "withdrawFee": "0.000010000000000000",
          "withdrawIntegerMultiple": null,
          "withdrawMax": "100.000000000000000000",
          "withdrawMin": "0.000100000000000000",
          "sameAddress": false,
          "contract": "0x7130d2a12b9bcbfae4f2634d864a1ee1ce3ead9c",
          "withdrawTips": null,
          "depositTips": null,
          "network": "BTC"
      }
    ]
  },
]

• GET /api/v3/capital/config/getall
  

Permission: SPOT_WITHDRAW_READ

Weight(IP): 10

Query currency details and the smart contract address

Parameters:

None

Response:

Withdraw(new)

Request

post /api/v3/capital/withdraw?coin=EOS&address=zzqqqqqqqqqq&amount=10&network=EOS&memo=MX10086&timestamp={{timestamp}}&signature={{signature}}

Response

{
    "id":"7213fea8e94b4a5593d507237e5a555b"
}

• POST /api/v3/capital/withdraw
  

Permission: SPOT_WITHDRAW_WRITE

Weight(IP): 1

Parameters:

Can get netWork via endpoints Get /api/v3/capital/config/getall's response params networkList.

Response:

Cancel withdraw

Request

delete /api/v3/capital/withdraw?id=ca7bd51895134fb5bd749f1cf875b8af&timestamp={{timestamp}}&signature={{signature}}

Response

{
    "id": "ca7bd51895134fb5bd749f1cf875b8af"
}

• DELETE /api/v3/capital/withdraw
  

Permission: SPOT_WITHDRAW_W

Weight(IP): 1

Request

Response

Deposit History(supporting network)

Request

get /api/v3/capital/deposit/hisrec?coin=EOS&timestamp={{timestamp}}&signature={{signature}}

Response

[
  {
        "amount": "50000",
        "coin": "EOS",
        "network": "EOS",
        "status": 5,
        "address": "0x20b7cf77db93d6ef1ab979c49142ec168427fdee",
        "txId": "01391d1c1397ef0a3cbb3c7f99a90846f7c8c2a8dddcdcf84f46b530dede203e1bc804",
        "insertTime": 1659513342000,
        "unlockConfirm": "10",
        "confirmTimes": "241",
        "memo": "xxyy1122"
  }
]

• GET /api/v3/capital/deposit/hisrec
  

Permission: SPOT_WITHDRAW_READ

Weight(IP): 1

Parameters:

1. default return the records of the last 7 days.
2. Ensure that the default timestamp of 'startTime' and 'endTime' does not exceed 7 days.
3. can query 90 days data at most.

Response:

Withdraw History (supporting network)

Request

get /api/v3/capital/withdraw/history?coin=USDT&timestamp={{timestamp}}&signature={{signature}}

Response

[
  {
        "id": "bb17a2d452684f00a523c015d512a341",
        "txId": null,
        "coin": "EOS",
        "network": "EOS",
        "address": "zzqqqqqqqqqq",
        "amount": "10",
        "transferType": 0,
        "status": 3,
        "transactionFee": "0",
        "confirmNo": null,
        "applyTime": 1665300874000,
        "remark": "",
        "memo": "MX10086",
        "transHash": "0x0ced593b8b5adc9f600334d0d7335456a7ed772ea5547beda7ffc4f33a065c",
        "updateTime": 1712134082000,
        "coinId": "128f589271cb495b03e71e6323eb7be",
        "vcoinId": "af42c6414b9a46c8869ce30fd51660f"
  }
]

• GET /api/v3/capital/withdraw/history
  

Permission: SPOT_WITHDRAW_READ

Weight(IP): 1

Parameters:

1. default return the records of the last 7 days.
2. Ensure that the default timestamp of 'startTime' and 'endTime' does not exceed 7 days.
3. can query 90 days data at most.
4. Supported multiple network coins's withdraw history may not return the 'network' field.

Response:

Generate deposit address (supporting network)

Request

post /api/v3/capital/deposit/address?coin=EOS&network=EOS&timestamp={{timestamp}}&signature={{signature}}

Response

[
  {
      "coin": "USDT",
      "network": "TRC20",
      "address": "TXobiKkdciupZrhdvZyTSSLjE8CmZAufS",
      "tag": null
  },
  {
     "coin": "EOS",
     "network": "EOS",
     "address": "zzqqqqqqqqqq",
     "memo": "MX10068"
  }
]

• POST /api/v3/capital/deposit/address
  

Permission: SPOT_WITHDRAW_WRITE

Weight(IP): 1

Parameters:

Response:

Deposit Address (supporting network)

Request

get /api/v3/capital/deposit/address?coin=USDT&timestamp={{timestamp}}&signature={{signature}}

Response

[
  {
      "coin": "USDT",
      "network": "TRC20",
      "address": "TXobiKkdciupZrhdvZyTSSLjE8CmZAufS",
      "memo": null
  },
  {
      "coin": "USDT",
      "network": "BEP20(BSC)",
      "address": "0xebe4804f7ecc22d5011c42e6ea1f2e6c891d89b",
      "memo": null
  },
  {
      "coin": "USDT",
      "network": "ERC20",
      "address": "0x3f4d1f43761b52fd594e5a77cd83cab6955e85b",
      "memo": null
  }
]

• GET /api/v3/capital/deposit/address
  

Permission: SPOT_WITHDRAW_READ

Weight(IP): 10

Parameters:

Response:

Withdraw Address (supporting network)

Request

get /api/v3/capital/withdraw/address?coin=USDT&timestamp={{timestamp}}&signature={{signature}}

Response

{
    "data": [
        {
            "coin": "USDT",
            "network": "TRC20",
            "address": "TArGWdTApuuZtiWMjupXqbZqQYsBTy126o",
            "addressTag": "test",
            "memo": null
        },
        {
            "coin": "USDT",
            "network": "BEP20(BSC)",
            "address": "0xa82898C70BeB5E1b1621fdA62fD17Ba27227BBC5",
            "addressTag": "usdt",
            "memo": null
        }
    ],
    "totalRecords": 2,
    "page": 1,
    "totalPageNum": 1
}

• GET /api/v3/capital/withdraw/address
  

Permission: SPOT_WITHDRAW_R

Weight(IP): 10

Request

Response

User Universal Transfer

Request

post /api/v3/capital/transfer?fromAccountType=FUTURES&toAccountType=SPOT&asset=USDT&amount=1&timestamp={{timestamp}}&signature={{signature}}

Response

[
  {
    "tranId": "c45d800a47ba4cbc876a5cd29388319"
  }
]

• POST /api/v3/capital/transfer
  

Permission: SPOT_TRANSFER_WRITE

Weight(IP): 1

Parameters:

Response:

Query User Universal Transfer History

Request

get /api/v3/capital/transfer

Response

[
  {
    "rows":[
    {
      "tranId":"11945860693",
      "clientTranId":"test",
      "asset":"BTC",
      "amount":"0.1",
      "fromAccountType":"SPOT",
      "toAccountType":"FUTURE",
      "fromSymbol":"SPOT",
      "toSymbol":"FUTURE",
      "status":"SUCCESS",
      "timestamp":1544433325000
    },
    {
      "tranId":"11945860693",
      "clientTranId":"test",
      "asset":"BTC",
      "amount":"0.1",
      "fromAccountType":"SPOT",
      "toAccountType":"FUTURE",
      "fromSymbol":"SPOT",
      "toSymbol":"FUTURE",
      "status":"SUCCESS",
      "timestamp":1544433325000
    }],
    "total": 2,
  }
]

• GET /api/v3/capital/transfer
  

Permission: SPOT_TRANSFER_READ

Weight(IP): 1

Parameters:

1. Only can quary the data for the last six months
2. If 'startTime' and 'endTime' are not send, will return the last seven days' data by default

Response:

Query User Universal Transfer History （by tranId）

Request

get /api/v3/capital/transfer/tranId?tranId=cb28c88cd20c42819e4d5148d5fb5742&timestamp={{timestamp}}&signature={{signature}}

Response

{
    "tranId": "cb28c88cd20c42819e4d5148d5fb5742",
    "clientTranId": null,
    "asset": "USDT",
    "amount": "10",
    "fromAccountType": "SPOT",
    "toAccountType": "FUTURES",
    "symbol": null,
    "status": "SUCCESS",
    "timestamp": 1678603205000
}

• GET /api/v3/capital/transfer/tranId
  

Permission: SPOT_TRANSFER_R

Weight(IP): 1

request

Only can quary the data for the last six months

response

Get Assets That Can Be Converted Into MX

Request

get {{api_url}}/api/v3/capital/convert/list?timestamp={{timestamp}}&signature={{signature}}

Response

[
    {
           "convertMx": "0.000009",
           "convertUsdt": "0.000009",
           "balance": "0.000441",
           "asset": "USDT",
           "code": "30021",
           "message": "xxxxxxx"
 },
{
           "convertMx": "0.000009",
           "convertUsdt": "0.000009",
           "balance": "0.000441",
           "asset": "BTC",
           "code": "30021",
           "message": "xxxxxxx"
 }
]

• GET /api/v3/capital/convert/list
  

Permission: SPOT_ACCOUNT_READ

Weight(IP): 1

Parameters:

Response:

Dust Transfer

Request

post {{api_url}}/api/v3/capital/convert?asset=BTC,FIL,ETH&timestamp={{timestamp}}&signature={{signature}}

Response

{
  "successList":["ALGO","OMG"],
  "failedList":[],
  "totalConvert":"0.07085578",
  "convertFee":"0.00071571"
  }