Navbar
简体中文

更新日志

2021-10-01

2021-08-06

2021-07-23

2021-04-02

基本信息

Rest 基本信息

HTTP 返回代码

接口错误代码

接口的基本信息

testnet 环境信息

接口鉴权类型

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

需要签名的接口

时间同步安全

关于交易时效性 互联网状况并不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 发送

Example 1

HMAC SHA256 signature:

    $ 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

curl command:

    (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'

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

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

Example 2

HMAC SHA256 signature:

    $ 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

curl command:

    (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'

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

Example 3

HMAC SHA256 signature:

   $ 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

curl command:

    (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'

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

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

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

公开API参数

术语解释

枚举定义

期权合约类型

订单方向

持仓方向

有效方法 (timeInForce)

响应类型 (newOrderRespType)

订单种类 (type)

订单状态 (status)

行情接口

测试能否联通

响应:

{
  "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": 0.0002,                 // 合约标的最少交易量
      "maxQty": "10000",                // 合约标的最大交易量
      "priceScale": 2,                  // 报价资产精度
      "quantityScale": 4,               // 标的资产精度
      "side": "CALL",                   // 方向: CALL 多, PUT 空
      "leverage": 0,                    // 杠杆
      "strikePrice": 9000,              // 行权价格
      "makerFeeRate": "0.0003",         // maker手续费费率
      "takerFeeRate": "0.0003",         // taker手续费费率
      "initialMargin": "0.15",          // 开仓保证金率
      "autoReduceMargin": "0.075",      // 减仓保证金率
      "maintenanceMargin": "0.02",      // 维持保证金率
      "minInitialMargin": "0.1",        // 最低开仓保证金率
      "minAutoReduceMargin": "0.05",    // 最低减仓保证金率
      "minMaintenanceMargin": "0.013",  // 最低维持保证金率
      "expiryDate": 1593518400000,      // 行权时间
      "filters": [
        {
          "filterType": "PRICE_FILTER", // 价格限制
          "minPrice": "0.02",           // 卖出方向价格下限, 最小价格
          "maxPrice": "9223",           // 买入方向价格上限, 最大价格
          "tickSize": "0.01"            // 订单最小价格间隔
        },
        {
          "filterType": "LOT_SIZE",     // 数量限制
          "minQty": "0.0002",           // 数量下限, 最小数量
          "maxQty": "100000",           // 数量上限, 最大数量
          "stepSize": "0.0001"          // 订单最小数量间隔
        }
      ]
    }
  ]
}

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": 0.0002,                 // 合约标的最少交易量
        "maxQty": "10000",                // 合约标的最大交易量
        "priceScale": 2,                  // 报价资产精度
        "quantityScale": 4,               // 标的资产精度
        "side": "CALL",                   // 方向: CALL 多, PUT 空
        "leverage": 0,                    // 杠杆
        "strikePrice": 9000,              // 行权价格
        "makerFeeRate": "0.0003",         // maker手续费费率
        "takerFeeRate": "0.0003",         // taker手续费费率
        "initialMargin": "0.15",          // 开仓保证金率
        "autoReduceMargin": "0.075",      // 减仓保证金率
        "maintenanceMargin": "0.02",      // 维持保证金率
        "minInitialMargin": "0.1",        // 最低开仓保证金率
        "minAutoReduceMargin": "0.05",    // 最低减仓保证金率
        "minMaintenanceMargin": "0.013",  // 最低维持保证金率
        "expiryDate": 1593518400000,      // 行权时间
        "filters": [
          {
            "filterType": "PRICE_FILTER", // 价格限制
            "minPrice": "0.02",           // 卖出方向价格下限, 最小价格
            "maxPrice": "9223",           // 买入方向价格上限, 最大价格
            "tickSize": "0.01"            // 订单最小价格间隔
          },
          {
            "filterType": "LOT_SIZE",     // 数量限制
            "minQty": "0.0002",           // 数量下限, 最小数量
            "maxQty": "100000",           // 数量上限, 最大数量
            "stepSize": "0.0001"          // 订单最小数量间隔
          }
        ]
      }
    ]
  }
}

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价格
      "bidPrice":"999.34",              //最优买价
      "askPrice":"1000.23",             //最优卖价
      "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

权重: 1

参数:

名称 类型 是否必需 描述 示例
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": [
    {
      "id":"1",             // 交易ID   
      "price": "1000",      // 成交价格
      "qty": "-0.1",        // 成交数量
      "quoteQty": "-100",   // 成交额
      "time": 1592449455993,// 时间
      "side": -1            // 成交方向(-1 卖,1 买)
    }
  ]
}

GET /vapi/v1/trades

权重: 1

参数:

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

查询历史成交

响应:

{
  "code": 0,
  "msg": "success",
  "data": [
    { 
      "id":"159244945532993",     // 唯一ID  
      "tradeId":"1",             // 交易ID
      "price": "1000",            // 成交价格
      "qty": "-0.1",              // 成交数量
      "quoteQty": "-100",         // 成交额
      "time": 1592449455993,      // 时间
      "side": -1                  // 成交方向(-1 卖,1 买)
    }
  ]
}

GET /vapi/v1/historicalTrades

