v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB

Portfolios

Retrieve Portfolio

Retrieves a Portfolio by portfolioID.

get/managed/portfolios/{portfolioID}

Path parameters

portfolioIDstring required

A unique identifier associated with a specific Portfolio.

Response

Retrieving a Portfolio by portfolioID was Successful.

idstring

The unique identifier associated with a portfolio.

namestring

A name given to the Portfolio by the RIA.

clientPortfolioIDstring

A user defined identifier attached to the portfolio.

descriptionstring

A short description for the Portfolio.

userIDstring

The unique identifier of the registered investment advisors account.

isFundTargetsChangedboolean

fundsTargetsChangedboolean

Example response

{
  "id": "portfolio_4a22340a-31f8-4f0e-b5ee-24ddfbc66727",
  "name": "Recession Proof",
  "clientPortfolioID": "-3344.123456789",
  "description": "A portifolio description",
  "holdings": [
    {
      "id": "fund_3d9d00d1-f06e-4f86-9cbf-893c75cf77fe",
      "name": "TECH",
      "type": "FUND",
      "clientFundID": "-3344.123456789",
      "description": "Top 10 US Tech",
      "target": 0.95,
      "holdings": [
        {
          "instrumentID": "5b85fabb-d57c-44e6-a7f6-a3efc760226c",
          "target": 0.5
        }
      ],
      "triggers": [
        {
          "type": "TOTAL_DRIFT",
          "maxAllowed": 0.05,
          "lowerBound": 0.01,
          "upperBound": 0.02
        }
      ]
    }
  ],
  "userID": "66304da9-3h6f-2234-935f-ac6b7933d706",
  "triggers": [
    {
      "type": "TOTAL_DRIFT",
      "maxAllowed": 0.05,
      "lowerBound": 0.01,
      "upperBound": 0.02
    }
  ]
}