NAV
english
shell

介绍

API Key 设置

API Key 权限设置

在创建API Key时勾选所需要的权限

API 代码库

我们为开发者提供了Python,DotNET,Java,Javascript,Go五种语言的SDK,提供用户直接通过SDK调用API的方法。目前支持现货所有接口。

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

Demo示例

我们提供了5种语言的demo,用户可以参考,目前支持了现货,推送等示例,后续会持续更新。

https://github.com/mxcdevelop/mexc-api-demo

使用中遇到问题请通过提交问题反馈

Postman Collections

现在你可以通过Postman collection来快速体验、使用API接口。 如果想了解更多如何使用Postman,请访问: Mexc API Postman

联系我们

更新日志

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-06-21

2022-06-16

2022-03-29

2022-03-25

2022-03-24

2022-03-21

2022-03-18

2022-03-09

2022-02-19

2022-02-11

基本信息

接入URL

请选用以下的baseurl进行API请求:

HTTP 返回代码

请求格式

相应API接受GET,POST或DELETE类型的请求

返回格式

所有接口的返回数据均为JSON形式

请求Header中签名相关参数

组成部分 说明
X-MEXC-APIKEY API key中的access key
Content-Type application/json

签名

时间安全

伪代码示例

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

关于交易时效性互联网状况并不完全稳定可靠,因此你的程序本地到MEXC服务器的时延会有抖动。这是我们设置recvWindow的目的所在,如果你从事高频交易,对交易时效性有较高的要求,可以灵活设置recvWindow以达到你的要求。

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'

以下是在linux bash环境下使用 echo openssl 和curl工具实现的一个调用接口下单的示例 apikey、secret仅供示范

Key Value
apiKey mx0aBYs33eIilxBWC5
secretKey 45d0b3c26f2644f19bfb98b07741b2f5
参数 取值
symbol BTCUSDT
side BUY
type LIMIT
quantity 1
price 11
recvWindow 5000
timestamp 1644489390087

示例 1: 所有参数通过 request body 发送

所有参数通过 query string 发送

示例 3: 混合使用 query string 和 request body

请注意,签名与示例3不同。 "LIMIT"和"quantity = 1"之间没有&。

限频规则

对REST API的访问有频率限制,当超出限制时,返回状态429:请求过于频繁

需要携带access key进行访问的接口,以账号作为限速的基本单位;不需要携带access key进行访问的接口,以IP作为限速的基本单位

未说明限速规则的接口默认为20次/秒

行情接口

测试服务器连通性

测试能否联通 Rest API。

请求示例

GET /api/v3/ping

返回示例

{}

HTTP请求 - GET /api/v3/ping

请求参数

NONE

返回参数

NONE

获取服务器时间

获得服务器当前时间戳

请求示例

GET /api/v3/time

返回示例

{
    "serverTime" : 1645539742000
}

HTTP请求

请求参数

NONE

交易规范信息

获取交易规则和交易对信息。

请求示例

GET /api/v3/exchangeInfo?symbol=BTCUSDT

返回示例

{
    "timezone": "CST",
    "serverTime": 1657256965785,
    "rateLimits": [],
    "exchangeFilters": [],
    "symbols": 
{
            "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"
        }
}

HTTP请求

请求参数

三种用法

用法 举例
不需要交易对 curl -X GET "https://api.mexc.com/api/v3/exchangeInfo"
单个交易对 curl -X GET "https://api.mexc.com/api/v3/exchangeInfo?symbol=MXUSDT"
多个交易对 curl -X GET "https://api.mexc.com/api/v3/exchangeInfo?symbols=MXUSDT,BTCUSDT"

返回参数

参数名 数据类型 说明
timezone string 时区
serverTime long 服务器时间
rateLimits Array 频率限制
exchangeFilters Array 过滤器
symbol String 交易对
status String 状态
baseAsset String 交易币
baseAssetPrecision Int 交易币精度
quoteAsset String 计价币
quotePrecision Int 计价币价格精度
quoteAssetPrecision Int 计价币资产精度
baseCommissionPrecision Int 交易币手续费精度
quoteCommissionPrecision Int 计价币手续费精度
orderTypes Array 订单类型
quoteOrderQtyMarketAllowed Boolean 是否允许市价委托
isSpotTradingAllowed Boolean 是否允许api现货交易
isMarginTradingAllowed Boolean 是否允许api杠杆交易
permissions Array 权限
maxQuoteAmount String 最大委托数量
makerCommission String marker手续费
takerCommission String taker手续费
quoteAmountPrecision string 最小下单金额
baseSizePrecision string 最小下单数量

深度信息

获取指定交易对的深度信息,默认返回买卖盘各100条信息

请求示例

GET /api/v3/depth?symbol=BTCUSDT&limit=200

返回示例

{

  "lastUpdateId": 1377043284,
  "bids": [
        ["30225.77","2.132868"],
        ],
  "asks": [
        ["30225.80","1.130244"],
        ],
}

HTTP请求

请求参数

参数名 数据类型 是否必须 说明 取值范围
symbol string 交易对名称 如:BTCUSDT
limit integer 返回的条数 默认 100; 最大 5000

返回参数

参数名 数据类型 说明
lastUpdateId long 最新更新ID
bids list 买盘 [价位, 挂单量]
asks list 卖盘 [价位, 挂单量]

近期成交列表

获取指定交易对的近期成交信息,默认返回最近500条成交信息。

请求示例

GET /api/v3/trades?symbol=BTCUSDT&limit=600

返回示例

[
  {
    "id": null,
    "price": "29919.62",
    "qty": "1.292918",
    "quoteQty": "38683.61525116",
    "time": 1652848049876,
    "isBuyerMaker": true,
    "isBestMatch": true
  },
]

HTTP请求 - GET /api/v3/trades

请求参数

参数名 数据类型 是否必须 说明 取值范围
symbol string 交易对名称 如:BTCUSDT
limit integer 返回的条数 默认 500; 最大 1000

返回参数

参数名 说明
id 成交id
price 价格
qty 数量
quoteQty 成交额
time 成交时间
isBuyerMaker 是否为maker单
isBestMatch 是否为最佳匹配

近期成交(归集)

