Navbar
简体中文

更新日志

2022-09-20

WEBSOCKET


2022-09-14

REST


2022-09-05

REST


2022-08-22

REST


基本信息

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 /eapi/v1/order 的示例

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

Key Value
apiKey dbefbc809e3e83c283a984c3a1459732ea7db1360ca80c5c2c8867408d28cc83
secretKey 2b5eb11e18796d12d88f13dc27dbbd02c2cc51ff7059765ed9821957d82bb4d9
参数 取值
symbol BTC-210129-40000-C
side BUY
type LIMIT
timeInForce GTC
quantity 1
price 2000
recvWindow 5000
timestamp 1611825601400

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

示例1:

HMAC SHA256 签名:

    $ echo -n "symbol=BTC-210129-40000-C&side=BUY&type=LIMIT&quantity=1&price=2000&timeInForce=GTC&recvWindow=5000&timestamp=1611825601400" | openssl dgst -sha256 -hmac "2b5eb11e18796d12d88f13dc27dbbd02c2cc51ff7059765ed9821957d82bb4d9"
    (stdin)= 3c661234138461fcc7a7d8746c6558c9842d4e10870d2ecbedf7777cad694af9

curl 调用:

    (HMAC SHA256)
    $ curl -H "X-MBX-APIKEY: dbefbc809e3e83c283a984c3a1459732ea7db1360ca80c5c2c8867408d28cc83" -X POST 'https://eapi.binance.com/eapi/v1/order?symbol=BTC-210129-40000-C&side=BUY&type=LIMIT&quantity=1&price=9000&timeInForce=GTC&recvWindow=5000&timestamp=1611825601400&signature= 3c661234138461fcc7a7d8746c6558c9842d4e10870d2ecbedf7777cad694af9'

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

示例2:

HMAC SHA256 签名:

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

curl 调用:

    (HMAC SHA256)
    $ curl -H "X-MBX-APIKEY: dbefbc809e3e83c283a984c3a1459732ea7db1360ca80c5c2c8867408d28cc83" -X POST 'https://eapi.binance.com/eapi/v1/order' -d 'symbol=BTC-210129-40000-C&side=BUY&type=LIMIT&quantity=1&price=9000&timeInForce=GTC&recvWindow=5000&timestamp=1611825601400&signature= 3c661234138461fcc7a7d8746c6558c9842d4e10870d2ecbedf7777cad694af9'

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

示例3:

HMAC SHA256 签名:

    $ echo -n "symbol=BTC-210129-40000-C&side=BUY&type=LIMIT&quantity=1&price=2000&timeInForce=GTC&recvWindow=5000&timestamp=1611825601400" | openssl dgst -sha256 -hmac "2b5eb11e18796d12d88f13dc27dbbd02c2cc51ff7059765ed9821957d82bb4d9"
    (stdin)= 3c661234138461fcc7a7d8746c6558c9842d4e10870d2ecbedf7777cad694af9

curl 调用:

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

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

公开API参数

术语解释

枚举定义

期权方向 (side):

订单方向 (side):

持仓方向:

有效方式 (timeInForce):

响应类型 (newOrderRespType)

订单状态 (order status):

订单种类 (orderTypes, type):

K线间隔:

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

限制种类 (rateLimitType)

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

ORDERS javascript { "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.0100000",
    "maxQty": "1000.00000000",
    "stepSize": "0.00100000"
  }

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

逻辑伪代码如下:

行情接口

测试服务器连通性 PING

GET /eapi/v1/ping

响应:

{}

测试能否联通

权重: 1

参数: NONE

获取服务器时间

响应:

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

GET /eapi/v1/time

获取服务器时间

权重: 1

参数: NONE

获取交易规则和交易对

响应:

{
  "timezone": "UTC",                    // 服务器时区
  "serverTime": 1592387337630,          // 请忽略。如果需要获取当前系统时间,请查询接口 “GET /eapi/v1/time”
  "optionContracts": [                  // 期权合约底层资产信息
    {
      "id": 1,
      "baseAsset": "BTC",               // 标的资产
      "quoteAsset": "USDT",             // 报价资产
      "underlying": "BTCUSDT",          // 期权合约底层资产
      "settleAsset": "USDT"             // 结算资产
    }
  ],
  "optionAssets": [                     // 期权系统支持资产
    {
      "id": 1,
      "name": "USDT"                    // 资产名
    }
  ],
  "optionSymbols": [                    // 期权交易对信息
    {
        "contractId": 2,
        "expiryDate": 1660521600000,    // 到期时间
        "filters": [
            {
                "filterType": "PRICE_FILTER",
                "minPrice": "0.02",
                "maxPrice": "80000.01",
                "tickSize": "0.01"
            },
            {
                "filterType": "LOT_SIZE",
                "minQty": "0.01",
                "maxQty": "100",
                "stepSize": "0.01"
            }
        ],
        "id": 17,
        "symbol": "BTC-220815-50000-C",   // 交易对
        "side": "CALL",                   // 期权方向
        "strikePrice": "50000",           // 行权价
        "underlying": "BTCUSDT",          // 合约底层资产
        "unit": 1,                        // 合约单位, 单一合约代表的底层资产数量 
        "makerFeeRate": "0.0002",         // 被动成交手续费率 
        "takerFeeRate": "0.0002",         // 主动成交手续费率
        "minQty": "0.01",                 // 最小下单数量
        "maxQty": "100",                  // 最大下单数量
        "initialMargin": "0.15",          // 初始保证金率
        "maintenanceMargin": "0.075",     // 维持保证金率
        "minInitialMargin": "0.1",        // 最低初始保证金率
        "minMaintenanceMargin": "0.05",   // 最低维持保证金率
        "priceScale": 2,                  // 价格精度
        "quantityScale": 2,               // 数量精度 
        "quoteAsset": "USDT"              // 报价资产
    },
  ],
  "rateLimits": [
    {
        "rateLimitType": "REQUEST_WEIGHT",
        "interval": "MINUTE",
        "intervalNum": 1,
        "limit": 2400
    },
    {
        "rateLimitType": "ORDERS",
        "interval": "MINUTE",
        "intervalNum": 1,
        "limit": 1200
    },
    {
        "rateLimitType": "ORDERS",
        "interval": "SECOND",
        "intervalNum": 10,
        "limit": 300
    }
  ]
}

