Navbar
现货/杠杆/币安宝 U本位合约 币本位合约 欧式期权 WebSocket API 统一账户
简体中文

更新日志

重要文档通知

Binance 推出了全新的 API 文档门户。现有的 GitHub API 文档 已废弃，并将在用户迁移完成后的几个月内下线(2024-06-17)；具体日期将在适当时候确定并通知。

在此过渡阶段，两者网站将同时维持。然而，任何新服务将只会在新的门户上发布。

下面是当前和新 API 文档的链接的参考表：

功能 当前文档 新文档
现货交易 当前文档 新文档
现货Websocket API 当前文档 新文档
杠杆交易 当前文档 新文档
U本位合约 当前文档 新文档
币本位合约 当前文档 新文档
欧式期权 当前文档 新文档
统一账户 当前文档 新文档
钱包 当前文档 新文档
子母账户 当前文档 新文档
赚币 当前文档 新文档
双币投资 当前文档 新文档
定投 当前文档 新文档
ETH质押 当前文档 新文档
矿池接口 当前文档 新文档
策略交易 当前文档 新文档
跟单交易 当前文档 新文档
统一账户专业版 当前文档 新文档
法币 当前文档 新文档
C2C 当前文档 新文档
VIP借币 当前文档 新文档
质押借币 当前文档 新文档
Pay 当前文档 新文档
闪兑 当前文档 新文档
返佣 当前文档 新文档
NFT 当前文档 新文档
礼品卡 当前文档 新文档

2024-07-24

REST API

WebSocket API

弃用通知： - 以下接口将在未来几个月内弃用（具体日期待定）。请切换到上述新接口： - REST API: - GET /fapi/v2/balance - GET /fapi/v2/account - GET /fapi/v2/positionRisk - Websocket API: - account.status - account.balance - account.position

2024-06-19

2024-05-28

2024-05-24

2024-04-19

{
    "listenKey": "3HBntNTepshgEdjIwSUIBgB9keLyOCg5qv3n6bYAtktG8ejcaW5HXz9Vx1JgIieg"
}

2024-04-09

2024-04-01

WEBSOCKET API

2024-03-11

REST

2024-02-09

币安合约在进行Websocket服务升级，升级影响以下逻辑：

2024-01-24

测试网WEBSOCKET

2024-01-08

REST

2023-12-12

WEBSOCKET

2023-11-15

REST

WEBSOCKET

2023-11-01

REST

2023-10-19

REST

2023-10-16

REST

2023-10-11

REST

2023-09-25

REST

2023-09-20

REST

2023-09-19

{
    "code": -1008,
    "msg": "Server is currently overloaded with other requests. Please try again in a few minutes."
}

2023-09-05

2023-08-31

币安合约在进行Websocket服务升级，升级影响以下逻辑：

2023-08-29

2023-08-19

2023-08-14

2023-07-18

REST

2023-07-04

REST

2023-06-28

注意:

REST

2023-06-22

注意:

WEBSOCKET

2023-06-16

注意：

2023-06-14

注意:

2023-05-31

WEBSOCKET

2023-05-24

REST

2023-05-05

REST

WEBSOCKET

2023-04-17

发布日期 2023-04-18

recvWindow 校验也将在订单到达撮合后进行。recvWindow 校验在下单相关接口更加精确。

{
    "code": -5028,
    "msg": "Timestamp for this request is outside of the ME recvWindow"
}

发布前recvWindow逻辑：

发布后recvWindow逻辑：

2023-03-28

发布前推荐返佣逻辑：

{
  "e": "ACCOUNT_UPDATE",
  "T": 1679974782150,
  "E": 1679974782155,
  "a": {
    "B": [
      {
       "a": "USDT",
       "wb": "685.31478079",
       "cw": "677.17212454",
       "bc": "0.00258637"
      }
    ],
    "P": [],
    "m": "ADMIN_DEPOSIT"
  }
}

发布后推荐返佣逻辑：

2023-03-08

发布日期 2023-03-22

发布前订单逻辑：

{
    "code": -5021,
    "msg": "Due to the order could not be filled immediately, the FOK order has been rejected. The order will not be recorded in the order history"
}

发布后订单逻辑：

{
    "code": -5022,
    "msg": "Due to the order could not be executed as maker, the Post Only order will be rejected. The order will not be recorded in the order history"
}

2023-01-04

WEBSOCKET

2022-12-16

WEBSOCKET

2022-11-29

WEB SOCKET USER DATA STREAM

2022-10-13

注意: 此变动会在 2022-10-17 生效

REST RATE LIMIT WEIGHT

接口 GET /fapi/v1/ticker/bookTicker

权重更新:

2022-09-22

2022-07-27

REST RATE LIMIT WEIGHT

2022-06-28

REST

2022-04-08

WEBSOCKET

2022-03-01

REST

2022-02-10

REST

2021-12-30

WEBSOCKET

2021-11-02

REST

2021-07-06

REST

2021-06-15

WEBSOCKET

REST

2021-05-06

WEBSOCKET

REST

2021-04-27

WEBSOCKET

REST

2021-04-22

WEBSOCKET

2021-03-02

2021-02-24

REST RATE LIMIT WEIGHT

2021-02-22

REST RATE LIMIT WEIGHT

REST

2021-01-26

WEB SOCKET USER DATA STREAM

REST RATE LIMIT WEIGHT

REST

2021-01-21

合约订单用户自定义idnewClientOrderId更新正则规则为: ^[\.A-Z\:/a-z0-9_-]{1,36}$

2021-01-04

REST

2020-12-08

WEBSOCKET

REST API

ENUM

2020-11-27

2020-11-13

WEB SOCKET STREAM

2020-11-10

2020-11-09

WEB SOCKET USER DATA STREAM

USER-DATA-STREAM 中的事件ACCOUNT_UPDATE推送规则作出了以下更新和优化：

2020-10-27

WEB SOCKET STREAM

2020-10-10

WEBSOCKET

2020-10-09

2020-09-18

2020-09-16

WEBSOCKET

2020-09-09

2020-08-14

2020-08-12

2020-07-30

2020-07-17

2020-07-02

WEBSOCKET

2020-06-15

2020-06-04

2020-06-02

2020-05-18

2020-05-18

2020-05-15

2020-05-14

2020-05-11

2020-05-06

REST 接口

WEBSOCKET 账户信息推送

2020-04-25

2020-04-17

2020-04-14

WEB SOCKET 连接限制

2020-04-09

2020-04-08

2020-04-06

2020-03-30

2020-02-26

2020-02-20

2020-02-17

2020-02-12

2020-02-05

2020-01-19

2020-1-17

2020-1-6

2020-1-3

2019-12-19

2019-12-18

2019-12-12

2019-11-29

2019-11-25

2019-11-15

2019-11-12

2019-11-05

2019-10-28

2019-10-25

2019-10-24

2019-10-18

2019-10-14

2019-10-11

2019-10-08

2019-09-20

基本信息

SDK和代码示例

免责声明:

Python3

SDK: 可以通过以下方式获取Binance Futures Connector SDK：

Java

可以通过以下方式获取SDK：
* 访问 https://github.com/binance/binance-futures-connector-java,

Rest 基本信息

testnet

HTTP 返回代码

接口错误代码

异常响应格式如下：

{
  "code": -1121,
  "msg": "Invalid symbol."
}

接口的基本信息

访问限制

IP 访问限制

下单频率限制

接口鉴权类型

鉴权类型 描述
NONE 不需要鉴权的接口
TRADE 需要有效的API-KEY和签名
USER_DATA 需要有效的API-KEY和签名
USER_STREAM 需要有效的API-KEY
MARKET_DATA 需要有效的API-KEY

需要签名的接口 (TRADE 与 USER_DATA)

时间同步安全

逻辑伪代码：

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

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

POST /fapi/v1/order 的示例 - HMAC Keys

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

Key Value
apiKey dbefbc809e3e83c283a984c3a1459732ea7db1360ca80c5c2c8867408d28cc83
secretKey 2b5eb11e18796d12d88f13dc27dbbd02c2cc51ff7059765ed9821957d82bb4d9
参数 取值
symbol BTCUSDT
side BUY
type LIMIT
timeInForce GTC
quantity 1
price 9000
recvWindow 5000
timestamp 1591702613943

示例 1: 所有参数通过 query string 发送

示例1:

HMAC SHA256 签名:

    $ echo -n "symbol=BTCUSDT&side=BUY&type=LIMIT&quantity=1&price=9000&timeInForce=GTC&recvWindow=5000&timestamp=1591702613943" | openssl dgst -sha256 -hmac "2b5eb11e18796d12d88f13dc27dbbd02c2cc51ff7059765ed9821957d82bb4d9"
    (stdin)= 3c661234138461fcc7a7d8746c6558c9842d4e10870d2ecbedf7777cad694af9

curl 调用:


    $ curl -H "X-MBX-APIKEY: dbefbc809e3e83c283a984c3a1459732ea7db1360ca80c5c2c8867408d28cc83" -X POST 'https://fapi.binance.com/fapi/v1/order?symbol=BTCUSDT&side=BUY&type=LIMIT&quantity=1&price=9000&timeInForce=GTC&recvWindow=5000&timestamp=1591702613943&signature= 3c661234138461fcc7a7d8746c6558c9842d4e10870d2ecbedf7777cad694af9'

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

示例2:

HMAC SHA256 签名:

    $ echo -n "symbol=BTCUSDT&side=BUY&type=LIMIT&quantity=1&price=9000&timeInForce=GTC&recvWindow=5000&timestamp=1591702613943" | openssl dgst -sha256 -hmac "2b5eb11e18796d12d88f13dc27dbbd02c2cc51ff7059765ed9821957d82bb4d9"
    (stdin)= 3c661234138461fcc7a7d8746c6558c9842d4e10870d2ecbedf7777cad694af9

curl 调用:


    $ curl -H "X-MBX-APIKEY: dbefbc809e3e83c283a984c3a1459732ea7db1360ca80c5c2c8867408d28cc83" -X POST 'https://fapi.binance.com/fapi/v1/order' -d 'symbol=BTCUSDT&side=BUY&type=LIMIT&quantity=1&price=9000&timeInForce=GTC&recvWindow=5000&timestamp=1591702613943&signature= 3c661234138461fcc7a7d8746c6558c9842d4e10870d2ecbedf7777cad694af9'

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

示例3:

HMAC SHA256 签名:

    $ echo -n "symbol=BTCUSDT&side=BUY&type=LIMIT&timeInForce=GTCquantity=1&price=9000&recvWindow=5000&timestamp= 1591702613943" | openssl dgst -sha256 -hmac "2b5eb11e18796d12d88f13dc27dbbd02c2cc51ff7059765ed9821957d82bb4d9"
    (stdin)= f9d0ae5e813ef6ccf15c2b5a434047a0181cb5a342b903b367ca6d27a66e36f2

curl 调用:


    $ curl -H "X-MBX-APIKEY: dbefbc809e3e83c283a984c3a1459732ea7db1360ca80c5c2c8867408d28cc83" -X POST 'https://fapi.binance.com/fapi/v1/order?symbol=BTCUSDT&side=BUY&type=LIMIT&timeInForce=GTC' -d 'quantity=1&price=9000&recvWindow=5000&timestamp=1591702613943&signature=f9d0ae5e813ef6ccf15c2b5a434047a0181cb5a342b903b367ca6d27a66e36f2'

请注意，示例3中的签名有些许不同，在"GTC"和"quantity=1"之间没有"&"字符。

POST /fapi/v1/order 的示例 - RSA Keys

对于这个例子，Private Key 将被引用为test-prv-key.pem。

Key Value
apiKey vE3BDAL1gP1UaexugRLtteaAHg3UO8Nza20uexEuW1Kh3tVwQfFHdAiyjjY428o2
参数 取值
symbol BTCUSDT
side SELL
type MARKET
quantity 1.23
recvWindow 9999999
timestamp 1671090801999

有列出参数的签名 payload：

timestamp=1671090801999&recvWindow=9999999&symbol=BTCUSDT&side=SELL&type=MARKET&quantity=1.23

第1步: Payload

将参数列表排列成一个 string。 用 & 分隔每个参数。对于上述参数，签名 payload 如右所示。

第2步: 计算签名

2.1 - 将签名有效负载编码为 ASCII 数据。

第2.2步

 $ echo -n 'timestamp=1671090801999&recvWindow=9999999&symbol=BTCUSDT&side=SELL&type=MARKET&quantity=1.23' | openssl dgst -keyform PEM -sha256 -sign ./test-prv-key.pem

2.2 - 使用带有 SHA-256 hash 函数的 RSASSA-PKCS1-v1_5 算法对 payload 进行签名。

第2.3步

$ echo -n 'timestamp=1671090801999&recvWindow=9999999&symbol=BTCUSDT&side=SELL&type=MARKET&quantity=1.23' | openssl dgst -keyform PEM -sha256 -sign ./test-prv-key.pem | openssl enc -base64
aap36wD5loVXizxvvPI3wz9Cjqwmb3KVbxoym0XeWG1jZq8umqrnSk8H8dkLQeySjgVY91Ufs%2BBGCW%2B4sZjQEpgAfjM76riNxjlD3coGGEsPsT2lG39R%2F1q72zpDs8pYcQ4A692NgHO1zXcgScTGgdkjp%2Brp2bcddKjyz5XBrBM%3D

2.3 - 将输出编码为 base64 string。

第2.4步

$  echo -n 'timestamp=1671090801999&recvWindow=9999999&symbol=BTCUSDT&side=SELL&type=MARKET&quantity=1.23' | openssl dgst -keyform PEM -sha256 -sign ./test-prv-key.pem | openssl enc -base64 | tr -d '\n'
aap36wD5loVXizxvvPI3wz9Cjqwmb3KVbxoym0XeWG1jZq8umqrnSk8H8dkLQeySjgVY91Ufs%2BBGCW%2B4sZjQEpgAfjM76riNxjlD3coGGEsPsT2lG39R%2F1q72zpDs8pYcQ4A692NgHO1zXcgScTGgdkjp%2Brp2bcddKjyz5XBrBM%3D

2.4 - 删除签名中的所有 \n。

第2.5步

aap36wD5loVXizxvvPI3wz9Cjqwmb3KVbxoym0XeWG1jZq8umqrnSk8H8dkLQeySjgVY91Ufs%2BBGCW%2B4sZjQEpgAfjM76riNxjlD3coGGEsPsT2lG39R%2F1q72zpDs8pYcQ4A692NgHO1zXcgScTGgdkjp%2Brp2bcddKjyz5XBrBM%3D

2.5 - 由于签名可能包含 / 和 =，这可能会导致发送请求时出现问题。 所以签名必须是 URL 编码的。

第2.6步

 curl -H "X-MBX-APIKEY: vE3BDAL1gP1UaexugRLtteaAHg3UO8Nza20uexEuW1Kh3tVwQfFHdAiyjjY428o2" -X POST 'https://fapi.binance.com/fapi/v1/order?timestamp=1671090801999&recvWindow=9999999&symbol=BTCUSDT&side=SELL&type=MARKET&quantity=1.23&signature=aap36wD5loVXizxvvPI3wz9Cjqwmb3KVbxoym0XeWG1jZq8umqrnSk8H8dkLQeySjgVY91Ufs%2BBGCW%2B4sZjQEpgAfjM76riNxjlD3coGGEsPsT2lG39R%2F1q72zpDs8pYcQ4A692NgHO1zXcgScTGgdkjp%2Brp2bcddKjyz5XBrBM%3D'

2.6 - curl 命令

Bash 脚本

#!/usr/bin/env bash
# 设置身份验证：
apiKey="vE3BDAL1gP1UaexugRLtteaAHg3UO8Nza20uexEuW1Kh3tVwQfFHdAiyjjY428o2"   ### 替换成您的 API Key
# 设置您的请求:
apiMethod="POST"
apiCall="v1/order"
apiParams="timestamp=1671090801999&recvWindow=9999999&symbol=BTCUSDT&side=SELL&type=MARKET&quantity=1.23"
function rawurlencode {
    local value="$1"
    local len=${#value}
    local encoded=""
    local pos c o
    for (( pos=0 ; pos<len ; pos++ ))
    do
        c=${value:$pos:1}
        case "$c" in
            [-_.~a-zA-Z0-9] ) o="${c}" ;;
            * )   printf -v o '%%%02x' "'$c"
        esac
        encoded+="$o"
    done
    echo "$encoded"
}
ts=$(date +%s000)
paramsWithTs="$apiParams&timestamp=$ts"
rawSignature=$(echo -n "$paramsWithTs" \
               | openssl dgst -keyform PEM -sha256 -sign ./test-prv-key.pem \  ### 替换成您的 Private Key。不要与任何人共享此文件。
               | openssl enc -base64 \
               | tr -d '\n')
signature=$(rawurlencode "$rawSignature")
curl -H "X-MBX-APIKEY: $apiKey" -X $apiMethod \
    "https://fapi.binance.com/fapi/$apiCall?$paramsWithTs&signature=$signature"

右边有示例 Bash 脚本执行上述类似的步骤.

公开API参数

术语解释

枚举定义

交易对类型:

合约类型 (contractType):

合约状态 (contractStatus, status):

订单状态 (status):

订单种类 (orderTypes, type):

订单方向 (side):

持仓方向:

有效方式 (timeInForce):

条件价格触发类型 (workingType)

响应类型 (newOrderRespType)

K线间隔:

m -> 分钟; h -> 小时; d -> 天; w -> 周; M -> 月

防止自成交模式:

盘口价下单模式:

限制种类 (rateLimitType)

REQUEST_WEIGHT

  {
    "rateLimitType": "REQUEST_WEIGHT",
    "interval": "MINUTE",
    "intervalNum": 1,
    "limit": 2400
  }

ORDERS

  {
    "rateLimitType": "ORDERS",
    "interval": "MINUTE",
    "intervalNum": 1,
    "limit": 1200
   }

限制间隔

过滤器

过滤器，即Filter，定义了一系列交易规则。 共有两类，分别是针对交易对的过滤器symbol filters，和针对整个交易所的过滤器exchange filters(暂不支持)

交易对过滤器

PRICE_FILTER 价格过滤器

/exchangeInfo 响应中的格式:

  {
    "filterType": "PRICE_FILTER",
    "minPrice": "0.00000100",
    "maxPrice": "100000.00000000",
    "tickSize": "0.00000100"
  }

价格过滤器用于检测order订单中price参数的合法性

逻辑伪代码如下：

LOT_SIZE 订单尺寸

/exchangeInfo 响应中的格式:*

  {
    "filterType": "LOT_SIZE",
    "minQty": "0.00100000",
    "maxQty": "100000.00000000",
    "stepSize": "0.00100000"
  }

lots是拍卖术语，这个过滤器对订单中的quantity也就是数量参数进行合法性检查。包含三个部分：

逻辑伪代码如下：

MARKET_LOT_SIZE 市价订单尺寸

参考LOT_SIZE，区别仅在于对市价单还是限价单生效

MAX_NUM_ORDERS 最多订单数

/exchangeInfo 响应中的格式:

  {
    "filterType": "MAX_NUM_ORDERS",
    "limit": 200
  }

定义了某个交易对最多允许的挂单数量(不包括已关闭的订单)

普通订单与条件订单均计算在内

MAX_NUM_ALGO_ORDERS 最多条件订单数

/exchangeInfo format:

  {
    "filterType": "MAX_NUM_ALGO_ORDERS",
    "limit": 100
  }

定义了某个交易对最多允许的条件订单的挂单数量(不包括已关闭的订单)。

条件订单目前包括STOP, STOP_MARKET, TAKE_PROFIT, TAKE_PROFIT_MARKET, 和 TRAILING_STOP_MARKET

PERCENT_PRICE 价格振幅过滤器

/exchangeInfo 响应中的格式:

  {
    "filterType": "PERCENT_PRICE",
    "multiplierUp": "1.1500",
    "multiplierDown": "0.8500",
    "multiplierDecimal": 4
  }

PERCENT_PRICE 定义了基于标记价格计算的挂单价格的可接受区间.

挂单价格必须同时满足以下条件：

MIN_NOTIONAL 最小名义价值

/exchangeInfo 响应中的格式:

  {
    "filterType": "MIN_NOTIONAL",
    "notioanl": "5.0"
  }

MIN_NOTIONAL过滤器定义了交易对订单所允许的最小名义价值(成交额)。 订单的名义价值是价格*数量。 由于MARKET订单没有价格，因此会使用 mark price 计算。

Postman Collections

现在你可以通过Postman collection来快速体验、使用API接口。

如果想了解更多如果使用Postman，请访问Binance API Postman

WebSocket API基本信息

请求示例:

{
  "id": "9ca10e58-7452-467e-9454-f669bb9c764e",
  "method": "order.place",
  "params": {
    "apiKey": "yeqKcXjtA9Eu4Tr3nJk61UJAGzXsEmFqqfVterxpMpR4peNfqE7Zl7oans8Qj089",
    "price": "42088.0",
    "quantity": "0.1",
    "recvWindow": 5000,
    "side": "BUY",
    "signature": "996962a19802b5a09d7bc6ab1524227894533322a2f8a1f8934991689cabf8fe",
    "symbol": "BTCUSDT",
    "timeInForce": "GTC",
    "timestamp": 1705311512994,
    "type": "LIMIT"
  }
}

请求字段:

名称 类型 是否必需 描述
id INT / STRING / null YES 任意的 ID 用于匹配对请求的响应
method STRING YES 请求函数名称
params OBJECT NO 请求参数。如果没有参数可以省略

可以在一个会话中自由重复使用 ID，不过请注意不要一次发送多个具有相同 ID 的请求，因为否则可能无法区分响应。

WebSocket API响应格式

响应在 text 帧 中以 JSON 格式返回，每帧一个响应。

成功响应示例:

{
  "id": "43a3843a-2321-4e45-8f79-351e5c354563",
  "status": 200,
  "result": {
    "orderId": 336829446,
    "symbol": "BTCUSDT",
    "status": "NEW",
    "clientOrderId": "FqEw6cn0vDhrkmfiwLYPeo",
    "price": "42088.00",
    "avgPrice": "0.00",
    "origQty": "0.100",
    "executedQty": "0.000",
    "cumQty": "0.000",
    "cumQuote": "0.00000",
    "timeInForce": "GTC",
    "type": "LIMIT",
    "reduceOnly": false,
    "closePosition": false,
    "side": "BUY",
    "positionSide": "BOTH",
    "stopPrice": "0.00",
    "workingType": "CONTRACT_PRICE",
    "priceProtect": false,
    "origType": "LIMIT",
    "priceMatch": "NONE",
    "selfTradePreventionMode": "NONE",
    "goodTillDate": 0,
    "updateTime": 1705385954229
  },
  "rateLimits": [
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 2400,
      "count": 1
    },
    {
      "rateLimitType": "ORDERS",
      "interval": "SECOND",
      "intervalNum": 10,
      "limit": 300,
      "count": 1
    },
    {
      "rateLimitType": "ORDERS",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 1200,
      "count": 0
    }
  ]
}

失败响应示例:

{
  "id": "5761b939-27b1-4948-ab87-4a372a3f6b72",
  "status": 400,
  "error": {
    "code": -1102,
    "msg": "Mandatory parameter 'quantity' was not sent, was empty/null, or malformed."
  },
  "rateLimits": [
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 2400,
      "count": 1
    },
    {
      "rateLimitType": "ORDERS",
      "interval": "SECOND",
      "intervalNum": 10,
      "limit": 300,
      "count": 1
    },
    {
      "rateLimitType": "ORDERS",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 1200,
      "count": 1
    }
  ]
}

响应字段:

名称 类型 是否必需 描述
id INT / STRING / null YES 与原来请求的ID一样
status INT YES 响应状态。请看 状态代码
result OBJECT / ARRAY YES 响应内容。请求成功则显示
error OBJECT 错误描述。请求失败则显示
rateLimits ARRAY NO 速率限制状态。请看 速率限制

WebSocket API访问限制

WebSocket API连接后进行身份验证

你可以使用会话身份验证请求对已经建立的连接进行身份验证：

WebSocket API关于吊销API密钥

如果在活动会话期间，由于 任何 原因（例如IP地址未被加入白名单、API密钥被删除、API密钥没有正确的权限等），在下一个请求后，会话将被吊销，并显示以下错误消息:

{
  "id": null,
  "status": 401,
  "error": {
    "code": -2015,
    "msg": "Invalid API-key, IP, or permissions for action." 
  }
}

WebSocket API授权 临时 请求

WebSocket连接只能通过一个API密钥进行身份验证。 默认情况下，经过身份验证的API密钥将用于需要apiKey参数的请求。 但是，你始终可以为单个请求明确指定apiKey和signature，覆盖已认证的API密钥，以使用不同的API密钥授权特定请求。

例如，你可能希望用默认密钥来验证 USER_DATA，但在下单时使用TRADE密钥来签名。

WebSocket API身份验证请求

注意： 仅支持 Ed25519 密钥用于此功能。

用API key登录 (SIGNED)

请求

{
  "id": "c174a2b1-3f51-4580-b200-8528bd237cb7",
  "method": "session.logon",
  "params": {
    "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
    "signature": "1cf54395b336b0a9727ef27d5d98987962bc47aca6e13fe978612d0adee066ed",
    "timestamp": 1649729878532
  }
}

响应:

{
  "id": "c174a2b1-3f51-4580-b200-8528bd237cb7",
  "status": 200,
  "result": {
    "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
    "authorizedSince": 1649729878532,
    "connectedSince": 1649729873021,
    "returnRateLimits": false,
    "serverTime": 1649729878630
  }
}

使用提供的API密钥进行WebSocket连接身份验证。

在调用session.logon后，将来的需要apiKey和signature参数的请求可以省略它们。

请注意，只能认证一个API密钥。 多次调用session.logon将更改当前已认证的API密钥。

权重: 2

参数:

参数名 类型 是否必需 描述
apiKey STRING YES
recvWindow INT NO The value cannot be greater than 60000
signature STRING YES
timestamp INT YES

数据源: 缓存

查询会话状态

请求

{
  "id": "b50c16cd-62c9-4e29-89e4-37f10111f5bf",
  "method": "session.status"
}

响应:

{
  "id": "b50c16cd-62c9-4e29-89e4-37f10111f5bf",
  "status": 200,
  "result": {
    // 如果连接未经身份验证，"apiKey" 和 "authorizedSince" 将显示为 null。
    "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
    "authorizedSince": 1649729878532,
    "connectedSince": 1649729873021,
    "returnRateLimits": false,
    "serverTime": 1649730611671
  }
}

查询WebSocket连接的状态，检查用于授权请求的API密钥（如果有的话）。

权重: 2

参数: NONE

数据源: 缓存

退出会话

请求

{
  "id": "c174a2b1-3f51-4580-b200-8528bd237cb7",
  "method": "session.logout"
}

响应:

{
  "id": "c174a2b1-3f51-4580-b200-8528bd237cb7",
  "status": 200,
  "result": {
    "apiKey": null,
    "authorizedSince": null,
    "connectedSince": 1649729873021,
    "returnRateLimits": false,
    "serverTime": 1649730611671
  }
}

忘记之前认证的API密钥。 如果连接未经身份验证，此请求不会有任何作用。

请注意，session.logout请求后，WebSocket连接仍然保持打开状态。 你可以继续使用连接，但现在必须在需要的地方明确提供apiKey和signature参数。

权重: 2

参数: NONE

数据源: 缓存

SIGNED (TRADE and USER_DATA) 请求安全

SIGNED 请求示例 (Ed25519)

参数 取值
symbol BTCUSDT
side SELL
type LIMIT
timeInForce GTC
quantity 1
price 0.2
timestamp 1668481559918 
#!/usr/bin/env python3
import base64
import time
import json
from cryptography.hazmat.primitives.serialization import load_pem_private_key
from websocket import create_connection
# 设置身份验证：
API_KEY='替换成您的 API Key'
PRIVATE_KEY_PATH='test-prv-key.pem'
# 加载 private key。
# 在这个例子中，private key 没有加密，但我们建议使用强密码以提高安全性。
with open(PRIVATE_KEY_PATH, 'rb') as f:
    private_key = load_pem_private_key(data=f.read(), password=None)
# 设置请求参数：
params = {
    'apiKey':        API_KEY,   
    'symbol':       'BTCUSDT',
    'side':         'SELL',
    'type':         'LIMIT',
    'timeInForce':  'GTC',
    'quantity':     '1.0000000',
    'price':        '0.20'
}
# 参数中加时间戳：
timestamp = int(time.time() * 1000) # 以毫秒为单位的 UNIX 时间戳
params['timestamp'] = timestamp
# 参数中加签名：
payload = '&'.join([f'{param}={value}' for param, value in sorted(params.items())])
signature = base64.b64encode(private_key.sign(payload.encode('ASCII')))
params['signature'] = signature.decode('ASCII')
# 发送请求：
request = { 
    'id': 'my_new_order',   
    'method': 'order.place',    
    'params': params
}
ws = create_connection('wss://ws-fapi.binance.com/ws-fapi/v1')  
ws.send(json.dumps(request))    
result =  ws.recv() 
ws.close()  
print(result)