归集交易与逐笔交易的区别在于,同一价格、同一方向、同一时间的trade会被聚合为一条

请求示例

GET /api/v3/aggTrades?symbol=BTCUSDT

返回示例

[
  {
    "a": null,
    "f": null,
    "l": null,
    "p": "29881.4",
    "q": "0.010068",
    "T": 1652848230000,
    "m": false,
    "M": true
  },
]

HTTP请求

请求参数

参数名 数据类型 是否必须 说明 取值范围
symbol string 交易对名称 如:BTCUSDT
startTime long 从该时刻之后的成交记录开始返回结果
endTime long 返回该时刻为止的成交记录
limit integer 返回的条数 默认 500; 最大 1000

注意:startTime和endTime需同时使用

返回参数

参数名 说明
a 归集成交ID
f 被归集的首个成交ID
l 被归集的末个成交ID
p 成交价
q 成交量
T 成交时间
m 是否为主动卖出单
M 是否为最优撮合单(可忽略,目前总为最优撮合)

K线数据

获取指定交易对的k线数据,每根K线代表一个交易对。每根K线的开盘时间可视为唯一ID。

请求示例

GET /api/v3/klines?symbol=BTCUSDT&interval=1m&startTime=1652848049876&endTimne=1652848650458

返回示例

[
  [
    1652818380000,
    "30082.28",
    "30105.66",
    "30082.28",
    "30084.65",
    "5.838067",
    1652818440000,
    "175741.13"
  ],
]

HTTP请求

请求参数

参数名 数据类型 是否必须 说明
symbol string 交易对名称 如:BTCUSDT
interval ENUM 见枚举定义:K线间隔 如:1m
startTime long 如:1652848049876
endTime long 如:1652848650458
limit integer 默认 500; 最大 1000

注意:startTime和endTime需同时使用

返回参数

索引 说明
0 开盘时间
1 开盘价
2 最高价
3 最低价
4 收盘价
5 成交量
6 收盘时间
7 成交额

当前平均价格

获取指定交易对在一定时间范围内的平均价格。

请求示例

GET /api/v3/avgPrice?symbol=BTCUSDT

返回示例

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

HTTP请求

请求参数

参数名 数据类型 是否必须 说明
symbol string 交易对名称。如:BTCUSDT

返回参数

参数名 说明
mins 均价时间范围
price 价格

24小时价格滚动情况

获取指定交易对或者所有交易对在24小时内的价格滚动(5分钟为单位)

请求示例

GET /api/v3/ticker/24hr?symbol=BTCUSDT

返回示例

{
    "symbol": "BTCUSDT",
    "priceChange": "1588.47",
    "priceChangePercent": "0.07791949",
    "prevClosePrice": "20386.04",
    "lastPrice": "21974.51",
    "bidPrice": "21974.48",
    "bidQty": "0.645732",
    "askPrice": "21974.51",
    "askQty": "5.801688",
    "openPrice": "20386.04",
    "highPrice": "22508.06",
    "lowPrice": "20269.12",
    "volume": "6381.884246",
    "quoteVolume": "135594952.21",
    "openTime": 1657258200000,
    "closeTime": 1657258407860,
    "count": null
}

HTTP请求

请求参数

参数名 数据类型 是否必须 说明
symbol string 交易对名称 不传查全部(谨慎使用) 如:BTCUSDT

返回参数

参数名 说明
symbol 交易对
priceChange 价格变化
priceChangePercent 价格变化比
prevClosePrice 前一收盘价
lastPrice 最新价
lastQty 最新量
bidPrice 买盘价格
bidQty 买盘数量
askPrice 卖盘价格
askQty 卖盘数量
openPrice 开始价
highPrice 最高价
lowPrice 最低价
volume 成交量
quoteVolume 成交额
openTime 开始时间
closeTime 结束时间
count

最新价格

获取指定交易对或者所有交易对的最新价格

请求示例

GET /api/v3/ticker/price?symbol=BTCUSDT

返回示例

{
    "symbol": "BTCUSDT",
    "price": "29805.02"
}

HTTP请求

请求参数

参数名 数据类型 是否必须 说明
symbol string 交易对名称 不传查全部 如:BTCUSDT

返回参数

参数名 说明
symbol 交易对
price 最新价格

当前最优挂单

获取当前最优的挂单(最高买单,最低卖单)

请求示例

GET /api/v3/ticker/bookTicker?symbol=BTCUSDT

返回示例

{
    "symbol": "BTCUSDT",
    "bidPrice": "29820.79",
    "bidQty": "2.241948",
    "askPrice": "29820.82",
    "askQty": "2.301948"
}

HTTP请求

请求参数

参数名 数据类型 是否必须 说明
symbol string 交易对名称 不传查全部 如:BTCUSDT

返回参数

参数名 说明
symbol 交易对
bidPrice 最高买盘价
bidQty 最高买盘数量
askPrice 最低卖盘价
askQty 最低卖盘数量

母子账户接口

创建子账户

获取您的母账户生成一个虚拟子账户

请求示例

POST /api/v3/sub-account/virtualSubAccount?subAccount=subAccount1&note=1&timestamp={{timestamp}}&signature={{signature}}

返回示例

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

HTTP请求

请求参数

参数名 数据类型 是否必需 说明
subAccount STRING YES 子账户名称(8-32个字母加数字)如:subAccount1
note STRING YES 备注 如:1
recvWindow LONG NO
timestamp LONG YES

返回参数

参数名 数据类型 说明
subAccount STRING 子账户名称(8-32个字母加数字)如:subAccount1
note STRING 备注 如:1

查看子账户列表

获取您的母账户下所有子账户信息

请求示例

GET /api/v3/sub-account/list?timestamp={{timestamp}}&signature={{signature}}

返回示例

{
    "subAccounts":[
        {
            "subAccount":"subAccount1",
            "isFreeze":false,//是否冻结
            "createTime":1544433328000
        },
        {
            "subAccount":"subAccount2",
            "isFreeze":false,
            "createTime":1544433328000
        }
    ]
}

HTTP请求

请求参数

名称 类型 是否必需 说明
subAccount STRING NO 子账户名称 如:subAccount1
isFreeze STRING NO true or false
page INT NO 默认: 1
limit INT NO 默认: 10, 最大: 200
timestamp LONG YES
recvWindow LONG NO