GET /eapi/v1/exchangeInfo

获取交易规则和交易对

权重: 1

参数: NONE

深度信息

响应:

{
   "T": 1589436922972,   // 撮合引擎时间
   "bids": [             // 买单
    [
      "1000",            // 价格
      "0.9"              // 数量
    ]
  ],
  "asks": [              // 卖单
    [
      "1100",            // 价格
      "0.1"              // 数量
    ]
  ]
}  

GET /eapi/v1/depth

权重:

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

参数:

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

近期成交

响应:

[
  { 
    "id":"1",             // ID
    "symbol": "BTC-220722-19000-C",
    "price": "1000",      // 成交价格
    "qty": "-0.1",        // 成交量
    "quoteQty": "-100",   // 成交额
    "side": -1            // 主动成交方方向
    "time": 1592449455993,// 时间
  }
]  

GET /eapi/v1/trades

获取近期订单簿成交

权重: 5

参数:

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

查询历史成交(MARKET_DATA)

响应:

[
  {
    "id":"1",             // Id
    "tradeId": "159244329455993",    // 成交ID
    "price": "1000",      // 成交价格
    "qty": "-0.1",        // 成交量
    "quoteQty": "-100",   // 成交额
    "side": -1            // 主动成交方方向
    "time": 1592449455993,// 时间
  }
]

GET /eapi/v1/historicalTrades

查询订单簿历史成交

权重: 20

参数:

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

K线数据

响应:

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

GET /eapi/v1/klines

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

权重: 1

参数:

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

查询期权标记价格

响应:

[
  {
    "symbol": "BTC-200730-9000-C",// 交易对
    "markPrice": "1343.2883",     // 标记价格
    "bidIV": "1.40000077",        // 买一隐含波动率
    "askIV": "1.50000153",        // 卖一隐含波动率
    "markIV": "1.45000000"        // 标记价格隐含波动率
    "delta": "0.55937056",        // delta
    "theta": "3739.82509871",     // theta
    "gamma": "0.00010969",        // gamma
    "vega": "978.58874732",       // vega
    "highPriceLimit": "1618.241", // 买最高限价
    "lowPriceLimit": "1068.3356"  // 卖最低限价
  }
]

GET /eapi/v1/mark

权重: 5

参数:

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

24hr价格变动情况

响应:

[
  {
    "symbol": "BTC-200730-9000-C",
    "priceChange": "-16.2038",        //24小时价格变动
    "priceChangePercent": "-0.0162",  //24小时价格变动百分比
    "lastPrice": "1000",              //最近一次成交价
    "lastQty": "1000",                //最近一次成交额
    "open": "1016.2038",              //24小时内第一次成交的价格
    "high": "1016.2038",              //24小时最高价
    "low": "0",                       //24小时最低价
    "volume": "5",                    //成交额
    "amount": "1",                    //成交量
    "bidPrice":"999.34",              //最优买价
    "askPrice":"1000.23",             //最优卖价
    "openTime": 1592317127349,        //24小时内,第一笔交易的发生时间
    "closeTime": 1592380593516,       //24小时内,最后一笔交易的发生时间
    "firstTradeId": 1,                //首笔成交ID
    "tradeCount": 5,                  //成交笔数
    "strikePrice": "9000",            //行权价
    "exercisePrice": "3000.3356"      //行权前半小时返回预估结算价,其他时刻返回指数价格
  }
]

GET /eapi/v1/ticker

24小时价格变动

权重: 5

参数:

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

标的最新价格

响应:

{
   "time": 1656647305000,
   "indexPrice": "9200" // Current spot index price
}

GET /eapi/v1/index

返回最近指数价格

权重: 1

参数:

名称 类型 是否必需 描述
underlying STRING YES 现货交易对如BTCUSDT

历史行权记录

响应:

[
  { 
    "symbol": "BTC-220121-60000-P",            // 交易对  
    "strikePrice": "60000",                    // 行权价
    "realStrikePrice": "38844.69652571",       // 行权结算价格
    "expiryDate": 1642752000000,               // 行权时间
    "strikeResult": "REALISTIC_VALUE_STRICKEN" // 行权结果
  }
]

GET /eapi/v1/exerciseHistory

REALISTIC_VALUE_STRICKEN 行权 EXTRINSIC_VALUE_EXPIRED 未行权

权重: 3

参数:

名称 类型 是否必需 描述
startTime LONG NO 开始时间
endTime LONG NO 结束时间
limit INT NO 默认值:100 最大值:100.

账户和交易接口

账户信息 (TRADE)

响应:

