DRdrivewealth
AutoPilot

Retrieve Autopilot Run

Retrieves an Autopilot Run by rebalanceRunID.

get/managed/autopilot/{rebalanceRunID}

Request

  • Base URL
    https://bo-api.drivewealth.io/back-office
  • URL
    https://bo-api.drivewealth.io/back-office/managed/autopilot/{rebalanceRunID}
  • Auth
    HTTP bearer

Path parameters

rebalanceRunIDstring required

The unique re-balance run identifier rebalanceRunID associated with a specific re-balance.

Response

Retrieving an Autopilot Run by rebalanceRunID was Successful.

idstring

The unique re-balance run identifier rebalanceRunID associated with a specific re-balance.

riaIDstring

This is the parentIBID or userID of the registered investment advisor creating the re-balance run.

statusstring

Status of the re-balance run. See Autopilot Run Status for status values.

updatedstring

A timestamp of when the re-balance run was updated.

createdstring

A timestamp of when the re-balance run was created.

moneyMovementboolean

Was this run part of the regular AutoPilot money movement process?

regularRebalanceboolean

Was this run part of the regular AutoPilot rebalancing process?

reviewOnlyboolean

Example response

{
  "id": "ria_rebalance_123e4567-e89b-12d3-a456-000000000012",
  "riaID": "123e4567-e89b-12d3-a456-000000000167",
  "status": "REBALANCE_NOT_STARTED",
  "updated": "2022-12-27T06:07:28.955Z",
  "created": "2022-12-27T06:06:28.955Z",
  "moneyMovement": true,
  "regularRebalance": true,
  "reviewOnly": true,
  "orders": {
    "submitted": "https://example-bucket.s3.amazonaws.com/44304da9....",
    "outcome": "https://example-bucket.s3....",
    "amountBuys": -1059.35,
    "amountSells": 862.69
  },
  "allocations": {
    "submitted": "https://example-bucket.s3....",
    "outcome": "https://example-bucket.s3...."
  },
  "subAccounts": {
    "total": 4,
    "rebalanced": 3,
    "outcome": "https://example-bucket.s3...."
  }
}

Changes

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