DRdrivewealth
Trade Allocations

List Trade Allocations by Advisor

Fetches a list of an User's allocations.

get/users/{userID}/managed/allocations

Request

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

Path parameters

userIDstring required

sensitive A unique identifier created for each User on DriveWealth's platform.

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

sensitive The User's unique identifier.

Response

Fetching A List Of A User's Allocation was Successful.

idstring

The unique identifier that identifies the lot of the allocation.

clientListIDstring

sensitive A way to store a message/comment on the this object. Do not put personal or account data in this field.

status'NEW' | 'ACCEPTED' | 'PART_COMPLETE' | 'COMPLETED' | 'REJECTED'

The current status of the lot of allocation.

allocationsRequestednumber

The amount of sub account allocations passed to the system.

allocationsCompletednumber

The amount of completed sub account allocations.

unallocatedNotionalnumber

The notional value of the shares that have not been allocated to sub accounts.

unallocatedQuantitynumber

The remaining amount of shares that have not been allocated to the sub accounts.

commentstring

A custom comment generated by DriveWealth.

createdWhenstring

The date and time of the allocation creation.

Example response

[
  {
    "id": "JF.allocation.TendiesTradingCo.123e4567-e89b-12d3-a456-00000000004f",
    "clientListID": "Hey! Welcome to DriveWealth Developer Docs!",
    "status": "NEW",
    "allocationsRequested": 500,
    "allocationsCompleted": 25,
    "unallocatedNotional": 5320,
    "unallocatedQuantity": 302,
    "comment": "All allocated and accounted for. 1::1::0 client note[empty], . timeMs=667 ratePerSec=1.50 msPerItem=667.00",
    "createdWhen": "2022-12-22T16:04:46.724Z"
  }
]

Changes

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