Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    $inlinecount InlineCountValue Query-String Indication of whether the total count of elements must be returned.
    $skip Int Query-String Optional number of elements to skip.
    $top Int Query-String Optional number of elements to retrieve.
    ClientKey ClientKey Query-String The client to which the accounts belong.
    IncludeSubAccounts Bool Query-String Optionally set true to request that all sub accounts are returned.
  • Response Parameters

    View Response Codes
    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 Decimal 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 Bool Indicates whether the account is active or not.
    AutoTradingInvestmentId Int 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 Bool If true, the user may enable/disable the use of cash positions as margin trading collateral on the given account.
    CfdBorrowingCostsActive Bool 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 Int Number of decimals used in currency.
    DirectMarketAccess Bool 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.
    FractionalOrderEnabled Bool FractionalOrder is enabled or not for the account.
    IndividualMargining Bool Indicates that the margin exposure is calculated for this account only, without cross margining to other accounts within the same account group.
    IsCurrencyConversionAtSettlementTime Bool If true, currency conversions between trade and account currency take place at time of trade settlement. Typically end of business day.
    IsMarginTradingAllowed Bool Indicates whether trading on margin is allowed for the account.
    IsShareable Bool 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 Bool 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 Bool 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 Bool 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 Bool Enable/disable the use of cash positions for margin trading collateral.
  • Request Example

    Request URL
    GET port/v1/accounts/?$top=99&$skip=99&$inlinecount=None&ClientKey=493b43a5-fe85-4d1f-9071-dd4a9d4e42a4&IncludeSubAccounts=True
  • Response Example

    Response body
    {
      "__next": "/openapi/port/....../?$top=1&$skip=1",
      "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
        }
      ]
    }