{
  "asset": [                  
    {
      "asset": "USDT",                  // 资产类型
      "marginBalance": "10099.448",     // 账户余额
      "equity": "10094.44662",          // 账户权益
      "available": "8725.92524",        // 账户可用
      "locked": "1084.52138",           // 保证金锁定
      "unrealizedPNL": "-5.00138",      // 未实现盈亏   
   }
  ], 
  "greek": [
    {
      "underlying":"BTCUSDT"            // 标的资产
      "delta": "-0.05"                  // delta
      "gamma": "-0.002"                 // gamma
      "theta": "-0.05"                  // theta
      "vega": "-0.002"                  // vega  
    }
  ], 
  "time": 1592449455993                 // 时间  
}

GET /eapi/v1/account (HMAC SHA256)

现有账户信息。

权重: 3

参数:

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

资金划转 (TRADE)

响应:

{
  "code": "0",
  "msg": "success", // 请求是否成功发出(需用eapi/v1/bill确认是否到账)
  "data": 4         // 划转id
}

POST /eapi/v1/transfer (HMAC SHA256)

用户账户信息。

权重: 1

参数:

名称 类型 是否必需 描述
currency STRING YES 资产类型, e.g USDT
type ENUM YES IN: 从现货钱包转到期权钱包 OUT: 从期权钱包转到现货钱包
amount DECIMAL YES 数量如100
recvWindow LONG NO
timestamp LONG YES

下单 (TRADE)

响应ACK:


{
  "orderId": 4611875134427365377,     // 订单Id
  "clientOrderId": ""                 // 用户订单Id
  "symbol": "BTC-200730-9000-C",      // 交易对
  "price": "100",                     // 订单价格
  "quantity": "1",                    // 订单数量
  "side": "BUY",                      // 订单方向
  "type": "LIMIT",                    // 订单类型
  "createDate": 1592465880683,        // 订单时间
  "updateTime": 1566818724722,        // 更新时间
}

响应RESULT:

{
  "orderId": 4611875134427365377,     // 订单Id
  "symbol": "BTC-200730-9000-C",      // 交易对
  "price": 100,                       // 订单价格
  "quantity": 1,                      // 订单数量
  "executedQty": 0,                   // 执行数量
  "fee": 0,                           // 手续费 
  "side": "BUY",                      // 订单方向
  "type": "LIMIT",                    // 订单类型
  "timeInForce": "GTC",               // 有效时间
  "reduceOnly": false,                // 仅减仓
  "postOnly": false,                  // 仅做maker
  "createTime": 1592465880683,        // 订单创建时间
  "updateTime": 1566818724722,        // 订单更新时间
  "status": "ACCEPTED",               // 订单状态
  "avgPrice": "0",                    // 平均价格
  "clientOrderId": ""               // 用户自定义订单Id
  "priceScale": 2,                    // 价格精度 
  "quantityScale": 2,                 // 数量精度  
  "optionSide": "CALL",               // 期权类型
  "quoteAsset": "USDT",               // 报价资产
  "mmp": false                        // 是否为MMP单
}

POST /eapi/v1/order (HMAC SHA256)

下单。

参数:

名称 类型 是否必需 描述
symbol STRING YES 交易对
side ENUM YES 买卖方向 SELL, BUY
type ENUM YES 订单类型 LIMIT
quantity DECIMAL YES 下单数量
price DECIMAL NO 委托价格
timeInForce ENUM NO 有效时间
reduceOnly STRING NO 仅减仓true, false
postOnly STRING NO 仅减仓true, false
newOrderRespType ENUM NO "ACK", "RESULT", 默认 "ACK"
clientOrderId STRING NO 用户自定义的订单号,不可以重复出现在挂单中。如空缺系统会自动赋值。
isMmp BOOLEAN NO 是否为MMP订单true/false
recvWindow LONG NO
timestamp LONG YES

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

Type 强制要求的参数
LIMIT timeInForce, quantity, price

批量下单 (TRADE)

响应:

[
    {
        "orderId": 4612288550799409153,  // 订单号
        "symbol": "ETH-220826-1800-C",   // 交易对
        "price": "100",                  // 订单价格
        "quantity": "0.01",              // 订单数量
        "side": "BUY",                   // 订单方向
        "type": "LIMIT",                 // 订单类型
        "reduceOnly": false,             // 仅减仓
        "postOnly": false,               // 仅做maker
        "clientOrderId": "1001",         // 用户订单id
        "mmp": false                     // 做市商保护     
    }
]

POST /eapi/v1/batchOrders (HMAC SHA256)

批量下单。

权重: 5

参数:

名称 类型 是否必需 描述
orders LIST YES 订单列表,最多支持5个订单
recvWindow LONG NO
timestamp LONG YES

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

名称 类型 是否必需 描述
symbol STRING YES 交易对
side ENUM YES 买卖方向 SELL, BUY
type ENUM YES 订单类型 LIMIT
quantity DECIMAL YES 下单数量
price DECIMAL NO 委托价格
timeInForce ENUM NO 有效时间
reduceOnly STRING NO 仅减仓true, false
postOnly STRING NO 仅减仓true, false
newOrderRespType ENUM NO "ACK", "RESULT", 默认 "ACK"
clientOrderId STRING NO 用户自定义的订单号,不可以重复出现在挂单中。如空缺系统会自动赋值。必须满足正则规则 ^[\.A-Z\:/a-z0-9_-]{1,36}$
isMmp BOOLEAN NO 是否为MMP订单true/false

撤销订单 (TRADE)

响应:

{
  "orderId": 4611875134427365377,     // 订单Id
  "symbol": "BTC-200730-9000-C",      // 交易对
  "price": "100",                     // 订单价格
  "quantity": "1",                    // 订单数量
  "executedQty": "0",                 // 已经成交数量
  "fee": "0",                         // 手续费
  "side": "BUY",                      // 订单方向
  "type": "LIMIT",                    // 订单类型
  "timeInForce": "GTC",               // 有效时间
  "reduceOnly": false,                // 仅减仓
  "postOnly": false,                  // 仅做maker
  "createDate": 1592465880683,        // 订单创建时间
  "updateTime": 1566818724722,        // 订单更新时间
  "status": "ACCEPTED",               // 订单状态
  "avgPrice": "0",                    // 平均成交价
  "source": "API",                    // 订单来源
  "clientOrderId": "",                // 用户自定义的订单号
  "priceScale": 4,                    // 价格精度
  "quantityScale": 4,                 // 数量精度
  "optionSide": "CALL",               // 期权类型
  "quoteAsset": "USDT",               // 报价资产
  "mmp": false                        // 是否为MMP单
}

DELETE /eapi/v1/order (HMAC SHA256)

撤销订单。

权重: 1

Parameters:

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

orderIdorigClientOrderId 必须至少发送一个

批量撤销订单 (TRADE)

响应:

[
  {
    "orderId": 4611875134427365377,     // 订单Id
    "symbol": "BTC-200730-9000-C",      // 交易对
    "price": "100",                     // 订单价格
    "quantity": "1",                    // 订单数量
    "executedQty": "0",                 // 已经成交数量
    "fee": "0",                         // 手续费 
    "side": "BUY",                      // 订单方向
    "type": "LIMIT",                    // 订单类型
    "timeInForce": "GTC",               // 有效时间
    "createTime": 1592465880683,        // 订单创建时间
    "status": "ACCEPTED",               // 订单类型
    "avgPrice": "0",                    // 平均成交价
    "reduceOnly": false,                // 仅减仓
    "clientOrderId": ""                 // 用户自定义的订单号
    "updateTime": 1566818724722,        // 订单更新时间
  }
]

DELETE /eapi/v1/batchOrders (HMAC SHA256)

批量撤销订单。

权重: 1

Parameters:

名称 类型 是否必需 描述
symbol STRING YES 交易对
orderIds LIST<LONG> NO 系统订单号
比如 [4611875134427365377,4611875134427365378]
clientOrderIds LIST<STRING> NO 用户自定义的订单号
比如["my_id_1","my_id_2"] 需要encode双引号。逗号后面没有空格。
recvWindow LONG NO
timestamp LONG YES

orderIdsclientOrderIds 必须至少发送一个,不可同时发送

撤销单交易对全部订单 (TRADE)

响应:

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

DELETE /eapi/v1/allOpenOrders (HMAC SHA256)

取消一个交易对上所有订单。

权重: 1

Parameters:

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

撤销特定标的全部订单 (TRADE)

响应:

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

DELETE /eapi/v1/allOpenOrdersByUnderlying (HMAC SHA256)

取消特定标的上所有订单。

权重: 1

Parameters:

名称 类型 是否必需 描述
underlying STRING YES 标的资产如BTCUSDT
recvWindow LONG NO
timestamp LONG YES

查询当前挂单 (USER_DATA)

响应:

[
  {
    "orderId": 4611875134427365377,     // 订单Id
    "symbol": "BTC-200730-9000-C",      // 交易对
    "price": "100",                     // 订单价格
    "quantity": "1",                    // 订单数量
    "executedQty": "0",                 // 已经成交的交易量
    "fee": "0",                         // 手续费 
    "side": "BUY",                      // 订单方向
    "type": "LIMIT",                    // 订单类型
    "timeInForce": "GTC",               // 有效时间
    "reduceOnly": false,                // 仅减仓
    "postOnly": false,                  // 仅做maker
    "createTime": 1592465880683,        // 订单创建时间
    "updateTime": 1592465880683,        // 订单更新时间
    "status": "ACCEPTED",               // 订单状态
    "avgPrice": "0",                    // 已成交平均价
    "clientOrderId": ""                 // 用户自定义订单id       
    "priceScale": 2,                    // 价格精度  
    "quantityScale": 2,                 // 数量精度
    "optionSide": "CALL",               // 期权类型
    "quoteAsset": "USDT",               // 报价资产
    "mmp": false                        // 是否为MMP订单
  }
]

GET /eapi/v1/openOrders (HMAC SHA256)

查询当前挂单(包含状态为ACCEPTED/ PARTIALLY_FILLED的订单)

权重: 带symbol 1,不带40

参数:

名称 类型 是否必需 描述
symbol STRING NO 交易对(不传返回所有订单)
orderId LONG NO 只返回此orderID及之后的订单,缺省返回最近的订单
startTime LONG NO 开始时间
endTime LONG NO 结束时间
limit INT NO 返回数量,默认100 最大1000
recvWindow LONG NO
timestamp LONG YES

查询历史订单 (USER_DATA)

响应:

[
  {
    "orderId": 4611875134427365377,     // 订单Id
    "symbol": "BTC-200730-9000-C",      // 交易对
    "price": 100,                       // 订单价格
    "quantity": 1,                      // 订单数量
    "executedQty": 0,                   // 已经成交的交易量
    "fee": 0,                           // 手续费 
    "side": "BUY",                      // 订单方向
    "type": "LIMIT",                    // 订单类型
    "timeInForce": "GTC",               // 有效时间
    "reduceOnly": false,                // 仅减仓
    "postOnly": false,                  // 仅做maker
    "createTime": 1592465880683,        // 订单创建时间
    "updateTime": 1592465880683,        // 订单更新时间
    "status": "ACCEPTED",               // 订单状态
    "avgPrice": "0",                    // 已成交平均价
    "source": "API",                    // 订单来源
    "clientOrderId": ""                 // 用户自定义订单id       
    "priceScale": 2,                    // 价格精度  
    "quantityScale": 2,                 // 数量精度
    "optionSide": "CALL",               // 期权类型
    "quoteAsset": "USDT",               // 报价资产
    "mmp": false                        // 是否为MMP订单
  }
]