返回参数

参数名 数据类型 说明
subAccount STRING 子账户名称
isFreeze STRING 是否冻结
createTime LONG 创建时间

创建子账户的APIkey

为子账户创建APIkey

请求示例

POST /api/v3/sub-account/apiKey
body
[
        {
            "subAccount":"subAccount1",
            "permissions":"SPOT_ACCOUNT_READ",
            "ip":"135.181.193",
            "note":"1"
        }
]

返回示例

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

HTTP请求

请求参数

参数名 类型 是否必须 说明
subAccount STRING 子账户名称 如:subAccount1
note STRING APIKey的备注
permissions STRING 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 绑定ip地址,多个ip用半角逗号隔开,最多支持20个ip。 如:135.181.193
recvWindow LONG
timestamp LONG

返回参数

参数名 类型 说明
subAccount STRING 子账户名称
note STRING APIKey的备注
apiKey STRING API公钥
secretKey STRING API的私钥
permissions STRING APIKey权限
ip STRING APIKey绑定的ip地址
creatTime LONG 创建时间

查询子账户的APIKey

获取指定子账户的APIkey信息

请求示例

GET/api/v3/sub-account/apiKey?subAccount=subAccount1&timestamp=1597026383085

返回示例

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

HTTP请求

请求参数

参数名 类型 是否必须 说明
subAccount STRING 子账户名称 如:subAccount1
recvWindow LONG
timestamp LONG

返回参数

参数名 类型 说明
note STRING APIKey的备注
apiKey STRING API公钥
permissions STRING APIKey权限
ip STRING APIKey绑定的ip地址
creatTime LONG 创建时间

删除子账户的APIKey

请求示例

DELETE /api/v3/sub-account/apiKey
body
[
        {
            "subAccount":"subAccount1",
            "apiKey":"ghytfugy2168hjksaj"
        }
]

返回示例

{
           "subAccount":"subAccount1"
}

HTTP请求

请求参数

参数名 类型 是否必须 说明
subAccount STRING 子账户名称 如:subAccount1
apiKey STRING API的公钥 如:ghytfugy2168hjksaj
recvWindow LONG
timestamp LONG

返回参数

参数名 类型 说明
subAccount STRING 子账户名称

现货账户和交易接口

测试下单

用于测试订单请求,但不会提交到撮合引擎

请求示例

POST /api/v3/order/test

返回示例

{}

HTTP请求 - POST /api/v3/order/test

请求参数

同于 POST /api/v3/order

下单

只有当您的账户有足够的资金才能下单。

请求示例

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

返回示例

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

HTTP请求

请求参数

名称 类型 是否必需 说明
symbol STRING YES 交易对
side ENUM YES 详见枚举定义:订单方向
type ENUM YES 详见枚举定义:订单类型
quantity DECIMAL NO 委托数量
quoteOrderQty DECIMAL NO 委托总额
price DECIMAL NO 委托价格
newClientOrderId STRING NO 客户自定义的唯一订单ID
recvWindow LONG NO 赋值不能大于 60000
timestamp LONG YES

基于订单 type不同,强制要求某些参数:

类型 强制要求的参数
LIMIT quantity, price
MARKET quantity or quoteOrderQty

其他说明:

MARKET:当type是market时,若为买单,则quoteOrderQty,为必填参数。 若为卖单,quantity为必填参数,

返回参数

参数名 数据类型 说明
symbol STRING 交易对
orderId STRING 订单类型
orderListId 客户端订单列表

批量下单

支持单次批量下20单,限频2次/秒。

请求示例

POST /api/v3/batchOrders?batchOrders=[{"type": "LIMIT_ORDER","price": "40000","quantity": "0.0002","symbol": "BTC_USDT","side": "BID","client_order_id": 9588234},{"type": "LIMIT_ORDER","price": "0.00846945","quantity": "1","symbol": "RACA_USDT","side": "ASK"}]

返回示例

{ //成功返回:
  [
    {   
      "symbol": "BTCUSDT",   
      "orderId": "1196315350023612316",   
      "orderListId": -1 
    },
    {   
      "symbol": "BTCUSDT",   
      "orderId": "1196315350023612318",   
      "orderListId": -1 
    }
  ],
  //有失败的返回:
  [
    { 
      "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 
    }
  ] 
}

HTTP请求

请求参数

名称 类型 是否必需 说明
batchOrders LIST YES 订单列表,最多支持20个订单(list of JSON格式填写订单参数,参考请求示例)
symbol STRING YES 交易对
side ENUM YES 详见枚举定义:订单方向
type ENUM YES 详见枚举定义:订单类型
quantity DECIMAL NO 委托数量
quoteOrderQty DECIMAL NO 委托总额
price DECIMAL NO 委托价格
newClientOrderId STRING NO 客户自定义的唯一订单ID
recvWindow LONG NO 赋值不能大于 60000
timestamp LONG YES

基于订单 type不同,强制要求某些参数:

类型 强制要求的参数
LIMIT quantity, price
MARKET quantity or quoteOrderQty

返回参数

参数名 数据类型 说明
symbol STRING 交易对
orderId STRING 订单类型

撤销订单

取消有效订单。

请求示例

DELETE /api/v3/order?symbol=BTCUSDT&orderId=135598325645746176&timestamp={{timestamp}}&signature={{signature}}

返回示例

{
  "symbol": "BTCUSDT",
  "origClientOrderId": "myOrder1",
  "orderId": 4,
  "orderListId": -1, // OCO订单ID,否则为 -1
  "clientOrderId": "cancelMyOrder1",
  "price": "29000.0000",
  "origQty": "1.00000000",
  "executedQty": "0.00000000",
  "cummulativeQuoteQty": "0.00000000",
  "status": "CANCELED",
  "timeInForce": "GTC",
  "type": "LIMIT",
  "side": "BUY"
}

HTTP请求

请求参数

参数名 数据类型 是否必须 说明
symbol string 交易对名称
orderId string 订单Id
origClientOrderId string 初始自定义订单Id
newClientOrderId string NO 客户自定义的唯一订单ID
recvWindow long
timestamp long

返回参数

