Portfolio Rebalancer Buy Leg

The following table describes the parameters for this API:

NameDataTypeDescription Mandatory Sample ValueList of possible valuesNo. of decimalsNotes 
unitFractionSizeNumber The is to determine the rounding effect on the number of units.If the broker cannot do fractional shares, the unitFractionSize will be 1, if the broker can do fractional shares, the unitFractionSize will be 0.01Y0.01>02
portfoliosArray of ObjectsDetails of all the portfolios available Y{ "id":1, "threshold":0.2, "breakdown":[ { "investmentProductId":"AGG", "units":2.1, "subscriptionFee":0.01, "redemptionFee":0.01, "marketPrice":104.88, "modelPortfolioWeight":0.2, "minTopupAmt": 0, "maxTopupAmt": 10000, "minRedemptionUnits": 0, "maxRedemptionUnits": 10, "minHoldingUnits": 1 },    ......}
idNumberPortfolio IdentifierY1>00
thresholdNumberThreshold that triggers rebalancing for the portfolioY0.2>=04FE needs to convert the percentage to decimal representation before storing if the input from the front end is given as 20%, 50% etc.
breakdownArray of ObjectsBreakdown of information for every portfolio Y[ { "investmentProductId":"AGG", "units":2.1, "subscriptionFee":0.01, "redemptionFee":0.01, "marketPrice":104.88, "modelPortfolioWeight":0.2, "minTopupAmt": 0, "maxTopupAmt": 10000, "minRedemptionUnits": 0, "maxRedemptionUnits": 10, "minHoldingUnits": 1 },...]
investmentProductIdStringProduct identification codeYAGG, CASH
unitsNumberNumber of units owned for the portfolio Y108
subscriptionFeeNumber Subscription Fee charged for the product Y0.016
redemptionFeeNumber Redemption Fee charged for the productY0.016
marketPriceNumber Current price of the holdingsY31.28
modelPortfolioWeightNumber Weightage of model portfolio Y0.26
minTopupAmtNumber Minimum Top Up amount for this product, imposed by the brokerY0, 100, 500>02
maxTopupAmtNumber Maximum Top Up amount for this product, imposed by the brokerY10000>02
minRedemptionUnitsNumber Minimum Redemption number of units for this product, imposed by the brokerY10>08
maxRedemptionUnitsNumber Maximum Redemption number of units for this product, imposed by the brokerY1000>08
minHoldingUnitsNumberMinimum Holding Units for this product imposed by the brokerY10>08
excludedFundsArray, StringList of all products that are to be excluded from the rebalancing request Y[ "IVW" ,"NEAR"]

The following table describes the output for this API:

NameDataTypeDescription Sample ValueNo. of Decimals*Notes 
idNumberIdentifier for each portfolio that is to be rebalanced10
errorStringError nullnull - will be displayed by default Else any error returned will be displayed 
totalTransactionFeeNumberAggregation of all the fees paid for the products in the portfolio4.54164
investmentProductIdStringProduct identification codeAGG,CASH
currentWeightageNumberCurrent weightage of the product in the portfolio0.7894
modelPortfolioWeightNumberWeightage of the product in the model portfolio 0.24
upperBandNumberThe Upper Band threshold based on the Current Weightage and the Threshold %0.244
lowerBandNumberThe Lower Band threshold based on the Current Weightage and the Threshold %0.164
rebalancingStatusStringRebalancing status of the product which defines whether the product in the portfolio is over or under weightUnderweightOverweightOKValues can be :Underweight - product is less than the model portfolio recommendationOverweight - product is greater than the model portfolio recommendationOK - No change to the current product weights needed
transactionTypeString Type of rebalancing transaction to be performed for the product.BValues can be:B - for BuyS - Sell
roundedUnitDiffAfterFeeAdjustmentNumberDifference in holding units after rebalancing and factoring in fees, rounded to X decimal points3.0910
roundedAmtDiffAfterFeeAdjustmentNumberDifference in holdings (amount) after rebalancing and factoring in fees, rounded to 2 decimal points96.412
feesPaidNumberFees paid for the product 0.96414
passedMinTransactionBooleanValidation on whether Minimum transaction criteria has passed or not.True, FalseList of values allowed:TrueFalse
subscriptionFeeNumberSubscription Fee charged for the product 0.016
redemptionFeeNumberRedemption Fee charged for the product0.016
Language
Authentication
Bearer
Click Try It! to start a request and see the response here!