Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    TradeLeaderId String Query-String Id of leader to retrieve data for
  • Response Parameters

    View Response Codes
    Name Type Description
    AccountId String Account Id of this InvestmentContract
    AccountKey String Account Key of this InvestmentContract
    AutoTradingPartnerLeaderId String Unique Identifier for Partner Leader Combination
    ClientId ClientId Gets the client id of the investment.
    Currency String Account currency
    DisplayName String User defined name of investment. If not specified then it defaults to StrategyName
    EntryGateResult EntryGateResult Entry Gate Test Result
    ErrorCode ErrorCode Error Code
    ErrorNumber Int Error number if this InvestmentContract is in error state This property is obsolete, please use ErrorCode
    InitialFunding Decimal The initial funding amount.
    InvestmentId String Investment Item identifier
    InvestmentProcessState InvestmentProcessState Investment process state
    InvestmentShieldAmount Decimal Investment shield amount (drawdown protection level).
    InvestmentStateId Int State Id of this InvestmentContract
    IsAuthorizedToFollow Bool Reflects legal aspects of client (suitability and terms/conditions)
    IsAutoFundsTransfer Bool Information about whether the funds would be auto transferred in case of investment stop.
    IsFollowAllowed Bool Indicates whether user is allowed to follow current leaders instrument types and instruments. Also evaluates if follower passes any applied country filter or client group restrictions on leader. And verifies leader is enabled for any of followers owner(s).
    IsFollowing Bool Indicates if this InvestmentContract is actively following.
    IsOpenForFollowers Bool Indicates if additional followers can join.
    IsReadyForTrading Bool Indictes if this InvestmentContract is ready for trading.
    IsTradeFollowerReady Bool Indicates Trade Follower created, active and passed suitability test
    IsWithdrawalInProgress Bool Indicates if cash wtihdrawal is in progress.
    LeaderLogoUrl String Logo Url of the respective trade leader
    MinimumFunding Decimal The minimum funding amount.
    PendingFunding Decimal Any pending funding.
    PositionsCloseOnDeactivation Bool Information about whether to close or keep related positions open on the investment deactivation (not available to all)
    ReservedAmount Decimal Any amount marked as reserved for withdrawl
    ReturnPercentage Decimal Account Performance return fraction
    StateName String Description of the state this InvestmentContract is in
    StrategyName String Name of the strategy.
    TradeLeaderId String TradeLeader identifier.
  • Request Example

    Request URL
    GET at/v3/investments/?TradeLeaderId=8
  • Response Example

    Response body
    {
      "AccountId": "SAMGS*585220",
      "AccountKey": "LLnUM8rL-9CVIKwZTZG96g==",
      "ClientId": 2147279411,
      "Currency": "EUR",
      "DisplayName": "Investment Account",
      "DisplayState": 6,
      "EntryGateResult": "NA",
      "ErrorNumber": 0,
      "InitialFunding": 1000000.0,
      "InvestmentId": "1505",
      "InvestmentProcessState": "Starting",
      "InvestmentShieldAmount": 700000.0,
      "InvestmentStateId": 31,
      "IsAuthorizedToFollow": true,
      "IsFollowAllowed": true,
      "IsFollowing": true,
      "IsOpenForFollowers": false,
      "IsReadyForTrading": true,
      "IsTradeFollowerReady": true,
      "IsWithdrawalInProgress": false,
      "MinimumFunding": 20000.0,
      "PendingFunding": 0.0,
      "ReservedAmount": 0.0,
      "StrategyName": "Global StockPicker",
      "TradeLeaderId": "8"
    }