Contract API CN

Broker API URL
Broker Open API的地址请见这里​
Broker 合约公共端点
brokerInfo
获取当前broker的交易规则和合约symbol的信息（精度单位等信息），包括合约的风险限额和乘数等信息。
Request Weight:
0
Request Url:
GET /openapi/v1/brokerInfo
Parameters：
名称
类型
是否强制
默认
描述
type
string
NO
​
交易类型，支持的类型现为token（币币）、options（期权）、contracts（合约）。如果没有发送此参数，所有交易类型的symbol信息都会被返回。
Response:
名称
类型
例子
描述
timezone
string
UTC
时间戳的时区。
serverTime
long
1554887652929
返回现在的服务器时间戳（毫秒级）
在rateLimits信息组里: 下单api的请求限制将会被展示。
名称
类型
例子
描述
rateLimitType
string
ORDERS
速度限制类型
interval
string
SECOND
速度限制区间
limit
string
1500
速度限制区间价值
在contracts信息组里: 所有当前券商正在交易的合约的信息将会被返回：
名称
类型
例子
描述
symbol
string
BTC-PERP-REV
合约名称
status
string
TRADING
合约状态
baseAsset
string
BTC-PERP-REV
基础资产。对于合约来说，合约本身就是基础资产。
baseAssetPrecision
float
0.001
基础资产（合约数量）的精度
quoteAsset
string
USDT
定价资产。对于合约来说，这个是合约是以什么来结算的。
quoteAssetPrecision
float
0.001
定价资产（合约价格）的精度。
inverse
bool
true
合约是否为反向合约（true=是反向合约，false=是正向合约）。
index
string
BTCUSDT
标的指数的名称。标的指数实时价格可在index端点访问得到。比如BTC-PERP-REV使用BTCUSDT为标的指数，那么可以在index端点寻找BTCUSDT的实时价格。
contractMultiplier
string
true
合约的乘数。
icebergAllowed
string
false
是否支持冰山订单。
在 contracts的filters信息组里:
名称
类型
例子
描述
filterType
string
PRICE_FILTER
过滤器类型。
minPrice
float
0.001
允许的最小价格。
maxPrice
float
100000.00000000
允许的最大价格。
tickSize
float
0.001
合约价格的精度。
minQty
float
0.01
允许的最小数量。
maxQty
float
100000.00000000
允许的最大数量。
stepSize
float
0.001
合约数量的精度。
minNotional
float
1
最小交易额限制(数量 * 价格)
在riskLimits信息组里:
名称
类型
例子
描述
quantity
float
100
仓位小于此数且大于前一个档位的quantity的需要参照以下要求。
initialMargin
float
0.1
初始保证金率。
maintMargin
float
0.03
最小维持保证金率。
Example:
{
  "timezone":"UTC",
  "serverTime":"1570701444309",
  "brokerFilters":[],
  "rateLimits":[
    {
      "rateLimitType":"ORDERS",
      "interval":"SECOND",
      "limit":20
    },
    {"rateLimitType":"ORDERS",
    "interval":"DAY",
    "limit":350000
  },{
    "rateLimitType":"REQUEST_WEIGHT",
    "interval":"MINUTE",
    "limit":1500
  }],
  "contracts":[
    {
      "filters":[
        {"minPrice":"0.01",
        "maxPrice":"100000.00000000",
        "tickSize":"0.01",
        "filterType":"PRICE_FILTER"
      },
      {
        "minQty":"1",
        "maxQty":"100000.00000000",
        "stepSize":"1",
        "filterType":"LOT_SIZE"
      },{
        "minNotional":"0.000001",
        "filterType":"MIN_NOTIONAL"
      }],
      "exchangeId":"301",
      "symbol":"BTC-PERP-REV",
      "symbolName":"BTC-PERP-REV",
      "status":"TRADING",
      "baseAsset":"BTC-PERP-REV",
      "baseAssetPrecision":"1",
      "quoteAsset":"USDT",
      "quoteAssetPrecision":"0.01",
      "icebergAllowed":false,
      "inverse":true,
      "index":"BTCUSDT",
      "marginToken":"TBTC",
      "marginPrecision":"0.00000001",
      "contractMultiplier":"1.0",
      "riskLimits":[
        {
          "riskLimitId":"200000001",
          "quantity":"1000000.0",
          "initialMargin":"0.01",
          "maintMargin":"0.005"
        },
        {
          "riskLimitId":"200000002",
          "quantity":"2000000.0",
          "initialMargin":"0.02",
          "maintMargin":"0.01"
        },
        {
          "riskLimitId":"200000003",
          "quantity":"3000000.0",
          "initialMargin":"0.03",
          "maintMargin":"0.015"
        },
        {
          "riskLimitId":"200000004",
          "quantity":"4000000.0",
          "initialMargin":"0.04",
          "maintMargin":"0.02"
        }
      ]
    }
  ]
}
index
标的指数价格
Request Weight:
0
Request Url:
GET /openapi/quote/v1/contract/index
Parameters：
名称
类型
是否强制
默认
描述
symbol
string
NO
​
标的指数名称。如果这个没有发送，所有标的指数的价格都会被返回。
Response:
名称
类型
例子
描述
index
float
8342.73
标的指数的价格。
EDP
float
8432.32
标的指数的EDP(预估交割价，过去10分钟指数价格的平均值）。
Example:
{
  "index":{
    "BTCUSDT":"8243.21666667",
    "OKBUSDT":"1.482",
    "BNBUSDT":"31.2658",
    "HTUSDT":"3.1209",...
    },
  "edp":{
    "BTCUSDT":"8258.98505556",
    "OKBUSDT":"1.48578333",
    "BNBUSDT":"31.48741917",
    "HTUSDT":"3.14308",...
  }
}
fundingRate
获取当前资金费率 (历史资金费率正在建设)
Request Weight:
0
Request Url:
GET /openapi/contract/v1/fundingRate
Parameters：
名称
类型
是否强制
默认
描述
symbol
string
NO
​
合约名称。如果没有发送该参数，所有合约的资金费率都会被返回。
state
string
NO
current
获取current（当前）或者past（历史）的资金费率。
from
long
NO
​
开始时间戳。
to
long
NO
​
结束时间戳。
limit
integer
NO
20
返回条数。
Response:
名称
类型
例子
描述
symbol
string
BTC-PERP-REV
合约名称。
intervalStart
long
1554710400000
本次结算开始时间。
intervalEnd
long
1554710400000
本次结算结束时间。
rate
float
0.00321
该次结算资金费率。
Example:
[
  {
    'symbol': 'BTC-PERP-REV',
    'intervalStart': '1570708800000',
    'intervalEnd': '1570737600000',
  },...
]
depth
获取当前订单簿的数据。
Request Weight:
根据数量会不一样，请求数量越多，重量越大:
数量
请求重量
5, 10, 20, 50, 100
1
500
5
1000
10
Request Url:
GET /openapi/quote/v1/contract/depth
Parameters:
名称
类型
是否强制
默认
描述
symbol
string
YES
​
用来获取订单簿的合约名称。
limit
integer
NO
100 (max = 100)
返回bids和asks的数量
Response:
名称
类型
例子
描述
time
long
1550829103981
当前时间（Unix Timestamp，毫秒ms）
bids
list
(如下)
所有bid的价格和数量信息，最优bid价格由上到下排列。
asks
list
(如下)
所有ask的价格和数量信息，最优ask价格由上到下排列。
bids和asks所对应的信息组代表了订单簿的所有价格以及价格对应数量的信息，由最优价格从上到下排列。
名称
类型
例子
描述
''
float
123.10
价格
''
float
300
当前价格对应的数量
Example:
{
  "time": 1555049455783,
  "bids": [
   ["78.82", "0.526"],//[价格, 数量]
   ["77.24", "1.22"],
   ["76.65", "1.043"],
   ["76.58", "1.34"],
   ["75.67", "1.52"],
   ["75.12", "0.635"],
   ["75.02", "0.72"],
   ["75.01", "0.672"],
   ["73.73", "1.282"],
   ["73.58", "1.116"],
   ["73.45", "0.471"],
   ["73.44", "0.483"],
   ["72.32", "0.383"],
   ["72.26", "1.283"],
   ["72.11", "0.703"],
   ["70.61", "0.454"]],
   "asks": [
     ["122.96", "0.381"],//[价格, 数量]
     ["144.46", "1"],
     ["155.55", "0.065"],
     ["160.16", "0.052"],
     ["200", "0.775"],
     ["249", "0.17"],
     ["250", "1"],
     ["300", "1"],
     ["400", "1"],
     ["499", "1"]]
   }
trades
获取某个合约最近成交订单的信息。
Request Weight:
1
Request URL:
GET /openapi/quote/v1/contract/trades
Parameters：
名称
类型
是否强制
默认
描述
symbol
string
YES
​
合约名称
limit
integer
NO (最大值为1000)
100
返回成交订单的数量
Response:
名称
类型
例子
描述
price
float
0.055
交易价格
time
long
1537797044116
当前Unix时间戳，毫秒(ms)
qty
float
5
数量（张数）
isBuyerMaker
string
true
卖方还是买方。true=卖方，false=买方
Example:
[
  {
    "price": "1.21",
    "time": 1555034474064,
    "qty": "0.725",
    "isBuyerMaker": False
  },...
]
klines
获取某个合约的K线信息（高，低，开，收，交易量...)
Request Weight:
1
Request URL:
GET /openapi/quote/v1/contract/klines
Parameters：
名称
类型
是否强制
默认
描述
symbol|string|YES||合约名称 interval|string|YES||K线图区间。可识别发送的值为： 1m,5m,15m,30m,1h,1d,1w,1M（m=分钟，h=小时,d=天，w=星期，M=月） limit|integer|NO|1000|返回值的数量，最大值为1000 to|integer|NO||最后一个数据点的时间戳
Response:
名称
类型
例子
描述
''
long
1538728740000
开始时间戳，毫秒（ms）
''
float
36.00000'
开盘价
''
float
36.00000
最高价
''
float
36.00000
最低价
''
float
36.00000
收盘价
''
float
148976.11427815
合约交易金额
''
long
1538728740000
停止时间戳，毫秒（ms）
''
float
2434.19055334
交易数量（张数）
''
integer
308
已成交数量（张数）
''
float
1756.87402397
买方购买金额
''
float
28.46694368
买方购买数量（张数）
Example:
[
  [
    1538728740000, //'开盘时间'
    '36.000000000000000000', //'开盘价'
    '36.000000000000000000', //'最高价'
    '36.000000000000000000', //'最低价':
    '36.000000000000000000', //'收盘价'
    '148976.11427815',  // 合约交易金额
    1499644799999,      // 收盘时间
    '2434.19055334',    // 交易数量（张数）
    308,                // 已成交数量（张数）
    '1756.87402397',    // 买方购买金额
    '28.46694368'       // 买方购买数量（张数）
  ],...
]
base asset 代表买方收到了该数量的合约
quote asset 代表该数量的token用来获得合约
Private Endpoints
order
合约下单，这个端点需要签名访问。
Request Weight:
1
Request URL:
POST /openapi/contract/v1/order
Parameters：
名称
类型
是否强制
默认
描述
symbol
string
YES
​
合约名称。
side
string
YES
​
下单方向，方向类型为BUY_OPEN、SELL_OPEN、BUY_CLOSE、SELL_CLOSE。
orderType
string
YES
​
订单类型，支持订单类型为 LIMIT和STOP。
quantity
float
YES
​
订单的合约数量。
leverage
float
YES.（*_CLOSE平仓单不强制）
​
订单的杠杆。
price
float
NO. (LIMIT&INPUT)订单 强制需要
​
订单价格。
priceType
string
NO
INPUT
价格类型，支持的价格类型为INPUT、OPPONENT、QUEUE、OVER、MARKET。
triggerPrice
float
NO. STOP 订单 强制需要
​
计划委托的触发价格。
timeInForce
string
NO
GTC
LIMIT订单的时间指令（Time in Force），目前支持的类型为GTC、FOK、IOC、LIMIT_MAKER。
clientOrderId
string/long
YES
​
订单的ID，用户自己定义。
注意： 对于 市价订单, 你需要设置orderType为 LIMIT 并且设置 priceType 为 MARKET.
你可以在brokerInfo端点获取合约价格，数量的精度配置信息。
注意：如果你的余额没有达到需要保证金的要求（初始保证金+开仓手续费+平仓手续费），将会有"insufficient balance"（余额不足）的错误返回。
对于 价格类型 和 订单类型 的详细解释，请参见文末。
Response:
名称
类型
例子
描述
time
long
1570759718825
订单生成时的时间戳
updateTime
long
1551062936784
订单上次更新的时间戳
orderId
integer
469961015902208000
订单ID
clientOrderId
string
213443
用户定义的订单ID
symbol
string
BTC-PERP-REV
合约名称
price
float
8200
订单价格
leverage
float
4
订单杠杆
origQty
float
1.01
订单数量
executedQty
float
1.01
订单已执行数量
avgPrice
float
4754.24
平均交易价格
marginLocked
float
200
该订单锁定的保证金。这包括实际需要的保证金外加开仓和平仓所需的费用。
orderType
string
YES
订单类型（LIMIT和STOP）
priceType
string
INPUT
价格类型（INPUT、OPPONENT、QUEUE、OVER、MARKET）
side
string
BUY
订单方向（BUY_OPEN、SELL_OPEN、BUY_CLOSE、SELL_CLOSE）
status
string
NEW
订单状态（NEW、PARTIALLY_FILLED、FILLED、CANCELED、REJECTED）
timeInForce
string
GTC
时效单（Time in Force)类型(GTC、FOK、IOC、LIMIT_MAKER)
fees
​
​
订单的手续费
Example:
{
  'time': '1570759718825',
  'updateTime': '0',
  'orderId': '469961015902208000',
  'clientOrderId': '6423344174',
  'symbol': 'BTC-PERP-REV',
  'price': '8200',
  'leverage': '12.08',
  'origQty': '5',
  'executedQty': '0',
  'avgPrice': '0',
  'marginLocked': '0.00005047',
  'orderType': 'LIMIT',
  'side': 'BUY_OPEN',
  'fees': [],
  'timeInForce': 'GTC',
  'status': 'NEW',
  'priceType': 'INPUT'
}
cancel
取消某个订单，需要发送orderId或者clientOrderId其中之一。这个API端点需要你的请求签名。
Request Weight:
1
Request Url:
DELETE /openapi/contract/v1/order/cancel
Parameter:
名称
类型
是否强制
默认
描述
orderId
integer
NO
​
订单的ID
clientOrderId
string
NO
​
用户定义的订单ID
orderType
string
YES
​
订单类型（LIMIT和STOP）
注意：orderId 或者 clientOrderId 必须发送其中之一
Response:
名称
类型
例子
描述
time
long
1570759718825
订单生成时的时间戳
updateTime
long
1551062936784
订单上次更新的时间戳
orderId
integer
469961015902208000
订单ID
clientOrderId
string
213443
用户定义的订单ID
symbol
string
BTC-PERP-REV
合约名称
price
float
8200
订单价格
leverage
float
4
订单杠杆
origQty
float
1.01
订单数量
executedQty
float
1.01
订单已执行数量
avgPrice
float
4754.24
平均交易价格
marginLocked
float
200
该订单锁定的保证金。这包括实际需要的保证金外加开仓和平仓所需的费用。
orderType
string
YES
订单类型（LIMIT和STOP）
priceType
string
INPUT
价格类型（INPUT、OPPONENT、QUEUE、OVER、MARKET）
side
string
BUY
订单方向（BUY_OPEN、SELL_OPEN、BUY_CLOSE、SELL_CLOSE）
status
string
NEW
订单状态（NEW、PARTIALLY_FILLED、FILLED、CANCELED、REJECTED）。该端点返回的订单状态都是CANCELED
timeInForce
string
GTC
时效单（Time in Force)类型(GTC、FOK、IOC、LIMIT_MAKER)
fees
​
​
订单的手续费
在fees信息组里:
名称
类型
例子
描述
feeToken
string
USDT
手续费计价类型
fee
float
0
实际手续费
Example:
{
  'time': '1570759718825',
  'updateTime': '0',
  'orderId': '469961015902208000',
  'clientOrderId': '6423344174',
  'symbol': 'BTC-PERP-REV',
  'price': '8200',
  'leverage': '12.08',
  'origQty': '5',
  'executedQty': '0',
  'avgPrice': '0',
  'marginLocked': '0',
  'orderType': 'LIMIT',
  'side': 'BUY_OPEN',
  'fees': [],
  'timeInForce': 'GTC',
  'status': 'CANCELED',
  'priceType': 'INPUT' //status will always be `CANCELED` for cancel request
}
batchCancel
批量撤销订单(正在建设中: 计划委托的批量撤单)
Request Weight:
1
Request Url:
DELETE /openapi/contract/v1/order/batchCancel
Parameter:
名称
类型
是否强制
默认
描述
symbol
string/list
NO
​
合约名称（或者用,分割的合约名称的list）
Response:
名称
类型
例子
描述
message
string
success
撤单请求的返回消息
timestamp
long
1541161088303
返回时的时间戳
Example:
{
  'message':'success',
  'timestamp':1541161088303
}
openOrders
未完成委托，这个API端点需要请求签名。
Request Weight:
1
Request Url:
GET /openapi/contract/v1/openOrders
Parameters:
名称
类型
是否强制
默认
描述
symbol
string
NO
​
合约名称。如果没有在请求里发送，所有合约的未完成委托都会被返回。
orderId
integer
NO
​
订单ID
side
string
NO
​
订单方向（BUY_OPEN、SELL_OPEN、BUY_CLOSE、SELL_CLOSE）
orderType
string
YES
​
订单类型（LIMIT、STOP）
limit
integer
NO
20
返回值的长度。
如果发送了orderId，会返回所有< orderId的订单。如果没有则会返回最新的未完成订单。
Response:
名称
类型
例子
描述
time
long
1570759718825
订单生成时的时间戳
updateTime
long
1551062936784
订单上次更新的时间戳
orderId
integer
469961015902208000
订单ID
clientOrderId
string
213443
用户定义的订单ID
symbol
string
BTC-PERP-REV
合约名称
price
float
8200
订单价格
leverage
float
4
订单杠杆
origQty
float
1.01
订单数量
executedQty
float
1.01
订单已执行数量
avgPrice
float
4754.24
平均交易价格
marginLocked
float
200
该订单锁定的保证金。这包括实际需要的保证金外加开仓和平仓所需的费用。
orderType
string
YES
订单类型（LIMIT和STOP）
priceType
string
INPUT
价格类型（INPUT、OPPONENT、QUEUE、OVER、MARKET）
side
string
BUY
订单方向（BUY_OPEN、SELL_OPEN、BUY_CLOSE、SELL_CLOSE）
status
string
NEW
订单状态（NEW、PARTIALLY_FILLED、FILLED、CANCELED、REJECTED）
timeInForce
string
GTC
时效单（Time in Force)类型(GTC、FOK、IOC、LIMIT_MAKER)
fees
​
​
订单的手续费
在fees信息组里:
名称
类型
例子
描述
feeToken
string
USDT
手续费计价类型
fee
float
0
实际手续费
Example:
[
  {
    'time': '1570760254539',
    'updateTime': '0',
    'orderId': '469965509788581888',
    'clientOrderId': '1570760253946',
    'symbol': 'BTC-PERP-REV',
    'price': '8502.34',
    'leverage': '20',
    'origQty': '222',
    'executedQty': '0',
    'avgPrice': '0',
    'marginLocked': '0.00130552',
    'orderType': 'LIMIT',
    'side': 'BUY_OPEN',
    'fees': [],
    'timeInForce': 'GTC',
    'status': 'NEW',
    'priceType': 'INPUT'
  },...
]
historyOrders
Retrieves history of orders that have been partially or fully filled or canceled. This API endpoint requires your request to be signed.
Request Weight:
1
Request Url:
GET /openapi/contract/v1/historyOrders
Parameters:
名称
类型
是否强制
默认
描述
symbol
string
NO
​
Symbol to return open orders for. If not sent, orders of all contracts will be returned.
orderId
integer
NO
​
Order ID
side
string
NO
​
Direction of the order. Possible values include BUY_OPEN, SELL_OPEN, BUY_CLOSE, and SELL_CLOSE.
orderType
string
YES
​
The order type, possible types: LIMIT, STOP
limit
integer
NO
20
Number of entries to return.
If orderId is set, it will get orders < that orderId. Otherwise most recent orders are returned.
Response:
名称
类型
例子
描述
time
long
1570759718825
订单生成时的时间戳
updateTime
long
1551062936784
订单上次更新的时间戳
orderId
integer
469961015902208000
订单ID
clientOrderId
string
213443
用户定义的订单ID
symbol
string
BTC-PERP-REV
合约名称
price
float
8200
订单价格
leverage
float
4
订单杠杆
origQty
float
1.01
订单数量
executedQty
float
1.01
订单已执行数量
avgPrice
float
4754.24
平均交易价格
marginLocked
float
200
该订单锁定的保证金。这包括实际需要的保证金外加开仓和平仓所需的费用。
orderType
string
YES
订单类型（LIMIT和STOP）
priceType
string
INPUT
价格类型（INPUT、OPPONENT、QUEUE、OVER、MARKET）
side
string
BUY
订单方向（BUY_OPEN、SELL_OPEN、BUY_CLOSE、SELL_CLOSE）
status
string
NEW
订单状态（NEW、PARTIALLY_FILLED、FILLED、CANCELED、REJECTED）
timeInForce
string
GTC
时效单（Time in Force)类型(GTC、FOK、IOC、LIMIT_MAKER)
fees
​
​
订单的手续费
在fees信息组里:
名称
类型
例子
描述
feeToken
string
USDT
手续费计价类型
fee
float
0
实际手续费
Example:
[
  {
    'time': '1570759718825',
    'updateTime': '0',
    'orderId': '469961015902208000',
    'clientOrderId': '6423344174',
    'symbol': 'BTC-PERP-REV',
    'price': '8200',
    'leverage': '12.08',
    'origQty': '5',
    'executedQty': '0',
    'avgPrice': '0',
    'marginLocked': '0',
    'orderType': 'LIMIT',
    'side': 'BUY_OPEN',
    'fees': [],
    'timeInForce': 'GTC',
    'status': 'CANCELED',
    'priceType': 'INPUT'
  },...
]
getOrder
获取某个订单的详细信息
Request Weight:
1
Request Url:
GET /openapi/contract/v1/getOrder
Parameters:
名称
类型
是否强制
默认
描述
orderId
integer
NO
​
订单ID
clientOrderId
string
NO
​
用户定义的订单ID
orderType
string
YES
​
订单类型（LIMIT和STOP）
注意：orderId 或者 clientOrderId 必须发送其中之一
Response:
名称
类型
例子
描述
time
long
1570759718825
订单生成时的时间戳
updateTime
long
1551062936784
订单上次更新的时间戳
orderId
integer
469961015902208000
订单ID
clientOrderId
string
213443
用户定义的订单ID
symbol
string
BTC-PERP-REV
合约名称
price
float
8200
订单价格
leverage
float
4
订单杠杆
origQty
float
1.01
订单数量
executedQty
float
1.01
订单已执行数量
avgPrice
float
4754.24
平均交易价格
marginLocked
float
200
该订单锁定的保证金。这包括实际需要的保证金外加开仓和平仓所需的费用。
orderType
string
YES
订单类型（LIMIT和STOP）
priceType
string
INPUT
价格类型（INPUT、OPPONENT、QUEUE、OVER、MARKET）
side
string
BUY
订单方向（BUY_OPEN、SELL_OPEN、BUY_CLOSE、SELL_CLOSE）
status
string
NEW
订单状态（NEW、PARTIALLY_FILLED、FILLED、CANCELED、REJECTED）
timeInForce
string
GTC
时效单（Time in Force)类型(GTC、FOK、IOC、LIMIT_MAKER)
fees
​
​
订单的手续费
在fees信息组里:
名称
类型
例子
描述
feeToken
string
USDT
手续费计价类型
fee
float
0
实际手续费
Example:
{
  'time': '1570760254539',
  'updateTime': '0',
  'orderId': '469965509788581888',
  'clientOrderId': '1570760253946',
  'symbol': 'BTC-PERP-REV',
  'price': '8502.34',
  'leverage': '20',
  'origQty': '222',
  'executedQty': '0',
  'avgPrice': '0',
  'marginLocked': '0.00130552',
  'orderType': 'LIMIT',
  'side': 'BUY_OPEN',
  'fees': [],
  'timeInForce': 'GTC',
  'status': 'NEW',
  'priceType': 'INPUT'
}
myTrades
返回账户的成交历史，这个API端点需要请求签名。
Request Weight:
1
Request Url:
GET /openapi/contract/v1/myTrades
Parameters:
名称
类型
是否强制
默认
描述
symbol
string
NO
​
合约名称。如果没有发送，所有合约的成交历史都会被返回。
limit
integer
NO
20
返回限制(最大值为1000)
side
string
NO
​
订单方向
fromId
integer
NO
​
从TradeId开始（用来查询成交订单）
toId
integer
NO
​
到TradeId结束（用来查询成交订单）
Response:
名称
类型
例子
描述
time
long
1551062936784
订单生成是的时间戳
tradeId
long
49366
成交ID
orderId
long
630491436
订单ID
matchOrderId
long
630491432
成交对手订单ID
symbolId
string
BTC-PERP-REV
合约名称
price
float
4765.29
成交价格
quantity
float
1.01
成交数量
feeTokenId
string
USDT
手续费类型（Token名称）
fee
​
​
实际手续费
side
string
BUY
订单方向（BUY_OPEN、SELL_OPEN、BUY_CLOSE、SELL_CLOSE）
orderType
string
LIMIT
订单类型（LIMIT、MARKET)
Example:
[
  {
    'time': '1570760582848',
    'tradeId': '469968263995080704',
    'orderId': '469968263793737728',
    "matchOrderId": 436002617267469062,
    'accountId': '456552319339779840',
    'symbolId': 'BTC-PERP-REV',
    'price': '8531.17',
    'quantity': '100',
    'feeTokenId': 'TBTC',
    'fee': '0.00000586',
    'type': 'LIMIT',
    'side': 'BUY_OPEN'
  },...
]
positions
返回现在的仓位信息，这个API需要请求签名。
Request Weight:
1
Request Url:
GET /openapi/contract/v1/positions
Parameters:
名称
类型
是否强制
默认
描述
symbol
string
NO
​
合约名称。如果没有发送，所有的合约仓位信息都会被返回。
side
string
NO
​
仓位方向，LONG（多仓）或者SHORT（空仓）。如果没有发送，两个方向的仓位信息都会被返回。
Response:
名称
类型
例子
描述
symbol
string
BTC-PERP-REV
合约名称
side
string
LONG
仓位方向（LONG、SHORT）
avgPrice
float
100
平均开仓价格
position
float
20
开仓数量（张）
available
float
15
可平仓数量（张）
leverage
float
5
仓位现在杠杆
lastPrice
float
100
合约最新市场成交价
positionValue
float
2000
仓位价值
flp
float
80
强制平仓价格
margin
float
20
仓位保证金
marginRate
float
0.2
当前仓位的保证金率
unrealizedPnL
float
0.0
当前仓位的未实现盈亏
profitRate
float
0.0000333
当前仓位的盈利率
realizedPnL
float
6.8
当前 合约 的已实现盈亏
Example:
[
  {
    'symbol': 'BTC-PERP-REV',
    'side': 'LONG',
    'avgPrice': '8183.11',
    'position': '1100',
    'available': '1100',
    'leverage': '6',
    'lastPrice': '8572.53',
    'positionValue': '0.12833346',
    'flp': '7523.65',
    'margin': '0.01251335',
    'marginRate': '0.14',
    'unrealizedPnL': '0.00608975',
    'profitRate': '0.0000333',
    'realizedPnL': '-0.00006721'
  },...
]
account
返回合约账户余额，这个端点需要请求签名。
Request Weight:
1
Request Url:
GET  /openapi/contract/v1/account
Parameters:
None
Response:
名称
类型
例子
描述
total
float
131.06671401
总余额
availableMargin
float
131.0545541
可用保证金
positionMargin
float
0.01215991
仓位保证金
orderMargin
float
0
委托保证金（下单锁定）
Example:
{
  "TBTC": {
    "total":"131.06671401",
    "availableMargin":"131.0545541",
    "positionMargin":"0.01215991",
    "orderMargin":"0"
  },

名称	类型	是否强制	默认	描述
`symbol`	string	`YES`		合约名称。
`side`	string	`YES`		下单方向，方向类型为`BUY_OPEN`、`SELL_OPEN`、`BUY_CLOSE`、`SELL_CLOSE`。
`orderType`	string	`YES`		订单类型，支持订单类型为 `LIMIT`和`STOP`。
`quantity`	float	`YES`		订单的合约数量。
`leverage`	float	`YES`.（_CLOSE平仓单不强制*）		订单的杠杆。
`price`	float	`NO`. (`LIMIT`&`INPUT`)订单强制需要		订单价格。
`priceType`	string	`NO`	`INPUT`	价格类型，支持的价格类型为`INPUT`、`OPPONENT`、`QUEUE`、`OVER`、`MARKET`。
`triggerPrice`	float	`NO`. `STOP` 订单强制需要		计划委托的触发价格。
`timeInForce`	string	`NO`	`GTC`	`LIMIT`订单的时间指令（Time in Force），目前支持的类型为`GTC`、`FOK`、`IOC`、`LIMIT_MAKER`。
`clientOrderId`	string/long	`YES`		订单的ID，用户自己定义。

名称	类型	例子	描述
`time`	long	`1570759718825`	订单生成时的时间戳
`updateTime`	long	`1551062936784`	订单上次更新的时间戳
`orderId`	integer	`469961015902208000`	订单ID
`clientOrderId`	string	`213443`	用户定义的订单ID
`symbol`	string	`BTC-PERP-REV`	合约名称
`price`	float	`8200`	订单价格
`leverage`	float	`4`	订单杠杆
`origQty`	float	`1.01`	订单数量
`executedQty`	float	`1.01`	订单已执行数量
`avgPrice`	float	`4754.24`	平均交易价格
`marginLocked`	float	`200`	该订单锁定的保证金。这包括实际需要的保证金外加开仓和平仓所需的费用。
`orderType`	string	`YES`	订单类型（`LIMIT`和`STOP`）
`priceType`	string	`INPUT`	价格类型（`INPUT`、`OPPONENT`、`QUEUE`、`OVER`、`MARKET`）
`side`	string	`BUY`	订单方向（`BUY_OPEN`、`SELL_OPEN`、`BUY_CLOSE`、`SELL_CLOSE`）
`status`	string	`NEW`	订单状态（`NEW`、`PARTIALLY_FILLED`、`FILLED`、`CANCELED`、`REJECTED`）
`timeInForce`	string	`GTC`	时效单（Time in Force)类型(`GTC`、`FOK`、`IOC`、`LIMIT_MAKER`)
`fees`			订单的手续费