右边有 Python 脚本来示例如何使用 Ed25519 key 签名。

行情接口

测试服务器连通性 PING

GET /fapi/v1/ping

响应:

{}

测试能否联通

权重: 1

参数: NONE

获取服务器时间

响应:

{
  "serverTime": 1499827319559 // 当前的系统时间
}

GET /fapi/v1/time

获取服务器时间

权重: 1

参数: NONE

获取交易规则和交易对

响应:

{
    "exchangeFilters": [],
    "rateLimits": [ // API访问的限制
        {
            "interval": "MINUTE", // 按照分钟计算
            "intervalNum": 1, // 按照1分钟计算
            "limit": 2400, // 上限次数
            "rateLimitType": "REQUEST_WEIGHT" // 按照访问权重来计算
        },
        {
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 1200,
            "rateLimitType": "ORDERS" // 按照订单数量来计算
        }
    ],
    "serverTime": 1565613908500, // 请忽略。如果需要获取当前系统时间，请查询接口 “GET /fapi/v1/time”
    "assets": [ // 资产信息
        {
            "asset": "BUSD",
            "marginAvailable": true, // 是否可用作保证金
            "autoAssetExchange": 0 // 仅对vip 2-9用户生效
        },
        {
            "asset": "USDT",
            "marginAvailable": true, // 是否可用作保证金
            "autoAssetExchange": 0 // 仅对vip 2-9用户生效
        },
        {
            "asset": "BNB",
            "marginAvailable": false, // 是否可用作保证金
            "autoAssetExchange": null // 仅对vip 2-9用户生效
        }
    ],
    "symbols": [ // 交易对信息
        {
            "symbol": "BLZUSDT",  // 交易对
            "pair": "BLZUSDT",  // 标的交易对
            "contractType": "PERPETUAL",    // 合约类型
            "deliveryDate": 4133404800000,  // 交割日期
            "onboardDate": 1598252400000,     // 上线日期
            "status": "TRADING",  // 交易对状态
            "maintMarginPercent": "2.5000",  // 请忽略
            "requiredMarginPercent": "5.0000", // 请忽略
            "baseAsset": "BLZ",  // 标的资产
            "quoteAsset": "USDT", // 报价资产
            "marginAsset": "USDT", // 保证金资产
            "pricePrecision": 5,  // 价格小数点位数(仅作为系统精度使用，注意同tickSize 区分）
            "quantityPrecision": 0,  // 数量小数点位数(仅作为系统精度使用，注意同stepSize 区分）
            "baseAssetPrecision": 8,  // 标的资产精度
            "quotePrecision": 8,  // 报价资产精度
            "underlyingType": "COIN",
            "underlyingSubType": ["STORAGE"],
            "settlePlan": 0,
            "triggerProtect": "0.15", // 开启"priceProtect"的条件订单的触发阈值
            "filters": [
                {
                    "filterType": "PRICE_FILTER", // 价格限制
                    "maxPrice": "300", // 价格上限, 最大价格
                    "minPrice": "0.0001", // 价格下限, 最小价格
                    "tickSize": "0.0001" // 订单最小价格间隔
                },
                {
                    "filterType": "LOT_SIZE", // 数量限制
                    "maxQty": "10000000", // 数量上限, 最大数量
                    "minQty": "1", // 数量下限, 最小数量
                    "stepSize": "1" // 订单最小数量间隔
                },
                {
                    "filterType": "MARKET_LOT_SIZE", // 市价订单数量限制
                    "maxQty": "590119", // 数量上限, 最大数量
                    "minQty": "1", // 数量下限, 最小数量
                    "stepSize": "1" // 允许的步进值
                },
                {
                    "filterType": "MAX_NUM_ORDERS", // 最多订单数限制
                    "limit": 200
                },
                {
                    "filterType": "MAX_NUM_ALGO_ORDERS", // 最多条件订单数限制
                    "limit": 100
                },
                {
                    "filterType": "MIN_NOTIONAL",  // 最小名义价值
                    "notional": "5.0", 
                },
                {
                    "filterType": "PERCENT_PRICE", // 价格比限制
                    "multiplierUp": "1.1500", // 价格上限百分比
                    "multiplierDown": "0.8500", // 价格下限百分比
                    "multiplierDecimal": 4
                }
            ],
            "OrderType": [ // 订单类型
                "LIMIT",  // 限价单
                "MARKET",  // 市价单
                "STOP", // 止损单
                "STOP_MARKET", // 止损市价单
                "TAKE_PROFIT", // 止盈单
                "TAKE_PROFIT_MARKET", // 止盈暑市价单
                "TRAILING_STOP_MARKET" // 跟踪止损市价单
            ],
            "timeInForce": [ // 有效方式
                "GTC", // 成交为止, 一直有效
                "IOC", // 无法立即成交(吃单)的部分就撤销
                "FOK", // 无法全部立即成交就撤销
                "GTX" // 无法成为挂单方就撤销
            ],
            "liquidationFee": "0.010000",   // 强平费率
            "marketTakeBound": "0.30",  // 市价吃单(相对于标记价格)允许可造成的最大价格偏离比例
        }
    ],
    "timezone": "UTC" // 服务器所用的时间区域
}

GET /fapi/v1/exchangeInfo

获取交易规则和交易对

权重: 1

参数: NONE

深度信息

响应:

{
  "lastUpdateId": 1027024,
  "E": 1589436922972,   // 消息时间
  "T": 1589436922959,   // 撮合引擎时间
  "bids": [             // 买单
    [
      "4.00000000",     // 价格
      "431.00000000"    // 数量
    ]
  ],
  "asks": [             // 卖单
    [
      "4.00000200",     // 价格
      "12.00000000"     // 数量
    ]
  ]
}

GET /fapi/v1/depth

权重:

limit 权重
5, 10, 20, 50 2
100 5
500 10
1000 20

更新速率: 15ms

参数:

名称 类型 是否必需 描述
symbol STRING YES 交易对
limit INT NO 默认 500; 可选值:[5, 10, 20, 50, 100, 500, 1000]

近期成交

响应:

[
  {
    "id": 28457,                // 成交ID
    "price": "4.00000100",      // 成交价格
    "qty": "12.00000000",       // 成交量
    "quoteQty": "48.00",        // 成交额
    "time": 1499865549590,      // 时间
    "isBuyerMaker": true        // 买方是否为挂单方
  }
]

GET /fapi/v1/trades

获取近期订单簿成交

权重: 5

参数:

名称 类型 是否必需 描述
symbol STRING YES 交易对
limit INT NO 默认:500，最大1000

查询历史成交(MARKET_DATA)

响应:

[
  {
    "id": 28457,                // 成交ID
    "price": "4.00000100",      // 成交价格
    "qty": "12.00000000",       // 成交量
    "quoteQty": "48.00",        // 成交额
    "time": 1499865549590,      // 时间
    "isBuyerMaker": true        // 买方是否为挂单方
  }
]

GET /fapi/v1/historicalTrades

查询订单簿历史成交

权重: 20

参数:

名称 类型 是否必需 描述
symbol STRING YES 交易对
limit INT NO 默认值:500 最大值:1000.
fromId LONG NO 从哪一条成交id开始返回. 缺省返回最近的成交记录

近期成交(归集)

响应:

[
  {
    "a": 26129,         // 归集成交ID
    "p": "0.01633102",  // 成交价
    "q": "4.70443515",  // 成交量
    "f": 27781,         // 被归集的首个成交ID
    "l": 27781,         // 被归集的末个成交ID
    "T": 1498793709153, // 成交时间
    "m": true,          // 是否为主动卖出单
  }
]

GET /fapi/v1/aggTrades

归集交易与逐笔交易的区别在于，同一价格、同一方向、同一时间(100ms计算)的订单簿trade会被聚合为一条

权重: 20

参数:

名称 类型 是否必需 描述
symbol STRING YES 交易对
fromId LONG NO 从包含fromID的成交开始返回结果
startTime LONG NO 从该时刻之后的成交记录开始返回结果
endTime LONG NO 返回该时刻为止的成交记录
limit INT NO 默认 500; 最大 1000.

K线数据

响应:

[
  [
    1499040000000,      // 开盘时间
    "0.01634790",       // 开盘价
    "0.80000000",       // 最高价
    "0.01575800",       // 最低价
    "0.01577100",       // 收盘价(当前K线未结束的即为最新价)
    "148976.11427815",  // 成交量
    1499644799999,      // 收盘时间
    "2434.19055334",    // 成交额
    308,                // 成交笔数
    "1756.87402397",    // 主动买入成交量
    "28.46694368",      // 主动买入成交额
    "17928899.62484339" // 请忽略该参数
  ]
]

GET /fapi/v1/klines

每根K线的开盘时间可视为唯一ID

权重: 取决于请求中的LIMIT参数

LIMIT参数 权重
[1,100) 1
[100, 500) 2
[500, 1000] 5
> 1000 10

参数:

名称 类型 是否必需 描述
symbol STRING YES 交易对
interval ENUM YES 时间间隔
startTime LONG NO 起始时间
endTime LONG NO 结束时间
limit INT NO 默认值:500 最大值:1500.

连续合约K线数据

响应:

[
  [
    1607444700000,      // 开盘时间
    "18879.99",         // 开盘价
    "18900.00",         // 最高价
    "18878.98",         // 最低价
    "18896.13",         // 收盘价(当前K线未结束的即为最新价)
    "492.363",          // 成交量
    1607444759999,      // 收盘时间
    "9302145.66080",    // 成交额
    1874,               // 成交笔数
    "385.983",          // 主动买入成交量
    "7292402.33267",    // 主动买入成交额
    "0"                 // 请忽略该参数
  ]
]

GET /fapi/v1/continuousKlines 每根K线的开盘时间可视为唯一ID

权重: 取决于请求中的LIMIT参数

LIMIT参数 权重
[1,100) 1
[100, 500) 2
[500, 1000] 5
> 1000 10

参数:

名称 类型 是否必需 描述
pair STRING YES 标的交易对
contractType ENUM YES 合约类型
interval ENUM YES 时间间隔
startTime LONG NO 起始时间
endTime LONG NO 结束时间
limit INT NO 默认值:500 最大值:1500

价格指数K线数据

响应:

[
  [
    1591256400000,          // 开盘时间
    "9653.69440000",        // 开盘价
    "9653.69640000",        // 最高价
    "9651.38600000",        // 最低价
    "9651.55200000",        // 收盘价(当前K线未结束的即为最新价)
    "0  ",                  // 请忽略
    1591256459999,          // 收盘时间
    "0",                    // 请忽略
    60,                     // 请忽略
    "0",                    // 请忽略
    "0",                    // 请忽略
    "0"                     // 请忽略
  ]
]

GET /fapi/v1/indexPriceKlines

每根K线的开盘时间可视为唯一ID

权重: 取决于请求中的LIMIT参数

LIMIT参数 权重
[1,100) 1
[100, 500) 2
[500, 1000] 5
> 1000 10

参数:

名称 类型 是否必需 描述
pair STRING YES 标的交易对
interval ENUM YES 时间间隔
startTime LONG NO 起始时间
endTime LONG NO 结束时间
limit INT NO 默认值:500 最大值:1500

标记价格K线数据

响应:

[
  [
    1591256400000,          // 开盘时间
    "9653.69440000",        // 开盘价
    "9653.69640000",        // 最高价
    "9651.38600000",        // 最低价
    "9651.55200000",        // 收盘价(当前K线未结束的即为最新价)
    "0  ",                  // 请忽略
    1591256459999,          // 收盘时间
    "0",                    // 请忽略
    60,                     // 请忽略
    "0",                    // 请忽略
    "0",                    // 请忽略
    "0"                     // 请忽略
  ]
]

GET /fapi/v1/markPriceKlines 每根K线的开盘时间可视为唯一ID

权重: 取决于请求中的LIMIT参数

LIMIT参数 权重
[1,100) 1
[100, 500) 2
[500, 1000] 5
> 1000 10

参数:

名称 类型 是否必需 描述
symbol STRING YES 交易对
interval ENUM YES 时间间隔
startTime LONG NO 起始时间
endTime LONG NO 结束时间
limit INT NO 默认值:500 最大值:1500

溢价指数K线数据

响应:

[
  [
    1691603820000,          // 开盘时间
    "-0.00042931",          // 开盘价
    "-0.00023641",          // 最高价
    "-0.00059406",          // 最低价
    "-0.00043659",          // 收盘价
    "0",                    // 请忽略
    1691603879999,          // 收盘时间
    "0",                    // 请忽略
    12,                     // 请忽略
    "0",                    // 请忽略
    "0",                    // 请忽略
    "0"                     // 请忽略
  ]
]

GET /fapi/v1/premiumIndexKlines

合约溢价指数K线。每根K线的开盘时间可视为唯一ID。

权重: 取决于请求中的LIMIT参数

LIMIT参数 权重
[1,100) 1
[100, 500) 2
[500, 1000] 5
> 1000 10

参数:

名称 类型 是否必需 描述
symbol STRING YES 交易对
interval ENUM YES 时间间隔
startTime LONG NO 起始时间
endTime LONG NO 结束时间
limit INT NO 默认值:500 最大值:1500

最新标记价格和资金费率

响应:

{
    "symbol": "BTCUSDT",                // 交易对
    "markPrice": "11793.63104562",      // 标记价格
    "indexPrice": "11781.80495970",     // 指数价格
    "estimatedSettlePrice": "11781.16138815",  // 预估结算价,仅在交割开始前最后一小时有意义
    "lastFundingRate": "0.00038246",    // 最近更新的资金费率
    "nextFundingTime": 1597392000000,   // 下次资金费时间
    "interestRate": "0.00010000",       // 标的资产基础利率
    "time": 1597370495002               // 更新时间
}

当不指定symbol时相应

[
    {
        "symbol": "BTCUSDT",            // 交易对
        "markPrice": "11793.63104562",  // 标记价格
        "indexPrice": "11781.80495970", // 指数价格
        "estimatedSettlePrice": "11781.16138815",  // 预估结算价,仅在交割开始前最后一小时有意义
        "lastFundingRate": "0.00038246",    // 最近更新的预估资金费率
        "nextFundingTime": 1597392000000,   // 下次资金费时间
        "interestRate": "0.00010000",       // 标的资产基础利率
        "time": 1597370495002               // 更新时间
    }
]

GET /fapi/v1/premiumIndex

采集各大交易所数据加权平均

权重: 带symbol为1；不带symbol为10

参数:

名称 类型 是否必需 描述
symbol STRING NO 交易对

查询资金费率历史

响应:

[   
    {
        "symbol": "BTCUSDT",            // 交易对
        "fundingTime": 1698768000000,   // 资金费时间
        "fundingRate": "0.00010000",    // 资金费率
        "markPrice": "34287.54619963"   // 资金费对应标记价格
    },
    {
        "symbol": "BTCUSDT",
        "fundingTime": 1698796800000,
        "fundingRate": "0.00010000",
        "markPrice": "34651.40000000"
    }
]

GET /fapi/v1/fundingRate

频率限制 和GET /fapi/v1/fundingInfo共享500/5min/IP

参数:

名称 类型 是否必需 描述
symbol STRING NO 交易对
startTime LONG NO 起始时间
endTime LONG NO 结束时间
limit INT NO 默认值:100 最大值:1000

查询资金费率信息

响应:

[
    {
        "symbol": "BLZUSDT",
        "adjustedFundingRateCap": "0.02500000",
        "adjustedFundingRateFloor": "-0.02500000",
        "fundingIntervalHours": 8,
        "disclaimer": false
    }
]

GET /fapi/v1/fundingInfo

频率限制 和GET /fapi/v1/fundingRate共享500/5min/IP

查询资金费率信息，接口仅返回FundingRateCap/FundingRateFloor/fundingIntervalHours被特殊调整过的交易对。

24hr价格变动情况

响应:

{
  "symbol": "BTCUSDT",
  "priceChange": "-94.99999800",    //24小时价格变动
  "priceChangePercent": "-95.960",  //24小时价格变动百分比
  "weightedAvgPrice": "0.29628482", //加权平均价
  "lastPrice": "4.00000200",        //最近一次成交价
  "lastQty": "200.00000000",        //最近一次成交额
  "openPrice": "99.00000000",       //24小时内第一次成交的价格
  "highPrice": "100.00000000",      //24小时最高价
  "lowPrice": "0.10000000",         //24小时最低价
  "volume": "8913.30000000",        //24小时成交量
  "quoteVolume": "15.30000000",     //24小时成交额
  "openTime": 1499783499040,        //24小时内，第一笔交易的发生时间
  "closeTime": 1499869899040,       //24小时内，最后一笔交易的发生时间
  "firstId": 28385,   // 首笔成交id
  "lastId": 28460,    // 末笔成交id
  "count": 76         // 成交笔数
}

或(当不发送交易对信息)

[
    {
        "symbol": "BTCUSDT",
        "priceChange": "-94.99999800",    //24小时价格变动
        "priceChangePercent": "-95.960",  //24小时价格变动百分比
        "weightedAvgPrice": "0.29628482", //加权平均价
        "lastPrice": "4.00000200",        //最近一次成交价
        "lastQty": "200.00000000",        //最近一次成交额
        "openPrice": "99.00000000",       //24小时内第一次成交的价格
        "highPrice": "100.00000000",      //24小时最高价
        "lowPrice": "0.10000000",         //24小时最低价
        "volume": "8913.30000000",        //24小时成交量
        "quoteVolume": "15.30000000",     //24小时成交额
        "openTime": 1499783499040,        //24小时内，第一笔交易的发生时间
        "closeTime": 1499869899040,       //24小时内，最后一笔交易的发生时间
        "firstId": 28385,   // 首笔成交id
        "lastId": 28460,    // 末笔成交id
        "count": 76         // 成交笔数
    }
]

GET /fapi/v1/ticker/24hr

请注意，不携带symbol参数会返回全部交易对数据，不仅数据庞大，而且权重极高

权重: * 带symbol为1 * 不带为40

更新速率: 5s

参数:

名称 类型 是否必需 描述
symbol STRING NO 交易对

最新价格

响应:

{
  "symbol": "LTCBTC",       // 交易对
  "price": "4.00000200",        // 价格
  "time": 1589437530011   // 撮合引擎时间
}

或(当不发送symbol)

[
    {
        "symbol": "BTCUSDT",    // 交易对
        "price": "6000.01",     // 价格
        "time": 1589437530011   // 撮合引擎时间
    }
]

GET /fapi/v1/ticker/price

返回最近价格

权重: * 单交易对1 * 无交易对2

更新速率: 5s

参数:

名称 类型 是否必需 描述
symbol STRING NO 交易对

最新价格V2

响应:

{
  "symbol": "LTCBTC",       // 交易对
  "price": "4.00000200",        // 价格
  "time": 1589437530011   // 撮合引擎时间
}

或(当不发送symbol)

[
    {
        "symbol": "BTCUSDT",    // 交易对
        "price": "6000.01",     // 价格
        "time": 1589437530011   // 撮合引擎时间
    }
]

GET /fapi/v2/ticker/price

返回最近价格

权重: * 单交易对1 * 无交易对2

更新速率: 实时

参数:

名称 类型 是否必需 描述
symbol STRING NO 交易对

当前最优挂单

响应:

{
  "lastUpdateId": 1027024,
  "symbol": "BTCUSDT", // 交易对
  "bidPrice": "4.00000000", //最优买单价
  "bidQty": "431.00000000", //挂单量
  "askPrice": "4.00000200", //最优卖单价
  "askQty": "9.00000000", //挂单量
  "time": 1589437530011   // 撮合引擎时间
}

或(当不发送symbol)

[
    {
        "lastUpdateId": 1027024,
        "symbol": "BTCUSDT", // 交易对
        "bidPrice": "4.00000000", //最优买单价
        "bidQty": "431.00000000", //挂单量
        "askPrice": "4.00000200", //最优卖单价
        "askQty": "9.00000000", //挂单量
        "time": 1589437530011   // 撮合引擎时间
    }
]

GET /fapi/v1/ticker/bookTicker

返回当前最优的挂单(最高买单，最低卖单)

权重: * 单交易对2
* 无交易对5

更新速率: 实时

参数:

名称 类型 是否必需 描述
symbol STRING NO 交易对

获取未平仓合约数

响应:

{
    "openInterest": "10659.509", // 未平仓合约数量
    "symbol": "BTCUSDT",    // 交易对
    "time": 1589437530011   // 撮合引擎时间
}

GET /fapi/v1/openInterest

权重: 1

更新速率: 3s

参数:

名称 类型 是否必需 描述
symbol STRING YES 交易对

季度合约历史结算价

响应:

[
    {
        "deliveryPrice": 27101.10000000,
        "deliveryTime": 1695945600000
    },
    {
        "deliveryPrice": 30729.40000000,
        "deliveryTime": 1688083200000
    },
    {
        "deliveryPrice": 27823.70000000,
        "deliveryTime": 1680220800000
    },
    {
        "deliveryPrice": 44094.70000000,
        "deliveryTime": 1648166400000
    }
]

GET /futures/data/delivery-price

参数:

名称 类型 是否必需 描述
pair STRING YES 如BTCUSDT

合约持仓量

响应:

[
    { 
         "symbol":"BTCUSDT",
          "sumOpenInterest":"20403.12345678",// 持仓总数量
          "sumOpenInterestValue": "176196512.12345678", // 持仓总价值
          "timestamp":"1583127900000"

     },

     {

         "symbol":"BTCUSDT",
         "sumOpenInterest":"20401.36700000",
         "sumOpenInterestValue":"149940752.14464448",
         "timestamp":"1583128200000"

        },   

]

GET /futures/data/openInterestHist

参数:

名称 类型 是否必需 描述
symbol STRING YES
period ENUM YES "5m","15m","30m","1h","2h","4h","6h","12h","1d"
limit LONG NO default 30, max 500
startTime LONG NO
endTime LONG NO

大户账户数多空比

响应:

[
    { 
         "symbol":"BTCUSDT",
          "longShortRatio":"1.8105",// 大户多空账户数比值
          "longAccount": "0.6442", // 大户多仓账户数比例
          "shortAccount":"0.3558", // 大户空仓账户数比例
          "timestamp":"1583139600000"

    },
    {

         "symbol":"BTCUSDT",
          "longShortRatio":"1.8233",
          "longAccount": "0.5338", 
          "shortAccount":"0.3454",                  
          "timestamp":"1583139900000"

    },       
]

GET /futures/data/topLongShortAccountRatio

参数:

名称 类型 是否必需 描述
symbol STRING YES
period ENUM YES "5m","15m","30m","1h","2h","4h","6h","12h","1d"
limit LONG NO default 30, max 500
startTime LONG NO
endTime LONG NO

大户持仓量多空比

响应:

[
    { 
         "symbol":"BTCUSDT",
          "longShortRatio":"1.4342",// 大户多空持仓量比值
          "longAccount": "0.5344", // 大户多仓持仓量比例
          "shortAccount":"0.4656", // 大户空仓持仓量比例
          "timestamp":"1583139600000"
    }, 
    {

         "symbol":"BTCUSDT",
          "longShortRatio":"1.4337",
          "longAccount": "0.5891", 
          "shortAccount":"0.4108",                  
          "timestamp":"1583139900000"     
    },       
]

GET /futures/data/topLongShortPositionRatio

参数:

名称 类型 是否必需 描述
symbol STRING YES
period ENUM YES "5m","15m","30m","1h","2h","4h","6h","12h","1d"
limit LONG NO default 30, max 500
startTime LONG NO
endTime LONG NO

多空持仓人数比

响应:

[
    { 
        "symbol":"BTCUSDT",
        "longShortRatio":"0.1960", // 多空人数比值
        "longAccount": "0.6622", // 多仓人数比例
        "shortAccount":"0.3378", // 空仓人数比例
        "timestamp":"1583139600000"

    },
    {

        "symbol":"BTCUSDT",
        "longShortRatio":"1.9559",
        "longAccount": "0.6617", 
        "shortAccount":"0.3382",                    
        "timestamp":"1583139900000"          
    },     
]

GET /futures/data/globalLongShortAccountRatio

参数:

名称 类型 是否必需 描述
symbol STRING YES
period ENUM YES "5m","15m","30m","1h","2h","4h","6h","12h","1d"
limit LONG NO default 30, max 500
startTime LONG NO
endTime LONG NO

合约主动买卖量

响应:

[
    { 
          "buySellRatio":"1.5586",
          "buyVol": "387.3300", // 主动买入量
          "sellVol":"248.5030", // 主动卖出量
          "timestamp":"1585614900000"
    },
    {
          "buySellRatio":"1.3104",
          "buyVol": "343.9290", 
          "sellVol":"248.5030",                     
          "timestamp":"1583139900000"               
    },       
]

GET /futures/data/takerlongshortRatio

参数:

名称 类型 是否必需 描述
symbol STRING YES
period ENUM YES "5m","15m","30m","1h","2h","4h","6h","12h","1d"
limit LONG NO default 30, max 500
startTime LONG NO
endTime LONG NO

基差

响应:

[  
    {
        "indexPrice": "34400.15945055",
        "contractType": "PERPETUAL",
        "basisRate": "0.0004",
        "futuresPrice": "34414.10",
        "annualizedBasisRate": "",
        "basis": "13.94054945",
        "pair": "BTCUSDT",
        "timestamp": 1698742800000
    }
]

GET /futures/data/basis

参数:

名称 类型 是否必需 描述
pair STRING YES BTCUSDT
contractType ENUM YES CURRENT_QUARTER, NEXT_QUARTER, PERPETUAL
period ENUM YES "5m","15m","30m","1h","2h","4h","6h","12h","1d"
limit LONG YES Default 30,Max 500
startTime LONG NO
endTime LONG NO

杠杆代币历史净值K线

响应:

[
    [
        1598371200000,      // 开盘时间
        "5.88275270",       // 开盘净值
        "6.03142087",       // 最高净值
        "5.85749741",       // 最低净值
        "5.99403551",       // 收盘净值(当前K线未结束的即为最新净值)
        "2.28602984",       // 收盘真实杠杆
        1598374799999,      // 收盘时间
        "0",                // 请忽略
        6209,               // 净值更新笔数
        "14517.64507907",   // 请忽略
        "0",                // 请忽略
        "0"                 // 请忽略
    ]
]

GET /fapi/v1/lvtKlines

杠杆代币净值系统基于合约架构，故该接口采用fapi

权重: 1

参数:

名称 类型 是否必需 描述
symbol STRING YES token name, e.g. "BTCDOWN", "BTCUP"
interval ENUM YES
startTime LONG NO
endTime LONG NO
limit INT NO 默认 500, 最大 1000

综合指数交易对信息

响应:

[
    { 
        "symbol": "DEFIUSDT",
        "time": 1589437530011,    // 请求时间
        "component": "baseAsset", //成分资产
        "baseAssetList":[
            {
                "baseAsset":"BAL",    // 基础资产
                "quoteAsset": "USDT", // 报价资产
                "weightInQuantity":"1.04406228",  //权重(数量)
                "weightInPercentage":"0.02783900" //权重(比例)
            },
            {
                "baseAsset":"BAND",
                "quoteAsset": "USDT", 
                "weightInQuantity":"3.53782729",
                "weightInPercentage":"0.03935200"
            }
        ]
    }
]

获取交易对为综合指数的基础成分信息。

GET /fapi/v1/indexInfo

权重: 带symbol为1；不带symbol为10

参数:

名称 类型 是否必需 描述
symbol STRING NO

多资产模式资产汇率指数

响应:

{
    "symbol": "ADAUSD",
    "time": 1635740268004,
    "index": "1.92957370",
    "bidBuffer": "0.10000000", 
    "askBuffer": "0.10000000", 
    "bidRate": "1.73661633",
    "askRate": "2.12253107",
    "autoExchangeBidBuffer": "0.05000000",
    "autoExchangeAskBuffer": "0.05000000",
    "autoExchangeBidRate": "1.83309501",
    "autoExchangeAskRate": "2.02605238"
}

或(当不发送交易对信息)

[
    {
        "symbol": "ADAUSD",
        "time": 1635740268004,
        "index": "1.92957370",
        "bidBuffer": "0.10000000", 
        "askBuffer": "0.10000000", 
        "bidRate": "1.73661633",
        "askRate": "2.12253107",
        "autoExchangeBidBuffer": "0.05000000",
        "autoExchangeAskBuffer": "0.05000000",
        "autoExchangeBidRate": "1.83309501",
        "autoExchangeAskRate": "2.02605238"
    }
]

GET /fapi/v1/assetIndex

多资产模式资产汇率指数

权重: 带symbol为1, 不带为10

参数:

名称 类型 是否必需 描述
symbol STRING NO 资产对

查询指数价格成分

响应:

