Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    Arguments InvestmentsSubscriptionArguments Body
    ContextId String Body
    Format String Body
    ReferenceId String Body
    RefreshRate Int Body
    ReplaceReferenceId String Body
    Tag String Body
  • Response Parameters

    View Response Codes
    Name Type Description
    ContextId String
    Format String
    InactivityTimeout Int
    ReferenceId String
    RefreshRate Int
    Snapshot InvestmentContract []
    State String
    Tag String
  • Request Example

    Request URL
    POST at/v3/investments/subscriptions
    Request Body
    {
      "ContextId": "explorer_201704091208182471",
      "ReferenceId": "123",
      "RefreshRate": 1000
    }
    
  • Response Example

    Response body
    {
      "InactivityTimeout": 120,
      "RefreshRate": 1000,
      "Snapshot": [
        {
          "AccountId": "ALUSD*2147279411",
          "AccountKey": "y3OYuYog1dSJ2gLXrBLYejddPfnZpPFsfci84-E4|X0=",
          "AutoTradingPartnerLeaderId": "11",
          "ClientId": 2147279411,
          "Currency": "USD",
          "DisplayName": "Investment Account 1",
          "DisplayState": 7,
          "EntryGateResult": "NA",
          "ErrorNumber": 0,
          "InitialFunding": 63291.0,
          "InvestmentId": "3353",
          "InvestmentProcessState": "Stopping",
          "InvestmentShieldAmount": 0.0,
          "InvestmentStateId": 32,
          "IsAuthorizedToFollow": true,
          "IsFollowAllowed": true,
          "IsFollowing": false,
          "IsOpenForFollowers": false,
          "IsReadyForTrading": false,
          "IsTradeFollowerReady": true,
          "IsWithdrawalInProgress": false,
          "MinimumFunding": 20000.0,
          "PendingFunding": 63291.0,
          "ReservedAmount": 0.0,
          "StateName": "Ready",
          "StrategyName": "Discretionary Trading",
          "TradeLeaderId": "1"
        },
        {
          "AccountId": "BRCHA*2147279411",
          "AccountKey": "PCXvSNri4gfq0HWg6D18Yp|EQN3qRivawC3ak9LvubA=",
          "AutoTradingPartnerLeaderId": "110",
          "ClientId": 2147279411,
          "Currency": "CHF",
          "DisplayName": "Investment Account 2",
          "DisplayState": 3,
          "EntryGateResult": "NA",
          "ErrorNumber": 0,
          "InitialFunding": 0.0,
          "InvestmentId": "3356",
          "InvestmentProcessState": "Retry",
          "InvestmentShieldAmount": 0.0,
          "InvestmentStateId": 7,
          "IsAuthorizedToFollow": true,
          "IsFollowAllowed": true,
          "IsFollowing": true,
          "IsOpenForFollowers": true,
          "IsReadyForTrading": false,
          "IsTradeFollowerReady": true,
          "IsWithdrawalInProgress": false,
          "MinimumFunding": 10000.0,
          "PendingFunding": 10000.0,
          "ReservedAmount": 0.0,
          "StateName": "Stopping",
          "StrategyName": "Aggressive Portfolio (CHF)",
          "TradeLeaderId": "93"
        }
      ],
      "State": "Active"
    }