v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB

AutoPilot

Retrieve Portfolio by Account

Retrieve Portfolio details by accountID.

get/accounts/{accountID}/portfolio

Path parameters

accountIDstring required

The user's unique account identifier.

Example:cc07f91b-7ee1-4868-b8fc-823c70a1b932.1407775317759

Response

Fetching Portfolio details was Successful.

idstring

The unique identifier of a portfolio.

equitynumber

The account value of the customers account.

totalDriftnumber

Total drift away from target.

rebalanceRequiredboolean

A flag that determines if a re-balance is required based on total drift.

nextPortfolioRebalancestring

The date of the next portfolio re-balance.

lastPortfolioRebalancestring

The date of the last portfolio rebalance.

Example response

{
  "id": "portfolio_87fec25f-c350-4a53-83a0-fc6be0c2989e",
  "equity": 11003.76,
  "totalDrift": 0.012,
  "rebalanceRequired": true,
  "nextPortfolioRebalance": "2018-12-11T15:00:00.846Z",
  "lastPortfolioRebalance": "2017-12-11T15:00:00.846Z",
  "holdings": [
    {
      "id": "fund_4c16152c-f8e7-4a5a-af6b-c36f4e5cc6e7",
      "type": "FUND",
      "name": "Large Capitalization Fund",
      "target": 0.75,
      "actual": 0.3054,
      "value": 33604.12,
      "rebalanceRequired": true,
      "holdings": [
        {
          "instrumentID": "5b85fabb-d57c-44e6-a7f6-a3efc760226c",
          "target": 0.5
        }
      ]
    }
  ]
}