Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    Arguments AccountsRequest 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 AccountResponseListResult 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
    AccountGroupKey AccountGroupKey Unique ID of the account group used for selection
    AccountGroupName String Name of the account group, displayed to the user
    AccountId String Unique ID of the account, displayed to the user
    AccountKey AccountKey Unique ID of the account.
    AccountSubType AccountSubType Sub type of the account.
    AccountType AccountType Type of the account.
    AccountValueProtectionLimit Number If set, this value shields the account value from going below the given limit by automatically triggering closing of positions should the limit be exceeded. A limit of zero means there is no limit.
    Active Boolean Indicates whether the account is active or not.
    AutoTradingInvestmentId Integer If the account follows a trade leader on AutoTrading/SaxoSelect, this is the leader identifier.
    BenchmarkInstrument AccountBenchmarkInstrument Contains the instrument to be used as comparison then evaluating account performance.
    CanUseCashPositionsAsMarginCollateral Boolean If true, the user may enable/disable the use of cash positions as margin trading collateral on the given account.
    CfdBorrowingCostsActive Boolean Indicates if the account is configured for CFD borrowing costs.
    ClientId String Unique ID of the client owning the account
    ClientKey ClientKey Unique ID of the client - for navigation purposes
    CreationDate UtcDateTime The UTC date and time the account was created.
    Currency String Account currency.
    CurrencyDecimals Integer Number of decimals used in currency.
    DirectMarketAccess Boolean Indicates direct market access for the account.
    DirectMarketExchangesIds String [] Lists exchanges for which the account is direct market access enabled.
    DisplayName String User customizable account name.
    DividendReinvestmentConfig DividendReinvestmentConfiguration Indicates whether (and through which provider) dividend reinvestment is enabled for this account. If dividend reinvestment is not enabled, this field is omitted from the response, in which case dividends are booked as cash on the account.
    FractionalOrderEnabled Boolean FractionalOrder is enabled or not for the account.
    IndividualMargining Boolean Indicates that the margin exposure is calculated for this account only, without cross margining to other accounts within the same account group.
    IsCurrencyConversionAtSettlementTime Boolean If true, currency conversions between trade and account currency take place at time of trade settlement. Typically end of business day.
    IsMarginTradingAllowed Boolean Indicates whether trading on margin is allowed for the account.
    IsShareable Boolean Indicates whether or not the account can be shared. An account can only be shared if it is the only account of its client and it is not a trial account.
    IsTrialAccount Boolean IsTrialAccount - Is this a trial account.
    LegalAssetTypes AssetType [] AssetTypes that can be traded on this account.
    ManagementType ManagementType Account's Management Type.
    MarginCalculationMethod PortfolioMarginMethod Calculation method for assessing margin utilization.
    MarginLendingEnabled MarginLendingEnabled Margin Lending Enabled.
    PortfolioBasedMarginEnabled Boolean Portfolio Based Margin (PBM) is a method for mapping the risk of an investment portfolio. True if enabled else false.
    Sharing String [] Returns a list of application identifiers that the account has been shared with.
    SupportsAccountValueProtectionLimit Boolean If true, an AccountValueProtectionLimit may be set on this account. If it is false, the AccountValueProtectionLimit can be set on client or account group.
    UseCashPositionsAsMarginCollateral Boolean Enable/disable the use of cash positions for margin trading collateral.
  • Request Example

    Request URL
    POST /port/v1/accounts/subscriptions
    Request Body
    {
      "Arguments": {
        "AccountGroupKey": "LZTc7DdejXODf-WSl2aCyQ==",
        "AccountKey": "LZTc7DdejXODf-WSl2aCyQ==",
        "ClientKey": "7m4I|vtYLUnEGg77o9uQhw=="
      },
      "ContextId": "20240514081940019",
      "Format": "application/json",
      "ReferenceId": "A32484",
      "RefreshRate": 500,
      "Tag": "MyAccountRelatedSubscriptions"
    }
    
  • Response Example

    Response body
    {
      "ContextId": "20240514081940019",
      "Format": "application/json",
      "InactivityTimeout": 1500,
      "ReferenceId": "A32484",
      "RefreshRate": 500,
      "Snapshot": {
        "Data": [
          {
            "AccountGroupKey": "LZTc7DdejXODf-WSl2aCyQ==",
            "AccountId": "192134INET",
            "AccountKey": "LZTc7DdejXODf-WSl2aCyQ==",
            "AccountType": "Normal",
            "Active": true,
            "CanUseCashPositionsAsMarginCollateral": false,
            "CfdBorrowingCostsActive": false,
            "ClientId": "654321",
            "ClientKey": "7m4I|vtYLUnEGg77o9uQhw==",
            "CreationDate": "2017-01-01T13:00:00Z",
            "Currency": "EUR",
            "CurrencyDecimals": 2,
            "DirectMarketAccess": false,
            "FractionalOrderEnabled": false,
            "IndividualMargining": false,
            "IsCurrencyConversionAtSettlementTime": false,
            "IsMarginTradingAllowed": true,
            "IsShareable": true,
            "IsTrialAccount": false,
            "LegalAssetTypes": [
              "FxSpot",
              "Stock",
              "ContractFutures"
            ],
            "ManagementType": "Client",
            "MarginCalculationMethod": "Default",
            "MarginLendingEnabled": "None",
            "PortfolioBasedMarginEnabled": false,
            "Sharing": [
              "TradingFloor"
            ],
            "SupportsAccountValueProtectionLimit": false,
            "UseCashPositionsAsMarginCollateral": false
          }
        ]
      },
      "State": "Active",
      "Tag": "MyAccountRelatedSubscriptions"
    }
    
  • Streaming Response Example

    Response body
    {
      "AccountGroupKey": "LZTc7DdejXODf-WSl2aCyQ==",
      "AccountId": "192134INET",
      "AccountKey": "LZTc7DdejXODf-WSl2aCyQ==",
      "AccountType": "Normal",
      "Active": true,
      "CanUseCashPositionsAsMarginCollateral": false,
      "CfdBorrowingCostsActive": false,
      "ClientId": "654321",
      "ClientKey": "7m4I|vtYLUnEGg77o9uQhw==",
      "CreationDate": "2017-01-01T13:00:00+00:00",
      "Currency": "EUR",
      "CurrencyDecimals": 2,
      "DirectMarketAccess": false,
      "FractionalOrderEnabled": false,
      "IndividualMargining": false,
      "IsCurrencyConversionAtSettlementTime": false,
      "IsMarginTradingAllowed": true,
      "IsShareable": true,
      "IsTrialAccount": false,
      "LegalAssetTypes": [
        "FxSpot",
        "Stock",
        "ContractFutures"
      ],
      "ManagementType": "Client",
      "MarginCalculationMethod": "Default",
      "MarginLendingEnabled": "None",
      "PortfolioBasedMarginEnabled": false,
      "Sharing": [
        "TradingFloor"
      ],
      "SupportsAccountValueProtectionLimit": false,
      "UseCashPositionsAsMarginCollateral": false
    }