Portfolio Security Preferences:
Getting current security preferences for a specific portfolio is a two step process:
First, make a GET call to https://www.orioneclipse.com/v1/preference/Portfolio/51171, where 51171 is the Portfolio ID, and from the response look for the name “securitySetting”. Take the ID and Preference ID from the response to use in the next call.
{
“id”: 10865,
“preferenceId”: 103,
“categoryType”: “Security Setting”,
“subCategoryType”: null,
“name”: “securitySetting”,
“displayName”: “Security Setting”,
“required”: null,
“displayOrder”: 1001,
“valueType”: “hidden”,
“value”: null,
“indicatorValue”: null,
“isInherited”: true,
“inheritedValue”: null,
“inheritedIndicatorValue”: null,
“inheritedFrom”: “Firm”,
“inheritedFromName”: “”,
“inheritedFromId”: 1100,
“inheritedFromValueId”: 10771,
“options”: [],
“selectedOptions”: [],
“inheritedSelectedOptions”: [],
“indicatorOptions”: [],
“componentType”: “custom”,
“componentName”: “SecurityDataGrid”,
“minlength”: null,
“maxlength”: null,
“minValue”: null,
“maxValue”: null,
“pattern”: null,
“watermarkText”: null,
“symbol”: null,
“helpText”: null,
“requireSuperAdmin”: 0
}
Then to get security preferences that are applied to a portfolio, you can make a GET call to https://www.orioneclipse.com/v1/preference/Portfolio/securityPreference/51171/103/10865/10771. (51171=Portfolio ID, 103=Preference ID from above call, 10865=ID from above call, 10771=Inherited Value ID from above). Below is an example of the response you’ll get back showing the security name and symbol that are restricted.
{
“levelName”: “Portfolio”,
“recordId”: 51171,
“id”: 10865,
“preferenceId”: 103,
“name”: “securitySetting”,
“displayName”: “Security Setting”,
“categoryType”: “Security Setting”,
“componentType”: “custom”,
“componentName”: “SecurityDataGrid”,
“securityPreferences”: [
{
“id”: 4345,
“securityName”: “American Growth Fund of America F2”,
“securityType”: “Mutual Fund”,
“symbol”: “GFFFX”,
“alternateCustodianId”: null,
“custodianName”: null,
“taxableSecurityId”: null,
“taxableSecurity”: null,
“taxDeferredSecurityId”: null,
“taxDeferredSecurity”: null,
“taxExemptSecurityId”: null,
“taxExemptSecurity”: null,
“custodianSecuritySymbolId”: null,
“tBuyPriority”: null,
“tdBuyPriority”: null,
“teBuyPriority”: null,
“tSellPriority”: null,
“tdSellPriority”: null,
“teSellPriority”: null,
“astroRestrictionMax”: 0,
“astroRestrictionMin”: 0,
“buyPriority”: 1,
“buyTradeMaxAmtBySecurity”: null,
“buyTradeMaxPctBySecurity”: null,
“buyTradeMinAmtBySecurity”: null,
“buyTradeMinPctBySecurity”: null,
“buyTransactionFee”: null,
“capGainReinvestTaxable”: null,
“capGainsReinvestTaxDef”: null,
“capGainsReinvestTaxExempt”: null,
“coveredCallPercent”: null,
“custodianRedemptionDays”: null,
“custodianRedemptionFeeAmount”: null,
“custodianRedemptionFeeMaxAmount”: null,
“custodianRedemptionFeeMinAmount”: null,
“custodianRedemptionFeeTypeId”: null,
“doNotTLH”: null,
“excludeHolding”: null,
“minInitialBuyAmount”: null,
“optionsExpiringSoonDays”: null,
“optionTradingStrikePrice”: null,
“protectivePutCashPercent”: null,
“protectivePutPercent”: null,
“redemptionFeeAmount”: null,
“redemptionFeeDays”: null,
“redemptionFeeMaxAmount”: null,
“redemptionFeeMinAmount”: null,
“redemptionFeeTypeId”: null,
“securityEquivalent”: null,
“sellPriority”: 7,
“sellTradeMaxAmtBySecurity”: null,
“sellTradeMaxPctBySecurity”: null,
“sellTradeMinAmtBySecurity”: null,
“sellTradeMinPctBySecurity”: null,
“sellTransactionFee”: null,
“taxableAlternate”: null,
“taxableDivReInvest”: null,
“taxDefDivReinvest”: null,
“taxDeferredAlternate”: null,
“taxExemptAlternate”: null,
“taxExemptDivReinvest”: null,
“tlhAlternative”: null,
“tradeSettingByAccountType”: null,
“isRestricted”: 0,
“tlh”: [],
“alternatives”: [],
“equivalents”: [],
“astroRestrictionType”: 2
},
{
“id”: 96,
“securityName”: “International Business Machines”,
“securityType”: “Equity”,
“symbol”: “IBM”,
“alternateCustodianId”: null,
“custodianName”: null,
“taxableSecurityId”: null,
“taxableSecurity”: null,
“taxDeferredSecurityId”: null,
“taxDeferredSecurity”: null,
“taxExemptSecurityId”: null,
“taxExemptSecurity”: null,
“custodianSecuritySymbolId”: null,
“tBuyPriority”: 0,
“tdBuyPriority”: 0,
“teBuyPriority”: 0,
“tSellPriority”: 0,
“tdSellPriority”: 0,
“teSellPriority”: 0,
“astroRestrictionMax”: null,
“astroRestrictionMin”: null,
“buyPriority”: 1,
“buyTradeMaxAmtBySecurity”: null,
“buyTradeMaxPctBySecurity”: null,
“buyTradeMinAmtBySecurity”: null,
“buyTradeMinPctBySecurity”: null,
“buyTransactionFee”: null,
“capGainReinvestTaxable”: null,
“capGainsReinvestTaxDef”: null,
“capGainsReinvestTaxExempt”: null,
“coveredCallPercent”: null,
“custodianRedemptionDays”: null,
“custodianRedemptionFeeAmount”: null,
“custodianRedemptionFeeMaxAmount”: null,
“custodianRedemptionFeeMinAmount”: null,
“custodianRedemptionFeeTypeId”: null,
“doNotTLH”: null,
“excludeHolding”: null,
“minInitialBuyAmount”: null,
“optionsExpiringSoonDays”: null,
“optionTradingStrikePrice”: null,
“protectivePutCashPercent”: null,
“protectivePutPercent”: null,
“redemptionFeeAmount”: null,
“redemptionFeeDays”: null,
“redemptionFeeMaxAmount”: null,
“redemptionFeeMinAmount”: null,
“redemptionFeeTypeId”: null,
“securityEquivalent”: null,
“sellPriority”: 7,
“sellTradeMaxAmtBySecurity”: null,
“sellTradeMaxPctBySecurity”: null,
“sellTradeMinAmtBySecurity”: null,
“sellTradeMinPctBySecurity”: null,
“sellTransactionFee”: null,
“taxableAlternate”: null,
“taxableDivReInvest”: null,
“taxDefDivReinvest”: null,
“taxDeferredAlternate”: null,
“taxExemptAlternate”: null,
“taxExemptDivReinvest”: null,
“tlhAlternative”: null,
“tradeSettingByAccountType”: null,
“isRestricted”: 1,
“tlh”: [],
“alternatives”: [],
“equivalents”: [],
“astroRestrictionType”: 2
}
],
“inheritedSecurityPreferences”: []
}
Account Security Preferences:
To get security preferences for an account is similar to getting portfolio security preferences. Start by making a GET call to https://www.orioneclipse.com/v1/preference/Account/78416, where 78416 is the Eclipse Account ID. That returns all preferences for the account. In the response, there you’ll have the below section which provides the ID and Preference ID to use in your next call.
{
“id”: 10833,
“preferenceId”: 103,
“categoryType”: “Security Setting”,
“subCategoryType”: null,
“name”: “securitySetting”,
“displayName”: “Security Setting”,
“required”: null,
“displayOrder”: 1001,
“valueType”: “hidden”,
“value”: null,
“indicatorValue”: null,
“isInherited”: true,
“inheritedValue”: null,
“inheritedIndicatorValue”: null,
“inheritedFrom”: “Portfolio”,
“inheritedFromName”: “Pedicino, Test 7_36042”,
“inheritedFromId”: 51151,
“inheritedFromValueId”: 10831,
“options”: [],
“selectedOptions”: [],
“inheritedSelectedOptions”: [],
“indicatorOptions”: [],
“componentType”: “custom”,
“componentName”: “SecurityDataGrid”,
“minlength”: null,
“maxlength”: null,
“minValue”: null,
“maxValue”: null,
“pattern”: null,
“watermarkText”: null,
“symbol”: null,
“helpText”: null,
“requireSuperAdmin”: 0
},
Then to get security preferences that are applied to an account, you can make a GET call to https://www.orioneclipse.com/v1/preference/Account/securityPreference/78416/103/10833/10831. (78416=Eclipse Account ID, 103=Preference ID from above call, 10833=ID from above call, 10831=Inherited Value ID from above). Below is an example of the response you’ll get back showing the security name and symbol along with the preference that is set.
{
“levelName”: “Account”,
“recordId”: 78416,
“id”: 10833,
“preferenceId”: 103,
“name”: “securitySetting”,
“displayName”: “Security Setting”,
“categoryType”: “Security Setting”,
“componentType”: “custom”,
“componentName”: “SecurityDataGrid”,
“securityPreferences”: [
{
“id”: 1952,
“securityName”: “Meta Platforms Inc”,
“securityType”: “Equity”,
“symbol”: “META”,
“alternateCustodianId”: null,
“custodianName”: null,
“taxableSecurityId”: null,
“taxableSecurity”: null,
“taxDeferredSecurityId”: null,
“taxDeferredSecurity”: null,
“taxExemptSecurityId”: null,
“taxExemptSecurity”: null,
“custodianSecuritySymbolId”: null,
“tBuyPriority”: null,
“tdBuyPriority”: null,
“teBuyPriority”: null,
“tSellPriority”: null,
“tdSellPriority”: null,
“teSellPriority”: null,
“astroRestrictionMax”: 0,
“astroRestrictionMin”: 0,
“buyPriority”: 2,
“buyTradeMaxAmtBySecurity”: null,
“buyTradeMaxPctBySecurity”: null,
“buyTradeMinAmtBySecurity”: null,
“buyTradeMinPctBySecurity”: null,
“buyTransactionFee”: null,
“capGainReinvestTaxable”: null,
“capGainsReinvestTaxDef”: null,
“capGainsReinvestTaxExempt”: null,
“coveredCallPercent”: null,
“custodianRedemptionDays”: null,
“custodianRedemptionFeeAmount”: null,
“custodianRedemptionFeeMaxAmount”: null,
“custodianRedemptionFeeMinAmount”: null,
“custodianRedemptionFeeTypeId”: null,
“doNotTLH”: null,
“excludeHolding”: null,
“minInitialBuyAmount”: null,
“optionsExpiringSoonDays”: null,
“optionTradingStrikePrice”: null,
“protectivePutCashPercent”: null,
“protectivePutPercent”: null,
“redemptionFeeAmount”: null,
“redemptionFeeDays”: null,
“redemptionFeeMaxAmount”: null,
“redemptionFeeMinAmount”: null,
“redemptionFeeTypeId”: null,
“securityEquivalent”: null,
“sellPriority”: 6,
“sellTradeMaxAmtBySecurity”: null,
“sellTradeMaxPctBySecurity”: null,
“sellTradeMinAmtBySecurity”: null,
“sellTradeMinPctBySecurity”: null,
“sellTransactionFee”: null,
“taxableAlternate”: null,
“taxableDivReInvest”: null,
“taxDefDivReinvest”: null,
“taxDeferredAlternate”: null,
“taxExemptAlternate”: null,
“taxExemptDivReinvest”: null,
“tlhAlternative”: null,
“tradeSettingByAccountType”: null,
“tlh”: [],
“alternatives”: [],
“equivalents”: [],
“astroRestrictionType”: 4
}
],
“inheritedSecurityPreferences”: []
}
Getting Buy and Sell Priority Values:
For Buy Priority and Sell Priority you can use the below two endpoints:
GET – https://www.orioneclipse.com/v1/security/securityset/buypriority
GET – https://www.orioneclipse.com/v1/security/securityset/sellpriority
Security Preference Audit History:
Getting security preference changes for all securities in the database can be retrieved through the API by making a GET call to https://www.orioneclipse.com/v1/auditlog/preference/custom/securitySetting?toDate=2024-10-16&fromDate=2023-01-01. You can change the “toDate” and “fromDate” in the call as needed.