基本信息

Rest 基本信息

本篇列出REST接口的baseurl https://vapi.binance.com
所有接口的响应都是JSON格式
响应中如有数组，数组元素以时间升序排列，越早的数据越提前。
所有时间、时间戳均为UNIX时间，单位为毫秒

HTTP 返回代码

HTTP 4XX 错误码用于指示错误的请求内容、行为、格式。问题在于请求者。
HTTP 403 错误码表示违反WAF限制(Web应用程序防火墙)。
HTTP 429 错误码表示警告访问频次超限，即将被封IP。
HTTP 418 表示收到429后继续访问，于是被封了。
HTTP 5XX 错误码用于指示Binance服务侧的问题。
HTTP 504 表示API服务端已经向业务核心提交了请求但未能获取响应,特别需要注意的是504代码不代表请求失败,而是未知。很可能已经得到了执行,也有可能执行失败,需要做进一步确认。

接口错误代码

任何接口都可能返回错误
具体的错误码及其解释在错误代码

接口的基本信息

GET方法的接口, 参数必须在query string中发送.
POST, PUT, 和 DELETE 方法的接口, 参数可以在 query string中发送，也可以在 request body中发送(content type application/x-www-form-urlencoded)。允许混合这两种方式发送参数。
对参数的顺序不做要求。
但如果同一个参数名在query string和request body中都有，query string中的会被优先采用。

testnet 环境信息

本篇接口亦可接入testnet测试平台使用
testnet环境REST接口的baseurl https://testnet.binanceops.com
testnet环境Websocket的baseurl wss://testnetws.binanceops.com

接口鉴权类型

每个接口都有自己的鉴权类型，鉴权类型决定了访问时应当进行何种鉴权
如果需要 API-key，应当在HTTP头中以X-MBX-APIKEY字段传递
API-key 与 API-secret 是大小写敏感的
可以在网页用户中心修改API-key 所具有的权限，例如读取账户信息、发送交易指令、发送提现指令

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

需要签名的接口

调用这些接口时，除了接口本身所需的参数外，还需要传递signature即签名参数。
签名使用HMAC SHA256算法. API-KEY所对应的API-Secret作为 HMAC SHA256 的密钥，其他所有参数作为HMAC SHA256的操作对象，得到的输出即为签名。
签名大小写不敏感。
当同时使用query string和request body时，HMAC SHA256的输入query string在前，request body在后

时间同步安全

签名接口均需要传递timestamp参数, 其值应当是请求发送时刻的unix时间戳(毫秒)
服务器收到请求时会判断请求中的时间戳，如果是5000毫秒之前发出的，则请求会被认为无效。这个时间窗口值可以通过发送可选参数recvWindow来自定义。
另外，如果服务器计算得出客户端时间戳在服务器时间的‘未来’一秒以上，也会拒绝请求。

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

POST /vapi/v1/order 的示例

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

Key	Value
apiKey	22BjeOROKiXJ3NxbR3zjh3uoGcaflPu3VMyBXAg8Jj2J1xVSnY0eB4dzacdE9IWn
secretKey	YtP1BudNOWZE1ag5uzCkh4hIC7qSmQOu797r5EJBFGhxBYivjj8HIX0iiiPof5yG

参数	取值
symbol	BTC-210129-40000-C
side	BUY
type	LIMIT
timeInForce	GTC
quantity	0.01
price	2000
recvWindow	5000
timestamp	1611825601400

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

    $ echo -n "symbol=BTC-210129-40000-C&side=BUY&type=LIMIT&timeInForce=GTC&quantity=0.01&price=2000&recvWindow=5000&timestamp=1611825601400" | openssl dgst -sha256 -hmac "YtP1BudNOWZE1ag5uzCkh4hIC7qSmQOu797r5EJBFGhxBYivjj8HIX0iiiPof5yG"
    (stdin)= 7c12045972f6140e765e0f2b67d28099718df805732676494238f50be830a7d7

    (HMAC SHA256)
    $ curl -H "X-MBX-APIKEY: 22BjeOROKiXJ3NxbR3zjh3uoGcaflPu3VMyBXAg8Jj2J1xVSnY0eB4dzacdE9IWn" -X POST 'https://vapi.binance.com/vapi/v1/order' -d 'symbol=BTC-210129-40000-C&side=BUY&type=LIMIT&timeInForce=GTC&quantity=0.01&price=2000&recvWindow=5000&timestamp=1611825601400&signature=7c12045972f6140e765e0f2b67d28099718df805732676494238f50be830a7d7'
    

requestBody:

symbol=BTC-210129-40000-C
&side=BUY
&type=LIMIT
&timeInForce=GTC
&quantity=0.01
&price=2000
&recvWindow=5000
&timestamp=1611825601400

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

    $ echo -n "symbol=BTC-210129-40000-C&side=BUY&type=LIMIT&timeInForce=GTC&quantity=0.01&price=2000&recvWindow=5000&timestamp=1611825601400" | openssl dgst -sha256 -hmac "YtP1BudNOWZE1ag5uzCkh4hIC7qSmQOu797r5EJBFGhxBYivjj8HIX0iiiPof5yG"
    (stdin)= 7c12045972f6140e765e0f2b67d28099718df805732676494238f50be830a7d7
    

    (HMAC SHA256)
   $ curl -H "X-MBX-APIKEY: 22BjeOROKiXJ3NxbR3zjh3uoGcaflPu3VMyBXAg8Jj2J1xVSnY0eB4dzacdE9IWn" -X POST 'https://vapi.binance.com/vapi/v1/order?symbol=BTC-210129-40000-C&side=BUY&type=LIMIT&timeInForce=GTC&quantity=0.01&price=2000&recvWindow=5000&timestamp=1611825601400&signature=7c12045972f6140e765e0f2b67d28099718df805732676494238f50be830a7d7'
    

queryString:

