Trade Instance Fields

Trade Instances have some metadata fields that provide information on how a Trade Instance was created. These fields are optional in most API requests, if they are part of the schema. If they are not in the schema, the API will generally determine those values automatically.

NOTE: These values are for record keeping purposes only. Setting these values in an API request does not guarantee trading behavior. For example, if you generate a Quick Trade using the API and set these values to Tactical Tool values, the instance will show that it came from the Tactical Tool, despite the trade being handled as if it were a Quick Trade.

DO NOT DO THIS: Setting these values incorrectly can be misleading when viewing Trade Instances in the UI. The example below will generate a trade using the Quick Trade tool and the business rules appropriate to a Quick Trade, but the Trade Instance will look as if it came from the Tactical Tool.

POST api/v2/tradeorder/trades

{
    "application": "QuickTrades", //This is what dictates that you are doing a Quick Trade
    "trades": [
        {
            "action": 1,
            "isSendImmediately": false,
            "portfolioId": 227,
            "accountId": 127,
            "tradeShares": null,
            "tradePercent": null,
            "tradeAmount": 2100.57,
            "securityId": 13
        }
    ],
    "tradeToolSelection": 10, //10=Tactical Tool
    "tradeInstanceType": 7, //7=Tactical Tool
    "tradeInstanceSubType": 15 //15=Tactical Tool
}

Trade Instance Selection Method

Selection Method indicates which method was used to determine what Accounts were selected for trading.

Id	Value
1	Portfolio
2	Account
3	Model
4	Account Trade Group
5	Sleeve Portfolio
6	Excel Import
7	Portfolio Trade Group
8	Security Import
9	Individual Sleeve
10	Tactical Tool

Trade Instance Type

Id	Value
1	Astro
2	Cash Movements
3	Global Trades
4	Option Trading*
5	Quick Trade
6	Rebalance
7	Tactical Tool
8	Tax Harvesting
9	Tax Ticker Swap
10	Trade to Target
11	Liquidate

Trade Instance Sub Type

Id	Value
1	Automated Losses
2	ASTRO
3	Cash Needs
4	Focused Rebalance
5	Full Location Rebalance
6	Global Trades
7	Manual Gains
8	Manual Losses
9	Option Trading*
10	Partial Location Rebalance
11	Quick Trade
12	Raise Cash
13	Spend Cash
14	Standard Rebalance
15	Tactical Tool
16	Tax Ticker Swap
17	Trade Import
18	Trade to Target
19	Journal Only Cash
20	Journal Cash and Holdings
21	Money Market Rebalance
22	Liquidate