Navbar
现货/杠杆/币安宝 U本位合约 币本位合约 U本位合约testnet b币本位合约testnet
简体中文

更新日志

2021-01-04

REST

2020-12-08

WEBSOCKET

REST API

ENUM

2020-11-27

2020-11-10

2020-10-27

WEB SOCKET STREAM

2020-10-18

WEB SOCKET USER DATA STREAM

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

2020-10-10

WEBSOCKET

2020-10-09

2020-08-14

2020-08-12

2020-07-30

2020-07-17

2020-06-29

WEBSOCKET

2020-06-15

2020-06-04

2020-06-02

2020-05-18

2020-05-15

2020-05-14

2020-05-11

2020-05-06

2020-05-01

WEBSOCKET 账户信息推送

2020-04-24

2020-04-17

2020-04-14

WEB SOCKET 连接限制

2020-04-05

2020-03-24

2020-02-26

2020-02-20

2020-02-17

2020-02-12

2020-02-05

2020-01-19

2020-01-17

2020-01-06

2020-01-02

2019-12-12

2019-11-29

2019-11-23

2019-11-15

2019-11-12

2019-11-05

2019-10-28

2019-10-25

2019-10-24

2019-10-16

2019-10-11

2019-10-09

2019-09-27

2019-09-20

基本信息

SDK和代码示例

免责声明:

Python3

可以通过以下方式获取SDK：

Java

可以通过以下方式获取SDK：
* 访问 https://github.com/Binance-docs/Binance_Futures_Java,

Rest 基本信息

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 的示例

以下是在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 调用:

    (HMAC SHA256)
    $ curl -H "X-MBX-APIKEY: dbefbc809e3e83c283a984c3a1459732ea7db1360ca80c5c2c8867408d28cc83" -X POST 'https://testnet.binancefuture.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 调用:

    (HMAC SHA256)
    $ curl -H "X-MBX-APIKEY: dbefbc809e3e83c283a984c3a1459732ea7db1360ca80c5c2c8867408d28cc83" -X POST 'https://testnet.binancefuture.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&quantity=1&price=9000&timeInForce=GTC&recvWindow=5000&timestamp=1591702613943" | openssl dgst -sha256 -hmac "2b5eb11e18796d12d88f13dc27dbbd02c2cc51ff7059765ed9821957d82bb4d9"
    (stdin)= 3c661234138461fcc7a7d8746c6558c9842d4e10870d2ecbedf7777cad694af9

curl 调用:

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

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

公开API参数

术语解释

枚举定义

交易对类型:

合约类型 (contractType):

订单状态:

订单种类:

订单方向:

持仓方向:

有效方式:

条件价格触发类型 (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": 25
  }

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

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

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 定义了基于标记价格计算的挂单价格的可接受区间.

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

Postman Collections

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

行情接口

测试服务器连通性 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, // 系统时间
    "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,  // 价格小数点位数
            "quantityPrecision": 0,  // 数量小数点位数
            "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": "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" // 无法成为挂单方就撤销
            ]
        }
    ],
    "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

参数:

名称 类型 是否必需 描述
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

获取近期成交

权重: 1

参数:

名称 类型 是否必需 描述
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

归集交易与逐笔交易的区别在于，同一价格、同一方向、同一时间(按秒计算)的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

最新标记价格和资金费率

响应:

{
    "symbol": "BTCUSDT",                // 交易对
    "markPrice": "11793.63104562",      // 标记价格
    "indexPrice": "11781.80495970",     // 指数价格
    "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

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

权重: 1

参数:

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

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

参数:

名称 类型 是否必需 描述
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

参数:

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

当前最优挂单

响应:

{
  "symbol": "BTCUSDT",
  "bidPrice": "9994.00000000", //最优买单价
  "bidQty": "431.00000000", //挂单量
  "askPrice": "9994.00000200", //最优卖单价
  "askQty": "9.00000000", //挂单量
  "time": 1589437530011   // 撮合引擎时间
}

或(当不发送symbol)

[
    {
        "symbol": "BTCUSDT",
        "bidPrice": "9994.00000000", //最优买单价
        "bidQty": "431.00000000", //挂单量
        "askPrice": "9994.00000200", //最优卖单价
        "askQty": "9.00000000", //挂单量
        "time": 1589437530011  // 撮合引擎时间
    }
]

GET /fapi/v1/ticker/bookTicker

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

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

参数:

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

获取市场强平订单

响应:

[

    {
          "symbol": "BTCUSDT",                // 交易对
          "price": "7918.33",                 // 订单价格
          "origQty": "0.014",                 // 订单数量
          "executedQty": "0.014",             // 成交量
          "avragePrice": "7918.33",           // 成交均价
          "status": "FILLED",                 // 订单状态
          "timeInForce": "IOC",               // 有效方式
          "type": "LIMIT",                   // 订单类型
          "side": "SELL",                     // 订单方向
          "time": 1568014460893 
    },
]

GET /fapi/v1/allForceOrders

权重: 20

参数:

名称 类型 是否必需 描述
symbol STRING NO 交易对
startTime LONG NO 起始时间
endTime LONG NO 结束时间,默认当前时间
limit LONG NO 从endTime倒推算起的数据条数，默认值:100 最大值:1000

获取未平仓合约数

响应:

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

GET /fapi/v1/openInterest

权重: 1

参数:

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

综合指数交易对信息

响应:

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

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

GET /fapi/v1/indexInfo

权重: 1

参数:

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

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会被聚合为一条.推送间隔100毫秒。

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

Update Speed: 3000ms

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线)的更新。

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

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

