DRdrivewealth
Trade Allocations

Retrieve Trade Allocation

Retrieves Trade Allocation by allocationID.

get/managed/allocations/{allocationID}

Request

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

Path parameters

allocationIDstring required

The unique identifier returned when a Trade Allocation request is made.

Response

Retrieving Trade Allocation by allocationID was Successful.

idstring

The unique allocationID associated with a specific allocation.

status'NEW' | 'ACCEPTED' | 'PART_COMPLETE' | 'COMPLETE' | 'REJECTED'

Overall status of an allocation.

clientListIDstring

An advisor created identifier for a specific allocation.

accountIDstring

sensitive The account identifier for the RIA master trading account.

accountNostring

sensitive The account number for the RIA master trading account.

createdWhenstring

Date and time of allocation creation.

commentstring

A note created by the RIA upon creating an allocation.

Example response

{
  "id": "JL.allocation.SomeRIACompany.123e4567-e89b-12d3-a456-000000000009",
  "status": "COMPLETE",
  "clientListID": "SUMS_CUSTOM_ALLOCATION_TEST",
  "accountID": "123e4567-e89b-12d3-a456-00000000000f.1234567890127",
  "accountNo": "UUUU000072",
  "createdWhen": "2022-12-22T16:04:46.724Z",
  "allocations": [
    {
      "accountID": "123e4567-e89b-12d3-a456-00000000000e.1234567890126",
      "accountNo": "VVVV000073",
      "status": "FILLED",
      "instrumentID": "123e4567-e89b-12d3-a456-000000000006",
      "symbol": "MS",
      "side": "B",
      "clientComment": "Foo test allocation",
      "qtyRequested": 10,
      "qtyAllocated": 10,
      "avgPx": 126.52
    }
  ],
  "comment": "All allocated and accounted for. 1::1::0 client note[allocating via bo api 1st allocation test]. timeMs=423 ratePerSec=2.36 msPerItem=423.00"
}

Changes

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