参数名 说明
symbol 交易对
origClientOrderId 原始客户端订单id
orderId 订单id
clientOrderId 客户端id
price 价格
origOty 初始数量
executedQty 已成交数量
cummulativeQuoteQty 已成交金额
status 当前状态
timeInForce 订单有效方式
type 订单类型
side 订单方向

撤销单一交易对所有订单

撤销单一交易对下所有挂单, 包括OCO的挂单。

请求示例

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

返回示例

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

HTTP请求

请求参数

参数名 数据类型 是否必须 说明
symbol string 交易对
recvWindow long
timestamp long

返回参数

参数名 说明
symbol 交易对
origClientOrderId 原始客户端订单id
orderId 订单id
clientOrderId 客户端id
price 价格
origOty 初始数量
executedQty 已成交数量
cummulativeQuoteQty 已成交金额
status 状态
timeInForce 订单有效方式
type 订单类型
side 订单方向

查询订单

查询指定交易对订单状态,最多查询7天内的订单记录,超过7天的可在web客户端查看和导出。

请求示例

GET /api/v3/order?symbol=BTCUSDT&orderId=129402018493145088&timestamp={{timestamp}}&signature={{signature}}

返回示例

{
  "symbol": "LTCBTC", // 交易对
  "orderId": 1, // 系统的订单ID
  "orderListId": -1, // OCO订单的ID,不然就是-1
  "clientOrderId": "myOrder1", // 客户自己设置的ID
  "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, // 订单是否出现在orderbook中
  "origQuoteOrderQty": "0.000000" // 原始的交易金额
}

HTTP请求

请求参数

参数名 数据类型 是否必须 说明
symbol 交易对
origClientOrderId 原始客户端订单id
orderId 订单id
recvWindow long
timestamp long

返回参数

参数名 说明
symbol 交易对
origClientOrderId 原始客户端订单id
orderId 系统订单id
clientOrderId 客户自定义id
price 价格
origOty 原始订单数量
executedQty 交易的订单数量
cummulativeQuoteQty 累计订单金额
status 订单状态
timeInForce 订单的时效方式
type 订单类型
side 订单方向
stopPrice 止损价格
icebergQty 冰山数量
time 订单时间
updateTime 最后更新时间
isWorking 是否在orderbook中
origQuoteOrderQty 原始的交易金额

当前挂单

获取当前挂单支持查询多交易对,每次最多可以传5个symbol。
若批量查5个交易对,最多也只返回1000条挂单

请求示例

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

返回示例

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

HTTP请求

请求参数

参数名 数据类型 是否必须 说明
symbol string 交易对,【最多可以传5个symbol, 由","分隔的字符串表示. e.g. "BTCUSDT,MXUSDT,ADAUSDT"】
recvWindow long
timestamp long

返回参数

参数名 说明
symbol 交易对
origClientOrderId 原始客户端订单id
orderId 系统订单id
clientOrderId 客户自定义id
price 价格
origOty 原始订单数量
executedQty 交易的订单数量
cummulativeQuoteQty 累计订单金额
status 订单状态
timeInForce 订单的时效方式
type 订单类型
side 订单方向
stopPrice 止损价格
icebergQty 冰山数量
time 订单时间
updateTime 最后更新时间
isWorking 是否在orderbook中
origQuoteOrderQty 原始的交易金额

查询所有订单

获取所有帐户订单; 有效,已取消或已完成,最多查询最近7天数据。

请求示例

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

返回示例

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

HTTP请求

请求参数

参数名 数据类型 是否必须 说明
symbol string 交易对
startTime long
endTime long
limit int 默认 500; 最大 1000;
recvWindow long
timestamp long

返回参数

参数名 说明
symbol 交易对
origClientOrderId 原始客户端订单id
orderId 系统订单id
clientOrderId 客户自定义id
price 价格
origOty 原始订单数量
executedQty 交易的订单数量
cummulativeQuoteQty 累计订单金额
status 订单状态
timeInForce 订单的时效方式
type 订单类型
side 订单方向
stopPrice 止损价格
icebergQty 冰山数量
time 订单时间
updateTime 最后更新时间
isWorking 是否在orderbook中
origQuoteOrderQty 原始的交易金额

账户信息

获取当前账户信息,限速2次每秒。

请求示例

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

返回示例

{
    "makerCommission": 20,
    "takerCommission": 20,
    "buyerCommission": 0,
    "sellerCommission": 0,
    "canTrade": true,
    "canWithdraw": true,
    "canDeposit": true,
    "updateTime": null,
    "accountType": "SPOT",
    "balances": [
        {
            "asset": "MX",
            "free": "3",
            "locked": "0"
        },
        {
            "asset": "BTC",
            "free": "0.0003",
            "locked": "0"
        }
    ],
    "permissions": [
        "SPOT"
    ]
}

HTTP请求

请求参数

参数名 数据类型 是否必须 说明
recvWindow long
timestamp long

返回参数

参数名 说明
makerCommission maker 费率
takerCommission taker 费率
buyerCommission
sellerCommission
canTrade 是否可交易
canWithdraw 是否可提现
canDeposit 是否可充值
updateTime 更新时间
accountType 账户类型
balances 余额
asset 资产币种
free 可用数量
locked 冻结数量
permissions 权限

账户成交历史

获取账户指定交易对的成交历史

请求示例

GET /api/v3/myTrades?symbol=MXUSDT&timestamp={{timestamp}}&signature={{signature}}

返回示例

[
  {
      "symbol": "MXUSDT",
      "id": "fad2af9e942049b6adbda1a271f990c6",
      "orderId": "bb41e5663e124046bd9497a3f5692f39",
      "orderListId": -1,
      "price": "2.044",
      "qty": "3",
      "quoteQty": "6.132",
      "commission": "0.012264",
      "commissionAsset": "USDT",
      "time": 1651980451000,
      "isBuyer": true,
      "isMaker": false,
      "isBestMatch": true,
      "isSelfTrade": null,
      "clientOrderId": null
  }
]

HTTP请求

请求参数

参数名 数据类型 是否必须 说明
symbol string 交易对
orderId string 必须和symbol一起使用
startTime long
endTime long
limit int 默认 500; 最大 1000;
recvWindow long
timestamp long

返回参数

