Fetch pending actions

The API returns the pending actions, if any, for all the smallcases or for a given smallcase. The API provides the data like fix, rebalance, sell, buy and sip actions for the user

<<apiUseCaseTerm>>: This API is ideal when you want to notify the user about their pending actions on the smallcases, or if you want any specific handling based on any pending action

get/{gatewayname}/engine/user/actions

Request

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

Path parameters

gatewaynamestring required

Query parameters

iscidstring

Optional | if passed, only return pending actions for the iscid

Headers

x-gateway-secretstring required

Required | apiSecret shared for authentication

x-gateway-authtokenstring required

Required | JWT signed with shared secret & payload for connected user

Response

200

successboolean

errorsunknown

Example response

{
  "success": true,
  "data": {
    "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",
          "imageUrl": "https://assets.smallcase.com/images/smallcases/200/SCTR_0003.png"
        }
      ],
      "fix": [
        {
          "iscid": "6045b146f4a551a00f98ac15",
          "date": "2021-03-08T05:09:07.550Z",
          "name": "ICICI Prudential Leaders",
          "batchId": "6045b16ff4a551a00f98ac2d",
          "scid": "ICIET_0002",
          "source": "PROFESSIONAL",
          "filled": 1,
          "quantity": 4,
          "originalLabel": "INVESTMORE",
          "imageUrl": "https://assets.smallcase.com/images/smallcases/200/ICIET_0002.png"
        }
      ],
      "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",
          "imageUrl": "https://assets.smallcase.com/images/smallcases/200/SCMO_0020.png"
        }
      ]
    }
  }
}

Changes

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