NAV
english
shell

Introduction

API Key Setup

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

Change Log

2022-06-16

2022-03-29

2022-03-25

2022-03-24

2022-03-21

2022-03-18

2022-03-09

2022-02-19

General Info

Base endpoint

The base endpoint is：

HTTP Return Codes

The API accepts requests of type GET, POST or DELETE

Relevant parameters in the header

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

SIGNED

Timing security

The logic is as follows:

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

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

Example 2: As a query string

Example 3: Mixed query string and request body

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 Date Endpoints

Test Connectivity

Response

{}

Test connectivity to the Rest API.

Parameter：

NONE

Check Server Time

Response

{
    "serverTime" : 1645539742000
}

Parameter：

NONE

Exchange Information

Response

{
  "timezone": "UTC",
  "serverTime": 1642403250139,
  "rateLimits": [],
  "exchangeFilters": [],
  "symbols": [{
      "symbol": "ABCDEFGSSSUSDT",
      "status": "DISABLED",
      "baseAsset": "ABCDEFGSSS",
      "baseAssetPrecision": 1,
      "quoteAsset": "USDT",
      "quotePrecision": 1,
      "quoteAssetPrecision": 1,
      "baseCommissionPrecision": 1,
      "quoteCommissionPrecision": 1,
      "orderTypes": ["LIMIT", "MARKET", "LIMIT_MAKER"],
      "icebergAllowed": false,
      "ocoAllowed": false,
      "quoteOrderQtyMarketAllowed": false,
      "isSpotTradingAllowed": true,
      "isMarginTradingAllowed": false,
      "permissions": ["SPOT"],
      "filters": []
  }]
}

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"]
  ]
}

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 Deal time
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
  }
]

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
  }
]

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 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"
  ]
]

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"
}

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",
    "lastQty": "",
    "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",
    "lastQty": "",
    "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",
    "lastQty": "",
    "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
  }
]

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"
  }
]

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"
  }
]

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"
}

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
        }
    ]
}

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
    }

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_ORDER_READ,SPOT_ORDER, ,SPOT_WITHDRAW_READ,SPOT_WITHDRAW,SPOT_TRANSFER_READ,SPOT_TRANSFER,FUTURES_ACCOUNT_READ,FUTURES_ORDER_READ,FUTURES_ORDER
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
        }
        ]
   }

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"
}

Parameters:

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

Spot Account/Trade

Test New Order

Response

{}

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": "1196315350023612316",
    "orderListId": -1
}

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.

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"
}

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"
  }
]

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

Parameters:

name Type Mandatory Description
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

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"
}

Check an order's status.

Parameters:

name Type Mandatory Description
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 all open orders on a symbol. Careful when accessing this with no symbol.

Parameters:

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

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 all account orders; active, cancelled or completed

Parameters:

name Type Mandatory Description
symbol string YES Symbol
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 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 current account information

Parameters:

name Type Mandatory Description
recvWindow long NO
timestamp long YES

Response:

name Description
makerCommission maker fee
takerCommission taker fee
buyerCommission
sellerCommission
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": 28457,
    "orderId": 100234, 
    "orderListId": -1, 
    "price": "4.00000100", 
    "qty": "12.00000000", 
    "quoteQty": "48.000012", 
    "commission": "10.10000000", 
    "commissionAsset": "BNB", 
    "time": 1499865549590, 
    "isBuyer": true, 
    "isMaker": false, 
    "isBestMatch": true
  }
]

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

ETF

Get ETF info

Response

{

"symbol": "BTC3LUSDT", 

"netValue": "0.147", 

"feeRate":" 0.00001", 

"timestamp": `1507725176595`

}

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

Margin Account and Trading Interface

TradeMode

switch trademode of margin account

request

POST /api/v3/margin/tradeMode

response

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

Http Request

Request Parameter

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

Response Parameter

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

Place Order

request

POST /api/v3/margin/order

response

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

Http Request

Request Parameter

name Description Mandatory Type Sample
timestamp time YES [string] {{timestamp}}
signature signature YES [string] {{signature}}
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]

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&resultType=failure

response

[
  {
    "tranId": 100000001
  }
]

Http Request

Request Parameter

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

Response Parameter

name Description Type Sample
tranId transfer id [number] 100000001

Description：

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

Repayment

Description

request

post /api/v3/margin/repay&resultType=failure

response

[
  {
    "tranId": 100000001
  }
]

Http Request

Request Parameter

name Description Mandatory Type Sample
timestamp YES [string] {{timestamp}}
signature YES [string] {{signature}}
asset asset/btc YES [string]
isIsolated is Isolated，"TRUE", Default "TRUE" NO [string]
symbol isolated 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]

Response Parameter

name Description Type Sample
tranId repay id [number] 100000001

Description：

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

Cancel all Open Orders on a Symbol

request

delete /api/v3/1111

response