{
    "symbol": "BTCUSDT",
    "time": 1697421272043,
    "constituents": [
        {
            "exchange": "binance",
            "symbol": "BTCUSDT"
        },
        {
            "exchange": "okex",
            "symbol": "BTC-USDT"
        },
        {
            "exchange": "huobi",
            "symbol": "btcusdt"
        },
        {
            "exchange": "coinbase",
            "symbol": "BTC-USDT"
        }
    ]
}

GET /fapi/v1/constituents

查询指数价格成分

权重: 2

参数:

名称 类型 是否必需 描述
symbol STRING YES 交易对

Websocket 行情推送

实时订阅/取消数据流

订阅一个信息流

响应

  {
    "result": null,
    "id": 1
  }

取消订阅一个信息流

响应

  {
    "result": null,
    "id": 312
  }

{
"method": "UNSUBSCRIBE",
"params":
[
"btcusdt@depth"
],
"id": 312
}

已订阅信息流

响应

  {
    "result": [
      "btcusdt@aggTrade"
    ],
    "id": 3
  }

{
"method": "LIST_SUBSCRIPTIONS",
"id": 3
}

设定属性

当前，唯一可以设置的属性是设置是否启用combined("组合")信息流。
当使用/ws/("原始信息流")进行连接时，combined属性设置为false，而使用 /stream/进行连接时则将属性设置为true。

响应

  {
    "result": null
    "id": 5
  }

{
"method": "SET_PROPERTY",
"params":
[
"combined",
true
],
"id": 5
}

检索属性

响应

  {
    "result": true, // Indicates that combined is set to true.
    "id": 2
  }

{
"method": "GET_PROPERTY",
"params":
[
"combined"
],
"id": 2
}

错误信息

错误信息 描述
{"code": 0, "msg": "Unknown property"} SET_PROPERTY 或 GET_PROPERTY中应用的参数无效
{"code": 1, "msg": "Invalid value type: expected Boolean"} 仅接受true或false
{"code": 2, "msg": "Invalid request: property name must be a string"} 提供的属性名无效
{"code": 2, "msg": "Invalid request: request ID must be an unsigned integer"} 参数id未提供或id值是无效类型
{"code": 2, "msg": "Invalid request: unknown variant %s, expected one of SUBSCRIBE, UNSUBSCRIBE, LIST_SUBSCRIPTIONS, SET_PROPERTY, GET_PROPERTY at line 1 column 28"} 错字提醒，或提供的值不是预期类型
{"code": 2, "msg": "Invalid request: too many parameters"} 数据中提供了不必要参数
{"code": 2, "msg": "Invalid request: property name must be a string"} 未提供属性名
{"code": 2, "msg": "Invalid request: missing field method at line 1 column 73"} 数据未提供method
{"code":3,"msg":"Invalid JSON: expected value at line %s column %s"} JSON 语法有误.

最新合约价格

aggTrade中的价格'p'或ticker/miniTicker中的价格'c'均可以作为最新成交价。

归集交易

Payload:

{
  "e": "aggTrade",  // 事件类型
  "E": 123456789,   // 事件时间
  "s": "BNBUSDT",    // 交易对
  "a": 5933014,     // 归集成交 ID
  "p": "0.001",     // 成交价格
  "q": "100",       // 成交量
  "f": 100,         // 被归集的首个交易ID
  "l": 105,         // 被归集的末次交易ID
  "T": 123456785,   // 成交时间
  "m": true         // 买方是否是做市方。如true，则此次成交是一个主动卖出单，否则是一个主动买入单。
}

同一价格、同一方向、同一时间(100ms计算)的trade会被聚合为一条.

Stream Name:
<symbol>@aggTrade

Update Speed: 100ms

最新标记价格

Payload:

  {
    "e": "markPriceUpdate",     // 事件类型
    "E": 1562305380000,         // 事件时间
    "s": "BTCUSDT",             // 交易对
    "p": "11794.15000000",      // 标记价格
    "i": "11784.62659091",      // 现货指数价格
    "P": "11784.25641265",      // 预估结算价,仅在结算前最后一小时有参考价值
    "r": "0.00038167",          // 资金费率
    "T": 1562306400000          // 下次资金时间
  }

Stream Name:
<symbol>@markPrice 或 <symbol>@markPrice@1s

Update Speed: 3000ms 或 1000ms

全市场最新标记价格

Payload:

[
  {
    "e": "markPriceUpdate",     // 事件类型
    "E": 1562305380000,         // 事件时间
    "s": "BTCUSDT",             // 交易对
    "p": "11185.87786614",      // 标记价格
    "i": "11784.62659091"       // 现货指数价格
    "P": "11784.25641265",      // 预估结算价,仅在结算前最后一小时有参考价值
    "r": "0.00030000",          // 资金费率
    "T": 1562306400000          // 下个资金时间
  }
]

Stream Name:
!markPrice@arr 或 !markPrice@arr@1s

Update Speed: 3000ms 或 1000ms

K线

Payload:

{
  "e": "kline",     // 事件类型
  "E": 123456789,   // 事件时间
  "s": "BNBUSDT",    // 交易对
  "k": {
    "t": 123400000, // 这根K线的起始时间
    "T": 123460000, // 这根K线的结束时间
    "s": "BNBUSDT",  // 交易对
    "i": "1m",      // K线间隔
    "f": 100,       // 这根K线期间第一笔成交ID
    "L": 200,       // 这根K线期间末一笔成交ID
    "o": "0.0010",  // 这根K线期间第一笔成交价
    "c": "0.0020",  // 这根K线期间末一笔成交价
    "h": "0.0025",  // 这根K线期间最高成交价
    "l": "0.0015",  // 这根K线期间最低成交价
    "v": "1000",    // 这根K线期间成交量
    "n": 100,       // 这根K线期间成交笔数
    "x": false,     // 这根K线是否完结(是否已经开始下一根K线)
    "q": "1.0000",  // 这根K线期间成交额
    "V": "500",     // 主动买入的成交量
    "Q": "0.500",   // 主动买入的成交额
    "B": "123456"   // 忽略此参数
  }
}

K线stream逐秒推送所请求的K线种类(最新一根K线)的更新。推送间隔250毫秒(如有刷新)

订阅Kline需要提供间隔参数，最短为分钟线，最长为月线。支持以下间隔:

m -> 分钟; h -> 小时; d -> 天; w -> 周; M -> 月

Stream Name:
<symbol>@kline_<interval>

Update Speed: 250ms

连续合约K线

Payload:

{
  "e":"continuous_kline",   // 事件类型
  "E":1607443058651,        // 事件时间
  "ps":"BTCUSDT",           // 标的交易对
  "ct":"PERPETUAL",         // 合约类型 
  "k":{
    "t":1607443020000,      // 这根K线的起始时间
    "T":1607443079999,      // 这根K线的结束时间
    "i":"1m",               // K线间隔
    "f":116467658886,       // 这根K线期间第一笔更新ID
    "L":116468012423,       // 这根K线期间末一笔更新ID
    "o":"18787.00",         // 这根K线期间第一笔成交价
    "c":"18804.04",         // 这根K线期间末一笔成交价
    "h":"18804.04",         // 这根K线期间最高成交价
    "l":"18786.54",         // 这根K线期间最低成交价
    "v":"197.664",          // 这根K线期间成交量
    "n":543,                // 这根K线期间成交笔数
    "x":false,              // 这根K线是否完结(是否已经开始下一根K线)
    "q":"3715253.19494",    // 这根K线期间成交额
    "V":"184.769",          // 主动买入的成交量
    "Q":"3472925.84746",    // 主动买入的成交额
    "B":"0"                 // 忽略此参数
  }
}

K线stream逐秒推送所请求的K线种类(最新一根K线)的更新。

合约类型:

订阅Kline需要提供间隔参数,最短为分钟线,最长为月线。支持以下间隔:

m -> 分钟; h -> 小时; d -> 天; w -> 周; M -> 月

Stream Name:
<pair>_<contractType>@continuousKline_<interval>

Update Speed: 250ms

按Symbol的精简Ticker

Payload:

  {
    "e": "24hrMiniTicker",  // 事件类型
    "E": 123456789,         // 事件时间(毫秒)
    "s": "BNBUSDT",          // 交易对
    "c": "0.0025",          // 最新成交价格
    "o": "0.0010",          // 24小时前开始第一笔成交价格
    "h": "0.0025",          // 24小时内最高成交价
    "l": "0.0010",          // 24小时内最低成交价
    "v": "10000",           // 成交量
    "q": "18"               // 成交额
  }

按Symbol刷新的24小时精简ticker信息.

Stream Name:
<symbol>@miniTicker

Update Speed: 500ms

全市场的精简Ticker

Payload:

[  
  {
    "e": "24hrMiniTicker",  // 事件类型
    "E": 123456789,         // 事件时间(毫秒)
    "s": "BNBUSDT",          // 交易对
    "c": "0.0025",          // 最新成交价格
    "o": "0.0010",          // 24小时前开始第一笔成交价格
    "h": "0.0025",          // 24小时内最高成交价
    "l": "0.0010",          // 24小时内最低成交价
    "v": "10000",           // 成交量
    "q": "18"               // 成交额
  }
]

所有symbol24小时精简ticker信息.需要注意的是，只有发生变化的ticker更新才会被推送。

Stream Name:
!miniTicker@arr

Update Speed: 1000ms

按Symbol的完整Ticker

Payload:

{
  "e": "24hrTicker",  // 事件类型
  "E": 123456789,     // 事件时间
  "s": "BNBUSDT",      // 交易对
  "p": "0.0015",      // 24小时价格变化
  "P": "250.00",      // 24小时价格变化(百分比)
  "w": "0.0018",      // 平均价格
  "c": "0.0025",      // 最新成交价格
  "Q": "10",          // 最新成交价格上的成交量
  "o": "0.0010",      // 24小时内第一比成交的价格
  "h": "0.0025",      // 24小时内最高成交价
  "l": "0.0010",      // 24小时内最低成交价
  "v": "10000",       // 24小时内成交量
  "q": "18",          // 24小时内成交额
  "O": 0,             // 统计开始时间
  "C": 86400000,      // 统计关闭时间
  "F": 0,             // 24小时内第一笔成交交易ID
  "L": 18150,         // 24小时内最后一笔成交交易ID
  "n": 18151          // 24小时内成交数
}

按Symbol刷新的24小时完整ticker信息

Stream Name:
<symbol>@ticker

Update Speed: 2000ms

全市场的完整Ticker

Payload:

[
    {
      "e": "24hrTicker",  // 事件类型
      "E": 123456789,     // 事件时间
      "s": "BNBUSDT",      // 交易对
      "p": "0.0015",      // 24小时价格变化
      "P": "250.00",      // 24小时价格变化(百分比)
      "w": "0.0018",      // 平均价格
      "c": "0.0025",      // 最新成交价格
      "Q": "10",          // 最新成交价格上的成交量
      "o": "0.0010",      // 24小时内第一比成交的价格
      "h": "0.0025",      // 24小时内最高成交价
      "l": "0.0010",      // 24小时内最低成交价
      "v": "10000",       // 24小时内成交量
      "q": "18",          // 24小时内成交额
      "O": 0,             // 统计开始时间
      "C": 86400000,      // 统计结束时间
      "F": 0,             // 24小时内第一笔成交交易ID
      "L": 18150,         // 24小时内最后一笔成交交易ID
      "n": 18151          // 24小时内成交数
    }
]

所有symbol 24小时完整ticker信息.需要注意的是，只有发生变化的ticker更新才会被推送。

Stream Name:
!ticker@arr

Update Speed: 1000ms

按Symbol的最优挂单信息

Payload:

{
  "e":"bookTicker",     // 事件类型
  "u":400900217,        // 更新ID
  "E": 1568014460893,   // 事件推送时间
  "T": 1568014460891,   // 撮合时间
  "s":"BNBUSDT",        // 交易对
  "b":"25.35190000",    // 买单最优挂单价格
  "B":"31.21000000",    // 买单最优挂单数量
  "a":"25.36520000",    // 卖单最优挂单价格
  "A":"40.66000000"     // 卖单最优挂单数量
}

实时推送指定交易对最优挂单信息

Stream Name: <symbol>@bookTicker

Update Speed: 实时

全市场最优挂单信息

Payload:

{
  // Same as <symbol>@bookTicker payload
}

所有交易对交易对最优挂单信息

Stream Name: !bookTicker

Update Speed: 实时， 将于2023-12-20改为5s

强平订单

Payload:

{

    "e":"forceOrder",                   // 事件类型
    "E":1568014460893,                  // 事件时间
    "o":{

        "s":"BTCUSDT",                   // 交易对
        "S":"SELL",                      // 订单方向
        "o":"LIMIT",                     // 订单类型
        "f":"IOC",                       // 有效方式
        "q":"0.014",                     // 订单数量
        "p":"9910",                      // 订单价格
        "ap":"9910",                     // 平均价格
        "X":"FILLED",                    // 订单状态
        "l":"0.014",                     // 订单最近成交量
        "z":"0.014",                     // 订单累计成交量
        "T":1568014460893,              // 交易时间

    }

}

推送特定symbol的强平订单快照信息。

1000ms内至多仅推送一条最近的强平订单作为快照

Stream Name:  <symbol>@forceOrder

Update Speed: 1000ms

全市场强平订单

Payload:

{

    "e":"forceOrder",                   // 事件类型
    "E":1568014460893,                  // 事件时间
    "o":{

        "s":"BTCUSDT",                   // 交易对
        "S":"SELL",                      // 订单方向
        "o":"LIMIT",                     // 订单类型
        "f":"IOC",                       // 有效方式
        "q":"0.014",                     // 订单数量
        "p":"9910",                      // 订单价格
        "ap":"9910",                     // 平均价格
        "X":"FILLED",                    // 订单状态
        "l":"0.014",                     // 订单最近成交量
        "z":"0.014",                     // 订单累计成交量
        "T":1568014460893,              // 交易时间

    }

}

推送全市场强平订单快照信息

每个symbol，1000ms内至多仅推送一条最近的强平订单作为快照

Stream Name: !forceOrder@arr

Update Speed: 实时

有限档深度信息

Payload:

{
  "e": "depthUpdate",           // 事件类型
  "E": 1571889248277,           // 事件时间
  "T": 1571889248276,           // 交易时间
  "s": "BTCUSDT",
  "U": 390497796,
  "u": 390497878,
  "pu": 390497794,
  "b": [                        // 买方
    [
      "7403.89",                // 价格
      "0.002"                   // 数量
    ],
    [
      "7403.90",
      "3.906"
    ],
    [
      "7404.00",
      "1.428"
    ],
    [
      "7404.85",
      "5.239"
    ],
    [
      "7405.43",
      "2.562"
    ]
  ],
  "a": [                        // 卖方
    [
      "7405.96",                // 价格
      "3.340"                   // 数量
    ],
    [
      "7406.63",
      "4.525"
    ],
    [
      "7407.08",
      "2.475"
    ],
    [
      "7407.15",
      "4.800"
    ],
    [
      "7407.20",
      "0.175"
    ]
  ]
}

推送有限档深度信息。levels表示几档买卖单信息, 可选 5/10/20档

Stream Names: <symbol>@depth<levels> 或 <symbol>@depth<levels>@500ms 或 <symbol>@depth<levels>@100ms.

Update Speed: 250ms 或 500ms 或 100ms

增量深度信息

Payload:

{
  "e": "depthUpdate",   // 事件类型
  "E": 123456789,       // 事件时间
  "T": 123456788,       // 撮合时间
  "s": "BNBUSDT",       // 交易对
  "U": 157,             // 从上次推送至今新增的第一个 update Id
  "u": 160,             // 从上次推送至今新增的最后一个 update Id
  "pu": 149,            // 上次推送的最后一个update Id(即上条消息的‘u’)
  "b": [                // 变动的买单深度
    [
      "0.0024",         // 价格
      "10"              // 数量
    ]
  ],
  "a": [                // 变动的卖单深度
    [
      "0.0026",         // 价格
      "100"             // 数量
    ]
  ]
}

orderbook的变化部分，推送间隔250毫秒,500毫秒，100毫秒(如有刷新)

Stream Names:
<symbol>@depth OR <symbol>@depth@500ms OR <symbol>@depth@100ms

Update Speed: 250ms 或 500ms 或 100ms

如何正确在本地维护一个orderbook副本

  1. 订阅 wss://fstream.binance.com/stream?streams=btcusdt@depth
  2. 开始缓存收到的更新。同一个价位，后收到的更新覆盖前面的。
  3. 访问Rest接口 https://fapi.binance.com/fapi/v1/depth?symbol=BTCUSDT&limit=1000获得一个1000档的深度快照
  4. 将目前缓存到的信息中u< 步骤3中获取到的快照中的lastUpdateId的部分丢弃(丢弃更早的信息，已经过期)。
  5. 将深度快照中的内容更新到本地orderbook副本中，并从websocket接收到的第一个U <= lastUpdateId 且 u >= lastUpdateId 的event开始继续更新本地副本。
  6. 每一个新event的pu应该等于上一个event的u，否则可能出现了丢包，请从step3重新进行初始化。
  7. 每一个event中的挂单量代表这个价格目前的挂单量绝对值，而不是相对变化。
  8. 如果某个价格对应的挂单量为0，表示该价位的挂单已经撤单或者被吃，应该移除这个价位。

综合指数交易对信息流

Payload:

{
  "e":"compositeIndex",     // 事件类型
  "E":1602310596000,        // 事件事件
  "s":"DEFIUSDT",           // 交易对
  "p":"554.41604065",       // 价格
  "C":"baseAsset",
  "c":[                 // 成分信息
    {
        "b":"BAL",          // 基础资产
        "q":"USDT",         // 报价资产
        "w":"1.04884844",   // 权重(数量)
        "W":"0.01457800",   // 权重(比例)
        "i":"24.33521021"   // 指数价格
    },
    {
        "b":"BAND",
        "q":"USDT",        
        "w":"3.53782729",
        "W":"0.03935200",
        "i":"7.26420084"
    }
  ]
}

获取交易对为综合指数的基础成分信息。 推送间隔1000毫秒(如有刷新)

Stream Name: <symbol>@compositeIndex

Update Speed: 1000ms

交易对信息信息流

Payload:

{
    "e":"contractInfo",      // 事件类型
    "E":1669356423908,       // 事件时间
    "s":"IOTAUSDT",          // 交易对
    "ps":"IOTAUSDT",         // 交易对标的
    "ct":"PERPETUAL",        // 合约类型
    "dt":4133404800000,      // 结算时间
    "ot":1569398400000,      // 上架时间
    "cs":"TRADING",          // 交易对状态
    "bks":[
        {
            "bs":1,          // 层级
            "bnf":0,         // 该层对应的名义价值下限
            "bnc":5000,      // 该层对应的名义价值上限
            "mmr":0.01,      // 该层对应的维持保证金率
            "cf":0,          // 速算数
            "mi":21,         // 该层杠杆下界
            "ma":50          // 该层杠杆上界
        },
        {
            "bs":2,
            "bnf":5000,
            "bnc":25000,
            "mmr":0.025,
            "cf":75,
            "mi":11,
            "ma":20
        }
    ]
}

Symbol状态更改时推送（上架/下架/bracket调整）; bks仅在bracket调整时推出。

Stream Name: !contractInfo Update Speed: 实时

多资产模式资产汇率指数

Payload:

[
    {
      "e":"assetIndexUpdate",
      "E":1686749230000,
      "s":"ADAUSD",         // asset index symbol
      "i":"0.27462452",     // 指数价格
      "b":"0.10000000",     // bid估值折扣
      "a":"0.10000000",     // ask估值折扣
      "B":"0.24716207",     // bid价格
      "A":"0.30208698",     // ask价格
      "q":"0.05000000",     // 自动兑换bid估值折扣
      "g":"0.05000000",     // 自动兑换ask估值折扣
      "Q":"0.26089330",     // 自动兑换bid价格
      "G":"0.28835575"      // 自动兑换ask价格
    },
    {
      "e":"assetIndexUpdate",
      "E":1686749230000,
      "s":"USDTUSD",
      "i":"0.99987691",
      "b":"0.00010000",
      "a":"0.00010000",
      "B":"0.99977692",
      "A":"0.99997689",
      "q":"0.00010000",
      "g":"0.00010000",
      "Q":"0.99977692",
      "G":"0.99997689"
    }

多资产模式资产价格指数

Stream Name: !assetIndex@arrOR <assetSymbol>@assetIndex

Update Speed: 1s

账户和交易接口

划转

执行现货账户与合约账户之间的划转, 详情请见这里.

获取划转历史

获取现货账户与合约账户之间的资金划转历史记录,详情请见这里.

更改持仓模式(TRADE)

响应:

{
    "code": 200,
    "msg": "success"
}

POST /fapi/v1/positionSide/dual

变换用户在 所有symbol 合约上的持仓模式：双向持仓或单向持仓。

权重: 1

参数:

名称 类型 是否必需 描述
dualSidePosition STRING YES "true": 双向持仓模式；"false": 单向持仓模式
recvWindow LONG NO
timestamp LONG YES

查询持仓模式(USER_DATA)

响应:

{
    "dualSidePosition": true // "true": 双向持仓模式；"false": 单向持仓模式
}

GET /fapi/v1/positionSide/dual

查询用户目前在 所有symbol 合约上的持仓模式：双向持仓或单向持仓。

权重: 30

参数:

名称 类型 是否必需 描述
recvWindow LONG NO
timestamp LONG YES

更改联合保证金模式(TRADE)

响应:

{
    "code": 200,
    "msg": "success"
}

POST /fapi/v1/multiAssetsMargin

变换用户在 所有symbol 合约上的联合保证金模式：开启或关闭联合保证金模式。

权重: 1

参数:

名称 类型 是否必需 描述
multiAssetsMargin STRING YES "true": 联合保证金模式开启；"false": 联合保证金模式关闭
recvWindow LONG NO
timestamp LONG YES

查询联合保证金模式(USER_DATA)

响应:

{
    "multiAssetsMargin": true // "true": 联合保证金模式开启；"false": 联合保证金模式关闭
}

GET /fapi/v1/multiAssetsMargin

查询用户目前在 所有symbol 合约上的联合保证金模式。

权重: 30

参数:

名称 类型 是否必需 描述
recvWindow LONG NO
timestamp LONG YES

合约交易 BNB 抵扣开关 (TRADE)

Response:

{
    "code": 200,
    "msg": "success"
}

POST /fapi/v1/feeBurn (HMAC SHA256)

改变用户 所有 symbol 合约交易 BNB 抵扣开关 (手续费抵扣开或关)

Weight: 1

Parameters:

Name Type Mandatory Description
feeBurn STRING YES "true": 手续费抵扣开; "false": 手续费抵扣关
recvWindow LONG NO
timestamp LONG YES

获取 BNB 抵扣开关状态 (USER_DATA)

Response:

{
    "feeBurn": true // "true": 手续费抵扣开; "false": 手续费抵扣关
}

GET /fapi/v1/feeBurn (HMAC SHA256)

查询用户 所有 symbol 合约交易 BNB 抵扣开关状态 (手续费抵扣开或关)

Weight: 30

Parameters:

Name Type Mandatory Description
recvWindow LONG NO
timestamp LONG YES

下单 (TRADE)

响应:

{
    "clientOrderId": "testOrder", // 用户自定义的订单号
    "cumQty": "0",
    "cumQuote": "0", // 成交金额
    "executedQty": "0", // 成交量
    "orderId": 22542179, // 系统订单号
    "avgPrice": "0.00000",  // 平均成交价
    "origQty": "10", // 原始委托数量
    "price": "0", // 委托价格
    "reduceOnly": false, // 仅减仓
    "side": "SELL", // 买卖方向
    "positionSide": "SHORT", // 持仓方向
    "status": "NEW", // 订单状态
    "stopPrice": "0", // 触发价，对`TRAILING_STOP_MARKET`无效
    "closePosition": false,   // 是否条件全平仓
    "symbol": "BTCUSDT", // 交易对
    "timeInForce": "GTD", // 有效方法
    "type": "TRAILING_STOP_MARKET", // 订单类型
    "origType": "TRAILING_STOP_MARKET",  // 触发前订单类型
    "activatePrice": "9020", // 跟踪止损激活价格, 仅`TRAILING_STOP_MARKET` 订单返回此字段
    "priceRate": "0.3", // 跟踪止损回调比例, 仅`TRAILING_STOP_MARKET` 订单返回此字段
    "updateTime": 1566818724722, // 更新时间
    "workingType": "CONTRACT_PRICE", // 条件价格触发类型
    "priceProtect": false,            // 是否开启条件单触发保护
    "priceMatch": "NONE",              //盘口价格下单模式
    "selfTradePreventionMode": "NONE", //订单自成交保护模式
    "goodTillDate": 1693207680000      //订单TIF为GTD时的自动取消时间
}

POST /fapi/v1/order

权重: 0

参数:

名称 类型 是否必需 描述
symbol STRING YES 交易对
side ENUM YES 买卖方向 SELL, BUY
positionSide ENUM NO 持仓方向，单向持仓模式下非必填，默认且仅可填BOTH;在双向持仓模式下必填,且仅可选择 LONG 或 SHORT
type ENUM YES 订单类型 LIMIT, MARKET, STOP, TAKE_PROFIT, STOP_MARKET, TAKE_PROFIT_MARKET, TRAILING_STOP_MARKET
reduceOnly STRING NO true, false; 非双开模式下默认false；双开模式下不接受此参数； 使用closePosition不支持此参数。
quantity DECIMAL NO 下单数量,使用closePosition不支持此参数。
price DECIMAL NO 委托价格
newClientOrderId STRING NO 用户自定义的订单号，不可以重复出现在挂单中。如空缺系统会自动赋值。必须满足正则规则 ^[\.A-Z\:/a-z0-9_-]{1,36}$
stopPrice DECIMAL NO 触发价, 仅 STOP, STOP_MARKET, TAKE_PROFIT, TAKE_PROFIT_MARKET 需要此参数
closePosition STRING NO true, false；触发后全部平仓，仅支持STOP_MARKET和TAKE_PROFIT_MARKET；不与quantity合用；自带只平仓效果，不与reduceOnly 合用
activationPrice DECIMAL NO 追踪止损激活价格，仅TRAILING_STOP_MARKET 需要此参数, 默认为下单当前市场价格(支持不同workingType)
callbackRate DECIMAL NO 追踪止损回调比例，可取值范围[0.1, 10],其中 1代表1% ,仅TRAILING_STOP_MARKET 需要此参数
timeInForce ENUM NO 有效方法
workingType ENUM NO stopPrice 触发类型: MARK_PRICE(标记价格), CONTRACT_PRICE(合约最新价). 默认 CONTRACT_PRICE
priceProtect STRING NO 条件单触发保护："TRUE","FALSE", 默认"FALSE". 仅 STOP, STOP_MARKET, TAKE_PROFIT, TAKE_PROFIT_MARKET 需要此参数
newOrderRespType ENUM NO "ACK", "RESULT", 默认 "ACK"
symbol STRING YES 交易对
priceMatch ENUM NO OPPONENT/ OPPONENT_5/ OPPONENT_10/ OPPONENT_20/QUEUE/ QUEUE_5/ QUEUE_10/ QUEUE_20；不能与price同时传
selfTradePreventionMode ENUM NO NONE / EXPIRE_TAKER/ EXPIRE_MAKER/ EXPIRE_BOTH； 默认NONE
goodTillDate LONG NO TIF为GTD时订单的自动取消时间， 当timeInforce为GTD时必传；传入的时间戳仅保留秒级精度，毫秒级部分会被自动忽略，时间戳需大于当前时间+600s且小于253402300799000
recvWindow LONG NO
timestamp LONG YES

根据 order type的不同，某些参数强制要求，具体如下:

Type 强制要求的参数
LIMIT timeInForce, quantity, price
MARKET quantity
STOP, TAKE_PROFIT quantity, price, stopPrice
STOP_MARKET, TAKE_PROFIT_MARKET stopPrice
TRAILING_STOP_MARKET quantity,callbackRate

测试下单接口 (TRADE)

响应:

字段与下单接口一致，但均为无效值

POST /fapi/v1/order/test

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

参数:

参考 POST /fapi/v1/order

修改订单 (TRADE)

响应:

{
    "orderId": 20072994037,
    "symbol": "BTCUSDT",
    "pair": "BTCUSDT",
    "status": "NEW",
    "clientOrderId": "LJ9R4QZDihCaS8UAOOLpgW",
    "price": "30005",
    "avgPrice": "0.0",
    "origQty": "1",
    "executedQty": "0",
    "cumQty": "0",
    "cumBase": "0",
    "timeInForce": "GTC",
    "type": "LIMIT",
    "reduceOnly": false,
    "closePosition": false,
    "side": "BUY",
    "positionSide": "LONG",
    "stopPrice": "0",
    "workingType": "CONTRACT_PRICE",
    "priceProtect": false,
    "origType": "LIMIT",
    "priceMatch": "NONE",              //盘口价格下单模式
    "selfTradePreventionMode": "NONE", //订单自成交保护模式
    "goodTillDate": 0                 //订单TIF为GTD时的自动取消时间
    "updateTime": 1629182711600
}

PUT /fapi/v1/order

修改订单功能，当前只支持限价（LIMIT）订单修改，修改后会在撮合队列里重新排序

权重: 10s order rate limit(X-MBX-ORDER-COUNT-10S)为1 1min order rate limit(X-MBX-ORDER-COUNT-1M)为1 IP rate limit(x-mbx-used-weight-1m)为1

参数:

名称 类型 是否必需 描述
orderId LONG NO 系统订单号
origClientOrderId STRING NO 用户自定义的订单号
symbol STRING YES 交易对
side ENUM YES 买卖方向 SELL, BUY; side需要和原订单相同
quantity DECIMAL YES 下单数量,使用closePosition不支持此参数。
price DECIMAL YES 委托价格
priceMatch ENUM NO OPPONENT/ OPPONENT_5/ OPPONENT_10/ OPPONENT_20/QUEUE/ QUEUE_5/ QUEUE_10/ QUEUE_20；不能与price同时传
timestamp LONG YES

批量下单 (TRADE)

响应:

[
    {
        "clientOrderId": "testOrder", // 用户自定义的订单号
        "cumQty": "0",
        "cumQuote": "0", // 成交金额
        "executedQty": "0", // 成交量
        "orderId": 22542179, // 系统订单号
        "avgPrice": "0.00000",  // 平均成交价
        "origQty": "10", // 原始委托数量
        "price": "0", // 委托价格
        "reduceOnly": false, // 仅减仓
        "side": "SELL", // 买卖方向
        "positionSide": "SHORT", // 持仓方向
        "status": "NEW", // 订单状态
        "stopPrice": "0", // 触发价，对`TRAILING_STOP_MARKET`无效
        "closePosition": false,   // 是否条件全平仓
        "symbol": "BTCUSDT", // 交易对
        "timeInForce": "GTC", // 有效方法
        "type": "TRAILING_STOP_MARKET", // 订单类型
        "origType": "TRAILING_STOP_MARKET",  // 触发前订单类型
        "activatePrice": "9020", // 跟踪止损激活价格, 仅`TRAILING_STOP_MARKET` 订单返回此字段
        "priceRate": "0.3", // 跟踪止损回调比例, 仅`TRAILING_STOP_MARKET` 订单返回此字段
        "updateTime": 1566818724722, // 更新时间
        "workingType": "CONTRACT_PRICE", // 条件价格触发类型
        "priceProtect": false,            // 是否开启条件单触发保护
        "priceMatch": "NONE",              //盘口价格下单模式
        "selfTradePreventionMode": "NONE", //订单自成交保护模式
        "goodTillDate": 0      //订单TIF为GTD时的自动取消时间
    },
    {
        "code": -2022, 
        "msg": "ReduceOnly Order is rejected."
    }
]

POST /fapi/v1/batchOrders

权重: 10s order rate limit(X-MBX-ORDER-COUNT-10S)为5 1min order rate limit(X-MBX-ORDER-COUNT-1M)为1 IP rate limit(x-mbx-used-weight-1m)为5

参数:

名称 类型 是否必需 描述
batchOrders list<JSON> YES 订单列表，最多支持5个订单
recvWindow LONG NO
timestamp LONG YES

其中batchOrders应以list of JSON格式填写订单参数

名称 类型 是否必需 描述
symbol STRING YES 交易对
side ENUM YES 买卖方向 SELL, BUY
positionSide ENUM NO 持仓方向，单向持仓模式下非必填，默认且仅可填BOTH;在双向持仓模式下必填,且仅可选择 LONG 或 SHORT
type ENUM YES 订单类型 LIMIT, MARKET, STOP, TAKE_PROFIT, STOP_MARKET, TAKE_PROFIT_MARKET, TRAILING_STOP_MARKET
reduceOnly STRING NO true, false; 非双开模式下默认false；双开模式下不接受此参数。
quantity DECIMAL YES 下单数量
price DECIMAL NO 委托价格
newClientOrderId STRING NO 用户自定义的订单号，不可以重复出现在挂单中。如空缺系统会自动赋值. 必须满足正则规则 ^[\.A-Z\:/a-z0-9_-]{1,36}$
stopPrice DECIMAL NO 触发价, 仅 STOP, STOP_MARKET, TAKE_PROFIT, TAKE_PROFIT_MARKET 需要此参数
activationPrice DECIMAL NO 追踪止损激活价格，仅TRAILING_STOP_MARKET 需要此参数, 默认为下单当前市场价格(支持不同workingType)
callbackRate DECIMAL NO 追踪止损回调比例，可取值范围[0.1, 4],其中 1代表1% ,仅TRAILING_STOP_MARKET 需要此参数
timeInForce ENUM NO 有效方法
workingType ENUM NO stopPrice 触发类型: MARK_PRICE(标记价格), CONTRACT_PRICE(合约最新价). 默认 CONTRACT_PRICE
priceProtect STRING NO 条件单触发保护："TRUE","FALSE", 默认"FALSE". 仅 STOP, STOP_MARKET, TAKE_PROFIT, TAKE_PROFIT_MARKET 需要此参数
newOrderRespType ENUM NO "ACK", "RESULT", 默认 "ACK"
priceMatch ENUM NO OPPONENT/ OPPONENT_5/ OPPONENT_10/ OPPONENT_20/QUEUE/ QUEUE_5/ QUEUE_10/ QUEUE_20；不能与price同时传
selfTradePreventionMode ENUM NO NONE / EXPIRE_TAKER/ EXPIRE_MAKER/ EXPIRE_BOTH； 默认NONE
goodTillDate LONG NO TIF为GTD时订单的自动取消时间， 当timeInforce为GTD时必传；传入的时间戳仅保留秒级精度，毫秒级部分会被自动忽略，时间戳需大于当前时间+600s且小于253402300799000

批量修改订单 (TRADE)

响应:

[
    {
        "orderId": 20072994037,
        "symbol": "BTCUSDT",
        "pair": "BTCUSDT",
        "status": "NEW",
        "clientOrderId": "LJ9R4QZDihCaS8UAOOLpgW",
        "price": "30005",
        "avgPrice": "0.0",
        "origQty": "1",
        "executedQty": "0",
        "cumQty": "0",
        "cumBase": "0",
        "timeInForce": "GTC",
        "type": "LIMIT",
        "reduceOnly": false,
        "closePosition": false,
        "side": "BUY",
        "positionSide": "LONG",
        "stopPrice": "0",
        "workingType": "CONTRACT_PRICE",
        "priceProtect": false,
        "origType": "LIMIT",
        "priceMatch": "NONE",              //盘口价格下单模式
        "selfTradePreventionMode": "NONE", //订单自成交保护模式
        "goodTillDate": 0      //订单TIF为GTD时的自动取消时间
        "updateTime": 1629182711600
    },
    {
        "code": -2022, 
        "msg": "ReduceOnly Order is rejected."
    }
]

PUT /fapi/v1/batchOrders

权重: 5

参数:

名称 类型 是否必需 描述
batchOrders list<JSON> YES 订单列表,最多支持5个订单
recvWindow LONG NO
timestamp LONG YES

其中batchOrders应以list of JSON格式填写订单参数

名称 类型 是否必需 描述
orderId LONG NO 系统订单号，orderId 与 origClientOrderId 至少要传一个
origClientOrderId STRING NO 用户自定义的订单号，orderId 与 origClientOrderId 至少要传一个
symbol STRING YES 交易对
side ENUM YES 买卖方向 SELL, BUY
quantity DECIMAL YES 下单数量,使用closePosition不支持此参数。
price DECIMAL YES 委托价格
stopPrice DECIMAL NO 触发价, 仅 STOP, STOP_MARKET, TAKE_PROFIT, TAKE_PROFIT_MARKET 需要此参数
priceMatch ENUM NO OPPONENT/ OPPONENT_5/ OPPONENT_10/ OPPONENT_20/QUEUE/ QUEUE_5/ QUEUE_10/ QUEUE_20；不能与price同时传
recvWindow LONG NO
timestamp LONG YES

查询订单修改历史 (USER_DATA)

响应:

[
    {
        "amendmentId": 5363,    // 修改记录号
        "symbol": "BTCUSDT",
        "pair": "BTCUSDT",
        "orderId": 20072994037,
        "clientOrderId": "LJ9R4QZDihCaS8UAOOLpgW",
        "time": 1629184560899,  // 修改时间
        "amendment": {
            "price": {
                "before": "30004",
                "after": "30003.2"
            },
            "origQty": {
                "before": "1",
                "after": "1"
            },
            "count": 3  // 修改记数，代表该修改记录是这笔订单第几次修改
        },
        "priceMatch":"QUEUE_20"
    },
    {
        "amendmentId": 5361,
        "symbol": "BTCUSDT",
        "pair": "BTCUSDT",
        "orderId": 20072994037,
        "clientOrderId": "LJ9R4QZDihCaS8UAOOLpgW",
        "time": 1629184533946,
        "amendment": {
            "price": {
                "before": "30005",
                "after": "30004"
            },
            "origQty": {
                "before": "1",
                "after": "1"
            },
            "count": 2
        },
        "priceMatch":"QUEUE_20"
    },
    {
        "amendmentId": 5325,
        "symbol": "BTCUSDT",
        "pair": "BTCUSDT",
        "orderId": 20072994037,
        "clientOrderId": "LJ9R4QZDihCaS8UAOOLpgW",
        "time": 1629182711787,
        "amendment": {
            "price": {
                "before": "30002",
                "after": "30005"
            },
            "origQty": {
                "before": "1",
                "after": "1"
            },
            "count": 1
        },
        "priceMatch":"QUEUE_20"
    }
]

GET /fapi/v1/orderAmendment

查询订单修改历史

权重: 1

参数:

名称 类型 是否必需 描述
symbol STRING YES 交易对
orderId LONG NO 系统订单号
origClientOrderId STRING NO 用户自定义的订单号
startTime LONG NO 起始时间
endTime LONG NO 结束时间
limit INT NO 返回的结果集数量 默认值:1000 最大值:1000
recvWindow LONG NO
timestamp LONG YES

注意:

查询订单 (USER_DATA)

响应:

{
    "avgPrice": "0.00000",              // 平均成交价
    "clientOrderId": "abc",             // 用户自定义的订单号
    "cumQuote": "0",                    // 成交金额
    "executedQty": "0",                 // 成交量
    "orderId": 1573346959,              // 系统订单号
    "origQty": "0.40",                  // 原始委托数量
    "origType": "TRAILING_STOP_MARKET", // 触发前订单类型
    "price": "0",                       // 委托价格
    "reduceOnly": false,                // 是否仅减仓
    "side": "BUY",                      // 买卖方向
    "positionSide": "SHORT",            // 持仓方向
    "status": "NEW",                    // 订单状态
    "stopPrice": "9300",                    // 触发价，对`TRAILING_STOP_MARKET`无效
    "closePosition": false,   // 是否条件全平仓
    "symbol": "BTCUSDT",                // 交易对
    "time": 1579276756075,              // 订单时间
    "timeInForce": "GTC",               // 有效方法
    "type": "TRAILING_STOP_MARKET",     // 订单类型
    "activatePrice": "9020",            // 跟踪止损激活价格, 仅`TRAILING_STOP_MARKET` 订单返回此字段
    "priceRate": "0.3",                 // 跟踪止损回调比例, 仅`TRAILING_STOP_MARKET` 订单返回此字段
    "updateTime": 1579276756075,        // 更新时间
    "workingType": "CONTRACT_PRICE", // 条件价格触发类型
    "priceProtect": false,            // 是否开启条件单触发保护
    "priceMatch": "NONE",              //盘口价格下单模式
    "selfTradePreventionMode": "NONE", //订单自成交保护模式
    "goodTillDate": 0                  //订单TIF为GTD时的自动取消时间
}

GET /fapi/v1/order

查询订单状态

权重: 1

参数:

名称 类型 是否必需 描述
symbol STRING YES 交易对
orderId LONG NO 系统订单号
origClientOrderId STRING NO 用户自定义的订单号
recvWindow LONG NO
timestamp LONG YES

注意:

撤销订单 (TRADE)

响应:

{
    "clientOrderId": "myOrder1", // 用户自定义的订单号
    "cumQty": "0",
    "cumQuote": "0", // 成交金额
    "executedQty": "0", // 成交量
    "orderId": 283194212, // 系统订单号
    "origQty": "11", // 原始委托数量
    "price": "0", // 委托价格
    "reduceOnly": false, // 仅减仓
    "side": "BUY", // 买卖方向
    "positionSide": "SHORT", // 持仓方向
    "status": "CANCELED", // 订单状态
    "stopPrice": "9300", // 触发价，对`TRAILING_STOP_MARKET`无效
    "closePosition": false,   // 是否条件全平仓
    "symbol": "BTCUSDT", // 交易对
    "timeInForce": "GTC", // 有效方法
    "origType": "TRAILING_STOP_MARKET", // 触发前订单类型
    "type": "TRAILING_STOP_MARKET", // 订单类型
    "activatePrice": "9020", // 跟踪止损激活价格, 仅`TRAILING_STOP_MARKET` 订单返回此字段
    "priceRate": "0.3", // 跟踪止损回调比例, 仅`TRAILING_STOP_MARKET` 订单返回此字段
    "updateTime": 1571110484038, // 更新时间
    "workingType": "CONTRACT_PRICE", // 条件价格触发类型
    "priceProtect": false,            // 是否开启条件单触发保护
    "priceMatch": "NONE",              //盘口价格下单模式
    "selfTradePreventionMode": "NONE", //订单自成交保护模式
    "goodTillDate": 0                  //订单TIF为GTD时的自动取消时间
}

DELETE /fapi/v1/order

权重: 1

Parameters:

名称 类型 是否必需 描述
symbol STRING YES 交易对
orderId LONG NO 系统订单号
origClientOrderId STRING NO 用户自定义的订单号
recvWindow LONG NO
timestamp LONG YES

orderId 与 origClientOrderId 必须至少发送一个

撤销全部订单 (TRADE)

响应:

{
    "code": 200, 
    "msg": "The operation of cancel all open order is done."
}

DELETE /fapi/v1/allOpenOrders

权重: 1

Parameters:

名称 类型 是否必需 描述
symbol STRING YES 交易对
recvWindow LONG NO
timestamp LONG YES

批量撤销订单 (TRADE)

响应:

[
    {
        "clientOrderId": "myOrder1", // 用户自定义的订单号
        "cumQty": "0",
        "cumQuote": "0", // 成交金额
        "executedQty": "0", // 成交量
        "orderId": 283194212, // 系统订单号
        "origQty": "11", // 原始委托数量
        "price": "0", // 委托价格
        "reduceOnly": false, // 仅减仓
        "side": "BUY", // 买卖方向
        "positionSide": "SHORT", // 持仓方向
        "status": "CANCELED", // 订单状态
        "stopPrice": "9300", // 触发价，对`TRAILING_STOP_MARKET`无效
        "closePosition": false,   // 是否条件全平仓
        "symbol": "BTCUSDT", // 交易对
        "timeInForce": "GTC", // 有效方法
        "origType": "TRAILING_STOP_MARKET", // 触发前订单类型
        "type": "TRAILING_STOP_MARKET", // 订单类型
        "activatePrice": "9020", // 跟踪止损激活价格, 仅`TRAILING_STOP_MARKET` 订单返回此字段
        "priceRate": "0.3", // 跟踪止损回调比例, 仅`TRAILING_STOP_MARKET` 订单返回此字段
        "updateTime": 1571110484038, // 更新时间
        "workingType": "CONTRACT_PRICE", // 条件价格触发类型
        "priceProtect": false,            // 是否开启条件单触发保护
        "priceMatch": "NONE",              //盘口价格下单模式
        "selfTradePreventionMode": "NONE", //订单自成交保护模式
        "goodTillDate": 0                  //订单TIF为GTD时的自动取消时间
    },
    {
        "code": -2011,
        "msg": "Unknown order sent."
    }
]

DELETE /fapi/v1/batchOrders

权重: 1

Parameters:

名称 类型 是否必需 描述
symbol STRING YES 交易对
orderIdList LIST<LONG> NO 系统订单号, 最多支持10个订单

比如[1234567,2345678]
origClientOrderIdList LIST<STRING> NO 用户自定义的订单号, 最多支持10个订单

比如["my_id_1","my_id_2"] 需要encode双引号。逗号后面没有空格。
recvWindow LONG NO
timestamp LONG YES

orderIdList 与 origClientOrderIdList 必须至少发送一个，不可同时发送

倒计时撤销所有订单 (TRADE)

响应:

{
    "symbol": "BTCUSDT", 
    "countdownTime": "100000"
}

POST /fapi/v1/countdownCancelAll

权重: 10

Parameters:

名称 类型 是否必需 描述
symbol STRING YES
countdownTime LONG YES 倒计时。 1000 表示 1 秒； 0 表示取消倒计时撤单功能。
recvWindow LONG NO
timestamp LONG YES

查询当前挂单 (USER_DATA)

响应:


{
    "avgPrice": "0.00000",              // 平均成交价
    "clientOrderId": "abc",             // 用户自定义的订单号
    "cumQuote": "0",                        // 成交金额
    "executedQty": "0",                 // 成交量
    "orderId": 1917641,                 // 系统订单号
    "origQty": "0.40",                  // 原始委托数量
    "origType": "TRAILING_STOP_MARKET", // 触发前订单类型
    "price": "0",                   // 委托价格
    "reduceOnly": false,                // 是否仅减仓
    "side": "BUY",                      // 买卖方向
    "status": "NEW",                    // 订单状态
    "positionSide": "SHORT", // 持仓方向
    "stopPrice": "9300",                    // 触发价，对`TRAILING_STOP_MARKET`无效
    "closePosition": false,   // 是否条件全平仓
    "symbol": "BTCUSDT",                // 交易对
    "time": 1579276756075,              // 订单时间
    "timeInForce": "GTC",               // 有效方法
    "type": "TRAILING_STOP_MARKET",     // 订单类型
    "activatePrice": "9020", // 跟踪止损激活价格, 仅`TRAILING_STOP_MARKET` 订单返回此字段
    "priceRate": "0.3", // 跟踪止损回调比例, 仅`TRAILING_STOP_MARKET` 订单返回此字段
    "updateTime": 1579276756075,        // 更新时间
    "workingType": "CONTRACT_PRICE", // 条件价格触发类型
    "priceProtect": false,            // 是否开启条件单触发保护
    "priceMatch": "NONE",             //盘口价格下单模式
    "selfTradePreventionMode": "NONE", //订单自成交保护模式
    "goodTillDate": 0      //订单TIF为GTD时的自动取消时间
}

GET /fapi/v1/openOrder

请小心使用不带symbol参数的调用

权重: 1

参数:

名称 类型 是否必需 描述
symbol STRING YES 交易对
orderId LONG NO 系统订单号
origClientOrderId STRING NO 用户自定义的订单号
recvWindow LONG NO
timestamp LONG YES

查看当前全部挂单 (USER_DATA)

响应:

[
  {
    "avgPrice": "0.00000",              // 平均成交价
    "clientOrderId": "abc",             // 用户自定义的订单号
    "cumQuote": "0",                        // 成交金额
    "executedQty": "0",                 // 成交量
    "orderId": 1917641,                 // 系统订单号
    "origQty": "0.40",                  // 原始委托数量
    "origType": "TRAILING_STOP_MARKET", // 触发前订单类型
    "price": "0",                   // 委托价格
    "reduceOnly": false,                // 是否仅减仓
    "side": "BUY",                      // 买卖方向
    "positionSide": "SHORT", // 持仓方向
    "status": "NEW",                    // 订单状态
    "stopPrice": "9300",                    // 触发价，对`TRAILING_STOP_MARKET`无效
    "closePosition": false,   // 是否条件全平仓
    "symbol": "BTCUSDT",                // 交易对
    "time": 1579276756075,              // 订单时间
    "timeInForce": "GTC",               // 有效方法
    "type": "TRAILING_STOP_MARKET",     // 订单类型
    "activatePrice": "9020", // 跟踪止损激活价格, 仅`TRAILING_STOP_MARKET` 订单返回此字段
    "priceRate": "0.3", // 跟踪止损回调比例, 仅`TRAILING_STOP_MARKET` 订单返回此字段
    "updateTime": 1579276756075,       // 更新时间
    "workingType": "CONTRACT_PRICE",   // 条件价格触发类型
    "priceProtect": false,             // 是否开启条件单触发保护
    "priceMatch": "NONE",              // 盘口价格下单模式
    "selfTradePreventionMode": "NONE", // 订单自成交保护模式
    "goodTillDate": 0                  // 订单TIF为GTD时的自动取消时间
  }
]

GET /fapi/v1/openOrders

请小心使用不带symbol参数的调用

权重: - 带symbol 1 - 不带 40

参数:

名称 类型 是否必需 描述
symbol STRING NO 交易对
recvWindow LONG NO
timestamp LONG YES

查询所有订单(包括历史订单) (USER_DATA)

响应:

[
  {
    "avgPrice": "0.00000",              // 平均成交价
    "clientOrderId": "abc",             // 用户自定义的订单号
    "cumQuote": "0",                        // 成交金额
    "executedQty": "0",                 // 成交量
    "orderId": 1917641,                 // 系统订单号
    "origQty": "0.40",                  // 原始委托数量
    "origType": "TRAILING_STOP_MARKET", // 触发前订单类型
    "price": "0",                   // 委托价格
    "reduceOnly": false,                // 是否仅减仓
    "side": "BUY",                      // 买卖方向
    "positionSide": "SHORT", // 持仓方向
    "status": "NEW",                    // 订单状态
    "stopPrice": "9300",                    // 触发价，对`TRAILING_STOP_MARKET`无效
    "closePosition": false,             // 是否条件全平仓
    "symbol": "BTCUSDT",                // 交易对
    "time": 1579276756075,              // 订单时间
    "timeInForce": "GTC",               // 有效方法
    "type": "TRAILING_STOP_MARKET",     // 订单类型
    "activatePrice": "9020", // 跟踪止损激活价格, 仅`TRAILING_STOP_MARKET` 订单返回此字段
    "priceRate": "0.3", // 跟踪止损回调比例, 仅`TRAILING_STOP_MARKET` 订单返回此字段
    "updateTime": 1579276756075,       // 更新时间
    "workingType": "CONTRACT_PRICE",   // 条件价格触发类型
    "priceProtect": false,             // 是否开启条件单触发保护
    "priceMatch": "NONE",              //盘口价格下单模式
    "selfTradePreventionMode": "NONE", //订单自成交保护模式
    "goodTillDate": 0      //订单TIF为GTD时的自动取消时间
  }
]

GET /fapi/v1/allOrders

权重: 5

Parameters:

名称 类型 是否必需 描述
symbol STRING YES 交易对
orderId LONG NO 只返回此orderID及之后的订单，缺省返回最近的订单
startTime LONG NO 起始时间
endTime LONG NO 结束时间
limit INT NO 返回的结果集数量 默认值:500 最大值:1000
recvWindow LONG NO
timestamp LONG YES

账户余额V3 (USER_DATA)

响应:

[
 {
   "accountAlias": "SgsR",              // 账户唯一识别码
   "asset": "USDT",                       // 资产
   "balance": "122607.35137903",        // 总余额
   "crossWalletBalance": "23.72469206", // 全仓余额
   "crossUnPnl": "0.00000000"           // 全仓持仓未实现盈亏
   "availableBalance": "23.72469206",   // 下单可用余额
   "maxWithdrawAmount": "23.72469206",  // 最大可转出余额
   "marginAvailable": true,             // 是否可用作联合保证金
   "updateTime": 1617939110373
 }
]

GET /fapi/v3/balance

Weight: 5

Parameters:

名称 类型 是否必需 描述
recvWindow LONG NO
timestamp LONG YES

账户余额V2 (USER_DATA)

响应:

[
    {
        "accountAlias": "SgsR",    // 账户唯一识别码
        "asset": "USDT",        // 资产
        "balance": "122607.35137903",   // 总余额
        "crossWalletBalance": "23.72469206", // 全仓余额
        "crossUnPnl": "0.00000000"  // 全仓持仓未实现盈亏
        "availableBalance": "23.72469206",       // 下单可用余额
        "maxWithdrawAmount": "23.72469206",     // 最大可转出余额
        "marginAvailable": true,    // 是否可用作联合保证金
        "updateTime": 1617939110373
    }
]

GET /fapi/v2/balance

Weight: 5

Parameters:

名称 类型 是否必需 描述
recvWindow LONG NO
timestamp LONG YES

账户信息V3 (USER_DATA)

响应:

单资产模式

{   
    "totalInitialMargin": "0.00000000",            // 当前所需起始保证金总额(存在逐仓请忽略), 仅计算usdt资产positions), only for USDT asset
    "totalMaintMargin": "0.00000000",              // 维持保证金总额, 仅计算usdt资产
    "totalWalletBalance": "103.12345678",          // 账户总余额, 仅计算usdt资产
    "totalUnrealizedProfit": "0.00000000",         // 持仓未实现盈亏总额, 仅计算usdt资产
    "totalMarginBalance": "103.12345678",          // 保证金总余额, 仅计算usdt资产
    "totalPositionInitialMargin": "0.00000000",    // 持仓所需起始保证金(基于最新标记价格), 仅计算usdt资产
    "totalOpenOrderInitialMargin": "0.00000000",   // 当前挂单所需起始保证金(基于最新标记价格), 仅计算usdt资产
    "totalCrossWalletBalance": "103.12345678",     // 全仓账户余额, 仅计算usdt资产
    "totalCrossUnPnl": "0.00000000",               // 全仓持仓未实现盈亏总额, 仅计算usdt资产
    "availableBalance": "103.12345678",            // 可用余额, 仅计算usdt资产
    "maxWithdrawAmount": "103.12345678"            // 最大可转出余额, 仅计算usdt资产
    "assets": [ 
        {
            "asset": "USDT",                        // 资产
            "walletBalance": "23.72469206",         // 余额
            "unrealizedProfit": "0.00000000",       // 未实现盈亏
            "marginBalance": "23.72469206",         // 保证金余额
            "maintMargin": "0.00000000",            // 维持保证金
            "initialMargin": "0.00000000",          // 当前所需起始保证金
            "positionInitialMargin": "0.00000000",  // 持仓所需起始保证金(基于最新标记价格)
            "openOrderInitialMargin": "0.00000000", // 当前挂单所需起始保证金(基于最新标记价格)
            "crossWalletBalance": "23.72469206",    // 全仓账户余额
            "crossUnPnl": "0.00000000"              // 全仓持仓未实现盈亏
            "availableBalance": "23.72469206",      // 可用余额
            "maxWithdrawAmount": "23.72469206",     // 最大可转出余额
            "updateTime": 1625474304765             // 更新时间
        },   
        {
            "asset": "USDC",                      
            "walletBalance": "103.12345678",      
            "unrealizedProfit": "0.00000000",     
            "marginBalance": "103.12345678",      
            "maintMargin": "0.00000000",         
            "initialMargin": "0.00000000",   
            "positionInitialMargin": "0.00000000",   
            "openOrderInitialMargin": "0.00000000",  
            "crossWalletBalance": "103.12345678",    
            "crossUnPnl": "0.00000000"      
            "availableBalance": "126.72469206", 
            "maxWithdrawAmount": "103.12345678", 
            "updateTime": 1625474304765 
        }
    ],
    "positions": [  // 仅有仓位或挂单的交易对会被返回
                    // 根据用户持仓模式展示持仓方向，即单向模式下只返回BOTH持仓情况，双向模式下只返回 LONG 和 SHORT 持仓情况
      {
           "symbol": "BTCUSDT",               // 交易对
           "positionSide": "BOTH",            // 持仓方向
           "positionAmt": "1.000",            // 持仓数量
           "unrealizedProfit": "0.00000000",  // 持仓未实现盈亏   
           "isolatedMargin": "0.00000000",  
           "notional": "0",
           "isolatedWallet": "0",
           "initialMargin": "0",              // 持仓所需起始保证金(基于最新标记价格)
           "maintMargin": "0",                // 当前杠杆下用户可用的最大名义价值
           "updateTime": 0                    // 更新时间 
      } 
    ]
}

多资产模式 

{   
    "totalInitialMargin": "0.00000000",          // 以USD计价的所需起始保证金总额
    "totalMaintMargin": "0.00000000",            // 以USD计价的维持保证金总额
    "totalWalletBalance": "126.72469206",        // 以USD计价的账户总余额
    "totalUnrealizedProfit": "0.00000000",       // 以USD计价的持仓未实现盈亏总额
    "totalMarginBalance": "126.72469206",        // 以USD计价的保证金总余额 
    "totalPositionInitialMargin": "0.00000000",  // 以USD计价的持仓所需起始保证金(基于最新标记价格)
    "totalOpenOrderInitialMargin": "0.00000000", // 以USD计价的当前挂单所需起始保证金(基于最新标记价格)
    "totalCrossWalletBalance": "126.72469206",   // 以USD计价的全仓账户余额
    "totalCrossUnPnl": "0.00000000",             // 以USD计价的全仓持仓未实现盈亏总额
    "availableBalance": "126.72469206",          // 以USD计价的可用余额
    "maxWithdrawAmount": "126.72469206"          // 以USD计价的最大可转出余额
    "assets": [
        {
            "asset": "USDT",                        // 资产
            "walletBalance": "23.72469206",         // 余额
            "unrealizedProfit": "0.00000000",       // 未实现盈亏
            "marginBalance": "23.72469206",         // 保证金余额
            "maintMargin": "0.00000000",            // 维持保证金
            "initialMargin": "0.00000000",          // 当前所需起始保证金
            "positionInitialMargin": "0.00000000",  // 持仓所需起始保证金(基于最新标记价格)
            "openOrderInitialMargin": "0.00000000", // 当前挂单所需起始保证金(基于最新标记价格)
            "crossWalletBalance": "23.72469206",    // 全仓账户余额
            "crossUnPnl": "0.00000000"              // 全仓持仓未实现盈亏
            "availableBalance": "23.72469206",      // 可用余额
            "maxWithdrawAmount": "23.72469206",     // 最大可转出余额
            "updateTime": 1625474304765             // 更新时间
        },   
        {
            "asset": "USDC",                      
            "walletBalance": "103.12345678",      
            "unrealizedProfit": "0.00000000",     
            "marginBalance": "103.12345678",      
            "maintMargin": "0.00000000",         
            "initialMargin": "0.00000000",   
            "positionInitialMargin": "0.00000000",   
            "openOrderInitialMargin": "0.00000000",  
            "crossWalletBalance": "103.12345678",    
            "crossUnPnl": "0.00000000"      
            "availableBalance": "126.72469206", 
            "maxWithdrawAmount": "103.12345678", 
            "updateTime": 1625474304765 
        }
    ],
    "positions": [  // 仅有仓位或挂单的交易对会被返回
                    // 根据用户持仓模式展示持仓方向，即单向模式下只返回BOTH持仓情况，双向模式下只返回 LONG 和 SHORT 持仓情况
      {
           "symbol": "BTCUSDT",               // 交易对
           "positionSide": "BOTH",            // 持仓方向
           "positionAmt": "1.000",            // 持仓数量
           "unrealizedProfit": "0.00000000",  // 持仓未实现盈亏   
           "isolatedMargin": "0.00000000",  
           "notional": "0",
           "isolatedWallet": "0",
           "initialMargin": "0",              // 持仓所需起始保证金(基于最新标记价格)
           "maintMargin": "0",                // 当前杠杆下用户可用的最大名义价值
           "updateTime": 0                    // 更新时间 
      } 
    ]
}

GET /fapi/v3/account

现有账户信息。 用户在单资产模式和多资产模式下会看到不同结果，响应部分的注释解释了两种模式下的不同。

权重: 5

参数:

名称 类型 是否必需 描述
recvWindow LONG NO
timestamp LONG YES

账户信息V2 (USER_DATA)

响应:

单资产模式

{
    "feeTier": 0,  // 手续费等级
    "feeBurn": true,        // "true": 手续费抵扣开; "false": 手续费抵扣关
    "canTrade": true,  // 是否可以交易
    "canDeposit": true,  // 是否可以入金
    "canWithdraw": true, // 是否可以出金
    "updateTime": 0,     // 保留字段，请忽略
    "multiAssetsMargin": false,
    "tradeGroupId": -1,
    "totalInitialMargin": "0.00000000",  // 当前所需起始保证金总额(存在逐仓请忽略), 仅计算usdt资产
    "totalMaintMargin": "0.00000000",  // 维持保证金总额, 仅计算usdt资产
    "totalWalletBalance": "23.72469206",   // 账户总余额, 仅计算usdt资产
    "totalUnrealizedProfit": "0.00000000",  // 持仓未实现盈亏总额, 仅计算usdt资产
    "totalMarginBalance": "23.72469206",  // 保证金总余额, 仅计算usdt资产
    "totalPositionInitialMargin": "0.00000000",  // 持仓所需起始保证金(基于最新标记价格), 仅计算usdt资产
    "totalOpenOrderInitialMargin": "0.00000000",  // 当前挂单所需起始保证金(基于最新标记价格), 仅计算usdt资产
    "totalCrossWalletBalance": "23.72469206",  // 全仓账户余额, 仅计算usdt资产
    "totalCrossUnPnl": "0.00000000",    // 全仓持仓未实现盈亏总额, 仅计算usdt资产
    "availableBalance": "23.72469206",       // 可用余额, 仅计算usdt资产
    "maxWithdrawAmount": "23.72469206"     // 最大可转出余额, 仅计算usdt资产
    "assets": [
        {
            "asset": "USDT",        //资产
            "walletBalance": "23.72469206",  //余额
            "unrealizedProfit": "0.00000000",  // 未实现盈亏
            "marginBalance": "23.72469206",  // 保证金余额
            "maintMargin": "0.00000000",    // 维持保证金
            "initialMargin": "0.00000000",  // 当前所需起始保证金
            "positionInitialMargin": "0.00000000",  // 持仓所需起始保证金(基于最新标记价格)
            "openOrderInitialMargin": "0.00000000", // 当前挂单所需起始保证金(基于最新标记价格)
            "crossWalletBalance": "23.72469206",  //全仓账户余额
            "crossUnPnl": "0.00000000" // 全仓持仓未实现盈亏
            "availableBalance": "126.72469206",       // 可用余额
            "maxWithdrawAmount": "23.72469206",     // 最大可转出余额
            "marginAvailable": true,   // 是否可用作联合保证金
            "updateTime": 1625474304765  //更新时间
        },
        {
            "asset": "BUSD",        //资产
            "walletBalance": "103.12345678",  //余额
            "unrealizedProfit": "0.00000000",  // 未实现盈亏
            "marginBalance": "103.12345678",  // 保证金余额
            "maintMargin": "0.00000000",    // 维持保证金
            "initialMargin": "0.00000000",  // 当前所需起始保证金
            "positionInitialMargin": "0.00000000",  // 持仓所需起始保证金(基于最新标记价格)
            "openOrderInitialMargin": "0.00000000", // 当前挂单所需起始保证金(基于最新标记价格)
            "crossWalletBalance": "103.12345678",  //全仓账户余额
            "crossUnPnl": "0.00000000" // 全仓持仓未实现盈亏
            "availableBalance": "126.72469206",       // 可用余额
            "maxWithdrawAmount": "103.12345678",     // 最大可转出余额
            "marginAvailable": true,   // 否可用作联合保证金
            "updateTime": 0  // 更新时间
            }
    ],
    "positions": [  // 头寸，将返回所有市场symbol。
        //根据用户持仓模式展示持仓方向，即单向模式下只返回BOTH持仓情况，双向模式下只返回 LONG 和 SHORT 持仓情况
        {
            "symbol": "BTCUSDT",  // 交易对
            "initialMargin": "0",   // 当前所需起始保证金(基于最新标记价格)
            "maintMargin": "0", //维持保证金
            "unrealizedProfit": "0.00000000",  // 持仓未实现盈亏
            "positionInitialMargin": "0",  // 持仓所需起始保证金(基于最新标记价格)
            "openOrderInitialMargin": "0",  // 当前挂单所需起始保证金(基于最新标记价格)
            "leverage": "100",  // 杠杆倍率
            "isolated": true,  // 是否是逐仓模式
            "entryPrice": "0.00000",  // 持仓成本价
            "maxNotional": "250000",  // 当前杠杆下用户可用的最大名义价值
            "bidNotional": "0",  // 买单净值，忽略
            "askNotional": "0",  // 卖单净值，忽略
            "positionSide": "BOTH",  // 持仓方向
            "positionAmt": "0",      // 持仓数量
            "updateTime": 0         // 更新时间 
        }
    ]
}

多资产模式 

{
    "feeTier": 0,  // 手续费等级
    "feeBurn": true,        // "true": 手续费抵扣开; "false": 手续费抵扣关
    "canTrade": true,  // 是否可以交易
    "canDeposit": true,  // 是否可以入金
    "canWithdraw": true, // 是否可以出金
    "updateTime": 0,     // 保留字段，请忽略
    "multiAssetsMargin": true,
    "tradeGroupId": -1,
    "totalInitialMargin": "0.00000000",  // 以USD计价的所需起始保证金总额
    "totalMaintMargin": "0.00000000",  // 以USD计价的维持保证金总额
    "totalWalletBalance": "126.72469206",   // 以USD计价的账户总余额
    "totalUnrealizedProfit": "0.00000000",  // 以USD计价的持仓未实现盈亏总额
    "totalMarginBalance": "126.72469206",  // 以USD计价的保证金总余额
    "totalPositionInitialMargin": "0.00000000",  // 以USD计价的持仓所需起始保证金(基于最新标记价格)
    "totalOpenOrderInitialMargin": "0.00000000",  // 以USD计价的当前挂单所需起始保证金(基于最新标记价格)
    "totalCrossWalletBalance": "126.72469206",  // 以USD计价的全仓账户余额
    "totalCrossUnPnl": "0.00000000",    // 以USD计价的全仓持仓未实现盈亏总额
    "availableBalance": "126.72469206",       // 以USD计价的可用余额
    "maxWithdrawAmount": "126.72469206"     // 以USD计价的最大可转出余额
    "assets": [
        {
            "asset": "USDT",        //资产
            "walletBalance": "23.72469206",  //余额
            "unrealizedProfit": "0.00000000",  // 未实现盈亏
            "marginBalance": "23.72469206",  // 保证金余额
            "maintMargin": "0.00000000",    // 维持保证金
            "initialMargin": "0.00000000",  // 当前所需起始保证金
            "positionInitialMargin": "0.00000000",  // 持仓所需起始保证金(基于最新标记价格)
            "openOrderInitialMargin": "0.00000000", // 当前挂单所需起始保证金(基于最新标记价格)
            "crossWalletBalance": "23.72469206",  //全仓账户余额
            "crossUnPnl": "0.00000000" // 全仓持仓未实现盈亏
            "availableBalance": "23.72469206",       // 可用余额
            "maxWithdrawAmount": "23.72469206",     // 最大可转出余额
            "marginAvailable": true,   // 是否可用作联合保证金
            "updateTime": 1625474304765  //更新时间
        },
        {
            "asset": "BUSD",        //资产
            "walletBalance": "103.12345678",  //余额
            "unrealizedProfit": "0.00000000",  // 未实现盈亏
            "marginBalance": "103.12345678",  // 保证金余额
            "maintMargin": "0.00000000",    // 维持保证金
            "initialMargin": "0.00000000",  // 当前所需起始保证金
            "positionInitialMargin": "0.00000000",  // 持仓所需起始保证金(基于最新标记价格)
            "openOrderInitialMargin": "0.00000000", // 当前挂单所需起始保证金(基于最新标记价格)
            "crossWalletBalance": "103.12345678",  //全仓账户余额
            "crossUnPnl": "0.00000000" // 全仓持仓未实现盈亏
            "availableBalance": "103.12345678",       // 可用余额
            "maxWithdrawAmount": "103.12345678",     // 最大可转出余额
            "marginAvailable": true,   // 否可用作联合保证金
            "updateTime": 0  // 更新时间
            }
    ],
    "positions": [  // 头寸，将返回所有市场symbol。
        //根据用户持仓模式展示持仓方向，即单向模式下只返回BOTH持仓情况，双向模式下只返回 LONG 和 SHORT 持仓情况
        {
            "symbol": "BTCUSDT",  // 交易对
            "initialMargin": "0",   // 当前所需起始保证金(基于最新标记价格)
            "maintMargin": "0", //维持保证金
            "unrealizedProfit": "0.00000000",  // 持仓未实现盈亏
            "positionInitialMargin": "0",  // 持仓所需起始保证金(基于最新标记价格)
            "openOrderInitialMargin": "0",  // 当前挂单所需起始保证金(基于最新标记价格)
            "leverage": "100",  // 杠杆倍率
            "isolated": true,  // 是否是逐仓模式
            "entryPrice": "0.00000",  // 持仓成本价
            "breakEvenPrice": "0.0",  // 持仓成本价
            "maxNotional": "250000",  // 当前杠杆下用户可用的最大名义价值
            "bidNotional": "0",  // 买单净值，忽略
            "askNotional": "0",  // 买单净值，忽略
            "positionSide": "BOTH",  // 持仓方向
            "positionAmt": "0",      // 持仓数量
            "updateTime": 0         // 更新时间 
        }
    ]
}

GET /fapi/v2/account

现有账户信息。 用户在单资产模式和多资产模式下会看到不同结果，响应部分的注释解释了两种模式下的不同。

权重: 5

参数:

名称 类型 是否必需 描述
recvWindow LONG NO
timestamp LONG YES

调整开仓杠杆 (TRADE)

响应:

{
    "leverage": 21, // 杠杆倍数
    "maxNotionalValue": "1000000", // 当前杠杆倍数下允许的最大名义价值
    "symbol": "BTCUSDT" // 交易对
}

POST /fapi/v1/leverage

调整用户在指定symbol合约的开仓杠杆。

权重: 1

参数:

名称 类型 是否必需 描述
symbol STRING YES 交易对
leverage INT YES 目标杠杆倍数：1 到 125 整数
recvWindow LONG NO
timestamp LONG YES

变换逐全仓模式 (TRADE)

响应:

{
    "code": 200,
    "msg": "success"
}

POST /fapi/v1/marginType

变换用户在指定symbol合约上的保证金模式：逐仓或全仓。

权重: 1

参数:

名称 类型 是否必需 描述
symbol STRING YES 交易对
marginType ENUM YES 保证金模式 ISOLATED(逐仓), CROSSED(全仓)
recvWindow LONG NO
timestamp LONG YES

调整逐仓保证金 (TRADE)

响应:

{
    "amount": 100.0,
    "code": 200,
    "msg": "Successfully modify position margin.",
    "type": 1
}

POST /fapi/v1/positionMargin

针对逐仓模式下的仓位，调整其逐仓保证金资金。

权重: 1

参数:

名称 类型 是否必需 描述
symbol STRING YES 交易对
positionSide ENUM NO 持仓方向，单向持仓模式下非必填，默认且仅可填BOTH;在双向持仓模式下必填,且仅可选择 LONG 或 SHORT
amount DECIMAL YES 保证金资金
type INT YES 调整方向 1: 增加逐仓保证金，2: 减少逐仓保证金
recvWindow LONG NO
timestamp LONG YES

逐仓保证金变动历史 (TRADE)

响应:

[
    {
        "symbol": "BTCUSDT", // 交易对
        "type": 1,  // 调整方向
        "deltaType": "USER_ADJUST", // 划转类型
        "amount": "23.36332311", // 数量
        "asset": "USDT", // 资产
        "time": 1578047897183, // 时间
        "positionSide": "BOTH"  // 持仓方向
    },
    {
        "symbol": "BTCUSDT",
        "type": 1, 
        "deltaType": "USER_ADJUST",
        "amount": "100",
        "asset": "USDT",
        "time": 1578047900425,
        "positionSide": "LONG" 
    }
]

GET /fapi/v1/positionMargin/history

权重: 1

参数:

名称 类型 是否必需 描述
symbol STRING YES 交易对
type INT NO 调整方向 1: 增加逐仓保证金，2: 减少逐仓保证金
startTime LONG NO 起始时间
endTime LONG NO 结束时间，默认为当前时间
limit INT NO 返回的结果集数量 默认值: 500
recvWindow LONG NO
timestamp LONG YES

用户持仓风险V3 (USER_DATA)

响应:

单向持仓模式下：

[
  {
        "symbol": "ADAUSDT",
        "positionSide": "LONG",               // position side 
        "positionAmt": "30",
        "entryPrice": "0.385",
        "breakEvenPrice": "0.385077",
        "markPrice": "0.41047590",
        "unRealizedProfit": "0.76427700",     // unrealized profit  
        "liquidationPrice": "0",
        "isolatedMargin": "0",
        "notional": "12.31427700",
        "marginAsset": "USDT",
        "isolatedWallet": "0",
        "initialMargin": "0.61571385",        // initial margin required with current mark price 
        "maintMargin": "0.08004280",          // maintenance margin required
        "positionInitialMargin": "0.61571385",// initial margin required for positions with current mark price
        "openOrderInitialMargin": "0",        // initial margin required for open orders with current mark price 
        "adl": 2,
        "bidNotional": "0",                   // bids notional, ignore
        "askNotional": "0",                   // ask notional, ignore
        "updateTime": 1720736417660
  },
  {
        "symbol": "COMPUSDT",
        "positionSide": "SHORT",
        "positionAmt": "-1.000",
        "entryPrice": "70.92841",
        "breakEvenPrice": "70.900038636",
        "markPrice": "49.72023376",
        "unRealizedProfit": "21.20817624",
        "liquidationPrice": "2260.56757210",
        "isolatedMargin": "0",
        "notional": "-49.72023376",
        "marginAsset": "USDT",
        "isolatedWallet": "0",
        "initialMargin": "2.48601168",
        "maintMargin": "0.49720233",
        "positionInitialMargin": "2.48601168",
        "openOrderInitialMargin": "0",
        "adl": 2,
        "bidNotional": "0",
        "askNotional": "0",
        "updateTime": 1708943511656
  }
]

双向持仓模式下：

[
    {
        "symbol": "BTCUSDT", // 交易对
        "positionAmt": "0.001", // 头寸数量，符号代表多空方向, 正数为多，负数为空
        "entryPrice": "22185.2", // 开仓均价
        "breakEvenPrice": "0.0",  // 盈亏平衡价
        "markPrice": "21123.05052574", // 当前标记价格
        "unRealizedProfit": "-1.06214947", // 持仓未实现盈亏
        "liquidationPrice": "19731.45529116", // 参考强平价格
        "leverage": "4", // 当前杠杆倍数
        "maxNotionalValue": "100000000", // 当前杠杆倍数允许的名义价值上限
        "marginType": "cross", // 逐仓模式或全仓模式
        "isolatedMargin": "0.00000000", // 逐仓保证金
        "isAutoAddMargin": "false",
        "positionSide": "LONG", // 持仓方向
        "notional": "21.12305052",
        "isolatedWallet": "0",
        "updateTime": 1655217461579 //更新时间
    },
    {
        "symbol": "BTCUSDT",
        "positionAmt": "0.000",
        "entryPrice": "0.0",
        "breakEvenPrice": "0.0",  
        "markPrice": "21123.05052574",
        "unRealizedProfit": "0.00000000",
        "liquidationPrice": "0",
        "leverage": "4",
        "maxNotionalValue": "100000000",
        "marginType": "cross",
        "isolatedMargin": "0.00000000",
        "isAutoAddMargin": "false",
        "positionSide": "SHORT",
        "notional": "0",
        "isolatedWallet": "0",
        "updateTime": 0
    }
]

GET /fapi/v3/positionRisk

查询持仓风险，仅返回有持仓或挂单的交易对

权重: 5

参数:

名称 类型 是否必需 描述
symbol STRING NO
recvWindow LONG NO
timestamp LONG YES

注意
请与账户推送信息ACCOUNT_UPDATE配合使用，以满足您的及时性和准确性需求。

用户持仓风险V2 (USER_DATA)

响应:

单向持仓模式下：

[
    {
        "entryPrice": "0.00000",  // 开仓均价
        "breakEvenPrice": "0.0",  // 盈亏平衡价
        "marginType": "isolated", // 逐仓模式或全仓模式
        "isAutoAddMargin": "false",
        "isolatedMargin": "0.00000000", // 逐仓保证金
        "leverage": "10", // 当前杠杆倍数
        "liquidationPrice": "0", // 参考强平价格
        "markPrice": "6679.50671178",   // 当前标记价格
        "maxNotionalValue": "20000000", // 当前杠杆倍数允许的名义价值上限
        "positionAmt": "0.000", // 头寸数量，符号代表多空方向, 正数为多，负数为空
        "notional": "0",
        "isolatedWallet": "0",
        "symbol": "BTCUSDT", // 交易对
        "unRealizedProfit": "0.00000000", // 持仓未实现盈亏
        "positionSide": "BOTH", // 持仓方向
        "updateTime": 1625474304765   // 更新时间
    }
]

双向持仓模式下：

[
    {
        "symbol": "BTCUSDT", // 交易对
        "positionAmt": "0.001", // 头寸数量，符号代表多空方向, 正数为多，负数为空
        "entryPrice": "22185.2", // 开仓均价
        "breakEvenPrice": "0.0",  // 盈亏平衡价
        "markPrice": "21123.05052574", // 当前标记价格
        "unRealizedProfit": "-1.06214947", // 持仓未实现盈亏
        "liquidationPrice": "19731.45529116", // 参考强平价格
        "leverage": "4", // 当前杠杆倍数
        "maxNotionalValue": "100000000", // 当前杠杆倍数允许的名义价值上限
        "marginType": "cross", // 逐仓模式或全仓模式
        "isolatedMargin": "0.00000000", // 逐仓保证金
        "isAutoAddMargin": "false",
        "positionSide": "LONG", // 持仓方向
        "notional": "21.12305052",
        "isolatedWallet": "0",
        "updateTime": 1655217461579 //更新时间
    },
    {
        "symbol": "BTCUSDT",
        "positionAmt": "0.000",
        "entryPrice": "0.0",
        "breakEvenPrice": "0.0",  
        "markPrice": "21123.05052574",
        "unRealizedProfit": "0.00000000",
        "liquidationPrice": "0",
        "leverage": "4",
        "maxNotionalValue": "100000000",
        "marginType": "cross",
        "isolatedMargin": "0.00000000",
        "isAutoAddMargin": "false",
        "positionSide": "SHORT",
        "notional": "0",
        "isolatedWallet": "0",
        "updateTime": 0
    }
]

GET /fapi/v2/positionRisk

权重: 5

参数:

名称 类型 是否必需 描述
symbol STRING NO
recvWindow LONG NO
timestamp LONG YES

注意
请与账户推送信息ACCOUNT_UPDATE配合使用，以满足您的及时性和准确性需求。

账户成交历史 (USER_DATA)

响应:

[
  {
    "buyer": false, // 是否是买方
    "commission": "-0.07819010", // 手续费
    "commissionAsset": "USDT", // 手续费计价单位
    "id": 698759,   // 交易ID
    "maker": false, // 是否是挂单方
    "orderId": 25851813, // 订单编号
    "price": "7819.01", // 成交价
    "qty": "0.002", // 成交量
    "quoteQty": "15.63802", // 成交额
    "realizedPnl": "-0.91539999",   // 实现盈亏
    "side": "SELL", // 买卖方向
    "positionSide": "SHORT",  // 持仓方向
    "symbol": "BTCUSDT", // 交易对
    "time": 1569514978020 // 时间
  }
]

GET /fapi/v1/userTrades

获取某交易对的成交历史

权重: 5

参数:

名称 类型 是否必需 描述
symbol STRING YES 交易对
orderId LONG NO 必须要和参数symbol一起使用
startTime LONG NO 起始时间
endTime LONG NO 结束时间
fromId LONG NO 返回该fromId及之后的成交，缺省返回最近的成交
limit INT NO 返回的结果集数量 默认值:500 最大值:1000.
recvWindow LONG NO
timestamp LONG YES

获取账户损益资金流水 (USER_DATA)

响应:

[
    {
        "symbol": "", // 交易对，仅针对涉及交易对的资金流
        "incomeType": "TRANSFER",   // 资金流类型
        "income": "-0.37500000", // 资金流数量，正数代表流入，负数代表流出
        "asset": "USDT", // 资产内容
        "info":"TRANSFER", // 备注信息，取决于流水类型
        "time": 1570608000000, // 时间
        "tranId":"9689322392",      // 划转ID
        "tradeId":""                    // 引起流水产生的原始交易ID
    },
    {
        "symbol": "BTCUSDT",
        "incomeType": "COMMISSION", 
        "income": "-0.01000000",
        "asset": "USDT",
        "info":"COMMISSION",
        "time": 1570636800000,
        "tranId":"9689322392",      
        "tradeId": 2059192                  
    }
]

GET /fapi/v1/income

权重: 30

参数:

名称 类型 是否必需 描述
symbol STRING NO 交易对
incomeType STRING NO 收益类型： TRANSFER 转账, WELCOME_BONUS 欢迎奖金, REALIZED_PNL 已实现盈亏, FUNDING_FEE 资金费用, COMMISSION 手续费, INSURANCE_CLEAR 强平, REFERRAL_KICKBACK 推荐人返佣, COMMISSION_REBATE 被推荐人返佣, API_REBATE API佣金回扣, CONTEST_REWARD 交易大赛奖金, CROSS_COLLATERAL_TRANSFER cc转账, OPTIONS_PREMIUM_FEE 期权购置手续费, OPTIONS_SETTLE_PROFIT 期权行权收益, INTERNAL_TRANSFER 内部账户，给普通用户划转, AUTO_EXCHANGE 自动兑换, DELIVERED_SETTELMENT 下架结算, COIN_SWAP_DEPOSIT 闪兑转入, COIN_SWAP_WITHDRAW 闪兑转出, POSITION_LIMIT_INCREASE_FEE 仓位限制上调费用
startTime LONG NO 起始时间
endTime LONG NO 结束时间
page INT NO 分页数
limit INT NO 返回的结果集数量 默认值:100 最大值:1000
recvWindow LONG NO
timestamp LONG YES

杠杆分层标准 (USER_DATA)

响应:

[
    {
        "symbol": "ETHUSDT",
        "notionalCoef": 1.50,   //用户bracket相对默认bracket的倍数，仅在和交易对默认不一样时显示
        "brackets": [
            {
                "bracket": 1,   // 层级
                "initialLeverage": 75,  // 该层允许的最高初始杠杆倍数
                "notionalCap": 10000,  // 该层对应的名义价值上限
                "notionalFloor": 0,  // 该层对应的名义价值下限 
                "maintMarginRatio": 0.0065, // 该层对应的维持保证金率
                "cum":0 // 速算数
            },
        ]
    }
]

或 (若发送symbol)


{
    "symbol": "ETHUSDT",
    "notionalCoef": 1.50,
    "brackets": [
        {
            "bracket": 1,
            "initialLeverage": 75,
            "notionalCap": 10000,
            "notionalFloor": 0,
            "maintMarginRatio": 0.0065,
            "cum":0
        },
    ]
}

GET /fapi/v1/leverageBracket

权重: 1

参数:

名称 类型 是否必需 描述
symbol STRING NO
recvWindow LONG NO
timestamp LONG YES

持仓ADL队列估算 (USER_DATA)

响应:

[
    {
        "symbol": "ETHUSDT", 
        "adlQuantile": 
            {
                // 对于全仓状态下的双向持仓模式的交易对，会返回 "LONG", "SHORT" 和 "HEDGE", 其中"HEDGE"的存在仅作为标记;如果多空均有持仓的情况下,"LONG"和"SHORT"应返回共同计算后相同的队列分数。
                "LONG": 3,  
                "SHORT": 3, 
                "HEDGE": 0   // HEDGE 仅作为指示出现，请忽略数值
            }
        },
    {
        "symbol": "BTCUSDT", 
        "adlQuantile": 
            {
                // 对于单向持仓模式或者是逐仓状态下的双向持仓模式的交易对，会返回 "LONG", "SHORT" 和 "BOTH" 分别表示不同持仓方向上持仓的adl队列分数
                "LONG": 1,  // 双开模式下多头持仓的ADL队列估算分
                "SHORT": 2,     // 双开模式下空头持仓的ADL队列估算分
                "BOTH": 0       // 单开模式下持仓的ADL队列估算分
            }
    }
 ]

GET /fapi/v1/adlQuantile

权重: 5

参数:

名称 类型 是否必需 描述
symbol STRING NO
recvWindow LONG NO
timestamp LONG YES

用户强平单历史 (USER_DATA)

响应:

[
  {
    "orderId": 6071832819, 
    "symbol": "BTCUSDT", 
    "status": "FILLED", 
    "clientOrderId": "autoclose-1596107620040000020", 
    "price": "10871.09", 
    "avgPrice": "10913.21000", 
    "origQty": "0.001", 
    "executedQty": "0.001", 
    "cumQuote": "10.91321", 
    "timeInForce": "IOC", 
    "type": "LIMIT", 
    "reduceOnly": false, 
    "closePosition": false, 
    "side": "SELL", 
    "positionSide": "BOTH", 
    "stopPrice": "0", 
    "workingType": "CONTRACT_PRICE", 
    "origType": "LIMIT", 
    "time": 1596107620044, 
    "updateTime": 1596107620087
  }
  {
    "orderId": 6072734303, 
    "symbol": "BTCUSDT", 
    "status": "FILLED", 
    "clientOrderId": "adl_autoclose", 
    "price": "11023.14", 
    "avgPrice": "10979.82000", 
    "origQty": "0.001", 
    "executedQty": "0.001", 
    "cumQuote": "10.97982", 
    "timeInForce": "GTC", 
    "type": "LIMIT", 
    "reduceOnly": false, 
    "closePosition": false, 
    "side": "BUY", 
    "positionSide": "SHORT", 
    "stopPrice": "0", 
    "workingType": "CONTRACT_PRICE", 
    "origType": "LIMIT", 
    "time": 1596110725059, 
    "updateTime": 1596110725071
  }
]

GET /fapi/v1/forceOrders

权重: 带symbol 20, 不带symbol 50

参数:

名称 类型 是否必需 描述
symbol STRING NO
autoCloseType ENUM NO "LIQUIDATION": 强平单, "ADL": ADL减仓单.
startTime LONG NO
endTime LONG NO
limit INT NO Default 50; max 100.
recvWindow LONG NO
timestamp LONG YES

合约交易量化规则指标 (USER_DATA)

响应:

{
    "indicators": { // indicator:风控指标名, value:用户在该市场的风控指标数值, triggerValue:阈值, 对于没有达到记录阈值的则不返回数据。
        "BTCUSDT": [
            {
                "isLocked": true, // 用户该品种交易是否被风控禁用
                "plannedRecoverTime": 1545741270000, // 预计恢复时间，若当前时间大等于预计恢复时间则为空
                "indicator": "UFR",  // Unfilled Ratio (UFR)
                "value": 0.05,  // Current value
                "triggerValue": 0.995  // Trigger value
            },
            {
                "isLocked": true, // 用户该品种交易是否被风控禁用
                "plannedRecoverTime": 1545741270000,
                "indicator": "IFER",  // IOC/FOK Expiration Ratio (IFER)
                "value": 0.99,  // Current value
                "triggerValue": 0.99  // Trigger value
            },
            {
                "isLocked": true, // 用户该品种交易是否被风控禁用
                "plannedRecoverTime": 1545741270000,
                "indicator": "GCR",  // GTC Cancellation Ratio (GCR)
                "value": 0.99,  // Current value
                "triggerValue": 0.99  // Trigger value
            },
            {
                "isLocked": true, // 用户该品种交易是否被风控禁用
                "plannedRecoverTime": 1545741270000,
                "indicator": "DR",  // Dust Ratio (DR)
                "value": 0.99,  // Current value
                "triggerValue": 0.99  // Trigger value
            }
        ],
        "ETHUSDT": [
            {
                "isLocked": true, // 用户该品种交易是否被风控禁用
                "plannedRecoverTime": 1545741270000,
                "indicator": "UFR",
                "value": 0.05,
                "triggerValue": 0.995
            },
            {
                "isLocked": true, // 用户该品种交易是否被风控禁用
                "plannedRecoverTime": 1545741270000,
                "indicator": "IFER",
                "value": 0.99,
                "triggerValue": 0.99
            },
            {
                "isLocked": true, // 用户该品种交易是否被风控禁用
                "plannedRecoverTime": 1545741270000,
                "indicator": "GCR",
                "value": 0.99,
                "triggerValue": 0.99
            }
            {
                "isLocked": true, // 用户该品种交易是否被风控禁用
                "plannedRecoverTime": 1545741270000,
                "indicator": "DR",
                "value": 0.99,
                "triggerValue": 0.99
            }
        ]
    },
    "updateTime": 1545741270000 // 返回值的更新时间
}

或(触发账号层级违规时)

{
    "indicators":{
        "ACCOUNT":[
            {
                "indicator":"TMV",  //  Too many violations 多交易对触发账号层级违规
                "value":10,
                "triggerValue":1,
                "plannedRecoverTime":1644919865000,
                "isLocked":true
            }
        ]
    },
    "updateTime":1644913304748
}

GET /fapi/v1/apiTradingStatus

权重:

参数:

名称 类型 是否必需 描述
symbol STRING NO
recvWindow LONG NO
timestamp LONG YES

账户配置 (USER_DATA)

响应:

{   
    "feeTier": 0,               // 费率等级
    "canTrade": true,           // 是否可以交易
    "canDeposit": true,         // 是否可以存款
    "canWithdraw": true,        // 是否可以提现
    "dualSidePosition": true,
    "updateTime": 0,            // 忽略
    "multiAssetsMargin": false,
    "tradeGroupId": -1
}

GET /fapi/v1/accountConfig

查询账户配置

权重: 5

参数:

名称 类型 是否必需 描述
recvWindow LONG NO
timestamp LONG YES

交易对配置(USER_DATA)

响应:

[
  {
  "symbol": "BTCUSDT", 
  "marginType": "CROSSED",
  "isAutoAddMargin": "false",
  "leverage": 21,
  "maxNotionalValue": "1000000",
  }
]

GET /fapi/v1/symbolConfig

查询交易对上的基础配置

权重: 5

参数:

名称 类型 是否必需 描述
symbol STRING NO 交易对
recvWindow LONG NO
timestamp LONG YES

用户手续费率 (USER_DATA)

响应:

{
    "symbol": "BTCUSDT",
    "makerCommissionRate": "0.0002",  // 0.02%
    "takerCommissionRate": "0.0004"   // 0.04%
}

GET /fapi/v1/commissionRate

权重: 20

参数:

名称 类型 是否必需 描述
symbol STRING YES
recvWindow LONG NO
timestamp LONG YES

查询用户下单限频 (USER_DATA)

响应:

[
  {
    "rateLimitType": "ORDERS",
    "interval": "SECOND",
    "intervalNum": 10,
    "limit": 10000,
  },
  {
    "rateLimitType": "ORDERS",
    "interval": "MINUTE",
    "intervalNum": 1,
    "limit": 20000,
  }
]

GET /fapi/v1/rateLimit/order

权重: 1

参数:

名称 类型 是否必需 描述
recvWindow LONG NO
timestamp LONG YES

获取合约资金流水下载Id (USER_DATA)

响应:

{
    "avgCostTimestampOfLast30d":7241837, //过去30天平均数据下载时间
    "downloadId":"546975389218332672",   //下载Id
}

GET /fapi/v1/income/asyn

权重: 1500

参数:

名称 类型 是否必需 描述
startTime LONG YES 起始时间，ms格式时间戳
endTime LONG YES 结束时间，ms格式时间戳
recvWindow LONG NO
timestamp LONG YES

通过下载Id获取合约资金流水下载链接 (USER_DATA)

响应:

{
    "downloadId":"545923594199212032", // 下载Id
    "status":"completed",     // 状态，枚举类型：completed 已完成，processing 处理中
    "url":"www.binance.com",  // 适配该笔ID请求的下载链接       
    "notified":true,          // 忽略
    "expirationTimestamp":1645009771000,  // 晚于该时间戳之后链接将自动失效
    "isExpired":null,
}

或 (服务器仍在处理中会返回)

{
    "downloadId":"545923594199212032",
    "status":"processing",
    "url":"", 
    "notified":false,
    "expirationTimestamp":-1
    "isExpired":null,
}

GET /fapi/v1/income/asyn/id

权重: 10

参数:

名称 类型 是否必需 描述
downloadId STRING YES 通过下载id 接口获取
recvWindow LONG NO
timestamp LONG YES

获取合约订单历史下载Id (USER_DATA)

响应:

{
    "avgCostTimestampOfLast30d":7241837, //过去30天平均数据下载时间
    "downloadId":"546975389218332672",   //下载Id
}

GET /fapi/v1/order/asyn

权重: 1500

参数:

名称 类型 是否必需 描述
startTime LONG YES 起始时间，ms格式时间戳
endTime LONG YES 结束时间，ms格式时间戳
recvWindow LONG NO
timestamp LONG YES

通过下载Id获取合约订单下载链接 (USER_DATA)

响应:

{
    "downloadId":"545923594199212032", // 下载Id
    "status":"completed",     // 状态，枚举类型：completed 已完成，processing 处理中
    "url":"www.binance.com",  // 适配该笔ID请求的下载链接       
    "notified":true,          // 忽略
    "expirationTimestamp":1645009771000,  // 晚于该时间戳之后链接将自动失效
    "isExpired":null,   
}

或 (服务器仍在处理中会返回)

{
    "downloadId":"545923594199212032",
    "status":"processing",
    "url":"", 
    "notified":false,
    "expirationTimestamp":-1
    "isExpired":null,
}

GET /fapi/v1/order/asyn/id

权重: 10

参数:

名称 类型 是否必需 描述
downloadId STRING YES 通过下载id 接口获取
recvWindow LONG NO
timestamp LONG YES

获取合约交易历史下载Id (USER_DATA)

响应:

{
    "avgCostTimestampOfLast30d":7241837, //过去30天平均数据下载时间
    "downloadId":"546975389218332672",   //下载Id
}

GET /fapi/v1/trade/asyn

权重: 1500

参数:

名称 类型 是否必需 描述
startTime LONG YES 起始时间，ms格式时间戳
endTime LONG YES 结束时间，ms格式时间戳
recvWindow LONG NO
timestamp LONG YES

通过下载Id获取合约交易历史下载链接 (USER_DATA)

响应:

{
    "downloadId":"545923594199212032", // 下载Id
    "status":"completed",     // 状态，枚举类型：completed 已完成，processing 处理中
    "url":"www.binance.com",  // 适配该笔ID请求的下载链接       
    "notified":true,          // 忽略
    "expirationTimestamp":1645009771000,  // 晚于该时间戳之后链接将自动失效
    "isExpired":null,
}

或 (服务器仍在处理中会返回)

{
    "downloadId":"545923594199212032",
    "status":"processing",
    "url":"", 
    "notified":false,
    "expirationTimestamp":-1
    "isExpired":null,   
}

GET /fapi/v1/trade/asyn/id

权重: 10

参数:

名称 类型 是否必需 描述
downloadId STRING YES 通过下载id 接口获取
recvWindow LONG NO
timestamp LONG YES

Websocket 账户信息推送

生成listenKey (USER_STREAM)

响应:

{
  "listenKey": "pqia91ma19a5s61cv6a81va65sdf19v8a65a1a5s61cv6a81va65sdf19v8a65a1"
}

POST /fapi/v1/listenKey

创建一个新的user data stream，返回值为一个listenKey，即websocket订阅的stream名称。如果该帐户具有有效的listenKey，则将返回该listenKey并将其有效期延长60分钟。在极少数情况下，在该帐户具有有效的listenKey时本接口依然会生成新的listenKey，请使用该listenKey重新建议连接。不建议用本接口延长listenKey，建议用PUT /fapi/v1/listenKey延长listenkey

权重: 1

参数:

None

延长listenKey有效期 (USER_STREAM)

响应:

{
    "listenKey": "3HBntNTepshgEdjIwSUIBgB9keLyOCg5qv3n6bYAtktG8ejcaW5HXz9Vx1JgIieg" // 被延长的listenkey
}

PUT /fapi/v1/listenKey

有效期延长至本次调用后60分钟。如收到-1125报错提示此listenKey不存在，建议重新使用POST /fapi/v1/listenKey生成listenKey并用新listenKey建立连接

权重: 1

参数:

None

关闭listenKey (USER_STREAM)

响应:

{}

DELETE /fapi/v1/listenKey

关闭某账户数据流

权重: 1

参数:

None

listenKey 过期推送

Payload:

{
    "stream": "OfYGbUzi3PraNagEkdKuFwUHn48brFsItTdsuiIXrucEvD0rhRXZ7I6URWfE8YE8",
    "data": {
        "e": "listenKeyExpired",   // 事件类型
        "E": "1699596037418",      // 事件时间
        "listenKey": "OfYGbUzi3PraNagEkdKuFwUHn48brFsItTdsuiIXrucEvD0rhRXZ7I6URWfE8YE8"
    }
}

当前连接使用的有效listenKey过期时，user data stream 将会推送此事件。

注意:

Websocket 账户信息请求(将被弃用)

请求格式

响应

{
    "result"[
        {
            "req":"<listenKey>@account",   // request name 1
            "res":            // request name 1 的请求结果
                ...
        },
        {
            "req":"<listenKey>@balance",   // request name 2 (如有)
            "res":            // request name 2 的请求结果 (如有)
                ...
        }
    ]
    "id": 12     // ID
}

追加保证金通知

Payload:

{
    "e":"MARGIN_CALL",      // 事件类型
    "E":1587727187525,      // 事件时间
    "cw":"3.16812045",      // 除去逐仓仓位保证金的钱包余额, 仅在全仓 margin call 情况下推送此字段
    "p":[                   // 涉及持仓
      {
        "s":"ETHUSDT",      // symbol
        "ps":"LONG",        // 持仓方向
        "pa":"1.327",       // 仓位
        "mt":"CROSSED",     // 保证金模式
        "iw":"0",           // 若为逐仓，仓位保证金
        "mp":"187.17127",   // 标记价格
        "up":"-1.166074",   // 未实现盈亏
        "mm":"1.614445"     // 持仓需要的维持保证金
      }
    ]
}

Balance和Position更新推送

Payload:

{
  "e": "ACCOUNT_UPDATE",                // 事件类型
  "E": 1564745798939,                   // 事件时间
  "T": 1564745798938 ,                  // 撮合时间
  "a":                                  // 账户更新事件
    {
      "m":"ORDER",                      // 事件推出原因 
      "B":[                             // 余额信息
        {
          "a":"USDT",                   // 资产名称
          "wb":"122624.12345678",       // 钱包余额
          "cw":"100.12345678",          // 除去逐仓仓位保证金的钱包余额
          "bc":"50.12345678"            // 除去盈亏与交易手续费以外的钱包余额改变量
        },
        {
          "a":"BUSD",           
          "wb":"1.00000000",
          "cw":"0.00000000",         
          "bc":"-49.12345678"
        }
      ],
      "P":[
       {
          "s":"BTCUSDT",            // 交易对
          "pa":"0",                 // 仓位
          "ep":"0.00000",           // 入仓价格
          "bep":"0",                // 盈亏平衡价
          "cr":"200",               // (费前)累计实现损益
          "up":"0",                 // 持仓未实现盈亏
          "mt":"isolated",          // 保证金模式
          "iw":"0.00000000",        // 若为逐仓，仓位保证金
          "ps":"BOTH"               // 持仓方向
       }，
       {
          "s":"BTCUSDT",
          "pa":"20",
          "ep":"6563.66500",
          "bep":"6563.6",
          "cr":"0",
          "up":"2850.21200",
          "mt":"isolated",
          "iw":"13200.70726908",
          "ps":"LONG"
       },
       {
          "s":"BTCUSDT",
          "pa":"-10",
          "ep":"6563.86000",
          "bep":"6563.6", 
          "cr":"-45.04000000",
          "up":"-1423.15600",
          "mt":"isolated",
          "iw":"6570.42511771",
          "ps":"SHORT"
       }
      ]
    }
}

账户更新事件的 event type 固定为 ACCOUNT_UPDATE

订单/交易 更新推送

Payload:

{
  "e":"ORDER_TRADE_UPDATE",         // 事件类型
  "E":1568879465651,                // 事件时间
  "T":1568879465650,                // 撮合时间
  "o":{                             
    "s":"BTCUSDT",                  // 交易对
    "c":"TEST",                     // 客户端自定订单ID
      // 特殊的自定义订单ID:
      // "autoclose-"开头的字符串: 系统强平订单
      // "adl_autoclose": ADL自动减仓订单
      // "settlement_autoclose-": 下架或交割的结算订单
    "S":"SELL",                     // 订单方向
    "o":"TRAILING_STOP_MARKET",     // 订单类型
    "f":"GTC",                      // 有效方式
    "q":"0.001",                    // 订单原始数量
    "p":"0",                        // 订单原始价格
    "ap":"0",                       // 订单平均价格
    "sp":"7103.04",                 // 条件订单触发价格，对追踪止损单无效
    "x":"NEW",                      // 本次事件的具体执行类型
    "X":"NEW",                      // 订单的当前状态
    "i":8886774,                    // 订单ID
    "l":"0",                        // 订单末次成交量
    "z":"0",                        // 订单累计已成交量
    "L":"0",                        // 订单末次成交价格
    "N": "USDT",                    // 手续费资产类型
    "n": "0",                       // 手续费数量
    "T":1568879465650,              // 成交时间
    "t":0,                          // 成交ID
    "b":"0",                        // 买单净值
    "a":"9.91",                     // 卖单净值
    "m": false,                     // 该成交是作为挂单成交吗？
    "R":false   ,                   // 是否是只减仓单
    "wt": "CONTRACT_PRICE",         // 触发价类型
    "ot": "TRAILING_STOP_MARKET",   // 原始订单类型
    "ps":"LONG"                     // 持仓方向
    "cp":false,                     // 是否为触发平仓单; 仅在条件订单情况下会推送此字段
    "AP":"7476.89",                 // 追踪止损激活价格, 仅在追踪止损单时会推送此字段
    "cr":"5.0",                     // 追踪止损回调比例, 仅在追踪止损单时会推送此字段
    "pP": false,                    // 是否开启条件单触发保护
    "si": 0,                        // 忽略
    "ss": 0,                        // 忽略
    "rp":"0",                       // 该交易实现盈亏
    "V":"EXPIRE_TAKER",             // 自成交防止模式
    "pm":"OPPONENT",                // 价格匹配模式
    "gtd":0                         // TIF为GTD的订单自动取消时间
  }
}

当有新订单创建、订单有新成交或者新的状态变化时会推送此类事件 事件类型统一为 ORDER_TRADE_UPDATE

订单方向

订单类型

本次事件的具体执行类型

订单状态

有效方式:

强平和ADL:

杠杆倍数等账户配置 更新推送

Payload:

{
    "e":"ACCOUNT_CONFIG_UPDATE",       // 事件类型
    "E":1611646737479,                 // 事件时间
    "T":1611646737476,                 // 撮合时间
    "ac":{                              
    "s":"BTCUSDT",                     // 交易对
    "l":25                             // 杠杆倍数

    }
}

Or

{
    "e":"ACCOUNT_CONFIG_UPDATE",       // 事件类型
    "E":1611646737479,                 // 事件时间
    "T":1611646737476,                 // 撮合时间
    "ai":{                             // 用户账户配置
    "j":true                           // 联合保证金状态
    }
}

当账户配置发生变化时会推送此类事件类型统一为ACCOUNT_CONFIG_UPDATE

当交易对杠杆倍数发生变化时推送消息体会包含对象ac表示交易对账户配置，其中s代表具体的交易对，l代表杠杆倍数

当用户联合保证金状态发生变化时推送消息体会包含对象ai表示用户账户配置，其中j代表用户联合保证金状态

策略交易 更新推送

Payload:

{
    "e": "STRATEGY_UPDATE", // 事件类型
    "T": 1669261797627, // 撮合时间
    "E": 1669261797628, // 事件时间
    "su": {
            "si": 176054594, // 策略 ID
            "st": "GRID", // 策略类型
            "ss": "NEW", // 策略状态
            "s": "BTCUSDT", // 交易对
            "ut": 1669261797627, // 更新时间
            "c": 8007 // opCode
        }
}

STRATEGY_UPDATE 在策略交易创建、取消、失效等等时候更新。

策略状态

opCode

网格 更新推送

Payload:

{
    "e": "GRID_UPDATE", // 事件类型
    "T": 1669262908216, // 撮合时间
    "E": 1669262908218, // 事件时间
    "gu": { 
            "si": 176057039, // 策略 ID
            "st": "GRID", // 策略类型
            "ss": "WORKING", // 策略状态
            "s": "BTCUSDT", // 交易对
            "r": "-0.00300716", // 已实现 PNL
            "up": "16720", // 未配对均价
            "uq": "-0.001", // 未配对数量
            "uf": "-0.00300716", // 未配对手续费
            "mp": "0.0", // 已配对 PNL
            "ut": 1669262908197 // 更新时间
        }
}

GRID_UPDATE 在网格子订单有部份或是完全成交时更新。

策略状态

条件订单（TP/SL）触发后拒绝 更新推送

Payload:

{
    "e":"CONDITIONAL_ORDER_TRIGGER_REJECT",      // 事件类型
    "E":1685517224945,      // 事件时间
    "T":1685517224955,      // 撮合时间
    "or":{
      "s":"ETHUSDT",      // 交易对
      "i":155618472834,      // 订单号
      "r":"Due to the order could not be filled immediately, the FOK order has been rejected. The order will not be recorded in the order history",      // 拒绝原因
     }
}

CONDITIONAL_ORDER_TRIGGER_REJECT 在止盈止损单触发后被拒绝时推送

统一账户专业版

为了给币安合约用户提供更加优质的服务及提高用户的资金利用率，币安将推出统一账户专业版计划。该计划将以合约钱包、现货杠杆钱包的总资产作为保证金来计算。 关于经典统一帐户：币安经典统一帐户计划是一项跨资产保证金计划，支持超过 200 种有效的加密资产。 U本位合约、币本位合约以及杠杆钱包中支持的加密资产和头寸将作为有效的联合抵押品，以确定统一账户专业版的权益、保证金余额和维持保证金要求。

FAQ: 币安合约统一账户专业版总览

仅对特定用户开放此功能，详情：加入统一账户专业版计划

查询统一账户专业版账户信息 (USER_DATA)

响应：

{
    "maxWithdrawAmountUSD": "1627523.32459208",   //统一账户专业版以USD计价的最大可转出余额
    "asset": "BTC",            // 资产
    "maxWithdrawAmount": "27.43689636",        //忽略
}

GET /fapi/v1/pmAccountInfo

查询统一账户专业版当前账户信息

权重(IP)： 5

参数：

名称 类型 是否必需 描述
asset STRING YES
recvWindow LONG NO
timestamp LONG YES

统一账户专业版推送

账户风险状态变动

Payload:

{
    "e":"riskLevelChange",      
    "E":1587727187525,      
    "u":"1.99999999",     
    "s":"MARGIN_CALL",       
    "eq":"30.23416728",    
    "ae":"30.23416728",     
    "m":"15.11708371"    
}

当用户账户的风险状态变化时，该时间被推出。 该消息仅作为风控参考，不作为投资建议。 RISK_LEVEL_CHANGE 包含以下类型：MARGIN_CALL, SUPPLY_MARGIN, REDUCE_ONLY, FORCE_LIQUIDATION 高波动率市场下，用户仓位可能在事件推出时被爆仓

WebSocket API

下单 (TRADE)

请求

{
    "id": "3f7df6e3-2df4-44b9-9919-d2f38f90a99a",
    "method": "order.place",
    "params": {
        "apiKey": "HMOchcfii9ZRZnhjp2XjGXhsOBd6msAhKz9joQaWwZ7arcJTlD2hGPHQj1lGdTjR",
        "positionSide": "BOTH",
        "price": "43187.00",
        "quantity": 0.1,
        "side": "BUY",
        "symbol": "BTCUSDT",
        "timeInForce": "GTC",
        "timestamp": 1702555533821,
        "type": "LIMIT",
        "signature": "0f04368b2d22aafd0ggc8809ea34297eff602272917b5f01267db4efbc1c9422"
    }
}

响应:

{
    "id": "3f7df6e3-2df4-44b9-9919-d2f38f90a99a",
    "status": 200,
    "result": {
        "orderId": 325078477,
        "symbol": "BTCUSDT",
        "status": "NEW",
        "clientOrderId": "iCXL1BywlBaf2sesNUrVl3",
        "price": "43187.00",
        "avgPrice": "0.00",
        "origQty": "0.100",
        "executedQty": "0.000",
        "cumQty": "0.000",
        "cumQuote": "0.00000",
        "timeInForce": "GTC",
        "type": "LIMIT",
        "reduceOnly": false,
        "closePosition": false,
        "side": "BUY",
        "positionSide": "BOTH",
        "stopPrice": "0.00",
        "workingType": "CONTRACT_PRICE",
        "priceProtect": false,
        "origType": "LIMIT",
        "priceMatch": "NONE",
        "selfTradePreventionMode": "NONE",
        "goodTillDate": 0,
        "updateTime": 1702555534435
    },
    "rateLimits": [
        {
            "rateLimitType": "ORDERS",
            "interval": "SECOND",
            "intervalNum": 10,
            "limit": 300,
            "count": 1
        },
        {
            "rateLimitType": "ORDERS",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 1200,
            "count": 1
        },
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 2400,
            "count": 1
        }
    ]
}