权重: 1

参数:

名称 类型 是否必需 描述 示例
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
postOnly 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
    "lastTrade": {
        "id": 7,                        // 交易id
        "time": 1625457024251,          // 时间
        "price": "300",                 // 价格
        "qty": "-0.01"                  // 数量
    }
  }]
}

POST /vapi/v1/batchOrders (HMAC SHA256)

权重: 1

参数:

名称 类型 是否必需 描述 示例
orders LIST YES 订单列表,最多支持5个订单 [{"symbol":"BTC-210115-35000-C","price":"100","quantity":"0.0002","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, MARKET LIMIT
quantity DECIMAL YES 下单数量 3
price DECIMAL NO 委托价格 1000
timeInForce ENUM NO 有效方法(默认GTC) GTC
reduceOnly BOOLEAN NO 是否仅平仓单(默认false) false
postOnly 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

期权查询成交历史 (USER_DATA)

响应:

{
  "code": 0,
  "msg": "success",
  "data": [
      {
        "id": "4611875134427365376",        // 唯一标识
        "tradeId": "239",                   // 交易ID
        "orderId": "4611875134427365377",   // 订单ID
        "symbol": "BTC-200730-9000-C",      // 期权交易对
        "price": 100,                       // 成交价格
        "quantity": 1,                      // 成交数量
        "fee": 0,                           // 手续费
        "quoteAsset": "USDT",               // 手续费计价资产
        "realizedProfit": 0,                // 已实现盈亏
        "side": "BUY",                      // 买卖方向
        "type": "LIMIT",                    // 订单类型
        "volatility": "GTC",                // 波动率
        "liquidity": "TAKER",               // TAKER或MAKER
        "createDate": 1592465880683         // 时间
      }
  ]
}

GET /vapi/v1/userTrades (HMAC SHA256)

权重: 1

参数:

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

Websocket账户信息推送

Websocket错误信息

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

生成 Listen Key (USER_STREAM)

响应:

{
  "listenKey":"pqia91ma19a5s61cv6a81va65sdf19v8a65a1a5s61cv6a81va65sdf19v8a65a1"
}

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

POST /vapi/v1/userDataStream

权重: 1

参数:

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

延长 Listen Key 有效期 (USER_STREAM)

响应:

{
  "listenKey":"pqia91ma19a5s61cv6a81va65sdf19v8a65a1a5s61cv6a81va65sdf19v8a65a1"
}

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

PUT /vapi/v1/userDataStream

权重: 1

参数:

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

删除 Listen Key (USER_STREAM)

响应:

{}

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

DELETE /vapi/v1/userDataStream

权重: 1

参数:

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

Payload: 账户数据

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

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

持仓变化

响应:

{
    "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: 订单数据

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

订单状态 (s)

响应:

{
    "e":"ORDER_TRADE_UPDATE",               // 事件类型
    "E":1591698525864,                      // 事件时间
    "o":[
        {
            "T":0,                          // 交易时间 
            "oid":1,                        // 订单Id
            "S":symbol,                     // 合约名称
            "cid":"zdy",                    // 用户自定义信息
            "p":"1235",                     // 交易价格
            "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",                    // 手续费
            //成交明细
            "fi":[ {
               "t":1,                     // 交易Id
               "p":"1000",                // 交易价格
               "q":"-2",                  // 交易量
               "m":0,                     // taker 0 maker 1
               "T":1591677567872,         // 成交时间
             }  
            ]
        }
    ]
}

Websocket 行情推送

Payload: 24小时TICKER

Update Speed: 实时

订阅一个信息流

响应:

{
    "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
    "bo":"999.25",                          //最优买价
    "ao":"1000.38",                         //最优卖价
    "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: 最近成交

Update Speed: 实时

响应:

{
    "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线

Update Speed: 实时

响应:

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

Payload: 深度

Update Speed: 实时

响应:

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

深度条数1000 返回增量数据。如何正确在本地维护一个深度副本

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

请求

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

Payload: 新增交易对信息推送

Update Speed: 实时

响应:

{
    "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 //行权时间
}

错误代码

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

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

-1000 UNKNOWN

-1001 DISCONNECTED

-1002 UNAUTHORIZED

-1003 TOO_MANY_REQUESTS

-1004 SERVER_BUSY

-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

11xx - 2xxx 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 BAD_CONTRACT

-1129 BAD_CURRENCY

-1130 INVALID_PARAMETER

-1131 BAD_RECV_WINDOW

-2010 NEW_ORDER_REJECTED

-2011 CANCEL_REJECTED

-2013 NO_SUCH_ORDER

-2014 BAD_API_KEY_FMT

-2015 INVALID_API_KEY

-2018 BALANCE_NOT_SUFFICIENT

-2027 OPTION_MARGIN_NOT_SUFFICIENT

3xxx-5xxx Filters and other issues

-3029 TRANSFER_FAILED

-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

-4013 PRICE_LESS_THAN_MIN_PRICE

-4029 INVALID_TICK_SIZE_PRECISION

-4030 INVALID_QTY_PRECISION

-4055 AMOUNT_MUST_BE_POSITIVE

-5005 BLACK_COUNTRY

-5008 KYC_NOT_PASS