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/mxcdevelop/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

Contact us

MEXC API Telegram Grop 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

2022-09-06

Add Rebate Endpoints

2022-09-02

Add v3 websocket

2022-08-26

ETF endpoint add some response params

2022-08-15

Add Universal Transfer,Query Universal Transfer History,Enable Futures for Sub-account,Enable Margin for Sub-account endpoints.

2022-08-03

Add wallet endpoints

2022-07-27

Order type add IOC and FOK

2022-07-15

V3/myTrades add params:"isSelfTrade"

2022-07-08

Add batchOrders Endpoints

2022-07-03

Add Query the currency info Endpoints

2022-06-16

Add Margin Account and Trading Endpoints

2022-05-22

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

2022-04-25

Optimize exchangeInfo Endpoints,add parameters: isSpotTradingAllowed and isMarginTradingAllowed
Optimize openOrders Endpoints

2022-03-29

Add Sub-Account Endpoints

2022-03-25

Add Postman collection

2022-03-24

Add information of market order

2022-03-21

Add order state

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

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 or in the request body with content type application/x-www-form-urlencoded. 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.

Relevant parameters in the header

key	Description
`X-MEXC-APIKEY`	Access key
`Content-Type`	`application/json`

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).
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 not case sensitive.
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.

Key	Value
apiKey	mx0aBYs33eIilxBWC5
secretKey	45d0b3c26f2644f19bfb98b07741b2f5

Parameter	Value
symbol	BTCUSDT
side	BUY
type	LIMIT
quantity	1
price	11
recvWindow	5000
timestamp	1644489390087

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.

The default rate limiting rule for an endpoint is 20 times per second.

Market Data Endpoints

Test Connectivity

Response

{}

GET /api/v3/ping

Test connectivity to the Rest API.

Parameter：

NONE

Check Server Time

Response

{
    "serverTime" : 1645539742000
}

GET /api/v3/time

Parameter：

NONE

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",
        "MARGIN"
    ],
    "filters": [],
    "maxQuoteAmount": "5000000",
    "makerCommission": "0.002",
    "takerCommission": "0.002"
}

GET /api/v3/exchangeInfo

Current exchange trading rules and symbol information

Parameter：

There are 3 possible options:

Method	Example
No parameter	curl -X GET "https://api.mexc.com/api/v3/exchangeInfo"
symbol	curl -X GET "https://api.mexc.com/api/v3/exchangeInfo?symbol=MXUSDT"
symbols	curl -X GET "https://api.mexc.com/api/v3/exchangeInfo?symbols=MXUSDT,BTCUSDT"

Order Book

Response

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

GET /api/v3/depth

Parameter：

name	Type	Mandatory	Description	Scope
symbol	string	YES	Symbol
limit	integer	NO	Returen number	default 100; max 5000

Response：

name	Type	Description
lastUpdateId	long	Last Update Id
bids	list	Bid [Price, Quantity ]
asks	list	Ask [Price, Quantity ]

Recent Trades List

Response

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

GET /api/v3/trades

Parameter：

name	Type	Mandatory	Description	Scope
symbol	string	YES
limit	integer	NO		Default 500; max 1000

Response:

name	Description
id	Trade id
price	Price
qty	Number
quoteQty	Trade total
time	Trade time
isBuyerMaker	Was the buyer the maker?
isBestMatch	Was the trade the best price match?

Old Trade Lookup

Response

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

GET /api/v3/historicalTrades

Parameters:

name	Type	Mandatory	Description	Scope
symbol	string	YES	Symbol
limit	integer	NO	Return number	Default 500; max 1000

Response:

name	Description
id	Trade id
price	Price
qty	Number
quoteQty	Trade total
time	Trade time
isBuyerMaker	Was the buyer the maker?
isBestMatch	Was the trade the best price match?

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

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

Parameters:

name	Type	Mandatory	Description	Scope
symbol	string	YES
startTime	long	NO	Timestamp in ms to get aggregate trades from INCLUSIVE.
endTime	long	NO	Timestamp in ms to get aggregate trades until INCLUSIVE.
limit	integer	NO		Default 500; max 1000.

Response:

name	Description
a	Aggregate tradeId
f	First tradeId
l	Last tradeId
p	Price
q	Quantity
T	Timestamp
m	Was the buyer the maker?
M	Was the trade the best price match?

Kline/Candlestick Data

Response

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

GET /api/v3/klines

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

Parameters:

name	Type	Mandatory	Description
symbol	string	YES
interval	ENUM	YES	ENUM: Kline interval
startTime	long	NO
endTime	long	NO
limit	integer	NO	Default 500; max 1000.

Response:

Index	Description
0	Open time
1	Open
2	High
3	Low
4	Close
5	Volume
6	Close time
7	Quote asset volume

Current Average Price

Response

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

GET /api/v3/avgPrice

Parameters:

name	Type	Mandatory	Description
symbol	string	YES

Response:

name	Description
mins	Average price time frame
price	Price

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

Parameters:

name	Type	Mandatory	Description
symbol	string	NO	If the symbol is not sent, tickers for all symbols will be returned in an array.

Response:

name	Description
symbol	Symbol
priceChange	price Change
priceChangePercent	price change percent
prevClosePrice	Previous close price
lastPrice	Last price
lastQty	Last quantity
bidPrice	Bid best price
bidQty	Bid best quantity
askPrice	Ask best price
askQty	Ask best quantity
openPrice	Open
highPrice	High
lowPrice	Low
volume	Deal volume
quoteVolume	Quote asset volume
openTime	Start time
closeTime	Close time
count

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

Parameters:

name	Type	Mandatory	Description
symbol	string	NO	If the symbol is not sent, all symbols will be returned in an array.

Response:

name	Description
symbol
price	Last price

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

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

Parameters:

name	Type	Mandatory	Description
symbol	string	NO	If the symbol is not sent, all symbols will be returned in an array.

Response:

name	Description
symbol	Symbol
bidPrice	Best bid price
bidQty	Best bid quantity
askPrice	Best ask price
askQty	Best ask quantity

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

Parameters:

name	Type	Mandatory	Description
subAccount	STRING	YES	Sub-account name
note	STRING	YES	Sub-account notes
recvWindow	LONG	NO
timestamp	LONG	YES

Query Sub-account List (For Master Account)

Get details of the sub-account list

Response

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

GET / api/v3/sub-account/list

Parameters:

name	Type	Mandatory	Description
subAccount	STRING	NO	Sub-account name
isFreeze	STRING	NO	true or false
page	INT	NO	Default value: 1
limit	INT	NO	Default value: 10, Max value: 200
timestamp	LONG	YES
recvWindow	LONG	NO

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

Parameters:

name	Type	Mandatory	Description
subAccount	STRING	YES	Sub-account name
note	STRING	YES	APIKey note
permissions	STRING	YES	Permission of APIKey: SPOT_ACCOUNT_READ, SPOT_ACCOUNT_WRITE, SPOT_DEAL_READ, SPOT_DEAL_WRITE, ISOLATED_MARGIN_ACCOUNT_READ, ISOLATED_MARGIN_ACCOUNT_WRITE, ISOLATED_MARGIN_DEAL_READ, ISOLATED_MARGIN_DEAL_WRITE, CONTRACT_ACCOUNT_READ, CONTRACT_ACCOUNT_WRITE, CONTRACT_DEAL_READ, CONTRACT_DEAL_WRITE, SPOT_TRANSFER_READ, SPOT_TRANSFER_WRITE
ip	STRING	NO	Link IP addresses, separate with commas if more than one. Support up to 20 addresses.
recvWindow	LONG	NO
timestamp	LONG	YES

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

Parameters:

name	Type	Mandatory	Description
subAccount	STRING	YES	Sub-account name
recvWindow	LONG	NO
timestamp	LONG	YES

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

Response

  {
           "subAccount":"mexc1"
}

DELETE /api/v3/sub-account/apiKey

Parameters:

name	Type	Mandatory	Description
subAccount	STRING	YES	Sub-account name
apiKey	STRING	YES	API public key
recvWindow	LONG	NO
timestamp	LONG	YES

Universal Transfer (For Master Account)

Request

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

Response

 {
    "tranId":11945860693 
 }

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

Parameters:

