v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB

Trade Allocations

Retrieve Trade Allocation

Retrieves Trade Allocation by allocationID.

get/managed/allocations/{allocationID}

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

The account identifier for the RIA master trading account.

accountNostring

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.9d6def3b-14d7-4934-8a64-57d443e67ce6",
  "status": "COMPLETE",
  "clientListID": "SUMS_CUSTOM_ALLOCATION_TEST",
  "accountID": "66304da9-3d6f-4253-935f-ac6b7933d701.1619201263789",
  "accountNo": "ZYXB000008",
  "createdWhen": "2022-12-22T16:04:46.724Z",
  "allocations": [
    {
      "accountID": "743a1018-e292-449c-a43f-58d657990db0.1671689261882",
      "accountNo": "ZYXC000008",
      "status": "FILLED",
      "instrumentID": "3fb1e8a9-f7d5-4d90-95e2-43e7326b5636",
      "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"
}