Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    ClientKey ClientKey Query-String Client Key to fetch standing instructions for.
    IncludeSubAccounts Bool Query-String Indicates whether to include standing instructions from sub-clients.
  • Response Parameters

    View Response Codes
    Name Type Description
    AccountDisplayName String Account display name
    AccountId String The attain key of the account that this standing instruction applies to.
    AssetType AssetType Asset Type
    ClientId String Client Identifier
    CreatedDate Date Creation Date for Standing Instruction
    DisplayAndFormat InstrumentDisplayAndFormat Instrument Details
    OptionType OptionType The type of option to automatically elect. Must be either SECU or CASH.
    StandingInstructionId String Standing instruction Id
    Uic Int The instrument that this standing instruction applies to.
  • Request Example

    Request URL
    GET ca/v2/standinginstructions/?ClientKey=7m4I|vtYLUnEGg77o9uQhw==&IncludeSubAccounts=false
  • Response Example

    Response body
    {
      "Data": [
        {
          "AccountDisplayName": "Derivatives",
          "AccountId": "12642445",
          "AssetType": "Stock",
          "ClientId": "9971842",
          "CreatedDate": "0001-01-01",
          "DisplayAndFormat": {
            "Description": "ABB Ltd",
            "IsinCode": "CH0012221716",
            "Symbol": "ABB:xome"
          },
          "OptionType": "SECU",
          "StandingInstructionId": "31272",
          "Uic": 101
        }
      ]
    }