下新订单

权重: 0

方式: order.place

参数:

名称 类型 是否必需 描述
symbol STRING YES 交易对
side ENUM YES 买卖方向 SELL, BUY
positionSide ENUM NO 持仓方向，单向持仓模式下非必填，默认且仅可填BOTH;在双向持仓模式下必填,且仅可选择 LONG 或 SHORT
type ENUM YES 订单类型 LIMIT, MARKET, STOP, TAKE_PROFIT, STOP_MARKET, TAKE_PROFIT_MARKET, TRAILING_STOP_MARKET
reduceOnly STRING NO true, false; 非双开模式下默认false；双开模式下不接受此参数； 使用closePosition不支持此参数。
quantity DECIMAL NO 下单数量,使用closePosition不支持此参数。
price DECIMAL NO 委托价格
newClientOrderId STRING NO 用户自定义的订单号，不可以重复出现在挂单中。如空缺系统会自动赋值。必须满足正则规则 ^[\.A-Z\:/a-z0-9_-]{1,36}$
stopPrice DECIMAL NO 触发价, 仅 STOP, STOP_MARKET, TAKE_PROFIT, TAKE_PROFIT_MARKET 需要此参数
closePosition STRING NO true, false；触发后全部平仓，仅支持STOP_MARKET和TAKE_PROFIT_MARKET；不与quantity合用；自带只平仓效果，不与reduceOnly 合用
activationPrice DECIMAL NO 追踪止损激活价格，仅TRAILING_STOP_MARKET 需要此参数, 默认为下单当前市场价格(支持不同workingType)
callbackRate DECIMAL NO 追踪止损回调比例，可取值范围[0.1, 10],其中 1代表1% ,仅TRAILING_STOP_MARKET 需要此参数
timeInForce ENUM NO 有效方法
workingType ENUM NO stopPrice 触发类型: MARK_PRICE(标记价格), CONTRACT_PRICE(合约最新价). 默认 CONTRACT_PRICE
priceProtect STRING NO 条件单触发保护："TRUE","FALSE", 默认"FALSE". 仅 STOP, STOP_MARKET, TAKE_PROFIT, TAKE_PROFIT_MARKET 需要此参数
newOrderRespType ENUM NO "ACK", "RESULT", 默认 "ACK"
symbol STRING YES 交易对
priceMatch ENUM NO OPPONENT/ OPPONENT_5/ OPPONENT_10/ OPPONENT_20/QUEUE/ QUEUE_5/ QUEUE_10/ QUEUE_20；不能与price同时传
selfTradePreventionMode ENUM NO NONE / EXPIRE_TAKER/ EXPIRE_MAKER/ EXPIRE_BOTH； 默认NONE
goodTillDate LONG NO TIF为GTD时订单的自动取消时间， 当timeInforce为GTD时必传；传入的时间戳仅保留秒级精度，毫秒级部分会被自动忽略，时间戳需大于当前时间+600s且小于253402300799000
recvWindow LONG NO
timestamp LONG YES

