Discover smallcases

get https://gatewayapi.smallcase.com/v1/{gatewayname}/engine/smallcases

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

Use case: This is ideal data API when you want to display list of available smallcases to user.

Request parameters

Path Params

gatewayname

string

required

Defaults to gatewaydemo

Query Params

sortBy

string

Defaults to default

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

sortOrder

int32

Defaults to 1

Optional | Possible Values for sortOrder 1 or -1

count

int32

Defaults to 10

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

offset

int32

Defaults to 0

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

showBlocked

boolean

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

showPlayedOut

boolean

Optional | whether to fetch played out smallcases

Headers

x-gateway-secret

string

required

Defaults to gatewayDemo_secret

apiSecret shared for authentication

x-gateway-authtoken

string

required

Defaults to eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJndWVzdCI6dHJ1ZSwiaWF0IjoxNjU0MzIxMDAwfQ.qiZ_w1yFYXhkdLMlqI28XJOXitfZwr64e2oL-lMEHZU

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

Response

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://gatewayapi.smallcase.com/v1/gatewaydemo/engine/smallcases?sortBy=default&sortOrder=1&count=10&offset=0' \
3
     --header 'accept: application/json' \
4
     --header 'x-gateway-authtoken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJndWVzdCI6dHJ1ZSwiaWF0IjoxNjU0MzIxMDAwfQ.qiZ_w1yFYXhkdLMlqI28XJOXitfZwr64e2oL-lMEHZU' \
5
     --header 'x-gateway-secret: gatewayDemo_secret'


xxxxxxxxxx
462
}
1
{
2
  "success": true,
3
  "errors": null,
4
  "data": {
5
    "smallcases": [
6
      {
7
        "_id": "5b34d9e5ab964248596b2cb3",
8
        "info": {
9
          "created": "2014-06-30T00:00:00.000Z",
10
          "uploaded": "2018-06-28T12:51:49.060Z",
11
          "name": "Tech",
12
          "shortDescription": "YOLO",
13
          "type": "Model-based",
14
          "publisherName": "leprechaun",
15
          "blogURL": null,
16
          "nextUpdate": "2020-09-20T15:26:03.113Z",
17
          "rebalanceSchedule": "weekly",
18
          "lastRebalanced": "2020-09-13T00:00:00.000Z",
19
          "imageUrl": "https://assets.smallcase.com/images/smallcases/200/LEPMO_0004.png"
20
        },
21
        "stats": {
22
          "returns": {
23
            "daily": 0.0068279276241948,
24
            "weekly": -0.0301510708810352,
25
            "monthly": -0.00354508448749107,

Request parameters

200200