Minimum Trade Sizes
Minimum trade sizes set the smallest trade amount AdviceCloud uses when it builds trade proposals.
You can set a minimum for a security symbol, for a security type, or for your whole firm. When more than one applies to a security, the most specific wins:
- Security symbol, such as
VTI - Security type: one of
Alternative,Bond,Cash,Cash Equivalent,Crypto,Equity,ETF,Fund,Mutual Fund,Stock,Unknown - Firm-wide: no symbol and no type. A firm has at most one.
To see which minimum applies to a security, call Get the minimum for a security. To check an amount, call Validate a trade amount.
List minimum trade sizes
Returns your firm's minimum trade sizes, most specific first: symbol minimums, then security type minimums, then the firm-wide minimum.
Create a minimum trade size
Creates a minimum trade size. Send `securitySymbol` for a symbol minimum, `securityType` for a security type minimum, or neither for the firm-wide minimum. Your firm can have one minimum for each symbol, one for each security type, and one firm-wide.
Get the minimum for a security
Returns the minimum trade amount that applies to a security: the symbol minimum if your firm has one, otherwise the security type minimum, otherwise the firm-wide minimum. Returns `0` when no minimum applies.
Update a minimum trade size
Updates the minimum trade size with the given ID. Fields you leave out keep their current values. If your firm has no minimum trade size with that ID, nothing changes and the response is status `200` with the body `{}`.
Delete a minimum trade size
Deletes the minimum trade size with the given ID. Returns `200` with `deleted: true`, or `deleted: false` if your firm has no minimum trade size with that ID.
Validate a trade amount
Checks a trade amount against the minimum that applies to a security. Nothing is saved. The minimum is chosen the same way as in **Get the minimum for a security**. An amount is valid when its absolute value is at least the minimum, or when no minimum applies.