Stream Name:
<symbol>@kline_<interval>

Update Speed: 250ms

连续合约K线

Payload:

{
  "e":"continuous_kline",   // 事件类型
  "E":1607443058651,        // 事件时间
  "ps":"BTCBUSD",           // 标的交易对
  "ct":"NEXT_QUARTER",          // 合约类型 
  "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>

例如 "btcbusd_next_quarter@continuousKline_1m"

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: 500ms

全市场的完整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 名称:
!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: 实时

强平订单

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的强平订单信息

Stream Name:  <symbol>@forceOrder

Update Speed: 实时

全市场强平订单

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,              // 交易时间

    }

}

推送全市场强平订单信息

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

增量深度信息stream

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 名称:
<symbol>@depth OR <symbol>@depth@500ms OR <symbol>@depth@100ms

Update Speed: 250ms 或 500ms 或 100ms

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

  1. 订阅 wss://stream.binancefuture.com/stream?streams=btcusdt@depth
  2. 开始缓存收到的更新。同一个价位，后收到的更新覆盖前面的。
  3. 访问Rest接口 https://testnet.binancefuture.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":[                 // 成分信息
    {
        "b":"BAL",          //基础资产
        "w":"1.35038833",   // 权重(数量)
        "W":"0.03957100"    // 权重(比例)
    },
    {
        "b":"BAND",
        "w":"3.53782729",
        "W":"0.03935200"
    }
  ]
}

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

Stream Name: <symbol>@compositeIndex

Update Speed: 1000ms

账户和交易接口

更改持仓模式(TRADE)

响应:

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

POST /fapi/v1/positionSide/dual (HMAC SHA256)

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

权重: 1

参数:

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

查询持仓模式(USER_DATA)

响应:

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

GET /fapi/v1/positionSide/dual (HMAC SHA256)

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

权重: 30

参数:

名称 类型 是否必需 描述
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": "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            // 是否开启条件单触发保护
}

POST /fapi/v1/order (HMAC SHA256)

权重: 1

参数:

名称 类型 是否必需 描述
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 用户自定义的订单号，不可以重复出现在挂单中。如空缺系统会自动赋值
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, 5],其中 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"
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 callbackRate

测试下单接口 (TRADE)

响应:

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

POST /fapi/v1/order/test (HMAC SHA256)

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

权重: 1

参数:

参考 POST /fapi/v1/order

批量下单 (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            // 是否开启条件单触发保护
    },
    {
        "code": -2022, 
        "msg": "ReduceOnly Order is rejected."
    }
]

POST /fapi/v1/batchOrders (HMAC SHA256)

权重: 5

参数:

名称 类型 是否必需 描述
batchOrders list 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 用户自定义的订单号，不可以重复出现在挂单中。如空缺系统会自动赋值
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"

查询订单 (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            // 是否开启条件单触发保护
}

GET /fapi/v1/order (HMAC SHA256)

查询订单状态

权重: 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            // 是否开启条件单触发保护
}

DELETE /fapi/v1/order (HMAC SHA256)

权重: 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 (HMAC SHA256)

权重: 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            // 是否开启条件单触发保护
    },
    {
        "code": -2011,
        "msg": "Unknown order sent."
    }
]

DELETE /fapi/v1/batchOrders (HMAC SHA256)

权重: 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 (HMAC SHA256)

