Get open positions

GET /v1/positions

Get current open positions across all or single exchange.

Query Parameters

exchange_id string
Filter the balances to the specific exchange.

Responses

Collection of positons.

application/json

Schema
Example (from schema)

Schema

Array [
exchange_id string
Exchange identifier used to identify the routing destination.
data object[]
Array [
symbol_id_exchange string
Exchange symbol.
symbol_id_coinapi string
CoinAPI symbol.
avg_entry_price number
Calculated average price of all fills on this position.
quantity number
The current position quantity.
side OrdSide
Possible values: [BUY, SELL]
Side of order.
unrealized_pnl number
Unrealised profit or loss (PNL) of this position.
leverage number
Leverage for this position reported by the exchange.
cross_margin boolean
Is cross margin mode enable for this position?
liquidation_price number
Liquidation price. If mark price will reach this value, the position will be liquidated.
raw_data object
]
]

[
  {
    "exchange_id": "KRAKEN",
    "data": [
      {
        "symbol_id_exchange": "XBTUSD",
        "symbol_id_coinapi": "BITMEX_PERP_BTC_USD",
        "avg_entry_price": 0.00134444,
        "quantity": 7,
        "side": "BUY",
        "unrealized_pnl": 0,
        "leverage": 0,
        "cross_margin": true,
        "liquidation_price": 0.072323,
        "raw_data": "Other information provided by the exchange on this position."
      }
    ]
  }
]

Exchange is unreachable.

appliction/json

Schema
Example (from schema)

Schema

type string
Message type, constant.
reject_reason RejectReason
Possible values: [OTHER, EXCHANGE_UNREACHABLE, EXCHANGE_RESPONSE_TIMEOUT, ORDER_ID_NOT_FOUND, INVALID_TYPE, METHOD_NOT_SUPPORTED, JSON_ERROR]
Cause of rejection.
exchange_id string
If the message related to exchange, then the identifier of the exchange will be provided.
message string
Message text.
rejected_message string
Value of rejected request, if available.

{
  "type": "MESSAGE_REJECT",
  "reject_reason": "ORDER_ID_NOT_FOUND",
  "exchange_id": "BINANCE",
  "message": "Order with ID: BINANCE-7d8a-4888 not found",
  "rejected_message": "{\"client_order_id\":\"BINANCE-7d8a-4888\",\"exchange_id\":\"BINANCE\",\"type\":\"ORDER_CANCEL_SINGLE_REQUEST\"}"
}

Was this section helpful?