Contract API EN

Base Url
The base url of broker open API can be found here​
Broker Contract Public Endpoint
brokerInfo
Current broker trading rules and symbol information.
Request Weight:
0
Request Url:
GET /openapi/v1/brokerInfo
Parameters：
name
type
required
default
description
type
string
NO
​
Trading section information. Possible values include token, options, and contracts. If the parameter is not sent, all trading information will be returned.
Response:
name
type
example
description
timezone
string
UTC
Timezone of timestamp
serverTime
long
1554887652929
Retrieves the current time on server (in ms).
In the rateLimits field: Order api request limit will be displayed.
name
type
example
description
rateLimitType
string
ORDERS
Rate Limit type
interval
string
SECOND
Rate Limit interval
limit
string
1500
Rate Limit value within the interval.
In the contracts field: All actively trading contracts will be displayed.
name
type
example
description
symbol
string
BTCUSD
Name of the contract.
status
string
TRADING
Status of the contract.
baseAsset
string
BTCUSD
Base Asset of the trading pair. In the case with contracts, the contract itself is the base asset.
baseAssetPrecision
float
0.001
Precision of the contract quantity (baseAsset).
quoteAsset
string
USDT
Quote asset for the contract. Meaning the contract is quoted in that currency.
quoteAssetPrecision
float
0.001
Precision of the contract price (quoteAsset).
inverse
bool
true
Whether the contract is inverse.
index
string
BTCUSDT
Index symbol of the underlying asset. Index price can be accessed at the index endpoint. For instance, BTC-PERP-REV uses BTCUSDT for index price.
contractMultiplier
string
true
The multiplier of contract.
icebergAllowed
string
false
Whether iceberg orders are allowed.
For filters in contracts field:
name
type
example
description
filterType
string
PRICE_FILTER
Type of the filter.
minPrice
float
0.001
Minimum price allowed
maxPrice
float
100000.00000000
Maximum price allowed
tickSize
float
0.001
Precision of the contract price.
minQty
float
0.01
Minimum quantity allowed
maxQty
float
100000.00000000
Maximum quantity allowed
stepSize
float
0.001
Precision of the contract quantity
minNotional
float
1
Minimum trade size (quantity * price)
In the riskLimits filed:
name
type
example
description
quantity
float
100
Positions below this amount follows the following requirement.
initialMargin
float
0.1
Initial margin rate requirement.
maintMargin
float
0.03
Minimum maintenance margin rate requirement.
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"
        }
      ]
    }
  ]
}
insurance (PENDING)
Get current insurance funding.
Request Weight:
0
Request Url:
GET /openapi/contract/v1/insurance
Parameters：
name
type
required
default
description
symbol
string
NO
​
Input specific symbol to return the corresponding records. If not entered, records for all symbols will be returned.
fromId
long
NO
​
pagination,    return record which id < fromId
toId
long
NO
​
pagination, return record which id > toId. If toId is given, toId cannot be 0.
limit
integer
NO
20
Number of entries returned.
Response:
name
type
example
description
id
long
1552272184833
The ID of the record.
timestamp
long
155227218483
current server timestamp.
value
float
23.23
Balance of the insurance fund.
unit
string
BTC
Unit of the balance..
{
  "BTC":[
    {
      "id": 1552272184833,
      "timestamp": 155227218483,
      "value": 23.23,
      "unit": "BTC"
    },...
  ],...
}
index
Underlying asset index price.
Request Weight:
0
Request Url:
GET /openapi/quote/v1/contract/index
Parameters：
name
type
required
default
description
symbol
string
NO
​
Underlying index symbol. If this parameter is not sent, all symbols
will be returned.
Response:
name
type
example
description
index
float
8342.73
The index price of the instrument.
EDP
float
8432.32
The EDP (estimated delivery price of the contract). The average price of the index in the last 1o minutes. This will be the price on which the contract is going to be settled.
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
Get current funding rate (historical in process)
Request Weight:
0
Request Url:
GET /openapi/contract/v1/fundingRate
Parameters：
name
type
required
default
description
symbol
string
NO
​
The contract to be returned. If not sent, records for all symbols will be returned as a result.
state
string
NO
current
Get current or past funding rate.
from
long
NO
​
Timestamp to start.
to
long
NO
​
Timestamp to end.
limit
integer
NO
20
Number of entries returned.
Response:
name
type
example
description
symbol
string
BTCUSD
Name of the contracts
intervalStart
long
1554710400000
Timestamp when the interval started.
intervalEnd
long
1554710400000
Timestamp when the interval ended.
rate
float
0.00321
The funding rate of this interval.
index
float
10076.34
Index price at the time of settlement.
Example:
[
  {
    'symbol': 'BTC-PERP-REV',
    'intervalStart': '1570708800000',
    'intervalEnd': '1570737600000',
    'rate': '-0.000048567445464006'
  },...
]
depth
Retrieves the contracts order book.
Request Weight:
Adjusted based on the limit:
Limit
Weight
5, 10, 20, 50, 100
1
500
5
1000
10
Request Url:
GET /openapi/quote/v1/contract/depth
Parameters:
parameter
type
required
default
description
symbol
string
YES
​
The contract name for which to retrieve the order book
limit
integer
NO
100 (max = 100)
The number of entries to return for bids and asks.
Response:
name
type
example
description
time
long
1550829103981
Current timestamp (ms)
bids
list
(see below)
List of all bids, best bids first. See below for entry details.
asks
list
(see below)
List of all asks, best asks first. See below for entry details.
The fields bids and asks are lists of orderbook price level entries, sorted from best to worst.
name
type
example
description
''
float
123.10
price level
''
float
300
The total quantity of orders for this price level
Example:
{
  "time": 1555049455783,
  "bids": [
   ["78.82", "0.526"],//[Price, Quantity]
   ["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"],//[Price, Quantity]
     ["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
Retrieve the latest trades that have occurred for a specific contract.
Request Weight:
1
Request URL:
GET /openapi/quote/v1/contract/trades
Parameters：
Parameter
type
required
default
description
symbol
string
YES
​
The name of the contract.
limit
integer
NO (clamped to max 1000)
100
The number of trades returned
Response:
name
type
example
description
price
float
0.055
The price of the trade
time
long
1537797044116
Current timestamp (ms)
qty
float
5
The quantity traded
isBuyerMaker
string
true
Maker or taker of the trade. true= maker, false = taker
Example:
[
  {
    "price": "1.21",
    "time": 1555034474064,
    "qty": "0.725",
    "isBuyerMaker": False
  },...
]
klines
Retrieves the kline information (open, high, trade volume, etc.) for a specific contract.
Request Weight:
1
Request URL:
GET /openapi/quote/v1/contract/klines
Parameters：
Parameter
type
required
default
description
symbol
string
YES
​
Name of the contract.
interval
string
YES
​
Interval of the kline. Possible values include: 1m,5m,15m,30m,1h,1d,1w,1M
limit
integer
NO
1000
Number of entries returned. Max is capped at 1000.
to
integer
NO
​
timestamp of the last datapoint
Response:
name
type
example
description
''
long
1538728740000
Open Time
''
float
36.00000
Open
''
float
36.00000
High
''
float
36.00000
Low
''
float
36.00000
Close
''
float
148976.11427815
Trade volume amount
''
long
1538728740000
Close time
''
float
2434.19055334
Quote asset volume
''
integer
308
Number of trades
''
float
1756.87402397
Taker buy base asset volume
''
float
28.46694368
Taker buy quote asset volume
Example:
[
  [
    1538728740000, //'opentime'
    "36.000000000000000000", //'open'
    "36.000000000000000000", //'high'
    "36.000000000000000000", //'low':
    "36.000000000000000000", //'close'
    "148976.11427815",  // Volume
    1499644799999,      // Close time
    "2434.19055334",    // Quote asset volume
    308,                // Number of trades
    "1756.87402397",    // Taker buy base asset volume
    "28.46694368"       // Taker buy quote asset volume
  ],...
]
base asset means the quantity is expressed as the amount of contracts that were received by the buyer.
quote asset means the amount of tokens paid to acquire the contracts.
Private Endpoints
order
Places order for a contract. This API endpoint requires your request to be signed.
Request Weight:
1
Request URL:
POST /openapi/contract/v1/order
Parameters：
Parameter
type
required
default
description
symbol
string
YES
​
Name of the contract.
side
string
YES
​
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
quantity
float
YES
​
The number of contracts to buy.
leverage
float
YES(NOT REQUIRED for *_CLOSE" orders)
​
Leverage of the order.
price
float
NO. REQUIRED for (LIMIT & INPUT) orders
​
Price of the order
priceType
string
NO
INPUT
The price type, possible types include: INPUT, OPPONENT, QUEUE, OVER, and MARKET.
triggerPrice
float
NO. REQUIRED for STOP orders.
​
The price at which the trigger order will be executed.
timeInForce
string
NO
GTC
Time in force for LIMIT orders. Possible values include GTC,FOK,IOC,LIMIT_MAKER.
clientOrderId
string/long
YES
​
A unique ID of the order (user defined)
NOTE For Market Orders, you need to set orderType as LIMIT AND priceType as MARKET.
You can get contracts' price, quantity precision configuration data in the brokerInfo endpoint.
Note: if your balance does not meet the margin requirement (which is the minimum margin requirement + open position fee + close position fee), "insufficient balance" error message will be returned.
For detailed information regarding various price types and order types. Please refer to the explanation section in the end.
Response:
Name
type
example
description
time
long
1570759718825
Timestamp when the order is created.
updateTime
long
1551062936784
Last time this order was updated
orderId
integer
469961015902208000
ID of the order.
clientOrderId
string
213443
A unique ID of the order.
symbol
string
BTC-PERP-REV
Name of the contract.
price
float
8200
Price of the order.
leverage
float
4
Leverage of the order.
origQty
float
1.01
Quantity ordered
executedQty
float
1.01
Quantity of orders that has been executed
avgPrice
float
4754.24
Average price of filled orders.
marginLocked
float
200
Amount of margin locked for this order. This includes the actually margin needed plus fees to open and close the position.
orderType
string
YES
The order type, possible types: LIMIT, STOP
priceType
string
INPUT
The price type. Possible values include INPUT, OPPONENT, QUEUE, OVER, and MARKET.
side
string
BUY
Direction of the order. Possible values include BUY_OPEN, SELL_OPEN, BUY_CLOSE, and SELL_CLOSE.
status
string
NEW
The state of the order.Possible values include NEW, PARTIALLY_FILLED, FILLED, CANCELED, and REJECTED.
timeInForce
string
GTC
Time in force. Possible values include GTC,FOK,IOC, and LIMIT_MAKER
fees
​
​
Fees incurred for this order.
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
Cancels an order, specified by orderId or clientOrderId. This API endpoint requires your request to be signed.
Request Weight:
1
Request Url:
DELETE /openapi/contract/v1/order/cancel
Parameter:
Parameter
type
required
default
description
orderId
integer
NO
​
The order ID of the order to be canceled
clientOrderId
string
NO
​
Unique client customized ID of the order.
orderType
string
YES
​
The order type, possible types: LIMIT and STOP.
One MUST be provided for either of these two parameters.
Response:
Name
type
example
description
time
long
1551062936784
Timestamp when the order is created.
updateTime
long
1551062936784
Last time this order was updated
orderId
integer
891
ID of the order.
clientOrderId
string
213443
A unique ID of the order.
symbol
string
BTC-PERP-REV
Name of the contract.
price
float
4765.29
Price of the order.
leverage
float
4
Leverage of the order.
origQty
float
1.01
Quantity ordered
executedQty
float
1.01
Quantity of orders that has been executed
avgPrice
float
4754.24
Average price of filled orders.
marginLocked
float
200
Amount of margin locked for this order. This includes the actually margin needed plus fees to open and close the position.
orderType
string
LIMIT
The order type, possible types: LIMIT and STOP.
priceType
string
INPUT
The price type. Possible values include INPUT, OPPONENT, QUEUE, OVER, and MARKET.
side
string
BUY_OPEN
Direction of the order. Possible values include BUY_OPEN, BUY_CLOSE, SELL_OPEN and SELL_CLOSE
status
string
NEW
The state of the order.Possible values include NEW, PARTIALLY_FILLED, FILLED, CANCELED, and REJECTED.
timeInForce
string
GTC
Time in force. Possible values include GTC,FOK,IOC, and LIMIT_MAKER
fees
​
​
Fees incurred for this order.
In the fees field:
Name
type
example
description
feeToken
string
USDT
Fee token kind.
fee
float
0
Actual transaction fees occurred.
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
Cancel orders en masse. (PENDING: batch cancel for STOP orders)
Request Weight:
1
Request Url:
DELETE /openapi/contract/v1/order/batchCancel
Parameter:
Parameter
type
required
default
description
symbol
string/list
NO
​
The symbol ids of the cancel orders
Response:
Name
type
example
description
message
string
success
The message response of the cancel request.
timestamp
long
1541161088303
The timestamp when the response is returned.
Example:
{
  'message':'success',
  'timestamp':1541161088303
}
openOrders
Retrieves open orders. This API endpoint requires your request to be signed.
Request Weight:
1
Request Url:
GET /openapi/contract/v1/openOrders
Parameters:
Parameter
type
required
default
description
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 and 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:
Name
type
example
description
time
long
1551062936784
Timestamp when the order is created.
updateTime
long
1551062936784
Last time this order was updated
orderId
integer
891
ID of the order.
clientOrderId
string
213443
A unique ID of the order.
symbol
string
BTC-PERP-REV
Name of the contracts.
price
float
4765.29
Price of the order.
leverage
float
4
Leverage of the order.
origQty
float
1.01
Quantity ordered
executedQty
float
1.01
Quantity of orders that has been executed
avgPrice
float
4754.24
Average price of filled orders.
marginLocked
float
200
Amount of margin locked for this order. This includes the actually margin needed plus fees to open and close the position.
orderType
string
LIMIT
The order type, possible types: LIMIT and STOP.
priceType
string
INPUT
The price type. Possible values include INPUT, OPPONENT, QUEUE, OVER, and MARKET.
side
string
BUY_OPEN
Direction of the order. Possible values include BUY_OPEN, SELL_OPEN, BUY_CLOSE, and SELL_CLOSE.
status
string
NEW
The state of the order.Possible values include NEW, PARTIALLY_FILLED, FILLED, CANCELED, and REJECTED.
timeInForce
string
GTC
Time in force. Possible values include GTC,FOK,IOC, and LIMIT_MAKER.
fees
​
​
Fees incurred for this order.
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:
Parameter
type
required
default
description
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:
Name
type
example
description
time
long
1551062936784
Timestamp when the order is created.
updateTime
long
1551062936784
Last time this order was updated
orderId
integer
891
ID of the order.
clientOrderId
string
213443
A unique ID of the order.
symbol
string
BTC-PERP-REV
Name of the contracts.
price
float
4765.29
Price of the order.
leverage
float
4
Leverage of the order.
origQty
float
1.01
Quantity ordered
executedQty
float
1.01
Quantity of orders that has been executed
avgPrice
float
4754.24
Average price of filled orders.
marginLocked
float
200
Amount of margin locked for this order. This includes the actually margin needed plus fees to open and close the position.
orderType
string
LIMIT
The order type, possible types: LIMIT and STOP.
priceType
string
INPUT
The price type. Possible values include INPUT, OPPONENT, QUEUE, OVER, and MARKET.
side
string
BUY_OPEN
Direction of the order. Possible values include BUY_OPEN, SELL_OPEN, BUY_CLOSE, and SELL_CLOSE.
status
string
NEW
The state of the order.Possible values include NEW, PARTIALLY_FILLED, FILLED, CANCELED, and REJECTED.
timeInForce
string
GTC
Time in force. Possible values include GTC,FOK,IOC, and LIMIT_MAKER.
fees
​
​
Fees incurred for this order.
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
Get details on a specific order, regardless of order state.
Request Weight:
1
Request Url:
GET /openapi/contract/v1/getOrder
Parameters:
Parameter
type
required
default
description
orderId
integer
NO
​
Order ID.
clientOrderId
string
NO
​
Unique client customized ID of the order.
orderType
string
YES
​
The order type, possible types: LIMIT, STOP
Either orderId or clientOrderId must be sent
Response:
Name
type
example
description
time
long
1551062936784
Timestamp when the order is created.
updateTime
long
1551062936784
Last time this order was updated
orderId
integer
891
ID of the order.
clientOrderId
string
213443
A unique ID of the order.
symbol
string
BTC-PERP-REV
Name of the contracts.
price
float
4765.29
Price of the order.
leverage
float
4
Leverage of the order.
origQty
float
1.01
Quantity ordered
executedQty
float
1.01
Quantity of orders that has been executed
avgPrice
float
4754.24
Average price of filled orders.
marginLocked
float
200
Amount of margin locked for this order. This includes the actually margin needed plus fees to open and close the position.
orderType
string
LIMIT
The order type, possible types: LIMIT and STOP.
priceType
string
INPUT
The price type. Possible values include INPUT, OPPONENT, QUEUE, OVER, and MARKET.
side
string
BUY_OPEN
Direction of the order. Possible values include BUY_OPEN, SELL_OPEN, BUY_CLOSE, and SELL_CLOSE.
status
string
NEW
The state of the order.Possible values include NEW, PARTIALLY_FILLED, FILLED, CANCELED, and REJECTED.
timeInForce
string
GTC
Time in force. Possible values include GTC,FOK,IOC, and LIMIT_MAKER.
fees
​
​
Fees incurred for this order.
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
Retrieve the trade history of the account. This API endpoint requires your request to be signed.
Request Weight:
1
Request Url:
GET /openapi/contract/v1/myTrades
Parameters:
Parameter
type
required
default
description
symbol
string
NO
​
Name of the contract. If not sent, trades for all symbols will be returned.
limit
integer
NO
20
The number of trades returned (clamped to max 1000)
side
string
NO
​
Direction of the order.
fromId
integer
NO
​
TradeId to fetch from.
toId
integer
NO
​
TradeId to fetch to.
Response:
Name
type
example
description
time
long
1551062936784
Timestamp when the order is created.
tradeId
long
49366
The ID for the trade
orderId
integer
891
ID of the order.
matchOrderId
long
630491432
ID of the match order.
symbolId
string
BTC-PERP-REV
Name of the contract.
price
float
4765.29
Price of the trade.
quantity
float
1.01
Quantity of the trade.
feeTokenId
string
USDT
Fee token name.
fee
​
​
Fee of the trade.
side
string
BUY
Direction of the order. Possible values include BUY_OPEN, SELL_OPEN, BUY_CLOSE, and SELL_CLOSE.
orderType
string
LIMIT
The order type, possible types: 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
Retrieves current positions. This API endpoint requires your request to be signed.
Request Weight:
1
Request Url:
GET /openapi/contract/v1/positions
Parameters:
Parameter
type
required
default
description
symbol
string
NO
​
Name of the contract. If not sent, positions for all contracts will be returned.
side
string
NO
​
LONG or SHORT. Direction of the position. If not sent, positions for both sides will be returned.
Response:
Name
type
example
description
symbol
string
BTC-PERP-REV
Name of the contract.
side
string
LONG
Position side.
avgPrice
float
100
Average price for opening the position.
position
float
20
Amount of contracts opened
available
float
15
Amount of contracts available to close.
leverage
float
5
Leverage of the position
lastPrice
float
100
Last trade price of the symbol.
positionValue
float
2000
Current position value.
flp
float
80
Forced liquidation price.
margin
float
20
Margin for this position.
marginRate
float
0.2
Margin rate for current position.
unrealizedPnL
float
0.0
Unrealized profit and loss for current position held.
profitRate
float
0.0000333
Rate of return for the position.
realizedPnL
float
6.8
Cumulative realized profit and loss for this symbol.
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': 

Parameter	type	required	default	description
`symbol`	string	`YES`		Name of the contract.
`side`	string	`YES`		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`
`quantity`	float	`YES`		The number of contracts to buy.
`leverage`	float	`YES`(NOT REQUIRED for *_CLOSE" orders)		Leverage of the order.
`price`	float	`NO`. REQUIRED for (`LIMIT` & `INPUT`) orders		Price of the order
`priceType`	string	`NO`	`INPUT`	The price type, possible types include: `INPUT`, `OPPONENT`, `QUEUE`, `OVER`, and `MARKET`.
`triggerPrice`	float	`NO`. REQUIRED for `STOP` orders.		The price at which the trigger order will be executed.
`timeInForce`	string	`NO`	`GTC`	Time in force for `LIMIT` orders. Possible values include `GTC`,`FOK`,`IOC`,`LIMIT_MAKER`.
`clientOrderId`	string/long	`YES`		A unique ID of the order (user defined)

Name	type	example	description
`time`	long	`1570759718825`	Timestamp when the order is created.
`updateTime`	long	`1551062936784`	Last time this order was updated
`orderId`	integer	`469961015902208000`	ID of the order.
`clientOrderId`	string	`213443`	A unique ID of the order.
`symbol`	string	`BTC-PERP-REV`	Name of the contract.
`price`	float	`8200`	Price of the order.
`leverage`	float	`4`	Leverage of the order.
`origQty`	float	`1.01`	Quantity ordered
`executedQty`	float	`1.01`	Quantity of orders that has been executed
`avgPrice`	float	`4754.24`	Average price of filled orders.
`marginLocked`	float	`200`	Amount of margin locked for this order. This includes the actually margin needed plus fees to open and close the position.
`orderType`	string	`YES`	The order type, possible types: `LIMIT`, `STOP`
`priceType`	string	`INPUT`	The price type. Possible values include `INPUT`, `OPPONENT`, `QUEUE`, `OVER`, and `MARKET`.
`side`	string	`BUY`	Direction of the order. Possible values include `BUY_OPEN`, `SELL_OPEN`, `BUY_CLOSE`, and `SELL_CLOSE`.
`status`	string	`NEW`	The state of the order.Possible values include `NEW`, `PARTIALLY_FILLED`, `FILLED`, `CANCELED`, and `REJECTED`.
`timeInForce`	string	`GTC`	Time in force. Possible values include `GTC`,`FOK`,`IOC`, and `LIMIT_MAKER`
`fees`			Fees incurred for this order.

Name	type	example	description
`time`	long	`1551062936784`	Timestamp when the order is created.
`updateTime`	long	`1551062936784`	Last time this order was updated
`orderId`	integer	`891`	ID of the order.
`clientOrderId`	string	`213443`	A unique ID of the order.
`symbol`	string	`BTC-PERP-REV`	Name of the contract.
`price`	float	`4765.29`	Price of the order.
`leverage`	float	`4`	Leverage of the order.
`origQty`	float	`1.01`	Quantity ordered
`executedQty`	float	`1.01`	Quantity of orders that has been executed
`avgPrice`	float	`4754.24`	Average price of filled orders.
`marginLocked`	float	`200`	Amount of margin locked for this order. This includes the actually margin needed plus fees to open and close the position.
`orderType`	string	`LIMIT`	The order type, possible types: `LIMIT` and `STOP`.
`priceType`	string	`INPUT`	The price type. Possible values include `INPUT`, `OPPONENT`, `QUEUE`, `OVER`, and `MARKET`.
`side`	string	`BUY_OPEN`	Direction of the order. Possible values include `BUY_OPEN`, `BUY_CLOSE`, `SELL_OPEN` and `SELL_CLOSE`
`status`	string	`NEW`	The state of the order.Possible values include `NEW`, `PARTIALLY_FILLED`, `FILLED`, `CANCELED`, and `REJECTED`.
`timeInForce`	string	`GTC`	Time in force. Possible values include `GTC`,`FOK`,`IOC`, and `LIMIT_MAKER`
`fees`			Fees incurred for this order.

Name	type	example	description
`time`	long	`1551062936784`	Timestamp when the order is created.
`updateTime`	long	`1551062936784`	Last time this order was updated
`orderId`	integer	`891`	ID of the order.
`clientOrderId`	string	`213443`	A unique ID of the order.
`symbol`	string	`BTC-PERP-REV`	Name of the contracts.
`price`	float	`4765.29`	Price of the order.
`leverage`	float	`4`	Leverage of the order.
`origQty`	float	`1.01`	Quantity ordered
`executedQty`	float	`1.01`	Quantity of orders that has been executed
`avgPrice`	float	`4754.24`	Average price of filled orders.
`marginLocked`	float	`200`	Amount of margin locked for this order. This includes the actually margin needed plus fees to open and close the position.
`orderType`	string	`LIMIT`	The order type, possible types: `LIMIT` and `STOP`.
`priceType`	string	`INPUT`	The price type. Possible values include `INPUT`, `OPPONENT`, `QUEUE`, `OVER`, and `MARKET`.
`side`	string	`BUY_OPEN`	Direction of the order. Possible values include `BUY_OPEN`, `SELL_OPEN`, `BUY_CLOSE`, and `SELL_CLOSE`.
`status`	string	`NEW`	The state of the order.Possible values include `NEW`, `PARTIALLY_FILLED`, `FILLED`, `CANCELED`, and `REJECTED`.
`timeInForce`	string	`GTC`	Time in force. Possible values include `GTC`,`FOK`,`IOC`, and `LIMIT_MAKER`.
`fees`			Fees incurred for this order.

Name	type	example	description
`time`	long	`1551062936784`	Timestamp when the order is created.
`updateTime`	long	`1551062936784`	Last time this order was updated
`orderId`	integer	`891`	ID of the order.
`clientOrderId`	string	`213443`	A unique ID of the order.
`symbol`	string	`BTC-PERP-REV`	Name of the contracts.
`price`	float	`4765.29`	Price of the order.
`leverage`	float	`4`	Leverage of the order.
`origQty`	float	`1.01`	Quantity ordered
`executedQty`	float	`1.01`	Quantity of orders that has been executed
`avgPrice`	float	`4754.24`	Average price of filled orders.
`marginLocked`	float	`200`	Amount of margin locked for this order. This includes the actually margin needed plus fees to open and close the position.
`orderType`	string	`LIMIT`	The order type, possible types: `LIMIT` and `STOP`.
`priceType`	string	`INPUT`	The price type. Possible values include `INPUT`, `OPPONENT`, `QUEUE`, `OVER`, and `MARKET`.
`side`	string	`BUY_OPEN`	Direction of the order. Possible values include `BUY_OPEN`, `SELL_OPEN`, `BUY_CLOSE`, and `SELL_CLOSE`.
`status`	string	`NEW`	The state of the order.Possible values include `NEW`, `PARTIALLY_FILLED`, `FILLED`, `CANCELED`, and `REJECTED`.
`timeInForce`	string	`GTC`	Time in force. Possible values include `GTC`,`FOK`,`IOC`, and `LIMIT_MAKER`.
`fees`			Fees incurred for this order.