The purpose of this article is to show how to run a raise cash optimization using Astro to optimize towards a tax efficient withdrawal of cash of a target amount.
Property | Description | Required | Default |
optSrc | Request Source. Use 5 which indicates api user. | 5 | 0 |
optType | Use 4 | 4 | |
accountId | Eclipse Account ID. Note, this is not the same as Orion Account ID. | Yes | |
withdrawAmount | Amount in dollars to raise. | Yes | $0.00 |
minTrackErr | No | Preference Setting | |
maxCapitalGains | No | Preference Setting | |
minTradeSizePCT | No | Preference Setting | |
maxTrades | No | Preference Setting | |
includeCash | Should current cash balance be included in the Optimization, or should it raise the full amount regardless of cash balance. | No | false |
onlySellSecurities | No | false |
URL
POST https://test.orioneclipse.com/api/v2/Account/AstroAccounts/WithdrawCash
Example Payload – FULL
{
"accountId": "1505",
"withdrawAmount": 15000,
"maxTrackErr": 5,
"minTrackErr": 1,
"maxCapitalGains": 1000000,
"minTradeSizePCT": 0,
"maxTrades": 2000000,
"includeCash": false,
"onlySellSecurities": false
}
Example Payload – Minimum
{
"accountId": "1505",
"withdrawAmount": 15000,
}