Trading API
Place a New Order
POST /api/v1/perpetual/products/{contractCode}/order
Request Parameter:
Path Parameter
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
contractCode | y | string | Futurescode |
Query
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
AccessKeyId | y | string | Accesskey | ||
SignatureVersion | y | string | Version | ||
SignatureMethod | y | string | Signature Method | HmacSHA256 | |
Signature | y | string | Signature | ||
Timestamp | y | string | Timestamp |
Body(json)
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
type | y | string | Type | 10 Limit or Conditional 11 Market price | |
triggerBy | n | string | triggerType | Conditional option, if not conditional order this field must be NULL,IndexPrice:index,MarkPrice:mark,LastPrice:last | |
triggerPrice | n | string | Conditional option trigger price | ||
side | y | string | Side | open_long Open Long open_short Open Short close_long Close Long close_short Close Short | |
price | y | string | Price | ||
ioc | n | int | if orders cannot be immediately traded , the untranslated part will be cancelled immediately | 0 | 0: Disable,1: Enable |
amount | y | int | Amount | ||
beMaker | n | int | Timestamp | 0 | Post-only:0:Not Post-only 1:Post-only |
Response
{
"id": "1237893454356"
}
Return:
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
id | y | long | Orderid |
Place a New Conditional Order
POST /api/v1/perpetual/products/{contractCode}/order
Request Parameter:
Path Parameter
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
contractCode | y | string | Futurescode |
Query
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
AccessKeyId | y | string | Accesskey | ||
SignatureVersion | y | string | Version | ||
SignatureMethod | y | string | Signature Method | HmacSHA256 | |
Signature | y | string | Signature | ||
Timestamp | y | string | Timestamp |
Body(json)
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
type | y | string | Type | 12 :conditional order | |
triggerBy | n | string | triggerType | default "mark",MarkPrice:mark,LastPrice:last | |
triggerPrice | n | string | Conditional option trigger price | Conditional option trigger price | |
side | y | string | Side | open_long Open Long, open_short Open Short ,close_long Close Long, close_short Close Short | |
price | y | string | Price | Price | |
amount | y | int | Amount | Amount | |
algoType | y | int | Order type | 10 Limit price , 11 Market price | |
currentPrice | y | string | Current contract price | The current contract price, to determine the direction of profit and loss |
//Plan to place orders
{
"type": 12, //type: order type, 12: condition order
"side": "open_long", //side: open position direction after triggering
"triggerBy": "last", //Trigger type: index price: index, mark price: mark, last price: last
"triggerPrice": "500", //Trigger price
"price": "600.000000", // After triggering the order price (limit order price must be posted)
"amount": "10", // Number of orders placed after triggerin
"algoType": 10 // Conditional order Type 10: limit order 11: market order
}
//Stop profit stop loss order
{
"type": 12, //type: order type, 12: condition order
"amount": 12, //Number of orders placed after triggering
"side": "close_long", //side: open position after triggering
"triggerBy": "last", // Trigger type: index price: index, mark price: mark, last price: last
"triggerPrice": "12", // Trigger price
"currentPrice": "600.000000", // Current contract price, determine the direction of stop profit and stop loss
"algoType": 10, // Conditional order Type 10: limit order 11: market orde
"price": "600.000000", // After triggering the order price (limit order price must be posted)
}
Return:
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
id | y | long | Orderid |
Response
{
"id": "1237893454356"
}
Place a Batch of Orders
POST /api/v1/perpetual/products/{contractCode}/batch-order
Request Parameter:
Path Parameter
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
contractCode | y | string | Contractcode |
Query
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
AccessKeyId | y | string | Accesskey | ||
SignatureVersion | y | string | Version | ||
SignatureMethod | y | string | Signature Method | HmacSHA256 | |
Signature | y | string | Signature | ||
Timestamp | y | string | Timestamp |
[
{
"amount": 1,
"lang": "zh_CN",
"platform": 1,
"price": "2.94",
"side": "open_long",
"type": 10,
"tag": 1
}
]
Body(list-json)
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
type | y | string | Type | 10 Limit or Conditional 11 Market price | |
side | y | string | Side | open_long Open Long open_short Open Short close_long Close Long close_short Close Short | |
price | y | string | Price | ||
amount | y | int | Amount | ||
beMaker | n | int | Timestamp | 0 | Post-only:0:Not Post-only 1:Post-only |
ioc | n | int | if orders cannot be immediately traded , the untranslated part will be cancelled immediately | 0 | 0: Disable,1: Enable |
tag | n | string | Tag | tags defined by the user at the time of order placing and returned after the order is placed |
Response
[
{
"orderId": 80742077438016,
"tag": "1"
}
]
Return(list-json):
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
id | y | long | Orderid |
Order List
GET /api/v1/perpetual/products/{contractCode}/list
Request Parameter:
Path Parameter
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
contractCode | y | string | Contractcode |
Query
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
AccessKeyId | y | string | Accesskey | ||
SignatureVersion | y | string | Version | ||
SignatureMethod | y | string | Signature Method | HmacSHA256 | |
Signature | y | string | Signature | ||
Timestamp | y | string | Timestamp |
Response
[
{
"amount": "300.0000000000000000",
"avgPrice": "0E-16",
"base": "",
"contractCode": "fbtcusd",
"contractDirection": 0,
"createdDate": 1582225542000,
"dealAmount": "0E-16",
"detailSide": "open_long",
"direction": "",
"fee": "0E-16",
"id": 69109290623152,
"orderSize": "0.32258064",
"price": "9300.0000000000000000",
"profit": "0E-16",
"quote": "",
"reason": 0,
"refConditionOrderId": 0,
"refOrderCondition": null,
"side": "long",
"source": "",
"status": 0,
"systemType": 10,
"triggerBy": "",
"triggerPrice": ""
}
]
Return:
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
amount | y | string | Amount | ||
avgPrice | y | string | Avg. Filled Price | ||
base | y | string | Base curreny,such as btc、fbtc | ||
contractCode | y | string | A combination between Base and Quote P_BTC_USDT,R_BTC_USDT | ||
contractDirection | y | int | FuturesSide 0: Linear,1: Inverse | ||
createdDate | y | string | Creation Time | ||
dealAmount | y | string | Filled Amount | ||
detailSide | y | string | OrderSide 1.Open Longopen_long 2.Open Shortopen_short 3.Close Longclose_long 4.Close Shortclose_short | ||
direction | y | string | Conditional:triggerSide,greater Greater,less Less | ||
fee | y | string | The handling fee paid after the order is filled: Positive means fee obtained, negative means fee paid | ||
id | y | long | Orderid | ||
orderSize | y | string | Ordervalue | ||
price | y | string | OrderPrice | ||
profit | y | string | The P/L corresponding to the order after being filled: Positive means profit, negative means loss | ||
quote | y | string | Quote currency name,usd,cny,usdt | ||
reason | y | int | Reasons for cancellation of this order,0 is Default Value,no reasons | ||
refConditionOrderId | y | long | ConditionalOrderid | ||
refOrderCondition | y | object | ConditionalOrderDetails | ||
side | y | string | OrderSide,longLong,shortShort | ||
source | y | string | Source | ||
status | y | int | Status 0:Waiting to fill 1:Partial filled 2:Filled -1:Cancelled | ||
systemType | y | int | 10:Limit 11:Market 13:Forced Liquidation 14: Liquidation 15:Over loss 16:ADL | ||
triggerBy | y | string | ConditionaltriggerType,IndexPrice:index,MarkPrice:mark,LastPrice:last | ||
triggerPrice | y | string | ConditionaltriggerPrice |
Cancel Order
DELETE /api/v1/perpetual/products/{contractCode}/order/{id}
Request Parameter:
Path Parameter
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
contractCode | y | string | Futurescode | ||
id | y | long | Orderid |
Query
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
AccessKeyId | y | string | Accesskey | ||
SignatureVersion | y | string | Version | ||
SignatureMethod | y | string | Signature Method | HmacSHA256 | |
Signature | y | string | Signature | ||
Timestamp | y | string | Timestamp |
Response
{
"code": 200,
"msg": "success",
"data": null
}
Return:
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
code | y | int | Status,200:Success | ||
msg | y | string | Tips | ||
data | y | object |
Batch Cancel Order
DELETE /api/v1/perpetual/products/{contractCode}/orders
Request Parameter:
Path Parameter
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
contractCode | y | string | Futurescode |
Query
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
AccessKeyId | y | string | Accesskey | ||
SignatureVersion | y | string | Version | ||
SignatureMethod | y | string | Signature Method | HmacSHA256 | |
Signature | y | string | Signature | ||
Timestamp | y | string | Timestamp |
Response
{
"code": 200,
"msg": "success",
"data": null
}
Return:
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
code | y | int | Status,200:Success | ||
msg | y | string | Tips | ||
data | y | object |
Batch Cancel According to Order No.
DELETE /api/v1/perpetual/products/{contractCode}/batch-delete-order
Request Parameter:
Path Parameter
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
contractCode | y | string | Futurescode |
Query
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
AccessKeyId | y | string | Accesskey | ||
SignatureVersion | y | string | Version | ||
SignatureMethod | y | string | Signature Method | HmacSHA256 | |
Signature | y | string | Signature | ||
Timestamp | y | string | Timestamp |
[
80581909355536,
80581909355537
]
Body(list)
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
id | y | string | OrderNo. |
Response
{
"code": 200,
"msg": "success",
"data": null
}
Return:
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
code | y | int | Status,200:Success | ||
msg | y | string | Tips | ||
data | y | object |
OrderDetails
GET /api/v1/perpetual/products/{contractCode}/{id}
Request Parameter:
Path Parameter
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
contractCode | y | string | Futurescode | ||
id | y | long | Orderid |
Query
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
AccessKeyId | y | string | Accesskey | ||
SignatureVersion | y | string | Version | ||
SignatureMethod | y | string | Signature Method | HmacSHA256 | |
Signature | y | string | Signature | ||
Timestamp | y | string | Timestamp |
Response
{
"amount": "300.0000000000000000",
"avgPrice": "0E-16",
"base": "",
"contractCode": "fbtcusd",
"contractDirection": 0,
"createdDate": 1582225542000,
"dealAmount": "0E-16",
"detailSide": "open_long",
"direction": "",
"fee": "0E-16",
"id": 69109290623152,
"orderSize": "0.32258064",
"price": "9300.0000000000000000",
"profit": "0E-16",
"quote": "",
"reason": 0,
"refConditionOrderId": 0,
"refOrderCondition": null,
"side": "long",
"source": "",
"status": 0,
"systemType": 10,
"triggerBy": "",
"triggerPrice": ""
}
Return:
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
amount | y | string | Amount | ||
avgPrice | y | string | Avg. Filled Price | ||
base | y | string | Base currency name,such asbtc、fbtc | ||
contractCode | y | string | A combination between Base and Quote P_BTC_USDT,R_BTC_USDT | ||
contractDirection | y | int | FuturesSide 0: Linear,1: Inverse | ||
createdDate | y | string | Creation Time | ||
dealAmount | y | string | Filled Amount | ||
detailSide | y | string | OrderSide 1.Open Longopen_long 2.Open Shortopen_short 3.Close Longclose_long 4.Close Shortclose_short | ||
direction | y | string | ConditionalOrder:triggerSide,greaterGreater,lessLess | ||
fee | y | string | The handling fee paid after the order is filled: Positive means fee obtained, negative means fee paid | ||
id | y | long | Orderid | ||
orderSize | y | string | Ordervalue | ||
price | y | string | OrderPrice | ||
profit | y | string | The P/L corresponding to the order after being filled: Positive means profit, negative means loss | ||
quote | y | string | Quote currency name,usd,cny,usdt | ||
reason | y | int | Reasons for cancellation of this order,0 is Default Value,no reasons | ||
refConditionOrderId | y | long | Conditional orderid | ||
refOrderCondition | y | object | Conditional order details | ||
side | y | string | OrderSide,longLong,shortShort | ||
source | y | string | Source | ||
status | y | int | Status 0:Waiting to fill 1:Partial filled 2:Filled -1:Cancelled | ||
systemType | y | int | 10:Limit 11:Market 13:Forced Liquidation 14: Liquidation 15:Over loss 16:ADL | ||
triggerBy | y | string | ConditionalOrdertriggerType,IndexPrice:index,MarkPrice:mark,LastPrice:last | ||
triggerPrice | y | string | ConditionalOrdertriggerPrice |
Market Close All
POST /api/v1/perpetual/products/{contract_code}/{side}/closePosition
Request Parameter:
Path Parameter
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
contractCode | y | string | Futurescode | ||
side | y | string | Side | long Long short Short |
Query
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
AccessKeyId | y | string | Accesskey | ||
SignatureVersion | y | string | Version | ||
SignatureMethod | y | string | Signature Method | HmacSHA256 | |
Signature | y | string | Signature | ||
Timestamp | y | string | Timestamp |
Response
{
"code": 200,
"msg": "success",
"data": null
}
Return:
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
code | y | int | Status,200:Success | ||
msg | y | string | Tips | ||
data | y | object |
History Order
GET /api/v1/perpetual/products/{contractCode}/history-list
Request Parameter:
Path Parameter
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
contractCode | y | string | Futurescode |
Query
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
AccessKeyId | y | string | Accesskey | ||
SignatureVersion | y | string | Version | ||
SignatureMethod | y | string | Signature Method | HmacSHA256 | |
Signature | y | string | Signature | ||
Timestamp | y | string | Timestamp | ||
base | n | string | Base currency | ||
detailSide | n | string | PositionSide 1.Open Longopen_long 2.Open Shortopen_short 3.Close Longclose_long 4.Close Shortclose_short | ||
status | n | int | Status:1 Filled 2 Partial filledCancelled 3 Cancelled Order;Multiple conditions filters separated by "," | ||
type | n | int | FuturesSide 0: Linear,1: Inverse | ||
systemType | n | string | OrderingType:10:Limit 11:Market 13:Forced Liquidation 14: Liquidation 15:Over loss 16:ADL;Multiple conditions filters separated by "," | ||
startDate | n | int | Start Time | ||
endTime | n | int | End Time | ||
page | n | int | Page | 1 | |
pageSize | n | int | Page size | 20 | |
stopLimitType | n | int | TriggerType:0 -Stop-profit 1-Stop-loss 2-Trigger Order |
Return
Response
{
"code": 0,
"msg": "",
"data": {
"total": 0,
"rows": [
{
"id": 0,
"contractCode": "",
"base": "",
"quote": "",
"indexBase": "",
"contractDirection": 0,
"side": "",
"detailSide": "",
"amount": "",
"dealAmount": "",
"avgPrice": "",
"price": "",
"orderSize": "",
"status": 0,
"systemType": 0,
"direction": "",
"profit": "",
"fee": "",
"reason": 0,
"triggerBy": "",
"triggerPrice": "",
"triggerDate": 0,
"modifyDate": 0,
"createdDate": "2022-04-18 16:07:49",
"source": "",
"refConditionOrderId": 0,
"refOrderCondition": {
"id": 0,
"contractCode": "",
"base": "",
"quote": "",
"indexBase": "",
"contractDirection": 0,
"type": "",
"direction": "",
"triggerPrice": "",
"triggerBy": "",
"price": "",
"side": "",
"detailSide": "",
"amount": "",
"avgPrice": "",
"dealAmount": "",
"orderSize": "",
"dealSize": "",
"status": 0,
"reason": 0,
"systemType": 0,
"createdDate": "2022-04-18 16:07:49",
"source": "",
"orderPriceType": 0,
"positionType": 0,
"stopLimitType": 0,
"refOrderId": 0,
"lever": 0,
"unitAmount": "",
"marginDigit": 0,
"marketPriceDigit": 0,
"triggerDate": 0,
"modifyDate": 0,
"tiggerOrderDetail": {
"id": 0,
"price": ""
}
},
"stopLimitType": "",
"lever": "",
"orderPriceType": 0,
"positionType": 0,
"unitAmount": "",
"marginDigit": 0,
"marketPriceDigit": 0,
"stopLoss": {
"id": 0,
"contractCode": "",
"base": "",
"quote": "",
"indexBase": "",
"contractDirection": 0,
"type": "",
"direction": "",
"triggerPrice": "",
"triggerBy": "",
"price": "",
"side": "",
"detailSide": "",
"amount": "",
"avgPrice": "",
"dealAmount": "",
"orderSize": "",
"dealSize": "",
"status": 0,
"reason": 0,
"systemType": 0,
"createdDate": "2022-04-18 16:07:49",
"source": "",
"orderPriceType": 0,
"positionType": 0,
"stopLimitType": 0,
"refOrderId": 0,
"lever": 0,
"unitAmount": "",
"marginDigit": 0,
"marketPriceDigit": 0,
"triggerDate": 0,
"modifyDate": 0,
"tiggerOrderDetail": {
"id": 0,
"price": ""
}
},
"stopProfit": {
"id": 0,
"contractCode": "",
"base": "",
"quote": "",
"indexBase": "",
"contractDirection": 0,
"type": "",
"direction": "",
"triggerPrice": "",
"triggerBy": "",
"price": "",
"side": "",
"detailSide": "",
"amount": "",
"avgPrice": "",
"dealAmount": "",
"orderSize": "",
"dealSize": "",
"status": 0,
"reason": 0,
"systemType": 0,
"createdDate": "2022-04-18 16:07:49",
"source": "",
"orderPriceType": 0,
"positionType": 0,
"stopLimitType": 0,
"refOrderId": 0,
"lever": 0,
"unitAmount": "",
"marginDigit": 0,
"marketPriceDigit": 0,
"triggerDate": 0,
"modifyDate": 0,
"tiggerOrderDetail": {
"id": 0,
"price": ""
}
}
}
]
}
}
Object-data
Name | Type | Description | Default Value | Remarks |
---|---|---|---|---|
id | number | ID | ||
contractCode | string | FuturesCode | ||
base | string | Base currency name,such asbtc | ||
quote | string | Quote currency name,usd,cny,usdt | ||
indexBase | string | Indexcurrency | ||
contractDirection | number | Side 0: Linear,1: Inverse | ||
side | string | PositionSide,longLong,shortShort | ||
detailSide | string | PositionSide 1.Open Longopen_long 2.Open Shortopen_short 3.Close Longclose_long 4.Close Shortclose_short | ||
amount | string | Order Amount | ||
dealAmount | string | Filled Amount | ||
avgPrice | string | Avg. filledPrice | ||
price | string | OrderPrice | ||
orderSize | string | Ordervalue | ||
status | number | 0 Waiting to fill 1 Partial filled 2 Filled -1 Cancelled | ||
systemType | number | 10:Limit 11:Market 13:Forced Liquidation 14: Liquidation 15:Over loss 16:ADL | ||
direction | string | triggerSide,greaterGreater,lessLess | ||
profit | string | The P/L corresponding to the order after being filled: Positive means profit, negative means loss | ||
fee | string | The handling fee paid after the order is filled: Positive means fee obtained, negative means fee paid | ||
reason | number | Reasons for cancellation of this order,0isDefault Value,1 Cancelled by system,2 Cancelled by users Others-Order failed | ||
triggerBy | string | Trigger OrderType: index-IndexPricemarket/mark-MarkPricemark/last-LastPricelast | ||
triggerPrice | string | triggerPrice | ||
triggerDate | number | triggertime | ||
modifyDate | number | Last operation time | ||
createdDate | string | Creation Time | ||
source | string | Source | ||
refConditionOrderId | number | Associated conditionsOrderid | ||
refOrderCondition | OrderCondition | AssociateConditionalOrder #Object-OrderCondition | ||
stopLimitType | string | ConditionalOrderType 0 -Stop-profit 1-Stop-loss 2-Trigger Order | ||
lever | string | Leverages | ||
orderPriceType | number | 20 Optimal20/10 Optimal10/5 Optimal5/1 BBO | ||
positionType | number | HoldingType | ||
unitAmount | string | quote face value corresponding to a Futures,default1 | ||
marginDigit | number | Margin demical | ||
marketPriceDigit | number | MarkPricedemical | ||
stopLoss | object | AssociateStop-lossorder #Object-OrderCondition | ||
stopProfit | object | AssociateStop-profitorder #Object-OrderCondition |
Object-OrderCondition
Name | Type | Description | Default Value | Remarks |
---|---|---|---|---|
id | number | ConditionalOrderid | ||
contractCode | string | Futurescode:A combination between Base and Quote | ||
base | string | Base currency name | ||
quote | string | Quote currency name | ||
indexBase | string | Indexcurrency | ||
contractDirection | number | Side 0: Linear,1: Inverse | ||
type | string | triggerType:IndexPrice,MarkPrice,LastPrice | ||
direction | string | triggerSide,greaterGreater,lessLess | ||
triggerPrice | string | triggerPrice | ||
triggerBy | string | Trigger OrderType: index-IndexPricemarket/mark-MarkPricemark/last-LastPricelast | ||
price | string | User OrderingOrder or BankruptcyPrice | ||
side | string | PositionSide,longLong,shortShort | ||
detailSide | string | 1.Open Longopen_long 2.Open Shortopen_short 3.Close Longclose_long 4.Close Shortclose_short | ||
amount | string | Order Amount | ||
avgPrice | string | Avg. filledPrice | ||
dealAmount | string | Filled Amount | ||
orderSize | string | Ordervalue | ||
dealSize | string | Filledvalue | ||
status | number | Status 1:Triggered 0、2:Untrigger 3:Pre-ConditionalOrder -1:Cancelled | ||
reason | number | Reasons for Orderbeing cancelled 1:Cancelled by system 2:Cancelled by users 3、4、5:Failed after trigger Order Separated by comma | ||
systemType | number | 10:Limit 11:Market 13:Forced Liquidation 14: Liquidation | ||
createdDate | string | Creation Time | ||
source | string | Source | ||
orderPriceType | number | OrderingPriceType,BBO:opponent,Optimal20:optimal_20,Optimal10:optimal_10,Optimal5:optimal_5 | ||
positionType | number | PositionPattern | ||
stopLimitType | number | ConditionalType | ||
refOrderId | number | AssociateOrderid | ||
lever | number | Leverages | ||
unitAmount | string | Unit | ||
marginDigit | number | Margindecimal | ||
marketPriceDigit | number | Pricedecimal | ||
triggerDate | number | triggertime | ||
modifyDate | number | Modify time | ||
tiggerOrderDetail | object |
Order Transaction Details
GET /api/v1/perpetual/products/{contractCode}/orderDetail
Request Parameter:
Path Parameter
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
contractCode | y | string | Futurescode |
Query
Parameter | Mandatory | Type | Description | Default Value | Value Range |
---|---|---|---|---|---|
AccessKeyId | y | string | Accesskey | ||
SignatureVersion | y | string | Version | ||
SignatureMethod | y | string | Signature Method | HmacSHA256 | |
Signature | y | string | Signature | ||
Timestamp | y | string | Timestamp | ||
orderId | y | number | OrderID |
Return
body
Response
{
"code": 200,
"data": {
"amount": "4",
"avgPrice": "342.150000",
"canceledDate": 0,
"contract": {
"amount24": "",
"base": "usdt",
"code": "bchusdt",
"countDownTimeInterval": "",
"direction": 0,
"env": 0,
"fluctuation": "",
"fund": "",
"high": "",
"indexBase": "bch",
"indexPrice": "",
"lastCny": "",
"low": "",
"makerRate": "",
"marginDigit": 6,
"markPrice": "",
"marketPriceDigit": 6,
"maxLever": 0,
"minQuoteDigit": 0,
"minTradeDigit": 0,
"minTradeUnit": 0,
"nextLiquidationInterval": 0,
"openTradeTime": "",
"price": "",
"quote": "usdt",
"size24": "",
"sort": 0,
"takerRate": "",
"totalPosition": "",
"tradeStatus": 0,
"unitAmount": 0.1,
"unitAmountStr": "0.1"
},
"createdDate": 1649925906000,
"currencyCode": "usdt",
"dealAmount": "4",
"dealDetails": [
{
"dealAmount": "4",
"dealDate": 1649925907000,
"fee": "-0.088959",
"markerTaker": 2
}
],
"detailSide": "close_long",
"fee": "-0.088959",
"historyOrderFlag": true,
"lever": "20",
"liquidateExplosionDetail": null,
"orderId": 138434463977680,
"orderPriceType": 0,
"orderSystemType": 11,
"positionType": 1,
"price": "341.686700",
"profit": "-0.560000",
"refConditionOrderId": 0,
"refOrderId": 0,
"refType": 1,
"settingDate": 0,
"side": "short",
"status": 2,
"stopLimitType": 0,
"systemType": 11,
"triggerDate": 0,
"triggerPrice": "",
"unitAmount": "0.1",
"userId": 20600095
},
"msg": "success"
}
data
Name | Type | Description | Default Value | Remarks |
---|---|---|---|---|
amount | string | Order Amount | ||
avgPrice | string | Average transaction price | ||
canceledDate | number | Revoke time | ||
contract | object | Futuresdetails | ContractNavigation | |
createdDate | number | Creation Time | ||
currencyCode | string | Currency | ||
dealAmount | string | Transaction Amount | ||
dealDetails | object [] | TransactionDetails | item Type: OrderDealDetail | |
detailSide | string | DetailPositionSide:1.Open Longopen_long 2.Open Shortopen_short 3.Close Longclose_long 4.Close Shortclose_short | ||
fee | string | Fee | ||
historyOrderFlag | boolean | HistoryOrder or not | ||
lever | string | Leverages | ||
liquidateExplosionDetail | object | Forced liquidation Details | LiquidateExplosionDetail | |
orderId | number | OrderID | ||
orderPriceType | number | OrderType | ||
positionType | number | PositionType | ||
price | string | Order价 | ||
profit | string | Yield | ||
refConditionOrderId | number | ConditionalOrderid | ||
settingDate | number | Setting time | ||
side | string | Side | ||
status | number | 1 Partial filled 2 Filled -1 Cancelled 0 NotTransaction(when the system type is not equal to 12) 0 is not trigger(when the system type is equal to 12ConditionalOrder) | ||
stopLimitType | number | ConditionalOrderType 0 -Stop-profit 1-Stop-loss 2-Trigger Order | ||
systemType | number | SystemType 10:Limit 11:Market12:ConditionalOrder 13:Forced Liquidation 14: Liquidation 15:Liquidation 16:ADL | ||
triggerDate | number | triggertime | ||
triggerPrice | string | triggerprice |
ContractNavigation
Name | Mandatory | Type | Description | Default Value | Remarks |
---|---|---|---|---|---|
amount24 | y | string | 24H Transaction (Cont) | ||
base | y | string | Base currency name | ||
code | y | string | Futurescode | ||
contractType | y | string | FuturesType,Swap-perpetual、 Delivery-deliver 、current weekDelivery-week、next weekDelivery-nextWeek、current quarterlyDelivery-quarter、next quarterlyDelivery-nextQuarter | ||
countDownTimeInterval | y | string | Countdown interval | ||
direction | y | integer | Side 0: Linear,1: Inverse | format: int32 | |
env | y | integer | testing or not 0:launched,1:test | format: int32 | |
fluctuation | y | string | Change | ||
fund | y | string | Funding rate | ||
high | y | string | Highest price | ||
indexBase | y | string | Indexcurrency | ||
indexPrice | y | string | IndexPrice | ||
lastCny | y | string | Last price equivalent to | ||
liquidationDate | y | string | Liquidation time | format: date-time | |
low | y | string | Lowest price | ||
makerRate | y | string | maker exchange rate | ||
marginDigit | y | integer | margin precision | format: int32 | |
markPrice | y | string | MarkPrice | ||
marketPriceDigit | y | integer | MarkPrice Min.Unit(precision) | format: int32 | |
maxLever | y | number | Max.Leverages | ||
minQuoteDigit | y | integer | QuotecurrencyMin. transactiondemical | format: int32 | |
minTradeDigit | y | integer | basecurrencyMin. transactiondemical | format: int32 | |
minTradeUnit | y | number | Min. transactionUnit | ||
nextLiquidationInterval | y | integer | Next liquidate time gap | format: int64 | |
openTradeTime | y | string | Opening Time | ||
price | y | string | Lastprice | ||
quote | y | string | Quote currency name | ||
size24 | y | string | 24H Transactionvalue | ||
sort | y | integer | Sort | format: int32 | |
takerRate | y | string | taker Exchange Rate | ||
totalPosition | y | string | HoldingVol. | ||
tradeStatus | y | integer | PublishStatus:1pre-publish,2Within 7 days after the launch,3.7 days after the launch | format: int32 | |
unitAmount | y | number | quote face value corresponding to a Futures,default1 |
OrderDealDetail
Name | Type | Description | Default Value | Remarks |
---|---|---|---|---|
dealAmount | string | Transaction Amount | ||
dealDate | string | Transaction Time | ||
fee | string | Fee |
LiquidateExplosionDetail
Name | Type | Description | Default Value | Remarks |
---|---|---|---|---|
contractCode | string | Futurescode | ||
explosionPrice | string | Bankruptcy price | ||
feeRate | string | Feerate | ||
lever | string | Leverages | ||
liquidatePrice | string | Forced liquidation price | ||
maintainRate | string | Maintenance margin rate | ||
price | string | OrderPrice | ||
side | string | Side |