GET /eapi/v1/historyOrders (HMAC SHA256)

查询5天内的历史订单,订单的最终状态为 CANCELED 或者 FILLED 或者 REJECTED

权重: 3

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

仓位信息 (USER_DATA)

Response:

[
  {
    "entryPrice": "1000",             // 开仓均价
    "symbol": "BTC-200730-9000-C",    // 交易对
    "side": "SHORT",                  // 仓位方向
    "quantity": "-0.1",               // 仓位数量
    "reducibleQty": "0",              // 可减仓数量
    "markValue": "105.00138",         // 期权价值
    "ror": "-0.05",                   // 收益率
    "unrealizedPNL": "-5.00138",      // 未实现盈亏
    "markPrice": "1050.0138",         // 期权标记价格
    "strikePrice": "9000",            // 行权价
    "expiryDate": 1593511200000       // 行权时间
    "positionCost": "1000.0000",      // 仓位成本
    "priceScale": 2,                  // 价格精度 
    "quantityScale": 2,               // 数量精度
    "optionSide": "CALL",             // 期权方向
    "quoteAsset": "USDT"              // 报价资产
   }
]

GET /eapi/v1/position (HMAC SHA256)

获取仓位信息。

Weight: 5

Parameters:

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

账户成交历史 (USER_DATA)

响应:

[
  {
    "id": 4611875134427365377,          // id
    "tradeId": 239,                     // 交易id
    "orderId": 4611875134427365377,     // 订单id
    "symbol": "BTC-200730-9000-C",      // 交易对
    "price": "100",                     // 成交价
    "quantity": "1",                    // 成交量
    "fee": "0",                         // 手续费
    "realizedProfit": "0.00000000",     // 已实现盈亏
    "side": "BUY",                      // 订单方向
    "type": "LIMIT",                    // 订单类型 
    "volatility": "0.9",                // 隐含波动率
    "liquidity": "TAKER",               // TAKER or MAKER      
    "quoteAsset": "USDT",               // 报价资产
    "time": 1592465880683               // 交易时间
    "priceScale": 2,                    // 价格精度
    "quantityScale": 2,                 // 数量精度 
    "optionSide": "CALL",               // 期权种类
    "quoteAsset": "USDT"                // 报价资产
  } 
]

GET /eapi/v1/userTrades (HMAC SHA256)

获取某交易对的成交历史

权重: 5

参数:

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

用户行权历史(USER_DATA)

Response:

[
    {
        "id": "1125899906842624042",        
        "currency": "USDT",                  // 结算资产
        "symbol": "BTC-220721-25000-C",      // 交易对
        "exercisePrice": "25000.00000000",   // 行权价
        "markPrice": "25000.00000000",       // 结算标记价格
        "quantity": "1.00000000",            // 数量
        "amount": "0.00000000",              // 金额
        "fee": "0.00000000",                 // 手续费
        "createDate": 1658361600000,         // 行权时间
        "priceScale": 2,                     // 价格精度
        "quantityScale": 2,                  // 数量精度
        "optionSide": "CALL",                // 期权种类
        "positionSide": "LONG",              // 仓位方向
        "quoteAsset": "USDT"                 // 报价资产
    }
] 

GET /eapi/v1/exerciseRecord (HMAC SHA256)

获取用户行权历史.

Weight: 5

Parameters:

Name Type Mandatory Description
symbol STRING NO 交易对如 BTC-200730-9000-C
startTime LONG NO 起始时间如1593511200000
endTime LONG NO 结束时间如1593512200000
limit INT NO 默认1000, 最大1000
recvWindow LONG NO
timestamp LONG YES

获取账户资金流水(USER_DATA)

响应:

[
  {
    "id": 1125899906842624000,
    "asset": "USDT",              // 资产类型
    "amount": "-0.552",           // 数量 (正数为流入,负数为流出)
    "type": "FEE",                // 类型 (手续费)
    "createDate": 1592449456000,  // 时间
  },
  {
    "id": 1125899906842624000,
    "asset": "USDT",              // 资产类型
    "amount": "100",              // 数量 (正数为流入,负数为流出)
    "type": "CONTRACT",           // 类型(买卖合约)
    "createDate": 1592449456000,  // 时间
  },
  {
    "id": 1125899906842624000,
    "asset": "USDT",              // 资产类型
    "amount": "10000",            // 数量 (正数为流入,负数为流出)
    "type": "TRANSFER",           // 类型(资金划转)
    "createDate": 1592448410000,  // 时间
  }
]

GET /eapi/v1/bill (HMAC SHA256)

权重: 1

参数:

名称 类型 是否必需 描述
currency STRING YES 资产类型如USDT
recordId LONG NO 返回该recordId及之后的成交,缺省返回最近的成交
startTime LONG NO 起始时间如1593511200000
endTime LONG NO 结束时间如1593512200000
limit INT NO 默认100 最大1000
recvWindow LONG NO
timestamp LONG YES

Websocket 行情推送

实时订阅/取消数据流

订阅一个信息流

响应

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

取消订阅一个信息流

响应

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

{
"method": "UNSUBSCRIBE",
"params":
[
"BTC-210630-9000-P@ticker"
],
"id": 312
}

已订阅信息流