参数名 说明
symbol 交易对
id 成交id
orderId 订单id
price 价格
qty 数量
quoteQty 成交金额
time 成交时间
commission 手续费
commissionAsset 手续费币种
isBuyerMaker 是否为买方maker单
isBestMatch 是否为最佳匹配
isSelfTrade 是否自成交
clientOrderId 用户自定义id

钱包接口

查询币种信息

返回币种详细信息以及智能合约地址

请求示例

Get /api/v3/capital/config/getall

返回示例

[
  {
    "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"
      }
    ]
  },
]

HTTP请求

请求参数

返回参数

参数名 说明
depositEnable 是否可充值
network 币种所支持的网络
withdrawEnable 是否可提币
withdrawFee 提币手续费
withdrawMax 最大提币限额
withdrawMin 最大提币限额
contract 币种智能合约地址

提币

请求示例

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

返回示例

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

HTTP请求

请求参数

参数名 数据类型 是否必须 说明
timestamp string 时间戳
signature string 签名
coin string 币种
withdrawOrderId string 自定义提币ID(目前不支持)
network string 提币网络
address string 提币地址
amount string 数量
remark string 备注
  1. 如果不发送network,将按该币种默认网络返回结果;
  2. 可以在接口 Get /api/v3/capital/config/getall的返回值中某币种的networkList获取network网络字段和isDefault是否为默认网络。

返回参数

参数名 说明
id 提币ID

获取充值历史(支持多网络)

请求示例

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

返回示例

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

HTTP请求

请求参数

参数名 数据类型 是否必须 说明
timestamp string 时间戳
signature string 签名
coin string 币种
status string 状态
startTime string 默认当前时间90天前的时间
endTime string 默认当前时间戳,13位
limit string 默认:1000,最大1000

请注意startTimeendTime 的默认时间戳,保证请求时间间隔不超过90天.

返回参数

参数名 说明
amount 数量
coin 币种
network 链类型
status 充值状态,1:小额充值,2:延遲到賬,3:大額充值,4:等待中,5:入账成功,6:审核中,7:驳回
address 地址
addressTag 地址标签
txId 交易编号
insertTime 插入时间/创建时间
unlockConfirm 解锁需要的网络确认次数
confirmTimes 已解锁次数

获取提币历史 (支持多网络)

请求示例

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

返回示例

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

HTTP请求

请求参数

参数名 数据类型 是否必须 说明
timestamp string 时间戳
signature string 签名
coin string 币种
status string 提币状态
limit string 默认:1000, 最大:1000
startTime string 默认当前时间90天前的时间戳
endTime string 默认当前时间戳
  1. 支持多网络提币前的历史记录可能不会返回network字段.
  2. 请注意startTimeendTime 的默认时间戳,保证请求时间间隔不超过90天.

返回参数

参数名 说明
address 地址
amount 提现转出金额
applyTime 申请时间
coin 币种
id 该笔提现的id
withdrawOrderId 自定义ID,如果没有则不返回该字段
network 链类型
transferType 0: 站外转账,1: 站内转账
status 提币状态,1:提交申请,2:审核中,3:等待处理,4:处理中,5:等待打包,6:等待确认,7:提现成功,8:提现失败,9:已取消,10:手动入账
transactionFee 手续费
confirmNo 提现确认数
txId 提现交易id
remark 提现记录备注

获取充值地址 (支持多网络)

请求示例

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

返回示例

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

HTTP请求

请求参数

参数名 数据类型 是否必须 说明
timestamp string 时间戳
signature string 签名
coin string 币种
network string

返回参数

参数名 说明
address 地址
coin 币种
tag 标签
network

用户万向划转【母母账户】

请求示例

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

返回示例

[
  {
    "tranId": "c45d800a47ba4cbc876a5cd29388319"
  }
]

HTTP请求

请求参数

参数名 数据类型 是否必须 说明
timestamp string 时间戳
signature string 签名
fromAccountType string 划出账户类型,现货/合约/杠杆/法币,枚举值:"SPOT","FUTURES","ISOLATED_MARGIN""FIAT"
toAccountType string 划入账户类型,现货/合约/杠杆/法币,枚举值:"SPOT","FUTURES","ISOLATED_MARGIN""FIAT"
asset string 资产
amount string 数量
symbol string 交易对,当fromAccountType为逐仓杠杆(ISOLATED_MARGIN)时必传,eg:ETHUSDT

当类型为 ISOLATEDMARGIN,fromSymboltoSymbol 必须要发送.

返回参数

参数名 说明
tranId 划转ID

查询用户万向划转历史

请求示例

get /api/v3/capital/transfer

返回示例

[
  {
    "rows":[
    {
      "tranId":"11945860693",//划转ID
      "clientTranId":"test",//client ID
      "asset":"BTC",//币种
      "amount":"0.1",//划转数量
      "fromAccountType":"SPOT",//转出业务账户
      "toAccountType":"FUTURE",//划入业务账户
      "fromSymbol":"SPOT",//转出交易对
      "toSymbol":"FUTURE",//划入交易对
      "status":"SUCCESS",//划转状态
      "timestamp":1544433325000//划转时间
    },
    {
      "tranId":"11945860693",//划转ID
      "clientTranId":"test",//client ID
      "asset":"BTC",//币种
      "amount":"0.1",//划转数量
      "fromAccountType":"SPOT",//转出业务账户
      "toAccountType":"FUTURE",//划入业务账户
      "fromSymbol":"SPOT",//转出交易对
      "toSymbol":"FUTURE",//划入交易对
      "status":"SUCCESS",//划转状态
      "timestamp":1544433325000//划转时间
    }],
    "total": 2,//总数
  }
]

HTTP请求

请求参数

参数名 数据类型 是否必须 说明
timestamp string 时间戳
signature string 签名
fromAccountType string 划出账户类型,现货/合约/杠杆/法币,枚举值:"SPOT","FUTURES","ISOLATED_MARGIN""FIAT"
toAccountType string 划入账户类型,现货/合约/杠杆/法币,枚举值:"SPOT","FUTURES","ISOLATED_MARGIN""FIAT"
startTime string
endTime string
page string 默认1
size string 默认 10, 最大 100
symbol string 交易对,当fromAccountType为逐仓杠杆(ISOLATED_MARGIN)时必传,如:ETHUSDT
  1. 仅支持查询最近半年(6个月)数据
  2. startTimeendTime没传,则默认返回最近7天数据 返回参数
