Sign in

v1

latestSwagger 2.02026-07-179553242.0 KB
Position

Get your positions.

This endpoint is used for retrieving position information. The fields largely follow the FIX spec definitions. Some selected fields are explained in more detail below.

The fields account, symbol, currency are unique to each position and form its key.

Spot trading symbols returns a subset of the position fields, mainly the open order aggregates.

  • account: Your unique account ID.
  • symbol: The contract for this position.
  • currency: The margin currency for this position.
  • underlying: Meta data of the symbol.
  • quoteCurrency: Meta data of the symbol, All prices are in the quoteCurrency
  • commission: The maximum of the maker, taker, and settlement fee.
  • initMarginReq: The initial margin requirement. This will be at least the symbol's default initial maintenance margin, but can be higher if you choose lower leverage.
  • maintMarginReq: The maintenance margin requirement. This will be at least the symbol's default maintenance maintenance margin, but can be higher if you choose a higher risk limit.
  • riskLimit: This is a function of your maintMarginReq.
  • leverage: 1 / initMarginReq.
  • crossMargin: True/false depending on whether you set cross margin on this position.
  • deleveragePercentile: Indicates where your position is in the ADL queue.
  • rebalancedPnl: The value of realised PNL that has transferred to your wallet for this position.
  • prevRealisedPnl: The value of realised PNL that has transferred to your wallet for this position since the position was closed.
  • currentQty: The current position amount in contracts.
  • currentCost: The current cost of the position in the settlement currency of the symbol (currency).
  • currentComm: The current commission of the position in the settlement currency of the symbol (currency).
  • realisedCost: The realised cost of this position calculated with regard to average cost accounting.
  • unrealisedCost: currentCost - realisedCost.
  • grossOpenPremium: The amount your bidding above the mark price in the settlement currency of the symbol (currency).
  • markPrice: The mark price of the symbol in quoteCurrency.
  • markValue: The currentQty at the mark price in the settlement currency of the symbol (currency).
  • homeNotional: Value of position in units of underlying.
  • foreignNotional: Value of position in units of quoteCurrency.
  • realisedPnl: The negative of realisedCost.
  • unrealisedPnl: unrealisedGrossPnl.
  • liquidationPrice: Once markPrice reaches this price, this position will be liquidated.
  • bankruptPrice: Once markPrice reaches this price, this position will have no equity.
get/position

Query parameters

filterstring JSON

Table filter. For example, send {"symbol": "XBTUSD"}.

columnsstring JSON

Which columns to fetch. For example, send ["columnName"].

countinteger

Number of rows to fetch.

Response

Request was successful

accountinteger required
symbolstring required
currencystring
underlyingstring
quoteCurrencystring
commissionnumber double
initMarginReqnumber double
maintMarginReqnumber double
riskLimitinteger
leveragenumber double
crossMarginboolean
deleveragePercentilenumber double
rebalancedPnlinteger
prevRealisedPnlinteger
prevUnrealisedPnlinteger
openingQtyinteger
openOrderBuyQtyinteger
openOrderBuyCostinteger
openOrderBuyPremiuminteger
openOrderSellQtyinteger
openOrderSellCostinteger
openOrderSellPremiuminteger
currentQtyinteger
currentCostinteger
currentComminteger
realisedCostinteger
unrealisedCostinteger
grossOpenPremiuminteger
isOpenboolean
markPricenumber double
markValueinteger
riskValueinteger
homeNotionalnumber double
foreignNotionalnumber double
posStatestring
posCostinteger
posCrossinteger
posComminteger
posLossinteger
posMargininteger
posMaintinteger
initMargininteger
maintMargininteger
realisedPnlinteger
unrealisedPnlinteger
unrealisedPnlPcntnumber double
unrealisedRoePcntnumber double
avgCostPricenumber double
avgEntryPricenumber double
breakEvenPricenumber double
marginCallPricenumber double
liquidationPricenumber double
bankruptPricenumber double
timestampstring date-time

Example response

[
  {
    "symbol": "symbol",
    "breakEvenPrice": 8.969578798196912,
    "avgCostPrice": 0.10263654006109402,
    "posLoss": 6,
    "openOrderSellQty": 1,
    "avgEntryPrice": 4.652396432933246,
    "foreignNotional": 6.965117697638846,
    "riskLimit": 5,
    "prevUnrealisedPnl": 2,
    "marginCallPrice": 7.740351818741173,
    "unrealisedCost": 9,
    "posComm": 6,
    "posMaint": 6,
    "realisedCost": 9,
    "maintMargin": 3,
    "riskValue": 6,
    "grossOpenPremium": 6,
    "currentCost": 4,
    "underlying": "underlying",
    "quoteCurrency": "quoteCurrency",
    "initMarginReq": 1.4658129805029452,
    "isOpen": true,
    "posCross": 2,
    "unrealisedPnlPcnt": 7.058770351582356,
    "leverage": 2.3021358869347655,
    "posState": "posState",
    "openOrderSellPremium": 7,
    "openingQty": 4,
    "homeNotional": 3.5571952270680973,
    "liquidationPrice": 3.0205796992916243,
    "openOrderBuyQty": 7,
    "unrealisedPnl": 0,
    "markPrice": 8.762042012749001,
    "posMargin": 5,
    "crossMargin": true,
    "deleveragePercentile": 7.061401241503109,
    "openOrderBuyCost": 1,
    "posCost": 1,
    "currency": "currency",
    "commission": 6.027456183070403,
    "maintMarginReq": 5.962133916683182,
    "bankruptPrice": 3.0576100241049344,
    "openOrderSellCost": 6,
    "markValue": 9,
    "timestamp": "2000-01-23T04:56:07.000+00:00",
    "realisedPnl": 7,
    "rebalancedPnl": 9,
    "openOrderBuyPremium": 1,
    "currentQty": 1,
    "currentComm": 5,
    "prevRealisedPnl": 3,
    "initMargin": 3,
    "unrealisedRoePcnt": 6.519180951018382,
    "account": 0
  }
]