symbol=BTC-210129-40000-C
&side=BUY
&type=LIMIT
&timeInForce=GTC
&quantity=0.01
&price=2000
&recvWindow=5000
&timestamp=1611825601400

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

   $ echo -n "symbol=BTC-210129-40000-C&side=BUY&type=LIMIT&timeInForce=GTCquantity=0.01&price=2000&recvWindow=5000&timestamp=1611825601400" | openssl dgst -sha256 -hmac "YtP1BudNOWZE1ag5uzCkh4hIC7qSmQOu797r5EJBFGhxBYivjj8HIX0iiiPof5yG"
    (stdin)= fa6045c54fb02912b766442be1f66fab619217e551a4fb4f8a1ee000df914d8e
    

    (HMAC SHA256)
    $ curl -H "X-MBX-APIKEY: 22BjeOROKiXJ3NxbR3zjh3uoGcaflPu3VMyBXAg8Jj2J1xVSnY0eB4dzacdE9IWn" -X POST 'https://vapi.binance.com/vapi/v1/order?symbol=BTC-210129-40000-C&side=BUY&type=LIMIT&timeInForce=GTC' -d 'quantity=0.01&price=2000&recvWindow=5000&timestamp=1611825601400&signature=fa6045c54fb02912b766442be1f66fab619217e551a4fb4f8a1ee000df914d8e'

queryString:

symbol=BTC-210129-40000-C&side=BUY&type=LIMIT&timeInForce=GTC

requestBody:

quantity=0.01&price=2000&recvWindow=5000&timestamp=1611825601400

请注意，签名与示例3不同。 “GTC”和”quantity = 1”之间没有＆。

公开API参数

术语解释

symbol 指期权合约交易对名称
underlying 指期权合约交易对的标的物交易对
baseAsset 指标的物交易对交易对象
quoteAsset 指标的物交易对的定价资产
settleAsset 指期权合约交易对行权时的结算资产

枚举定义

期权合约类型

CALL 看涨
PUT 看跌

订单方向

BUY 买入
SELL 卖出

持仓方向

LONG 多头
SHORT 空头

有效方法 (timeInForce)

GTC - Good Till Cancel 成交为止
IOC - Immediate or Cancel 无法立即成交(吃单)的部分就撤销
FOK - Fill or Kill 无法全部立即成交就撤销

响应类型 (newOrderRespType)

ACK
RESULT

订单种类 (type)

LIMIT 限价单
MARKET 市价单
REDUCING 主动减仓单
REDUCED 被动减仓单
LIQUIDATION 强平单

订单状态 (status)

RECEIVED(0) 新建订单
UNTRIGGERED(1) 下单失败
ACCEPTED(2) 下单成功
REJECTED(3) 订单被拒绝
PARTIALLY_FILLED(4) 部分成交
FILLED(5) 完全成交
CANCELLING(6) 撤单中
CANCELLED(7) 撤单完成

行情接口

测试能否联通

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

GET /vapi/v1/ping

权重: 1

参数: NONE

获取服务器时间

{
  "code": 0,
  "msg": "success",
  "data": 1592387156596 // 当前的系统时间
}

GET /vapi/v1/time

权重: 1

参数: NONE

获取此时的交易对信息

{
  "code": 0,
  "msg": "success",
  "data": [
    {
      "id": 1,
      "contractId": 1,
      "underlying": "BTCUSDT",          // 合约标的
      "quoteAsset": "USDT",             // 计价资产
      "symbol": "BTC-200730-9000-C",    // 交易对名称
      "unit": 1,                        // 兑换比例，一张合约代表的标的数量
      "minQty": 1,                      // 合约标的最少交易量
      "side": "CALL",                   // 方向: CALL 多, PUT 空
      "leverage": 0,                    // 杠杆
      "strikePrice": 9000,              // 行权价格
      "expiryDate": 1593518400000       // 行权时间
    }
  ]
}

GET /vapi/v1/optionInfo

权重: 1

参数: NONE

获取此时的限制信息和交易对信息

{
  "code": 0,
  "msg": "success",
  "data": {
    "timezone": "UTC",                    // 服务器所用的时间区域
    "serverTime": 1592387337630,          // 当前的系统时间
    "optionContracts": [                  // 期权合约标的信息
      {
        "id": 1,
        "baseAsset": "BTC",               // 基准货币
        "quoteAsset": "USDT",             // 计价货币
        "underlying": "BTCUSDT",          // 期权合约标的名称
        "settleAsset": "USDT"             // 结算货币
      }
    ],
    "optionAssets": [                     // 期权资产信息
      {
        "id": 1,
        "name": "USDT"                    // 资产名称
      }
    ],
    "optionSymbols": [                    // 期权交易对信息
      {
        "id": 1,
        "contractId": 1,
        "underlying": "BTCUSDT",          // 合约标的
        "quoteAsset": "USDT",             // 计价资产
        "symbol": "BTC-200730-9000-C",    // 交易对名称
        "unit": 1,                        // 兑换比例，一张合约代表的标的数量
        "minQty": 1,                      // 合约标的最少交易量
        "side": "CALL",                   // 方向: CALL 多, PUT 空
        "leverage": 0,                    // 杠杆
        "strikePrice": 9000,              // 行权价格
        "expiryDate": 1593518400000       // 行权时间
      }
    ]
  }
}

GET /vapi/v1/exchangeInfo

权重: 1

参数: NONE

现货指数价格获取

{
  "code": 0,
  "msg": "success",
  "data": {
    "indexPrice": "9200" // 当前现货指数价格
  }
}

GET /vapi/v1/index

权重: 1

参数:

名称	类型	是否必需	描述	示例
underlying	STRING	YES	现货币种对（期权合约标的）	BTCUSDT

获取最新价格

