Endpoint Parameters

  • Request parameters

    There are no Request Parameters

  • Response Parameters

    View Response Codes
    Name Type Description
    AccountFundingLimit Decimal Account funding limit. This field is available for TaxSaving AccountType and FrancePea and FrancePeaPme SubAccountTypes.
    AccountNetFundedAmount Decimal Account funding limit. This field is available for TaxSaving AccountType and FrancePea and FrancePeaPme SubAccountTypes.
    AccountRemainingFunding Decimal Account Remaining Funding. This field is available for TaxSaving and Pension AccountTypes, and FrancePea and FrancePeaPme SubAccountTypes.
    AccountValueProtectionLimit Decimal If set, this value shields the account/client value from going below the given limit by automatically triggering closing of open positions should the limit be exceeded. A limit of zero means there is no limit.
    CalculationReliability CalculationReliability In case an error was encountered while computing balances, this field indicates the source of the calculation error.
    CashAvailableForTrading Decimal Cash available for trading for the current account/client.
    CashBalance Decimal Current cash balance of the account/client.
    CashBlocked Decimal Cash blocked for the current account/client.
    ChangesScheduled Bool True if there are scheduled changes to margin, collateral or rating changes.
    ClosedPositionsCount Int Number of current closed positions.
    CollateralAvailable Decimal Sum of collateral from positions, cash, collateral credit and other holdings available to maintain positions.
    CollateralCreditLine LineStatus The utilization state and maximum collateral credit line limit.
    CollateralCreditValue LineStatus The utilization state and maximum collateral credit value.
    CollateralLoan Decimal Size of loan secured by collateral
    CorporateActionUnrealizedAmounts Decimal Corporate Action Unrealized Amounts.
    CostToClosePositions Decimal Estimated costs payable if all position where to be closed on the account/client. The provided value is negative for costs charged to the account.
    CreditLine LineStatus The utilization state and maximum credit limit.
    Currency String Currency of the Account, AccountGroup, or Client, depending on the selected entity for which balances are requested. All values provided in this response are denominated in this currency unless otherwise specified.
    CurrencyDecimals Int Number of decimals used to represent values in this currency. For most common currency denominations this value will be: 2.
    ExtendedTradingHoursUncertaintyValue Decimal Extended trading hours uncertainty value. Only available if the client in configured for trading in extended trading hours (pre- and post-market). The provided value is negative for any margin that is charged to initial margin available.
    FirstFundingDate Obsolete UtcDateTime FirstFundingDate will not be available from the 1st of October 2022.
    FundsAvailableForSettlement Decimal Funds available for trades settling today.
    FundsReservedForSettlement Decimal Funds reserved for trades settling today at market opening.
    InitialMargin InitialMarginResponse If set, this represents the calculation entity's initial margin (purchasing power).
    IntradayMarginDiscount Decimal Margin credited for unnetted positions closed intraday
    IsPortfolioMarginModelSimple Bool True if the given client/account is on simple margining. F.ex. Used to indicate if the account supports close all positions. Typically this means the client has a single account or single account margining and no settlement accounts. As well as no Fx Forwards/Options, listed options or Futures using advanced margining methods.
    MarginAndCollateralUtilizationPct Decimal Level of margin already utilized in percent. I.e. the ratio between the margin collateral used and the total available margin collateral. Indicates distance to margin calls.
    MarginAvailableForTrading Decimal Margin available for trading. The amount of remaining collateral available for margin trading for the account/client.
    MarginCollateralNotAvailable Decimal Current collateral deduction of unrealized positions.
    MarginCollateralNotAvailableDetail MarginCollateralNotAvailableDetail Detail of MarginCollateralNotAvailable
    MarginExposureCoveragePct Decimal Percentage of total margin exposure to total collateral. I.e. the ratio between the Account Value and the Net Exposure. If account exposure is 0, the coverage percent is also returned as 0.
    MarginNetExposure Decimal Total net exposure of margin traded positions across all instruments.
    MarginOverview MarginOverviewByGroup Instrument margin utilization for positions.
    MarginUsedByCurrentPositions Decimal Sum of maintenance margin used for current positions on the account/client. The provided value is negative for any margin that is charged to the available margin on the account/client.
    MarginUtilizationPct Decimal Level of margin already utilized in percent. I.e. the ratio between the margin collateral used and the total available margin collateral. Indicates distance to margin calls.
    NetEquityForMargin Decimal Value used as basis to calculate maintinance margin. It is calculated as TotalValue plus pending settlements (funds awaiting settlement for partners), minus MarginCollateralNotAvailable.
    NetPositionsCount Int Number of current open net positions.
    NonMarginPositionsValue Decimal Sum of MarketValue for all non-margin instruments held in the account/by the client.
    OpenIpoOrdersCount Int Open Ipo order(s) count
    OpenPositionsCount Int Number of current open positions.
    OptionPremiumsMarketValue Decimal Combined market value of premium for all options, both FX and Contract Options.
    OrdersCount Int Number of current open orders.
    OtherCollateral Decimal Indicates the value of securities that have been deposited as collateral for margin.
    OtherCollateralDeduction Decimal Other Collateral Deduction derived from regulatory contributor margin value.
    SettlementLine LineStatus The utilization state and maximum settlement credit limit.
    SettlementValue Decimal Net current settlement value, long and short positions combined.
    ShareSpendingPower Obsolete Decimal ShareSpendingPower will not be available from the 1st of October 2022 - use SpendingPowerDetail.Maximum instead.
    SpendingPower Obsolete Decimal SpendingPower will not be available from the 1st of October 2022 - use SpendingPowerDetail.Current instead.
    SpendingPowerDetail SpendingPower Available spending power on the account/client.
    SrdSpendingPower Obsolete Decimal SrdSpendingPower will not be available from the 1st of October 2022 - use SpendingPowerDetail.Current instead.
    TotalRiskLine LineStatus The utilization state and risk credit limit.
    TotalValue Decimal Current value of unrealized positions incl. costs, cash balance and transactions not booked.
    TradingLine LineStatus The utilization state and maximum trading credit limit.
    TransactionsNotBooked Decimal Value of transactions that have yet to be booked to the account/client.
    TransactionsNotBookedDetail TransactionsNotBookedDetail Detail of transaction(s) that yet have to be booked to the account/client.
    TriggerOrdersCount Int Number of current open trigger orders.
    UnrealizedMarginClosedProfitLoss Decimal ProfitLoss on all closed (netting and explicit) part of positions (Intraday netting specific).
    UnrealizedMarginOpenProfitLoss Decimal ProfitLoss on open part of positions (Intraday netting specific).
    UnrealizedMarginProfitLoss Decimal Sum of profit/loss ex. costs for all margin instruments held in the account/by the client.
    UnrealizedPositionsValue Decimal The current unrealized profit/loss and face value of all positions excl. costs.
    VariationMargin Decimal The change in value of unrealized derivatives positions since opening them.
    VariationMarginCashBalance Decimal Cash amount withdrawn from unrealized derivatives positions (VariationMargin).
    VariationMarginThreshold Decimal Maximmum amount that may be withdrawn from unrealized derivatives positions (VariationMargin).
  • Request Example

    Request URL
    GET port/v1/balances/me
  • Response Example

    Response body
    {
      "CalculationReliability": "Ok",
      "CashAvailableForTrading": 100573853.73,
      "CashBalance": 100573853.73,
      "CashBlocked": 0.0,
      "ChangesScheduled": false,
      "ClosedPositionsCount": 0,
      "CollateralAvailable": 99839075.64,
      "CorporateActionUnrealizedAmounts": 0.0,
      "CostToClosePositions": -1677.57,
      "Currency": "EUR",
      "CurrencyDecimals": 0,
      "InitialMargin": {
        "CollateralAvailable": 12254541.55,
        "MarginAvailable": 12254541.55,
        "MarginCollateralNotAvailable": 0.0,
        "MarginUsedByCurrentPositions": -1225544.66,
        "MarginUtilizationPct": 15.11,
        "NetEquityForMargin": 1222521.77,
        "OtherCollateralDeduction": 0.0
      },
      "IntradayMarginDiscount": 0.0,
      "IsPortfolioMarginModelSimple": true,
      "MarginAndCollateralUtilizationPct": 0.38,
      "MarginAvailableForTrading": 99839075.64,
      "MarginCollateralNotAvailable": -468419.84,
      "MarginExposureCoveragePct": 344.35,
      "MarginNetExposure": 29088391.02,
      "MarginUsedByCurrentPositions": -326828.87,
      "MarginUtilizationPct": 0.33,
      "NetEquityForMargin": 85539075.64,
      "NetPositionsCount": 0,
      "NonMarginPositionsValue": 509207.41,
      "OpenIpoOrdersCount": 0,
      "OpenPositionsCount": 0,
      "OptionPremiumsMarketValue": 0.0,
      "OrdersCount": 0,
      "OtherCollateral": 103798.26,
      "SettlementValue": 0.0,
      "ShareSpendingPower": 50.0,
      "SpendingPower": 50.0,
      "SpendingPowerDetail": {
        "Current": 50.0,
        "Maximum": 50.0
      },
      "SrdSpendingPower": 50.0,
      "TotalValue": 100634324.36,
      "TransactionsNotBooked": -118.71,
      "TriggerOrdersCount": 0,
      "UnrealizedMarginClosedProfitLoss": 0.0,
      "UnrealizedMarginOpenProfitLoss": 0.0,
      "UnrealizedMarginProfitLoss": -550738.76,
      "UnrealizedPositionsValue": -43208.92
    }