权重: 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",                      // 买卖方向
    "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            // 是否开启条件单触发保护
}

GET /fapi/v1/openOrder (HMAC SHA256)

请小心使用不带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            // 是否开启条件单触发保护
  }
]

GET /fapi/v1/openOrders (HMAC SHA256)

请小心使用不带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            // 是否开启条件单触发保护
  }
]

GET /fapi/v1/allOrders (HMAC SHA256)

权重: 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

账户余额V2 (USER_DATA)

响应:

[
    {
        "accountAlias": "SgsR",    // 账户唯一识别码
        "asset": "USDT",        // 资产
        "balance": "122607.35137903",   // 总余额
        "crossWalletBalance": "23.72469206", // 全仓余额
        "crossUnPnl": "0.00000000"  // 全仓持仓未实现盈亏
        "availableBalance": "23.72469206",       // 可用余额
        "maxWithdrawAmount": "23.72469206"     // 最大可转出余额
    }
]

GET /fapi/v2/balance (HMAC SHA256)

Weight: 1

Parameters:

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

账户信息V2 (USER_DATA)

响应:


{
    "feeTier": 0,  // 手续费等级
    "canTrade": true,  // 是否可以交易
    "canDeposit": true,  // 是否可以入金
    "canWithdraw": true, // 是否可以出金
    "updateTime": 0,
    "totalInitialMargin": "0.00000000",  // 但前所需起始保证金总额(存在逐仓请忽略)
    "totalMaintMargin": "0.00000000",  // 维持保证金总额
    "totalWalletBalance": "23.72469206",   // 账户总余额
    "totalUnrealizedProfit": "0.00000000",  // 持仓未实现盈亏总额
    "totalMarginBalance": "23.72469206",  // 保证金总余额
    "totalPositionInitialMargin": "0.00000000",  // 持仓所需起始保证金(基于最新标记价格)
    "totalOpenOrderInitialMargin": "0.00000000",  // 当前挂单所需起始保证金(基于最新标记价格)
    "totalCrossWalletBalance": "23.72469206",  // 全仓账户余额
    "totalCrossUnPnl": "0.00000000",    // 全仓持仓未实现盈亏总额
    "availableBalance": "23.72469206",       // 可用余额
    "maxWithdrawAmount": "23.72469206"     // 最大可转出余额
    "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"     // 最大可转出余额
        }
    ],
    "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",  // 当前杠杆下用户可用的最大名义价值
            "positionSide": "BOTH",  // 持仓方向
            "positionAmt": "0"      // 持仓数量
        }
    ]
}

GET /fapi/v2/account (HMAC SHA256)

权重: 5

参数:

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

调整开仓杠杆 (TRADE)

响应:

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

POST /fapi/v1/leverage (HMAC SHA256)

调整用户在指定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 (HMAC SHA256)

变换用户在指定symbol合约上的保证金模式：逐仓或全仓。
不同持仓方向上使用相同的保证金模式。双向持仓模式下的逐仓，LONG 与 SHORT使用独立的逐仓仓位。

权重: 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 (HMAC SHA256)

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

权重: 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)

响应:

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

GET /fapi/v1/positionMargin/history (HMAC SHA256)

权重: 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

用户持仓风险V2 (USER_DATA)

响应:

单向持仓模式下：

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

双向持仓模式下：

[
    {
        "entryPrice": "6563.66500", // 开仓均价
        "marginType": "isolated", // 逐仓模式或全仓模式
        "isAutoAddMargin": "false",
        "isolatedMargin": "15517.54150468", // 逐仓保证金
        "leverage": "10", // 当前杠杆倍数
        "liquidationPrice": "5930.78", // 参考强平价格
        "markPrice": "6679.50671178",   // 当前标记价格
        "maxNotionalValue": "20000000", // 当前杠杆倍数允许的名义价值上限
        "positionAmt": "20.000", // 头寸数量，符号代表多空方向, 正数为多，负数为空
        "symbol": "BTCUSDT", // 交易对
        "unRealizedProfit": "2316.83423560" // 持仓未实现盈亏
        "positionSide": "LONG", // 持仓方向
    },
    {
        "entryPrice": "0.00000", // 开仓均价
        "marginType": "isolated", // 逐仓模式或全仓模式
        "isAutoAddMargin": "false",
        "isolatedMargin": "5413.95799991", // 逐仓保证金
        "leverage": "10", // 当前杠杆倍数
        "liquidationPrice": "7189.95", // 参考强平价格
        "markPrice": "6679.50671178",   // 当前标记价格
        "maxNotionalValue": "20000000", // 当前杠杆倍数允许的名义价值上限
        "positionAmt": "-10.000", // 头寸数量，符号代表多空方向, 正数为多，负数为空
        "symbol": "BTCUSDT", // 交易对
        "unRealizedProfit": "-1156.46711780" // 持仓未实现盈亏
        "positionSide": "SHORT", // 持仓方向
    }

]