{
  "code": 0,
  "msg": "success",
  "data": [
    {
      "symbol": "BTC-200730-9000-C",
      "priceChange": "-16.2038",        //24小时价格变动
      "priceChangePercent": "-0.0162",  //24小时价格变动百分比
      "lastPrice": "1000",              //最近一次成交价
      "lastQty": "1000",                //最近一次成交额
      "open": "1016.2038",              //24小时Open价格
      "high": "1016.2038",              //24小时High价格
      "low": "0",                       //24小时Low价格
      "volume": "5",                    //交易量
      "amount": null,                   //交易金额
      "openTime": 1592317127349,        //24小时内，第一笔交易的发生时间
      "closeTime": 1592380593516,       //24小时内，最后一笔交易的发生时间
      "firstTradeId": 1,                //首笔成交id
      "tradeCount": 5,                  //成交笔数
      "strikePrice": "9000"             //行权价
    }
  ]
}

GET /vapi/v1/ticker

权重: 1

参数:

名称	类型	是否必需	描述	示例
symbol	STRING	NO	期权交易对	BTC-200730-9000-C

获取最新标记价格

{
  "code": 0,
  "msg": "success",
  "data": [
    {
      "symbol": "BTC-200730-9000-C",
      "markPrice": 1343.2883,       //标记价格
      "bidIV": "1.40000077",        //隐含波动率 买
      "askIV": "1.50000153",        //隐含波动率 卖
      "delta": 0.55937056,          //delta
      "theta": 3739.82509871,       //theta
      "gamma": 0.00010969,          //gamma
      "vega": 978.58874732,         //vega
      "highPriceLimit": 1618.241,   //当前最高价格限制
      "lowPriceLimit": 1068.3356    //当前最低价格限制
    }
  ]
}

GET /vapi/v1/mark

权重: 1

参数:

名称	类型	是否必需	描述	示例
symbol	STRING	NO	期权交易对	BTC-200730-9000-C

深度信息

{
  "code": 0,
  "msg": "success",
  "data": {
    "bids": [   // 买单
      [
        "1000", // 价格
        "0.9"   // 数量
      ]
    ],
    "asks": [   // 卖单
      [
        "1100", // 价格
        "0.1"   // 数量
      ]
    ]
  }
}

GET /vapi/v1/depth

权重: 5

参数:

名称	类型	是否必需	描述	示例
symbol	STRING	YES	期权交易对	BTC-200730-9000-C
limit	INT	NO	默认值:100 最大值:1000.可选值:[10, 20, 50, 100, 500, 1000]	100

K线数据

{
  "code": 0,
  "msg": "success",
  "data": [
      {
        "close": "1000",            // 收盘价(当前K线未结束的即为最新价)
        "closeTime": 1499644799999, // 收盘时间
        "tradeCount": 10,           // 成交笔数
        "high": "1100",             // 最高价
        "low": "900",               // 最低价
        "open": "950",              // 开盘价
        "openTime": 1499040000000,  // 开盘时间
        "takerAmount": "10000",     // 主动成交交易金额
        "takerVolume": "100",       // 主动成交交易量
        "interval": "5m",           // K线类型
        "volume": "100"             // 交易量
      }
  ]
}

GET /vapi/v1/klines

权重: 5

参数:

名称	类型	是否必需	描述	示例
symbol	STRING	YES	期权交易对	BTC-200730-9000-C
interval	STRING	YES	时间间隔	5m
startTime	LONG	NO	起始时间	1592317127349
endTime	LONG	NO	结束时间	1592318127349
limit	INT	NO	记录条数默认值:500 最大值:1500	500

期权近期成交

{
  "code": 0,
  "msg": "success",
  "data": [
    {
      "price": "1000",      // 成交价格
      "qty": "-0.1",        // 成交数量
      "quoteQty": "-100",   // 成交额
      "time": 1592449455993,// 时间
      "side": -1            // 成交方向（-1 卖，1 买）
    }
  ]
}

GET /vapi/v1/trades

权重: 5

参数:

名称	类型	是否必需	描述	示例
symbol	STRING	YES	期权交易对	BTC-200730-9000-C
limit	INT	NO	交易记录条数默认值:100 最大值:500	100

查询历史成交

{
  "code": 0,
  "msg": "success",
  "data": [
    {
      "price": "1000",      // 成交价格
      "qty": "-0.1",        // 成交数量
      "quoteQty": "-100",   // 成交额
      "time": 1592449455993,// 时间
      "side": -1            // 成交方向（-1 卖，1 买）
    }
  ]
}

GET /vapi/v1/historicalTrades

权重: 5

参数:

名称	类型	是否必需	描述	示例
symbol	STRING	YES	期权交易对	BTC-200730-9000-C
fromId	LONG	NO	从哪一条成交id开始返回. 缺省返回最近的成交记录	1592317127349
limit	INT	NO	交易记录条数默认值:100 最大值:500	100

账户和交易接口

账户资产信息(USER_DATA)

{
  "code": 0,
  "msg": "success",
  "data": [
    {
      "currency": "USDT",               // 资产类型
      "equity": 10094.44662,            // 账户权益
      "available": 8725.92524,          // 账户可用
      "orderMargin": 1084.52138,        // 委托保证金
      "positionMargin": 289.00138,      // 持仓保证金
      "unrealizedPNL": -5.00138,        // 未实现盈亏
      "maintMargin": 151.00138,         // 维持保证金
      "balance": 10099.448              // 账户余额
    }
  ]
}

GET /vapi/v1/account (HMAC SHA256)

权重: 1

参数:

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

资金划转(USER_DATA)

{
  "code": 0,
  "msg": "success",
  "data": 4         // 划转记录ID
}

POST /vapi/v1/transfer (HMAC SHA256)

权重: 1

参数:

名称	类型	是否必需	描述	示例
currency	STRING	YES	资产类型	USDT
type	ENUM	YES	IN: 现货账户向合约账户划转 OUT: 合约账户向现货账户划转	IN
amount	DECIMAL	YES	金额	10000
recvWindow	LONG	NO
timestamp	LONG	YES

期权持仓信息(USER_DATA)

