Open Positions

This subscription feed publishes the open positions of the user account.

Request

string

required

subscribe or unsubscribe

string

required

The requested subscription feed. Value: open_positions

string

required

The user API key.

string

required

The message that is received from a challenge request.

string

required

The signed challenge message with user API secret.

{
  "event": "subscribe",
  "feed": "open_positions",
  "api_key": "CMl2SeSn09Tz+2tWuzPiPUjaXEQRGq6qv5UaexXuQ3SnahDQU/gO3aT+",
  "original_challenge": "226aee50-88fc-4618-a42a-34f7709570b2",
  "signed_challenge": "RE0DVOc7vS6pzcEjGWd/WJRRBWb54RkyvV+AZQSRl4+rap8Rlk64diR+Z9DQILm7qxncswMmJyvP/2vgzqqh+g=="
}

Response Success

string

One of: subscribed, subscribed_failed, unsubscribed, unsubscribed_failedThe result.

string

The requested subscription feed. Value: open_positions

string

The user API key.

string

The message that is received from a challenge request.

string

The signed challenge message with user API secret.

{
  "event": "subscribed",
  "feed": "open_positions",
  "api_key": "CMl2SeSn09Tz+2tWuzPiPUjaXEQRGq6qv5UaexXuQ3SnahDQU/gO3aT+",
  "original_challenge": "226aee50-88fc-4618-a42a-34f7709570b2",
  "signed_challenge": "RE0DVOc7vS6pzcEjGWd/WJRRBWb54RkyvV+AZQSRl4+rap8Rlk64diR+Z9DQILm7qxncswMmJyvP/2vgzqqh+g=="
}

Response Snapshot

string

The subscribed feed.

string

The user account.

positive integer

The subscription message sequence number.

positive integer

The UTC time in milliseconds.

list of structures

A list containing the user open positions.

Show properties

string

The instrument (referred also as symbol or product_id) of the order.

float

The size of the position.

positive float

The average entry price of the instrument.

positive float

The market price of the position instrument.

positive float

The index price of the position instrument.

float

The profit and loss of the position.

float

The mark price of the contract at which the position will be liquidated.

float

The percentage gain or loss relative to the initial margin used in the position. Formula: PnL/IM.

float

Unrealised funding from funding rate.

float

How leveraged the net position is in a given margin account. Formula: Position Value at Market / Portfolio Value.

float

The initial margin for the open position.

float

The initial margin for the open position and open orders of the same instrument.

float

The maintenance margin for the open position.

string

The profit currency for the position, not returned for inverse positions.

positive float

The maximum allowed fixed leverage for the position’s instrument.

ISO8601 datetime

The time the most recent fill occurred for this position.

float

The option’s implied volatility.

float

Delta, the option value’s sensitivity to change in the underlying price.

float

Theta, the option value’s sensitivity to the passage of time.

float

Gamma, delta’s sensitivity to change in the underlying price.

float

Vega, the option value’s sensitivity to change in volatility.

float

Rho, the option value’s sensitivity to the interest rate.

{
  "feed": "open_positions",
  "account": "DemoUser",
  "positions": [
    {
      "instrument": "PF_XRPUSD",
      "balance": 500.0,
      "pnl": -239.6506683474764,
      "entry_price": 0.3985,
      "mark_price": 0.4925844,
      "index_price": 0.49756,
      "liquidation_threshold": 0.0,
      "effective_leverage": 0.17404676894304316,
      "return_on_equity": -2.3609636135508127,
      "initial_margin": 101.5054475943615,
      "initial_margin_with_orders": 101.5054475943615,
      "maintenance_margin": 50.75272379718075
    },
    {
      "instrument": "PF_XBTUSD",
      "balance": 0.04,
      "pnl": 119.56244985549435,
      "entry_price": 26911.75,
      "mark_price": 29900.81124638736,
      "index_price": 29900.47,
      "liquidation_threshold": 9572.804662403718,
      "effective_leverage": 0.31865408963748215,
      "return_on_equity": 5.553450159107747,
      "unrealized_funding": 0.0004114160669590132,
      "initial_margin": 21.529400000000003,
      "initial_margin_with_orders": 21.529400000000003,
      "maintenance_margin": 10.764700000000001,
      "pnl_currency": "USD"
    },
    {
      "instrument": "OF_ETHUSD_240101_1000_C",
      "balance": 0.04,
      "pnl": 119.56244985549435,
      "entry_price": 26911.75,
      "mark_price": 29900.81124638736,
      "index_price": 29900.47,
      "return_on_equity": 5.553450159107747,
      "iv": 0.3,
      "delta": 0.5,
      "gamma": 0.5,
      "vega": 0.5,
      "theta": 0.5,
      "rho": 0.5
    }
  ],
  "seq": 4,
  "timestamp": 1687383625330
}

Response Error

string

Value: error

string

One of: Invalid product id, Invalid feed, Json ErrorAn error message.

{
  "event": "error",
  "message": "Invalid product id"
}

Public Channels

Private Channels

Authentication

Request

Response Success

Response Snapshot

Response Error

​Request

​Response Success

​Response Snapshot

​Response Error

Request

Response Success

Response Snapshot

Response Error