[
  [
  {
    "symbol": "BTCUSDT",
    "isIsolated": true,      
    "clientOrderId": "pXLV6Hz6mprAcVYpVMTGgx",
    "price": "0.089853",
    "origQty": "0.178622",
    "executedQty": "0.000000",
    "cummulativeQuoteQty": "0.000000",
    "status": "CANCELED",
    "type": "LIMIT",
    "side": "BUY"
  },
  {
    "symbol": "BTCUSDT",
    "isIsolated": false,      
    "orderId": 13,
    "clientOrderId": "pXLV6Hz6mprAcVYpVMTGgx",
    "price": "0.090430",
    "origQty": "0.178622",
    "executedQty": "0.000000",
    "cummulativeQuoteQty": "0.000000",
    "status": "CANCELED",
    "type": "LIMIT",
    "side": "BUY"
  }
  ]
]

Http Request

Request Parameter

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

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

Description

request

delete /api/v3/margin/order&resultType=failure

response

[
  {
  "symbol": "LTCBTC",
  "orderId": "693471305432961024",
  "clientOrderId": "cancelMyOrder1",
  "price": "1.00000000",
  "origQty": "10.00000000",
  "executedQty": "8.00000000",
  "cummulativeQuoteQty": "8.00000000",
  "status": "CANCELED",
  "type": "LIMIT",
  "side": "SELL",
  "isIsolated": true       
  }
]

Http Request

Request Parameter

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

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

Description

request

get /api/v3/margin/loan

response

[

]

Http Request

Request Parameter

name Description Mandatory Type Sample
timestamp YES [string] {{timestamp}}
signature YES [string] {{signature}}
asset asset YES [string] BTC
symbol symbol NO [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 YES [string]

Response Parameter

name Description Type Sample
rows [array]
rows>>symbol symbol [string] MXUSDT
rows>>tranId [number] 12807067523
rows>>asset [string] MX
rows>>principal principal [string] 0.84624403
rows>>timestamp time [number] 1555056425000
rows>>remainAmount remainAmount [string]
rows>>remainInterest remainInterest [string]
rows>>repayAmount repayAmount [string] 300
rows>>repayInterest repayInterest [string] 1.96249686
rows>>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

Description

request

get /api/v3/margin/allOrders

response

[

]

Http Request

Request Parameter

name Description Mandatory Type Sample
timestamp YES [string] {{timestamp}}
signature YES [string] {{signature}}
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]

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

Description

request

get /api/v3/margin/myTrades

response

[

]

Http Request

Request Parameter

name Description Mandatory Type Sample
timestamp YES [string] {{timestamp}}
signature YES [string] {{signature}}
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]

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

Description

request

get /api/v3/margin/openOrders

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

Request Parameter

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

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

response

[

]

Http Request

Request Parameter

name Description Mandatory Type Sample
timestamp YES [string] {{timestamp}}
signature YES [string] {{signature}}
asset YES [string]
symbol symbol YES [string]

Response Parameter

name Description Type Sample
amount [string] 3.59498107

Margin PriceIndex

request

get /api/v3/margin/priceIndex

response

[

]

Http Request

Request Parameter

name Description Mandatory Type Sample
timestamp YES [string] {{timestamp}}
signature YES [string] {{signature}}
symbol YES [string]

Response Parameter

name Description Type Sample
calcTime [number] 1562046418000
price [string] 0.00333930
symbol [string] MXBTC

Query Order

request

get /api/v3/margin/order

response

[

]

Http Request

Request Parameter

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

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

response

[
  {
   "assets":[
      {
        "baseAsset": 
          {
          "asset": "BTC",
          "borrowEnabled": true,
          "borrowed": "0.00000000",
          "free": "0.00000000",
          "interest": "0.00000000",
          "locked": "0.00000000",
          "netAsset": "0.00000000",
          "repayEnabled": true,
          "totalAsset": "0.00000000"
        },
        "quoteAsset": 
        {
          "asset": "USDT",
          "borrowEnabled": true,
          "borrowed": "0.00000000",
          "free": "0.00000000",
          "interest": "0.00000000",
          "locked": "0.00000000",
          "netAsset": "0.00000000",
          "totalAsset": "0.00000000"
        },
        "symbol": "BTCUSDT",
        "enabled": true, 
        "tradeMode": 0, 
        "marginLevel": "0.00000000", 
        "riskRate": "0.00000000",
        "indexPrice": "10000.00000000",
        "liquidatePrice": "1000.00000000",
        "liquidateRate": "1.00000000",
        "tradeEnabled": true,
        "totalUsdtValue": 100
      }
    ]
  }
]
response with symbol:
{
   "assets":[
      {
        "baseAsset": 
          {
          "asset": "BTC",
          "borrowEnabled": true,
          "borrowed": "0.00000000",
          "free": "0.00000000",
          "interest": "0.00000000",
          "locked": "0.00000000",
          "netAsset": "0.00000000",
          "repayEnabled": true,
          "totalAsset": "0.00000000"
        },
        "quoteAsset": 
        {
          "asset": "USDT",
          "borrowEnabled": true,
          "borrowed": "0.00000000",
          "free": "0.00000000",
          "interest": "0.00000000",
          "locked": "0.00000000",
          "netAsset": "0.00000000",
          "repayEnabled": true,
          "totalAsset": "0.00000000"
        },
        "symbol": "BTCUSDT"
        "enabled": true, 
        "tradeMode": 0, 
        "marginLevel": "0.00000000", 
        "riskRate": "0.00000000",
        "indexPrice": "10000.00000000",
        "liquidatePrice": "1000.00000000",
        "liquidateRate": "1.00000000",
        "tradeEnabled": true,
        "totalUsdtValue": 100
      }
    ]
}