{
  "code": 0,
  "msg": "success",
  "data": [
    {
      "entryPrice": 1000,               // 开仓均价
      "symbol": "BTC-200730-9000-C",    // 期权交易对
      "side": "SHORT",                  // 持仓方向
      "leverage": 0,                    // 杠杆
      "quantity": -0.1,                 // 持仓数量（正数为多，负数为空）
      "reducibleQty": 0,                // 可平仓数量
      "markValue": 105.00138,           // 当前市值
      "autoReducePriority": 0,          // 减仓顺序
      "ror": -0.05,                     // 收益率
      "unrealizedPNL": -5.00138,        // 未实现盈亏
      "markPrice": 1050.0138,           // 标记价格
      "strikePrice": 9000,              // 行权价格
      "expiryDate": 1593511200000       // 行权时间
    }
  ]
}

GET /vapi/v1/position (HMAC SHA256)

权重: 1

参数:

名称	类型	是否必需	描述	示例
symbol	STRING	NO	期权交易对	BTC-200730-9000-C
recvWindow	LONG	NO
timestamp	LONG	YES

账户资金流水(USER_DATA)

{
  "code": 0,
  "msg": "success",
  "data": [
    {
      "id": 1125899906842624000,
      "currency": "USDT",           // 资产类型
      "amount": -0.552,             // 金额（正数代表流入，负数代表流出）
      "type": "FEE",                // 账单类型（手续费）
      "createDate": 1592449456000,  // 时间
    },
    {
      "id": 1125899906842624000,
      "currency": "USDT",           // 资产类型
      "amount": 100,                // 金额（正数代表流入，负数代表流出）
      "type": "CONTRACT",           // 账单类型（买卖合约）
      "createDate": 1592449456000,  // 时间
    },
    {
      "id": 1125899906842624000,
      "currency": "USDT",           // 资产类型
      "amount": 10000,              // 金额（正数代表流入，负数代表流出）
      "type": "TRANSFER",           // 账单类型（资金划转）
      "createDate": 1592448410000,  // 时间
    }
  ]
}

POST /vapi/v1/bill (HMAC SHA256)

权重: 1

参数:

名称	类型	是否必需	描述	示例
currency	STRING	YES	资产类型	USDT
recordId	LONG	NO	返回该recordId及之后的数据,缺省返回最近的数据	100000
startTime	LONG	NO	起始时间	1593511200000
endTime	LONG	NO	结束时间	1593512200000
limit	INT	NO	返回的结果集数量默认值:100 最大值:1000	100
recvWindow	LONG	NO
timestamp	LONG	YES

期权下单 (TRADE)

{
  "code": 0,
  "msg": "success",
  "data": {
    "id": "4611875134427365377",        // 系统订单号
    "symbol": "BTC-200730-9000-C",      // 期权交易对
    "price": 100,                       // 委托价格
    "quantity": 1,                      // 委托数量
    "executedQty": 0,                   // 成交数量
    "fee": 0,                           // 手续费
    "side": "BUY",                      // 买卖方向
    "type": "LIMIT",                    // 订单类型
    "timeInForce": "GTC",               // 有效方法
    "createDate": 1592465880683,        // 委托时间
    "status": "ACCEPTED",               // 订单状态
    "avgPrice": 0,                      // 成交均价
    "source": "WEB",                    // 订单来源
    "reduceOnly": false,                // 是否仅平仓单
    "clientOrderId": ""                 // 客户端订单ID
  }
}

POST /vapi/v1/order (HMAC SHA256)

权重: 1

参数:

名称	类型	是否必需	描述	示例
symbol	STRING	YES	期权交易对	BTC-200730-9000-C
side	ENUM	YES	买卖方向 SELL, BUY	BUY
type	ENUM	YES	订单类型 LIMIT(仅支持LIMIT)	LIMIT
quantity	DECIMAL	YES	下单数量	3
price	DECIMAL	NO	委托价格	1000
timeInForce	ENUM	NO	有效方法（默认GTC）	GTC
reduceOnly	BOOLEAN	NO	是否仅平仓单（默认false）	false
newOrderRespType	ENUM	NO	“ACK”, “RESULT”, 默认 “ACK”	ACK
clientOrderId	STRING	NO	用户自定义的订单号，不可以重复出现在挂单中	10000
recvWindow	LONG	NO
timestamp	LONG	YES

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

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

期权批量下单 (TRADE)

{
  "code": 0,
  "msg": "SUCCESS 5, FAILED 0",
  "data": [{
    "id": "4611875134427365377",        // 系统订单号
    "symbol": "BTC-200730-9000-C",      // 期权交易对
    "price": 100,                       // 委托价格
    "quantity": 1,                      // 委托数量
    "executedQty": 0,                   // 成交数量
    "fee": 0,                           // 手续费
    "side": "BUY",                      // 买卖方向
    "type": "LIMIT",                    // 订单类型
    "timeInForce": "GTC",               // 有效方法
    "createDate": 1592465880683,        // 委托时间
    "status": "ACCEPTED",               // 订单状态
    "avgPrice": 0,                      // 成交均价
    "source": "WEB",                    // 订单来源
    "reduceOnly": false,                // 是否仅平仓单
    "clientOrderId": ""                 // 客户端订单ID
  }]
}

POST /vapi/v1/batchOrders (HMAC SHA256)

权重: 1

参数:

名称	类型	是否必需	描述	示例
orders	LIST	YES	订单列表，最多支持5个订单	[{“symbol”:”BTC-210115-35000-C”,”price”:”100”,”quantity”:”0.0001”,”side”:”BUY”,”type”:”LIMIT”}]
recvWindow	LONG	NO
timestamp	LONG	YES

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

名称	类型	是否必需	描述	示例
symbol	STRING	YES	期权交易对	BTC-200730-9000-C
side	ENUM	YES	买卖方向 SELL, BUY	BUY
type	ENUM	YES	订单类型 LIMIT(仅支持LIMIT)	LIMIT
quantity	DECIMAL	YES	下单数量	3
price	DECIMAL	NO	委托价格	1000
timeInForce	ENUM	NO	有效方法（默认GTC）	GTC
reduceOnly	BOOLEAN	NO	是否仅平仓单（默认false）	false
newOrderRespType	ENUM	NO	“ACK”, “RESULT”, 默认 “ACK”	ACK
clientOrderId	STRING	NO	用户自定义的订单号，不可以重复出现在挂单中	10000

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

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

