private/get_position

Retrieves the open position for a specific instrument. Returns detailed position information including size, average entry price, mark price, unrealized P&L, initial margin, maintenance margin, and other position-related metrics.

If no position exists for the specified instrument, the response will indicate a zero position.

Scope: trade:read

Try in API console

cURL

cURL

curl --request GET \
  --url https://test.deribit.com/api/v2/private/get_position \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 404,
  "method": "private/get_position",
  "params": {
    "instrument_name": "BTC-PERPETUAL"
  }
}
'

200

{
  "jsonrpc": "2.0",
  "id": 404,
  "result": {
    "average_price": 0,
    "delta": 0,
    "direction": "buy",
    "estimated_liquidation_price": 0,
    "floating_profit_loss": 0,
    "index_price": 3555.86,
    "initial_margin": 0,
    "instrument_name": "BTC-PERPETUAL",
    "interest_value": 1.7362511643080387,
    "leverage": 100,
    "kind": "future",
    "maintenance_margin": 0,
    "mark_price": 3556.62,
    "open_orders_margin": 0.000165889,
    "realized_profit_loss": 0,
    "settlement_price": 3555.44,
    "size": 0,
    "size_currency": 0,
    "total_profit_loss": 0
  }
}

Query Parameters

instrument_name · string · required

Instrument name Unique instrument identifier

Example:

"BTC-PERPETUAL"

Response

200

application/json

Success response

jsonrpc · enum<string> · required

The JSON-RPC version (2.0)

Available options: 2.0

result · object · required

Hide child attributes

result. instrument_name · string · required

Unique instrument identifier

Example:

"BTC-PERPETUAL"

result. kind · enum<string> · required

Instrument kind: "future", "option", "spot", "future_combo", "option_combo"

Available options: future, option, spot, future_combo, option_combo

result. average_price · number · required

Average price of trades that built this position

result. direction · enum<string> · required

Direction: buy, sell or zero

Available options: buy, sell, zero

result. mark_price · number · required

Current mark price for position's instrument

result. delta · number · required

Delta parameter

result. index_price · number · required

Current index price

result. initial_margin · number · required

Initial margin

result. maintenance_margin · number · required

Maintenance margin

result. settlement_price · number · required

Optional (not added for spot). Last settlement price for position's instrument 0 if instrument wasn't settled yet

result. total_profit_loss · number · required

Profit or loss from position

result. floating_profit_loss · number · required

Floating profit or loss

result. realized_profit_loss · number · required

Realized profit or loss

result. size · number · required

Position size for futures size in quote currency (e.g. USD), for options size is in base currency (e.g. BTC)

result. estimated_liquidation_price · number · required

Estimated liquidation price, added only for futures, for users with segregated_sm margin model

result. open_orders_margin · number · required

Open orders margin

result. gamma · number

Only for options, Gamma parameter

result. vega · number

Only for options, Vega parameter

result. theta · number

Only for options, Theta parameter

result. size_currency · number

Only for futures, position size in base currency

result. average_price_usd · number

Only for options, average price in USD

result. floating_profit_loss_usd · number

Only for options, floating profit or loss in USD

result. leverage · integer

Current available leverage for future position

result. realized_funding · number

Realized Funding in current session included in session realized profit or loss, only for positions of perpetual instruments

result. interest_value · number

Value used to calculate realized_funding (perpetual only)

id · integer

The id that was sent in the request