GET /fapi/v2/positionRisk (HMAC SHA256)

权重: 1

参数:

名称 类型 是否必需 描述
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 (HMAC SHA256)

获取某交易对的成交历史

权重: 5

参数:

名称 类型 是否必需 描述
symbol STRING YES 交易对
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 (HMAC SHA256)

权重: 20

参数:

名称 类型 是否必需 描述
symbol STRING NO 交易对
incomeType STRING NO 收益类型 "TRANSFER"，"WELCOME_BONUS", "REALIZED_PNL"，"FUNDING_FEE", "COMMISSION", and "INSURANCE_CLEAR"
startTime LONG NO 起始时间
endTime LONG NO 结束时间
limit INT NO 返回的结果集数量 默认值:100 最大值:1000
recvWindow LONG NO
timestamp LONG YES

杠杆分层标准 (USER_DATA)

响应:

[
    {
        "symbol": "ETHUSDT",
        "brackets": [
            {
                "bracket": 1,   // 层级
                "initialLeverage": 75,  // 该层允许的最高初始杠杆倍数
                "notionalCap": 10000,  // 该层对应的名义价值上限
                "notionalFloor": 0,  // 该层对应的名义价值下限 
                "maintMarginRatio": 0.0065, // 该层对应的维持保证金率
                "cum":0. // 速算数
            }, 
        ]
    }
]

或 (若发送symbol)


{
    "symbol": "ETHUSDT",
    "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

权重: 20

参数:

名称 类型 是否必需 描述
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)

响应:

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

GET /fapi/v1/commissionRate (HMAC SHA256)

权重: 20

参数:

名称 类型 是否必需 描述
symbol STRING YES
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分钟。

权重: 1

参数:

None

延长listenKey有效期 (USER_STREAM)

响应:

{}

PUT /fapi/v1/listenKey

有效期延长至本次调用后60分钟

权重: 1

参数:

None

关闭listenKey (USER_STREAM)

响应:

{}

DELETE /fapi/v1/listenKey

关闭某账户数据流

权重: 1

参数:

None

追加保证金通知

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"           // 除去逐仓仓位保证金的钱包余额
        },
        {
          "a":"BNB",           
          "wb":"1.00000000",
          "cw":"0.00000000"         
        }
      ],
      "P":[
       {
          "s":"BTCUSDT",            // 交易对
          "pa":"0",                 // 仓位
          "ep":"0.00000",            // 入仓价格
          "cr":"200",               // (费前)累计实现损益
          "up":"0",                     // 持仓未实现盈亏
          "mt":"isolated",              // 保证金模式
          "iw":"0.00000000",            // 若为逐仓，仓位保证金
          "ps":"BOTH"                   // 持仓方向
       }，
       {
            "s":"BTCUSDT",
            "pa":"20",
            "ep":"6563.66500",
            "cr":"0",
            "up":"2850.21200",
            "mt":"isolated",
            "iw":"13200.70726908",
            "ps":"LONG"
         },
       {
            "s":"BTCUSDT",
            "pa":"-10",
            "ep":"6563.86000",
            "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自动减仓订单
    "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":1568879465651,              // 成交时间
    "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",                     // 追踪止损回调比例, 仅在追踪止损单时会推送此字段
    "rp":"0"                            // 该交易实现盈亏

  }

}

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

订单方向

持仓方向:

订单类型

本次事件的具体执行类型

订单状态

有效方式:

错误代码

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

-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

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

-1111 BAD_PRECISION

-1112 NO_DEPTH

-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

-1125 INVALID_LISTEN_KEY

-1127 MORE_THAN_XX_HOURS

-1128 OPTIONAL_PARAMS_BAD_COMBO

-1130 INVALID_PARAMETER

20xx - Processing Issues

-2010 NEW_ORDER_REJECTED

-2011 CANCEL_REJECTED

-2013 NO_SUCH_ORDER

-2014 BAD_API_KEY_FMT

-2015 REJECTED_MBX_KEY

-2016 NO_TRADING_WINDOW

-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

-4141 SYMBOL_ALREADY_CLOSED