DRdrivewealth
Advisor Reports

List Allocations by Advisor

Fetches a user's sub account orders allocations by userID

get/users/{userID}/managed/orders

Request

  • Base URL
    https://bo-api.drivewealth.io/back-office
  • URL
    https://bo-api.drivewealth.io/back-office/users/{userID}/managed/orders
  • 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.

Query parameters

fromstring required

The date and time in which to start from.

tostring required

The date and time in which to end at.

Response

Fetching A user's Sub Account Orders Allocations By userID was Successful.

riaIDstring

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

orderIDstring

A unique DriveWealth order identifier created when an order is placed.

orderNostring

A unique, human-readable DriveWealth order number.

orderType'MARKET' | 'LIMIT' | 'STOP' | 'STOP_LIMIT' | 'MARKET_IF_TOUCHED'

The type of the Order.

createdWhenstring

The createdWhen is the date and time the order was created.

instrumentIDstring uuid

A unique ID created by DriveWealth to identify a specific instrument.

symbolstring nullable

The ticker symbol of the Instrument. Debt Instruments and Global Mutual Funds do not have symbols and are referred to buy their instrumentID or ISIN.

side'B' | 'S' | 'BUY_OPEN' | 'BUY_CLOSE' | 'SELL_OPEN' | 'SELL_CLOSE'

The side of the order.

orderQtynumber

The amount of the instrument in shares.

cumQtynumber

The amount of shares currently being transacted; larger orders may execute in chunks.

avgPxnumber

The average price of the security being transacted in the order.

Example response

[
  {
    "riaID": "123e4567-e89b-12d3-a456-000000000004",
    "orderID": "IC.123e4567-e89b-12d3-a456-000000000049",
    "orderNo": "ZZZZ000025",
    "orderType": "MARKET",
    "createdWhen": "2022-12-11T22:28:21.810Z",
    "instrumentID": "123e4567-e89b-12d3-a456-000000000006",
    "symbol": "MS",
    "side": "B",
    "orderQty": 0.7219,
    "cumQty": 0.7219,
    "avgPx": 1038.81,
    "allocations": [
      {
        "id": "JF.allocation.TendiesTradingCo.123e4567-e89b-12d3-a456-00000000004f",
        "status": "NEW",
        "unallocatedNotional": 5320,
        "unallocatedQuantity": 302
      }
    ]
  }
]

Changes

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