name	Type	Mandatory	Description
fromAccount	string	NO	Transfer from master account by default if fromAccount is not sent
toAccount	string	NO	Transfer to master account by default if toAccount is not sent
fromAccountType	string	YES	fromAccountType:"SPOT","FUTURES","ISOLATED_MARGIN""FIAT"
toAccountType	string	YES	toAccountType:"SPOT","FUTURES","ISOLATED_MARGIN""FIAT"
symbol	string	NO	Only supported under ISOLATED_MARGIN type,eg:ETHUSDT
asset	string	YES	asset,eg:USDT
amount	string	YES	amount,eg:1.82938475
timestamp	string	YES	timestamp
signature	string	YES	sign

Response:

name	Type	Description
tranId	string	transfer ID

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

Parameters:

name	Type	Mandatory	Description
fromAccount	string	NO	Transfer from master account by default if fromAccount is not sent
toAccount	string	NO	Transfer to master account by default if toAccount is not sent
fromAccountType	string	YES	fromAccountType:"SPOT","FUTURES","ISOLATED_MARGIN""FIAT"
toAccountType	string	YES	toAccountType:"SPOT","FUTURES","ISOLATED_MARGIN""FIAT"
startTime	string	NO	startTime
endTime	string	NO	endTime
page	string	NO	default 1
limit	string	NO	default 500, max 500
timestamp	string	YES	timestamp
signature	string	YES	sign

Response:

name	Type	Description
tranId	string	transfer ID
fromAccount	string	fromAccount
toAccount	string	toAccount
clientTranId	string	clientTranId
asset	string	asset
amount	string	transfer amount
fromAccountType	string	fromAccountType
toAccountType	string	toAccountType
fromSymbol	string	fromSymbol
toSymbol	string	toSymbol
status	string	status
timestamp	number	timestamp
totalCount	number	total transfer

Enable Futures for Sub-account (For Master Account)

Request

post /api/v3/sub-account/futures

Response

  {
    "code": "0",
    "message": "",
    "data": [{
        "subAccount": "mexc1",
        "isFuturesEnabled": true,
        "timestamp": "1597026383085"
    }]
  }

POST /api/v3/sub-account/futures

Parameters:

name	Type	Mandatory	Description
subAccount	string	YES	subaccount name
timestamp	string	YES	timestamp
signature	string	YES	sign

Response:

name	Type	Description
subAccount	string	subaccount name
isFuturesEnabled	boolean	isFuturesEnabled:true
timestamp	string	response time

Enable Margin for Sub-account (For Master Account)

Request

post /api/v3/sub-account/margin

Response

{
  "code": "0",
  "message": "",
  "data": [{
      "subAccount": "mexc1",
      "isMarginEnabled": true,
      "timestamp": "1597026383085"
  }]
}

POST /api/v3/sub-account/margin

Parameters:

name	Type	Mandatory	Description
subAccount	string	YES	subaccount name
timestamp	string	YES	timestamp
signature	string	YES	sign

Response:

name	Type	Description
subAccount	string	subaccount name
isMarginEnabled	booleanisMarginEnabled:true or false
timestamp	string	response time

Spot Account/Trade

Test New Order

Response

{}

POST /api/v3/order/test

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

Parameters:

equaled POST /api/v3/order

New Order

Response

{
    "symbol": "BTCUSDT",
    "orderId": "0a3b6af38f7a4f2e9bea9a5782321ddc",
    "orderListId": -1
}

POST /api/v3/order

Parameters:

name	type	Mandatory	Description
symbol	STRING	YES
side	ENUM	YES	ENUM：Order Side
type	ENUM	YES	ENUM：Order Type
quantity	DECIMAL	NO	Quantity
quoteOrderQty	DECIMAL	NO	Quote order quantity
price	DECIMAL	NO	Price
newClientOrderId	STRING	NO
recvWindow	LONG	NO	Max 60000
timestamp	LONG	YES

Additional mandatory parameters based on type:

Type	Additional mandatory parameters
`LIMIT`	`quantity`, `price`
`MARKET`	`quantity` or `quoteOrderQty`

Other info:

MARKET: When type is market, if it is a buy order, quoteOrderQty is a required. If it is a sell order, quantity is a required.

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 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": "BID","newClientOrderId": 9588234},{"type": "LIMIT_ORDER","price": "4005","quantity": "0.0003","symbol": "BTCUSDT","side": "ASK"}]

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

Parameters:

name	type	Mandatory	Description
batchOrders	LIST	YES	list of batchOrders,supports max 20 orders
symbol	STRING	YES	symbol
side	ENUM	YES	order side
type	ENUM	YES	order type
quantity	DECIMAL	NO	quantity
quoteOrderQty	DECIMAL	NO	quoteOrderQty
price	DECIMAL	NO	order price
newClientOrderId	STRING	NO	ClientOrderId
recvWindow	LONG	NO	less than 60000
timestamp	LONG	YES	order time

base on differenttype,some params are mandatory:

type	Mandatory params
`LIMIT`	`quantity`, `price`
`MARKET`	`quantity` or `quoteOrderQty`

Response

name	type	Description
symbol	STRING	symbol
orderId	STRING	orderId

Cancel Orde

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

Cancel an active order.

Parameters:

name	Type	Mandatory	Description
symbol	string	YES
orderId	string	NO	Order id
origClientOrderId	string	NO
newClientOrderId	string	NO
recvWindow	long	NO
timestamp	long	YES

Either orderId or origClientOrderId must be sent.

Response:

name	Description
symbol	Symbol
origClientOrderId	Original client order id
orderId	order id
clientOrderId	client order id
price	Price
origOty	Original order quantity
executedQty	Executed order quantity
cummulativeQuoteQty	Cummulative quote quantity
status	Order status
timeInForce
type	Order type
side	Order side

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

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

Parameters:

name	Type	Mandatory	Description
symbol	string	YES	maximum input 5 symbols,separated by ",". e.g. "BTCUSDT,MXUSDT,ADAUSDT"
recvWindow	long	NO
timestamp	long	YES

Response:

name	Description
symbol	Symbol
origClientOrderId	Original client order id
orderId	order id
clientOrderId	client order id
price	Price
origOty	Original order quantity
executedQty	Executed order quantity
cummulativeQuoteQty	Cummulative quote quantity
status	Order status
timeInForce
type	Order type
side	Order side

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

Check an order's status.

Parameters:

name	Type	Mandatory
symbol	String	YES
origClientOrderId	String	NO
orderId	String	NO
recvWindow	long	NO
timestamp	long	YES

Response:

name	Description
symbol	Symbol
origClientOrderId	Original client order id
orderId	order id
clientOrderId	client order id
price	Price
origOty	Original order quantity
executedQty	Executed order quantity
cummulativeQuoteQty	Cummulative quote quantity
status	Order status
timeInForce
type	Order type
side	Order side
stopPrice	stop price
time	Order created time
updateTime	Last update time
isWorking	is orderbook

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

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

Parameters:

name	Type	Mandatory
symbol	string	YES
recvWindow	long	NO
timestamp	long	YES

Response:

name	Description
symbol	Symbol
origClientOrderId	Original client order id
orderId	order id
clientOrderId	client order id
price	Price
origOty	Original order quantity
executedQty	Executed order quantity
cummulativeQuoteQty	Cummulative quote quantity
status	Order status
timeInForce
type	Order type
side	Order side
stopPrice	stop price
time	Order created time
updateTime	Last update time
isWorking	is orderbook

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

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:

name	Type	Mandatory	Description
symbol	string	YES	Symbol
startTime	long	NO
endTime	long	NO
limit	int	NO	Default 500; max 1000;
recvWindow	long	NO
timestamp	long	YES

Response:

name	Description
symbol	Symbol
origClientOrderId	Original client order id
orderId	order id
clientOrderId	client order id
price	Price
origOty	Original order quantity
executedQty	Executed order quantity
cummulativeQuoteQty	Cummulative quote quantity
status	Order status
timeInForce
type	Order type
side	Order side
stopPrice	stop price
time	Order created time
updateTime	Last update time
isWorking	is orderbook
origQuoteOrderQty

Account Information

Response

