Skip to content

Query Current Positions

Address: /openApi/contract/position

Receive Parameters

need

Submission Method: get

Submission Parameters

Parameter Name Required Type Example Description
symbol No string ETH-USDT Trading pair, not required for querying all
is_full No int 1 1 Margin 2 Full position

Response Parameters

Parameter Name Required Type Example Description
errno Yes int 0 Return Status Code
errmsg Yes string Success Return Information
result Yes object See example Return data

result parameters

Parameter Name Required Type Example Description
type Yes int 1 1 Long 2 Short
symbol Yes string ETH-USDT Trading Pair
lever_rate Yes int 10 Leverage ratio
amount Yes string 10 Holding Quantity
profit Yes string 10 Realized Profit and Loss
open_price_avg Yes string 0.3 Opening average price
bood Yes string 6 Frozen margin (USDT)
contract_frozen Yes string 5 Delegated freeze (in contracts)
settle_rate Yes string 0.1 Current funding settlement fee
equity Yes string 3.4 Account Equity (USDT)
avail Yes string 20 Available (USDT)
risk_rate Yes string 1.1 Risk Rate
liquidation_price Yes string 0.9 Liquidation Price
avail_amount Yes string 50 Available amount for closing (in contracts)
un_profit Yes string 0 Unrealized Profit/Loss

Return Example

JSON
{
    "errno": 0,
    "errmsg": "success",
    "result": [{
        "type": 1, //1 long position 2 short position
        "symbol": "ETH-USDT", //Trading Pair
        "lever_rate": 10, //Leverage ratio
        "amount": "10", //Holding quantity
        "profit": "10", //Realized profit and loss
        "open_price_avg": "0.3", //Average opening price
        "bood": "6", //Frozen Margin (usdt)
        "contract_frozen": "5", //Delegate frozen (in contracts)
        "settle_rate": "0.1", //Current capital settlement fee
        "equity": "3.4", //Account equity (usdt)
        "avail": "20", //Available (usdt)
        "risk_rate": "1.1", //Risk Rate
        "liquidation_price": "0.9", //Liquidation Price
        "avail_amount": "50", //Available amount for closing (in contracts)
        "unrealized_profit": "0" //Unrealized profit
    }]
}