Development Guides

Astro Optimizer – Raise/Withdrawal Cash

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.

PropertyDescriptionRequiredDefault
optSrcRequest Source. Use 5 which indicates api user.50
optTypeUse 44
accountIdEclipse Account ID. Note, this is not the same as Orion Account ID.Yes
withdrawAmountAmount in dollars to raise.Yes$0.00
minTrackErrNoPreference Setting
maxCapitalGainsNoPreference Setting
minTradeSizePCTNoPreference Setting
maxTradesNoPreference Setting
includeCashShould current cash balance be included in the Optimization, or should it raise the full amount regardless of cash balance.Nofalse
onlySellSecuritiesNofalse

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,  
}