Mutual Funds Analytics

With Mutual Fund Holdings Import, you can easily import the user's mutual funds summary and transaction data on your platform through webhooks

Analytics ✨

smallcase Gateway now provides an API, through which one can add on analytics over the mutual funds summary data on scheme level, as well as meta information on the transactions

How?

To add on the analytics on the response received from the Mutual Fund Holdings Import, one can pass the summary and transactions in the request body received from the webhook response as shown in the below snippets as an input to the Analytics API

Request body structure

{
  "gateway": "gatewaydemo",
  "requestId": "something13",
  "data": {
    "format": "SMALLCASE",
    "payload": {
      "summary": { // <--- this would be the summary object received in webhooks response
        ....
        ....
        ....
      },
      "transactions": [ // <--- this would be the transactions array received in webhooks response
        ....
        ....
        ....
      ]
    }
  }
}

What's new?

Here are all the fields that are shared as a part of smallcase Gateway’s Mutual Fund Holdings Import analytics API and what they mean:

XIRR i.e Extended Internal Rate of Return calculates returns on investments from all the transactions made by the user.
Invested value is the sum invested by an investor in a scheme.
Current returns is the return generated by the investment made by a user in a given scheme.
FundType is a broad categorisation of the scheme into Equity, Gold, ELSS, or Debt depending on the underlying asset.
averagePrice refers to the average purchase price of each unit for the investor in a scheme.
Scheme weight is the ratio of the scheme w.r.t. the current value of the portfolio.
nav is the last closed net asset value.
Realised returns are returns on the investment booked by the user from sell and dividends.
Total returns is sum of current and realised returns.
Sector allocation represents the broad sectors in which sum is invested.

Note:

Current returns, total returns, realised returns, sector allocation and XIRR will be shared both at the scheme level and portfolio level.
The rest of the analytics data points will be shared at the scheme level only.
Analytics will only be available for those folios, which don't have number of units and currentValue as zero. The folios with currentValue: 0 and units: 0, will be shown under the data.summary.exited array
The analytics api can be used to update the analytics field periodically, without refreshing the mutual fund holdings of the user i.e. summary and transactions derived for a previous import can be used.
Exited folios/ funds are not included in the analytics.
Folio/ fund level XIRR is calculated when the first investment is at least 1 year old.
Portfolio XIRR is calculated when at least one fund in the portfolio is older than 1 year old.

Response object

field	type	description
data.summary.schemeDetails	SchemeDetails	Array of scheme details
data.summary.schemeDetails.portfolio	Portfolio	Portfolio Summary
data.summary.exited		Includes those folios, which have currentValue and units as zero [No analytics are added for it]
data.transactions	Transactions	Array of all the transactions

Object.data.summary.schemeDetails

field	type	description
isin	string	A 12-digit alphanumeric code that uniquely identifies a specific security
folios	array	Array of folios
scheme	string	Scheme name
schemeCode	string	Scheme code
amc	string	Amc name
amcCode	string	Amc code
assetType	string	Asset type
currentValue	number	Current value of the scheme
exitLoad	string	Exit load remarks
entryLoad	string	Entry load remarks
units	number	Number of units for the scheme
nav	number	Net asset value of the scheme
analytics	Analytics	Analytics object
fundType	string	Type of fund
exitLoadRemarks	string	Exit load remarks

Object.data.summary.schemeDetails.folios

field	type	description
folioNumber	string	Folio number of the scheme
brokerName	string	Name of the broker
brokerCode	string	Broker code
units	number	Number of units associated with the folio
isDemat	boolean
investedValue	number	Invested amount in the scheme
currentValue	number	Current Value
currentReturns	number	Current returns
totalReturns	number	Total returns
realisedReturns	number	Realised returns
averagePrice	number	AveragePrice of the scheme
currentReturnsPercentage	number	Current returns percentage
xirr	number	Folio level xirr
rtaCode	string
kycStatus	string	KYC verified status 3 - Verified
email	string
decimalUnits	number	Decimal Units- Up to 3 decimal Points
decimalAmount	number	Decimal Units for Amount – Upto 2 decimal Points
decimalNav	number	Decimal Units for NAV – upto 4 decimal Points
lastTrxnDate	string	Last Transaction Date
openingBal	number	Opening Balance of the holdings
closingBal	string	closing Balance of the holdings
lastNavDate	string	Last NAV Date – which is available for the scheme

Object.data.summary.schemeDetails.analytics

field	type	description
timestamp	string	Timestamp of the response
xirr	number	Scheme level xirr
investedValue	number	Invested amount in the scheme
currentReturns	number	Current returns
averagePrice	number	AveragePrice of the scheme
currentReturnsPercentage	number	Current returns percentage
schemeWeight	number	Scheme weight is the ratio of the scheme w.r.t. the current value of the portfolio.
realisedReturns	number	Realised returns
totalReturns	number	Total returns
sectorAllocationPercentage	array	Sector allocation percentage

Object.data.summary.schemeDetails.analytics.sectorAllocationPercentage

field	type	description
sectorName	string	Sector name
value	number	Sector value

Object.data.summary.portfolio

field	type	description
xirr	number	Portfolio level xirr
schemeCount	number	Total scheme count
currentReturns	number	Current returns
realisedReturns	number	Realised returns
totalReturns	number	Total returns
sectorAllocationPercentage	array	Sector allocation percentage

Object.data.summary.portfolio.sectorAllocationPercentage

field	type	description
sectorName	string	Sector name
value	number	Sector value

Object.data.transactions

field	type	description
isin	string	a 12-digit alphanumeric code that uniquely identifies a specific security
folioNumber	string	Folio number
amc	string	Amc name
amcCode	string	Amc code
schemeCode	string	Scheme code
scheme	string	Scheme name
transactionDate	string	Transaction date
postedDate	string	Date at which transaction was posted
trxnDescription	string	Transaction Description – Possible values – Purchase, Redemption, Switch, SIP & NFTs description
trxnUnits	number	Transaction amount
purchasePrice	number	NAV – at which the Transaction was executed
stampDuty	number	Stamp Duty applied charges
totalTax	number	Total tax deducted
transactionMode	string	Transaction Mode Possible Values - "N - Normal ", M - missed , R - Reversal
cashFlow	string	Possible Values - "SELL" , "DEPOSIT"
checkDigit	number
email	string	email id
trxnCharge	number
sttTax	number
tax	number
analytics	Analytics	Analytics object

Object.data.transaction.analytics

field	type	description
transactionType	string	Type of transaction Possible values : [DEPOSIT, WITHDRAW, REJECTED DEPOSIT, NA]
transactionStatus	string	Status of the transaction Possible values : [SUCCESS, ADJUSTMENT, VOID]
transactionDescription	string	Transaction description Eg. PURCHASE, REDEMPTION, SIP, DIVIDEND, SWITCH IN, SWITCH OUT, REJECTED….
exited	boolean	Denotes whether the transaction belongs to an exited folio or not for exited ones, analytics are not derived