DRdrivewealth
AutoPilot

Retrieve Portfolio by Account

Retrieve Portfolio details by accountID.

get/accounts/{accountID}/portfolio

Request

  • Base URL
    https://bo-api.drivewealth.io/back-office
  • URL
    https://bo-api.drivewealth.io/back-office/accounts/{accountID}/portfolio
  • Auth
    HTTP bearer

Path parameters

accountIDstring required

sensitive The user's unique account identifier.

Example:123e4567-e89b-12d3-a456-000000000004.1234567890125

sensitive

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_123e4567-e89b-12d3-a456-000000000051",
  "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_123e4567-e89b-12d3-a456-000000000050",
      "type": "FUND",
      "name": "Large Capitalization Fund",
      "target": 0.75,
      "actual": 0.3054,
      "value": 33604.12,
      "rebalanceRequired": true,
      "holdings": [
        {
          "instrumentID": "123e4567-e89b-12d3-a456-000000000003",
          "target": 0.5
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.