Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.wooxpro.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Get Current Position Risk Details(KEYED)

Applicable for checking the position risk details a specified contract

​
Request URL

GET https://cloud-api.wooxpro.com/contract/private/position-risk

​
Request Limit

See Detailed Rate Limit

​
Request Parameter

Request 
curl -H 'X-BM-KEY:{{AccessKey}}'
https://cloud-api.wooxpro.com/contract/private/position-risk?symbol=BTCUSDT
FieldTypeRequired?Description
symbolStringNoSymbol of the contract(like BTCUSDT)
accountStringNoTrading account
-futures
-copy_trading

​
Response Data

Response 
{
  "code": 1000,
  "message": "Ok",
  "data": [
    {
      "symbol":"BTCUSDT",
      "position_amt":"1",
      "mark_price":"67957.7",
      "unrealized_profit":"969.6",
      "liquidation_price":"64245",
      "leverage":"20",
      "max_notional_value":"3000000",
      "margin_type":"Isolated",
      "isolated_margin":"3078.51948691",
      "position_side":"Long",
      "notional":"66988.1",
      "update_time":1712390438,
      "account": "futures"
    }
  ],
  "trace": "ae96cae5-1f09-4ea5-971e-4474a6724bc8"
}
字段类型描述
symbolStringSymbol of the contract(like BTCUSDT)
position_amtStringPosition amount
mark_priceStringMark Price of the contract
unrealized_profitStringUnrealized profit of the position
liquidation_priceStringLiquidationPrice of the position
leverageStringPosition leverage
max_notional_valueStringMaximum notional value for the current risk level
margin_typeStringMargin type of the position
-Cross
-Isolated
isolated_marginStringMargin for the isolated position
position_sideStringPosition side
-Long
-Short
notionalStringnotional = position_amt*mark_Price
accountStringTrading account
-futures
-copy_trading
update_timeLongUnix timestamp in milliseconds for when the last updated time occurred