Sign in

v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB
Funds

Create Fund

Creates a Fund.

post/managed/funds

Request body

userIDstring required

The unique identifier of the registered investment advisors account.

namestring required

A name given to the Fund by the RIA.

clientFundIDstring required

An advisor created identifier for a specific allocation.

descriptionstring required

A short description for the Fund.

Example request

{
  "userID": "66304da9-3h6f-2234-935f-ac6b7933d706",
  "name": "TECH",
  "clientFundID": "SUMS_CUSTOM_ALLOCATION_TEST",
  "description": "Top 10 US Tech",
  "holdings": [
    {
      "instrumentID": "5b85fabb-d57c-44e6-a7f6-a3efc760226c",
      "target": 0.5
    }
  ],
  "triggers": [
    {
      "type": "TOTAL_DRIFT",
      "maxAllowed": 0.05,
      "lowerBound": 0.01,
      "upperBound": 0.02
    }
  ]
}

Response

Creating a Fund was Successful

idstring

The unique identifier associated with the Fund.

userIDstring

The unique identifier of the registered investment advisors account.

namestring

A name given to the Fund by the RIA.

typestring
clientFundIDstring

A user defined identifier attached to the fund.

descriptionstring

A short description for the Fund.

isInstrumentTargetsChangedboolean
instrumentTargetsChangedboolean

Example response

{
  "id": "fund_3d7d00d1-f09e-4f86-9cbf-893c75cf77fe",
  "userID": "66304da9-3h6f-2234-935f-ac6b7933d706",
  "name": "TECH",
  "type": "FUND",
  "clientFundID": "-3344.123456789",
  "description": "Top 10 US Tech",
  "holdings": [
    {
      "instrumentID": "5b85fabb-d57c-44e6-a7f6-a3efc760226c",
      "target": 0.5
    }
  ],
  "triggers": [
    {
      "type": "TOTAL_DRIFT",
      "maxAllowed": 0.05,
      "lowerBound": 0.01,
      "upperBound": 0.02
    }
  ]
}