Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    Arguments InvestmentsSubscriptionArguments 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 InvestmentContract [] 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
    AccountId String Account Id of this
    AccountKey String Account Key of this
    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
    DisplayState Integer SaxoInternal - States are bundled in DisplayStates for UI guidance. Only relevant for Saxo applications
    EntryGateResult EntryGateResult Entry Gate Test Result
    ErrorCode ErrorCode Error Code
    ErrorNumber Integer Error number if this is in error state This property is obsolete, please use
    InitialFunding Number The initial funding amount.
    InvestmentId String Investment Item identifier
    InvestmentProcessState InvestmentProcessState Investment process state
    InvestmentShieldAmount Number Investment shield amount (drawdown protection level).
    InvestmentStateId Integer State Id of this
    IsAuthorizedToFollow Boolean Reflects legal aspects of client (suitability and terms/conditions)
    IsAutoFundsTransfer Boolean Information about whether the funds would be auto transferred in case of investment stop.
    IsFollowAllowed Boolean 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 Boolean Indicates if this is actively following.
    IsOpenForFollowers Boolean Expresses if follower amount has exceeded limit.
    IsReadyForTrading Boolean Indictes if this is ready for trading.
    IsTradeFollowerReady Boolean Indicates Trade Follower created, active and passed suitability test
    IsWithdrawalInProgress Boolean Indicates if cash wtihdrawal is in progress.
    LeaderLogoUrl String Logo Url of the respective trade leader
    MinimumFunding Number The minimum funding amount.
    PendingFunding Number Any pending funding.
    PositionsCloseOnDeactivation Boolean Information about whether to close or keep related positions open on the investment deactivation (not available to all)
    ReservedAmount Number Any amount marked as reserved for withdrawl
    ReturnPercentage Number Account Performance return fraction
    StateName String Description of the state this is in
    StrategyName String Name of the strategy.
    TradeLeaderId String identifier.

  • 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,
      "InvestmentId": "3353",
      "InvestmentProcessState": "Stopping",
      "InvestmentShieldAmount": 0,
      "InvestmentStateId": 32,
      "IsAuthorizedToFollow": true,
      "IsFollowAllowed": true,
      "IsFollowing": false,
      "IsOpenForFollowers": false,
      "IsReadyForTrading": false,
      "IsTradeFollowerReady": true,
      "IsWithdrawalInProgress": false,
      "MinimumFunding": 20000,
      "PendingFunding": 63291,
      "ReservedAmount": 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,
      "InvestmentId": "3356",
      "InvestmentProcessState": "Retry",
      "InvestmentShieldAmount": 0,
      "InvestmentStateId": 7,
      "IsAuthorizedToFollow": true,
      "IsFollowAllowed": true,
      "IsFollowing": true,
      "IsOpenForFollowers": true,
      "IsReadyForTrading": false,
      "IsTradeFollowerReady": true,
      "IsWithdrawalInProgress": false,
      "MinimumFunding": 10000,
      "PendingFunding": 10000,
      "ReservedAmount": 0,
      "StateName": "Stopping",
      "StrategyName": "Aggressive Portfolio (CHF)",
      "TradeLeaderId": "93"
    }
  ],
  "State": "Active"
}

  • Streaming 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,
  "InvestmentId": "1505",
  "InvestmentProcessState": "Starting",
  "InvestmentShieldAmount": 700000,
  "InvestmentStateId": 31,
  "IsAuthorizedToFollow": true,
  "IsFollowAllowed": true,
  "IsFollowing": true,
  "IsOpenForFollowers": false,
  "IsReadyForTrading": true,
  "IsTradeFollowerReady": true,
  "IsWithdrawalInProgress": false,
  "MinimumFunding": 20000,
  "PendingFunding": 0,
  "ReservedAmount": 0,
  "StrategyName": "Global StockPicker",
  "TradeLeaderId": "8"
}