API Endpoints
Try Demo

Fetch smallcase investments

get https://gatewayapi.smallcase.com/v1//engine/user/investments

The API provides the list of all the user smallcase investment details or returns the user investment details for a particular smallcase, provided a particular iscid in query param. Data like the current config of the smallcase, stats, returns, smallcase description, and much more is shared.

If query param "aggregatedData" is provided, the API shares user’s aggregated investment details. “data” object field containing aggregated data would be returned.

Use case: This is an ideal data api when you want to display information to a user about the investments that have been made by the user

NOTE:

  • authToken must contain smallcaseAuthId in the payload.
  • iscid passed should be associated with the smallcaseAuthId otherwise no data would be returned.

Sample responses when aggregatedData query param is provided as true.

{
    "success": true,
    "errors": null,
    "data": {
        "aggregated": {
            "currentInvestment": 22,
            "currentReturns": 1.7,
            "networth": 23.7,
            "totalReturns": 1.7,
            "currentReturnsPercent": 7.73,
            "totalReturnsPercent": 7.73
        }
    }
}

{
    "success": true,
    "errors": null,
    "data": {
        "aggregated": []
    }
}

{
    "success": true,
    "errors": null,
    "data": {
        "aggregated": {
            "currentInvestment": 0,
            "currentReturns": 0,
            "networth": 0,
            "totalReturns": 0,
            "currentReturnsPercent": null,
            "totalReturnsPercent": null
        }
    }
}

📘

Understanding smallcase returns

Performance metrics that help user track smallcase investments better - https://www.smallcase.com/blog/investment-details-explained/


Request parameters

