Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    DisplayName String Body The displayName for the investment
    FundingAccountKey AccountKey Body The account from where to withdraw the initial funding amount.
    InitialFunding Decimal Body The initial funding amount.
    InvestmentShieldAmount Decimal Body Investment shield amount (drawdown protection level).
    IsDisclaimerAccepted Bool Body A value indicating whether user has accepted disclaimer before following a trade leader or not.
    TradeLeaderId String Body The id of the trade leader to invest in.
  • Response Parameters

    View Response Codes
    Name Type Description
    AccountId String Account Id of this InvestmentCreateResponse This property is obsolete.
    AccountKey String Account Key of this InvestmentCreateResponse This property is obsolete.
    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 InvestmentCreateResponse 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 InvestmentCreateResponse
    IsAuthorizedToFollow Bool Reflects legal aspects of client (suitability and terms/conditions)
    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 InvestmentCreateResponse is actively following.
    IsOpenForFollowers Bool Indicates if additional followers can join.
    IsReadyForTrading Bool Indictes if this InvestmentCreateResponse is ready for trading.
    IsTradeFollowerReady Bool Indicates Trade Follower created, active and passed suitability test
    IsWithdrawalInProgress Bool Indicates if cash wtihdrawal is in progress.
    MinimumFunding Decimal The minimum funding amount.
    PendingFunding Decimal Any pending funding.
    ReservedAmount Decimal Any amount marked as reserved for withdrawl
    ReturnPercentage Decimal Account Performance return fraction
    StateName String Description of the state this InvestmentCreateResponse is in
    StrategyName String Name of the strategy.
    TradeLeaderId String TradeLeader identifier.
  • Request Example

    Request URL
    POST at/v3/investments
    Request Body
    {
      "DisplayName": "Investment Account",
      "FundingAccountKey": "nUAg42i1-LI7kgWmWfSoaw==",
      "InitialFunding": 0.0,
      "InvestmentShieldAmount": 700000.0,
      "IsDisclaimerAccepted": true,
      "IsPortfolioMandateAccepted": false,
      "TradeLeaderId": "8"
    }
    
  • Response Example

    Response body
    {
      "AccountId": "AccountIda7bb671d-3326-45de-8abc-3f812bdf2059",
      "AccountKey": "AccountKey732d14b5-a082-4f5e-ba2e-222186f29b7b",
      "AutoTradingPartnerLeaderId": "AutoTradingPartnerLeaderId72d3c909-0b0c-497a-a8ed-5f6edf254c63",
      "ClientId": 1272368166,
      "Currency": "Currencyf3cb234d-c8a6-4833-b181-f2dce54d03ed",
      "DisplayName": "DisplayName17bf2ab3-6ee2-411d-9f6e-28011c52bafa",
      "DisplayState": 228,
      "EntryGateResult": "NA",
      "ErrorCode": "NotSuitable",
      "ErrorNumber": 224,
      "InitialFunding": -197314395219.21088,
      "InvestmentId": "InvestmentId1e66af2c-4034-4b2d-8069-d4e392072051",
      "InvestmentShieldAmount": 26902635834407.152,
      "InvestmentStateId": 176,
      "IsAuthorizedToFollow": true,
      "IsFollowAllowed": false,
      "IsFollowing": false,
      "IsOpenForFollowers": true,
      "IsReadyForTrading": true,
      "IsTradeFollowerReady": false,
      "IsWithdrawalInProgress": false,
      "MinimumFunding": -4.7525728467017053E+20,
      "PendingFunding": 1473112778.4274271,
      "ReservedAmount": -7.0868786942818423,
      "ReturnPercentage": -30.135261633115373,
      "StateName": "StateNamecf7de26c-e200-49bd-8c12-171e6d106233",
      "StrategyName": "StrategyName1d603c39-7152-491c-a661-1c0297e52a5a",
      "TradeLeaderId": "TradeLeaderId839ec21c-42b4-45fb-aa87-c82afb6636a9"
    }