响应

  {
    "result": [
      "BTC-210630-9000-P@ticker"
    ],
    "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_PROPERTYGET_PROPERTY中应用的参数无效
{"code": 1, "msg": "Invalid value type: expected Boolean"} 仅接受truefalse
{"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 语法有误.

最新交易

Payload:


{
    "e":"trade",                  // 事件类型  
    "E":1591677941092,            // 事件时间   
    "s":"BTC-200630-9000-P",      // 交易对  
    "t":1,                        // 交易ID   
    "p":"1000",                   // 交易价格   
    "q":"-2",                     // 交易数量   
    "b":4611781675939004417,      // 买单ID   
    "a":4611781675939004418,      // 卖单ID   
    "T":1591677567872,            // 交易时间  
    "S":"-1"                      // 方向   
}

交易流推出最新成交信息。

Stream Name:
<symbol>@trade

Update Speed: 50ms

指数价格

** Payload: **

{
    "e":"index",         // 事件类型
    "E":1661415480351,   // 事件时间
    "s":"ETHUSDT",       // 标的资产
    "p":"1707.89008607"  // 指数价格
}

标的资产指数价格(如ETHUSDT).

Stream Name:
<symbol>@index

Update Speed: 1000ms

标记价格

** Payload: **

[
    {
      "e":"markPrice",         // 事件类型
      "E":1663684594227,       // 事件时间
      "s":"ETH-220930-1500-C", // 交易对
      "mp":"30.3"              // 指数价格
    },
    {
      "e":"markPrice",
      "E":1663684594228,
      "s":"ETH-220923-1000-C",
      "mp":"341.5"
    }

单一标的的所有期权交易对标记价格。如ETH@markPrice

Stream Name:
<underlyingAsset>@markPrice

Update Speed: 1000ms

K线

Payload:

{
    "e":"kline",                        // 事件类型
    "E":1638747660000,                  // 事件时间
    "s":"BTC-200630-9000-P",            // 交易对  
    "k":{                             
        "t":1638747660000,              // 这根K线的起始时间
        "T":1638747719999,              // 这根K线的结束时间
        "s":"BTC-200630-9000-P",        // 交易对  
        "i":"1m",                       // K线间隔
        "F":0,                          // 这根K线期间第一笔成交ID
        "L":0,                          // 这根K线期间末一笔成交ID
        "o":"1000",                     // 这根K线期间第一笔成交价   
        "c":"1000",                     // 这根K线期间末一笔成交价   
        "h":"1000",                     // 这根K线期间最高成交价    
        "l":"1000",                     // 这根K线期间最低成交价   
        "v":"0",                        // 这根K线期间成交量   
        "n":0,                          // 这根K线期间成交笔数
        "x":false,                      // 这根K线是否完结(是否已经开始下一根K线)
        "q":"0",                        // 这根K线期间成交额
        "V":"0",                        // 主动买入的成交额
        "Q":"0"                         // 主动买入的成交量
    }
}

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

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

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

Stream Name:
<symbol>@kline_<interval>

Update Speed: 1000ms

按交易对的Ticker

Payload:

{  
  "e":"24hrTicker",           // 事件类型
  "E":1657706425200,          // 事件时间
  "s":"BTC-220930-18000-C",   // 交易对   
  "o":"2000",                 // 24小时前开始第一笔成交价格
  "h":"2020",                 // 24小时内最高成交价
  "l":"2000",                 // 24小时内最低成交价
  "c":"2020",                 // 最新成交价格
  "V":"1.42",                 // 交易量
  "A":"2841",                 // 交易额
  "P":"0.01",                 // 价格变动
  "p":"20",                   // 价格变动比例
  "Q":"0.01",                 // 最近交易成交额
  "F":"27",                   // 第一笔交易id
  "L":"48",                   // 最后一笔交易id
  "n":22,                     // 交易笔数
  "bo":"2012",                // 买一价
  "ao":"2020",                // 卖一价
  "bq":"4.9",                 // 买一数量
  "aq":"0.03",                // 卖一数量
  "b":"0.1202",               // 买一隐含波动率
  "a":"0.1318",               // 卖一隐含波动率
  "d":"0.98911",              // delta
  "t":"-0.16961",             // theta 
  "g":"0.00004",              // gamma  
  "v":"2.66584",              // vega
  "vo":"0.10001",             // 隐含波动率
  "mp":"2003.5102",           // 标记价格
  "hl":"2023.511",            // 买最高限价
  "ll":"1983.511",            // 卖最低限价
  "eep":"0"                   // 结算前半小时返回预估结算价
} 

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

Stream Name:
`<symbol>@ticker

Update Speed: 1000ms

按标的资产和到期日的Ticker

Payload:

[
    {  
      "e":"24hrTicker",           // 事件类型
      "E":1657706425200,          // 事件时间
      "s":"ETH-220930-1600-C",    // 交易对   
      "o":"2000",                 // 24小时前开始第一笔成交价格
      "h":"2020",                 // 24小时内最高成交价
      "l":"2000",                 // 24小时内最低成交价
      "c":"2020",                 // 最新成交价格
      "V":"1.42",                 // 交易量
      "A":"2841",                 // 交易额
      "P":"0.01",                 // 价格变动
      "p":"20",                   // 价格变动比例
      "Q":"0.01",                 // 最近交易成交额
      "F":"27",                   // 第一笔交易id
      "L":"48",                   // 最后一笔交易id
      "n":22,                     // 交易笔数
      "bo":"2012",                // 买一价
      "ao":"2020",                // 卖一价
      "bq":"4.9",                 // 买一数量
      "aq":"0.03",                // 卖一数量
      "b":"0.1202",               // 买一隐含波动率
      "a":"0.1318",               // 卖一隐含波动率
      "d":"0.98911",              // delta
      "t":"-0.16961",             // theta 
      "g":"0.00004",              // gamma  
      "v":"2.66584",              // vega
      "vo":"0.10001",             // 隐含波动率
      "mp":"2003.5102",           // 标记价格
      "hl":"2023.511",            // 买最高限价
      "ll":"1983.511",            // 卖最低限价
      "eep":"0"                   // 结算前半小时返回预估结算价
    },
    {
      "e":"24hrTicker",
      "E":1663685112123,
      "s":"ETH-220930-1500-C",
      "o":"34.9",
      "h":"44.6",
      "l":"26.8",
      "c":"26.8",
      "V":"11.84",
      "A":"444.37",
      "P":"-0.232",
      "p":"-8.1",
      "Q":"0",
      "F":"91",
      "L":"129",
      "n":39,
      "bo":"26.8",
      "ao":"33.9",
      "bq":"0.65",
      "aq":"0.01",
      "b":"0.88790536",
      "a":"0.98729014",
      "d":"0.2621153",
      "t":"-3.44806807",
      "g":"0.00158298",
      "v":"0.7148147",
      "vo":"0.93759775",
      "mp":"30.3",
      "hl":"228.7",
      "ll":"0.1",
      "eep":"0"
    } 
]    

按期权标的资产和到期日的Ticker。E.g.ETH@ticker@220930

Stream Name:
`<underlyingAsset>@ticker@<expirationDate>

Update Speed: 1000ms

全市场Ticker

Payload:

[
  {
      "e":"24hrMiniTicker",        // 事件类型
      "E":1591677962357,           // 事件时间
      "s":"BTC-200630-9000-P",     // 交易对
      "p":"0",                     // 价格变动
      "P":"0",                     // 价格变动比例
      "c":"1000",                  // 最新成交价格
      "Q":"2000",                  // 最近交易成交额
      "o":"1000",                  // 24小时前开始第一笔成交价格
      "h":"1000",                  // 24小时内最高成交价
      "l":"1000",                  // 24小时内最低成交价
      "V":"2",                     // 交易量
      "A":"0",                     // 交易额
      "mp":"3452.79",              // 标记价格  
      "eep":"0"                    // 结算前半小时返回预估结算价
      "b":"0.40",                  // 买一隐含波动率
      "a":"0.43",                  // 卖一隐含波动率
      "vo":"0.80443",              // 隐含波动率
      "d":"0.5",                   // delta   
      "t":"0.02",                  // theta   
      "g":"0.002",                 // gamma   
      "v":"0.001",                 // vega    
      "hl":"4100.53",              // 买最高限价  
      "ll":"2805.05",              // 卖最低限价
      "bo":"999.25",               // 买一价格
      "ao":"1000.38",              // 卖一价格
      "bq":"11",                   // 买一数量
      "aq":"10",                   // 卖一数量 
  }
]

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

Stream Name:
!miniTicker@arr

Update Speed: 1000ms

新增交易对信息推送

Payload:

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

新增交易对推送。

Stream Name:
option_pair

Update Speed: 50ms

有限档深度信息

Payload:

{
    "e":"depth",                    // 时间类型
    "T":1591695934010,              // 撮合时间
    "s":"BTC-200630-9000-P",        // 交易对
    "b":[                           // 买单
      [
          "200",                    // Price
          "3",                      // quantity
      ],
      [
          "101",
          "1"
      ],
      [
          "100",
          "2"
      ]
    ],
    "a":[                           // 卖单  
        [
            "1000",
            "89"
        ]
    ]
}

推送有限档深度信息。levels表示几档买卖单信息, 可选10/20/50/100/1000档 当levels设置为10/20/50/100时,返回有限档全量深度信息 当levels设置为1000时,返回增量深度增量

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

Update Speed: 100ms 或 250ms 或 500ms

Websocket 账户信息推送

生成listenKey (USER_STREAM)

响应:

{
  "listenKey": "pqia91ma19a5s61cv6a81va65sdf19v8a65a1a5s61cv6a81va65sdf19v8a65a1"
}

POST /eapi/v1/listenKey

创建一个新的user data stream,返回值为一个listenKey,即websocket订阅的stream名称。如果该帐户具有有效的listenKey,则将返回该listenKey并将其有效期延长60分钟。

权重: 1

参数: None

延长listenKey有效期 (USER_STREAM)

响应:

{}

PUT /eapi/v1/listenKey

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

权重: 1

参数: None

关闭listenKey (USER_STREAM)

响应:

{}

DELETE /eapi/v1/listenKey

关闭某账户数据流

权重: 1

参数: None

Account数据更新推送

Payload:

 {
    "e":"ACCOUNT_UPDATE",                 // 事件类型
    "E":1591696384141,                    // 事件时间
    "B":[
        {
          "b":"100007992.26053177",       // 账户余额
          "m":"0",                        // 仓位价值 
          "u":"458.782655111111",         // 未实现盈亏  
          "U":200,                        // 多仓未实现盈利
          "M":"-15452.328456",            // 维持保证金
          "i":"-18852.328456",            // 初始保证金
          "a":"USDT",                     // 保证金资产  
        }
    ],
    "G":[
        {
         "ui":"SOLUSDT",                  // 标的资产 
         "d":-33.2933905,                 // Delta  
         "t":35.5926375,                  // Theta 
         "g":-14.3023855,                 // Gamma 
         "v":-0.1929375                   // Vega    
        }
    ],
    "P":[
      {
       "s":"SOL-220912-35-C",             // 交易对   
       "c":"-50",                         // 仓位数量   
       "r":"-50",                         // 可减数量  
       "p":"-100",                        // 仓位价值
       "a":"2.2",                         // 仓位均价   
      }
    ],
    "uid":1000006559949
}  

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

Update Speed: 50ms

订单/交易 更新推送

Payload:

{
  "e":"ORDER_TRADE_UPDATE",           // 事件类型
  "E":1657613775883,                  // 事件时间
  "o":[
    {
      "T":1657613342918,              // 订单创建时间
      "t":1657613342918,              // 订单更新时间
      "s":"BTC-220930-18000-C",       // 交易对
      "c":"",                         // 用户订单id
      "oid":"4611869636869226548",    // 订单id
      "p":"1993",                     // 订单价格
      "q":"1",                        // 订单数量
      "stp":0,                        // 忽略
      "r":false,                      // 只减仓
      "po":true,                      // 仅做maker
      "S":"PARTIALLY_FILLED",         // 订单状态
      "e":"0.1",                      // 交易量     
      "ec":"199.3",                   // 交易额
      "f":"2",                        // 手续费 
      "tif": "GTC",                   // 有效时间
      "oty":"LIMIT",                  // 订单类型 目前仅limit
      "fi":[
        {
          "t":"20",                   // 交易id
          "p":"1993",                 // 交易价格
          "q":"0.1",                  // 交易数量
          "T":1657613774336,          // 交易时间
          "m":"MAKER"                 // 是否为主动交易
        }
      ]
    }
  ]
}

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

Update Speed: 50ms

做市商接口

做市商保护(Market Maker Protection) 是一种为期权做市商设计的保护机制,该机制能够防止做市商的订单在短时间大量成交。一旦某个账户在短时间内的总交易额超过了配置的限额,该账户的做市商保护将被触发。当做市商保护被触发时,账户现有的做市商保护订单(被标记为做市商保护的订单)将被撮合自动取消,而该账户新的做市商保护订单将在冻结期被拒绝。用户可以利用这段时间重新评估行情并修改报价。

保证金账户信息

Response:

 {
  "asset": [                  
    {
      "asset": "USDT",                    // 资产
      "marginBalance": "10099.448"        // 账户余额
      "equity": "10094.44662",            // 账户权益
      "available": "8725.92524",          // 账户可用
      "initialMargin": "1084.52138",      // 初始保证金
      "maintMargin": "151.00138",         // 维持保证金
      "unrealizedPNL": "-5.00138",        // 未实现盈亏
      "lpProfit": "-5.00138",             // 多仓未实现盈利
     }
  ], 
  "greek": [
    {
      "underlying":"BTCUSDT"              // 标的资产
      "delta": "-0.05"                    // delta
      "gamma": "-0.002"                   // gamma
      "theta": "-0.05"                    // theta
      "vega": "-0.002"                    // vega  
    }
  ],
  "time": 1592449455993                   // 时间  
}  

GET /eapi/v1/marginAccount (HMAC SHA256)

获取保证金账户信息

权重: 3

Parameters:

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

设置MMP规则

Response:

{
    "underlyingId": 2,
    "underlying": "BTCUSDT",
    "windowTimeInMilliseconds": 3000,
    "frozenTimeInMilliseconds": 300000,
    "qtyLimit": "2",
    "deltaLimit": "2.3",
    "lastTriggerTime": 0

}

POST /eapi/v1/mmpSet (HMAC SHA256)

设置MMP参数

权重: 1

Parameters:

名称 类型 是否必需 描述
underlying STRING YES 标的资产如BTCUSDT
windowTimeInMilliseconds LONG YES MMP监控时间窗口(毫秒),在(0,5000]之间
frozenTimeInMilliseconds LONG NO MMP冻结时间(毫秒),设置为0后代表账号为冻结状态,需要手动重置
qtyLimit LONG NO 数量限制
deltaLimit INT NO 净delta限制
recvWindow LONG NO
timestamp LONG NO

获取MMP规则

Response:

{
    "underlyingId": 2,
    "underlying": "BTCUSDT",
    "windowTimeInMilliseconds": 3000,
    "frozenTimeInMilliseconds": 300000,
    "qtyLimit": "2",
    "deltaLimit": "2.3",
    "lastTriggerTime": 0

}

GET /eapi/v1/mmpSet (HMAC SHA256)

获取MMP参数

权重: 1

Parameters:

名称 类型 是否必需 描述
underlying STRING YES 标的资产如BTCUSDT
recvWindow LONG NO
timestamp LONG NO

重置MMP状态

Response:

{
    "underlyingId": 2,
    "underlying": "BTCUSDT",
    "windowTimeInMilliseconds": 3000,
    "frozenTimeInMilliseconds": 300000,
    "qtyLimit": "2",
    "deltaLimit": "2.3",
    "lastTriggerTime": 0

}

POST /eapi/v1/mmpReset (HMAC SHA256)

MMP冻结后重置MMP,重新开启MMP下单

Parameters:

名称 类型 是否必需 描述
underlying STRING YES 标的资产如BTCUSDT
recvWindow LONG NO
timestamp LONG NO

错误代码

error JSON payload:

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

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

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

-1000 UNKNOWN

-1001 DISCONNECTED

-1002 UNAUTHORIZED

-1008 TOO_MANY_REQUESTS

-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

-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

-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

-5009 IP_COUNTRY_BLACK

-5010 NOT_ENOUGH_POSITION