Http Request

Request Parameter

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

Response Parameter

name Description Type Sample
assets [array]
assets>>baseAsset [object]
assets>>baseAsset>>asset [string] BTC
assets>>baseAsset>>borrowEnabled [boolean] true
assets>>baseAsset>>borrowed [string] 0.00000000
assets>>baseAsset>>free [string] 0.00000000
assets>>baseAsset>>interest [string] 0.00000000
assets>>baseAsset>>locked [string] 0.00000000
assets>>baseAsset>>netAsset [string] 0.00000000
assets>>baseAsset>>netAssetOfBtc [string] 0.00000000
assets>>baseAsset>>repayEnabled [boolean] true
assets>>baseAsset>>totalAsset [string] 0.00000000
assets>>quoteAsset [object]
assets>>quoteAsset>>asset [string] USDT
assets>>quoteAsset>>borrowEnabled [boolean] true
assets>>quoteAsset>>borrowed [string] 0.00000000
assets>>quoteAsset>>free [string] 0.00000000
assets>>quoteAsset>>interest [string] 0.00000000
assets>>quoteAsset>>locked [string] 0.00000000
assets>>quoteAsset>>netAsset [string] 0.00000000
assets>>quoteAsset>>netAssetOfBtc [string] 0.00000000
assets>>quoteAsset>>repayEnabled [boolean] true
assets>>quoteAsset>>totalAsset [string] 0.00000000
assets>>symbol [string] BTCUSDT
assets>>isolatedCreated [boolean] true
assets>>enabled enabled [boolean] true
assets>>marginLevel [string] 0.00000000
assets>>marginRatio [string] 0.00000000
assets>>indexPrice [string] 10000.00000000
assets>>liquidatePrice [string] 1000.00000000
assets>>liquidateRate [string] 1.00000000
assets>>tradeEnabled [boolean] true

Query TrigerOrder

request

get /api/v3/margin/trigerOrder

response

[

]

Http Request

Request Parameter

name Description Mandatory Type Sample
timestamp YES [string] {{timestamp}}
signature YES [string] {{signature}}

Response Parameter

name Description Type Sample

MaxBorrowable

request

get /api/v3/margin/maxBorrowable

response

[

]

Http Request

Request Parameter

name Description Mandatory Type Sample
timestamp YES [string] {{timestamp}}
signature YES [string] {{signature}}
asset YES [string]
symbol is isolated symbol NO [string]

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

response

[

]

Http Request

Request Parameter

name Description Mandatory Type Sample
timestamp YES [string] {{timestamp}}
signature YES [string] {{signature}}
asset YES [string]
symbol symbol NO [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]

Response Parameter

name Description Type Sample
rows [array]
rows>>symbol symbol [string] MXUSDT
rows>>amount amount [string] 14.00000000
rows>>asset [string] MX
rows>>interest interest [string] 0.01866667
rows>>principal principal [string] 13.98133333
rows>>timestamp [number] 1563438204000
rows>>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

response

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

Http Request

Request Parameter

name Description Mandatory Type Sample
timestamp YES [string] {{timestamp}}
signature YES [string] {{signature}}
symbol YES [string]

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

response

[

]

Http Request

Request Parameter

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

Response Parameter

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

Description：

Responses are returned in descending order.

Isolated MarginData

request

get /api/v3/margin/isolatedMarginData

response

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

]

Http Request

Request Parameter

name Description Mandatory Type Sample
timestamp YES [string] {{timestamp}}
signature YES [string] {{signature}}
symbol NO [string]

Response Parameter

name Description Type Sample
symbol [string] BTCUSDT
leverage [string] 10
data [array]
data>>coin [string] BTC
data>>hourInterest hourInterest [string] 0.00026125
data>>borrowLimit borrowLimit [string] 270

Isolated MarginTier

request

get /api/v3/margin/isolatedMarginTier

response

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

Http Request

Request Parameter

name Description Mandatory Type Sample
timestamp YES [string
signature YES [string] {{signature}}
symbol YES [string]
tier NO [string]

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

Public API Definitions

ENUM definitions

Order side

Order type

Order State

Kline Interval

shell