Skip to main content

Get subaccounts

GET 

/subaccounts

Return information about subaccounts, including balances and UIDs.

Responses

Schema
    oneOf
    masterAccountUid stringrequired

    Master account UID

    subaccounts object[]required

    The sub-accounts.

  • Array [
  • accountUid stringrequired

    The account UID

    email stringrequired

    The email associated with the account

    fullName stringnullrequired

    The name of the account

    holdingAccounts object[]required

    Structure containing structures with holding accounts information for a specific holding account asset.

  • Array [
  • currency stringrequired

    The currency of the account. All figures shown in this currency.

    amount numberrequired

    The amount of currency in the holding account.

  • ]
  • futuresAccounts object[]required

    Structure containing structures with single-collateral accounts information for a specific futures account asset.

  • Array [
  • name stringrequired

    The name of the futures account as the account pair.

    availableMargin numberrequired

    The amount of currency in the holding account in the quote currency of the name pair.

  • ]
  • flexAccount objectrequired

    Multi-collateral account structure.

    currencies object[]required
  • Array [
  • currency stringrequired

    The name of the currency.

    quantity numberrequired

    The amount of currency in the multi-collateral account.

    value numberrequired

    The value of the currency quantity.

    collateral numberrequired

    The collateral value of the currency quantity (value * haircut).

    available numberrequired

    The available currency (quantity - margin requirement)

  • ]
  • initialMargin numberrequired

    The total initial margin for the multi-collateral account in USD.

    initialMarginWithOrders numberrequired

    The total initial margin of open positions without the margin held by open orders for the multi-collateral account in USD.

    maintenanceMargin numberrequired

    The total maintenance margin for the multi-collateral account in USD.

    balanceValue numberrequired

    The total balance value for the multi-collateral account in USD.

    portfolioValue numberrequired

    The total value of the portfolio in USD (Balance Value + Total Unrealised Profit/Loss).

    collateralValue numberrequired

    The USD value of balances in account usable for margin [(Balance Value * (1-Haircut)].

    pnl numberrequired

    The unrealised pnl for the multi-collateral account.

    unrealizedFunding numberrequired

    The total unrealised funding for the multi-collateral account in USD.

    totalUnrealized numberrequired

    Total unrealised Profit/Loss and unrealised funding of open positions in USD (Unrealised Position(s) Profit/Loss + Unrealised Funding Rate Profit/Loss) * USD rate.

    totalUnrealizedAsMargin numberrequired

    Unrealised Profit/Loss and unrealised funding that is usable as margin (Unrealised Profit/Loss + Unrealised Funding Rate) * Haircut - Conversion Fee.

    availableMargin numberrequired

    Account-wide margin available to create new orders (Margin Equity - Total Initial Margin).

    marginEquity numberrequired

    The Balance Value multiplied by the dollar rate and with haircuts applied to non-USD currencies, plus unrealised profit or loss as Margin.

    [Balance Value in USD * (1-Haircut)] + (Total Unrealised Profit/Loss as Margin in USD)

    portfolioMarginBreakdown object

    Breakdown of portfolio margin components.

    totalCrossAssetNettedMarketRisk doublerequired
    totalMarketRisk doublerequired
    totalScenarioPnls double[]
    totalAbsoluteOptionPositionDeltaNotional doublerequired
    netPortfolioDelta doublerequired
    totalPremium doublerequired
    isBuyOnly booleanrequired
    futuresMaintenanceMargin doublerequired
  • ]
  • result stringrequired

    Possible values: [success]

    serverTime date-timerequired

    Server time in Coordinated Universal Time (UTC)

Loading...