根据 order type的不同，某些参数强制要求，具体如下:

Type 强制要求的参数
LIMIT timeInForce, quantity, price
MARKET quantity
STOP, TAKE_PROFIT quantity, price, stopPrice
STOP_MARKET, TAKE_PROFIT_MARKET stopPrice
TRAILING_STOP_MARKET quantity,callbackRate

撤销订单 (TRADE)

请求

{
    "id": "5633b6a2-90a9-4192-83e7-925c90b6a2fd",
    "method": "order.cancel", 
    "params": { 
        "apiKey": "HsOehcfih8ZRxnhjp2XjGXhsOBd6msAhKz9joQaWwZ7arcJTlD2hGOGQj1lGdTjR", 
        "orderId": 283194212, 
        "symbol": "BTCUSDT", 
        "timestamp": 1703439070722, 
        "signature": "b09c49815b4e3f1f6098cd9fbe26a933a9af79803deaaaae03c29f719c08a8a8" 
    }
}

响应:

{
  "id": "5633b6a2-90a9-4192-83e7-925c90b6a2fd",
  "status": 200,
  "result": {
    "clientOrderId": "myOrder1",
    "cumQty": "0",
    "cumQuote": "0",
    "executedQty": "0",
    "orderId": 283194212,
    "origQty": "11",
    "origType": "TRAILING_STOP_MARKET",
    "price": "0",
    "reduceOnly": false,
    "side": "BUY",
    "positionSide": "SHORT",
    "status": "CANCELED",
    "stopPrice": "9300",                
    "closePosition": false,  
    "symbol": "BTCUSDT",
    "timeInForce": "GTC",
    "type": "TRAILING_STOP_MARKET",
    "activatePrice": "9020",            
    "priceRate": "0.3",                
    "updateTime": 1571110484038,
    "workingType": "CONTRACT_PRICE",
    "priceProtect": false,           
    "priceMatch": "NONE",              
    "selfTradePreventionMode": "NONE",
    "goodTillDate": 0                 
  },
  "rateLimits": [
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 2400,
      "count": 1
    }
  ]
}