参数名 说明
total 总数
tranId 划转ID
clientTranId client ID
asset 币种
amount 划转数量
fromAccountType 转出业务账户
toAccountType 划入业务账户
symbol 转出交易对
status 划转状态
timestamp 划转时间

ETF接口

获取杠杆ETF基础信息

获取ETF的基础信息,如可交易币对、最新净值和管理费率。

请求示例

GET /api/v3/etf/info

返回示例

{

"symbol": "BTC3LUSDT", 

"netValue": "0.147", 

"feeRate":" 0.00001", 

"timestamp": `1507725176595`

}

HTTP请求

请求参数

参数 数据类型 是否必须 默认值 描述
symbol string NA ETF交易对,不填返回所有

返回参数

字段名称 数据类型 描述
symbol string 杠杆ETF交易对
netValue string 最新净值
feeRate string 管理费率
timestamp long 系统时间

杠杆账户和交易接口

切换杠杆账户模式

切换杠杆账户的交易模式

请求示例

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

返回示例

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

HTTP请求

请求参数

参数名 说明 是否必须 数据类型 示例
timestamp 时间戳 string 1655143087012
signature 签名 string
tradeMode 交易模式 int 0: 手动模式 1:自动借还模式
symbol 交易对 string BTCUSDT

返回参数

参数名 说明 数据类型 示例
tradeMode 交易模式 int 0
symbol 交易对 string BTCUSDT

下单

进行杠杆账户下单操作

请求示例

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

返回示例

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

HTTP请求

请求参数

参数名 说明 是否必须 数据类型 示例
timestamp 时间 string 1507725176595
signature 签名 string signature
symbol 交易对 string BTCUSDT
isIsolated 是否逐仓杠杆 string "TRUE", "FALSE", 默认 "TRUE"
side 方向 string BUY
type 详见枚举定义:订单类型 (暂不支持市价单) string LIMIT
quantity 订单数量 string 10
quoteOrderQty 订单总额 string 200000
price 下单价格买入价 string 20000
newClientOrderId 客户自定义的唯一订单ID string 6gCrw2kRUAF9CvJDGP16IP
recvWindow 同步时间 string 6000

返回参数

参数名 说明 数据类型 示例
symbol 交易对 string BTCUSDT
orderId 订单id string 693471305432961024
clientOrderId 客户自定义订单id string 6gCrw2kRUAF9CvJDGP16IP
isIsolated 是否是逐仓 boolean true
transactTime 下单时间 number 1507725176595

借贷

请求示例

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

返回示例

[
  {
    "tranId": 746784754145301480
  }
]

HTTP请求

请求参数

参数名 说明 是否必须 数据类型 示例
timestamp 时间 string 1507725176595
signature 签名 string signature
asset 资产 string BTC
isIsolated 是否逐仓杠杆 string "TRUE", "FALSE", 默认 "TRUE"
symbol 交易对 string BTCUSDT
amount 数量 string 10
recvWindow 同步时间 string 6000

返回参数

参数名 说明 数据类型 示例
tranId 借款记录id number 746784754145301480

详细说明

如果 isIsolated = “TRUE”, 表示逐仓借贷,此时 symbol 必填。

归还借贷

请求示例

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

返回示例

[
  {
    "tranId": 2597392
  }
]

HTTP请求

请求参数

参数名 说明 是否必须 数据类型 示例
timestamp 时间 string 1507725176595
signature 签名 string signature
asset 资产 string BTC
isIsolated 是否逐仓杠杆 string "TRUE", "FALSE", 默认 "TRUE"
symbol 交易对 string BTCUSDT
amount amount和isAllRepay,二选一 string 10
borrowId 借款订单id string 746784754145301480
isAllRepay 全不全还 string true or false
recvWindow 同步时间 string 6000

返回参数

参数名 说明 数据类型 示例
tranId 还款id number 2597392

详细说明

如果 isIsolated = “TRUE”, 表示逐仓还款,此时 symbol 必填。

撤销单一交易对的所有挂单

请求示例

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

返回示例

