Discover smallcases

The API provides list of all smallcases enabled for your gateway. Data like smallcase info, return stats, benchmark info is shared.

<<apiUseCaseTerm>>: This is ideal data API when you want to display list of available smallcases to user.

get/{gatewayname}/engine/smallcases

Request

Base URL
https://gatewayapi.smallcase.com/v1
URL
https://gatewayapi.smallcase.com/v1/{gatewayname}/engine/smallcases
Auth
none required

Path parameters

gatewaynamestring required

Query parameters

sortBystring

Optional | Possible values for sortBy: default, dailyReturns, weeklyReturns, monthlyReturns, yearlyReturns, indexValue, minInvestAmount, cagr, risk, sharpe, inceptionDate, uploadedDate, nextRebalanceDate,

sortOrderinteger

Optional | Possible Values for sortOrder 1 or -1

countinteger

Optional | Maximum number of smallcases to be returned (used for pagination)

offsetinteger

Optional | Number of smallcases to skip over (used for pagination)

showBlockedboolean

Optional | Whether to fetch blocked smallcases (default: false)

showPlayedOutboolean

Optional | whether to fetch played out smallcases

Headers

x-gateway-secretstring required

apiSecret shared for authentication

x-gateway-authtokenstring required

JWT signed with shared secret & payload of guest user or connected user

Response

200

successboolean

errorsunknown

Example response

{
  "success": true,
  "data": {
    "smallcases": [
      {
        "_id": "5b34d9e5ab964248596b2cb3",
        "info": {
          "created": "2014-06-30T00:00:00.000Z",
          "uploaded": "2018-06-28T12:51:49.060Z",
          "name": "Tech",
          "shortDescription": "YOLO",
          "type": "Model-based",
          "publisherName": "leprechaun",
          "nextUpdate": "2020-09-20T15:26:03.113Z",
          "rebalanceSchedule": "weekly",
          "lastRebalanced": "2020-09-13T00:00:00.000Z",
          "imageUrl": "https://assets.smallcase.com/images/smallcases/200/LEPMO_0004.png"
        },
        "stats": {
          "returns": {
            "daily": 0.0068279276241948,
            "weekly": -0.0301510708810352,
            "monthly": -0.00354508448749107,
            "quarterly": 0.166121496076316,
            "halfyearly": 0.395119740825772,
            "yearly": 0.48371971669421,
            "threeYear": 0.868615078324472,
            "fiveYear": 0.868615078324472,
            "sinceInception": 0.933335701173431
          },
          "indexValue": 232.6622004738096,
          "unadjustedIndex": 232.6622004738096,
          "divReturns": 1.81175060341145,
          "lastCloseIndex": 190.008934224636,
          "minInvestAmount": 39675,
          "ratios": {
            "cagr": 0.13196503441673846,
            "momentumRank": 681,
            "risk": 1.232351150371391,
            "sharpe": -0.276233773295825,
            "52wHigh": 225.94663978967776,
            "52wLow": 89.77575641573681,
            "divYield": 1.3698741944592436,
            "divYieldDifferential": -0.000125805540756474,
            "largeCapPercentage": 95.00478557082958,
            "marketCapCategory": "Large cap",
            "pb": 4.228098172076307,
            "pbDiscount": 0.16507835760346534,
            "pe": 20.9951756849074,
            "peDiscount": -21.434796722302107,
            "smallCapPercentage": 4.995214429170369,
            "ema": 176.63175169075208,
            "momentum": 28.727249003577437,
            "lastCloseEma": 175.52355195860554,
            "sharpeRatio": 0.6441454182853268,
            "riskLabel": "Medium Volatility",
            "oneYearLiveHistory": true,
            "cagrDuration": "3Y"
          },
          "minSipAmount": 5000,
          "launchDateIndex": 100
        },
        "version": 7,
        "scid": "LEPMO_0004",
        "rationale": "<p>YOLO</p>",
        "updates": [
          {
            "label": "Y Merge Rebalance Testing ",
            "rationale": "Y Merge Rebalance Testing Y Merge Rebalance Testing Y Merge Rebalance Testing Y Merge Rebalance Testing Y Merge Rebalance Testing ",
            "date": "2020-09-13T00:00:00.000Z",
            "version": 7,
            "appliedToUsers": true
          }
        ],
        "benchmark": {
          "id": ".NSEI",
          "message": "As this smallcase mainly consists of large cap stocks",
          "index": ".NIFTY100",
          "msg": "Compare with top 100 market cap stocks"
        },
        "assetUniverse": "IN",
        "assetClass": "ETI"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.