名称	类型	例子	描述
`time`	long	`1570759718825`	订单生成时的时间戳
`updateTime`	long	`1551062936784`	订单上次更新的时间戳
`orderId`	integer	`469961015902208000`	订单ID
`clientOrderId`	string	`213443`	用户定义的订单ID
`symbol`	string	`BTC-PERP-REV`	合约名称
`price`	float	`8200`	订单价格
`leverage`	float	`4`	订单杠杆
`origQty`	float	`1.01`	订单数量
`executedQty`	float	`1.01`	订单已执行数量
`avgPrice`	float	`4754.24`	平均交易价格
`marginLocked`	float	`200`	该订单锁定的保证金。这包括实际需要的保证金外加开仓和平仓所需的费用。
`orderType`	string	`YES`	订单类型（`LIMIT`和`STOP`）
`priceType`	string	`INPUT`	价格类型（`INPUT`、`OPPONENT`、`QUEUE`、`OVER`、`MARKET`）
`side`	string	`BUY`	订单方向（`BUY_OPEN`、`SELL_OPEN`、`BUY_CLOSE`、`SELL_CLOSE`）
`status`	string	`NEW`	订单状态（`NEW`、`PARTIALLY_FILLED`、`FILLED`、`CANCELED`、`REJECTED`）。该端点返回的订单状态都是`CANCELED`
`timeInForce`	string	`GTC`	时效单（Time in Force)类型(`GTC`、`FOK`、`IOC`、`LIMIT_MAKER`)
`fees`			订单的手续费