OLD RESPONSE: HIDDEN ```json { "success": true, "errors": null, "data": [ { "investment": { "currentConfig": { "constituents": [ { "averagePrice": 23.35, "shares": 4, "returns": 0.16402569593147742, "ticker": "ICICINXT50", "stockName": "ICICI Prudential Nifty Next 50 ETF" }, { "averagePrice": 79.77, "shares": 2, "returns": 0.17838786511219762, "ticker": "ICICILOVOL", "stockName": "ICICI Prudential Nifty 100 Low Vol 30 ETF" }, { "averagePrice": 46.4, "shares": 2, "returns": 0.24181034482758618, "ticker": "ICICINV20", "stockName": "ICICI Prudential NV20 ETF" } ] }, "returns": { "networth": 411.96000000000004, "unrealizedInvestment": 345.74, "realizedInvestment": 102, "realizedReturns": 11.950000000000003, "otherReturns": 0, "divReturns": 0, "accruedDivReturns": 0, "creditedDivReturns": 0, "weekly": 0, "monthly": 0 }, "stats": { "indexValue": 117.45879304953768, "lastCloseIndex": 117.95014964041633, "pe": 0, "lastWeekCloseIndex": 117.95014964041633, "lastToLastWeekCloseIndex": 119.5671595122169, "lastMonthCloseIndex": 117.65980256398802 }, "flags": { "amoPending": false, "private": false, "sip": false }, "date": "2020-03-12T12:30:21.809Z", "name": "ICICI Prudential Leaders", "scid": "ICIET_0002", "shortDescription": "Large cap focused ETFs for long term investing", "status": "INVALID", "version": 2, "iscid": "5e6a2b5d47e01c078674dcb6", "imageUrl": "https://assets.smallcase.com/images/smallcases/200/ICIET_0002.png", "recommendedAction": "FIX" }, "actions": { "rebalance": [ { "iscid": "5847d5bef67ce42096d334e0", "scid": "SCTR_0003", "date": "2020-09-16T00:00:00.000Z", "name": "smallcase Energy Tracker", "label": "Quarterly Update: Stocks Change", "version": 18, "rationale": "To continue reflecting the underlying theme of this smallcase, stocks have been updated for the next quarter", "hidden": false } ], "fix": [ { "hidden": false, "iscid": "5e6a2b5d47e01c078674dcb6", "date": "2020-09-01T04:00:23.733Z", "name": "ICICI Prudential Leaders", "batchId": "5f4d2677881dcf775275b291", "scid": "ICIET_0002", "source": "PROFESSIONAL", "filled": 0, "quantity": 3, "originalLabel": "SELLALL" } ], "sip": [ { "iscid": "587477d0ea8b853038ecb003", "scid": "SCMO_0020", "name": "Growth at a Fair Price - Low-Cost Version", "source": "PROFESSIONAL", "frequency": "1m", "amount": 5000, "scheduledDate": "2021-02-22T00:00:00.000Z" } ] } }, { "investment": { "currentConfig": { "constituents": [] }, "returns": { "networth": 0, "unrealizedInvestment": 0, "realizedInvestment": 0, "realizedReturns": 0, "otherReturns": 0, "divReturns": 0, "accruedDivReturns": 0, "creditedDivReturns": 0, "weekly": 0, "monthly": 0 }, "stats": { "indexValue": null, "lastCloseIndex": 100, "pe": 0, "lastToLastWeekCloseIndex": 100, "lastWeekCloseIndex": 100, "lastMonthCloseIndex": 100 }, "flags": { "amoPending": false, "private": false }, "date": "2020-07-01T12:58:42.493Z", "name": "ICICI Prudential Smart", "scid": "ICIET_0003", "shortDescription": "Smart ETFs for investing in companies using factors like Volatility and Value", "status": "INVALID", "version": 2, "iscid": "5efc88821f7eb1540eab4fef", "imageUrl": "https://assets.smallcase.com/images/smallcases/200/ICIET_0003.png", "recommendedAction": "FIX" }, "actions": { "rebalance": [], "fix": [ { "hidden": false, "iscid": "5efc88821f7eb1540eab4fef", "date": "2020-07-01T12:58:42.745Z", "name": "ICICI Prudential Smart", "batchId": "5efc88821f7eb1540eab4ff1", "scid": "ICIET_0003", "source": "PROFESSIONAL", "filled": 0, "quantity": 2, "originalLabel": "BUY" } ], "sip": [] } }, { "investment": { "currentConfig": { "constituents": [ { "averagePrice": 113.98, "shares": 1, "returns": 0.05588699771889796, "ticker": "ICICINIFTY", "stockName": "ICICI Prudential Nifty 50 ETF" }, { "averagePrice": 273, "shares": 1, "returns": 0.036556776556776624, "ticker": "JUNIORBEES", "stockName": "Nippon India Junior Bees ETF" } ] }, "returns": { "networth": 403.33000000000004, "unrealizedInvestment": 386.98, "realizedInvestment": 0, "realizedReturns": 0, "otherReturns": 0, "divReturns": 0, "accruedDivReturns": 0, "creditedDivReturns": 0, "weekly": 0, "monthly": 0 }, "stats": { "indexValue": 104.2250245490723, "lastCloseIndex": 104.07256188950333, "pe": 0, "lastToLastWeekCloseIndex": 107.47583854462763, "lastWeekCloseIndex": 104.07256188950333, "lastMonthCloseIndex": 103.98728616465966 }, "flags": { "amoPending": false, "private": false, "sip": false }, "date": "2020-07-13T15:19:26.515Z", "name": "Top 100 Stocks", "scid": "SCET_0010", "shortDescription": "2 ETFs that represent the 100 largest companies weighted to minimize risk", "status": "VALID", "version": 5, "iscid": "5f0c7b7eff842d7e926bc4ba", "imageUrl": "https://assets.smallcase.com/images/smallcases/200/SCET_0010.png", "recommendedAction": "INVESTMORE" }, "actions": { "rebalance": [], "fix": [], "sip": [] } }, { "investment": { "returns": { "networth": 62.18, "unrealizedInvestment": 63.459999999999994, "realizedInvestment": 0, "realizedReturns": 0, "otherReturns": 0, "divReturns": 0, "accruedDivReturns": 0, "creditedDivReturns": 0, "weekly": 0, "monthly": 0 }, "name": "Testgateway", "scid": "GATENM_0001", "shortDescription": "test gateway flow", "date": "2020-08-31T16:35:13.818Z", "status": "INVALID", "version": 1, "currentConfig": { "constituents": [ { "averagePrice": 17.74, "shares": 2, "returns": -0.013528748590755268, "ticker": "M100", "stockName": "Motilal Oswal Nifty Midcap 100 ETF" }, { "averagePrice": 27.98, "shares": 1, "returns": -0.028591851322373147, "ticker": "ICICINXT50", "stockName": "ICICI Prudential Nifty Next 50 ETF" } ] }, "stats": { "indexValue": 97.98298140560983, "lastCloseIndex": 98.94421682949891, "pe": 0, "lastMonthCloseIndex": 100, "lastToLastWeekCloseIndex": null, "lastWeekCloseIndex": 98.94421682949891 }, "flags": { "amoPending": false, "private": false }, "iscid": "5f4d26c191368a7519c132f7", "imageUrl": "https://assets.smallcase.com/images/smallcases/200/GATENM_0001.png", "recommendedAction": "FIX" }, "actions": { "rebalance": [], "fix": [ { "hidden": false, "iscid": "5f4d26c191368a7519c132f7", "date": "2020-09-01T04:00:24.545Z", "name": "Testgateway", "batchId": "5f4d26c191368a7519c132f9", "scid": "GATENM_0001", "source": "PROFESSIONAL", "filled": 2, "quantity": 3, "originalLabel": "BUY" } ], "sip": [] } } ] } ```
Language
Click Try It! to start a request and see the response here!