{
    "makerCommission": 20,
    "takerCommission": 20,
    "buyerCommission": 0,
    "sellerCommission": 0,
    "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

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

Parameters:

name	Type	Mandatory	Description
recvWindow	long	NO
timestamp	long	YES

Response:

name	Description
makerCommission	maker fee
takerCommission	taker fee
buyerCommission	buyer fee
sellerCommission	seller fee
canTrade	Can Trade
canWithdraw	Can Withdraw
canDeposit	Can Deposit
updateTime	Update Time
accountType	Account type
balances	Balance
asset	Aseet coin
free	Available coin
locked	Forzen coin
permissions	Permission

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

Get trades for a specific account and symbol.

Parameters:

name	Type	Mandatory	Description
symbol	string	YES
orderId	string	NO	order Id
startTime	long	NO
endTime	long	NO
limit	int	NO	Default 500; max 1000;
recvWindow	long	NO
timestamp	long	YES

Response:

name	Description
symbol
id	deal id
orderId	order id
price	Price
qty	Quantity
quoteQty	Deal quantity
time	Deal time
commission
commissionAsset
time	trade time
isBuyerMaker
isBestMatch
isSelfTrade	isSelfTrade
clientOrderId	clientOrderId

Wallet Endpoints

Query the currency information

Request

Get /api/v3/capital/config/getall

Response

[
  {
    "coin": "BTC",
    "name": "Bitcoin",
    "networkList": [
      {
          "coin": "BTC",
          "depositDesc": null,
          "depositEnable": true,
          "minConfirm": 0,
          "name": "BTC-TRX",
          "network": "TRC20",
          "withdrawEnable": false,
          "withdrawFee": "0.000100000000000000",
          "withdrawIntegerMultiple": null,
          "withdrawMax": "40.000000000000000000",
          "withdrawMin": "0.001000000000000000",
          "sameAddress": false,
          "contract": "TN3W4H6rK2ce4vX9YnFQHwKENnHjoxb3m9"
      },
      {
          "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"
      }
    ]
  },
]

GET /api/v3/capital/config/getall

Query currency details and the smart contract address

Parameters:

None

Response:

name	Description
depositEnable	depositEnable
network	withdraw network
withdrawEnable	withdrawEnable
withdrawFee	withdrawFee
withdrawMax	Max withdraw amount
withdrawMin	Min withdraw amount
contract	coin contract

Withdraw

Request

post /api/v3/capital/withdraw/apply?coin=USDT&network=TRC20&address=TPb5qT9ZikopzCUD4zyieSEfwbjdjUPVb&amount=3&signature={{signature}}&timestamp={{timestamp}}

Response

[
  {
    "id":"7213fea8e94b4a5593d507237e5a555b"
  }
]

POST /api/v3/capital/withdraw/apply

Parameters:

name	Type	Mandatory	Description
coin	string	YES	coin
withdrawOrderId	string	NO	withdrawOrderId
network	string	NO	withdraw network
address	string	YES	withdraw address( memo please use : for splicing)
amount	string	YES	withdraw amount
remark	string	NO	remark
timestamp	string	YES	timestamp
signature	string	YES	signature

If network is not sent, will return default network in that currency.
Can get network via endpoints Get /api/v3/capital/config/getall's response params networkList and check whether is default network by response paramsisDefault
Withdraw address only support address which added in withdrawal settings on website. Response:

name	Description
id	withdraw ID

Deposit History(supporting network)

Request

get /api/v3/capital/deposit/hisrec?coin=USDT-BSC&timestamp={{timestamp}}&signature={{signature}}

Response

[
  {
        "amount": "128",
        "coin": "USDT-BSC",
        "network": "BSC",
        "status": 5,
        "address": "0xebe4804f7ecc22d5011c42e6ea1f22e6c891d9b",
        "addressTag": null,
        "txId": "0xd8ff2e4e87ba64454039b62f6fcd456cb8afdbd21352a94b2b115b70212d97d:0",
        "insertTime": 1657952043000,
        "unlockConfirm": "16",
        "confirmTimes": "24"
  }
]

GET /api/v3/capital/deposit/hisrec

Parameters:

name	Type	Mandatory	Description
coin	string	YES	coin
status	string	NO	status
startTime	string	NO	default: 90 days ago from current time
endTime	string	NO	default:current time
limit	string	NO	default:1000,max:1000
timestamp	string	YES	timestamp
signature	string	YES	signature

Ensure that the default timestamp of 'startTime' and 'endTime' does not exceed 90 days.

Response:

name	Description
amount	deposit amount
coin	coin
network	deposit network
status	deposit status,1:SMALL,2:TIME_DELAY,3:LARGE_DELAY, 4:PENDING,5:SUCCESS,6:AUDITING,7:REJECTED
address	deposit adress
addressTag	addressTag
txId	txId
insertTime	insertTime
unlockConfirm	unlockConfirm
confirmTimes	confirmTimes

Withdraw History (supporting network)

Request

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

Response

[
  {
        "id": "17bc9f68c3b740c5947c074748d42c3",
        "txId": "0xaa61d7a5b51580ec4e4e56b3f49e4c8f2f9d0665995f0652dfeeb5007f8fbf9",
        "coin": "USDT-BSC",
        "network": "BSC",
        "address": "0x2c7471e7F4A841b591460F431D9A3B1DEF6E5EC",
        "amount": "1501",
        "transferType": 0,
        "status": 7,
        "transactionFee": "1",
        "confirmNo": null,
        "applyTime": 1658625828000,
        "remark": ""
  }
]

GET /api/v3/capital/withdraw/history

Parameters:

name	Type	Mandatory	Description
coin	string	YES	coin
status	string	NO	withdraw status
limit	string	NO	default:1000, max:1000
startTime	string	NO	default: 90 days ago from current time
endTime	string	NO	default:current time
timestamp	string	YES	timestamp
signature	string	YES	signature

Supported multiple network coins' withdraw history may not return the 'network' field.
Ensure that the default timestamp of 'startTime' and 'endTime' does not exceed 90 days.

Response:

name	Description
address	withdraw address
amount	withdraw amount
applyTime	apply time
coin	coin
id	withdraw id
withdrawOrderId	withdrawOrderId
network	withdraw network
transferType	transferType, 0: outside transfer，1: inside transfer
status	withdraw status,1:APPLY,2:AUDITING,3:WAIT,4:PROCESSING,5:WAIT_PACKAGING, 6:WAIT_CONFIRM,7:SUCCESS,8:FAILED,9:CANCEL,10:MANUAL
transactionFee	transactionFee
confirmNo	confirmNo
txId	txId
remark	remark

Deposit Address (supporting network)

Request

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

Response

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

GET /api/v3/capital/deposit/address

Parameters:

name	Type	Mandatory	Description
coin	string	YES	coin
network	string	NO	deposit network
timestamp	string	YES	timestamp
signature	string	YES	signature

Response:

name	Description
address	deposit address
coin	coin
tag	tag
network	network

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

Parameters:

name	Type	Mandatory	Description
fromAccountType	string	YES	fromAccountType:"SPOT","FUTURES", "ISOLATED_MARGIN""FIAT"
toAccountType	string	YES	toAccountType:"SPOT","FUTURES", "ISOLATED_MARGIN""FIAT"
asset	string	YES	asset
amount	string	YES	amount
symbol	string	NO	symbol,needed when`fromAccountType`is ISOLATED_MARGIN.eg:ETHUSDT
timestamp	string	YES	timestamp
signature	string	YES	signature

When type isISOLATEDMARGIN, fromSymbol and toSymbol must be sent.

Response:

name	Description
tranId	tranId

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

Parameters:

name	Type	Mandatory	Description
fromAccountType	string	YES	fromAccountType:"SPOT","FUTURES", "ISOLATED_MARGIN""FIAT"
toAccountType	string	YES	toAccountType:"SPOT","FUTURES", "ISOLATED_MARGIN""FIAT"
startTime	string	NO	startTime
endTime	string	NO	endTime
page	string	NO	default:1
size	string	NO	default:10, max:100
symbol	string	YES	symbol,needed when`fromAccountType`is ISOLATED_MARGIN.eg:ETHUSDT
timestamp	string	YES	timestamp
signature	string	YES	signature

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

name	Description
total	total
tranId	tranId
clientTranId	client ID
asset	coin
amount	amount
fromAccountType	fromAccountType
toAccountType	toAccountType
symbol	symbol
status	status
timestamp	timestamp

ETF

Get ETF info

Response

{
  "symbol": "OP3SUSDT",
  "netValue": "0.332",
  "feeRate": "0.00001",
  "timestamp": 1661494588543,
  "leverage": -3,
  "realLeverage": 2.9126,
  "mergedTimes": 3,
  "lastMergedTime": 1659063531000,
  "preBasket": 18827.8361,
  "preLeverage": 2.2888,
  "basket": 24678.0916
}

GET api/v3/etf/info

Get information on ETFs, such as symbol, netValue and fund fee.

Parameters:

name	Type	Mandatory	Description
symbol	string	No	ETF symbol

Response:

name	Type	Description
symbol	string	ETF symbol
netValue	string	Net Value
feeRate	string	Fund Fee
timestamp	long
leverage	string	target leverage
realLeverage	string	real leverage
mergedTimes	string	mergedTimes
lastMergedTime	long	lastMergedTime
preBasket	string	Basket Before
preLeverage	string	Leverage Before
basket	string	Basket After

Margin Account and Trading Interface

TradeMode

switch trademode of margin account

request

POST /api/v3/margin/tradeMode?tradeMode=0&symbol=BTCUSDT&timestamp={{timestamp}}&signature={{signature}}

response

[
  {
  "tradeMode": 0,
  "symbol": "BTCUSDT"
  }
]

Http Request

POST /api/v3/margin/tradeMode

Request Parameter

name	Description	Mandatory	Type	Sample
tradeMode	tradeMode	YES	int	0: Normal 1:Auto
symbol	symbol	YES	string	BTCUSDT
timestamp	time	YES	string	1655143087012
signature	signature	YES	string

Response Parameter

name	Description	Type	Sample
tradeMode	tradeMode	int	0
symbol	symbol	string	BTCUSDT

Place Order

request

POST /api/v3/margin/order?symbol=BTCUSDT&side=BUY&type=LIMIT&quantity=0.0003&price=20000&timestamp={{timestamp}}&signature={{signature}}

response

[
  {
  "symbol": "BTCUSDT",
  "orderId": "693471305432961024",
  "clientOrderId": "6gCrw2kRUAF9CvJDGP16IP",
  "isIsolated": true,       
  "transactTime": 1507725176595
  }
]

Http Request

POST /api/v3/margin/order

Request Parameter

name	Description	Mandatory	Type	Sample
symbol	symbol	YES	string	BTCUSDT
isIsolated	is Isolated，"TRUE", "FALSE", Default "TRUE"	NO	string	TRUE
side	BUY SELL	YES	string	BUY
type	API Definitions：order type	YES	string
quantity	quantity	NO	string
quoteOrderQty	order quantity	NO	string
price	price	NO	string
newClientOrderId	newClientOrderId	NO	string
recvWindow		NO	string
timestamp	time	YES	string	timestamp
signature	signature	YES	string	signature

Response Parameter

name	Description	Type	Sample
symbol		string	BTCUSDT
orderId		string	693471305432961024
clientOrderId		string	6gCrw2kRUAF9CvJDGP16IP
isIsolated	is Isolated	boolean	true
transactTime		number	1507725176595

Loan

request

post /api/v3/margin/loan?asset=BTC&amount=0.002&symbol=BTCUSDT&timestamp={{timestamp}}&signature={{signature}}

response

[
  {
    "tranId": 746784754145301480
  }
]

Http Request

POST /api/v3/margin/loan

Request Parameter

name	Description	Mandatory	Type	Sample
asset	asset	YES	string	BTC
isIsolated	is Isolated，"TRUE", Default "TRUE"	NO	string
symbol	symbol	YES	string
amount	amount	YES	string
recvWindow		NO	string
timestamp	time	YES	string	timestamp
signature	signature	YES	string	signature

Response Parameter

name	Description	Type	Sample
tranId	transfer id	number	746784754145301480

Description：

If isIsolated = "TRUE", means isolated mode,symbol must be filled in.

Repayment

request

post /api/v3/margin/repay?asset=BTC&symbol=BTCUSDT&isAllRepay=true&borrowId=746784754145300480&timestamp={{timestamp}}&signature={{signature}}

response

[
  {
    "tranId": 2597392
  }
]

Http Request

POST /api/v3/margin/repay

Request Parameter

name	Description	Mandatory	Type	Sample
asset	asset/btc	YES	string
isIsolated	is Isolated，"TRUE", Default "TRUE"	NO	string
symbol	symbol	YES	string
amount	amount or isAllRepay	NO	string
borrowId	loan order id	YES	string
isAllRepay	all repay or portion repay	NO	string
recvWindow		YES	string
timestamp		YES	string	timestamp
signature		YES	string	signature

Response Parameter

name	Description	Type	Sample
tranId	repay id	number	2597392

Description：

If isIsolated = "TRUE", means isolated mode,symbol must be filled in.

Cancel all Open Orders on a Symbol

request

delete /api/v3/margin/openOrders?symbol=BTCUSDT&timestamp={{timestamp}}&signature={{signature}}

response

[
  {
       "symbol": "BTCUSDT",
       "orderId": "746779360689786880",
       "orderListId": "-1",
       "clientOrderId": null,
       "price": "20000",
       "origQty": "0.0003",
       "executedQty": "0",
       "cummulativeQuoteQty": "0",
       "status": "NEW",
       "type": "LIMIT",
       "side": "BUY",
       "isIsolated": true,
       "isWorking": true,
       "time": 1658212540000,
       "updateTime": 1658212540000
  }
]

Http Request

DELETE /api/v3/margin/openOrders

Request Parameter

name	Description	Mandatory	Type	Sample
symbol		YES	string
isIsolated	is Isolated，"TRUE", Default "TRUE"	NO	string
recvWindow	less than `60000`	NO	string
timestamp		YES	string	timestamp
signature		YES	string	signature

Response Parameter

name	Description	Type	Sample
symbol		string	BTCUSDT
isIsolated	is isolated symbol	boolean	true
clientOrderId		string	pXLV6Hz6mprAcVYpVMTGgx
price		string	0.089853
origQty		string	0.178622
executedQty		string	0.000000
cummulativeQuoteQty		string	0.000000
status		string	CANCELED
type		string	LIMIT
side		string	BUY
orderId		string
orderListId	-1	string

Cancel Order

request

delete /api/v3/margin/order?symbol=BTCUSDT&orderId=746777776866070528&timestamp={{timestamp}}&signature={{signature}}

response

[
  {
     "symbol": "BTCUSDT",
     "orderId": "746777776866070528",
     "orderListId": "-1",
     "clientOrderId": null,
     "price": "20000",
     "origQty": "0.0003",
     "executedQty": "0",
     "cummulativeQuoteQty": "0",
     "status": "NEW",
     "type": "LIMIT",
     "side": "BUY",
     "isIsolated": true,
     "isWorking": true,
     "time": 1658212162000,
     "updateTime": 1658212162000     
  }
]

Http Request

DELETE /api/v3/margin/order

Request Parameter

name	Description	Mandatory	Type	Sample
symbol		YES	string
isIsolated	is Isolated，"TRUE", "FALSE", Default "FALSE"	NO	string
orderId		YES	string
origClientOrderId	origClientOrderId	NO	string
recvWindow		NO	string
timestamp		YES	string	timestamp
signature		YES	string	signature

Response Parameter

name	Description	Type	Sample
symbol		string	LTCBTC
orderId		string	693471305432961024
clientOrderId		string	cancelMyOrder1
price		string	1.00000000
origQty		string	10.00000000
executedQty		string	8.00000000
cummulativeQuoteQty	cummulativeQuoteQty	string	8.00000000
status		string	CANCELED
type		string	LIMIT
side		string	SELL
isIsolated	is isolated symbol	boolean	true

Description：

must send any one of orderId or origClientOrderId .

Query Loan List

request

get /api/v3/margin/loan?asset=BTC&symbol=BTCUSDT&timestamp={{timestamp}}&signature={{signature}}

response

[
  {
     "symbol": "BTCUSDT",
     "tranId": "746784754145300480",
     "asset": "BTC",
     "principal": "0.002",
     "remainAmount": "0",
     "remainInterest": "0",
     "repayAmount": "0.002",
     "repayInterest": "0.00000001",
     "status": "REPAID",
     "timestamp": 1658213826000
  }
]

Http Request

GET /api/v3/margin/loan

Request Parameter

name	Description	Mandatory	Type	Sample
asset	asset	YES	string	BTC
symbol	symbol	YES	string
tranId	tranId	NO	string
startTime		NO	string
endTime		NO	string
current	current page. Default:1	NO	string
size	Default:10 max:100	NO	string
recvWindow		NO	string
timestamp		YES	string	timestamp
signature		YES	string	signature

Response Parameter

name	Description	Type	Sample
symbol	symbol	string	MXUSDT
tranId		number	12807067523
asset		string	MX
principal	principal	string	0.84624403
timestamp	time	number	1555056425000
remainAmount	remainAmount	string
remainInterest	remainInterest	string
repayAmount	repayAmount	string	300
repayInterest	repayInterest	string	1.96249686
status	status: PENDING , CONFIRMED, FAILED;	string	CONFIRMED
total		number	1

Description：

TranId or startTime must be sent, tranId takes precedence. Responses are returned in descending order. If you send isolatedSymbol, return the credit record for the specified store-by-store symbol specified asset.

All Order

request

get /api/v3/margin/allOrders?symbol=BTCUSDT&timestamp={{timestamp}}&signature={{signature}}

response

[
  {
       "symbol": "BTCUSDT",
       "orderId": "746779360689786880",
       "orderListId": "-1",
       "clientOrderId": null,
       "price": "20000",
       "origQty": "0.0003",
       "executedQty": "0",
       "cummulativeQuoteQty": "0",
       "status": "CANCELED",
       "type": "LIMIT",
       "side": "BUY",
       "isIsolated": true,
       "isWorking": true,
       "time": 1658212540000,
       "updateTime": 1658212551000
  }
]

Http Request

GET /api/v3/margin/allOrders

Request Parameter

name	Description	Mandatory	Type	Sample
symbol		YES	string
isIsolated	is Isolated，"TRUE", "FALSE",Default "TRUE"	NO	string
orderId		NO	string
startTime		NO	string
endTime		NO	string
limit	Default 500;max 500.	NO	string
timestamp		YES	string	timestamp
signature		YES	string	signature

Response Parameter

name	Description	Type	Sample
clientOrderId		string	D2KDy4DIeS56PvkM13f8cP
cummulativeQuoteQty		string	0.00000000
executedQty		string	0.00000000
isWorking		boolean	false
orderId		number	41295
origQty		string	5.31000000
price		string	0.22500000
side		string	SELL
status		string	CANCELED
symbol		string	MXBTC
isIsolated	is isolated symbol	boolean	false
time		number	1565769338806
type		string	TAKE_PROFIT_LIMIT
updateTime		number	1565769342148

Description：

If orderId is set, get the order >= orderId, NO returns the recent order history. Some historical orders of cummulativeQuoteQty < 0: YES Indicates that the current data does not exist.

Account Trade List

request

get /api/v3/margin/myTrades?symbol=BTCUSDT&timestamp={{timestamp}}&signature={{signature}}

response

[

]

Http Request

GET /api/v3/margin/myTrades

Request Parameter

name	Description	Mandatory	Type	Sample
symbol		YES	string
isIsolated	is Isolated，"TRUE", "FALSE",Default "TRUE"	NO	string
startTime		NO	string
endTime		NO	string
fromId	TradeId	NO	string
limit	Default 500; max 1000.	NO	string
timestamp		YES	string	timestamp
signature		YES	string	signature

Response Parameter

name	Description	Type	Sample
commission	commission	string	0.00006000
commissionAsset	commissionAsset	string	BTC
id	trade-id	number	34
isBuyer		boolean	false
orderId		number	39324
price		string	0.02000000
qty		string	3.00000000
symbol		string	MXBTC
isIsolated	is isolated symbol	boolean	false
time		number	1561973357171

Description：

If fromId is set, get the order ID > = fromId, NO Returns the recent order history.

Current Open Orders

request

get /api/v3/margin/openOrders?symbol=BTCUSDT&timestamp={{timestamp}}&signature={{signature}}

response

[
  {
    "rows": [
      {
          "isolatedSymbol": "MXUSDT", 
          "id": "12807067523",
          "asset": "MX",
          "timestamp": 1555056425000,
          "amount": "315.53307675",
          "dealAmount": "319.26088158",
          "dealQuantity": "23768.97",
          "fee": "0",
          "feeCurrency": "USDT",
          "orderType": "STOP_OUT",
          "price": "0.013275",
          "quantity": "23768.97",
                "remainQuantity": "0",
          "remainAmount": "300",
                "side": "SELL",
                "status": "FILLED"
      }
    ],
    "total": 1
  }
]

Http Request

GET /api/v3/margin/openOrders

Request Parameter

name	Description	Mandatory	Type	Sample
symbol	symbol	YES	string
isIsolated	is Isolated，"TRUE", "FALSE",Default "TRUE"	NO	string
timestamp		YES	string	timestamp
signature		YES	string	signature

Response Parameter

name	Description	Type	Sample
clientOrderId		string	qhcZw71gAkCCTv0t0k8LUK
cummulativeQuoteQty	cummulativeQuoteQty	string	0.00000000
executedQty		string	0.00000000
isWorking		boolean	true
orderId		number	211842552
origQty		string	0.30000000
price		string	0.00475010
side		string	SELL
status		string	NEW
symbol		string	MXBTC
isIsolated	is isolated symbol	boolean	true
time		number	1562040170089
timeInForce		string	GTC
type		string	LIMIT
updateTime		number	1562040170089

Account Max Transferable

request

get /api/v3/margin/maxTransferable?asset=BTC&symbol=BTCUSDT&timestamp={{timestamp}}&signature={{signature}}

response

[
  {
     "amount": "0.00022998"
  } 
]

Http Request

GET /api/v3/margin/maxTransferable

Request Parameter

name	Description	Mandatory	Type	Sample
asset		YES	string
symbol	symbol	YES	string
timestamp		YES	string	timestamp
signature		YES	string	signature

Response Parameter

name	Description	Type	Sample
amount		string	0.00022998

Margin PriceIndex

request

get /api/v3/margin/priceIndex?symbol=BTCUSDT&timestamp={{timestamp}}&signature={{signature}}

response

[
  {
     "price": "21823.45",
     "symbol": "BTCUSDT",
     "calcTime": 1658215048128
  }
]

Http Request

GET /api/v3/margin/priceIndex

Request Parameter

name	Mandatory	Type	Sample
symbol	YES	string
timestamp	YES	string	timestamp
signature	YES	string	signature

Response Parameter

name	Type	Sample
calcTime	number	1562046418000
price	string	0.00333930
symbol	string	MXBTC

Query Order

request

get /api/v3/margin/order?symbol=BTCUSDT&orderId=746779360689786880&timestamp={{timestamp}}&signature={{signature}}

response

[
  {
     "symbol": "BTCUSDT",
     "orderId": "746779360689786880",
     "orderListId": "-1",
     "clientOrderId": null,
     "price": "20000",
     "origQty": "0.0003",
     "executedQty": "0",
     "cummulativeQuoteQty": "0",
     "status": "CANCELED",
     "type": "LIMIT",
     "side": "BUY",
     "isIsolated": true,
     "isWorking": true,
     "time": 1658212540000,
     "updateTime": 1658212551000
  }
]

Http Request

GET /api/v3/margin/order

Request Parameter

name	Description	Mandatory	Type	Sample
symbol		YES	string
isIsolated	is Isolated，"TRUE", "FALSE",Default "TRUE"	NO	string
orderId		NO	string
timestamp		YES	string	timestamp
signature		YES	string	signature

Response Parameter

name	Description	Type	Sample
clientOrderId		string	ZwfQzuDIGpceVhKW5DvCmO
cummulativeQuoteQty	cummulativeQuoteQty	string	0.00000000
executedQty	amount	string	0.00000000
isWorking		boolean	true
orderId		number	213205622
origQty	orign amount	string	0.30000000
price		string	0.00493630
side		string	SELL
status		string	NEW
symbol		string	MXBTC
isIsolated	is isolated symbol	boolean	true
time		number	1562133008725
type		string	LIMIT
updateTime		number	1562133008725

Description：

You must send either orderId or origClientOrderId. Some historical orders of cummulativeQuoteQty < 0: YES Indicates that the current data does not exist.

Isolated Account

request

get /api/v3/margin/isolated/account?symbols=BTCUSDT&timestamp={{timestamp}}&signature={{signature}}

response

[
  {
   "assets":[
      {
        "baseAsset": {
          "asset": "BTC",
          "borrowEnabled": true,
          "borrowed": "0",
          "free": "0.00022998",
          "interest": "0",
          "locked": "0",
          "netAsset": "0.00022998",
          "netAssetOfBtc": "0.00022998",
          "repayEnabled": true,
          "totalAsset": "0.00022998"
        },
        "quoteAsset": {
          "asset": "USDT",
          "borrowEnabled": true,
          "borrowed": "0",
          "free": "10",
          "interest": "0",
          "locked": "0",
          "netAsset": "10",
          "netAssetOfBtc": "0.000458278339932541",
          "repayEnabled": true,
          "totalAsset": "10"
        },
        "symbol": "BTCUSDT",
        "isolatedCreated": true,
        "enabled": true,
        "marginLevel": "1.00006882",
        "marginRatio": "9",
        "indexPrice": "21804.199655172413793103",
        "liquidatePrice": "--",
        "liquidateRate": "--",
        "tradeEnabled": true
      }
   ]
  }
]

Http Request

GET /api/v3/margin/isolated/account

Request Parameter

name	Description	Mandatory	Type	Sample
symbols	max 5 symbols; String delimited by ",".	YES	string	"BTCUSDT,MXUSDT,ADAUSDT"
timestamp		YES	string	timestamp
signature		YES	string	signature

Response Parameter

name	Description	Type	Sample
asset		string	BTC
borrowEnabled		boolean	true
borrowed		string	0.00000000
free		string	0.00000000
interest		string	0.00000000
locked		string	0.00000000
netAsset		string	0.00000000
netAssetOfBtc		string	0.00000000
repayEnabled		boolean	true
totalAsset		string	0.00000000
isolatedCreated		boolean	true
enabled	enabled	boolean	true
marginLevel		string	0.00000000
marginRatio		string	0.00000000
indexPrice		string	10000.00000000
liquidatePrice		string	1000.00000000
liquidateRate		string	1.00000000
tradeEnabled		boolean	true

MaxBorrowable

request

get /api/v3/margin/maxBorrowable?asset=BTC&symbol=BTCUSDT&timestamp={{timestamp}}&signature={{signature}}

response

[
  {
     "amount": "0.00618914",
     "borrowLimit": "30"
  }
]

Http Request

GET /api/v3/margin/maxBorrowable

Request Parameter

name	Description	Mandatory	Type	Sample
asset		YES	string
symbol	symbol	YES	string
timestamp		YES	string	timestamp
signature		YES	string	signature

Response Parameter

name	Description	Type	Sample
amount	max borrowable amount	string	1.69248805
borrowLimit	borrowLimit	string	60

Repay

Description

request

get /api/v3/margin/repay?asset=BTC&symbol=BTCUSDT&tranId=2597392&timestamp={{timestamp}}&signature={{signature}}

response

[

]

Http Request

GET /api/v3/margin/repay

Request Parameter

name	Description	Mandatory	Type	Sample
asset		YES	string
symbol	symbol	YES	string
tranId	transfer id	YES	string
startTime		NO	string
endTime		NO	string
current	current page Default:1	NO	string
size	Default:10 max:100	NO	string
recvWindow		NO	string
timestamp		YES	string	timestamp
signature		YES	string	signature

Response Parameter

name	Description	Type	Sample
symbol	symbol	string	MXUSDT
amount	amount	string	14.00000000
asset		string	MX
interest	interest	string	0.01866667
principal	principal	string	13.98133333
timestamp		number	1563438204000
tranId		number	2970933056
total		number	1

Description：

TranId or startTime must be sent, tranId takes precedence. Responses are returned in descending order. If a symbol is sent, returns the repayment record for the specified symbol specified asset on a store-by-store basis.

Isolated Symbol

request

get /api/v3/margin/isolated/pair?symbol=BTCUSDT&timestamp={{timestamp}}&signature={{signature}}

response

[
  {
   "symbol":"BTCUSDT",
   "base":"BTC",
   "quote":"USDT",
   "isMarginTrade":true
  }
]

Http Request

GET /api/v3/margin/isolated/pair

Request Parameter

name	Mandatory	Type	Sample
symbol	YES	string
timestamp	YES	string	timestamp
signature	YES	string	signature

Response Parameter

name	Description	Type	Sample
symbol		string	BTCUSDT
base		string	BTC
quote		string	USDT
isMarginTrade	isMarginTrade	boolean	true

Force Liquidation Record

request

get /api/v3/margin/forceLiquidationRec?symbol=BTCUSDT&timestamp={{timestamp}}&signature={{signature}}

response

[

]

Http Request

GET /api/v3/margin/forceLiquidationRec

Request Parameter

name	Description	Mandatory	Type	Sample
startTime		NO	string
endTime		NO	string
symbol		YES	string
current	current page Default:1	NO	string
size	Default:10 max:100	NO	string
timestamp		YES	string	timestamp
signature		YES	string	signature

Response Parameter

name	Description	Type	Sample
avgPrice		string	0.00388359
executedQty		string	31.39000000
orderId	order id	string	180015097
price	price	string	0.00388110
qty		string	31.39000000
side		string	SELL
symbol		string	MXBTC
isIsolated	is isolated	boolean	true
updatedTime		number	1558941374745
total		number	1

Description：

Responses are returned in descending order.

Isolated MarginData

request

get /api/v3/margin/isolatedMarginData?symbol=BTCUSDT&timestamp={{timestamp}}&signature={{signature}}

response

[
  [
    {
        "symbol": "BTCUSDT",
        "leverage": "10",
        "data": [
            {
                "coin": "BTC",
                "hourInterest": "0.00026125",
                "borrowLimit": "270"
            },
            {
                "coin": "USDT",
                "hourInterest": "0.000475",
                "borrowLimit": "2100000"
            }
        ]
    }
] 

]

Http Request

GET /api/v3/margin/isolatedMarginData

Request Parameter

name	Mandatory	Type	Sample
symbol	YES	string
timestamp	YES	string	timestamp
signature	YES	string	signature

Response Parameter

name	Description	Type	Sample
symbol		string	BTCUSDT
leverage		string	10
coin		string	BTC
hourInterest	hourInterest	string	0.00026125
borrowLimit	borrowLimit	string	270

Isolated MarginTier

request

get /api/v3/margin/isolatedMarginTier?symbol=BTCUSDT&timestamp={{timestamp}}&signature={{signature}}

response

[
  [
    {
        "symbol": "BTCUSDT",
        "tier": 1,
        "effectiveMultiple": "10",
        "initialRiskRatio": "1.111",
        "liquidationRiskRatio": "1.05",
        "baseAssetMaxBorrowable": "9",
        "quoteAssetMaxBorrowable": "70000"
    }
  ]
]

Http Request

GET /api/v3/margin/isolatedMarginTier

Request Parameter

name	Mandatory	Type	Sample
symbol	YES	string
tier	NO	string
timestamp	YES	string	timestamp
signature	YES	string	signature

Response Parameter

name	Description	Type	Sample
symbol		string	BTCUSDT
tier	tier	number	1
effectiveMultiple	effectiveMultiple	string	10
initialRiskRatio	initialRiskRatio	string	1.111
liquidationRiskRatio	liquidationRiskRatio	string	1.05
baseAssetMaxBorrowable	baseAssetMaxBorrowable	string	9
quoteAssetMaxBorrowable	quoteAssetMaxBorrowable	string	70000

Websocket Market Streams

The base endpoint is: wss://wbs.mexc.com/ws
A single connection to wbs.mexc.com is only valid for 24 hours; expect to be disconnected at the 24 hour mark
All symbols are Uppercase
eg:spot@public.deals.v3.api@<symbol>
->spot@public.deals.v3.api@BTCUSDT
If there is no valid websocket subscription, the server will disconnect in 30 seconds. If the subscription is successful but there is no streams, the server will disconnect in 1 minute. The client can send PING to maintain the connection.

Live Subscribing/Unsubscribing to streams

The following data can be sent through the websocket instance in order to subscribe/unsubscribe from streams. Examples can be seen below.
The id used in the JSON payloads is an unsigned INT used as an identifier to uniquely identify the messages going back and forth.
In the response, if the msg received is same as request params, this means the request sent was a success.

Subscribe Response

 {
  "id":0,
  "code":0,
  "msg":"spot@public.deals.v3.api@BTCUSDT"
 }

Request

{ "method":"SUBSCRIPTION", "params":["spot@public.deals.v3.api@BTCUSDT"] }

Unsubscribe to a stream

Unsubscribe Response

 {
  "id":0,
  "code":0,
  "msg":"spot@public.increase.depth.v3.api@BTCUSDT,spot@public.deals.v3.api@BTCUSDT"
 }

Request

{ "method":"UNSUBSCRIPTION", "params":["spot@public.deals.v3.api@BTCUSDT","spot@public.increase.depth.v3.api@BTCUSDT"] }

PING/PONG

PING/PONG Response

 {
  "id":0,
  "code":0,
  "msg":"PONG"
 }

Request

{"method":"PING"}

Trade Streams

request:

{
    "method": "SUBSCRIPTION",
    "params": [
        "spot@public.deals.v3.api@BTCUSDT"
    ]
}

response:

{
    "c":"spot@public.deals.v3.api@BTCUSDT",    
    "d":{
            "deals":[{
                    "S":2,                             //tradeType
                    "p":"20233.84",                    //price
                    "t":1661927587825,                         //dealTime
                    "v":"0.001028"}],                            //quantity
            "e":"spot@public.deals.v3.api"},        //eventType                  
    "s":"BTCUSDT",                                             //symbol
    "t":1661927587836                          //eventTime
}

Request： spot@public.deals.v3.api@<symbol>

The Trade Streams push raw trade information; each trade has a unique buyer and seller.

Response:

name	Type	Description
deals	array	dealsInfo
> S	int	tradeType 1:buy 2:sell
> p	string	price
> t	long	dealTime
> v	string	quantity
e	string	eventType
s	string	symbol
t	long	eventTime

Kline Streams

request:

{
    "method": "SUBSCRIPTION",
    "params": [
        "spot@public.kline.v3.api@BTCUSDT@Min15"
    ]
}

response:

{
    "c":"spot@public.kline.v3.api@BTCUSDT@Min15",  
    "d":{
            "k":{
                "T":1661931900,                     
                "a":29043.48804658,  
                "c":20279.43,                
                "h":20284.93,                
                "i":"Min15",                 
                "l":20277.52,                
                "o":20284.93,                
                "s":"BTCUSDT",           
                "t":1661931000,          
                "v":1.43211},                
            "e":"spot@public.kline.v3.api"},                    
    "s":"BTCUSDT",                      
    "t":1661931016878                    
}

The Kline/Candlestick Stream push updates to the current klines/candlestick every second.

Request： spot@public.kline.v3.api@<symbol>@<interval>

Response:

name	Type	Description
k	object	klineInfo
> T	long	endTime
> a	bigDecimal	volume
> c	bigDecimal	closingPrice
> h	bigDecimal	highestPrice
> i	interval	interval
> l	bigDecimal	lowestPrice
> o	bigDecimal	openingPrice
> t	long	stratTime
> v	bigDecimal	quantity
s	string	symbol
t	long	eventTime

Kline chart intervals:

Min -> minutes; Hour -> hours; Day -> days; Week -> weeks, M -> months

Min1
Min5
Min15
Min30
Min60
Hour4
Hour8
Day1
Week1
Month1

Diff.Depth Stream

request:

{
    "method": "SUBSCRIPTION",
    "params": [
        "spot@public.increase.depth.v3.api@BTCUSDT"
    ]
}

response:


{
    "c":"spot@public.increase.depth.v3.api@BTCUSDT",  
    "d":{
        "asks":[{                                   
            "p":"20290.89",     
            "v":"0.000000"}], 
        "e":"spot@public.increase.depth.v3.api", },  
    "s":"BTCUSDT",                      
    "t":1661932660144                   
}

If the quantity is 0, it means that the order of the price has been cancel or traded，remove the price level.

Request: spot@public.increase.depth.v3.api@<symbol>

Response:

name	Type	Description
p	string	price
v	string	quantity
e	string	eventType
s	string	symbol
t	long	eventTime

Websocket User Data Streams

The base API endpoint is: https://api.mexc.com
A User Data Stream listenKey is valid for 60 minutes after creation.
Doing a PUT on a listenKey will extend its validity for 60 minutes.
Doing a DELETE on a listenKey will close the stream and invalidate the listenKey.
Doing a POST on an account with an active listenKey will return the currently active listenKey and extend its validity for 60 minutes.
websocket baseurl: wss://wbs.mexc.me/ws
User Data Streams are accessed at /ws?listenKey=listenKey
eg:wss://wbs.mexc.me/ws?listenKey=pqia91ma19a5s61cv6a81va65sd099v8a65a1a5s61cv6a81va65sdf19v8a65a1
A single connection is only valid for 24 hours; expect to be disconnected at the 24 hour mark

Listen Key(SPOT)

Create a ListenKey

Response

{
  "listenKey": "pqia91ma19a5s61cv6a81va65sdf19v8a65a1a5s61cv6a81va65sdf19v8a65a1"
}

HTTP

POST /api/v3/userDataStream

Start a new user data stream. The stream will close after 60 minutes unless a keepalive is sent. If the account has an active listenKey, that listenKey will be returned and its validity will be extended for 60 minutes.

request:

NONE

Keep-alive a ListenKey

Response

{
    "listenKey": "pqia91ma19a5s61cv6a81va65sdf19v8a65a1a5s61cv6a81va65sdf19v8a65a1"
}

HTTP

PUT /api/v3/userDataStream

Keepalive a user data stream to prevent a time out. User data streams will close after 60 minutes. It's recommended to send a ping about every 30 minutes.

Request:

name	Type	Mandatory	Description
listenKey	STRING	YES

### Close a ListenKey

Response

 {
     "listenKey": "pqia91ma19a5s61cv6a81va65sdf19v8a65a1a5s61cv6a81va65sdf19v8a65a1"
 }

HTTP

DELETE /api/v3/userDataStream

Close out a user data stream.

Account Deals

request:

{
    "method": "SUBSCRIPTION",
    "params": [
        "spot@private.deals.v3.api"
    ]
}

response:

{
    "c": "spot@private.deals.v3.api",
    "d": {
        "S": 1,
        "T": 1661938980268,
        "c": "",
        "i": "c079b0fcb80a46e8b128b281ce4e4f38",
        "m": 1,
        "p": "1.008",
        "st": 0,
        "t": "4079b1522a0b40e7919f609e1ea38d44",
        "v": "5"
    },
    "s": "MXUSDT",
    "t": 1661938980285
}

Request： spot@private.deals.v3.api

Response:

name	Type	Description
d	json	dealsInfo
> S	int	tradetype 1:buy 2:sell
> T	long	tradeTime
> c	string	clientOrderId
> i	string	orderId
> m	int	isMaker
> p	string	price
> st	byte	isSelfTrade
> t	string	tradeId
> v	string	quantity
s	string	symbol
t	long	eventTime

Account Orders

request:

{
  "method": "SUBSCRIPTION",
  "params": [
      "spot@private.orders.v3.api"
  ]
}

Request： spot@private.orders.v3.api

a.Limit/Market Orders

response:

{
  "c": "spot@private.orders.v3.api",
  "d": {
        "A":8.0,
        "O":1661938138000,
        "S":1,
        "V":10,
        "a":8,
        "c":"",
        "i":"e03a5c7441e44ed899466a7140b71391",
        "m":0,
        "o":1,
        "p":0.8,
        "s":1,
        "v":10
  },
  "s": "MXUSDT",
  "t": 1661938138193
}

Response:

name	Type	Description
d	json	orderInfo
> A	bigDecimal	remainAmount
> O	long	createTime
> S	int	tradetype 1:buy 2:sell
> V	bigDecimal	remainQuantity
> a	bigDecimal	amount
> c	string	clientOrderId
> i	string	orderId
> m	int	isMaker
> o	int	LIMIT_ORDER(1),POST_ONLY(2),IMMEDIATE_OR_CANCEL(3), FILL_OR_KILL(4),MARKET_ORDER(5);STOP_LIMIT(100)
> p	bigDecimal	PRICE
> s	int	status 1:New order 2:Filled 3:Partially filled 4:Order canceled 5:Order filled partially, and then the rest of the order is canceled
> v	bigDecimal	quantity
t	long	eventTime
s	string	symbol

b.Stop Limit Order

response:

{
  "c": "spot@private.orders.v3.api",
  "d": {
        "N":"USDT",
        "O":1661938853715,
        "P":0.9,
        "S":1,
        "T":"LE",
        "i":"f6d82e5f41d745f59fe9d3cafffd80b5",
        "o":100,
        "p":1.01,
        "s":"NEW",
        "v":6
  },
  "s": "MXUSDT",
  "t": 1661938853727
}

Response:

name	Type	Description
d	json	orderInfo
> N	string	commissionAsset
> O	long	createTime
> P	bigDecimal	triggerPrice
> S	int	tradetype 1:buy 2:sell
> T	int	0: GE(price is higher than triggerPrice) 1: LE(price is lower than triggerPrice)
> i	string	orderId
> o	int	orderType LIMIT_ORDER(1),POST_ONLY(2),IMMEDIATE_OR_CANCEL(3), FILL_OR_KILL(4),MARKET_ORDER(5);STOP_LIMIT(100)
> p	bigDecimal	price
> s	string	state NEW,CANCELED,EXECUTED,FAILED
> v	bigDecimal	quantity
s	string	symbol
t	long	eventTime

Rebate Endpoints

Get Rebate History Records

request

get /api/v3/rebate/taxQuery?timestamp={{timestamp}}&signature={{signature}}

response

{
    "page": 1,  
    "totalRecords": 1,  
    "totalPageNum": 1,  
    "data": [
        {
            "spot": "0.00082273",  
            "futures":"0.00022487",       
            "total": "0.00012126",  
            "uid": "221827",  
            "account": "154****291@qq.com",  
            "inviteTime": 1637651320000
        },
        ...
        {
            "spot": "0.00082273",  
            "futures":"0.00022487",    
            "total": "0.00012126",  
            "uid": "82937",  
            "account": "338****291@qq.com",  
            "inviteTime": 1637651320000
        }
    ]
}

Http Request

GET /api/v3/rebate/taxQuery

Request

name	Type	Mandatory	Description
startTime	long	NO
endTime	long	NO
page	int	NO	default 1
recvWindow	long	NO
timestamp	long	YES
signature	string	YES

Response

name	Type	Description
spot	string	spot rebate,unit:usdt
futures	string	futures rebate,unit:usdt
total	string	total rebate,unit:usdt
uid	string	Invitee uid
account	string	Invitee account
inviteTime	long	invite time

If startTime and endTime are not sent, the recent 1 year's data will be returned.

Get Rebate Records Detail

request

get /api/v3/rebate/detail?timestamp={{timestamp}}&signature={{signature}}

response

{
     "page": 1, 
     "totalRecords": 1, 
     "totalPageNum": 1, 
     "data": [
         {
             "asset": "USDT", 
             "type": "spot",       
             "rate": "0.3", 
             "amount": "0.0001126", 
             "uid": "2293729101827", 
             "account": "154****291@qq.com", 
             "tradeTime": 1637651320000,
             "updateTime": 1637651320000
         },
         ...
         {
             "asset": "ETH", 
             "type": "margin", 
             "rate": "0.3", 
             "amount": "0.00000056",
             "uid": "22937291018263", 
             "account": "154****291@qq.com", 
             "tradeTime": 1637651320000,
             "updateTime": 1637928379000
         }
     ]
}

Http Request

GET /api/v3/rebate/detail

Request

name	Type	Mandatory	Description
startTime	long	NO
endTime	long	NO
page	int	NO	default 1
recvWindow	long	NO
timestamp	long	YES
signature	string	YES

Response

name	Type	Description
asset	string	rebate asset
type	string	rebate type: spot futures margin
rate	string	rebate rate
amount	string	rebate amount
uid	string	Invitee uid
account	string	Invitee account
tradeTime	long	trade time
updateTime	long	update time

If startTime and endTime are not sent, the recent 1 year's data will be returned.

Get Self Rebate Records Detail

request

get /api/v3/rebate/detail/kickback?timestamp={{timestamp}}&signature={{signature}}

response

{
    "page": 1,  
    "totalRecords": 27,  
    "totalPageNum": 3,  
    "data": [
        {
            "asset": "USDT",  
            "type": "spot",        
            "rate": "0.3", 
            "amount": "0.0001126",  
            "uid": "2293729101827",  
            "account": "154****291@qq.com",  
            "tradeTime": 1637651320000,
            "updateTime": 1637651320000
        },
        ...
        {
            "asset": "ETH", 
            "type": "margin", 
            "rate": "0.3", 
            "amount": "0.00000056",
            "uid": "22937291018263",  
            "account": "154****291@qq.com",  
            "tradeTime": 1637651320000,
            "updateTime": 1637928379000
        }
    ]
}

Http Request

GET /api/v3/rebate/detail/kickback

Request

name	Type	Mandatory	Description
startTime	long	NO
endTime	long	NO
page	int	NO	default 1
recvWindow	long	NO
timestamp	long	YES
signature	string	YES

Response

name	Type	Description
asset	string	rebate asset
type	string	rebate type: spot futures margin
rate	string	rebate rate
amount	string	rebate amount
uid	string	Invitee uid
account	string	Invitee account
tradeTime	long	trade time
updateTime	long	update time

If startTime and endTime are not sent, the recent 1 year's data will be returned.

Public API Definitions

ENUM definitions

Order side

BUY
SELL

Order type

LIMIT (Limit order)
MARKET (Market order)
LIMIT_MAKER (Limit maker order)
IMMEDIATE_OR_CANCEL (Immediate or cancel order)
FILL_OR_KILL (Fill or kill order)

Order State

NEW Uncompleted
FIELLD Filled
PARTIALLY_FILLED Partially filled
CANCELED Canceled
PARTIALLY_CANCELED Partially canceled

Kline Interval

1m 1 minute
5m 5 minute
15m 15 minute
30m 30 minute
60m 60 minute
4h 4 hour
1d 1 day
1M 1 month

Introduction

API Key Setup

API Key Restrictions

API Library

Postman Collections

Contact us

Change Log

2022-09-06

2022-09-02

2022-08-26

2022-08-15

2022-08-03

2022-07-27

2022-07-15

2022-07-08

2022-07-03

2022-06-16

2022-05-22

2022-04-25

2022-03-29

2022-03-25

2022-03-24

2022-03-21

2022-03-18

2022-03-09

2022-02-19

2022-02-11

General Info

Base endpoint

HTTP Return Codes

Header

SIGNED

Timing security

SIGNED Endpoint Examples for POST /api/v3/order

Example 1: As a request body

Limits

Market Data Endpoints

Test Connectivity

Check Server Time

Exchange Information

Order Book

Recent Trades List

Old Trade Lookup

Compressed/Aggregate Trades List

Kline/Candlestick Data

Current Average Price

24hr Ticker Price Change Statistics

Symbol Price Ticker

Symbol Order Book Ticker

Sub-Account Endpoints

Create a Sub-account(For Master Account)

Query Sub-account List (For Master Account)

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

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

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

Universal Transfer (For Master Account)

Query Universal Transfer History (For Master Account)

Enable Futures for Sub-account (For Master Account)

Enable Margin for Sub-account (For Master Account)

Spot Account/Trade

Test New Order

New Order

Batch Orders

Cancel Orde

Cancel all Open Orders on a Symbol

Query Order

Current Open Orders

All Orders

Account Information

Account Trade List

Wallet Endpoints

Query the currency information

Withdraw

Deposit History(supporting network)

Withdraw History (supporting network)

Deposit Address (supporting network)

User Universal Transfer

Query User Universal Transfer History

ETF

Get ETF info