名称	类型	例子	描述
`time`	long	`1570759718825`	订单生成时的时间戳
`updateTime`	long	`1551062936784`	订单上次更新的时间戳
`orderId`	integer	`469961015902208000`	订单ID
`clientOrderId`	string	`213443`	用户定义的订单ID
`symbol`	string	`BTC-PERP-REV`	合约名称
`price`	float	`8200`	订单价格
`leverage`	float	`4`	订单杠杆
`origQty`	float	`1.01`	订单数量
`executedQty`	float	`1.01`	订单已执行数量
`avgPrice`	float	`4754.24`	平均交易价格
`marginLocked`	float	`200`	该订单锁定的保证金。这包括实际需要的保证金外加开仓和平仓所需的费用。
`orderType`	string	`YES`	订单类型（`LIMIT`和`STOP`）
`priceType`	string	`INPUT`	价格类型（`INPUT`、`OPPONENT`、`QUEUE`、`OVER`、`MARKET`）
`side`	string	`BUY`	订单方向（`BUY_OPEN`、`SELL_OPEN`、`BUY_CLOSE`、`SELL_CLOSE`）
`status`	string	`NEW`	订单状态（`NEW`、`PARTIALLY_FILLED`、`FILLED`、`CANCELED`、`REJECTED`）
`timeInForce`	string	`GTC`	时效单（Time in Force)类型(`GTC`、`FOK`、`IOC`、`LIMIT_MAKER`)
`fees`			订单的手续费

