OrderAllocation

View as MarkdownOpen in Claude

OrderAllocation

FieldTypeDescription
accountstringReferences the Account ID, i.e. U1234567, being allocated to.
positionstringReferences the current position of the account being allocated to.
positionDesiredstringStates the full position increase intended by the current trade.
positionAfterstringSize of the position once the order has been allocated.
desiredAllocQtystringReference the quantity to increase by based on allocation.
allowedAllocQtystringReferences the maximum allowed quantity increase.
isMonetaryboolDenotes whether the order is a monetary allocation (true) or whole share allocation (false).