取消订单

权重: 1

方式: order.cancel

Parameters:

名称 类型 是否必需 描述
symbol STRING YES 交易对
orderId LONG NO 系统订单号
origClientOrderId STRING NO 用户自定义的订单号
recvWindow LONG NO
timestamp LONG YES

修改订单 (TRADE)

请求

{
    "id": "c8c271ba-de70-479e-870c-e64951c753d9",
    "method": "order.modify",
    "params": {
        "apiKey": "HMOchcfiT9ZRZnhjp2XjGXhsOBd6msAhKz9joQaWwZ7arcJTlD2hGPHQj1lGdTjR",
        "orderId": 328971409,
        "origType": "LIMIT",
        "positionSide": "SHORT",
        "price": "43769.1",
        "priceMatch": "NONE",
        "quantity": "0.11",
        "side": "SELL",
        "symbol": "BTCUSDT",
        "timestamp": 1703426755754,
        "signature": "d30c9f0736a307f5a9988d4a40b688662d18324b17367d51421da5484e835923"
    }
}

响应:

{
    "id": "c8c271ba-de70-479e-870c-e64951c753d9",
    "status": 200,
    "result": {
        "orderId": 328971409,
        "symbol": "BTCUSDT",
        "status": "NEW",
        "clientOrderId": "xGHfltUMExx0TbQstQQfRX",
        "price": "43769.10",
        "avgPrice": "0.00",
        "origQty": "0.110",
        "executedQty": "0.000",
        "cumQty": "0.000",
        "cumQuote": "0.00000",
        "timeInForce": "GTC",
        "type": "LIMIT",
        "reduceOnly": false,
        "closePosition": false,
        "side": "SELL",
        "positionSide": "SHORT",
        "stopPrice": "0.00",
        "workingType": "CONTRACT_PRICE",
        "priceProtect": false,
        "origType": "LIMIT",
        "priceMatch": "NONE",
        "selfTradePreventionMode": "NONE",
        "goodTillDate": 0,
        "updateTime": 1703426756190
    },
    "rateLimits": [
        {
            "rateLimitType": "ORDERS",
            "interval": "SECOND",
            "intervalNum": 10,
            "limit": 300,
            "count": 1
        },
        {
            "rateLimitType": "ORDERS",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 1200,
            "count": 1
        },
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 2400,
            "count": 1
        }
    ]
}

修改订单功能，当前只支持限价（LIMIT）订单修改，修改后会在撮合队列里重新排序

权重: 10s order rate limit(X-MBX-ORDER-COUNT-10S)为1 1min order rate limit(X-MBX-ORDER-COUNT-1M)为1 IP rate limit(x-mbx-used-weight-1m)为1

方式: order.modify

参数:

名称 类型 是否必需 描述
orderId LONG NO 系统订单号
origClientOrderId STRING NO 用户自定义的订单号
symbol STRING YES 交易对
side ENUM YES 买卖方向 SELL, BUY; side需要和原订单相同
quantity DECIMAL YES 下单数量,使用closePosition不支持此参数。
price DECIMAL YES 委托价格
priceMatch ENUM NO OPPONENT/ OPPONENT_5/ OPPONENT_10/ OPPONENT_20/QUEUE/ QUEUE_5/ QUEUE_10/ QUEUE_20；不能与price同时传
recvWindow LONG NO
timestamp LONG YES

查询订单 (USER_DATA)

请求

{
    "id": "0ce5d070-a5e5-4ff2-b57f-1556741a4204",
    "method": "order.status",
    "params": {
        "apiKey": "HMOchcfii9ZRZnhjp2XjGXhsOBd6msAhKz9joQaWwZ7arcJTlD2hGPHQj1lGdTjR",
        "orderId": 328999071,
        "symbol": "BTCUSDT",
        "timestamp": 1703441060152,
        "signature": "ba48184fc38a71d03d2b5435bd67c1206e3191e989fe99bda1bc643a880dfdbf"
    }
}

响应:

{
    "id": "0ce5d070-a5e5-4ff2-b57f-1556741a4204",
    "status": 200,
    "result": {
        "orderId": 328999071,
        "symbol": "BTCUSDT",
        "status": "NEW",
        "clientOrderId": "bK2CASGXToGAKVsePruSCs",
        "price": "43634.50",
        "avgPrice": "0.00",
        "origQty": "0.010",
        "executedQty": "0.000",
        "cumQuote": "0.00000",
        "timeInForce": "GTC",
        "type": "LIMIT",
        "reduceOnly": false,
        "closePosition": false,
        "side": "BUY",
        "positionSide": "BOTH",
        "stopPrice": "0.00",
        "workingType": "CONTRACT_PRICE",
        "priceProtect": false,
        "origType": "LIMIT",
        "priceMatch": "NONE",
        "selfTradePreventionMode": "NONE",
        "goodTillDate": 0,
        "time": 1703441059890,
        "updateTime": 1703441059890
    },
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 2400,
            "count": 6
        }
    ]
}

查询订单状态

方式: order.status

权重: 1

参数:

名称 类型 是否必需 描述
symbol STRING YES 交易对
orderId LONG NO 系统订单号
origClientOrderId STRING NO 用户自定义的订单号
recvWindow LONG NO
timestamp LONG YES

注意:

账户信息V2 (USER_DATA)

请求

{
    "id": "605a6d20-6588-4cb9-afa0-b0ab087507ba",
    "method": "v2/account.status",
    "params": {
        "apiKey": "xTaDyrmvA9XT2oBHHjy39zyPzKCvMdtH3b9q4xadkAg2dNSJXQGCxzui26L823W2",
        "timestamp": 1702620814781,
        "signature": "6bb98ef84170c70ba3d01f44261bfdf50fef374e551e590de22b5c3b729b1d8c"
    }
}

响应:

单资产模式

{
  "id": "605a6d20-6588-4cb9-afa0-b0ab087507ba",
  "status": 200,
  "result": {
    "feeTier": 0,  // 手续费等级
    "canTrade": true,  // 是否可以交易
    "canDeposit": true,  // 是否可以入金
    "canWithdraw": true, // 是否可以出金
    "updateTime": 0,     // 保留字段，请忽略
    "multiAssetsMargin": false,
    "tradeGroupId": -1,
    "totalInitialMargin": "0.00000000",  // 当前所需起始保证金总额(存在逐仓请忽略), 仅计算usdt资产
    "totalMaintMargin": "0.00000000",  // 维持保证金总额, 仅计算usdt资产
    "totalWalletBalance": "23.72469206",   // 账户总余额, 仅计算usdt资产
    "totalUnrealizedProfit": "0.00000000",  // 持仓未实现盈亏总额, 仅计算usdt资产
    "totalMarginBalance": "23.72469206",  // 保证金总余额, 仅计算usdt资产
    "totalPositionInitialMargin": "0.00000000",  // 持仓所需起始保证金(基于最新标记价格), 仅计算usdt资产
    "totalOpenOrderInitialMargin": "0.00000000",  // 当前挂单所需起始保证金(基于最新标记价格), 仅计算usdt资产
    "totalCrossWalletBalance": "23.72469206",  // 全仓账户余额, 仅计算usdt资产
    "totalCrossUnPnl": "0.00000000",    // 全仓持仓未实现盈亏总额, 仅计算usdt资产
    "availableBalance": "23.72469206",       // 可用余额, 仅计算usdt资产
    "maxWithdrawAmount": "23.72469206"     // 最大可转出余额, 仅计算usdt资产
    "assets": [
        {
            "asset": "USDT",        //资产
            "walletBalance": "23.72469206",  //余额
            "unrealizedProfit": "0.00000000",  // 未实现盈亏
            "marginBalance": "23.72469206",  // 保证金余额
            "maintMargin": "0.00000000",    // 维持保证金
            "initialMargin": "0.00000000",  // 当前所需起始保证金
            "positionInitialMargin": "0.00000000",  // 持仓所需起始保证金(基于最新标记价格)
            "openOrderInitialMargin": "0.00000000", // 当前挂单所需起始保证金(基于最新标记价格)
            "crossWalletBalance": "23.72469206",  //全仓账户余额
            "crossUnPnl": "0.00000000" // 全仓持仓未实现盈亏
            "availableBalance": "126.72469206",       // 可用余额
            "maxWithdrawAmount": "23.72469206",     // 最大可转出余额
            "marginAvailable": true,   // 是否可用作联合保证金
            "updateTime": 1625474304765  //更新时间
        },
        {
            "asset": "BUSD",        //资产
            "walletBalance": "103.12345678",  //余额
            "unrealizedProfit": "0.00000000",  // 未实现盈亏
            "marginBalance": "103.12345678",  // 保证金余额
            "maintMargin": "0.00000000",    // 维持保证金
            "initialMargin": "0.00000000",  // 当前所需起始保证金
            "positionInitialMargin": "0.00000000",  // 持仓所需起始保证金(基于最新标记价格)
            "openOrderInitialMargin": "0.00000000", // 当前挂单所需起始保证金(基于最新标记价格)
            "crossWalletBalance": "103.12345678",  //全仓账户余额
            "crossUnPnl": "0.00000000" // 全仓持仓未实现盈亏
            "availableBalance": "126.72469206",       // 可用余额
            "maxWithdrawAmount": "103.12345678",     // 最大可转出余额
            "marginAvailable": true,   // 否可用作联合保证金
            "updateTime": 0  // 更新时间
            }
    ],
    "positions": [  // 头寸，将返回所有市场symbol。
        //根据用户持仓模式展示持仓方向，即单向模式下只返回BOTH持仓情况，双向模式下只返回 LONG 和 SHORT 持仓情况
        {
            "symbol": "BTCUSDT",  // 交易对
            "initialMargin": "0",   // 当前所需起始保证金(基于最新标记价格)
            "maintMargin": "0", //维持保证金
            "unrealizedProfit": "0.00000000",  // 持仓未实现盈亏
            "positionInitialMargin": "0",  // 持仓所需起始保证金(基于最新标记价格)
            "openOrderInitialMargin": "0",  // 当前挂单所需起始保证金(基于最新标记价格)
            "leverage": "100",  // 杠杆倍率
            "isolated": true,  // 是否是逐仓模式
            "entryPrice": "0.00000",  // 持仓成本价
            "maxNotional": "250000",  // 当前杠杆下用户可用的最大名义价值
            "bidNotional": "0",  // 买单净值，忽略
            "askNotional": "0",  // 卖单净值，忽略
            "positionSide": "BOTH",  // 持仓方向
            "positionAmt": "0",      // 持仓数量
            "updateTime": 0         // 更新时间 
        }
    ]
  },
  "rateLimits": [
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 2400,
      "count": 20
    }
  ]
}

多资产模式 

{
  "id": "605a6d20-6588-4cb9-afa0-b0ab087507ba",
  "status": 200,
  "result": {   
    "totalInitialMargin": "0.00000000",            // 当前所需起始保证金总额(存在逐仓请忽略), 仅计算usdt资产positions), only for USDT asset
    "totalMaintMargin": "0.00000000",              // 维持保证金总额, 仅计算usdt资产
    "totalWalletBalance": "103.12345678",          // 账户总余额, 仅计算usdt资产
    "totalUnrealizedProfit": "0.00000000",         // 持仓未实现盈亏总额, 仅计算usdt资产
    "totalMarginBalance": "103.12345678",          // 保证金总余额, 仅计算usdt资产
    "totalPositionInitialMargin": "0.00000000",    // 持仓所需起始保证金(基于最新标记价格), 仅计算usdt资产
    "totalOpenOrderInitialMargin": "0.00000000",   // 当前挂单所需起始保证金(基于最新标记价格), 仅计算usdt资产
    "totalCrossWalletBalance": "103.12345678",     // 全仓账户余额, 仅计算usdt资产
    "totalCrossUnPnl": "0.00000000",               // 全仓持仓未实现盈亏总额, 仅计算usdt资产
    "availableBalance": "103.12345678",            // 可用余额, 仅计算usdt资产
    "maxWithdrawAmount": "103.12345678"            // 最大可转出余额, 仅计算usdt资产
    "assets": [ 
        {
            "asset": "USDT",                        // 资产
            "walletBalance": "23.72469206",         // 余额
            "unrealizedProfit": "0.00000000",       // 未实现盈亏
            "marginBalance": "23.72469206",         // 保证金余额
            "maintMargin": "0.00000000",            // 维持保证金
            "initialMargin": "0.00000000",          // 当前所需起始保证金
            "positionInitialMargin": "0.00000000",  // 持仓所需起始保证金(基于最新标记价格)
            "openOrderInitialMargin": "0.00000000", // 当前挂单所需起始保证金(基于最新标记价格)
            "crossWalletBalance": "23.72469206",    // 全仓账户余额
            "crossUnPnl": "0.00000000"              // 全仓持仓未实现盈亏
            "availableBalance": "23.72469206",      // 可用余额
            "maxWithdrawAmount": "23.72469206",     // 最大可转出余额
            "updateTime": 1625474304765             // 更新时间
        },   
        {
            "asset": "USDC",                      
            "walletBalance": "103.12345678",      
            "unrealizedProfit": "0.00000000",     
            "marginBalance": "103.12345678",      
            "maintMargin": "0.00000000",         
            "initialMargin": "0.00000000",   
            "positionInitialMargin": "0.00000000",   
            "openOrderInitialMargin": "0.00000000",  
            "crossWalletBalance": "103.12345678",    
            "crossUnPnl": "0.00000000"      
            "availableBalance": "126.72469206", 
            "maxWithdrawAmount": "103.12345678", 
            "updateTime": 1625474304765 
        }
    ],
    "positions": [  // 仅有仓位或挂单的交易对会被返回
                    // 根据用户持仓模式展示持仓方向，即单向模式下只返回BOTH持仓情况，双向模式下只返回 LONG 和 SHORT 持仓情况
      {
           "symbol": "BTCUSDT",               // 交易对
           "positionSide": "BOTH",            // 持仓方向
           "positionAmt": "1.000",            // 持仓数量
           "unrealizedProfit": "0.00000000",  // 持仓未实现盈亏   
           "isolatedMargin": "0.00000000",  
           "notional": "0",
           "isolatedWallet": "0",
           "initialMargin": "0",              // 持仓所需起始保证金(基于最新标记价格)
           "maintMargin": "0",                // 当前杠杆下用户可用的最大名义价值
           "updateTime": 0                    // 更新时间 
      } 
    ]
  },
  "rateLimits": [
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 2400,
      "count": 20
    }
  ]
}

多资产模式 

{
  "id": "605a6d20-6588-4cb9-afa0-b0ab087507ba",
  "status": 200,
  "result": {   
    "totalInitialMargin": "0.00000000",          // 以USD计价的所需起始保证金总额
    "totalMaintMargin": "0.00000000",            // 以USD计价的维持保证金总额
    "totalWalletBalance": "126.72469206",        // 以USD计价的账户总余额
    "totalUnrealizedProfit": "0.00000000",       // 以USD计价的持仓未实现盈亏总额
    "totalMarginBalance": "126.72469206",        // 以USD计价的保证金总余额 
    "totalPositionInitialMargin": "0.00000000",  // 以USD计价的持仓所需起始保证金(基于最新标记价格)
    "totalOpenOrderInitialMargin": "0.00000000", // 以USD计价的当前挂单所需起始保证金(基于最新标记价格)
    "totalCrossWalletBalance": "126.72469206",   // 以USD计价的全仓账户余额
    "totalCrossUnPnl": "0.00000000",             // 以USD计价的全仓持仓未实现盈亏总额
    "availableBalance": "126.72469206",          // 以USD计价的可用余额
    "maxWithdrawAmount": "126.72469206"          // 以USD计价的最大可转出余额
    "assets": [
        {
            "asset": "USDT",                        // 资产
            "walletBalance": "23.72469206",         // 余额
            "unrealizedProfit": "0.00000000",       // 未实现盈亏
            "marginBalance": "23.72469206",         // 保证金余额
            "maintMargin": "0.00000000",            // 维持保证金
            "initialMargin": "0.00000000",          // 当前所需起始保证金
            "positionInitialMargin": "0.00000000",  // 持仓所需起始保证金(基于最新标记价格)
            "openOrderInitialMargin": "0.00000000", // 当前挂单所需起始保证金(基于最新标记价格)
            "crossWalletBalance": "23.72469206",    // 全仓账户余额
            "crossUnPnl": "0.00000000"              // 全仓持仓未实现盈亏
            "availableBalance": "23.72469206",      // 可用余额
            "maxWithdrawAmount": "23.72469206",     // 最大可转出余额
            "updateTime": 1625474304765             // 更新时间
        },   
        {
            "asset": "USDC",                      
            "walletBalance": "103.12345678",      
            "unrealizedProfit": "0.00000000",     
            "marginBalance": "103.12345678",      
            "maintMargin": "0.00000000",         
            "initialMargin": "0.00000000",   
            "positionInitialMargin": "0.00000000",   
            "openOrderInitialMargin": "0.00000000",  
            "crossWalletBalance": "103.12345678",    
            "crossUnPnl": "0.00000000"      
            "availableBalance": "126.72469206", 
            "maxWithdrawAmount": "103.12345678", 
            "updateTime": 1625474304765 
        }
    ],
    "positions": [  // 仅有仓位或挂单的交易对会被返回
                    // 根据用户持仓模式展示持仓方向，即单向模式下只返回BOTH持仓情况，双向模式下只返回 LONG 和 SHORT 持仓情况
      {
           "symbol": "BTCUSDT",               // 交易对
           "positionSide": "BOTH",            // 持仓方向
           "positionAmt": "1.000",            // 持仓数量
           "unrealizedProfit": "0.00000000",  // 持仓未实现盈亏   
           "isolatedMargin": "0.00000000",  
           "notional": "0",
           "isolatedWallet": "0",
           "initialMargin": "0",              // 持仓所需起始保证金(基于最新标记价格)
           "maintMargin": "0",                // 当前杠杆下用户可用的最大名义价值
           "updateTime": 0                    // 更新时间 
      } 
    ]
  },
  "rateLimits": [
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 2400,
      "count": 20
    }
  ]
}

现有账户信息。 用户在单资产模式和多资产模式下会看到不同结果，响应部分的注释解释了两种模式下的不同。

权重: 5

方式: v2/account.status

参数:

名称 类型 是否必需 描述
recvWindow LONG NO
timestamp LONG YES

账户信息 (USER_DATA)

请求

{
    "id": "605a6d20-6588-4cb9-afa0-b0ab087507ba",
    "method": "account.status",
    "params": {
        "apiKey": "xTaDyrmvA9XT2oBHHjy39zyPzKCvMdtH3b9q4xadkAg2dNSJXQGCxzui26L823W2",
        "timestamp": 1702620814781,
        "signature": "6bb98ef84170c70ba3d01f44261bfdf50fef374e551e590de22b5c3b729b1d8c"
    }
}

响应:

单资产模式

{
  "id": "605a6d20-6588-4cb9-afa0-b0ab087507ba",
  "status": 200,
  "result": {
    "feeTier": 0,  // 手续费等级
    "canTrade": true,  // 是否可以交易
    "canDeposit": true,  // 是否可以入金
    "canWithdraw": true, // 是否可以出金
    "updateTime": 0,     // 保留字段，请忽略
    "multiAssetsMargin": false,
    "tradeGroupId": -1,
    "totalInitialMargin": "0.00000000",  // 当前所需起始保证金总额(存在逐仓请忽略), 仅计算usdt资产
    "totalMaintMargin": "0.00000000",  // 维持保证金总额, 仅计算usdt资产
    "totalWalletBalance": "23.72469206",   // 账户总余额, 仅计算usdt资产
    "totalUnrealizedProfit": "0.00000000",  // 持仓未实现盈亏总额, 仅计算usdt资产
    "totalMarginBalance": "23.72469206",  // 保证金总余额, 仅计算usdt资产
    "totalPositionInitialMargin": "0.00000000",  // 持仓所需起始保证金(基于最新标记价格), 仅计算usdt资产
    "totalOpenOrderInitialMargin": "0.00000000",  // 当前挂单所需起始保证金(基于最新标记价格), 仅计算usdt资产
    "totalCrossWalletBalance": "23.72469206",  // 全仓账户余额, 仅计算usdt资产
    "totalCrossUnPnl": "0.00000000",    // 全仓持仓未实现盈亏总额, 仅计算usdt资产
    "availableBalance": "23.72469206",       // 可用余额, 仅计算usdt资产
    "maxWithdrawAmount": "23.72469206"     // 最大可转出余额, 仅计算usdt资产
    "assets": [
        {
            "asset": "USDT",        //资产
            "walletBalance": "23.72469206",  //余额
            "unrealizedProfit": "0.00000000",  // 未实现盈亏
            "marginBalance": "23.72469206",  // 保证金余额
            "maintMargin": "0.00000000",    // 维持保证金
            "initialMargin": "0.00000000",  // 当前所需起始保证金
            "positionInitialMargin": "0.00000000",  // 持仓所需起始保证金(基于最新标记价格)
            "openOrderInitialMargin": "0.00000000", // 当前挂单所需起始保证金(基于最新标记价格)
            "crossWalletBalance": "23.72469206",  //全仓账户余额
            "crossUnPnl": "0.00000000" // 全仓持仓未实现盈亏
            "availableBalance": "126.72469206",       // 可用余额
            "maxWithdrawAmount": "23.72469206",     // 最大可转出余额
            "marginAvailable": true,   // 是否可用作联合保证金
            "updateTime": 1625474304765  //更新时间
        },
        {
            "asset": "BUSD",        //资产
            "walletBalance": "103.12345678",  //余额
            "unrealizedProfit": "0.00000000",  // 未实现盈亏
            "marginBalance": "103.12345678",  // 保证金余额
            "maintMargin": "0.00000000",    // 维持保证金
            "initialMargin": "0.00000000",  // 当前所需起始保证金
            "positionInitialMargin": "0.00000000",  // 持仓所需起始保证金(基于最新标记价格)
            "openOrderInitialMargin": "0.00000000", // 当前挂单所需起始保证金(基于最新标记价格)
            "crossWalletBalance": "103.12345678",  //全仓账户余额
            "crossUnPnl": "0.00000000" // 全仓持仓未实现盈亏
            "availableBalance": "126.72469206",       // 可用余额
            "maxWithdrawAmount": "103.12345678",     // 最大可转出余额
            "marginAvailable": true,   // 否可用作联合保证金
            "updateTime": 0  // 更新时间
            }
    ],
    "positions": [  // 头寸，将返回所有市场symbol。
        //根据用户持仓模式展示持仓方向，即单向模式下只返回BOTH持仓情况，双向模式下只返回 LONG 和 SHORT 持仓情况
        {
            "symbol": "BTCUSDT",  // 交易对
            "initialMargin": "0",   // 当前所需起始保证金(基于最新标记价格)
            "maintMargin": "0", //维持保证金
            "unrealizedProfit": "0.00000000",  // 持仓未实现盈亏
            "positionInitialMargin": "0",  // 持仓所需起始保证金(基于最新标记价格)
            "openOrderInitialMargin": "0",  // 当前挂单所需起始保证金(基于最新标记价格)
            "leverage": "100",  // 杠杆倍率
            "isolated": true,  // 是否是逐仓模式
            "entryPrice": "0.00000",  // 持仓成本价
            "maxNotional": "250000",  // 当前杠杆下用户可用的最大名义价值
            "bidNotional": "0",  // 买单净值，忽略
            "askNotional": "0",  // 卖单净值，忽略
            "positionSide": "BOTH",  // 持仓方向
            "positionAmt": "0",      // 持仓数量
            "updateTime": 0         // 更新时间 
        }
    ]
  },
  "rateLimits": [
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 2400,
      "count": 20
    }
  ]
}

多资产模式 

{
  "id": "605a6d20-6588-4cb9-afa0-b0ab087507ba",
  "status": 200,
  "result": {
    "feeTier": 0,  // 手续费等级
    "canTrade": true,  // 是否可以交易
    "canDeposit": true,  // 是否可以入金
    "canWithdraw": true, // 是否可以出金
    "updateTime": 0,     // 保留字段，请忽略
    "multiAssetsMargin": true,
    "tradeGroupId": -1,
    "totalInitialMargin": "0.00000000",  // 以USD计价的所需起始保证金总额
    "totalMaintMargin": "0.00000000",  // 以USD计价的维持保证金总额
    "totalWalletBalance": "126.72469206",   // 以USD计价的账户总余额
    "totalUnrealizedProfit": "0.00000000",  // 以USD计价的持仓未实现盈亏总额
    "totalMarginBalance": "126.72469206",  // 以USD计价的保证金总余额
    "totalPositionInitialMargin": "0.00000000",  // 以USD计价的持仓所需起始保证金(基于最新标记价格)
    "totalOpenOrderInitialMargin": "0.00000000",  // 以USD计价的当前挂单所需起始保证金(基于最新标记价格)
    "totalCrossWalletBalance": "126.72469206",  // 以USD计价的全仓账户余额
    "totalCrossUnPnl": "0.00000000",    // 以USD计价的全仓持仓未实现盈亏总额
    "availableBalance": "126.72469206",       // 以USD计价的可用余额
    "maxWithdrawAmount": "126.72469206"     // 以USD计价的最大可转出余额
    "assets": [
        {
            "asset": "USDT",        //资产
            "walletBalance": "23.72469206",  //余额
            "unrealizedProfit": "0.00000000",  // 未实现盈亏
            "marginBalance": "23.72469206",  // 保证金余额
            "maintMargin": "0.00000000",    // 维持保证金
            "initialMargin": "0.00000000",  // 当前所需起始保证金
            "positionInitialMargin": "0.00000000",  // 持仓所需起始保证金(基于最新标记价格)
            "openOrderInitialMargin": "0.00000000", // 当前挂单所需起始保证金(基于最新标记价格)
            "crossWalletBalance": "23.72469206",  //全仓账户余额
            "crossUnPnl": "0.00000000" // 全仓持仓未实现盈亏
            "availableBalance": "23.72469206",       // 可用余额
            "maxWithdrawAmount": "23.72469206",     // 最大可转出余额
            "marginAvailable": true,   // 是否可用作联合保证金
            "updateTime": 1625474304765  //更新时间
        },
        {
            "asset": "BUSD",        //资产
            "walletBalance": "103.12345678",  //余额
            "unrealizedProfit": "0.00000000",  // 未实现盈亏
            "marginBalance": "103.12345678",  // 保证金余额
            "maintMargin": "0.00000000",    // 维持保证金
            "initialMargin": "0.00000000",  // 当前所需起始保证金
            "positionInitialMargin": "0.00000000",  // 持仓所需起始保证金(基于最新标记价格)
            "openOrderInitialMargin": "0.00000000", // 当前挂单所需起始保证金(基于最新标记价格)
            "crossWalletBalance": "103.12345678",  //全仓账户余额
            "crossUnPnl": "0.00000000" // 全仓持仓未实现盈亏
            "availableBalance": "103.12345678",       // 可用余额
            "maxWithdrawAmount": "103.12345678",     // 最大可转出余额
            "marginAvailable": true,   // 否可用作联合保证金
            "updateTime": 0  // 更新时间
            }
    ],
    "positions": [  // 头寸，将返回所有市场symbol。
        //根据用户持仓模式展示持仓方向，即单向模式下只返回BOTH持仓情况，双向模式下只返回 LONG 和 SHORT 持仓情况
        {
            "symbol": "BTCUSDT",  // 交易对
            "initialMargin": "0",   // 当前所需起始保证金(基于最新标记价格)
            "maintMargin": "0", //维持保证金
            "unrealizedProfit": "0.00000000",  // 持仓未实现盈亏
            "positionInitialMargin": "0",  // 持仓所需起始保证金(基于最新标记价格)
            "openOrderInitialMargin": "0",  // 当前挂单所需起始保证金(基于最新标记价格)
            "leverage": "100",  // 杠杆倍率
            "isolated": true,  // 是否是逐仓模式
            "entryPrice": "0.00000",  // 持仓成本价
            "breakEvenPrice": "0.0",  // 持仓成本价
            "maxNotional": "250000",  // 当前杠杆下用户可用的最大名义价值
            "bidNotional": "0",  // 买单净值，忽略
            "askNotional": "0",  // 买单净值，忽略
            "positionSide": "BOTH",  // 持仓方向
            "positionAmt": "0",      // 持仓数量
            "updateTime": 0         // 更新时间 
        }
    ]
  },
  "rateLimits": [
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 2400,
      "count": 20
    }
  ]
}

现有账户信息。 用户在单资产模式和多资产模式下会看到不同结果，响应部分的注释解释了两种模式下的不同。

权重: 5

方式: account.status

参数:

名称 类型 是否必需 描述
recvWindow LONG NO
timestamp LONG YES

账户余额 (USER_DATA)

请求

{
    "id": "605a6d20-6588-4cb9-afa0-b0ab087507ba",
    "method": "account.balance",
    "params": {
        "apiKey": "xTaDyrmvA9XT2oBHHjy39zyPzKCvMdtH3b9q4xadkAg2dNSJXQGCxzui26L823W2",
        "timestamp": 1702561978458,
        "signature": "208bb94a26f99aa122b1319490ca9cb2798fccc81d9b6449521a26268d53217a"
    }
}

响应:

{
    "id": "605a6d20-6588-4cb9-afa0-b0ab087507ba",
    "status": 200,
    "result": {
        [
            {
                "accountAlias": "SgsR",    // 账户唯一识别码
                "asset": "USDT",        // 资产
                "balance": "122607.35137903",   // 总余额
                "crossWalletBalance": "23.72469206", // 全仓余额
                "crossUnPnl": "0.00000000"  // 全仓持仓未实现盈亏
                "availableBalance": "23.72469206",       // 下单可用余额
                "maxWithdrawAmount": "23.72469206",     // 最大可转出余额
                "marginAvailable": true,    // 是否可用作联合保证金
                "updateTime": 1617939110373
            }
        ]
    },
    "rateLimits": [
      {
        "rateLimitType": "REQUEST_WEIGHT",
        "interval": "MINUTE",
        "intervalNum": 1,
        "limit": 2400,
        "count": 20
      }
    ]
}

Weight: 5

Parameters:

名称 类型 是否必需 描述
recvWindow LONG NO
timestamp LONG YES

账户余额V2 (USER_DATA)

请求

{
    "id": "605a6d20-6588-4cb9-afa0-b0ab087507ba",
    "method": "v2/account.balance",
    "params": {
        "apiKey": "xTaDyrmvA9XT2oBHHjy39zyPzKCvMdtH3b9q4xadkAg2dNSJXQGCxzui26L823W2",
        "timestamp": 1702561978458,
        "signature": "208bb94a26f99aa122b1319490ca9cb2798fccc81d9b6449521a26268d53217a"
    }
}

响应:

{
    "id": "605a6d20-6588-4cb9-afa0-b0ab087507ba",
    "status": 200,
    "result": {
        [
           {
             "accountAlias": "SgsR",              // 账户唯一识别码
             "asset": "USDT",                     // 资产
             "balance": "122607.35137903",        // 总余额
             "crossWalletBalance": "23.72469206", // 全仓余额
             "crossUnPnl": "0.00000000"           // 全仓持仓未实现盈亏
             "availableBalance": "23.72469206",   // 下单可用余额
             "maxWithdrawAmount": "23.72469206",  // 最大可转出余额
             "marginAvailable": true,             // 是否可用作联合保证金
            "updateTime": 1617939110373
            }
        ]
    },
    "rateLimits": [
      {
        "rateLimitType": "REQUEST_WEIGHT",
        "interval": "MINUTE",
        "intervalNum": 1,
        "limit": 2400,
        "count": 20
      }
    ]
}

权重: 5

方式: v2/account.status

参数:

名称 类型 是否必需 描述
recvWindow LONG NO
timestamp LONG YES

用户持仓风险V2 (USER_DATA)

请求

{
    "id": "605a6d20-6588-4cb9-afa0-b0ab087507ba",
    "method": "v2/account.position",
    "params": {
        "apiKey": "xTaDyrmvA9XT2oBHHjy39zyPzKCvMdtH3b9q4xadkAg2dNSJXQGCxzui26L823W2",
        "symbol": "BTCUSDT",
        "timestamp": 1702920680303,
        "signature": "31ab02a51a3989b66c29d40fcdf78216978a60afc6d8dc1c753ae49fa3164a2a"
    }
}

响应:

单向持仓模式下：

{
  "id": "605a6d20-6588-4cb9-afa0-b0ab087507ba",
  "status": 200,
  "result":[
    {
        "symbol": "ADAUSDT",
        "positionSide": "BOTH",               // 持仓方向
        "positionAmt": "30",
        "entryPrice": "0.385",
        "breakEvenPrice": "0.385077",
        "markPrice": "0.41047590",
        "unRealizedProfit": "0.76427700",     // 持仓未实现盈亏 
        "liquidationPrice": "0",
        "isolatedMargin": "0",
        "notional": "12.31427700",
        "marginAsset": "USDT",
        "isolatedWallet": "0",
        "initialMargin": "0.61571385",        // 初始保证金
        "maintMargin": "0.08004280",          // 维持保证金
        "positionInitialMargin": "0.61571385",// 仓位初始保证金
        "openOrderInitialMargin": "0",        // 订单初始保证金
        "adl": 2,
        "bidNotional": "0",                   
        "askNotional": "0",                   
        "updateTime": 1720736417660           // 更新时间
    }
  ],
  "rateLimits": [
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 2400,
      "count": 20
    }
  ]
}

双向持仓模式下： javascript { "id": "605a6d20-6588-4cb9-afa0-b0ab087507ba", "status": 200, "result": [ { "symbol": "ADAUSDT", "positionSide": "LONG", "positionAmt": "30", "entryPrice": "0.385", "breakEvenPrice": "0.385077", "markPrice": "0.41047590", "unRealizedProfit": "0.76427700", "liquidationPrice": "0", "isolatedMargin": "0", "notional": "12.31427700", "marginAsset": "USDT", "isolatedWallet": "0", "initialMargin": "0.61571385", "maintMargin": "0.08004280", "positionInitialMargin": "0.61571385", "openOrderInitialMargin": "0", "adl": 2, "bidNotional": "0", "askNotional": "0", "updateTime": 1720736417660 }, { "symbol": "COMPUSDT", "positionSide": "SHORT", "positionAmt": "-1.000", "entryPrice": "70.92841", "breakEvenPrice": "70.900038636", "markPrice": "49.72023376", "unRealizedProfit": "21.20817624", "liquidationPrice": "2260.56757210", "isolatedMargin": "0", "notional": "-49.72023376", "marginAsset": "USDT", "isolatedWallet": "0", "initialMargin": "2.48601168", "maintMargin": "0.49720233", "positionInitialMargin": "2.48601168", "openOrderInitialMargin": "0", "adl": 2, "bidNotional": "0", "askNotional": "0", "updateTime": 1708943511656 } ], "rateLimits": [ { "rateLimitType": "REQUEST_WEIGHT", "interval": "MINUTE", "intervalNum": 1, "limit": 2400, "count": 20 } ] }

权重: 5

方式: v2/account.position

参数:

名称 类型 是否必需 描述
symbol STRING NO
recvWindow LONG NO
timestamp LONG YES

注意
请与账户推送信息ACCOUNT_UPDATE配合使用，以满足您的及时性和准确性需求。

用户持仓风险 (USER_DATA)

请求

{
    "id": "605a6d20-6588-4cb9-afa0-b0ab087507ba",
    "method": "account.position",
    "params": {
        "apiKey": "xTaDyrmvA9XT2oBHHjy39zyPzKCvMdtH3b9q4xadkAg2dNSJXQGCxzui26L823W2",
        "symbol": "BTCUSDT",
        "timestamp": 1702920680303,
        "signature": "31ab02a51a3989b66c29d40fcdf78216978a60afc6d8dc1c753ae49fa3164a2a"
    }
}

响应:

单向持仓模式下：

{
  "id": "605a6d20-6588-4cb9-afa0-b0ab087507ba",
  "status": 200,
  "result":[
    {
        "entryPrice": "0.00000",  // 开仓均价
        "breakEvenPrice": "0.0",  // 盈亏平衡价
        "marginType": "isolated", // 逐仓模式或全仓模式
        "isAutoAddMargin": "false",
        "isolatedMargin": "0.00000000", // 逐仓保证金
        "leverage": "10", // 当前杠杆倍数
        "liquidationPrice": "0", // 参考强平价格
        "markPrice": "6679.50671178",   // 当前标记价格
        "maxNotionalValue": "20000000", // 当前杠杆倍数允许的名义价值上限
        "positionAmt": "0.000", // 头寸数量，符号代表多空方向, 正数为多，负数为空
        "notional": "0",
        "isolatedWallet": "0",
        "symbol": "BTCUSDT", // 交易对
        "unRealizedProfit": "0.00000000", // 持仓未实现盈亏
        "positionSide": "BOTH", // 持仓方向
        "updateTime": 1625474304765   // 更新时间
    }
  ],
  "rateLimits": [
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 2400,
      "count": 20
    }
  ]
}

双向持仓模式下：

{
  "id": "605a6d20-6588-4cb9-afa0-b0ab087507ba",
  "status": 200,
  "result": [
    {
        "symbol": "BTCUSDT",
        "positionAmt": "0.001",
        "entryPrice": "22185.2",
        "breakEvenPrice": "0.0",  
        "markPrice": "21123.05052574",
        "unRealizedProfit": "-1.06214947",
        "liquidationPrice": "19731.45529116",
        "leverage": "4",
        "maxNotionalValue": "100000000",
        "marginType": "cross",
        "isolatedMargin": "0.00000000",
        "isAutoAddMargin": "false",
        "positionSide": "LONG",
        "notional": "21.12305052",
        "isolatedWallet": "0",
        "updateTime": 1655217461579
    },
    {
        "symbol": "BTCUSDT",
        "positionAmt": "0.000",
        "entryPrice": "0.0",
        "breakEvenPrice": "0.0",  
        "markPrice": "21123.05052574",
        "unRealizedProfit": "0.00000000",
        "liquidationPrice": "0",
        "leverage": "4",
        "maxNotionalValue": "100000000",
        "marginType": "cross",
        "isolatedMargin": "0.00000000",
        "isAutoAddMargin": "false",
        "positionSide": "SHORT",
        "notional": "0",
        "isolatedWallet": "0",
        "updateTime": 0
    }
],
  "rateLimits": [
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 2400,
      "count": 20
    }
  ]
}

权重: 5

方式: account.position

参数:

名称 类型 是否必需 描述
symbol STRING NO
recvWindow LONG NO
timestamp LONG YES

注意
请与账户推送信息ACCOUNT_UPDATE配合使用，以满足您的及时性和准确性需求。

深度信息

请求

{
    "id": "51e2affb-0aba-4821-ba75-f2625006eb43",
    "method": "depth",
    "params": {
      "symbol": "BTCUSDT"
    }
}

响应:

{
  "id": "51e2affb-0aba-4821-ba75-f2625006eb43",
  "status": 200,
  "result": {
    "lastUpdateId": 1027024,
    "E": 1589436922972,   // 消息时间
    "T": 1589436922959,   // 撮合引擎时间
    "bids": [               // 买单
      [
        "4.00000000",     // 价格
        "431.00000000"    // 数量
      ]
    ],
    "asks": [               // 卖单
      [
        "4.00000200",       // 价格
        "12.00000000"       // 数量
      ]
    ]
  },
  "rateLimits": [
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 2400,
      "count": 5
    }
  ]
}

获取有限档订单薄信息

方式: depth

权重:

limit 权重
5, 10, 20, 50 2
100 5
500 10
1000 20

更新速率: 15ms

参数:

名称 类型 是否必需 描述
symbol STRING YES 交易对
limit INT NO 默认 500; 可选值:[5, 10, 20, 50, 100, 500, 1000]

最新价格

请求

{
    "id": "9d32157c-a556-4d27-9866-66760a174b57",
    "method": "ticker.price",
    "params": {
        "symbol": "BTCUSDT"
    }
}

响应:

{
  "id": "9d32157c-a556-4d27-9866-66760a174b57",
  "status": 200,
  "result": {
    "symbol": "BTCUSDT",
    "price": "6000.01",
    "time": 1589437530011   
  },
  "rateLimits": [
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 2400,
      "count": 2
    }
  ]
}

或(当不发送symbol)

{
  "id": "9d32157c-a556-4d27-9866-66760a174b57",
  "status": 200,
  "result": [
    {
       "symbol": "BTCUSDT",
       "price": "6000.01",
       "time": 1589437530011  
    }  
  ],
  "rateLimits": [
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 2400,
      "count": 2
    }
  ]
}

返回最近价格

权重: * 单交易对1 * 无交易对2

方式: ticker.price

更新速率: 实时

参数:

名称 类型 是否必需 描述
symbol STRING NO 交易对

当前最优挂单

请求

{
    "id": "9d32157c-a556-4d27-9866-66760a174b57",
    "method": "ticker.book",
    "params": {
        "symbol": "BTCUSDT"
    }
}

响应:

{
  "id": "9d32157c-a556-4d27-9866-66760a174b57",
  "status": 200,
  "result": {
    "lastUpdateId": 1027024,
    "symbol": "BTCUSDT", // 交易对
    "bidPrice": "4.00000000", //最优买单价
    "bidQty": "431.00000000", //挂单量
    "askPrice": "4.00000200", //最优卖单价
    "askQty": "9.00000000", //挂单量
    "time": 1589437530011   // 撮合引擎时间
  },
  "rateLimits": [
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 2400,
      "count": 2
    }
  ]
}

或(当不发送symbol)

{
  "id": "9d32157c-a556-4d27-9866-66760a174b57",
  "status": 200,
  "result": [
    {
      "lastUpdateId": 1027024,
      "symbol": "BTCUSDT", // 交易对
      "bidPrice": "4.00000000", //最优买单价
      "bidQty": "431.00000000", //挂单量
      "askPrice": "4.00000200", //最优卖单价
      "askQty": "9.00000000", //挂单量
      "time": 1589437530011   // 撮合引擎时间
    }
 ]
  "rateLimits": [
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 2400,
      "count": 2
    }
  ]
}

返回当前最优的挂单(最高买单，最低卖单)

权重: * 单交易对2
* 无交易对5

方式: ticker.book

更新速率: 实时

参数:

名称 类型 是否必需 描述
symbol STRING NO 交易对

生成listenKey (USER_STREAM)

请求

{
  "id": "d3df8a61-98ea-4fe0-8f4e-0fcea5d418b0",
  "method": "userDataStream.start",
  "params": {
    "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A"
  }
}

响应:

{
  "id": "d3df8a61-98ea-4fe0-8f4e-0fcea5d418b0",
  "status": 200,
  "result": {
    "listenKey": "xs0mRXdAKlIPDRFrlPcw0qI41Eh3ixNntmymGyhrhgqo7L6FuLaWArTD7RLP"
  },
   "rateLimits": [
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 2400,
      "count": 2
    }
  ]
}

以下请求用于管理 用户信息推送订阅

创建一个新的user data stream，返回值为一个listenKey，即websocket订阅的stream名称。

注意: 订阅流回在60分钟内关闭如果没有定期请求userDataStream.ping

权重: 5

方式： userDataStream.start

参数:

名称 类型 是否必需 描述
apiKey STRING YES

延长listenKey有效期 (USER_STREAM)

请求

{
  "id": "815d5fce-0880-4287-a567-80badf004c74",
  "method": "userDataStream.ping",
  "params": {
    "listenKey": "xs0mRXdAKlIPDRFrlPcw0qI41Eh3ixNntmymGyhrhgqo7L6FuLaWArTD7RLP",
    "apiKey": "vmPUZE6mv9SD5VNHk9HlWFsOr9aLE2zvsw0MuIgwCIPy8atIco14y7Ju91duEh8A"
   }
}

响应

{
  "id": "815d5fce-0880-4287-a567-80badf004c74",
  "status": 200,
  "result": {
    "listenKey": "3HBntNTepshgEdjIwSUIBgB9keLyOCg5qv3n6bYAtktG8ejcaW5HXz9Vx1JgIieg"
  },
  "rateLimits": [
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 2400,
      "count": 2
    }
  ]
}

保持用户数据流活跃。

即使你在 WebSocket Streams 上监听数据，用户数据流会在 60 分钟后自动关闭。为了保持流的开启，你需要定期使用 userDataStream.ping 请求发送 ping。

建议每 30 分钟发送一次 ping.

权重: 5

方式: userDataStream.ping

参数:

名称 类型 是否必需 描述
listenKey STRING YES
apiKey STRING YES

关闭listenKey (USER_STREAM)

请求

{
  "id": "819e1b1b-8c06-485b-a13e-131326c69599",
  "method": "userDataStream.stop",
  "params": {
    "listenKey": "xs0mRXdAKlIPDRFrlPcw0qI41Eh3ixNntmymGyhrhgqo7L6FuLaWArTD7RLP",
    "apiKey": "vmPUZE6mv9SD5VNHk9HlWFsOr9aLE2zvsw0MuIgwCIPy8atIco14y7Ju91duEh8A"
  }
}

响应

{
  "id": "819e1b1b-8c06-485b-a13e-131326c69599",
  "status": 200,
  "result": {},
   "rateLimits": [
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 2400,
      "count": 2
    }
  ]
}

关闭账户数据流

权重: 1

参数:

名称 类型 是否必需 描述
listenKey STRING YES
apiKey STRING YES

listenKey 过期推送

Payload:

{
    "stream": "OfYGbUzi3PraNagEkdKuFwUHn48brFsItTdsuiIXrucEvD0rhRXZ7I6URWfE8YE8",
    "data": {
        "e": "listenKeyExpired",   // 事件类型
        "E": "1699596037418",      // 事件时间
        "listenKey": "OfYGbUzi3PraNagEkdKuFwUHn48brFsItTdsuiIXrucEvD0rhRXZ7I6URWfE8YE8"
    }
}

当前连接使用的有效listenKey过期时，user data stream 将会推送此事件。

注意:

错误代码

error JSON payload:

{
  "code":-1121,
  "msg":"Invalid symbol."
}

错误由两部分组成：错误代码和消息。 代码是通用的，但是消息可能会有所不同。

10xx - 常规服务器或网络问题

-1000 UNKNOWN

-1001 DISCONNECTED

-1002 UNAUTHORIZED

-1003 TOO_MANY_REQUESTS

-1004 DUPLICATE_IP

-1005 NO_SUCH_IP

-1006 UNEXPECTED_RESP

-1007 TIMEOUT

-1008 SERVER_BUSY

-1014 UNKNOWN_ORDER_COMPOSITION

-1015 TOO_MANY_ORDERS

-1016 SERVICE_SHUTTING_DOWN

-1020 UNSUPPORTED_OPERATION

-1021 INVALID_TIMESTAMP

-1022 INVALID_SIGNATURE

-1023 START_TIME_GREATER_THAN_END_TIME

-1099 NOT_FOUND

11xx - Request issues

-1100 ILLEGAL_CHARS

-1101 TOO_MANY_PARAMETERS

-1102 MANDATORY_PARAM_EMPTY_OR_MALFORMED

-1103 UNKNOWN_PARAM

-1104 UNREAD_PARAMETERS

-1105 PARAM_EMPTY

-1106 PARAM_NOT_REQUIRED

-1108 BAD_ASSET

-1109 BAD_ACCOUNT

-1110 BAD_INSTRUMENT_TYPE

-1111 BAD_PRECISION

-1112 NO_DEPTH

-1113 WITHDRAW_NOT_NEGATIVE

-1114 TIF_NOT_REQUIRED

-1115 INVALID_TIF

-1116 INVALID_ORDER_TYPE

-1117 INVALID_SIDE

-1118 EMPTY_NEW_CL_ORD_ID

-1119 EMPTY_ORG_CL_ORD_ID

-1120 BAD_INTERVAL

-1121 BAD_SYMBOL

-1122 INVALID_SYMBOL_STATUS

-1125 INVALID_LISTEN_KEY

-1126 ASSET_NOT_SUPPORTED

-1127 MORE_THAN_XX_HOURS

-1128 OPTIONAL_PARAMS_BAD_COMBO

-1130 INVALID_PARAMETER

-1136 INVALID_NEW_ORDER_RESP_TYPE

20xx - Processing Issues

-2010 NEW_ORDER_REJECTED

-2011 CANCEL_REJECTED

-2012 CANCEL_ALL_FAIL

-2013 NO_SUCH_ORDER

-2014 BAD_API_KEY_FMT

-2015 REJECTED_MBX_KEY

-2016 NO_TRADING_WINDOW

-2017 API_KEYS_LOCKED

-2018 BALANCE_NOT_SUFFICIENT

-2019 MARGIN_NOT_SUFFICIEN

-2020 UNABLE_TO_FILL

-2021 ORDER_WOULD_IMMEDIATELY_TRIGGER

-2022 REDUCE_ONLY_REJECT

-2023 USER_IN_LIQUIDATION

-2024 POSITION_NOT_SUFFICIENT

-2025 MAX_OPEN_ORDER_EXCEEDED

-2026 REDUCE_ONLY_ORDER_TYPE_NOT_SUPPORTED

-2027 MAX_LEVERAGE_RATIO

-2028 MIN_LEVERAGE_RATIO

40xx - Filters and other Issues

-4000 INVALID_ORDER_STATUS

-4001 PRICE_LESS_THAN_ZERO

-4002 PRICE_GREATER_THAN_MAX_PRICE

-4003 QTY_LESS_THAN_ZERO

-4004 QTY_LESS_THAN_MIN_QTY

-4005 QTY_GREATER_THAN_MAX_QTY

-4006 STOP_PRICE_LESS_THAN_ZERO

-4007 STOP_PRICE_GREATER_THAN_MAX_PRICE

-4008 TICK_SIZE_LESS_THAN_ZERO

-4009 MAX_PRICE_LESS_THAN_MIN_PRICE

-4010 MAX_QTY_LESS_THAN_MIN_QTY

-4011 STEP_SIZE_LESS_THAN_ZERO

-4012 MAX_NUM_ORDERS_LESS_THAN_ZERO

-4013 PRICE_LESS_THAN_MIN_PRICE

-4014 PRICE_NOT_INCREASED_BY_TICK_SIZE

-4015 INVALID_CL_ORD_ID_LEN

-4016 PRICE_HIGHTER_THAN_MULTIPLIER_UP

-4017 MULTIPLIER_UP_LESS_THAN_ZERO

-4018 MULTIPLIER_DOWN_LESS_THAN_ZERO

-4019 COMPOSITE_SCALE_OVERFLOW

-4020 TARGET_STRATEGY_INVALID

-4021 INVALID_DEPTH_LIMIT

-4022 WRONG_MARKET_STATUS

-4023 QTY_NOT_INCREASED_BY_STEP_SIZE

-4024 PRICE_LOWER_THAN_MULTIPLIER_DOWN

-4025 MULTIPLIER_DECIMAL_LESS_THAN_ZERO

-4026 COMMISSION_INVALID

-4027 INVALID_ACCOUNT_TYPE

-4028 INVALID_LEVERAGE

-4029 INVALID_TICK_SIZE_PRECISION

-4030 INVALID_STEP_SIZE_PRECISION

-4031 INVALID_WORKING_TYPE

-4032 EXCEED_MAX_CANCEL_ORDER_SIZE

-4033 INSURANCE_ACCOUNT_NOT_FOUND

-4044 INVALID_BALANCE_TYPE

-4045 MAX_STOP_ORDER_EXCEEDED

-4046 NO_NEED_TO_CHANGE_MARGIN_TYPE

-4047 THERE_EXISTS_OPEN_ORDERS

-4048 THERE_EXISTS_QUANTITY

-4049 ADD_ISOLATED_MARGIN_REJECT

-4050 CROSS_BALANCE_INSUFFICIENT

-4051 ISOLATED_BALANCE_INSUFFICIENT

-4052 NO_NEED_TO_CHANGE_AUTO_ADD_MARGIN

-4053 AUTO_ADD_CROSSED_MARGIN_REJECT

-4054 ADD_ISOLATED_MARGIN_NO_POSITION_REJECT

-4055 AMOUNT_MUST_BE_POSITIVE

-4056 INVALID_API_KEY_TYPE

-4057 INVALID_RSA_PUBLIC_KEY

-4058 MAX_PRICE_TOO_LARGE

-4059 NO_NEED_TO_CHANGE_POSITION_SIDE

-4060 INVALID_POSITION_SIDE

-4061 POSITION_SIDE_NOT_MATCH

-4062 REDUCE_ONLY_CONFLICT

-4063 INVALID_OPTIONS_REQUEST_TYPE

-4064 INVALID_OPTIONS_TIME_FRAME

-4065 INVALID_OPTIONS_AMOUNT

-4066 INVALID_OPTIONS_EVENT_TYPE

-4067 POSITION_SIDE_CHANGE_EXISTS_OPEN_ORDERS

-4068 POSITION_SIDE_CHANGE_EXISTS_QUANTITY

-4069 INVALID_OPTIONS_PREMIUM_FEE

-4070 INVALID_CL_OPTIONS_ID_LEN

-4071 INVALID_OPTIONS_DIRECTION

-4072 OPTIONS_PREMIUM_NOT_UPDATE

-4073 OPTIONS_PREMIUM_INPUT_LESS_THAN_ZERO

-4074 OPTIONS_AMOUNT_BIGGER_THAN_UPPER

-4075 OPTIONS_PREMIUM_OUTPUT_ZERO

-4076 OPTIONS_PREMIUM_TOO_DIFF

-4077 OPTIONS_PREMIUM_REACH_LIMIT

-4078 OPTIONS_COMMON_ERROR

-4079 INVALID_OPTIONS_ID

-4080 OPTIONS_USER_NOT_FOUND

-4081 OPTIONS_NOT_FOUND

-4082 INVALID_BATCH_PLACE_ORDER_SIZE

-4083 PLACE_BATCH_ORDERS_FAIL

-4084 UPCOMING_METHOD

-4085 INVALID_NOTIONAL_LIMIT_COEF

-4086 INVALID_PRICE_SPREAD_THRESHOLD

-4087 REDUCE_ONLY_ORDER_PERMISSION

-4088 NO_PLACE_ORDER_PERMISSION

-4104 INVALID_CONTRACT_TYPE

-4114 INVALID_CLIENT_TRAN_ID_LEN

-4115 DUPLICATED_CLIENT_TRAN_ID

-4118 REDUCE_ONLY_MARGIN_CHECK_FAILED

-4131 MARKET_ORDER_REJECT

-4135 INVALID_ACTIVATION_PRICE

-4137 QUANTITY_EXISTS_WITH_CLOSE_POSITION

-4138 REDUCE_ONLY_MUST_BE_TRUE

-4139 ORDER_TYPE_CANNOT_BE_MKT

-4140 INVALID_OPENING_POSITION_STATUS

-4141 SYMBOL_ALREADY_CLOSED

-4142 STRATEGY_INVALID_TRIGGER_PRICE

-4144 INVALID_PAIR

-4161 ISOLATED_LEVERAGE_REJECT_WITH_POSITION

-4164 MIN_NOTIONAL

-4165 INVALID_TIME_INTERVAL

-4167 ISOLATED_REJECT_WITH_JOINT_MARGIN

-4168 JOINT_MARGIN_REJECT_WITH_ISOLATED

-4169 JOINT_MARGIN_REJECT_WITH_MB

-4170 JOINT_MARGIN_REJECT_WITH_OPEN_ORDER

-4171 NO_NEED_TO_CHANGE_JOINT_MARGIN

-4172 JOINT_MARGIN_REJECT_WITH_NEGATIVE_BALANCE

-4183 PRICE_HIGHTER_THAN_STOP_MULTIPLIER_UP

-4184 PRICE_LOWER_THAN_STOP_MULTIPLIER_DOWN

-4192 COOLING_OFF_PERIOD

-4202 ADJUST_LEVERAGE_KYC_FAILED

-4203 ADJUST_LEVERAGE_ONE_MONTH_FAILED

-4205 ADJUST_LEVERAGE_X_DAYS_FAILED

-4206 ADJUST_LEVERAGE_KYC_LIMIT

-4208 ADJUST_LEVERAGE_ACCOUNT_SYMBOL_FAILED

-4209 ADJUST_LEVERAGE_SYMBOL_FAILED

-4210 STOP_PRICE_HIGHER_THAN_PRICE_MULTIPLIER_LIMIT

-4211 STOP_PRICE_LOWER_THAN_PRICE_MULTIPLIER_LIMIT

-4400 TRADING_QUANTITATIVE_RULE

-4401 COMPLIANCE_RESTRICTION

-4402 COMPLIANCE_BLACK_SYMBOL_RESTRICTION

-4403 ADJUST_LEVERAGE_COMPLIANCE_FAILED

50xx - Order Execution Issues

-5021 FOK_ORDER_REJECT

-5022 GTX_ORDER_REJECT

-5024 MOVE_ORDER_NOT_ALLOWED_SYMBOL_REASON

-5025 LIMIT_ORDER_ONLY

-5026 Exceed_Maximum_Modify_Order_Limit

-5027 SAME_ORDER

-5028 ME_RECVWINDOW_REJECT

-5037 INVALID_PRICE_MATCH

-5038 UNSUPPORTED_ORDER_TYPE_PRICE_MATCH

-5039 INVALID_SELF_TRADE_PREVENTION_MODE

-5040 FUTURE_GOOD_TILL_DATE

-5041 BBO_ORDER_REJECT