名称	类型	例子	描述
`time`	long	`1570759718825`	订单生成时的时间戳
`updateTime`	long	`1551062936784`	订单上次更新的时间戳
`orderId`	integer	`469961015902208000`	订单ID
`clientOrderId`	string	`213443`	用户定义的订单ID
`symbol`	string	`BTC-PERP-REV`	合约名称
`price`	float	`8200`	订单价格
`leverage`	float	`4`	订单杠杆
`origQty`	float	`1.01`	订单数量
`executedQty`	float	`1.01`	订单已执行数量
`avgPrice`	float	`4754.24`	平均交易价格
`marginLocked`	float	`200`	该订单锁定的保证金。这包括实际需要的保证金外加开仓和平仓所需的费用。
`orderType`	string	`YES`	订单类型（`LIMIT`和`STOP`）
`priceType`	string	`INPUT`	价格类型（`INPUT`、`OPPONENT`、`QUEUE`、`OVER`、`MARKET`）
`side`	string	`BUY`	订单方向（`BUY_OPEN`、`SELL_OPEN`、`BUY_CLOSE`、`SELL_CLOSE`）
`status`	string	`NEW`	订单状态（`NEW`、`PARTIALLY_FILLED`、`FILLED`、`CANCELED`、`REJECTED`）
`timeInForce`	string	`GTC`	时效单（Time in Force)类型(`GTC`、`FOK`、`IOC`、`LIMIT_MAKER`)
`fees`			订单的手续费