具体订单条件规则，与普通下单一致
批量下单采取并发处理，不保证订单撮合顺序
批量下单的返回内容顺序，与订单列表顺序一致

期权撤销订单 (TRADE)

{
  "code": 0,
  "msg": "success",
  "data": {
    "id": "4611875134427365377",        // 系统订单号
    "symbol": "BTC-200730-9000-C",      // 期权交易对
    "price": 100,                       // 委托价格
    "quantity": 1,                      // 委托数量
    "executedQty": 0,                   // 成交数量
    "fee": 0,                           // 手续费
    "side": "BUY",                      // 买卖方向
    "type": "LIMIT",                    // 订单类型
    "timeInForce": "GTC",               // 有效方法
    "createDate": 1592465880683,        // 委托时间
    "status": "CANCELLED",              // 订单状态
    "avgPrice": 0,                      // 成交均价
    "source": "WEB",                    // 订单来源
    "reduceOnly": false,                // 是否仅平仓单
    "clientOrderId": ""                 // 客户端订单ID
  }
}

DELETE /vapi/v1/order (HMAC SHA256)

权重: 1

参数:

名称	类型	是否必需	描述	示例
symbol	STRING	YES	期权交易对	BTC-200730-9000-C
orderId	LONG	NO	订单ID	4611875134427365377
clientOrderId	STRING	NO	用户自定义的订单号	10000
recvWindow	LONG	NO
timestamp	LONG	YES

orderId 与 clientOrderId 必须至少发送一个

期权批量撤销订单 (TRADE)

{
  "code": 0,
  "msg": "SUCCESS 5, FAILED 0",
  "data": [{
    "id": "4611875134427365377",        // 系统订单号
    "symbol": "BTC-200730-9000-C",      // 期权交易对
    "price": 100,                       // 委托价格
    "quantity": 1,                      // 委托数量
    "executedQty": 0,                   // 成交数量
    "fee": 0,                           // 手续费
    "side": "BUY",                      // 买卖方向
    "type": "LIMIT",                    // 订单类型
    "timeInForce": "GTC",               // 有效方法
    "createDate": 1592465880683,        // 委托时间
    "status": "CANCELLED",              // 订单状态
    "avgPrice": 0,                      // 成交均价
    "source": "WEB",                    // 订单来源
    "reduceOnly": false,                // 是否仅平仓单
    "clientOrderId": ""                 // 客户端订单ID
  }]
}

DELETE /vapi/v1/batchOrders (HMAC SHA256)

权重: 1

参数:

名称	类型	是否必需	描述	示例
symbol	STRING	YES	期权交易对	BTC-200730-9000-C
orderIds	LIST	NO	订单ID,最多支持10个订单	[4611875134427365377,4611875134427365378]
clientOrderIds	LIST	NO	用户自定义的订单号,最多支持10个订单	[“my_id_1”,”my_id_2”]
recvWindow	LONG	NO
timestamp	LONG	YES

orderIds 与 clientOrderIds 必须至少发送一个，不可同时发送

期权撤销全部订单 (TRADE)

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

DELETE /vapi/v1/allOpenOrders (HMAC SHA256)

权重: 1

参数:

名称	类型	是否必需	描述	示例
symbol	STRING	YES	期权交易对	BTC-200730-9000-C
recvWindow	LONG	NO
timestamp	LONG	YES

期权查询订单 (TRADE)

{
  "code": 0,
  "msg": "success",
  "data": {
    "id": "4611875134427365377",        // 系统订单号
    "symbol": "BTC-200730-9000-C",      // 期权交易对
    "price": 100,                       // 委托价格
    "quantity": 1,                      // 委托数量
    "executedQty": 0,                   // 成交数量
    "fee": 0,                           // 手续费
    "side": "BUY",                      // 买卖方向
    "type": "LIMIT",                    // 订单类型
    "timeInForce": "GTC",               // 有效方法
    "createDate": 1592465880683,        // 委托时间
    "status": "ACCEPTED",               // 订单状态
    "avgPrice": 0,                      // 成交均价
    "source": "WEB",                    // 订单来源
    "reduceOnly": false,                // 是否仅平仓单
    "clientOrderId": ""                 // 客户端订单ID
  }
}

GET /vapi/v1/order (HMAC SHA256)

权重: 1

参数:

名称	类型	是否必需	描述	示例
symbol	STRING	YES	期权交易对	BTC-200730-9000-C
orderId	LONG	NO	订单ID	4611875134427365377
clientOrderId	STRING	NO	用户自定义的订单号	10000
recvWindow	LONG	NO
timestamp	LONG	YES

orderId 与 clientOrderId 必须至少发送一个

期权查询当前挂单 (TRADE)

{
  "code": 0,
  "msg": "success",
  "data": [
      {
        "id": "4611875134427365377",        // 系统订单号
        "symbol": "BTC-200730-9000-C",      // 期权交易对
        "price": 100,                       // 委托价格
        "quantity": 1,                      // 委托数量
        "executedQty": 0,                   // 成交数量
        "fee": 0,                           // 手续费
        "side": "BUY",                      // 买卖方向
        "type": "LIMIT",                    // 订单类型
        "timeInForce": "GTC",               // 有效方法
        "createDate": 1592465880683,        // 委托时间
        "status": "ACCEPTED",               // 订单状态
        "avgPrice": 0,                      // 成交均价
        "source": "WEB",                    // 订单来源
        "reduceOnly": false,                // 是否仅平仓单
        "clientOrderId": ""                 // 客户端订单ID
      }
  ]
}

GET /vapi/v1/openOrders (HMAC SHA256)

权重: 1

参数:

名称	类型	是否必需	描述	示例
symbol	STRING	YES	期权交易对	BTC-200730-9000-C
orderId	LONG	NO	返回该orderId及之后的订单，缺省返回最近的订单	100000
startTime	LONG	NO	起始时间	1593511200000
endTime	LONG	NO	结束时间	1593512200000
limit	INT	NO	返回的结果集数量默认值:100 最大值:1000	100
recvWindow	LONG	NO
timestamp	LONG	YES

期权查询历史委托 (TRADE)

{
  "code": 0,
  "msg": "success",
  "data": [
      {
        "id": "4611875134427365377",        // 系统订单号
        "symbol": "BTC-200730-9000-C",      // 期权交易对
        "price": 100,                       // 委托价格
        "quantity": 1,                      // 委托数量
        "executedQty": 0,                   // 成交数量
        "fee": 0,                           // 手续费
        "side": "BUY",                      // 买卖方向
        "type": "LIMIT",                    // 订单类型
        "timeInForce": "GTC",               // 有效方法
        "createDate": 1592465880683,        // 委托时间
        "status": "CANCELLED",              // 订单状态
        "avgPrice": 0,                      // 成交均价
        "source": "WEB",                    // 订单来源
        "reduceOnly": false,                // 是否仅平仓单
        "clientOrderId": ""                 // 客户端订单ID
      }
  ]
}

GET /vapi/v1/historyOrders (HMAC SHA256)

权重: 1

参数:

名称	类型	是否必需	描述	示例
symbol	STRING	YES	期权交易对	BTC-200730-9000-C
orderId	LONG	NO	返回该orderId及之后的订单，缺省返回最近的订单	100000
startTime	LONG	NO	起始时间	1593511200000
endTime	LONG	NO	结束时间	1593512200000
limit	INT	NO	返回的结果集数量默认值:100 最大值:1000	100
recvWindow	LONG	NO
timestamp	LONG	YES

Websocket账户信息推送

本篇所列出API接口的base url: https://vapi.binance.com

用于订阅账户数据的 listenKey 从创建时刻起有效期为60分钟

可以通过 PUT 一个 listenKey 延长60分钟有效期

可以通过DELETE一个 listenKey 立即关闭当前数据流，并使该listenKey 无效

在具有有效listenKey的帐户上执行POST将返回当前有效的listenKey并将其有效期延长60分钟

websocket接口的baseurl: wss://vstream.binance.com

U订阅账户数据流的stream名称为 /ws/ 或 /stream?streams=

每个链接有效期不超过24小时，请妥善处理断线重连。

账户数据流的消息不保证严格时间序; 请使用 E 字段进行排序

数据默认是GZIP压缩数据连接成功后发送 {"method":"BINARY", "params":["false"], "id":1} 转换为文本数据

生成 Listen Key (USER_STREAM)

{
  "listenKey":"pqia91ma19a5s61cv6a81va65sdf19v8a65a1a5s61cv6a81va65sdf19v8a65a1"
}

开始一个新的数据流。除非发送 keepalive，否则数据流于60分钟后关闭。如果该帐户具有有效的listenKey，则将返回该listenKey并将其有效期延长60分钟。

GET /vapi/v1/userDataStream

权重: 1

参数: NONE

延长 Listen Key 有效期 (USER_STREAM)

{
  "listenKey":"pqia91ma19a5s61cv6a81va65sdf19v8a65a1a5s61cv6a81va65sdf19v8a65a1"
}

有效期延长至本次调用后60分钟,建议每30分钟发送一个 put 请求。

PUT /vapi/v1/userDataStream

权重: 1

参数:

名称	类型	是否必需	描述	示例
listenKey	STRING	YES	listenKey	“pqia91ma19a5s61cv6a81va65sdf19v8a65a1a5s61cv6a81va65sdf19v8a65a1”

删除 Listen Key (USER_STREAM)

{}

开始一个新的数据流。除非发送 keepalive，否则数据流于60分钟后关闭。如果该帐户具有有效的listenKey，则将返回该listenKey并将其有效期延长60分钟。

DELETE /vapi/v1/userDataStream

权重: 1

参数:

名称	类型	是否必需	描述	示例
listenKey	STRING	YES	listenKey	“pqia91ma19a5s61cv6a81va65sdf19v8a65a1a5s61cv6a81va65sdf19v8a65a1”

Payload: 账户数据

当下列情形发生时更新: 账户发生充值或提取

交易账户之间发生划转(例如现货向杠杆账户划转)

持仓变化

{
    "e":"ACCOUNT_UPDATE",                   // 事件类型
    "E":1591696384141,                      // 事件时间
    "B":[
        {
          
            "b":"100007992.26053177",       // 账户余额
            "m":"0",                        // 持仓价值
            "u":"458.782655111111",         // 未实现盈亏
            "U":"458.782655111111",         // 未实现盈亏 (卖方)
            "o":"-13238.246342",            // 委托保证金额
            "p":"-18852.328456",            // 持仓保证金额
            "r":"-15452.328456",            // 减仓保证金额
            "M":"-15452.328456"             // 维持保证金额
        }
    ],
    //持仓信息变化 如果有变化包含P属性 没有变化则不包含
    "P":[
          {
           "S":symbol,                      // 合约类型
           "c":1,                           // 当前持仓量
           "r":1,                           // 可平仓量
           "p":1,                           // 持仓价值
           "a":1                            // 持仓均价
          }
        ]
}

Payload: 订单数据

当下列情形发生时更新: 订单变化下单撤单成交

订单状态 (s)

0 新建订单
1 下单失败
2 下单成功
3 订单被拒绝
4 部分成交
5 完全成交
6 撤单中
7 撤单完成

 "e":"ORDER_TRADE_UPDATE",                  // 事件类型
    "E":1591698525864,                      // 事件时间
    "o":[
        {
            "T":0,                          // 交易时间 
            "oid":1,                        // 订单Id
            "S":symbol,                     // 合约名称
            "cid":"zdy",                    // 用户自定义信息
            "q":"0.111",                    // 交易量
            "stp":0,                        // selfTradePrevention
            "r":false,                      // 减仓
            "c":false,                      // 暂未使用
            "s":0,                          // 状态 状态 0 初始订单 1下单失败  2 下单成功  3订单被拒绝 4 部分成交 5完全成交 6 撤单中  7 撤单成功 
            "e":"1",                        // 成交量
            "ec":"1",                       // 成交金额
            "f":"0.011"                     // 手续费
        }
    ]
}

