Retrieve Autopilot Run

get deprecatedhttps://bo-api.drivewealth.io/back-office/managed/autopilot/{rebalanceRunID}

Retrieves an Autopilot Run by rebalanceRunID.

Please note that DriveWealth will replace this API with an improved solution in 2025.

Response

Response body

object

string

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

riaID

string

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

status

string

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

updated

string

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

created

string

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

moneyMovement

boolean

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

regularRebalance

boolean

Was this run part of the regular AutoPilot rebalancing process?

reviewOnly

boolean

orders

object

An object containing the details of submitted orders for the re-balance.

total

number

Total number of orders submitted.

submitted

string

Amazon S3 download containing the details of each submitted order.

outcome

string

Amazon S3 download containing the status and final outcome of the orders that were submitted.

amountBuys

number

An aggregate value of all buy orders. Expect a negative number.

amountSells

number

An aggregate value of all sell orders.

cleanedUp

string

allocations

object

An object containing the details of the allocations in a re-balance.

submitted

string

Amazon S3 download containing the details of each submitted allocation.

outcome

string

Amazon S3 download containing the status and final outcome of each allocation that was submitted.

subAccounts

object

An object containing details on user accounts and their holdings.

total

number

The total number of user accounts under the advisor.

rebalanced

number

The total number of user accounts that were rebalanced.

error

number

The total number of allocation errors at the users account level during the rebalance.

outcome

string

Amazon S3 download containing the final outcome of the rebalance, includes users account details and their holdings.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://bo-api.drivewealth.io/back-office/managed/autopilot/rebalanceRunID \
3
     --header 'accept: application/json' \
4
     --header 'dw-client-app-key: {{yourAppKey}}'


xxxxxxxxxx
28
}
1
{
2
  "id": "ria_rebalance_ebf7e764-e2d6-4b3d-a333-b8ff05b92b89",
3
  "riaID": "66304da9-3h6f-2234-935f-ac6b7933d706",
4
  "status": "REBALANCE_NOT_STARTED",
5
  "updated": "2022-12-27T06:07:28.955Z",
6
  "created": "2022-12-27T06:06:28.955Z",
7
  "moneyMovement": true,
8
  "regularRebalance": true,
9
  "reviewOnly": true,
10
  "orders": {
11
    "total": 0,
12
    "submitted": "https://uat.drivewealth.autopilot.s3.amazonaws.com/44304da9....",
13
    "outcome": "https://uat.drivewealth.autopilot.s3....",
14
    "amountBuys": -1059.35,
15
    "amountSells": 862.69,
16
    "cleanedUp": null
17
  },
18
  "allocations": {
19
    "submitted": "https://uat.drivewealth.autopilot.s3....",
20
    "outcome": "https://uat.drivewealth.autopilot.s3...."
21
  },
22
  "subAccounts": {
23
    "total": 4,
24
    "rebalanced": 3,
25
    "error": 0,

200Retrieving an Autopilot Run by rebalanceRunID was Successful.