Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    Arguments BalanceRequest Body Arguments for the subscription request.
    ContextId String Body The streaming context id that this request is associated with. This parameter must only contain letters (a-z) and numbers (0-9) as well as - (dash) and _ (underscore). It is case insensitive. Max length is 50 characters.
    Format String Body Optional Media type (RFC 2046) of the serialized data updates that are streamed to the client. Currently only application/json and application/x-protobuf is supported. If an unrecognized format is specified, the subscription end point will return HTTP status code 400 - Bad format.
    ReferenceId String Body Mandatory client specified reference id for the subscription. This parameter must only contain alphanumberic characters as well as - (dash) and _ (underscore). Cannot start with _. It is case insensitive. Max length is 50 characters.
    RefreshRate Integer Body Optional custom refresh rate, measured in milliseconds, between each data update. Note that it is not possible to get a refresh rate lower than the rate specified in the customer service level agreement (SLA).
    ReplaceReferenceId String Body Reference id of the subscription that should be replaced.
    Tag String Body Optional client specified tag used for grouping subscriptions.

  • Response Parameters

    View Response Codes
    Name Type Description
    ContextId String The streaming context id that this response is associated with.
    Format String The media type (RFC 2046), of the serialized data updates that are streamed to the client.
    InactivityTimeout Integer The time (in seconds) that the client should accept the subscription to be inactive before considering it invalid.
    ReferenceId String The reference id that (along with streaming context id and session id) identifies the subscription (within the context of a specific service/subscription type)
    RefreshRate Integer Actual refresh rate assigned to the subscription according to the customers SLA.
    Snapshot BalanceResponse Snapshot of the current data on hand, when subscription was created.
    State String This property is kept for backwards compatibility.
    Tag String Client specified tag assigned to the subscription, if specified in the request.

  • Streaming Response Parameters

    Name Type Description
    AccountFundingLimit Number Account funding limit. This field is available for TaxSaving AccountType and FrancePea and FrancePeaPme SubAccountTypes.
    AccountNetFundedAmount Number Account funding limit. This field is available for TaxSaving AccountType and FrancePea and FrancePeaPme SubAccountTypes.
    AccountRemainingFunding Number Account Remaining Funding. This field is available for TaxSaving and Pension AccountTypes, and FrancePea and FrancePeaPme SubAccountTypes.
    AccountValueProtectionLimit Number 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 Number Cash available for trading for the current account/client.
    CashBalance Number Current cash balance of the account/client.
    CashBlocked Number Cash blocked for the current account/client.
    CashBlockedFromWithdrawal Number Cash which cannot be withdrawn (e.g. outstanding tax)
    ChangesScheduled Boolean True if there are scheduled changes to margin, collateral or rating changes.
    ClosedPositionsCount Integer Number of current closed positions.
    CollateralAvailable Number 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 Number Size of loan secured by collateral
    CorporateActionUnrealizedAmounts Number Corporate Action Unrealized Amounts.
    CostToClosePositions Number 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 Integer Number of decimals used to represent values in this currency. For most common currency denominations this value will be: 2.
    FinancingAccruals Number Net financing accruals (e.g. interest, carrying costs, and holding fees)
    FundsAvailableForSettlement Number Funds available for trades settling today.
    FundsReservedForSettlement Number Funds reserved for trades settling today at market opening.
    InitialMargin InitialMarginResponse If set, this represents the calculation entity's initial margin (purchasing power).
    IntradayMarginDiscount Number Margin credited for unnetted positions closed intraday
    IsPortfolioMarginModelSimple Boolean 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 Number 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 Number Margin available for trading. The amount of remaining collateral available for margin trading for the account/client.
    MarginCollateralNotAvailable Number Current collateral deduction of unrealized positions.
    MarginCollateralNotAvailableDetail MarginCollateralNotAvailableDetail Detail of MarginCollateralNotAvailable
    MarginExposureCoveragePct Number 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 Number Total net exposure of margin traded positions across all instruments.
    MarginOverview MarginOverviewByGroup Instrument margin utilization for positions.
    MarginUsedByCurrentPositions Number 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 Number 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 Number Value used as basis to calculate maintinance margin. It is calculated as TotalValue plus pending settlements (funds awaiting settlement for partners), minus MarginCollateralNotAvailable.
    NetPositionsCount Integer Number of current open net positions.
    NonMarginPositionsValue Number Sum of MarketValue for all non-margin instruments held in the account/by the client.
    OpenIpoOrdersCount Integer Open Ipo order(s) count
    OpenPositionsCount Integer Number of current open positions.
    OptionPremiumsMarketValue Number Combined market value of premium for all options, both FX and Contract Options.
    OrdersCount Integer Number of current open orders.
    OtherCollateral Number Indicates the value of securities that have been deposited as collateral for margin.
    OtherCollateralDeduction Number Other Collateral Deduction derived from regulatory contributor margin value.
    SettlementLine LineStatus The utilization state and maximum settlement credit limit.
    SettlementValue Number Net current settlement value, long and short positions combined.
    SpendingPowerDetail SpendingPower Available spending power on the account/client.
    TotalRiskLine LineStatus The utilization state and risk credit limit.
    TotalValue Number Current value of unrealized positions incl. costs, cash balance and transactions not booked.
    TradingLine LineStatus The utilization state and maximum trading credit limit.
    TransactionsNotBooked Number 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 Integer Number of current open trigger orders.
    UnrealizedMarginClosedProfitLoss Number ProfitLoss on all closed (netting and explicit) part of positions (Intraday netting specific).
    UnrealizedMarginOpenProfitLoss Number ProfitLoss on open part of positions (Intraday netting specific).
    UnrealizedMarginProfitLoss Number Sum of profit/loss ex. costs for all margin instruments held in the account/by the client.
    UnrealizedPositionsValue Number The current unrealized profit/loss and face value of all positions excl. costs.
    VariationMargin Number The change in value of unrealized derivatives positions since opening them.
    VariationMarginCashBalance Number Cash amount withdrawn from unrealized derivatives positions (VariationMargin).
    VariationMarginThreshold Number Maximmum amount that may be withdrawn from unrealized derivatives positions (VariationMargin).

  • Request Example

    Request URL
    POST /port/v1/balances/subscriptions
    Request Body
    {
  "Arguments": {
    "AccountGroupKey": "",
    "AccountKey": "",
    "ClientKey": "7m4I|vtYLUnEGg77o9uQhw=="
  },
  "ContextId": "20241111112310101",
  "ReferenceId": "B07470",
  "RefreshRate": 500,
  "Tag": "MyBalancesRelatedSubscriptions"
}

  • Response Example

    Response body
    {
  "ContextId": "20241111112310105",
  "Format": "application/json",
  "InactivityTimeout": 1500,
  "ReferenceId": "B93942",
  "RefreshRate": 500,
  "Snapshot": {
    "CalculationReliability": "Ok",
    "CashAvailableForTrading": 100573853.73,
    "CashBalance": 100573853.73,
    "CashBlocked": 0,
    "ChangesScheduled": false,
    "ClosedPositionsCount": 0,
    "CollateralAvailable": 99839075.64,
    "CorporateActionUnrealizedAmounts": 0,
    "CostToClosePositions": -1677.57,
    "Currency": "EUR",
    "CurrencyDecimals": 0,
    "InitialMargin": {
      "CollateralAvailable": 12254541.55,
      "MarginAvailable": 12254541.55,
      "MarginCollateralNotAvailable": 0,
      "MarginUsedByCurrentPositions": -1225544.66,
      "MarginUtilizationPct": 15.11,
      "NetEquityForMargin": 1222521.77,
      "OtherCollateralDeduction": 0
    },
    "IntradayMarginDiscount": 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,
    "OrdersCount": 0,
    "OtherCollateral": 103798.26,
    "SettlementValue": 0,
    "ShareSpendingPower": 50,
    "SpendingPower": 50,
    "SpendingPowerDetail": {
      "Current": 50,
      "Maximum": 50
    },
    "SrdSpendingPower": 50,
    "TotalValue": 100634324.36,
    "TransactionsNotBooked": -118.71,
    "TriggerOrdersCount": 0,
    "UnrealizedMarginClosedProfitLoss": 0,
    "UnrealizedMarginOpenProfitLoss": 0,
    "UnrealizedMarginProfitLoss": -550738.76,
    "UnrealizedPositionsValue": -43208.92
  },
  "State": "Active",
  "Tag": "MyBalancesRelatedSubscriptions"
}

  • Streaming Response Example

    Response body
    {
  "CalculationReliability": "Ok",
  "CashAvailableForTrading": 100573853.73,
  "CashBalance": 100573853.73,
  "CashBlocked": 0,
  "ChangesScheduled": false,
  "ClosedPositionsCount": 0,
  "CollateralAvailable": 99839075.64,
  "CorporateActionUnrealizedAmounts": 0,
  "CostToClosePositions": -1677.57,
  "Currency": "EUR",
  "CurrencyDecimals": 0,
  "InitialMargin": {
    "CollateralAvailable": 12254541.55,
    "MarginAvailable": 12254541.55,
    "MarginCollateralNotAvailable": 0,
    "MarginUsedByCurrentPositions": -1225544.66,
    "MarginUtilizationPct": 15.11,
    "NetEquityForMargin": 1222521.77,
    "OtherCollateralDeduction": 0
  },
  "IntradayMarginDiscount": 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,
  "OrdersCount": 0,
  "OtherCollateral": 103798.26,
  "SettlementValue": 0,
  "SpendingPowerDetail": {
    "Current": 50,
    "Maximum": 50
  },
  "TotalValue": 100634324.36,
  "TransactionsNotBooked": -118.71,
  "TriggerOrdersCount": 0,
  "UnrealizedMarginClosedProfitLoss": 0,
  "UnrealizedMarginOpenProfitLoss": 0,
  "UnrealizedMarginProfitLoss": -550738.76,
  "UnrealizedPositionsValue": -43208.92
}