Payload: 策略交易

当下列情形发生时更新: 订单变化下单撤单成交

{ ”e”:”STRATEGY_ORDER_TRADE_UPDATE”,//事件类型 ”E”:1611746634599,//事件时间 ”o”:[ { ”id”:”7”, //id ”S”:”symbol”, //币种 ”v”:”1.03”,//波动率 ”q”:”1”, //量 ”e”:”0”,//成交量 ”s”:1, //方向 1 long -1 short ”t”:0,// 订单类型 0 波动率下单 ”c”:1611736477000,//时间 ”st”:2, // 状态状态 0 初始订单 1下单失败 2 下单成功 3订单被拒绝 4 部分成交 5完全成交 6 撤单中 7 撤单成功 8 订单无效 ”sr”:0// 订单来源 0 web 1 ios 2 android 3 pc 4 h5 5 MAC 6 API } ] }

行情数据 Payload: 24小时TICKER

订阅一个信息流

{
    "e":"ticker",                           // 事件类型
    "E":1591677962357,                      // 事件事件
    "s":"BTC-200630-9000-P",                // 期权交易对
    "o":"1000",                             // 24小时开盘价
    "h":"1000",                             // 最高价
    "l":"1000",                             // 最低价
    "c":"1000",                             // 最新价
    "V":"2",                                // 交易量
    "A":"0",                                // 交易金额
    "p":"0",                                // 涨跌幅
    "Q":"2000",                             // 最后成交量
    "F":1,                                  // 第一笔交易id
    "L":1,                                  // 最后一笔交易Id
    "n":1,                                  // 交易笔数
    "b":"0",                                // 买隐含波动率
    "a":"0",                                // 卖隐含波动率
    "d":"0",                                // delta
    "t":"0",                                // theta
    "g":"0",                                // gamma
    "v":"0"                                 // vega
}

请求

{
“method”: “SUBSCRIBE”,
“params”:
[
“BTC-200630-9000-P@ticker”
],
“id”: 1
}

24ticker

行情数据 Payload: 最近成交

{
    "e":"trade",                        // 事件类型
    "E":1591677941092,                  // 事件时间
    "s":"BTC-200630-9000-P",            // 期权交易对
    "t":[                               // 历史交易
        {
            "t":1,                      // 交易Id
            "p":"1000",                 // 交易价格
            "q":"-2",                   // 交易量
            "b":4611781675939004417,    // 卖单Id
            "a":4611781675939004418,    // 卖单Id
            "T":1591677567872,          // 成交时间
            "s":"-1"                    // 方向
        }
    ]
}

请求

{
“method”: “SUBSCRIBE”,
“params”:
[
“BTC-200630-9000-P@trade”
],
“id”: 1
}

行情数据 Payload: k线

{
    "e":"kline",                        // 事件类型
    "E":1591677941085,                  // 事件事件
    "s":"BTC-200630-9000-P",            // 期权交易对
    "k":[{                              // 倒数第二条
        "t":1591677900000,              // k线事件
        "i":"1m",                       // k线周期
        "F":0,                          // 第一个交易id
        "L":0,                          // 最后一个交易id
        "o":"1000",                     // 开
        "h":"1000",                     // 高
        "l":"1000",                     // 低
        "c":"1000",                     // 收
        "v":"0",                        // 量
        "n":0,                          // 交易笔数
        "q":"0",                        // 成交金额
        "x":false,                      // 当前k线是否完成
        "V":"0",                        // taker成交量
        "Q":"0"                         // taker成交金额
    },{                                 // 最新k线数据
        "t":1591677900000,              // k线事件
        "i":"1m",                       // k线周期
        "F":0,                          // 第一个交易id
        "L":0,                          // 最后一个交易id
        "o":"1000",                     // 开
        "h":"1000",                     // 高
        "l":"1000",                     // 低
        "c":"1000",                     // 收
        "v":"0",                        // 量
        "n":0,                          // 交易笔数
        "q":"0",                        // 成交金额
        "x":false,                      // 当前k线是否完成
        "V":"0",                        // taker成交量
        "Q":"0"                         // taker成交金额
    }
  ]
}

请求

{
“method”: “SUBSCRIBE”,
“params”:
[
“BTC-200630-9000-P@kline_1m”
],
“id”: 1
}

周期 “1m”, “3m”, “5m”, “15m” “30m” “1h”, “2h”, “4h”, “6”, “12h “1d”, “3d”, “1w”,

行情数据 Payload: 深度

{
    "e":"depth",                        // 事件类型
    "E":1591695934033,                  // 事件时间
    "s":"BTC-200630-9000-P",            // 期权交易对
    "b":[                               // 买单
        [
            "200",                      // 价格
            "3"                         // 量
        ],
        [
            "101",
            "1"
        ],
        [
            "100",
            "2"
        ]
    ],
    "a":[                               // 卖单
        [
            "1000",
            "89"
        ]
    ]
}

请求

{
“method”: “SUBSCRIBE”,
“params”:
[
“BTC-200630-9000-P@depth10”
],
“id”: 1
}

返回深度条数 “10”, “20”, “50”, “100” “1000”

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

发送订阅深度请求。订阅之后第一次返回全量！需本地缓存起来，之后就是增量数量返回，根据增量数据更新本地缓存。
开始缓存收到的更新。同一个价位，后收到的更新覆盖前面的。
如果某个价格对应的挂单量为0，表示该价位的挂单已经撤单或者被吃，应该移除这个价位。
如果收到某个价位本地缓存中不存在，则新增本地缓存。
如果连接断开请重新连接,然后重复1-4步骤。

请求

{
“method”: “SUBSCRIBE”,
“params”:
[
“option_pair”
],
“id”: 1
}

交易对信息 Payload: 新增交易对信息推送

{
    "e":"OPTION_PAIR", //事件类型
    "E":1611636498525, //事件时间
    "id":1,            //id 
    "cid":1,           //合约标的ID
    "u":"BTCUSDT",     //标的(基准资产)
    "qa":"USDT",       //计价资产
    "S":"BTC-210106-10000-C", //币种
    "unit":"1",        //一张合约代表的标的数量
    "s":1,             //交易方向: 1 多, -1 空
    "l":"0",           //杠杆
    "sp":"10000",      //行权价格
    "ed":1609927200000 //行权时间
}

Websocket错误信息

错误码	描述
{“error”:{“code”:-1125,”msg”:”Invalid ListenKey “}}	Listen Key 无效
{“error”:{“code”:-1130,”msg”:”UNKNOWN_PARAM “}}	参数错误

错误代码

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

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

-1000 UNKNOWN

处理请求时发生未知错误。

-1001 DISCONNECTED

内部错误; 无法处理您的请求。请再试一次.

-1002 UNAUTHORIZED

您无权执行此请求。

-1003 TOO_MANY_REQUESTS

排队的请求过多。
请求权重过多；请使用websocket获取实时更新。
请求权重过多；当前限制为每分钟％s请求权重。请使用websocket进行实时更新，以避免轮询API。
请求权重过多； IP被禁止，直到％s。请使用websocket进行实时更新，以免被禁。

-1004 SERVER_BUSY

服务器正忙，请稍候再试。

-1006 UNEXPECTED_RESP

从消息总线收到意外的响应。执行状态未知。

-1007 TIMEOUT

等待后端服务器响应超时。发送状态未知；执行状态未知。

-1014 UNKNOWN_ORDER_COMPOSITION

不支持的订单组合。

-1015 TOO_MANY_ORDERS

新订单太多。
新订单太多；当前限制为每％s ％s个订单。

-1016 SERVICE_SHUTTING_DOWN

该服务不可用。

-1020 UNSUPPORTED_OPERATION

不支持此操作。

-1021 INVALID_TIMESTAMP

此请求的时间戳在recvWindow之外。
此请求的时间戳比服务器时间提前1000毫秒。

-1022 INVALID_SIGNATURE

此请求的签名无效。

11xx - 2xxx Request issues

-1100 ILLEGAL_CHARS

在参数中发现非法字符。
在参数中发现非法字符。％s
在参数％s中发现非法字符；合法范围是％s。

-1101 TOO_MANY_PARAMETERS

为此端点发送的参数太多。
参数太多；预期为％s并收到了％s。
检测到的参数值重复。

-1102 MANDATORY_PARAM_EMPTY_OR_MALFORMED

未发送强制性参数，该参数为空/空或格式错误。
强制参数％s未发送，为空/空或格式错误。
必须发送参数％s或％s，但两者均为空！

-1103 UNKNOWN_PARAM

发送了未知参数。

-1104 UNREAD_PARAMETERS

并非所有发送的参数都被读取。
并非所有发送的参数都被读取；读取了％s参数，但被发送了％s。

-1105 PARAM_EMPTY

参数为空。
参数％s为空。

-1106 PARAM_NOT_REQUIRED

不需要时已发送参数。
不需要时发送参数％s。

-1111 BAD_PRECISION

精度超过为此资产定义的最大值。

-1112 NO_DEPTH

交易对没有挂单。

-1114 TIF_NOT_REQUIRED

不需要时发送了TimeInForce参数。

-1115 INVALID_TIF

无效 timeInForce.

-1116 INVALID_ORDER_TYPE

无效订单类型。

-1117 INVALID_SIDE

无效买卖方向。

-1118 EMPTY_NEW_CL_ORD_ID

新的客户订单ID为空。

-1119 EMPTY_ORG_CL_ORD_ID

客户自定义的订单ID为空。

-1120 BAD_INTERVAL

无效时间间隔。

-1121 BAD_SYMBOL

无效的交易对。

-1125 INVALID_LISTEN_KEY

该listenKey不存在。

-1127 MORE_THAN_XX_HOURS

查询间隔太大。
从开始时间到结束时间之间超过％s小时。

-1128 BAD_CONTRACT

无效的期权合约标的。

-1129 BAD_CURRENCY

无效的资产类型。

-1130 INVALID_PARAMETER

发送的参数为无效数据。
发送参数％s的数据无效。

-1131 BAD_RECV_WINDOW

recvWindow 必须小于 60000

-2010 NEW_ORDER_REJECTED

新订单被拒绝

-2011 CANCEL_REJECTED

取消订单被拒绝

-2013 NO_SUCH_ORDER

订单不存在。

-2014 BAD_API_KEY_FMT

API-key 格式无效。

-2015 INVALID_API_KEY

无效的API密钥，IP或操作权限。

-2018 BALANCE_NOT_SUFFICIENT

余额不足。

-2027 OPTION_MARGIN_NOT_SUFFICIENT

期权可用余额不足。

3xxx-5xxx Filters and other issues

-3029 TRANSFER_FAILED

资金划转失败。

-4001 PRICE_LESS_THAN_ZERO

价格小于0。

-4002 PRICE_GREATER_THAN_MAX_PRICE

价格超过最大值。

-4003 QTY_LESS_THAN_ZERO

数量小于0。

-4004 QTY_LESS_THAN_MIN_QTY

数量小于最小值。

-4005 QTY_GREATER_THAN_MAX_QTY

数量大于最大值。

-4013 PRICE_LESS_THAN_MIN_PRICE

价格小于最小价格。

-4029 INVALID_TICK_SIZE_PRECISION

价格精度小数点位数不正确。

-4030 INVALID_QTY_PRECISION

数量精度小数点位数不正确。

-4055 AMOUNT_MUST_BE_POSITIVE

金额必须大于零。

-5055 BLACK_COUNTRY

此国家在黑名单上。