[
  [
    {
      "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请求

请求参数

参数名 说明 是否必须 数据类型 示例
timestamp 时间 string 1507725176595
signature 签名 string signature
symbol 交易对 string BTCUSDT
isIsolated 是否逐仓杠杆 string "TRUE", "FALSE", 默认 "TRUE"
recvWindow 同步时间 string 6000

返回参数

参数名 说明 数据类型 示例
symbol 交易对 string BTCUSDT
isIsolated 是否是逐仓 boolean true
clientOrderId 客户自定义订单id 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 订单id string
orderListId 客户端订单列表 string

撤销订单

请求示例

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

返回示例

[
  {
    "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请求

请求参数

参数名 说明 是否必须 数据类型 示例
timestamp 时间 string 1507725176595
signature 签名 string signature
isIsolated 是否逐仓杠杆 string "TRUE", "FALSE", 默认 "TRUE"
symbol 交易对 string BTCUSDT
orderId 订单id string 746777776866070528
origClientOrderId 下单时,用户传入的自定义id string
recvWindow 同步时间 string 6000

返回参数

参数名 说明 数据类型 示例
symbol 交易对 string LTCBTC
orderId 订单id string 693471305432961024
clientOrderId 客户自定义订单id string cancelMyOrder1
price 下单价格 string 1.00000000
origQty 下单数量 string 10.00000000
executedQty 成交数量 string 8.00000000
cummulativeQuoteQty 累计成交金额累计成交金额 string 8.00000000
status 订单状态 string CANCELED
type 订单类型 string LIMIT
side 方向 string SELL
isIsolated 是否是逐仓 boolean true

详细说明

必须发送 orderId 或 origClientOrderId 其中一个。

查询借贷记录

请求示例

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

返回示例

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

HTTP请求

请求参数

参数名 说明 是否必须 数据类型 示例
timestamp 时间 string 1507725176595
signature 签名 string signature
asset 资产 string BTC
symbol 逐仓symbol string BTCUSDT
tranId 借贷id in POST /api/v3/margin/loan string 746784754145300480
startTime 开始时间 string
endTime 截止时间 string
current 当前查询页 string 开始值 1, 默认:1
size string 默认:10 最大:100
recvWindow 同步时间 string 6000

返回参数

参数名 说明 数据类型 示例
symbol 逐仓借贷 返回逐仓symbol; 若是全仓不会返回此字段 string BTCUSDT
tranId 借贷id number 12807067523
asset 资产 string BTC
principal 借款金额 string 0.84624403
timestamp 时间 number 1555056425000
remainAmount 待还金额 string
remainInterest 待还利息 string
repayAmount 已还金额 string 300
repayInterest 已还利息 string 1.96249686
status 订单状态: PENDING (等待执行), CONFIRMED (成功借贷), FAILED (执行失败); string CONFIRMED
total 总数 number 1

详细说明

必须发送tranId 或 startTime,tranId 优先。响应返回为降序排列。如果发送isolatedSymbol,返回指定逐仓symbol指定asset的借贷记录。

查询历史委托记录

请求示例

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

返回示例

[
  {
      "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请求

请求参数

参数名 说明 是否必须 数据类型 示例
timestamp 时间 string 1507725176595
signature 签名 string signature
symbol 交易对 string BTCUSDT
isIsolated 是否逐仓杠杆 string "TRUE", "FALSE", 默认 "TRUE"
orderId 订单id 订单id string 746779360689786880
startTime 开始时间 string
endTime 截止时间 string
limit 默认 500;最大500. string

返回参数

参数名 说明 数据类型 示例
clientOrderId 客户自定义订单id string D2KDy4DIeS56PvkM13f8cP
cummulativeQuoteQty 累计成交金额 string 0.00000000
executedQty 成交数量 string 0.00000000
isWorking 是否正常工作 boolean false
orderId 订单id number 41295
origQty 下单数量 string 5.31000000
price 下单价格 string 0.22500000
side 方向 string SELL
status 订单状态 string CANCELED
symbol 交易对 string MXBTC
isIsolated 是否是逐仓 boolean false
time 下单时间 number 1565769338806
type 订单类型 string TAKE_PROFIT_LIMIT
updateTime 更新时间 number 1565769342148

详细说明

如果设置 orderId , 获取订单 >= orderId, 否则返回近期订单历史。一些历史订单的 cummulativeQuoteQty < 0, 是指当前数据不存在。

查询历史成交记录

请求示例

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

返回示例

[

]

HTTP请求

请求参数

参数名 说明 是否必须 数据类型 示例
timestamp 时间 string 1507725176595
signature 签名 string signature
symbol 交易对 string BTCUSDT
isIsolated 是否逐仓杠杆 string "TRUE", "FALSE", 默认 "TRUE"
startTime 开始时间 string
endTime 截止时间 string
fromId 获取TradeId,默认获取近期交易历史。 string
limit 默认 500; 最大 1000. string

返回参数

参数名 说明 数据类型 示例
commission 手续费 string 0.00006000
commissionAsset 手续费币种 string BTC
id trade-id number 34
isBuyer 是否自成交 boolean false
orderId 订单id number 39324
price 下单价格 string 0.02000000
qty 数量 string 3.00000000
symbol 交易对 string MXBTC
isIsolated 是否是逐仓 boolean false
time 下单时间 number 1561973357171

详细说明

如果设置 fromId , 获取订单 id >= fromId, 否则返回近期订单历史。

查询当前挂单记录

请求示例

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

返回示例

[
  {
  "rows": [
    {
        "isolatedSymbol": "MXUSDT", // 逐仓借贷 返回逐仓symbol; 【统一参数】
        "id": "12807067523",//order id 
        "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请求

请求参数

参数名 说明 是否必须 数据类型 示例
timestamp 时间 string 1507725176595
signature 签名 string signature
symbol 交易对 string BTCUSDT
isIsolated 是否逐仓杠杆 string "TRUE", "FALSE", 默认 "TRUE"

返回参数

参数名 说明 数据类型 示例
clientOrderId 客户自定义订单id string qhcZw71gAkCCTv0t0k8LUK
cummulativeQuoteQty 累计成交金额成交金额 string 0.00000000
executedQty 成交数量 string 0.00000000
isWorking 是否正常工作 boolean true
orderId 订单id number 211842552
origQty 下单数量 string 0.30000000
price 下单价格 string 0.00475010
side 方向 string SELL
status 订单状态 string NEW
symbol 交易对 string MXBTC
isIsolated 是否是逐仓 boolean true
time 下单时间 number 1562040170089
timeInForce 生效时间 string GTC
type 订单类型 string LIMIT
updateTime 更新时间 number 1562040170089

详细说明

如未发送symbol,返回所有 symbols 订单记录。如果 isIsolated = “TRUE”, symbol 为必填

查询最大可转出额

请求示例

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

返回示例

[
  {
    "amount": "0.00022998"
  } 
]

HTTP请求

请求参数

参数名 说明 是否必须 数据类型 示例
timestamp 时间 string 1507725176595
signature 签名 string signature
asset 资产 string BTC
symbol 交易对 string BTCUSDT

返回参数

参数名 说明 数据类型 示例
amount 可转出数额 string 0.00022998

查询杠杆价格指数

说明

请求示例

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

返回示例

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

HTTP请求

请求参数

参数名 说明 是否必须 数据类型 示例
timestamp 时间 string 1507725176595
signature 签名 string signature
symbol 交易对 string BTCUSDT

返回参数

参数名 说明 数据类型 示例
calcTime 查询时间 number 1562046418000
price 下单价格 string 21823.45
symbol 交易对 string BTCUSDT

查询杠杆账户订单详情

请求示例

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

返回示例

[
  {
    "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请求

请求参数

参数名 说明 是否必须 数据类型 示例
timestamp 时间 string 1507725176595
signature 签名 string signature
symbol 交易对 string BTCUSDT
isIsolated 是否逐仓杠杆 string "TRUE", "FALSE", 默认 "TRUE"
orderId 订单id string 746779360689786880

返回参数

参数名 说明 数据类型 示例
clientOrderId 客户自定义订单id string ZwfQzuDIGpceVhKW5DvCmO
cummulativeQuoteQty 累计成交金额累计交易货币数量?? string 0.00000000
executedQty 成交数量实际数量 string 0.00000000
isWorking 是否正常工作 boolean true
orderId 订单id number 213205622
origQty 下单数量原始数量 string 0.30000000
price 下单价格 string 0.00493630
side 方向 string SELL
status 订单状态 string NEW
symbol 交易对 string MXBTC
isIsolated 是否是逐仓 boolean true
time 下单时间 number 1562133008725
type 订单类型 string LIMIT
updateTime 更新时间 number 1562133008725

详细说明

必须发送 orderId 或 origClientOrderId 其中一个。一些历史订单的 cummulativeQuoteQty < 0, 是指当前数据不存在。

查询杠杆逐仓账户信息

请求示例

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

返回示例

[
  {
    "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请求

请求参数

参数名 说明 是否必须 数据类型 示例
timestamp 时间 string 1507725176595
signature 签名 string signature
symbols 最多可以传5个symbol; 由","分隔的字符串表示. e.g. "BTCUSDT,MXUSDT,ADAUSDT" string

返回参数

参数名 说明 数据类型 示例
asset 资产 string BTC
borrowEnabled 是否可借 boolean true
borrowed 已借金额 string 0
free 可用金额 string 1
interest 利息金额 string 0
locked 冻结金额 string 0
netAsset 净资产 string 1
netAssetOfBtc 净资产折合BTC string 0.0002
repayEnabled 是否可还 boolean true
totalAsset 总资产 string 1
symbol 交易对 string BTCUSDT
isolatedCreated 该逐仓账户创建状态 boolean true
enabled 账户是否启用,true-启用,false-停用 boolean true
marginLevel 实际杠杆倍数 string 1
marginRatio 支持杠杠倍数 string 9
indexPrice 指数价格 string 10000.00000000
liquidatePrice 强平价 string 1000.00000000
liquidateRate 强平率 string 1.00000000
tradeEnabled 是否可交易 boolean true

详细说明

传”symbols”, 将只会返回制定symbol的杠杆逐仓资产

查询账户最大可借贷额度

请求示例

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

返回示例

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

HTTP请求

请求参数

参数名 说明 是否必须 数据类型 示例
timestamp 时间 string 1507725176595
signature 签名 string signature
asset 资产 string BTC
symbol 交易对 string BTCUSDT

返回参数

参数名 说明 数据类型 示例
amount 系统可借充足情况下,用户账户当前最大可借额度 string 1.69248805
borrowLimit 平台限制的用户当前等级可以借的额度 string 60

查询还贷记录

请求示例

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

返回示例

[

]

HTTP请求

请求参数

参数名 说明 是否必须 数据类型 示例
timestamp 时间 string 1507725176595
signature 签名 string signature
asset 资产 string BTC
symbol 交易对 string BTCUSDT
tranId 还款id string
startTime 开始时间 string
endTime 截止时间 string
current 当前查询页。开始值 1. 默认:1 string
size 默认:10 最大:100 string
recvWindow 同步时间 string 6000

返回参数

参数名 说明 数据类型 示例
symbol 逐仓还款 返回逐仓symbol; 若是全仓不会返回此字段 string MXUSDT
amount 还款总额 string 14.00000000
asset 资产 string MX
interest 支付的利息 string 0.01866667
principal 支付的本金 string 13.98133333
timestamp 时间 number 1563438204000
tranId 还款id number 2970933056
total 总数 number 1

详细说明

必须发送tranId 或 startTime,tranId 优先。响应返回为降序排列。如果发送symbol,返回指定逐仓symbol指定asset的还贷记录。

查询逐仓杠杆交易对

请求示例

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

返回示例

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

HTTP请求

请求参数

参数名 说明 是否必须 数据类型 示例
timestamp 时间 string 1507725176595
signature 签名 string signature
symbol 交易对 string BTCUSDT

返回参数

参数名 说明 数据类型 示例
symbol 交易对 string BTCUSDT
base 交易币种 string BTC
quote 计价币种 string USDT
isMarginTrade 能不能杠杆交易 boolean true

获取账户强制平仓记录

请求示例

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

返回示例

[

]

HTTP请求

请求参数

参数名 说明 是否必须 数据类型 示例
timestamp 时间 string 1507725176595
signature 签名 string signature
startTime 开始时间 string
endTime 截止时间 string
symbol 交易对 string BTCUSDT
current 当前查询页。 开始值 1. 默认:1 string
size 默认:10 最大:100 string

返回参数

参数名 说明 数据类型 示例
avgPrice string 0.00388359
executedQty 成交数量 string 31.39000000
orderId 订单id没有order id 为系统还 string 180015097
price 下单价格没有price 为直接还 string 0.00388110
qty 数量 string 31.39000000
side 方向 string SELL
symbol 交易对 string MXBTC
isIsolated 是否是逐仓 boolean true
updatedTime 更新时间 number 1558941374745
total 总数 number 1

详细说明

响应返回为降序排列。

获取逐仓杠杆利率及限额

请求示例

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

返回示例

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

]

HTTP请求

请求参数

参数名 说明 是否必须 数据类型 示例
timestamp 时间 string 1507725176595
signature 签名 string signature
symbol 交易对 string BTCUSDT

返回参数

参数名 说明 数据类型 示例
symbol 交易对 string BTCUSDT
leverage 杠杆倍率 string 10
coin 币种 string BTC
hourInterest 小时利息 string 0.00026125
borrowLimit 借贷限额 string 270

获取逐仓档位信息

请求示例

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

返回示例

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

HTTP请求

请求参数

参数名 说明 是否必须 数据类型 示例
timestamp 时间 [string
signature 签名 string signature
symbol 交易对 string BTCUSDT
tier 不传则返回所有逐仓杠杆档位 string

返回参数

参数名 说明 数据类型 示例
symbol 交易对 string BTCUSDT
tier 仓位等级 number 1
effectiveMultiple 有效倍数 string 10
initialRiskRatio 初始风险比 string 1.111
liquidationRiskRatio 清算风险比 string 1.05
baseAssetMaxBorrowable 基础货币最大可借 string 9
quoteAssetMaxBorrowable 计价货币最大可借 string 70000

公开API参数

枚举定义

订单方向

订单类型

订单状态

K线间隔