v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB

Trade Allocations

List Trade Allocations by Advisor

Fetches a list of an User's allocations.

get/users/{userID}/managed/allocations

Path parameters

userIDstring required

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

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

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

A way to store a message/comment on the this object.

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.e61f512a-ed9c-4047-9ccf-224a5864158d",
    "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"
  }
]